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