[BACK]Return to newsyslog.8 CVS log [TXT][DIR] Up to [local] / src / usr.bin / newsyslog

Diff for /src/usr.bin/newsyslog/newsyslog.8 between version 1.17 and 1.18

version 1.17, 2000/03/05 00:28:53 version 1.18, 2000/03/10 19:07:22
Line 62 
Line 62 
 .Nm  .Nm
 is a program that should be scheduled to run periodically by  is a program that should be scheduled to run periodically by
 .Xr cron 8 .  .Xr cron 8 .
 When it is executed it archives log files if necessary.  If a log file  When it is executed it archives log files if necessary.
 is determined to require archiving,  If a log file is determined to require archiving,
 .Nm  .Nm
 rearranges the files so that  rearranges the files so that
 .Pa logfile  .Pa logfile
Line 74 
Line 74 
 .Pa logfile.1  .Pa logfile.1
 has the next to last  has the next to last
 period's logs in it, and so on, up to a user-specified number of  period's logs in it, and so on, up to a user-specified number of
 archived logs.  Optionally the archived logs can be compressed to save  archived logs.
   Optionally the archived logs can be compressed to save
 space.  space.
 .Pp  .Pp
 A log can be archived because of two reasons.  The log file can have  The options are as follows:
   .Bl -tag -width Ds
   .It Fl f Ar config-file
   Use
   .Ar config-file
   instead of
   .Pa /etc/newsyslog.conf
   for the configuration file.
   .It Fl v
   Be verbose.
   In this mode it will print out each log and its
   reasons for either trimming that log or skipping it.
   .It Fl n
   Do not trim the logs, but instead print out what would be done if this option
   were not specified.
   .It Fl r
   Removes the restriction that
   .Nm
   must be running as root.
   Of course,
   .Nm
   will not be able to send a
   .Dv SIGHUP
   signal to
   .Xr syslogd 8 ,
   so this option should only be used in debugging.
   .It Fl m
   Monitoring mode; only entries marked with an
   .Sq M
   in flags are processed,
   and notifications sent if any have changed.
   Without this option, monitored entries are not processed.
   .El
   .Pp
   A log can be archived because of two reasons.
   The log file can have
 grown bigger than a preset size in kilobytes, or a preset number of  grown bigger than a preset size in kilobytes, or a preset number of
 hours may have elapsed since the last log archive.  The granularity of  hours may have elapsed since the last log archive.
   The granularity of
 .Nm  .Nm
 is dependent on how often it is scheduled to run in  is dependent on how often it is scheduled to run in
 .Xr cron 8 .  .Xr cron 8 .
Line 89 
Line 126 
 When starting up,  When starting up,
 .Nm  .Nm
 reads in a configuration file to determine which logs should be looked  reads in a configuration file to determine which logs should be looked
 at.  By default, this configuration file is  at.
   By default, this configuration file is
 .Pa /etc/newsyslog.conf .  .Pa /etc/newsyslog.conf .
 Each line of the file contains information about a particular log file  Each line of the file contains information about a particular log file
 that should be handled by  that should be handled by
 .Nm newsyslog .  .Nm newsyslog .
 Each line has five mandatory fields and up to three optional fields, with a  Each line has five mandatory fields and up to three optional fields, with a
 whitespace separating each field.  Blank lines or lines beginning with  whitespace separating each field.
 .Ql #  Blank lines or lines beginning with a hash mark
 are ignored.  The fields of the configuration file are as  .Pq Ql #
   are ignored.
   The fields of the configuration file are as
 follows:  follows:
 .Bl -tag -width XXXXXXXXXXXXXXXX  .Bl -tag -width XXXXXXXXXXXXXXXX
 .It logfile name  .It logfile name
 The full pathname of the system log file to be archived.  The full pathname of the system log file to be archived.
 .It owner.group of archives (optional)  .It owner.group of archives (optional)
 Specify an ownership and group for the archive file.  The  Specify an ownership and group for the archive file.
   The
 .Ql \&.  .Ql \&.
 is essential, even if the  is essential, even if the
 .Ar owner  .Ar owner
 or  or
 .Ar group  .Ar group
 field is left blank.  The fields may be numeric, or a name which is looked up  field is left blank.
   The fields may be numeric, or a name which is looked up
 in the system password and group databases.  in the system password and group databases.
 .It mode of logfile & archives  .It mode of logfile & archives
 Octal mode of created log files and archives.  Octal mode of created log files and archives.
