README.md: clarify timezone reload

[user/henk/code/snooze.git] / README.md

diff --git a/README.md b/README.md
index d33c953bedd7ba6365f351f7b6df26ad649fef8d..4b6832c1ac397036415137ddd680a512abd3e0e2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 running a command.  Together with a service supervision system such as
 runit, this can be used to replace cron(8).
 
-`lr` has been tested on Linux 4.2.
+`snooze` has been tested on Linux 4.2.
 It will likely work on other Unix-like systems with C99.
 
 ## Benefits
@@ -129,7 +129,7 @@ Only mtime is looked at, so touch(1) is good.
 * if we woke due to a SIGALRM, the command is executed immediately as well
 * if the event is in the future, recompute the time it takes, possibly
   considering shifting of the system time or timezone changes
-  (possibly only works on glibc)
+  (timezone reload only tested on glibc)
 * If no command was given, just return with status 0
 * and so on...
 
@@ -160,6 +160,16 @@ Use snooze inline, cron-style mail:
        actualjob >output 2>&1 ||
                mail -s "$(hostname): snooze job failed with status $?" root <output
 
+Snooze for rate-limiting a general purpose runit service: don't
+restart faster than every two minutes. (Note that after a crash with a
+daemon runtime of more than two minutes, it will be restarted
+immediately):
+
+       set -e
+       snooze -H'*' -M'*' -S'*' -t timefile -T 2m
+       touch timefile
+       exec mydaemond
+
 ## Installation
 
 Use `make all` to build, `make install` to install relative to `PREFIX`