From fa428b409667d3c36e844bc1a229b1bfa2d542a6 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Tue, 22 Feb 2011 23:07:19 +0000
Subject: [PATCH] document scontrol's --wait-job option

---
 doc/man/man1/scontrol.1 | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1
index 8b24e46548e..4f89bcc737d 100644
--- a/doc/man/man1/scontrol.1
+++ b/doc/man/man1/scontrol.1
@@ -357,7 +357,8 @@ updated configuration values to the \fIupdate\fP. Note that while most
 configuration values can be changed using this command, not all can be changed
 using this mechanism. In particular, the hardware configuration of a node or
 the physical addition or removal of nodes from the cluster may only be
-accomplished through editing the Slurm configuration file and executing the \fIreconfigure\fP command (described above).
+accomplished through editing the Slurm configuration file and executing\
+the \fIreconfigure\fP command (described above).
 
 .TP
 \fBverbose\fP
@@ -368,6 +369,13 @@ This includes time\-stamps on data structures, record counts, etc.
 \fBversion\fP
 Display the version number of scontrol being executed.
 
+.TP
+\fBwait_job\fP \fIjob_id\fP
+Wait until a job andall of its nodes are ready for use or the job has entered
+some termination state. This option is particularly useful in the SLURM Prolog
+or in the batch script itself if nodes are powered down and restarted
+automatically as needed.
+
 .TP
 \fB!!\fP
 Repeat the last command executed.
-- 
GitLab