From 3fd65f93696d11ab25d16166be27b9b4a1f2e859 Mon Sep 17 00:00:00 2001 From: Sebastien GODARD Date: Thu, 29 Dec 2022 11:59:38 +0100 Subject: [PATCH] Update manual pages Signed-off-by: Sebastien GODARD --- man/iostat.in | 12 ++---------- man/mpstat.1 | 12 ++---------- man/pidstat.1 | 12 ++---------- man/sar.in | 37 ++++++++++++++++++++++--------------- man/tapestat.1 | 12 ++---------- 5 files changed, 30 insertions(+), 55 deletions(-) diff --git a/man/iostat.in b/man/iostat.in index 20548c6..13468f1 100644 --- a/man/iostat.in +++ b/man/iostat.in @@ -396,25 +396,17 @@ Its value is a colon-separated list of capabilities that defaults to Supported capabilities are: .RS .TP -.B H= -This is equivalent to SGR substring -.BR "X=" " (see below)." -.TP .B I= SGR (Select Graphic Rendition) substring for device names. .TP -.B M= -This is equivalent to SGR substring -.BR "W=" " (see below)." -.TP .B N= SGR substring for non-zero statistics values. .TP -.B W= +.BR "W=" " (or " "M=" ")" SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% depending on the metric's meaning). .TP -.B X= +.BR "X=" " (or " "H=" ")" SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% depending on the metric's meaning). .TP diff --git a/man/mpstat.1 b/man/mpstat.1 index 8bcf406..2ca2d06 100644 --- a/man/mpstat.1 +++ b/man/mpstat.1 @@ -194,25 +194,17 @@ Its value is a colon-separated list of capabilities that defaults to Supported capabilities are: .RS .TP -.B H= -This is equivalent to SGR substring -.BR "X=" " (see below)." -.TP .B I= SGR (Select Graphic Rendition) substring for CPU number. .TP -.B M= -This is equivalent to SGR substring -.BR "W=" " (see below)." -.TP .B N= SGR substring for non-zero statistics values. .TP -.B W= +.BR "W=" " (or " "M=" ")" SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% depending on the metric's meaning). .TP -.B X= +.BR "X=" " (or " "H=" ")" SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% depending on the metric's meaning). .TP diff --git a/man/pidstat.1 b/man/pidstat.1 index 361e64c..091f5cf 100644 --- a/man/pidstat.1 +++ b/man/pidstat.1 @@ -385,25 +385,17 @@ Its value is a colon-separated list of capabilities that defaults to Supported capabilities are: .RS .TP -.B H= -This is equivalent to SGR substring -.BR "X=" " (see below)." -.TP .B I= SGR (Select Graphic Rendition) substring for item values like PID, UID or CPU number. .TP -.B M= -This is equivalent to SGR substring -.BR "W=" " (see below)." -.TP .B N= SGR substring for non-zero statistics values and for tasks names. .TP -.B W= +.BR "W=" " (or " "M=" ")" SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% depending on the metric's meaning). .TP -.B X= +.BR "X=" " (or " "H=" ")" SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% depending on the metric's meaning). .TP diff --git a/man/sar.in b/man/sar.in index 8ee565b..2313dfe 100644 --- a/man/sar.in +++ b/man/sar.in @@ -391,8 +391,21 @@ Note that these statistics depend on .BR "sadc" "'s option " "-S POWER " "to be collected." Possible keywords are -.BR "CPU" ", " "FAN" ", " "FREQ" ", " "IN" ", " "TEMP " "and " "USB" "." +.BR "BAT" ", " "CPU" ", " "FAN" ", " "FREQ" ", " "IN" ", " "TEMP " "and " "USB" "." +.RB "With the " "BAT" +keyword, statistics about batteries capacity are reported. +The following values are displayed: +.RS +.IP %cap +Battery capacity. +.IP cap/min +Capacity lost or gained per minute by the battery. +.IP status +Charging status of the battery: ↑ (full), ↗ (charging), → (not charging), ↘ (discharging), ? (unknown). +.RE + +.IP .RB "With the " "CPU" keyword, statistics about CPU are reported. The following value is displayed: @@ -1601,30 +1614,24 @@ Supported capabilities are: SGR (Select Graphic Rendition) substring for comments inserted in the binary daily data files. .TP -.B H= -This is equivalent to SGR substring -.BR "X=" " (see below)." -.TP .B I= SGR substring for item names or values (eg. network interfaces, CPU number...) .TP -.B M= -This is equivalent to SGR substring -.BR "W=" " (see below)." -.TP .B N= SGR substring for non-zero statistics values. .TP .B R= SGR substring for restart messages. .TP -.B W= -SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% depending on the -metric's meaning). +.BR "W=" " (or " "M=" ")" +SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% +depending on the metric's meaning). +It is also used for negative values in the range from -10 to -5. .TP -.B X= -SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% depending on the -metric's meaning). +.BR "X=" " (or " "H=" ")" +SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% +depending on the metric's meaning). +It is also used for negative values lower than or equal to -10. .TP .B Z= SGR substring for zero values. diff --git a/man/tapestat.1 b/man/tapestat.1 index a59e31c..206d1f8 100644 --- a/man/tapestat.1 +++ b/man/tapestat.1 @@ -173,25 +173,17 @@ Its value is a colon-separated list of capabilities that defaults to Supported capabilities are: .RS .TP -.B H= -This is equivalent to SGR substring -.BR "X=" " (see below)." -.TP .B I= SGR (Select Graphic Rendition) substring for tape names. .TP -.B M= -This is equivalent to SGR substring -.BR "W=" " (see below)." -.TP .B N= SGR substring for non-zero statistics values. .TP -.B W= +.BR "W=" " (or " "M=" ")" SGR substring for percentage values in the range from 75% to 90% (or in the range 10% to 25% depending on the metric's meaning). .TP -.B X= +.BR "X=" " (or " "H=" ")" SGR substring for percentage values greater than or equal to 90% (or lower than or equal to 10% depending on the metric's meaning). .TP -- 2.40.0