lib/terminal-colors.d.5

   1 .\" terminal-colors.d.5 --
   2 .\" Copyright 2014 Ondrej Oprala <ooprala@redhat.com>
   3 .\" Copyright (C) 2014 Karel Zak <kzak@redhat.com>
   4 .\" Copyright 2014 Red Hat, Inc.
   5 .\" May be distributed under the GNU General Public License
   6 .TH "TERMINAL_COLORS.D" "5" "January 2014" "util-linux" "terminal-colors.d"
   7 .SH "NAME"
   8 terminal-colors.d \- Configure output colorization for various utilities
   9 .SH "SYNOPSIS"
  10 /etc/terminal-colors\&.d/[[\fIname\fR][@\fIterm\fR]\&.][\fItype\fR]
  11 .SH "DESCRIPTION"
  12 Files in this directory determine the default behavior for utilities
  13 when coloring output.
  14
  15 The
  16 .I name
  17 is a utility name.  The name is optional and when none is specified then the
  18 file is used for all unspecified utilities.
  19
  20 The
  21 .I term
  22 is a terminal identifier (the TERM environment variable).
  23 The terminal identifier is optional and when none is specified then the file
  24 is used for all unspecified terminals.
  25
  26 The
  27 .I type
  28 is a file type.  Supported file types are:
  29 .TP
  30 .B disable
  31 Turns off output colorization for all compatible utilities.
  32 .TP
  33 .B enable
  34 Turns on output colorization; any matching
  35 .B disable
  36 files are ignored.
  37 .TP
  38 .B scheme
  39 Specifies colors used for output.  The file format may be specific to the utility,
  40 the default format is described below.
  41 .PP
  42 If there are more files that match for a utility, then the file with the more
  43 specific filename wins.  For example, the filename "@xterm.scheme" has less
  44 priority than "dmesg@xterm.scheme".  The lowest priority are those files without a
  45 utility name and terminal identifier (e.g. "disable").
  46
  47 The user-specific
  48 .I $XDG_CONFIG_HOME/terminal-colors.d
  49 or
  50 .I $HOME/.config/terminal-colors.d
  51 overrides the global setting.
  52
  53 .SH EXAMPLES
  54 Disable colors for all compatible utilities:
  55 .RS
  56 .br
  57 .B "touch /etc/terminal-colors.d/disable"
  58 .br
  59 .RE
  60
  61 Disable colors for all compatible utils on a vt100 terminal:
  62 .RS
  63 .br
  64 .B "touch /etc/terminal-colors.d/@vt100.disable"
  65 .br
  66 .RE
  67
  68 Disable colors for all compatible utils except dmesg(1):
  69 .RS
  70 .br
  71 .B "touch /etc/terminal-colors.d/disable"
  72 .sp
  73 .B "touch /etc/terminal-colors.d/dmesg.enable"
  74 .br
  75 .RE
  76
  77 .SH DEFAULT SCHEME FILES FORMAT
  78 The following statement is recognized:
  79
  80 .RS
  81 .br
  82 .B "name color-sequence"
  83 .br
  84 .RE
  85
  86 The
  87 .B name
  88 is a logical name of color sequence (for example "error").  The names are
  89 specific to the utilities.  For more details always see the COLORS section
  90 in the man page for the utility.
  91
  92 The
  93 .B color-sequence
  94 is a color name, ASCII color sequences or escape sequences.
  95
  96 .SS Color names
  97 black, blue, brown, cyan, darkgray, gray, green, lightblue, lightcyan
  98 lightgray, lightgreen, lightmagenta, lightred, magenta, red and yellow
  99 .SS ANSI color sequences
 100 The color sequences are composed of sequences of numbers
 101 separated by semicolons.  The most common codes are:
 102 .sp
 103 .RS
 104 .TS
 105 l l.
 106  0      to restore default color
 107  1      for brighter colors
 108  4      for underlined text
 109  5      for flashing text
 110 30      for black foreground
 111 31      for red foreground
 112 32      for green foreground
 113 33      for yellow (or brown) foreground
 114 34      for blue foreground
 115 35      for purple foreground
 116 36      for cyan foreground
 117 37      for white (or gray) foreground
 118 40      for black background
 119 41      for red background
 120 42      for green background
 121 43      for yellow (or brown) background
 122 44      for blue background
 123 45      for purple background
 124 46      for cyan background
 125 47      for white (or gray) background
 126 .TE
 127 .RE
 128 .SS Escape sequences
 129 To specify control or blank characters in the color sequences,
 130 C-style \e-escaped notation can be used:
 131 .sp
 132 .RS
 133 .TS
 134 lb l.
 135 \ea     Bell (ASCII 7)
 136 \eb     Backspace (ASCII 8)
 137 \ee     Escape (ASCII 27)
 138 \ef     Form feed (ASCII 12)
 139 \en     Newline (ASCII 10)
 140 \er     Carriage Return (ASCII 13)
 141 \et     Tab (ASCII 9)
 142 \ev     Vertical Tab (ASCII 11)
 143 \e?     Delete (ASCII 127)
 144 \e_     Space
 145 \e\e    Backslash (\e)
 146 \e^     Caret (^)
 147 \e#     Hash mark (#)
 148 .TE
 149 .RE
 150 .sp
 151 Please note that escapes are necessary to enter a space, backslash,
 152 caret, or any control character anywhere in the string, as well as a
 153 hash mark as the first character.
 154
 155 For example, to use a red background for alert messages in the output of
 156 .BR dmesg (1),
 157 use:
 158
 159 .RS
 160 .br
 161 .B "echo 'alert 37;41' >> /etc/terminal-colors.d/dmesg.scheme"
 162 .br
 163 .RE
 164
 165 .SH FILES
 166 .B $XDG_CONFIG_HOME/terminal-colors.d
 167 .br
 168 .B $HOME/.config/terminal-colors.d
 169 .br
 170 .B /etc/terminal-colors.d
 171
 172 .SH COMPATIBILITY
 173 The terminal-colors.d functionality is currently supported by all util-linux
 174 utilities which provides colorized output.  For more details always see the
 175 COLORS section in the man page for the utility.
 176
 177 .SH AVAILABILITY
 178 terminal-colors.d is part of the util-linux package and is available from
 179 .UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 180 Linux Kernel Archive
 181 .UE .