diff --git a/doc/man/man1/sreport.1 b/doc/man/man1/sreport.1 index d6f7e44cdd5e97dff080ee4d480ac58a12b76b63..62178e0b73021b7ccb52451042af7e69ea214a89 100644 --- a/doc/man/man1/sreport.1 +++ b/doc/man/man1/sreport.1 @@ -1,14 +1,13 @@ -.TH SREPORT "1" "October 2008" "sreport 1.3" "Slurm components" +.TH SREPORT "1" "February 2009" "sreport 2.0" "Slurm components" .SH "NAME" -sreport \- Used to generate reports from the slurm accounting data. +sreport \- Generate reports from the slurm accounting data. .SH "SYNOPSIS" \fBsreport\fR [\fIOPTIONS\fR...] [\fICOMMAND\fR...] .SH "DESCRIPTION" -\fBsreport\fR is used to generate certain reports. More can be added -at any time. It provides a view into accounting data gathered from slurm via +\fBsreport\fR is used to generate certain reports. It provides a view into accounting data gathered from slurm via the account information maintained within a database with the interface being provided by the \fBslurmdbd\fR (Slurm Database daemon). @@ -16,49 +15,43 @@ being provided by the \fBslurmdbd\fR (Slurm Database daemon). .TP \fB\-a\fR, \fB\-\-all_clusters\fR -Use all clusters instead of only cluster from where the command was run. - +Use all clusters instead of only the cluster from where the command was run. .TP \fB\-h\fR, \fB\-\-help\fR Print a help message describing the usage of \fBsreport\fR. -This is equivalent to the \fBhelp\fR command. - .TP \fB\-n\fR, \fB\-\-no_header\fR Don't display header when listing results. - .TP \fB\-p\fR, \fB\-\-parsable\fR Output will be '|' delimited with a '|' at the end. - .TP \fB\-P\fR, \fB\-\-parsable2\fR Output will be '|' delimited without a '|' at the end. - .TP \fB\-q\fR, \fB\-\-quiet\fR Print no warning or informational messages, only error messages. -This is equivalent to the \fBquiet\fR command. - .TP \fB\-t <format>\fR Specify the output time format. Time format options are case insensitive and may be abbreviated. The default format is Minutes. -Supported time format options are listed with the \fBtime\fP command below. - +Supported time format options are listed in the \fBtime\fP command +section below. .TP \fB\-v\fR, \fB\-\-verbose\fR Print detailed event logging. -This is equivalent to the \fBverbose\fR command. - .TP \fB\-V\fR , \fB\-\-version\fR Print version information and exit. -This is equivalent to the \fBversion\fR command. .SH "COMMANDS" +.TP +\<keyword\> may be omitted from the execute line and sreport will +execute in interactive mode. sreport will process commands as entered until +explicitly terminated. + .TP \fBexit\fP Terminate the execution of sreport. @@ -68,6 +61,14 @@ Identical to the \fBquit\fR command. \fBhelp\fP Display a description of sreport options and commands. +.TP +\fBparsable\fP +Output will be | delimited with an ending '|'. + +.TP +\fBparsable2\fP +Output will be | delimited without an ending '|'. + .TP \fBquiet\fP Print no warning or informational messages, only fatal error messages. @@ -109,14 +110,11 @@ Percentage of Total .TP \fBverbose\fP -Print detailed event logging. -This includes time\-stamps on data structures, record counts, etc. -This is an independent command with no options meant for use in interactive mode. +Enable detailed event logging. .TP \fBversion\fP -Display the version number of sreport being executed. - \-q or \-\-quiet: equivalent to \"quiet\" command \n\ +Display the sreport version number. .TP \fB!!\fP @@ -124,17 +122,26 @@ Repeat the last command executed. .SH "REPORT TYPES" .TP -\fBcluster\fP, \fBjob\fP, and \fBuser\fP +Valid report types are: +\fBcluster\fP \<REPORT\> \<OPTIONS\> + +\fBjob\fP \<REPORT\> \<OPTIONS\> + +\fBuser\fP \<REPORT\> \<OPTIONS\> +.RE .TP -Various reports are as follows... - cluster \- AccountUtilizationByUser, UserUtilizationByAccount, - UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser - job \- Sizes - user \- TopUsage +\<REPORT\> options for each type include: +\fBcluster\fP \- AccountUtilizationByUser, UserUtilizationByAccount, +UserUtilizationByWckey, Utilization, WCKeyUtilizationByUser + +\fBjob\fP \- Sizes + +\fBuser\fP \- TopUsage .TP + .TP REPORT DESCRIPTION .RS @@ -158,7 +165,7 @@ on separate lines. .TP .B cluster Utilization This report will display total usage divided by Allocated, Down, -Idle, and resrved time for selected clusters. Reserved time +Idle, and Reserved time for selected clusters. Reserved time refers to time that a job was waiting for resources after the job had become eligible. If the value is not of importance for you the number should be grouped with idle time. @@ -190,7 +197,7 @@ COMMON FOR ALL TYPES .RS .TP .B All_Clusters -Use all monitored clusters default is local cluster. +Use all monitored clusters. Default is local cluster. .TP .B End=<OPT> Period ending for report. Default is 23:59:59 of previous day. @@ -211,7 +218,7 @@ List of clusters to include in report. Default is local cluster. .TP .B Tree When used with the AccountUtilizationByUser report will span the -accounts as they in the hierarchy. +accounts as they are in the hierarchy. .RE .TP @@ -219,7 +226,7 @@ JOB .RS .TP .B Accounts=<OPT> -List of accounts to use for the report Default is all. +List of accounts to use for the report. Default is all. .TP .B Clusters=<OPT> List of clusters to include in report. Default is local cluster. @@ -240,10 +247,6 @@ List of partitions jobs ran on to include in report. Default is all. When used with the Sizes report will print number of jobs ran instead of time used. .TP -.B TopCount=<OPT> -Used in the TopUsage report. Change the number of users displayed. -Default is 10. -.TP .B Users=<OPT> List of users jobs to include in report. Default is all. .RE @@ -252,16 +255,48 @@ List of users jobs to include in report. Default is all. USER .RS .TP +.B Accounts=<OPT> +List of accounts to use for the report. Default is all. +.TP .B Clusters=<OPT> List of clusters to include in report. Default is local cluster. .TP .B Group Group all accounts together for each user. Default is a separate entry for each user and account reference. .TP +.B TopCount=<OPT> +Used in the TopUsage report. Change the number of users displayed. +Default is 10. +.TP .B Users=<OPT> List of users jobs to include in report. Default is all. -.RE +.RE +.TP + Below are the format options for each report. + + Cluster + - AccountUtilizationByUser + - UserUtilizationByAccount + - Accounts, Cluster, CPUCount, Login, Proper, Used + - UserUtilizationByWckey + - WCKeyUtilizationByUser + - Cluster, CPUCount, Login, Proper, Used, Wckey + - Utilization + - Allocated, Cluster, CPUCount, Down, Idle, Overcommited, + PlannedDown, Reported, Reserved + + Job + - Sizes + - Account, Cluster + + User + - TopUsage + - Account, Cluster, Login, Proper, Used + +.TP +All commands and options are case-insensitive. +.TP .SH "EXAMPLES" .eo @@ -274,9 +309,9 @@ List of users jobs to include in report. Default is all. .ec .SH "COPYING" -Copyright (C) 2008 Lawrence Livermore National Security. +Copyright (C) 2009 Lawrence Livermore National Security. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). -CODE\-OCEC\-09\-009. All rights reserved. +CODE-OCEC-09-009. All rights reserved. .LP This file is part of SLURM, a resource management program. For details, see <https://computing.llnl.gov/linux/slurm/>. @@ -292,4 +327,4 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .SH "SEE ALSO" -\fBsacct\fR(1), \fBslurmdbe\fR(8) +\fBsacct\fR(1), \fBslurmdbd\fR(8)