More improvements to the sacct man page

doc/man/man1/sacct.1

@@ -12,34 +12,21 @@ SLURM job accounting log or SLURM database
 Accounting information for jobs invoked with SLURM are either logged
 in the job accounting log file or saved to the SLURM database.
 .PP
-The
-.BR "sacct "
-command displays job accounting data stored in the job accounting log
-file or SLURM database in a variety of forms for your analysis.
-The
-.BR "sacct "
-command displays information on jobs, job steps, status, and exitcodes by
-default.
-You can tailor the output with the use of the
-\f3\-\-format=\fP
-option to specify the fields to be shown.
+The \f3sacct\fP command displays job accounting data stored in the job
+accounting log file or SLURM database in a variety of forms for your
+analysis.  The \f3sacct\fP command displays information on jobs, job
+steps, status, and exitcodes by default.  You can tailor the output
+with the use of the \f3\-\-format=\fP option to specify the fields to
+be shown.
 .PP
-For the root user, the
-.BR "sacct "
-command displays job accounting data for all users, although there are
-options to filter the output to report only the jobs from a specified
-user or group.
+For the root user, the \f3sacct\fP command displays job accounting
+data for all users, although there are options to filter the output to
+report only the jobs from a specified user or group.
 .PP
-For the non\-root user, the
-.BR "sacct "
-command limits the display of job accounting data to jobs that were
-launched with their own user identifier (UID) by default.
-Data for other users can be displayed with the
-\f3\-\-all\fP,
-\f3\-\-user\fP,
-or
-\f3\-\-uid\fP
-options.
+For the non\-root user, the \f3sacct\fP command limits the display of
+job accounting data to jobs that were launched with their own user
+identifier (UID) by default.  Data for other users can be displayed
+with the \f3\-\-all\fP, \f3\-\-user\fP, or \f3\-\-uid\fP options.
 .TP "10"
 \f3Note: \fP\c
 Much of the data reported by \f3sacct\fP has been generated by
@@ -57,8 +44,8 @@ Elapsed time fields are presented as 2 fields, integral seconds and integral mic
 If \-\-dump is not specified, elapsed time fields are presented as
 [[days-]hours:]minutes:seconds.hundredths.
 .IP
-The default input file is the file named in the jobacct_logfile
-parameter in slurm.conf.
+The default input file is the file named in the
+\f3AccountingStorageLoc\fP parameter in slurm.conf.
 
 .SH "OPTIONS"
 
@@ -73,7 +60,6 @@ Displays jobs when a comma separated list of accounts are given as the
 argument.
 .IP
 
-
 .TP
 \f3\-b\fP\f3,\fP \f3\-\-brief\fP
 Displays a brief listing, which includes the following data:
@@ -92,7 +78,8 @@ option is also specified.
 
 .TP
 \f3\-c\fP\f3,\fP \f3\-\-completion\fP
-Use job completion instead of job accounting.
+Use job completion instead of job accounting.  The \f3JobCompType\fP
+parameter in the slurm.conf file must be defined to a non-none option.
 .IP
 
 
@@ -106,16 +93,16 @@ data output when this option is used.
 
 .TP
 \f3\-\-duplicates\fP
-If SLURM job ids are reset, but the job accounting log file isn't
-reset at the same time (with \-e, for example), some job numbers will
-probably appear more than once in the accounting log file to refer to
-different jobs; such jobs can be distinguished by the "submit" time
-stamp in the data records.
+If SLURM job ids are reset, some job numbers will probably appear more
+than once in the accounting log file but refer to different jobs.
+Such jobs can be distinguished by the "submit" time stamp in the data
+records.
+
 .IP
-When data for specific jobs are requested with the \-\-jobs option, we
-assume that the user wants to see only the most recent job with that
-number. This behavior can be overridden by specifying \-\-duplicates, in
-which case all records that match the selection criteria will be returned.
+When data for specific jobs are requested with the \-\-jobs option,
+\f3sacct\fP returns the most recent job with that number. This
+behavior can be overridden by specifying \-\-duplicates, in which case
+all records that match the selection criteria will be returned.
 
 .TP
 \f3\-e\fP\f3,\fP \f3\-\-helpformat\fP
