xref: /openbsd/usr.sbin/cron/crontab.1 (revision 78b63d65)
1.\"/* Copyright 1988,1990,1993 by Paul Vixie
2.\" * All rights reserved
3.\" */
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
10.\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
11.\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
12.\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
15.\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
16.\" SOFTWARE.
17.\"
18.\" $OpenBSD: crontab.1,v 1.10 2001/08/02 18:37:34 mpech Exp $
19.\"
20.Dd June 8, 1999
21.Dt CRONTAB 1
22.Os
23.Sh NAME
24.Nm crontab
25.Nd maintain crontab files for individual users (V3)
26.Sh SYNOPSIS
27.Nm crontab
28.Op Fl u Ar user
29.Ar file
30.Nm crontab
31.Op Fl u Ar user
32.Oo
33.Fl l No \&|
34.Fl r No \&|
35.Fl e
36.Oc
37.Sh DESCRIPTION
38.Nm
39is the program used to install, deinstall, or list the tables
40used to drive the
41.Xr cron 8
42daemon in Vixie Cron.
43Each user can have their own
44.Xr crontab 5 ,
45and though these are files in
46.Pa /var/cron/tabs ,
47they are not intended to be edited directly.
48.Pp
49If the
50.Pa /var/cron/allow
51file exists, then you must be listed therein in order to use
52.Nm crontab .
53If the
54.Pa /var/cron/allow
55file does not exist but the
56.Pa /var/cron/deny
57file does exist, then you must
58.Em not
59be listed in the
60.Pa /var/cron/deny
61file in order to use
62.Nm crontab .
63If neither of these files exists, then
64depending on site-dependent configuration parameters, only the super user
65will be allowed to use
66.Nm crontab ,
67or all users will be able to use it.
68.Pp
69If the
70.Fl u
71option is given,
72.Ar user
73specifies the name of the user whose
74.Xr crontab 5
75is to be
76tweaked.
77If this option is not given,
78.Nm
79examines
80.Dq your
81.Xr crontab 5 ;
82i.e., the
83crontab of the person executing the command.
84Note that
85.Xr su 8
86can confuse
87.Nm
88and that if you are running inside of
89.Xr su 8
90you should always use the
91.Fl u
92option for safety's sake.
93.Pp
94The first form of this command is used to install a new crontab from some
95named file, or standard input if the pseudo-filename
96.Sq Fl
97is given.
98.Pp
99The
100.Fl l
101option causes the current crontab to be displayed on standard output.
102.Pp
103The
104.Fl r
105option causes the current crontab to be removed.
106.Pp
107The
108.Fl e
109option is used to edit the current crontab using the editor specified by
110the
111.Ev VISUAL
112or
113.Ev EDITOR
114environment variables.
115After you exit from the editor, the modified
116.Xr crontab 5
117will be installed automatically.
118.Sh FILES
119.Bl -tag -width "/var/cron/allow" -compact
120.It Pa /var/cron/allow
121list of users allowed to use crontab
122.It Pa /var/cron/deny
123list of users prohibited from using crontab
124.It Pa /var/cron/tabs
125directory of individual crontabs
126.El
127.Sh SEE ALSO
128.Xr crontab 5 ,
129.Xr cron 8
130.Sh STANDARDS
131The
132.Nm
133utility is compliant with the
134.St -p1003.2-92
135specification.
136.Sh DIAGNOSTICS
137A fairly informative usage message appears if you run it with a bad command
138line.
139.Sh AUTHORS
140Paul Vixie <paul@vix.com>
141