QMSG(1)                    POSIX Programmer's Manual                   QMSG(1)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       qmsg -- send message to batch jobs

SSYYNNOOPPSSIISS
       qmsg [[-EO]] _m_e_s_s_a_g_e___s_t_r_i_n_g _j_o_b___i_d_e_n_t_i_f_i_e_r...

DDEESSCCRRIIPPTTIIOONN
       To send a message to a batch job is to request that a server write a
       message string into one or more output files of the batch job. A
       message is sent to a batch job by a request to the batch server that
       manages the batch job. The _q_m_s_g utility is a user-accessible batch
       client that requests the sending of messages to one or more batch jobs.

       The _q_m_s_g utility shall write messages into the files of batch jobs by
       sending a _J_o_b _M_e_s_s_a_g_e _R_e_q_u_e_s_t to the batch server that manages the
       batch job. The _q_m_s_g utility shall not directly write the message into
       the files of the batch job.

       The _q_m_s_g utility shall send a _J_o_b _M_e_s_s_a_g_e _R_e_q_u_e_s_t for those batch jobs,
       and only those batch jobs, for which a batch _j_o_b___i_d_e_n_t_i_f_i_e_r is
       presented to the utility.

       The _q_m_s_g utility shall send _J_o_b _M_e_s_s_a_g_e _R_e_q_u_e_s_ts for batch jobs in the
       order in which their batch _j_o_b___i_d_e_n_t_i_f_i_e_rs are presented to the
       utility.

       If the _q_m_s_g utility fails to process any batch _j_o_b___i_d_e_n_t_i_f_i_e_r
       successfully, the utility shall proceed to process the remaining batch
       _j_o_b___i_d_e_n_t_i_f_i_e_rs, if any.

       The _q_m_s_g utility shall not exit before a _J_o_b _M_e_s_s_a_g_e _R_e_q_u_e_s_t has been
       sent to the server that manages the batch job that corresponds to each
       successfully processed batch _j_o_b___i_d_e_n_t_i_f_i_e_r.

OOPPTTIIOONNSS
       The _q_m_s_g utility shall conform to the Base Definitions volume of
       POSIX.1-2017, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s.

       The following options shall be supported by the implementation:

       --EE        Specify that the message is written to the standard error of
                 each batch job.

                 The _q_m_s_g utility shall write the message into the standard
                 error of the batch job.

       --OO        Specify that the message is written to the standard output of
                 each batch job.

                 The _q_m_s_g utility shall write the message into the standard
                 output of the batch job.

       If neither the --OO nor the --EE option is presented to the _q_m_s_g utility,
       the utility shall write the message into an implementation-defined
       file. The conformance document for the implementation shall describe
       the name and location of the implementation-defined file. If both the
       --OO and the --EE options are presented to the _q_m_s_g utility, then the
       utility shall write the messages to both standard output and standard
       error.

OOPPEERRAANNDDSS
       The _q_m_s_g utility shall accept a minimum of two operands, _m_e_s_s_a_g_e___s_t_r_i_n_g
       and one or more batch _j_o_b___i_d_e_n_t_i_f_i_e_rs.

       The _m_e_s_s_a_g_e___s_t_r_i_n_g operand shall be the string to be written to one or
       more output files of the batch job followed by a <newline>.  If the
       string contains <blank> characters, then the application shall ensure
       that the string is quoted. The _m_e_s_s_a_g_e___s_t_r_i_n_g shall be encoded in the
       portable character set (see the Base Definitions volume of
       POSIX.1-2017, _S_e_c_t_i_o_n _6_._1, _P_o_r_t_a_b_l_e _C_h_a_r_a_c_t_e_r _S_e_t).

       All remaining operands are batch _j_o_b___i_d_e_n_t_i_f_i_e_rs that conform to the
       syntax for a batch _j_o_b___i_d_e_n_t_i_f_i_e_r (see _S_e_c_t_i_o_n _3_._3_._1, _B_a_t_c_h _J_o_b
       _I_d_e_n_t_i_f_i_e_r).

