summary refs log tree commit diff
path: root/man
diff options
context:
space:
mode:
authorGerrit Pape <pape@smarden.org>2004-03-28 18:17:35 +0000
committerGerrit Pape <pape@smarden.org>2004-03-28 18:17:35 +0000
commit05dd48613e140530ed4feea11db539fa1158eefb (patch)
treecd8cc1c15a15642fde6a258e90a8ce247015308c /man
parent14575be847d9741724337326dcf17a46df73021f (diff)
downloadrunit-05dd48613e140530ed4feea11db539fa1158eefb.tar.gz
runit-05dd48613e140530ed4feea11db539fa1158eefb.tar.xz
runit-05dd48613e140530ed4feea11db539fa1158eefb.zip
* man/svlogd.8: timestamps are not considered when matching patterns (thx
    Andras KORN).
  * runsv.c: on exit run the finish scripts when taking the service down
    (thx X.).
  * runsv.c, runsvctrl.c: handle sig_quit (thx Wayne Marshall).
  * svlogd.c: don't crash on zero byte long config file (thx Alex Efros).
  * man/*: minor cleanup.
Diffstat (limited to 'man')
-rw-r--r--man/runit-init.818
-rw-r--r--man/runit.817
-rw-r--r--man/runsv.812
-rw-r--r--man/runsvchdir.87
-rw-r--r--man/runsvctrl.843
-rw-r--r--man/runsvdir.828
-rw-r--r--man/runsvstat.815
-rw-r--r--man/svlogd.816
-rw-r--r--man/svwaitdown.814
-rw-r--r--man/svwaitup.818
-rw-r--r--man/utmpset.813
11 files changed, 125 insertions, 76 deletions
diff --git a/man/runit-init.8 b/man/runit-init.8
index 7dc9f92..aa48cb1 100644
--- a/man/runit-init.8
+++ b/man/runit-init.8
@@ -6,7 +6,8 @@ init \- a UNIX process no 1
 [ 0 | 6 ]
 .SH DESCRIPTION
 .B runit-init
-is the first process the kernel starts. If
+is the first process the kernel starts.
+If
 .B runit-init
 is started as process no 1, it runs and replaces itself with
 .BR runit (8).
@@ -19,7 +20,8 @@ or
 .B init 6\fR:
 .TP
 .B init 0
-tells the Unix process no 1 to shutdown and halt the system. To signal
+tells the Unix process no 1 to shutdown and halt the system.
+To signal
 .BR runit (8)
 the system halt request,
 .B runit-init
@@ -32,7 +34,8 @@ Then a CONT signal is sent to
 .BR runit (8).
 .TP
 .B init 6
-tells the Unix process no 1 to shutdown and reboot the system. To signal
+tells the Unix process no 1 to shutdown and reboot the system.
+To signal
 .BR runit (8)
 the system reboot request,
 .B runit-init
@@ -47,13 +50,14 @@ and
 returns 111 on error, 0 in all other cases.
 .SH SEE ALSO
 runit(8),
+runsvdir(8),
+runsvchdir(8),
+utmpset(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-runsvdir(8),
-runsvchdir(8),
-svlogd(8),
-utmpset(8)
+chpst(8),
+svlogd(8)
 .P
 http://smarden.org/runit/
 .SH AUTHOR
diff --git a/man/runit.8 b/man/runit.8
index a451316..4461065 100644
--- a/man/runit.8
+++ b/man/runit.8
@@ -5,13 +5,14 @@ runit \- a UNIX process no 1
 .B runit
 .SH DESCRIPTION
 .B runit
-must be run as Unix process no 1. It performs the system's
-booting, running, and shutdown in three Stages:
+must be run as Unix process no 1.
+It performs the system's booting, running, and shutdown in three Stages:
 .SH STAGE 1
 .B runit
 runs
 .I /etc/runit/1
-and waits for it to terminate. The system's one time tasks are done here.
+and waits for it to terminate.
+The system's one time tasks are done here.
 .I /etc/runit/1
 has full control of
 .I /dev/console
@@ -26,7 +27,8 @@ will skip stage 2 and enter stage 3.
 runs
 .IR /etc/runit/2 ,
 which should not return until system shutdown; if it crashes, it will be
-restarted. Normally
+restarted.
+Normally
 .I /etc/runit/2
 starts
 .BR runsvdir (8).
@@ -74,13 +76,14 @@ receives an INT signal, a ctrl-alt-del keyboard request is triggered.
 runit-init(8),
 runsvdir(8),
 runsvchdir(8),
+utmpset(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-svwaitdown(8),
-svwaitup(8),
+chpst(8),
 svlogd(8),
-utmpset(8)
+svwaitdown(8),
+svwaitup(8)
 .P
 http://smarden.org/runit/
 .SH AUTHOR
diff --git a/man/runsv.8 b/man/runsv.8
index 70da0d3..769c7f2 100644
--- a/man/runsv.8
+++ b/man/runsv.8
@@ -86,8 +86,7 @@ After it stops, do not restart service.
 .B o
 Once.
 If the service is not running, start it.
-Do not restart it if it
-stops.
+Do not restart it if it stops.
 .TP
 .B p
 Pause.
@@ -109,6 +108,9 @@ If the service is running, send it a ALRM signal.
 Interrupt.
 If the service is running, send it a INT signal.
 .TP
+.B q
+Quit.
+If the service is running, send it a QUIT signal.
 .B 1
 User-defined 1.
 If the service is running, send it a USR1 signal.
@@ -172,13 +174,13 @@ exits 0 if it was told to exit.
 .SH SEE ALSO
 runsvctrl(8),
 runsvstat(8),
+chpst(8),
+svlogd(8),
 runit(8),
 runit-init(8),
 runsvdir(8),
 runsvchdir(8),
-svlogd(8),
-svwaitdown(8),
-svwaitup(8),
+utmpset(8)
 .P
 http://smarden.org/runit/
 .SH AUTHOR
diff --git a/man/runsvchdir.8 b/man/runsvchdir.8
index 30294c9..8e54cad 100644
--- a/man/runsvchdir.8
+++ b/man/runsvchdir.8
@@ -45,11 +45,14 @@ exits 0 on success.
  /etc/runit/runsvdir/current.new
 .SH SEE ALSO
 runsvdir(8),
+runit(8),
+runit-init(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-runit(8),
-runit-init(8),
+chpst(8),
+svlogd(8),
+utmpset(8),
 svwaitdown(8),
 svwaitup(8)
 .P
diff --git a/man/runsvctrl.8 b/man/runsvctrl.8
index bf19bd5..d804e02 100644
--- a/man/runsvctrl.8
+++ b/man/runsvctrl.8
@@ -28,14 +28,17 @@ which must be controlled by
 .SH COMMANDS
 .TP
 .B up
-If the service is not running, start it. If the service stops, restart it.
+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.
+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.
+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.
@@ -52,11 +55,16 @@ If the service is running, send it a ALRM signal.
 .B interrupt
 If the service is running, send it a INT signal.
 .TP
+.B quit
+If the service is running, send it a QUIT signal.
+.TP
 .B 1
-User-defined 1. If the service is running, send it a USR1 signal.
+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.
+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.
@@ -65,13 +73,17 @@ If the service is running, send it a TERM signal.
 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,
+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,
+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
+exits.
+This command is ignored if it is given to
 .IR service /log/supervise/control.
 .P
 .BR runsvctrl
@@ -90,18 +102,21 @@ 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.
+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),
 runsv(8),
+runsvstat(8),
+chpst(8),
+svlogd(8),
 runit(8),
 runit-init(8),
 runsvdir(8),
 runsvchdir(8),
-svlogd(8),
+utmpset(8),
 svwaitdown(8),
 svwaitup(8)
 .P
diff --git a/man/runsvdir.8 b/man/runsvdir.8
index 7b6470d..9065bbc 100644
--- a/man/runsvdir.8
+++ b/man/runsvdir.8
@@ -31,19 +31,21 @@ At least every five seconds,
 .B runsvdir
 checks if
 .I dir
-has changed. If it sees a new subdirectory in
+has changed.
+If it sees a new subdirectory in
 .IR dir ,
 it starts a new
 .BR runsv (8)
-process. If it sees an old sudirectory where a
+process.
+If it sees an old sudirectory where a
 .BR runsv (8)
 process has exited, it restarts the
 .BR runsv (8)
 process.
 If
 .B runsvdir
-sees a subdirectory being removed that was previously there, it sends
-the corresponding
+sees a subdirectory being removed that was previously there, it sends the
+corresponding
 .BR runsv (8)
 process a TERM signal, stops monitoring this process, and so does not
 restart the
@@ -58,12 +60,12 @@ all output to standard error is redirected to this
 .IR log ,
 which is similar to the
 .BR readproctitle (8)
-log. To see the most recent error messages, use a process-listing tool
-such as
+log.
+To see the most recent error messages, use a process-listing tool such as
 .BR ps (1).
 .B runsvdir
-writes a dot to the readproctitle log every 15 minutes so that old
-error messages expire.
+writes a dot to the readproctitle log every 15 minutes so that old error
+messages expire.
 .P
 Normally
 .B runsvdir
@@ -81,15 +83,17 @@ receives a HUP signal, it sends a TERM signal to each
 .BR runsv (8)
 process it is monitoring and then exits with 111.
 .SH SEE ALSO
-runsvchdir(8),
 runsv(8),
-runsvctrl(8),
-runsvstat(8),
 runit(8),
 runit-init(8),
+runsvchdir(8),
+runsvctrl(8),
+runsvstat(8),
+chpst(8),
 svlogd(8),
+utmpset(8),
 svwaitdown(8),
-svwaitup(8),
+svwaitup(8)
 .P
 http://smarden.org/runit/
 .SH AUTHOR
diff --git a/man/runsvstat.8 b/man/runsvstat.8
index 9e68002..05bb491 100644
--- a/man/runsvstat.8
+++ b/man/runsvstat.8
@@ -28,7 +28,8 @@ of the corresponding
 .SH OPTIONS
 .TP
 .B \-l
-log service. Check for each
+log service.
+Check for each
 .I service
 if there exists a corresponding
 .I log
@@ -48,18 +49,20 @@ 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.
+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),
 runsv(8),
-runsvdir(8),
-runsvchdir(8),
+runsvctrl(8),
+chpst(8),
+svlogd(8),
 runit(8),
 runit-init(8),
-svlogd(8),
+runsvdir(8),
+runsvchdir(8),
 svwaitdown(8),
 svwaitup(8)
 .P
diff --git a/man/svlogd.8 b/man/svlogd.8
index 93a58b1..5dd4f85 100644
--- a/man/svlogd.8
+++ b/man/svlogd.8
@@ -122,8 +122,8 @@ is started again.
 .B svlogd
 also saves any output that the
 .I processor
-writes to file descriptor 5, and make that output available on
-file descriptor 4 when it runs
+writes to file descriptor 5, and make that output available on file
+descriptor 4 when it runs
 .I processor
 on the next log file rotation.
 .P
@@ -282,6 +282,10 @@ character in
 A star at the end of
 .I pattern
 matches any string.
+.P
+Timestamps optionally added by
+.B svlogd
+are not considered part of the log message.
 .SH OPTIONS
 .TP
 .B \-t
@@ -370,12 +374,14 @@ with a non empty
 log file.
 .SH SEE ALSO
 runsv(8),
-runsvstat(8),
 runsvctrl(8),
-runsvdir(8),
-runsvchdir(8),
+runsvstat(8),
+chpst(8),
 runit(8),
 runit-init(8),
+runsvdir(8),
+runsvchdir(8),
+utmpset(8),
 multilog(8)
 .P
 http://smarden.org/runit/
diff --git a/man/svwaitdown.8 b/man/svwaitdown.8
index 9d78ed1..36321d7 100644
--- a/man/svwaitdown.8
+++ b/man/svwaitdown.8
@@ -95,23 +95,25 @@ For each
 .I service
 that causes an error while checking,
 .B svwaitdown
-increases the exit code by one and exits non zero. The maximum is 100.
+increases the exit code by one and exits non zero.
+The maximum is 100.
 .P
 .B svwaitdown
 returns 111 if the timeout
 .I sec
 was reached.
 .SH SEE ALSO
-svwaitdown(8),
+svwaitup(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-runsvdir(8),
-runsvchdir(8),
+chpst(8),
+svlogd(8),
 runit(8),
 runit-init(8),
-supervise(8),
-svscan(8)
+runsvdir(8),
+runsvchdir(8),
+utmpset(8)
 .P
  http://smarden.org/runit/
  http://cr.yp.to/daemontools.html
diff --git a/man/svwaitup.8 b/man/svwaitup.8
index 476cce1..fe61ef6 100644
--- a/man/svwaitup.8
+++ b/man/svwaitup.8
@@ -13,7 +13,8 @@ svwaitup \- waits for services controlled by runsv(8) or supervise(8) to be up
 .I services
 .SH DESCRIPTION
 .I services
-consist of one or more arguments. Each
+consist of one or more arguments.
+Each
 .I service
 directory must start with a slash.
 .P
@@ -49,7 +50,8 @@ has to be up to
 .I sec
 seconds.
 .I sec
-must be between 2 and 600. Default is 2.
+must be between 2 and 600.
+Default is 2.
 .SH EXIT CODES
 .B svwaitup
 returns 0 as soon as all
@@ -82,7 +84,8 @@ checking (e.g.
 .BR runsv (8)
 is not running),
 .B svwaitup
-increases the exit code by one and exits non zero. The maximum is 100.
+increases the exit code by one and exits non zero.
+The maximum is 100.
 .P
 .B svwaitup
 returns 111 on error.
@@ -91,12 +94,13 @@ svwaitdown(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-runsvdir(8),
-runsvchdir(8),
+chpst(8),
+svlogd(8),
 runit(8),
 runit-init(8),
-supervise(8),
-svscan(8)
+runsvdir(8),
+runsvchdir(8),
+utmpset(8)
 .P
  http://smarden.org/runit/
  http://cr.yp.to/daemontools.html
diff --git a/man/utmpset.8 b/man/utmpset.8
index 01dd442..8272af7 100644
--- a/man/utmpset.8
+++ b/man/utmpset.8
@@ -20,7 +20,8 @@ has logged out.
 .P
 Ordinary
 .BR init (8)
-processes handle utmp file records for local login accounting. The
+processes handle utmp file records for local login accounting.
+The
 .BR runit (8)
 program doesn't include code to update the utmp file, the
 .BR getty (8)
@@ -47,13 +48,15 @@ to the wtmp file.
 .B utmpset
 returns 111 on error, 1 on wrong usage, 0 in all other cases.
 .SH SEE ALSO
+runit(8),
+runit-init(8)
+runsvdir(8),
+runsvchdir(8),
 runsv(8),
 runsvctrl(8),
 runsvstat(8),
-runsvdir(8),
-runsvchdir(8),
-runit(8),
-runit-init(8),
+chpst(8),
+svlogd(8),
 getty(8)
 .P
 http://smarden.org/runit/