commit 0371689c4f91e01806074556bcece40f91f69f1d
parent 2543ff373b417663b52569a0da6947a96357da69
Author: Gerrit Pape <pape@smarden.org>
Date: Sun, 13 Feb 2005 17:30:32 +0000
* doc/index.html, doc/replaceinit.html: no longer refer to sysvinit's
shutdown program.
* man/svlogd.8: svlogd doesn't decrease the number of log files in a log
directory; with n0 don't remove any log files.
Diffstat:
5 files changed, 104 insertions(+), 91 deletions(-)
diff --git a/doc/index.html b/doc/index.html
@@ -106,9 +106,8 @@ These are working examples for Debian sarge:
<p>
The program <a href="runit-init.8.html">runit-init</a> is intended to
replace <tt>/sbin/init</tt>.
-sysvinit's command <tt>shutdown</tt> will keep working.
-On *BSD systems use <b><tt>init 0</tt></b> for system halt and
-<b><tt>init 6</tt></b> for reboot.
+The command <b><tt>init 0</tt></b> tells <i>runit</i> to halt the system,
+and <b><tt>init 6</tt></b> to reboot.
<a href="runlevels.html">Runlevels</a> are handled through the
<a href="runsvdir.8.html">runsvdir</a> and
<a href="runsvchdir.8.html">runsvchdir</a> programs.
diff --git a/doc/replaceinit.html b/doc/replaceinit.html
@@ -113,7 +113,7 @@ Now it is time to replace the <i>sysvinit</i> <tt>/sbin/init</tt> binary:
The last step is to do the final reboot to boot the system with the new
default Unix process no 1 <i>runit</i>.
<pre>
- # shutdown -r now
+ # init 6
</pre>
To report success:
<pre>
diff --git a/doc/svlogd.8.html b/doc/svlogd.8.html
@@ -46,125 +46,127 @@ or is older than a specified amount of <i>time</i>, <i>current</i> is rotated: <
<b>svlogd</b>
closes <i>current</i>, changes permission of <i>current</i> to 0755, renames <i>current</i>
to @<i>timestamp.s,</i> and starts with a new empty <i>current</i>. If <b>svlogd</b> sees <i>num</i>
-or more old log files in <i>dir</i>, it removes the oldest one.
+or more old log files in the log directory, it removes the oldest one. Note
+that this doesn’t decrease the number of log files if there are already
+more than <i>num</i> log files.
<h3><a name='sect5'>Processor</a></h3>
-If <b>svlogd</b>
-is told to process recent log files, it saves <i>current</i> to @<i>timestamp.u,</i> feeds
-@<i>timestamp.u</i> through ‘‘sh -c "<i>processor</i>"’’ and writes the output to @<i>timestamp.t.</i>
-If the <i>processor</i> finishes successfully, @<i>timestamp.u</i> is deleted and @<i>timestamp.t</i>
-is renamed to @<i>timestamp.s,</i> otherwise @<i>timestamp.t</i> is deleted and the <i>processor</i>
-is started again. <b>svlogd</b> also saves any output that the <i>processor</i> writes
-to file descriptor 5, and makes that output available on file descriptor
-4 when running <i>processor</i> on the next log file rotation. <p>
-A <i>processor</i> is run
-in the background. If <b>svlogd</b> sees a previously started <i>processor</i> still running
-when trying to start a new one for the same <i>log</i>, it blocks until the currently
-running <i>processor</i> has finished successfully. Only the HUP signal works in
-that situation. Note that this may block any program feeding its log data
-to <b>svlogd.</b>
+If <b>svlogd</b> is told to process recent log
+files, it saves <i>current</i> to @<i>timestamp.u,</i> feeds @<i>timestamp.u</i> through ‘‘sh -c
+"<i>processor</i>"’’ and writes the output to @<i>timestamp.t.</i> If the <i>processor</i> finishes
+successfully, @<i>timestamp.u</i> is deleted and @<i>timestamp.t</i> is renamed to @<i>timestamp.s,</i>
+otherwise @<i>timestamp.t</i> is deleted and the <i>processor</i> is started again. <b>svlogd</b>
+also saves any output that the <i>processor</i> writes to file descriptor 5, and
+makes that output available on file descriptor 4 when running <i>processor</i>
+on the next log file rotation. <p>
+A <i>processor</i> is run in the background. If <b>svlogd</b>
+sees a previously started <i>processor</i> still running when trying to start
+a new one for the same <i>log</i>, it blocks until the currently running <i>processor</i>
+has finished successfully. Only the HUP signal works in that situation. Note
+that this may block any program feeding its log data to <b>svlogd.</b>
<p>
<h3><a name='sect6'>Config</a></h3>
-On startup, and after receiving a HUP signal, <b>svlogd</b> checks
-for each <i>log</i> if the configuration file <i>log/config</i> exists, and if so, reads
-the file line by line and adjusts configuration for <i>log</i> as follows: <p>
-If
-the line is empty, less than two characters long, or starts with a ‘‘#’’, it
-is ignored. A line of the form
+On
+startup, and after receiving a HUP signal, <b>svlogd</b> checks for each log directory
+<i>log</i> if the configuration file <i>log/config</i> exists, and if so, reads the file
+line by line and adjusts configuration for <i>log</i> as follows: <p>
+If the line
+is empty, less than two characters long, or starts with a ‘‘#’’, it is ignored.
+A line of the form
<dl>
<dt>s<i>size</i> </dt>
-<dd>sets the maximum file size of <i>current</i>
-when <b>svlogd</b> should rotate the current log file to <i>size</i> bytes. Default is
-1000000. If <i>size</i> is zero, <b>svlogd</b> doesn’t rotate log files. You should set
-<i>size</i> to at least (2 * <i>len</i>). </dd>
+<dd>sets the maximum file size of <i>current</i> when <b>svlogd</b>
+should rotate the current log file to <i>size</i> bytes. Default is 1000000. If
+<i>size</i> is zero, <b>svlogd</b> doesn’t rotate log files. You should set <i>size</i> to at
+least (2 * <i>len</i>). </dd>
<dt>n<i>num</i> </dt>
-<dd>sets the maximum number of old log files
-<b>svlogd</b> should maintain to <i>num</i>. If <b>svlogd</b> sees more that <i>num</i> old log files
-in <i>log</i> after log file rotation, it deletes the oldest one. Default is 10.
-</dd>
+<dd>sets the number of old log files <b>svlogd</b> should maintain
+to <i>num</i>. If <b>svlogd</b> sees more that <i>num</i> old log files in <i>log</i> after log file
+rotation, it deletes the oldest one. Default is 10. If <i>num</i> is zero, <b>svlogd</b>
+doesn’t remove old log files. </dd>
<dt>N<i>min</i> </dt>
-<dd>sets the minimum number of old log files <b>svlogd</b> should maintain to
-<i>min</i>. <i>min</i> must be less than <i>num</i>. If <i>min</i> is set, and <b>svlogd</b> cannot write to
-<i>current</i> because the filesystem is full, and it sees more than <i>min</i> old log
-files, it deletes the oldest one. </dd>
+<dd>sets the minimum number of old log files
+<b>svlogd</b> should maintain to <i>min</i>. <i>min</i> must be less than <i>num</i>. If <i>min</i> is set,
+and <b>svlogd</b> cannot write to <i>current</i> because the filesystem is full, and
+it sees more than <i>min</i> old log files, it deletes the oldest one. </dd>
-<dt>t<i>timeout</i> </dt>
-<dd>sets the maximum age of the <i>current</i>
-log file when <b>svlogd</b> should rotate the current log file to <i>timeout</i> seconds.
-If <i>current</i> is <i>timeout</i> seconds old, and is not empty, <b>svlogd</b> forces log
-file rotation. </dd>
+<dt>t<i>timeout</i>
+</dt>
+<dd>sets the maximum age of the <i>current</i> log file when <b>svlogd</b> should rotate
+the current log file to <i>timeout</i> seconds. If <i>current</i> is <i>timeout</i> seconds old,
+and is not empty, <b>svlogd</b> forces log file rotation. </dd>
<dt>!<i>processor</i> </dt>
-<dd>tells <b>svlogd</b> to feed each recent log file through
-<i>processor</i> (see above) on log file rotation. By default log files are not
-processed. </dd>
+<dd>tells <b>svlogd</b>
+to feed each recent log file through <i>processor</i> (see above) on log file
+rotation. By default log files are not processed. </dd>
<dt>u<i>a.b.c.d[:port]</i> </dt>
-<dd>tells <b>svlogd</b> to transmit the first <i>len</i> characters
-of selected log messages to the IP address <i>a.b.c.d</i>, port number <i>port</i>. If <i>port</i>
-isn’t set, the default port for syslog is used (514). <i>len</i> can be set through
-the -l option, see below. If <b>svlogd</b> has trouble sending udp packets, it writes
-error messages to the log directory. Attention: logging through udp is unreliable,
-and should be used in private networks only. </dd>
+<dd>tells <b>svlogd</b>
+to transmit the first <i>len</i> characters of selected log messages to the IP
+address <i>a.b.c.d</i>, port number <i>port</i>. If <i>port</i> isn’t set, the default port for syslog
+is used (514). <i>len</i> can be set through the -l option, see below. If <b>svlogd</b>
+has trouble sending udp packets, it writes error messages to the log directory.
+Attention: logging through udp is unreliable, and should be used in private
+networks only. </dd>
<dt>U<i>a.b.c.d[:port]</i> </dt>
-<dd>is the same as
-the <i>u</i> line above, but the log messages are no longer written to the log
-directory, but transmitted through udp only. Error messages from <b>svlogd</b>
-concerning sending udp packages still go to the log directory. </dd>
+<dd>is the same as the <i>u</i> line above, but the log
+messages are no longer written to the log directory, but transmitted through
+udp only. Error messages from <b>svlogd</b> concerning sending udp packages still
+go to the log directory. </dd>
</dl>
<p>
-If a line
-starts with a <i>-</i>, <i>+</i>, <i>e</i>, or <i>E</i>, <b>svlogd</b> matches the first <i>len</i> characters of
-each log message against <i>pattern</i> and acts accordingly:
+If a line starts with a <i>-</i>, <i>+</i>, <i>e</i>, or <i>E</i>, <b>svlogd</b> matches
+the first <i>len</i> characters of each log message against <i>pattern</i> and acts accordingly:
+
<dl>
<dt>-<i>pattern</i> </dt>
-<dd>the log
-message is deselected. </dd>
+<dd>the log message is deselected. </dd>
<dt>+<i>pattern</i> </dt>
-<dd>the log message is selected. </dd>
+<dd>the log message is selected.
+</dd>
<dt>e<i>pattern</i> </dt>
-<dd>the
-log message is selected to be printed to standard error. </dd>
+<dd>the log message is selected to be printed to standard error. </dd>
-<dt>E<i>pattern</i> </dt>
-<dd>the log
-message is deselected to be printed to standard error. </dd>
+<dt>E<i>pattern</i>
+</dt>
+<dd>the log message is deselected to be printed to standard error. </dd>
</dl>
<p>
-Initially each line
-is selected to be written to <i>log/current</i>. Deselected log messages are discarded
-from <i>log</i>. Initially each line is deselected to be written to standard err.
-Log messages selected for standard error are written to standard error.
-
+Initially
+each line is selected to be written to <i>log/current</i>. Deselected log messages
+are discarded from <i>log</i>. Initially each line is deselected to be written
+to standard err. Log messages selected for standard error are written to
+standard error.
<h2><a name='sect7'>Pattern Matching</a></h2>
-<b>svlogd</b> matches a log message against the string <i>pattern</i>
-as follows: <p>
-<i>pattern</i> is applied to the log message one character by one,
-starting with the first. A character not a star (‘‘*’’) and not a plus (‘‘+’’) matches
-itself. A plus matches the next character in <i>pattern</i> in the log message
-one or more times. A star before the end of <i>pattern</i> matches any string in
-the log message that does not include the next character in <i>pattern</i>. A star
-at the end of <i>pattern</i> matches any string. <p>
-Timestamps optionally added by
-<b>svlogd</b> are not considered part of the log message.
+<b>svlogd</b> matches a log message against the
+string <i>pattern</i> as follows: <p>
+<i>pattern</i> is applied to the log message one character
+by one, starting with the first. A character not a star (‘‘*’’) and not a plus
+(‘‘+’’) matches itself. A plus matches the next character in <i>pattern</i> in the
+log message one or more times. A star before the end of <i>pattern</i> matches
+any string in the log message that does not include the next character
+in <i>pattern</i>. A star at the end of <i>pattern</i> matches any string. <p>
+Timestamps optionally
+added by <b>svlogd</b> are not considered part of the log message.
<h2><a name='sect8'>Options</a></h2>
<dl>
<dt><b>-t</b> </dt>
-<dd>timestamp. Prefix
-each selected line with a precise timestamp (see <i><b>tai64n</b>(8)</i>) when writing
-to <i>log</i> or to standard error. </dd>
+<dd>timestamp.
+Prefix each selected line with a precise timestamp (see <i><b>tai64n</b>(8)</i>) when
+writing to <i>log</i> or to standard error. </dd>
<dt><b>-tt</b> </dt>
-<dd>timestamp. Prefix each selected line with
-a human readable, sortable UTC timestamp of the form YYYY-MM-DD_HH:MM:SS.xxxxx
+<dd>timestamp. Prefix each selected line
+with a human readable, sortable UTC timestamp of the form YYYY-MM-DD_HH:MM:SS.xxxxx
when writing to <i>log</i> or to standard error. </dd>
<dt><b>-r <i>c</b> </i></dt>
diff --git a/man/svlogd.8 b/man/svlogd.8
@@ -93,9 +93,11 @@ If
.B svlogd
sees
.I num
-or more old log files in
-.IR dir ,
-it removes the oldest one.
+or more old log files in the log directory, it removes the oldest one.
+Note that this doesn't decrease the number of log files if there are
+already more than
+.I num
+log files.
.SS PROCESSOR
If
.B svlogd
@@ -148,7 +150,7 @@ Note that this may block any program feeding its log data to
.SS CONFIG
On startup, and after receiving a HUP signal,
.B svlogd
-checks for each
+checks for each log directory
.I log
if the configuration file
.I log/config
@@ -180,7 +182,7 @@ to at least (2 *
.IR len ).
.TP
.RI n num
-sets the maximum number of old log files
+sets the number of old log files
.B svlogd
should maintain to
.IR num .
@@ -192,6 +194,11 @@ old log files in
.I log
after log file rotation, it deletes the oldest one.
Default is 10.
+If
+.I num
+is zero,
+.B svlogd
+doesn't remove old log files.
.TP
.RI N min
sets the minimum number of old log files
diff --git a/package/CHANGES b/package/CHANGES
@@ -1,3 +1,8 @@
+ * doc/index.html, doc/replaceinit.html: no longer refer to sysvinit's
+ shutdown program.
+ * man/svlogd.8: svlogd doesn't decrease the number of log files in a log
+ directory; with n0 don't remove any log files.
+
runit 1.2.1
Sat, 15 Jan 2005 11:57:46 +0000
* chpst.c: typo.
