diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1 index d1784ba23fffd8230bd3cb6a502e253eb5bf6ce9..95179d59945e637870a7c8090cb0196bc0ac835f 100644 --- a/doc/man/man1/salloc.1 +++ b/doc/man/man1/salloc.1 @@ -92,6 +92,10 @@ Force salloc to ring the terminal bell when the job allocation is granted if the allocation is pending for more than ten seconds (and only if stdout is a tty). Also see the option \fB\-\-no\-bell\fR. +.TP +\fB\-\-comment\fR=<\fIstring\fR> +An arbitrary comment. + .TP \fB\-C\fR, \fB\-\-constraint\fR[=]<\fIlist\fR> Specify a list of constraints. @@ -120,10 +124,6 @@ Constraints with node counts may only be combined with AND operators. If no nodes have the requested features, then the job will be rejected by the slurm job manager. -.TP -\fB\-\-comment\fR=<\fIstring\fR> -An arbitrary comment. - .TP \fB\-\-contiguous\fR If set, then the allocated nodes must form a contiguous set. diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 5239532eb6df52d2323f4512348f3c5afcf78bd2..a06330b7462b0cbc5907293c3a3836e9dfe60252 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -82,6 +82,26 @@ and you can tell SLURM to run the job today with the keyword The value may be changed after job submission using the \fBscontrol\fR command. +.TP +\fB\-\-checkpoint\fR=\fItime\fR +Specifies the interval between creating checkpoints of the job step. +By default, the job step will no checkpoints created. +Acceptable time formats include "minutes", "minutes:seconds", +"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and +"days\-hours:minutes:seconds". + +.TP +\fB\-\-checkpoint\-dir\fR=\fIdirectory\fR +Specifies the directory into which the job or job step's checkpoint should +be written (used by the checkpoint/blcrm and checkpoint/xlch plugins only). +The default value is the current working directory. +Checkpoint files will be of the form "<job_id>.ckpt" for jobs +and "<job_id>.<step_id>.ckpt" for job steps. + +.TP +\fB\-\-comment\fR=<\fIstring\fR> +An arbitrary comment. + .TP \fB\-C\fR, \fB\-\-constraint\fR[=]<\fIlist\fR> Specify a list of constraints. @@ -110,6 +130,12 @@ Constraints with node counts may only be combined with AND operators. If no nodes have the requested features, then the job will be rejected by the slurm job manager. +.TP +\fB\-\-contiguous\fR +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\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR Bind tasks to CPUs. Used only when the task/affinity plugin is enabled. @@ -167,22 +193,6 @@ auto\-generated masks bind to threads show this help message .RE -.TP -\fB\-\-checkpoint\fR=\fItime\fR -Specifies the interval between creating checkpoints of the job step. -By default, the job step will no checkpoints created. -Acceptable time formats include "minutes", "minutes:seconds", -"hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and -"days\-hours:minutes:seconds". - -.TP -\fB\-\-checkpoint\-dir\fR=\fIdirectory\fR -Specifies the directory into which the job or job step's checkpoint should -be written (used by the checkpoint/blcrm and checkpoint/xlch plugins only). -The default value is the current working directory. -Checkpoint files will be of the form "<job_id>.ckpt" for jobs -and "<job_id>.<step_id>.ckpt" for job steps. - .TP \fB\-c\fR, \fB\-\-cpus\-per\-task\fR[=]<\fIncpus\fR> Advise the SLURM controller that ensuing job steps will require \fIncpus\fR @@ -197,16 +207,6 @@ the \-\-cpus\-per\-task=3 options, the controller knows that each task requires 3 processors on the same node, and the controller will grant an allocation of 4 nodes, one for each of the 4 tasks. -.TP -\fB\-\-comment\fR=<\fIstring\fR> -An arbitrary comment. - -.TP -\fB\-\-contiguous\fR -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\-D\fR, \fB\-\-workdir\fR[=]<\fIdirectory\fR> Set the working directory of the batch script to \fIdirectory\fR before diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index 2b6434f9a04c23ca1f086fa6a6886b990ac21254..0ac67179850906de00f0b990845defe0bb9495ba 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -93,6 +93,17 @@ The default value is the current working directory. Checkpoint files will be of the form "<job_id>.ckpt" for jobs and "<job_id>.<step_id>.ckpt" for job steps. +.TP +\fB\-\-comment\fR=<\fIstring\fR> +An arbitrary comment. + +.TP +\fB\-\-contiguous\fR +If set, then the job's 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. +Not honored for a job step's allocation. + .TP \fB\-C\fR, \fB\-\-constraint\fR[=]<\fIlist\fR> Specify a list of constraints. @@ -121,6 +132,13 @@ Constraints with node counts may only be combined with AND operators. If no nodes have the requested features, then the job will be rejected by the slurm job manager. +.TP +\fB\-\-core\fR=\fItype\fR +Adjust corefile format for parallel job. If possible, srun will set +up the environment for the job such that a corefile format other than +full core dumps is enabled. If run with type = "list", srun will +print a list of supported corefile format types to stdout and exit. + .TP \fB\-\-cpu_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR Bind tasks to CPUs. Used only when the task/affinity plugin is enabled. @@ -259,24 +277,6 @@ This option may also be useful to spawn tasks without allocating resources to the job step from the job's allocation when running multiple job steps with the \fB\-\-exclusive\fR option. -.TP -\fB\-\-comment\fR=<\fIstring\fR> -An arbitrary comment. - -.TP -\fB\-\-contiguous\fR -If set, then the job's 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. -Not honored for a job step's allocation. - -.TP -\fB\-\-core\fR=\fItype\fR -Adjust corefile format for parallel job. If possible, srun will set -up the environment for the job such that a corefile format other than -full core dumps is enabled. If run with type = "list", srun will -print a list of supported corefile format types to stdout and exit. - .TP \fB\-D\fR, \fB\-\-chdir\fR=\fIpath\fR have the remote processes do a chdir to \fIpath\fR before beginning