Blame man-pages-posix-2013-a/man1p/qdel.1p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH QDEL "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
qdel
Packit 7cfc04
\(em delete batch jobs
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
qdel \fIjob_identifier\fP...
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
A batch job is deleted by sending a request to the batch server that
Packit 7cfc04
manages the batch job. A batch job that has been deleted is no longer
Packit 7cfc04
subject to management by batch services.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility is a user-accessible client of batch services that requests the
Packit 7cfc04
deletion of one or more batch jobs.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall request a batch server to delete those batch jobs for
Packit 7cfc04
which a batch
Packit 7cfc04
.IR job_identifier
Packit 7cfc04
is presented to the utility.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall delete batch jobs in the order in which their batch
Packit 7cfc04
.IR job_identifier s
Packit 7cfc04
are presented to the utility.
Packit 7cfc04
.P
Packit 7cfc04
If the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility fails to process any batch
Packit 7cfc04
.IR job_identifier
Packit 7cfc04
successfully, the utility shall proceed to process the remaining batch
Packit 7cfc04
.IR job_identifier s,
Packit 7cfc04
if any.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall delete each batch job by sending a
Packit 7cfc04
.IR "Delete Job Request"
Packit 7cfc04
to the batch server that manages the batch job.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall not exit until the batch job corresponding to each
Packit 7cfc04
successfully processed batch
Packit 7cfc04
.IR job_identifier
Packit 7cfc04
has been deleted.
Packit 7cfc04
.SH OPTIONS
Packit 7cfc04
None.
Packit 7cfc04
.SH OPERANDS
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall accept one or more operands that conform to the syntax
Packit 7cfc04
for a batch
Packit 7cfc04
.IR job_identifier
Packit 7cfc04
(see
Packit 7cfc04
.IR "Section 3.3.1" ", " "Batch Job Identifier").
Packit 7cfc04
.SH STDIN
Packit 7cfc04
Not used.
Packit 7cfc04
.SH "INPUT FILES"
Packit 7cfc04
None.
Packit 7cfc04
.SH "ENVIRONMENT VARIABLES"
Packit 7cfc04
The following environment variables shall affect the execution of
Packit 7cfc04
.IR qdel :
Packit 7cfc04
.IP "\fILANG\fP" 10
Packit 7cfc04
Provide a default value for the internationalization variables that are
Packit 7cfc04
unset or null. (See the Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Section 8.2" ", " "Internationalization Variables"
Packit 7cfc04
the precedence of internationalization variables used to determine the
Packit 7cfc04
values of locale categories.)
Packit 7cfc04
.IP "\fILC_ALL\fP" 10
Packit 7cfc04
If set to a non-empty string value, override the values of all the
Packit 7cfc04
other internationalization variables.
Packit 7cfc04
.IP "\fILC_CTYPE\fP" 10
Packit 7cfc04
Determine the locale for the interpretation of sequences of bytes of
Packit 7cfc04
text data as characters (for example, single-byte as opposed to
Packit 7cfc04
multi-byte characters in arguments).
Packit 7cfc04
.IP "\fILC_MESSAGES\fP" 10
Packit 7cfc04
.br
Packit 7cfc04
Determine the locale that should be used to affect the format and
Packit 7cfc04
contents of diagnostic messages written to standard error.
Packit 7cfc04
.IP "\fILOGNAME\fP" 10
Packit 7cfc04
Determine the login name of the user.
Packit 7cfc04
.SH "ASYNCHRONOUS EVENTS"
Packit 7cfc04
Default.
Packit 7cfc04
.SH STDOUT
Packit 7cfc04
An implementation of the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility may write informative messages to standard output.
Packit 7cfc04
.SH STDERR
Packit 7cfc04
The standard error shall be used only for diagnostic messages.
Packit 7cfc04
.SH "OUTPUT FILES"
Packit 7cfc04
None.
Packit 7cfc04
.SH "EXTENDED DESCRIPTION"
Packit 7cfc04
None.
Packit 7cfc04
.SH "EXIT STATUS"
Packit 7cfc04
The following exit values shall be returned:
Packit 7cfc04
.IP "\00" 6
Packit 7cfc04
Successful completion.
Packit 7cfc04
.IP >0 6
Packit 7cfc04
An error occurred.
Packit 7cfc04
.SH "CONSEQUENCES OF ERRORS"
Packit 7cfc04
In addition to the default behavior, the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility shall not be required to write a diagnostic message to standard
Packit 7cfc04
error when the error reply received from a batch server indicates that
Packit 7cfc04
the batch
Packit 7cfc04
.IR job_identifier
Packit 7cfc04
does not exist on the server. Whether or not the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility waits to output the diagnostic message while attempting to
Packit 7cfc04
locate the job on other servers is implementation-defined.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
None.
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility allows users and administrators to delete jobs.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility provides functionality that is not otherwise available. For
Packit 7cfc04
example, the
Packit 7cfc04
.IR kill
Packit 7cfc04
utility of the operating system does not suffice. First, to use the
Packit 7cfc04
.IR kill
Packit 7cfc04
utility, the user might have to log in on a remote node, because the
Packit 7cfc04
.IR kill
Packit 7cfc04
utility does not operate across the network. Second, unlike
Packit 7cfc04
.IR qdel ,
Packit 7cfc04
.IR kill
Packit 7cfc04
cannot remove jobs from queues. Lastly, the arguments of the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility are job identifiers rather than process identifiers, and so
Packit 7cfc04
this utility can be passed the output of the
Packit 7cfc04
.IR qselect
Packit 7cfc04
utility, thus providing users with a means of deleting a list of jobs.
Packit 7cfc04
.P
Packit 7cfc04
Because a set of jobs can be selected using the
Packit 7cfc04
.IR qselect
Packit 7cfc04
utility, the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility has not been complicated with options that provide for
Packit 7cfc04
selection of jobs. Instead, the batch jobs to be deleted are identified
Packit 7cfc04
individually by their job identifiers.
Packit 7cfc04
.P
Packit 7cfc04
Historically, the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility has been a component of NQS, the existing practice on which it
Packit 7cfc04
is based. However, the
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility defined in this volume of POSIX.1\(hy2008 does not provide an option for specifying a
Packit 7cfc04
signal number to send to the batch job prior to the killing of the
Packit 7cfc04
process; that capability has been subsumed by the
Packit 7cfc04
.IR qsig
Packit 7cfc04
utility.
Packit 7cfc04
.P
Packit 7cfc04
A discussion was held about the delays of networking and the
Packit 7cfc04
possibility that the batch server may never respond, due to a down
Packit 7cfc04
router, down batch server, or other network mishap. The DESCRIPTION
Packit 7cfc04
records this under the words ``fails to process any job identifier''.
Packit 7cfc04
In the broad sense, the network problem is also an error, which causes
Packit 7cfc04
the failure to process the batch job identifier.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
The
Packit 7cfc04
.IR qdel
Packit 7cfc04
utility may be removed in a future version.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "Chapter 3" ", " "Batch Environment Services",
Packit 7cfc04
.IR "\fIkill\fR\^",
Packit 7cfc04
.IR "\fIqselect\fR\^",
Packit 7cfc04
.IR "\fIqsig\fR\^"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Chapter 8" ", " "Environment Variables"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .