[lwatch-cvs] files/doc lwatch.1,1.1,1.2 lwatch.sgml,1.2,1.3
Brought to you by:
arturcz
|
From: <ar...@us...> - 2002-09-08 00:44:34
|
Update of /cvsroot/lwatch/files/doc In directory usw-pr-cvs1:/tmp/cvs-serv7857 Modified Files: lwatch.1 lwatch.sgml Log Message: More documentation. Index: lwatch.1 =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.1,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** lwatch.1 9 Aug 2002 19:26:36 -0000 1.1 --- lwatch.1 8 Sep 2002 00:44:29 -0000 1.2 *************** *** 69,72 **** --- 69,92 ---- data from file /etc/lwatch.conf or (if given) from file provided with option \fB-C\fP + .PP + Its working (jego dzia³anie) is very simple. It reads a line from input, split it + into four parts: date, hostname, service name (with PID, if available) + and real message. Each part has own default color. You can redefine them + in configuration file. Default colors as the same as in loco(1) [see: http://zjuul.net/~jules/loco/]. But lwatch is not only static log colorizer. It is + something more. It can colorize your logs that way, as you wish. You are + able to set a new color for any part (date, host, service, message) using + regexp based patterns. + .SH "Configuration file" + .PP + There is no documentation for configuration file for now. Look at + provided file, there are a lot of comments inside. + .PP + I am going to make some changes in configuration file before + 1.0-stable release. I will also provide docs about configure lwatch in this + release. + .SH "Command line options" + .PP + Type lwatch -h for options and its description. + .SH "Environment" .PP *************** *** 74,77 **** --- 94,106 ---- .SH "Running" .PP + Preferred way to run lwatch is reading syslog messages from named fifo or from standard input. + .PP + If you use syslog you really want to read messages from named fifo. + To do it put a line: *.* |/tmp/your_fifo in your syslog.conf. + Create apropriate fifo and restart syslog, then run lwatch. + You can also run lwatch before starting syslog, but remember: fifo must exists. + .PP + In syslog-ng you can run lwatch directly from syslog, i.e.: + .PP log { source(src); destination(console_all);}; .PP *************** *** 79,85 **** .SH "Copyright" .PP ! GPL disclaimer should be placed here ! .SH "See also" ! .PP ! lwatch.conf(5) ! ...\" created by instant / docbook-to-man, Fri 09 Aug 2002, 21:11 --- 108,115 ---- .SH "Copyright" .PP ! This program is free software; you can redistribute it and/or modify ! it under the terms of the GNU General Public License as published by the ! Free Software Foundation; either version 2 of the License, or (at your ! option) any later version. ! ! ...\" created by instant / docbook-to-man, Sun 08 Sep 2002, 02:38 Index: lwatch.sgml =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.sgml,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** lwatch.sgml 9 Aug 2002 19:26:36 -0000 1.2 --- lwatch.sgml 8 Sep 2002 00:44:29 -0000 1.3 *************** *** 76,90 **** <option>-C</option></para> </refsect1> <refsect1> <title>Environment</title> <para>The lwatch does not use any <envvar>VARIABLES</envvar></para> ! </refsect1> <refsect1> <title>Running</title> <para>log { source(src); destination(console_all);};</para> <para>destination console_all {program("/usr/bin/lwatch -f- > /dev/tty11"); };</para> --- 76,120 ---- <option>-C</option></para> + <para>Its working (jego dzia³anie) is very simple. It reads a line from input, split it + into four parts: date, hostname, service name (with PID, if available) + and real message. Each part has own default color. You can redefine them + in configuration file. Default colors as the same as in loco(1) [see: http://zjuul.net/~jules/loco/]. But lwatch is not only static log colorizer. It is + something more. It can colorize your logs that way, as you wish. You are + able to set a new color for any part (date, host, service, message) using + regexp based patterns.</para> + + </refsect1> + + <refsect1> + <title>Configuration file</title> + <para>There is no documentation for configuration file for now. Look at + provided file, there are a lot of comments inside.</para> + <para>I am going to make some changes in configuration file before + 1.0-stable release. I will also provide docs about configure lwatch in this + release.</para> </refsect1> <refsect1> + <title>Command line options</title> + <para> + Type lwatch -h for options and its description. + </para> + </refsect1> + + <!-- <refsect1> <title>Environment</title> <para>The lwatch does not use any <envvar>VARIABLES</envvar></para> ! </refsect1> --> <refsect1> <title>Running</title> + <para>Preferred way to run lwatch is reading syslog messages from named fifo or from standard input.</para> + <para>If you use syslog you really want to read messages from named fifo. + To do it put a line: *.* |/tmp/your_fifo in your syslog.conf. + Create apropriate fifo and restart syslog, then run lwatch. + You can also run lwatch before starting syslog, but remember: fifo must exists.</para> + <para>In syslog-ng you can run lwatch directly from syslog, i.e.:</para> <para>log { source(src); destination(console_all);};</para> <para>destination console_all {program("/usr/bin/lwatch -f- > /dev/tty11"); };</para> *************** *** 94,99 **** <title>Copyright</title> ! <para>GPL disclaimer should be placed here</para> </refsect1> <refsect1> <title>See also</title> --- 124,136 ---- <title>Copyright</title> ! <para>This program is free software; you can redistribute it and/or modify ! it under the terms of the GNU General Public License as published by the ! Free Software Foundation; either version 2 of the License, or (at your ! option) any later version. ! </para> ! </refsect1> + + <!-- <refsect1> <title>See also</title> *************** *** 101,104 **** --- 138,143 ---- <para>lwatch.conf(5)</para> </refsect1> + --> + </refentry> |