{ "content": [ { "type": "text", "text": "# terminal-colors.d (man)\n\n## NAME\n\nterminal-colors.d - configure output colorization for various utilities\n\n## SYNOPSIS\n\n/etc/terminal-colors.d/[[name][@term].][type]\n\n## DESCRIPTION\n\nFiles in this directory determine the default behavior for utilities when coloring output.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (3 subsections)\n- **DEFAULT SCHEME FILES FORMAT** (4 subsections)\n- **ENVIRONMENT**\n- **FILES**\n- **EXAMPLE**\n- **COMPATIBILITY**\n- **REPORTING BUGS**\n- **AVAILABILITY**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "terminal-colors.d", "section": "", "mode": "man", "summary": "terminal-colors.d - configure output colorization for various utilities", "synopsis": "/etc/terminal-colors.d/[[name][@term].][type]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "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/dmesg.enable" ], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 10, "subsections": [ { "name": "disable", "lines": 2 }, { "name": "enable", "lines": 2 }, { "name": "scheme", "lines": 11 } ] }, { "name": "DEFAULT SCHEME FILES FORMAT", "lines": 10, "subsections": [ { "name": "Color names", "lines": 4 }, { "name": "ANSI color sequences", "lines": 67 }, { "name": "Escape sequences", "lines": 53 }, { "name": "Comments", "lines": 3 } ] }, { "name": "ENVIRONMENT", "lines": 3, "subsections": [] }, { "name": "FILES", "lines": 6, "subsections": [] }, { "name": "EXAMPLE", "lines": 14, "subsections": [] }, { "name": "COMPATIBILITY", "lines": 4, "subsections": [] }, { "name": "REPORTING BUGS", "lines": 3, "subsections": [] }, { "name": "AVAILABILITY", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "terminal-colors.d - configure output colorization for various utilities\n", "subsections": [] }, "SYNOPSIS": { "content": "/etc/terminal-colors.d/[[name][@term].][type]\n", "subsections": [] }, "DESCRIPTION": { "content": "Files in this directory determine the default behavior for utilities when coloring output.\n\nThe name is a utility name. The name is optional and when none is specified then the file is\nused for all unspecified utilities.\n\nThe term is a terminal identifier (the TERM environment variable). The terminal identifier is\noptional and when none is specified then the file is used for all unspecified terminals.\n\nThe type is a file type. Supported file types are:\n", "subsections": [ { "name": "disable", "content": "Turns off output colorization for all compatible utilities.\n" }, { "name": "enable", "content": "Turns on output colorization; any matching disable files are ignored.\n" }, { "name": "scheme", "content": "Specifies colors used for output. The file format may be specific to the utility, the\ndefault format is described below.\n\nIf there are more files that match for a utility, then the file with the more specific\nfilename wins. For example, the filename \"@xterm.scheme\" has less priority than\n\"dmesg@xterm.scheme\". The lowest priority are those files without a utility name and terminal\nidentifier (e.g., \"disable\").\n\nThe user-specific $XDGCONFIGHOME/terminal-colors.d or $HOME/.config/terminal-colors.d\noverrides the global setting.\n" } ] }, "DEFAULT SCHEME FILES FORMAT": { "content": "The following statement is recognized:\n\nname color-sequence\n\nThe name is a logical name of color sequence (for example \"error\"). The names are specific to\nthe utilities. For more details always see the COLORS section in the man page for the\nutility.\n\nThe color-sequence is a color name, ASCII color sequences or escape sequences.\n", "subsections": [ { "name": "Color names", "content": "black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue,\nlightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, and\nyellow.\n" }, { "name": "ANSI color sequences", "content": "The color sequences are composed of sequences of numbers separated by semicolons. The most\ncommon codes are:\n┌────┬────────────────────────────────┐\n│ │ │\n│ 0 │ to restore default color │\n├────┼────────────────────────────────┤\n│ │ │\n│ 1 │ for brighter colors │\n├────┼────────────────────────────────┤\n│ │ │\n│ 4 │ for underlined text │\n├────┼────────────────────────────────┤\n│ │ │\n│ 5 │ for flashing text │\n├────┼────────────────────────────────┤\n│ │ │\n│ 30 │ for black foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 31 │ for red foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 32 │ for green foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 33 │ for yellow (or brown) │\n│ │ foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 34 │ for blue foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 35 │ for purple foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 36 │ for cyan foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 37 │ for white (or gray) foreground │\n├────┼────────────────────────────────┤\n│ │ │\n│ 40 │ for black background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 41 │ for red background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 42 │ for green background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 43 │ for yellow (or brown) │\n│ │ background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 44 │ for blue background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 45 │ for purple background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 46 │ for cyan background │\n├────┼────────────────────────────────┤\n│ │ │\n│ 47 │ for white (or gray) background │\n└────┴────────────────────────────────┘\n\n" }, { "name": "Escape sequences", "content": "To specify control or blank characters in the color sequences, C-style \\-escaped\nnotation can be used:\n┌────┬────────────────────────────┐\n│ │ │\n│ \\a │ Bell (ASCII 7) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\b │ Backspace (ASCII 8) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\e │ Escape (ASCII 27) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\f │ Form feed (ASCII 12) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\n │ Newline (ASCII 10) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\r │ Carriage Return (ASCII 13) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\t │ Tab (ASCII 9) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\v │ Vertical Tab (ASCII 11) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\? │ Delete (ASCII 127) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\ │ Space │\n├────┼────────────────────────────┤\n│ │ │\n│ \\\\ │ Backslash (\\) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\^ │ Caret (^) │\n├────┼────────────────────────────┤\n│ │ │\n│ \\# │ Hash mark (#) │\n└────┴────────────────────────────┘\n\n\nPlease note that escapes are necessary to enter a space, backslash, caret, or\nany control character anywhere in the string, as well as a hash mark as the\nfirst character.\n\nFor example, to use a red background for alert messages in the output of\ndmesg(1), use:\n\necho 'alert 37;41' >> /etc/terminal-colors.d/dmesg.scheme\n" }, { "name": "Comments", "content": "Lines where the first non-blank character is a # (hash) are ignored. Any\nother use of the hash character is not interpreted as introducing a comment.\n" } ] }, "ENVIRONMENT": { "content": "TERMINALCOLORSDEBUG=all\nenables debug output.\n", "subsections": [] }, "FILES": { "content": "$XDGCONFIGHOME/terminal-colors.d\n\n$HOME/.config/terminal-colors.d\n\n/etc/terminal-colors.d\n", "subsections": [] }, "EXAMPLE": { "content": "Disable colors for all compatible utilities:\n\ntouch /etc/terminal-colors.d/disable\n\nDisable colors for all compatible utils on a vt100 terminal:\n\ntouch /etc/terminal-colors.d/@vt100.disable\n\nDisable colors for all compatible utils except dmesg(1):\n\ntouch /etc/terminal-colors.d/disable\n\ntouch /etc/terminal-colors.d/dmesg.enable\n", "subsections": [] }, "COMPATIBILITY": { "content": "The terminal-colors.d functionality is currently supported by all util-linux\nutilities which provides colorized output. For more details always see the\nCOLORS section in the man page for the utility.\n", "subsections": [] }, "REPORTING BUGS": { "content": "For bug reports, use the issue tracker at\n\u001b[34mhttps://github.com/util-linux/util-linux/issues\u001b[0m.\n", "subsections": [] }, "AVAILABILITY": { "content": "terminal-colors.d is part of the util-linux package which can be downloaded\nfrom \u001b[34mLinux Kernel Archive\u001b[0m\n.\n\nutil-linux 2.39.3 2023-10-23 TERMINAL-COLORS.D(5)", "subsections": [] } } } }