@@ -167,18 +154,14 @@ MM/DD[/YY]\-HH:MM[:SS]
 YYYY\-MM\-DD[THH:MM[:SS]]
 .IP
 
-
 .TP
 \f3\-f \fP\f2file\fP\f3,\fP  \f3\-\-file\fP\f3=\fP\f2file\fP
-Causes the
-.BR "sacct "
-command to read job accounting data from the named
-\f2file\fP
-instead of the current SLURM job accounting log file. Only applicable
-when running the filetxt plugin.
+Causes the \f3sacct\fP command to read job accounting data from the
+named \f2file\fP instead of the current SLURM job accounting log
+file. Only applicable when running the filetxt plugin.
 
 .TP
-\f3\-g \fP\f2gid_list\fP\f3,\fP  \f3\-\-gid\fP\f3=\fP\f2gid_list\fP \f3\-\-group\fP\f3=\fP\f2group_list\fP
+\f3\-g \fP\f2gid_list\fP\f3, \-\-gid=\fP\f2gid_list\fP \f3\-\-group=\fP\f2group_list\fP
 Displays the statistics only for the jobs started with the GID
 or the GROUP specified by the \f2gid_list\fP or the\f2group_list\fP operand, which is a comma\-separated
 list.  Space characters are not allowed.
@@ -219,21 +202,21 @@ maximum timelimit of the range.  Default is no restriction.
 Equivalent to specifying:
 .IP
 .na
-\'\-\-format=jobid,jobname,partition,maxvmsize,maxvmsizenode,maxvmsizetask,avevmsize,maxrss,maxrssnode,maxrsstask,averss,maxpages,maxpagesnode,maxpagestask,avepages,mincpu,mincpunode,mincputask,avecpu,ntasks,alloccpus,elapsed,state,exitcode\'
+\-\-format=jobid,jobname,partition,maxvmsize,maxvmsizenode,maxvmsizetask,avevmsize,maxrss,maxrssnode,maxrsstask,averss,maxpages,maxpagesnode,maxpagestask,avepages,mincpu,mincpunode,mincputask,avecpu,ntasks,alloccpus,elapsed,state,exitcode
 .ad
 
 .TP
 \f3\-L\fP\f3,\fP \f3\-\-allclusters\fP
 Display jobs ran on all clusters. By default, only jobs ran on the
-cluster from where sacct is called are displayed.
+cluster from where \f3sacct\fP is called are displayed.
 
 .TP
-\f3\-M \fP\f2cluster_list\fP\f3,\fP  \f3\-\-clusters\fP\f3=\fP\f2cluster_list\fP
-Displays the statistics only for the jobs started on the clusters specified by
-the \f2cluster_list\fP operand, which is a comma\-separated list of clusters.
-Space characters are not allowed in the \f2cluster_list\fP. \-1 for
-all clusters, default is current cluster you are executing the sacct
-command on\&.
+\f3\-M \fP\f2cluster_list\fP\f3, \-\-clusters=\fP\f2cluster_list\fP
+Displays the statistics only for the jobs started on the clusters
+specified by the \f2cluster_list\fP operand, which is a
+comma\-separated list of clusters.  Space characters are not allowed
+in the \f2cluster_list\fP. Use \-1 for all clusters.  The default is
+current cluster you are executing the \f3sacct\fP command on\&.
 
 .TP
 \f3\-n\fP\f3,\fP \f3\-\-noheader\fP
@@ -245,8 +228,8 @@ This option has no effect when used with the
 option.
 
 .TP
-\f3\-N\fP\f3,\fP \f3\-\-nodelist\fP
-Display jobs that ran on any of these nodes, can be one or more using
+\f3\-N \fP\f2node_list\fP\f3, \-\-nodelist=\fP\f2node_list\fP
+Display jobs that ran on any of these node(s).  \f2node_list\fP can be
 a ranged string.
 .IP
 
@@ -259,7 +242,7 @@ NOTE: When using the format option for listing various fields you can put a
 %NUMBER afterwards to specify how many characters should be printed.
 
 e.g. format=name%30 will print 30 characters of field name right
