Add S_COLORS variable definition in man pages

Update iostat, mpstat and sar manual pages to define S_COLORS
environment variable (used to enable color display).

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

diff --git a/man/iostat.in b/man/iostat.in
index 4fc0652eead92d8a90a6ce9c65422daaadb70979..934e10d4856455de8d21743a20ed39bd9272e062 100644 (file)
--- a/man/iostat.in
+++ b/man/iostat.in
@@ -1,4 +1,4 @@
-.TH IOSTAT 1 "AUGUST 2015" Linux "Linux User's Manual" -*- nroff -*-
+.TH IOSTAT 1 "SEPTEMBER 2015" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 iostat \- Report Central Processing Unit (CPU) statistics and input/output
 statistics for devices and partitions.
@@ -345,6 +345,13 @@ The
 .B iostat
 command takes into account the following environment variables:
 
+.IP POSIXLY_CORRECT
+When this variable is set, transfer rates are shown in 512-byte blocks instead
+of the default 1K blocks.
+
+.IP S_COLORS
+When this variable is set, display statistics in color on the terminal.
+
 .IP S_TIME_FORMAT
 If this variable exists and its value is
 .BR ISO
@@ -355,10 +362,6 @@ command will use the ISO 8601 format (YYYY-MM-DD) instead.
 The timestamp displayed with option -t will also be compliant with ISO 8601
 format.
 
-.IP POSIXLY_CORRECT
-When this variable is set, transfer rates are shown in 512-byte blocks instead
-of the default 1K blocks.
-
 .SH EXAMPLES
 .B iostat
 .RS

diff --git a/man/mpstat.1 b/man/mpstat.1
index ee6c72afd38e068377cef8d599eda240a7ed59e0..9d08aed340e8705ece02e97b40e1d7be79461a43 100644 (file)
--- a/man/mpstat.1
+++ b/man/mpstat.1
@@ -1,4 +1,4 @@
-.TH MPSTAT 1 "JUNE 2013" Linux "Linux User's Manual" -*- nroff -*-
+.TH MPSTAT 1 "SEPTEMBER 2015" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 mpstat \- Report processors related statistics.
 .SH SYNOPSIS
@@ -184,6 +184,9 @@ The
 .B mpstat
 command takes into account the following environment variable:
 
+.IP S_COLORS
+When this variable is set, display statistics in color on the terminal.
+
 .IP S_TIME_FORMAT
 If this variable exists and its value is
 .BR ISO

diff --git a/man/sar.in b/man/sar.in
index 7f48b96c46e8fa47749efba656c61c0dd61655b9..b959065ccb91c122977de6ed31f6646c25dd45b6 100644 (file)
--- a/man/sar.in
+++ b/man/sar.in
@@ -1,4 +1,4 @@
-.TH SAR 1 "APRIL 2015" Linux "Linux User's Manual" -*- nroff -*-
+.TH SAR 1 "SEPTEMBER 2015" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 sar \- Collect, report, or save system activity information.
 .SH SYNOPSIS
@@ -2204,13 +2204,8 @@ The
 .B sar
 command takes into account the following environment variables:
 
-.IP S_TIME_FORMAT
-If this variable exists and its value is
-.B ISO
-then the current locale will be ignored when printing the date in the report header.
-The
-.B sar
-command will use the ISO 8601 format (YYYY-MM-DD) instead.
+.IP S_COLORS
+When this variable is set, display statistics in color on the terminal.
 
 .IP S_TIME_DEF_TIME
 If this variable exists and its value is
@@ -2224,6 +2219,14 @@ data file located in the
 .IR @SA_DIR@
 directory. This variable may be useful for servers with users located across
 several timezones.
+
+.IP S_TIME_FORMAT
+If this variable exists and its value is
+.B ISO
+then the current locale will be ignored when printing the date in the report header.
+The
+.B sar
+command will use the ISO 8601 format (YYYY-MM-DD) instead.
 .SH EXAMPLES
 .B sar -u 2 5
 .RS