update the man page for sacct

doc/man/man1/sacct.1

@@ -47,7 +47,7 @@ options.
 Much of the data reported by \f3sacct\fP has been generated by
 the \f2wait3()\fP and \f2getrusage()\fP system calls. Some systems
 gather and report incomplete information for these calls;
-\f3sacct\fP reports values of 0 for this missing data. See your system's
+\f3sacct\fP reports values of 0 for this missing data. See your systems
 \f2getrusage(3)\fP man page for information about which data are
 actually available on your system.
 .SS "Options"
@@ -88,10 +88,42 @@ options.
 .IP 
 The section titled "INTERPRETING THE --dump OPTION OUTPUT" describes the 
 data output when this option is used.
+.TP
+\f3\-S \fP\f3,\fP \f3--stat\fP
+.IP
+Queries the status of a job as the job is running displaying
+the following data:
+.RS 
+.TP "3"
+\(bu
+\f3jobid\fP 
+.TP "3"
+\(bu
+\f3vsize\fP 
+.TP "3"
+\(bu
+\f3rss\fP 
+.TP "3"
+\(bu
+\f3pages\fP 
+.TP "3"
+\(bu
+\f3cputime\fP 
+.TP "3"
+\(bu
+\f3ntasks\fP 
+.TP "3"
+\(bu
+\f3status\fP 
+.RE 
+.IP
+You must also include the --jobs=job(.step) option if no (.step) is 
+given you will recieve the job.0 step.
+
 .TP
 \f3-e \fP\f2time_spec\fP \f3,\fP \f3--expire=\fP\f2time_spec\fP
 .IP
-Removes job data from SLURM's current accounting log file (or the file
+Removes job data from SLURMs current accounting log file (or the file
 specified with \f3--file\fP) for jobs that completed more than
 \f2time_spec\fP
 ago and appends them to the expired log file.
@@ -201,13 +233,12 @@ Fields available:
    cpu         elapsed     exitcode    blockid
    gid         group       idrss       inblocks
    isrss       ixrss       job         jobname
-   jobid     majflt      minflt      msgrcv
+   jobid       majflt      minflt      msgrcv
    msgsnd      ncpus       nivcsw      nodes
-   nprocs      ntasks      nsignals    nswap
-   nvcsw       outblocks   partition   psize
+   ntasks      nsignals    nswap       cputime
+   nvcsw       outblocks   partition   vsize
    rss         status      submitted   systemcpu
-   uid         user        usercpu     vsize 
-   cputime
+   uid         user        usercpu      
 
 .ft 1
 .fi 
@@ -225,20 +256,12 @@ Space characters are not permitted in this list.
 .IP 
 The default is to display information on all jobs.
 .TP 
-\f3\-J \fP\f2job.step\fP \f3,\fP  \f3--jobid\fP\f3=\fP\f2job.step\fP
-Displays data only for the job steps specified by the 
-\f2job.step\fP 
-operand, which is a comma-separated list.
-Space characters are not allowed in the 
-\f2field_list\fP\c
-\&. 
-.TP 
 \f3\-l\fP\f3,\fP \f3--long\fP
 Displays a long listing, which includes the following data:
 .RS 
 .TP "3"
 \(bu
-\f3jobstep\fP 
+\f3jobid\fP 
 .TP "3"
 \(bu
 \f3jobname\fP 
@@ -357,13 +380,13 @@ The following describes each job accounting field:
 The sum of the system time (systemcpu) and user time (usercpu) in seconds 
 .TP 
 \f3elapsed\fP 
-The job's elapsed time.
+The jobs elapsed time.
 .IP 
-The format of this field's output is as follows:
+The format of this fields output is as follows:
 .RS 
 .PD "0"
 .HP 
-\f2[DD-[hh:]]mm:ss.nn\fP 
+\f2[DD-[hh:]]mm:ss\fP 
 .PD 
 .RE 
 .IP 
@@ -381,47 +404,11 @@ minutes
 .TP 
 \f2ss\fP 
 seconds
-.TP 
-\f2nn\fP 
-hundredths of seconds
 .RE 
 .TP 
 \f3exitcode\fP 
 The first non-zero error code returned by any job step.
 .TP 
-\f3finished\fP 
-The time and date stamp (in Universal Time Coordinated, UTC) the job completed. 
-.IP 
-The format of the output is: 
-.RS 
-.PD "0"
-.HP 
-\f2YYYYMMDDhhmmss\fP 
-.PD 
-.RE 
-.IP 
-as defined by the following:
-.RS 
-.TP "10"
-\f2YYYY\fP 
-year
-.TP 
-\f2MM\fP 
-month
-.TP 
-\f2DD\fP 
-days
-.TP 
-\f2hh\fP 
-hours
-.TP 
-\f2mm\fP 
-minutes
-.TP 
-\f2ss\fP 
-seconds
-.RE 
-.TP 
 \f3gid\fP 
 The group identifier of the user who ran the job.
 .TP 
@@ -440,7 +427,7 @@ Maximum shared memory (in KB) of any process.
 \f3job\fP 
 The SLURM job identifier of the job.
 .TP 
-\f3jobstep\fP 
+\f3jobid\fP 
 The number of the job step.
 It is in the form: 
 \f2job.jobstep\fP\c
@@ -467,8 +454,8 @@ Total number of involuntary context switches for all processes.
 \f3nodes\fP 
 A list of nodes allocated to the job.
 .TP 
-\f3nprocs\fP 
-Total number of processes used.
+\f3ntasks\fP 
+Total number of tasks in job.
 .TP 
 \f3nsignals\fP 
 Total number of signals received for all processes.
@@ -476,11 +463,6 @@ Total number of signals received for all processes.
 \f3nswap\fP 
 Maximum number of swap operations of any process.
 .TP 
-\f3ntasks\fP
-Synonym for
-\f3nprocs\fP\c
-\&.
-.TP
 \f3nvcsw\fP 
 Total number of voluntary context switches for all processes.
 .TP 
@@ -490,11 +472,21 @@ Total block output operations for all processes.
 \f3partition\fP 
 Identifies the partition on which the job ran.
 .TP 
-\f3psize\fP 
-Maximum physical memory (in KB) occupied by any process.
-.TP 
 \f3rss\fP 
-Maximum resident set size (in KB) of any process.
+Maximum resident set size of any process followed by its task id along with
+the average of all processes running in the step.
+.TP 
+\f3pages\fP 
+Maximum page faults of any process followed by its task id along with
+the average of all processes running in the step.
+.TP 
+\f3vsize\fP 
+Maximum Virtual Memory size of any process followed by its task id along with
+the average of all processes running in the step.
+.TP 
+\f3cputime\fP 
+Minimum CPU time of any process followed by its task id along with
+the average of all processes running in the step.
 .TP 
 \f3status\fP 
 Displays the job status, or state.
@@ -544,14 +536,11 @@ The amount of user CPU time.
 The format of the output is identical to that of the 
 \f3elapsed\fP 
 field.
-.TP 
-\f3vsize\fP 
-Maximum Virtual Memory size (in KB) bytes of any process.
 .RE 
 .SH "INTERPRETING THE -DUMP OPTION OUTPUT"
 The 
 .BR "sacct "
-command's 
+commands 
 \f3--dump\fP 
 option displays data in a horizontal list of fields depending on the 
 record type;
@@ -607,7 +596,7 @@ Field
 \f3submitted\fP 
 .TP 
 4
-The job's start time;
+The jobs start time;
 this value is the number of non-leap seconds since the Epoch (00:00:00 
 UTC, January 1, 1970)
 .TP 
@@ -669,7 +658,7 @@ Field
 \f3submitted\fP 
 .TP 
 4
-The job's start time;
+The jobs start time;
 this value is the number of non-leap seconds since the Epoch (00:00:00 
 UTC, January 1, 1970)
 .TP 
@@ -689,7 +678,7 @@ Job Record Version (1)
 The number of fields in the record (38)
 .TP 
 10
-\f3jobstep\fP 
+\f3jobid\fP 
 .TP 
 11
 \f3finished\fP 
@@ -725,7 +714,7 @@ Timed out
 \f3exitcode\fP 
 .TP 
 14
-\f3nprocs\fP 
+\f3ntasks\fP 
 .TP 
 15
 \f3ncpus\fP 
@@ -799,8 +788,6 @@ expressed in microseconds
 37
 \f3vsize\fP 
 .TP 
-38
-\f3psize\fP 
 .RE 
 .SS "Output for the JOB_TERMINATED Record Type"
 The following describes the horizontal fields output by the 
@@ -824,7 +811,7 @@ Field
 \f3submitted\fP 
 .TP 
 4
-The job's start time;
+The jobs start time;
 this value is the number of non-leap seconds since the Epoch (00:00:00 
 UTC, January 1, 1970)
 .TP 
@@ -886,7 +873,7 @@ Timed out
 \f3exitcode\fP 
 .TP 
 14
-\f3nprocs\fP 
+\f3ntasks\fP 
 .TP 
 15
 \f3ncpus\fP 
@@ -960,8 +947,6 @@ expressed in microseconds
 37
 \f3vsize\fP 
 .TP 
-38
-\f3psize\fP 
 .RE 
 .SH "EXAMPLES"
 This example illustrates the default invocation of the 
@@ -972,7 +957,7 @@ command:
 .nf 
 .ft 3
 # sacct
-Jobstep    Jobname    Partition    Ncpus Status     Exitcode
+Jobid      Jobname    Partition    Ncpus Status     Exitcode
 ---------- ---------- ---------- ------- ---------- -----
 2          script01   srun             1 RUNNING        0
 3          script02   srun             1 RUNNING        0
@@ -991,7 +976,7 @@ option.
 .nf 
 .ft 3
 # sacct --brief
-Jobstep    Status     Exitcode
+Jobid      Status     Exitcode
 ---------- ---------- -----
 2          RUNNING        0
 3          RUNNING        0
@@ -1006,7 +991,7 @@ Jobstep    Status     Exitcode
 .nf 
 .ft 3
 # sacct --total
-Jobstep    Jobname    Partition    Ncpus Status     Exitcode
+Jobid      Jobname    Partition    Ncpus Status     Exitcode
 ---------- ---------- ---------- ------- ---------- -----
 3          sja_init   andy             1 COMPLETED      0
 4          sjaload    andy             2 COMPLETED      0
@@ -1029,8 +1014,8 @@ The fields are displayed in the order designated on the command line.
 .PP
 .nf 
 .ft 3
-# sacct --fields=jobstep,ncpus,nprocs,nsignals,status
-Jobstep      Ncpus  Nprocs  Nsignals Status
+# sacct --fields=jobid,ncpus,ntasks,nsignals,status
+Jobid        Ncpus  Ntasks  Nsignals     Status
 ---------- ------- ------- --------- ----------
 3                2       1         0 COMPLETED
 3.0              2       1         0 COMPLETED