Magellan Linux

  • Back to homepage
    • /[pkg-src]/trunk/logrotate/patches/logrotate-3.7.7-manpage-fixes.patch

    Contents of /trunk/logrotate/patches/logrotate-3.7.7-manpage-fixes.patch

    Parent Directory Parent Directory | Revision Log Revision Log

    Revision 703 - (show annotations) (download)
    Tue Oct 14 22:21:29 2008 UTC (15 years, 7 months ago) by niro
    File size: 15840 byte(s) 
    -re-diffed for 3.7.7
    1 diff -Naur logrotate-3.7.7/logrotate.8 logrotate-3.7.7-magellan/logrotate.8
    2 --- logrotate-3.7.7/logrotate.8 2008-05-14 10:12:14.000000000 +0200
    3 +++ logrotate-3.7.7-magellan/logrotate.8 2008-10-15 00:30:44.000000000 +0200
    4 @@ -2,7 +2,8 @@
    5 .SH NAME
    6 logrotate \- rotates, compresses, and mails system logs
    7 .SH SYNOPSIS
    8 -\fBlogrotate\fR [-dv] [-f|--force] [-s|--state \fIfile\fR] \fIconfig_file\fR+
    9 +\fBlogrotate\fR [\fB\-dv\fR] [\fB\-f\fR|\fB\-\-force\fR]
    10 +[\fB\-s\fR|\fB-\-state\ \fIstatefile\fR] \fIconfig_file\fR ..
    11 .SH DESCRIPTION
    12 \fBlogrotate\fR is designed to ease administration of systems that generate
    13 large numbers of log files. It allows automatic rotation, compression,
    14 @@ -10,16 +11,16 @@
    15 weekly, monthly, or when it grows too large.
    16 .P
    17 Normally, \fBlogrotate\fR is run as a daily cron job. It will not modify
    18 -a log multiple times in one day unless the criterium for that log is
    19 -based on the log's size and \fBlogrotate\fR is being run multiple times
    20 -each day, or unless the \fB-f\fR or \fB-force\fR option is used.
    21 +a log more than once in one day unless the criterion for that log is
    22 +based on the log's size and \fBlogrotate\fR is being run more than once
    23 +each day, or unless the \fB-f\fR or \fB-\-force\fR option is used.
    24 .P
    25 Any number of config files may be given on the command line. Later config
    26 files may override the options given in earlier files, so the order
    27 -in which the \fBlogrotate\fR config files are listed in is important.
    28 +in which the \fBlogrotate\fR config files are listed is important.
    29 Normally, a single config file which includes any other config files
    30 which are needed should be used. See below for more information on how
    31 -to use the \fIinclude\fR directive to accomplish this. If a directory
    32 +to use the \fBinclude\fR directive to accomplish this. If a directory
    33 is given on the command line, every file in that directory is used as
    34 a config file.
    35 .P
    36 @@ -35,14 +36,15 @@
    37 be made to the logs or to the \fBlogrotate\fR state file.
    38
    39 .TP
    40 -\fB-f, -\-force\fR
    41 +\fB-f\fR, \fB-\-force\fR
    42 Tells \fBlogrotate\fR to force the rotation, even if it doesn't think
    43 this is necessary. Sometimes this is useful after adding new entries to
    44 -\fBlogrotate\fR, or if old log files have been removed by hand, as the
    45 -new files will be created, and logging will continue correctly.
    46 +a \fBlogrotate\fR config file, or if old log files have been removed
    47 +by hand, as the new files will be created, and logging will continue
    48 +correctly.
    49
    50 .TP
    51 -\fB-m, -\-mail <command>\fR
    52 +\fB-m\R, \B-\-mail <command>\fR
    53 Tells \fBlogrotate\fR which command to use when mailing logs. This
    54 command should accept two arguments: 1) the subject of the message, and
    55 2) the recipient. The command must then read a message on standard input
    56 @@ -50,9 +52,9 @@
    57 -s\fR.
    58
    59 .TP
    60 -\fB-s, -\-state <statefile>\fR
    61 +\fB-s\fR, \fB-\-state <statefile>\fR
    62 Tells \fBlogrotate\fR to use an alternate state file. This is useful
    63 -if logrotate is being run as a different user for various sets of
    64 +if \fBlogrotate\fR is being run as a different user for various sets of
    65 log files. The default state file is \fI/var/lib/logrotate.status\fR.
    66
    67 .TP
    68 @@ -60,7 +62,7 @@
    69 Prints a short usage message.
    70
    71 .TP
    72 -\fB-v\fR
    73 +\fB-v\fR, \fB--verbose\fR
    74 Turns on verbose mode.
    75
    76 .SH CONFIGURATION FILE
    77 @@ -80,17 +82,17 @@
    78 rotate 5
    79 weekly
    80 postrotate
    81 - /sbin/killall -HUP syslogd
    82 + /bin/killall -HUP syslogd
    83 endscript
    84 }
    85
    86 "/var/log/httpd/access.log" /var/log/httpd/error.log {
    87 rotate 5
    88 mail www@my.org
    89 - size=100k
    90 + size 100k
    91 sharedscripts
    92 postrotate
    93 - /sbin/killall -HUP httpd
    94 + /bin/killall -HUP httpd
    95 endscript
    96 }
    97
    98 @@ -110,24 +112,24 @@
    99 The first few lines set global options; in the example, logs are
    100 compressed after they are rotated. Note that comments may appear
    101 anywhere in the config file as long as the first non-whitespace
    102 -character on the line is a #.
    103 +character on the line is a \fB#\fR.
    104
    105 -The next section of the config files defined how to handle the log file
    106 +The next section of the config file defines how to handle the log file
    107 \fI/var/log/messages\fR. The log will go through five weekly rotations before
    108 being removed. After the log file has been rotated (but before the old
    109 version of the log has been compressed), the command
    110 -\fI/sbin/killall -HUP syslogd\fR will be executed.
    111 +\fI/bin/killall -HUP syslogd\fR will be executed.
    112
    113 The next section defines the parameters for both
    114 \fI/var/log/httpd/access.log\fR and \fI/var/log/httpd/error.log\fR.
    115 -They are rotated whenever it grows over 100k in size, and the old logs
    116 +Each is rotated whenever it grows over 100k is size, and the old log
    117 files are mailed (uncompressed) to www@my.org after going through 5
    118 rotations, rather than being removed. The \fBsharedscripts\fR means that
    119 the \fBpostrotate\fR script will only be run once (after the old logs have
    120 -been compressed), not once for each log which is rotated. Note that the double
    121 -quotes around the first filename at the beginning of this section allows
    122 -logrotate to rotate logs with spaces in the name. Normal shell quoting rules
    123 -apply, with ', ", and \\ characters supported.
    124 +been compressed), not once for each log which is rotated. Note that log file
    125 +names may be enclosed in quotes (and that quotes are required if the name
    126 +contains spaces). Normal shell quoting rules apply, with \fB'\fR, \fB"\fR,
    127 +and \fB\\\fR characters supported.
    128
    129 The last section defines the parameters for all of the files in
    130 \fI/var/log/news\fR. Each file is rotated on a monthly basis. This is
    131 @@ -138,29 +140,33 @@
    132 rotate all files, including previously rotated ones. A way around this
    133 is to use the \fBolddir\fR directive or a more exact wildcard (such as *.log).
    134
    135 +If the directory \fI/var/log/news\fR does not exist, this will cause
    136 +\fBlogrotate\fR to report an error. This error cannot be stopped with
    137 +the \fBmissingok\fR directive.
    138 +
    139 Here is more information on the directives which may be included in
    140 a \fBlogrotate\fR configuration file:
    141
    142 .TP
    143 \fBcompress\fR
    144 -Old versions of log files are compressed with \fBgzip\fR by default. See also
    145 -\fBnocompress\fR.
    146 +Old versions of log files are compressed with \fBgzip\fR(1) by default.
    147 +See also \fBnocompress\fR.
    148
    149 .TP
    150 \fBcompresscmd\fR
    151 Specifies which command to use to compress log files. The default is
    152 -\fBgzip\fR. See also \fBcompress\fR.
    153 +\fBgzip\fR(1). See also \fBcompress\fR.
    154
    155 .TP
    156 \fBuncompresscmd\fR
    157 Specifies which command to use to uncompress log files. The default is
    158 -\fBgunzip\fR.
    159 +\fBgunzip\fR(1).
    160
    161 .TP
    162 \fBcompressext\fR
    163 Specifies which extension to use on compressed logfiles, if compression
    164 -is enabled. The default follows that of the configured compression
    165 -command.
    166 +is enabled. The default follows that of the default compression
    167 +command (.gz).
    168
    169 .TP
    170 \fBcompressoptions\fR
    171 @@ -177,7 +183,7 @@
    172
    173 .TP
    174 \fBcopytruncate\fR
    175 -Truncate the original log file in place after creating a copy,
    176 +Truncate the original log file to zero size in place after creating a copy,
    177 instead of moving the old log file and optionally creating a new one.
    178 It can be used when some program cannot be told to close its logfile
    179 and thus might continue writing (appending) to the previous log file forever.
    180 @@ -191,7 +197,7 @@
    181 Immediately after rotation (before the \fBpostrotate\fR script is run)
    182 the log file is created (with the same name as the log file just rotated).
    183 \fImode\fR specifies the mode for the log file in octal (the same
    184 -as \fBchmod(2)\fR), \fIowner\fR specifies the user name who will own the
    185 +as \fBchmod\fR)(2), \fIowner\fR specifies the user name who will own the
    186 log file, and \fIgroup\fR specifies the group the log file will belong
    187 to. Any of the log file attributes may be omitted, in which case those
    188 attributes for the new file will use the same values as the original log
    189 @@ -217,21 +223,21 @@
    190 .TP
    191 \fBdelaycompress\fR
    192 Postpone compression of the previous log file to the next rotation cycle.
    193 -This has only effect when used in combination with \fBcompress\fR.
    194 +This only has effect when used in combination with \fBcompress\fR.
    195 It can be used when some program cannot be told to close its logfile
    196 and thus might continue writing to the previous log file for some time.
    197
    198 .TP
    199 \fBextension \fIext\fR
    200 Log files with \fIext\fR extension can keep it after the rotation.
    201 -If compression is used, the compression extension (normally \fB.gz\fR)
    202 +If compression is used, the compression extension (normally \fI.gz\fR)
    203 appears after \fIext\fR. For example you have a logfile named mylog.foo
    204 and want to rotate it to mylog.1.foo.gz instead of mylog.foo.1.gz.
    205
    206 .TP
    207 \fBifempty\fR
    208 Rotate the log file even if it is empty, overriding the \fBnotifempty\fR
    209 -option (ifempty is the default).
    210 +option (\fBifempty\fR is the default).
    211
    212 .TP
    213 \fBinclude \fIfile_or_directory\fR
    214 @@ -242,12 +248,12 @@
    215 which are ignored are files which are not regular files (such as
    216 directories and named pipes) and files whose names end with one of
    217 the taboo extensions, as specified by the \fBtabooext\fR directive.
    218 -The \fBinclude\fR directive may not appear inside of a log file
    219 +The \fBinclude\fR directive may not appear inside a log file
    220 definition.
    221
    222 .TP
    223 \fBmail \fIaddress\fR
    224 -When a log is rotated out-of-existence, it is mailed to \fIaddress\fR. If
    225 +When a log is rotated out of existence, it is mailed to \fIaddress\fR. If
    226 no mail should be generated by a particular log, the \fBnomail\fR directive
    227 may be used.
    228
    229 @@ -289,8 +295,7 @@
    230
    231 .TP
    232 \fBnocompress\fR
    233 -Old versions of log files are not compressed with \fBgzip\fR. See also
    234 -\fBcompress\fR.
    235 +Old versions of log files are not compressed. See also \fBcompress\fR.
    236
    237 .TP
    238 \fBnocopy\fR
    239 @@ -318,7 +323,7 @@
    240
    241 .TP
    242 \fBnomail\fR
    243 -Don't mail old log files to any address.
    244 +Do not mail old log files to any address.
    245
    246 .TP
    247 \fBnomissingok\fR
    248 @@ -326,12 +331,12 @@
    249
    250 .TP
    251 \fBnoolddir\fR
    252 -Logs are rotated in the same directory the log normally resides in (this
    253 +Logs are rotated in the directory they normally reside in (this
    254 overrides the \fBolddir\fR option).
    255
    256 .TP
    257 \fBnosharedscripts\fR
    258 -Run \fBprerotate\fR and \fBpostrotate\fR scripts for every log file which
    259 +Run \fBprerotate\fR and \fBpostrotate\fR scripts for every log which
    260 is rotated (this is the default, and overrides the \fBsharedscripts\fR
    261 option). If the scripts exit with error, the remaining actions will
    262 not be executed for the affected log only.
    263 @@ -357,8 +362,8 @@
    264 \fBpostrotate\fR/\fBendscript\fR
    265 The lines between \fBpostrotate\fR and \fBendscript\fR (both of which
    266 must appear on lines by themselves) are executed after the log file is
    267 -rotated. These directives may only appear inside of a log file definition.
    268 -See \fBprerotate\fR as well. See \fBsharedscripts\fR and
    269 +rotated. These directives may only appear inside a log file definition.
    270 +See also \fBprerotate\fR. See \fBsharedscripts\fR and
    271 \fBnosharedscripts\fR for error handling.
    272
    273 .TP
    274 @@ -366,9 +371,8 @@
    275 The lines between \fBprerotate\fR and \fBendscript\fR (both of which
    276 must appear on lines by themselves) are executed before the log file is
    277 rotated and only if the log will actually be rotated. These directives
    278 -may only appear inside of a log file definition. See \fBpostrotate\fR
    279 -as well. See \fBsharedscripts\fR and \fBnosharedscripts\fR for error
    280 -handling.
    281 +may only appear inside a log file definition. See also \fBpostrotate\fR.
    282 +See \fBsharedscripts\fR and \fBnosharedscripts\fR for error handling.
    283
    284 .TP
    285 \fBfirstaction\fR/\fBendscript\fR
    286 @@ -376,7 +380,7 @@
    287 must appear on lines by themselves) are executed once before all log
    288 files that match the wildcarded pattern are rotated, before prerotate script
    289 is run and only if at least one log will actually be rotated. These directives
    290 -may only appear inside of a log file definition. If the script exits
    291 +may only appear inside a log file definition. If the script exits
    292 with error, no further processing is done. See \fBlastaction\fR as well.
    293
    294 .TP
    295 @@ -385,34 +389,34 @@
    296 must appear on lines by themselves) are executed once after all log
    297 files that match the wildcarded pattern are rotated, after postrotate script
    298 is run and only if at least one log is rotated. These directives may only
    299 -appear inside of a log file definition. If the script exits with
    300 +appear inside a log file definition. If the script exits with
    301 error, just an error message is shown (as this is the last
    302 action). See \fBfirstaction\fR as well.
    303
    304 .TP
    305 \fBrotate \fIcount\fR
    306 -Log files are rotated <count> times before being removed or mailed to the
    307 +Log files are rotated \fIcount\fR times before being removed or mailed to the
    308 address specified in a \fBmail\fR directive. If \fIcount\fR is 0, old versions
    309 are removed rather than rotated.
    310
    311 .TP
    312 -\fBsize \fIsize\fR
    313 ++\fBsize \fIsize\fR[\fBG\fR|\fBM\fR|\fBk\fR]
    314 Log files are rotated when they grow bigger than \fIsize\fR bytes. If
    315 \fIsize\fR is followed by \fIM\fR, the size if assumed to be in megabytes.
    316 -If the \fIk\fR is used, the size is in kilobytes. So \fBsize 100\fR,
    317 -\fIsize 100k\fR, and \fIsize 100M\fR are all valid.
    318 +If the \fIG\fR suffix is used, the size is in gigabytes.
    319 +If the \fIk\fR suffix is used, the size is in kilobytes. So \fBsize 100\fR,
    320 +\fIsize 100k\fR, \fIsize 100M\fR and \fIsize 1G\fR are all valid.
    321
    322 .TP
    323 \fBsharedscripts\fR
    324 -Normally, \fBprescript\fR and \fBpostscript\fR scripts are run for each
    325 +Normally, \fBprerotate\fR and \fBpostrotate\fR scripts are run for each
    326 log which is rotated, meaning that a single script may be run multiple
    327 times for log file entries which match multiple files (such as the
    328 -/var/log/news/* example). If \fBsharedscript\fR is specified, the scripts
    329 +\fI/var/log/news/*\fR example). If \fBsharedscript\fR is specified, the scripts
    330 are only run once, no matter how many logs match the wildcarded pattern.
    331 However, if none of the logs in the pattern require rotating, the scripts
    332 -will not be run at all. If the scripts exit with error, the remaining
    333 -actions will not be executed for any logs. This option overrides the
    334 -\fBnosharedscripts\fR option and implies \fBcreate\fR option.
    335 +will not be run at all. This option overrides the \fBnosharedscripts\fR
    336 +option and implies \fBcreate\fR option.
    337
    338 .TP
    339 \fBshred\fR
    340 @@ -436,18 +440,19 @@
    341 .TP
    342 \fBtabooext\fR [+] \fIlist\fR
    343 The current taboo extension list is changed (see the \fBinclude\fR directive
    344 -for information on the taboo extensions). If a + precedes the list of
    345 -extensions, the current taboo extension list is augmented, otherwise it
    346 +for information on the taboo extensions). If a \fB+\fR precedes \fIlist\fR,
    347 +the current taboo extension list is augmented by \fIlist\fR, otherwise it
    348 is replaced. At startup, the taboo extension list
    349 contains .rpmorig, .rpmsave, ,v, .swp, .rpmnew, ~, .cfsaved and .rhn-cfg-tmp-*.
    350 +Note that all hidden files (files starting with .) are ignored.
    351
    352 .TP
    353 \fBweekly\fR
    354 Log files are rotated if the current weekday is less than the weekday
    355 of the last rotation or if more than a week has passed since the last
    356 rotation. This is normally the same as rotating logs on the first day
    357 -of the week, but it works better if \fIlogrotate\fR is not run every
    358 -night.
    359 +of the week, but if \fBlogrotate\fR is not being run every night a log
    360 +rotation will happen at the first valid opportunity.
    361
    362 .TP
    363 \fByearly\fR
    364 @@ -463,11 +468,17 @@
    365 Configuration options.
    366
    367 .SH SEE ALSO
    368 -.IR gzip (1)
    369 +.BR gzip (1)
    370
    371 .SH AUTHORS
    372 .nf
    373 Erik Troan <ewt@redhat.com>
    374 .nf
    375 Preston Brown <pbrown@redhat.com>
    376 +.nf
    377 +Corrections and changes for Debian by Paul Martin <pm@debian.org>
    378 +.nf
    379 +Corrections and changes for Gentoo by Daniel Gryniewicz <dang@gentoo.org>
    380 +.nf
    381 +Corrections and changes for Magellan by Niels Rogalla <niro@magellan-linux.org>
    382 .fi