summary refs log tree commit diff
path: root/man/svwaitdown.8
diff options
context:
space:
mode:
Diffstat (limited to 'man/svwaitdown.8')
-rw-r--r--man/svwaitdown.884
1 files changed, 84 insertions, 0 deletions
diff --git a/man/svwaitdown.8 b/man/svwaitdown.8
new file mode 100644
index 0000000..5f3edc2
--- /dev/null
+++ b/man/svwaitdown.8
@@ -0,0 +1,84 @@
+.TH svwaitdown 8
+.SH NAME
+svwaitdown \- waits for services controlled by supervise(8) to be down
+.SH SYNOPSIS
+.B svwaitdown
+[
+.B \-v
+]
+[
+.B \-t
+.I sec
+]
+.I services
+.SH DESCRIPTION
+.I services
+consist of one or more arguments.
+.P
+.B svwaitdown
+checks each
+.I service
+given at the command line for being down.
+The
+.I services
+given at the command line must be controlled by
+.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).
+.SH EXIT CODES
+.B svwaitdown
+returns 0 as soon as all
+.I services
+are down.
+.P
+If a
+.I service
+is usually controlled by
+.BR supervise (8),
+but no
+.BR supervise (8)
+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
+svwaitup(8),
+supervise(8),
+svscan(8),
+runit(8),
+runit-init(8)
+.P
+ http://smarden.org/runit/
+ http://cr.yp.to/daemontools.html
+.SH AUTHOR
+Gerrit Pape <pape@smarden.org>