Google Git
Sign in
chromium / external / gitster / git-htmldocs / 78e3a7820b2267111cd2f29fd3d06e8919f2b36c / . / git-cat-file.html
blob: 96f287b5f991f1bcabd1cc7da7b868a911346d24 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]47h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]83 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]166 text-align: right;
167}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306</style>
307<title>git-cat-file(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-cat-file(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-cat-file -
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]317 Provide content or type and size information for repository objects
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanodc8f25b2008-06-11 07:52:28[diff] [blame]323<div class="verseblock">
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]324<div class="content"><em>git cat-file</em> (-t | -s | -e | -p | &lt;type&gt; | --textconv ) &lt;object&gt;
Junio C Hamano9f10ed32009-05-26 08:38:52[diff] [blame]325<em>git cat-file</em> (--batch | --batch-check) &lt; &lt;list-of-objects&gt;</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]326</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]327<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]328<div class="sectionbody">
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]329<div class="para"><p>In its first form, the command provides the content or the type of an object in
330the repository. The type is required unless <em>-t</em> or <em>-p</em> is used to find the
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]331object type, or <em>-s</em> is used to find the object size, or <em>--textconv</em> is used
332(which implies type "blob").</p></div>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]333<div class="para"><p>In the second form, a list of objects (separated by linefeeds) is provided on
334stdin, and the SHA1, type, and size of each object is printed on stdout.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]335</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]336<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]337<div class="sectionbody">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]338<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]339<dt>
340&lt;object&gt;
341</dt>
342<dd>
343<p>
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame]344 The name of the object to show.
345 For a more complete list of ways to spell object names, see
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame^]346 the "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(1)</a>.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]347</p>
348</dd>
349<dt>
350-t
351</dt>
352<dd>
353<p>
354 Instead of the content, show the object type identified by
355 &lt;object&gt;.
356</p>
357</dd>
358<dt>
359-s
360</dt>
361<dd>
362<p>
363 Instead of the content, show the object size identified by
364 &lt;object&gt;.
365</p>
366</dd>
367<dt>
368-e
369</dt>
370<dd>
371<p>
372 Suppress all output; instead exit with zero status if &lt;object&gt;
373 exists and is a valid object.
374</p>
375</dd>
376<dt>
Junio C Hamano8eb323c2006-05-25 05:55:22[diff] [blame]377-p
378</dt>
379<dd>
380<p>
381 Pretty-print the contents of &lt;object&gt; based on its type.
382</p>
383</dd>
384<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]385&lt;type&gt;
386</dt>
387<dd>
388<p>
389 Typically this matches the real type of &lt;object&gt; but asking
390 for a type that can trivially be dereferenced from the given
391 &lt;object&gt; is also permitted. An example is to ask for a
392 "tree" with &lt;object&gt; being a commit object that contains it,
393 or to ask for a "blob" with &lt;object&gt; being a tag object that
394 points at it.
395</p>
396</dd>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]397<dt>
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]398--textconv
399</dt>
400<dd>
401<p>
402 Show the content as transformed by a textconv filter. In this case,
403 &lt;object&gt; has be of the form &lt;treeish&gt;:&lt;path&gt;, or :&lt;path&gt; in order
404 to apply the filter to the content recorded in the index at &lt;path&gt;.
405</p>
406</dd>
407<dt>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]408--batch
409</dt>
410<dd>
411<p>
412 Print the SHA1, type, size, and contents of each object provided on
413 stdin. May not be combined with any other options or arguments.
414</p>
415</dd>
416<dt>
417--batch-check
418</dt>
419<dd>
420<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]421 Print the SHA1, type, and size of each object provided on stdin. May not
422 be combined with any other options or arguments.
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]423</p>
424</dd>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]425</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]427<h2 id="_output">OUTPUT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]428<div class="sectionbody">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]429<div class="para"><p>If <em>-t</em> is specified, one of the &lt;type&gt;.</p></div>
430<div class="para"><p>If <em>-s</em> is specified, the size of the &lt;object&gt; in bytes.</p></div>
431<div class="para"><p>If <em>-e</em> is specified, no output.</p></div>
432<div class="para"><p>If <em>-p</em> is specified, the contents of &lt;object&gt; are pretty-printed.</p></div>
433<div class="para"><p>If &lt;type&gt; is specified, the raw (though uncompressed) contents of the &lt;object&gt;
434will be returned.</p></div>
435<div class="para"><p>If <em>--batch</em> is specified, output of the following form is printed for each
436object specified on stdin:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]437<div class="listingblock">
438<div class="content">
439<pre><tt>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF
440&lt;contents&gt; LF</tt></pre>
441</div></div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]442<div class="para"><p>If <em>--batch-check</em> is specified, output of the following form is printed for
443each object specified on stdin:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]444<div class="listingblock">
445<div class="content">
446<pre><tt>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF</tt></pre>
447</div></div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]448<div class="para"><p>For both <em>--batch</em> and <em>--batch-check</em>, output of the following form is printed
449for each object specified on stdin that does not exist in the repository:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]450<div class="listingblock">
451<div class="content">
452<pre><tt>&lt;object&gt; SP missing LF</tt></pre>
453</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]454</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]455<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]456<div class="sectionbody">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]457<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]458</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]459<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]460<div class="sectionbody">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]461<div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]462</div>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]463<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]464<div class="sectionbody">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]465<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]466</div>
467<div id="footer">
468<div id="footer-text">
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame^]469Last updated 2010-07-15 22:23:59 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]470</div>
471</div>
472</body>
473</html>