File: logcheck.sgml

package info (click to toggle)
logcheck 1.4.2%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,608 kB
  • sloc: sh: 1,118; perl: 274; makefile: 78
file content (290 lines) | stat: -rw-r--r-- 8,571 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
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@


	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Jon</firstname>">
  <!ENTITY dhsurname   "<surname>Middleton</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>May 3, 2005</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>jjm@debian.org</email>">
  <!ENTITY dhusername  "Jon Middleton">
  <!ENTITY dhucpackage "<refentrytitle>Logcheck</refentrytitle>">
  <!ENTITY dhpackage   "logcheck">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>program to scan system logs for interesting lines</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg>OPTIONS</arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>The <command>&dhpackage;</command> program helps spot problems and
    security violations in your logfiles automatically and will send the
    results to you periodically in an e-mail. By default logcheck runs as
    an hourly cronjob just off the hour and after every reboot.</para>

    <para><command>&dhpackage;</command> supports three level of filtering:
    "paranoid" is for high-security machines running as few services
    as possible. Don't use it if you can't handle its verbose messages.
    "server" is the default and contains rules for many different daemons.
    "workstation" is for sheltered machines and filters most of the messages.
    The ignore rules work in additive manner. "paranoid" rules are also
    included at level "server". "workstation" level includes both "paranoid"
    and "server" rules.</para>

    <para>The messages reported are sorted into three layers, system events,
    security events and attack alerts. The verbosity of system events is
    controlled by which level you choose, paranoid, server or workstation.
    However, security events and attack alerts are not affected by this.</para>

  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>


    <para><command>&dhpackage;</command> can be invoked directly thanks
    to su(8) or sudo(8), which change the user ID. The following example checks the logfiles
    without updating the offset and outputs everything to STDOUT.</para>

    <para>sudo -u logcheck <command>&dhpackage;</command> -o -t</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>A summary of options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>-c CFG</option>
        </term>
        <listitem>
          <para>Overrule default configuration file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>
        </term>
        <listitem>
          <para>Debug mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>
        </term>
        <listitem>
          <para>Show usage information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-H</option>
        </term>
        <listitem>
          <para>Use this hostname string in the subject of logcheck mail.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l LOG</option>
        </term>
        <listitem>
          <para>Run logfile through logcheck.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-L CFG</option>
        </term>
        <listitem>
          <para>Overrule default logfiles list.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-D DIR</option>
        </term>
        <listitem>
          <para>Overrule default logfiles lists directory.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option>
        </term>
        <listitem>
          <para>Mail report to recipient.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option>
        </term>
        <listitem>
          <para>STDOUT mode, not sending mail.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option>
        </term>
        <listitem>
          <para>Set the report level to "paranoid".</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r DIR</option>
        </term>
        <listitem>
          <para>Overrule default rules directory.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-R</option>
        </term>
        <listitem>
          <para>Adds "Reboot:" to the email subject line.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
        </term>
        <listitem>
          <para>Set the report level to "server".</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-S DIR</option>
        </term>
        <listitem>
          <para>Overrule default state directory.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>
        </term>
        <listitem>
          <para>Testing mode does not update offset.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-T</option>
        </term>
        <listitem>
          <para>Do not remove the TMPDIR.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-u</option>
        </term>
        <listitem>
          <para>Enable syslog-summary.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
        </term>
        <listitem>
          <para>Print current version.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option>
        </term>
        <listitem>
          <para>Set the report level to "workstation".</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>FILES</title>

    <para>/etc/logcheck/logcheck.conf is the main configuration file.</para>
    <para>/etc/logcheck/logcheck.logfiles is the list of files to monitor.</para>
    <para>/etc/logcheck/logcheck.logfiles.d is the directory of lists of files to monitor.</para>
    <para>/usr/share/doc/logcheck-database/README.logcheck-database.gz for hints on how to write, test and maintain rules.</para>
  </refsect1>
  <refsect1>
    <title>EXIT STATUS</title>
    <para>0 upon success; 1 upon failure</para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para><command>logtail</command>(8)</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>&dhpackage; is developed by Debian &dhpackage; Team at:
    https://salsa.debian.org/debian/logcheck.</para>

    <para>This manual page was written by &dhusername;.</para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->