man: Document COLORFGBG environment variable

Default colors are not contrast enough on dark backround
and this functionality, which uses more suitable colors
is hidden in the code.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
This commit is contained in:
Petr Vorel 2019-02-21 16:04:01 +01:00 committed by Stephen Hemminger
parent 2f103545a5
commit 8b5f9338e5
1 changed files with 17 additions and 0 deletions

View File

@ -189,6 +189,12 @@ precedence. This flag is ignored if
.B \-json
is also given.
Used color palette can be influenced by
.BR COLORFGBG
environment variable
(see
.BR ENVIRONMENT ).
.TP
.BR "\-t" , " \-timestamp"
display current time when using monitor option.
@ -330,6 +336,17 @@ Usually it is
or, if the objects of this class cannot be listed,
.BR "help" .
.SH ENVIRONMENT
.TP
.B COLORFGBG
If set, it's value is used for detection whether background is dark or light and use contrast colors for it.
COLORFGBG environment variable usually contains either two or three
values separated by semicolons; we want the last value in either case.
If this value is 0-6 or 8, chose colors suitable for dark background:
COLORFGBG=";0" ip -c a
.SH EXIT STATUS
Exit status is 0 if command was successful, and 1 if there is a syntax error.
If an error was reported by the kernel exit status is 2.