1qsub(1B)                              PBS                             qsub(1B)
2
3
4

NAME

6       qsub - submit pbs job
7

SYNOPSIS

9       qsub   [-a   date_time]   [-A  account_string]  [-b  secs]  [-c  check‐
10       point_options] [-C directive_prefix] [-d path] [-D path] [-e path] [-f]
11       [-h]  [-I] [-j join] [-k keep] [-l resource_list] [-m mail_options] [-M
12       user_list]  [-N  name]  [-o  path]  [-p   priority]   [-P   proxy_user‐
13       name[:group]]  [-q destination] [-r c] [-S path_list] [-t num_jobs] [-T
14       prologue/epilogue script_name] [-u user_list] [-v  variable_list]  [-V]
15       [-w] path [-W additional_attributes] [-x] [-X] [-z] [script]
16

DESCRIPTION

18       To  create  a  job is to submit an executable script to a batch server.
19       The batch server will be the default server unless  the  -q  option  is
20       specified.   See  discussion of PBS_DEFAULT under Environment Variables
21       below.  Typically, the script is a shell script which will be  executed
22       by a command shell such as sh or csh.
23
24       Options on the qsub command allow the specification of attributes which
25       affect the behavior of the job.
26
27       The qsub command will pass certain environment variables in  the  Vari‐
28       able_List  attribute  of the job.  These variables will be available to
29       the job.  The value for the following variables will be taken from  the
30       environment  of  the  qsub  command:  HOME,  LANG, LOGNAME, PATH, MAIL,
31       SHELL, and TZ.  These values will be assigned to a new  name  which  is
32       the  current  name prefixed with the string "PBS_O_".  For example, the
33       job will have access to an environment variable named PBS_O_HOME  which
34       have the value of the variable HOME in the qsub command environment.
35
36       In  addition  to the above, the following environment variables will be
37       available to the batch job.
38
39       PBS_O_HOST
40              the name of the host upon which the qsub command is running.
41
42       PBS_SERVER
43              the hostname of the pbs_server which qsub submits the job to.
44
45       PBS_O_QUEUE
46              the name of the original queue to which the job was submitted.
47
48       PBS_O_WORKDIR
49              the absolute path of the current working directory of  the  qsub
50              command.
51
52       PBS_ARRAYID
53              each  member of a job array is assigned a unique identifier (see
54              -t)
55
56       PBS_ENVIRONMENT
57              set to PBS_BATCH to indicate the job  is  a  batch  job,  or  to
58              PBS_INTERACTIVE  to  indicate  the job is a PBS interactive job,
59              see -I option.
60
61       PBS_JOBID
62              the job identifier assigned to the job by the batch system.
63
64       PBS_JOBNAME
65              the job name supplied by the user.
66
67       PBS_NODEFILE
68              the name of the file contain the list of nodes assigned  to  the
69              job (for parallel and cluster systems).
70
71       PBS_QUEUE
72              the name of the queue from which the job is executed.
73

OPTIONS

