42f135fa3ee5d3ed6d61faf9b4088fd00d8302e2
[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-device" m
36 #~~~~~~~~~~~~~~~~~~~~~~
37 "choose mixer device"
38 string typestr = "device"
39 optional
40 details = "
41 The default device (used if this option is not given)
42 depends on the selected mixer API. For ALSA, the
43 default is 'hw:0' which corresponds to the first sound
44 device. For OSS, '/dev/mixer' is used as the default.
45 "
46
47 option "mixer-channel" C
48 #~~~~~~~~~~~~~~~~~~~~~~~
49 "select the analog mixer channel"
50 string typestr = "channel"
51 optional
52 details = "
53 For the ALSA mixer API, the possible values are
54 determined at runtime depending on the hardware and
55 can be printed by specifying an invalid mixer channel,
56 for example --mixer-channel help. The default channel
57 is 'Master'.
58
59 For OSS the possible values are invariably 'volume',
60 'bass', 'treble', 'synth', 'pcm', 'speaker', 'line',
61 'mic', 'cd', 'imix', 'altpcm', 'reclev', 'igain',
62 'ogain'. However, not all listed channels might be
63 supported on any particular hardware. The default
64 channel is 'volume'.
65 "
66
67 section "Options for sleep mode"
68 ################################
69
70 option "ivol" -
71 #~~~~~~~~~~~~~~
72 "set initial volume"
73 int typestr = "volume"
74 default = "60"
75 optional
76 details = "
77 Used as the start volume, before fading out to the
78 fade out volume.
79 "
80
81 option "fo-mood" -
82 #~~~~~~~~~~~~~~~~~
83 "afs mood/playlist during fade out"
84 string typestr = "mood_spec"
85 default = "m/fade"
86 optional
87 details = "
88 Select this mood right after setting the
89 volume. Example: --fo-mood m/sleep
90 "
91
92 option "fo-time" -
93 #~~~~~~~~~~~~~~~~~
94 "fall asleep fade out time"
95 int typestr = "seconds"
96 default = "1800"
97 optional
98 details = "
99 No fading if set to 0.
100 "
101
102 option "fo-vol" -
103 #~~~~~~~~~~~~~~~~
104 "volume to fade out to"
105 int typestr = "volume"
106 default = "20"
107 optional
108
109 option "sleep-mood" -
110 #~~~~~~~~~~~~~~~~~~~~
111 "sleep time afs mood/playlist"
112 string typestr = "mood_spec"
113 default = "m/sleep"
114 optional
115 details = "
116 Select the given afs mood/playlist after the fade
117 out is complete. If unset, the \"stop\" command is
118 sent to para_server.
119 "
120
121 option "wake-hour" H
122 #~~~~~~~~~~~~~~~~~~~
123 "(0-23) (default: now + 9 hours)"
124 int typestr = "hour"
125 optional
126
127 option "wake-min" M
128 #~~~~~~~~~~~~~~~~~~
129 "(0-59)"
130 int typestr = "minutes"
131 default = "0"
132 optional
133
134 option "fi-mood" -
135 #~~~~~~~~~~~~~~~~~
136 "afs mood/playlist during fade in"
137 string typestr = "mood_spec"
138 default = "m/wake"
139 optional
140 details = "
141 Change to this afs mood/playlist on wake time.
142 "
143
144 option "fi-time" -
145 #~~~~~~~~~~~~~~~~~
146 "wake up fade in time"
147 int typestr="seconds"
148 default="1200"
149 optional
150 details = "
151 No fading in if set to 0.
152 "
153
154 option "fi-vol" -
155 #~~~~~~~~~~~~~~~~
156 "volume to fade to at wake time"
157 int typestr = "volume"
158 default = "80"
159 optional
160
161 section "Options for snooze mode"
162 #################################
163
164 option "so-time" -
165 #~~~~~~~~~~~~~~~~~
166 "snooze-out time"
167 int typestr = "seconds"
168 default = "30"
169 optional
170
171 option "so-vol" -
172 #~~~~~~~~~~~~~~~~
173 "volume to fade to before snooze"
174 int typestr = "volume"
175 default = "20"
176 optional
177
178 option "snooze-time" -
179 #~~~~~~~~~~~~~~~~~~~~~
180 "delay"
181 int typestr = "seconds"
182 default = "600"
183 optional
184
185 option "si-time" -
186 #~~~~~~~~~~~~~~~~~
187 "snooze-in time"
188 int typestr = "seconds"
189 default = "180"
190 optional
191
192 option "si-vol" -
193 #~~~~~~~~~~~~~~~~
194 "volume to fade to after snooze"
195 int typestr = "volume"
196 default = "80"
197 optional
198
199 section "Options for fade mode"
200 ###############################
201
202 option "fade-vol" f
203 #~~~~~~~~~~~~~~~~~~
204 "volume to fade to"
205 int typestr = "volume"
206 default = "50"
207 optional
208
209 option "fade-time" t
210 #~~~~~~~~~~~~~~~~~~~
211 "fading time"
212 int typestr = "seconds"
213 default = "5"
214 optional