Line 117 
Line 159 
 Specify the number of archives to be kept besides the log file itself.  Specify the number of archives to be kept besides the log file itself.
 .It size of archives  .It size of archives
 When the size of the log file reaches this point, the log file becomes trimmed  When the size of the log file reaches this point, the log file becomes trimmed
 as described above.  If this field is replaced by a  as described above.
   If this field is replaced by a
 .Ql * ,  .Ql * ,
 then the size of  then the size of
 the log file is not taken into account when determining when to trim the  the log file is not taken into account when determining when to trim the
 log file.  log file.
 .It archive interval  .It archive interval
 Specify the time separation between the trimming of the log file.  If this  Specify the time separation between the trimming of the log file.
 field is replaced by a  If this field is replaced by a
 .Ql * ,  .Ql * ,
 the number of hours since the last time the  the number of hours since the last time the
 log was trimmed will not be taken into consideration.  log was trimmed will not be taken into consideration.
Line 132 
Line 175 
 The  The
 .Ar flags  .Ar flags
 field specifies if the archives should have any special processing  field specifies if the archives should have any special processing
 done to the archived log files.  The  done to the archived log files.
   The
 .Sq Z  .Sq Z
 flag will make the archive  flag will make the archive
 files compressed to save space using  files compressed to save space using
 .Xr gzip 1  .Xr gzip 1
 or  or
 .Xr compress 1 ,  .Xr compress 1 ,
 depending on compilation options.  The  depending on compilation options.
   The
 .Sq B  .Sq B
 flag means that the file is a  flag means that the file is a
 binary file, and so the ASCII message which  binary file, and so the ASCII message which
 .Nm  .Nm
 inserts to indicate the fact that the logs have been turned over  inserts to indicate the fact that the logs have been turned over
 should not be included.  The  should not be included.
   The
 .Sq M  .Sq M
 flag marks this entry as a monitored  flag marks this entry as a monitored
 log file.  log file.
 .It monitor notification (optional)  .It monitor notification (optional)
 Specify the account that should receive notification messages if this is  Specify the account that should receive notification messages if this is
 a monitored log file.  Notification messages are sent as email; the operator  a monitored log file.
   Notification messages are sent as email; the operator
 deserves what they get if they mark the  deserves what they get if they mark the
 .Xr sendmail 8  .Xr sendmail 8
 log file as monitored.  log file as monitored.
Line 161 
Line 208 
 signal to instead of  signal to instead of
 .Pa /var/run/syslog.pid .  .Pa /var/run/syslog.pid .
 .It signal (optional)  .It signal (optional)
 Specify the signal to send to the process instead of SIGHUP.  Signal names  Specify the signal to send to the process instead of
   .Dv SIGHUP .
   Signal names
 must start with  must start with
 .Dq SIG  .Dq SIG
 and be the signal name, not the number.  Eg.  and be the signal name, not the number, e.g.,
 .Em SIGUSR1 .  .Em SIGUSR1 .
 .It command (optional)  .It command (optional)
 Specify a command to run instead of sending a signal to the process.  Specify a command to run instead of sending a signal to the process.
 The command must be enclosed in double quotes ('"').  You cannot specify  The command must be enclosed in double quotes
 both a command and a pid file.  .Pq Ql \&" ) .
   You cannot specify both a command and a PID file.
 .El  .El
 .Pp  
 The options are as follows:  
 .Bl -tag -width XXX  
 .It Fl f Ar config-file  
 Instructs newsyslog to use  
 .Ar config-file  
 instead of  
 .Pa /etc/newsyslog.conf  
 for its configuration file.  
 .It Fl v  
 Places  
 .Nm  
 in verbose mode.  In this mode it will print out each log and its  
 reasons for either trimming that log or skipping it.  
 .It Fl n  
 Causes  
 .Nm  
 not to trim the logs, but to print out what it would do if this option  
 were not specified.  
 .It Fl r  
 Removes the restriction that  
 .Nm  
 must be running as root.  Of course,  
 .Nm  
 will not be able to send a  
 .Dv SIGHUP  
 signal to  
 .Xr syslogd 8 ,  
 so this option should only be used in debugging.  
 .It Fl m  
 Places  
 .Nm  
 in monitoring mode; only entries marked with an  
 .Sq M  
 in flags are processed,  
 and notifications sent if any have changed.  Without this option, monitored  
 entries are not processed.  
 .El  
 .Sh FILES  .Sh FILES
 .Bl -tag -width /etc/newsyslog.conf  .Bl -tag -width /etc/newsyslog.conf
 .It Pa /etc/newsyslog.conf  .It Pa /etc/newsyslog.conf
Line 220 
Line 232 
 .Xr syslog 3 ,  .Xr syslog 3 ,
 .Xr syslogd 8  .Xr syslogd 8
 .Sh AUTHOR  .Sh AUTHOR
 .Bd -unfilled -offset indent  .Bd -unfilled
 Theodore Ts'o, MIT Project Athena  Theodore Ts'o, MIT Project Athena
 Copyright 1987, Massachusetts Institute of Technology  Copyright 1987, Massachusetts Institute of Technology
 .Ed  .Ed
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18