[PATCH] Add git-var a tool for reading interesting git variables.
[gitweb.git] / Documentation / git-cat-file.txt
index 48fb37769c2f4e528f143713125b3d6593d57c7d..2131a29993405742fcc67ed81a578c06bf950f44 100644 (file)
@@ -9,12 +9,13 @@ git-cat-file - Provide content or type information for repository objects
 
 SYNOPSIS
 --------
-'git-cat-file' (-t | <type>) <object>
+'git-cat-file' (-t | -s | <type>) <object>
 
 DESCRIPTION
 -----------
 Provides content or type of objects in the repository. The type
-is required if '-t' is not being used to find the object type.
+is required unless '-t' is used to find the object type,
+or '-s' is used to find the object size.
 
 OPTIONS
 -------
@@ -25,6 +26,10 @@ OPTIONS
        Instead of the content, show the object type identified by
        <object>.
 
+-s::
+       Instead of the content, show the object size identified by
+       <object>.
+
 <type>::
        Typically this matches the real type of <object> but asking
        for a type that can trivially dereferenced from the given
@@ -35,7 +40,8 @@ OPTIONS
 
 OUTPUT
 ------
-If '-t' is specified, one of the <type>.
+If '-t' is specified, one of the <type>.  If '-s' is specified,
+the size of the <object> in bytes.
 
 Otherwise the raw (though uncompressed) contents of the <object> will
 be returned.