X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=m4%2Fgengetopt%2Ffade.m4;h=59389ffefb5105ee8af56e4d7b844377c9d5d9c7;hp=e5d08bf00e45b7f17e7b5e8cc6d9a928d071fd50;hb=42ddd68159d7eff0f3e7c225665c97f9abd59425;hpb=46af7dd81149caee0409535d5d9884ed9fa5af0e

diff --git a/m4/gengetopt/fade.m4 b/m4/gengetopt/fade.m4
index e5d08bf0..59389ffe 100644
--- a/m4/gengetopt/fade.m4
+++ b/m4/gengetopt/fade.m4
@@ -1,17 +1,27 @@
-args "--conf-parser --no-handle-version"
+args "--conf-parser --no-handle-version --no-handle-help"
 
+purpose "An alarm clock and volume-fader for OSS and ALSA"
+
+include(header.m4)
+define(CURRENT_PROGRAM,para_fade)
+define(DEFAULT_CONFIG_FILE,~/.paraslash/fade.conf)
+<qu>
 section "General options"
 #########################
 
+</qu>
+include(config_file.m4)
+include(loglevel.m4)
+<qu>
 option "mode" o
 #~~~~~~~~~~~~~~
 "how to fade volume"
 	enum typestr = "mode"
-	values = "sleep", "snooze", "fade"
+	values = "sleep", "fade", "set", "snooze"
 	default = "sleep"
 	optional
 	details="
-		para_fade knows three different fading modes:
+		para_fade knows the following modes:
 
 		sleep mode: Change to the initial volume and select
 		the initial afs mood/playlist. Then fade out until
@@ -23,14 +33,22 @@ option "mode" o
 		fade: Fade the volume to the given value in the
 		given time.
 
+		set: Just set the value and exit.
+
 		snooze: Fade out, sleep a bit and fade in.
 "
 
-option "config-file" c
-#~~~~~~~~~~~~~~~~~~~~~
-"(default='~/.paraslash/fade.conf')"
-	string typestr = "filename"
+option "mixer-api" a
+#~~~~~~~~~~~~~~~~~~~
+"choose the mixer API"
+	string typestr = "api"
 	optional
+	details = "
+		ALSA is preferred over OSS if both APIs are supported
+		and this option is not given. To see the supported
+		mixer APIs, use this option with an invalid string
+		as the mixer API, e.g. --mixer-api help.
+	"
 
 option "mixer-device" m
 #~~~~~~~~~~~~~~~~~~~~~~
@@ -38,8 +56,10 @@ option "mixer-device" m
 	string typestr = "device"
 	optional
 	details = "
-		If this option is not given '/dev/mixer' is used as
-		the default.
+		The default device (used if this option is not given)
+		depends on the selected mixer API. For ALSA, the
+		default is 'hw:0' which corresponds to the first sound
+		device. For OSS, '/dev/mixer' is used as the default.
 	"
 
 option "mixer-channel" C
@@ -48,11 +68,18 @@ option "mixer-channel" C
 	string typestr = "channel"
 	optional
 	details = "
-		The possible values are 'volume', 'bass', 'treble',
-		'synth', 'pcm', 'speaker', 'line', 'mic', 'cd', 'imix',
-		'altpcm', 'reclev', 'igain', 'ogain'. However, not all
-		listed channels might be supported on any particular
-		hardware. The default mixer channel is 'volume'.
+		For the ALSA mixer API, the possible values are
+		determined at runtime depending on the hardware and
+		can be printed by specifying an invalid mixer channel,
+		for example --mixer-channel help. The default channel
+		is 'Master'.
+
+		For OSS the possible values are invariably 'volume',
+		'bass', 'treble', 'synth', 'pcm', 'speaker', 'line',
+		'mic', 'cd', 'imix', 'altpcm', 'reclev', 'igain',
+		'ogain'. However, not all listed channels might be
+		supported on any particular hardware. The default
+		channel is 'volume'.
 	"
 
 section "Options for sleep mode"
@@ -61,12 +88,15 @@ section "Options for sleep mode"
 option "ivol" -
 #~~~~~~~~~~~~~~
 "set initial volume"
-	int typestr = "volume"
+	string typestr = "[channel:]volume"
 	default = "60"
 	optional
+	multiple
 	details = "
 		Used as the start volume, before fading out to the
-		fade out volume.
+		fade out volume. The channel part may be omitted, in
+		which case the default channel is used. This option
+		may be given multiple times.
 	"
 
 option "fo-mood" -
@@ -203,3 +233,14 @@ option "fade-time" t
 	int typestr = "seconds"
 	default = "5"
 	optional
+
+section "Options for set mode"
+##############################
+
+option "val" -
+"value to set"
+	int typestr = "value"
+	default = "0"
+	optional
+
+</qu>