75       -a date_time
76               Declares  the  time  after which the job is eligible for execu‐
77               tion.
78
79               The     date_time     argument     is     in     the      form:
80               [[[[CC]YY]MM]DD]hhmm[.SS]
81
82               Where  CC is the first two digits of the year (the century), YY
83               is the second two digits of the year, MM is the two digits  for
84               the  month,  DD  is the day of the month, hh is the hour, mm is
85               the minute, and the optional SS is the seconds.
86
87               If the month, MM, is not specified, it will default to the cur‐
88               rent  month  if the specified day DD, is in the future.  Other‐
89               wise, the month will be set to next month.   Likewise,  if  the
90               day, DD, is not specified, it will default to today if the time
91               hhmm is in the future.  Otherwise,  the  day  will  be  set  to
92               tomorrow.   For  example, if you submit a job at 11:15am with a
93               time of -a 1110, the job will be eligible  to  run  at  11:10am
94               tomorrow.
95
96       -A account_string
97               Defines  the  account  string  associated  with  the  job.  The
98               account_string is an undefined  string  of  characters  and  is
99               interpreted  by the server which executes the job.  See section
100               2.7.1 of the PBS ERS.
101
102       -b seconds
103               Defines the maximum number of seconds qsub will block  attempt‐
104               ing  to  contact  pbs_server.   If pbs_server is down, or for a
105               variety of communication failures, qsub will continually  retry
106               connecting  to pbs_server for job submission.  This value over‐
107               rides the CLIENTRETRY parameter in torque.cfg.  This is a  non-
108               portable  TORQUE  extension.   Portability-minded users can use
109               the PBS_CLIENTRETRY environmental variable.  A  negative  value
110               is interpreted as infinity.  The default is 0.
111
112       -c checkpoint_options
113               Defines  the  options  that  will apply to the job.  If the job
114               executes upon a host which does not support  checkpoint,  these
115               options will be ignored.
116
117               Valid checkpoint options are:
118
119               none
120                  No checkpointing is to be performed.
121
122               enabled
123                  Specify that checkpointing is allowed but must be explicitly
124                  invoked by either the qhold or qchkpt commands.
125
126               shutdown
127                  Specify that checkpointing is to be done on a job at pbs_mom
128                  shutdown.
129
130               periodic
131                  Specify  that periodic checkpointing is enabled. The default
132                  interval is 10 minutes and can be  changed  by  the  $check‐
133                  point_interval  option in the mom config file or by specify‐
134                  ing an interval when the job is submitted
135
136               interval=minutes
137                  Checkpointing is to be performed at an interval of  minutes,
138                  which  is the integer number of minutes of wall time used by
139                  the job.  This value must be greater than zero.
140
141               depth=number
142                  Specify a number (depth) of checkpoint images to be kept  in
143                  the checkpoint directory.
144
145               dir=path
146                  Specify     a     checkpoint     directory    (default    is
147                  /var/spool/torque/checkpoint).
148
149       -C directive_prefix
150               Defines the prefix that declares a directive to the  qsub  com‐
151               mand  within  the  script  file.   See  the paragraph on script
152               directives in the Extended Description section.
153
154               If the -C option is presented with a directive_prefix  argument
155               that is the null string, qsub will not scan the script file for
156               directives.
157
158       -d path Defines the working directory path to be used for the job.   If
159               the  -d  option is not specified, the default working directory
160               is the home directory.  This option sets the environment  vari‐
161               able PBS_O_INITDIR.
162
163       -D path Defines the root directory to be used for the job.  This option
164               sets the environment variable PBS_O_ROOTDIR.
165
166       -e path Defines the path to be used for the standard  error  stream  of
167               the batch job.  The path argument is of the form:
168                   [hostname:][path_name]
169               where  hostname is the name of a host to which the file will be
170               returned and path_name is the path name on  that  host  in  the
171               syntax  recognized  by POSIX.  The argument will be interpreted
172               as follows:
173
174               path_name
175                      Where path_name is not an absolute path name,  then  the
176                      qsub  command  will expand the path name relative to the
177                      current working directory of the command.   The  command
178                      will  supply  the name of the host upon which it is exe‐
179                      cuting for the hostname component.
180
181               hostname:path_name
182                      Where path_name is not an absolute path name,  then  the
183                      qsub  command  will not expand the path name relative to
184                      the current working directory of the command.  On deliv‐
185                      ery  of  the  standard  error,  the  path  name  will be
186                      expanded relative to the user's home  directory  on  the
187                      hostname system.
188
189               path_name
190                      Where  path_name  specifies  an absolute path name, then
191                      the qsub will supply the name of the host on which it is
192                      executing for the hostname
193
194               hostname:path_name
195                      Where  path_name  specifies  an  absolute path name, the
196                      path will be used as specified.  hostname.
197
198               hostname:
199                      Where hostname specifies the name of the host  that  the
200                      file should be returned to. The path will be the default
201                      file name.
202
203               If the -e option is not specified or the path_name is not spec‐
204               ified or is specified and is a directory, the default file name
205               for the standard error stream will be used.  The  default  name
206               has the following form:
207                   job_name.esequence_number
208               where  job_name  is  the  name  of  the job, see -N option, and
209               sequence_number is the job number assigned when the job is sub‐
210               mitted.
211
212       -f      Specifies  that  the  job is fault tolerant. The fault_tolerant
213               attribute will be set to true, which indicates that the job can
214               survive  the loss of a mom other than the "mother superior" mom
215               (the first node in the exec hosts )
216
217       -h      Specifies that a user hold be applied to the job at  submission
218               time.
219
220       -I      Declares  that  the  job is to be run "interactively".  The job
221               will be queued and scheduled as any PBS  batch  job,  but  when
222               executed,  the standard input, output, and error streams of the
223               job are connected through qsub to the terminal session in which
224               qsub is running.  Interactive jobs are forced to not rerunable.
225               See the "Extended Description" paragraph for addition  informa‐
226               tion of interactive jobs.
227
228       -j join Declares if the standard error stream of the job will be merged
229               with the standard output stream of the job.
230
231               An option argument value of oe directs  that  the  two  streams
232               will  be  merged,  intermixed,  as  standard output.  An option
233               argument value of eo directs  that  the  two  streams  will  be
234               merged, intermixed, as standard error.
235
236               If  the  join argument is n or the option is not specified, the
237               two streams will be two separate files.
238
239       -k keep Defines which (if either) of standard output or standard  error
240               will  be  retained on the execution host.  If set for a stream,
241               this option overrides the path name for that  stream.   If  not
242               set, neither stream is retained on the execution host.
243
244               The  argument  is  either  the single letter "e" or "o", or the
245               letters "e" and "o" combined in either order.  Or the  argument
246               is the letter "n".
247
248               e  The  standard  error  stream is to retained on the execution
249                  host.  The  stream will be placed in the home  directory  of
250                  the  user  under  whose  user id the job executed.  The file
251                  name will be the default file name given  by:  job_name.ese‐
252                  quence where job_name is the name specified for the job, and
253                  sequence is the sequence number component of the job identi‐
254                  fier.
255
256               o  The  standard  output stream is to retained on the execution
257                  host.  The  stream will be placed in the home  directory  of
258                  the  user  under  whose  user id the job executed.  The file
259                  name will be the default file name given  by:  job_name.ose‐
260                  quence where job_name is the name specified for the job, and
261                  sequence is the sequence number component of the job identi‐
262                  fier.
263
264               eo Both  the standard output and standard error streams will be
265                  retained.
266
267               oe Both the standard output and standard error streams will  be
268                  retained.
269
270               n  Neither stream is retained.
271
272       -l resource_list
273               Defines  the  resources that are required by the job and estab‐
274               lishes a limit to the amount of resource that can be  consumed.
275               If  not  set  for  a  generally available resource, such as CPU
276               time, the limit is infinite.  The resource_list argument is  of
277               the form:
278                   resource_name[=[value]][,resource_name[=[value]],...]
279
280       -m mail_options
281               Defines  the set of conditions under which the execution server
282               will send a mail message about the job.  The mail_options argu‐
283               ment  is a string which consists of either the single character
284               "n", or one or more of the characters "a", "b", and "e".
285
286               If the character "n" is specified, no mail will be sent.
287
288               For the letters "a", "b", and "e":
289
290               a  mail is sent when the job is aborted by the batch system.
291
292               b  mail is sent when the job begins execution.
293
294               e  mail is sent when the job terminates.
295
296               If the -m option is not specified, mail will be sent if the job
297               is aborted.
298
299       -M user_list
300               Declares  the  list of users to whom mail is sent by the execu‐
301               tion server when it sends mail about the job.
302
303               The user_list argument is of the form:
304                   user[@host][,user[@host],...]
305               If unset, the list defaults to the submitting user at the  qsub
306               host, i.e. the job owner.
307
308       -N name Declares  a  name for the job.  The name specified may be up to
309               and including 15 characters in  length.   It  must  consist  of
310               printable,  non white space characters with the first character
311               alphabetic.
312
313               If the -N option is not specified, the job  name  will  be  the
314               base name of the job script file specified on the command line.
315               If no script file name was specified and the  script  was  read
316               from  the  standard  input,  then  the  job name will be set to
317               STDIN.
318
319       -o path Defines the path to be used for the standard output  stream  of
320               the batch job.  The path argument is of the form:
321                   [hostname:][path_name]
322               where  hostname is the name of a host to which the file will be
323               returned and path_name is the path name on  that  host  in  the
324               syntax  recognized  by POSIX.  The argument will be interpreted
325               as follows:
326
327               path_name
328                      Where path_name is not an absolute path name,  then  the
329                      qsub  command  will expand the path name relative to the
330                      current working directory of the command.   The  command
331                      will  supply  the name of the host upon which it is exe‐
332                      cuting for the hostname component.
333
334               hostname:path_name
335                      Where path_name is not an absolute path name,  then  the
336                      qsub  command  will not expand the path name relative to
337                      the current working directory of the command.  On deliv‐
338                      ery  of  the  standard  output,  the  path  name will be
339                      expanded relative to the user's home  directory  on  the
340                      hostname system.
341
342               path_name
343                      Where  path_name  specifies  an absolute path name, then
344                      the qsub will supply the name of the host on which it is
345                      executing for the hostname
346
347               hostname:path_name
348                      Where  path_name  specifies  an  absolute path name, the
349                      path will be used as specified.  hostname.
350
351               hostname:
352                      Where hostname specifies the name of the host  that  the
353                      file should be returned to. The path will be the default
354                      file name.
355
356               If the -o option is not specified or the path_name is not spec‐
357               ified or is specified and is a directory, the default file name
358               for the standard output stream will be used.  The default  name
359               has the following form:
360                   job_name.osequence_number
361               where  job_name  is  the  name  of  the job, see -N option, and
362               sequence_number is the job number assigned when the job is sub‐
363               mitted.
364
365       -p priority
366               Defines the priority of the job.  The priority argument must be
367               a integer between -1024 and +1023 inclusive.  The default is no
368               priority which is equivalent to a priority of zero.
369
370       -P proxy_user[:group]
371               Proxy  user  for whom the job should be submitted.  This option
372               is only available for the super user.
373
374       -q destination
375               Defines the destination of the job.  The  destination  names  a
376               queue, a server, or a queue at a server.
377
378               The  qsub  command will submit the script to the server defined
379               by the destination argument.  If the destination is  a  routing
380               queue,  the  job  may be routed by the server to a new destina‐
381               tion.
382
383               If the -q option is not specified, the qsub command will submit
384               the  script  to  the default server.  See PBS_DEFAULT under the
385               Environment Variables section on this man page and the PBS  ERS
386               section 2.7.4, "Default Server".
387
388               If  the  -q  option is specified, it is in one of the following
389               three forms:
390                   queue
391                   @server
392                   queue@server
393
394               If the destination argument names a queue and does not  name  a
395               server,  the  job  will  be submitted to the named queue at the
396               default server.
397
398               If the destination argument names a server and does not name  a
399               queue,  the  job  will be submitted to the default queue at the
400               named server.
401
402               If the destination argument names both a queue  and  a  server,
403               the  job  will  be  submitted  to  the named queue at the named
404               server.
405
406       -r y|n  Declares whether the job is rerunable.  See the qrerun command.
407               The option argument is a single character, either y or n.
408
409               If  the argument is "y", the job is rerunable.  If the argument
410               is "n", the job is not rerunable.  The default  value  is  'y',
411               rerunable.
412
413       -S path_list
414               Declares the shell that interprets the job script.
415
416               The option argument path_list is in the form:
417                   path[@host][,path[@host],...]
418               Only  one  path  may be specified for any host named.  Only one
419               path may be specified without the corresponding host name.  The
420               path  selected  will be the one with the host name that matched
421               the name of the execution host.  If no matching host is  found,
422               then  the  path  specified  without a host will be selected, if
423               present.
424
425               If the -S option is not specified, the option argument  is  the
426               null  string,  or  no entry from the path_list is selected, the
427               execution will use the user's  login  shell  on  the  execution
428               host.
429
430       -t array_request
431               Specifies  the task ids of a job array.  Single task arrays are
432               allowed.
433
434               The array_request argument is an integer id or a range of inte‐
435               gers.  Multiple  ids  or  id  ranges can be combined in a comma
436               delimted list. Examples : -t 1-100 or -t 1,10,50-100
437
438       -T script_name
439               Allows for per job prologue  and  epilogue  scripts.  The  full
440               script name will be prologue.[name] or epilogue.[name]. For the
441               job submission, only request the name of the prologue  or  epi‐
442               logue script.
443
444               Example: qsub -T prescript
445               Specifies to use the script prologue.prescript
446
447       -u user_list
448               Defines the user name under which the job is to run on the exe‐
449               cution system.
450
451               The user_list argument is of the form:
452                   user[@host][,user[@host],...]
453               Only one user name may be given per specified host.   Only  one
454               of  the  user specifications may be supplied without the corre‐
455               sponding host specification.  That user name will used for exe‐
456               cution  on  any host not named in the argument list.  If unset,
457               the user list defaults to the user who is running qsub.
458
459       -v variable_list
460               Expands the list of environment variables that are exported  to
461               the job.
462
463               In  addition  to  the  variables described in the "Description"
464               section above, variable_list names environment  variables  from
465               the  qsub  command  environment which are made available to the
466               job when it executes.  The variable_list is a  comma  separated
467               list  of strings of the form variable or variable=value.  These
468               variables and their values are passed to the job.
469
470       -V      Declares that all environment variables in the  qsub  command's
471               environment are to be exported to the batch job.
472
473       -w path Defines  the working directory path to be used for the job.  If
474               the -w option is not specified, the default  working  directory
475               is  the  current  directory.   This option sets the environment
476               variable PBS_O_WORKDIR.
477
478       -W additional_attributes
479               The -W option allows for the specification  of  additional  job
480               attributes.  The general syntax of the -W is in the form:
481                   -W attr_name=attr_value[,attr_name=attr_value...]
482               Note  if white space occurs anywhere within the option argument
483               string or the equal sign, "=", occurs within an attribute_value
484               string,  then the string must be enclosed with either single or
485               double quote marks.
486
487               PBS currently supports the following attributes within  the  -W
488               option.
489
490               depend=dependency_list
491               Defines the dependency between this and other jobs.  The depen‐
492               dency_list is in the form:
493               type[:argument[:argument...][,type:argument...].
494               The argument is either a numeric count or a PBS job id  accord‐
495               ing  to type .  If argument is a count, it must be greater than
496               0.  If it is a job id and  not  fully  specified  in  the  form
497               seq_number.server.name,  it  will  be expanded according to the
498               default server rules which apply to job IDs on  most  commands.
499               If  argument  is  null  (the preceding colon need not be speci‐
500               fied), the dependency of  the  corresponding  type  is  cleared
501               (unset).
502
503                   synccount:count
504                       This  job  is the first in a set of jobs to be executed
505                       at the same time.  Count is the  number  of  additional
506                       jobs in the set.
507
508                   syncwith:jobid
509                       This job is an additional member of a set of jobs to be
510                       executed at the same time.  In the above and  following
511                       dependency  types,  jobid  is the job identifier of the
512                       first job in the set.
513
514                   after:jobid[:jobid...]
515                       This job may be scheduled for execution  at  any  point
516                       after jobs jobid have started execution.
517
518                   afterok:jobid[:jobid...]
519                       This job may be scheduled for execution only after jobs
520                       jobid have terminated with  no  errors.   See  the  csh
521                       warning under "Extended Description".
522
523                   afternotok:jobid[:jobid...]
524                       This job may be scheduled for execution only after jobs
525                       jobid have terminated with errors.  See the csh warning
526                       under "Extended Description".
527
528                   afterany:jobid[:jobid...]
529                       This  job  may  be  scheduled  for execution after jobs
530                       jobid have terminated, with or without errors.
531
532                   on:count
533                       This job may be scheduled  for  execution  after  count
534                       dependencies  on  other jobs have been satisfied.  This
535                       form is used in conjunction  with  one  of  the  before
536                       forms, see below.
537
538                   before:jobid[:jobid...]
539                       When  this  job has begun execution, then jobs jobid...
540                       may begin.
541
542                   beforeok:jobid[:jobid...]
543                       If this job terminates execution without  errors,  then
544                       jobs  jobid...  may  begin.   See the csh warning under
545                       "Extended Description".
546
547                   beforenotok:jobid[:jobid...]
548                       If this job terminates execution with errors, then jobs
549                       jobid...   may   begin.   See  the  csh  warning  under
550                       "Extended Description".
551
552                   beforeany:jobid[:jobid...]
553                       When this job terminates execution, jobs  jobid...  may
554                       begin.
555
556                       If  any  of  the before forms are used, the jobs refer‐
557                       enced by jobid must have been submitted with  a  depen‐
558                       dency type of on.
559
560                       If  any  of  the before forms are used, the jobs refer‐
561                       enced by jobid must have the  same  owner  as  the  job
562                       being submitted.  Otherwise, the dependency is ignored.
563
564                   Error  processing  of the existence, state, or condition of
565                   the job on which the newly submitted job is a deferred ser‐
566                   vice,  i.e. the check is performed after the job is queued.
567                   If an error is detected, the new job will be deleted by the
568                   server.  Mail will be sent to the job submitter stating the
569                   error.
570
571                   Dependency examples:
572                   qsub -W depend=afterok:123.big.iron.com /tmp/script
573                   qsub      -W      depend=before:234.hunk1.com:235.hunk1.com
574                   /tmp/script
575
576               group_list=g_list
577               Defines  the  group  name  under which the job is to run on the
578               execution system.  The g_list argument is of the form:
579               group[@host][,group[@host],...]
580               Only one group name may be given per specified host.  Only  one
581               of  the group specifications may be supplied without the corre‐
582               sponding host specification.  That group  name  will  used  for
583               execution  on  any host not named in the argument list.  If not
584               set, the group_list defaults to the primary group of  the  user
585               under which the job will be run.
586
587               interactive=true
588               If the interactive attribute is specified, the job is an inter‐
589               active job.  The -I option is a alternative method of  specify‐
590               ing this attribute.
591
592               stagein=file_list
593               stageout=file_list
594               Specifies  which  files are staged (copied) in before job start
595               or staged out after the job completes execution.  On completion
596               of the job, all staged-in and staged-out files are removed from
597               the execution system.  The file_list is in the form
598               local_file@hostname:remote_file[,...]
599               regardless of the direction of the copy.  The  name  local_file
600               is  the  name of the file on the system where the job executed.
601               It may be an absolute path or relative to the home directory of
602               the  user.  The name remote_file is the destination name on the
603               host specified by hostname.  The name may be absolute or  rela‐
604               tive to the user's home directory on the destination host.  The
605               use of wildcards in the file name is not recommended.  The file
606               names  map to a remote copy program (rcp) call on the execution
607               system in the follow manner:
608               For stagein:   rcp hostname:remote_file local_file
609               For stageout:  rcp local_file hostname:remote_file
610               Data staging examples:
611               -W stagein=/tmp/input.txt@headnode:/home/user/input.txt
612               -W stageout=/tmp/output.txt@headnode:/home/user/output.txt
613               If TORQUE has been compiled with wordexp  support,  then  vari‐
614               ables  can  be  used  in  the  specified paths.  Currently only
615               $PBS_JOBID, $HOME, and $TMPDIR are supported for stagein.
616
617               umask=XXX
618               Sets umask used to create stdout  and  stderr  spool  files  in
619               pbs_mom  spool directory. Values starting with 0 are treated as
620               octal values, otherwise the value is treated as a decimal umask
621               value.
622
623       -x      When  running  an interactive job, the -x flag makes it so that
624               the script won't be parsed for PBS directives, but instead will
625               be  a  command  that  is  launched once the interactive job has
626               started. The job will terminate at the completion of this  com‐
627               mand.
628
629       -X      Enables  X11 forwarding.  The DISPLAY environment variable must
630               be set.
631
632       -z      Directs that the qsub command is not to write the  job  identi‐
633               fier assigned to the job to the command's standard output.
634

OPERANDS

636       The  qsub  command  accepts  a  script  operand that is the path to the
637       script of the job.  If the path is relative, it will be expanded  rela‐
638       tive to the working directory of the qsub command.
639
640       If  the  script  operand  is  not provided or the operand is the single
641       character "-", the qsub command reads the script from  standard  input.
642       When  the  script is being read from Standard Input, qsub will copy the
643       file to a temporary file.  This temporary file is passed to the library
644       interface  routine  pbs_submit.   The temporary file is removed by qsub
645       after pbs_submit returns or upon the receipt of a  signal  which  would
646       cause qsub to terminate.
647

STANDARD INPUT

649       The  qsub  command  reads the script for the job from standard input if
650       the script operand is missing or is the single character "-".
651

INPUT FILES

653       The script file is read by the qsub command.  Qsub acts upon any direc‐
654       tives found in the script.
655
656       When  the  job  is  created, a copy of the script file is made and that
657       copy cannot be modified.
658

STANDARD OUTPUT

660       Unless the -z option is set, the job identifier  assigned  to  the  job
661       will be written to standard output if the job is successfully created.
662

STANDARD ERROR

664       The  qsub command will write a diagnostic message to standard error for
665       each error occurrence.
666

ENVIRONMENT VARIABLES

668       The values of some or all of the variables in the qsub command's  envi‐
669       ronment are exported with the job, see the -v and -V options.
670
671       The  environment  variable  PBS_DEFAULT defines the name of the default
672       server.   Typically, it corresponds to the system name of the  host  on
673       which the server is running.  If PBS_DEFAULT is not set, the default is
674       defined by an administrator established file.
675
676       The environment variable PBS_DPREFIX determines the prefix string which
677       identifies directives in the script.
678
679       The  environment variable PBS_CLIENTRETRY defines the maximum number of
680       seconds qsub will block.  See the -b option above.  Despite  the  name,
681       currently qsub is the only client that supports this option.
682

TORQUE.CFG

684       The  torque.cfg  file, located in PBS_SERVER_HOME (/var/spool/torque by
685       default) controls the behavior of the qsub command. This file  contains
686       a list of parameters and values separated by whitespace
687
688       QSUBSLEEP  takes  an integer operand which specifies time to sleep when
689       running qsub command.  Used to  prevent  users  from  overwhelming  the
690       scheduler.
691
692       SUBMITFILTER  specifies  the  path  to  the  submit filter used to pre-
693       process job submission. The default path is  $(libexecdir)/qsub_filter,
694       which  falls  back to /usr/local/sbin/torque_submitfilter for backwards
695       compatibility. This torque.cfg parameter overrides this default.
696
697       SERVERHOST specifies the value for the PBS_SERVER environment variable
698
699       QSUBHOST specifies the hostname for the jobs QSUB_O_HOST variable
700
701       QSUBSENDUID specifies a uid to use for the jobs PBS_O_UID variable
702
703       XAUTHPATH specifies the path to xauth
704
705       CLIENTRETRY specifies the integer seconds  between  retry  attempts  to
706       communicate with pbs_server
707
708       VALIDATEGROUP  set  this  parameter to force qsub to verify the submit‐
709       ter's group id
710
711       DEFAULTCKPT  specifies  the  default  value  for  the  jobs  checkpoint
712       attribute.  The user overrides this with the -c qsub option.
713
714       VALIDATEPATH  set  this parameter to force qsub to validate local exis‐
715       tence of a "-d" working directory
716
717       RERUNNABLEBYDEFAULT this parameter specifies if a job is rerunnable  by
718       default.  The  default  is  true,  setting  this  to  false  causes the
719       rerunnable attribute value to be false unless the users specifies  oth‐
720       erwise with the -r option
721
722       FAULT_TOLERANT_BY_DEFAULT  this  parameter  specifies if a job is fault
723       tolerant by default.  The default  value  for  the  fault_tolerant  job
724       attribute  is  false, setting this parameter to true causes the default
725       value of the attribute to be true. The user can specify  their  prefer‐
726       ence with the -f qsub option.
727
728       For example:
729              QSUBSLEEP  2
730              RERUNNABLEBYDEFAULT  false
731
732

EXTENDED DESCRIPTION

734       Script Processing:
735
736       A  job  script  may  consist of PBS directives, comments and executable
737       statements.   A  PBS  directive  provides  a  way  of  specifying   job
738       attributes in addition to the command line options.  For example:
739              :
740              #PBS -N Job_name
741              #PBS -l walltime=10:30,mem=320kb
742              #PBS -m be
743              #
744              step1 arg1 arg2
745              step2 arg3 arg4
746
747
748       The qsub command scans the lines of the script file for directives.  An
749       initial line in the script that begins with the characters "#!" or  the
750       character  ":"  will  be  ignored and scanning will start with the next
751       line.  Scanning will continue until the first executable line, that  is
752       a  line that is not blank, not a directive line, nor a line whose first
753       non white space character is "#".  If directives  occur  on  subsequent
754       lines, they will be ignored.
755
756       A  line  in the script file will be processed as a directive to qsub if
757       and only if the string of characters starting with the first non  white
758       space  character  on  the  line and of the same length as the directive
759       prefix matches the directive prefix.
760
761       The remainder of the directive line consists of the options to qsub  in
762       the same syntax as they appear on the command line.  The option charac‐
763       ter is to be preceded with the "-" character.
764
765       If an option is present in both a directive and on  the  command  line,
766       that option and its argument, if any, will be ignored in the directive.
767       The command line takes precedence.
768
769       If an option is present in a directive and not  on  the  command  line,
770       that  option  and  its argument, if any, will be processed as if it had
771       occurred on the command line.
772
773       The directive prefix string will be determined in order  of  preference
774       from:
775
776           The  value  of the -C option argument if the option is specified on
777           the command line.
778
779           The value of the environment variable PBS_DPREFIX if it is defined.
780
781           The four character string #PBS.
782
783       If the -C option is found in a directive in the script file, it will be
784       ignored.
785
786       User Authorization:
787
788       When  the  user submits a job from a system other than the one on which
789       the PBS Server is running, the name under which the job is to  be  exe‐
790       cuted  is  selected  according to the rules listed under the -u option.
791       The user submitting the job must be authorized to run the job under the
792       execution user name.  This authorization is provided if
793
794              (1)  The  host  on which qsub is run is trusted by the execution
795                   host (see /etc/hosts.equiv),
796
797              (2)  The execution user has an .rhosts file naming  the  submit‐
798                   ting user on the submitting host.
799
800       C-Shell .logout File:
801
802       The  following  warning  applies for users of the c-shell, csh.  If the
803       job is executed under the csh and a .logout file  exists  in  the  home
804       directory in which the job executes, the exit status of the job is that
805       of the .logout script, not the job script.  This may impact any  inter-
806       job  dependencies.   To preserve the job exit status, either remove the
807       .logout file or place the following line  as  the  first  line  in  the
808       .logout file
809          set EXITVAL = $status
810       and the following line as the last executable line in .logout
811          exit $EXITVAL
812
813       Interactive Jobs:
814
815       If the -I option is specified on the command line or in a script direc‐
816       tive, or if the "interactive" job attribute declared true  via  the  -W
817       option,  -W interactive=true, either on the command line or in a script
818       directive, the job is an interactive job.  The script will be processed
819       for  directives,  but  will not be included with the job.  When the job
820       begins execution, all input to the job is from the terminal session  in
821       which qsub is running.
822
823       When  an interactive job is submitted, the qsub command will not termi‐
824       nate when the job is submitted.  Qsub will remain running until the job
825       terminates, is aborted, or the user interrupts qsub with an SIGINT (the
826       control-C key).  If qsub is interrupted prior to  job  start,  it  will
827       query  if  the  user  wishes to exit.  If the user response "yes", qsub
828       exits and the job is aborted.
829
830       Once the interactive job has started execution,  input  to  and  output
831       from  the  job  pass  through  qsub.  Keyboard generated interrupts are
832       passed to the job.  Lines entered that begin with the tilde ('~') char‐
833       acter  and  contain  special sequences are escaped by qsub.  The recog‐
834       nized escape sequences are:
835
836              ~.     Qsub terminates execution.  The batch job is also  termi‐
837                     nated.
838
839              ~susp  Suspend  the  qsub  program if running under the C shell.
840                     "susp" is the suspend character, usually CNTL-Z.
841
842              ~asusp Suspend the input half of qsub  (terminal  to  job),  but
843                     allow  output  to  continue  to be displayed.  Only works
844                     under the C shell.   "asusp"  is  the  auxiliary  suspend
845                     character, usually CNTL-Y.
846

EXIT STATUS

848       Upon  successful  processing,  the  qsub exit status will be a value of
849       zero.
850
851       If the qsub command fails, the command exits with a value greater  than
852       zero.
853

SEE ALSO

855       qalter(1B),   qdel(1B),  qhold(1B),  qmove(1B),  qmsg(1B),  qrerun(1B),
856       qrls(1B),   qselect(1B),    qsig(1B),    qstat(1B),    pbs_connect(3B),
857       pbs_job_attributes(7B),                       pbs_queue_attributes(7B),
858       pbs_resources_irix5(7B),                         pbs_resources_sp2(7B),
859       pbs_resources_sunos4(7B),                    pbs_resources_unicos8(7B),
860       pbs_server_attributes(7B), and pbs_server(8B)
861
862
863
864
865Local                                                                 qsub(1B)
Impressum