Skip to content
Snippets Groups Projects
Commit b048474c authored by Danny Auble's avatar Danny Auble
Browse files

update documentation

parent 44f0ab46
No related branches found
No related tags found
No related merge requests found
...@@ -49,12 +49,18 @@ Print a list of fields that can be specified with the '\-\-format' option. ...@@ -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 \f3\-h\fP\f3,\fP \f3\-\-help\fP
Displays a general help message. 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 .TP
\f3\-j\fP\f3,\fP \f3\-\-jobs\fP \f3\-j\fP\f3,\fP \f3\-\-jobs\fP
Format is <job(.step)>. Stat this job step or comma-separated list of 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 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 lowest step running if not specified, unless the --allsteps flag is
specifying a step will result in all running steps to be displayed. set where not specifying a step will result in all running steps to be
displayed.
.TP .TP
\f3\-n\fP\f3,\fP \f3\-\-noheader\fP \f3\-n\fP\f3,\fP \f3\-\-noheader\fP
...@@ -66,6 +72,12 @@ display a header. ...@@ -66,6 +72,12 @@ display a header.
Comma separated list of fields. Comma separated list of fields.
(use '\-\-helpformat' for a list of available 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 .TP
\f3\-p\fP\f3,\fP \f3\-\-parsable\fP \f3\-p\fP\f3,\fP \f3\-\-parsable\fP
output will be '|' delimited with a '|' at the end output will be '|' delimited with a '|' at the end
......
...@@ -75,13 +75,16 @@ sstat [<OPTION>] -j <job(.stepid)> \n\ ...@@ -75,13 +75,16 @@ sstat [<OPTION>] -j <job(.stepid)> \n\
Print a list of fields that can be specified with the \n\ Print a list of fields that can be specified with the \n\
'--format' option \n\ '--format' option \n\
-h, --help: Print this description of use. \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\ -j, --jobs: \n\
Format is <job(.step)>. Stat this job step \n\ Format is <job(.step)>. Stat this job step \n\
or comma-separated list of job steps. This option is \n\ or comma-separated list of job steps. This option is \n\
required. The step portion will default to step 0 if not\n\ required. The step portion will default to lowest step \n\
specified, unless the --allsteps flag is set where not \n\ running if not specified, unless the --allsteps flag is \n\
specifying a step will result in all running steps to be \n\ set where not specifying a step will result in all \n\
displayed. \n\ running steps to be displayed. \n\
-n, --noheader: \n\ -n, --noheader: \n\
No header will be added to the beginning of output. \n\ No header will be added to the beginning of output. \n\
The default is to print a header. \n\ The default is to print a header. \n\
......
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