Merge branch 'rs/archive'
[git/builtin-gsoc.git] / Documentation / git-cat-file.txt
blobafa095c79529dc92d5db6c54effd435c57f5eb7a
1 git-cat-file(1)
2 ===============
4 NAME
5 ----
6 git-cat-file - Provide content or type/size information for repository objects
9 SYNOPSIS
10 --------
11 'git-cat-file' [-t | -s | -e | -p | <type>] <object>
13 DESCRIPTION
14 -----------
15 Provides content or type of objects in the repository. The type
16 is required unless '-t' or '-p' is used to find the object type,
17 or '-s' is used to find the object size.
19 OPTIONS
20 -------
21 <object>::
22         The name of the object to show.
23         For a more complete list of ways to spell object names, see
24         "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
26 -t::
27         Instead of the content, show the object type identified by
28         <object>.
30 -s::
31         Instead of the content, show the object size identified by
32         <object>.
34 -e::
35         Suppress all output; instead exit with zero status if <object>
36         exists and is a valid object.
38 -p::
39         Pretty-print the contents of <object> based on its type.
41 <type>::
42         Typically this matches the real type of <object> but asking
43         for a type that can trivially be dereferenced from the given
44         <object> is also permitted.  An example is to ask for a
45         "tree" with <object> being a commit object that contains it,
46         or to ask for a "blob" with <object> being a tag object that
47         points at it.
49 OUTPUT
50 ------
51 If '-t' is specified, one of the <type>.
53 If '-s' is specified, the size of the <object> in bytes.
55 If '-e' is specified, no output.
57 If '-p' is specified, the contents of <object> are pretty-printed.
59 Otherwise the raw (though uncompressed) contents of the <object> will
60 be returned.
63 Author
64 ------
65 Written by Linus Torvalds <torvalds@osdl.org>
67 Documentation
68 --------------
69 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
71 GIT
72 ---
73 Part of the gitlink:git[7] suite