write: Add --buffer-tree option.
[paraslash.git] / ggo / fade.ggo
index 01eb6aa..80f8b73 100644 (file)
-section "general options"
+section "General options"
 #########################
 
 option "mode" o
 #~~~~~~~~~~~~~~
 #########################
 
 option "mode" o
 #~~~~~~~~~~~~~~
-"{sleep|fade|snooze}"
-string default="sleep"
-optional
-details="
-       para_fade knows these three different modes.
+"how to fade volume"
+       enum typestr = "mode"
+       values = "sleep", "snooze", "fade"
+       default = "sleep"
+       optional
+       details="
+               para_fade knows three different fading modes:
 
 
-       sleep mode: Change to the initial volume and an initial afs
-       mode, then fade the volume down until the fade out volume is
-       reached. Switch to the afs sleep mode until the wake time is
-       reached. Then switch to the afs wake mode and and fade in to
-       the wake volume.
+               sleep mode: Change to the initial volume and select
+               the initial afs mood/playlist. Then fade out until
+               the fade-out volume is reached. Switch to the
+               sleep mood/playlist until wake time minus fade-in
+               time. Finally switch to the wake mood/playlist and
+               fade to the fade-in volume.
 
 
-       fade: Fade the volume to the given value in the given time.
+               fade: Fade the volume to the given value in the
+               given time.
 
 
-       snooze: Fade out, sleep a bit and fade in.
+               snooze: Fade out, sleep a bit and fade in.
 "
 
 "
 
-option "config_file" c
+option "config-file" c
 #~~~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~~~
- "(default='~/.paraslash/fade.conf')"
-       string typestr="filename"
+"(default='~/.paraslash/fade.conf')"
+       string typestr = "filename"
        optional
 
        optional
 
-option "mixer_device" m
+option "mixer-device" m
 #~~~~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~~~~
- "mixer device file"
-       string typestr="device"
-       default="/dev/mixer"
+"mixer device file"
+       string typestr = "device"
+       default = "/dev/mixer"
        optional
 
        optional
 
-option "mixer_channel" C
+option "mixer-channel" C
 #~~~~~~~~~~~~~~~~~~~~~~~
 "select the analog mixer channel"
 #~~~~~~~~~~~~~~~~~~~~~~~
 "select the analog mixer channel"
-       enum typestr="channel"
-       values="volume", "bass", "treble", "synth", "pcm", "speaker", "line",
+       enum typestr = "channel"
+       values = "volume", "bass", "treble", "synth", "pcm", "speaker", "line",
                "mic", "cd", "imix", "altpcm", "reclev", "igain", "ogain"
                "mic", "cd", "imix", "altpcm", "reclev", "igain", "ogain"
-       default="volume"
+       default = "volume"
        optional
        optional
-       details="
-       Not all listed channels might be supported on any particular hardware.
+       details = "
+               Not all listed channels might be supported on any
+               particular hardware.
 "
 
 "
 
-section "sleep options (only relevant in sleep mode)"
-#####################################################
+section "Options for sleep mode"
+################################
 
 
-option "sleep_ivol" -
-#~~~~~~~~~~~~~~~~~~~~
+option "ivol" -
+#~~~~~~~~~~~~~~
 "set initial volume"
 "set initial volume"
-int typestr="volume"
-default="60"
-optional
-details="
-       Used as the start volume, before fading out to the fade out volume.
-"
+       int typestr = "volume"
+       default = "60"
+       optional
+       details = "
+               Used as the start volume, before fading out to the
+               fade out volume.
+       "
 
 
-option "fa_mode" -
+option "fo-mood" -
 #~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~
-"fall asleep afs mode."
-string typestr="afs_mode"
-default="m/fade"
-optional
-details="
-       Select this mode right after setting the volume. Example:
-       --fa_mode m/sleep
+"afs mood/playlist during fade out"
+       string typestr = "mood_spec"
+       default = "m/fade"
+       optional
+       details = "
+               Select this mood right after setting the
+               volume. Example: --fo-mood m/sleep
 "
 
 "
 
-option "fa_fade" -
+option "fo-time" -
 #~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~
- "fall asleep fading time"
-int typestr="seconds"
-default="1800"
-optional
-details="
-       No fading if set to 0.
-"
+"fall asleep fade out time"
+       int typestr = "seconds"
+       default = "1800"
+       optional
+       details = "
+               No fading if set to 0.
+       "
 
 
-option "fa_vol" -
+option "fo-vol" -
 #~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~
- "volume to fade to"
-       int typestr="volume"
-       default="20"
+"volume to fade out to"
+       int typestr = "volume"
+       default = "20"
        optional
 
        optional
 
