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 June 6, 2018
  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 .Ev PATH
  76 is set to
  77 .Pa /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin ,
  78 and
  79 .Ev LOGNAME
  80 and
  81 .Ev HOME
  82 are set from the
  83 .Pa /etc/passwd
  84 line of the crontab's owner.
  85 .Ev HOME ,
  86 .Ev PATH
  87 and
  88 .Ev SHELL
  89 may be overridden by settings in the crontab;
  90 .Ev LOGNAME
  91 may not.
  92 .Pp
  93 (Another note: the
  94 .Ev LOGNAME
  95 variable is sometimes called
  96 .Ev USER
  97 on
  98 .Bx
  99 systems...
 100 On these systems,
 101 .Ev USER
 102 will be set also).
 103 .Pp
 104 In addition to
 105 .Ev LOGNAME ,
 106 .Ev HOME ,
 107 .Ev PATH ,
 108 and
 109 .Ev SHELL ,
 110 .Xr cron 8
 111 will look at
 112 .Ev MAILTO
 113 if it has any reason to send mail as a result of running
 114 commands in ``this'' crontab.
 115 If
 116 .Ev MAILTO
 117 is defined (and non-empty), mail is
 118 sent to the user so named.
 119 .Ev MAILTO
 120 may also be used to direct mail to multiple recipients
 121 by separating recipient users with a comma.
 122 If
 123 .Ev MAILTO
 124 is defined but empty (MAILTO=""), no
 125 mail will be sent.
 126 Otherwise mail is sent to the owner of the crontab.
 127 This
 128 option is useful if you decide on
 129 .Pa /bin/mail
 130 instead of
 131 .Pa /usr/lib/sendmail
 132 as
 133 your mailer when you install cron --
 134 .Pa /bin/mail
 135 does not do aliasing, and UUCP
 136 usually does not read its mail.
 137 .Pp
 138 The format of a cron command is very much the V7 standard, with a number of
 139 upward-compatible extensions.
 140 Each line has five time and date fields,
 141 followed by a user name
 142 (with optional ``:<group>'' and ``/<login-class>'' suffixes)
 143 if this is the system crontab file,
 144 followed by a command.
 145 Commands are executed by
 146 .Xr cron 8
 147 when the minute, hour, and month of year fields match the current time,
 148 .Em and
 149 when at least one of the two day fields (day of month, or day of week)
 150 matches the current time (see ``Note'' below).
 151 .Xr cron 8
 152 examines cron entries once every minute.
 153 The time and date fields are:
 154 .Bd -literal -offset indent
 155 field         allowed values
 156 -----         --------------
 157 minute        0-59
 158 hour          0-23
 159 day of month  1-31
 160 month         1-12 (or names, see below)
 161 day of week   0-7 (0 or 7 is Sun, or use names)
 162 .Ed
 163 .Pp
 164 A field may be an asterisk (*), which always stands for ``first\-last''.
 165 .Pp
 166 Ranges of numbers are allowed.
 167 Ranges are two numbers separated
 168 with a hyphen.
 169 The specified range is inclusive.
 170 For example,
 171 8-11 for an ``hours'' entry specifies execution at hours 8, 9, 10
 172 and 11.
 173 .Pp
 174 Lists are allowed.
 175 A list is a set of numbers (or ranges)
 176 separated by commas.
 177 Examples: ``1,2,5,9'', ``0-4,8-12''.
 178 .Pp
 179 Step values can be used in conjunction with ranges.
 180 Following
 181 a range with ``/<number>'' specifies skips of the number's value
 182 through the range.
 183 For example, ``0-23/2'' can be used in the hours
 184 field to specify command execution every other hour (the alternative
 185 in the V7 standard is ``0,2,4,6,8,10,12,14,16,18,20,22'').
 186 Steps are
 187 also permitted after an asterisk, so if you want to say ``every two
 188 hours'', just use ``*/2''.
 189 .Pp
 190 Names can also be used for the ``month'' and ``day of week''
 191 fields.
 192 Use the first three letters of the particular
 193 day or month (case does not matter).
 194 Ranges or
 195 lists of names are not allowed.
 196 .Pp
 197 The ``sixth'' field (the rest of the line) specifies the command to be
 198 run.
 199 The entire command portion of the line, up to a newline or %
 200 character, will be executed by
 201 .Pa /bin/sh
 202 or by the shell
 203 specified in the
 204 .Ev SHELL
 205 variable of the cronfile.
 206 Percent-signs (%) in the command, unless escaped with backslash
 207 (\\), will be changed into newline characters, and all data
 208 after the first % will be sent to the command as standard
 209 input.
 210 .Pp
 211 Note: The day of a command's execution can be specified by two
 212 fields \(em day of month, and day of week.
 213 If both fields are
 214 restricted (ie, are not *), the command will be run when
 215 .Em either
 216 field matches the current time.
 217 For example,
 218 ``30 4 1,15 * 5''
 219 would cause a command to be run at 4:30 am on the 1st and 15th of each
 220 month, plus every Friday.
 221 .Pp
 222 Instead of the first five fields,
 223 a line may start with
 224 .Sq @
 225 symbol followed either by one of eight special strings or by a numeric value.
 226 The recognized special strings are:
 227 .Bd -literal -offset indent
 228 string          meaning
 229 ------          -------
 230 @reboot         Run once, at startup of cron.
 231 @yearly         Run once a year, "0 0 1 1 *".
 232 @annually       (same as @yearly)
 233 @monthly        Run once a month, "0 0 1 * *".
 234 @weekly         Run once a week, "0 0 * * 0".
 235 @daily          Run once a day, "0 0 * * *".
 236 @midnight       (same as @daily)
 237 @hourly         Run once an hour, "0 * * * *".
 238 @every_minute   Run once a minute, "*/1 * * * *".
 239 @every_second   Run once a second.
 240 .Ed
 241 .Pp
 242 The
 243 .Sq @
 244 symbol followed by a numeric value has a special notion of running
 245 a job that much seconds after completion of previous invocation of
 246 the job.
 247 Unlike regular syntax, it guarantees not to overlap two or more
 248 invocations of the same job.
 249 The first run is scheduled specified amount of seconds after cron
 250 has started.
 251 .Sh EXAMPLE CRON FILE
 252 .Bd -literal
 253
 254 # use /bin/sh to run commands, overriding the default set by cron
 255 SHELL=/bin/sh
 256 # mail any output to `paul', no matter whose crontab this is
 257 MAILTO=paul
 258 #
 259 # run five minutes after midnight, every day
 260 5 0 * * *       $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
 261 # run at 2:15pm on the first of every month -- output mailed to paul
 262 15 14 1 * *     $HOME/bin/monthly
 263 # run at 10 pm on weekdays, annoy Joe
 264 0 22 * * 1-5    mail -s "It's 10pm" joe%Joe,%%Where are your kids?%
 265 23 0-23/2 * * * echo "run 23 minutes after midn, 2am, 4am ..., everyday"
 266 5 4 * * sun     echo "run at 5 after 4 every sunday"
 267 # run at 5 minutes intervals, no matter how long it takes
 268 @300            svnlite up /usr/src
 269 .Ed
 270 .Sh SEE ALSO
 271 .Xr crontab 1 ,
 272 .Xr cron 8
 273 .Sh EXTENSIONS
 274 When specifying day of week, both day 0 and day 7 will be considered Sunday.
 275 .Bx
 276 and
 277 .Tn ATT
 278 seem to disagree about this.
 279 .Pp
 280 Lists and ranges are allowed to co-exist in the same field.
 281 "1-3,7-9" would
 282 be rejected by
 283 .Tn ATT
 284 or
 285 .Bx
 286 cron -- they want to see "1-3" or "7,8,9" ONLY.
 287 .Pp
 288 Ranges can include "steps", so "1-9/2" is the same as "1,3,5,7,9".
 289 .Pp
 290 Names of months or days of the week can be specified by name.
 291 .Pp
 292 Environment variables can be set in the crontab.
 293 In
 294 .Bx
 295 or
 296 .Tn ATT ,
 297 the
 298 environment handed to child processes is basically the one from
 299 .Pa /etc/rc .
 300 .Pp
 301 Command output is mailed to the crontab owner
 302 .No ( Bx
 303 cannot do this), can be
 304 mailed to a person other than the crontab owner (SysV cannot do this), or the
 305 feature can be turned off and no mail will be sent at all (SysV cannot do this
 306 either).
 307 .Pp
 308 All of the
 309 .Sq @
 310 directives that can appear in place of the first five fields
 311 are extensions.
 312 .Sh AUTHORS
 313 .An Paul Vixie Aq Mt paul@vix.com
 314 .Sh BUGS
 315 If you are in one of the 70-odd countries that observe Daylight
 316 Savings Time, jobs scheduled during the rollback or advance may be
 317 affected if
 318 .Xr cron 8
 319 is not started with the
 320 .Fl s
 321 flag.
 322 In general, it is not a good idea to schedule jobs during
 323 this period if
 324 .Xr cron 8
 325 is not started with the
 326 .Fl s
 327 flag, which is enabled by default.
 328 See
 329 .Xr cron 8
 330 for more details.
 331 .Pp
 332 For US timezones (except parts of AZ and HI) the time shift occurs at
 333 2AM local time.
 334 For others, the output of the
 335 .Xr zdump 8
 336 program's verbose
 337 .Fl ( v )
 338 option can be used to determine the moment of time shift.