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
13 qhold — hold batch jobs
14
16 qhold [−h hold_list] job_identifier...
17
19 A hold is placed on a batch job by a request to the batch server that
20 manages the batch job. A batch job that has one or more holds is not
21 eligible for execution. The qhold utility is a user-accessible client
22 of batch services that requests one or more types of hold to be placed
23 on one or more batch jobs.
24 The qhold utility shall place holds on those batch jobs for which a
26 batch job_identifier is presented to the utility.
27 The qhold utility shall place holds on batch jobs in the order in which
29 their batch job_identifiers are presented to the utility. If the qhold
30 utility fails to process any batch job_identifier successfully, the
31 utility shall proceed to process the remaining batch job_identifiers,
32 if any.
33 The qhold utility shall place holds on each batch job by sending a Hold
35 Job Request to the batch server that manages the batch job.
36 The qhold utility shall not exit until holds have been placed on the
38 batch job corresponding to each successfully processed batch job_iden‐
39 tifier.
40
42 The qhold utility shall conform to the Base Definitions volume of
43 POSIX.1‐2008, Section 12.2, Utility Syntax Guidelines.
44 The following option shall be supported by the implementation:
46 −h hold_list
48 Define the types of holds to be placed on the batch job.
49 The qhold −h option shall accept a value for the hold_list
51 option-argument that is a string of alphanumeric characters
52 in the portable character set (see the Base Definitions vol‐
53 ume of POSIX.1‐2008, Section 6.1, Portable Character Set).
54 The qhold utility shall accept a value for the hold_list
56 option-argument that is a string of one or more of the char‐
57 acters 'u', 's', or 'o', or the single character 'n'.
58 For each unique character in the hold_list option-argument,
60 the qhold utility shall add a value to the Hold_Types
61 attribute of the batch job as follows, each representing a
62 different hold type:
63 u USER
65 s SYSTEM
67 o OPERATOR
69 If any of these characters are duplicated in the hold_list
71 option-argument, the duplicates shall be ignored.
72 An existing Hold_Types attribute can be cleared by the fol‐
74 lowing hold type:
75 n NO_HOLD
77 The qhold utility shall consider it an error if any hold type
79 other than 'n' is combined with hold type 'n'.
80 Strictly conforming applications shall not repeat any of the
82 characters 'u', 's', 'o', or 'n' within the hold_list option-
83 argument. The qhold utility shall permit the repetition of
84 characters, but shall not assign additional meaning to the
85 repeated characters.
86 An implementation may define other hold types. The confor‐
88 mance document for an implementation shall describe any addi‐
89 tional hold types, how they are specified, their internal
90 behavior, and how they affect the behavior of the utility.
91 If the −h option is not presented to the qhold utility, the
93 implementation shall set the Hold_Types attribute to USER.
94
96 The qhold utility shall accept one or more operands that conform to the
97 syntax for a batch job_identifier (see Section 3.3.1, Batch Job Identi‐
98 fier).
99
101 Not used.
102
104 None.
105
107 The following environment variables shall affect the execution of
108 qhold:
109 LANG Provide a default value for the internationalization vari‐
111 ables that are unset or null. (See the Base Definitions vol‐
112 ume of POSIX.1‐2008, Section 8.2, Internationalization Vari‐
113 ables the precedence of internationalization variables used
114 to determine the values of locale categories.)
115 LC_ALL If set to a non-empty string value, override the values of
117 all the other internationalization variables.
118 LC_CTYPE Determine the locale for the interpretation of sequences of
120 bytes of text data as characters (for example, single-byte as
121 opposed to multi-byte characters in arguments).
122 LC_MESSAGES
124 Determine the locale that should be used to affect the format
125 and contents of diagnostic messages written to standard
126 error.
127 LOGNAME Determine the login name of the user.
129
131 Default.
132
134 None.
135
137 The standard error shall be used only for diagnostic messages.
138
140 None.
141
143 None.
144
146 The following exit values shall be returned:
147 0 Successful completion.
149 >0 An error occurred.
151
153 In addition to the default behavior, the qhold utility shall not be
154 required to write a diagnostic message to standard error when the error
155 reply received from a batch server indicates that the batch job_identi‐
156 fier does not exist on the server. Whether or not the qhold utility
157 waits to output the diagnostic message while attempting to locate the
158 job on other servers is implementation-defined.
159 The following sections are informative.
161
163 None.
164
166 None.
167
169 The qhold utility allows users to place a hold on one or more jobs. A
170 hold makes a batch job ineligible for execution.
171 The qhold utility has options that allow the user to specify the type
173 of hold. Should the user wish to place a hold on a set of jobs that
174 meet a selection criteria, such a list of jobs can be acquired using
175 the qselect utility.
176 The −h option allows the user to specify the type of hold that is to be
178 placed on the job. This option allows for USER, SYSTEM, OPERATOR, and
179 implementation-defined hold types. The USER and OPERATOR holds are dis‐
180 tinct. The batch server that manages the batch job will verify that the
181 user is authorized to set the specified hold for the batch job.
182 Mail is not required on hold because the administrator has the tools
184 and libraries to build this option if he or she wishes.
185 Historically, the qhold utility has been a part of some existing batch
187 systems, although it has not traditionally been a part of the NQS.
188
190 The qhold utility may be removed in a future version.
191
193 Chapter 3, Batch Environment Services, qselect
194 The Base Definitions volume of POSIX.1‐2008, Section 6.1, Portable
196 Character Set, Chapter 8, Environment Variables, Section 12.2, Utility
197 Syntax Guidelines
198
200 Portions of this text are reprinted and reproduced in electronic form
201 from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
202 -- Portable Operating System Interface (POSIX), The Open Group Base
203 Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
204 cal and Electronics Engineers, Inc and The Open Group. (This is
205 POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
206 event of any discrepancy between this version and the original IEEE and
207 The Open Group Standard, the original IEEE and The Open Group Standard
208 is the referee document. The original Standard can be obtained online
209 at http://www.unix.org/online.html .
210 Any typographical or formatting errors that appear in this page are
212 most likely to have been introduced during the conversion of the source
213 files to man page format. To report such errors, see https://www.ker‐
214 nel.org/doc/man-pages/reporting_bugs.html .
215IEEE/The Open Group 2013 QHOLD(1P)