From b048474c46b595eb79e4213bf7be8b431ae8f5c1 Mon Sep 17 00:00:00 2001
From: Danny Auble <da@llnl.gov>
Date: Fri, 25 Jun 2010 17:57:38 +0000
Subject: [PATCH] update documentation
---
doc/man/man1/sstat.1 | 16 ++++++++++++++--
src/sstat/options.c | 11 +++++++----
2 files changed, 21 insertions(+), 6 deletions(-)
diff --git a/doc/man/man1/sstat.1 b/doc/man/man1/sstat.1
index adac2a306d1..2531f6bba6d 100644
--- a/doc/man/man1/sstat.1
+++ b/doc/man/man1/sstat.1
@@ -49,12 +49,18 @@ Print a list of fields that can be specified with the '\-\-format' option.
\f3\-h\fP\f3,\fP \f3\-\-help\fP
Displays a general help message.
+.TP
+\f3\-i\fP\f3,\fP \f3\-\-pidformat\fP
+Predefined format to list the pids running for each job step.
+(JobId,Nodes,Pids)
+
.TP
\f3\-j\fP\f3,\fP \f3\-\-jobs\fP
Format is <job(.step)>. Stat this job step or comma-separated list of
job steps. This option is required. The step portion will default to
-step 0 if not specified, unless the \-\-allsteps flag is set where not
-specifying a step will result in all running steps to be displayed.
+lowest step running if not specified, unless the --allsteps flag is
+set where not specifying a step will result in all running steps to be
+displayed.
.TP
\f3\-n\fP\f3,\fP \f3\-\-noheader\fP
@@ -66,6 +72,12 @@ display a header.
Comma separated list of fields.
(use '\-\-helpformat' for a list of available fields).
+NOTE: When using the format option for listing various fields you can put a
+%NUMBER afterwards to specify how many characters should be printed.
+
+i.e. format=name%30 will print 30 characters of field name right
+justified. A \-30 will print 30 characters left justified.
+
.TP
\f3\-p\fP\f3,\fP \f3\-\-parsable\fP
output will be '|' delimited with a '|' at the end
diff --git a/src/sstat/options.c b/src/sstat/options.c
index 9718ed138bd..2b4293ed0ac 100644
--- a/src/sstat/options.c
+++ b/src/sstat/options.c
@@ -75,13 +75,16 @@ sstat [<OPTION>] -j <job(.stepid)> \n\
Print a list of fields that can be specified with the \n\
'--format' option \n\
-h, --help: Print this description of use. \n\
+ -i, --pidformat: \n\
+ Predefined format to list the pids running for each \n\
+ job step. (JobId,Nodes,Pids) \n\
-j, --jobs: \n\
Format is <job(.step)>. Stat this job step \n\
or comma-separated list of job steps. This option is \n\
- required. The step portion will default to step 0 if not\n\
- specified, unless the --allsteps flag is set where not \n\
- specifying a step will result in all running steps to be \n\
- displayed. \n\
+ required. The step portion will default to lowest step \n\
+ running if not specified, unless the --allsteps flag is \n\
+ set where not specifying a step will result in all \n\
+ running steps to be displayed. \n\
-n, --noheader: \n\
No header will be added to the beginning of output. \n\
The default is to print a header. \n\
--
GitLab