Skip to content
Snippets Groups Projects
Commit 95cbc075 authored by Don Lipari's avatar Don Lipari
Browse files

Minor changes to salloc/sbatch/srun man pages

parent 505b9118
No related branches found
No related tags found
No related merge requests found
......@@ -163,6 +163,12 @@ If set, then the allocated nodes must form a contiguous set.
Not honored with the \fBtopology/tree\fR or \fBtopology/3d_torus\fR
plugins, both of which can modify the node ordering.
.TP
\fB\-\-cores\-per\-socket\fR=<\fIcores\fR>
Restrict node selection to nodes with at least the specified number of
cores per socket. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
Bind tasks to CPUs. Used only when the task/affinity plugin is enabled.
......@@ -496,7 +502,7 @@ round\-robin fashion). For example, consider an allocation of three
nodes each with two cpus. A four\-task cyclic distribution request
will distribute those tasks to the nodes with tasks one and four on
the first node, task two on the second node, and task three on the
third node.
third node.
Note that when SelectType is select/cons_res, the same number of CPUs
may not be allocated on each node. Task distribution will be
round\-robin among all the nodes with CPUs yet to be assigned to tasks.
......@@ -598,8 +604,8 @@ NOTE: To have SLURM always report on the selected memory binding for
all commands executed in a shell, you can enable verbose mode by
setting the SLURM_MEM_BIND environment variable value to "verbose".
The following informational environment variables are set when \fB\-\-mem_bind\
is in use:
The following informational environment variables are set when
\fB\-\-mem_bind\fR is in use:
.nf
SLURM_MEM_BIND_VERBOSE
......@@ -818,6 +824,12 @@ By default, no signal is sent before the job's end time.
If a \fIsig_num\fR is specified without any \fIsig_time\fR,
the default time will be 60 seconds.
.TP
\fB\-\-sockets\-per\-node\fR=<\fIsockets\fR>
Restrict node selection to nodes with at least the specified number of
sockets. See additional information under \fB\-B\fR option above when
task/affinity plugin is enabled.
.TP
\fB\-t\fR, \fB\-\-time\fR=<\fItime\fR>
Set a limit on the total run time of the job allocation. If the
......@@ -831,6 +843,12 @@ limit be imposed. Acceptable time formats include "minutes",
"minutes:seconds", "hours:minutes:seconds", "days\-hours",
"days\-hours:minutes" and "days\-hours:minutes:seconds".
.TP
\fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
Restrict node selection to nodes with at least the specified number of
threads per core. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-time\-min\fR=<\fItime\fR>
Set a minimum time limit on the job allocation.
......
......@@ -85,7 +85,7 @@ You may also specify \fImidnight\fR, \fInoon\fR, or
with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
You can also say what day the job will be run, by specifying
a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
\fIYYYY\-MM-DD\fR. Combine date and time using the following
\fIYYYY\-MM\-DD\fR. Combine date and time using the following
format \fIYYYY\-MM\-DD[THH:MM[:SS]]\fR. You can also
give times like \fInow + count time\-units\fR, where the time\-units
can be \fIseconds\fR (default), \fIminutes\fR, \fIhours\fR,
......@@ -101,6 +101,7 @@ For example:
\-\-begin=now+60 (seconds by default)
\-\-begin=2010\-01\-20T12:34:00
.fi
.RS
.PP
Notes on date/time specifications:
......@@ -171,6 +172,12 @@ If set, then the allocated nodes must form a contiguous set.
Not honored with the \fBtopology/tree\fR or \fBtopology/3d_torus\fR
plugins, both of which can modify the node ordering.
.TP
\fB\-\-cores\-per\-socket\fR=<\fIcores\fR>
Restrict node selection to nodes with at least the specified number of
cores per socket. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
Bind tasks to CPUs. Used only when the task/affinity plugin is enabled.
......@@ -550,7 +557,7 @@ round\-robin fashion). For example, consider an allocation of three
nodes each with two cpus. A four\-task cyclic distribution request
will distribute those tasks to the nodes with tasks one and four on
the first node, task two on the second node, and task three on the
third node.
third node.
Note that when SelectType is select/cons_res, the same number of CPUs
may not be allocated on each node. Task distribution will be
round\-robin among all the nodes with CPUs yet to be assigned to tasks.
......@@ -653,7 +660,7 @@ all commands executed in a shell, you can enable verbose mode by
setting the SLURM_MEM_BIND environment variable value to "verbose".
The following informational environment variables are set when
\fB\-\-mem_bind is in use:
\fB\-\-mem_bind\fR is in use:
.nf
SLURM_MEM_BIND_VERBOSE
......@@ -805,7 +812,7 @@ This is related to \fB\-\-cpus\-per\-task\fR=\fIncpus\fR,
but does not require knowledge of the actual number of cpus on
each node. In some cases, it is more convenient to be able to
request that no more than a specific number of tasks be invoked
on each node. Examples include submitting
on each node. Examples of this include submitting
a hybrid MPI/OpenMP app where only one MPI "task/rank" should be
assigned to each node while allowing the OpenMP portion to utilize
all of the parallelism present in the node, or submitting a single
......@@ -930,6 +937,12 @@ By default, no signal is sent before the job's end time.
If a \fIsig_num\fR is specified without any \fIsig_time\fR,
the default time will be 60 seconds.
.TP
\fB\-\-sockets\-per\-node\fR=<\fIsockets\fR>
Restrict node selection to nodes with at least the specified number of
sockets. See additional information under \fB\-B\fR option above when
task/affinity plugin is enabled.
.TP
\fB\-t\fR, \fB\-\-time\fR=<\fItime\fR>
Set a limit on the total run time of the job allocation. If the
......@@ -948,6 +961,12 @@ limit be imposed. Acceptable time formats include "minutes",
Specify the number of tasks to be launched per node.
Equivalent to \fB\-\-ntasks\-per\-node\fR.
.TP
\fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
Restrict node selection to nodes with at least the specified number of
threads per core. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-time\-min\fR=<\fItime\fR>
Set a minimum time limit on the job allocation.
......
......@@ -159,7 +159,8 @@ Not honored for a job step's allocation.
.TP
\fB\-\-cores\-per\-socket\fR=<\fIcores\fR>
Restrict node selection to nodes with at least the specified number of
cores per socket.
cores per socket. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
......@@ -577,7 +578,7 @@ SLURM_HOSTFILE. If this variable is listed it will over ride any
other method specified. If not set the method will default to block.
Inside the hostfile must contain at minimum the number of hosts
requested and be one per line or comma separated. If specifying a
task count (\fB\-n\fR, \fB\-\-ntasks\fR=<\fInumber\fR>), your tasks
task count (\fB\-n\fR, \fB\-\-ntasks\fR=<\fInumber\fR>), your tasks
will be laid out on the nodes in the order of the file.
.TP
......@@ -652,8 +653,8 @@ NOTE: To have SLURM always report on the selected memory binding for
all commands executed in a shell, you can enable verbose mode by
setting the SLURM_MEM_BIND environment variable value to "verbose".
The following informational environment variables are set when \fB\-\-mem_bind\
is in use:
The following informational environment variables are set when
\fB\-\-mem_bind\fR is in use:
.nf
SLURM_MEM_BIND_VERBOSE
......@@ -1020,7 +1021,8 @@ the job. By default only errors are displayed.
.TP
\fB\-\-sockets\-per\-node\fR=<\fIsockets\fR>
Restrict node selection to nodes with at least the specified number of
sockets.
sockets. See additional information under \fB\-B\fR option above when
task/affinity plugin is enabled.
.TP
\fB\-T\fR, \fB\-\-threads\fR=<\fInthreads\fR>
......@@ -1077,6 +1079,12 @@ current job queue and all the other \fBsrun\fR arguments specifying
the job. This limits \fBsrun's\fR behavior to just return
information; no job is actually submitted.
.TP
\fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
Restrict node selection to nodes with at least the specified number of
threads per core. See additional information under \fB\-B\fR option
above when task/affinity plugin is enabled.
.TP
\fB\-\-time\-min\fR=<\fItime\fR>
Set a minimum time limit on the job allocation.
......@@ -1090,11 +1098,6 @@ Acceptable time formats include "minutes", "minutes:seconds",
"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
"days\-hours:minutes:seconds".
.TP
\fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
Restrict node selection to nodes with at least the specified number of
threads per core.
.TP
\fB\-\-tmp\fR=<\fIMB\fR>
Specify a minimum amount of temporary disk space.
......
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