-justified.  A \-30 will print 30 characters left justified.
+justified.  A %\-30 will print 30 characters left justified.
 .IP
 
 .TP
@@ -287,7 +270,7 @@ Comma separated list of partitions to select jobs and job steps
 from. The default is all partitions.
 
 .TP
-\f3\-s \fP\f2state_list\fP \f3,\fP  \f3\-\-state\fP\f3=\fP\f2state_list\fP
+\f3\-s \fP\f2state_list\fP \f3, \-\-state\fP\f3=\fP\f2state_list\fP
 Selects jobs based on their state during the time period given.
 Unless otherwise specified, the start and end time will be the
 current time when the \f3\-\-state\fP option is specified and
@@ -336,10 +319,8 @@ Job has an allocation, but execution has been suspended.
 Job terminated upon reaching its time limit.
 .RE
 .IP
-The
-\f2state_list\fP
-operand is a comma\-separated list of these state designators.
-Space characters are not allowed in the
+The \f2state_list\fP operand is a comma\-separated list of these state
+designators.  Space characters are not allowed in the
 \f2state_list\fP\c
 
 NOTE: When specifying states and no start time is given the default
@@ -368,9 +349,9 @@ Truncate time.  So if a job started before \-\-starttime the start time
 would be truncated to \-\-starttime.  The same for end time and \-\-endtime.
 
 .TP
-\f3\-u \fP\f2uid_list\fP\f3,\fP  \f3\-\-uid\fP\f3=\fP\f2uid_list\fP \f3\-\-user\fP\f3=\fP\f2user_list\fP
-Use this comma separated list of uids or user names to select jobs to display.  By default, the running
-user's uid is used.
+\f3\-u \fP\f2uid_list\fP\f3, \-\-uid=\fP\f2uid_list\fP\f3, \-\-user=\fP\f2user_list\fP
+Use this comma separated list of uids or user names to select jobs to
+display.  By default, the running user's uid is used.
 
 .TP
 \f3\-\-usage\fP
@@ -386,20 +367,18 @@ variables during processing.
 Print version.
 
 .TP
-\f3\-W \fP\f2wckey_list\fP\f3,\fP  \f3\-\-wckeys\fP\f3=\fP\f2wckey_list\fP
-Displays the statistics only for the jobs started on the wckeys specified by
-the \f2wckey_list\fP operand, which is a comma\-separated list of
-wckey names.
-Space characters are not allowed in the \f2wckey_list\fP. Default is
-all wckeys\&.
+\f3\-W \fP\f2wckey_list\fP\f3, \-\-wckeys=\fP\f2wckey_list\fP
+Displays the statistics only for the jobs started on the wckeys
+specified by the \f2wckey_list\fP operand, which is a comma\-separated
+list of wckey names.  Space characters are not allowed in the
+\f2wckey_list\fP. Default is all wckeys\&.
 
 .TP
-\f3\-x \fP\f2associd_list\fP\f3,\fP \f3\-\-associations\fP\f3=\fP\f2assoc_list\fP
+\f3\-x \fP\f2associd_list\fP\f3, -\-associations=\fP\f2assoc_list\fP
 Displays the statistics only for the jobs running under the
 association ids specified by the \f2assoc_list\fP operand, which is a
-comma\-separated list of association ids.
-Space characters are not allowed in the \f2assoc_list\fP. Default is
-all associations\&.
+comma\-separated list of association ids.  Space characters are not
+allowed in the \f2assoc_list\fP. Default is all associations\&.
 
 .TP
 \f3\-X\fP\f3,\fP \f3\-\-allocations\fP
@@ -555,7 +534,7 @@ The name of the job or job step. The \f3slurm_accounting.log\fP file
 is a space delimited file. Because of this if a space is used in the 
 jobname an underscore is substituted for the space before the record 
 is written to the accounting file. So when the jobname is displayed 
-by sacct the jobname that had a space in it will now have an underscore 
+by \f3sacct\fP the jobname that had a space in it will now have an underscore 
 in place of the space.
 
 .TP
@@ -731,13 +710,9 @@ Reference to the wckey.
 
 .RE
 .SH "INTERPRETING THE \-DUMP OPTION OUTPUT"
