158 lines
6.3 KiB
Groff
158 lines
6.3 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_connect 3B "" Local PBS
|
|
.so ../ers/ers.macros
|
|
.Ig
|
|
.SH NAME
|
|
pbs_connect \- connect to a pbs batch server
|
|
.SH SYNOPSIS
|
|
#include <pbs_error.h>
|
|
.br
|
|
#include <pbs_ifl.h>
|
|
.sp
|
|
.ft 3
|
|
.nf
|
|
int pbs_connect(\^char *server\^)
|
|
.sp
|
|
extern char *pbs_server;
|
|
.ft 1
|
|
.fi
|
|
.SH DESCRIPTION
|
|
A virtual stream (TCP/IP) connection is established with the server
|
|
specified by
|
|
.Ar server .
|
|
.LP
|
|
This function must be called before any of the other
|
|
.B pbs_
|
|
functions.
|
|
They will transmit their batch requests over the connection established
|
|
by this function.
|
|
Multiple requests may be issued over the connection before it is closed.
|
|
.LP
|
|
The connection should be closed by a call to \fBpbs_disconnect\fP()
|
|
when all requests have been sent to the server.
|
|
.LP
|
|
The parameter,
|
|
.Ar server ,
|
|
is of the form
|
|
.Ty host_name[:port] ,
|
|
see section 2.7.9.
|
|
If
|
|
.Ty port
|
|
is not specified, the standard PBS port number will be used.
|
|
.LP
|
|
If the parameter,
|
|
.Ar server ,
|
|
is either the null string or a null pointer,
|
|
a connection will be opened to the default server.
|
|
The default server is defined
|
|
.if !\n(Pb .ig Ig
|
|
in section \*(Si.
|
|
.Ig
|
|
.if \n(Pb .ig Ig
|
|
by (a) the setting of the environment
|
|
variable
|
|
.B PBS_DEFAULT
|
|
which contains a destination, or (b) the destination in the batch administrator
|
|
established file
|
|
.Av {PBS_DIR}/default_destn .
|
|
.Ig
|
|
.LP
|
|
The variable
|
|
.Ar pbs_server ,
|
|
declared in pbs_ifl.h,
|
|
is set on return to point to the server
|
|
name to which pbs_connect() connected or attempted to connect.
|
|
.SH SEE ALSO
|
|
qsub(1B),
|
|
pbs_alterjob(3B), pbs_deljob(3B), pbs_disconnect(3B), pbs_geterrmsg(3B),
|
|
pbs_holdjob(3B), pbs_locate(3B), pbs_manager(3B), pbs_movejob(3B),
|
|
pbs_msgjob(3B), pbs_rerunjob(3B), pbs_rlsjob(3B), pbs_runjob(3B),
|
|
pbs_selectjob(3B), pbs_selstat(3B), pbs_sigjob(3B), pbs_statjob(3B),
|
|
pbs_statque(3B), pbs_statserver(3B), pbs_submit(3B), pbs_terminate(3B),
|
|
pbs_server(8B),
|
|
and the PBS External Reference Specification
|
|
.SH DIAGNOSTICS
|
|
When the connection to batch server
|
|
has been successfully created, the routine will return a connection
|
|
identifier which is positive.
|
|
Otherwise, a negative value is returned. The error number is set
|
|
in pbs_errno.
|
|
\" turn off any extra indent left by the Sh macro
|
|
.RE
|