1 m4_define(PROGRAM, para_fade)
2 m4_define(DEFAULT_CONFIG_FILE, ~/.paraslash/fade.conf)
4 version-string = GIT_VERSION()
5 [supercommand para_fade]
6 purpose = alarm clock and volume-fader for OSS and ALSA
8 para_fade is a simple program which adjusts the settings of an audio
9 mixing device. It can set the level of a mixer channel, or fade the
10 level from one value to another in a given time period. In sleep and
11 snooze mode, it contacts para_server to start or stop streaming.
13 m4_include(common-option-section.m4)
15 m4_include(detailed-help.m4)
16 m4_include(version.m4)
17 m4_include(config-file.m4)
18 m4_include(loglevel.m4)
19 m4_include(per-command-options-section.m4)
22 summary = select mode of operation (sleep, fade, set or snooze)
23 arg_info = required_arg
28 sleep: Change to the initial volume and select the initial
29 afs mood/playlist. Then fade out until the fade-out volume is
30 reached. Switch to the sleep mood/playlist until wake time minus
31 fade-in time. Finally switch to the wake mood/playlist and fade to
34 fade: Fade the volume to the given value in the given time.
36 set: Just set the value and exit.
38 snooze: Fade out, sleep a bit, and fade in.
42 summary = select alternative mixer API
43 arg_info = required_arg
47 ALSA is preferred over OSS if both APIs are supported and this option
48 is not given. To see the supported mixer APIs, use this option with
49 an invalid string as the mixer API, e.g. --mixer-api help.
53 summary = set mixer device
54 arg_info = required_arg
58 The default device (used if this option is not given) depends
59 on the selected mixer API. For ALSA, the default is 'hw:0' which
60 corresponds to the first sound device. For OSS, '/dev/mixer' is used
63 [option mixer-channel]
65 summary = select the analog mixer channel
66 arg_info = required_arg
70 For the ALSA mixer API, the possible values are determined at runtime
71 depending on the hardware and can be printed by specifying an invalid
72 mixer channel, for example --mixer-channel help. The default channel is
75 For OSS the possible values are invariably 'volume', 'bass', 'treble',
76 'synth', 'pcm', 'speaker', 'line', 'mic', 'cd', 'imix', 'altpcm',
77 'reclev', 'igain', 'ogain'. However, not all listed channels might be
78 supported on any particular hardware. The default channel is 'volume'.
81 summary = Options for sleep mode
84 summary = set initial volume
85 arg_info = required_arg
89 typestr = [channel:]volume
91 Used as the start volume, before fading out to the fade-out volume. The
92 channel part may be omitted, in which case the default channel is
93 used. This option may be given multiple times.
96 summary = mood or playlist for fade-out
97 arg_info = required_arg
102 This mood (or playlist) is selected right after setting the initial
106 summary = duration of fade-out period
107 arg_info = required_arg
112 No fading if this is set to 0.
115 summary = destination volume for fade-out
116 arg_info = required_arg
121 summary = mood/playlist between fade-out and fade-in
122 arg_info = required_arg
125 default_val = m/sleep
127 Select the given mood or playlist after the fade-out. If unset,
128 playback is stopped until fade-in starts.
132 summary = A number between 0 and 23
133 arg_info = required_arg
137 If this is not given, the default is computed as now + 9 hours.
141 summary = A number between 0 and 59
142 arg_info = required_arg
146 summary = mood or playlist for fade-in
147 arg_info = required_arg
152 This mood or playlist is selected right before fade-in begins.
155 summary = duration of fade-in period
156 arg_info = required_arg
161 No fading if this is set to 0.
164 summary = destination volume for fade-in
165 arg_info = required_arg
170 summary = Options for snooze mode
173 summary = duration of fade-out period
174 arg_info = required_arg
179 summary = destination volume for fade-out
180 arg_info = required_arg
185 summary = delay between end of fade-out and begin of fade-in
186 arg_info = required_arg
191 summary = duration of fade-in period
192 arg_info = required_arg
197 summary = destination volume for fade-in
198 arg_info = required_arg
203 summary = Options for fade mode
207 summary = destination volume for fading
208 arg_info = required_arg
214 summary = duration of fade period
215 arg_info = required_arg
220 summary = Options for set mode
223 summary = mixer channel value to set
224 arg_info = required_arg