# qhold

## PROLOG



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


## NAME



           qhold — hold batch jobs
    


## SYNOPSIS



           qhold **[** -h _hold_list_**]**_job_identifier_...
    


## DESCRIPTION



           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 _qhold_ 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 _qhold_ utility shall place holds on those batch jobs for which
           a batch _job_identifier_ is presented to the utility.
    
           The _qhold_ utility shall place holds on batch jobs in the order in
           which their batch _job_identifier_ s are presented to the utility. If
           the _qhold_ utility fails to process any batch _job_identifier_
           successfully, the utility shall proceed to process the remaining
           batch _job_identifier_ s, if any.
    
           The _qhold_ utility shall place holds on each batch job by sending a
           _Hold Job Request_ to the batch server that manages the batch job.
    
           The _qhold_ utility shall not exit until holds have been placed on
           the batch job corresponding to each successfully processed batch
           _job_identifier_.
    


## OPTIONS



           The _qhold_ utility shall conform to the Base Definitions volume of
           POSIX.1‐2017, _Section 12.2_ , _Utility Syntax Guidelines_.
    
           The following option shall be supported by the implementation:
    
           **-h** _hold_list_
                     Define the types of holds to be placed on the batch job.
    
                     The _qhold_ **-h** option shall accept a value for the
                     _hold_list_ option-argument that is a string of
                     alphanumeric characters in the portable character set
                     (see the Base Definitions volume of POSIX.1‐2017,
                     _Section 6.1_ , _Portable Character Set_).
    
                     The _qhold_ utility shall accept a value for the _hold_list_
                     option-argument that is a string of one or more of the
                     characters **'u'** , **'s'** , or **'o'** , or the single character
                     **'n'**.
    
                     For each unique character in the _hold_list_ option-
                     argument, the _qhold_ utility shall add a value to the
                     _Hold_Types_ 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
                     _hold_list_ option-argument, the duplicates shall be
                     ignored.
    
                     An existing _Hold_Types_ attribute can be cleared by the
                     following hold type:
    
                     n     NO_HOLD
    
                     The _qhold_ utility shall consider it an error if any hold
                     type other than **'n'** is combined with hold type **'n'**.
    
                     Strictly conforming applications shall not repeat any of
                     the characters **'u'** , **'s'** , **'o'** , or **'n'** within the
                     _hold_list_ option-argument. The _qhold_ 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 **-h** option is not presented to the _qhold_ utility,
                     the implementation shall set the _Hold_Types_ attribute to
                     USER.
    


## OPERANDS



           The _qhold_ utility shall accept one or more operands that conform
           to the syntax for a batch _job_identifier_ (see _Section 3.3.1_ , _Batch_
           _Job Identifier_).
    


## STDIN



           Not used.
    


## INPUT FILES



           None.
    


## ENVIRONMENT VARIABLES



           The following environment variables shall affect the execution of
           _qhold_ :
    
           _LANG_      Provide a default value for the internationalization
                     variables that are unset or null. (See the Base
                     Definitions volume of POSIX.1‐2017, _Section 8.2_ ,
                     _Internationalization Variables_ the precedence of
                     internationalization variables used to determine the
                     values of locale categories.)
    
           _LC_ALL_    If set to a non-empty string value, override the values
                     of all the other internationalization variables.
    
           _LC_CTYPE_  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).
    
           _LC_MESSAGES_
                     Determine the locale that should be used to affect the
                     format and contents of diagnostic messages written to
                     standard error.
    
           _LOGNAME_   Determine the login name of the user.
    


## ASYNCHRONOUS EVENTS



           Default.
    


## STDOUT



           None.
    


## STDERR



           The standard error shall be used only for diagnostic messages.
    


## OUTPUT FILES



           None.
    


## EXTENDED DESCRIPTION



           None.
    


## EXIT STATUS



           The following exit values shall be returned:
    
            0    Successful completion.
    
           >0    An error occurred.
    


## CONSEQUENCES OF ERRORS



           In addition to the default behavior, the _qhold_ 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 _job_identifier_ does not exist on the server. Whether or not
           the _qhold_ utility waits to output the diagnostic message while
           attempting to locate the job on other servers is implementation-
           defined.
    
           _The following sections are informative._
    


## APPLICATION USAGE



           None.
    


## EXAMPLES



           None.
    


## RATIONALE



           The _qhold_ utility allows users to place a hold on one or more
           jobs. A hold makes a batch job ineligible for execution.
    
           The _qhold_ 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 _qselect_ utility.
    
           The **-h** 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 _qhold_ utility has been a part of some existing
           batch systems, although it has not traditionally been a part of
           the NQS.
    


## FUTURE DIRECTIONS



           The _qhold_ utility may be removed in a future version.
    


* * *