Adjust shalarm cfg.
[LittleDebian.git] / etc / skel / .config / shalarm / shalarm.cfg
1 ################################################################################
2 #   config file for shalarm.sh      |   version 1.4     |   2014-11-07
3 #   James Hendrie                   |   hendrie.james@gmail.com
4 ################################################################################
5
6 #   This entire file is optional, but if it exists in either directory that the
7 #   script checks for config files (/etc and ~/.config/shalarm by default), then
8 #   it will be used.  The second location (~/.config/shalarm/shalarm.cfg) takes
9 #   precedence over the first.
10
11 #   Each option given has a default value, as well as an example or two printed
12 #   below just to show how else it might be done.  Any setting with 'DEFAULT' as
13 #   its value will be filled with the script default (duh).
14
15 #-------------------------------------------------------------------------------
16 #                                 MEDIA PLAYER
17 #
18 #   The media player to use for the alarm clock.  It's best to use a media
19 #   player that works well in the console (mplayer, mplayer2, mpv, etc.), but
20 #   you can use whatever you want as long as you don't mind weirdness.
21 #-------------------------------------------------------------------------------
22 #mediaPlayer=DEFAULT
23 mediaPlayer=parole
24 #mediaPlayer="/path/to/mediaPlayer.bin" ##  NOTE:  Use quotes around the path
25
26
27 #-------------------------------------------------------------------------------
28 #                             MEDIA PLAYER OPTIONS
29 #
30 #   Custom options to pass to your media player should you choose to do so.  By
31 #   default the script will loop indefinitely on its own, unless you kill it or
32 #   set the timeout variable, so you don't need to set that here.  The exception
33 #   to this rule is if you know that you will use a GUI player such as VLC, in
34 #   which case you will find it very helpful to set its options here.
35 #-------------------------------------------------------------------------------
36 mediaPlayerOptions="-E -i -n"
37 #mediaPlayerOptions="--loop"    #   Useful for VLC
38
39
40 #-------------------------------------------------------------------------------
41 #                                  SOUND FILE
42 #
43 #   This is the sound file played by the alarm.  It can be the default ring wav,
44 #   a song somewhere on your harddrive, whatever.
45 #-------------------------------------------------------------------------------
46 soundFile=~/.local/share/shalarm/ring.wav
47 #soundFile="/path/to/soundFile.wav"     ##  NOTE:  Use quotes around the path
48 #soundFile="/path/to/song.mp3"
49
50
51 #-------------------------------------------------------------------------------
52 #                                ALARM MESSAGE
53 #-------------------------------------------------------------------------------
54 alarmMessage=DEFAULT
55 #alarmMessage=FORTUNE                   ##  Message is a random short fortune
56
57 printAlarmMessage=DEFAULT
58 #printAlarmMessage=0                    ##  Numeric value, 0 = off, 1 = on
59                                         ##  (requires fortune to be installed)
60 #alarmMessage="Up and at 'em!"          ##  Use quotes
61
62 messageRepeat=0                         ##  If 0, do not repeat.  If 1, repeat.
63 #messageRepeat=1
64
65
66 #-------------------------------------------------------------------------------
67 #                                ALARM TIMEOUT
68 #-------------------------------------------------------------------------------
69 alarmTimeout=0                          ##  If greater than 0, this is the
70                                         ##  length of time (in seconds) before
71                                         ##  the alarm will shut itself off.  0
72                                         ##  or less means that the alarm will
73                                         ##  never time out.  The default is 0.
74
75 #alarmTimeout=300                       ##  Shut off after five minutes
76
77
78 #-------------------------------------------------------------------------------
79 #                                    SNOOZE
80 #-------------------------------------------------------------------------------
81 snooze=300                                ##  0 to disable snooze.  Any value
82                                         ##  greater than zero is the snooze
83                                         ##  interval, in seconds.
84
85 #snooze=300                             ##  Set snooze for 300 seconds (5 min)