[lwatch-cvs] files/doc lwatch.1.in,1.20,1.21 lwatch.conf.5.in,1.1,1.2 lwatch.conf.sgml,1.2,1.3 lwatc
Brought to you by:
arturcz
Menu
▾
▴
[lwatch-cvs] files/doc lwatch.1.in,1.20,1.21 lwatch.conf.5.in,1.1,1.2 lwatch.conf.sgml,1.2,1.3 lwatch.sgml,1.17,1.18
|
From: Artur R. C. <ar...@us...> - 2004-08-11 12:06:35
|
Update of /cvsroot/lwatch/files/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10944/doc Modified Files: lwatch.1.in lwatch.conf.5.in lwatch.conf.sgml lwatch.sgml Log Message: User manual completed. Index: lwatch.conf.5.in =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.conf.5.in,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** lwatch.conf.5.in 10 Aug 2004 14:34:49 -0000 1.1 --- lwatch.conf.5.in 11 Aug 2004 12:06:24 -0000 1.2 *************** *** 54,63 **** .TH "lwatch.conf" "5" .SH "NAME" ! \fBlwatch.conf\fR \(em configuration file for lwatch, syntax highlighting for syslog/syslog-ng file .SH "DESCRIPTION" .PP ! FIXME .PP ! Some useful entities: @CONFDIR@/lwatch.conf @INPUTFILE@ @BINDIR@/lwatch .SH "COPYRIGHT" .PP --- 54,149 ---- .TH "lwatch.conf" "5" .SH "NAME" ! \fBlwatch.conf\fR \(em configuration file for lwatch(1), syntax highlighting for syslog/syslog-ng file .SH "DESCRIPTION" .PP ! Default configuration file for lwatch is @CONFDIR@/lwatch.conf (built-in value), but you can specify another file with \fB-C\fP command line option. Read lwatch(1) for details. ! .SS "Comments" .PP ! Everything from # (hash) to end of line is a comment. ! .SS "General options" ! .PP ! \fBcfg_ver\fP - this is obligatory variable and it must be placed as a first option in config file (note: although it is not enforced now, it shall be in next release of lwatch). This variable contains version of configuration file syntax. Current manual describes version 1. ! .PP ! \fBdate_color\fP - default color of date part ! .PP ! \fBhost_color\fP - default color of hostname part ! .PP ! \fBserv_color\fP - default color of service part ! .PP ! \fBmesg_color\fP - default color of message part ! .PP ! \fBinput_file\fP - where lwatch is reading data from, built-in default is @INPUTFILE@, could be overwriten with command line option \fB-i\fP ! .PP ! \fBoutput_file\fP - where lwatch output colored data; built-in default is stdout (-), could be overwriten with command line option \fB-o\fP ! .PP ! \fBshow_unparsed\fP - by default lwatch ignores lines which cannot be splitted into date, host, service and message, set this variable to yes if you like to see those lines; it is the same as command line option \fB-s\fP ! .SS "Available colors" ! .PP ! To specify color you can use following strings: black red green brown blue magenta cyan lightgray darkgray brightred brightgreen yellow brightblue purple brightcyan white. ! .SS "Matching patterns" ! .PP ! There is hidden The Power of Lwatch. You can match input lines again PCRE (Perl Compatible Regular Expression) and change output depends on matching. You can read more about PCRE in pcrepattern(3) (from libpcre) or in perlre(1) (from perl). ! .PP ! There are two way to define matchin pattern/action. First one is the simple one. Just pattern and one action: ! ! .PP ! .nf ! .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n ! /regexp/ action ! ! .fi ! The second one is more complex, but it allows to specify more than one action or modificator with one pattern: ! ! .PP ! .nf ! .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n ! /regexp/ { ! \ \ \ \ \ \ \ \ action1 ! \ \ \ \ \ \ \ \ action2 ! \ \ \ \ \ \ \ \ ... ! \ \ \ \ \ \ \ \ actionN ! } ! ! .fi ! ! .PP ! There is one important thing which you should remember. There is no need to quote / (slash) if you use it ! inside regexp pattern. For example: ! ! .PP ! .nf ! .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n ! //USR/SBIN/CRON/ { # cron's messages are not important ! \ \ \ \ \ \ \ \ color=blue # display it in blue ! \ \ \ \ \ \ \ \ match_service ! } ! ! .fi ! ! .PP ! For every input line message part is matched against all defined patterns, from top to bottom. For every matched ! pattern attached actions are runned until \fBexit\fP is not specified (see below). ! .SS "Actions and modificators" ! .PP ! \fBdate_color\fP - set date color ! .PP ! \fBmesg_color\fP, \fBcolor\fP - set message color ! .PP ! \fBserv_color\fP - set service name color ! .PP ! \fBhost_color\fP - set hostname color ! .PP ! \fBexit\fP - do not match next patterns ! .PP ! \fBhighlight\fP - highlight matched string with given color ! .PP ! \fBignore\fP - ignore this pattern, do not match next patterns ! .PP ! \fBmatch_host\fP - match hostname insted message ! .PP ! \fBmatch_service\fP - match service name instead message ! .SH "EXAMPLES" ! .PP ! Just look into provided lwatch.conf. .SH "COPYRIGHT" .PP *************** *** 75,78 **** .SH "SEE ALSO" .PP ! lwatch(1) ! .\" created by instant / docbook-to-man, Tue 10 Aug 2004, 16:31 --- 161,164 ---- .SH "SEE ALSO" .PP ! lwatch(1), pcrepattern(3), perlre(1) ! .\" created by instant / docbook-to-man, Wed 11 Aug 2004, 14:04 Index: lwatch.1.in =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.1.in,v retrieving revision 1.20 retrieving revision 1.21 diff -C2 -d -r1.20 -r1.21 *** lwatch.1.in 10 Aug 2004 14:34:49 -0000 1.20 --- lwatch.1.in 11 Aug 2004 12:06:24 -0000 1.21 *************** *** 142,149 **** .nf .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n ! tail -f /path/to/filename | lwatch -i- .fi It could be subject of change in the future. .SH "COPYRIGHT" .PP --- 142,154 ---- .nf .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n ! tail -f /path/to/filename | @BINDIR@/lwatch -i- .fi It could be subject of change in the future. + .SH "RESOURCES" + .IP " \(bu" 6 + http://sf.net/projects/lwatch + .IP " \(bu" 6 + http://freshmeat.net/projects/lwatch/ .SH "COPYRIGHT" .PP *************** *** 159,164 **** ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/ .SH "SEE ALSO" .PP lwatch.conf(5) ! .\" created by instant / docbook-to-man, Tue 10 Aug 2004, 16:31 --- 164,178 ---- ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/ + .SH "NOTE FROM AUTHOR" + .PP + I have writen this tool for my own needs because perl tools, however flexible, eated a lot of memory and CPU. + I have found it useful and I share it with the Open Source Community. But stil developing of this software is driven + by my own needs. So, you could except next release in a year or two ;) + .PP + It would be really nice if you could find some time and spare it for rate this project on FreshMeat (see RESOURCES). Comments are welcomed too. I cannot promise that I will add new features to lwatch immediatly but any positive feedback will raise my motivation level up. + .PP + Thank in advance for your time. .SH "SEE ALSO" .PP lwatch.conf(5) ! .\" created by instant / docbook-to-man, Wed 11 Aug 2004, 14:04 Index: lwatch.conf.sgml =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.conf.sgml,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** lwatch.conf.sgml 11 Aug 2004 08:20:51 -0000 1.2 --- lwatch.conf.sgml 11 Aug 2004 12:06:24 -0000 1.3 *************** *** 49,68 **** <refsect1> <title>DESCRIPTION</title> ! <para>This manual documents syntax and semantic of lwatch configuration file version 1.</para> <para> - lwatch.config logically divided into two parts: <itemizedlist mark="dash" spacing="compact"> ! <listitem><para>one</para></listitem> ! <listitem><para>two</para></listitem> </itemizedlist> </para> ! <para>Some useful entities: &conf; &infile; &bin;</para> </refsect1> <!-- <itemizedlist mark="dash" spacing="compact"> <listitem><para>fifo must exist</para></listitem> --- 49,136 ---- <refsect1> <title>DESCRIPTION</title> ! <para>Default configuration file for lwatch is &conf; (built-in value), but you can specify another file with <option>-C</option> command line option. Read lwatch(1) for details.</para> ! <!-- <para> <itemizedlist mark="dash" spacing="compact"> ! <listitem><para>match&action settings</para></listitem> </itemizedlist> </para> + --> + <refsect2> + <title>Comments</title> + <para>Everything from # (hash) to end of line is a comment.</para> + </refsect2> + <refsect2> + <title>General options</title> + <para><option>cfg_ver</option> - this is obligatory variable and it must be placed as a first option in config file (note: although it is not enforced now, it shall be in next release of lwatch). This variable contains version of configuration file syntax. Current manual describes version 1.</para> + <para><option>date_color</option> - default color of date part</para> + <para><option>host_color</option> - default color of hostname part</para> + <para><option>serv_color</option> - default color of service part</para> + <para><option>mesg_color</option> - default color of message part</para> + <para><option>input_file</option> - where lwatch is reading data from, built-in default is &infile;, could be overwriten with command line option <option>-i</option></para> + <para><option>output_file</option> - where lwatch output colored data; built-in default is stdout (-), could be overwriten with command line option <option>-o</option></para> + <para><option>show_unparsed</option> - by default lwatch ignores lines which cannot be splitted into date, host, service and message, set this variable to yes if you like to see those lines; it is the same as command line option <option>-s</option></para> + </refsect2> + <refsect2> + <title>Available colors</title> + <para>To specify color you can use following strings: black red green brown blue magenta cyan lightgray darkgray brightred brightgreen yellow brightblue purple brightcyan white.</para> + </refsect2> ! <refsect2> ! <title>Matching patterns</title> ! <para>There is hidden The Power of Lwatch. You can match input lines again PCRE (Perl Compatible Regular Expression) and change output depends on matching. You can read more about PCRE in pcrepattern(3) (from libpcre) or in perlre(1) (from perl).</para> ! <para>There are two way to define matchin pattern/action. First one is the simple one. Just pattern and one action: ! <literallayout> ! /regexp/ action ! </literallayout> ! The second one is more complex, but it allows to specify more than one action or modificator with one pattern: ! <literallayout> ! /regexp/ { ! &tab;action1 ! &tab;action2 ! &tab;... ! &tab;actionN ! } ! </literallayout> ! </para> ! <para>There is one important thing which you should remember. There is no need to quote / (slash) if you use it ! inside regexp pattern. For example: ! <literallayout> ! //USR/SBIN/CRON/ { # cron's messages are not important ! &tab;color=blue # display it in blue ! &tab;match_service ! } ! </literallayout> ! </para> ! <para>For every input line message part is matched against all defined patterns, from top to bottom. For every matched ! pattern attached actions are runned until <option>exit</option> is not specified (see below).</para> ! </refsect2> ! ! <refsect2> ! <title>Actions and modificators</title> ! <para><option>date_color</option> - set date color</para> ! <para><option>mesg_color</option>, <option>color</option> - set message color</para> ! <para><option>serv_color</option> - set service name color</para> ! <para><option>host_color</option> - set hostname color</para> ! <para><option>exit</option> - do not match next patterns</para> ! <para><option>highlight</option> - highlight matched string with given color</para> ! <para><option>ignore</option> - ignore this pattern, do not match next patterns</para> ! <para><option>match_host</option> - match hostname insted message</para> ! <para><option>match_service</option> - match service name instead message</para> ! </refsect2> ! ! </refsect1> ! ! <refsect1> ! <title>EXAMPLES</title> ! ! <para>Just look into provided lwatch.conf.</para> </refsect1> <!-- + <para>Some useful entities: &conf; &infile; &bin;</para> <itemizedlist mark="dash" spacing="compact"> <listitem><para>fifo must exist</para></listitem> *************** *** 99,103 **** <title>SEE ALSO</title> ! <para>lwatch(1)</para> </refsect1> --- 167,171 ---- <title>SEE ALSO</title> ! <para>lwatch(1), pcrepattern(3), perlre(1)</para> </refsect1> Index: lwatch.sgml =================================================================== RCS file: /cvsroot/lwatch/files/doc/lwatch.sgml,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** lwatch.sgml 10 Aug 2004 14:08:09 -0000 1.17 --- lwatch.sgml 11 Aug 2004 12:06:24 -0000 1.18 *************** *** 189,193 **** <para> Lwatch does not support reading from regular files. If you really need this functionality use following command: ! <literallayout>tail -f /path/to/filename | lwatch -i-</literallayout> It could be subject of change in the future. </para> --- 189,193 ---- <para> Lwatch does not support reading from regular files. If you really need this functionality use following command: ! <literallayout>tail -f /path/to/filename | &bin; -i-</literallayout> It could be subject of change in the future. </para> *************** *** 195,198 **** --- 195,206 ---- <refsect1> + <title>RESOURCES</title> + <itemizedlist mark="dash" spacing="compact"> + <listitem><para>http://sf.net/projects/lwatch</para></listitem> + <listitem><para>http://freshmeat.net/projects/lwatch/</para></listitem> + </itemizedlist> + </refsect1> + + <refsect1> <title>COPYRIGHT</title> *************** *** 213,216 **** --- 221,233 ---- <refsect1> + <title>NOTE FROM AUTHOR</title> + <para>I have writen this tool for my own needs because perl tools, however flexible, eated a lot of memory and CPU. + I have found it useful and I share it with the Open Source Community. But stil developing of this software is driven + by my own needs. So, you could except next release in a year or two ;)</para> + <para>It would be really nice if you could find some time and spare it for rate this project on FreshMeat (see RESOURCES). Comments are welcomed too. I cannot promise that I will add new features to lwatch immediatly but any positive feedback will raise my motivation level up.</para> + <para>Thank in advance for your time.</para> + </refsect1> + + <refsect1> <title>SEE ALSO</title> |
