From d7efb5d95467c3ef3efbf9c0e4e6464f84368c7f Mon Sep 17 00:00:00 2001
From: Andre Noll <maan@systemlinux.org>
Date: Thu, 15 Jan 2009 05:20:51 +0100
Subject: [PATCH] para_fade: Add description of the three modes of operation.

Some other small improvements as well.
---
 fade.ggo | 81 ++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 52 insertions(+), 29 deletions(-)

diff --git a/fade.ggo b/fade.ggo
index 5965cba9..388642e5 100644
--- a/fade.ggo
+++ b/fade.ggo
@@ -3,10 +3,22 @@ section "general options"
 
 option "mode" o
 #~~~~~~~~~~~~~~
-
 "{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
 #~~~~~~~~~~~~~~~~~~~~~
@@ -26,29 +38,34 @@ section "sleep options (only relevant in sleep mode)"
 
 option "sleep_ivol" -
 #~~~~~~~~~~~~~~~~~~~~
- "set initial volume before doing anything else"
-	int typestr="volume"
-	default="60"
-	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. Select this mode
-right after setting the volume. Example:
+#~~~~~~~~~~~~~~~~~
+"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
 "
 
-	string typestr="afs_mode"
-	default="m/fade"
-	optional
-
 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" -
 #~~~~~~~~~~~~~~~~
@@ -59,11 +76,14 @@ option "fa_vol" -
 
 option "sleep_mode" -
 #~~~~~~~~~~~~~~~~~~~~~~
- "change to this afs mode after fading, stop
-playing if unset."
-	string typestr="afs_mode"
-	default="m/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
 #~~~~~~~~~~~~~~~~~~~
@@ -79,11 +99,14 @@ option "wake_min" M
 	optional
 
 option "wake_mode" -
-#~~~~~~~~~~~~~~~~~~~~~
- "change to this afs mode on waketime"
-	string typestr="afs_mode"
-	default="m/wake"
-	optional
+#~~~~~~~~~~~~~~~~~~~
+"wake time afs mode"
+string typestr="afs_mode"
+default="m/wake"
+optional
+details="
+	Change to this afs mode on waketime.
+"
 
 option "wake_fade" -
 #~~~~~~~~~~~~~~~~~~~
-- 
2.39.5