git: grok 'help' to mean '--help'.
[alt-git.git] / Documentation / git-cat-file.txt
blob504eb1b16a59c5af43fa1206723dece9207ee0eb
1 git-cat-file(1)
2 ===============
4 NAME
5 ----
6 git-cat-file - Provide content or type information for repository objects
9 SYNOPSIS
10 --------
11 'git-cat-file' [-t | -s | -e | <type>] <object>
13 DESCRIPTION
14 -----------
15 Provides content or type of objects in the repository. The type
16 is required unless '-t' is used to find the object type,
17 or '-s' is used to find the object size.
19 OPTIONS
20 -------
21 <object>::
22         The sha1 identifier of the object.
24 -t::
25         Instead of the content, show the object type identified by
26         <object>.
28 -s::
29         Instead of the content, show the object size identified by
30         <object>.
32 -e::
33         Suppress all output; instead exit with zero status if <object>
34         exists and is a valid object.
36 <type>::
37         Typically this matches the real type of <object> but asking
38         for a type that can trivially be dereferenced from the given
39         <object> is also permitted.  An example is to ask for a
40         "tree" with <object> being a commit object that contains it,
41         or to ask for a "blob" with <object> being a tag object that
42         points at it.
44 OUTPUT
45 ------
46 If '-t' is specified, one of the <type>.
48 If '-s' is specified, the size of the <object> in bytes.
50 If '-e' is specified, no output.
52 Otherwise the raw (though uncompressed) contents of the <object> will
53 be returned.
56 Author
57 ------
58 Written by Linus Torvalds <torvalds@osdl.org>
60 Documentation
61 --------------
62 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
64 GIT
65 ---
66 Part of the gitlink:git[7] suite