git.1: Clarify the behavior of the --paginate option
authorJonathan Nieder <jrnieder@gmail.com>
Sun, 14 Feb 2010 12:02:35 +0000 (06:02 -0600)
committerJunio C Hamano <gitster@pobox.com>
Mon, 15 Feb 2010 02:23:17 +0000 (18:23 -0800)
The --paginate option is meant to negate the effect of an explicit or
implicit pager.<cmd> = false setting.  Thus it turns the pager on if
output is going to a terminal rather than unconditionally.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git.txt

index 01c463101b9b212f002e10a0d9e89a2df12652a2..f26641a5f4157907fd2e14b97d4a1050116e3e9a 100644 (file)
@@ -229,7 +229,10 @@ help ...`.
 
 -p::
 --paginate::
-       Pipe all output into 'less' (or if set, $PAGER).
+       Pipe all output into 'less' (or if set, $PAGER) if standard
+       output is a terminal.  This overrides the `pager.<cmd>`
+       configuration options (see the "Configuration Mechanism" section
+       below).
 
 --no-pager::
        Do not pipe git output into a pager.
@@ -401,7 +404,8 @@ people.  Here is an example:
 ------------
 
 Various commands read from the configuration file and adjust
-their operation accordingly.
+their operation accordingly.  See linkgit:git-config[1] for a
+list.
 
 
 Identifier Terminology