Annotation of src/usr.bin/at/at.1, Revision 1.2
1.2 ! deraadt 1: .\" $OpenBSD: at.1,v 1.6 1995/03/25 18:13:29 glass Exp $
1.1 deraadt 2: .\" $NetBSD: at.1,v 1.6 1995/03/25 18:13:29 glass Exp $
3: .\"
4: .\"
5: .\" Copyright (c) 1993 Christopher G. Demetriou
6: .\" All rights reserved.
7: .\"
8: .\" Redistribution and use in source and binary forms, with or without
9: .\" modification, are permitted provided that the following conditions
10: .\" are met:
11: .\" 1. Redistributions of source code must retain the above copyright
12: .\" notice, this list of conditions and the following disclaimer.
13: .\" 2. Redistributions in binary form must reproduce the above copyright
14: .\" notice, this list of conditions and the following disclaimer in the
15: .\" documentation and/or other materials provided with the distribution.
16: .\" 3. All advertising materials mentioning features or use of this software
17: .\" must display the following acknowledgement:
18: .\" This product includes software developed by Christopher G. Demetriou.
19: .\" 3. The name of the author may not be used to endorse or promote products
20: .\" derived from this software without specific prior written permission
21: .\"
22: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32: .\"
33: .\"
34: .Dd December 5, 1993
35: .Dt "AT" 1
36: .Os NetBSD 0.9a
37: .Sh NAME
38: .Nm at, batch, atq, atrm
39: .Nd queue, examine, or delete jobs for later execution
40: .\"
41: .Sh SYNOPSIS
42: .Nm at
43: .Op Fl q Ar queue
44: .Op Fl f Ar file
45: .Op Fl m
46: .Ar time
47: .Pp
48: .Nm atq
49: .Op Fl q Ar queue
50: .Op Fl v
51: .Pp
52: .Nm atrm
53: .Ar job
54: .Op Ar job ...
55: .Pp
56: .Nm batch
57: .Op Fl f Ar file
58: .Op Fl m
59: .Sh DESCRIPTION
60: The
61: .Nm at
62: and
63: .Nm batch
64: utilities read commands from the standard input or a specified file
65: which are to be executed at a later time, using
66: .Xr sh 1 .
67: .Pp
68: The functions of the commands are as follows:
69: .Bl -tag -width indent
70: .It Nm at
71: Executes commands at a specified time.
72: .It Nm atq
73: Lists the user's pending jobs, unless the user is
74: the superuser. In that case, everybody's jobs are
75: listed.
76: .It Nm atrm
77: Deletes jobs.
78: .It Nm batch
79: executes commands when system load levels permit.
80: In other words, it executes the commands when the load
81: average drops below a specified level.
82: .El
83: .Pp
84: For both
85: .Nm at
86: and
87: .Nm batch ,
88: the working directory, environment (except for the variables
89: .Nm TERM ,
90: .Nm TERMCAP ,
91: .Nm DISPLAY ,
92: and
93: .Nm _ )
94: and the umask are retained from the time of invocation. The user
95: will be mailed the standard output and standard error from
96: his commands if any output is generated. If
97: .Nm at
98: is executed from a
99: .Xr su 1
100: shell, the owner of the login shell will receive the mail.
101: .Sh OPTIONS
102: .Bl -tag -width indent
103: The available options are as follows:
104: .It Fl q Ar queue
105: Use the specified queue. A queue designation consists
106: of a single letter; valid queue designation range from
107: .Ar a
108: to
109: .Ar l .
110: The
111: .Ar a
112: queue is the default, and
113: .Ar b
114: is the batch queue. Queues with higher letters run with
115: increased niceness. If
116: .Nm atq
117: is given a specific queue, it will only show jobs pending
118: in that queue.
119: .It Fl m
120: Send mail to the user when the job has completed, even if
121: there was no output.
122: .It Fl f Ar file
123: Reads the job from
124: .Ar file
125: rather than the standard input.
126: .It Fl v
127: Shows completed but not yet deleted jobs in the queue.
128: .Sh TIME SPECIFICATION
129: .Nm At
130: allows some moderately complex time specifications.
131: It accepts times of the form
132: .Ar HHMM
133: or
134: .Ar HH:MM
135: to run a job at a specific time of day. If
136: that time is already passed, the next day is assumed.
137: You may also specify
138: .Nm midnight ,
139: .Nm noon ,
140: or
141: .Nm teatime
142: (4PM) and you can give a time of day suffixed with
143: .Nm AM
144: or
145: .Nm PM
146: for running in the morning or the evening. You can
147: also specify the date on which the job will be run
148: by giving a date in the form
149: .Ar month-name day
150: with an optional
151: .Ar year ,
152: or giving a date of the form
153: .Ar MMDDYY ,
154: .Ar MM/DD/YY
155: or
156: .Ar DD.MM.YY .
157: You can also give times like
158: .Nm now +
159: .Ar count time-units ,
160: where the time units can be
161: .Nm minutes, hours, days,
162: or
163: .Nm weeks
164: You can suffix the time with
165: .Nm today
166: to run the job today, or
167: .Nm tomorrow
168: to run the job tomorrow.
169: .Pp
170: For example, to run a job at 4PM three days from now, you
171: would specify a time of
172: .Nm 4PM + 3 days .
173: To run a job at 10:00AM on on July 31, you would specify
174: a time of
175: .Nm 10AM Jul 31 .
176: Finally, to run a job at 1AM tomorrow, you would specify
177: a time of
178: .Nm 1AM tomorrow .
179: .Sh FILES
180: .Bl -tag -width /var/at/lockfile -compact
181: .It Pa /var/at/jobs
182: Directory containing job files
183: .It Pa /var/at/spool
184: Directory containing output spool files
185: .It Pa /var/at/lockfile
186: Job-creation lock file.
187: .It Pa /var/run/utmp
188: .El
189: .Sh SEE ALSO
190: .Xr cron 8 ,
191: .Xr nice 1 ,
192: .Xr sh 1 ,
193: .Xr atrun 8
194: .Sh AUTHOR
195: .Bl -tag
196: Thomas Koenig, ig25@rz.uni-karlsruhe.de
197: .El
198: .Sh BUGS
199: Traditional access control to
200: .Nm at
201: and
202: .Nm batch
203: via the files
204: .Pa /var/at/at.allow
205: and
206: .Pa /var/at/at.deny
207: is not implemented.
208: .Pp
209: If the file
210: .Pa /var/run/utmp
211: is not available or corrupted, or if the user is not
212: logged in at the time
213: .Nm at
214: is invoked, the mail is sent to the userid found in the
215: environment variable
216: .Nm LOGNAME .
217: If that is undefined or empty, the current userid is assumed.