summaryrefslogtreecommitdiff
path: root/usr.bin/newsyslog/newsyslog.8
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>1999-06-05 01:21:54 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>1999-06-05 01:21:54 +0000
commit1805b94e6caa317d402e398fa06fa3d93d6827a0 (patch)
treee58ba56a51e58547f1d6f5a95c25435bc397c5c3 /usr.bin/newsyslog/newsyslog.8
parentf35d61706eae00527a19f021ef26ab0109f18e5c (diff)
- remove trailing white space
- remove arguments from .Os macros - remove arguments from .Nm macros, where appropriate - some more Dq/Sq/Ql insanity - still lots to do in the usr.bin tree... :/
Diffstat (limited to 'usr.bin/newsyslog/newsyslog.8')
-rw-r--r--usr.bin/newsyslog/newsyslog.884
1 files changed, 52 insertions, 32 deletions
diff --git a/usr.bin/newsyslog/newsyslog.8 b/usr.bin/newsyslog/newsyslog.8
index 7617c06ea4e..09e26d8466d 100644
--- a/usr.bin/newsyslog/newsyslog.8
+++ b/usr.bin/newsyslog/newsyslog.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: newsyslog.8,v 1.12 1999/05/23 14:11:30 aaron Exp $
+.\" $OpenBSD: newsyslog.8,v 1.13 1999/06/05 01:21:35 aaron Exp $
.\"
.\" Copyright (c) 1997, Jason Downs. All rights reserved.
.\"
@@ -35,7 +35,7 @@
.\" from: @(#)newsyslog.8
.\"
.\" Copyright 1988, 1989 by the Massachusetts Institute of Technology
-.\"
+.\"
.\" Permission to use, copy, modify, and distribute this software
.\" and its documentation for any purpose and without fee is
.\" hereby granted, provided that the above copyright notice
@@ -59,45 +59,53 @@
.Op Fl vmnr
.Op Fl f Ar configuration file
.Sh DESCRIPTION
-.Nm newsyslog
+.Nm
is a program that should be scheduled to run periodically by
.Xr cron 8 .
When it is executed it archives log files if necessary. If a log file
-is determined to require archiving,
-.Nm newsyslog
-rearranges the files so that ``logfile'' is empty, ``logfile.0'' has
-the last period's logs in it, ``logfile.1'' has the next to last
+is determined to require archiving,
+.Nm
+rearranges the files so that
+.Pa logfile
+is empty,
+.Pa logfile.0
+has
+the last period's logs in it,
+.Pa logfile.1
+has the next to last
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
-space.
+space.
.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
hours may have elapsed since the last log archive. The granularity of
-.Nm newsyslog
+.Nm
is dependent on how often it is scheduled to run in
.Xr cron 8 .
Since the program is quite fast, it may be scheduled to run every hour
without any ill effects.
.Pp
-When starting up,
-.Nm newsyslog
+When starting up,
+.Nm
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 .
Each line of the file contains information about a particular log file
that should be handled by
.Nm newsyslog .
Each line has five mandatory fields and up to three optional fields, with a
whitespace separating each field. Blank lines or lines beginning with
-``#'' are ignored. The fields of the configuration file are as
-follows:
+.Ql #
+are ignored. The fields of the configuration file are as
+follows:
.Bl -tag -width XXXXXXXXXXXXXXXX
.It logfile name
The full pathname of the system log file to be archived.
.It owner.group of archives (optional)
-Specify an ownership and group for the archive file. The "." is essential,
-even if the
+Specify an ownership and group for the archive file. The
+.Ql \&.
+is essential, even if the
.Ar owner
or
.Ar group
@@ -109,32 +117,42 @@ Octal mode of created log files and archives.
Specify the number of archives to be kept besides the log file itself.
.It size of archives
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 ``*'', then the size of
+as described above. If this field is replaced by a
+.Ql * ,
+then the size of
the log file is not taken into account when determining when to trim the
log file.
.It archive interval
Specify the time separation between the trimming of the log file. If this
-field is replaced by a ``*'', the number of hours since the last time the
+field is replaced by a
+.Ql * ,
+the number of hours since the last time the
log was trimmed will not be taken into consideration.
.It flags (optional)
The
.Ar flags
field specifies if the archives should have any special processing
-done to the archived log files. The ``Z'' flag will make the archive
+done to the archived log files. The
+.Sq Z
+flag will make the archive
files compressed to save space using
.Xr gzip 1
or
.Xr compress 1 ,
-depending on compilation options. The ``B'' flag means that the file is a
+depending on compilation options. The
+.Sq B
+flag means that the file is a
binary file, and so the ASCII message which
-.Nm newsyslog
+.Nm
inserts to indicate the fact that the logs have been turned over
-should not be included. The ``M'' flag marks this entry as a monitored
+should not be included. The
+.Sq M
+flag marks this entry as a monitored
log file.
.It monitor notification (optional)
Specify the account that should receive notification messages if this is
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
log file as monitored.
.It pid file (optional)
@@ -148,33 +166,35 @@ The following options can be used with
.Nm newsyslog :
.Bl -tag -width XXX
.It Fl f Ar config-file
-Instructs newsyslog to use
+Instructs newsyslog to use
.Ar config-file
instead of
.Pa /etc/newsyslog.conf
for its configuration file.
.It Fl v
-Places
-.Nm newsyslog
+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 newsyslog
+.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 newsyslog
-must be running as root. Of course,
-.Nm newsyslog
+.Nm
+must be running as root. Of course,
+.Nm
will not be able to send a HUP signal to
.Xr syslogd 8 ,
so this option should only be used in debugging.
.It Fl m
Places
-.Nm newsyslog
-in monitoring mode; only entries marked with an ``M'' in flags are processed,
+.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