usr.sbin/newsyslog/newsyslog.8

   1 .\" This file contains changes from the Open Software Foundation.
   2 .\"
   3 .\"     from: @(#)newsyslog.8
   4 .\" $FreeBSD$
   5 .\"
   6 .\" Copyright 1988, 1989 by the Massachusetts Institute of Technology
   7 .\"
   8 .\" Permission to use, copy, modify, and distribute this software
   9 .\" and its documentation for any purpose and without fee is
  10 .\" hereby granted, provided that the above copyright notice
  11 .\" appear in all copies and that both that copyright notice and
  12 .\" this permission notice appear in supporting documentation,
  13 .\" and that the names of M.I.T. and the M.I.T. S.I.P.B. not be
  14 .\" used in advertising or publicity pertaining to distribution
  15 .\" of the software without specific, written prior permission.
  16 .\" M.I.T. and the M.I.T. S.I.P.B. make no representations about
  17 .\" the suitability of this software for any purpose.  It is
  18 .\" provided "as is" without express or implied warranty.
  19 .\"
  20 .Dd January 31, 2011
  21 .Dt NEWSYSLOG 8
  22 .Os
  23 .Sh NAME
  24 .Nm newsyslog
  25 .Nd maintain system log files to manageable sizes
  26 .Sh SYNOPSIS
  27 .Nm
  28 .Op Fl CFNPnrsv
  29 .Op Fl a Ar directory
  30 .Op Fl d Ar directory
  31 .Op Fl f Ar config_file
  32 .Op Fl S Ar pidfile
  33 .Op Fl t Ar timefmt
  34 .Op Oo Fl R Ar tagname Oc Ar
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 utility should be scheduled to run periodically by
  39 .Xr cron 8 .
  40 When it is executed it archives log files if necessary.
  41 If a log file
  42 is determined to require archiving,
  43 .Nm
  44 rearranges the files so that
  45 .Dq Va logfile
  46 is empty,
  47 .Dq Va logfile Ns Li \&.0
  48 has
  49 the last period's logs in it,
  50 .Dq Va logfile Ns Li \&.1
  51 has the next to last
  52 period's logs in it, and so on, up to a user-specified number of
  53 archived logs.
  54 It is also possible to let archived log filenames be created using the
  55 time the log file was archived instead of the sequential number using
  56 the
  57 .Fl t
  58 option.
  59 Optionally the archived logs can be compressed to save
  60 space.
  61 .Pp
  62 A log can be archived for three reasons:
  63 .Bl -enum -offset indent
  64 .It
  65 It is larger than the configured size (in kilobytes).
  66 .It
  67 A configured number of hours have elapsed since the log was last
  68 archived.
  69 .It
  70 This is the specific configured hour for rotation of the log.
  71 .El
  72 .Pp
  73 The granularity of
  74 .Nm
  75 is dependent on how often it is scheduled to run by
  76 .Xr cron 8 .
  77 Since the program is quite fast, it may be scheduled to run every hour
  78 without any ill effects,
  79 and mode three (above) assumes that this is so.
  80 .Sh OPTIONS
  81 The following options can be used with
  82 .Nm :
  83 .Bl -tag -width indent
  84 .It Fl f Ar config_file
  85 Instruct
  86 .Nm
  87 to use
  88 .Ar config_file
  89 instead of
  90 .Pa /etc/newsyslog.conf
  91 for its configuration file.
  92 .It Fl a Ar directory
  93 Specify a
  94 .Ar directory
  95 into which archived log files will be written.
  96 If a relative path is given,
  97 it is appended to the path of each log file
  98 and the resulting path is used as the directory
  99 into which the archived log for that log file will be written.
 100 If an absolute path is given,
 101 all archived logs are written into the given
 102 .Ar directory .
 103 If any component of the path
 104 .Ar directory
 105 does not exist,
 106 it will be created when
 107 .Nm
 108 is run.
 109 .It Fl d Ar directory
 110 Specify a
 111 .Ar directory
 112 which all log files will be relative to.
 113 To allow archiving of logs outside the root, the
 114 .Ar directory
 115 passed to the
 116 .Fl a
 117 option is unaffected.
 118 .It Fl v
 119 Place
 120 .Nm
 121 in verbose mode.
 122 In this mode it will print out each log and its
 123 reasons for either trimming that log or skipping it.
 124 .It Fl n
 125 Cause
 126 .Nm
 127 not to trim the logs, but to print out what it would do if this option
 128 were not specified. This option implies the
 129 .Fl r
 130 option.
 131 .It Fl r
 132 Remove the restriction that
 133 .Nm
 134 must be running as root.
 135 Of course,
 136 .Nm
 137 will not be able to send a HUP signal to
 138 .Xr syslogd 8
 139 so this option should only be used in debugging.
 140 .It Fl s
 141 Specify that
 142 .Nm
 143 should not send any signals to any daemon processes that it would
 144 normally signal when rotating a log file.
 145 For any log file which is rotated, this option will usually also
 146 mean the rotated log file will not be compressed if there is a
 147 daemon which would have been signalled without this option.
 148 However, this option is most likely to be useful when specified
 149 with the
 150 .Fl R
 151 option, and in that case the compression will be done.
 152 .It Fl t Ar timefmt
 153 If specified
 154 .Nm
 155 will create the
 156 .Dq rotated
 157 logfiles using the specified time format instead of the default
 158 sequential filenames.
 159 The time format is described in the
 160 .Xr strftime 3
 161 manual page.
 162 If the
 163 .Ar timefmt
 164 argument is set to an empty string or the string
 165 .Dq DEFAULT ,
 166 the default built in time format
 167 is used.
 168 If the
 169 .Ar timefmt
 170 string is changed the old files created using the previous time format
 171 will not be be automatically removed (unless the new format is very
 172 similar to the old format).
 173 This is also the case when changing from sequential filenames to time
 174 based file names, and the other way around.
 175 The time format should contain at least year, month, day, and hour to
 176 make sure rotating of old logfiles can select the correct logfiles.
 177 .It Fl C
 178 If specified once, then
 179 .Nm
 180 will create any log files which do not exist, and which have the
 181 .Sy C
 182 flag specified in their config file entry.
 183 If specified multiple times, then
 184 .Nm
 185 will create all log files which do not already exist.
 186 If log files are given on the command-line, then the
 187 .Fl C
 188 or
 189 .Fl CC
 190 will only apply to those specific log files.
 191 .It Fl F
 192 Force
 193 .Nm
 194 to trim the logs, even if the trim conditions have not been met.
 195 This
 196 option is useful for diagnosing system problems by providing you with
 197 fresh logs that contain only the problems.
 198 .It Fl N
 199 Do not perform any rotations.
 200 This option is intended to be used with the
 201 .Fl C
 202 or
 203 .Fl CC
 204 options when creating log files is the only objective.
 205 .It Fl P
 206 Prevent further action if we should send signal but the
 207 .Dq pidfile
 208 is empty or does not exist.
 209 .It Fl R Ar tagname
 210 Specify that
 211 .Nm
 212 should rotate a given list of files, even if trim conditions are not
 213 met for those files.
 214 The
 215 .Ar tagname
 216 is only used in the messages written to the log files which are
 217 rotated.
 218 This differs from the
 219 .Fl F
 220 option in that one or more log files must also be specified, so that
 221 .Nm
 222 will only operate on those specific files.
 223 This option is mainly intended for the daemons or programs which write
 224 some log files, and want to trigger a rotate based on their own criteria.
 225 With this option they can execute
 226 .Nm
 227 to trigger the rotate when they want it to happen, and still give the
 228 system administrator a way to specify the rules of rotation (such as how
 229 many backup copies are kept, and what kind of compression is done).
 230 When a daemon does execute
 231 .Nm
 232 with the
 233 .Fl R
 234 option, it should make sure all of the log files are closed before
 235 calling
 236 .Nm ,
 237 and then it should re-open the files after
 238 .Nm
 239 returns.
 240 Usually the calling process will also want to specify the
 241 .Fl s
 242 option, so
 243 .Nm
 244 will not send a signal to the very process which called it to force
 245 the rotate.
 246 Skipping the signal step will also mean that
 247 .Nm
 248 will return faster, since
 249 .Nm
 250 normally waits a few seconds after any signal that is sent.
 251 .It Fl S Ar pidfile
 252 Use
 253 .Ar pidfile
 254 as
 255 .Xr syslogd 8 Ns 's
 256 pidfile.
 257 .El
 258 .Pp
 259 If additional command line arguments are given,
 260 .Nm
 261 will only examine log files that match those arguments; otherwise, it
 262 will examine all files listed in the configuration file.
 263 .Sh FILES
 264 .Bl -tag -width /etc/newsyslog.confxxxx -compact
 265 .It Pa /etc/newsyslog.conf
 266 .Nm
 267 configuration file
 268 .El
 269 .Sh COMPATIBILITY
 270 Previous versions of the
 271 .Nm
 272 utility used the dot (``.'') character to
 273 distinguish the group name.
 274 Beginning with
 275 .Fx 3.3 ,
 276 this has been changed to a colon (``:'') character so that user and group
 277 names may contain the dot character.
 278 The dot (``.'') character is still
 279 accepted for backwards compatibility.
 280 .Sh SEE ALSO
 281 .Xr bzip2 1 ,
 282 .Xr gzip 1 ,
 283 .Xr xz 1 ,
 284 .Xr syslog 3 ,
 285 .Xr newsyslog.conf 5 ,
 286 .Xr chown 8 ,
 287 .Xr syslogd 8
 288 .Sh HISTORY
 289 The
 290 .Nm
 291 utility originated from
 292 .Nx
 293 and first appeared in
 294 .Fx 2.2 .
 295 .Sh AUTHORS
 296 .An Theodore Ts'o ,
 297 MIT Project Athena
 298 .Pp
 299 Copyright 1987, Massachusetts Institute of Technology
 300 .Sh BUGS
 301 Does not yet automatically read the logs to find security breaches.