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