QHOLD(1)                   POSIX Programmer's Manual                  QHOLD(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
       qhold -- hold batch jobs

SSYYNNOOPPSSIISS
       qhold [[-h _h_o_l_d___l_i_s_t]] _j_o_b___i_d_e_n_t_i_f_i_e_r...

DDEESSCCRRIIPPTTIIOONN
       A hold is placed on a batch job by a request to the batch server that
       manages the batch job. A batch job that has one or more holds is not
       eligible for execution. The _q_h_o_l_d utility is a user-accessible client
       of batch services that requests one or more types of hold to be placed
       on one or more batch jobs.

       The _q_h_o_l_d utility shall place holds on 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_h_o_l_d utility shall place holds on 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_h_o_l_d
       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_h_o_l_d utility shall place holds on each batch job by sending a _H_o_l_d
       _J_o_b _R_e_q_u_e_s_t to the batch server that manages the batch job.

       The _q_h_o_l_d utility shall not exit until holds have been placed on the
       batch job corresponding to each successfully processed batch
       _j_o_b___i_d_e_n_t_i_f_i_e_r.

OOPPTTIIOONNSS
       The _q_h_o_l_d 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 option shall be supported by the implementation:

       --hh _h_o_l_d___l_i_s_t
                 Define the types of holds to be placed on the batch job.

                 The _q_h_o_l_d --hh option shall accept a value for the _h_o_l_d___l_i_s_t
                 option-argument that is a string of alphanumeric characters
                 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).

                 The _q_h_o_l_d utility shall accept a value for the _h_o_l_d___l_i_s_t
                 option-argument that is a string of one or more of the
                 characters ''uu'', ''ss'', or ''oo'', or the single character ''nn''.

                 For each unique character in the _h_o_l_d___l_i_s_t option-argument,
                 the _q_h_o_l_d utility shall add a value to the _H_o_l_d___T_y_p_e_s
                 attribute of the batch job as follows, each representing a
                 different hold type:

                 u     USER

                 s     SYSTEM

                 o     OPERATOR

                 If any of these characters are duplicated in the _h_o_l_d___l_i_s_t
                 option-argument, the duplicates shall be ignored.

                 An existing _H_o_l_d___T_y_p_e_s attribute can be cleared by the
                 following hold type:

                 n     NO_HOLD

                 The _q_h_o_l_d utility shall consider it an error if any hold type
                 other than ''nn'' is combined with hold type ''nn''.

                 Strictly conforming applications shall not repeat any of the
                 characters ''uu'', ''ss'', ''oo'', or ''nn'' within the _h_o_l_d___l_i_s_t option-
                 argument. The _q_h_o_l_d utility shall permit the repetition of
                 characters, but shall not assign additional meaning to the
                 repeated characters.

                 An implementation may define other hold types. The
                 conformance document for an implementation shall describe any
                 additional hold types, how they are specified, their internal
                 behavior, and how they affect the behavior of the utility.

                 If the --hh option is not presented to the _q_h_o_l_d utility, the
                 implementation shall set the _H_o_l_d___T_y_p_e_s attribute to USER.

OOPPEERRAANNDDSS
       The _q_h_o_l_d utility shall accept one or more operands 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_h_o_l_d:

       _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_h_o_l_d 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_h_o_l_d
       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_h_o_l_d utility allows users to place a hold on one or more jobs. A
       hold makes a batch job ineligible for execution.

       The _q_h_o_l_d utility has options that allow the user to specify the type
       of hold.  Should the user wish to place a hold on a set of jobs that
       meet a selection criteria, such a list of jobs can be acquired using
       the _q_s_e_l_e_c_t utility.

       The --hh option allows the user to specify the type of hold that is to be
       placed on the job. This option allows for USER, SYSTEM, OPERATOR, and
       implementation-defined hold types. The USER and OPERATOR holds are
       distinct. The batch server that manages the batch job will verify that
       the user is authorized to set the specified hold for the batch job.

       Mail is not required on hold because the administrator has the tools
       and libraries to build this option if he or she wishes.

       Historically, the _q_h_o_l_d utility has been a part of some existing batch
       systems, although it has not traditionally been a part of the NQS.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       The _q_h_o_l_d 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                             QHOLD(1)
