Initial commit

runit/svwaitdown.8

@@ -0,0 +1,119 @@
+.TH svwaitdown 8
+.SH NAME
+svwaitdown \- waits for services controlled by runsv(8) or supervise(8) to be down
+.SH SYNOPSIS
+.B svwaitdown
+[
+.B \-v
+] [
+.B \-k
+] [
+.B \-t
+.I sec
+]
+.I services
+.SH DESCRIPTION
+.I services
+consists of one or more arguments. Each
+.I service
+directory must start with a slash.
+.P
+.B svwaitdown
+sends each
+.I service
+given at the command line the ``down'' command, and waits for it to become
+down.
+The
+.I services
+given at the command line must be controlled by
+.BR runsv (8),
+or
+.BR supervise (8).
+.P
+.B svwaitdown
+blocks, limited by a
+.IR timeout ,
+until all
+.I services
+are down or reports errors.
+.SH OPTIONS
+.TP
+.B \-v
+verbose. Print verbose messages to stderr.
+.TP
+.B \-t \fIsec
+Set the timeout for waiting for
+.I services
+to become down to
+.I sec
+seconds.
+.I sec
+must be between 2 and 6000. Default is 600 (10 minutes).
+.TP
+.B \-k
+Kill. If the timeout is reached before all
+.I services
+are down, tell the
+.BR runsv (8)
+processes to send the
+.I services
+a KILL signal.
+.TP
+.B \-x
+Exit. Send each
+.I service
+the ``exit'' command additionally to the ``down'' command, and wait for the
+corresponding
+.BR runsv (8)
+processes to exit instead for the
+.I services
+to be down.
+This option should only be used by
+.BR runit (8)
+in stage 3 when
+.BR runsvdir (8)
+is already stopped.
+.SH EXIT CODES
+.B svwaitdown
+returns 0 as soon as all
+.I services
+are down.
+.P
+If a
+.I service
+is usually controlled by
+.B runsv (8)
+or
+.BR supervise (8),
+but no supervisor process is currently running,
+.B svwaitdown
+treats this
+.I service
+as if it would be down.
+.P
+For each
+.I service
+that causes an error while checking,
+.B svwaitdown
+increases the exit code by one and exits non zero. The maximum is 100.
+.P
+.B svwaitdown
+returns 111 if the timeout
+.I sec
+was reached.
+.SH SEE ALSO
+svwaitdown(8),
+runsv(8),
+runsvctrl(8),
+runsvstat(8),
+runsvdir(8),
+runsvchdir(8),
+runit(8),
+runit-init(8),
+supervise(8),
+svscan(8)
+.P
+ http://smarden.org/runit/
+ http://cr.yp.to/daemontools.html
+.SH AUTHOR
+Gerrit Pape <pape@smarden.org>