diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1 index aafef26fd15146cf604dc3446421b7c7a4503fc2..4b3c40817bb6265f551c3c0f05cb0b6ec85947d5 100644 --- a/doc/man/man1/scontrol.1 +++ b/doc/man/man1/scontrol.1 @@ -53,13 +53,16 @@ such as the addition of memory or processors. Running jobs continue execution. .TP \fIshow\fP \fIENTITY\fP \fPID\fP Display the state of the specified entity with the specified identification. -\fIENTITY\fP may be \fIconfig\fP, \fIjob\fP, \fInode\fP or \fIpartition\fP. +\fIENTITY\fP may be \fIconfig\fP, \fIjob\fP, \fInode\fP, \fIpartition\fP +or \fIstep\fP. \fIID\fP can be used to identify a specific element of the identified -entity: the configuration parameter name, job ID, node name or partition name for -entities \fIconfig\fP, \fIjob\fP, \fInode\fP and \fIpartition\fP respectively. +entity: the configuration parameter name, job ID, node name, partition name, +or job step ID for entities \fIconfig\fP, \fIjob\fP, \fInode\fP, \fIpartition\fP, +and \fIstep\fP respectively. Multiple node names may be specified using simple regular expressions (e.g. "lx[10-20]"). All other \fIID\fP values must identify a single -element. By default, all elements of the entity type specified are printed. +element. The job step ID is of the form "job_id.step_id", (e.g. "1234.1"). +By default, all elements of the entity type specified are printed. .TP \fIshutdown\fP Instruct the Slurm controller to terminate.