para_fade: Add description of the three modes of operation.

[paraslash.git] / fade.ggo

diff --git a/fade.ggo b/fade.ggo
index f467c1996ac9cfd68487a475cc67e34a8819a6b0..388642e5c60a8f6936cd383445ea34bac67967af 100644 (file)
--- a/fade.ggo
+++ b/fade.ggo
@@ -3,10 +3,22 @@ section "general options"
 
 option "mode" o
 #~~~~~~~~~~~~~~
 
 option "mode" o
 #~~~~~~~~~~~~~~

-

 "{sleep|fade|snooze}"
 "{sleep|fade|snooze}"

-       string default="sleep"
-       optional
+string default="sleep"
+optional
+details="
+       para_fade knows these three different 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.
+
+       fade: Fade the volume to the given value in the given time.
+
+       snooze: Fade out, sleep a bit and fade in.
+"

 
 option "config_file" c
 #~~~~~~~~~~~~~~~~~~~~~
 
 option "config_file" c
 #~~~~~~~~~~~~~~~~~~~~~


@@ -26,27 +38,34 @@ section "sleep options (only relevant in sleep mode)"
 
 option "sleep_ivol" -
 #~~~~~~~~~~~~~~~~~~~~
 
 option "sleep_ivol" -
 #~~~~~~~~~~~~~~~~~~~~

- "set initial volume before doing anything else"
-       int typestr="volume"
-       default="60"
-       optional
-
-option "fa_stream" -
-#~~~~~~~~~~~~~~~~~~~
- "fall asleep stream. Change to this stream
-right after setting the volume"
-
-       string typestr="streamname"
-       default="fa"
-       optional
+"set initial volume"
+int typestr="volume"
+default="60"
+optional
+details="
+       Used as the start volume, before fading out to the fade out volume.
+"
+
+option "fa_mode" -
+#~~~~~~~~~~~~~~~~~
+"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
+"

 
 option "fa_fade" -
 #~~~~~~~~~~~~~~~~~
 
 option "fa_fade" -
 #~~~~~~~~~~~~~~~~~

- "fall asleep fading time, no fading if set
-to 0"
-       int typestr="seconds"
-       default="1800"
-       optional
+ "fall asleep fading time"
+int typestr="seconds"
+default="1800"
+optional
+details="
+       No fading if set to 0.
+"

 
 option "fa_vol" -
 #~~~~~~~~~~~~~~~~
 
 option "fa_vol" -
 #~~~~~~~~~~~~~~~~


@@ -55,34 +74,39 @@ option "fa_vol" -
        default="20"
        optional
 
        default="20"
        optional
 

-option "sleep_stream" -
+option "sleep_mode" -

 #~~~~~~~~~~~~~~~~~~~~~~
 #~~~~~~~~~~~~~~~~~~~~~~

- "change to this stream after fading, stop
-playing if unset"
-       string typestr="streamname"
-       default="sleep"
-       optional
+"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 "wake_hour" H
 #~~~~~~~~~~~~~~~~~~~
 
 option "wake_hour" H
 #~~~~~~~~~~~~~~~~~~~

- "(0-23)"
+ "(0-23) (default: now + 9 hours)"

        int typestr="hour"
        int typestr="hour"

-       default="8"

        optional
 
 option "wake_min" M
 #~~~~~~~~~~~~~~~~~~
 "(0-59)"
        optional
 
 option "wake_min" M
 #~~~~~~~~~~~~~~~~~~
 "(0-59)"

-       int typestr="seconds"
+       int typestr="minutes"

        default="0"
        optional
 
        default="0"
        optional
 

-option "wake_stream" -
-#~~~~~~~~~~~~~~~~~~~~~
- "change to this stream on waketime"
-       string typestr="streamname"
-       default="wake"
-       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 "wake_fade" -
 #~~~~~~~~~~~~~~~~~~~
 
 option "wake_fade" -
 #~~~~~~~~~~~~~~~~~~~