README.md

   1 ## snooze: run a command at a particular time
   2
   3 `snooze` is a new tool for to wait until a particular time and then
   4 run a command.  Together with a service supervision system such as runit,
   5 this can be used to replace cron(8).
   6
   7 `lr` has been tested on Linux 4.2.
   8 It will likely work on other Unix-like systems with C99.
   9
  10 ## Benefits
  11
  12 Over cron:
  13 - mnemonic syntax
  14 - no overlapping job runs possible
  15 - filtering by ISO week and day of year
  16 - due to supervision, no centralized daemon required
  17 - due to supervision, can easily disable jobs or force their
  18   execution instantly
  19 - due to supervision, have custom logs
  20 - due to no centralized daemon, no fuzzing with multiple users/permissions
  21 - very robust with respect to external time changes
  22 - can use a file timestamp to ensure minimum waiting time between two
  23   runs, even across reboots
  24 - randomized delays (some cron have that)
  25 - variable slack (no need for anacron)
  26
  27 Over runwhen:
  28 - less confusing usage (I hope)
  29 - filtering by ISO week and day of year
  30 - zero dependencies
  31
  32 Over uschedule:
  33 - due to supervision, no centralized daemon required
  34
  35 ## Rosetta stone
  36
  37 * run five minutes after midnight, every day:
  38   cron: `5 0 * * *`
  39   snooze: `-M5`
  40 * run at 2:15pm on the first of every month:
  41   cron: `15 14 1 * *`
  42   snooze: `-d1 -H2 -M15`
  43 * run at 10 pm on weekdays:
  44   cron: `0 22 * * 1-5`
  45   snooze: `-w1-5 -H22`
  46 * run 23 minutes after midnight, 2am, 4am ..., everyday:
  47   cron: `23 0-23/2 * * *`
  48   snooze: `-H/2 -M23`
  49 * run every second week:
  50   snooze: `-W/2`
  51 * run every 10 days:
  52   snooze: `-D/10`
  53
  54 ## Usage:
  55
  56         snooze [-nv] [-t timefile] [-T timewait] [-R randdelay] [-s slack] [-d mday] [-m mon] [-w wday] [-D yday] [-W yweek] [-H hour] [-M min] [-S sec] COMMAND...
  57
  58 * `-n`: dry-run, print the next 5 times the command would run.
  59 * `-v`: verbose, print scheduled (and rescheduled) times.
  60 * `-t`, `-T`: see below timefiles
  61 * `-R`: add between 0 and RANDDELAY seconds to the scheduled time.
  62 * `-s`: commands are executed even if they are SLACK (default: 60) seconds late.
  63
  64 The durations RANDDELAY and SLACK and TIMEWAIT are parsed as seconds,
  65 unless a postfix of `m` for minutes, `h` for hours, or `d` for days is used.
  66
  67 The remaining arguments are patterns for the time fields:
  68
  69 * `-d`: day of month
  70 * `-m`: month
  71 * `-w`: weekday (0-7, sunday is 0 and 7)
  72 * `-D`: day of year
  73 * `-W`: ISO week of year (0..53)
  74 * `-H`: hour
  75 * `-M`: minute
  76 * `-S`: second
  77
  78 The following syntax is used for these options:
  79
  80 * exact match: `-d 3`, run on the 3rd
  81 * alternation: `-d 3,10,27`, run on 3rd, 10th, 27th
  82 * range: `-d 1-5`, run on 1st, 2nd, 3rd, 4th, 5th
  83 * star: `-d '*'`, run every day
  84 * repetition: `-d /5`, run on 5th, 10th, 15th, 20th, 25th, 30th day
  85 * shifted repetition: `-d 2/5`, run on 7th, 12th, 17th, 22nd, 27th day
  86
  87 and combinations of those, e.g. `-d 1-10,15/5,28`.
  88
  89 The defaults are `-d* -m* -w* -D* -W* -H0 -M0 -S0`, that is, every midnight.
  90
  91 Note that *all* patterns need to match (contrary to cron where either
  92 day of month *or* day of week matches), so `-w5 -d13` only runs on
  93 Friday the 13th.
  94
  95 ## Timefiles
  96
  97 Optionally, you can keep track of runs in time files, using `-t` and
  98 optionally `-T`.
  99
 100 When `-T` is passed, execution will not start earlier than the mtime
 101 of TIMEFILE plus TIMEWAIT seconds.
 102
 103 When `-T` is *not* passed, snooze will start finding the first matching time
 104 starting from the mtime of TIMEFILE, and taking SLACK into account.
 105 (E.g. `-H0 -s 1d -t timefile` will start an instant
 106 execution when timefile has not been touched today, whereas without `-t`
 107 this would always wait until next midnight.)
 108
 109 If TIMEFILE does not exist, it will be assumed outdated enough to
 110 ensure earliest execution.
 111
 112 snooze does not update the timefiles, your job needs to do that!
 113 Only mtime is looked at, so touch(1) is good.
 114
 115 ## Exact behavior
 116
 117 * snooze parses the option flags and computes the first time the
 118   date pattern matches, as a symbolic date
 119 * if a timefile is specified, the time is upped to timefile + timewait seconds
 120 * if a random delay is requested, it is added
 121 * snooze computes how far this event is in the future
 122 * snooze sleeps that long, but at most 5 minutes
 123 * after waking, snooze recomputes how far the event is in the future
 124 * if the event is in the past, but fewer than SLACK seconds, snooze
 125   execs the command.  You need to ensure (by setting up supervision)
 126   snooze runs again after that!
 127 * if we woke due to a SIGALRM, the command is executed immediately as well
 128 * if the event is in the future, recompute the time it takes, possibly
 129   considering shifting of the system time or timezone changes
 130   (possibly only works on glibc)
 131 * If no command was given, just return with status 0
 132 * and so on...
 133
 134 ## Common usages
 135
 136 Run a job like cron, every day at 7am and 7pm:
 137
 138         exec snooze -H7,19 rdumpfs / /data/dump/mybox 2>&1
 139
 140 Run a job daily, never twice a day:
 141
 142         exec snooze -H0 -s 1d -t timefile \
 143                 sh -c 'run-parts /etc/cron.daily; touch timefile'
 144
 145 Use snooze inline, run a mirror script every hour at 30 minutes past,
 146 but ensure there are at least 20 minutes in between.
 147
 148         set -e
 149         snooze -H'*' -M30 -t timefile -T 20m
 150         touch timefile  # remove this if instantly retrying on failure were ok
 151         mirrorallthethings
 152         touch timefile
 153
 154 Use snooze inline, cron-style mail:
 155
 156         set -e
 157         snooze ...
 158         actualjob >output 2>&1 ||
 159                 mail -s "$(hostname): snooze job failed with status $?" root <output
 160
 161 ## Installation
 162
 163 Use `make all` to build, `make install` to install relative to `PREFIX`
 164 (`/usr/local` by default).  The `DESTDIR` convention is respected.
 165 You can also just copy the binary into your `PATH`.
 166
 167 ## Copyright
 168
 169 snooze is in the public domain.
 170
 171 To the extent possible under law,
 172 Christian Neukirchen <chneukirchen@gmail.com>
 173 has waived all copyright and related or
 174 neighboring rights to this work.
 175
 176 http://creativecommons.org/publicdomain/zero/1.0/