commit a1e1cb261dc7bf8d78179b1f5e659b6c8febfee0
parent 29327426e121fa67e6427281f5d7a80858f85db8
Author: Gerrit Pape <pape@smarden.org>
Date: Thu, 4 Sep 2003 09:49:10 +0000
minor; html.
Diffstat:
2 files changed, 103 insertions(+), 94 deletions(-)
diff --git a/doc/svlogd.8.html b/doc/svlogd.8.html
@@ -24,8 +24,7 @@ be processed by an arbitrary processor program when they are rotated, and
<B>svlogd</B> can be told to alert selected log messages to standard error. <P>
<B>svlogd</B>
runs until it sees end-of-file on standard input or is sent a TERM signal,
-see below. <P>
-
+see below.
<H3><A NAME="sect3">Log Directory</A></H3>
A log directory <I>log</I> contains some number of old
log files, and the current log file <I>current</I>. Old log files have a file name
@@ -33,138 +32,146 @@ starting with <I>@</I> followed by a precise timestamp (see <B><I>tai64n</B>(8)<
when <I>current</I> was rotated and renamed to this file. <P>
A log directory additionally
contains the lock file <I>lock</I>, maybe <I>state</I> and <I>newstate</I>, and optionally the
-file <I>config</I>. <B>svlogd</B> creates necessary files if they don't exist.
-<H3><A NAME="sect4">Log File
-Rotation</A></H3>
-<B>svlogd</B> appends selected log messages to the <I>current</I> log file. If
-<I>current</I> has <I>size</I> bytes or more size (or there is a new-line within the last
-<I>len</I> of <I>size</I> bytes) <I>current</I> is rotated: <P>
-<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.
+file <I>config</I>. <B>svlogd</B> creates necessary files if they don't exist. <P>
+If <B>svlogd</B>
+has trouble opening a log directory, it prints a warning, and ignores this
+log directory. If <B>svlogd</B> is unable to open all log directories given at
+the command line, it exits with an error. This can happen on start-up or
+after receiving a HUP signal.
+<H3><A NAME="sect4">Log File Rotation</A></H3>
+<B>svlogd</B> appends selected log
+messages to the <I>current</I> log file. If <I>current</I> has <I>size</I> bytes or more size
+(or there is a new-line within the last <I>len</I> of <I>size</I> bytes) <I>current</I> is rotated:
+<P>
+<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.
<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 make that
-output available on file descriptor 4 when it runs <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>
+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 make that output available on file descriptor
+4 when it runs <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 <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 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>
<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>
</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>log messages matching <I>pattern</I> are printed to standard error. </DD>
+<DD>log
+messages matching <I>pattern</I> are printed to standard error. </DD>
-<DT>E<I>pattern</I>
-</DT>
-<DD>log messages not matching <I>pattern</I> are printed to standard error. </DD>
+<DT>E<I>pattern</I> </DT>
+<DD>log messages
+not matching <I>pattern</I> are printed to standard error. </DD>
</DL>
<P>
-Initially
-each line is selected. Deselected log messages are discarded from <I>log</I>.
-<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.
+Initially each line
+is selected. Deselected log messages are discarded from <I>log</I>.
+<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.
<H2><A NAME="sect8">Options</A></H2>
<DL>
<DT><B>-t</B> </DT>
-<DD>timestamp. Prefix each selected
-line with a precise timestamp (see <B><I>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 <B><I>tai64n</B>(8)</I>) when writing to <I>log</I> or to standard error.
+</DD>
<DT><B>-r <I>c</B> </I></DT>
-<DD>replace. <I>c</I> must be a single character. Replace non-printable
-characters in log messages with <I>c</I>. Characters are replaced before pattern
-matching is applied. </DD>
+<DD>replace. <I>c</I> must be a single character. Replace non-printable characters
+in log messages with <I>c</I>. Characters are replaced before pattern matching
+is applied. </DD>
<DT><B>-R <I>xyz</B> </I></DT>
-<DD>replace charset. Additionally to non-printable
-characters, replace all characters found in <I>xyz</I> with <I>c</I> (default ``_''). </DD>
+<DD>replace charset. Additionally to non-printable characters,
+replace all characters found in <I>xyz</I> with <I>c</I> (default ``_''). </DD>
-<DT><B>-l <I>len</B>
-</I></DT>
-<DD>line length. Pattern matching applies to the first <I>len</I> characters of a log
-message only. Default is 1000. </DD>
+<DT><B>-l <I>len</B> </I></DT>
+<DD>line length.
+Pattern matching applies to the first <I>len</I> characters of a log message only.
+Default is 1000. </DD>
<DT><B>-b <I>buflen</B> </I></DT>
-<DD>buffer size. Set the size of the buffer
-<B>svlogd</B> uses when reading from standard input and writing to <I>logs</I> to <I>buflen</I>.
-Default is 1024. <I>buflen</I> must be greater than <I>len</I>. </DD>
+<DD>buffer size. Set the size of the buffer <B>svlogd</B>
+uses when reading from standard input and writing to <I>logs</I> to <I>buflen</I>. Default
+is 1024. <I>buflen</I> must be greater than <I>len</I>. </DD>
<DT><B>-v</B> </DT>
-<DD>verbose. Print verbose
-messages to standard error. </DD>
+<DD>verbose. Print verbose messages
+to standard error. </DD>
</DL>
<H2><A NAME="sect9">Signals</A></H2>
-If <B>svlogd</B> is sent a HUP signal, it closes
-and reopens all <I>logs</I>, and updates their configuration according to <I>log/config</I>.
-<P>
-If <B>svlogd</B> is sent a TERM signal, or if it sees end-of-file on standard input,
-it stops reading standard input, processes the data in the buffer, waits
-for all <I>processor</I> subprocesses to finish if any, and exits 0 as soon as
-possible. <P>
-If <B>svlogd</B> is sent an ALRM signal, it forces log file rotation
-for all <I>logs</I> with a non empty <I>current</I> log file.
+If <B>svlogd</B> is sent a HUP signal, it closes and
+reopens all <I>logs</I>, and updates their configuration according to <I>log/config</I>.
+If <B>svlogd</B> has trouble opening a log directory, it prints a warning, and
+discards this log directory. If <B>svlogd</B> is unable to open all log directories
+given at the command line, it exits with an error. <P>
+If <B>svlogd</B> is sent a TERM
+signal, or if it sees end-of-file on standard input, it stops reading standard
+input, processes the data in the buffer, waits for all <I>processor</I> subprocesses
+to finish if any, and exits 0 as soon as possible. <P>
+If <B>svlogd</B> is sent an
+ALRM signal, it forces log file rotation for all <I>logs</I> with a non empty
+<I>current</I> log file.
<H2><A NAME="sect10">See Also</A></H2>
-<I>runsv(8)</I>, <I>runsvstat(8)</I>,
-<I>runsvctrl(8)</I>, <I>runsvdir(8)</I>, <I>runsvchdir(8)</I>, <I>runit(8)</I>, <I>runit-init(8)</I>, <I>multilog(8)</I>
-<P>
-<I>http://smarden.org/runit/</I>
+<I>runsv(8)</I>, <I>runsvstat(8)</I>, <I>runsvctrl(8)</I>, <I>runsvdir(8)</I>,
+<I>runsvchdir(8)</I>, <I>runit(8)</I>, <I>runit-init(8)</I>, <I>multilog(8)</I> <P>
+<I>http://smarden.org/runit/</I>
+
<H2><A NAME="sect11">Author</A></H2>
Gerrit Pape <pape@smarden.org> <P>
diff --git a/package/CHANGES b/package/CHANGES
@@ -4,6 +4,7 @@ Mon, 01 Sep 2003 13:02:57 +0200
Schwinge).
* svlogd.c: barf if all log directories given at the command line fail.
* man/svlogd.8: adapt.
+ * doc/runscripts.html: adaptions (thx Erich Schubert, Lang Martin).
runit 0.11.0
Fri, 08 Aug 2003 12:37:14 +0200
@@ -36,6 +37,7 @@ Wed, 04 Jun 2003 13:56:33 +0200
* man/svlogd.8: document -v option; minor.
* etc/freebsd/3, etc/openbsd/3: check if magic files in /etc/runit/ are
executable, not readable.
+ A
* etc/*/getty-tty*/run: remove utmpset from script.
* etc/*/getty-tty*/finish: new: run utmpset.
* doc/replaceinit.html: adapt.
