i9e: Remove \return from documentation of i9e_attach_to_stdout().
[paraslash.git] / m4 / lls / write_cmd.suite.m4
1 [suite write_cmd]
2 caption = writers
3 [subcommand alsa]
4 purpose = native ALSA output plugin
5 [option device]
6 short_opt = d
7 summary = set PCM device
8 typestr = device
9 arg_info = required_arg
10 arg_type = string
11 default_val = default
12 [help]
13 Check for the presence of a /proc/asound/ directory to see if ALSA
14 is present in your kernel. The file /proc/asound/devices contains
15 all devices ALSA knows about.
16 [/help]
17 [option buffer-time]
18 short_opt = B
19 summary = duration of the ALSA buffer
20 typestr = milliseconds
21 arg_info = required_arg
22 arg_type = uint32
23 default_val = 170
24 [help]
25 This is only a hint as ALSA might pick a slightly different time,
26 depending on the sound hardware. The chosen value is shown in debug
27 output as BUFFER_TIME.
28
29 If synchronization between multiple clients is desired, the same
30 buffer time should be configured for all clients.
31 [/help]
32 [subcommand ao]
33 purpose = output plugin for libao
34 [option driver]
35 short_opt = d
36 summary = select a output driver by name
37 typestr = name
38 arg_info = required_arg
39 arg_type = string
40 [help]
41 If this is not given, the driver with the highest priority will be
42 used. The list of available drivers and their priorities is shown in
43 debug mode.
44 [/help]
45 [option ao-option]
46 short_opt = o
47 summary = pass a key-value pair to the libao driver
48 typestr = key:value
49 arg_info = required_arg
50 arg_type = string
51 flag multiple
52 [help]
53 For each time this option is given, the supplied key-value pair is
54 appended to the list of options for the driver. Invalid keys are
55 silently ignored. The list of available keys is shown in debug mode.
56 [/help]
57 [subcommand oss]
58 purpose = output plugin for the Open Sound System
59 [option device]
60 short_opt = d
61 summary = set PCM device
62 typestr = path
63 arg_info = required_arg
64 arg_type = string
65 default_val = /dev/dsp
66 [subcommand file]
67 purpose = output plugin that writes to a local file
68 [option filename]
69 short_opt = f
70 summary = specify output file name
71 typestr = path
72 arg_info = required_arg
73 arg_type = string
74 [help]
75 Defaults to a random filename in ~/.paraslash.
76 [/help]