1QHOLD(1P) POSIX Programmer's Manual QHOLD(1P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
12 qhold - hold batch jobs
13
15 qhold [-h hold_list] job_identifier ...
16
18 A hold is placed on a batch job by a request to the batch server that
19 manages the batch job. A batch job that has one or more holds is not
20 eligible for execution. The qhold utility is a user-accessible client
21 of batch services that requests one or more types of hold to be placed
22 on one or more batch jobs.
23 The qhold utility shall place holds on those batch jobs for which a
25 batch job_identifier is presented to the utility.
26 The qhold utility shall place holds on batch jobs in the order in which
28 their batch job_identifiers are presented to the utility. If the qhold
29 utility fails to process any batch job_identifier successfully, the
30 utility shall proceed to process the remaining batch job_identifiers,
31 if any.
32 The qhold utility shall place holds on each batch job by sending a Hold
34 Job Request to the batch server that manages the batch job.
35 The qhold utility shall not exit until holds have been placed on the
37 batch job corresponding to each successfully processed batch job_iden‐
38 tifier.
39
41 The qhold utility shall conform to the Base Definitions volume of
42 IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines.
43 The following option shall be supported by the implementation:
45 -h hold_list
47 Define the types of holds to be placed on the batch job.
48 The qhold -h option shall accept a value for the hold_list option-argu‐
50 ment that is a string of alphanumeric characters in the portable char‐
51 acter set (see the Base Definitions volume of IEEE Std 1003.1-2001,
52 Section 6.1, Portable Character Set).
53 The qhold utility shall accept a value for the hold_list option-argu‐
55 ment that is a string of one or more of the characters 'u', 's', or
56 'o', or the single character 'n' .
57 For each unique character in the hold_list option-argument, the qhold
59 utility shall add a value to the Hold_Types attribute of the batch job
60 as follows, each representing a different hold type:
61 u
63 USER
64 s
66 SYSTEM
67 o
69 OPERATOR
70 If any of these characters are duplicated in the hold_list option-argu‐
73 ment, the duplicates shall be ignored.
74 An existing Hold_Types attribute can be cleared by the following hold
76 type:
77 n
79 NO_HOLD
80 The qhold utility shall consider it an error if any hold type other
83 than 'n' is combined with hold type 'n' .
84 Strictly conforming applications shall not repeat any of the characters
86 'u', 's', 'o', or 'n' within the hold_list option-argument. The qhold
87 utility shall permit the repetition of characters, but shall not assign
88 additional meaning to the repeated characters.
89 An implementation may define other hold types. The conformance document
91 for an implementation shall describe any additional hold types, how
92 they are specified, their internal behavior, and how they affect the
93 behavior of the utility.
94 If the -h option is not presented to the qhold utility, the implementa‐
96 tion shall set the Hold_Types attribute to USER.
97
100 The qhold utility shall accept one or more operands that conform to the
101 syntax for a batch job_identifier (see Batch Job Identifier ).
102
104 Not used.
105
107 None.
108
110 The following environment variables shall affect the execution of
111 qhold:
112 LANG Provide a default value for the internationalization variables
114 that are unset or null. (See the Base Definitions volume of
115 IEEE Std 1003.1-2001, Section 8.2, Internationalization Vari‐
116 ables for the precedence of internationalization variables used
117 to determine the values of locale categories.)
118 LC_ALL If set to a non-empty string value, override the values of all
120 the other internationalization variables.
121 LC_CTYPE
123 Determine the locale for the interpretation of sequences of
124 bytes of text data as characters (for example, single-byte as
125 opposed to multi-byte characters in arguments).
126 LC_MESSAGES
128 Determine the locale that should be used to affect the format
129 and contents of diagnostic messages written to standard error.
130 LOGNAME
132 Determine the login name of the user.
133
136 Default.
137
139 None.
140
142 The standard error shall be used only for diagnostic messages.
143
145 None.
146
148 None.
149
151 The following exit values shall be returned:
152 0 Successful completion.
154 >0 An error occurred.
156
159 In addition to the default behavior, the qhold utility shall not be
160 required to write a diagnostic message to standard error when the error
161 reply received from a batch server indicates that the batch job_identi‐
162 fier does not exist on the server. Whether or not the qhold utility
163 waits to output the diagnostic message while attempting to locate the
164 job on other servers is implementation-defined.
165 The following sections are informative.
167
169 None.
170
172 None.
173
175 The qhold utility allows users to place a hold on one or more jobs. A
176 hold makes a batch job ineligible for execution.
177 The qhold utility has options that allow the user to specify the type
179 of hold. Should the user wish to place a hold on a set of jobs that
180 meet a selection criteria, such a list of jobs can be acquired using
181 the qselect utility.
182 The -h option allows the user to specify the type of hold that is to be
184 placed on the job. This option allows for USER, SYSTEM, OPERATOR, and
185 implementation-defined hold types. The USER and OPERATOR holds are dis‐
186 tinct. The batch server that manages the batch job will verify that the
187 user is authorized to set the specified hold for the batch job.
188 Mail is not required on hold because the administrator has the tools
190 and libraries to build this option if he or she wishes.
191 Historically, the qhold utility has been a part of some existing batch
193 systems, although it has not traditionally been a part of the NQS.
194
196 None.
197
199 Batch Environment Services, qselect
200
202 Portions of this text are reprinted and reproduced in electronic form
203 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
204 -- Portable Operating System Interface (POSIX), The Open Group Base
205 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
206 Electrical and Electronics Engineers, Inc and The Open Group. In the
207 event of any discrepancy between this version and the original IEEE and
208 The Open Group Standard, the original IEEE and The Open Group Standard
209 is the referee document. The original Standard can be obtained online
210 at http://www.opengroup.org/unix/online.html .
211IEEE/The Open Group 2003 QHOLD(1P)