m4/gengetopt/fade.m4

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