cat-file: document -p option

Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Jeff King 2006-05-24 21:22:32 -04:00 committed by Junio C Hamano
parent 4acdeafe5e
commit ed90cbf5f6
1 changed files with 7 additions and 2 deletions

View File

@ -8,12 +8,12 @@ git-cat-file - Provide content or type information for repository objects


SYNOPSIS SYNOPSIS
-------- --------
'git-cat-file' [-t | -s | -e | <type>] <object> 'git-cat-file' [-t | -s | -e | -p | <type>] <object>


DESCRIPTION DESCRIPTION
----------- -----------
Provides content or type of objects in the repository. The type Provides content or type of objects in the repository. The type
is required unless '-t' is used to find the object type, is required unless '-t' or '-p' is used to find the object type,
or '-s' is used to find the object size. or '-s' is used to find the object size.


OPTIONS OPTIONS
@ -33,6 +33,9 @@ OPTIONS
Suppress all output; instead exit with zero status if <object> Suppress all output; instead exit with zero status if <object>
exists and is a valid object. exists and is a valid object.


-p::
Pretty-print the contents of <object> based on its type.

<type>:: <type>::
Typically this matches the real type of <object> but asking Typically this matches the real type of <object> but asking
for a type that can trivially be dereferenced from the given for a type that can trivially be dereferenced from the given
@ -49,6 +52,8 @@ If '-s' is specified, the size of the <object> in bytes.


If '-e' is specified, no output. If '-e' is specified, no output.


If '-p' is specified, the contents of <object> are pretty-printed.

Otherwise the raw (though uncompressed) contents of the <object> will Otherwise the raw (though uncompressed) contents of the <object> will
be returned. be returned.