Merge git://git.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-cat-file.txt
1 git-cat-file(1)
2 ===============
3
4 NAME
5 ----
6 git-cat-file - Provide content or type information for repository objects
7
8
9 SYNOPSIS
10 --------
11 'git-cat-file' [-t | -s | -e | <type>] <object>
12
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.
18
19 OPTIONS
20 -------
21 <object>::
22 The sha1 identifier of the object.
23
24 -t::
25 Instead of the content, show the object type identified by
26 <object>.
27
28 -s::
29 Instead of the content, show the object size identified by
30 <object>.
31
32 -e::
33 Suppress all output; instead exit with zero status if <object>
34 exists and is a valid object.
35
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.
43
44 OUTPUT
45 ------
46 If '-t' is specified, one of the <type>.
47
48 If '-s' is specified, the size of the <object> in bytes.
49
50 If '-e' is specified, no output.
51
52 Otherwise the raw (though uncompressed) contents of the <object> will
53 be returned.
54
55
56 Author
57 ------
58 Written by Linus Torvalds <torvalds@osdl.org>
59
60 Documentation
61 --------------
62 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
63
64 GIT
65 ---
66 Part of the gitlink:git[7] suite
67