openpbs/doc/man8/pbs_tclsh.8B

.\" Copyright (C) 1994-2018 Altair Engineering, Inc.
.\" For more information, contact Altair at www.altair.com.
.\"
.\" This file is part of the PBS Professional ("PBS Pro") software.
.\"
.\" Open Source License Information:
.\"
.\" PBS Pro is free software. You can redistribute it and/or modify it under the
.\" terms of the GNU Affero General Public License as published by the Free
.\" Software Foundation, either version 3 of the License, or (at your option) any
.\" later version.
.\"
.\" PBS Pro is distributed in the hope that it will be useful, but WITHOUT ANY
.\" WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
.\" FOR A PARTICULAR PURPOSE.
.\" See the GNU Affero General Public License for more details.
.\"
.\" You should have received a copy of the GNU Affero General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.\"
.\" Commercial License Information:
.\"
.\" For a copy of the commercial license terms and conditions,
.\" go to: (http://www.pbspro.com/UserArea/agreement.html)
.\" or contact the Altair Legal Department.
.\"
.\" Altair’s dual-license business model allows companies, individuals, and
.\" organizations to create proprietary derivative works of PBS Pro and
.\" distribute them - whether embedded or bundled with other software -
.\" under a commercial license agreement.
.\"
.\" Use of Altair’s trademarks, including but not limited to "PBS™",
.\" "PBS Professional®", and "PBS Pro™" and Altair’s logos is subject to Altair's
.\" trademark licensing policies.
.\"
.TH pbs_tclsh 8B "22 November 2017" Local "PBS Professional"
.SH NAME
.B pbs_tclsh 
- TCL shell with TCL-wrapped PBS API
.SH SYNOPSIS
.B pbs_tclsh 

.B pbs_tclsh 
--version
.SH DESCRIPTION
The
.B pbs_tclsh
command starts a version of the TCL shell which includes wrapped versions of
the PBS external API. The PBS TCL API is documented in the pbs_tclapi(3B) manual page.

The 
.B pbs_tclsh
command is used to query MoM.  For example:

.RS
.nf
\> pbs_tclsh
tclsh> openrm <hostname>
<file descriptor>
tclsh> addreq <file descriptor> "loadave"
tclsh> getreq <file descriptor>
<load average>
tclsh> closereq <file descriptor>
.fi
.RE

.B Required Privilege
.br
Root privilege is required in order to query MoM for dynamic 
resources.  Root privilege is not required in order to query
MoM for built-in resources and site-defined static resources.


.SH OPTIONS
.IP "--version" 8
The 
.B pbs_tclsh
command returns its PBS version information and exits.
This option can only be used alone.

.SH STANDARD ERROR
The
.B pbs_tclsh
command writes a diagnostic message to standard error for
each error occurrence.

.SH SEE ALSO
The
.I PBS Professional Administrator's Guide, 
the 
.I PBS Professional Programmer's Guide, 
and the following manual pages:
pbs_wish(8B), pbs_server(8B), pbs_mom(8B), pbs_sched(8B)