From 66a6fd439effea6df1ff750cdf4101b93d2b4002 Mon Sep 17 00:00:00 2001 From: Sebastien GODARD Date: Mon, 5 Oct 2015 08:04:51 +0200 Subject: [PATCH] Update pidstat manual page Add documentation on color support for pidstat. Signed-off-by: Sebastien GODARD --- man/pidstat.1 | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/man/pidstat.1 b/man/pidstat.1 index feb60e1..cfce986 100644 --- a/man/pidstat.1 +++ b/man/pidstat.1 @@ -1,4 +1,4 @@ -.TH PIDSTAT 1 "JUNE 2014" Linux "Linux User's Manual" -*- nroff -*- +.TH PIDSTAT 1 "OCTOBER 2015" Linux "Linux User's Manual" -*- nroff -*- .SH NAME pidstat \- Report statistics for Linux tasks. .SH SYNOPSIS @@ -544,7 +544,44 @@ The command name of the task. .SH ENVIRONMENT The .B pidstat -command takes into account the following environment variable: +command takes into account the following environment variables: + +.IP S_COLORS +When this variable is set, display statistics in color on the terminal. +Possible values for this variable are +.IR never , +.IR always +or +.IR auto +(the latter is the default). + +.IP S_COLORS_SGR +Specify the colors and other attributes used to display statistics on the terminal. +Its value is a colon-separated list of capabilities that defaults to +.BR H=31;1:I=32;22:M=34;1:N=33;1:Z=33;22 . +Supported capabilities are: + +.RS +.TP +.B H= +SGR (Select Graphic Rendition) substring for percentage values greater than or equal to 75%. + +.TP +.B I= +SGR substring for item values like PID, UID or CPU number. + +.TP +.B M= +SGR substring for percentage values in the range from 50% to 75%. + +.TP +.B N= +SGR substring for non-zero statistics values and for tasks names. + +.TP +.B Z= +SGR substring for zero values and for threads names. +.RE .IP S_TIME_FORMAT If this variable exists and its value is -- 2.50.0