146 lines
5.9 KiB
Groff
146 lines
5.9 KiB
Groff
.\" OpenPBS (Portable Batch System) v2.3 Software License
|
|
.\"
|
|
.\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" ---------------------------------------------------------------------------
|
|
.\" For a license to use or redistribute the OpenPBS software under conditions
|
|
.\" other than those described below, or to purchase support for this software,
|
|
.\" please contact Veridian Systems, PBS Products Department ("Licensor") at:
|
|
.\"
|
|
.\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org
|
|
.\" 877 902-4PBS (US toll-free)
|
|
.\" ---------------------------------------------------------------------------
|
|
.\"
|
|
.\" This license covers use of the OpenPBS v2.3 software (the "Software") at
|
|
.\" your site or location, and, for certain users, redistribution of the
|
|
.\" Software to other sites and locations. Use and redistribution of
|
|
.\" OpenPBS v2.3 in source and binary forms, with or without modification,
|
|
.\" are permitted provided that all of the following conditions are met.
|
|
.\" After December 31, 2001, only conditions 3-6 must be met:
|
|
.\"
|
|
.\" 1. Commercial and/or non-commercial use of the Software is permitted
|
|
.\" provided a current software registration is on file at www.OpenPBS.org.
|
|
.\" If use of this software contributes to a publication, product, or service
|
|
.\" proper attribution must be given; see www.OpenPBS.org/credit.html
|
|
.\"
|
|
.\" 2. Redistribution in any form is only permitted for non-commercial,
|
|
.\" non-profit purposes. There can be no charge for the Software or any
|
|
.\" software incorporating the Software. Further, there can be no
|
|
.\" expectation of revenue generated as a consequence of redistributing
|
|
.\" the Software.
|
|
.\"
|
|
.\" 3. Any Redistribution of source code must retain the above copyright notice
|
|
.\" and the acknowledgment contained in paragraph 6, this list of conditions
|
|
.\" and the disclaimer contained in paragraph 7.
|
|
.\"
|
|
.\" 4. Any Redistribution in binary form must reproduce the above copyright
|
|
.\" notice and the acknowledgment contained in paragraph 6, this list of
|
|
.\" conditions and the disclaimer contained in paragraph 7 in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" 5. Redistributions in any form must be accompanied by information on how to
|
|
.\" obtain complete source code for the OpenPBS software and any
|
|
.\" modifications and/or additions to the OpenPBS software. The source code
|
|
.\" must either be included in the distribution or be available for no more
|
|
.\" than the cost of distribution plus a nominal fee, and all modifications
|
|
.\" and additions to the Software must be freely redistributable by any party
|
|
.\" (including Licensor) without restriction.
|
|
.\"
|
|
.\" 6. All advertising materials mentioning features or use of the Software must
|
|
.\" display the following acknowledgment:
|
|
.\"
|
|
.\" "This product includes software developed by NASA Ames Research Center,
|
|
.\" Lawrence Livermore National Laboratory, and Veridian Information
|
|
.\" Solutions, Inc.
|
|
.\" Visit www.OpenPBS.org for OpenPBS software support,
|
|
.\" products, and information."
|
|
.\"
|
|
.\" 7. DISCLAIMER OF WARRANTY
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS
|
|
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
.\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT
|
|
.\" ARE EXPRESSLY DISCLAIMED.
|
|
.\"
|
|
.\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE
|
|
.\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
|
.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" This license will be governed by the laws of the Commonwealth of Virginia,
|
|
.\" without reference to its choice of law rules.
|
|
.if \n(Pb .ig Ig
|
|
.TH pbs_rlsjob 3B "" Local PBS
|
|
.so ../ers/ers.macros
|
|
.Ig
|
|
.SH NAME
|
|
pbs_rlsjob \- release a hold on a pbs batch job
|
|
.SH SYNOPSIS
|
|
#include <pbs_error.h>
|
|
.br
|
|
#include <pbs_ifl.h>
|
|
.sp
|
|
.ft 3
|
|
.nf
|
|
int pbs_rlsjob(\^int\ connect, char\ *job_id, char\ *hold_type, char\ *extend\^)
|
|
.fi
|
|
.ft 1
|
|
.SH DESCRIPTION
|
|
Issue a batch request to release a hold from a job.
|
|
.LP
|
|
A
|
|
.I "Release Job"
|
|
batch request is generated and sent to the server over the connection
|
|
specified by
|
|
.Ar connect
|
|
which is the return value of \fBpbs_connect\fP().
|
|
.LP
|
|
The argument,
|
|
.Ar job_id ,
|
|
identifies the job from which the hold is to be released,
|
|
it is specified in the form:
|
|
.Ty "sequence_number.server"
|
|
.LP
|
|
The parameter,
|
|
.Ar hold_type ,
|
|
contains the type of hold to be released. The possible values are
|
|
defined in pbs_ifl.h as:
|
|
.RS
|
|
.IP #define\ USER_HOLD\ "u"
|
|
Available to the owner of the job, the batch operator, and the
|
|
batch administrator.
|
|
.IP #define\ OTHER_HOLD\ "o"
|
|
Available to the batch operator and the batch administrator.
|
|
.IP #define\ SYSTEM_HOLD\ "s"
|
|
Available only to the batch administrator.
|
|
.RE
|
|
.LP
|
|
If
|
|
.Ar hold_type
|
|
is either a null pointer or points to a null string, USER_HOLD will be released.
|
|
.LP
|
|
The parameter,
|
|
.Ar extend ,
|
|
is reserved for implementation defined extensions.
|
|
.if !\n(Pb .ig Ig
|
|
It is not
|
|
currently used by this function.
|
|
.Ig
|
|
.SH "SEE ALSO"
|
|
qrls(1B), qhold(1B), qalter(1B), pbs_alterjob(3B), pbs_connect(3B), and
|
|
pbs_holdjob(3B)
|
|
.SH DIAGNOSTICS
|
|
When the batch request generated by \fBpbs_rlsjob\fP()
|
|
function has been completed successfully by a batch server, the routine will
|
|
return 0 (zero).
|
|
Otherwise, a non zero error is returned. The error number is also set
|
|
in pbs_errno.
|
|
\" turn off any extra indent left by the Sh macro
|
|
.RE
|
|
|