The second batch
[git] / Documentation / config / color.txt
1 color.advice::
2         A boolean to enable/disable color in hints (e.g. when a push
3         failed, see `advice.*` for a list).  May be set to `always`,
4         `false` (or `never`) or `auto` (or `true`), in which case colors
5         are used only when the error output goes to a terminal. If
6         unset, then the value of `color.ui` is used (`auto` by default).
7
8 color.advice.hint::
9         Use customized color for hints.
10
11 color.blame.highlightRecent::
12         This can be used to color the metadata of a blame line depending
13         on age of the line.
14 +
15 This setting should be set to a comma-separated list of color and date settings,
16 starting and ending with a color, the dates should be set from oldest to newest.
17 The metadata will be colored given the colors if the line was introduced
18 before the given timestamp, overwriting older timestamped colors.
19 +
20 Instead of an absolute timestamp relative timestamps work as well, e.g.
21 2.weeks.ago is valid to address anything older than 2 weeks.
22 +
23 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
24 everything older than one year blue, recent changes between one month and
25 one year old are kept white, and lines introduced within the last month are
26 colored red.
27
28 color.blame.repeatedLines::
29         Use the customized color for the part of git-blame output that
30         is repeated meta information per line (such as commit id,
31         author name, date and timezone). Defaults to cyan.
32
33 color.branch::
34         A boolean to enable/disable color in the output of
35         linkgit:git-branch[1]. May be set to `always`,
36         `false` (or `never`) or `auto` (or `true`), in which case colors are used
37         only when the output is to a terminal. If unset, then the
38         value of `color.ui` is used (`auto` by default).
39
40 color.branch.<slot>::
41         Use customized color for branch coloration. `<slot>` is one of
42         `current` (the current branch), `local` (a local branch),
43         `remote` (a remote-tracking branch in refs/remotes/),
44         `upstream` (upstream tracking branch), `plain` (other
45         refs).
46
47 color.diff::
48         Whether to use ANSI escape sequences to add color to patches.
49         If this is set to `always`, linkgit:git-diff[1],
50         linkgit:git-log[1], and linkgit:git-show[1] will use color
51         for all patches.  If it is set to `true` or `auto`, those
52         commands will only use color when output is to the terminal.
53         If unset, then the value of `color.ui` is used (`auto` by
54         default).
55 +
56 This does not affect linkgit:git-format-patch[1] or the
57 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
58 command line with the `--color[=<when>]` option.
59
60 color.diff.<slot>::
61         Use customized color for diff colorization.  `<slot>` specifies
62         which part of the patch to use the specified color, and is one
63         of `context` (context text - `plain` is a historical synonym),
64         `meta` (metainformation), `frag`
65         (hunk header), 'func' (function in hunk header), `old` (removed lines),
66         `new` (added lines), `commit` (commit headers), `whitespace`
67         (highlighting whitespace errors), `oldMoved` (deleted lines),
68         `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
69         `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
70         `newMovedAlternativeDimmed` (See the '<mode>'
71         setting of '--color-moved' in linkgit:git-diff[1] for details),
72         `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
73         `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
74
75 color.decorate.<slot>::
76         Use customized color for 'git log --decorate' output.  `<slot>` is one
77         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
78         branches, remote-tracking branches, tags, stash and HEAD, respectively
79         and `grafted` for grafted commits.
80
81 color.grep::
82         When set to `always`, always highlight matches.  When `false` (or
83         `never`), never.  When set to `true` or `auto`, use color only
84         when the output is written to the terminal.  If unset, then the
85         value of `color.ui` is used (`auto` by default).
86
87 color.grep.<slot>::
88         Use customized color for grep colorization.  `<slot>` specifies which
89         part of the line to use the specified color, and is one of
90 +
91 --
92 `context`;;
93         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
94 `filename`;;
95         filename prefix (when not using `-h`)
96 `function`;;
97         function name lines (when using `-p`)
98 `lineNumber`;;
99         line number prefix (when using `-n`)
100 `column`;;
101         column number prefix (when using `--column`)
102 `match`;;
103         matching text (same as setting `matchContext` and `matchSelected`)
104 `matchContext`;;
105         matching text in context lines
106 `matchSelected`;;
107         matching text in selected lines
108 `selected`;;
109         non-matching text in selected lines
110 `separator`;;
111         separators between fields on a line (`:`, `-`, and `=`)
112         and between hunks (`--`)
113 --
114
115 color.interactive::
116         When set to `always`, always use colors for interactive prompts
117         and displays (such as those used by "git-add --interactive" and
118         "git-clean --interactive"). When false (or `never`), never.
119         When set to `true` or `auto`, use colors only when the output is
120         to the terminal. If unset, then the value of `color.ui` is
121         used (`auto` by default).
122
123 color.interactive.<slot>::
124         Use customized color for 'git add --interactive' and 'git clean
125         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
126         or `error`, for four distinct types of normal output from
127         interactive commands.
128
129 color.pager::
130         A boolean to specify whether `auto` color modes should colorize
131         output going to the pager. Defaults to true; set this to false
132         if your pager does not understand ANSI color codes.
133
134 color.push::
135         A boolean to enable/disable color in push errors. May be set to
136         `always`, `false` (or `never`) or `auto` (or `true`), in which
137         case colors are used only when the error output goes to a terminal.
138         If unset, then the value of `color.ui` is used (`auto` by default).
139
140 color.push.error::
141         Use customized color for push errors.
142
143 color.remote::
144         If set, keywords at the start of the line are highlighted. The
145         keywords are "error", "warning", "hint" and "success", and are
146         matched case-insensitively. May be set to `always`, `false` (or
147         `never`) or `auto` (or `true`). If unset, then the value of
148         `color.ui` is used (`auto` by default).
149
150 color.remote.<slot>::
151         Use customized color for each remote keyword. `<slot>` may be
152         `hint`, `warning`, `success` or `error` which match the
153         corresponding keyword.
154
155 color.showBranch::
156         A boolean to enable/disable color in the output of
157         linkgit:git-show-branch[1]. May be set to `always`,
158         `false` (or `never`) or `auto` (or `true`), in which case colors are used
159         only when the output is to a terminal. If unset, then the
160         value of `color.ui` is used (`auto` by default).
161
162 color.status::
163         A boolean to enable/disable color in the output of
164         linkgit:git-status[1]. May be set to `always`,
165         `false` (or `never`) or `auto` (or `true`), in which case colors are used
166         only when the output is to a terminal. If unset, then the
167         value of `color.ui` is used (`auto` by default).
168
169 color.status.<slot>::
170         Use customized color for status colorization. `<slot>` is
171         one of `header` (the header text of the status message),
172         `added` or `updated` (files which are added but not committed),
173         `changed` (files which are changed but not added in the index),
174         `untracked` (files which are not tracked by Git),
175         `branch` (the current branch),
176         `nobranch` (the color the 'no branch' warning is shown in, defaulting
177         to red),
178         `localBranch` or `remoteBranch` (the local and remote branch names,
179         respectively, when branch and tracking information is displayed in the
180         status short-format), or
181         `unmerged` (files which have unmerged changes).
182
183 color.transport::
184         A boolean to enable/disable color when pushes are rejected. May be
185         set to `always`, `false` (or `never`) or `auto` (or `true`), in which
186         case colors are used only when the error output goes to a terminal.
187         If unset, then the value of `color.ui` is used (`auto` by default).
188
189 color.transport.rejected::
190         Use customized color when a push was rejected.
191
192 color.ui::
193         This variable determines the default value for variables such
194         as `color.diff` and `color.grep` that control the use of color
195         per command family. Its scope will expand as more commands learn
196         configuration to set a default for the `--color` option.  Set it
197         to `false` or `never` if you prefer Git commands not to use
198         color unless enabled explicitly with some other configuration
199         or the `--color` option. Set it to `always` if you want all
200         output not intended for machine consumption to use color, to
201         `true` or `auto` (this is the default since Git 1.8.4) if you
202         want such output to use color when written to the terminal.