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 [-E][-O] 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 IEEE Std 1003.1-2001, 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 error of the
55 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 output of
61 the batch job.
62 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>s, then the application shall ensure that the
79 string is quoted. The message_string shall be encoded in the portable
80 character set (see the Base Definitions volume of IEEE Std 1003.1-2001,
81 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 Batch Job Identifier ).
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 variables
96 that are unset or null. (See the Base Definitions volume of
97 IEEE Std 1003.1-2001, Section 8.2, Internationalization Vari‐
98 ables for 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 all
102 the other internationalization variables.
103 LC_CTYPE
105 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 error.
112 LOGNAME
114 Determine the login name of the user.
115
118 Default.
119
121 None.
122
124 The standard error shall be used only for diagnostic messages.
125
127 None.
128
130 None.
131
133 The following exit values shall be returned:
134 0 Successful completion.
136 >0 An error occurred.
138
141 In addition to the default behavior, the qmsg utility shall not be
142 required to write a diagnostic message to standard error when the error
143 reply received from a batch server indicates that the batch job_identi‐
144 fier does not exist on the server. Whether or not the qmsg utility
145 waits to output the diagnostic message while attempting to locate the
146 job on other servers is implementation-defined.
147 The following sections are informative.
149
151 None.
152
154 None.
155
157 The qmsg utility allows users to write messages into the output files
158 of running jobs. Users, including operators and administrators, have a
159 number of occasions when they want to place messages in the output
160 files of a batch job. For example, if a disk that is being used by a
161 batch job is showing errors, the operator might note this in the stan‐
162 dard error stream of the batch job.
163 The options of the qmsg utility provide users with the means of placing
165 the message in the output stream of their choice. The default output
166 stream for the message-if the user does not designate an output stream-
167 is implementation-defined, since many implementations will provide, as
168 an extension to this volume of IEEE Std 1003.1-2001, a log file that
169 shows the history of utility execution.
170 If users wish to send a message to a set of jobs that meet a selection
172 criteria, the qselect utility can be used to acquire the appropriate
173 list of job identifiers.
174 The -E option allows users to place the message in the standard error
176 stream of the batch job.
177 The -O option allows users to place the message in the standard output
179 stream of the batch job.
180 Historically, the qmsg utility is an existing practice in the offerings
182 of one or more implementors of an NQS-derived batch system. The utility
183 has been found to be useful enough that it deserves to be included in
184 this volume of IEEE Std 1003.1-2001.
185
187 None.
188
190 Batch Environment Services, qselect
191
193 Portions of this text are reprinted and reproduced in electronic form
194 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
195 -- Portable Operating System Interface (POSIX), The Open Group Base
196 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
197 Electrical and Electronics Engineers, Inc and The Open Group. In the
198 event of any discrepancy between this version and the original IEEE and
199 The Open Group Standard, the original IEEE and The Open Group Standard
200 is the referee document. The original Standard can be obtained online
201 at http://www.opengroup.org/unix/online.html .
202IEEE/The Open Group 2003 QMSG(1P)