paraslash 0.7.3

[paraslash.git] / m4 / lls / mixer.suite.m4

diff --git a/m4/lls/mixer.suite.m4 b/m4/lls/mixer.suite.m4
index 83d6ad955771c9f4a9bd0ccc567e0156e2f8da0e..e366a201569e538bc374f5356bf3d1c957164955 100644 (file)
--- a/m4/lls/mixer.suite.m4
+++ b/m4/lls/mixer.suite.m4
@@ -62,6 +62,25 @@ caption = List of subcommands
                        'reclev', 'igain', 'ogain'. However, not all listed channels might be
                        supported on any particular hardware. The default channel is 'volume'.
                [/help]
+       [option fade-exponent]
+               summary = set non-linear time scale for fading
+               arg_info = required_arg
+               arg_type = uint32
+               typestr = value
+               default_val = 0
+               [help]
+                       This option affects the fade, snooze and sleep subcommands. It is
+                       ignored in set mode.
+
+                       The argument must be a number between 0 and 100. The default value
+                       0 corresponds to linear scaling. That is, the value of the mixer
+                       channel is increased or decreased in fixed time intervals until the
+                       destination value is reached. Exponents between 1 and 99 cause low
+                       channel values to be increased more quickly than high channel values.
+                       Large exponents cause greater differences. The special value 100 sets
+                       the destination value immediately. The command then sleeps for the
+                       configured fade time.
+               [/help]
 [subcommand help]
        purpose = print subcommand help
        non-opts-name = [<subcommand>]
@@ -128,11 +147,10 @@ caption = List of subcommands
 [subcommand sleep]
        purpose = stream, fade out, sleep, fade in
        [description]
-               Change to the initial volume and select the initial mood/playlist.
-               Fade out to the given fade-out volume in the specified time. Switch
-               to the sleep mood/playlist and wait until wake time minus fade-in
-               time. Finally, switch to the wake mood/playlist and fade in to the
-               fade-in volume.
+               Set the initial volume and mood, start playing and sleep. Then switch
+               to the fade-out mood and fade to the fade-out volume. Next, switch to
+               the sleep mood and wait until wake time minus fade-in time. Finally,
+               switch to the wake mood and fade in to the fade-in volume.
        [/description]
        [option ivol]
                summary = set initial volume
@@ -146,12 +164,31 @@ caption = List of subcommands
                        channel part may be omitted, in which case the default channel is
                        used. This option may be given multiple times.
                [/help]
+       [option initial-mood]
+               summary = mood or playlist to start with
+               arg_info = required_arg
+               arg_type = string
+               typestr = mood_spec
+               [help]
+                       This mood or playlist is selected right after setting the initial
+                       volume and before fade-out starts. If unset, fade-out starts
+                       immediately.
+               [/help]
+       [option initial-delay]
+               summary = time before fade-out starts.
+               arg_info = required_arg
+               arg_type = uint32
+               typestr = seconds
+               default_val = 0
+               [help]
+                       If left at the default, no initial delay occurs even if an initial
+                       mood is given.
+               [/help]
        [option fo-mood]
                summary = mood or playlist for fade-out
                arg_info = required_arg
                arg_type = string
                typestr = mood_spec
-               default_val = m/fade
                [help]
                        This mood (or playlist) is selected right after setting the initial
                        volume.
@@ -176,32 +213,27 @@ caption = List of subcommands
                arg_info = required_arg
                arg_type = string
                typestr = mood_spec
-               default_val = m/sleep
                [help]
                        Select the given mood or playlist after the fade-out. If unset,
                        playback is stopped until fade-in starts.
                [/help]
-       [option wake-hour]
-               short_opt = H
-               summary = A number between 0 and 23
+       [option wake-time]
+               short_opt = w
+               summary = when to start fade in
                arg_info = required_arg
-               arg_type = uint32
-               typestr = hour
+               arg_type = string
+               typestr = [+][HH][:MM]
+               default_val = +9:00
                [help]
-                       If this is not given, the default is computed as now + 9 hours.
+                       If the optional plus character is given, the wake time is computed as
+                       now + HH hours + MM minutes. Otherwise the HH:MM argument is considered
+                       an absolute time (referring to either the current or the next day).
                [/help]
-       [option wake-min]
-               short_opt = M
-               summary = A number between 0 and 59
-               arg_info = required_arg
-               arg_type = uint32
-               typestr = minutes
        [option fi-mood]
                summary = mood or playlist for fade-in
                arg_info = required_arg
                arg_type = string
                typestr = mood_spec
-               default_val = m/wake
                [help]
                        This mood or playlist is selected right before fade-in begins.
                [/help]