]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
terminal-colors.d: (man) reduce two tables to succinct lists
authorBenno Schulenberg <bensberg@telfort.nl>
Thu, 17 Apr 2025 09:48:19 +0000 (11:48 +0200)
committerKarel Zak <kzak@redhat.com>
Thu, 24 Apr 2025 09:51:45 +0000 (11:51 +0200)
Before the move to asciidoctor, these tables were succinct lists in the
man page.  Change the asciidoc text to make them into lists again.

Use {nbsp} on one line to avoid weird groff behavior for \? when .ss
is defined to be zero-width (as asciidoctor does), and reshuffle two
paragraphs to avoid an asciidoctor bug that adds a spurious \fP after
a monospace span defined with double backticks.

Also, correct some markup in a few earlier paragraphs.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
lib/terminal-colors.d.5.adoc

index ed8c4872712963a55b4c7dd2600b41120549ab26..4936947b112dcdcd6c0633c4a93852e372819266 100644 (file)
@@ -47,14 +47,15 @@ The user-specific _$XDG_CONFIG_HOME/terminal-colors.d_ or _$HOME/.config/termina
 == DEFAULT SCHEME FILES FORMAT
 
 The following statement is recognized:
-
 ____
-*name color-sequence*
+_name color-sequence_
 ____
 
-The *name* is a logical name of 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 _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_ is a color name, ASCII color sequences, or escape sequences.
 
 === Color names
 
@@ -63,67 +64,59 @@ black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightb
 === ANSI color sequences
 
 The color sequences are composed of sequences of numbers separated by semicolons. The most common codes are:
-
 ____
-[cols=",",]
-|===
-|0 |to restore default color
-|1 |for brighter colors
-|4 |for underlined text
-|5 |for flashing text
-|30 |for black foreground
-|31 |for red foreground
-|32 |for green foreground
-|33 |for yellow (or brown) foreground
-|34 |for blue foreground
-|35 |for purple foreground
-|36 |for cyan foreground
-|37 |for white (or gray) foreground
-|40 |for black background
-|41 |for red background
-|42 |for green background
-|43 |for yellow (or brown) background
-|44 |for blue background
-|45 |for purple background
-|46 |for cyan background
-|47 |for white (or gray) background
-|===
+     0   to restore default color
+     1   for brighter colors
+     4   for underlined text
+     5   for flashing text
+    30   for black foreground
+    31   for red foreground
+    32   for green foreground
+    33   for yellow (or brown) foreground
+    34   for blue foreground
+    35   for purple foreground
+    36   for cyan foreground
+    37   for white (or gray) foreground
+    40   for black background
+    41   for red background
+    42   for green background
+    43   for yellow (or brown) background
+    44   for blue background
+    45   for purple background
+    46   for cyan background
+    47   for white (or gray) background
 ____
 
-=== Escape sequences
+For example, to use a red background for alert messages in the output of *dmesg*(1), use:
 
-To specify control or blank characters in the color sequences, C-style \-escaped notation can be used:
+``  *echo 'alert 37;41' >> /etc/terminal-colors.d/dmesg.scheme*``
 
-____
-[cols=",",]
-|===
-|*\a* |Bell (ASCII 7)
-|*\b* |Backspace (ASCII 8)
-|*\e* |Escape (ASCII 27)
-|*\f* |Form feed (ASCII 12)
-|*\n* |Newline (ASCII 10)
-|*\r* |Carriage Return (ASCII 13)
-|*\t* |Tab (ASCII 9)
-|*\v* |Vertical Tab (ASCII 11)
-|*\?* |Delete (ASCII 127)
-|*\_* |Space
-|*\\* |Backslash (\)
-|*\^* |Caret (^)
-|*\#* |Hash mark (#)
-|===
-____
-
-Please note that escapes are necessary to enter a space, backslash, caret, or any control character anywhere in the string, as well as a hash mark as the first character.
+=== Escape sequences
 
-For example, to use a red background for alert messages in the output of *dmesg*(1), use:
+An escape sequence is necessary 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:
 
 ____
-*echo 'alert 37;41' >> /etc/terminal-colors.d/dmesg.scheme*
+``    *\a*   Bell (ASCII 7)``
+``    *\b*   Backspace (ASCII 8)``
+``    *\e*   Escape (ASCII 27)``
+``    *\f*   Form feed (ASCII 12)``
+``    *\n*   Newline (ASCII 10)``
+``    *\r*   Carriage Return (ASCII 13)``
+``    *\t*   Tab (ASCII 9)``
+``    *\v*   Vertical Tab (ASCII 11)``
+``    *\?*{nbsp}{nbsp}{nbsp}Delete (ASCII 127)``
+``    *\_*   Space``
+``    *\\*   Backslash (\)``
+``    *\^*   Caret (^)``
+``    *\\#*   Hash mark (#)``
 ____
 
 === Comments
 
-Lines where the first non-blank character is a # (hash) are ignored. Any other use of the hash character is not interpreted as introducing a comment.
+Lines where the first non-blank character is a *#* (hash) are ignored.
+Any other use of the hash character is not interpreted as introducing a comment.
 
 == ENVIRONMENT