1 m4_define(PROGRAM, para_mixer)
2 m4_define(DEFAULT_CONFIG_FILE, ~/.paraslash/mixer.conf)
4 version-string = GIT_VERSION()
5 caption = List of subcommands
6 [supercommand para_mixer]
7 purpose = alarm clock and volume-fader for OSS and ALSA
8 synopsis = [<options>] -- [<subcommand>] [<subcommand_options>]
10 para_mixer adjusts the settings of an audio mixing device. It can
11 set the level of a mixer channel, or fade the level from one value
12 to another in a given time period. The sleep and snooze subcommands
13 contact para_server to start or stop streaming.
15 m4_include(common-option-section.m4)
17 m4_include(detailed-help.m4)
18 m4_include(version.m4)
19 m4_include(config-file.m4)
20 m4_include(loglevel.m4)
21 m4_include(per-command-options-section.m4)
23 These options apply to several subcommands.
27 summary = select alternative mixer API
28 arg_info = required_arg
32 ALSA is preferred over OSS if both APIs are supported and this option
33 is not given. To see the supported mixer APIs, use this option with
34 an invalid string as the mixer API, e.g. --mixer-api help.
38 summary = set mixer device
39 arg_info = required_arg
43 The default device (used if this option is not given) depends
44 on the selected mixer API. For ALSA, the default is 'hw:0' which
45 corresponds to the first sound device. For OSS, '/dev/mixer' is used
48 [option mixer-channel]
50 summary = select a mixer channel
51 arg_info = required_arg
55 For the ALSA mixer API, the possible values are determined at runtime
56 depending on the hardware and can be printed by specifying an invalid
57 mixer channel, for example --mixer-channel help. The default channel is
60 For OSS the possible values are invariably 'volume', 'bass', 'treble',
61 'synth', 'pcm', 'speaker', 'line', 'mic', 'cd', 'imix', 'altpcm',
62 'reclev', 'igain', 'ogain'. However, not all listed channels might be
63 supported on any particular hardware. The default channel is 'volume'.
66 purpose = print subcommand help
67 non-opts-name = [<subcommand>]
69 summary = print the long help text
73 purpose = set a channel to the given value and exit
75 summary = mixer channel value to set
76 arg_info = required_arg
81 purpose = fade a channel to the given value in the given time
84 summary = destination volume for fading
85 arg_info = required_arg
91 summary = duration of fade period
92 arg_info = required_arg
97 purpose = fade out, pause, sleep, play, fade in
99 summary = duration of fade-out period
100 arg_info = required_arg
105 summary = destination volume for fade-out
106 arg_info = required_arg
111 summary = delay between end of fade-out and begin of fade-in
112 arg_info = required_arg
117 summary = duration of fade-in period
118 arg_info = required_arg
123 summary = destination volume for fade-in
124 arg_info = required_arg
129 purpose = stream, fade out, sleep, fade in
131 Change to the initial volume and select the initial mood/playlist.
132 Fade out to the given fade-out volume in the specified time. Switch
133 to the sleep mood/playlist and wait until wake time minus fade-in
134 time. Finally, switch to the wake mood/playlist and fade in to the
138 summary = set initial volume
139 arg_info = required_arg
143 typestr = [channel:]volume
145 Used as the start volume, before fading out to the fade-out volume. The
146 channel part may be omitted, in which case the default channel is
147 used. This option may be given multiple times.
150 summary = mood or playlist for fade-out
151 arg_info = required_arg
156 This mood (or playlist) is selected right after setting the initial
160 summary = duration of fade-out period
161 arg_info = required_arg
166 No fading if this is set to 0.
169 summary = destination volume for fade-out
170 arg_info = required_arg
175 summary = mood/playlist between fade-out and fade-in
176 arg_info = required_arg
179 default_val = m/sleep
181 Select the given mood or playlist after the fade-out. If unset,
182 playback is stopped until fade-in starts.
186 summary = when to start fade in
187 arg_info = required_arg
189 typestr = [+][HH][:MM]
192 If the optional plus character is given, the wake time is computed as
193 now + HH hours + MM minutes. Otherwise the HH:MM argument is considered
194 an absolute time (referring to either the current or the next day).
197 summary = mood or playlist for fade-in
198 arg_info = required_arg
203 This mood or playlist is selected right before fade-in begins.
206 summary = duration of fade-in period
207 arg_info = required_arg
212 No fading if this is set to 0.
215 summary = destination volume for fade-in
216 arg_info = required_arg