freebsd-dev/usr.sbin/cron/crontab/crontab.1

.\"/* Copyright 1988,1990,1993 by Paul Vixie
.\" * All rights reserved
.\" *
.\" * Distribute freely, except: don't remove my name from the source or
.\" * documentation (don't take credit for my work), mark your changes (don't
.\" * get me blamed for your possible bugs), don't alter or remove this
.\" * notice.  May be sold if buildable source is provided to buyer.  No
.\" * warrantee 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.
.\" *
.\" * Send bug reports, bug fixes, enhancements, requests, flames, etc., and
.\" * I'll try to keep a version up to date.  I can be reached as follows:
.\" * Paul Vixie          <paul@vix.com>          uunet!decwrl!vixie!paul
.\" */
.\"
.\" $FreeBSD$
.\"
.Dd December 29, 1993
.Dt CRONTAB 1
.Os
.Sh NAME
.Nm crontab
.Nd maintain crontab files for individual users (V3)
.Sh SYNOPSIS
.Nm
.Op Fl u Ar user
.Ar file
.Nm
.Op Fl u Ar user
{
.Fl l |
.Fl r |
.Fl e
}
.Sh DESCRIPTION
.Nm Crontab
is the program used to install, deinstall or list the tables
used to drive the
.Xr cron 8
daemon in Vixie Cron.  Each user can have their own crontab, and though
these are files in
.Pa /var ,
they are not intended to be edited directly.
.Pp
If the
.Pa allow
file exists, then you must be listed therein in order to be allowed to use
this command.  If the
.Pa allow
file does not exist but the
.Pa deny
file does exist, then you must
.Em not
be listed in the
.Pa deny
file in order to use this command.  If neither of these files exists, then
depending on site-dependent configuration parameters, only the super user
will be allowed to use this command, or all users will be able to use this
command.
.Pp
The first form of this command is used to install a new crontab from some
named file or standard input if the pseudo-filename ``-'' is given.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl u
Specify the name of the user whose crontab is to be
tweaked.  If this option is not given,
.Nm
examines "your" crontab, i.e., the crontab of the person executing the
command.  Note that
.Xr su 1
can confuse
.Nm
and that if you are running inside of
.Xr su 1
you should always use the
.Fl u
option for safety's sake.
.It Fl l
Display the current crontab on standard output.
.It Fl r
Remove the current crontab.
.It Fl e
Edit the current crontab using the editor specified by
the
.Ev VISUAL
or
.Ev EDITOR
environment variables.
The specified editor
.Em must
edit the file in place;
any editor that unlinks the file and recreates it cannot be used.
After you exit
from the editor, the modified crontab will be installed automatically.
.El
.Sh SEE ALSO
.Xr crontab 5 ,
.Xr cron 8
.Sh FILES
.Bl -tag -width /var/cron/allow -compact
.It Pa /var/cron/allow
.It Pa /var/cron/deny
.El
.Sh STANDARDS
The
.Nm
command conforms to
.St -p1003.2 .
This new command syntax
differs from previous versions of Vixie Cron, as well as from the classic
SVR3 syntax.
.Sh DIAGNOSTICS
A fairly informative usage message appears if you run it with a bad command
line.
.Sh AUTHORS
.An Paul Vixie Aq paul@vix.com
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`.\"/* Copyright 1988,1990,1993 by Paul Vixie`
			`.\" * All rights reserved`
			`.\" *`
			`.\" * Distribute freely, except: don't remove my name from the source or`
			`.\" * documentation (don't take credit for my work), mark your changes (don't`
			`.\" * get me blamed for your possible bugs), don't alter or remove this`
			`.\" * notice. May be sold if buildable source is provided to buyer. No`
			`.\" * warrantee 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.`
			`.\" *`
			`.\" * Send bug reports, bug fixes, enhancements, requests, flames, etc., and`
			`.\" * I'll try to keep a version up to date. I can be reached as follows:`
			`.\" * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul`
			`.\" */`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`.\"`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Dd December 29, 1993`
			`.Dt CRONTAB 1`
			`.Os`
			`.Sh NAME`
			`.Nm crontab`
			`.Nd maintain crontab files for individual users (V3)`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Op Fl u Ar user`
			`.Ar file`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Op Fl u Ar user`
			`{`
			`.Fl l \|`
			`.Fl r \|`
			`.Fl e`
			`}`
			`.Sh DESCRIPTION`
			`.Nm Crontab`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`is the program used to install, deinstall or list the tables`
			`used to drive the`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Xr cron 8`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`daemon in Vixie Cron. Each user can have their own crontab, and though`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`these are files in`
			`.Pa /var ,`
			`they are not intended to be edited directly.`
			`.Pp`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`If the`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Pa allow`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`file exists, then you must be listed therein in order to be allowed to use`
			`this command. If the`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Pa allow`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`file does not exist but the`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Pa deny`
			`file does exist, then you must`
			`.Em not`
			`be listed in the`
			`.Pa deny`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`file in order to use this command. If neither of these files exists, then`
			`depending on site-dependent configuration parameters, only the super user`
			`will be allowed to use this command, or all users will be able to use this`
			`command.`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Pp`
			`The first form of this command is used to install a new crontab from some`
			named file or standard input if the pseudo-filename ``-'' is given.
			`.Pp`
			`The following options are available:`
			`.Bl -tag -width indent`
			`.It Fl u`
			`Specify the name of the user whose crontab is to be`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`tweaked. If this option is not given,`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Nm`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`examines "your" crontab, i.e., the crontab of the person executing the`
			`command. Note that`
Bad reference of su(8) changed to su(1). 1999-08-14 06:34:50 +00:00			`.Xr su 1`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`can confuse`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Nm`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`and that if you are running inside of`
Bad reference of su(8) changed to su(1). 1999-08-14 06:34:50 +00:00			`.Xr su 1`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`you should always use the`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Fl u`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`option for safety's sake.`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.It Fl l`
			`Display the current crontab on standard output.`
			`.It Fl r`
			`Remove the current crontab.`
			`.It Fl e`
			`Edit the current crontab using the editor specified by`
			`the`
			`.Ev VISUAL`
			`or`
			`.Ev EDITOR`
