qmsg(1p)

1QMSG(P)                    POSIX Programmer's Manual                   QMSG(P)
2
3
4

NAME

6       qmsg - send message to batch jobs
7

SYNOPSIS

9       qmsg [-E][-O] message_string job_identifier ...
10

DESCRIPTION

12       To  send  a  message to a batch job is to request that a server write a
13       message string into one or more output files of the batch job.  A  mes‐
14       sage  is sent to a batch job by a request to the batch server that man‐
15       ages the batch job. The qmsg utility is a user-accessible batch  client
16       that requests the sending of messages to one or more batch jobs.
17
18       The  qmsg  utility shall write messages into the files of batch jobs by
19       sending a Job Message Request to the  batch  server  that  manages  the
20       batch  job.  The qmsg utility shall not directly write the message into
21       the files of the batch job.
22
23       The qmsg utility shall send a Job Message Request for those batch jobs,
24       and  only  those  batch  jobs, for which a batch job_identifier is pre‐
25       sented to the utility.
26
27       The qmsg utility shall send Job Message Requests for batch jobs in  the
28       order  in  which their batch job_identifiers are presented to the util‐
29       ity.
30
31       If the qmsg utility fails to process any batch job_identifier  success‐
32       fully,  the  utility  shall  proceed  to  process  the  remaining batch
33       job_identifiers, if any.
34
35       The qmsg utility shall not exit before a Job Message Request  has  been
36       sent  to the server that manages the batch job that corresponds to each
37       successfully processed batch job_identifier.
38

OPTIONS

40       The qmsg utility shall  conform  to  the  Base  Definitions  volume  of
41       IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines.
42
43       The following options shall be supported by the implementation:
44
45       -E     Specify  that  the  message  is written to the standard error of
46              each batch job.
47
48       The qmsg utility shall write the message into the standard error of the
49       batch job.
50
51       -O     Specify  that  the  message is written to the standard output of
52              each batch job.
53
54       The qmsg utility shall write the message into the  standard  output  of
55       the batch job.
56
57
58       If  neither  the -O nor the -E option is presented to the qmsg utility,
59       the utility shall write  the  message  into  an  implementation-defined
60       file.  The  conformance  document for the implementation shall describe
61       the name and location of the implementation-defined file. If  both  the
62       -O and the -E options are presented to the qmsg utility, then the util‐
63       ity shall write the messages  to  both  standard  output  and  standard
64       error.
65

OPERANDS

67       The qmsg utility shall accept a minimum of two operands, message_string
68       and one or more batch job_identifiers.
69
70       The message_string operand shall be the string to be written to one  or
71       more  output  files  of  the  batch job followed by a <newline>. If the
72       string contains <blank>s, then the application shall  ensure  that  the
73       string  is  quoted. The message_string shall be encoded in the portable
74       character set (see the Base Definitions volume of IEEE Std 1003.1-2001,
75       Section 6.1, Portable Character Set).
76
77       All  remaining  operands  are batch job_identifiers that conform to the
78       syntax for a batch job_identifier (see Batch Job Identifier ).
79

STDIN

81       Not used.
82

INPUT FILES

84       None.
85

ENVIRONMENT VARIABLES

87       The following environment variables shall affect the execution of qmsg:
88
89       LANG   Provide a default value for the  internationalization  variables
90              that  are  unset  or  null.  (See the Base Definitions volume of
91              IEEE Std 1003.1-2001, Section  8.2,  Internationalization  Vari‐
92              ables  for the precedence of internationalization variables used
93              to determine the values of locale categories.)
94
95       LC_ALL If set to a non-empty string value, override the values  of  all
96              the other internationalization variables.
97
98       LC_CTYPE
99              Determine  the  locale  for  the  interpretation of sequences of
100              bytes of text data as characters (for  example,  single-byte  as
101              opposed to multi-byte characters in arguments).
102
103       LC_MESSAGES
104              Determine  the  locale  that should be used to affect the format
105              and contents of diagnostic messages written to standard error.
106
107       LOGNAME
108              Determine the login name of the user.
109
110

ASYNCHRONOUS EVENTS

112       Default.
113

STDOUT

115       None.
116

STDERR

118       The standard error shall be used only for diagnostic messages.
119

OUTPUT FILES

121       None.
122

EXTENDED DESCRIPTION

124       None.
125

EXIT STATUS

127       The following exit values shall be returned:
128
129        0     Successful completion.
130
131       >0     An error occurred.
132
133

CONSEQUENCES OF ERRORS

135       In addition to the default behavior, the  qmsg  utility  shall  not  be
136       required to write a diagnostic message to standard error when the error
137       reply received from a batch server indicates that the batch job_identi‐
138       fier  does  not  exist  on  the server. Whether or not the qmsg utility
139       waits to output the diagnostic message while attempting to  locate  the
140       job on other servers is implementation-defined.
141
142       The following sections are informative.
143

APPLICATION USAGE

145       None.
146

EXAMPLES

148       None.
149

RATIONALE

151       The  qmsg  utility allows users to write messages into the output files
152       of running jobs. Users, including operators and administrators, have  a
153       number  of  occasions  when  they  want to place messages in the output
154       files of a batch job. For example, if a disk that is being  used  by  a
155       batch  job is showing errors, the operator might note this in the stan‐
156       dard error stream of the batch job.
157
158       The options of the qmsg utility provide users with the means of placing
159       the  message  in the output stream of their choice.  The default output
160       stream for the message-if the user does not designate an output stream-
161       is  implementation-defined, since many implementations will provide, as
162       an extension to this volume of IEEE Std 1003.1-2001, a  log  file  that
163       shows the history of utility execution.
164
165       If  users wish to send a message to a set of jobs that meet a selection
166       criteria, the qselect utility can be used to  acquire  the  appropriate
167       list of job identifiers.
168
169       The  -E  option allows users to place the message in the standard error
170       stream of the batch job.
171
172       The -O option allows users to place the message in the standard  output
173       stream of the batch job.
174
175       Historically, the qmsg utility is an existing practice in the offerings
176       of one or more implementors of an NQS-derived batch system. The utility
177       has  been  found to be useful enough that it deserves to be included in
178       this volume of IEEE Std 1003.1-2001.
179

FUTURE DIRECTIONS

181       None.
182

COPYRIGHT

187       Portions of this text are reprinted and reproduced in  electronic  form
188       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
189       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
190       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
191       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
192       event of any discrepancy between this version and the original IEEE and
193       The Open Group Standard, the original IEEE and The Open Group  Standard
194       is  the  referee document. The original Standard can be obtained online
195       at http://www.opengroup.org/unix/online.html .
196
197
198
199IEEE/The Open Group                  2003                              QMSG(P)