m4/lls/fade.suite.m4

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