Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / cron / crontab / crontab.1
1 .\"/* Copyright 1988,1990,1993 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: src/usr.sbin/cron/crontab/crontab.1,v 1.7.2.4 2002/06/21 16:40:09 charnier Exp $
19 .\" $DragonFly: src/usr.sbin/cron/crontab/crontab.1,v 1.3 2006/02/17 19:40:13 swildner Exp $
20 .\"
21 .Dd December 29, 1993
22 .Dt CRONTAB 1
23 .Os
24 .Sh NAME
25 .Nm crontab
26 .Nd maintain crontab files for individual users (V3)
27 .Sh SYNOPSIS
28 .Nm
29 .Op Fl u Ar user
30 .Ar file
31 .Nm
32 .Op Fl u Ar user
33 {
34 .Fl l |
35 .Fl r |
36 .Fl e
37 }
38 .Sh DESCRIPTION
39 The
40 .Nm
41 utility is the program used to install, deinstall or list the tables
42 used to drive the
43 .Xr cron 8
44 daemon in Vixie Cron.  Each user can have their own crontab, and though
45 these are files in
46 .Pa /var ,
47 they are not intended to be edited directly.
48 .Pp
49 If the
50 .Pa allow
51 file exists, then you must be listed therein in order to be allowed to use
52 this command.  If the
53 .Pa allow
54 file does not exist but the
55 .Pa deny
56 file does exist, then you must
57 .Em not
58 be listed in the
59 .Pa deny
60 file in order to use this command.  If neither of these files exists, then
61 depending on site-dependent configuration parameters, only the super user
62 will be allowed to use this command, or all users will be able to use this
63 command.
64 The format of these files is one username per line,
65 with no leading or trailing whitespace.
66 Lines of other formats will be ignored,
67 and so can be used for comments.
68 .Pp
69 The first form of this command is used to install a new crontab from some
70 named file or standard input if the pseudo-filename ``-'' is given.
71 .Pp
72 The following options are available:
73 .Bl -tag -width indent
74 .It Fl u
75 Specify the name of the user whose crontab is to be
76 tweaked.  If this option is not given,
77 .Nm
78 examines "your" crontab, i.e., the crontab of the person executing the
79 command.  Note that
80 .Xr su 1
81 can confuse
82 .Nm
83 and that if you are running inside of
84 .Xr su 1
85 you should always use the
86 .Fl u
87 option for safety's sake.
88 .It Fl l
89 Display the current crontab on standard output.
90 .It Fl r
91 Remove the current crontab.
92 .It Fl e
93 Edit the current crontab using the editor specified by
94 the
95 .Ev VISUAL
96 or
97 .Ev EDITOR
98 environment variables.
99 The specified editor
100 .Em must
101 edit the file in place;
102 any editor that unlinks the file and recreates it cannot be used.
103 After you exit
104 from the editor, the modified crontab will be installed automatically.
105 .El
106 .Sh FILES
107 .Bl -tag -width /var/cron/allow -compact
108 .It Pa /var/cron/allow
109 .It Pa /var/cron/deny
110 .El
111 .Sh DIAGNOSTICS
112 A fairly informative usage message appears if you run it with a bad command
113 line.
114 .Sh SEE ALSO
115 .Xr crontab 5 ,
116 .Xr cron 8
117 .Sh STANDARDS
118 The
119 .Nm
120 command conforms to
121 .St -p1003.2 .
122 This new command syntax
123 differs from previous versions of Vixie Cron, as well as from the classic
124 SVR3 syntax.
125 .Sh AUTHORS
126 .An Paul Vixie Aq paul@vix.com