commit 472ce2eec7b0a7a018f136847eefb82b40645058
parent 8b0b2c4737a7a81904d58361519ddf0a89f4158e
Author: Gerrit Pape <pape@smarden.org>
Date: Sun, 23 Dec 2001 17:17:10 +0000
docs adapted.
Diffstat:
5 files changed, 147 insertions(+), 10 deletions(-)
diff --git a/doc/index.html b/doc/index.html
@@ -13,7 +13,9 @@
<a href="usedietlibc.html">How to use dietlibc</a>
<p>
<a href="runit.8.html">The <tt>runit</tt> program</a><br>
-<a href="runit-init.8.html">The <tt>runit-init</tt> program</a>
+<a href="runit-init.8.html">The <tt>runit-init</tt> program</a><br>
+<a href="svwaitdown.8.html">The <tt>svwaitdown</tt> program</a><br>
+<a href="svwaitup.8.html">The <tt>svwaitup</tt> program</a>
<hr>
<i>runit</i> cooperates with djb's
<a href="http://cr.yp.to/daemontools.html">daemontools</a> package to create
diff --git a/doc/runit-init.8.html b/doc/runit-init.8.html
@@ -9,7 +9,7 @@
<a href="http://smarden.org/pape/">G. Pape</a><br><A HREF="index.html">runit</A><hr><P>
<H2><A NAME="sect0">Name</A></H2>
-init - the UNIX process no 1
+init - a UNIX process no 1
<H2><A NAME="sect1">Synopsis</A></H2>
<B>init</B> [ 0 | 6 ]
<H2><A NAME="sect2">Description</A></H2>
@@ -37,11 +37,12 @@ files are touched. Then a CONT signal is sent to <B><I>runit</B>(8)</I>. </DD>
<B>runit-init</B>
returns 111 on error, 0 in all other cases.
<H2><A NAME="sect4">See Also</A></H2>
-<I>runit(8)</I> <P>
- <I>http://smarden.org/runit/</I>
-
+<I>runit(8)</I>, <I>svwaitdown(8)</I>,
+<I>svwaitup(8)</I> <P>
+<I>http://smarden.org/runit/</I>
<H2><A NAME="sect5">Author</A></H2>
-Gerrit Pape <pape@smarden.org> <P>
+Gerrit Pape <pape@smarden.org>
+<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
diff --git a/doc/runit.8.html b/doc/runit.8.html
@@ -44,11 +44,11 @@ the system. <P>
if <B>runit</B> receives an INT signal, a ctrl-alt-del keyboard request
is triggered.
<H2><A NAME="sect8">See Also</A></H2>
-<I>runit-init(8)</I> <P>
- <I>http://smarden.org/runit/</I>
+<I>runit-init(8)</I>, <I>svwaitdown(8)</I>, <I>svwaitup(8)</I> <P>
+<I>http://smarden.org/runit/</I>
+
<H2><A NAME="sect9">Author</A></H2>
-Gerrit
-Pape <pape@smarden.org> <P>
+Gerrit Pape <pape@smarden.org> <P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
diff --git a/doc/svwaitdown.8.html b/doc/svwaitdown.8.html
@@ -0,0 +1,68 @@
+
+
+
+<HTML>
+<HEAD>
+<TITLE>svwaitdown(8) manual page</TITLE>
+</HEAD>
+<BODY bgcolor=white>
+<a href="http://smarden.org/pape/">G. Pape</a><br><A HREF="index.html">runit</A><hr><P>
+
+<H2><A NAME="sect0">Name</A></H2>
+svwaitdown - waits for services controlled by <I>supervise(8)</I> to be down
+
+<H2><A NAME="sect1">Synopsis</A></H2>
+<B>svwaitdown</B> [ <B>-v</B> ] [ <B>-t</B> <I>sec</I> ] <I>services</I>
+<H2><A NAME="sect2">Description</A></H2>
+<I>services</I> consist
+of one or more arguments. <P>
+<B>svwaitdown</B> checks each <I>service</I> given at the command
+line for being down. The <I>services</I> given at the command line must be controlled
+by <B><I>supervise</B>(8)</I>. <P>
+<B>svwaitdown</B> blocks, limited by a <I>timeout</I>, until all <I>services</I>
+are down or reports errors.
+<H2><A NAME="sect3">Options</A></H2>
+
+<DL>
+
+<DT><B>-v</B> </DT>
+<DD>verbose. Print verbose messages to stderr.
+</DD>
+
+<DT><B>-t <I>sec</B> </I></DT>
+<DD>Set the timeout for waiting for <I>services</I> to become down to <I>sec</I> seconds.
+<I>sec</I> must be between 2 and 6000. Default is 600 (10 minutes). </DD>
+</DL>
+
+<H2><A NAME="sect4">Exit Codes</A></H2>
+<B>svwaitdown</B>
+returns 0 as soon as all <I>services</I> are down. <P>
+If a <I>service</I> is usually controlled
+by <B><I>supervise</B>(8)</I>, but no <B><I>supervise</B>(8)</I> process is currently running, <B>svwaitdown</B>
+treats this <I>service</I> as if it would be down. <P>
+For each <I>service</I> that causes
+an error while checking, <B>svwaitdown</B> increases the exit code by one and
+exits non zero. The maximum is 100. <P>
+<B>svwaitdown</B> returns 111 if the timeout
+<I>sec</I> was reached.
+<H2><A NAME="sect5">See Also</A></H2>
+<I>svwaitup(8)</I>, <I>supervise(8)</I>, <I>svscan(8)</I>, <I>runit(8)</I>,
+<I>runit-init(8)</I> <P>
+ <I>http://smarden.org/runit/</I><BR>
+ <I>http://cr.yp.to/daemontools.html</I><BR>
+
+<H2><A NAME="sect6">Author</A></H2>
+Gerrit Pape <pape@smarden.org> <P>
+
+<HR><P>
+<A NAME="toc"><B>Table of Contents</B></A><P>
+<UL>
+<LI><A NAME="toc0" HREF="#sect0">Name</A></LI>
+<LI><A NAME="toc1" HREF="#sect1">Synopsis</A></LI>
+<LI><A NAME="toc2" HREF="#sect2">Description</A></LI>
+<LI><A NAME="toc3" HREF="#sect3">Options</A></LI>
+<LI><A NAME="toc4" HREF="#sect4">Exit Codes</A></LI>
+<LI><A NAME="toc5" HREF="#sect5">See Also</A></LI>
+<LI><A NAME="toc6" HREF="#sect6">Author</A></LI>
+</UL>
+</BODY></HTML>
diff --git a/doc/svwaitup.8.html b/doc/svwaitup.8.html
@@ -0,0 +1,66 @@
+
+
+
+<HTML>
+<HEAD>
+<TITLE>svwaitup(8) manual page</TITLE>
+</HEAD>
+<BODY bgcolor=white>
+<a href="http://smarden.org/pape/">G. Pape</a><br><A HREF="index.html">runit</A><hr><P>
+
+<H2><A NAME="sect0">Name</A></H2>
+svwaitup - waits for services controlled by <I>supervise(8)</I> to be up
+<H2><A NAME="sect1">Synopsis</A></H2>
+<B>svwaitup</B>
+[ <B>-v</B> ] [ <B>-s</B> <I>sec</I> ] <I>services</I>
+<H2><A NAME="sect2">Description</A></H2>
+<I>services</I> consist of one or more arguments.
+<P>
+<B>svwaitup</B> checks each <I>service</I> given at the command line for being at least
+the specified number of seconds <I>sec</I> up. The <I>services</I> given at the command
+line must be controlled by <B><I>supervise</B>(8)</I>. <P>
+<B>svwaitup</B> blocks until all services
+are running the requested number of seconds or reports errors.
+<H2><A NAME="sect3">Options</A></H2>
+
+<DL>
+
+<DT><B>-v</B>
+</DT>
+<DD>verbose. Print verbose messages to stderr. </DD>
+
+<DT><B>-s <I>sec</B> </I></DT>
+<DD>Set the number of seconds
+the <I>services</I> have to be up to <I>sec</I> seconds. <I>sec</I> must be between 2 and 600.
+Default is 2. </DD>
+</DL>
+
+<H2><A NAME="sect4">Exit Codes</A></H2>
+<B>svwaitup</B> returns 0 as soon as all <I>services</I> are at
+least <I>sec</I> seconds up. <P>
+For each <I>service</I> that is down and not requested to
+become up, or that causes an error while checking (e.g. <B><I>supervise</B>(8)</I> is not
+running), <B>svwaitup</B> increases the exit code by one and exits non zero. The
+maximum is 100. <P>
+<B>svwaitup</B> returns 111 on error.
+<H2><A NAME="sect5">See Also</A></H2>
+<I>svwaitdown(8)</I>, <I>supervise(8)</I>,
+<I>svscan(8)</I>, <I>runit(8)</I>, <I>runit-init(8)</I> <P>
+ <I>http://smarden.org/runit/</I><BR>
+ <I>http://cr.yp.to/daemontools.html</I><BR>
+
+<H2><A NAME="sect6">Author</A></H2>
+Gerrit Pape <pape@smarden.org> <P>
+
+<HR><P>
+<A NAME="toc"><B>Table of Contents</B></A><P>
+<UL>
+<LI><A NAME="toc0" HREF="#sect0">Name</A></LI>
+<LI><A NAME="toc1" HREF="#sect1">Synopsis</A></LI>
+<LI><A NAME="toc2" HREF="#sect2">Description</A></LI>
+<LI><A NAME="toc3" HREF="#sect3">Options</A></LI>
+<LI><A NAME="toc4" HREF="#sect4">Exit Codes</A></LI>
+<LI><A NAME="toc5" HREF="#sect5">See Also</A></LI>
+<LI><A NAME="toc6" HREF="#sect6">Author</A></LI>
+</UL>
+</BODY></HTML>
