path: root/upstream/archlinux/man1p/batch.1p

'\" et
.TH BATCH "1P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
batch
\(em schedule commands to be executed in a batch queue
.SH SYNOPSIS
.LP
.nf
\fIbatch\fR
.fi
.SH DESCRIPTION
The
.IR batch
utility shall read commands from standard input and schedule them
for execution in a batch queue. It shall be the equivalent of
the command:
.sp
.RS 4
.nf

at -q b -m now
.fi
.P
.RE
.P
where queue
.IR b
is a special
.IR at
queue, specifically for batch jobs. Batch jobs shall be submitted to the
batch queue with no time constraints and shall be run by the system using
algorithms, based on unspecified factors, that may vary with each
invocation of
.IR batch .
.P
Users shall be permitted to use
.IR batch
if their name appears in the file
.BR at.allow
which is located in an implementation-defined directory.
If that file does not exist, the file
.BR at.deny ,
which is located in an implementation-defined directory,
shall be checked to determine whether the user shall be denied access to
.IR batch .
If neither file exists, only a process with appropriate privileges
shall be allowed to submit a job. If only
.BR at.deny
exists and is empty, global usage shall be permitted. The
.BR at.allow
and
.BR at.deny
files shall consist of one user name per line.
.SH OPTIONS
None.
.SH OPERANDS
None.
.SH STDIN
The standard input shall be a text file consisting of commands
acceptable to the shell command language described in
.IR "Chapter 2" ", " "Shell Command Language".
.SH "INPUT FILES"
The text files
.BR at.allow
and
.BR at.deny ,
which are located in an implementation-defined directory,
shall contain zero or more user names, one per line, of users who are,
respectively, authorized or denied access to the
.IR at
and
.IR batch
utilities.
.SH "ENVIRONMENT VARIABLES"
The following environment variables shall affect the execution of
.IR batch :
.IP "\fILANG\fP" 10
Provide a default value for the internationalization variables that are
unset or null. (See the Base Definitions volume of POSIX.1\(hy2017,
.IR "Section 8.2" ", " "Internationalization Variables"
for the precedence of internationalization variables used to determine
the values of locale categories.)
.IP "\fILC_ALL\fP" 10
If set to a non-empty string value, override the values of all the
other internationalization variables.
.IP "\fILC_CTYPE\fP" 10
Determine the locale for the interpretation of sequences of bytes of
text data as characters (for example, single-byte as opposed to
multi-byte characters in arguments and input files).
.IP "\fILC_MESSAGES\fP" 10
.br
Determine the locale that should be used to affect the format and
contents of diagnostic messages written to standard error and
informative messages written to standard output.
.IP "\fILC_TIME\fP" 10
Determine the format and contents for date and time strings written by
.IR batch .
.IP "\fINLSPATH\fP" 10
Determine the location of message catalogs for the processing of
.IR LC_MESSAGES .
.IP "\fISHELL\fP" 10
Determine the name of a command interpreter to be used to invoke the
at-job. If the variable is unset or null,
.IR sh
shall be used. If it is set to a value other than a name for
.IR sh ,
the implementation shall do one of the following: use that shell; use
.IR sh ;
use the login shell from the user database; any of the preceding
accompanied by a warning diagnostic about which was chosen.
.IP "\fITZ\fP" 10
Determine the timezone. The job shall be submitted for execution at the
time specified by
.IR timespec
or
.BR \-t
.IR time
relative to the timezone specified by the
.IR TZ
variable. If
.IR timespec
specifies a timezone, it overrides
.IR TZ .
If
.IR timespec
does not specify a timezone and
.IR TZ
is unset or null, an unspecified default timezone shall be used.
.SH "ASYNCHRONOUS EVENTS"
Default.
.SH STDOUT
When standard input is a terminal, prompts of unspecified format for
each line of the user input described in the STDIN section may be
written to standard output.
.SH STDERR
The following shall be written to standard error when a job has been
successfully submitted:
.sp
.RS 4
.nf

"job %s at %s\en", \fIat_job_id\fR, <\fIdate\fR>
.fi
.P
.RE
.P
where
.IR date
shall be equivalent in format to the output of:
.sp
.RS 4
.nf

date +"%a %b %e %T %Y"
.fi
.P
.RE
.P
The date and time written shall be adjusted so that they appear in the
timezone of the user (as determined by the
.IR TZ
variable).
.P
Neither this, nor warning messages concerning the selection of the
command interpreter, are considered a diagnostic that changes the exit
status.
.P
Diagnostic messages, if any, shall be written to standard error.
.SH "OUTPUT FILES"
None.
.SH "EXTENDED DESCRIPTION"
None.
.SH "EXIT STATUS"
The following exit values shall be returned:
.IP "\00" 6
Successful completion.
.IP >0 6
An error occurred.
.SH "CONSEQUENCES OF ERRORS"
The job shall not be scheduled.
.LP
.IR "The following sections are informative."
.SH "APPLICATION USAGE"
It may be useful to redirect standard output within the specified
commands.
.SH EXAMPLES
.IP " 1." 4
This sequence can be used at a terminal:
.RS 4 
.sp
.RS 4
.nf

batch
sort < file >outfile
EOT
.fi
.P
.RE
.RE
.IP " 2." 4
This sequence, which demonstrates redirecting standard error to a pipe,
is useful in a command procedure (the sequence of output redirection
specifications is significant):
.RS 4 
.sp
.RS 4
.nf

batch <<!
diff file1 file2 2>&1 >outfile | mailx mygroup
!
.fi
.P
.RE
.RE
.SH RATIONALE
Early proposals described
.IR batch
in a manner totally separated from
.IR at ,
even though the historical model treated it almost as a synonym for
.IR at
.BR \-qb .
A number of features were added to list and control batch work
separately from those in
.IR at .
Upon further reflection, it was decided that the benefit of this did
not merit the change to the historical interface.
.P
The
.BR \-m
option was included on the equivalent
.IR at
command because it is historical practice to mail results to the
submitter, even if all job-produced output is redirected. As explained
in the RATIONALE for
.IR at ,
the
.BR now
keyword submits the job for immediate execution (after scheduling
delays), despite some historical systems where
.IR at
.BR now
would have been considered an error.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIat\fR\^"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "Chapter 8" ", " "Environment Variables"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version 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 .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .