NEWS: Fix a typo.
[paraslash.git] / fade.ggo
1 section "general options"
2 #########################
3
4 option "mode" o
5 #~~~~~~~~~~~~~~
6
7 "{sleep|fade|snooze}"
8         string default="sleep"
9         optional
10
11 option "config_file" c
12 #~~~~~~~~~~~~~~~~~~~~~
13  "(default='~/.paraslash/fade.conf')"
14         string typestr="filename"
15         optional
16
17 option "mixer_device" m
18 #~~~~~~~~~~~~~~~~~~~~~~
19  "mixer device file"
20         string typestr="device"
21         default="/dev/mixer"
22         optional
23
24 section "sleep options (only relevant in sleep mode)"
25 #####################################################
26
27 option "sleep_ivol" -
28 #~~~~~~~~~~~~~~~~~~~~
29  "set initial volume before doing anything else"
30         int typestr="volume"
31         default="60"
32         optional
33
34 option "fa_mode" -
35 #~~~~~~~~~~~~~~~~~~~
36  "fall asleep afs mode. Select this mode
37 right after setting the volume. Example:
38         --fa_mode m:sleep
39 "
40
41         string typestr="afs_mode"
42         default="m:fa"
43         optional
44
45 option "fa_fade" -
46 #~~~~~~~~~~~~~~~~~
47  "fall asleep fading time, no fading if set
48 to 0"
49         int typestr="seconds"
50         default="1800"
51         optional
52
53 option "fa_vol" -
54 #~~~~~~~~~~~~~~~~
55  "volume to fade to"
56         int typestr="volume"
57         default="20"
58         optional
59
60 option "sleep_mode" -
61 #~~~~~~~~~~~~~~~~~~~~~~
62  "change to this afs mode after fading, stop
63 playing if unset."
64         string typestr="afs_mode"
65         default="m:sleep"
66         optional
67
68 option "wake_hour" H
69 #~~~~~~~~~~~~~~~~~~~
70  "(0-23) (default: now + 9 hours)"
71         int typestr="hour"
72         optional
73
74 option "wake_min" M
75 #~~~~~~~~~~~~~~~~~~
76 "(0-59)"
77         int typestr="seconds"
78         default="0"
79         optional
80
81 option "wake_mode" -
82 #~~~~~~~~~~~~~~~~~~~~~
83  "change to this afs mode on waketime"
84         string typestr="afs_mode"
85         default="m:wake"
86         optional
87
88 option "wake_fade" -
89 #~~~~~~~~~~~~~~~~~~~
90  "no fading in if set to 0"
91         int typestr="seconds"
92         default="1200"
93         optional
94
95 option "wake_vol" -
96 #~~~~~~~~~~~~~~~~~~
97  "vol to fade to at waketime"
98         int typestr="volume"
99         default="80"
100         optional
101
102 section "snooze options"
103 ########################
104
105 option "snooze_out_fade" -
106 #~~~~~~~~~~~~~~~~~~~~~~~~~
107  "fade out time"
108         int typestr="seconds"
109         default="30"
110         optional
111
112 option "snooze_out_vol" -
113 #~~~~~~~~~~~~~~~~~~~~~~~~
114  "vol to fade to before snooze"
115         int typestr="volume"
116         default="20"
117         optional
118
119 option "snooze_time" -
120 #~~~~~~~~~~~~~~~~~~~~~
121  "delay"
122         int typestr="seconds"
123         default="600"
124         optional
125
126 option "snooze_in_fade" -
127 #~~~~~~~~~~~~~~~~~~~~~~~~
128  "fade in time"
129         int typestr="seconds"
130         default="180"
131         optional
132
133 option "snooze_in_vol" -
134 #~~~~~~~~~~~~~~~~~~~~~~~
135  "vol to fade to after snooze"
136         int typestr="volume"
137         default="80"
138         optional
139
140 section "fade options"
141 ######################
142
143 option "fade_vol" f
144 #~~~~~~~~~~~~~~~~~~
145  "volume to fade to"
146         int typestr="volume"
147         default="50"
148         optional
149
150 option "fade_time" t
151 #~~~~~~~~~~~~~~~~~~~
152  "time to fade in"
153         int typestr="seconds"
154         default="5"
155         optional