From 8b5f9338e549cf06a3fa94c14b3a0b61ae8c3eca Mon Sep 17 00:00:00 2001 From: Petr Vorel Date: Thu, 21 Feb 2019 16:04:01 +0100 Subject: [PATCH] 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 --- man/man8/ip.8 | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/man/man8/ip.8 b/man/man8/ip.8 index 84ade110..133d40d5 100644 --- a/man/man8/ip.8 +++ b/man/man8/ip.8 @@ -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.