| blob | 1936d144ef2220843add9b71897adb6868809006 |
1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
6 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
8 .\" This notice shall appear on any product containing this material.
9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
12 .TH AT 1 "Apr 13, 2005"
13 .SH NAME
14 at, batch \- execute commands at a later time
15 .SH SYNOPSIS
16 .LP
17 .nf
18 \fB/usr/bin/at\fR [\fB-c\fR | \fB-k\fR | \fB-s\fR] [\fB-m\fR] [\fB-f\fR \fIfile\fR] [\fB-p\fR \fIproject\fR]
19 [\fB-q\fR \fIqueuename\fR] \fB-t\fR \fItime\fR
20 .fi
22 .LP
23 .nf
24 \fB/usr/bin/at\fR [\fB-c\fR | \fB-k\fR | \fB-s\fR] [\fB-m\fR] [\fB-f\fR \fIfile\fR] [\fB-p\fR \fIproject\fR]
25 [\fB-q\fR \fIqueuename\fR] \fItimespec\fR...
26 .fi
28 .LP
29 .nf
30 \fB/usr/bin/at\fR \fB-l\fR [\fB-p\fR \fIproject\fR] [\fB-q\fR \fIqueuename\fR] [\fIat_job_id\fR \fI...\fR]
31 .fi
33 .LP
34 .nf
35 \fB/usr/bin/at\fR \fB-r\fR \fIat_job_id\fR \fI...\fR
36 .fi
38 .LP
39 .nf
40 \fB/usr/bin/batch\fR [\fB-p\fR \fIproject\fR]
41 .fi
43 .LP
44 .nf
45 \fB/usr/xpg4/bin/at\fR [\fB-c\fR | \fB-k\fR | \fB-s\fR] [\fB-m\fR] [\fB-f\fR \fIfile\fR] [\fB-p\fR \fIproject\fR]
46 [\fB-q\fR \fIqueuename\fR] \fB-t\fR \fItime\fR
47 .fi
49 .LP
50 .nf
51 \fB/usr/xpg4/bin/at\fR [\fB-c\fR | \fB-k\fR | \fB-s\fR] [\fB-m\fR] [\fB-f\fR \fIfile\fR] [\fB-p\fR \fIproject\fR]
52 [\fB-q\fR \fIqueuename\fR] \fItimespec\fR...
53 .fi
55 .LP
56 .nf
57 \fB/usr/xpg4/bin/at\fR \fB-l\fR [\fB-p\fR \fIproject\fR] [\fB-q\fR \fIqueuename\fR]
58 [\fIat_job_id\fR \fI...\fR]
59 .fi
61 .LP
62 .nf
63 \fB/usr/xpg4/bin/at\fR \fB-r\fR \fIat_job_id\fR \fI...\fR
64 .fi
66 .LP
67 .nf
68 \fB/usr/xpg4/bin/batch\fR [\fB-p\fR \fIproject\fR]
69 .fi
71 .SH DESCRIPTION
72 .SS "at"
73 .sp
74 .LP
75 The \fBat\fR utility reads commands from standard input and groups them
76 together as an \fIat-job\fR, to be executed at a later time.
77 .sp
78 .LP
79 The at-job is executed in a separate invocation of the shell, running in a
80 separate process group with no controlling terminal, except that the
81 environment variables, current working directory, file creation mask (see
82 \fBumask\fR(1)), and system resource limits (for \fBsh\fR and \fBksh\fR only,
83 see \fBulimit\fR(1)) in effect when the \fBat\fR utility is executed is
84 retained and used when the at-job is executed.
85 .sp
86 .LP
87 When the at-job is submitted, the \fIat_job_id\fR and scheduled time are
88 written to standard error. The \fIat_job_id\fR is an identifier that is a
89 string consisting solely of alphanumeric characters and the period character.
90 The \fIat_job_id\fR is assigned by the system when the job is scheduled such
91 that it uniquely identifies a particular job.
92 .sp
93 .LP
94 User notification and the processing of the job's standard output and standard
95 error are described under the \fB-m\fR option.
96 .sp
97 .LP
98 Users are permitted to use \fBat\fR and \fBbatch\fR (see below) if their name
99 appears in the file \fB/usr/lib/cron/at.allow\fR. If that file does not exist,
100 the file \fB/usr/lib/cron/at.deny\fR is checked to determine if the user should
101 be denied access to \fBat\fR. If neither file exists, only a user with the
102 \fBsolaris.jobs.user\fR authorization is allowed to submit a job. If only
103 \fBat.deny\fR exists and is empty, global usage is permitted. The
104 \fBat.allow\fR and \fBat.deny\fR files consist of one user name per line.
105 .sp
106 .LP
107 \fBcron\fR and \fBat\fR jobs are not be executed if the user's account is
108 locked. Only accounts which are not locked as defined in \fBshadow\fR(4) will
109 have their job or process executed.
110 .SS "batch"
111 .sp
112 .LP
113 The \fBbatch\fR utility reads commands to be executed at a later time.
114 .sp
115 .LP
116 Commands of the forms:
117 .sp
118 .in +2
119 .nf
120 /usr/bin/batch [-p project]
121 /usr/xpg4/bin/batch [-p project]
122 .fi
123 .in -2
124 .sp
126 .sp
127 .LP
128 are respectively equivalent to:
129 .sp
130 .in +2
131 .nf
132 /usr/bin/at -q b [-p project] now
133 /usr/xpg4/bin/at -q b -m [-p project] now
134 .fi
135 .in -2
136 .sp
138 .sp
139 .LP
140 where queue \fBb\fR is a special \fBat\fR queue, specifically for batch jobs.
141 Batch jobs are submitted to the batch queue for immediate execution. Execution
142 of submitted jobs can be delayed by limits on the number of jobs allowed to run
143 concurrently. See \fBqueuedefs\fR(4).
144 .SH OPTIONS
145 .sp
146 .LP
147 If the \fB-c\fR, \fB-k\fR, or \fB-s\fR options are not specified, the
148 \fBSHELL\fR environment variable by default determines which shell to use.
149 .sp
150 .LP
151 If \fBSHELL\fR is unset or \fBNULL\fR, \fB/usr/bin/sh\fR is used.
152 .sp
153 .LP
154 The following options are supported:
155 .sp
156 .ne 2
157 .na
158 \fB\fB-c\fR \fR
159 .ad
160 .RS 17n
161 C shell. \fBcsh\fR(1) is used to execute the at-job.
162 .RE
164 .sp
165 .ne 2
166 .na
167 \fB\fB-k\fR \fR
168 .ad
169 .RS 17n
170 Korn shell. \fBksh\fR(1) is used to execute the at-job.
171 .RE
173 .sp
174 .ne 2
175 .na
176 \fB\fB-s\fR \fR
177 .ad
178 .RS 17n
179 Bourne shell. \fBsh\fR(1) is used to execute the at-job.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB-f\fR \fIfile\fR \fR
186 .ad
187 .RS 17n
188 Specifies the path of a file to be used as the source of the at-job, instead of
189 standard input.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB-l\fR \fR
196 .ad
197 .RS 17n
198 (The letter ell.) Reports all jobs scheduled for the invoking user if no
199 \fIat_job_id\fR operands are specified. If \fIat_job_id\fRs are specified,
200 reports only information for these jobs.
201 .RE
203 .sp
204 .ne 2
205 .na
206 \fB\fB-m\fR \fR
207 .ad
208 .RS 17n
209 Sends mail to the invoking user after the at-job has run, announcing its
210 completion. Standard output and standard error produced by the at-job are
211 mailed to the user as well, unless redirected elsewhere. Mail is sent even if
212 the job produces no output.
213 .sp
214 If \fB-m\fR is not used, the job's standard output and standard error is
215 provided to the user by means of mail, unless they are redirected elsewhere; if
216 there is no such output to provide, the user is not notified of the job's
217 completion.
218 .RE
220 .sp
221 .ne 2
222 .na
223 \fB\fB-p\fR \fIproject\fR\fR
224 .ad
225 .RS 17n
226 Specifies under which project the \fBat\fR or \fBbatch\fR job is run. When used
227 with the \fB-l\fR option, limits the search to that particular project. Values
228 for \fIproject\fR is interpreted first as a project name, and then as a
229 possible project \fBID\fR, if entirely numeric. By default, the user's current
230 project is used.
231 .RE
233 .sp
234 .ne 2
235 .na
236 \fB\fB-q\fR \fIqueuename\fR \fR
237 .ad
238 .RS 17n
239 Specifies in which queue to schedule a job for submission. When used with the
240 \fB-l\fR option, limits the search to that particular queue. Values for
241 \fIqueuename\fR are limited to the lower case letters \fBa\fR through \fBz\fR.
242 By default, at-jobs are scheduled in queue \fBa\fR. In contrast, queue \fBb\fR
243 is reserved for batch jobs. Since queue \fBc\fR is reserved for cron jobs, it
244 can not be used with the \fB-q\fR option.
245 .RE
247 .sp
248 .ne 2
249 .na
250 \fB\fB-r\fR \fIat_job_id\fR \fR
251 .ad
252 .RS 17n
253 Removes the jobs with the specified \fIat_job_id\fR operands that were
254 previously scheduled by the \fBat\fR utility.
255 .RE
257 .sp
258 .ne 2
259 .na
260 \fB\fB-t\fR \fItime\fR \fR
261 .ad
262 .RS 17n
263 Submits the job to be run at the time specified by the \fItime\fR
264 option-argument, which must have the format as specified by the \fBtouch\fR(1)
265 utility.
266 .RE
268 .SH OPERANDS
269 .sp
270 .LP
271 The following operands are supported:
272 .sp
273 .ne 2
274 .na
275 \fB\fIat_job_id\fR \fR
276 .ad
277 .RS 14n
278 The name reported by a previous invocation of the \fBat\fR utility at the time
279 the job was scheduled.
280 .RE
282 .sp
283 .ne 2
284 .na
285 \fB\fItimespec\fR \fR
286 .ad
287 .RS 14n
288 Submit the job to be run at the date and time specified. All of the
289 \fItimespec\fR operands are interpreted as if they were separated by space
290 characters and concatenated. The date and time are interpreted as being in the
291 timezone of the user (as determined by the \fBTZ\fR variable), unless a
292 timezone name appears as part of \fItime\fR below.
293 .sp
294 In the "C" locale, the following describes the three parts of the time
295 specification string. All of the values from the \fBLC_TIME\fR categories in
296 the "C" locale are recognized in a case-insensitive manner.
297 .sp
298 .ne 2
299 .na
300 \fB\fItime\fR \fR
301 .ad
302 .RS 14n
303 The \fItime\fR can be specified as one, two or four digits. One- and two-digit
304 numbers are taken to be hours, four-digit numbers to be hours and minutes. The
305 time can alternatively be specified as two numbers separated by a colon,
306 meaning \fIhour\fR\fB:\fR\fIminute\fR. An AM/PM indication (one of the values
307 from the \fBam_pm\fR keywords in the \fBLC_TIME\fR locale category) can follow
308 the time; otherwise, a 24-hour clock time is understood. A timezone name of
309 \fBGMT\fR, \fBUCT\fR, or \fBZULU \fR(case insensitive) can follow to specify
310 that the time is in Coordinated Universal Time. Other timezones can be
311 specified using the \fBTZ\fR environment variable. The \fItime\fR field can
312 also be one of the following tokens in the "C" locale:
313 .sp
314 .ne 2
315 .na
316 \fB\fBmidnight\fR \fR
317 .ad
318 .RS 13n
319 Indicates the time 12:00 am (00:00).
320 .RE
322 .sp
323 .ne 2
324 .na
325 \fB\fBnoon\fR \fR
326 .ad
327 .RS 13n
328 Indicates the time 12:00 pm.
329 .RE
331 .sp
332 .ne 2
333 .na
334 \fB\fBnow\fR \fR
335 .ad
336 .RS 13n
337 Indicate the current day and time. Invoking \fBat\fR \fBnow\fR submits an
338 at-job for potentially immediate execution (that is, subject only to
339 unspecified scheduling delays).
340 .RE
342 .RE
344 .sp
345 .ne 2
346 .na
347 \fB\fIdate\fR \fR
348 .ad
349 .RS 14n
350 An optional \fIdate\fR can be specified as either a month name (one of the
351 values from the \fBmon\fR or \fBabmon\fR keywords in the \fBLC_TIME\fR locale
352 category) followed by a day number (and possibly year number preceded by a
353 comma) or a day of the week (one of the values from the \fBday\fR or
354 \fBabday\fR keywords in the \fBLC_TIME\fR locale category). Two special days
355 are recognized in the "C" locale:
356 .sp
357 .ne 2
358 .na
359 \fB\fBtoday\fR \fR
360 .ad
361 .RS 13n
362 Indicates the current day.
363 .RE
365 .sp
366 .ne 2
367 .na
368 \fB\fBtomorrow\fR \fR
369 .ad
370 .RS 13n
371 Indicates the day following the current day.
372 .RE
374 If no \fIdate\fR is given, \fBtoday\fR is assumed if the given time is greater
375 than the current time, and \fBtomorrow\fR is assumed if it is less. If the
376 given month is less than the current month (and no year is given), next year is
377 assumed.
378 .RE
380 .sp
381 .ne 2
382 .na
383 \fB\fIincrement\fR \fR
384 .ad
385 .RS 14n
386 The optional \fIincrement\fR is a number preceded by a plus sign (\fB+\fR) and
387 suffixed by one of the following: \fBminutes\fR, \fBhours\fR, \fBdays\fR,
388 \fBweeks\fR, \fBmonths\fR, or \fByears\fR. (The singular forms are also
389 accepted.) The keyword \fBnext\fR is equivalent to an increment number of \fB+
390 1\fR. For example, the following are equivalent commands:
391 .sp
392 .in +2
393 .nf
394 \fBat 2pm + 1 week
395 at 2pm next week\fR
396 .fi
397 .in -2
398 .sp
400 .RE
402 .RE
404 .SH USAGE
405 .sp
406 .LP
407 The format of the \fBat\fR command line shown here is guaranteed only for the
408 "C" locale. Other locales are not supported for \fBmidnight\fR, \fBnoon\fR,
409 \fBnow\fR, \fBmon\fR, \fBabmon\fR, \fBday\fR, \fBabday\fR, \fBtoday\fR,
410 \fBtomorrow\fR, \fBminutes\fR, \fBhours\fR, \fBdays\fR, \fBweeks\fR,
411 \fBmonths\fR, \fByears\fR, and \fBnext\fR.
412 .sp
413 .LP
414 Since the commands run in a separate shell invocation, running in a separate
415 process group with no controlling terminal, open file descriptors, traps and
416 priority inherited from the invoking environment are lost.
417 .SH EXAMPLES
418 .SS "at"
419 .LP
420 \fBExample 1 \fRTypical Sequence at a Terminal
421 .sp
422 .LP
423 This sequence can be used at a terminal:
425 .sp
426 .in +2
427 .nf
428 $ at \(mim 0730 tomorrow
429 sort < file >outfile
430 <EOT>
431 .fi
432 .in -2
433 .sp
435 .LP
436 \fBExample 2 \fRRedirecting Output
437 .sp
438 .LP
439 This sequence, which demonstrates redirecting standard error to a pipe, is
440 useful in a command procedure (the sequence of output redirection
441 specifications is significant):
443 .sp
444 .in +2
445 .nf
446 $ at now + 1 hour <<!
447 diff file1 file2 2>&1 >outfile | mailx mygroup
448 .fi
449 .in -2
450 .sp
452 .LP
453 \fBExample 3 \fRSelf-rescheduling a Job
454 .sp
455 .LP
456 To have a job reschedule itself, \fBat\fR can be invoked from within the
457 at-job. For example, this "daily-processing" script named \fBmy.daily\fR runs
458 every day (although \fBcrontab\fR is a more appropriate vehicle for such work):
460 .sp
461 .in +2
462 .nf
463 # my.daily runs every day
464 at now tomorrow < my.daily
465 daily-processing
466 .fi
467 .in -2
468 .sp
470 .LP
471 \fBExample 4 \fRVarious Time and Operand Presentations
472 .sp
473 .LP
474 The spacing of the three portions of the "C" locale \fItimespec\fR is quite
475 flexible as long as there are no ambiguities. Examples of various times and
476 operand presentations include:
478 .sp
479 .in +2
480 .nf
481 at 0815am Jan 24
482 at 8 :15amjan24
483 at now "+ 1day"
484 at 5 pm FRIday
485 at '17
486 utc+
487 30minutes'
488 .fi
489 .in -2
490 .sp
492 .SS "batch"
493 .LP
494 \fBExample 5 \fRTypical Sequence at a Terminal
495 .sp
496 .LP
497 This sequence can be used at a terminal:
499 .sp
500 .in +2
501 .nf
502 $ batch
503 sort <file >outfile
504 <EOT>
505 .fi
506 .in -2
507 .sp
509 .LP
510 \fBExample 6 \fRRedirecting Output
511 .sp
512 .LP
513 This sequence, which demonstrates redirecting standard error to a pipe, is
514 useful in a command procedure (the sequence of output redirection
515 specifications is significant):
517 .sp
518 .in +2
519 .nf
520 $ batch <<!
521 diff file1 file2 2>&1 >outfile | mailx mygroup
522 !
523 .fi
524 .in -2
525 .sp
527 .SH ENVIRONMENT VARIABLES
528 .sp
529 .LP
530 See \fBenviron\fR(5) for descriptions of the following environment variables
531 that affect the execution of \fBat\fR and \fBbatch\fR: \fBLANG\fR,
532 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBNLSPATH\fR, and
533 \fBLC_TIME\fR.
534 .sp
535 .ne 2
536 .na
537 \fB\fBDATEMSK\fR \fR
538 .ad
539 .RS 12n
540 If the environment variable \fBDATEMSK\fR is set, \fBat\fR uses its value as
541 the full path name of a template file containing format strings. The strings
542 consist of format specifiers and text characters that are used to provide a
543 richer set of allowable date formats in different languages by appropriate
544 settings of the environment variable \fBLANG\fR or \fBLC_TIME\fR. The list of
545 allowable format specifiers is located in the \fBgetdate\fR(3C) manual page.
546 The formats described in the \fBOPERANDS\fR section for the \fItime\fR and
547 \fIdate\fR arguments, the special names \fBnoon\fR, \fBmidnight\fR, \fBnow\fR,
548 \fBnext\fR, \fBtoday\fR, \fBtomorrow\fR, and the \fIincrement\fR argument are
549 not recognized when \fBDATEMSK\fR is set.
550 .RE
552 .sp
553 .ne 2
554 .na
555 \fB\fBSHELL\fR \fR
556 .ad
557 .RS 12n
558 Determine a name of a command interpreter to be used to invoke the at-job. If
559 the variable is unset or \fINULL\fR, \fBsh\fR is used. If it is set to a value
560 other than \fBsh\fR, the implementation uses that shell; a warning diagnostic
561 is printed telling which shell will be used.
562 .RE
564 .sp
565 .ne 2
566 .na
567 \fB\fBTZ\fR \fR
568 .ad
569 .RS 12n
570 Determine the timezone. The job is submitted for execution at the time
571 specified by \fItimespec\fR or \fB-t\fR \fItime\fR relative to the timezone
572 specified by the \fBTZ\fR variable. If \fItimespec\fR specifies a timezone, it
573 overrides \fBTZ\fR. If \fItimespec\fR does not specify a timezone and \fBTZ\fR
574 is unset or \fINULL\fR, an unspecified default timezone is used.
575 .RE
577 .SH EXIT STATUS
578 .sp
579 .LP
580 The following exit values are returned:
581 .sp
582 .ne 2
583 .na
584 \fB\fB0\fR \fR
585 .ad
586 .RS 7n
587 The \fBat\fR utility successfully submitted, removed or listed a job or jobs.
588 .RE
590 .sp
591 .ne 2
592 .na
593 \fB\fB>0\fR \fR
594 .ad
595 .RS 7n
596 An error occurred, and the job will not be scheduled.
597 .RE
599 .SH FILES
600 .sp
601 .ne 2
602 .na
603 \fB\fB/usr/lib/cron/at.allow\fR \fR
604 .ad
605 .RS 27n
606 names of users, one per line, who are authorized access to the \fBat\fR and
607 \fBbatch\fR utilities
608 .RE
610 .sp
611 .ne 2
612 .na
613 \fB\fB/usr/lib/cron/at.deny\fR \fR
614 .ad
615 .RS 27n
616 names of users, one per line, who are denied access to the \fBat\fR and
617 \fBbatch\fR utilities
618 .RE
620 .SH ATTRIBUTES
621 .sp
622 .LP
623 See \fBattributes\fR(5) for descriptions of the following attributes:
624 .SS "/usr/bin/at"
625 .sp
627 .sp
628 .TS
629 box;
630 c | c
631 l | l .
632 ATTRIBUTE TYPE ATTRIBUTE VALUE
633 _
634 CSI Not enabled
635 _
636 Interface Stability Standard
637 .TE
639 .SS "/usr/xpg4/bin/at"
640 .sp
642 .sp
643 .TS
644 box;
645 c | c
646 l | l .
647 ATTRIBUTE TYPE ATTRIBUTE VALUE
648 _
649 CSI Not enabled
650 _
651 Interface Stability Standard
652 .TE
654 .SS "/usr/bin/batch"
655 .sp
657 .sp
658 .TS
659 box;
660 c | c
661 l | l .
662 ATTRIBUTE TYPE ATTRIBUTE VALUE
663 _
664 CSI Enabled
665 _
666 Interface Stability Standard
667 .TE
669 .SS "/usr/xpg4/bin/batch"
670 .sp
672 .sp
673 .TS
674 box;
675 c | c
676 l | l .
677 ATTRIBUTE TYPE ATTRIBUTE VALUE
678 _
679 CSI Enabled
680 _
681 Interface Stability Standard
682 .TE
684 .SH SEE ALSO
685 .sp
686 .LP
687 \fBauths\fR(1), \fBcrontab\fR(1), \fBcsh\fR(1), \fBdate\fR(1), \fBksh\fR(1),
688 \fBsh\fR(1), \fBtouch\fR(1), \fBulimit\fR(1), \fBumask\fR(1), \fBcron\fR(1M),
689 \fBgetdate\fR(3C), \fBauth_attr\fR(4), \fBshadow\fR(4), \fBqueuedefs\fR(4),
690 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
691 .SH NOTES
692 .sp
693 .LP
694 Regardless of queue used, \fBcron\fR(1M) has a limit of 100 jobs in execution
695 at any time.
696 .sp
697 .LP
698 There can be delays in \fBcron\fR at job execution. In some cases, these delays
699 can compound to the point that \fBcron\fR job processing appears to be hung.
700 All jobs are executed eventually. When the delays are excessive, the only
701 workaround is to kill and restart \fBcron\fR.