| blob | f83fdfcac67f7486f23744f5138448641cdfd75b |
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 "Oct 25, 2017"
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 .SH DESCRIPTION
44 .SS "at"
45 .sp
46 .LP
47 The \fBat\fR utility reads commands from standard input and groups them
48 together as an \fIat-job\fR, to be executed at a later time.
49 .sp
50 .LP
51 The at-job is executed in a separate invocation of the shell, running in a
52 separate process group with no controlling terminal, except that the
53 environment variables, current working directory, file creation mask (see
54 \fBumask\fR(1)), and system resource limits (for \fBsh\fR and \fBksh\fR only,
55 see \fBulimit\fR(1)) in effect when the \fBat\fR utility is executed is
56 retained and used when the at-job is executed.
57 .sp
58 .LP
59 When the at-job is submitted, the \fIat_job_id\fR and scheduled time are
60 written to standard error. The \fIat_job_id\fR is an identifier that is a
61 string consisting solely of alphanumeric characters and the period character.
62 The \fIat_job_id\fR is assigned by the system when the job is scheduled such
63 that it uniquely identifies a particular job.
64 .sp
65 .LP
66 User notification and the processing of the job's standard output and standard
67 error are described under the \fB-m\fR option.
68 .sp
69 .LP
70 Users are permitted to use \fBat\fR and \fBbatch\fR (see below) if their name
71 appears in the file \fB/usr/lib/cron/at.allow\fR. If that file does not exist,
72 the file \fB/usr/lib/cron/at.deny\fR is checked to determine if the user should
73 be denied access to \fBat\fR. If neither file exists, only a user with the
74 \fBsolaris.jobs.user\fR authorization is allowed to submit a job. If only
75 \fBat.deny\fR exists and is empty, global usage is permitted. The
76 \fBat.allow\fR and \fBat.deny\fR files consist of one user name per line.
77 .sp
78 .LP
79 \fBcron\fR and \fBat\fR jobs are not be executed if the user's account is
80 locked. Only accounts which are not locked as defined in \fBshadow\fR(4) will
81 have their job or process executed.
82 .SS "batch"
83 .sp
84 .LP
85 The \fBbatch\fR utility reads commands to be executed at a later time.
86 .sp
87 .LP
88 Commands of the forms:
89 .sp
90 .in +2
91 .nf
92 /usr/bin/batch [-p project]
93 .fi
94 .in -2
95 .sp
97 .sp
98 .LP
99 are respectively equivalent to:
100 .sp
101 .in +2
102 .nf
103 /usr/bin/at -q b -m [-p project] now
104 .fi
105 .in -2
106 .sp
108 .sp
109 .LP
110 where queue \fBb\fR is a special \fBat\fR queue, specifically for batch jobs.
111 Batch jobs are submitted to the batch queue for immediate execution. Execution
112 of submitted jobs can be delayed by limits on the number of jobs allowed to run
113 concurrently. See \fBqueuedefs\fR(4).
114 .SH OPTIONS
115 .sp
116 .LP
117 If the \fB-c\fR, \fB-k\fR, or \fB-s\fR options are not specified, the
118 \fBSHELL\fR environment variable by default determines which shell to use.
119 .sp
120 .LP
121 If \fBSHELL\fR is unset or \fBNULL\fR, \fB/usr/bin/sh\fR is used.
122 .sp
123 .LP
124 The following options are supported:
125 .sp
126 .ne 2
127 .na
128 \fB\fB-c\fR \fR
129 .ad
130 .RS 17n
131 C shell. \fBcsh\fR(1) is used to execute the at-job.
132 .RE
134 .sp
135 .ne 2
136 .na
137 \fB\fB-k\fR \fR
138 .ad
139 .RS 17n
140 Korn shell. \fBksh\fR(1) is used to execute the at-job.
141 .RE
143 .sp
144 .ne 2
145 .na
146 \fB\fB-s\fR \fR
147 .ad
148 .RS 17n
149 Bourne shell. \fBsh\fR(1) is used to execute the at-job.
150 .RE
152 .sp
153 .ne 2
154 .na
155 \fB\fB-f\fR \fIfile\fR \fR
156 .ad
157 .RS 17n
158 Specifies the path of a file to be used as the source of the at-job, instead of
159 standard input.
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fB-l\fR \fR
166 .ad
167 .RS 17n
168 (The letter ell.) Reports all jobs scheduled for the invoking user if no
169 \fIat_job_id\fR operands are specified. If \fIat_job_id\fRs are specified,
170 reports only information for these jobs.
171 .RE
173 .sp
174 .ne 2
175 .na
176 \fB\fB-m\fR \fR
177 .ad
178 .RS 17n
179 Sends mail to the invoking user after the at-job has run, announcing its
180 completion. Standard output and standard error produced by the at-job are
181 mailed to the user as well, unless redirected elsewhere. Mail is sent even if
182 the job produces no output.
183 .sp
184 If \fB-m\fR is not used, the job's standard output and standard error is
185 provided to the user by means of mail, unless they are redirected elsewhere; if
186 there is no such output to provide, the user is not notified of the job's
187 completion.
188 .RE
190 .sp
191 .ne 2
192 .na
193 \fB\fB-p\fR \fIproject\fR\fR
194 .ad
195 .RS 17n
196 Specifies under which project the \fBat\fR or \fBbatch\fR job is run. When used
197 with the \fB-l\fR option, limits the search to that particular project. Values
198 for \fIproject\fR is interpreted first as a project name, and then as a
199 possible project \fBID\fR, if entirely numeric. By default, the user's current
200 project is used.
201 .RE
203 .sp
204 .ne 2
205 .na
206 \fB\fB-q\fR \fIqueuename\fR \fR
207 .ad
208 .RS 17n
209 Specifies in which queue to schedule a job for submission. When used with the
210 \fB-l\fR option, limits the search to that particular queue. Values for
211 \fIqueuename\fR are limited to the lower case letters \fBa\fR through \fBz\fR.
212 By default, at-jobs are scheduled in queue \fBa\fR. In contrast, queue \fBb\fR
213 is reserved for batch jobs. Since queue \fBc\fR is reserved for cron jobs, it
214 can not be used with the \fB-q\fR option.
215 .RE
217 .sp
218 .ne 2
219 .na
220 \fB\fB-r\fR \fIat_job_id\fR \fR
221 .ad
222 .RS 17n
223 Removes the jobs with the specified \fIat_job_id\fR operands that were
224 previously scheduled by the \fBat\fR utility.
225 .RE
227 .sp
228 .ne 2
229 .na
230 \fB\fB-t\fR \fItime\fR \fR
231 .ad
232 .RS 17n
233 Submits the job to be run at the time specified by the \fItime\fR
234 option-argument, which must have the format as specified by the \fBtouch\fR(1)
235 utility.
236 .RE
238 .SH OPERANDS
239 .sp
240 .LP
241 The following operands are supported:
242 .sp
243 .ne 2
244 .na
245 \fB\fIat_job_id\fR \fR
246 .ad
247 .RS 14n
248 The name reported by a previous invocation of the \fBat\fR utility at the time
249 the job was scheduled.
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fItimespec\fR \fR
256 .ad
257 .RS 14n
258 Submit the job to be run at the date and time specified. All of the
259 \fItimespec\fR operands are interpreted as if they were separated by space
260 characters and concatenated. The date and time are interpreted as being in the
261 timezone of the user (as determined by the \fBTZ\fR variable), unless a
262 timezone name appears as part of \fItime\fR below.
263 .sp
264 In the "C" locale, the following describes the three parts of the time
265 specification string. All of the values from the \fBLC_TIME\fR categories in
266 the "C" locale are recognized in a case-insensitive manner.
267 .sp
268 .ne 2
269 .na
270 \fB\fItime\fR \fR
271 .ad
272 .RS 14n
273 The \fItime\fR can be specified as one, two or four digits. One- and two-digit
274 numbers are taken to be hours, four-digit numbers to be hours and minutes. The
275 time can alternatively be specified as two numbers separated by a colon,
276 meaning \fIhour\fR\fB:\fR\fIminute\fR. An AM/PM indication (one of the values
277 from the \fBam_pm\fR keywords in the \fBLC_TIME\fR locale category) can follow
278 the time; otherwise, a 24-hour clock time is understood. A timezone name of
279 \fBGMT\fR, \fBUCT\fR, or \fBZULU \fR(case insensitive) can follow to specify
280 that the time is in Coordinated Universal Time. Other timezones can be
281 specified using the \fBTZ\fR environment variable. The \fItime\fR field can
282 also be one of the following tokens in the "C" locale:
283 .sp
284 .ne 2
285 .na
286 \fB\fBmidnight\fR \fR
287 .ad
288 .RS 13n
289 Indicates the time 12:00 am (00:00).
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fBnoon\fR \fR
296 .ad
297 .RS 13n
298 Indicates the time 12:00 pm.
299 .RE
301 .sp
302 .ne 2
303 .na
304 \fB\fBnow\fR \fR
305 .ad
306 .RS 13n
307 Indicate the current day and time. Invoking \fBat\fR \fBnow\fR submits an
308 at-job for potentially immediate execution (that is, subject only to
309 unspecified scheduling delays).
310 .RE
312 .RE
314 .sp
315 .ne 2
316 .na
317 \fB\fIdate\fR \fR
318 .ad
319 .RS 14n
320 An optional \fIdate\fR can be specified as either a month name (one of the
321 values from the \fBmon\fR or \fBabmon\fR keywords in the \fBLC_TIME\fR locale
322 category) followed by a day number (and possibly year number preceded by a
323 comma) or a day of the week (one of the values from the \fBday\fR or
324 \fBabday\fR keywords in the \fBLC_TIME\fR locale category). Two special days
325 are recognized in the "C" locale:
326 .sp
327 .ne 2
328 .na
329 \fB\fBtoday\fR \fR
330 .ad
331 .RS 13n
332 Indicates the current day.
333 .RE
335 .sp
336 .ne 2
337 .na
338 \fB\fBtomorrow\fR \fR
339 .ad
340 .RS 13n
341 Indicates the day following the current day.
342 .RE
344 If no \fIdate\fR is given, \fBtoday\fR is assumed if the given time is greater
345 than the current time, and \fBtomorrow\fR is assumed if it is less. If the
346 given month is less than the current month (and no year is given), next year is
347 assumed.
348 .RE
350 .sp
351 .ne 2
352 .na
353 \fB\fIincrement\fR \fR
354 .ad
355 .RS 14n
356 The optional \fIincrement\fR is a number preceded by a plus sign (\fB+\fR) and
357 suffixed by one of the following: \fBminutes\fR, \fBhours\fR, \fBdays\fR,
358 \fBweeks\fR, \fBmonths\fR, or \fByears\fR. (The singular forms are also
359 accepted.) The keyword \fBnext\fR is equivalent to an increment number of \fB+
360 1\fR. For example, the following are equivalent commands:
361 .sp
362 .in +2
363 .nf
364 \fBat 2pm + 1 week
365 at 2pm next week\fR
366 .fi
367 .in -2
368 .sp
370 .RE
372 .RE
374 .SH USAGE
375 .sp
376 .LP
377 The format of the \fBat\fR command line shown here is guaranteed only for the
378 "C" locale. Other locales are not supported for \fBmidnight\fR, \fBnoon\fR,
379 \fBnow\fR, \fBmon\fR, \fBabmon\fR, \fBday\fR, \fBabday\fR, \fBtoday\fR,
380 \fBtomorrow\fR, \fBminutes\fR, \fBhours\fR, \fBdays\fR, \fBweeks\fR,
381 \fBmonths\fR, \fByears\fR, and \fBnext\fR.
382 .sp
383 .LP
384 Since the commands run in a separate shell invocation, running in a separate
385 process group with no controlling terminal, open file descriptors, traps and
386 priority inherited from the invoking environment are lost.
387 .SH EXAMPLES
388 .SS "at"
389 .LP
390 \fBExample 1 \fRTypical Sequence at a Terminal
391 .sp
392 .LP
393 This sequence can be used at a terminal:
395 .sp
396 .in +2
397 .nf
398 $ at \(mim 0730 tomorrow
399 sort < file >outfile
400 <EOT>
401 .fi
402 .in -2
403 .sp
405 .LP
406 \fBExample 2 \fRRedirecting Output
407 .sp
408 .LP
409 This sequence, which demonstrates redirecting standard error to a pipe, is
410 useful in a command procedure (the sequence of output redirection
411 specifications is significant):
413 .sp
414 .in +2
415 .nf
416 $ at now + 1 hour <<!
417 diff file1 file2 2>&1 >outfile | mailx mygroup
418 .fi
419 .in -2
420 .sp
422 .LP
423 \fBExample 3 \fRSelf-rescheduling a Job
424 .sp
425 .LP
426 To have a job reschedule itself, \fBat\fR can be invoked from within the
427 at-job. For example, this "daily-processing" script named \fBmy.daily\fR runs
428 every day (although \fBcrontab\fR is a more appropriate vehicle for such work):
430 .sp
431 .in +2
432 .nf
433 # my.daily runs every day
434 at now tomorrow < my.daily
435 daily-processing
436 .fi
437 .in -2
438 .sp
440 .LP
441 \fBExample 4 \fRVarious Time and Operand Presentations
442 .sp
443 .LP
444 The spacing of the three portions of the "C" locale \fItimespec\fR is quite
445 flexible as long as there are no ambiguities. Examples of various times and
446 operand presentations include:
448 .sp
449 .in +2
450 .nf
451 at 0815am Jan 24
452 at 8 :15amjan24
453 at now "+ 1day"
454 at 5 pm FRIday
455 at '17
456 utc+
457 30minutes'
458 .fi
459 .in -2
460 .sp
462 .SS "batch"
463 .LP
464 \fBExample 5 \fRTypical Sequence at a Terminal
465 .sp
466 .LP
467 This sequence can be used at a terminal:
469 .sp
470 .in +2
471 .nf
472 $ batch
473 sort <file >outfile
474 <EOT>
475 .fi
476 .in -2
477 .sp
479 .LP
480 \fBExample 6 \fRRedirecting Output
481 .sp
482 .LP
483 This sequence, which demonstrates redirecting standard error to a pipe, is
484 useful in a command procedure (the sequence of output redirection
485 specifications is significant):
487 .sp
488 .in +2
489 .nf
490 $ batch <<!
491 diff file1 file2 2>&1 >outfile | mailx mygroup
492 !
493 .fi
494 .in -2
495 .sp
497 .SH ENVIRONMENT VARIABLES
498 .sp
499 .LP
500 See \fBenviron\fR(5) for descriptions of the following environment variables
501 that affect the execution of \fBat\fR and \fBbatch\fR: \fBLANG\fR,
502 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBNLSPATH\fR, and
503 \fBLC_TIME\fR.
504 .sp
505 .ne 2
506 .na
507 \fB\fBDATEMSK\fR \fR
508 .ad
509 .RS 12n
510 If the environment variable \fBDATEMSK\fR is set, \fBat\fR uses its value as
511 the full path name of a template file containing format strings. The strings
512 consist of format specifiers and text characters that are used to provide a
513 richer set of allowable date formats in different languages by appropriate
514 settings of the environment variable \fBLANG\fR or \fBLC_TIME\fR. The list of
515 allowable format specifiers is located in the \fBgetdate\fR(3C) manual page.
516 The formats described in the \fBOPERANDS\fR section for the \fItime\fR and
517 \fIdate\fR arguments, the special names \fBnoon\fR, \fBmidnight\fR, \fBnow\fR,
518 \fBnext\fR, \fBtoday\fR, \fBtomorrow\fR, and the \fIincrement\fR argument are
519 not recognized when \fBDATEMSK\fR is set.
520 .RE
522 .sp
523 .ne 2
524 .na
525 \fB\fBSHELL\fR \fR
526 .ad
527 .RS 12n
528 Determine a name of a command interpreter to be used to invoke the at-job. If
529 the variable is unset or \fINULL\fR, \fBsh\fR is used. If it is set to a value
530 other than \fBsh\fR, the implementation uses that shell; a warning diagnostic
531 is printed telling which shell will be used.
532 .RE
534 .sp
535 .ne 2
536 .na
537 \fB\fBTZ\fR \fR
538 .ad
539 .RS 12n
540 Determine the timezone. The job is submitted for execution at the time
541 specified by \fItimespec\fR or \fB-t\fR \fItime\fR relative to the timezone
542 specified by the \fBTZ\fR variable. If \fItimespec\fR specifies a timezone, it
543 overrides \fBTZ\fR. If \fItimespec\fR does not specify a timezone and \fBTZ\fR
544 is unset or \fINULL\fR, an unspecified default timezone is used.
545 .RE
547 .SH EXIT STATUS
548 .sp
549 .LP
550 The following exit values are returned:
551 .sp
552 .ne 2
553 .na
554 \fB\fB0\fR \fR
555 .ad
556 .RS 7n
557 The \fBat\fR utility successfully submitted, removed or listed a job or jobs.
558 .RE
560 .sp
561 .ne 2
562 .na
563 \fB\fB>0\fR \fR
564 .ad
565 .RS 7n
566 An error occurred, and the job will not be scheduled.
567 .RE
569 .SH FILES
570 .sp
571 .ne 2
572 .na
573 \fB\fB/usr/lib/cron/at.allow\fR \fR
574 .ad
575 .RS 27n
576 names of users, one per line, who are authorized access to the \fBat\fR and
577 \fBbatch\fR utilities
578 .RE
580 .sp
581 .ne 2
582 .na
583 \fB\fB/usr/lib/cron/at.deny\fR \fR
584 .ad
585 .RS 27n
586 names of users, one per line, who are denied access to the \fBat\fR and
587 \fBbatch\fR utilities
588 .RE
590 .SH ATTRIBUTES
591 .sp
592 .LP
593 See \fBattributes\fR(5) for descriptions of the following attributes:
594 .SS "/usr/bin/at"
595 .sp
597 .sp
598 .TS
599 box;
600 c | c
601 l | l .
602 ATTRIBUTE TYPE ATTRIBUTE VALUE
603 _
604 CSI Not enabled
605 _
606 Interface Stability Standard
607 .TE
609 .SS "/usr/bin/batch"
610 .sp
612 .sp
613 .TS
614 box;
615 c | c
616 l | l .
617 ATTRIBUTE TYPE ATTRIBUTE VALUE
618 _
619 CSI Enabled
620 _
621 Interface Stability Standard
622 .TE
624 .SH SEE ALSO
625 .sp
626 .LP
627 \fBauths\fR(1), \fBcrontab\fR(1), \fBcsh\fR(1), \fBdate\fR(1), \fBksh\fR(1),
628 \fBsh\fR(1), \fBtouch\fR(1), \fBulimit\fR(1), \fBumask\fR(1), \fBcron\fR(1M),
629 \fBgetdate\fR(3C), \fBauth_attr\fR(4), \fBshadow\fR(4), \fBqueuedefs\fR(4),
630 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
631 .SH NOTES
632 .sp
633 .LP
634 Regardless of queue used, \fBcron\fR(1M) has a limit of 100 jobs in execution
635 at any time.
636 .sp
637 .LP
638 There can be delays in \fBcron\fR at job execution. In some cases, these delays
639 can compound to the point that \fBcron\fR job processing appears to be hung.
640 All jobs are executed eventually. When the delays are excessive, the only
641 workaround is to kill and restart \fBcron\fR.