path: root/upstream/debian-unstable/man5/crontab.5

'\" t
.\"     Title: Crontab
.\"    Author: Paul Vixie <paul@vix.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/26/2024
.\"    Manual: crontab User Manual
.\"    Source: crontab
.\"  Language: English
.\"
.TH "CRONTAB" "5" "03/26/2024" "crontab" "crontab User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
crontab \- tables for driving cron
.SH "DESCRIPTION"
.PP
A
\fIcrontab\fR
file contains instructions to the
\fBcron\fR(8)
daemon of the general form:
\(lqrun this command at this time on this date\(rq\&. Each user has their own crontab, and commands in any given crontab will be executed as the user who owns the crontab\&. Uucp and News will usually have their own crontabs, eliminating the need for explicitly running
\fBsu\fR(1)
as part of a cron command\&.
.PP
Note that comments on the same line as cron commands are not interpreted as comments in the cron sense, but are considered part of the command and passed to the shell\&. This is similarly true for comments on the same line as environment variable settings\&.
.PP
An active line in a crontab will be either an environment setting or a cron command\&. An environment setting is of the form,
.sp
.if n \{\
.RS 4
.\}
.nf
name = value
      
.fi
.if n \{\
.RE
.\}
.sp
where the spaces around the equal\-sign (=) are optional, and any subsequent non\-leading spaces in
\fIvalue\fR
will be part of the value assigned to
\fIname\fR\&. The
\fIvalue\fR
string may be placed in quotes (single or double, but matching) to preserve leading or trailing blanks\&. To define an empty variable, quotes can be used\&.
.PP
The
\fIvalue\fR
string is not parsed for environmental substitutions or replacement of variables or tilde(~) expansion, thus lines like
.sp
.if n \{\
.RS 4
.\}
.nf
PATH=$HOME/bin:$PATH
PATH=~/bin:/usr/bin
	
.fi
.if n \{\
.RE
.\}
.sp
will not work as you might expect\&. And neither will this work
.sp
.if n \{\
.RS 4
.\}
.nf
A=1
B=2
C=$A $B
	
.fi
.if n \{\
.RE
.\}
.sp
There will not be any substitution for the defined variables in the last value\&. However, with most shells you can also try e\&.g\&.,:
.sp
.if n \{\
.RS 4
.\}
.nf
P=PATH=/a/b/c:$PATH
33 22 1 2 3 eval $P && some commands
	
.fi
.if n \{\
.RE
.\}
.sp
Several environment variables are set up automatically by the
\fBcron\fR(8)
daemon\&. SHELL is set to
/usr/bin/sh, and LOGNAME and HOME are set from the
/etc/passwd
line of the crontab\*(Aqs owner\&. HOME and SHELL may be overridden by settings in the crontab; LOGNAME may not\&.
.PP
(Another note: the LOGNAME variable is sometimes called USER on BSD systems\&.\&.\&. on these systems, USER will be set also\&.)
.PP
In addition to LOGNAME, HOME, and SHELL,
\fBcron\fR(8)
will look at MAILTO if it has any reason to send mail as a result of running commands in
\(lqthis\(rq
crontab\&. If MAILTO is defined (and non\-empty), mail is sent to the user so named\&. If MAILTO is defined but empty (MAILTO=""), no mail will be sent\&. Otherwise mail is sent to the owner of the crontab\&. This option is useful if you decide on
\fB/usr/bin/mail\fR
instead of
\fB/usr/lib/sendmail\fR
as your mailer when you install cron \-\-
\fB/usr/bin/mail\fR
doesn\*(Aqt do aliasing, and UUCP usually doesn\*(Aqt read its mail\&.
.PP
The format of a cron command is very much the V7 standard, with a number of upward\-compatible extensions\&. Each line has five time and date fields, followed by a command, followed by a newline character (\*(Aq\en\*(Aq)\&. The system crontab (/etc/crontab) uses the same format, except that the username for the command is specified after the time and date fields and before the command\&. The fields may be separated by spaces or tabs\&. The maximum permitted length for the command field is 998 characters\&.
.PP
Commands are executed by
\fBcron\fR(8)
when the minute, hour, and month of year fields match the current time, and when at least one of the two day fields (day of month, or day of week) match the current time (see
\(lqNote\(rq
below)\&.
\fBcron\fR(8)
examines cron entries once every minute\&. The time and date fields are:
.TS
allbox tab(:);
lB lB.
T{
field
T}:T{
allowed values
T}
.T&
l l
l l
l l
l l
l l.
T{
minute
T}:T{
0\-59
T}
T{
hour
T}:T{
0\-23
T}
T{
day of month
T}:T{
0\-31
T}
T{
month
T}:T{
0\-12 (or names, see below)
T}
T{
day of week
T}:T{
0\-7 (0 or 7 is Sun, or use names)
T}
.TE
.sp 1
.PP
A field may be an asterisk (*), which always stands for
\(lqfirst\-last\(rq\&.
.PP
Ranges of numbers are allowed\&. Ranges are two numbers separated with a hyphen\&. The specified range is inclusive\&. For example, 8\-11 for an
\(lqhours\(rq
entry specifies execution at hours 8, 9, 10 and 11\&.
.PP
Lists are allowed\&. A list is a set of numbers (or ranges) separated by commas\&. Examples:
\(lq1,2,5,9\(rq,
\(lq0\-4,8\-12\(rq\&.
.PP
Step values can be used in conjunction with ranges\&. Following a range with
\(lq/<number>\(rq
specifies skips of the number\*(Aqs value through the range\&. For example,
\(lq0\-23/2\(rq
can be used in the hours field to specify command execution every other hour (the alternative in the V7 standard is
\(lq0,2,4,6,8,10,12,14,16,18,20,22\(rq)\&. Steps are also permitted after an asterisk, so if you want to say
\(lqevery two hours\(rq, just use
\(lq*/2\(rq\&.
.PP
Names can also be used for the
\(lqmonth\(rq
and
\(lqday of week\(rq
fields\&. Use the first three letters of the particular day or month (case doesn\*(Aqt matter)\&. Ranges or lists of names are not allowed\&.
.PP
The
\(lqsixth\(rq
field (the rest of the line) specifies the command to be run\&. The entire command portion of the line, up to a newline or % character, will be executed by
\fB/usr/bin/sh\fR
or by the shell specified in the SHELL variable of the cronfile\&. Percent\-signs (%) in the command, unless escaped with backslash (\e), will be changed into newline charac\(hy ters, and all data after the first % will be sent to the command as standard input\&.
.PP
Note: The day of a command\*(Aqs execution can be specified by two fields \(em day of month, and day of week\&. If both fields are restricted (i\&.e\&., aren\*(Aqt *), the command will be run when either field matches the current time\&. For example,
\(lq30 4 1,15 * 5\(rq
would cause a command to be run at 4:30 am on the 1st and 15th of each month, plus every Friday\&. One can, however, achieve the desired result by adding a test to the command (see the last example in EXAMPLE CRON FILE below)\&.
.PP
Instead of the first five fields, one of eight special strings may appear:
.TS
allbox tab(:);
lB lB.
T{
string
T}:T{
meaning
T}
.T&
l l
l l
l l
l l
l l
l l
l l
l l.
T{
@reboot
T}:T{
Run once, at startup\&.
T}
T{
@yearly
T}:T{
Run once a year, "0 0 1 1 *"\&.
T}
T{
@annually
T}:T{
(same as @yearly)
T}
T{
@monthly
T}:T{
Run once a month, "0 0 1 * *"\&.
T}
T{
@weekly
T}:T{
Run once a week, "0 0 * * 0"\&.
T}
T{
@daily
T}:T{
Run once a day, "0 0 * * *"\&.
T}
T{
@midnight
T}:T{
(same as @daily)
T}
T{
@hourly
T}:T{
Run once an hour, "0 * * * *"\&.
T}
.TE
.sp 1
.PP
Please note that startup, as far as @reboot is concerned, is the time when the
\fBcron\fR(8)
daemon startup\&. In particular, it may be before some system daemons, or other facilities, were startup\&. This is due to the boot order sequence of the machine\&.
.PP
.PP
.SH "EXAMPLE CRON FILE"
.PP
.if n \{\
.RS 4
.\}
.nf
# use /usr/bin/sh to run commands, no matter what /etc/passwd says
SHELL=/usr/bin/sh
# mail any output to `paul\*(Aq, no matter whose crontab this is
MAILTO=paul
#
# run five minutes after midnight, every day
5 0 * * *       $HOME/bin/daily\&.job >> $HOME/tmp/out 2>&1
# run at 2:15pm on the first of every month \-\- output mailed to paul
15 14 1 * *     $HOME/bin/monthly
# run at 10 pm on weekdays, annoy Joe
0 22 * * 1\-5    mail \-s "It\*(Aqs 10pm" joe%Joe,%%Where are your kids?%
23 0\-23/2 * * * echo "run 23 minutes after midn, 2am, 4am \&.\&.\&., everyday"
5 4 * * sun     echo "run at 5 after 4 every Sunday"
0 */4 1 * mon   echo "run every 4th hour on the 1st and on every Monday"
0 0 */2 * sun   echo "run at midn on every Sunday that\*(Aqs an uneven date"
# Run on every second Saturday of the month
0 4 8\-14 * *    test $(date +\e%u) \-eq 6 && echo "2nd Saturday"
# Same thing, efficient too:
0 4 * * * Sat   d=$(date +e) && test $d \-ge 8 \-a $d \-le 14 && echo "2nd Saturday"
#Execute early the next morning following the first
#Thursday of each month
57 2 * * 5 case $(date +d) in 0[2\-8]) echo "After 1st Thursday"; esac
      
.fi
.if n \{\
.RE
.\}
.PP
All the above examples run non\-interactive programs\&. If you wish to run a program that interacts with the user\*(Aqs desktop you have to make sure the proper environment variable
\fIDISPLAY\fR
is set\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# Execute a program and run a notification every day at 10:00 am
0 10 * * *  $HOME/bin/program | DISPLAY=:0 notify\-send "Program run" "$(cat)"
      
.fi
.if n \{\
.RE
.\}
.sp
.SH "EXAMPLE SYSTEM CRON FILE"
.PP
The following lists the content of a regular system\-wide crontab file\&. Unlike a user\*(Aqs crontab, this file has the username field, as used by
/etc/crontab\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# /etc/crontab: system\-wide crontab
# Unlike any other crontab you don\*(Aqt have to run the `crontab\*(Aq
# command to install the new version when you edit this file
# and files in /etc/cron\&.d\&.  These files also have username fields,
# that none of the other crontabs do\&.

SHELL=/bin/sh
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin

# Example of job definition:
# \&.\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- minute (0 \- 59)
# |  \&.\-\-\-\-\-\-\-\-\-\-\-\-\- hour (0 \- 23)
# |  |  \&.\-\-\-\-\-\-\-\-\-\- day of month (1 \- 31)
# |  |  |  \&.\-\-\-\-\-\-\- month (1 \- 12) OR jan,feb,mar,apr \&.\&.\&.
# |  |  |  |  \&.\-\-\-\- day of week (0 \- 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat
# m h dom mon dow usercommand
17 * * * *  root  cd / && run\-parts \-\-report /etc/cron\&.hourly
25 6 * * *  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.daily )
47 6 * * 7  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.weekly )
52 6 1 * *  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.monthly )
#
       
.fi
.if n \{\
.RE
.\}
.PP
Note that all the system\-wide tasks will run, by default, from 6 am to 7 am\&. In the case of systems that are not powered on during that period of time, only the hourly tasks will be executed unless the defaults above are changed\&.
.SH "YET ANOTHER EXAMPLE"
.PP
In that example one can see that numbers can be prepended some 0, in order to line up columns\&.
.sp
.if n \{\
.RS 4
.\}
.nf
17  * * * *  root  cd / && run\-parts \-\-report /etc/cron\&.hourly
25 16 * * *  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.daily )
47 06 * * 7  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.weekly )
52 06 1 * *  root  test \-x /usr/sbin/anacron || ( cd / && run\-parts \-\-report /etc/cron\&.monthly )
       
.fi
.if n \{\
.RE
.\}
.sp
.SH "SEE ALSO"
.PP
\fBcron\fR(8),
\fBcrontab\fR(1)
.SH "EXTENSIONS"
.PP
When specifying day of week, both day 0 and day 7 will be considered Sunday\&. BSD and AT&T seem to disagree about this\&.
.PP
Lists and ranges are allowed to co\-exist in the same field\&. "1\-3,7\-9" would be rejected by AT&T or BSD cron \-\- they want to see "1\-3" or "7,8,9" ONLY\&.
.PP
Ranges can include "steps", so "1\-9/2" is the same as "1,3,5,7,9"\&.
.PP
Names of months or days of the week can be specified by name\&.
.PP
Environment variables can be set in the crontab\&. In BSD or AT&T, the environment handed to child processes is basically the one from
/etc/rc\&.
.PP
Command output is mailed to the crontab owner (BSD can\*(Aqt do this), can be mailed to a person other than the crontab owner (SysV can\*(Aqt do this), or the feature can be turned off and no mail will be sent at all (SysV can\*(Aqt do this either)\&.
.PP
All of the
\(lq@\(rq
commands that can appear in place of the first five fields are extensions\&.
.SH "LIMITATIONS"
.PP
The
\fBcron\fR
daemon runs with a defined timezone\&. It currently does not support per\-user timezones\&. All the tasks: system\*(Aqs and user\*(Aqs will be run based on the configured timezone\&. Even if a user specifies the
\fITZ\fR
environment variable in his crontab this will affect only the commands executed in the crontab, not the execution of the crontab tasks them\(hy selves\&. If one wants to specify a particular timezone for crontab tasks, one may check the date in the child script, for example:
.sp
.if n \{\
.RS 4
.\}
.nf
# m h  dom mon dow   command

TZ=UTC
0 * * * * [ "$(date +\e%R)" = 00:00 ] && run_some_script
       
.fi
.if n \{\
.RE
.\}
.PP
POSIX specifies that the day of month and the day of week fields both need to match the current time if either of them
\fIis\fR
a *\&. However, this implementation only checks if the
\fIfirst character\fR
is a *\&. This is why "0 0 */2 * sun" runs every Sunday that\*(Aqs an uneven date while the POSIX standard would have it run every Sunday and on every uneven date\&.
.PP
The
\fIcrontab\fR
syntax does not make it possible to define all possible periods one can imagine\&. For example, it is not straightforward to define the last weekday of a month\&. To have a task run in a time period that cannot be defined using
\fIcrontab\fR
syntax, the best approach would be to have the program itself check the date and time information and continue execution only if the period matches the desired one\&.
.PP
If the program itself cannot do the checks then a wrapper script would be required\&. Useful tools that could be used for date analysis are
\fIncal\fR
or
\fIcalendar\fR\&. For example, to run a program the last Saturday of every month you could use the following wrapper code:
.sp
.if n \{\
.RS 4
.\}
.nf
0 4 * * Sat   [ "$(date +\e%e)" = "$(LANG=C ncal | sed \-n \*(Aqs/^Sa \&.* \e([0\-9]\e+\e) *$/\e1/p\*(Aq)" ] && echo "Last Saturday" && program_to_run
      
.fi
.if n \{\
.RE
.\}
.sp
.SH "USING EVAL TO WRAP MISC ENVIRONMENT SETTINGS"
.PP
The following tip is kindly provided by 積丹尼 Dan Jacobson:
.sp
.if n \{\
.RS 4
.\}
.nf
CONTENT_TYPE="text/plain; charset=UTF\-8"
d=eval LANG=zh_TW\&.UTF\-8 w3m \-dump
26 22 16 1\-12 * $d https://www\&.ptt\&.cc/bbs/transgender/index\&.html
      
.fi
.if n \{\
.RE
.\}
.PP
it won\*(Aqt work without the eval\&. Saying
.sp
.if n \{\
.RS 4
.\}
.nf
d=LANG=zh_TW\&.UTF\-8 w3m \-dump
      
.fi
.if n \{\
.RE
.\}
.PP
will get
.sp
.if n \{\
.RS 4
.\}
.nf
/bin/sh: LANG=zh_TW\&.UTF\-8: command not found
      
.fi
.if n \{\
.RE
.\}
.PP
.SH "DIAGNOSTICS"
.PP
cron requires that each entry in a crontab end in a newline character\&. If the last entry in a crontab is missing a newline (i\&.e\&. terminated by EOF), cron will consider the crontab (at least partially) broken\&. A warning will be written to syslog\&.
.SH "AUTHORS"
.PP
\fBPaul Vixie\fR <\&paul@vix\&.com\&>
.RS 4
Wrote this manpage (1994)\&.
.RE
.PP
\fBSteve Greenland\fR <\&stevegr@debian\&.org\&>
.RS 4
Maintained the package (1996\-2005)\&.
.RE
.PP
\fBJavier Fern\('andez\-Sanguino Pe\(~na\fR <\&jfs@debian\&.org\&>
.RS 4
Maintained the package (2005\-2014)\&.
.RE
.PP
\fBChristian Kastner\fR <\&ckk@debian\&.org\&>
.RS 4
Maintained the package (2010\-2016)\&.
.RE
.PP
\fBGeorges Khaznadar\fR <\&georgesk@debian\&.org\&>
.RS 4
Maintained the package (2022\-2024)\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 1994 Paul Vixie
.br
.PP
Distribute freely, except: don\*(Aqt remove my name from the source or documentation (don\*(Aqt take credit for my work), mark your changes (don\*(Aqt get me blamed for your possible bugs), don\*(Aqt alter or remove this notice\&. May be sold if buildable source is provided to buyer\&. No warranty of any kind, express or implied, is included with this software; use at your own risk, responsibility for damages (if any) to anyone resulting from the use of this software rests entirely with the user\&.
.PP
Since year 1994, many modifications were made in this manpage, authored by Debian Developers which maintained
cron; above is a short list, more information can be found in the file
/usr/share/doc/cron/copyright\&.
.sp