sar, iostat, pidstat, tapestat, cifsiostat: Update manual pages

Document new "--human" option.

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

diff --git a/man/cifsiostat.in b/man/cifsiostat.in
index 42dca4761979901916ba896718386d28de01fc0c..dee5b2e56d438b4a372ee6427cd56cb0f9550034 100644 (file)
--- a/man/cifsiostat.in
+++ b/man/cifsiostat.in
@@ -1,16 +1,16 @@
-.TH CIFSIOSTAT 1 "OCTOBER 2015" Linux "Linux User's Manual" -*- nroff -*-
+.TH CIFSIOSTAT 1 "NOVEMBER 2016" 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 ] [
+.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --debuginfo ] [ --human ] [
 .I interval
 .B [
 .I count
 .B ] ]
 .\}
 .el \{
-.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [
+.B cifsiostat [ -h ] [ -k | -m ] [ -t ] [ -V ] [ --human ] [
 .I interval
 .B [
 .I count
@@ -101,6 +101,12 @@ Print debug output to stderr.
 .\}
 .IP -h
 Make the CIFS report easier to read by a human.
+.B --human
+is enabled implicitly with this option.
+.IP --human
+Print sizes in human readable format (e.g. 1k, 1.23M, etc.)
+The units displayed with this option supersede any other default units (e.g.
+kilobytes, sectors...) associated with the metrics.
 .IP -k
 Display statistics in kilobytes per second.
 .IP -m

diff --git a/man/iostat.in b/man/iostat.in
index 3425621df42db6be97272fdebfca0076dd6c8e92..351fb111393c975089143926c35637eefcd1677d 100644 (file)
--- a/man/iostat.in
+++ b/man/iostat.in
@@ -8,7 +8,7 @@ statistics for devices and partitions.
 .B [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ]
 .B [ [ -H ] -g
 .I group_name
-.B ] [ -p [
+.B ] [ --human ] [ -p [
 .I device
 .B [,...] | ALL ] ] [
 .I device
@@ -23,7 +23,7 @@ statistics for devices and partitions.
 .B [ -j { ID | LABEL | PATH | UUID | ... } ] [ -o JSON ]
 .B [ [ -H ] -g
 .I group_name
-.B ] [ -p [
+.B ] [ --human ] [ -p [
 .I device
 .B [,...] | ALL ] ] [
 .I device
@@ -294,6 +294,12 @@ 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.
+.IP --human
+Print sizes in human readable format (e.g. 1k, 1.23M, etc.)
+The units displayed with this option supersede any other default units (e.g.
+kilobytes, sectors...) associated with the metrics.
 .IP "-j { ID | LABEL | PATH | UUID | ... } [ device [...] | ALL ]"
 Display persistent device names. Options
 .BR ID ,

diff --git a/man/pidstat.1 b/man/pidstat.1
index 3a0518ca3e1a44d4773a093c06c2f1eaa29c8779..756f88f065961f4aa86a6b39bcb9e2db9912d4e0 100644 (file)
--- a/man/pidstat.1
+++ b/man/pidstat.1
@@ -1,4 +1,4 @@
-.TH PIDSTAT 1 "MARCH 2016" Linux "Linux User's Manual" -*- nroff -*-
+.TH PIDSTAT 1 "NOVEMBER 2016" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 pidstat \- Report statistics for Linux tasks.
 .SH SYNOPSIS
@@ -9,7 +9,7 @@ pidstat \- Report statistics for Linux tasks.
 .I comm
 .B ] [ -G
 .I process_name
-.B ] [ -p {
+.B ] [ --human ] [ -p {
 .I pid
 .B [,...] | SELF | ALL } ] [ -T { TASK | CHILD | ALL } ] [
 .I interval
@@ -130,6 +130,10 @@ include the string
 .IP -h
 Display all activities horizontally on a single line. This is
 intended to make it easier to be parsed by other programs.
+.IP --human
+Print sizes in human readable format (e.g. 1k, 1.23M, etc.)
+The units displayed with this option supersede any other default units (e.g.
+kilobytes, sectors...) associated with the metrics.
 .IP -I
 In an SMP environment, indicate that tasks CPU usage
 (as displayed by option

diff --git a/man/sar.in b/man/sar.in
index 2d5c67058aa1cefed641763b173b0c3088fa4f4e..b9d618b6b241530775e4b8cf5b9530c0773caa45 100644 (file)
--- a/man/sar.in
+++ b/man/sar.in
@@ -3,7 +3,7 @@
 sar \- Collect, report, or save system activity information.
 .SH SYNOPSIS
 .B sar [ -A ] [ -B ] [ -b ] [ -C ] [ -D ] [ -d ] [ -F [ MOUNT ] ] [ -H ] [ -h ] [ -p ] [ -q ] [ -R ]
-.B [ -r [ ALL ] ] [ -S ] [ -t ] [ -u [ ALL ] ] [ -V ] [ -v ] [ -W ] [ -w ] [ -y ] [ --sadc ]
+.B [ -r [ ALL ] ] [ -S ] [ -t ] [ -u [ ALL ] ] [ -V ] [ -v ] [ -W ] [ -w ] [ -y ] [ --human ] [ --sadc ]
 .B [ -I {
 .I int
 .B [,...] | SUM | ALL | XALL } ] [ -P {
@@ -437,6 +437,10 @@ Percentage of total hugepages memory that has been allocated.
 .RE
 .IP -h
 Display a short help message then exit.
+.IP --human
+Print sizes in human readable format (e.g. 1k, 1.23M, etc.)
+The units displayed with this option supersede any other default units (e.g.
+kilobytes, sectors...) associated with the metrics.
 .IP "-I { int [,...] | SUM | ALL | XALL }"
 Report statistics for a given interrupt.
 .I int

diff --git a/man/tapestat.1 b/man/tapestat.1
index 8e7eda84984f569cbbb08fe7d76a8da12e844db2..c18bd074eccd88229e2b143e4805a6bff7e119cc 100644 (file)
--- a/man/tapestat.1
+++ b/man/tapestat.1
@@ -1,8 +1,8 @@
-.TH TAPESTAT 1 "MARCH 2016" Linux "Linux User's Manual" -*- nroff -*-
+.TH TAPESTAT 1 "NOVEMBER 2016" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 tapestat \- Report tape statistics.
 .SH SYNOPSIS
-.B tapestat [ -k | -m ] [ -t ] [ -V ] [ -y ] [ -z ] [
+.B tapestat [ -k | -m ] [ -t ] [ -V ] [ -y ] [ -z ] [ --human ] [
 .I interval
 .B [
 .I count
@@ -108,6 +108,10 @@ using methods outside of the tape driver (e.g. via sg ioctls).
 .RE
 .RE
 .SH OPTIONS
+.IP --human
+Print sizes in human readable format (e.g. 1k, 1.23M, etc.)
+The units displayed with this option supersede any other default units (e.g.
+kilobytes, sectors...) associated with the metrics.
 .IP -k
 Show the amount of data written or read in kilobytes per second instead of megabytes.
 This option is mutually exclusive with -m.