1QMSG(1P) POSIX Programmer's Manual QMSG(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 qmsg — send message to batch jobs
13
15 qmsg [-EO] message_string job_identifier...
16
18 To send a message to a batch job is to request that a server write a
19 message string into one or more output files of the batch job. A mes‐
20 sage is sent to a batch job by a request to the batch server that man‐
21 ages the batch job. The qmsg utility is a user-accessible batch client
22 that requests the sending of messages to one or more batch jobs.
23 The qmsg utility shall write messages into the files of batch jobs by
25 sending a Job Message Request to the batch server that manages the
26 batch job. The qmsg utility shall not directly write the message into
27 the files of the batch job.
28 The qmsg utility shall send a Job Message Request for those batch jobs,
30 and only those batch jobs, for which a batch job_identifier is pre‐
31 sented to the utility.
32 The qmsg utility shall send Job Message Requests for batch jobs in the
34 order in which their batch job_identifiers are presented to the util‐
35 ity.
36 If the qmsg utility fails to process any batch job_identifier success‐
38 fully, the utility shall proceed to process the remaining batch
39 job_identifiers, if any.
40 The qmsg utility shall not exit before a Job Message Request has been
42 sent to the server that manages the batch job that corresponds to each
43 successfully processed batch job_identifier.
44
46 The qmsg utility shall conform to the Base Definitions volume of
47 POSIX.1‐2017, Section 12.2, Utility Syntax Guidelines.
48 The following options shall be supported by the implementation:
50 -E Specify that the message is written to the standard error of
52 each batch job.
53 The qmsg utility shall write the message into the standard
55 error of the batch job.
56 -O Specify that the message is written to the standard output of
58 each batch job.
59 The qmsg utility shall write the message into the standard
61 output of the batch job.
62 If neither the -O nor the -E option is presented to the qmsg utility,
64 the utility shall write the message into an implementation-defined
65 file. The conformance document for the implementation shall describe
66 the name and location of the implementation-defined file. If both the
67 -O and the -E options are presented to the qmsg utility, then the util‐
68 ity shall write the messages to both standard output and standard
69 error.
70
72 The qmsg utility shall accept a minimum of two operands, message_string
73 and one or more batch job_identifiers.
74 The message_string operand shall be the string to be written to one or
76 more output files of the batch job followed by a <newline>. If the
77 string contains <blank> characters, then the application shall ensure
78 that the string is quoted. The message_string shall be encoded in the
79 portable character set (see the Base Definitions volume of
80 POSIX.1‐2017, Section 6.1, Portable Character Set).
81 All remaining operands are batch job_identifiers that conform to the
83 syntax for a batch job_identifier (see Section 3.3.1, Batch Job Identi‐
84 fier).
85
87 Not used.
88
90 None.
91
93 The following environment variables shall affect the execution of qmsg:
94 LANG Provide a default value for the internationalization vari‐
96 ables that are unset or null. (See the Base Definitions vol‐
97 ume of POSIX.1‐2017, Section 8.2, Internationalization Vari‐
98 ables the precedence of internationalization variables used
99 to determine the values of locale categories.)
100 LC_ALL If set to a non-empty string value, override the values of
102 all the other internationalization variables.
103 LC_CTYPE Determine the locale for the interpretation of sequences of
105 bytes of text data as characters (for example, single-byte as
106 opposed to multi-byte characters in arguments).
107 LC_MESSAGES
109 Determine the locale that should be used to affect the format
110 and contents of diagnostic messages written to standard
111 error.
112 LOGNAME Determine the login name of the user.
114
116 Default.
117
119 None.
120
122 The standard error shall be used only for diagnostic messages.
123
125 None.
126
128 None.
129
131 The following exit values shall be returned:
132 0 Successful completion.
134 >0 An error occurred.
136
138 In addition to the default behavior, the qmsg utility shall not be
139 required to write a diagnostic message to standard error when the error
140 reply received from a batch server indicates that the batch job_identi‐
141 fier does not exist on the server. Whether or not the qmsg utility
142 waits to output the diagnostic message while attempting to locate the
143 job on other servers is implementation-defined.
144 The following sections are informative.
146
148 None.
149
151 None.
152
154 The qmsg utility allows users to write messages into the output files
155 of running jobs. Users, including operators and administrators, have a
156 number of occasions when they want to place messages in the output
157 files of a batch job. For example, if a disk that is being used by a
158 batch job is showing errors, the operator might note this in the stan‐
159 dard error stream of the batch job.
160 The options of the qmsg utility provide users with the means of placing
162 the message in the output stream of their choice. The default output
163 stream for the message—if the user does not designate an output stream—
164 is implementation-defined, since many implementations will provide, as
165 an extension to this volume of POSIX.1‐2017, a log file that shows the
166 history of utility execution.
167 If users wish to send a message to a set of jobs that meet a selection
169 criteria, the qselect utility can be used to acquire the appropriate
170 list of job identifiers.
171 The -E option allows users to place the message in the standard error
173 stream of the batch job.
174 The -O option allows users to place the message in the standard output
176 stream of the batch job.
177 Historically, the qmsg utility is an existing practice in the offerings
179 of one or more implementors of an NQS-derived batch system. The utility
180 has been found to be useful enough that it deserves to be included in
181 this volume of POSIX.1‐2017.
182
184 The qmsg utility may be removed in a future version.
185
187 Chapter 3, Batch Environment Services, qselect
188 The Base Definitions volume of POSIX.1‐2017, Section 6.1, Portable
190 Character Set, Chapter 8, Environment Variables, Section 12.2, Utility
191 Syntax Guidelines
192
194 Portions of this text are reprinted and reproduced in electronic form
195 from IEEE Std 1003.1-2017, Standard for Information Technology -- Por‐
196 table Operating System Interface (POSIX), The Open Group Base Specifi‐
197 cations Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of
198 Electrical and Electronics Engineers, Inc and The Open Group. In the
199 event of any discrepancy between this version and the original IEEE and
200 The Open Group Standard, the original IEEE and The Open Group Standard
201 is the referee document. The original Standard can be obtained online
202 at http://www.opengroup.org/unix/online.html .
203 Any typographical or formatting errors that appear in this page are
205 most likely to have been introduced during the conversion of the source
206 files to man page format. To report such errors, see https://www.ker‐
207 nel.org/doc/man-pages/reporting_bugs.html .
208IEEE/The Open Group 2017 QMSG(1P)