Sync usage with man page.
[netbsd-mini2440.git] / libexec / cron / crontab.1
blob4370b75bb401c4198f28adac683337b3aa82b95e
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 .\" $Id: crontab.1,v 1.1 1994/01/05 20:40:12 jtc Exp $
19 .\"
20 .TH CRONTAB 1 "29 December 1993"
21 .UC 4
22 .SH NAME
23 crontab \- maintain crontab files for individual users (V3)
24 .SH SYNOPSIS
25 crontab [ -u user ] file
26 .br
27 crontab [ -u user ] { -l | -r | -e }
28 .SH DESCRIPTION
29 .I Crontab
30 is the program used to install, deinstall or list the tables
31 used to drive the
32 .IR cron (8)
33 daemon in Vixie Cron.  Each user can have their own crontab, and though
34 these are files in /var, they are not intended to be edited directly.
35 .PP
36 If the
37 .I allow
38 file exists, then you must be listed therein in order to be allowed to use
39 this command.  If the
40 .I allow
41 file does not exist but the
42 .I deny
43 file does exist, then you must \fBnot\fR be listed in the
44 .I deny
45 file in order to use this command.  If neither of these files exists, then
46 depending on site-dependent configuration parameters, only the super user
47 will be allowed to use this command, or all users will be able to use this
48 command.
49 .PP
50 If the
51 .I -u
52 option is given, it specifies the name of the user whose crontab is to be
53 tweaked.  If this option is not given,
54 .I crontab
55 examines "your" crontab, i.e., the crontab of the person executing the
56 command.  Note that
57 .IR su (8)
58 can confuse
59 .I crontab
60 and that if you are running inside of
61 .IR su (8)
62 you should always use the
63 .I -u
64 option for safety's sake.
65 .PP
66 The first form of this command is used to install a new crontab from some
67 named file or standard input if the pseudo-filename ``-'' is given.
68 .PP
69 The
70 .I -l
71 option causes the current crontab to be displayed on standard output.
72 .PP
73 The
74 .I -r
75 option causes the current crontab to be removed.
76 .PP
77 The
78 .I -e
79 option is used to edit the current crontab using the editor specified by
80 the \s-1VISUAL\s+1 or \s-1EDITOR\s+1 environment variables.  After you exit
81 from the editor, the modified crontab will be installed automatically.
82 .SH "SEE ALSO"
83 crontab(5), cron(8)
84 .SH FILES
85 .nf
86 /var/cron/allow
87 /var/cron/deny
88 .fi
89 .SH STANDARDS
90 The
91 .I crontab
92 command conforms to IEEE Std1003.2-1992 (``POSIX'').  This new command syntax
93 differs from previous versions of Vixie Cron, as well as from the classic
94 SVR3 syntax.
95 .SH DIAGNOSTICS
96 A fairly informative usage message appears if you run it with a bad command
97 line.
98 .SH AUTHOR
99 .nf
100 Paul Vixie <paul@vix.com>