m4/lls/mixer.suite.m4

   1 m4_define(PROGRAM, para_mixer)
   2 m4_define(DEFAULT_CONFIG_FILE, ~/.paraslash/mixer.conf)
   3 [suite mixer]
   4 version-string = GIT_VERSION()
   5 caption = List of subcommands
   6 [supercommand para_mixer]
   7         purpose = alarm clock and volume-fader for OSS and ALSA
   8         synopsis = [<options>] -- [<subcommand>] [<subcommand_options>]
   9         [description]
  10                 para_mixer adjusts the settings of an audio mixing device. It can
  11                 set the level of a mixer channel, or fade the level from one value
  12                 to another in a given time period. The sleep and snooze subcommands
  13                 contact para_server to start or stop streaming.
  14         [/description]
  15         m4_include(common-option-section.m4)
  16         m4_include(help.m4)
  17         m4_include(detailed-help.m4)
  18         m4_include(version.m4)
  19         m4_include(config-file.m4)
  20         m4_include(loglevel.m4)
  21         m4_include(per-command-options-section.m4)
  22         [help]
  23                 These options apply to several subcommands.
  24         [/help]
  25         [option mixer-api]
  26                 short_opt = a
  27                 summary = select alternative mixer API
  28                 arg_info = required_arg
  29                 arg_type = string
  30                 typestr = api
  31                 [help]
  32                         ALSA is preferred over OSS if both APIs are supported and this option
  33                         is not given. To see the supported mixer APIs, use this option with
  34                         an invalid string as the mixer API, e.g. --mixer-api help.
  35                 [/help]
  36         [option mixer-device]
  37                 short_opt = m
  38                 summary = set mixer device
  39                 arg_info = required_arg
  40                 arg_type = string
  41                 typestr = device
  42                 [help]
  43                         The default device (used if this option is not given) depends
  44                         on the selected mixer API. For ALSA, the default is 'hw:0' which
  45                         corresponds to the first sound device. For OSS, '/dev/mixer' is used
  46                         as the default.
  47                 [/help]
  48         [option mixer-channel]
  49                 short_opt = C
  50                 summary = select a mixer channel
  51                 arg_info = required_arg
  52                 arg_type = string
  53                 typestr = channel
  54                 [help]
  55                         For the ALSA mixer API, the possible values are determined at runtime
  56                         depending on the hardware and can be printed by specifying an invalid
  57                         mixer channel, for example --mixer-channel help. The default channel is
  58                         'Master'.
  59
  60                         For OSS the possible values are invariably 'volume', 'bass', 'treble',
  61                         'synth', 'pcm', 'speaker', 'line', 'mic', 'cd', 'imix', 'altpcm',
  62                         'reclev', 'igain', 'ogain'. However, not all listed channels might be
  63                         supported on any particular hardware. The default channel is 'volume'.
  64                 [/help]
  65 [subcommand help]
  66         purpose = print subcommand help
  67         non-opts-name = [<subcommand>]
  68         [option long]
  69                 summary = print the long help text
  70                 short_opt = l
  71
  72 [subcommand set]
  73         purpose = set a channel to the given value and exit
  74         [option val]
  75                 summary = mixer channel value to set
  76                 arg_info = required_arg
  77                 arg_type = uint32
  78                 typestr = value
  79                 default_val = 10
  80 [subcommand fade]
  81         purpose = fade a channel to the given value in the given time
  82         [option fade-vol]
  83                 short_opt = f
  84                 summary = destination volume for fading
  85                 arg_info = required_arg
  86                 arg_type = uint32
  87                 typestr = volume
  88                 default_val = 50
  89         [option fade-time]
  90                 short_opt = t
  91                 summary = duration of fade period
  92                 arg_info = required_arg
  93                 arg_type = uint32
  94                 typestr = seconds
  95                 default_val = 5
  96 [subcommand snooze]
  97         purpose = fade out, pause, sleep, play, fade in
  98         [option so-time]
  99                 summary = duration of fade-out period
 100                 arg_info = required_arg
 101                 arg_type = uint32
 102                 typestr = seconds
 103                 default_val = 30
 104         [option so-vol]
 105                 summary = destination volume for fade-out
 106                 arg_info = required_arg
 107                 arg_type = uint32
 108                 typestr = volume
 109                 default_val = 20
 110         [option snooze-time]
 111                 summary = delay between end of fade-out and begin of fade-in
 112                 arg_info = required_arg
 113                 arg_type = uint32
 114                 typestr = seconds
 115                 default_val = 600
 116         [option si-time]
 117                 summary = duration of fade-in period
 118                 arg_info = required_arg
 119                 arg_type = uint32
 120                 typestr = seconds
 121                 default_val = 180
 122         [option si-vol]
 123                 summary = destination volume for fade-in
 124                 arg_info = required_arg
 125                 arg_type = uint32
 126                 typestr = volume
 127                 default_val = 80
 128 [subcommand sleep]
 129         purpose = stream, fade out, sleep, fade in
 130         [description]
 131                 Change to the initial volume and select the initial mood/playlist.
 132                 Fade out to the given fade-out volume in the specified time. Switch
 133                 to the sleep mood/playlist and wait until wake time minus fade-in
 134                 time. Finally, switch to the wake mood/playlist and fade in to the
 135                 fade-in volume.
 136         [/description]
 137         [option ivol]
 138                 summary = set initial volume
 139                 arg_info = required_arg
 140                 arg_type = string
 141                 default_val = 60
 142                 flag multiple
 143                 typestr = [channel:]volume
 144                 [help]
 145                         Used as the start volume, before fading out to the fade-out volume. The
 146                         channel part may be omitted, in which case the default channel is
 147                         used. This option may be given multiple times.
 148                 [/help]
 149         [option fo-mood]
 150                 summary = mood or playlist for fade-out
 151                 arg_info = required_arg
 152                 arg_type = string
 153                 typestr = mood_spec
 154                 default_val = m/fade
 155                 [help]
 156                         This mood (or playlist) is selected right after setting the initial
 157                         volume.
 158                 [/help]
 159         [option fo-time]
 160                 summary = duration of fade-out period
 161                 arg_info = required_arg
 162                 arg_type = uint32
 163                 typestr = seconds
 164                 default_val = 1800
 165                 [help]
 166                         No fading if this is set to 0.
 167                 [/help]
 168         [option fo-vol]
 169                 summary = destination volume for fade-out
 170                 arg_info = required_arg
 171                 arg_type = uint32
 172                 typestr = volume
 173                 default_val = 20
 174         [option sleep-mood]
 175                 summary = mood/playlist between fade-out and fade-in
 176                 arg_info = required_arg
 177                 arg_type = string
 178                 typestr = mood_spec
 179                 default_val = m/sleep
 180                 [help]
 181                         Select the given mood or playlist after the fade-out. If unset,
 182                         playback is stopped until fade-in starts.
 183                 [/help]
 184         [option wake-hour]
 185                 short_opt = H
 186                 summary = A number between 0 and 23
 187                 arg_info = required_arg
 188                 arg_type = uint32
 189                 typestr = hour
 190                 [help]
 191                         If this is not given, the default is computed as now + 9 hours.
 192                 [/help]
 193         [option wake-min]
 194                 short_opt = M
 195                 summary = A number between 0 and 59
 196                 arg_info = required_arg
 197                 arg_type = uint32
 198                 typestr = minutes
 199         [option fi-mood]
 200                 summary = mood or playlist for fade-in
 201                 arg_info = required_arg
 202                 arg_type = string
 203                 typestr = mood_spec
 204                 default_val = m/wake
 205                 [help]
 206                         This mood or playlist is selected right before fade-in begins.
 207                 [/help]
 208         [option fi-time]
 209                 summary = duration of fade-in period
 210                 arg_info = required_arg
 211                 arg_type = uint32
 212                 typestr = seconds
 213                 default_val = 1200
 214                 [help]
 215                         No fading if this is set to 0.
 216                 [/help]
 217         [option fi-vol]
 218                 summary = destination volume for fade-in
 219                 arg_info = required_arg
 220                 arg_type = uint32
 221                 typestr = volume
 222                 default_val = 80