diff options
author | Gerrit Pape <pape@smarden.org> | 2005-01-10 19:37:17 +0000 |
---|---|---|
committer | Gerrit Pape <pape@smarden.org> | 2005-01-10 19:37:17 +0000 |
commit | b37aaae20b84b87560edeeb2a6496384368da9db (patch) | |
tree | 92ad5b3049a3951d12fcb4c26e8104a08679193c /doc | |
parent | 61fb77984e256dc8b50b38710543c9a735864ab9 (diff) | |
download | runit-b37aaae20b84b87560edeeb2a6496384368da9db.tar.gz runit-b37aaae20b84b87560edeeb2a6496384368da9db.tar.xz runit-b37aaae20b84b87560edeeb2a6496384368da9db.zip |
html.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/svwaitdown.8.html | 77 | ||||
-rw-r--r-- | doc/svwaitup.8.html | 60 |
2 files changed, 67 insertions, 70 deletions
diff --git a/doc/svwaitdown.8.html b/doc/svwaitdown.8.html index cdbc500..7fb1c68 100644 --- a/doc/svwaitdown.8.html +++ b/doc/svwaitdown.8.html @@ -9,62 +9,61 @@ <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>runsv(8)</i> or <i>supervise(8)</i> -to be down +svwaitdown - waits for services controlled by <i>runsv(8)</i> to be down <h2><a name='sect1'>Synopsis</a></h2> -<b>svwaitdown</b> [ <b>-v</b> ] [ <b>-k</b> ] [ <b>-t</b> <i>sec</i> ] <i>services</i> +<b>svwaitdown</b> +[ <b>-v</b> ] [ <b>-k</b> ] [ <b>-t</b> <i>sec</i> ] <i>services</i> <h2><a name='sect2'>Description</a></h2> -<i>services</i> -consists of one or more arguments. Each <i>service</i> directory must start with -a slash. <p> -<b>svwaitdown</b> sends each <i>service</i> given at the command line the ‘‘down’’ -command, and waits for it to become down. The <i>services</i> given at the command -line must be controlled by <i><b>runsv</b>(8)</i>, or <i><b>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. +<i>services</i> consists of one or more +arguments, each argument naming a service directory. <p> +<b>svwaitdown</b> sends each +<i>service</i> given at the command line the ‘‘down’’ command, and waits for it to +become down. The <i>services</i> given at the command line must be controlled by +<i><b>runsv</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>-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> +<dd>Set the timeout for waiting for <i>services</i> to become down to <i>sec</i> seconds. +<i>sec</i> must be between 1 and 6000. Default is 600 (10 minutes). </dd> <dt><b>-k</b> </dt> -<dd>Kill. If the timeout is reached before all -<i>services</i> are down, tell the <i><b>runsv</b>(8)</i> processes to send the <i>services</i> a KILL -signal. </dd> +<dd>Kill. If the +timeout is reached before all <i>services</i> are down, tell the <i><b>runsv</b>(8)</i> processes +to send the <i>services</i> a KILL signal. </dd> <dt><b>-x</b> </dt> -<dd>Exit. Send each <i>service</i> the ‘‘exit’’ command additionally to the ‘‘down’’ -command, and wait for the corresponding <i><b>runsv</b>(8)</i> processes to exit instead -for the <i>services</i> to be down. </dd> +<dd>Exit. Send each <i>service</i> the ‘‘exit’’ command +additionally to the ‘‘down’’ command, and wait for the corresponding <i><b>runsv</b>(8)</i> +processes to exit instead for the <i>services</i> to be down. </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 <i><b>runsv (8)</b></i> or <i><b>supervise</b>(8)</i>, -but no supervisor 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. - +<b>svwaitdown</b> +returns 0 as soon as all <i>services</i> are down. <p> +If a <i>service</i> is usually controlled +by <i><b>runsv (8)</i>,</b> but no supervisor process is currently running in the directory, +<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 on +error, or if the timeout <i>sec</i> was reached. <h2><a name='sect5'>See Also</a></h2> -<i>svwaitup(8)</i>, <i>runsv(8)</i>, <i>runsvctrl(8)</i>, <i>runsvstat(8)</i>, <i>chpst(8)</i>, <i>svlogd(8)</i>, -<i>runit(8)</i>, <i>runit-init(8)</i>, <i>runsvdir(8)</i>, <i>runsvchdir(8)</i>, <i>utmpset(8)</i> <p> - <i>http://smarden.org/runit/</i><br> - <i>http://cr.yp.to/daemontools.html</i><br> - +<i>svwaitup(8)</i>, <i>runsv(8)</i>, +<i>runsvctrl(8)</i>, <i>runsvstat(8)</i>, <i>chpst(8)</i>, <i>svlogd(8)</i>, <i>runit(8)</i>, <i>runit-init(8)</i>, +<i>runsvdir(8)</i>, <i>runsvchdir(8)</i>, <i>utmpset(8)</i> <p> +<i>http://smarden.org/runit/</i> <h2><a name='sect6'>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/svwaitup.8.html b/doc/svwaitup.8.html index 02491f1..bafab91 100644 --- a/doc/svwaitup.8.html +++ b/doc/svwaitup.8.html @@ -9,55 +9,53 @@ <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>runsv(8)</i> or <i>supervise(8)</i> -to be up +svwaitup - waits for services controlled by <i>runsv(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> +<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. Each <i>service</i> directory must start with -a slash. <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 <i><b>runsv</b>(8)</i>, or <i><b>supervise</b>(8)</i>. <p> -<b>svwaitup</b> blocks -until all <i>services</i> were up and running at least <i>sec</i> seconds when <b>svwaitup</b> -was checking or reports errors. +<i>services</i> consists of one or more arguments, +each argument naming a service directory. <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 <i><b>runsv</b>(8)</i>. +<p> +<b>svwaitup</b> blocks until all <i>services</i> were up and running at least <i>sec</i> seconds +when <b>svwaitup</b> was checking or reports errors. <h2><a name='sect3'>Options</a></h2> <dl> <dt><b>-v</b> </dt> -<dd>verbose. Print verbose messages -to stderr. </dd> +<dd>verbose. Print verbose +messages to stderr. </dd> <dt><b>-s <i>sec</b> </i></dt> -<dd>Set the minimum number of seconds each <i>service</i> has to be -up to <i>sec</i> seconds. <i>sec</i> must be between 2 and 600. Default is 2. </dd> +<dd>Set the minimum number of seconds each <i>service</i> +has to be up to <i>sec</i> seconds. <i>sec</i> must be between 1 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> were at least <i>sec</i> seconds up. <p> -<b>Note</b>: If -<b>svwaitup</b> exits 0, it does not guarantee that all <i>services</i> are actually -running. A <i>service</i> could have crashed immediatly after <b>svwaitup</b> was successfully -checking it to be up <i>sec</i> seconds. <i>services</i> should be designed not to rely -on <b>svwaitup</b> to resolve dependencies. <p> -For each <i>service</i> that is down and not -requested to become up, or that causes an error while checking (e.g. <i><b>runsv</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 0 as soon as all <i>services</i> were at least <i>sec</i> +seconds up. <p> +<b>Note</b>: If <b>svwaitup</b> exits 0, it does not guarantee that all <i>services</i> +are actually running. A <i>service</i> could have crashed immediatly after <b>svwaitup</b> +was successfully checking it to be up <i>sec</i> seconds. <i>services</i> should be designed +not to rely on <b>svwaitup</b> to resolve dependencies. <p> +For each <i>service</i> that is +down and not requested to become up, or that causes an error while checking +(e.g. <i><b>runsv</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>runsv(8)</i>, <i>runsvctrl(8)</i>, <i>runsvstat(8)</i>, <i>chpst(8)</i>, <i>svlogd(8)</i>, <i>runit(8)</i>, <i>runit-init(8)</i>, <i>runsvdir(8)</i>, <i>runsvchdir(8)</i>, <i>utmpset(8)</i> <p> - <i>http://smarden.org/runit/</i><br> - <i>http://cr.yp.to/daemontools.html</i><br> - +<i>http://smarden.org/runit/</i> <h2><a name='sect6'>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> |