logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

qhold.1p (7898B)


  1. '\" et
  2. .TH QHOLD "1P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. qhold
  12. \(em hold batch jobs
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. qhold \fB[\fR-h \fIhold_list\fB] \fIjob_identifier\fR...
  17. .fi
  18. .SH DESCRIPTION
  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
  22. .IR qhold
  23. utility is a user-accessible client of batch services that requests one
  24. or more types of hold to be placed on one or more batch jobs.
  25. .P
  26. The
  27. .IR qhold
  28. utility shall place holds on those batch jobs for which a batch
  29. .IR job_identifier
  30. is presented to the utility.
  31. .P
  32. The
  33. .IR qhold
  34. utility shall place holds on batch jobs in the order in which their
  35. batch
  36. .IR job_identifier s
  37. are presented to the utility. If the
  38. .IR qhold
  39. utility fails to process any batch
  40. .IR job_identifier
  41. successfully, the utility shall proceed to process the remaining batch
  42. .IR job_identifier s,
  43. if any.
  44. .P
  45. The
  46. .IR qhold
  47. utility shall place holds on each batch job by sending a
  48. .IR "Hold Job Request"
  49. to the batch server that manages the batch job.
  50. .P
  51. The
  52. .IR qhold
  53. utility shall not exit until holds have been placed on the batch job
  54. corresponding to each successfully processed batch
  55. .IR job_identifier .
  56. .SH OPTIONS
  57. The
  58. .IR qhold
  59. utility shall conform to the Base Definitions volume of POSIX.1\(hy2017,
  60. .IR "Section 12.2" ", " "Utility Syntax Guidelines".
  61. .P
  62. The following option shall be supported by the implementation:
  63. .IP "\fB\-h\ \fIhold_list\fR" 10
  64. Define the types of holds to be placed on the batch job.
  65. .RS 10
  66. .P
  67. The
  68. .IR qhold
  69. .BR \-h
  70. option shall accept a value for the
  71. .IR hold_list
  72. option-argument that is a string of alphanumeric characters in the
  73. portable character set (see the Base Definitions volume of POSIX.1\(hy2017,
  74. .IR "Section 6.1" ", " "Portable Character Set").
  75. .P
  76. The
  77. .IR qhold
  78. utility shall accept a value for the
  79. .IR hold_list
  80. option-argument that is a string of one or more of the characters
  81. .BR 'u' ,
  82. .BR 's' ,
  83. or
  84. .BR 'o' ,
  85. or the single character
  86. .BR 'n' .
  87. .P
  88. For each unique character in the
  89. .IR hold_list
  90. option-argument, the
  91. .IR qhold
  92. utility shall add a value to the
  93. .IR Hold_Types
  94. attribute of the batch job as follows, each representing a different
  95. hold type:
  96. .IP "\fRu\fP" 6
  97. USER
  98. .IP "\fRs\fP" 6
  99. SYSTEM
  100. .IP "\fRo\fP" 6
  101. OPERATOR
  102. .P
  103. If any of these characters are duplicated in the
  104. .IR hold_list
  105. option-argument, the duplicates shall be ignored.
  106. .P
  107. An existing
  108. .IR Hold_Types
  109. attribute can be cleared by the following hold type:
  110. .IP "\fRn\fP" 6
  111. NO_HOLD
  112. .P
  113. The
  114. .IR qhold
  115. utility shall consider it an error if any hold type other than
  116. .BR 'n'
  117. is combined with hold type
  118. .BR 'n' .
  119. .P
  120. Strictly conforming applications shall not repeat any of the characters
  121. .BR 'u' ,
  122. .BR 's' ,
  123. .BR 'o' ,
  124. or
  125. .BR 'n'
  126. within the
  127. .IR hold_list
  128. option-argument. The
  129. .IR qhold
  130. utility shall permit the repetition of characters, but shall not assign
  131. additional meaning to the repeated characters.
  132. .P
  133. An implementation may define other hold types. The conformance document
  134. for an implementation shall describe any additional hold types, how
  135. they are specified, their internal behavior, and how they affect the
  136. behavior of the utility.
  137. .P
  138. If the
  139. .BR \-h
  140. option is not presented to the
  141. .IR qhold
  142. utility, the implementation shall set the
  143. .IR Hold_Types
  144. attribute to USER.
  145. .RE
  146. .SH OPERANDS
  147. The
  148. .IR qhold
  149. utility shall accept one or more operands that conform to the syntax
  150. for a batch
  151. .IR job_identifier
  152. (see
  153. .IR "Section 3.3.1" ", " "Batch Job Identifier").
  154. .SH STDIN
  155. Not used.
  156. .SH "INPUT FILES"
  157. None.
  158. .SH "ENVIRONMENT VARIABLES"
  159. The following environment variables shall affect the execution of
  160. .IR qhold :
  161. .IP "\fILANG\fP" 10
  162. Provide a default value for the internationalization variables that are
  163. unset or null. (See the Base Definitions volume of POSIX.1\(hy2017,
  164. .IR "Section 8.2" ", " "Internationalization Variables"
  165. the precedence of internationalization variables used to determine the
  166. values of locale categories.)
  167. .IP "\fILC_ALL\fP" 10
  168. If set to a non-empty string value, override the values of all the
  169. other internationalization variables.
  170. .IP "\fILC_CTYPE\fP" 10
  171. Determine the locale for the interpretation of sequences of bytes of
  172. text data as characters (for example, single-byte as opposed to
  173. multi-byte characters in arguments).
  174. .IP "\fILC_MESSAGES\fP" 10
  175. .br
  176. Determine the locale that should be used to affect the format and
  177. contents of diagnostic messages written to standard error.
  178. .IP "\fILOGNAME\fP" 10
  179. Determine the login name of the user.
  180. .SH "ASYNCHRONOUS EVENTS"
  181. Default.
  182. .SH STDOUT
  183. None.
  184. .SH STDERR
  185. The standard error shall be used only for diagnostic messages.
  186. .SH "OUTPUT FILES"
  187. None.
  188. .SH "EXTENDED DESCRIPTION"
  189. None.
  190. .SH "EXIT STATUS"
  191. .br
  192. The following exit values shall be returned:
  193. .IP "\00" 6
  194. Successful completion.
  195. .IP >0 6
  196. An error occurred.
  197. .SH "CONSEQUENCES OF ERRORS"
  198. In addition to the default behavior, the
  199. .IR qhold
  200. utility shall not be required to write a diagnostic message to standard
  201. error when the error reply received from a batch server indicates that
  202. the batch
  203. .IR job_identifier
  204. does not exist on the server. Whether or not the
  205. .IR qhold
  206. utility waits to output the diagnostic message while attempting to
  207. locate the job on other servers is implementation-defined.
  208. .LP
  209. .IR "The following sections are informative."
  210. .SH "APPLICATION USAGE"
  211. None.
  212. .SH EXAMPLES
  213. None.
  214. .SH RATIONALE
  215. The
  216. .IR qhold
  217. utility allows users to place a hold on one or more jobs. A hold makes
  218. a batch job ineligible for execution.
  219. .P
  220. The
  221. .IR qhold
  222. utility has options that allow the user to specify the type of hold.
  223. Should the user wish to place a hold on a set of jobs that meet a
  224. selection criteria, such a list of jobs can be acquired using the
  225. .IR qselect
  226. utility.
  227. .P
  228. The
  229. .BR \-h
  230. option allows the user to specify the type of hold that is to be placed
  231. on the job. This option allows for USER, SYSTEM, OPERATOR, and
  232. implementation-defined hold types. The USER and OPERATOR holds are
  233. distinct. The batch server that manages the batch job will verify that
  234. the user is authorized to set the specified hold for the batch job.
  235. .P
  236. Mail is not required on hold because the administrator has the tools
  237. and libraries to build this option if he or she wishes.
  238. .P
  239. Historically, the
  240. .IR qhold
  241. utility has been a part of some existing batch systems, although it has
  242. not traditionally been a part of the NQS.
  243. .SH "FUTURE DIRECTIONS"
  244. The
  245. .IR qhold
  246. utility may be removed in a future version.
  247. .SH "SEE ALSO"
  248. .IR "Chapter 3" ", " "Batch Environment Services",
  249. .IR "\fIqselect\fR\^"
  250. .P
  251. The Base Definitions volume of POSIX.1\(hy2017,
  252. .IR "Section 6.1" ", " "Portable Character Set",
  253. .IR "Chapter 8" ", " "Environment Variables",
  254. .IR "Section 12.2" ", " "Utility Syntax Guidelines"
  255. .\"
  256. .SH COPYRIGHT
  257. Portions of this text are reprinted and reproduced in electronic form
  258. from IEEE Std 1003.1-2017, Standard for Information Technology
  259. -- Portable Operating System Interface (POSIX), The Open Group Base
  260. Specifications Issue 7, 2018 Edition,
  261. Copyright (C) 2018 by the Institute of
  262. Electrical and Electronics Engineers, Inc and The Open Group.
  263. In the event of any discrepancy between this version and the original IEEE and
  264. The Open Group Standard, the original IEEE and The Open Group Standard
  265. is the referee document. The original Standard can be obtained online at
  266. http://www.opengroup.org/unix/online.html .
  267. .PP
  268. Any typographical or formatting errors that appear
  269. in this page are most likely
  270. to have been introduced during the conversion of the source files to
  271. man page format. To report such errors, see
  272. https://www.kernel.org/doc/man-pages/reporting_bugs.html .