1 args "--conf-parser --no-handle-version --no-handle-help"
3 purpose "An alarm clock and volume-fader for OSS and ALSA"
6 define(CURRENT_PROGRAM,para_fade)
7 define(DEFAULT_CONFIG_FILE,~/.paraslash/fade.conf)
9 section "General options"
10 #########################
13 include(config_file.m4)
20 values = "sleep", "fade", "set", "snooze"
24 para_fade knows the following modes:
26 sleep mode: Change to the initial volume and select
27 the initial afs mood/playlist. Then fade out until
28 the fade-out volume is reached. Switch to the
29 sleep mood/playlist until wake time minus fade-in
30 time. Finally switch to the wake mood/playlist and
31 fade to the fade-in volume.
33 fade: Fade the volume to the given value in the
36 set: Just set the value and exit.
38 snooze: Fade out, sleep a bit and fade in.
43 "choose the mixer API"
44 string typestr = "api"
47 ALSA is preferred over OSS if both APIs are supported
48 and this option is not given. To see the supported
49 mixer APIs, use this option with an invalid string
50 as the mixer API, e.g. --mixer-api help.
53 option "mixer-device" m
54 #~~~~~~~~~~~~~~~~~~~~~~
56 string typestr = "device"
59 The default device (used if this option is not given)
60 depends on the selected mixer API. For ALSA, the
61 default is 'hw:0' which corresponds to the first sound
62 device. For OSS, '/dev/mixer' is used as the default.
65 option "mixer-channel" C
66 #~~~~~~~~~~~~~~~~~~~~~~~
67 "select the analog mixer channel"
68 string typestr = "channel"
71 For the ALSA mixer API, the possible values are
72 determined at runtime depending on the hardware and
73 can be printed by specifying an invalid mixer channel,
74 for example --mixer-channel help. The default channel
77 For OSS the possible values are invariably 'volume',
78 'bass', 'treble', 'synth', 'pcm', 'speaker', 'line',
79 'mic', 'cd', 'imix', 'altpcm', 'reclev', 'igain',
80 'ogain'. However, not all listed channels might be
81 supported on any particular hardware. The default
85 section "Options for sleep mode"
86 ################################
91 string typestr = "[channel:]volume"
96 Used as the start volume, before fading out to the
97 fade out volume. The channel part may be omitted, in
98 which case the default channel is used. This option
99 may be given multiple times.
104 "afs mood/playlist during fade out"
105 string typestr = "mood_spec"
109 Select this mood right after setting the
110 volume. Example: --fo-mood m/sleep
115 "fall asleep fade out time"
116 int typestr = "seconds"
120 No fading if set to 0.
125 "volume to fade out to"
126 int typestr = "volume"
130 option "sleep-mood" -
131 #~~~~~~~~~~~~~~~~~~~~
132 "sleep time afs mood/playlist"
133 string typestr = "mood_spec"
137 Select the given afs mood/playlist after the fade
138 out is complete. If unset, the \"stop\" command is
144 "(0-23) (default: now + 9 hours)"
151 int typestr = "minutes"
157 "afs mood/playlist during fade in"
158 string typestr = "mood_spec"
162 Change to this afs mood/playlist on wake time.
167 "wake up fade in time"
168 int typestr="seconds"
172 No fading in if set to 0.
177 "volume to fade to at wake time"
178 int typestr = "volume"
182 section "Options for snooze mode"
183 #################################
188 int typestr = "seconds"
194 "volume to fade to before snooze"
195 int typestr = "volume"
199 option "snooze-time" -
200 #~~~~~~~~~~~~~~~~~~~~~
202 int typestr = "seconds"
209 int typestr = "seconds"
215 "volume to fade to after snooze"
216 int typestr = "volume"
220 section "Options for fade mode"
221 ###############################
226 int typestr = "volume"
233 int typestr = "seconds"
237 section "Options for set mode"
238 ##############################
242 int typestr = "value"