git-tar-tree: no more void pointer arithmetic
[git.git] / Documentation / git-cat-file.txt
index 2131a29..5e9cbf8 100644 (file)
@@ -1,6 +1,5 @@
 git-cat-file(1)
 ===============
-v0.1, May 2005
 
 NAME
 ----
@@ -9,12 +8,12 @@ git-cat-file - Provide content or type information for repository objects
 
 SYNOPSIS
 --------
-'git-cat-file' (-t | -s | <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
@@ -30,9 +29,16 @@ OPTIONS
        Instead of the content, show the object size identified by
        <object>.
 
+-e::
+       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 dereferenced from the given
+       for a type that can trivially be dereferenced from the given
        <object> is also permitted.  An example is to ask for a
        "tree" with <object> being a commit object that contains it,
        or to ask for a "blob" with <object> being a tag object that
@@ -40,8 +46,13 @@ OPTIONS
 
 OUTPUT
 ------
-If '-t' is specified, one of the <type>.  If '-s' is specified,
-the size of the <object> in bytes.
+If '-t' is specified, one of the <type>.
+
+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.
@@ -57,5 +68,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite