m4/gengetopt/fade.m4

   1 args "--conf-parser --no-handle-version"
   2
   3 include(header.m4)
   4 define(CURRENT_PROGRAM,para_fade)
   5 define(DEFAULT_CONFIG_FILE,~/.paraslash/fade.conf)
   6 <qu>
   7 section "General options"
   8 #########################
   9
  10 </qu>
  11 include(config_file.m4)
  12 include(loglevel.m4)
  13 <qu>
  14 option "mode" o
  15 #~~~~~~~~~~~~~~
  16 "how to fade volume"
  17         enum typestr = "mode"
  18         values = "sleep", "snooze", "fade"
  19         default = "sleep"
  20         optional
  21         details="
  22                 para_fade knows three different fading modes:
  23
  24                 sleep mode: Change to the initial volume and select
  25                 the initial afs mood/playlist. Then fade out until
  26                 the fade-out volume is reached. Switch to the
  27                 sleep mood/playlist until wake time minus fade-in
  28                 time. Finally switch to the wake mood/playlist and
  29                 fade to the fade-in volume.
  30
  31                 fade: Fade the volume to the given value in the
  32                 given time.
  33
  34                 snooze: Fade out, sleep a bit and fade in.
  35 "
  36
  37 option "mixer-api" a
  38 #~~~~~~~~~~~~~~~~~~~
  39 "choose the mixer API"
  40         string typestr = "api"
  41         optional
  42         details = "
  43                 ALSA is preferred over OSS if both APIs are supported
  44                 and this option is not given. To see the supported
  45                 mixer APIs, use this option with an invalid string
  46                 as the mixer API, e.g. --mixer-api help.
  47         "
  48
  49 option "mixer-device" m
  50 #~~~~~~~~~~~~~~~~~~~~~~
  51 "choose mixer device"
  52         string typestr = "device"
  53         optional
  54         details = "
  55                 The default device (used if this option is not given)
  56                 depends on the selected mixer API. For ALSA, the
  57                 default is 'hw:0' which corresponds to the first sound
  58                 device. For OSS, '/dev/mixer' is used as the default.
  59         "
  60
  61 option "mixer-channel" C
  62 #~~~~~~~~~~~~~~~~~~~~~~~
  63 "select the analog mixer channel"
  64         string typestr = "channel"
  65         optional
  66         details = "
  67                 For the ALSA mixer API, the possible values are
  68                 determined at runtime depending on the hardware and
  69                 can be printed by specifying an invalid mixer channel,
  70                 for example --mixer-channel help. The default channel
  71                 is 'Master'.
  72
  73                 For OSS the possible values are invariably 'volume',
  74                 'bass', 'treble', 'synth', 'pcm', 'speaker', 'line',
  75                 'mic', 'cd', 'imix', 'altpcm', 'reclev', 'igain',
  76                 'ogain'. However, not all listed channels might be
  77                 supported on any particular hardware. The default
  78                 channel is 'volume'.
  79         "
  80
  81 section "Options for sleep mode"
  82 ################################
  83
  84 option "ivol" -
  85 #~~~~~~~~~~~~~~
  86 "set initial volume"
  87         int typestr = "volume"
  88         default = "60"
  89         optional
  90         details = "
  91                 Used as the start volume, before fading out to the
  92                 fade out volume.
  93         "
  94
  95 option "fo-mood" -
  96 #~~~~~~~~~~~~~~~~~
  97 "afs mood/playlist during fade out"
  98         string typestr = "mood_spec"
  99         default = "m/fade"
 100         optional
 101         details = "
 102                 Select this mood right after setting the
 103                 volume. Example: --fo-mood m/sleep
 104 "
 105
 106 option "fo-time" -
 107 #~~~~~~~~~~~~~~~~~
 108 "fall asleep fade out time"
 109         int typestr = "seconds"
 110         default = "1800"
 111         optional
 112         details = "
 113                 No fading if set to 0.
 114         "
 115
 116 option "fo-vol" -
 117 #~~~~~~~~~~~~~~~~
 118 "volume to fade out to"
 119         int typestr = "volume"
 120         default = "20"
 121         optional
 122
 123 option "sleep-mood" -
 124 #~~~~~~~~~~~~~~~~~~~~
 125 "sleep time afs mood/playlist"
 126         string typestr = "mood_spec"
 127         default = "m/sleep"
 128         optional
 129         details = "
 130                 Select the given afs mood/playlist after the fade
 131                 out is complete. If unset, the \"stop\" command is
 132                 sent to para_server.
 133         "
 134
 135 option "wake-hour" H
 136 #~~~~~~~~~~~~~~~~~~~
 137 "(0-23) (default: now + 9 hours)"
 138         int typestr = "hour"
 139         optional
 140
 141 option "wake-min" M
 142 #~~~~~~~~~~~~~~~~~~
 143 "(0-59)"
 144         int typestr = "minutes"
 145         default = "0"
 146         optional
 147
 148 option "fi-mood" -
 149 #~~~~~~~~~~~~~~~~~
 150 "afs mood/playlist during fade in"
 151         string typestr = "mood_spec"
 152         default = "m/wake"
 153         optional
 154         details = "
 155                 Change to this afs mood/playlist on wake time.
 156         "
 157
 158 option "fi-time" -
 159 #~~~~~~~~~~~~~~~~~
 160 "wake up fade in time"
 161         int typestr="seconds"
 162         default="1200"
 163         optional
 164         details = "
 165                 No fading in if set to 0.
 166         "
 167
 168 option "fi-vol" -
 169 #~~~~~~~~~~~~~~~~
 170 "volume to fade to at wake time"
 171         int typestr = "volume"
 172         default = "80"
 173         optional
 174
 175 section "Options for snooze mode"
 176 #################################
 177
 178 option "so-time" -
 179 #~~~~~~~~~~~~~~~~~
 180 "snooze-out time"
 181         int typestr = "seconds"
 182         default = "30"
 183         optional
 184
 185 option "so-vol" -
 186 #~~~~~~~~~~~~~~~~
 187 "volume to fade to before snooze"
 188         int typestr = "volume"
 189         default = "20"
 190         optional
 191
 192 option "snooze-time" -
 193 #~~~~~~~~~~~~~~~~~~~~~
 194 "delay"
 195         int typestr = "seconds"
 196         default = "600"
 197         optional
 198
 199 option "si-time" -
 200 #~~~~~~~~~~~~~~~~~
 201 "snooze-in time"
 202         int typestr = "seconds"
 203         default = "180"
 204         optional
 205
 206 option "si-vol" -
 207 #~~~~~~~~~~~~~~~~
 208 "volume to fade to after snooze"
 209         int typestr = "volume"
 210         default = "80"
 211         optional
 212
 213 section "Options for fade mode"
 214 ###############################
 215
 216 option "fade-vol" f
 217 #~~~~~~~~~~~~~~~~~~
 218 "volume to fade to"
 219         int typestr = "volume"
 220         default = "50"
 221         optional
 222
 223 option "fade-time" t
 224 #~~~~~~~~~~~~~~~~~~~
 225 "fading time"
 226         int typestr = "seconds"
 227         default = "5"
 228         optional
 229 </qu>