usr.sbin/cron/crontab/crontab.5

   1 .\"/* Copyright 1988,1990,1993,1994 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$
  19 .\"
  20 .Dd January 24, 1994
  21 .Dt CRONTAB 5
  22 .Os
  23 .Sh NAME
  24 .Nm crontab
  25 .Nd tables for driving cron
  26 .Sh DESCRIPTION
  27 A
  28 .Nm
  29 file contains instructions to the
  30 .Xr cron 8
  31 daemon of the general form: ``run this command at this time on this date''.
  32 Each user has their own crontab, and commands in any given crontab will be
  33 executed as the user who owns the crontab.
  34 Uucp and News will usually have
  35 their own crontabs, eliminating the need for explicitly running
  36 .Xr su 1
  37 as part of a cron command.
  38 .Pp
  39 Blank lines and leading spaces and tabs are ignored.
  40 Lines whose first
  41 non-space character is a pound-sign (#) are comments, and are ignored.
  42 Note that comments are not allowed on the same line as cron commands, since
  43 they will be taken to be part of the command.
  44 Similarly, comments are not
  45 allowed on the same line as environment variable settings.
  46 .Pp
  47 An active line in a crontab will be either an environment setting or a cron
  48 command.
  49 An environment setting is of the form,
  50 .Bd -literal
  51     name = value
  52 .Ed
  53 .Pp
  54 where the spaces around the equal-sign (=) are optional, and any subsequent
  55 non-leading spaces in
  56 .Em value
  57 will be part of the value assigned to
  58 .Em name .
  59 The
  60 .Em value
  61 string may be placed in quotes (single or double, but matching) to preserve
  62 leading or trailing blanks.
  63 The
  64 .Em name
  65 string may also be placed in quote (single or double, but matching)
  66 to preserve leading, trailing or inner blanks.
  67 .Pp
  68 Several environment variables are set up
  69 automatically by the
  70 .Xr cron 8
  71 daemon.
  72 .Ev SHELL
  73 is set to
  74 .Pa /bin/sh ,
  75 and
  76 .Ev LOGNAME
  77 and
  78 .Ev HOME
  79 are set from the
  80 .Pa /etc/passwd
  81 line of the crontab's owner.
  82 .Ev HOME
  83 and
  84 .Ev SHELL
  85 may be overridden by settings in the crontab;
  86 .Ev LOGNAME
  87 may not.
  88 .Pp
  89 (Another note: the
  90 .Ev LOGNAME
  91 variable is sometimes called
  92 .Ev USER
  93 on
  94 .Bx
  95 systems...
  96 On these systems,
  97 .Ev USER
  98 will be set also).
  99 .Pp
 100 In addition to
 101 .Ev LOGNAME ,
 102 .Ev HOME ,
 103 and
 104 .Ev SHELL ,
 105 .Xr cron 8
 106 will look at
 107 .Ev MAILTO
 108 if it has any reason to send mail as a result of running
 109 commands in ``this'' crontab.
 110 If
 111 .Ev MAILTO
 112 is defined (and non-empty), mail is
 113 sent to the user so named.
 114 .Ev MAILTO
 115 may also be used to direct mail to multiple recipients
 116 by seperating recipient users with a comma.
 117 If
 118 .Ev MAILTO
 119 is defined but empty (MAILTO=""), no
 120 mail will be sent.
 121 Otherwise mail is sent to the owner of the crontab.
 122 This
 123 option is useful if you decide on
 124 .Pa /bin/mail
 125 instead of
 126 .Pa /usr/lib/sendmail
 127 as
 128 your mailer when you install cron --
 129 .Pa /bin/mail
 130 does not do aliasing, and UUCP
 131 usually does not read its mail.
 132 .Pp
 133 The format of a cron command is very much the V7 standard, with a number of
 134 upward-compatible extensions.
 135 Each line has five time and date fields,
 136 followed by a user name
 137 (with optional ``:<group>'' and ``/<login-class>'' suffixes)
 138 if this is the system crontab file,
 139 followed by a command.
 140 Commands are executed by
 141 .Xr cron 8
 142 when the minute, hour, and month of year fields match the current time,
 143 .Em and
 144 when at least one of the two day fields (day of month, or day of week)
 145 matches the current time (see ``Note'' below).
 146 .Xr cron 8
 147 examines cron entries once every minute.
 148 The time and date fields are:
 149 .Bd -literal -offset indent
 150 field         allowed values
 151 -----         --------------
 152 minute        0-59
 153 hour          0-23
 154 day of month  1-31
 155 month         1-12 (or names, see below)
 156 day of week   0-7 (0 or 7 is Sun, or use names)
 157 .Ed
 158 .Pp
 159 A field may be an asterisk (*), which always stands for ``first\-last''.
 160 .Pp
 161 Ranges of numbers are allowed.
 162 Ranges are two numbers separated
 163 with a hyphen.
 164 The specified range is inclusive.
 165 For example,
 166 8-11 for an ``hours'' entry specifies execution at hours 8, 9, 10
 167 and 11.
 168 .Pp
 169 Lists are allowed.
 170 A list is a set of numbers (or ranges)
 171 separated by commas.
 172 Examples: ``1,2,5,9'', ``0-4,8-12''.
 173 .Pp
 174 Step values can be used in conjunction with ranges.
 175 Following
 176 a range with ``/<number>'' specifies skips of the number's value
 177 through the range.
 178 For example, ``0-23/2'' can be used in the hours
 179 field to specify command execution every other hour (the alternative
 180 in the V7 standard is ``0,2,4,6,8,10,12,14,16,18,20,22'').
 181 Steps are
 182 also permitted after an asterisk, so if you want to say ``every two
 183 hours'', just use ``*/2''.
 184 .Pp
 185 Names can also be used for the ``month'' and ``day of week''
 186 fields.
 187 Use the first three letters of the particular
 188 day or month (case does not matter).
 189 Ranges or
 190 lists of names are not allowed.
 191 .Pp
 192 The ``sixth'' field (the rest of the line) specifies the command to be
 193 run.
 194 The entire command portion of the line, up to a newline or %
 195 character, will be executed by
 196 .Pa /bin/sh
 197 or by the shell
 198 specified in the
 199 .Ev SHELL
 200 variable of the cronfile.
 201 Percent-signs (%) in the command, unless escaped with backslash
 202 (\\), will be changed into newline characters, and all data
 203 after the first % will be sent to the command as standard
 204 input.
 205 .Pp
 206 Note: The day of a command's execution can be specified by two
 207 fields \(em day of month, and day of week.
 208 If both fields are
 209 restricted (ie, are not *), the command will be run when
 210 .Em either
 211 field matches the current time.
 212 For example,
 213 ``30 4 1,15 * 5''
 214 would cause a command to be run at 4:30 am on the 1st and 15th of each
 215 month, plus every Friday.
 216 .Pp
 217 Instead of the first five fields,
 218 one of eight special strings may appear:
 219 .Bd -literal -offset indent
 220 string          meaning
 221 ------          -------
 222 @reboot         Run once, at startup.
 223 @yearly         Run once a year, "0 0 1 1 *".
 224 @annually       (same as @yearly)
 225 @monthly        Run once a month, "0 0 1 * *".
 226 @weekly         Run once a week, "0 0 * * 0".
 227 @daily          Run once a day, "0 0 * * *".
 228 @midnight       (same as @daily)
 229 @hourly         Run once an hour, "0 * * * *".
 230 .Ed
 231 .Sh EXAMPLE CRON FILE
 232 .Bd -literal
 233
 234 # use /bin/sh to run commands, overriding the default set by cron
 235 SHELL=/bin/sh
 236 # mail any output to `paul', no matter whose crontab this is
 237 MAILTO=paul
 238 #
 239 # run five minutes after midnight, every day
 240 5 0 * * *       $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
 241 # run at 2:15pm on the first of every month -- output mailed to paul
 242 15 14 1 * *     $HOME/bin/monthly
 243 # run at 10 pm on weekdays, annoy Joe
 244 0 22 * * 1-5    mail -s "It's 10pm" joe%Joe,%%Where are your kids?%
 245 23 0-23/2 * * * echo "run 23 minutes after midn, 2am, 4am ..., everyday"
 246 5 4 * * sun     echo "run at 5 after 4 every sunday"
 247 .Ed
 248 .Sh SEE ALSO
 249 .Xr crontab 1 ,
 250 .Xr cron 8
 251 .Sh EXTENSIONS
 252 When specifying day of week, both day 0 and day 7 will be considered Sunday.
 253 .Bx
 254 and
 255 .Tn ATT
 256 seem to disagree about this.
 257 .Pp
 258 Lists and ranges are allowed to co-exist in the same field.
 259 "1-3,7-9" would
 260 be rejected by
 261 .Tn ATT
 262 or
 263 .Bx
 264 cron -- they want to see "1-3" or "7,8,9" ONLY.
 265 .Pp
 266 Ranges can include "steps", so "1-9/2" is the same as "1,3,5,7,9".
 267 .Pp
 268 Names of months or days of the week can be specified by name.
 269 .Pp
 270 Environment variables can be set in the crontab.
 271 In
 272 .Bx
 273 or
 274 .Tn ATT ,
 275 the
 276 environment handed to child processes is basically the one from
 277 .Pa /etc/rc .
 278 .Pp
 279 Command output is mailed to the crontab owner
 280 .No ( Bx
 281 cannot do this), can be
 282 mailed to a person other than the crontab owner (SysV cannot do this), or the
 283 feature can be turned off and no mail will be sent at all (SysV cannot do this
 284 either).
 285 .Pp
 286 All of the
 287 .Sq @
 288 commands that can appear in place of the first five fields
 289 are extensions.
 290 .Sh AUTHORS
 291 .An Paul Vixie Aq paul@vix.com
 292 .Sh BUGS
 293 If you are in one of the 70-odd countries that observe Daylight
 294 Savings Time, jobs scheduled during the rollback or advance will be
 295 affected.
 296 In general, it is not a good idea to schedule jobs during
 297 this period.
 298 .Pp
 299 For US timezones (except parts of IN, AZ, and HI) the time shift occurs at
 300 2AM local time.
 301 For others, the output of the
 302 .Xr zdump 8
 303 program's verbose
 304 .Fl ( v )
 305 option can be used to determine the moment of time shift.