Autogenerated man pages for v1.3.3-ged90
[git.git] / man1 / git-cat-file.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-CAT-FILE" 1 "" "" ""
21 .SH NAME
22 git-cat-file \- Provide content or type information for repository objects
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-cat\-file\fR [\-t | \-s | \-e | \-p | <type>] <object>
27
28 .SH "DESCRIPTION"
29
30
31 Provides content or type of objects in the repository\&. The type is required unless \fI\-t\fR or \fI\-p\fR is used to find the object type, or \fI\-s\fR is used to find the object size\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 <object>
37 The sha1 identifier of the object\&.
38
39 .TP
40 \-t
41 Instead of the content, show the object type identified by <object>\&.
42
43 .TP
44 \-s
45 Instead of the content, show the object size identified by <object>\&.
46
47 .TP
48 \-e
49 Suppress all output; instead exit with zero status if <object> exists and is a valid object\&.
50
51 .TP
52 \-p
53 Pretty\-print the contents of <object> based on its type\&.
54
55 .TP
56 <type>
57 Typically this matches the real type of <object> but asking for a type that can trivially be dereferenced from the given <object> is also permitted\&. An example is to ask for a "tree" with <object> being a commit object that contains it, or to ask for a "blob" with <object> being a tag object that points at it\&.
58
59 .SH "OUTPUT"
60
61
62 If \fI\-t\fR is specified, one of the <type>\&.
63
64
65 If \fI\-s\fR is specified, the size of the <object> in bytes\&.
66
67
68 If \fI\-e\fR is specified, no output\&.
69
70
71 If \fI\-p\fR is specified, the contents of <object> are pretty\-printed\&.
72
73
74 Otherwise the raw (though uncompressed) contents of the <object> will be returned\&.
75
76 .SH "AUTHOR"
77
78
79 Written by Linus Torvalds <torvalds@osdl\&.org>
80
81 .SH "DOCUMENTATION"
82
83
84 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
85
86 .SH "GIT"
87
88
89 Part of the \fBgit\fR(7) suite
90