File: syslog-summary.1.xml

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 (227 lines) | stat: -rw-r--r-- 8,438 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY dhfirstname "David">
  <!ENTITY dhsurname   "Paleino">
  <!-- dhusername could also be set to "&firstname; &surname;". -->  
  <!ENTITY dhusername  "David Paleino">
  <!ENTITY dhemail     "d.paleino@gmail.com">
  <!ENTITY dhsection   "1">
  <!ENTITY dhtitle     "Syslog-Summary User Manual">
  <!ENTITY dhucpackage "SYSLOG-SUMMARY">
  <!ENTITY dhpackage   "syslog-summary">
]>

<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <authorgroup>
      <author>
       <firstname>Lars</firstname>
        <surname>Wirzenius</surname>
        <contrib>Wrote this manpage for the Debian system.</contrib>
        <contrib>Wrote the first version of &dhpackage;.</contrib>
        <contrib>Maintained the Debian package from 1998 to 2000.</contrib>
        <address>
          <email>liw@iki.fi</email>
        </address>
      </author>
      <author>
        <firstname>Tommi</firstname>
        <surname>Virtanen</surname>
        <contrib>Maintained the package from 2001 to early 2008.</contrib>
        <address>
          <email>tv@debian.org</email>
        </address>
      </author>
      <author>
        <firstname>David</firstname>
        <surname>Paleino</surname>
        <contrib>Maintains the package since early 2008.</contrib>
        <address>
          <email>d.paleino@gmail.com</email>
        </address>
      </author>
    </authorgroup>
    <copyright>
      <year>2008</year>
      <holder>David Paleino</holder>
    </copyright>
    <copyright>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
      <year>2004</year>
      <year>2005</year>
      <year>2006</year>
      <year>2007</year>
      <holder>Tommi Virtanen</holder>
    </copyright>
    <copyright>
      <year>1998</year>
      <year>1999</year>
      <year>2000</year>
      <holder>Lars Wirzenius</holder>
    </copyright>
    <legalnotice>
      <para>This manual page was written for the Debian system
        (but may be used by others).</para>
      <para>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.</para>
      <para>On Debian systems, the complete text of the GNU General Public
        License can be found in
	<filename>/usr/share/common-licenses/GPL</filename>.</para>
    </legalnotice>
  </refentryinfo>
  <refmeta>
    <refentrytitle>&dhucpackage;</refentrytitle>
    <manvolnum>&dhsection;</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>summarize the contents of a syslog log file</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <!-- These are several examples, how syntaxes could look -->
      <arg choice="opt">
        <group choice="plain">
          <arg choice="plain"><option>-s</option></arg>
          <arg choice="plain"><option>--state=</option></arg>
        </group>
        <replaceable class="option">filename</replaceable>
      </arg>
      <arg choice="opt">
        <group choice="plain">
          <arg choice="plain"><option>-i</option></arg>
          <arg choice="plain"><option>--ignore=</option></arg>
        </group>
        <replaceable class="option">filename</replaceable>
      </arg>
      <arg choice="opt">
        <group choice="plain">
          <arg choice="plain"><option>-d</option></arg>
          <arg choice="plain"><option>--debug</option></arg>
        </group>
      </arg>
      <arg choice="opt">
        <group choice="plain">
          <arg choice="plain"><option>-r</option></arg>
          <arg choice="plain"><option>--repeat</option></arg>
        </group>
      </arg>
      <arg choice="plain" rep="repeat"><replaceable>logfile</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <!-- Normally the help and version options make the programs stop
           right after outputting the requested information. -->
      <arg choice="opt">
        <group choice="plain">
          <arg choice="plain"><option>-h</option></arg>
          <arg choice="plain"><option>--help</option></arg>
        </group>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>
    <para><command>&dhpackage;</command> summarizes the contents of log files
    via the
    <citerefentry>
      <refentrytitle>syslog</refentrytitle>
      <manvolnum>3</manvolnum>
    </citerefentry>
    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.</para>
  </refsect1>
  <refsect1 id="options">
    <title>OPTIONS</title>
    <variablelist>
      <!-- Use the variablelist.term.separator and the
           variablelist.term.break.after parameters to
           control the term elements. -->
      <varlistentry>
        <term><option>-i <replaceable>filename</replaceable></option></term>
        <term><option>--ignore=<replaceable>filename</replaceable></option></term>
        <listitem>
          <para>Read regular expressions from <replaceable>filename</replaceable>
          and ignore lines in the logfiles that match them.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s <replaceable>filename</replaceable></option></term>
        <term><option>--state=<replaceable>filename</replaceable></option></term>
        <listitem>
          <para>Read state information from <replaceable>filename</replaceable>.
          The state contains information about the already reported parts of a log
          file, and prevents <command>syslog-summary</command> from reporting the
          same things many times. This is useful when <command>syslog-summary</command>
          is run from <command>crontab</command> every hour. The file is created,
          if it doesn't exist already.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r</option></term>
        <term><option>--repeat</option></term>
        <listitem>
          <para>Merge "last message repeated * times" lines with the repeated
          event.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option></term>
        <term><option>--debug</option></term>
        <listitem>
          <para>Enable verbose messages when errors occur (i.e. "debug mode").</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/etc/syslog-summary/ignore.rules</filename></term>
        <listitem>
          <para>Default ignore.rules file with default regular expressions.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="diagnostics">
    <title>DIAGNOSTICS</title>
    <para>When reporting a bug, please run <command>syslog-summary</command>
    with the <option>-d</option> (or <option>--debug</option>) flag enabled.</para>
    <para><command>&dhpackage;</command> provides some return codes, that can
      be used in scripts:</para>
    <segmentedlist>
      <segtitle>Code</segtitle>
      <segtitle>Diagnostic</segtitle>
      <seglistitem>
        <seg><errorcode>0</errorcode></seg>
        <seg>Program exited successfully.</seg>
      </seglistitem>
      <seglistitem>
        <seg><errorcode>1</errorcode></seg>
        <seg>Something went wrong, please run the program with the debug messages enabled.</seg>
      </seglistitem>
    </segmentedlist>
  </refsect1>
</refentry>