commit: 6fe49a405c30f1ae5bb0d57bc869b383fc3198ab Author: Fabian Groffen <grobian <AT> gentoo <DOT> org> AuthorDate: Fri Jun 27 15:07:50 2025 +0000 Commit: Fabian Groffen <grobian <AT> gentoo <DOT> org> CommitDate: Fri Jun 27 15:07:50 2025 +0000 URL: https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=6fe49a40
man/q: add documentation for color.map support Bug: https://bugs.gentoo.org/958487 Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org> man/include/q-01-colours.include | 87 +++++++++++++++++++++++++++++++++++++++ man/q.1 | 89 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 175 insertions(+), 1 deletion(-) diff --git a/man/include/q-01-colours.include b/man/include/q-01-colours.include new file mode 100644 index 0000000..6c2f7d4 --- /dev/null +++ b/man/include/q-01-colours.include @@ -0,0 +1,87 @@ +.SH "COLOR.MAP SUPPORT" +The colors portage-utils is emitting can be changed via Portage's +.BR color.map (5) +file. At this point of writing, portage-utils +applets do not use the classes such as \fIWARN\fR, \fIERROR\fR, and so +forth. Instead the colors as used can be re-mapped onto other colors +via the simple color=color-definition syntax. The following example +shows supported syntax to set colors: + +.nf + red=Yellow + brown ="teal" + fuchsia='teal' + red= 0x000000 # RGB black + darkgreen = 1;96m # ANSI +.fi + +More specifically, the syntax is key=value, where spaces around key and +value after splitting on the =-sign are trimmed. Value may be +optionally quoted via single or double quotes. Keys and values are +matched case-insensitive against known values. The list of keys that +represent color names that can be redefined is: + +.nf + teal + bold + brown + turquoise + darkblue + green + darkgreen + fuchsia + red + white + yellow +.fi + +Supported value can be a color name, a selected set of RGB colors or +ANSI color escape code. The list of color names that can be used is: + +.nf + black + darkgrey + darkgray + red + darkred + green + darkgreen + yellow + brown + darkyellow + blue + darkblue + fuchsia + purple + turquoise + darkteal + teal + + bryellow + cyan + dkblue + dkgreen + magenta +.fi + +The list of RGB colors that can be used: + +.nf + 0x000000 (BLACK) + 0x555555 (DARKGREY) + 0xAA0000 (RED) + 0xFF5555 (DARKRED) + 0x00AA00 (GREEN) + 0x55FF55 (DARKGREEN) + 0xAA5500 (YELLOW) + 0xFFFF55 (BROWN) + 0x0000AA (BLUE) + 0x5555FF (DARKBLUE) + 0xAA00AA (FUCHSIA) + 0xFF55FF (PURPLE) + 0x00AAAA (TURQUOISE) + 0x55FFFF (TEAL) + 0xAAAAAA (WHITE) + 0xFFFFFF (LIGHTGREY) + 0xAAAA00 (BROWN) +.fi diff --git a/man/q.1 b/man/q.1 index 98d4cfe..7f36a6c 100644 --- a/man/q.1 +++ b/man/q.1 @@ -1,5 +1,5 @@ .\" generated by mkman.py, please do NOT edit! -.TH q "1" "Jan 2024" "Gentoo Foundation" "q" +.TH q "1" "Jun 2025" "Gentoo Foundation" "q" .SH NAME q \- invoke a portage utility applet .SH SYNOPSIS @@ -82,6 +82,93 @@ Print version and exit. qwhich <pkg ...> : find path to pkg qxpak <misc args> : manipulate xpak archives .fi +.SH "COLOR.MAP SUPPORT" +The colors portage-utils is emitting can be changed via Portage's +.BR color.map (5) +file. At this point of writing, portage-utils +applets do not use the classes such as \fIWARN\fR, \fIERROR\fR, and so +forth. Instead the colors as used can be re-mapped onto other colors +via the simple color=color-definition syntax. The following example +shows supported syntax to set colors: + +.nf + red=Yellow + brown ="teal" + fuchsia='teal' + red= 0x000000 # RGB black + darkgreen = 1;96m # ANSI +.fi + +More specifically, the syntax is key=value, where spaces around key and +value after splitting on the =-sign are trimmed. Value may be +optionally quoted via single or double quotes. Keys and values are +matched case-insensitive against known values. The list of keys that +represent color names that can be redefined is: + +.nf + teal + bold + brown + turquoise + darkblue + green + darkgreen + fuchsia + red + white + yellow +.fi + +Supported value can be a color name, a selected set of RGB colors or +ANSI color escape code. The list of color names that can be used is: + +.nf + black + darkgrey + darkgray + red + darkred + green + darkgreen + yellow + brown + darkyellow + blue + darkblue + fuchsia + purple + turquoise + darkteal + teal + + bryellow + cyan + dkblue + dkgreen + magenta +.fi + +The list of RGB colors that can be used: + +.nf + 0x000000 (BLACK) + 0x555555 (DARKGREY) + 0xAA0000 (RED) + 0xFF5555 (DARKRED) + 0x00AA00 (GREEN) + 0x55FF55 (DARKGREEN) + 0xAA5500 (YELLOW) + 0xFFFF55 (BROWN) + 0x0000AA (BLUE) + 0x5555FF (DARKBLUE) + 0xAA00AA (FUCHSIA) + 0xFF55FF (PURPLE) + 0x00AAAA (TURQUOISE) + 0x55FFFF (TEAL) + 0xAAAAAA (WHITE) + 0xFFFFFF (LIGHTGREY) + 0xAAAA00 (BROWN) +.fi .SH "REPORTING BUGS" Please report bugs via http://bugs.gentoo.org/ .br
