NAME

SYNOPSIS

DESCRIPTION

OPTIONS

-A account_string
Defines the account string associated with the job. The is an undefined string of characters and is interpreted by the server which executes the job. See section 2.7.1 of the PBS ERS. The attribute is set to the account string. If account_string is unset, it is not passed with the job to the job executor.
-c interval
Defines the interval at which the job will be checkpointed. If the job executes upon a host which does not support checkpoint, this option will be ignored.
The argument is specified as:

If is not specified, the attribute is set to the value

-C directive_prefix
Defines the prefix that declares a directive to the qsub command within the script file. See the paragraph on script directives in the Extended Description section.
If the option is presented with a argument that is the null string, qsub will not scan the script file for directives. The directive prefix is not a job attribute. It is used solely within the qsub command.
-e path
Defines the path to be used for the standard error stream of the batch job. The argument is of the form:


where is the name of a host to which the file will be returned and is the path name on that host in the syntax recognized by POSIX. The argument will be interpreted as follows:
If the option is not specified, the default file name for the standard error stream will be used. The default name has the following form:
job_name.esequence_number
where job_name is the name of the job, see option, and sequence_number is the job number assigned when the job is submitted. This option sets the job attribute

-h
Specifies that a user hold be applied to the job at submission time. The attribute will be set to USER, "u". If -h is not specified, then is set to NONE, "n".
-I
Declares that the job is to be run "interactively". The job will be queued and scheduled as any PBS batch job, but when executed, the standard input, output, and error streams of the job are connected through qsub to the terminal session in which qsub is running. See the "Extended Description" paragraph for addition information of interactive jobs. The -I option is a violation of the POSIX 1003.2d standard. Option key letters not defined by the standard, such as I, are reserved for future revisions of the standard. PBS can be built with the symbol PBS_NO_POSIX_VIOLATION defined, in which case the -I option is removed. The interactive attribute may still be specified via the -W option.
-j join
Declares if the standard error stream of the job will be merged with the standard output stream of the job.
An option argument value of directs that the two streams will be merged, intermixed, as standard output. The job attribute is set to "oe". An option argument value of directs that the two streams will be merged, intermixed, as standard error. The job attribute is set to "eo".
If the argument is or the option is not specified, the two streams will be two separate files. The job attribute is set to "n".
-k keep
Defines which (if either) of standard output or standard error will be retained on the execution host. If set for a stream, this option overrides the path name for that stream. If not set, neither stream is retained on the execution host.
The argument is either the single letter "e" or "o", or the letters "e" and "o" combined in either order. Or the argument is the letter n. Repetition of characters is permitted, but "n" may not appear in the same option argument with the other two characters. The attribute is set to the argument.
    e
    The standard error stream is to retained on the execution host. The stream will be placed in the home directory of the user under whose user id the job executed. The file name will be the default file name given by: job_name.esequence where job_name is the name specified for the job, and sequence is the sequence number component of the job identifier. The attribute is set to KEEP_ERROR.
    o
    The standard output stream is to retained on the execution host. The stream will be placed in the home directory of the user under whose user id the job executed. The file name will be the default file name given by: job_name.osequence where job_name is the name specified for the job, and sequence is the sequence number component of the job identifier. The attribute is set to KEEP_OUTPUT.
    eo
    Both the standard output and standard error streams will be retained. The attribute is set to "KEEP_OUTPUT | KEEP_ERROR".
    oe
    Both the standard output and standard error streams will be retained. The attribute is set to "KEEP_OUTPUT | KEEP_ERROR".
    n
    Neither stream is retained.
-l resource_list
Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed. If not set for a generally available resource, such as CPU time, the limit is infinite. The argument is of the form:

For each resource listed in the one entry will be added to the attribute of the job. The entry contains the resource name and its requested value. No white space is allowed in the value. Other than syntax, qsub performs no resource or value checking. The checking is performed by the execution server.
-m mail_options
Defines the set of conditions under which the execution server will send a mail message about the job. The argument is a string which consists of either the single character "n", or one or more of the characters "a", "b", and "e". Repeated letters are accepted, but n cannot be mixed with the other characters.
If the character "n" is specified, no mail will be sent. The attribute is set to NONE, "n".
For the letters "a", "b", and "e":
    a
    mail is sent when the job is aborted by the batch system. The attribute is set to ABORT, "a".
    b
    mail is sent when the job begins execution. The attribute is set to BEGINNING, "b".
    e
    mail is sent when the job terminates. The attribute is set to EXIT, "e".
If the option is not specified, mail will be sent if the job is aborted. The attribute is set to ABORT, "a".
-M user_list
Declares the list of users to whom mail is sent by the execution server when it sends mail about the job.
The argument is of the form:


If unset, the list defaults to the submitting user at the qsub host, i.e. the job owner.

The attribute is set to the argument.
-N name
Declares a name for the job. The name specified may be up to and including 15 characters in length. It must consist of printable, non white space characters with the first character alphabetic. [The POSIX 1003.2d Standard calls for only alphanumeric characters, but then calls for the use of the script file base name as the job name if a name is not specified. The file name may contain other than alphanumeric characters. Therefore I [Q]Qinterpret[U]U the standard as allowing printable characters.] Names taken from the script name may have a non-alphabetic character first. If the script basename is greater than 15 characters, it will be truncated to 15.
If the option is not specified, the job name will be the base name of the job script file specified on the command line. If no script file name was specified and the script was read from the standard input, then the job name will be set to
The attribute is set to the name.
-o path
Defines the path to be used for the standard output stream of the batch job. The argument is of the form:


