1
Closes: #101272, #335060
2
Patches from: J S Bygott <jsb_no_spm@jsbygott.fsnet.co.uk>
4
General fixes to manpages.
7
Index: logrotate-3.7.1/logrotate.8
8
===================================================================
9
--- logrotate-3.7.1.orig/logrotate.8 2006-04-08 21:43:29.280038309 +0100
10
+++ logrotate-3.7.1/logrotate.8 2006-04-08 21:45:53.721194620 +0100
13
logrotate \- rotates, compresses, and mails system logs
15
-\fBlogrotate\fR [-dv] [-f|--force] [-s|--state \fIfile\fR] \fIconfig_file\fR+
16
+\fBlogrotate\fR [\fB\-dv\fR] [\fB\-f\fR|\fB\-\-force\fR]
17
+[\fB\-s\fR|\fB-\-state\ \fIstatefile\fR] \fIconfig_file\fR ..
19
\fBlogrotate\fR is designed to ease administration of systems that generate
20
large numbers of log files. It allows automatic rotation, compression,
22
weekly, monthly, or when it grows too large.
24
Normally, \fBlogrotate\fR is run as a daily cron job. It will not modify
25
-a log multiple times in one day unless the criterium for that log is
26
-based on the log's size and \fBlogrotate\fR is being run multiple times
27
-each day, or unless the \fB-f\fR or \fB-force\fR option is used.
28
+a log more than once in one day unless the criterion for that log is
29
+based on the log's size and \fBlogrotate\fR is being run more than once
30
+each day, or unless the \fB-f\fR or \fB-\-force\fR option is used.
32
Any number of config files may be given on the command line. Later config
33
files may override the options given in earlier files, so the order
34
-in which the \fBlogrotate\fR config files are listed in is important.
35
+in which the \fBlogrotate\fR config files are listed is important.
36
Normally, a single config file which includes any other config files
37
which are needed should be used. See below for more information on how
38
-to use the \fIinclude\fR directive to accomplish this. If a directory
39
+to use the \fBinclude\fR directive to accomplish this. If a directory
40
is given on the command line, every file in that directory is used as
44
be made to the logs or to the \fBlogrotate\fR state file.
48
+\fB-f\fR, \fB-\-force\fR
49
Tells \fBlogrotate\fR to force the rotation, even if it doesn't think
50
this is necessary. Sometimes this is useful after adding new entries to
51
-\fBlogrotate\fR, or if old log files have been removed by hand, as the
52
-new files will be created, and logging will continue correctly.
53
+a \fBlogrotate\fR config file, or if old log files have been removed
54
+by hand, as the new files will be created, and logging will continue
58
-\fB-m, -\-mail <command>\fR
59
+\fB-m\R, \B-\-mail <command>\fR
60
Tells \fBlogrotate\fR which command to use when mailing logs. This
61
command should accept two arguments: 1) the subject of the message, and
62
2) the recipient. The command must then read a message on standard input
63
-and mail it to the recipient. The default mail command is \fB/bin/mail
64
+and mail it to the recipient. The default mail command is \fB/usr/bin/mail
68
-\fB-s, -\-state <statefile>\fR
69
+\fB-s\fR, \fB-\-state <statefile>\fR
70
Tells \fBlogrotate\fR to use an alternate state file. This is useful
71
-if logrotate is being run as a different user for various sets of
72
+if \fBlogrotate\fR is being run as a different user for various sets of
73
log files. The default state file is \fI/var/lib/logrotate/status\fR.
77
Prints a short usage message.
80
+\fB-v\fR, \fB--verbose\fR
81
+Display messages during rotation.
83
.SH CONFIGURATION FILE
85
\fBlogrotate\fR reads everything about the log files it should be handling
86
from the series of configuration files specified on the command line. Each
87
configuration file can set global options (local definitions override
88
global ones, and later definitions override earlier ones) and specify
89
-a logfile to rotate. A simple configuration file looks like this:
90
+some logfiles to rotate. A simple configuration file looks like this:
98
- /sbin/killall -HUP syslogd
99
+ /sbin/killall -HUP syslogd
107
- /sbin/killall -HUP httpd
108
+ /sbin/killall -HUP httpd
113
olddir /var/log/news/old
116
- kill -HUP `cat /var/run/inn.pid`
117
+ kill -HUP `cat /var/run/inn.pid`
122
The first few lines set global options; in the example, logs are
123
compressed after they are rotated. Note that comments may appear
124
anywhere in the config file as long as the first non-whitespace
125
-character on the line is a #.
126
+character on the line is a \fB#\fR.
128
-The next section of the config files defined how to handle the log file
129
+The next section of the config file defines how to handle the log file
130
\fI/var/log/messages\fR. The log will go through five weekly rotations before
131
being removed. After the log file has been rotated (but before the old
132
version of the log has been compressed), the command
133
@@ -117,13 +123,13 @@
135
The next section defines the parameters for both
136
\fI/var/log/httpd/access.log\fR and \fI/var/log/httpd/error.log\fR.
137
-They are rotated whenever is grows over 100k is size, and the old logs
138
+Each is rotated whenever it grows over 100k in size, and the old log
139
files are mailed (uncompressed) to www@my.org after going through 5
140
rotations, rather then being removed. The \fBsharedscripts\fR means that
141
the \fBpostrotate\fR script will only be run once, not once for each
142
-log which is rotated. Note that the double quotes around the first filename
143
-at the beginning of this section allows logrotate to rotate logs with
144
-spaces in the name. Normal shell quoting rules apply, with ', ", and \\
145
+log which is rotated. Note that log file names may be enclosed in
146
+quotes (and that quotes are required if the name contains spaces).
147
+Normal shell quoting rules apply, with \fB'\fR, \fB"\fR, and \fB\\\fR
148
characters supported.
150
The last section defines the parameters for all of the files in
151
@@ -135,29 +141,33 @@
152
rotate all files, including previously rotated ones. A way around this
153
is to use the \fBolddir\fR directive or a more exact wildcard (such as *.log).
155
+If the directory \fI/var/log/news\fR does not exist, this will cause
156
+\fBlogrotate\fR to report an error. This error cannot be stopped with
157
+the \fBmissingok\fR directive.
159
Here is more information on the directives which may be included in
160
a \fBlogrotate\fR configuration file:
164
-Old versions of log files are compressed with \fBgzip\fR by default. See also
166
+Old versions of log files are compressed with \fBgzip\fR(1) by default.
167
+See also \fBnocompress\fR.
171
Specifies which command to use to compress log files. The default is
172
-\fBgzip\fR. See also \fBcompress\fR.
173
+\fBgzip\fR(1). See also \fBcompress\fR.
177
Specifies which command to use to uncompress log files. The default is
183
Specifies which extension to use on compressed logfiles, if compression
184
-is enabled. The default follows that of the configured compression
186
+is enabled. The default follows that of the default compression
190
\fBcompressoptions\fR
195
-Truncate the original log file in place after creating a copy,
196
-instead of moving the old log file and optionally creating a new one,
197
-It can be used when some program can not be told to close its logfile
198
+Truncate the original log file to zero size in place after creating a copy,
199
+instead of moving the old log file and optionally creating a new one.
200
+It can be used when some program cannot be told to close its logfile
201
and thus might continue writing (appending) to the previous log file forever.
202
Note that there is a very small time slice between copying the file and
203
truncating it, so some logging data might be lost.
205
Immediately after rotation (before the \fBpostrotate\fR script is run)
206
the log file is created (with the same name as the log file just rotated).
207
\fImode\fR specifies the mode for the log file in octal (the same
208
-as \fBchmod(2)\fR), \fIowner\fR specifies the user name who will own the
209
+as \fBchmod\fR(2)), \fIowner\fR specifies the user name who will own the
210
log file, and \fIgroup\fR specifies the group the log file will belong
211
to. Any of the log file attributes may be omitted, in which case those
212
attributes for the new file will use the same values as the original log
213
@@ -207,20 +217,20 @@
216
Postpone compression of the previous log file to the next rotation cycle.
217
-This has only effect when used in combination with \fBcompress\fR.
218
-It can be used when some program can not be told to close its logfile
219
+This only has effect when used in combination with \fBcompress\fR.
220
+It can be used when some program cannot be told to close its logfile
221
and thus might continue writing to the previous log file for some time.
224
\fBextension \fIext\fR
225
Log files are given the final extension \fIext\fR after rotation. If
226
-compression is used, the compression extension (normally \fB.gz\fR)
227
+compression is used, the compression extension (normally \fI.gz\fR)
228
appears after \fIext\fR.
232
-Rotate the log file even if it is empty, overiding the \fBnotifempty\fR
233
-option (ifempty is the default).
234
+Rotate the log file even if it is empty, overriding the \fBnotifempty\fR
235
+option (\fBifempty\fR is the default).
238
\fBinclude \fIfile_or_directory\fR
239
@@ -231,12 +241,12 @@
240
which are ignored are files which are not regular files (such as
241
directories and named pipes) and files whose names end with one of
242
the taboo extensions, as specified by the \fBtabooext\fR directive.
243
-The \fBinclude\fR directive may not appear inside of a log file
244
+The \fBinclude\fR directive may not appear inside a log file
248
\fBmail \fIaddress\fR
249
-When a log is rotated out-of-existence, it is mailed to \fIaddress\fR. If
250
+When a log is rotated out of existence, it is mailed to \fIaddress\fR. If
251
no mail should be generated by a particular log, the \fBnomail\fR directive
258
-Old versions of log files are not compressed with \fBgzip\fR. See also
260
+Old versions of log files are not compressed. See also \fBcompress\fR.
268
-Don't mail old log files to any address.
269
+Do not mail old log files to any address.
273
@@ -300,12 +309,12 @@
277
-Logs are rotated in the same directory the log normally resides in (this
278
+Logs are rotated in the directory they normally reside in (this
279
overrides the \fBolddir\fR option).
282
\fBnosharedscripts\fR
283
-Run \fBprerotate\fR and \fBpostrotate\fR scripts for every script which
284
+Run \fBprerotate\fR and \fBpostrotate\fR scripts for every log which
285
is rotated (this is the default, and overrides the \fBsharedscripts\fR
288
@@ -326,16 +335,15 @@
289
\fBpostrotate\fR/\fBendscript\fR
290
The lines between \fBpostrotate\fR and \fBendscript\fR (both of which
291
must appear on lines by themselves) are executed after the log file is
292
-rotated. These directives may only appear inside of a log file definition.
293
-See \fBprerotate\fR as well.
294
+rotated. These directives may only appear inside a log file definition.
295
+See also \fBprerotate\fR.
298
\fBprerotate\fR/\fBendscript\fR
299
The lines between \fBprerotate\fR and \fBendscript\fR (both of which
300
must appear on lines by themselves) are executed before the log file is
301
rotated and only if the log will actually be rotated. These directives
302
-may only appear inside of a log file definition. See \fBpostrotate\fR
304
+may only appear inside a log file definition. See also \fBpostrotate\fR.
307
\fBfirstaction\fR/\fBendscript\fR
308
@@ -351,33 +359,34 @@
309
must appear on lines by themselves) are executed once after all log
310
files that match the wildcarded pattern are rotated, after postrotate script
311
is run and only if at least one log is rotated. These directives may only
312
-appear inside of a log file definition. See \fBlastaction\fR as well.
313
+appear inside a log file definition. See also \fBlastaction\fR.
316
\fBrotate \fIcount\fR
317
-Log files are rotated <count> times before being removed or mailed to the
318
+Log files are rotated \fIcount\fR times before being removed or mailed to the
319
address specified in a \fBmail\fR directive. If \fIcount\fR is 0, old versions
320
are removed rather then rotated.
324
-Log files are rotated when they grow bigger then \fIsize\fR bytes. If
325
-\fIsize\fR is followed by \fIM\fR, the size if assumed to be in megabytes.
326
-If the \fIk\fR is used, the size is in kilobytes. So \fBsize 100\fR,
327
-\fIsize 100k\fR, and \fIsize 100M\fR are all valid.
331
-Normally, \fBprescript\fR and \fBpostscript\fR scripts are run for each
332
+Normally, \fBprerotate\fR and \fBpostrotate\fR scripts are run for each
333
log which is rotated, meaning that a single script may be run multiple
334
times for log file entries which match multiple files (such as the
335
-/var/log/news/* example). If \fBsharedscript\fR is specified, the scripts
336
+\fI/var/log/news/*\fR example). If \fBsharedscripts\fR is specified, the scripts
337
are only run once, no matter how many logs match the wildcarded pattern.
338
However, if none of the logs in the pattern require rotating, the scripts
339
-will not be run at all. This option overrides the \fbnosharedscripts\fR
340
+will not be run at all. This option overrides the \fBnosharedscripts\fR
344
+\fBsize \fIsize\fR[\fBG\fR|\fBM\fR|\fBk\fR]
345
+Log files are rotated when they grow bigger then \fIsize\fR bytes. If
346
+\fIsize\fR is followed by \fIM\fR, the size if assumed to be in megabytes.
347
+If the \fIG\fR suffix is used, the size is in gigabytes.
348
+If the \fIk\fR suffix is used, the size is in kilobytes. So \fBsize 100\fR,
349
+\fIsize 100k\fR, \fIsize 100M\fR and \fIsize 1G\fR are all valid.
353
This is the number to use as the base for rotation. For example, if
354
you specify 0, the logs will be created with a .0 extension as they are
355
@@ -388,18 +397,21 @@
357
\fBtabooext\fR [+] \fIlist\fR
358
The current taboo extension list is changed (see the \fBinclude\fR directive
359
-for information on the taboo extensions). If a + precedes the list of
360
-extensions, the current taboo extension list is augmented, otherwise it
361
+for information on the taboo extensions). If a \fB+\fR precedes \fIlist\fR,
362
+the current taboo extension list is augmented by \fIlist\fR, otherwise it
363
is replaced. At startup, the taboo extension list
364
-contains .rpmorig, .rpmsave, ,v, .swp, .rpmnew, and ~.
365
+contains .rpmorig, .rpmsave, .dpkg-dist, .dpkg-old, .dpkg-new, .disabled,
366
+,v, .swp, .rpmnew, and ~. The members of the list are separated by spaces,
372
Log files are rotated if the current weekday is less then the weekday
373
of the last rotation or if more then a week has passed since the last
374
rotation. This is normally the same as rotating logs on the first day
375
-of the week, but it works better if \fIlogrotate\fR is not run every
377
+of the week, but if \fBlogrotate\fR is not being run every night a log
378
+rotation will happen at the first valid opportunity.
382
@@ -411,11 +423,16 @@
383
Configuration options.
390
+The \fBkillall\fR(1) program in Debian is found in the \fIpsmisc\fR package.
394
Erik Troan <ewt@redhat.com>
396
Preston Brown <pbrown@redhat.com>
398
+Corrections and changes for Debian by Paul Martin <pm@debian.org>
added
removed
debian/patches/manpage.patch
