450e05423db66925449934e0c5efab0b8d850c3e
[paraslash.git] / m4 / gengetopt / fade.m4
1 args "--conf-parser --no-handle-version"
2
3 section "General options"
4 #########################
5
6 option "mode" o
7 #~~~~~~~~~~~~~~
8 "how to fade volume"
9 enum typestr = "mode"
10 values = "sleep", "snooze", "fade"
11 default = "sleep"
12 optional
13 details="
14 para_fade knows three different fading modes:
15
16 sleep mode: Change to the initial volume and select
17 the initial afs mood/playlist. Then fade out until
18 the fade-out volume is reached. Switch to the
19 sleep mood/playlist until wake time minus fade-in
20 time. Finally switch to the wake mood/playlist and
21 fade to the fade-in volume.
22
23 fade: Fade the volume to the given value in the
24 given time.
25
26 snooze: Fade out, sleep a bit and fade in.
27 "
28
29 option "config-file" c
30 #~~~~~~~~~~~~~~~~~~~~~
31 "(default='~/.paraslash/fade.conf')"
32 string typestr = "filename"
33 optional
34
35 option "mixer-api" a
36 #~~~~~~~~~~~~~~~~~~~
37 "choose the mixer API"
38 string typestr = "api"
39 optional
40 details = "
41 ALSA is preferred over OSS if both APIs are supported
42 and this option is not given. To see the supported
43 mixer APIs, use this option with an invalid string
44 as the mixer API, e.g. --mixer-api help.
45 "
46
47 option "mixer-device" m
48 #~~~~~~~~~~~~~~~~~~~~~~
49 "choose mixer device"
50 string typestr = "device"
51 optional
52 details = "
53 The default device (used if this option is not given)
54 depends on the selected mixer API. For ALSA, the
55 default is 'hw:0' which corresponds to the first sound
56 device. For OSS, '/dev/mixer' is used as the default.
57 "
58
59 option "mixer-channel" C
60 #~~~~~~~~~~~~~~~~~~~~~~~
61 "select the analog mixer channel"
62 string typestr = "channel"
63 optional
64 details = "
65 For the ALSA mixer API, the possible values are
66 determined at runtime depending on the hardware and
67 can be printed by specifying an invalid mixer channel,
68 for example --mixer-channel help. The default channel
69 is 'Master'.
70
71 For OSS the possible values are invariably 'volume',
72 'bass', 'treble', 'synth', 'pcm', 'speaker', 'line',
73 'mic', 'cd', 'imix', 'altpcm', 'reclev', 'igain',
74 'ogain'. However, not all listed channels might be
75 supported on any particular hardware. The default
76 channel is 'volume'.
77 "
78
79 section "Options for sleep mode"
80 ################################
81
82 option "ivol" -
83 #~~~~~~~~~~~~~~
84 "set initial volume"
85 int typestr = "volume"
86 default = "60"
87 optional
88 details = "
89 Used as the start volume, before fading out to the
90 fade out volume.
91 "
92
93 option "fo-mood" -
94 #~~~~~~~~~~~~~~~~~
95 "afs mood/playlist during fade out"
96 string typestr = "mood_spec"
97 default = "m/fade"
98 optional
99 details = "
100 Select this mood right after setting the
101 volume. Example: --fo-mood m/sleep
102 "
103
104 option "fo-time" -
105 #~~~~~~~~~~~~~~~~~
106 "fall asleep fade out time"
107 int typestr = "seconds"
108 default = "1800"
109 optional
110 details = "
111 No fading if set to 0.
112 "
113
114 option "fo-vol" -
115 #~~~~~~~~~~~~~~~~
116 "volume to fade out to"
117 int typestr = "volume"
118 default = "20"
119 optional
120
121 option "sleep-mood" -
122 #~~~~~~~~~~~~~~~~~~~~
123 "sleep time afs mood/playlist"
124 string typestr = "mood_spec"
125 default = "m/sleep"
126 optional
127 details = "
128 Select the given afs mood/playlist after the fade
129 out is complete. If unset, the \"stop\" command is
130 sent to para_server.
131 "
132
133 option "wake-hour" H
134 #~~~~~~~~~~~~~~~~~~~
135 "(0-23) (default: now + 9 hours)"
136 int typestr = "hour"
137 optional
138
139 option "wake-min" M
140 #~~~~~~~~~~~~~~~~~~
141 "(0-59)"
142 int typestr = "minutes"
143 default = "0"
144 optional
145
146 option "fi-mood" -
147 #~~~~~~~~~~~~~~~~~
148 "afs mood/playlist during fade in"
149 string typestr = "mood_spec"
150 default = "m/wake"
151 optional
152 details = "
153 Change to this afs mood/playlist on wake time.
154 "
155
156 option "fi-time" -
157 #~~~~~~~~~~~~~~~~~
158 "wake up fade in time"
159 int typestr="seconds"
160 default="1200"
161 optional
162 details = "
163 No fading in if set to 0.
164 "
165
166 option "fi-vol" -
167 #~~~~~~~~~~~~~~~~
168 "volume to fade to at wake time"
169 int typestr = "volume"
170 default = "80"
171 optional
172
173 section "Options for snooze mode"
174 #################################
175
176 option "so-time" -
177 #~~~~~~~~~~~~~~~~~
178 "snooze-out time"
179 int typestr = "seconds"
180 default = "30"
181 optional
182
183 option "so-vol" -
184 #~~~~~~~~~~~~~~~~
185 "volume to fade to before snooze"
186 int typestr = "volume"
187 default = "20"
188 optional
189
190 option "snooze-time" -
191 #~~~~~~~~~~~~~~~~~~~~~
192 "delay"
193 int typestr = "seconds"
194 default = "600"
195 optional
196
197 option "si-time" -
198 #~~~~~~~~~~~~~~~~~
199 "snooze-in time"
200 int typestr = "seconds"
201 default = "180"
202 optional
203
204 option "si-vol" -
205 #~~~~~~~~~~~~~~~~
206 "volume to fade to after snooze"
207 int typestr = "volume"
208 default = "80"
209 optional
210
211 section "Options for fade mode"
212 ###############################
213
214 option "fade-vol" f
215 #~~~~~~~~~~~~~~~~~~
216 "volume to fade to"
217 int typestr = "volume"
218 default = "50"
219 optional
220
221 option "fade-time" t
222 #~~~~~~~~~~~~~~~~~~~
223 "fading time"
224 int typestr = "seconds"
225 default = "5"
226 optional