usr.sbin/cron/cron/cron.8

   1 .\"/* Copyright 1988,1990,1993 by Paul Vixie
   2 .\" * All rights reserved
   3 .\" *
   4 .\" * Distribute freely, except: don't remove my name from the source or
   5 .\" * documentation (don't take credit for my work), mark your changes (don't
   6 .\" * get me blamed for your possible bugs), don't alter or remove this
   7 .\" * notice.  May be sold if buildable source is provided to buyer.  No
   8 .\" * warrantee of any kind, express or implied, is included with this
   9 .\" * software; use at your own risk, responsibility for damages (if any) to
  10 .\" * anyone resulting from the use of this software rests entirely with the
  11 .\" * user.
  12 .\" *
  13 .\" * Send bug reports, bug fixes, enhancements, requests, flames, etc., and
  14 .\" * I'll try to keep a version up to date.  I can be reached as follows:
  15 .\" * Paul Vixie          <paul@vix.com>          uunet!decwrl!vixie!paul
  16 .\" */
  17 .\"
  18 .\" $FreeBSD: src/usr.sbin/cron/cron/cron.8,v 1.7.2.9 2003/03/11 21:13:48 trhodes Exp $
  19 .\" $DragonFly: src/usr.sbin/cron/cron/cron.8,v 1.3 2006/03/18 20:29:50 dillon Exp $
  20 .\"
  21 .Dd December 20, 1993
  22 .Dt CRON 8
  23 .Os
  24 .Sh NAME
  25 .Nm cron
  26 .Nd daemon to execute scheduled commands (Vixie Cron)
  27 .Sh SYNOPSIS
  28 .Nm
  29 .Op Fl j Ar jitter
  30 .Op Fl J Ar rootjitter
  31 .Op Fl s
  32 .Op Fl o
  33 .Op Fl x Ar debugflag Ns Op , Ns Ar ...
  34 .Sh DESCRIPTION
  35 The
  36 .Nm
  37 utility should be started from
  38 .Pa /etc/rc
  39 or
  40 .Pa /etc/rc.local .
  41 It will return immediately,
  42 so you don't need to start it with '&'.
  43 .Pp
  44 The
  45 .Nm
  46 utility searches
  47 .Pa /var/cron/tabs
  48 for crontab files which are named after accounts in
  49 .Pa /etc/passwd ;
  50 crontabs found are loaded into memory.
  51 The
  52 .Nm
  53 utility also searches for
  54 .Pa /etc/crontab
  55 which is in a different format (see
  56 .Xr crontab 5 ) .
  57 The
  58 .Nm
  59 utility
  60 then wakes up every minute, examining all stored crontabs, checking each
  61 command to see if it should be run in the current minute.  When executing
  62 commands, any output is mailed to the owner of the crontab (or to the user
  63 named in the
  64 .Ev MAILTO
  65 environment variable in the crontab, if such exists).
  66 .Pp
  67 Additionally,
  68 .Nm
  69 checks each minute to see if its spool directory's modification time (or
  70 the modification time on
  71 .Pa /etc/crontab )
  72 has changed, and if it has,
  73 .Nm
  74 will then examine the modification time on all crontabs and reload those
  75 which have changed.  Thus
  76 .Nm
  77 need not be restarted whenever a crontab file is modified.  Note that the
  78 .Xr crontab 1
  79 command updates the modification time of the spool directory whenever it
  80 changes a crontab.
  81 .Pp
  82 Available options:
  83 .Bl -tag -width indent
  84 .It Fl j Ar jitter
  85 Enable time jitter.
  86 Prior to executing commands,
  87 .Nm
  88 will sleep a random number of seconds in the range from 0 to
  89 .Ar jitter .
  90 This won't affect superuser jobs (see
  91 .Fl J ) .
  92 A value for
  93 .Ar jitter
  94 must be between 0 and 60 inclusive.
  95 Default is 0, which effectively disables time jitter.
  96 .Pp
  97 This option can help to smooth down system load spikes during
  98 moments when a lot of jobs are likely to start at once, e.g.,
  99 at the beginning of the first minute of each hour.
 100 .It Fl J Ar rootjitter
 101 Enable time jitter for superuser jobs.
 102 The same as
 103 .Fl j
 104 except that it will affect jobs run by the superuser only.
 105 .It Fl s
 106 Enable special handling of situations when the GMT offset of the local
 107 timezone changes, such as the switches between the standard time and
 108 daylight saving time.
 109 .Pp
 110 The jobs run during the GMT offset changes time as
 111 intuitively expected.
 112 If a job falls into a time interval that disappears
 113 (for example, during the switch from
 114 standard time) to daylight saving time or is
 115 duplicated (for example, during the reverse switch), then it's handled
 116 in one of two ways:
 117 .Pp
 118 The first case is for the jobs that run every at hour of a time interval
 119 overlapping with the disappearing or duplicated interval.
 120 In other words, if the job had run within one hour before the GMT offset change
 121 (and cron was not restarted nor the
 122 .Xr crontab 5
 123 changed after that)
 124 or would run after the change at the next hour.
 125 They work as always, skip the skipped time or run in the added
 126 time as usual.
 127 .Pp
 128 The second case is for the jobs that run less frequently.
 129 They are executed exactly once, they are not skipped nor
 130 executed twice (unless cron is restarted or the user's
 131 .Xr crontab 5
 132 is changed during such a time interval).
 133 If an interval disappears
 134 due to the GMT offset change, such jobs are
 135 executed at the same absolute point of time as they would be in the
 136 old time zone.
 137 For example, if exactly one hour disappears, this
 138 point would be during the next hour at the first minute that is
 139 specified for them in
 140 .Xr crontab 5 .
 141 .It Fl o
 142 Disable the special handling of situations when the GMT offset of the local
 143 timezone changes, to be compatible with the old (default) behavior.
 144 If both options
 145 .Fl o
 146 and
 147 .Fl s
 148 are specified, the option specified last wins.
 149 .It Fl x Ar debugflag Ns Op , Ns Ar ...
 150 Enable writing of debugging information to standard output.
 151 One or more of the following comma separated
 152 .Ar debugflag
 153 identifiers must be specified:
 154 .Pp
 155 .Bl -tag -width ".Cm proc" -compact
 156 .It Cm bit
 157 currently not used
 158 .It Cm ext
 159 make the other debug flags more verbose
 160 .It Cm load
 161 be verbose when loading crontab files
 162 .It Cm misc
 163 be verbose about miscellaneous one-off events
 164 .It Cm pars
 165 be verbose about parsing individual crontab lines
 166 .It Cm proc
 167 be verbose about the state of the process, including all of its offspring
 168 .It Cm sch
 169 be verbose when iterating through the scheduling algorithms
 170 .It Cm test
 171 trace through the execution, but do not perform any actions
 172 .El
 173 .El
 174 .Sh SEE ALSO
 175 .Xr crontab 1 ,
 176 .Xr crontab 5
 177 .Sh AUTHORS
 178 .An Paul Vixie Aq paul@vix.com