Teach para_fade to accept a mixer channel to fade.
[paraslash.git] / ggo / fade.ggo
1 section "general options"
2 #########################
3
4 option "mode" o
5 #~~~~~~~~~~~~~~
6 "{sleep|fade|snooze}"
7 string default="sleep"
8 optional
9 details="
10 para_fade knows these three different modes.
11
12 sleep mode: Change to the initial volume and an initial afs
13 mode, then fade the volume down until the fade out volume is
14 reached. Switch to the afs sleep mode until the wake time is
15 reached. Then switch to the afs wake mode and and fade in to
16 the wake volume.
17
18 fade: Fade the volume to the given value in the given time.
19
20 snooze: Fade out, sleep a bit and fade in.
21 "
22
23 option "config_file" c
24 #~~~~~~~~~~~~~~~~~~~~~
25 "(default='~/.paraslash/fade.conf')"
26 string typestr="filename"
27 optional
28
29 option "mixer_device" m
30 #~~~~~~~~~~~~~~~~~~~~~~
31 "mixer device file"
32 string typestr="device"
33 default="/dev/mixer"
34 optional
35
36 option "mixer_channel" C
37 #~~~~~~~~~~~~~~~~~~~~~~~
38 "select the analog mixer channel"
39 enum typestr="channel"
40 values="volume", "bass", "treble", "synth", "pcm", "speaker", "line",
41 "mic", "cd", "imix", "altpcm", "reclev", "igain", "ogain"
42 default="volume"
43 optional
44 details="
45 Not all listed channels might be supported on any particular hardware.
46 "
47
48 section "sleep options (only relevant in sleep mode)"
49 #####################################################
50
51 option "sleep_ivol" -
52 #~~~~~~~~~~~~~~~~~~~~
53 "set initial volume"
54 int typestr="volume"
55 default="60"
56 optional
57 details="
58 Used as the start volume, before fading out to the fade out volume.
59 "
60
61 option "fa_mode" -
62 #~~~~~~~~~~~~~~~~~
63 "fall asleep afs mode."
64 string typestr="afs_mode"
65 default="m/fade"
66 optional
67 details="
68 Select this mode right after setting the volume. Example:
69 --fa_mode m/sleep
70 "
71
72 option "fa_fade" -
73 #~~~~~~~~~~~~~~~~~
74 "fall asleep fading time"
75 int typestr="seconds"
76 default="1800"
77 optional
78 details="
79 No fading if set to 0.
80 "
81
82 option "fa_vol" -
83 #~~~~~~~~~~~~~~~~
84 "volume to fade to"
85 int typestr="volume"
86 default="20"
87 optional
88
89 option "sleep_mode" -
90 #~~~~~~~~~~~~~~~~~~~~~~
91 "sleep time afs mode"
92 details = "
93 Select the given afs mode after the fade out is complete. If
94 unset, the \"stop\" command is sent to para_server.
95 "
96 string typestr="afs_mode"
97 default="m/sleep"
98 optional
99
100 option "wake_hour" H
101 #~~~~~~~~~~~~~~~~~~~
102 "(0-23) (default: now + 9 hours)"
103 int typestr="hour"
104 optional
105
106 option "wake_min" M
107 #~~~~~~~~~~~~~~~~~~
108 "(0-59)"
109 int typestr="minutes"
110 default="0"
111 optional
112
113 option "wake_mode" -
114 #~~~~~~~~~~~~~~~~~~~
115 "wake time afs mode"
116 string typestr="afs_mode"
117 default="m/wake"
118 optional
119 details="
120 Change to this afs mode on waketime.
121 "
122
123 option "wake_fade" -
124 #~~~~~~~~~~~~~~~~~~~
125 "no fading in if set to 0"
126 int typestr="seconds"
127 default="1200"
128 optional
129
130 option "wake_vol" -
131 #~~~~~~~~~~~~~~~~~~
132 "vol to fade to at waketime"
133 int typestr="volume"
134 default="80"
135 optional
136
137 section "snooze options"
138 ########################
139
140 option "snooze_out_fade" -
141 #~~~~~~~~~~~~~~~~~~~~~~~~~
142 "fade out time"
143 int typestr="seconds"
144 default="30"
145 optional
146
147 option "snooze_out_vol" -
148 #~~~~~~~~~~~~~~~~~~~~~~~~
149 "vol to fade to before snooze"
150 int typestr="volume"
151 default="20"
152 optional
153
154 option "snooze_time" -
155 #~~~~~~~~~~~~~~~~~~~~~
156 "delay"
157 int typestr="seconds"
158 default="600"
159 optional
160
161 option "snooze_in_fade" -
162 #~~~~~~~~~~~~~~~~~~~~~~~~
163 "fade in time"
164 int typestr="seconds"
165 default="180"
166 optional
167
168 option "snooze_in_vol" -
169 #~~~~~~~~~~~~~~~~~~~~~~~
170 "vol to fade to after snooze"
171 int typestr="volume"
172 default="80"
173 optional
174
175 section "fade options"
176 ######################
177
178 option "fade_vol" f
179 #~~~~~~~~~~~~~~~~~~
180 "volume to fade to"
181 int typestr="volume"
182 default="50"
183 optional
184
185 option "fade_time" t
186 #~~~~~~~~~~~~~~~~~~~
187 "time to fade in"
188 int typestr="seconds"
189 default="5"
190 optional