SSTTDDIINN
       Not used.

IINNPPUUTT FFIILLEESS
       None.

EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
       The following environment variables shall affect the execution of _q_m_s_g:

       _L_A_N_G      Provide a default value for the internationalization
                 variables that are unset or null. (See the Base Definitions
                 volume of POSIX.1-2017, _S_e_c_t_i_o_n _8_._2, _I_n_t_e_r_n_a_t_i_o_n_a_l_i_z_a_t_i_o_n
                 _V_a_r_i_a_b_l_e_s the precedence of internationalization variables
                 used to determine the values of locale categories.)

       _L_C___A_L_L    If set to a non-empty string value, override the values of
                 all the other internationalization variables.

       _L_C___C_T_Y_P_E  Determine the locale for the interpretation of sequences of
                 bytes of text data as characters (for example, single-byte as
                 opposed to multi-byte characters in arguments).

       _L_C___M_E_S_S_A_G_E_S
                 Determine the locale that should be used to affect the format
                 and contents of diagnostic messages written to standard
                 error.

       _L_O_G_N_A_M_E   Determine the login name of the user.

AASSYYNNCCHHRROONNOOUUSS EEVVEENNTTSS
       Default.

SSTTDDOOUUTT
       None.

SSTTDDEERRRR
       The standard error shall be used only for diagnostic messages.

OOUUTTPPUUTT FFIILLEESS
       None.

EEXXTTEENNDDEEDD DDEESSCCRRIIPPTTIIOONN
       None.

EEXXIITT SSTTAATTUUSS
       The following exit values shall be returned:

        0    Successful completion.

       >0    An error occurred.

CCOONNSSEEQQUUEENNCCEESS OOFF EERRRROORRSS
       In addition to the default behavior, the _q_m_s_g utility shall not be
       required to write a diagnostic message to standard error when the error
       reply received from a batch server indicates that the batch
       _j_o_b___i_d_e_n_t_i_f_i_e_r does not exist on the server. Whether or not the _q_m_s_g
       utility waits to output the diagnostic message while attempting to
       locate the job on other servers is implementation-defined.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

EEXXAAMMPPLLEESS
       None.

RRAATTIIOONNAALLEE
       The _q_m_s_g utility allows users to write messages into the output files
       of running jobs. Users, including operators and administrators, have a
       number of occasions when they want to place messages in the output
       files of a batch job. For example, if a disk that is being used by a
       batch job is showing errors, the operator might note this in the
       standard error stream of the batch job.

       The options of the _q_m_s_g utility provide users with the means of placing
       the message in the output stream of their choice. The default output
       stream for the message--if the user does not designate an output
       stream--is implementation-defined, since many implementations will
       provide, as an extension to this volume of POSIX.1-2017, a log file
       that shows the history of utility execution.

       If users wish to send a message to a set of jobs that meet a selection
       criteria, the _q_s_e_l_e_c_t utility can be used to acquire the appropriate
       list of job identifiers.

       The --EE option allows users to place the message in the standard error
       stream of the batch job.

       The --OO option allows users to place the message in the standard output
       stream of the batch job.

       Historically, the _q_m_s_g utility is an existing practice in the offerings
       of one or more implementors of an NQS-derived batch system. The utility
       has been found to be useful enough that it deserves to be included in
       this volume of POSIX.1-2017.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       The _q_m_s_g utility may be removed in a future version.

SSEEEE AALLSSOO
       _C_h_a_p_t_e_r _3, _B_a_t_c_h _E_n_v_i_r_o_n_m_e_n_t _S_e_r_v_i_c_e_s, _q_s_e_l_e_c_t

       The Base Definitions volume of POSIX.1-2017, _S_e_c_t_i_o_n _6_._1, _P_o_r_t_a_b_l_e
       _C_h_a_r_a_c_t_e_r _S_e_t, _C_h_a_p_t_e_r _8, _E_n_v_i_r_o_n_m_e_n_t _V_a_r_i_a_b_l_e_s, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y
       _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                              QMSG(1)