-option "sleep_mode" -
-#~~~~~~~~~~~~~~~~~~~~~~
-"sleep time afs mode"
-details = "
-       Select the given afs mode after the fade out is complete. If
-       unset, the \"stop\" command is sent to para_server.
-"
-string typestr="afs_mode"
-default="m/sleep"
-optional
+option "sleep-mood" -
+#~~~~~~~~~~~~~~~~~~~~
+"sleep time afs mood/playlist"
+       string typestr = "mood_spec"
+       default = "m/sleep"
+       optional
+       details = "
+               Select the given afs mood/playlist after the fade
+               out is complete. If unset, the \"stop\" command is
+               sent to para_server.
+       "
 
 
-option "wake_hour" H
+option "wake-hour" H
 #~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~
- "(0-23) (default: now + 9 hours)"
-       int typestr="hour"
+"(0-23) (default: now + 9 hours)"
+       int typestr = "hour"
        optional
 
        optional
 
-option "wake_min" M
+option "wake-min" M
 #~~~~~~~~~~~~~~~~~~
 "(0-59)"
 #~~~~~~~~~~~~~~~~~~
 "(0-59)"
-       int typestr="minutes"
-       default="0"
+       int typestr = "minutes"
+       default = "0"
        optional
 
        optional
 
-option "wake_mode" -
-#~~~~~~~~~~~~~~~~~~~
-"wake time afs mode"
-string typestr="afs_mode"
-default="m/wake"
-optional
-details="
-       Change to this afs mode on waketime.
-"
+option "fi-mood" -
+#~~~~~~~~~~~~~~~~~
+"afs mood/playlist during fade in"
+       string typestr = "mood_spec"
+       default = "m/wake"
+       optional
+       details = "
+               Change to this afs mood/playlist on wake time.
+       "
 
 
-option "wake_fade" -
-#~~~~~~~~~~~~~~~~~~~
- "no fading in if set to 0"
+option "fi-time" -
+#~~~~~~~~~~~~~~~~~
+"wake up fade in time"
        int typestr="seconds"
        default="1200"
        optional
        int typestr="seconds"
        default="1200"
        optional
+       details = "
+               No fading in if set to 0.
+       "
 
 
-option "wake_vol" -
-#~~~~~~~~~~~~~~~~~~
- "vol to fade to at waketime"
-       int typestr="volume"
-       default="80"
+option "fi-vol" -
+#~~~~~~~~~~~~~~~~
+"volume to fade to at wake time"
+       int typestr = "volume"
+       default = "80"
        optional
 
        optional
 
-section "snooze options"
-########################
+section "Options for snooze mode"
+#################################
 
 
-option "snooze_out_fade" -
-#~~~~~~~~~~~~~~~~~~~~~~~~~
- "fade out time"
-       int typestr="seconds"
-       default="30"
+option "so-time" -
+#~~~~~~~~~~~~~~~~~
+"snooze-out time"
+       int typestr = "seconds"
+       default = "30"
        optional
 
        optional
 
-option "snooze_out_vol" -
-#~~~~~~~~~~~~~~~~~~~~~~~~
- "vol to fade to before snooze"
-       int typestr="volume"
-       default="20"
+option "so-vol" -
+#~~~~~~~~~~~~~~~~
+"volume to fade to before snooze"
+       int typestr = "volume"
+       default = "20"
        optional
 
        optional
 
-option "snooze_time" -
+option "snooze-time" -
 #~~~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~~~
- "delay"
-       int typestr="seconds"
-       default="600"
+"delay"
+       int typestr = "seconds"
+       default = "600"
        optional
 
        optional
 
-option "snooze_in_fade" -
-#~~~~~~~~~~~~~~~~~~~~~~~~
- "fade in time"
-       int typestr="seconds"
-       default="180"
+option "si-time" -
+#~~~~~~~~~~~~~~~~~
+"snooze-in time"
+       int typestr = "seconds"
+       default = "180"
        optional
 
        optional
 
-option "snooze_in_vol" -
-#~~~~~~~~~~~~~~~~~~~~~~~
- "vol to fade to after snooze"
-       int typestr="volume"
-       default="80"
+option "si-vol" -
+#~~~~~~~~~~~~~~~~
+"volume to fade to after snooze"
+       int typestr = "volume"
+       default = "80"
        optional
 
        optional
 
-section "fade options"
-######################
+section "Options for fade mode"
+###############################
 
 
-option "fade_vol" f
+option "fade-vol" f
 #~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~
- "volume to fade to"
-       int typestr="volume"
-       default="50"
+"volume to fade to"
+       int typestr = "volume"
+       default = "50"
        optional
 
        optional
 
-option "fade_time" t
+option "fade-time" t
 #~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~
- "time to fade in"
-       int typestr="seconds"
-       default="5"
+"fading time"
+       int typestr = "seconds"
+       default = "5"
        optional
        optional