where is the name of a host to which the file will be returned and is the path name on that host in the syntax recognized by POSIX. The argument will be interpreted as follows:
If the option is not specified, the default file name for the standard output stream will be used. The default name has the following form:
job_name.osequence_number
where job_name is the name of the job, see option, and sequence_number is the job number assigned when the job is submitted. This option sets the job attribute

-p priority
Defines the priority of the job. The argument must be a integer between -1024 and +1023 inclusive. The default is no priority which is equivalent to a priority of zero. The job attribute is set to this signed integer value.
-q destination
Defines the destination of the job. The names a queue, a server, or a queue at a server.
The qsub command will submit the script to the server defined by the argument. The server named by the destination is the one to which qsub sends the Queue Job batch request. If the destination is a routing queue, the job may be routed by the server to a new destination.
If the option is not specified, the qsub command will submit the script to the default server. See PBS_DEFAULT under the Environment Variables section on this man page and the PBS ERS section 2.7.4, "Default Server".
If the option is specified, it is in one of the following three forms:



If the argument names a queue and does not name a server, the job will be submitted to the named queue at the default server.
If the argument names a server and does not name a queue, the job will be submitted to the default queue at the named server.
If the argument names both a queue and a server, the job will be submitted to the named queue at the named server.
-r y|n
Declares whether the job is rerunable. See the qrerun command. The option argument is a single character, either or Also see rerunable in the glossary.
If the argument is "y", the job is rerunable. The attribute is set to the character 'y'. If the argument is "n", the job is not rerunable. The default value is 'y', rerunable.
-S path_list
Declares the shell that interprets the job script.
The option argument is in the form:


Only one path may be specified for any host named. Only one path may be specified without the corresponding host name. The path selected will be the one with the host name that matched the name of the execution host. If no matching host is found, then the path specified without a host will be selected, if present.

If the option is not specified, the option argument is the null string, or no entry from the is selected, the execution will use the user's login shell on the execution host. The attribute is set to the argument if present, otherwise it is set to the null string.
-u user_list
Defines the user name under which the job is to run on the execution system.
The argument is of the form:


Only one user name may be given per specified host. Only one of the specifications may be supplied without the corresponding specification. That user name will used for execution on any host not named in the argument list. The attribute is set to the value of If unset, the user list defaults to the user who is running qsub.

-v variable_list
Expands the list of environment variables that are exported to the job.
In addition to the variables described in the "Description" section above, names environment variables from the qsub command environment which are made available to the job when it executes. The is a comma separated list of strings of the form or These variables and their values are passed to the job. The attribute is appended with the variables in and their values.
-V
Declares that all environment variables in the qsub command's environment are to be exported to the batch job. The attribute is appended with the variables in the qsub command's environment and their values.
-W additional_attributes
The -W option allows for the specification of additional job attributes. POSIX.2 reserves all undefined option letters for future versions of the standard. The single letter 'W' is allowed for extensions. PBS makes use of the -W to specify attributes which are extensions to POSIX 1003.2d. The general syntax of the -W is in the form:

-W attr_name=attr_value[,attr_name=attr_value...]
Note if white space occurs anywhere within the option argument string or the equal sign, "=", occurs within an string, then the string must be enclosed with either single or double quote marks.

PBS currently supports the following attributes within the -W option.

Defines the dependency between this and other jobs. The is in the form:

The argument is either a numeric count or a PBS job id according to type . If argument is a count, it must be greater than 0. If it is a job id and not fully specified in the form it will be expanded according to the default server rules which apply to job ids on most commands. If argument is null (the preceeding colon need not be specified), the dependency of the cooresponding type is cleared (unset).


Defines the group name under which the job is to run on the execution system. The argument is of the form:

Only one group name may be given per specified host. Only one of the specifications may be supplied without the corresponding specification. That group name will used for execution on any host not named in the argument list. The attribute is set to the value of If not set, the defaults to the primary group of the user under which the job will be run.


If the interactive attribute is specified, the job is an interactive job. The -I option is a alternative method of specifying this attribute.



Specifies the or attribute, listing which files are staged (copied) in before job start or staged out after the job completes execution. On completion of the job, all staged-in and staged-out files are removed from the execution system. The is in the form

regardless of the direction of the copy. The name is the name of the file on the system where the job executed. It may be an absolute path or relative to the home directory of the user. The name is the destination name on the host specified by The name may be absolute or relative to the user's home directory on the destination host. The use of wildcards in the file name is not recommended. Since rcp (or scp) is run via rsh, it will pick up matching names from the remote system. However, pbs_mom will does not expand the wildcards and will fail to delete the staged files on job termination. The file names map to a remote copy program (rcp) call on the execution system in the follow manner:
For stagein: rcp hostname:remote_file local_file
For stageout: rcp local_file hostname:remote_file

-z
Directs that the qsub command is not to write the job identifier assigned to the job to the command's standard output.

OPERANDS

STANDARD INPUT

INPUT FILES

STANDARD OUTPUT

STANDARD ERROR

ENVIRONMENT VARIABLES

EXTENDED DESCRIPTION

EXIT STATUS

SEE ALSO