Google Git
Sign in
chromium / external / gitster / git-htmldocs / 4c8e46adbd153793b428c9138ff26fe6fd8166be / . / git-cat-file.html
blob: 3695ad3313e0d3a899412e9139079eeb76fdd9e9 [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoeaa95f72020-04-14 17:39:35[diff] [blame]7<meta name="generator" content="AsciiDoc 9.0.0rc1" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]8<title>git-cat-file(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]41 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]46 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]47}
48
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]56h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]71
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]104 font-weight: bold;
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]271
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]285}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]341}
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]352 color: #527bbd;
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]736<div id="header">
737<h1>
738git-cat-file(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-cat-file -
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]743 Provide content or type and size information for repository objects
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]750<div class="sectionbody">
Junio C Hamanodc8f25b2008-06-11 07:52:28[diff] [blame]751<div class="verseblock">
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]752<pre class="content"><em>git cat-file</em> (-t [--allow-unknown-type]| -s [--allow-unknown-type]| -e | -p | &lt;type&gt; | --textconv | --filters ) [--path=&lt;path&gt;] &lt;object&gt;
Junio C Hamano096c5cf2020-07-09 21:30:37[diff] [blame]753<em>git cat-file</em> (--batch[=&lt;format&gt;] | --batch-check[=&lt;format&gt;]) [ --textconv | --filters ] [--follow-symlinks]</pre>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]754<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]755</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]756</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]757</div>
758<div class="sect1">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]759<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]760<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]761<div class="paragraph"><p>In its first form, the command provides the content or the type of an object in
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]762the repository. The type is required unless <code>-t</code> or <code>-p</code> is used to find the
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]763object type, or <code>-s</code> is used to find the object size, or <code>--textconv</code> or
764<code>--filters</code> is used (which imply type "blob").</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]765<div class="paragraph"><p>In the second form, a list of objects (separated by linefeeds) is provided on
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]766stdin, and the SHA-1, type, and size of each object is printed on stdout. The
767output format can be overridden using the optional <code>&lt;format&gt;</code> argument. If
768either <code>--textconv</code> or <code>--filters</code> was specified, the input is expected to
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]769list the object names followed by the path name, separated by a single
770whitespace, so that the appropriate drivers can be determined.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]771</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]772</div>
773<div class="sect1">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]774<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]775<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]776<div class="dlist"><dl>
777<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]778&lt;object&gt;
779</dt>
780<dd>
781<p>
Junio C Hamano8f62db92007-02-01 00:22:22[diff] [blame]782 The name of the object to show.
783 For a more complete list of ways to spell object names, see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]784 the "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(7)</a>.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]785</p>
786</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]787<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]788-t
789</dt>
790<dd>
791<p>
792 Instead of the content, show the object type identified by
793 &lt;object&gt;.
794</p>
795</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]796<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]797-s
798</dt>
799<dd>
800<p>
801 Instead of the content, show the object size identified by
802 &lt;object&gt;.
803</p>
804</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]805<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]806-e
807</dt>
808<dd>
809<p>
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]810 Exit with zero status if &lt;object&gt; exists and is a valid
811 object. If &lt;object&gt; is of an invalid format exit with non-zero and
812 emits an error on stderr.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]813</p>
814</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]815<dt class="hdlist1">
Junio C Hamano8eb323c2006-05-25 05:55:22[diff] [blame]816-p
817</dt>
818<dd>
819<p>
820 Pretty-print the contents of &lt;object&gt; based on its type.
821</p>
822</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]823<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]824&lt;type&gt;
825</dt>
826<dd>
827<p>
828 Typically this matches the real type of &lt;object&gt; but asking
829 for a type that can trivially be dereferenced from the given
830 &lt;object&gt; is also permitted. An example is to ask for a
831 "tree" with &lt;object&gt; being a commit object that contains it,
832 or to ask for a "blob" with &lt;object&gt; being a tag object that
833 points at it.
834</p>
835</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]836<dt class="hdlist1">
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]837--textconv
838</dt>
839<dd>
840<p>
841 Show the content as transformed by a textconv filter. In this case,
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]842 &lt;object&gt; has to be of the form &lt;tree-ish&gt;:&lt;path&gt;, or :&lt;path&gt; in
843 order to apply the filter to the content recorded in the index at
844 &lt;path&gt;.
845</p>
846</dd>
847<dt class="hdlist1">
848--filters
849</dt>
850<dd>
851<p>
852 Show the content as converted by the filters configured in
853 the current working tree for the given &lt;path&gt; (i.e. smudge filters,
854 end-of-line conversion, etc). In this case, &lt;object&gt; has to be of
855 the form &lt;tree-ish&gt;:&lt;path&gt;, or :&lt;path&gt;.
856</p>
857</dd>
858<dt class="hdlist1">
859--path=&lt;path&gt;
860</dt>
861<dd>
862<p>
863 For use with --textconv or --filters, to allow specifying an object
864 name and a path separately, e.g. when it is difficult to figure out
865 the revision from which the blob came.
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]866</p>
867</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]868<dt class="hdlist1">
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]869--batch
870</dt>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]871<dt class="hdlist1">
872--batch=&lt;format&gt;
873</dt>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]874<dd>
875<p>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]876 Print object information and contents for each object provided
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]877 on stdin. May not be combined with any other options or arguments
878 except <code>--textconv</code> or <code>--filters</code>, in which case the input lines
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]879 also need to specify the path, separated by whitespace. See the
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]880 section <code>BATCH OUTPUT</code> below for details.
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]881</p>
882</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]883<dt class="hdlist1">
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]884--batch-check
885</dt>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]886<dt class="hdlist1">
887--batch-check=&lt;format&gt;
888</dt>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]889<dd>
890<p>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]891 Print object information for each object provided on stdin. May
Junio C Hamano53800482016-09-21 23:26:43[diff] [blame]892 not be combined with any other options or arguments except
893 <code>--textconv</code> or <code>--filters</code>, in which case the input lines also
Junio C Hamanoa90214f2019-01-28 22:05:25[diff] [blame]894 need to specify the path, separated by whitespace. See the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]895 section <code>BATCH OUTPUT</code> below for details.
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]896</p>
897</dd>
Junio C Hamanoe1b28592015-05-19 21:26:17[diff] [blame]898<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]899--batch-all-objects
900</dt>
901<dd>
902<p>
903 Instead of reading a list of objects on stdin, perform the
904 requested batch operation on all objects in the repository and
905 any alternate object stores (not just reachable objects).
906 Requires <code>--batch</code> or <code>--batch-check</code> be specified. Note that
907 the objects are visited in order sorted by their hashes.
908</p>
909</dd>
910<dt class="hdlist1">
911--buffer
912</dt>
913<dd>
914<p>
915 Normally batch output is flushed after each object is output, so
916 that a process can interactively read and write from
917 <code>cat-file</code>. With this option, the output uses normal stdio
918 buffering; this is much more efficient when invoking
919 <code>--batch-check</code> on a large number of objects.
920</p>
921</dd>
922<dt class="hdlist1">
Junio C Hamano11ae3202018-08-20 20:15:42[diff] [blame]923--unordered
924</dt>
925<dd>
926<p>
927 When <code>--batch-all-objects</code> is in use, visit objects in an
928 order which may be more efficient for accessing the object
929 contents than hash order. The exact details of the order are
930 unspecified, but if you do not require a specific order, this
931 should generally result in faster output, especially with
932 <code>--batch</code>. Note that <code>cat-file</code> will still show each object
933 only once, even if it is stored multiple times in the
934 repository.
935</p>
936</dd>
937<dt class="hdlist1">
Junio C Hamanoe1b28592015-05-19 21:26:17[diff] [blame]938--allow-unknown-type
939</dt>
940<dd>
941<p>
942 Allow -s or -t to query broken/corrupt objects of unknown type.
943</p>
944</dd>
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]945<dt class="hdlist1">
946--follow-symlinks
947</dt>
948<dd>
949<p>
950 With --batch or --batch-check, follow symlinks inside the
951 repository when requesting objects with extended SHA-1
952 expressions of the form tree-ish:path-in-tree. Instead of
953 providing output about the link itself, provide output about
954 the linked-to object. If a symlink points outside the
955 tree-ish (e.g. a link to /foo or a root-level link to ../foo),
956 the portion of the link which is outside the tree will be
957 printed.
958</p>
959<div class="paragraph"><p>This option does not (currently) work correctly when an object in the
960index is specified (e.g. <code>:link</code> instead of <code>HEAD:link</code>) rather than
961one in the tree.</p></div>
962<div class="paragraph"><p>This option cannot (currently) be used unless <code>--batch</code> or
963<code>--batch-check</code> is used.</p></div>
964<div class="paragraph"><p>For example, consider a git repository containing:</p></div>
965<div class="openblock">
966<div class="content">
967<div class="literalblock">
968<div class="content">
969<pre><code>f: a file containing "hello\n"
970link: a symlink to f
971dir/link: a symlink to ../f
972plink: a symlink to ../f
973alink: a symlink to /etc/passwd</code></pre>
974</div></div>
975</div></div>
976<div class="paragraph"><p>For a regular file <code>f</code>, <code>echo HEAD:f | git cat-file --batch</code> would print</p></div>
977<div class="openblock">
978<div class="content">
979<div class="literalblock">
980<div class="content">
981<pre><code>ce013625030ba8dba906f756967f9e9ca394464a blob 6</code></pre>
982</div></div>
983</div></div>
984<div class="paragraph"><p>And <code>echo HEAD:link | git cat-file --batch --follow-symlinks</code> would
985print the same thing, as would <code>HEAD:dir/link</code>, as they both point at
986<code>HEAD:f</code>.</p></div>
987<div class="paragraph"><p>Without <code>--follow-symlinks</code>, these would print data about the symlink
988itself. In the case of <code>HEAD:link</code>, you would see</p></div>
989<div class="openblock">
990<div class="content">
991<div class="literalblock">
992<div class="content">
993<pre><code>4d1ae35ba2c8ec712fa2a379db44ad639ca277bd blob 1</code></pre>
994</div></div>
995</div></div>
996<div class="paragraph"><p>Both <code>plink</code> and <code>alink</code> point outside the tree, so they would
997respectively print:</p></div>
998<div class="openblock">
999<div class="content">
1000<div class="literalblock">
1001<div class="content">
1002<pre><code>symlink 4
1003../f</code></pre>
1004</div></div>
1005<div class="literalblock">
1006<div class="content">
1007<pre><code>symlink 11
1008/etc/passwd</code></pre>
1009</div></div>
1010</div></div>
1011</dd>
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]1012</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1013</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1014</div>
1015<div class="sect1">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]1016<h2 id="_output">OUTPUT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1017<div class="sectionbody">
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1018<div class="paragraph"><p>If <code>-t</code> is specified, one of the &lt;type&gt;.</p></div>
1019<div class="paragraph"><p>If <code>-s</code> is specified, the size of the &lt;object&gt; in bytes.</p></div>
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1020<div class="paragraph"><p>If <code>-e</code> is specified, no output, unless the &lt;object&gt; is malformed.</p></div>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1021<div class="paragraph"><p>If <code>-p</code> is specified, the contents of &lt;object&gt; are pretty-printed.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1022<div class="paragraph"><p>If &lt;type&gt; is specified, the raw (though uncompressed) contents of the &lt;object&gt;
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]1023will be returned.</p></div>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1024</div>
1025</div>
1026<div class="sect1">
1027<h2 id="_batch_output">BATCH OUTPUT</h2>
1028<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1029<div class="paragraph"><p>If <code>--batch</code> or <code>--batch-check</code> is given, <code>cat-file</code> will read objects
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1030from stdin, one per line, and print information about them. By default,
1031the whole line is considered as an object, as if it were fed to
1032<a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1033<div class="paragraph"><p>You can specify the information shown for each object by using a custom
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1034<code>&lt;format&gt;</code>. The <code>&lt;format&gt;</code> is copied literally to stdout for each
1035object, with placeholders of the form <code>%(atom)</code> expanded, followed by a
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1036newline. The available atoms are:</p></div>
1037<div class="dlist"><dl>
1038<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1039<code>objectname</code>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1040</dt>
1041<dd>
1042<p>
1043 The 40-hex object name of the object.
1044</p>
1045</dd>
1046<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1047<code>objecttype</code>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1048</dt>
1049<dd>
1050<p>
Junio C Hamanod4bbec02017-09-25 07:24:53[diff] [blame]1051 The type of the object (the same as <code>cat-file -t</code> reports).
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1052</p>
1053</dd>
1054<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1055<code>objectsize</code>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1056</dt>
1057<dd>
1058<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1059 The size, in bytes, of the object (the same as <code>cat-file -s</code>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1060 reports).
1061</p>
1062</dd>
1063<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1064<code>objectsize:disk</code>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1065</dt>
1066<dd>
1067<p>
1068 The size, in bytes, that the object takes up on disk. See the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1069 note about on-disk sizes in the <code>CAVEATS</code> section below.
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1070</p>
1071</dd>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1072<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1073<code>deltabase</code>
Junio C Hamano21bc18b2014-01-10 20:33:07[diff] [blame]1074</dt>
1075<dd>
1076<p>
1077 If the object is stored as a delta on-disk, this expands to the
1078 40-hex sha1 of the delta base object. Otherwise, expands to the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1079 null sha1 (40 zeroes). See <code>CAVEATS</code> below.
Junio C Hamano21bc18b2014-01-10 20:33:07[diff] [blame]1080</p>
1081</dd>
1082<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1083<code>rest</code>
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1084</dt>
1085<dd>
1086<p>
1087 If this atom is used in the output string, input lines are split
1088 at the first whitespace boundary. All characters before that
1089 whitespace are considered to be the object name; characters
1090 after that first run of whitespace (i.e., the "rest" of the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1091 line) are output in place of the <code>%(rest)</code> atom.
Junio C Hamano8eac2682013-09-09 22:35:20[diff] [blame]1092</p>
1093</dd>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1094</dl></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1095<div class="paragraph"><p>If no format is specified, the default format is <code>%(objectname)
1096%(objecttype) %(objectsize)</code>.</p></div>
1097<div class="paragraph"><p>If <code>--batch</code> is specified, the object information is followed by the
1098object contents (consisting of <code>%(objectsize)</code> bytes), followed by a
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1099newline.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1100<div class="paragraph"><p>For example, <code>--batch</code> without a custom format would produce:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1101<div class="listingblock">
1102<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1103<pre><code>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF
1104&lt;contents&gt; LF</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1105</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1106<div class="paragraph"><p>Whereas <code>--batch-check='%(objectname) %(objecttype)'</code> would produce:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1107<div class="listingblock">
1108<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1109<pre><code>&lt;sha1&gt; SP &lt;type&gt; LF</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1110</div></div>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1111<div class="paragraph"><p>If a name is specified on stdin that cannot be resolved to an object in
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1112the repository, then <code>cat-file</code> will ignore any custom format and print:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1113<div class="listingblock">
1114<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1115<pre><code>&lt;object&gt; SP missing LF</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1116</div></div>
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]1117<div class="paragraph"><p>If a name is specified that might refer to more than one object (an ambiguous short sha), then <code>cat-file</code> will ignore any custom format and print:</p></div>
1118<div class="listingblock">
1119<div class="content">
1120<pre><code>&lt;object&gt; SP ambiguous LF</code></pre>
1121</div></div>
Junio C Hamano85f1fde2015-06-01 20:37:32[diff] [blame]1122<div class="paragraph"><p>If --follow-symlinks is used, and a symlink in the repository points
1123outside the repository, then <code>cat-file</code> will ignore any custom format
1124and print:</p></div>
1125<div class="listingblock">
1126<div class="content">
1127<pre><code>symlink SP &lt;size&gt; LF
1128&lt;symlink&gt; LF</code></pre>
1129</div></div>
1130<div class="paragraph"><p>The symlink will either be absolute (beginning with a /), or relative
1131to the tree root. For instance, if dir/link points to ../../foo, then
1132&lt;symlink&gt; will be ../foo. &lt;size&gt; is the size of the symlink in bytes.</p></div>
1133<div class="paragraph"><p>If --follow-symlinks is used, the following error messages will be
1134displayed:</p></div>
1135<div class="listingblock">
1136<div class="content">
1137<pre><code>&lt;object&gt; SP missing LF</code></pre>
1138</div></div>
1139<div class="paragraph"><p>is printed when the initial symlink requested does not exist.</p></div>
1140<div class="listingblock">
1141<div class="content">
1142<pre><code>dangling SP &lt;size&gt; LF
1143&lt;object&gt; LF</code></pre>
1144</div></div>
1145<div class="paragraph"><p>is printed when the initial symlink exists, but something that
1146it (transitive-of) points to does not.</p></div>
1147<div class="listingblock">
1148<div class="content">
1149<pre><code>loop SP &lt;size&gt; LF
1150&lt;object&gt; LF</code></pre>
1151</div></div>
1152<div class="paragraph"><p>is printed for symlink loops (or any symlinks that
1153require more than 40 link resolutions to resolve).</p></div>
1154<div class="listingblock">
1155<div class="content">
1156<pre><code>notdir SP &lt;size&gt; LF
1157&lt;object&gt; LF</code></pre>
1158</div></div>
1159<div class="paragraph"><p>is printed when, during symlink resolution, a file is used as a
1160directory name.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1161</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1162</div>
1163<div class="sect1">
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1164<h2 id="_caveats">CAVEATS</h2>
1165<div class="sectionbody">
1166<div class="paragraph"><p>Note that the sizes of objects on disk are reported accurately, but care
1167should be taken in drawing conclusions about which refs or objects are
1168responsible for disk usage. The size of a packed non-delta object may be
1169much larger than the size of objects which delta against it, but the
1170choice of which object is the base and which is the delta is arbitrary
Junio C Hamano21bc18b2014-01-10 20:33:07[diff] [blame]1171and is subject to change during a repack.</p></div>
1172<div class="paragraph"><p>Note also that multiple copies of an object may be present in the object
1173database; in this case, it is undefined which copy&#8217;s size or delta base
1174will be reported.</p></div>
Junio C Hamano0f578a72013-07-19 00:36:45[diff] [blame]1175</div>
1176</div>
1177<div class="sect1">
Junio C Hamanocb1c44f2008-08-06 06:19:33[diff] [blame]1178<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1179<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1180<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1181</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1182</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1183</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1184<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1185<div id="footer">
1186<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1187Last updated
Junio C Hamano096c5cf2020-07-09 21:30:37[diff] [blame]1188 2020-07-09 14:26:04 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1189</div>
1190</div>
1191</body>
1192</html>