]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
terminal-colors.d: (man) re-apply improvements lost in merge
authorBenno Schulenberg <bensberg@telfort.nl>
Wed, 11 Mar 2026 11:35:57 +0000 (12:35 +0100)
committerKarel Zak <kzak@redhat.com>
Wed, 11 Mar 2026 11:35:57 +0000 (12:35 +0100)
Commit 3252142521 improved the man page formatting and wording,
but merge commit d708fc7db6 undid all those changes due to a
conflict resolution mess.  Re-apply the improvements:

 - do not show 'type' as an optional part in the synopsis
 - indent the list of file types for clarity
 - correct and improve several wordings
 - fix grammar ("which provide" not "which provides")
 - compact the examples section

Addresses: https://github.com/util-linux/util-linux/commit/3252142521
Signed-off-by: Karel Zak <kzak@redhat.com>
lib/terminal-colors.d.5.adoc

index c49f85b160339b2d345e3832464153c5a7834574..f337c3a576eb0817707d88c90fd7290e405a1836 100644 (file)
@@ -21,7 +21,7 @@ terminal-colors.d - configure output colorization for various utilities
 
 == SYNOPSIS
 
-/etc/terminal-colors.d/_[[name][@term].][type]_
+*/etc/terminal-colors.d/*++[++_name_**.**|++[++_name_]**@**_term_**.**]_type_
 
 == DESCRIPTION
 
@@ -32,15 +32,14 @@ The _name_ is a utility name. The name is optional and when none is specified th
 The _term_ is a terminal identifier (the *TERM* environment variable). The terminal identifier is optional and when none is specified then the file is used for all unspecified terminals.
 
 The _type_ is a file type. Supported file types are:
-
+____
 *disable*::
 Turns off output colorization for all compatible utilities. See also the *NO_COLOR* environment variable below.
-
 *enable*::
 Turns on output colorization; any matching *disable* files are ignored.
-
 *scheme*::
 Specifies colors used for output. The file format may be specific to the utility, the default format is described below.
+____
 
 If there are more files that match for a utility, then the file with the more specific filename wins. For example, the filename _@xterm.scheme_ has less priority than _dmesg@xterm.scheme_. The lowest priority are those files without a utility name and terminal identifier (e.g., "disable").
 
@@ -57,15 +56,15 @@ The _name_ is a logical name for the color sequence (for example: *error*).
 The names are specific to the utilities. For more details always see
 the *COLORS* section in the man page for the utility.
 
-The _color-sequence_ is a color name, ASCII color sequences, or escape sequences.
+The _color-sequence_ can be a color name, an ANSI color sequence, or an escape sequence.
 
 === Color names
 
-black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, and yellow.
+Valid color names are: black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, and yellow.
 
 === ANSI color sequences
 
-The color sequences are composed of sequences of numbers separated by semicolons. The most common codes are:
+An ANSI color sequence is composed of sequences of numbers separated by semicolons. The most common codes are:
 
 [cols=">1,4"]
 |===
@@ -137,7 +136,7 @@ For example, to use a red background for alert messages in the output of *dmesg*
 
 === Escape sequences
 
-An escape sequence is necessary to enter a space, backslash, caret, or any
+An escape sequence is needed to enter a space, backslash, caret, or any
 control character anywhere in a string, as well as a hash mark as the first
 character. These C-style backslash-escapes can be used:
 
@@ -206,31 +205,27 @@ _$HOME/.config/terminal-colors.d_
 
 _/etc/terminal-colors.d_
 
-== EXAMPLE
+== EXAMPLES
 
 Disable colors for all compatible utilities:
-
 ____
 *touch /etc/terminal-colors.d/disable*
 ____
 
 Disable colors for all compatible utils on a vt100 terminal:
-
 ____
 *touch /etc/terminal-colors.d/@vt100.disable*
 ____
 
 Disable colors for all compatible utils except *dmesg*(1):
-
 ____
-*touch /etc/terminal-colors.d/disable*
-
+*touch /etc/terminal-colors.d/disable* +
 *touch /etc/terminal-colors.d/dmesg.enable*
 ____
 
 == COMPATIBILITY
 
-The *terminal-colors.d* functionality is currently supported by all util-linux utilities which provides colorized output. For more details always see the *COLORS* section in the man page for the utility.
+The *terminal-colors.d* functionality is currently supported by all util-linux utilities which provide colorized output. For more details always see the *COLORS* section in the man page for the utility.
 
 include::man-common/bugreports.adoc[]