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$
  19 .\"
  20 .Dd December 29, 1993
  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 {
  33 .Fl l |
  34 .Fl r |
  35 .Fl e
  36 }
  37 .Sh DESCRIPTION
  38 .Nm Crontab
  39 is the program used to install, deinstall or list the tables
  40 used to drive the
  41 .Xr cron 8
  42 daemon in Vixie Cron.  Each user can have their own crontab, and though
  43 these are files in
  44 .Pa /var ,
  45 they are not intended to be edited directly.
  46 .Pp
  47 If the
  48 .Pa allow
  49 file exists, then you must be listed therein in order to be allowed to use
  50 this command.  If the
  51 .Pa allow
  52 file does not exist but the
  53 .Pa deny
  54 file does exist, then you must
  55 .Em not
  56 be listed in the
  57 .Pa deny
  58 file in order to use this command.  If neither of these files exists, then
  59 depending on site-dependent configuration parameters, only the super user
  60 will be allowed to use this command, or all users will be able to use this
  61 command.
  62 .Pp
  63 The first form of this command is used to install a new crontab from some
  64 named file or standard input if the pseudo-filename ``-'' is given.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width indent
  68 .It Fl u
  69 Specify the name of the user whose crontab is to be
  70 tweaked.  If this option is not given,
  71 .Nm
  72 examines "your" crontab, i.e., the crontab of the person executing the
  73 command.  Note that
  74 .Xr su 1
  75 can confuse
  76 .Nm
  77 and that if you are running inside of
  78 .Xr su 1
  79 you should always use the
  80 .Fl u
  81 option for safety's sake.
  82 .It Fl l
  83 Display the current crontab on standard output.
  84 .It Fl r
  85 Remove the current crontab.
  86 .It Fl e
  87 Edit the current crontab using the editor specified by
  88 the
  89 .Ev VISUAL
  90 or
  91 .Ev EDITOR
  92 environment variables.  After you exit
  93 from the editor, the modified crontab will be installed automatically.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr crontab 5 ,
  97 .Xr cron 8
  98 .Sh FILES
  99 .Bl -tag -width /var/cron/allow -compact
 100 .It Pa /var/cron/allow
 101 .It Pa /var/cron/deny
 102 .El
 103 .Sh STANDARDS
 104 The
 105 .Nm
 106 command conforms to
 107 .St -p1003.2 .
 108 This new command syntax
 109 differs from previous versions of Vixie Cron, as well as from the classic
 110 SVR3 syntax.
 111 .Sh DIAGNOSTICS
 112 A fairly informative usage message appears if you run it with a bad command
 113 line.
 114 .Sh AUTHORS
 115 .An Paul Vixie Aq paul@vix.com