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 "mixer device file"
  38         string typestr = "device"
  39         default = "/dev/mixer"
  40         optional
  41
  42 option "mixer-channel" C
  43 #~~~~~~~~~~~~~~~~~~~~~~~
  44 "select the analog mixer channel"
  45         enum typestr = "channel"
  46         values = "volume", "bass", "treble", "synth", "pcm", "speaker", "line",
  47                 "mic", "cd", "imix", "altpcm", "reclev", "igain", "ogain"
  48         default = "volume"
  49         optional
  50         details = "
  51                 Not all listed channels might be supported on any
  52                 particular hardware.
  53 "
  54
  55 section "Options for sleep mode"
  56 ################################
  57
  58 option "ivol" -
  59 #~~~~~~~~~~~~~~
  60 "set initial volume"
  61         int typestr = "volume"
  62         default = "60"
  63         optional
  64         details = "
  65                 Used as the start volume, before fading out to the
  66                 fade out volume.
  67         "
  68
  69 option "fo-mood" -
  70 #~~~~~~~~~~~~~~~~~
  71 "afs mood/playlist during fade out"
  72         string typestr = "mood_spec"
  73         default = "m/fade"
  74         optional
  75         details = "
  76                 Select this mood right after setting the
  77                 volume. Example: --fo-mood m/sleep
  78 "
  79
  80 option "fo-time" -
  81 #~~~~~~~~~~~~~~~~~
  82 "fall asleep fade out time"
  83         int typestr = "seconds"
  84         default = "1800"
  85         optional
  86         details = "
  87                 No fading if set to 0.
  88         "
  89
  90 option "fo-vol" -
  91 #~~~~~~~~~~~~~~~~
  92 "volume to fade out to"
  93         int typestr = "volume"
  94         default = "20"
  95         optional
  96
  97 option "sleep-mood" -
  98 #~~~~~~~~~~~~~~~~~~~~
  99 "sleep time afs mood/playlist"
 100         string typestr = "mood_spec"
 101         default = "m/sleep"
 102         optional
 103         details = "
 104                 Select the given afs mood/playlist after the fade
 105                 out is complete. If unset, the \"stop\" command is
 106                 sent to para_server.
 107         "
 108
 109 option "wake-hour" H
 110 #~~~~~~~~~~~~~~~~~~~
 111 "(0-23) (default: now + 9 hours)"
 112         int typestr = "hour"
 113         optional
 114
 115 option "wake-min" M
 116 #~~~~~~~~~~~~~~~~~~
 117 "(0-59)"
 118         int typestr = "minutes"
 119         default = "0"
 120         optional
 121
 122 option "fi-mood" -
 123 #~~~~~~~~~~~~~~~~~
 124 "afs mood/playlist during fade in"
 125         string typestr = "mood_spec"
 126         default = "m/wake"
 127         optional
 128         details = "
 129                 Change to this afs mood/playlist on wake time.
 130         "
 131
 132 option "fi-time" -
 133 #~~~~~~~~~~~~~~~~~
 134 "wake up fade in time"
 135         int typestr="seconds"
 136         default="1200"
 137         optional
 138         details = "
 139                 No fading in if set to 0.
 140         "
 141
 142 option "fi-vol" -
 143 #~~~~~~~~~~~~~~~~
 144 "volume to fade to at wake time"
 145         int typestr = "volume"
 146         default = "80"
 147         optional
 148
 149 section "Options for snooze mode"
 150 #################################
 151
 152 option "so-time" -
 153 #~~~~~~~~~~~~~~~~~
 154 "snooze-out time"
 155         int typestr = "seconds"
 156         default = "30"
 157         optional
 158
 159 option "so-vol" -
 160 #~~~~~~~~~~~~~~~~
 161 "volume to fade to before snooze"
 162         int typestr = "volume"
 163         default = "20"
 164         optional
 165
 166 option "snooze-time" -
 167 #~~~~~~~~~~~~~~~~~~~~~
 168 "delay"
 169         int typestr = "seconds"
 170         default = "600"
 171         optional
 172
 173 option "si-time" -
 174 #~~~~~~~~~~~~~~~~~
 175 "snooze-in time"
 176         int typestr = "seconds"
 177         default = "180"
 178         optional
 179
 180 option "si-vol" -
 181 #~~~~~~~~~~~~~~~~
 182 "volume to fade to after snooze"
 183         int typestr = "volume"
 184         default = "80"
 185         optional
 186
 187 section "Options for fade mode"
 188 ###############################
 189
 190 option "fade-vol" f
 191 #~~~~~~~~~~~~~~~~~~
 192 "volume to fade to"
 193         int typestr = "volume"
 194         default = "50"
 195         optional
 196
 197 option "fade-time" t
 198 #~~~~~~~~~~~~~~~~~~~
 199 "fading time"
 200         int typestr = "seconds"
 201         default = "5"
 202         optional