Document new per-service options controlling automatic respawn

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>

doc/config.md

@@ -332,8 +332,11 @@ by declaring the PID file to look for: `pid:!/path/to/pidfile.pid`.
 **Syntax:** `service [LVLS] <COND> /path/to/daemon ARGS -- Optional description`
 
 Service, or daemon, to be monitored and automatically restarted if it
-exits prematurely.  Finit tries to restart services that die 10 times
+exits prematurely.  Finit tries to restart services that die, by
-before giving up, then you have to `initctl restart NAME` it manually.
+default 10 times before giving up and marking them as *crashed*.
+After which they have to be manually restarted with `initctl restart
+NAME`.  The limits controling this are configurable, see the options
+below.
   
 For daemons that support it, we recommend appending `--foreground`,
 `--no-background`, `-n`, `-F`, or similar command line argument to
@@ -390,6 +393,21 @@ optional `name` argument:
 
     name:<service-name>
 
+As mentioned previously, services are automatically restarted, this is
+configurable with the following options:
+
+  * `restart:NUM` -- number of times Finit tries to restart a crashing
+    service, default: 10.  When this limit is reached the service is
+	marked *crashed* and must be restarted manually with `initctl`
+  * `restart_sec:SEC` -- number of seconds before Finit tries to restart
+    a crashing service, default: 2 seconds for the first five retries,
+	then back-off to 5 seconds.  The maximum of this configured value
+	and the above (2 and 5) will be used
+  * `norestart` -- dont restart on failures, same as `restart:0`
+  * `oncrash:reboot` -- when all retries have failed, and the service
+    has *crashed*, if this option is set the system is rebooted.
+    Note, future releases may include other `oncrash:` actions
+
 When stopping a service (run/task/sysv/service), either manually or
 when moving to another runlevel, Finit starts by sending `SIGTERM`, to
 allow the process to shut down gracefully.  If the process has not

man/finit.conf.5

@@ -174,9 +174,13 @@ the default behavior for the
 command modifier.
 .It Cm service Oo LVLS Oc Ao COND Ac Ar /path/to/daemon ARGS Op -- Optional description
 Service, or daemon, to be monitored and automatically restarted if it
-exits prematurely.  Finit tries to restart services that die 10 times
+exits prematurely.  Finit tries to restart services that die, by
-before giving up, then you have to restart it manually:
+default 10 times, before giving up and marking them as
-.Cm initctl restart NAME
+.Em crashed .
+After which they have to be restarted manually using
+.Cm initctl restart NAME .
+The number of restarts, the delay between each restart, and more is
+configurable, see the options below.
 .Pp  
 For daemons that support it, we recommend appending
 .Cm --foreground , --no-background , -n , -F ,
@@ -200,6 +204,7 @@ flag (daemonize) to prevent it from forking to the background:
 .Bd -unfilled -offset indent
 service [2345] <pid/zebra> /sbin/ospfd -- OSPF daemon
 .Ed
+.Pp
 .Cm [2345]
 denote the runlevels
 .Cm ospfd
@@ -264,6 +269,34 @@ changed with the
 .Cm name:foo
 command modifier.
 .Pp
+As mentioned previously, services are automatically restarted should
+they crash, this is configurable with the following options:
+.Bl -tag -width 1n
+.It Cm restart:NUM
+number of times Finit tries to restart a crashing
+service, default: 10.  When this limit is reached the service is
+marked
+.Em crashed
+and must be restarted manually with
+.Xr initctl 8 .
+.It Cm restart_sec:SEC
+number of seconds before Finit tries to restart
+a crashing service, default: 2 seconds for the first five retries,
+then back-off to 5 seconds.  The maximum of this configured value
+and the above (2 and 5) will be used
+.It Cm norestart
+dont restart on failures, same as
+.Cm restart:0
+.It Cm oncrash:reboot
+when all retries have failed, and the service
+has
+.Em crashed ,
+if this option is set the system is rebooted.  Note, future releases
+may include other
+.Cm oncrash:
+actions.
+.El
+.Pp
 When stopping a service (run/task/sysv/service), either manually or when
 moving to another runlevel, Finit starts by sending SIGTERM, to allow
 the process to shut down gracefully.  If the process has not been