File: syslog-summary.1

package info (click to toggle)
syslog-summary 1.14-2.1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 160 kB
  • ctags: 19
  • sloc: python: 388; xml: 219; makefile: 49
file content (137 lines) | stat: -rw-r--r-- 3,791 bytes parent folder | download | duplicates (3)
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
130
131
132
133
134
135
136
137
.\"     Title: SYSLOG-SUMMARY
.\"    Author: Lars Wirzenius <liw@iki.fi>
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 02/07/2008
.\"    Manual: Syslog-Summary User Manual
.\"    Source: syslog-summary
.\"
.TH "SYSLOG\-SUMMARY" "1" "02/07/2008" "syslog-summary" "Syslog-Summary User Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
syslog-summary - summarize the contents of a syslog log file
.SH "SYNOPSIS"
.HP 15
\fBsyslog\-summary\fR [\fB\-s\fR\ |\ \fB\-\-state=\fR\ \fIfilename\fR] [\fB\-i\fR\ |\ \fB\-\-ignore=\fR\ \fIfilename\fR] [\fB\-d\fR\ |\ \fB\-\-debug\fR] [\fB\-r\fR\ |\ \fB\-\-repeat\fR] \fIlogfile\fR...
.HP 15
\fBsyslog\-summary\fR [\fB\-h\fR\ |\ \fB\-\-help\fR]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBsyslog\-summary\fR
command\.
.PP
\fBsyslog\-summary\fR
summarizes the contents of log files via the
\fBsyslog\fR(3)
service, by displaying each unique (except for the time) line once, and also the number of times such a line occurs in the input\. The lines are displayed in the order they occur in the input\.
.SH "OPTIONS"
.PP
\fB\-i \fR\fB\fIfilename\fR\fR, \fB\-\-ignore=\fR\fB\fIfilename\fR\fR
.RS 4
Read regular expressions from
\fIfilename\fR
and ignore lines in the logfiles that match them\.
.RE
.PP
\fB\-s \fR\fB\fIfilename\fR\fR, \fB\-\-state=\fR\fB\fIfilename\fR\fR
.RS 4
Read state information from
\fIfilename\fR\. The state contains information about the already reported parts of a log file, and prevents
\fBsyslog\-summary\fR
from reporting the same things many times\. This is useful when
\fBsyslog\-summary\fR
is run from
\fBcrontab\fR
every hour\. The file is created, if it doesn\'t exist already\.
.RE
.PP
\fB\-r\fR, \fB\-\-repeat\fR
.RS 4
Merge "last message repeated * times" lines with the repeated event\.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Enable verbose messages when errors occur (i\.e\. "debug mode")\.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show summary of options\.
.RE
.SH "FILES"
.PP
\fI/etc/syslog\-summary/ignore\.rules\fR
.RS 4
Default ignore\.rules file with default regular expressions\.
.RE
.SH "DIAGNOSTICS"
.PP
When reporting a bug, please run
\fBsyslog\-summary\fR
with the
\fB\-d\fR
(or
\fB\-\-debug\fR) flag enabled\.
.PP
\fBsyslog\-summary\fR
provides some return codes, that can be used in scripts:
.\" line length increase to cope w/ tbl weirdness
.ll +(\n(LLu * 62u / 100u)
.TS
ll.
\fICode\fR	\fIDiagnostic\fR
T{
\fB0\fR
T}	T{
Program exited successfully\.
T}
T{
\fB1\fR
T}	T{
Something went wrong, please run the program with the debug messages enabled\.
T}
.TE
.\" line length decrease back to previous value
.ll -(\n(LLu * 62u / 100u)
.sp
.SH "AUTHORS"
.PP
\fBLars Wirzenius\fR <\&liw@iki\.fi\&>
.sp -1n
.IP "" 4
Wrote this manpage for the Debian system\.
.sp -1n
.IP "" 4
Wrote the first version of syslog\-summary\.
.sp -1n
.IP "" 4
Maintained the Debian package from 1998 to 2000\.
.PP
\fBTommi Virtanen\fR <\&tv@debian\.org\&>
.sp -1n
.IP "" 4
Maintained the package from 2001 to early 2008\.
.PP
\fBDavid Paleino\fR <\&d\.paleino@gmail\.com\&>
.sp -1n
.IP "" 4
Maintains the package since early 2008\.
.SH "COPYRIGHT"
Copyright \(co 2008 David Paleino
.br
Copyright \(co 2001-2007 Tommi Virtanen
.br
Copyright \(co 1998-2000 Lars Wirzenius
.br
.PP
This manual page was written for the Debian system (but may be used by others)\.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or (at your option) any later version published by the Free Software Foundation\.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
\fI/usr/share/common\-licenses/GPL\fR\.
.sp