man1p/qdel.1p

   1 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   2 .TH "QDEL" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   3 .\" qdel
   4 .SH NAME
   5 qdel \- delete batch jobs
   6 .SH SYNOPSIS
   7 .LP
   8 \fBqdel\fP \fIjob_identifier\fP \fB... \fP
   9 .SH DESCRIPTION
  10 .LP
  11 A batch job is deleted by sending a request to the batch server that
  12 manages the batch job. A batch job that has been deleted is
  13 no longer subject to management by batch services.
  14 .LP
  15 The \fIqdel\fP utility is a user-accessible client of batch services
  16 that requests the deletion of one or more batch jobs.
  17 .LP
  18 The \fIqdel\fP utility shall request a batch server to delete those
  19 batch jobs for which a batch \fIjob_identifier\fP is
  20 presented to the utility.
  21 .LP
  22 The \fIqdel\fP utility shall delete batch jobs in the order in which
  23 their batch \fIjob_identifier\fPs are presented to the
  24 utility.
  25 .LP
  26 If the \fIqdel\fP utility fails to process any batch \fIjob_identifier\fP
  27 successfully, the utility shall proceed to process
  28 the remaining batch \fIjob_identifier\fPs, if any.
  29 .LP
  30 The \fIqdel\fP utility shall delete each batch job by sending a \fIDelete
  31 Job Request\fP to the batch server that manages the
  32 batch job.
  33 .LP
  34 The \fIqdel\fP utility shall not exit until the batch job corresponding
  35 to each successfully processed batch
  36 \fIjob_identifier\fP has been deleted.
  37 .SH OPTIONS
  38 .LP
  39 None.
  40 .SH OPERANDS
  41 .LP
  42 The \fIqdel\fP utility shall accept one or more operands that conform
  43 to the syntax for a batch \fIjob_identifier\fP (see \fIBatch Job Identifier\fP
  44 ).
  45 .SH STDIN
  46 .LP
  47 Not used.
  48 .SH INPUT FILES
  49 .LP
  50 None.
  51 .SH ENVIRONMENT VARIABLES
  52 .LP
  53 The following environment variables shall affect the execution of
  54 \fIqdel\fP:
  55 .TP 7
  56 \fILANG\fP
  57 Provide a default value for the internationalization variables that
  58 are unset or null. (See the Base Definitions volume of
  59 IEEE\ Std\ 1003.1-2001, Section 8.2, Internationalization Variables
  60 for
  61 the precedence of internationalization variables used to determine
  62 the values of locale categories.)
  63 .TP 7
  64 \fILC_ALL\fP
  65 If set to a non-empty string value, override the values of all the
  66 other internationalization variables.
  67 .TP 7
  68 \fILC_CTYPE\fP
  69 Determine the locale for the interpretation of sequences of bytes
  70 of text data as characters (for example, single-byte as
  71 opposed to multi-byte characters in arguments).
  72 .TP 7
  73 \fILC_MESSAGES\fP
  74 Determine the locale that should be used to affect the format and
  75 contents of diagnostic messages written to standard
  76 error.
  77 .TP 7
  78 \fILOGNAME\fP
  79 Determine the login name of the user.
  80 .sp
  81 .SH ASYNCHRONOUS EVENTS
  82 .LP
  83 Default.
  84 .SH STDOUT
  85 .LP
  86 An implementation of the \fIqdel\fP utility may write informative
  87 messages to standard output.
  88 .SH STDERR
  89 .LP
  90 The standard error shall be used only for diagnostic messages.
  91 .SH OUTPUT FILES
  92 .LP
  93 None.
  94 .SH EXTENDED DESCRIPTION
  95 .LP
  96 None.
  97 .SH EXIT STATUS
  98 .LP
  99 The following exit values shall be returned:
 100 .TP 7
 101 \ 0
 102 Successful completion.
 103 .TP 7
 104 >0
 105 An error occurred.
 106 .sp
 107 .SH CONSEQUENCES OF ERRORS
 108 .LP
 109 In addition to the default behavior, the \fIqdel\fP utility shall
 110 not be required to write a diagnostic message to standard
 111 error when the error reply received from a batch server indicates
 112 that the batch \fIjob_identifier\fP does not exist on the
 113 server. Whether or not the \fIqdel\fP utility waits to output the
 114 diagnostic message while attempting to locate the job on other
 115 servers is implementation-defined.
 116 .LP
 117 \fIThe following sections are informative.\fP
 118 .SH APPLICATION USAGE
 119 .LP
 120 None.
 121 .SH EXAMPLES
 122 .LP
 123 None.
 124 .SH RATIONALE
 125 .LP
 126 The \fIqdel\fP utility allows users and administrators to delete jobs.
 127 .LP
 128 The \fIqdel\fP utility provides functionality that is not otherwise
 129 available. For example, the \fIkill\fP utility of the operating system
 130 does not suffice. First, to use the \fIkill\fP utility, the user might
 131 have to log in on a remote node, because the \fIkill\fP utility does
 132 not operate across the network. Second, unlike \fIqdel\fP, \fIkill\fP
 133 cannot remove jobs from queues. Lastly, the arguments of the \fIqdel\fP
 134 utility are job
 135 identifiers rather than process identifiers, and so this utility can
 136 be passed the output of the \fIqselect\fP utility, thus providing
 137 users with a means of deleting a list of jobs.
 138 .LP
 139 Because a set of jobs can be selected using the \fIqselect\fP utility,
 140 the \fIqdel\fP
 141 utility has not been complicated with options that provide for selection
 142 of jobs. Instead, the batch jobs to be deleted are
 143 identified individually by their job identifiers.
 144 .LP
 145 Historically, the \fIqdel\fP utility has been a component of NQS,
 146 the existing practice on which it is based. However, the
 147 \fIqdel\fP utility defined in this volume of IEEE\ Std\ 1003.1-2001
 148 does not provide an option for specifying a signal
 149 number to send to the batch job prior to the killing of the process;
 150 that capability has been subsumed by the \fIqsig\fP utility.
 151 .LP
 152 A discussion was held about the delays of networking and the possibility
 153 that the batch server may never respond, due to a down
 154 router, down batch server, or other network mishap. The DESCRIPTION
 155 records this under the words "fails to process any job
 156 identifier". In the broad sense, the network problem is also an error,
 157 which causes the failure to process the batch job
 158 identifier.
 159 .SH FUTURE DIRECTIONS
 160 .LP
 161 None.
 162 .SH SEE ALSO
 163 .LP
 164 \fIBatch Environment Services\fP , \fIkill\fP() , \fIqselect\fP ,
 165 \fIqsig\fP
 166 .SH COPYRIGHT
 167 Portions of this text are reprinted and reproduced in electronic form
 168 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
 169 -- Portable Operating System Interface (POSIX), The Open Group Base
 170 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
 171 Electrical and Electronics Engineers, Inc and The Open Group. In the
 172 event of any discrepancy between this version and the original IEEE and
 173 The Open Group Standard, the original IEEE and The Open Group Standard
 174 is the referee document. The original Standard can be obtained online at
 175 http://www.opengroup.org/unix/online.html .