From e2afb97128418daabb2408ad493cd6d35939bb34 Mon Sep 17 00:00:00 2001 From: Sebastien GODARD Date: Sat, 25 Jul 2020 18:19:49 +0200 Subject: [PATCH] Update sar, iostat and cifsiostat manual pages Signed-off-by: Sebastien GODARD --- man/cifsiostat.in | 13 +++++++------ man/iostat.in | 15 +++++++++------ man/sar.in | 38 ++++++++++++-------------------------- 3 files changed, 28 insertions(+), 38 deletions(-) diff --git a/man/cifsiostat.in b/man/cifsiostat.in index 8800733..e5fecff 100644 --- a/man/cifsiostat.in +++ b/man/cifsiostat.in @@ -1,16 +1,16 @@ -.TH CIFSIOSTAT 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- +.TH CIFSIOSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME cifsiostat \- Report CIFS statistics. .SH SYNOPSIS .ie 'yes'@WITH_DEBUG@' \{ -.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --debuginfo ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ +.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --debuginfo ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ --pretty ] [ .I interval .B [ .I count .B ] ] .\} .el \{ -.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ +.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --dec={ 0 | 1 | 2 } ] [ --human ] [ --pretty ] [ .I interval .B [ .I count @@ -102,9 +102,8 @@ Print debug output to stderr. .IP "--dec={ 0 | 1 | 2 }" Specify the number of decimal places to use (0 to 2, default value is 2). .IP -h -Make the CIFS report easier to read by a human. -.B --human -is enabled implicitly with this option. +This option is equivalent to specifying +.BR "--human --pretty" . .IP --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. @@ -113,6 +112,8 @@ kilobytes, sectors...) associated with the metrics. Display statistics in kilobytes per second. .IP -m Display statistics in megabytes per second. +.IP --pretty +Make the CIFS report easier to read by a human. .IP -t Print the time for each report displayed. The timestamp format may depend on the value of the S_TIME_FORMAT environment variable (see below). diff --git a/man/iostat.in b/man/iostat.in index d84456a..b55b2fe 100644 --- a/man/iostat.in +++ b/man/iostat.in @@ -1,4 +1,4 @@ -.TH IOSTAT 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- +.TH IOSTAT 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME iostat \- Report Central Processing Unit (CPU) statistics and input/output statistics for devices and partitions. @@ -8,7 +8,7 @@ statistics for devices and partitions. .B [ --dec={ 0 | 1 | 2 } ] [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ] .B [ [ -H ] -g .I group_name -.B ] [ --human ] [ -p [ +.B ] [ --human ] [ --pretty ] [ -p [ .I device .B [,...] | ALL ] ] [ .I device @@ -23,7 +23,7 @@ statistics for devices and partitions. .B [ --dec={ 0 | 1 | 2 } ] [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ] .B [ [ -H ] -g .I group_name -.B ] [ --human ] [ -p [ +.B ] [ --human ] [ --pretty ] [ -p [ .I device .B [,...] | ALL ] ] [ .I device @@ -386,9 +386,8 @@ This option must be used with option -g and indicates that only global statistics for the group are to be displayed, and not statistics for individual devices in the group. .IP -h -Make the Device Utilization Report easier to read by a human. -.B --human -is enabled implicitly with this option. +This option is equivalent to specifying +.BR "--human --pretty" . .IP --human Print sizes in human readable format (e.g. 1.0k, 1.2M, etc.) The units displayed with this option supersede any other default units (e.g. @@ -402,6 +401,8 @@ only prerequisite is that directory with required persistent names is present in .IR /dev/disk . Optionally, multiple devices can be specified in the chosen persistent name type. Because persistent device names are usually long, option +.B --pretty +is implicitly set with this option. .IP -k Display statistics in kilobytes per second. .IP -m @@ -425,6 +426,8 @@ never been used. If option .B -j is defined before this option, devices entered on the command line can be specified with the chosen persistent name type. +.IP --pretty +Make the Device Utilization Report easier to read by a human. .IP -s Display a short (narrow) version of the report that should fit in 80 characters wide screens. diff --git a/man/sar.in b/man/sar.in index b4f56c6..642ba89 100644 --- a/man/sar.in +++ b/man/sar.in @@ -1,4 +1,4 @@ -.TH SAR 1 "JUNE 2020" Linux "Linux User's Manual" -*- nroff -*- +.TH SAR 1 "JULY 2020" Linux "Linux User's Manual" -*- nroff -*- .SH NAME sar \- Collect, report, or save system activity information. .SH SYNOPSIS @@ -10,7 +10,7 @@ sar \- Collect, report, or save system activity information. .I fs_list .B ] [ --help ] [ --human ] [ --iface= .I iface_list -.B ] [ --sadc ] +.B ] [ --pretty ] [ --sadc ] .B [ -I { .I int_list .B | SUM | ALL } ] [ -P { @@ -299,13 +299,10 @@ works only when used in conjunction with option -o to save data to file. .IP -d Report activity for each block device. -When data are displayed, the device specification -.I devM-n -is generally used (DEV column). -M is the major number of the device and n -its minor number. -Device names may also be pretty-printed if option -p -is used or persistent device names can be printed if option -j is used +When data are displayed, the device name is displayed as it +(should) appear in +.IR /dev . +Persistent device names can also be printed if option -j is used (see below). Statistics for all devices are displayed unless a restricted list is specified using option .BR --dev= @@ -489,13 +486,8 @@ Amount of surplus hugepages memory in kilobytes. .RE .RE .IP -h -Make the output of sar easier to read by a human. Options -.B --human -and -.B -p -(pretty-print) are enabled implicitly with this option. -This option may be especially useful when displaying e.g., network interfaces -or block devices statistics. +This option is equivalent to specifying +.BR "--pretty --human" . .IP --help Display a short help message then exit. .IP --human @@ -536,8 +528,6 @@ Options etc. specify the type of the persistent name. These options are not limited, only prerequisite is that directory with required persistent names is present in .IR /dev/disk . -If persistent name is not found for the device, the device name -is pretty-printed (see option -p below). Option .BR SID tries to get a stable identifier to use as the device name. A stable @@ -1944,14 +1934,10 @@ Specifying the .B ALL keyword reports statistics for each individual processor, and globally for all processors. Offline processors are not displayed. -.IP -p -Pretty-print device names. Use this option in conjunction with option -d. -By default names are printed as -.I devM-n -where M and n are the major and minor numbers for the device. -Use of this option displays the names of the devices as they (should) appear -in /dev. Name mappings are controlled by -.IR @SYSCONFIG_DIR@/sysstat.ioconf . +.IP "-p, --pretty" +Make reports easier to read by a human. +This option may be especially useful when displaying e.g., network interfaces +or block devices statistics. .IP "-q [ keyword [,...] | ALL ]" Report system load and pressure-stall statistics. -- 2.49.0