Skip to content
Snippets Groups Projects
Commit f846d54b authored by Morris Jette's avatar Morris Jette
Browse files

Note how optional arguments to the commands are parsed in man pages

parent e063642d
No related branches found
No related tags found
No related merge requests found
...@@ -21,8 +21,8 @@ section). If no command is specified, then the value of ...@@ -21,8 +21,8 @@ section). If no command is specified, then the value of
\fBSallocDefaultCommand\fR is not set, then \fBsalloc\fR runs the \fBSallocDefaultCommand\fR is not set, then \fBsalloc\fR runs the
user's default shell. user's default shell.
The following document describes the the influence of various options on the The following document describes the the influence of various options on the
allocation of cpus to jobs and tasks. allocation of cpus to jobs and tasks.
.br .br
http://www.schedmd.com/slurmdocs/cpu_management.html http://www.schedmd.com/slurmdocs/cpu_management.html
...@@ -141,7 +141,7 @@ Users can specify which of these \fBfeatures\fR are required by their job ...@@ -141,7 +141,7 @@ Users can specify which of these \fBfeatures\fR are required by their job
using the constraint option. using the constraint option.
Only nodes having features matching the job constraints will be used to Only nodes having features matching the job constraints will be used to
satisfy the request. satisfy the request.
Multiple constraints may be specified with AND, OR, exclusive OR, Multiple constraints may be specified with AND, OR, exclusive OR,
resource counts, etc. resource counts, etc.
Supported \fbconstraint\fR options include: Supported \fbconstraint\fR options include:
.PD 1 .PD 1
...@@ -180,7 +180,7 @@ Specific counts of multiple resources may be specified by using the AND ...@@ -180,7 +180,7 @@ Specific counts of multiple resources may be specified by using the AND
operator and enclosing the options within square brackets. operator and enclosing the options within square brackets.
For example: "\fB\-\-constraint=[rack1*2&rack2*4]"\fR might For example: "\fB\-\-constraint=[rack1*2&rack2*4]"\fR might
be used to specify that two nodes must be allocated from nodes with the feature be used to specify that two nodes must be allocated from nodes with the feature
of "rack1" and four nodes must be allocated from nodes with the feature of "rack1" and four nodes must be allocated from nodes with the feature
"rack2". "rack2".
.RE .RE
...@@ -209,9 +209,9 @@ the SLURM_CPU_BIND environment variable value to "verbose". ...@@ -209,9 +209,9 @@ the SLURM_CPU_BIND environment variable value to "verbose".
The following informational environment variables are set when \fB\-\-cpu_bind\fR The following informational environment variables are set when \fB\-\-cpu_bind\fR
is in use: is in use:
.nf .nf
SLURM_CPU_BIND_VERBOSE SLURM_CPU_BIND_VERBOSE
SLURM_CPU_BIND_TYPE SLURM_CPU_BIND_TYPE
SLURM_CPU_BIND_LIST SLURM_CPU_BIND_LIST
.fi .fi
See the \fBENVIRONMENT VARIABLE\fR section for a more detailed description See the \fBENVIRONMENT VARIABLE\fR section for a more detailed description
...@@ -453,7 +453,10 @@ time period specified. ...@@ -453,7 +453,10 @@ time period specified.
If no argument is given, resources must be available immediately If no argument is given, resources must be available immediately
for the request to succeed. for the request to succeed.
By default, \fB\-\-immediate\fR is off, and the command By default, \fB\-\-immediate\fR is off, and the command
will block until resources become available. will block until resources become available. Since this option's
argument is optional, for proper parsing the single letter option must
be followed immediately with the value and not include a space between
them. For example "\-I60" and not "\-I 60".
.TP .TP
\fB\-J\fR, \fB\-\-job\-name\fR=<\fIjobname\fR> \fB\-J\fR, \fB\-\-job\-name\fR=<\fIjobname\fR>
...@@ -476,8 +479,11 @@ allocation has been revoked. The job allocation can be revoked for a ...@@ -476,8 +479,11 @@ allocation has been revoked. The job allocation can be revoked for a
couple of reasons: someone used \fBscancel\fR to revoke the allocation, couple of reasons: someone used \fBscancel\fR to revoke the allocation,
or the allocation reached its time limit. If you do not specify a signal or the allocation reached its time limit. If you do not specify a signal
name or number and SLURM is configured to signal the spawned command at job name or number and SLURM is configured to signal the spawned command at job
termination, the default signal is SIGHUP for interactive and SIGTERM for termination, the default signal is SIGHUP for interactive and SIGTERM for
non\-interactive sessions. non\-interactive sessions. Since this option's argument is optional,
for proper parsing the single letter option must be followed
immediately with the value and not include a space between them. For
example "\-K1" and not "\-K 1".
.TP .TP
\fB\-k\fR, \fB\-\-no\-kill\fR \fB\-k\fR, \fB\-\-no\-kill\fR
...@@ -610,7 +616,7 @@ Also see \fB\-\-mem\-per\-cpu\fR. ...@@ -610,7 +616,7 @@ Also see \fB\-\-mem\-per\-cpu\fR.
\fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive. \fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive.
NOTE: Enforcement of memory limits currently requires enabling of NOTE: Enforcement of memory limits currently requires enabling of
accounting, which samples memory use on a periodic basis (data need accounting, which samples memory use on a periodic basis (data need
not be stored, just collected). A task may exceed the memory limit not be stored, just collected). A task may exceed the memory limit
until the next periodic accounting sample. until the next periodic accounting sample.
.TP .TP
...@@ -622,7 +628,7 @@ seen using the \fBscontrol show config\fR command. ...@@ -622,7 +628,7 @@ seen using the \fBscontrol show config\fR command.
Note that if the job's \fB\-\-mem\-per\-cpu\fR value exceeds the configured Note that if the job's \fB\-\-mem\-per\-cpu\fR value exceeds the configured
\fBMaxMemPerCPU\fR, then the user's limit will be treated as a memory limit \fBMaxMemPerCPU\fR, then the user's limit will be treated as a memory limit
per task; \fB\-\-mem\-per\-cpu\fR will be reduced to a value no larger than per task; \fB\-\-mem\-per\-cpu\fR will be reduced to a value no larger than
\fBMaxMemPerCPU\fR; \fB\-\-cpus\-per\-task\fR will be set and value of \fBMaxMemPerCPU\fR; \fB\-\-cpus\-per\-task\fR will be set and value of
\fB\-\-cpus\-per\-task\fR multiplied by the new \fB\-\-mem\-per\-cpu\fR \fB\-\-cpus\-per\-task\fR multiplied by the new \fB\-\-mem\-per\-cpu\fR
value will equal the original \fB\-\-mem\-per\-cpu\fR value specified by value will equal the original \fB\-\-mem\-per\-cpu\fR value specified by
the user. the user.
...@@ -653,9 +659,9 @@ The following informational environment variables are set when ...@@ -653,9 +659,9 @@ The following informational environment variables are set when
\fB\-\-mem_bind\fR is in use: \fB\-\-mem_bind\fR is in use:
.nf .nf
SLURM_MEM_BIND_VERBOSE SLURM_MEM_BIND_VERBOSE
SLURM_MEM_BIND_TYPE SLURM_MEM_BIND_TYPE
SLURM_MEM_BIND_LIST SLURM_MEM_BIND_LIST
.fi .fi
See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description
...@@ -817,7 +823,7 @@ other jobs cannot use them for some period of time. (Note that the ...@@ -817,7 +823,7 @@ other jobs cannot use them for some period of time. (Note that the
SLURM job is subject to the normal constraints on jobs, including time SLURM job is subject to the normal constraints on jobs, including time
limits, so that eventually the job will terminate and the resources limits, so that eventually the job will terminate and the resources
will be freed, or you can terminate the job manually using the will be freed, or you can terminate the job manually using the
\fBscancel\fR command.) \fBscancel\fR command.)
.TP .TP
\fB\-O\fR, \fB\-\-overcommit\fR \fB\-O\fR, \fB\-\-overcommit\fR
...@@ -885,7 +891,7 @@ When a tree topology is used, this defines the maximum count of switches ...@@ -885,7 +891,7 @@ When a tree topology is used, this defines the maximum count of switches
desired for the job allocation and optionally the maximum time to wait desired for the job allocation and optionally the maximum time to wait
for that number of switches. If SLURM finds an allocation containing more for that number of switches. If SLURM finds an allocation containing more
switches than the count specified, the job remains pending until it either finds switches than the count specified, the job remains pending until it either finds
an allocation with desired switch count or the time limit expires. an allocation with desired switch count or the time limit expires.
It there is no switch count limit, there is no delay in starting the job. It there is no switch count limit, there is no delay in starting the job.
Acceptable time formats include "minutes", "minutes:seconds", Acceptable time formats include "minutes", "minutes:seconds",
"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
...@@ -919,12 +925,12 @@ above when task/affinity plugin is enabled. ...@@ -919,12 +925,12 @@ above when task/affinity plugin is enabled.
Set a minimum time limit on the job allocation. Set a minimum time limit on the job allocation.
If specified, the job may have it's \fB\-\-time\fR limit lowered to a value If specified, the job may have it's \fB\-\-time\fR limit lowered to a value
no lower than \fB\-\-time\-min\fR if doing so permits the job to begin no lower than \fB\-\-time\-min\fR if doing so permits the job to begin
execution earlier than otherwise possible. execution earlier than otherwise possible.
The job's time limit will not be changed after the job is allocated resources. The job's time limit will not be changed after the job is allocated resources.
This is performed by a backfill scheduling algorithm to allocate resources This is performed by a backfill scheduling algorithm to allocate resources
otherwise reserved for higher priority jobs. otherwise reserved for higher priority jobs.
Acceptable time formats include "minutes", "minutes:seconds", Acceptable time formats include "minutes", "minutes:seconds",
"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
"days\-hours:minutes:seconds". "days\-hours:minutes:seconds".
.TP .TP
......
...@@ -26,7 +26,11 @@ Print a help message describing all options \fBsprio\fR. ...@@ -26,7 +26,11 @@ Print a help message describing all options \fBsprio\fR.
.TP .TP
\fB\-j <job_id_list>\fR, \fB\-\-jobs=<job_id_list>\fR \fB\-j <job_id_list>\fR, \fB\-\-jobs=<job_id_list>\fR
Requests a comma separated list of job ids to display. Defaults to all jobs. Requests a comma separated list of job ids to display. Defaults to
all jobs. Since this option's argument is optional, for proper parsing
the single letter option must be followed immediately with the value
and not include a space between them. For example "\-j1008,1009" and
not "\-j 1008,1009".
.TP .TP
\fB\-l\fR, \fB\-\-long\fR \fB\-l\fR, \fB\-\-long\fR
......
...@@ -49,7 +49,10 @@ Requests a comma separated list of job ids to display. Defaults to all jobs. ...@@ -49,7 +49,10 @@ Requests a comma separated list of job ids to display. Defaults to all jobs.
The \fB\-\-jobs=<job_id_list>\fR option may be used in conjunction with the The \fB\-\-jobs=<job_id_list>\fR option may be used in conjunction with the
\fB\-\-steps\fR option to print step information about specific jobs. \fB\-\-steps\fR option to print step information about specific jobs.
Note: If a list of job ids is provided, the jobs are displayed even if Note: If a list of job ids is provided, the jobs are displayed even if
they are on hidden partitions. they are on hidden partitions. Since this option's argument is optional,
for proper parsing the single letter option must be followed immediately
with the value and not include a space between them. For example "\-j1008"
and not "\-j 1008".
.TP .TP
\fB\-l\fR, \fB\-\-long\fR \fB\-l\fR, \fB\-\-long\fR
...@@ -354,7 +357,11 @@ Specify the reservation of the jobs to view. ...@@ -354,7 +357,11 @@ Specify the reservation of the jobs to view.
\fB\-s\fR, \fB\-\-steps\fR \fB\-s\fR, \fB\-\-steps\fR
Specify the job steps to view. This flag indicates that a comma separated list Specify the job steps to view. This flag indicates that a comma separated list
of job steps to view follows without an equal sign (see examples). of job steps to view follows without an equal sign (see examples).
The job step format is "job_id.step_id". Defaults to all job steps. The job step format is "job_id.step_id". Defaults to all job
steps. Since this option's argument is optional, for proper parsing
the single letter option must be followed immediately with the value
and not include a space between them. For example "\-s1008.0" and not
"\-s 1008.0".
.TP .TP
\fB\-S <sort_list>\fR, \fB\-\-sort=<sort_list>\fR \fB\-S <sort_list>\fR, \fB\-\-sort=<sort_list>\fR
......
...@@ -10,8 +10,8 @@ srun \- Run parallel jobs ...@@ -10,8 +10,8 @@ srun \- Run parallel jobs
Run a parallel job on cluster managed by SLURM. If necessary, srun will Run a parallel job on cluster managed by SLURM. If necessary, srun will
first create a resource allocation in which to run the parallel job. first create a resource allocation in which to run the parallel job.
The following document describes the the influence of various options on the The following document describes the the influence of various options on the
allocation of cpus to jobs and tasks. allocation of cpus to jobs and tasks.
.br .br
http://www.schedmd.com/slurmdocs/cpu_management.html http://www.schedmd.com/slurmdocs/cpu_management.html
...@@ -132,7 +132,7 @@ Users can specify which of these \fBfeatures\fR are required by their job ...@@ -132,7 +132,7 @@ Users can specify which of these \fBfeatures\fR are required by their job
using the constraint option. using the constraint option.
Only nodes having features matching the job constraints will be used to Only nodes having features matching the job constraints will be used to
satisfy the request. satisfy the request.
Multiple constraints may be specified with AND, OR, exclusive OR, Multiple constraints may be specified with AND, OR, exclusive OR,
resource counts, etc. resource counts, etc.
Supported \fbconstraint\fR options include: Supported \fbconstraint\fR options include:
.PD 1 .PD 1
...@@ -171,7 +171,7 @@ Specific counts of multiple resources may be specified by using the AND ...@@ -171,7 +171,7 @@ Specific counts of multiple resources may be specified by using the AND
operator and enclosing the options within square brackets. operator and enclosing the options within square brackets.
For example: "\fB\-\-constraint=[rack1*2&rack2*4]"\fR might For example: "\fB\-\-constraint=[rack1*2&rack2*4]"\fR might
be used to specify that two nodes must be allocated from nodes with the feature be used to specify that two nodes must be allocated from nodes with the feature
of "rack1" and four nodes must be allocated from nodes with the feature of "rack1" and four nodes must be allocated from nodes with the feature
"rack2". "rack2".
.RE .RE
...@@ -205,9 +205,9 @@ the SLURM_CPU_BIND environment variable value to "verbose". ...@@ -205,9 +205,9 @@ the SLURM_CPU_BIND environment variable value to "verbose".
The following informational environment variables are set when \fB\-\-cpu_bind\fR The following informational environment variables are set when \fB\-\-cpu_bind\fR
is in use: is in use:
.nf .nf
SLURM_CPU_BIND_VERBOSE SLURM_CPU_BIND_VERBOSE
SLURM_CPU_BIND_TYPE SLURM_CPU_BIND_TYPE
SLURM_CPU_BIND_LIST SLURM_CPU_BIND_LIST
.fi .fi
See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description
...@@ -339,7 +339,7 @@ allocation will include four CPUs. The job step allocation will then launch two ...@@ -339,7 +339,7 @@ allocation will include four CPUs. The job step allocation will then launch two
threads per CPU for a total of two tasks. threads per CPU for a total of two tasks.
\fBWARNING\fR: When srun is executed from within salloc or sbatch, \fBWARNING\fR: When srun is executed from within salloc or sbatch,
there are configurations and options which can result in inconsistent there are configurations and options which can result in inconsistent
allocations when \-c has a value greater than \-c on salloc or sbatch. allocations when \-c has a value greater than \-c on salloc or sbatch.
.TP .TP
\fB\-d\fR, \fB\-\-dependency\fR=<\fIdependency_list\fR> \fB\-d\fR, \fB\-\-dependency\fR=<\fIdependency_list\fR>
...@@ -493,7 +493,10 @@ time period specified. ...@@ -493,7 +493,10 @@ time period specified.
If no argument is given, resources must be available immediately If no argument is given, resources must be available immediately
for the request to succeed. for the request to succeed.
By default, \fB\-\-immediate\fR is off, and the command By default, \fB\-\-immediate\fR is off, and the command
will block until resources become available. will block until resources become available. Since this option's
argument is optional, for proper parsing the single letter option
must be followed immediately with the value and not include a
space between them. For example "\-I60" and not "\-I 60".
.TP .TP
\fB\-i\fR, \fB\-\-input\fR=<\fImode\fR> \fB\-i\fR, \fB\-\-input\fR=<\fImode\fR>
...@@ -508,10 +511,10 @@ a terminal is not possible. ...@@ -508,10 +511,10 @@ a terminal is not possible.
\fB\-J\fR, \fB\-\-job\-name\fR=<\fIjobname\fR> \fB\-J\fR, \fB\-\-job\-name\fR=<\fIjobname\fR>
Specify a name for the job. The specified name will appear along with Specify a name for the job. The specified name will appear along with
the job id number when querying running jobs on the system. The default the job id number when querying running jobs on the system. The default
is the supplied \fBexecutable\fR program's name. NOTE: This information is the supplied \fBexecutable\fR program's name. NOTE: This information
may be written to the slurm_jobacct.log file. This file is space delimited may be written to the slurm_jobacct.log file. This file is space delimited
so if a space is used in the \fIjobname\fR name it will cause problems in so if a space is used in the \fIjobname\fR name it will cause problems in
properly displaying the contents of the slurm_jobacct.log file when the properly displaying the contents of the slurm_jobacct.log file when the
\fBsacct\fR command is used. \fBsacct\fR command is used.
.TP .TP
...@@ -530,18 +533,21 @@ argument of zero will not terminate the job. A non\-zero argument or no ...@@ -530,18 +533,21 @@ argument of zero will not terminate the job. A non\-zero argument or no
argument will terminate the job. argument will terminate the job.
Note: This option takes precedence over the \fB\-W\fR, \fB\-\-wait\fR option Note: This option takes precedence over the \fB\-W\fR, \fB\-\-wait\fR option
to terminate the job immediately if a task exits with a non\-zero exit code. to terminate the job immediately if a task exits with a non\-zero exit code.
Since this option's argument is optional, for proper parsing the
single letter option must be followed immediately with the value and
not include a space between them. For example "\-K1" and not "\-K 1".
.TP .TP
\fB\-k\fR, \fB\-\-no\-kill\fR \fB\-k\fR, \fB\-\-no\-kill\fR
Do not automatically terminate a job of one of the nodes it has been Do not automatically terminate a job of one of the nodes it has been
allocated fails. This option is only recognized on a job allocation, allocated fails. This option is only recognized on a job allocation,
not for the submission of individual job steps. not for the submission of individual job steps.
The job will assume all responsibilities for fault\-tolerance. The job will assume all responsibilities for fault\-tolerance.
Tasks launch using this option will not be considered terminated Tasks launch using this option will not be considered terminated
(e.g. \fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR and (e.g. \fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR and
\fB\-W\fR, \fB\-\-wait\fR options will have no effect upon the job step). \fB\-W\fR, \fB\-\-wait\fR options will have no effect upon the job step).
The active job step (MPI job) will likely suffer a fatal error, The active job step (MPI job) will likely suffer a fatal error,
but subsequent job steps may be run if this option is specified. but subsequent job steps may be run if this option is specified.
The default action is to terminate the job upon node failure. The default action is to terminate the job upon node failure.
.TP .TP
...@@ -668,7 +674,7 @@ Also see \fB\-\-mem\-per\-cpu\fR. ...@@ -668,7 +674,7 @@ Also see \fB\-\-mem\-per\-cpu\fR.
\fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive. \fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive.
NOTE: Enforcement of memory limits currently requires enabling of NOTE: Enforcement of memory limits currently requires enabling of
accounting, which samples memory use on a periodic basis (data need accounting, which samples memory use on a periodic basis (data need
not be stored, just collected). A task may exceed the memory limit not be stored, just collected). A task may exceed the memory limit
until the next periodic accounting sample. until the next periodic accounting sample.
.TP .TP
...@@ -680,7 +686,7 @@ seen using the \fBscontrol show config\fR command. ...@@ -680,7 +686,7 @@ seen using the \fBscontrol show config\fR command.
Note that if the job's \fB\-\-mem\-per\-cpu\fR value exceeds the configured Note that if the job's \fB\-\-mem\-per\-cpu\fR value exceeds the configured
\fBMaxMemPerCPU\fR, then the user's limit will be treated as a memory limit \fBMaxMemPerCPU\fR, then the user's limit will be treated as a memory limit
per task; \fB\-\-mem\-per\-cpu\fR will be reduced to a value no larger than per task; \fB\-\-mem\-per\-cpu\fR will be reduced to a value no larger than
\fBMaxMemPerCPU\fR; \fB\-\-cpus\-per\-task\fR will be set and value of \fBMaxMemPerCPU\fR; \fB\-\-cpus\-per\-task\fR will be set and value of
\fB\-\-cpus\-per\-task\fR multiplied by the new \fB\-\-mem\-per\-cpu\fR \fB\-\-cpus\-per\-task\fR multiplied by the new \fB\-\-mem\-per\-cpu\fR
value will equal the original \fB\-\-mem\-per\-cpu\fR value specified by value will equal the original \fB\-\-mem\-per\-cpu\fR value specified by
the user. the user.
...@@ -711,9 +717,9 @@ The following informational environment variables are set when ...@@ -711,9 +717,9 @@ The following informational environment variables are set when
\fB\-\-mem_bind\fR is in use: \fB\-\-mem_bind\fR is in use:
.nf .nf
SLURM_MEM_BIND_VERBOSE SLURM_MEM_BIND_VERBOSE
SLURM_MEM_BIND_TYPE SLURM_MEM_BIND_TYPE
SLURM_MEM_BIND_LIST SLURM_MEM_BIND_LIST
.fi .fi
See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description
...@@ -907,9 +913,9 @@ NOTE: This option is not supported unless ...@@ -907,9 +913,9 @@ NOTE: This option is not supported unless
Overcommit resources. Normally, \fBsrun\fR Overcommit resources. Normally, \fBsrun\fR
will not allocate more than one process per CPU. By specifying will not allocate more than one process per CPU. By specifying
\fB\-\-overcommit\fR you are explicitly allowing more than one process \fB\-\-overcommit\fR you are explicitly allowing more than one process
per CPU. However no more than \fBMAX_TASKS_PER_NODE\fR tasks are per CPU. However no more than \fBMAX_TASKS_PER_NODE\fR tasks are
permitted to execute per node. NOTE: \fBMAX_TASKS_PER_NODE\fR is permitted to execute per node. NOTE: \fBMAX_TASKS_PER_NODE\fR is
defined in the file \fIslurm.h\fR and is not a variable, it is set at defined in the file \fIslurm.h\fR and is not a variable, it is set at
SLURM build time. SLURM build time.
.TP .TP
...@@ -975,7 +981,7 @@ The maximum size of a process's data segment ...@@ -975,7 +981,7 @@ The maximum size of a process's data segment
.TP .TP
\fBFSIZE\fR \fBFSIZE\fR
The maximum size of files created. Note that if the user sets FSIZE to less The maximum size of files created. Note that if the user sets FSIZE to less
than the current size of the slurmd.log, job launches will fail with than the current size of the slurmd.log, job launches will fail with
a 'File size limit exceeded' error. a 'File size limit exceeded' error.
.TP .TP
\fBMEMLOCK\fR \fBMEMLOCK\fR
...@@ -999,7 +1005,7 @@ The maximum stack size ...@@ -999,7 +1005,7 @@ The maximum stack size
Execute task zero in pseudo terminal mode. Execute task zero in pseudo terminal mode.
Implicitly sets \fB\-\-unbuffered\fR. Implicitly sets \fB\-\-unbuffered\fR.
Implicitly sets \fB\-\-error\fR and \fB\-\-output\fR to /dev/null Implicitly sets \fB\-\-error\fR and \fB\-\-output\fR to /dev/null
for all tasks except task zero, which may cause those tasks to for all tasks except task zero, which may cause those tasks to
exit immediately (e.g. shells will typically exit immediately exit immediately (e.g. shells will typically exit immediately
in that situation). in that situation).
Not currently supported on AIX platforms. Not currently supported on AIX platforms.
...@@ -1030,7 +1036,7 @@ This option may be used to spread several job steps out among the ...@@ -1030,7 +1036,7 @@ This option may be used to spread several job steps out among the
nodes of the current job. If \fB\-r\fR is used, the current job nodes of the current job. If \fB\-r\fR is used, the current job
step will begin at node \fIn\fR of the allocated nodelist, where step will begin at node \fIn\fR of the allocated nodelist, where
the first node is considered node 0. The \fB\-r\fR option is not the first node is considered node 0. The \fB\-r\fR option is not
permitted with \fB\-w\fR or \fB\-x\fR option and will result in a permitted with \fB\-w\fR or \fB\-x\fR option and will result in a
fatal error when not running within a prior allocation (i.e. when fatal error when not running within a prior allocation (i.e. when
SLURM_JOB_ID is not set). The default for \fIn\fR is 0. If the SLURM_JOB_ID is not set). The default for \fIn\fR is 0. If the
value of \fB\-\-nodes\fR exceeds the number of nodes identified value of \fB\-\-nodes\fR exceeds the number of nodes identified
...@@ -1098,7 +1104,7 @@ When a tree topology is used, this defines the maximum count of switches ...@@ -1098,7 +1104,7 @@ When a tree topology is used, this defines the maximum count of switches
desired for the job allocation and optionally the maximum time to wait desired for the job allocation and optionally the maximum time to wait
for that number of switches. If SLURM finds an allocation containing more for that number of switches. If SLURM finds an allocation containing more
switches than the count specified, the job remains pending until it either finds switches than the count specified, the job remains pending until it either finds
an allocation with desired switch count or the time limit expires. an allocation with desired switch count or the time limit expires.
It there is no switch count limit, there is no delay in starting the job. It there is no switch count limit, there is no delay in starting the job.
Acceptable time formats include "minutes", "minutes:seconds", Acceptable time formats include "minutes", "minutes:seconds",
"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
...@@ -1177,12 +1183,12 @@ above when task/affinity plugin is enabled. ...@@ -1177,12 +1183,12 @@ above when task/affinity plugin is enabled.
Set a minimum time limit on the job allocation. Set a minimum time limit on the job allocation.
If specified, the job may have it's \fB\-\-time\fR limit lowered to a value If specified, the job may have it's \fB\-\-time\fR limit lowered to a value
no lower than \fB\-\-time\-min\fR if doing so permits the job to begin no lower than \fB\-\-time\-min\fR if doing so permits the job to begin
execution earlier than otherwise possible. execution earlier than otherwise possible.
The job's time limit will not be changed after the job is allocated resources. The job's time limit will not be changed after the job is allocated resources.
This is performed by a backfill scheduling algorithm to allocate resources This is performed by a backfill scheduling algorithm to allocate resources
otherwise reserved for higher priority jobs. otherwise reserved for higher priority jobs.
Acceptable time formats include "minutes", "minutes:seconds", Acceptable time formats include "minutes", "minutes:seconds",
"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
"days\-hours:minutes:seconds". "days\-hours:minutes:seconds".
.TP .TP
...@@ -1227,7 +1233,7 @@ parameter in the slurm configuration file (see \fBslurm.conf(5)\fR). This ...@@ -1227,7 +1233,7 @@ parameter in the slurm configuration file (see \fBslurm.conf(5)\fR). This
option can be useful to insure that a job is terminated in a timely fashion option can be useful to insure that a job is terminated in a timely fashion
in the event that one or more tasks terminate prematurely. in the event that one or more tasks terminate prematurely.
Note: The \fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR option takes precedence Note: The \fB\-K\fR, \fB\-\-kill\-on\-bad\-exit\fR option takes precedence
over \fB\-W\fR, \fB\-\-wait\fR to terminate the job immediately if a task over \fB\-W\fR, \fB\-\-wait\fR to terminate the job immediately if a task
exits with a non\-zero exit code. exits with a non\-zero exit code.
.TP .TP
...@@ -1263,8 +1269,8 @@ if it contains a "/"character. ...@@ -1263,8 +1269,8 @@ if it contains a "/"character.
\fB\-Z\fR, \fB\-\-no\-allocate\fR \fB\-Z\fR, \fB\-\-no\-allocate\fR
Run the specified tasks on a set of nodes without creating a SLURM Run the specified tasks on a set of nodes without creating a SLURM
"job" in the SLURM queue structure, bypassing the normal resource "job" in the SLURM queue structure, bypassing the normal resource
allocation step. The list of nodes must be specified with the allocation step. The list of nodes must be specified with the
\fB\-w\fR, \fB\-\-nodelist\fR option. This is a privileged option \fB\-w\fR, \fB\-\-nodelist\fR option. This is a privileged option
only available for the users "SlurmUser" and "root". only available for the users "SlurmUser" and "root".
.PP .PP
......
...@@ -168,7 +168,10 @@ with the \fB\-\-jobid\fR option. When the \fB\-\-jobid\fR option is ...@@ -168,7 +168,10 @@ with the \fB\-\-jobid\fR option. When the \fB\-\-jobid\fR option is
used in conjunction with the \fB\-\-up\fR, \fB\-\-down\fR or used in conjunction with the \fB\-\-up\fR, \fB\-\-down\fR or
\fB\-\-drained\fR option, \fB\-\-drained\fR option,
all nodes allocated to that job will considered the nodes used as a all nodes allocated to that job will considered the nodes used as a
trigger event. trigger event.Since this option's argument is optional, for proper
parsing the single letter option must be followed immediately with
the value and not include a space between them. For example "\-ntux"
and not "\-n tux".
.TP .TP
\fB\-M\fR, \fB\-\-clusters\fR=<\fIstring\fR> \fB\-M\fR, \fB\-\-clusters\fR=<\fIstring\fR>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment