iostat: Update manual page

Explain --compact option.

Signed-off-by: Sebastien GODARD <sysstat@users.noreply.github.com>

diff --git a/man/iostat.in b/man/iostat.in
index 8dd0fe49b85f539dc8049cad433f3328bc60570c..4f67ef6bf2c5f526df55a2396bf9138b4abe252f 100644 (file)
--- a/man/iostat.in
+++ b/man/iostat.in
@@ -1,5 +1,5 @@
 .\" iostat manual page - (C) 1998-2020 Sebastien Godard (sysstat <at> orange.fr)
-.TH IOSTAT 1 "OCTOBER 2020" Linux "Linux User's Manual" -*- nroff -*-
+.TH IOSTAT 1 "SEPTEMBER 2021" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 iostat \- Report Central Processing Unit (CPU) statistics and input/output
 statistics for devices and partitions.
@@ -7,13 +7,13 @@ statistics for devices and partitions.
 .SH SYNOPSIS
 .ie 'yes'@WITH_DEBUG@' \{
 .B iostat [ -c ] [ -d ] [ -h ] [ -k | -m ] [ -N ] [ -s ] [ -t ] [ -V ] [ -x ] [ -y ] [ -z ]
-.BI "[ --dec={ 0 | 1 | 2 } ] [ { -f | +f } " "directory" " ] [ -j { ID | LABEL | PATH | UUID | ... } ] "
+.BI "[ --compact ] [ --dec={ 0 | 1 | 2 } ] [ { -f | +f } " "directory" " ] [ -j { ID | LABEL | PATH | UUID | ... } ] "
 .BI "[ -o JSON ] [ [ -H ] -g " "group_name " "] [ --human ] [ --pretty ] [ -p [ " "device" "[,...] | ALL ] ] ["
 .IB "device " "[...] | ALL ] [ --debuginfo ] [ " "interval " "[ " "count " "] ] "
 .\}
 .el \{
 .B iostat [ -c ] [ -d ] [ -h ] [ -k | -m ] [ -N ] [ -s ] [ -t ] [ -V ] [ -x ] [ -y ] [ -z ]
-.BI "[ --dec={ 0 | 1 | 2 } ] [ { -f | +f } " "directory" " ] [ -j { ID | LABEL | PATH | UUID | ... } ] "
+.BI "[ --compact ] [ --dec={ 0 | 1 | 2 } ] [ { -f | +f } " "directory" " ] [ -j { ID | LABEL | PATH | UUID | ... } ] "
 .BI "[ -o JSON ] [ [ -H ] -g " "group_name " "] [ --human ] [ --pretty ] [ -p [ " "device" "[,...] | ALL ] ] ["
 .IB "device " "[...] | ALL ] [ " "interval " "[ " "count " "] ]"
 .\}
@@ -222,6 +222,10 @@ modern SSDs, this number does not reflect their performance limits.
 .B -c
 Display the CPU utilization report.
 .TP
+.B --compact
+Don't break the Device Utilization Report into sub-reports so that all the metrics get displayed
+on a single line.
+.TP
 .B -d
 Display the device utilization report.
 .if 'yes'@WITH_DEBUG@' \{
@@ -336,6 +340,10 @@ specified with the chosen persistent name type.
 .TP
 .B --pretty
 Make the Device Utilization Report easier to read by a human.
+The device name will be printed on the right side. The report may also be broken
+into sub-reports if there are many metrics to display (use
+.B --compact
+option to prevent this).
 .TP
 .B -s
 Display a short (narrow) version of the report that should fit in 80