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
13 qmsg — send message to batch jobs
14
16 qmsg [−EO] message_string job_identifier...
17
19 To send a message to a batch job is to request that a server write a
20 message string into one or more output files of the batch job. A mes‐
21 sage is sent to a batch job by a request to the batch server that man‐
22 ages the batch job. The qmsg utility is a user-accessible batch client
23 that requests the sending of messages to one or more batch jobs.
24 The qmsg utility shall write messages into the files of batch jobs by
26 sending a Job Message Request to the batch server that manages the
27 batch job. The qmsg utility shall not directly write the message into
28 the files of the batch job.
29 The qmsg utility shall send a Job Message Request for those batch jobs,
31 and only those batch jobs, for which a batch job_identifier is pre‐
32 sented to the utility.
33 The qmsg utility shall send Job Message Requests for batch jobs in the
35 order in which their batch job_identifiers are presented to the util‐
36 ity.
37 If the qmsg utility fails to process any batch job_identifier success‐
39 fully, the utility shall proceed to process the remaining batch
40 job_identifiers, if any.
41 The qmsg utility shall not exit before a Job Message Request has been
43 sent to the server that manages the batch job that corresponds to each
44 successfully processed batch job_identifier.
45
47 The qmsg utility shall conform to the Base Definitions volume of
48 POSIX.1‐2008, Section 12.2, Utility Syntax Guidelines.
49 The following options shall be supported by the implementation:
51 −E Specify that the message is written to the standard error of
53 each batch job.
54 The qmsg utility shall write the message into the standard
56 error of the batch job.
57 −O Specify that the message is written to the standard output of
59 each batch job.
60 The qmsg utility shall write the message into the standard
62 output of the batch job.
63 If neither the −O nor the −E option is presented to the qmsg utility,
65 the utility shall write the message into an implementation-defined
66 file. The conformance document for the implementation shall describe
67 the name and location of the implementation-defined file. If both the
68 −O and the −E options are presented to the qmsg utility, then the util‐
69 ity shall write the messages to both standard output and standard
70 error.
71
73 The qmsg utility shall accept a minimum of two operands, message_string
74 and one or more batch job_identifiers.
75 The message_string operand shall be the string to be written to one or
77 more output files of the batch job followed by a <newline>. If the
78 string contains <blank> characters, then the application shall ensure
79 that the string is quoted. The message_string shall be encoded in the
80 portable character set (see the Base Definitions volume of
81 POSIX.1‐2008, Section 6.1, Portable Character Set).
82 All remaining operands are batch job_identifiers that conform to the
84 syntax for a batch job_identifier (see Section 3.3.1, Batch Job Identi‐
85 fier).
86
88 Not used.
89
91 None.
92
94 The following environment variables shall affect the execution of qmsg:
95 LANG Provide a default value for the internationalization vari‐
97 ables that are unset or null. (See the Base Definitions vol‐
98 ume of POSIX.1‐2008, Section 8.2, Internationalization Vari‐
99 ables the precedence of internationalization variables used
100 to determine the values of locale categories.)
101 LC_ALL If set to a non-empty string value, override the values of
103 all the other internationalization variables.
104 LC_CTYPE Determine the locale for the interpretation of sequences of
106 bytes of text data as characters (for example, single-byte as
107 opposed to multi-byte characters in arguments).
108 LC_MESSAGES
110 Determine the locale that should be used to affect the format
111 and contents of diagnostic messages written to standard
112 error.
113 LOGNAME Determine the login name of the user.
115
117 Default.
118
120 None.
121
123 The standard error shall be used only for diagnostic messages.
124
126 None.
127
129 None.
130
132 The following exit values shall be returned:
133 0 Successful completion.
135 >0 An error occurred.
137
139 In addition to the default behavior, the qmsg utility shall not be
140 required to write a diagnostic message to standard error when the error
141 reply received from a batch server indicates that the batch job_identi‐
142 fier does not exist on the server. Whether or not the qmsg utility
143 waits to output the diagnostic message while attempting to locate the
144 job on other servers is implementation-defined.
145 The following sections are informative.
147
149 None.
150
152 None.
153
155 The qmsg utility allows users to write messages into the output files
156 of running jobs. Users, including operators and administrators, have a
157 number of occasions when they want to place messages in the output
158 files of a batch job. For example, if a disk that is being used by a
159 batch job is showing errors, the operator might note this in the stan‐
160 dard error stream of the batch job.
161 The options of the qmsg utility provide users with the means of placing
163 the message in the output stream of their choice. The default output
164 stream for the message—if the user does not designate an output stream—
165 is implementation-defined, since many implementations will provide, as
166 an extension to this volume of POSIX.1‐2008, a log file that shows the
167 history of utility execution.
168 If users wish to send a message to a set of jobs that meet a selection
170 criteria, the qselect utility can be used to acquire the appropriate
171 list of job identifiers.
172 The −E option allows users to place the message in the standard error
174 stream of the batch job.
175 The −O option allows users to place the message in the standard output
177 stream of the batch job.
178 Historically, the qmsg utility is an existing practice in the offerings
180 of one or more implementors of an NQS-derived batch system. The utility
181 has been found to be useful enough that it deserves to be included in
182 this volume of POSIX.1‐2008.
183
185 The qmsg utility may be removed in a future version.
186
188 Chapter 3, Batch Environment Services, qselect
189 The Base Definitions volume of POSIX.1‐2008, Section 6.1, Portable
191 Character Set, Chapter 8, Environment Variables, Section 12.2, Utility
192 Syntax Guidelines
193
195 Portions of this text are reprinted and reproduced in electronic form
196 from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
197 -- Portable Operating System Interface (POSIX), The Open Group Base
198 Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
199 cal and Electronics Engineers, Inc and The Open Group. (This is
200 POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
201 event of any discrepancy between this version and the original IEEE and
202 The Open Group Standard, the original IEEE and The Open Group Standard
203 is the referee document. The original Standard can be obtained online
204 at http://www.unix.org/online.html .
205 Any typographical or formatting errors that appear in this page are
207 most likely to have been introduced during the conversion of the source
208 files to man page format. To report such errors, see https://www.ker‐
209 nel.org/doc/man-pages/reporting_bugs.html .
210IEEE/The Open Group 2013 QMSG(1P)