diff options
| author | Gerrit Pape <pape@smarden.org> | 2003-09-23 08:13:27 +0000 |
|---|---|---|
| committer | Gerrit Pape <pape@smarden.org> | 2003-09-23 08:13:27 +0000 |
| commit | 601c68e000e9f17e48b40d5aae52acff397c1b16 (patch) | |
| tree | d1d3971612b5a19dbff24fb10bd86b7cb7c51b5e /doc/runsv.8.html | |
| parent | ecb49a81572f39731df4e7bcbc1dd071e6592547 (diff) | |
| download | runit-601c68e000e9f17e48b40d5aae52acff397c1b16.tar.gz runit-601c68e000e9f17e48b40d5aae52acff397c1b16.tar.xz runit-601c68e000e9f17e48b40d5aae52acff397c1b16.zip | |
html.
Diffstat (limited to 'doc/runsv.8.html')
| -rw-r--r-- | doc/runsv.8.html | 223 |
1 files changed, 111 insertions, 112 deletions
diff --git a/doc/runsv.8.html b/doc/runsv.8.html index 6f44c86..8c16d10 100644 --- a/doc/runsv.8.html +++ b/doc/runsv.8.html @@ -1,140 +1,139 @@ -<HTML> -<HEAD> -<TITLE>runsv(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> +<html> +<head> +<title>runsv(8) manual page</title> +</head> +<body bgcolor='white'> +<a href='#toc'>Table of Contents</a><p> + +<h2><a name='sect0' href='#toc0'>Name</a></h2> runsv - starts and monitors a service and optionally an appendant log service -<H2><A NAME="sect1">Synopsis</A></H2> -<B>runsv</B> <I>service</I> -<H2><A NAME="sect2">Description</A></H2> -<I>service</I> must be a directory. <P> -<B>runsv</B> -switches to the directory <I>service</I> and starts ./run. if ./run exits and ./finish -exists, <B>runsv</B> starts ./finish. If ./finish doesn't exist or ./finish exits, -<B>runsv</B> restarts ./run. <P> -If ./run or ./finish exit immediately, <B>runsv</B> waits a -second before starting ./finish or restarting ./run. <P> -If the file <I>service</I>/down -exists, <B>runsv</B> does not start ./run immediately. The control interface (see -below) can be used to start the service and to give other commands to <B>runsv</B>. -<P> -If the directory <I>service</I>/log exists, <B>runsv</B> creates a pipe, redirects <I>service</I>/run's -and <I>service</I>/finish's standard output to the pipe, switches to the directory -<I>service</I>/log and starts ./run (and ./finish) exactly as described above for -the <I>service</I> directory. The standard input of the log service a redirected -to read from the pipe. <P> -<B>runsv</B> maintains status information in a binary format -compatible to <B><I>supervise</B>(8)</I> in <I>service</I>/supervise/status and <I>service</I>/log/supervise/status, -and in a human-readable format in <I>service</I>/supervise/stat, <I>service</I>/log/supervise/stat, -<I>service</I>/supervise/pid, <I>service</I>/log/supervise/pid. -<H2><A NAME="sect3">Control</A></H2> +<h2><a name='sect1' href='#toc1'>Synopsis</a></h2> +<b>runsv</b> <i>service</i> +<h2><a name='sect2' href='#toc2'>Description</a></h2> +<i>service</i> must be a directory. <p> +<b>runsv</b> +switches to the directory <i>service</i> and starts ./run. if ./run exits and ./finish +exists, <b>runsv</b> starts ./finish. If ./finish doesn’t exist or ./finish exits, +<b>runsv</b> restarts ./run. <p> +If ./run or ./finish exit immediately, <b>runsv</b> waits a +second before starting ./finish or restarting ./run. <p> +If the file <i>service</i>/down +exists, <b>runsv</b> does not start ./run immediately. The control interface (see +below) can be used to start the service and to give other commands to <b>runsv</b>. +<p> +If the directory <i>service</i>/log exists, <b>runsv</b> creates a pipe, redirects <i>service</i>/run’s +and <i>service</i>/finish’s standard output to the pipe, switches to the directory +<i>service</i>/log and starts ./run (and ./finish) exactly as described above for +the <i>service</i> directory. The standard input of the log service a redirected +to read from the pipe. <p> +<b>runsv</b> maintains status information in a binary format +compatible to <i><b>supervise</b>(8)</i> in <i>service</i>/supervise/status and <i>service</i>/log/supervise/status, +and in a human-readable format in <i>service</i>/supervise/stat, <i>service</i>/log/supervise/stat, +<i>service</i>/supervise/pid, <i>service</i>/log/supervise/pid. +<h2><a name='sect3' href='#toc3'>Control</a></h2> The named pipes -<I>service</I>/supervise/control, and (optionally) <I>service</I>/log/supervise/control -are provided to give commands to <B>runsv</B>. You can use <B><I>svc</B>(8)</I> to control the +<i>service</i>/supervise/control, and (optionally) <i>service</i>/log/supervise/control +are provided to give commands to <b>runsv</b>. You can use <i><b>svc</b>(8)</i> to control the service or just write one of the following characters to the named pipe: -<DL> +<dl> -<DT><B>u</B> </DT> -<DD>Up. If the service is not running, start it. If the service stops, restart -it. </DD> +<dt><b>u</b> </dt> +<dd>Up. If the service is not running, start it. If the service stops, restart +it. </dd> -<DT><B>d</B> </DT> -<DD>Down. 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>d</b> </dt> +<dd>Down. 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>o</B> </DT> -<DD>Once. -If the service is not running, start it. Do not restart it if it stops. </DD> +<dt><b>o</b> </dt> +<dd>Once. +If the service is not running, start it. Do not restart it if it stops. </dd> -<DT><B>p</B> -</DT> -<DD>Pause. If the service is running, send it a STOP signal. </DD> +<dt><b>p</b> +</dt> +<dd>Pause. If the service is running, send it a STOP signal. </dd> -<DT><B>c</B> </DT> -<DD>Continue. If the -service is running, send it a CONT signal. </DD> +<dt><b>c</b> </dt> +<dd>Continue. If the +service is running, send it a CONT signal. </dd> -<DT><B>h</B> </DT> -<DD>Hangup. If the service is running, -send it a HUP signal. </DD> +<dt><b>h</b> </dt> +<dd>Hangup. If the service is running, +send it a HUP signal. </dd> -<DT><B>a</B> </DT> -<DD>Alarm. If the service is running, send it a ALRM -signal. </DD> +<dt><b>a</b> </dt> +<dd>Alarm. If the service is running, send it a ALRM +signal. </dd> -<DT><B>i</B> </DT> -<DD>Interrupt. If the service is running, send it a INT signal. </DD> +<dt><b>i</b> </dt> +<dd>Interrupt. If the service is running, send it a INT signal. -<DT><B>1</B> </DT> -<DD>User-defined 1. -If the service is running, send it a USR1 signal. </DD> +<dt><b>1</b> </dt> +<dd>User-defined 1. If the service is running, send it a USR1 signal. </dd> -<DT><B>2</B> </DT> -<DD>User-defined 2. -If the service is running, send it a USR2 signal. </DD> +<dt><b>2</b> </dt> +<dd>User-defined 2. If the service is running, send it a USR2 signal. </dd> -<DT><B>t</B> </DT> -<DD>Terminate. If the service is -running, send it a TERM signal. </DD> +<dt><b>t</b> </dt> +<dd>Terminate. If the service is +running, send it a TERM signal. </dd> -<DT><B>k</B> </DT> -<DD>Kill. If the service is running, send it -a KILL signal. </DD> +<dt><b>k</b> </dt> +<dd>Kill. If the service is running, send it +a KILL signal. </dd> -<DT><B>x or <B>e</B> </B></DT> -<DD>Exit. If the service is running, send it a TERM signal. +<dt><b>x or <b>e</b> </b></dt> +<dd>Exit. 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, -<B>runsv</B> exits. If the service is down and a log service exists, <B>runsv</B> closes +<b>runsv</b> exits. If the service is down and a log service exists, <b>runsv</b> closes the standard input of the log service, and waits for it to terminate. If -the log service is down, <B>runsv</B> exits. This command is ignored if it is given -to <I>service</I>/log/supervise/control. </DD> -</DL> -<P> +the log service is down, <b>runsv</b> exits. This command is ignored if it is given +to <i>service</i>/log/supervise/control. </dd> +</dl> +<p> For example, to send a TERM signal to -/service/socklog-unix, either do # svc -t /service/socklog-unix<BR> - or<BR> - # echo -n t >/service/socklog-unix/supervise/control<BR> - <P> -If <B><I>echo</B>(1)</I> on your systems does not provide the -n option, leave it out, -<B>runsv</B> ignores unknown characters written to the control pipe. <B><I>echo</B>(1)</I> usually -blocks if no <B>runsv</B> process is running in the service directory. -<H2><A NAME="sect4">Signals</A></H2> +/service/socklog-unix, either do # svc -t /service/socklog-unix<br> + or<br> + # echo -n t >/service/socklog-unix/supervise/control<br> + <p> +If <i><b>echo</b>(1)</i> on your systems does not provide the -n option, leave it out, +<b>runsv</b> ignores unknown characters written to the control pipe. <i><b>echo</b>(1)</i> usually +blocks if no <b>runsv</b> process is running in the service directory. +<h2><a name='sect4' href='#toc4'>Signals</a></h2> If -<B>runsv</B> receives a TERM signal, it acts as if the character x was written +<b>runsv</b> receives a TERM signal, it acts as if the character x was written to the control pipe. -<H2><A NAME="sect5">Exit Codes</A></H2> -<B>runsv</B> exits 111 on an error on startup or -if another <B>runsv</B> is running in <I>service</I>. <P> -<B>runsv</B> exits 0 if it was told to +<h2><a name='sect5' href='#toc5'>Exit Codes</a></h2> +<b>runsv</b> exits 111 on an error on startup or +if another <b>runsv</b> is running in <i>service</i>. <p> +<b>runsv</b> exits 0 if it was told to exit. -<H2><A NAME="sect6">See Also</A></H2> -<I>runsvctrl(8)</I>, <I>runsvstat(8)</I>, <I>runit(8)</I>, <I>runit-init(8)</I>, <I>runsvdir(8)</I>, -<I>runsvchdir(8)</I>, <I>svlogd(8)</I>, <I>svwaitdown(8)</I>, <I>svwaitup(8)</I>, <I>svc(8)</I>, <I>supervise(8)</I> -<P> - <I>http://smarden.org/runit/</I><BR> - <I>http://cr.yp.to/daemontools.html</I><BR> +<h2><a name='sect6' href='#toc6'>See Also</a></h2> +<i>runsvctrl(8)</i>, <i>runsvstat(8)</i>, <i>runit(8)</i>, <i>runit-init(8)</i>, <i>runsvdir(8)</i>, +<i>runsvchdir(8)</i>, <i>svlogd(8)</i>, <i>svwaitdown(8)</i>, <i>svwaitup(8)</i>, <i>svc(8)</i>, <i>supervise(8)</i> +<p> + <i>http://smarden.org/runit/</i><br> + <i>http://cr.yp.to/daemontools.html</i><br> -<H2><A NAME="sect7">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">Control</A></LI> -<LI><A NAME="toc4" HREF="#sect4">Signals</A></LI> -<LI><A NAME="toc5" HREF="#sect5">Exit Codes</A></LI> -<LI><A NAME="toc6" HREF="#sect6">See Also</A></LI> -<LI><A NAME="toc7" HREF="#sect7">Author</A></LI> -</UL> -</BODY></HTML> +<h2><a name='sect7' href='#toc7'>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'>Control</a></li> +<li><a name='toc4' href='#sect4'>Signals</a></li> +<li><a name='toc5' href='#sect5'>Exit Codes</a></li> +<li><a name='toc6' href='#sect6'>See Also</a></li> +<li><a name='toc7' href='#sect7'>Author</a></li> +</ul> +</body> +</html> |