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'.
65 [option fade-exponent]
66 summary = set non-linear time scale for fading
67 arg_info = required_arg
72 This option affects the fade, snooze and sleep subcommands. It is
75 The argument must be a number between 0 and 100. The default value
76 0 corresponds to linear scaling. That is, the value of the mixer
77 channel is increased or decreased in fixed time intervals until the
78 destination value is reached. Exponents between 1 and 99 cause low
79 channel values to be increased more quickly than high channel values.
80 Large exponents cause greater differences. The special value 100 sets
81 the destination value immediately. The command then sleeps for the
85 purpose = print subcommand help
86 non-opts-name = [<subcommand>]
88 summary = print the long help text
92 purpose = set a channel to the given value and exit
94 summary = mixer channel value to set
95 arg_info = required_arg
100 purpose = fade a channel to the given value in the given time
103 summary = destination volume for fading
104 arg_info = required_arg
110 summary = duration of fade period
111 arg_info = required_arg
116 purpose = fade out, pause, sleep, play, fade in
118 summary = duration of fade-out period
119 arg_info = required_arg
124 summary = destination volume for fade-out
125 arg_info = required_arg
130 summary = delay between end of fade-out and begin of fade-in
131 arg_info = required_arg
136 summary = duration of fade-in period
137 arg_info = required_arg
142 summary = destination volume for fade-in
143 arg_info = required_arg
148 purpose = stream, fade out, sleep, fade in
150 Set the initial volume and mood, start playing and sleep. Then switch
151 to the fade-out mood and fade to the fade-out volume. Next, switch to
152 the sleep mood and wait until wake time minus fade-in time. Finally,
153 switch to the wake mood and fade in to the fade-in volume.
156 summary = set initial volume
157 arg_info = required_arg
161 typestr = [channel:]volume
163 Used as the start volume, before fading out to the fade-out volume. The
164 channel part may be omitted, in which case the default channel is
165 used. This option may be given multiple times.
167 [option initial-mood]
168 summary = mood or playlist to start with
169 arg_info = required_arg
173 This mood or playlist is selected right after setting the initial
174 volume and before fade-out starts. If unset, fade-out starts
177 [option initial-delay]
178 summary = time before fade-out starts.
179 arg_info = required_arg
184 If left at the default, no initial delay occurs even if an initial
188 summary = mood or playlist for fade-out
189 arg_info = required_arg
193 This mood (or playlist) is selected right after setting the initial
197 summary = duration of fade-out period
198 arg_info = required_arg
203 No fading if this is set to 0.
206 summary = destination volume for fade-out
207 arg_info = required_arg
212 summary = mood/playlist between fade-out and fade-in
213 arg_info = required_arg
217 Select the given mood or playlist after the fade-out. If unset,
218 playback is stopped until fade-in starts.
222 summary = when to start fade in
223 arg_info = required_arg
225 typestr = [+][HH][:MM]
228 If the optional plus character is given, the wake time is computed as
229 now + HH hours + MM minutes. Otherwise the HH:MM argument is considered
230 an absolute time (referring to either the current or the next day).
233 summary = mood or playlist for fade-in
234 arg_info = required_arg
238 This mood or playlist is selected right before fade-in begins.
241 summary = duration of fade-in period
242 arg_info = required_arg
247 No fading if this is set to 0.
250 summary = destination volume for fade-in
251 arg_info = required_arg