146 lines
6.0 KiB
Groff
146 lines
6.0 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 Iq
|
|
.TH qmsg 1B "" Local PBS
|
|
.so ../ers/ers.macros
|
|
.Iq
|
|
.SH NAME
|
|
qmsg \- send message to pbs batch jobs
|
|
.SH SYNOPSIS
|
|
qmsg
|
|
[\-E] [\-O] message_string
|
|
job_identifier ...
|
|
.SH DESCRIPTION
|
|
To send a message to a job is to write a message string into one or
|
|
more output files of the job. Typically this is done to leave an
|
|
informative message in the output of the job.
|
|
.LP
|
|
The
|
|
.B qmsg
|
|
command writes messages into the files of jobs
|
|
by sending a
|
|
.I "Message Job"
|
|
batch request to the batch server that owns the job.
|
|
The qmsg
|
|
command does not directly write the message into the files of the job.
|
|
.SH OPTIONS
|
|
.IP "\-E" 15
|
|
Specifies that the message is written to the standard error of each job.
|
|
.IP "\-O" 15
|
|
Specifies that the message is written to the standard output of each job.
|
|
.LP
|
|
If neither the
|
|
.Ar \-E
|
|
nor the
|
|
.Ar \-O
|
|
option is specified, the message will be written to the standard error
|
|
of the job.
|
|
.SH OPERANDS
|
|
The first operand,
|
|
.Ar message_string ,
|
|
is the message to be written. If the string contains blanks, the string
|
|
must be quoted.
|
|
If the final character of the string is not a newline, a newline character
|
|
will be added when written to the job's file.
|
|
.LP
|
|
All following operands are
|
|
.Ar job_identifiers
|
|
which specify the jobs to receive the message string.
|
|
The qmsg command accepts one or more
|
|
.Ar job_identifier
|
|
operands of the form:
|
|
.br
|
|
.Ty "\ \ \ \ sequence_number[.server_name][@server]"
|
|
.br
|
|
.if !\n(Pb .ig Ig
|
|
See the description under "Job Identifier" in section \*(Ji in this ERS.
|
|
.Ig
|
|
.SH STANDARD ERROR
|
|
The qmsg
|
|
command will write a diagnostic message to standard error for
|
|
each error occurrence.
|
|
.SH EXIT STATUS
|
|
Upon successful processing of all the operands presented to the
|
|
qmsg
|
|
command, the exit status will be a value of zero.
|
|
.LP
|
|
If the qmsg command fails to process any operand, the
|
|
command exits with a value greater than zero.
|
|
.SH SEE ALSO
|
|
qsub(1B), pbs_msgjob(3B)
|
|
.RE
|