commit d96872c0cebd1a3366e7aaf9d4cceb4a5ceb8ea2
parent 345e3f4cea0993e8c1bbaa21436069a59cf2a226
Author: Gerrit Pape <pape@smarden.org>
Date: Mon, 21 Oct 2002 14:16:56 +0000
add manpages for not installed by default programs.
Diffstat:
8 files changed, 349 insertions(+), 4 deletions(-)
diff --git a/Makefile b/Makefile
@@ -3,7 +3,7 @@ DESTDIR=
PACKAGE=runit-0.7.0
DIRS=doc man etc package src
MANPAGES=runit.8 runit-init.8 runsvdir.8 runsv.8 svwaitdown.8 svwaitup.8 \
-utmpset.8 runsvchdir.8
+utmpset.8 runsvchdir.8 runsvstat.8 runsvctrl.8
all: clean .manpages $(PACKAGE).tar.gz
diff --git a/debian/runsvctrl.8 b/debian/runsvctrl.8
@@ -2,7 +2,7 @@
.SH NAME
runsvctrl \- controls a service monitored by
.BR runsv (8).
-.SH hSYNOPSIS
+.SH SYNOPSIS
.B runsvctrl
.I command
.I services
diff --git a/doc/index.html b/doc/index.html
@@ -27,7 +27,12 @@ Dependencies</a><br>
<br>
<a href="utmpset.8.html">The <tt>utmpset</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>
+<a href="svwaitup.8.html">The <tt>svwaitup</tt> program</a><br>
+<br>
+<a href="runsvstat.8.html">The <tt>runsvstat</tt> program</a>
+(not installed by default)<br>
+<a href="runsvctrl.8.html">The <tt>runsvctrl</tt> program</a>
+(not installed by default)
<hr>
<i>runit</i> is a
<a href="http://cr.yp.to/daemontools.html">daemontools</a> alike
diff --git a/doc/runsv.8.html b/doc/runsv.8.html
@@ -98,7 +98,7 @@ example, to send a TERM signal to /service/socklog-unix, either do # svc
# 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> usally
+<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>
If
diff --git a/doc/runsvctrl.8.html b/doc/runsvctrl.8.html
@@ -0,0 +1,105 @@
+
+
+
+<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 <B><I>runsv</B>(8)</I>.
+<H2><A NAME="sect1">hSYNOPSIS</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 <B><I>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 <B><I>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. </LI><B></B><LI>User-defined 1. If the service is running, send it a
+USR1 signal. </LI><B></B><LI>User-defined 2. 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, <B><I>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, <B><I>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 <B><I>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>runsvstat(8)</I>, <I>runit(8)</I>,
+<I>runit-init(8)</I>, <I>runsvdir(8)</I>, <I>runsv(8)</I>, <I>svwaitdown(8)</I>, <I>svwaitup(8)</I> <P>
+ <I>http://smarden.org/runit/</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">hSYNOPSIS</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
@@ -0,0 +1,61 @@
+
+
+
+<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 <B><I>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 <B><I>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 <B><I>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 <B><I>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>runsvctrl(8)</I>, <I>runit(8)</I>,
+<I>runit-init(8)</I>, <I>runsvdir(8)</I>, <I>runsv(8)</I>, <I>svwaitdown(8)</I>, <I>svwaitup(8)</I> <P>
+ <I>http://smarden.org/runit/</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/man/runsvctrl.8 b/man/runsvctrl.8
@@ -0,0 +1,108 @@
+.TH runsvctrl 8
+.SH NAME
+runsvctrl \- controls a service monitored by
+.BR runsv (8).
+.SH SYNOPSIS
+.B runsvctrl
+.I command
+.I services
+.SH DESCRIPTION
+.I services
+consists of one or more arguments, each argument naming a directory used by
+.BR runsv (8).
+.I command
+is one of up, down, once, pause, cont, hup, alarm, interrupt, 1, 2, term,
+kill, or exit.
+.P
+For each
+.I service
+of
+.IR services ,
+.B runsvctrl
+sends the command
+.I command
+to the
+.IR service ,
+which must be controlled by
+.BR runsv (8).
+.SH COMMANDS
+.TP
+.B up
+If the service is not running, start it. If the service stops, restart it.
+.TP
+.B 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.
+.TP
+.B once
+If the service is not running, start it. Do not restart it if it stops.
+.TP
+.B pause
+If the service is running, send it a STOP signal.
+.TP
+.B cont
+If the service is running, send it a CONT signal.
+.TP
+.B hup
+If the service is running, send it a HUP signal.
+.TP
+.B alarm
+If the service is running, send it a ALRM signal.
+.TP
+.B interrupt
+If the service is running, send it a INT signal.
+.TP
+.B 1
+User-defined 1. If the service is running, send it a USR1 signal.
+.TP
+.B 2
+User-defined 2. If the service is running, send it a USR2 signal.
+.TP
+.B term
+If the service is running, send it a TERM signal.
+.TP
+.B kill
+If the service is running, send it a KILL signal.
+.TP
+.B 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,
+.BR runsv (8)
+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,
+.BR runsv (8)
+exits. This command is ignored if it is given to
+.IR service /log/supervise/control.
+.P
+.BR runsvctrl
+actually looks only at the first character of
+.IR command .
+.SH EXIT CODES
+.B runsvctrl
+exits 0, if the
+.I command
+was sent successfully to all
+.IR services .
+.P
+For each
+.I service
+that caused an error (e.g. the directory is not controlled by a
+.BR runsv (8)
+process),
+.B runsvctrl
+increases the exit code by one and exits non zero. The maximum is 100.
+.P
+.B runsvctrl
+exits 111 on error.
+.SH SEE ALSO
+runsvstat(8),
+runit(8),
+runit-init(8),
+runsvdir(8),
+runsv(8),
+svwaitdown(8),
+svwaitup(8)
+.P
+ http://smarden.org/runit/
+.SH AUTHOR
+Gerrit Pape <pape@smarden.org>
diff --git a/man/runsvstat.8 b/man/runsvstat.8
@@ -0,0 +1,66 @@
+.TH runsvstat 8
+.SH NAME
+runsvstat \- prints the status of services monitored by
+.BR runsv (8).
+.SH SYNOPSIS
+.B runsvstat
+[
+.B \-l
+]
+.I services
+.SH DESCRIPTION
+.I services
+consists of one or more arguments, each argument naming a directory.
+.P
+.B runsvstat
+checks for each directory if
+.BR runsv (8)
+is successfully running this
+.IR service ,
+and if so, prints one human-readable line reporting the status of this
+.IR service .
+Optionally
+.BR runsvstat (8)
+prints a second line, also in human-readable format, reporting the status
+of the corresponding
+.I log
+.IR service .
+.SH OPTIONS
+.TP
+.B -l
+log service. Check for each
+.I service
+if there exists a corresponding
+.I log
+.IR service .
+If so, print an additional, indented, line reporting the status of the
+.I log
+.IR service .
+.SH EXIT CODES
+.B runsvstat
+exits 0, if the states of all
+.I services
+were reported successfully.
+.P
+For each
+.I service
+that caused an error (e.g. the directory is not controlled by a
+.BR runsv (8)
+process),
+.B runsvstat
+increases the exit code by one and exits non zero. The maximum is 100.
+.P
+.B runsvstat
+exits 111 on error.
+.SH SEE ALSO
+runsvctrl(8),
+runit(8),
+runit-init(8),
+runsvdir(8),
+runsv(8),
+svwaitdown(8),
+svwaitup(8)
+.P
+ http://smarden.org/runit/
+.SH AUTHOR
+Gerrit Pape <pape@smarden.org>
