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

qstat.1p (11077B)

    

  1. '\" et
  2. .TH QSTAT "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. qstat
  12. \(em show status of batch jobs
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. qstat \fB[\fR-f\fB] \fIjob_identifier\fR...
  17. .P
  18. qstat -Q \fB[\fR-f\fB] \fIdestination\fR...
  19. .P
  20. qstat -B \fB[\fR-f\fB] \fIserver_name\fR...
  21. .fi
  22. .SH DESCRIPTION
  23. The status of a batch job, batch queue, or batch server is obtained by
  24. a request to the server. The
  25. .IR qstat
  26. utility is a user-accessible batch client that requests the status of
  27. one or more batch jobs, batch queues, or servers, and writes the status
  28. information to standard output.
  29. .P
  30. For each successfully processed batch
  31. .IR job_identifier ,
  32. the
  33. .IR qstat
  34. utility shall display information about the corresponding batch job.
  35. .P
  36. For each successfully processed destination, the
  37. .IR qstat
  38. utility shall display information about the corresponding batch queue.
  39. .P
  40. For each successfully processed server name, the
  41. .IR qstat
  42. utility shall display information about the corresponding server.
  43. .P
  44. The
  45. .IR qstat
  46. utility shall acquire batch job status information by sending a
  47. .IR "Job Status Request"
  48. to a batch server. The
  49. .IR qstat
  50. utility shall acquire batch queue status information by sending a
  51. .IR "Queue Status Request"
  52. to a batch server. The
  53. .IR qstat
  54. utility shall acquire server status information by sending a
  55. .IR "Server Status Request"
  56. to a batch server.
  57. .SH OPTIONS
  58. The
  59. .IR qstat
  60. utility shall conform to the Base Definitions volume of POSIX.1\(hy2017,
  61. .IR "Section 12.2" ", " "Utility Syntax Guidelines".
  62. .P
  63. The following options shall be supported by the implementation:
  64. .IP "\fB\-f\fR" 10
  65. Specify that a full display is produced.
  66. .RS 10 
  67. .P
  68. The minimum contents of a full display are specified in the STDOUT
  69. section.
  70. .P
  71. Additional contents and format of a full display are
  72. implementation-defined.
  73. .RE
  74. .IP "\fB\-Q\fR" 10
  75. Specify that the operand is a destination.
  76. .RS 10 
  77. .P
  78. The
  79. .IR qstat
  80. utility shall display information about each batch queue at each
  81. destination identified as an operand.
  82. .RE
  83. .IP "\fB\-B\fR" 10
  84. Specify that the operand is a server name.
  85. .RS 10 
  86. .P
  87. The
  88. .IR qstat
  89. utility shall display information about each server identified as an
  90. operand.
  91. .RE
  92. .SH OPERANDS
  93. If the
  94. .BR \-Q
  95. option is presented to the
  96. .IR qstat
  97. utility, the utility shall accept one or more operands that conform to
  98. the syntax for a destination (see
  99. .IR "Section 3.3.2" ", " "Destination").
  100. .P
  101. If the
  102. .BR \-B
  103. option is presented to the
  104. .IR qstat
  105. utility, the utility shall accept one or more
  106. .IR server_name
  107. operands.
  108. .P
  109. If neither the
  110. .BR \-B
  111. nor the
  112. .BR \-Q
  113. option is presented to the
  114. .IR qstat
  115. utility, the utility shall accept one or more operands that conform to
  116. the syntax for a batch
  117. .IR job_identifier
  118. (see
  119. .IR "Section 3.3.1" ", " "Batch Job Identifier").
  120. .SH STDIN
  121. Not used.
  122. .SH "INPUT FILES"
  123. None.
  124. .SH "ENVIRONMENT VARIABLES"
  125. The following environment variables shall affect the execution of
  126. .IR qstat :
  127. .IP "\fIHOME\fP" 10
  128. Determine the pathname of the user's home directory.
  129. .IP "\fILANG\fP" 10
  130. Provide a default value for the internationalization variables that are
  131. unset or null. (See the Base Definitions volume of POSIX.1\(hy2017,
  132. .IR "Section 8.2" ", " "Internationalization Variables"
  133. the precedence of internationalization variables used to determine the
  134. values of locale categories.)
  135. .IP "\fILC_ALL\fP" 10
  136. If set to a non-empty string value, override the values of all the
  137. other internationalization variables.
  138. .IP "\fILC_COLLATE\fP" 10
  139. .br
  140. Determine the locale for the behavior of ranges, equivalence classes,
  141. and multi-character collating elements within regular expressions.
  142. .IP "\fILC_CTYPE\fP" 10
  143. Determine the locale for the interpretation of sequences of bytes of
  144. text data as characters (for example, single-byte as opposed to
  145. multi-byte characters in arguments).
  146. .IP "\fILC_MESSAGES\fP" 10
  147. .br
  148. Determine the locale that should be used to affect the format and
  149. contents of diagnostic messages written to standard error.
  150. .IP "\fILC_NUMERIC\fP" 10
  151. .br
  152. Determine the locale for selecting the radix character used when
  153. writing floating-point formatted output.
  154. .SH "ASYNCHRONOUS EVENTS"
  155. Default.
  156. .SH STDOUT
  157. If an operand presented to the
  158. .IR qstat
  159. utility is a batch
  160. .IR job_identifier
  161. and the
  162. .BR \-f
  163. option is not specified, the
  164. .IR qstat
  165. utility shall display the following items on a single line, in the
  166. stated order, with white space between each item, for each successfully
  167. processed operand:
  168. .IP " *" 4
  169. The batch
  170. .IR job_identifier
  171. .IP " *" 4
  172. The batch job name
  173. .IP " *" 4
  174. The
  175. .IR Job_Owner
  176. attribute
  177. .IP " *" 4
  178. The CPU time used by the batch job
  179. .IP " *" 4
  180. The batch job state
  181. .IP " *" 4
  182. The batch job location
  183. .P
  184. If an operand presented to the
  185. .IR qstat
  186. utility is a batch
  187. .IR job_identifier
  188. and the
  189. .BR \-f
  190. option is specified, the
  191. .IR qstat
  192. utility shall display the following items for each success fully
  193. processed operand:
  194. .IP " *" 4
  195. The batch
  196. .IR job_identifier
  197. .IP " *" 4
  198. The batch job name
  199. .IP " *" 4
  200. The
  201. .IR Job_Owner
  202. attribute
  203. .IP " *" 4
  204. The execution user ID
  205. .IP " *" 4
  206. The CPU time used by the batch job
  207. .IP " *" 4
  208. The batch job state
  209. .IP " *" 4
  210. The batch job location
  211. .IP " *" 4
  212. Additional implementation-defined information, if any, about the
  213. batch job or batch queue
  214. .P
  215. If an operand presented to the
  216. .IR qstat
  217. utility is a destination, the
  218. .BR \-Q
  219. option is specified, and the
  220. .BR \-f
  221. option is not specified, the
  222. .IR qstat
  223. utility shall display the following items on a single line, in the
  224. stated order, with white space between each item, for each successfully
  225. processed operand:
  226. .IP " *" 4
  227. The batch queue name
  228. .IP " *" 4
  229. The maximum number of batch jobs that shall be run in the batch
  230. queue concurrently
  231. .IP " *" 4
  232. The total number of batch jobs in the batch queue
  233. .IP " *" 4
  234. The status of the batch queue
  235. .IP " *" 4
  236. For each state, the number of batch jobs in that state in the batch
  237. queue and the name of the state
  238. .IP " *" 4
  239. The type of batch queue (execution or routing)
  240. .P
  241. If the operands presented to the
  242. .IR qstat
  243. utility are destinations, the
  244. .BR \-Q
  245. option is specified, and the
  246. .BR \-f
  247. option is specified, the
  248. .IR qstat
  249. utility shall display the following items for each successfully
  250. processed operand:
  251. .IP " *" 4
  252. The batch queue name
  253. .IP " *" 4
  254. The maximum number of batch jobs that shall be run in the batch
  255. queue concurrently
  256. .IP " *" 4
  257. The total number of batch jobs in the batch queue
  258. .IP " *" 4
  259. The status of the batch queue
  260. .IP " *" 4
  261. For each state, the number of batch jobs in that state in the batch
  262. queue and the name of the state
  263. .IP " *" 4
  264. The type of batch queue (execution or routing)
  265. .IP " *" 4
  266. Additional implementation-defined information, if any, about
  267. the batch queue
  268. .P
  269. If the operands presented to the
  270. .IR qstat
  271. utility are batch server names, the
  272. .BR \-B
  273. option is specified, and the
  274. .BR \-f
  275. option is not specified, the
  276. .IR qstat
  277. utility shall display the following items on a single line, in the
  278. stated order, with white space between each item, for each successfully
  279. processed operand:
  280. .IP " *" 4
  281. The batch server name
  282. .IP " *" 4
  283. The maximum number of batch jobs that shall be run in the batch
  284. queue concurrently
  285. .IP " *" 4
  286. The total number of batch jobs managed by the batch server
  287. .IP " *" 4
  288. The status of the batch server
  289. .IP " *" 4
  290. For each state, the number of batch jobs in that state and the name of
  291. the state
  292. .P
  293. If the operands presented to the
  294. .IR qstat
  295. utility are server names, the
  296. .BR \-B
  297. option is specified, and the
  298. .BR \-f
  299. option is specified, the
  300. .IR qstat
  301. utility shall display the following items for each successfully
  302. processed operand:
  303. .IP " *" 4
  304. The server name
  305. .IP " *" 4
  306. The maximum number of batch jobs that shall be run in the batch
  307. queue concurrently
  308. .IP " *" 4
  309. The total number of batch jobs managed by the server
  310. .IP " *" 4
  311. The status of the server
  312. .IP " *" 4
  313. For each state, the number of batch jobs in that state and the name of
  314. the state
  315. .IP " *" 4
  316. Additional implementation-defined information, if any, about the server
  317. .SH STDERR
  318. The standard error shall be used only for diagnostic messages.
  319. .SH "OUTPUT FILES"
  320. None.
  321. .SH "EXTENDED DESCRIPTION"
  322. None.
  323. .SH "EXIT STATUS"
  324. The following exit values shall be returned:
  325. .IP "\00" 6
  326. Successful completion.
  327. .IP >0 6
  328. An error occurred.
  329. .SH "CONSEQUENCES OF ERRORS"
  330. In addition to the default behavior, the
  331. .IR qstat
  332. utility shall not be required to write a diagnostic message to standard
  333. error when the error reply received from a batch server indicates that
  334. the batch
  335. .IR job_identifier
  336. does not exist on the server. Whether or not the
  337. .IR qstat
  338. utility waits to output the diagnostic message while attempting to
  339. locate the batch job on other servers is implementation-defined.
  340. .LP
  341. .IR "The following sections are informative."
  342. .SH "APPLICATION USAGE"
  343. None.
  344. .SH EXAMPLES
  345. None.
  346. .SH RATIONALE
  347. The
  348. .IR qstat
  349. utility allows users to display the status of jobs and list the
  350. batch jobs in queues.
  351. .P
  352. The operands of the
  353. .IR qstat
  354. utility may be either job identifiers, queues (specified as destination
  355. identifiers), or batch server names. The
  356. .BR \-Q
  357. and
  358. .BR \-B
  359. options, or absence thereof, indicate the nature of the operands.
  360. .P
  361. The other options of the
  362. .IR qstat
  363. utility allow the user to control the amount of information displayed
  364. and the format in which it is displayed. Should a user wish to display
  365. the status of a set of jobs that match a selection criteria, the
  366. .IR qselect
  367. utility may be used to acquire such a list.
  368. .P
  369. The
  370. .BR \-f
  371. option allows users to request a ``full'' display in an
  372. implementation-defined format.
  373. .P
  374. Historically, the
  375. .IR qstat
  376. utility has been a part of the NQS and its derivatives, the existing
  377. practice on which it is based.
  378. .SH "FUTURE DIRECTIONS"
  379. The
  380. .IR qstat
  381. utility may be removed in a future version.
  382. .SH "SEE ALSO"
  383. .IR "Chapter 3" ", " "Batch Environment Services",
  384. .IR "\fIqselect\fR\^"
  385. .P
  386. The Base Definitions volume of POSIX.1\(hy2017,
  387. .IR "Chapter 8" ", " "Environment Variables",
  388. .IR "Section 12.2" ", " "Utility Syntax Guidelines"
  389. .\"
  390. .SH COPYRIGHT
  391. Portions of this text are reprinted and reproduced in electronic form
  392. from IEEE Std 1003.1-2017, Standard for Information Technology
  393. -- Portable Operating System Interface (POSIX), The Open Group Base
  394. Specifications Issue 7, 2018 Edition,
  395. Copyright (C) 2018 by the Institute of
  396. Electrical and Electronics Engineers, Inc and The Open Group.
  397. In the event of any discrepancy between this version and the original IEEE and
  398. The Open Group Standard, the original IEEE and The Open Group Standard
  399. is the referee document. The original Standard can be obtained online at
  400. http://www.opengroup.org/unix/online.html .
  401. .PP
  402. Any typographical or formatting errors that appear
  403. in this page are most likely
  404. to have been introduced during the conversion of the source files to
  405. man page format. To report such errors, see
  406. https://www.kernel.org/doc/man-pages/reporting_bugs.html .