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 POSIX.1‐2017, 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
50 option-argument that is a string of alphanumeric characters
51 in the portable character set (see the Base Definitions vol‐
52 ume of POSIX.1‐2017, Section 6.1, Portable Character Set).
53 The qhold utility shall accept a value for the hold_list
55 option-argument that is a string of one or more of the char‐
56 acters 'u', 's', or 'o', or the single character 'n'.
57 For each unique character in the hold_list option-argument,
59 the qhold utility shall add a value to the Hold_Types
60 attribute of the batch job as follows, each representing a
61 different hold type:
62 u USER
64 s SYSTEM
66 o OPERATOR
68 If any of these characters are duplicated in the hold_list
70 option-argument, the duplicates shall be ignored.
71 An existing Hold_Types attribute can be cleared by the fol‐
73 lowing hold type:
74 n NO_HOLD
76 The qhold utility shall consider it an error if any hold type
78 other than 'n' is combined with hold type 'n'.
79 Strictly conforming applications shall not repeat any of the
81 characters 'u', 's', 'o', or 'n' within the hold_list option-
82 argument. The qhold utility shall permit the repetition of
83 characters, but shall not assign additional meaning to the
84 repeated characters.
85 An implementation may define other hold types. The confor‐
87 mance document for an implementation shall describe any addi‐
88 tional hold types, how they are specified, their internal
89 behavior, and how they affect the behavior of the utility.
90 If the -h option is not presented to the qhold utility, the
92 implementation shall set the Hold_Types attribute to USER.
93
95 The qhold utility shall accept one or more operands that conform to the
96 syntax for a batch job_identifier (see Section 3.3.1, Batch Job Identi‐
97 fier).
98
100 Not used.
101
103 None.
104
106 The following environment variables shall affect the execution of
107 qhold:
108 LANG Provide a default value for the internationalization vari‐
110 ables that are unset or null. (See the Base Definitions vol‐
111 ume of POSIX.1‐2017, Section 8.2, Internationalization Vari‐
112 ables the precedence of internationalization variables used
113 to determine the values of locale categories.)
114 LC_ALL If set to a non-empty string value, override the values of
116 all the other internationalization variables.
117 LC_CTYPE Determine the locale for the interpretation of sequences of
119 bytes of text data as characters (for example, single-byte as
120 opposed to multi-byte characters in arguments).
121 LC_MESSAGES
123 Determine the locale that should be used to affect the format
124 and contents of diagnostic messages written to standard
125 error.
126 LOGNAME Determine the login name of the user.
128
130 Default.
131
133 None.
134
136 The standard error shall be used only for diagnostic messages.
137
139 None.
140
142 None.
143
145 The following exit values shall be returned:
146 0 Successful completion.
148 >0 An error occurred.
150
152 In addition to the default behavior, the qhold utility shall not be
153 required to write a diagnostic message to standard error when the error
154 reply received from a batch server indicates that the batch job_identi‐
155 fier does not exist on the server. Whether or not the qhold utility
156 waits to output the diagnostic message while attempting to locate the
157 job on other servers is implementation-defined.
158 The following sections are informative.
160
162 None.
163
165 None.
166
168 The qhold utility allows users to place a hold on one or more jobs. A
169 hold makes a batch job ineligible for execution.
170 The qhold utility has options that allow the user to specify the type
172 of hold. Should the user wish to place a hold on a set of jobs that
173 meet a selection criteria, such a list of jobs can be acquired using
174 the qselect utility.
175 The -h option allows the user to specify the type of hold that is to be
177 placed on the job. This option allows for USER, SYSTEM, OPERATOR, and
178 implementation-defined hold types. The USER and OPERATOR holds are dis‐
179 tinct. The batch server that manages the batch job will verify that the
180 user is authorized to set the specified hold for the batch job.
181 Mail is not required on hold because the administrator has the tools
183 and libraries to build this option if he or she wishes.
184 Historically, the qhold utility has been a part of some existing batch
186 systems, although it has not traditionally been a part of the NQS.
187
189 The qhold utility may be removed in a future version.
190
192 Chapter 3, Batch Environment Services, qselect
193 The Base Definitions volume of POSIX.1‐2017, Section 6.1, Portable
195 Character Set, Chapter 8, Environment Variables, Section 12.2, Utility
196 Syntax Guidelines
197
199 Portions of this text are reprinted and reproduced in electronic form
200 from IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
201 table Operating System Interface (POSIX), The Open Group Base Specifi‐
202 cations Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of
203 Electrical and Electronics Engineers, Inc and The Open Group. In the
204 event of any discrepancy between this version and the original IEEE and
205 The Open Group Standard, the original IEEE and The Open Group Standard
206 is the referee document. The original Standard can be obtained online
207 at http://www.opengroup.org/unix/online.html .
208 Any typographical or formatting errors that appear in this page are
210 most likely to have been introduced during the conversion of the source
211 files to man page format. To report such errors, see https://www.ker‐
212 nel.org/doc/man-pages/reporting_bugs.html .
213IEEE/The Open Group 2017 QHOLD(1P)