ggo/fade.ggo

   1 section "general options"
   2 #########################
   3
   4 option "mode" o
   5 #~~~~~~~~~~~~~~
   6 "{sleep|fade|snooze}"
   7 string default="sleep"
   8 optional
   9 details="
  10         para_fade knows these three different modes.
  11
  12         sleep mode: Change to the initial volume and an initial afs
  13         mode, then fade the volume down until the fade out volume is
  14         reached. Switch to the afs sleep mode until the wake time is
  15         reached. Then switch to the afs wake mode and and fade in to
  16         the wake volume.
  17
  18         fade: Fade the volume to the given value in the given time.
  19
  20         snooze: Fade out, sleep a bit and fade in.
  21 "
  22
  23 option "config_file" c
  24 #~~~~~~~~~~~~~~~~~~~~~
  25  "(default='~/.paraslash/fade.conf')"
  26         string typestr="filename"
  27         optional
  28
  29 option "mixer_device" m
  30 #~~~~~~~~~~~~~~~~~~~~~~
  31  "mixer device file"
  32         string typestr="device"
  33         default="/dev/mixer"
  34         optional
  35
  36 section "sleep options (only relevant in sleep mode)"
  37 #####################################################
  38
  39 option "sleep_ivol" -
  40 #~~~~~~~~~~~~~~~~~~~~
  41 "set initial volume"
  42 int typestr="volume"
  43 default="60"
  44 optional
  45 details="
  46         Used as the start volume, before fading out to the fade out volume.
  47 "
  48
  49 option "fa_mode" -
  50 #~~~~~~~~~~~~~~~~~
  51 "fall asleep afs mode."
  52 string typestr="afs_mode"
  53 default="m/fade"
  54 optional
  55 details="
  56         Select this mode right after setting the volume. Example:
  57         --fa_mode m/sleep
  58 "
  59
  60 option "fa_fade" -
  61 #~~~~~~~~~~~~~~~~~
  62  "fall asleep fading time"
  63 int typestr="seconds"
  64 default="1800"
  65 optional
  66 details="
  67         No fading if set to 0.
  68 "
  69
  70 option "fa_vol" -
  71 #~~~~~~~~~~~~~~~~
  72  "volume to fade to"
  73         int typestr="volume"
  74         default="20"
  75         optional
  76
  77 option "sleep_mode" -
  78 #~~~~~~~~~~~~~~~~~~~~~~
  79 "sleep time afs mode"
  80 details = "
  81         Select the given afs mode after the fade out is complete. If
  82         unset, the \"stop\" command is sent to para_server.
  83 "
  84 string typestr="afs_mode"
  85 default="m/sleep"
  86 optional
  87
  88 option "wake_hour" H
  89 #~~~~~~~~~~~~~~~~~~~
  90  "(0-23) (default: now + 9 hours)"
  91         int typestr="hour"
  92         optional
  93
  94 option "wake_min" M
  95 #~~~~~~~~~~~~~~~~~~
  96 "(0-59)"
  97         int typestr="minutes"
  98         default="0"
  99         optional
 100
 101 option "wake_mode" -
 102 #~~~~~~~~~~~~~~~~~~~
 103 "wake time afs mode"
 104 string typestr="afs_mode"
 105 default="m/wake"
 106 optional
 107 details="
 108         Change to this afs mode on waketime.
 109 "
 110
 111 option "wake_fade" -
 112 #~~~~~~~~~~~~~~~~~~~
 113  "no fading in if set to 0"
 114         int typestr="seconds"
 115         default="1200"
 116         optional
 117
 118 option "wake_vol" -
 119 #~~~~~~~~~~~~~~~~~~
 120  "vol to fade to at waketime"
 121         int typestr="volume"
 122         default="80"
 123         optional
 124
 125 section "snooze options"
 126 ########################
 127
 128 option "snooze_out_fade" -
 129 #~~~~~~~~~~~~~~~~~~~~~~~~~
 130  "fade out time"
 131         int typestr="seconds"
 132         default="30"
 133         optional
 134
 135 option "snooze_out_vol" -
 136 #~~~~~~~~~~~~~~~~~~~~~~~~
 137  "vol to fade to before snooze"
 138         int typestr="volume"
 139         default="20"
 140         optional
 141
 142 option "snooze_time" -
 143 #~~~~~~~~~~~~~~~~~~~~~
 144  "delay"
 145         int typestr="seconds"
 146         default="600"
 147         optional
 148
 149 option "snooze_in_fade" -
 150 #~~~~~~~~~~~~~~~~~~~~~~~~
 151  "fade in time"
 152         int typestr="seconds"
 153         default="180"
 154         optional
 155
 156 option "snooze_in_vol" -
 157 #~~~~~~~~~~~~~~~~~~~~~~~
 158  "vol to fade to after snooze"
 159         int typestr="volume"
 160         default="80"
 161         optional
 162
 163 section "fade options"
 164 ######################
 165
 166 option "fade_vol" f
 167 #~~~~~~~~~~~~~~~~~~
 168  "volume to fade to"
 169         int typestr="volume"
 170         default="50"
 171         optional
 172
 173 option "fade_time" t
 174 #~~~~~~~~~~~~~~~~~~~
 175  "time to fade in"
 176         int typestr="seconds"
 177         default="5"
 178         optional