summary refs log tree commit diff
path: root/doc/svlogd.8.html
diff options
context:
space:
mode:
authorGerrit Pape <pape@smarden.org>2003-04-24 11:26:38 +0000
committerGerrit Pape <pape@smarden.org>2003-04-24 11:26:38 +0000
commita5cdef272de649d7ce10ad93559eea590aaed094 (patch)
tree002b96be35ed6ae7a933045b2f728ccca5cec6a5 /doc/svlogd.8.html
parent6877501dc293237dd3dee39efd136b7beefc68dc (diff)
downloadrunit-a5cdef272de649d7ce10ad93559eea590aaed094.tar.gz
runit-a5cdef272de649d7ce10ad93559eea590aaed094.tar.xz
runit-a5cdef272de649d7ce10ad93559eea590aaed094.zip
html.
Diffstat (limited to 'doc/svlogd.8.html')
-rw-r--r--doc/svlogd.8.html120
1 files changed, 66 insertions, 54 deletions
diff --git a/doc/svlogd.8.html b/doc/svlogd.8.html
index 23ea453..930dded 100644
--- a/doc/svlogd.8.html
+++ b/doc/svlogd.8.html
@@ -70,87 +70,98 @@ long, or starts with a ``#'', it is ignored. A line of the form
 <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. </DD>
+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">Options</A></H2>
+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>. Character 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>abc</B> </I></DT>
-<DD>replace characters. Additionally
-to non-printable characters, replace all characters found in <I>abc</I> with <I>c</I>
-(default ``_''). </DD>
+<DD>replace charset. Additionally to non-printable
+characters, replace all characters found in <I>abc</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>
 </DL>
 
-<H2><A NAME="sect8">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>
+<H2><A NAME="sect9">Signals</A></H2>
 If <B>svlogd</B> is sent
-a TERM signal, or if it sees end-of-file on standard input, it closes standard
-input, 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 tries for all
-<I>logs</I> to rotate the current log file, if it is not empty. 
-<H2><A NAME="sect9">See Also</A></H2>
-<I>runsvstat(8)</I>,
-<I>runit(8)</I>, <I>runit-init(8)</I>, <I>runsv(8)</I>, <I>runsvstat(8)</I>, <I>runsvctrl(8)</I>, <I>runsvdir(8)</I>,
-<I>runsvchdir(8)</I>, <I>svwaitdown(8)</I>, <I>svwaitup(8)</I> <P>
+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.
+
+<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> 
-<H2><A NAME="sect10">Author</A></H2>
+<H2><A NAME="sect11">Author</A></H2>
 Gerrit
 Pape &lt;pape@smarden.org&gt; <P>
 
@@ -166,9 +177,10 @@ Pape &lt;pape@smarden.org&gt; <P>
 <LI><A NAME="toc5" HREF="#sect5">Processor</A></LI>
 <LI><A NAME="toc6" HREF="#sect6">Config</A></LI>
 </UL>
-<LI><A NAME="toc7" HREF="#sect7">Options</A></LI>
-<LI><A NAME="toc8" HREF="#sect8">Signals</A></LI>
-<LI><A NAME="toc9" HREF="#sect9">See Also</A></LI>
-<LI><A NAME="toc10" HREF="#sect10">Author</A></LI>
+<LI><A NAME="toc7" HREF="#sect7">Pattern Matching</A></LI>
+<LI><A NAME="toc8" HREF="#sect8">Options</A></LI>
+<LI><A NAME="toc9" HREF="#sect9">Signals</A></LI>
+<LI><A NAME="toc10" HREF="#sect10">See Also</A></LI>
+<LI><A NAME="toc11" HREF="#sect11">Author</A></LI>
 </UL>
 </BODY></HTML>