Skip to content

Commit a84216c

Browse files
peffgitster
authored andcommitted
doc: explain the use of color.pager
The current documentation for color.pager is technically correct, but slightly misleading and doesn't really clarify the purpose of the variable. As explained in the original thread which added it: https://lore.kernel.org/git/[email protected]/ the point is to deal with pagers that don't understand colors. And hence it being set to "true" is necessary for colorizing output to the pager, but not sufficient by itself (you must also have enabled one of the other color options, though note that these are set to "auto" by default these days). Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 48bf2fa commit a84216c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/config/color.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,9 @@ color.interactive.<slot>::
127127
interactive commands.
128128

129129
color.pager::
130-
A boolean to enable/disable colored output when the pager is in
131-
use (default is true).
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.
132133

133134
color.push::
134135
A boolean to enable/disable color in push errors. May be set to

0 commit comments

Comments
 (0)