Attempt to fix problem with users being able to convince the crontab program to read any file which is a valid crontab file. The fix is based on that used in NetBSD and OpenBSD - we keep the file open while the user is editing it. This means that files must be edited in place. Cron attempts to warn you if your editor does not do this. The fact that the file must be edited in place is also noted in the man page. This patch has been confirmed to work by atleast one person on -security and has been tested locally. Obtained from: OpenBSD 2000-11-06 11:17:37 +00:00			`environment variables.`
			`The specified editor`
			`.Em must`
			`edit the file in place;`
			`any editor that unlinks the file and recreates it cannot be used.`
			`After you exit`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`from the editor, the modified crontab will be installed automatically.`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr crontab 5 ,`
			`.Xr cron 8`
			`.Sh FILES`
			`.Bl -tag -width /var/cron/allow -compact`
			`.It Pa /var/cron/allow`
			`.It Pa /var/cron/deny`
			`.El`
			`.Sh STANDARDS`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`The`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Nm`
			`command conforms to`
			`.St -p1003.2 .`
			`This new command syntax`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`differs from previous versions of Vixie Cron, as well as from the classic`
			`SVR3 syntax.`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.Sh DIAGNOSTICS`
Paul Vixie's cron, version 3.0. Munged into bmake format. If this goes well, expect our two seperate directories for cron and crontab to go away shortly. Submitted by: jkh 1994-08-27 13:43:04 +00:00			`A fairly informative usage message appears if you run it with a bad command`
			`line.`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.Sh AUTHORS`
Use err(3). Rewrote man page in mdoc format. 1997-09-15 06:39:25 +00:00			`.An Paul Vixie Aq paul@vix.com`