File: lwatch.1.in

package info (click to toggle)
lwatch 0.6.2-5
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 884 kB
  • sloc: sh: 4,420; ansic: 1,079; lex: 357; makefile: 57; lisp: 44
file content (129 lines) | stat: -rw-r--r-- 4,817 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
.TH "lwatch" "1" 
.SH "NAME" 
\fBlwatch\fR  \(em syntax highlighting for syslog/syslog-ng file 
.SH "SYNOPSIS" 
.PP 
\fBlwatch\fR [\-C \fIfilename\fR]  [\-\-config \fIfilename\fR]  [\-i \fIfilename\fR]  [\-\-input \fIfilename\fR]  [\-o \fIfilename\fR]  [\-\-output \fIfilename\fR]  [\-sdOhv]  [\-\-show-unparsed]  [\-\-daemon]  [\-\-omit-rc]  [\-\-help]  
.SH "DESCRIPTION" 
.PP 
Lwatch is a log colorizer. It reads syslog/syslog-ng data 
from named fifo or from stdin and displays colored logs into 
stdout. 
.PP 
Lwatch is highly user-customizable. It reads configuration 
data from the file @CONFDIR@/lwatch.conf or (if given) from the file provided with option 
\fB-C\fP 
.PP 
The way it works is simple. It reads a line from input (build-in default is @INPUTFILE@), splits it 
into four parts: date, hostname, service name (with PID, if available) 
and real message. Each part has its own default color. You can redefine 
them in configuration file. Default colors as the same as in loco(1) 
[see: http://www.zjuul.net/~jules/loco/]. But lwatch is not only a static log 
colorizer. It is something more. It can colorize your logs any way 
you wish. You are able to set a new color for any part (date, host, 
service, message) using regexp based patterns. 
.SH "COMMAND LINE OPTIONS" 
.PP 
Lwatch accepts some command line options. Command line options have precedence over values from configuration file. 
 
.IP "\fB-C \fIfilename\fR\fP" 10 
.IP "\fB\-\-config \fIfilename\fR\fP" 10 
read config from filename instead of @CONFDIR@/lwatch.conf 
.IP "\fB-i \fIfilename\fR\fP" 10 
.IP "\fB\-\-input \fIfilename\fR\fP" 10 
read data from named fifo filename instead of @INPUTFILE@ 
.IP "\fB-o \fIfilename\fR\fP" 10 
.IP "\fB\-\-output \fIfilename\fR\fP" 10 
write colored logs to filename instead stdout 
.IP "\fB-s\fP" 10 
.IP "\fB\-\-show-unparsed\fP" 10 
show unparsed lines like `last message repeated 5 times' or `\-\-- MARK \-\--' 
.IP "\fB-d\fP" 10 
.IP "\fB\-\-daemon\fP" 10 
run as daemon, detach from control terminal, move to background 
.IP "\fB-O\fP" 10 
.IP "\fB\-\-omit-rc\fP" 10 
do not read values from config file 
.IP "\fB-h\fP" 10 
.IP "\fB\-\-help\fP" 10 
show help about runtime option 
.IP "\fB-v\fP" 10 
.IP "\fB\-\-version\fP" 10 
show version and copyright notices      
.SH "RUNNING" 
.PP 
Preferred way to run lwatch is to read 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: 
 
.PP 
.nf 
*.*                                 |@INPUTFILE@ 
 
.fi 
in your syslog.conf. Create appropriate fifo and restart syslog, then run 
lwatch. You can also run lwatch before starting syslog. 
If you don't know how to create named fifo see mknod(1) for details. 
 
.PP 
Remember: 
 
.IP "   \(bu" 6 
fifo must exist 
.IP "   \(bu" 6 
proper name must be put in @CONFDIR@/lwatch.conf or given with \-i command line option      
.PP 
In syslog-ng you can run lwatch directly from syslog, i.e.: 
 
.PP 
.nf 
log { source(src); destination(console_all);}; 
destination console_all {program("@BINDIR@/lwatch \-i- \-o/dev/tty11"); }; 
 
.fi 
 
.PP 
Lwatch does not support reading from regular files. If you really need this functionality use following command: 
 
.PP 
.nf 
tail \-f /path/to/filename | @BINDIR@/lwatch \-i- 
.fi 
It could be subject to 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 
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. 
 
.PP 
Regular expression support is provided by the PCRE library package, which 
is open source software, written by Philip Hazel, and copyright by the 
University of Cambridge, England. This library is available at: 
ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/ 
 
.SH "NOTE FROM AUTHOR" 
.PP 
I have written 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 still, developing of this software is driven 
by my own needs. So, you could expect next release in a year or two ;) 
.PP 
It would be really nice if you could find some time and spare 
it for rating this project on FreshMeat (see RESOURCES). Comments 
are welcome too. I cannot promise that I will add new features to 
lwatch immediately but any positive feedback will raise my motivation level up. 
.PP 
Thank you in advance for your time. 
.SH "SEE ALSO" 
.PP 
lwatch.conf(5) 
.\" created by instant / docbook-to-man, Tue 07 Jan 2014, 21:27