diff options
author | Gerrit Pape <pape@smarden.org> | 2005-08-24 07:33:20 +0000 |
---|---|---|
committer | Gerrit Pape <pape@smarden.org> | 2005-08-24 07:33:20 +0000 |
commit | 1d9040e2150cc722658c441cf61fbd198004e58f (patch) | |
tree | 652221c666c20bc5f7a07683b8413d94e7c01202 /doc/sv.8.html | |
parent | 8c165793aa5dde5f5812c182c279ae44879e0ac3 (diff) | |
download | runit-1d9040e2150cc722658c441cf61fbd198004e58f.tar.gz runit-1d9040e2150cc722658c441cf61fbd198004e58f.tar.xz runit-1d9040e2150cc722658c441cf61fbd198004e58f.zip |
html.
Diffstat (limited to 'doc/sv.8.html')
-rw-r--r-- | doc/sv.8.html | 88 |
1 files changed, 48 insertions, 40 deletions
diff --git a/doc/sv.8.html b/doc/sv.8.html index a4a39a2..5d07cd4 100644 --- a/doc/sv.8.html +++ b/doc/sv.8.html @@ -77,17 +77,22 @@ of these <i>command</i>s. <dt><b>start</b> </dt> <dd>Same as <i>up</i>, but wait up to 7 seconds for the command -to take effect. Then report the status or timeout. </dd> +to take effect. Then report the status or timeout. If the script <i>./check</i> exists +in the service directory, <b>sv</b> runs this script to check whether the service +is up and available; it’s considered to be available if <i>./check</i> exits with +0. </dd> <dt><b>stop</b> </dt> -<dd>Same as <i>down</i>, but -wait up to 7 seconds for the service to become down. Then report the status -or timeout. </dd> +<dd>Same as <i>down</i>, but wait up to 7 seconds for the service to become +down. Then report the status or timeout. </dd> <dt><b>restart</b> </dt> -<dd>Send the commands <i>term</i>, <i>cont</i>, and <i>up</i> to the service, -and wait up to 7 seconds for the service to restart. Then report the status -or timeout. </dd> +<dd>Send the commands <i>term</i>, +<i>cont</i>, and <i>up</i> to the service, and wait up to 7 seconds for the service to +restart. Then report the status or timeout. If the script <i>./check</i> exists in +the service directory, <b>sv</b> runs this script to check whether the service +is up and available again; it’s considered to be available if <i>./check</i> exits +with 0. </dd> <dt><b>shutdown</b> </dt> <dd>Same as <i>exit</i>, but wait up to 7 seconds for the <i><b>runsv</b>(8)</i> @@ -107,13 +112,15 @@ service the <i>kill</i> command. </dd> <dt><b>force-restart</b> </dt> <dd>Send the service the <i>term</i>, <i>cont</i> and <i>up</i> commands, and wait up to 7 seconds for the service to restart. Then report -the status, and on timeout send the service the <i>kill</i> command. </dd> - -<dt><b>force-shutdown</b> -</dt> -<dd>Same as <i>exit</i>, but wait up to 7 seconds for the <i><b>runsv</b>(8)</i> process to terminate. -Then report the status, and on timeout send the service the <i>kill</i> command. -</dd> +the status, and on timeout send the service the <i>kill</i> command. If the script +<i>./check</i> exists in the service directory, <b>sv</b> runs this script to check whether +the service is up and available again; it’s considered to be available if +<i>./check</i> exits with 0. </dd> + +<dt><b>force-shutdown</b> </dt> +<dd>Same as <i>exit</i>, but wait up to 7 seconds +for the <i><b>runsv</b>(8)</i> process to terminate. Then report the status, and on timeout +send the service the <i>kill</i> command. </dd> </dl> <h2><a name='sect5'>Options</a></h2> @@ -121,13 +128,13 @@ Then report the status, and on timeout send the service the <i>kill</i> command. <dl> <dt><b>-v</b> </dt> -<dd>If the <i>command</i> is up, down, term, once, or exit, then wait up -to 7 seconds for the command to take effect. Then report the status or timeout. -</dd> +<dd>If the <i>command</i> is up, down, +term, once, or exit, then wait up to 7 seconds for the command to take +effect. Then report the status or timeout. </dd> <dt><b>-w <i>sec</b> </i></dt> -<dd>Override the default timeout of 7 seconds with <i>sec</i> seconds. This option -implies <i>-v</i>. </dd> +<dd>Override the default timeout +of 7 seconds with <i>sec</i> seconds. This option implies <i>-v</i>. </dd> </dl> <h2><a name='sect6'>Environment</a></h2> @@ -135,34 +142,35 @@ implies <i>-v</i>. </dd> <dl> <dt><b>SVDIR</b> </dt> -<dd>The environment variable $SVDIR overrides the -default services directory <i>/var/service/</i>. </dd> +<dd>The +environment variable $SVDIR overrides the default services directory <i>/var/service/</i>. +</dd> <dt><b>SVWAIT</b> </dt> -<dd>The environment variable -$SVWAIT overrides the default 7 seconds to wait for a command to take effect. -It is overridden by the -w option. </dd> +<dd>The environment variable $SVWAIT overrides the default 7 seconds +to wait for a command to take effect. It is overridden by the -w option. </dd> </dl> -<h2><a name='sect7'>Exit Codes</a></h2> -<b>sv</b> exits 0, if the <i>command</i> was -successfully sent to all <i>services</i>, and, if it was told to wait, the <i>command</i> -has taken effect to all services. <p> -For each <i>service</i> that caused an error -(e.g. the directory is not controlled by a <i><b>runsv</b>(8)</i> process, or <b>sv</b> timed -out while waiting), <b>sv</b> increases the exit code by one and exits non zero. -The maximum is 99. <b>sv</b> exits 100 on error. <p> -If <b>sv</b> is called with a base name -other than <b>sv</b>, it exits 1 on timeout or trouble sending the command. If -the <i>command</i> is <b>status</b>, it exits 3 if the service is down, and 4 if the -status is unknown. It exits 2 on wrong usage, and 151 on error. -<h2><a name='sect8'>See Also</a></h2> -<i>runsv(8)</i>, -<i>runsvdir(8)</i>, <i>runsvchdir(8)</i>, <i>chpst(8)</i>, <i>svlogd(8)</i>, <i>runit(8)</i>, <i>runit-init(8)</i> +<h2><a name='sect7'>Exit +Codes</a></h2> +<b>sv</b> exits 0, if the <i>command</i> was successfully sent to all <i>services</i>, +and, if it was told to wait, the <i>command</i> has taken effect to all services. <p> +For each <i>service</i> that caused an error (e.g. the directory is not controlled +by a <i><b>runsv</b>(8)</i> process, or <b>sv</b> timed out while waiting), <b>sv</b> increases the +exit code by one and exits non zero. The maximum is 99. <b>sv</b> exits 100 on error. +<p> +If <b>sv</b> is called with a base name other than <b>sv</b>, it exits 1 on timeout or +trouble sending the command. If the <i>command</i> is <b>status</b>, it exits 3 if the +service is down, and 4 if the status is unknown. It exits 2 on wrong usage, +and 151 on error. +<h2><a name='sect8'>See Also</a></h2> +<i>runsv(8)</i>, <i>runsvdir(8)</i>, <i>runsvchdir(8)</i>, <i>chpst(8)</i>, +<i>svlogd(8)</i>, <i>runit(8)</i>, <i>runit-init(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> |