Add custom subject prefix support to format-patch (take 3)
[gitweb.git] / Documentation / git-cat-file.txt
index 504eb1b16a59c5af43fa1206723dece9207ee0eb..075c0d05efca85c2357e09aa640aa4b7f0305419 100644 (file)
@@ -3,23 +3,25 @@ git-cat-file(1)
 
 NAME
 ----
-git-cat-file - Provide content or type information for repository objects
+git-cat-file - Provide content or type/size information for repository objects
 
 
 SYNOPSIS
 --------
-'git-cat-file' [-t | -s | -e | <type>] <object>
+'git-cat-file' [-t | -s | -e | -p | <type>] <object>
 
 DESCRIPTION
 -----------
 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.
 
 OPTIONS
 -------
 <object>::
-       The sha1 identifier of the object.
+       The name of the object to show.
+       For a more complete list of ways to spell object names, see
+       "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 
 -t::
        Instead of the content, show the object type identified by
@@ -33,6 +35,9 @@ OPTIONS
        Suppress all output; instead exit with zero status if <object>
        exists and is a valid object.
 
+-p::
+       Pretty-print the contents of <object> based on its type.
+
 <type>::
        Typically this matches the real type of <object> but asking
        for a type that can trivially be dereferenced from the given
@@ -49,6 +54,8 @@ If '-s' is specified, the size of the <object> in bytes.
 
 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
 be returned.