From: Jeff King <peff@peff.net>
Date: Thu, 25 May 2006 01:22:32 +0000 (-0400)
Subject: cat-file: document -p option
X-Git-Tag: v1.4.0-rc1~68
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=ed90cbf5f681c0144909457be3f4792b47604a5b;p=git.git

cat-file: document -p option

Signed-off-by: Junio C Hamano <junkio@cox.net>
---

diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 504eb1b1..5e9cbf87 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -8,12 +8,12 @@ git-cat-file - Provide content or type 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
@@ -33,6 +33,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 +52,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.