-The
-.BR "sacct "
-commands
-\f3\-\-dump\fP
-option displays data in a horizontal list of fields depending on the
-record type;
-there are three record types:
+The \f3sacct\fP command's \f3\-\-dump\fP option displays data in a
+horizontal list of fields depending on the record type.  There are
+three record types:
 \f3JOB_START\fP\c
 \&,
 \f3JOB_STEP\fP\c
@@ -768,12 +743,8 @@ Thus, a pair of fields output as "\c
 The least significant digits in the second field are truncated in
 formatted displays.
 .SS "Output for the JOB_START Record Type"
-The following describes the horizontal fields output by the
-.BR "sacct "
-\f3\-\-dump\fP
-option for the
-\f3JOB_START\fP
-record type.
+The following describes the horizontal fields output by the \f3sacct
+\-\-dump\fP option for the \f3JOB_START\fP record type.
 .RS
 .TP "10"
 Field #
@@ -830,12 +801,8 @@ Relative SLURM priority
 \f3nodes\fP
 .RE
 .SS "Output for the JOB_STEP Record Type"
-The following describes the horizontal fields output by the
-.BR "sacct "
-\f3\-\-dump\fP
-option for the
-\f3JOB_STEP\fP
-record type.
+The following describes the horizontal fields output by the \f3sacct
+\-\-dump\fP option for the \f3JOB_STEP\fP record type.
 .RS
 .TP "10"
 Field #
@@ -983,11 +950,8 @@ expressed in microseconds
 .TP
 .RE
 .SS "Output for the JOB_TERMINATED Record Type"
-The following describes the horizontal fields output by the
-.BR "sacct "
-\f3\-\-dump\fP
-option for the
-\f3JOB_TERMINATED\fP (literal string)
+The following describes the horizontal fields output by the \f3sacct
+\-\-dump\fP option for the \f3JOB_TERMINATED\fP (literal string)
 record type.
 .RS
 .TP "10"
@@ -1023,14 +987,10 @@ Job Record Version (1)
 9
 The number of fields in the record (38)
 .IP
-Although thirty\-eight fields are displayed by the
-.BR "sacct "
-command for the
-\f3JOB_TERMINATED\fP
-record, only fields 1 through 12 are recorded in the actual data file;
-the
-.BR "sacct "
-command aggregates the remainder.
+Although thirty\-eight fields are displayed by the \f3sacct\fP command
+for the \f3JOB_TERMINATED\fP record, only fields 1 through 12 are
+recorded in the actual data file.  The \f3sacct\fP command aggregates
+the remainder.
 .TP
 10
 The total elapsed time in seconds for the job.
@@ -1142,8 +1102,7 @@ expressed in microseconds
 .RE
 
 .SH "EXAMPLES"
-This example illustrates the default invocation of the
-.BR "sacct "
+This example illustrates the default invocation of the \f3sacct\fP
 command:
 .RS
 .PP
@@ -1162,8 +1121,7 @@ Jobid      Jobname    Partition    Account AllocCPUS State     ExitCode
 .RE
 .PP
 This example shows the same job accounting information with the
-\f3brief\fP
-option.
+\f3brief\fP option.
 .RS
 .PP
 .nf
@@ -1200,9 +1158,8 @@ Jobid      Jobname    Partition Account    AllocCPUS  State     ExitCode
 .RE
 .PP
 This example demonstrates the ability to customize the output of the
-.BR "sacct "
-command.
-The fields are displayed in the order designated on the command line.
+\f3sacct\fP command.  The fields are displayed in the order designated
+on the command line.
 .RS
 .PP
 .nf

doc/man/man5/slurm.conf.5

@@ -567,7 +567,7 @@ Acceptable values at present include "jobacct_gather/aix" (for AIX operating
 system), "jobacct_gather/linux" (for Linux operating system) and "jobacct_gather/none"
 (no accounting data collected).
 The default value is "jobacct_gather/none".
-In order to use the \fBsacct\fR tool, "jobacct_gather/aix" or "jobacct_gather/linux"
+In order to use the \fBsstat\fR tool, "jobacct_gather/aix" or "jobacct_gather/linux"
 must be configured.
 
 .TP