xref: /netbsd-src/external/bsd/cron/dist/crontab.1 (revision 67d03c4b7880d8908f46531cbc6d37477b596b39)
1*67d03c4bSkre.\"	$NetBSD: crontab.1,v 1.6 2024/10/29 22:22:09 kre Exp $
2032a4398Schristos.\"
30061c6a5Schristos.\"/* Copyright 1988,1990,1993 by Paul Vixie
40061c6a5Schristos.\" * All rights reserved
50061c6a5Schristos.\" */
60061c6a5Schristos.\"
70061c6a5Schristos.\" Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
80061c6a5Schristos.\" Copyright (c) 1997,2000 by Internet Software Consortium, Inc.
90061c6a5Schristos.\"
100061c6a5Schristos.\" Permission to use, copy, modify, and distribute this software for any
110061c6a5Schristos.\" purpose with or without fee is hereby granted, provided that the above
120061c6a5Schristos.\" copyright notice and this permission notice appear in all copies.
130061c6a5Schristos.\"
140061c6a5Schristos.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
150061c6a5Schristos.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
160061c6a5Schristos.\" MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
170061c6a5Schristos.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
180061c6a5Schristos.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
190061c6a5Schristos.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
200061c6a5Schristos.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
210061c6a5Schristos.\"
220061c6a5Schristos.\" Id: crontab.1,v 1.7 2004/01/23 19:03:32 vixie Exp
230061c6a5Schristos.\"
24b8f08142Schristos.Dd May 6, 2010
25b8f08142Schristos.Dt CRONTAB 1
26b8f08142Schristos.Os
27b8f08142Schristos.Sh NAME
28b8f08142Schristos.Nm crontab
29b8f08142Schristos.Nd maintain crontab files for individual users (ISC Cron V4.1)
30b8f08142Schristos.Sh SYNOPSIS
31b8f08142Schristos.Nm
32*67d03c4bSkre.Oo Fl u Ar user Oc Ar file
33b8f08142Schristos.Nm
34*67d03c4bSkre.Oo Fl elr Oc Oo Fl u Ar user Oc
35b8f08142Schristos.Sh DESCRIPTION
36b8f08142Schristos.Nm
376f0c1d2eSwizis the program used to install, deinstall, or list the tables
380061c6a5Schristosused to drive the
39b8f08142Schristos.Xr cron 8
40b8f08142Schristosdaemon in ISC Cron.
41b8f08142SchristosEach user can have their own crontab, and though
42b8f08142Schristosthese are files in
43b8f08142Schristos.Pa /var/cron ,
44b8f08142Schristosthey are not intended to be edited directly.
45b8f08142Schristos.Pp
460061c6a5SchristosIf the
47b8f08142Schristos.Pa /var/cron/allow
480061c6a5Schristosfile exists, then you must be listed therein in order to be allowed to use
49b8f08142Schristosthis command.
50b8f08142SchristosIf the
51b8f08142Schristos.Pa /var/cron/allow
520061c6a5Schristosfile does not exist but the
53b8f08142Schristos.Pa /var/cron/deny
54b8f08142Schristosfile does exist, then you must not be listed in the
55b8f08142Schristos.Pa /var/cron/deny
56b8f08142Schristosfile in order to use this command.
57b8f08142SchristosIf neither of these files exists, depending on the compiled in settings,
58b8f08142Schristosonly the super user will be allowed to use this command,
59b8f08142Schristosor everyone will be allowed to use this command.
60b8f08142SchristosOn
61b8f08142Schristos.Nx
62b8f08142Schristoseveryone is allowed to use this command.
63b8f08142Schristos.Pp
64032a4398SchristosThe default maximum size for a crontab is 256 kilobytes, but this may be
65032a4398Schristoschanged for all users on the system by putting the desired maximum size
66032a4398Schristos(in bytes) in the
67b8f08142Schristos.Pa /var/cron/maxtabsize
68032a4398Schristosfile.
69b8f08142Schristos.Pp
700061c6a5SchristosIf the
71b8f08142Schristos.Fl u
72*67d03c4bSkreoption is given,
73*67d03c4bSkrewhich is allowed only for privileged users,
74*67d03c4bSkreit specifies the name of the user whose crontab is to be
756f0c1d2eSwiztweaked.
766f0c1d2eSwizIf this option is not given,
77b8f08142Schristos.Nm
78b8f08142Schristosexamines
79b8f08142Schristos.Dq your
80b8f08142Schristoscrontab, i.e., the crontab of the person executing the command.
81b8f08142SchristosNote that
82b8f08142Schristos.Xr su 1
830061c6a5Schristoscan confuse
84b8f08142Schristos.Nm
850061c6a5Schristosand that if you are running inside of
86b8f08142Schristos.Xr su 1
870061c6a5Schristosyou should always use the
88b8f08142Schristos.Fl u
890061c6a5Schristosoption for safety's sake.
90b8f08142Schristos.Pp
910061c6a5SchristosThe first form of this command is used to install a new crontab from some
92*67d03c4bSkrenamed
93*67d03c4bSkre.Ar file
94*67d03c4bSkreor standard input if the pseudo-filename
95b8f08142Schristos.Dq -
96b8f08142Schristosis given.
97b8f08142Schristos.Pp
980061c6a5SchristosThe
99b8f08142Schristos.Fl l
1000061c6a5Schristosoption causes the current crontab to be displayed on standard output.
101b8f08142Schristos.Pp
1020061c6a5SchristosThe
103b8f08142Schristos.Fl r
1040061c6a5Schristosoption causes the current crontab to be removed.
105b8f08142Schristos.Pp
1060061c6a5SchristosThe
107b8f08142Schristos.Fl e
1080061c6a5Schristosoption is used to edit the current crontab using the editor specified by
109b8f08142Schristosthe
110b8f08142Schristos.Dv VISUAL
111b8f08142Schristosor
112b8f08142Schristos.Dv EDITOR
113b8f08142Schristosenvironment variables.
114b8f08142SchristosAfter you exit from the editor, the modified crontab will be installed
115b8f08142Schristosautomatically.
116b8f08142Schristos.Sh FILES
117b8f08142Schristos.Bl -tag -width /var/cron/maxtabsize -compact
118b8f08142Schristos.It Pa /var/cron/allow
119b8f08142SchristosOptional list of users that are allowed to use
120b8f08142Schristos.Nm .
121b8f08142Schristos.It Pa /var/cron/deny
122b8f08142SchristosOptional list of users that are disallowed to use
123b8f08142Schristos.Nm .
124b8f08142Schristos.It Pa /var/cron/maxtabsize
125b8f08142SchristosMaximum size of
126b8f08142Schristos.Nm
127b8f08142Schristosfiles.
128b8f08142SchristosDefaults to
129b8f08142Schristos.Dv 256
130b8f08142Schristoskilobytes.
1316f0c1d2eSwiz.It Pa /var/cron/tabs/
1326f0c1d2eSwizDirectory containing the individual user crontab files, named after the user.
133b8f08142Schristos.El
1346f0c1d2eSwiz.Sh DIAGNOSTICS
1356f0c1d2eSwizA fairly informative usage message appears if you run it with a bad command
1366f0c1d2eSwizline.
1376f0c1d2eSwiz.Sh SEE ALSO
1386f0c1d2eSwiz.Xr crontab 5 ,
1396f0c1d2eSwiz.Xr cron 8
140b8f08142Schristos.Sh STANDARDS
1410061c6a5SchristosThe
142b8f08142Schristos.Nm
143b8f08142Schristoscommand conforms to
144*67d03c4bSkre.St -p1003.2 ,
145*67d03c4bSkreexcept that using
146*67d03c4bSkre.Dq \&-
147*67d03c4bSkreas
148*67d03c4bSkre.Ar file
149*67d03c4bSkreis required, for safety reasons, to use standard input to replace the
150*67d03c4bSkrecurrent crontab.
151b8f08142SchristosThis new command syntax
1520061c6a5Schristosdiffers from previous versions of Vixie Cron, as well as from the classic
15326593da5Sjoerg.At v3
154b8f08142Schristossyntax.
155b8f08142Schristos.Sh AUTHORS
156b8f08142Schristos.An Paul Vixie
157b8f08142Schristos.Aq vixie@isc.org
158