summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorGerrit Pape <pape@smarden.org>2006-05-10 20:58:26 +0000
committerGerrit Pape <pape@smarden.org>2006-05-10 20:58:26 +0000
commit2e3297e68726f529958c5d5ac0ec95566f21fa69 (patch)
treeeb70b3169cab4a26e38bfc04c077dcae344dca92 /doc
parentfed0b5a233e677db02a4e52a107dd8daaa347b36 (diff)
downloadrunit-2e3297e68726f529958c5d5ac0ec95566f21fa69.tar.gz
runit-2e3297e68726f529958c5d5ac0ec95566f21fa69.tar.xz
runit-2e3297e68726f529958c5d5ac0ec95566f21fa69.zip
* man/runsvctrl.8, man/runsvstat.8, man/svwaitup.8, man/svwaitdown.8,
    doc/runsvctrl.html, doc/runsvstat.html, doc/svwaitdown.html,
    doc/svwaitup.html: remove; obsolete.
Diffstat (limited to 'doc')
-rw-r--r--doc/runsvctrl.8.html114
-rw-r--r--doc/runsvstat.8.html62
-rw-r--r--doc/svwaitdown.8.html79
-rw-r--r--doc/svwaitup.8.html72
4 files changed, 0 insertions, 327 deletions
diff --git a/doc/runsvctrl.8.html b/doc/runsvctrl.8.html
deleted file mode 100644
index f067e32..0000000
--- a/doc/runsvctrl.8.html
+++ /dev/null
@@ -1,114 +0,0 @@
-
-
-
-<html>
-<head>
-<title>runsvctrl(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>
-runsvctrl - controls a service monitored by <i><b>runsv</b>(8)</i>. 
-<h2><a name='sect1'>Synopsis</a></h2>
-<b>runsvctrl</b>
-<i>command</i> <i>services</i> 
-<h2><a name='sect2'>Description</a></h2>
-<i>services</i> consists of one or more arguments,
-each argument naming a directory used by <i><b>runsv</b>(8)</i>. <i>command</i> is one of up,
-down, once, pause, cont, hup, alarm, interrupt, 1, 2, term, kill, or exit.
-<p>
-For each <i>service</i> of <i>services</i>, <b>runsvctrl</b> sends the command <i>command</i> to the
-<i>service</i>, which must be controlled by <i><b>runsv</b>(8)</i>. 
-<h2><a name='sect3'>Commands</a></h2>
-
-<dl>
-
-<dt><b>up</b> </dt>
-<dd>If the service
-is not running, start it. If the service stops, restart it. </dd>
-
-<dt><b>down</b> </dt>
-<dd>If the service
-is running, send it a TERM signal. If ./run exits, start ./finish if it exists.
-After it stops, do not restart service. </dd>
-
-<dt><b>once</b> </dt>
-<dd>If the service is not running,
-start it. Do not restart it if it stops. </dd>
-
-<dt><b>pause</b> </dt>
-<dd>If the service is running,
-send it a STOP signal. </dd>
-
-<dt><b>cont</b> </dt>
-<dd>If the service is running, send it a CONT signal.
-</dd>
-
-<dt><b>hup</b> </dt>
-<dd>If the service is running, send it a HUP signal. </dd>
-
-<dt><b>alarm</b> </dt>
-<dd>If the service
-is running, send it a ALRM signal. </dd>
-
-<dt><b>interrupt</b> </dt>
-<dd>If the service is running,
-send it a INT signal. </dd>
-
-<dt><b>quit</b> </dt>
-<dd>If the service is running, send it a QUIT signal. </dd>
-
-<dt><b>1</b> </dt>
-<dd>If the service is running, send it a USR1 signal. </dd>
-
-<dt><b>2</b> </dt>
-<dd>If the service is running, send it a USR2 signal. </dd>
-
-<dt><b>term</b> </dt>
-<dd>If the service is running, send it a TERM signal.
-</dd>
-
-<dt><b>kill</b> </dt>
-<dd>If the service is running, send it a KILL signal. </dd>
-
-<dt><b>exit</b> </dt>
-<dd>If the service
-is running, send it a TERM signal. Do not restart the service. If the service
-is down, and no log service exists, <i><b>runsv</b>(8)</i> exits. If the service is down
-and a log service exists, send a TERM signal to the log service. If the
-log service is down, <i><b>runsv</b>(8)</i> exits. This command is ignored if it is given
-to <i>service</i>/log/supervise/control. </dd>
-</dl>
-<p>
-<b>runsvctrl</b> actually looks only at the first
-character of <i>command</i>. 
-<h2><a name='sect4'>Exit Codes</a></h2>
-<b>runsvctrl</b> exits 0, if the <i>command</i> was sent
-successfully to all <i>services</i>. <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), <b>runsvctrl</b> increases
-the exit code by one and exits non zero. The maximum is 100. <p>
-<b>runsvctrl</b> exits
-111 on error. 
-<h2><a name='sect5'>See Also</a></h2>
-<i>sv(8)</i>, <i>runsv(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>runsvstat(8)</i> <p>
-<i>http://smarden.org/runit/</i> 
-<h2><a name='sect6'>Author</a></h2>
-Gerrit
-Pape &lt;pape@smarden.org&gt; <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'>Commands</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/runsvstat.8.html b/doc/runsvstat.8.html
deleted file mode 100644
index 0e89576..0000000
--- a/doc/runsvstat.8.html
+++ /dev/null
@@ -1,62 +0,0 @@
-
-
-
-<html>
-<head>
-<title>runsvstat(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>
-runsvstat - prints the status of services monitored by <i><b>runsv</b>(8)</i>. 
-<h2><a name='sect1'>Synopsis</a></h2>
-<b>runsvstat</b>
-[ <b>-l</b> ] <i>services</i> 
-<h2><a name='sect2'>Description</a></h2>
-<i>services</i> consists of one or more arguments, each
-argument naming a directory. <p>
-<b>runsvstat</b> checks for each directory if <i><b>runsv</b>(8)</i>
-is successfully running this <i>service</i>, and if so, prints one human-readable
-line reporting the status of this <i>service</i>. Optionally <i><b>runsvstat</b>(8)</i> prints
-a second line, also in human-readable format, reporting the status of the
-corresponding <i>log</i> <i>service</i>. 
-<h2><a name='sect3'>Options</a></h2>
-
-<dl>
-
-<dt><b>-l</b> </dt>
-<dd>log service. Check for each <i>service</i> if
-there exists a corresponding <i>log</i> <i>service</i>. If so, print an additional, indented,
-line reporting the status of the <i>log</i> <i>service</i>. </dd>
-</dl>
-
-<h2><a name='sect4'>Exit Codes</a></h2>
-<b>runsvstat</b> exits
-0, if the states of all <i>services</i> were reported successfully. <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), <b>runsvstat</b> increases the exit code by one and exits non zero. The
-maximum is 100. <p>
-<b>runsvstat</b> exits 111 on error. 
-<h2><a name='sect5'>See Also</a></h2>
-<i>sv(8)</i>, <i>runsv(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>runsvctrl(8)</i>
-<p>
-<i>http://smarden.org/runit/</i> 
-<h2><a name='sect6'>Author</a></h2>
-Gerrit Pape &lt;pape@smarden.org&gt; <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/svwaitdown.8.html b/doc/svwaitdown.8.html
deleted file mode 100644
index 934e43b..0000000
--- a/doc/svwaitdown.8.html
+++ /dev/null
@@ -1,79 +0,0 @@
-
-
-
-<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>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> 
-<h2><a name='sect2'>Description</a></h2>
-<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 &lsquo;&lsquo;down&rsquo;&rsquo; 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>-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 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>
-
-<dt><b>-x</b> </dt>
-<dd>Exit. Send each <i>service</i> the &lsquo;&lsquo;exit&rsquo;&rsquo; command
-additionally to the &lsquo;&lsquo;down&rsquo;&rsquo; 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)</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>sv(8)</i>, <i>runsv(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>svwaitup(8)</i>
-<p>
-<i>http://smarden.org/runit/</i> 
-<h2><a name='sect6'>Author</a></h2>
-Gerrit Pape &lt;pape@smarden.org&gt; <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
deleted file mode 100644
index 65833a6..0000000
--- a/doc/svwaitup.8.html
+++ /dev/null
@@ -1,72 +0,0 @@
-
-
-
-<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>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> 
-<h2><a name='sect2'>Description</a></h2>
-<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>
-
-<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 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 111 on error. 
-<h2><a name='sect5'>See Also</a></h2>
-<i>sv(8)</i>,
-<i>runsv(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>svwaitdown(8)</i> <p>
-<i>http://smarden.org/runit/</i> 
-<h2><a name='sect6'>Author</a></h2>
-Gerrit Pape &lt;pape@smarden.org&gt;
-<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>