git-cat-file.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   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>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-cat-file(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.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 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.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
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var 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.
 562 toc: 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;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 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");
 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];
 612     if (entry.nodeName.toLowerCase() == 'div'
 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.
 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
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 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");
 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++;
 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       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 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   }
 706 },
 707
 708 install: 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;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-cat-file(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-cat-file -
 743    Provide contents or details of repository objects
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git cat-file</em> &lt;type&gt; &lt;object&gt;
 753 <em>git cat-file</em> (-e | -p) &lt;object&gt;
 754 <em>git cat-file</em> (-t | -s) [--allow-unknown-type] &lt;object&gt;
 755 <em>git cat-file</em> (--textconv | --filters)
 756              [&lt;rev&gt;:&lt;path|tree-ish&gt; | --path=&lt;path|tree-ish&gt; &lt;rev&gt;]
 757 <em>git cat-file</em> (--batch | --batch-check | --batch-command) [--batch-all-objects]
 758              [--buffer] [--follow-symlinks] [--unordered]
 759              [--textconv | --filters] [-Z]</pre>
 760 <div class="attribution">
 761 </div></div>
 762 </div>
 763 </div>
 764 <div class="sect1">
 765 <h2 id="_description">DESCRIPTION</h2>
 766 <div class="sectionbody">
 767 <div class="paragraph"><p>Output the contents or other properties such as size, type or delta
 768 information of one or more objects.</p></div>
 769 <div class="paragraph"><p>This command can operate in two modes, depending on whether an option
 770 from the <code>--batch</code> family is specified.</p></div>
 771 <div class="paragraph"><p>In non-batch mode, the command provides information on an object
 772 named on the command line.</p></div>
 773 <div class="paragraph"><p>In batch mode, arguments are read from standard input.</p></div>
 774 </div>
 775 </div>
 776 <div class="sect1">
 777 <h2 id="_options">OPTIONS</h2>
 778 <div class="sectionbody">
 779 <div class="dlist"><dl>
 780 <dt class="hdlist1">
 781 &lt;object&gt;
 782 </dt>
 783 <dd>
 784 <p>
 785         The name of the object to show.
 786         For a more complete list of ways to spell object names, see
 787         the "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(7)</a>.
 788 </p>
 789 </dd>
 790 <dt class="hdlist1">
 791 -t
 792 </dt>
 793 <dd>
 794 <p>
 795         Instead of the content, show the object type identified by
 796         <code>&lt;object&gt;</code>.
 797 </p>
 798 </dd>
 799 <dt class="hdlist1">
 800 -s
 801 </dt>
 802 <dd>
 803 <p>
 804         Instead of the content, show the object size identified by
 805         <code>&lt;object&gt;</code>. If used with <code>--use-mailmap</code> option, will show
 806         the size of updated object after replacing idents using the
 807         mailmap mechanism.
 808 </p>
 809 </dd>
 810 <dt class="hdlist1">
 811 -e
 812 </dt>
 813 <dd>
 814 <p>
 815         Exit with zero status if <code>&lt;object&gt;</code> exists and is a valid
 816         object. If <code>&lt;object&gt;</code> is of an invalid format, exit with non-zero
 817         status and emit an error on stderr.
 818 </p>
 819 </dd>
 820 <dt class="hdlist1">
 821 -p
 822 </dt>
 823 <dd>
 824 <p>
 825         Pretty-print the contents of <code>&lt;object&gt;</code> based on its type.
 826 </p>
 827 </dd>
 828 <dt class="hdlist1">
 829 &lt;type&gt;
 830 </dt>
 831 <dd>
 832 <p>
 833         Typically this matches the real type of <code>&lt;object&gt;</code> but asking
 834         for a type that can trivially be dereferenced from the given
 835         <code>&lt;object&gt;</code> is also permitted.  An example is to ask for a
 836         "tree" with <code>&lt;object&gt;</code> being a commit object that contains it,
 837         or to ask for a "blob" with <code>&lt;object&gt;</code> being a tag object that
 838         points at it.
 839 </p>
 840 </dd>
 841 <dt class="hdlist1">
 842 --[no-]mailmap
 843 </dt>
 844 <dt class="hdlist1">
 845 --[no-]use-mailmap
 846 </dt>
 847 <dd>
 848 <p>
 849        Use mailmap file to map author, committer and tagger names
 850        and email addresses to canonical real names and email addresses.
 851        See <a href="git-shortlog.html">git-shortlog(1)</a>.
 852 </p>
 853 </dd>
 854 <dt class="hdlist1">
 855 --textconv
 856 </dt>
 857 <dd>
 858 <p>
 859         Show the content as transformed by a textconv filter. In this case,
 860         <code>&lt;object&gt;</code> has to be of the form <code>&lt;tree-ish&gt;:&lt;path&gt;</code>, or <code>:&lt;path&gt;</code> in
 861         order to apply the filter to the content recorded in the index at
 862         <code>&lt;path&gt;</code>.
 863 </p>
 864 </dd>
 865 <dt class="hdlist1">
 866 --filters
 867 </dt>
 868 <dd>
 869 <p>
 870         Show the content as converted by the filters configured in
 871         the current working tree for the given <code>&lt;path&gt;</code> (i.e. smudge filters,
 872         end-of-line conversion, etc). In this case, <code>&lt;object&gt;</code> has to be of
 873         the form <code>&lt;tree-ish&gt;:&lt;path&gt;</code>, or <code>:&lt;path&gt;</code>.
 874 </p>
 875 </dd>
 876 <dt class="hdlist1">
 877 --path=&lt;path&gt;
 878 </dt>
 879 <dd>
 880 <p>
 881         For use with <code>--textconv</code> or <code>--filters</code>, to allow specifying an object
 882         name and a path separately, e.g. when it is difficult to figure out
 883         the revision from which the blob came.
 884 </p>
 885 </dd>
 886 <dt class="hdlist1">
 887 --batch
 888 </dt>
 889 <dt class="hdlist1">
 890 --batch=&lt;format&gt;
 891 </dt>
 892 <dd>
 893 <p>
 894         Print object information and contents for each object provided
 895         on stdin. May not be combined with any other options or arguments
 896         except <code>--textconv</code>, <code>--filters</code>, or <code>--use-mailmap</code>.
 897 </p>
 898 <div class="openblock">
 899 <div class="content">
 900 <div class="ulist"><ul>
 901 <li>
 902 <p>
 903 When used with <code>--textconv</code> or <code>--filters</code>, the input lines
 904           must specify the path, separated by whitespace. See the section
 905           <code>BATCH OUTPUT</code> below for details.
 906 </p>
 907 </li>
 908 <li>
 909 <p>
 910 When used with <code>--use-mailmap</code>, for commit and tag objects, the
 911           contents part of the output shows the identities replaced using the
 912           mailmap mechanism, while the information part of the output shows
 913           the size of the object as if it actually recorded the replacement
 914           identities.
 915 </p>
 916 </li>
 917 </ul></div>
 918 </div></div>
 919 </dd>
 920 <dt class="hdlist1">
 921 --batch-check
 922 </dt>
 923 <dt class="hdlist1">
 924 --batch-check=&lt;format&gt;
 925 </dt>
 926 <dd>
 927 <p>
 928         Print object information for each object provided on stdin. May not be
 929         combined with any other options or arguments except <code>--textconv</code>, <code>--filters</code>
 930         or <code>--use-mailmap</code>.
 931 </p>
 932 <div class="openblock">
 933 <div class="content">
 934 <div class="ulist"><ul>
 935 <li>
 936 <p>
 937 When used with <code>--textconv</code> or <code>--filters</code>, the input lines must
 938          specify the path, separated by whitespace. See the section
 939          <code>BATCH OUTPUT</code> below for details.
 940 </p>
 941 </li>
 942 <li>
 943 <p>
 944 When used with <code>--use-mailmap</code>, for commit and tag objects, the
 945           printed object information shows the size of the object as if the
 946           identities recorded in it were replaced by the mailmap mechanism.
 947 </p>
 948 </li>
 949 </ul></div>
 950 </div></div>
 951 </dd>
 952 <dt class="hdlist1">
 953 --batch-command
 954 </dt>
 955 <dt class="hdlist1">
 956 --batch-command=&lt;format&gt;
 957 </dt>
 958 <dd>
 959 <p>
 960         Enter a command mode that reads commands and arguments from stdin. May
 961         only be combined with <code>--buffer</code>, <code>--textconv</code>, <code>--use-mailmap</code> or
 962         <code>--filters</code>.
 963 </p>
 964 <div class="openblock">
 965 <div class="content">
 966 <div class="ulist"><ul>
 967 <li>
 968 <p>
 969 When used with <code>--textconv</code> or <code>--filters</code>, the input lines must
 970           specify the path, separated by whitespace. See the section
 971           <code>BATCH OUTPUT</code> below for details.
 972 </p>
 973 </li>
 974 <li>
 975 <p>
 976 When used with <code>--use-mailmap</code>, for commit and tag objects, the
 977           <code>contents</code> command shows the identities replaced using the
 978           mailmap mechanism, while the <code>info</code> command shows the size
 979           of the object as if it actually recorded the replacement
 980           identities.
 981 </p>
 982 </li>
 983 </ul></div>
 984 </div></div>
 985 <div class="paragraph"><p><code>--batch-command</code> recognizes the following commands:</p></div>
 986 <div class="openblock">
 987 <div class="content">
 988 <div class="dlist"><dl>
 989 <dt class="hdlist1">
 990 contents &lt;object&gt;
 991 </dt>
 992 <dd>
 993 <p>
 994         Print object contents for object reference <code>&lt;object&gt;</code>. This corresponds to
 995         the output of <code>--batch</code>.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 info &lt;object&gt;
1000 </dt>
1001 <dd>
1002 <p>
1003         Print object info for object reference <code>&lt;object&gt;</code>. This corresponds to the
1004         output of <code>--batch-check</code>.
1005 </p>
1006 </dd>
1007 <dt class="hdlist1">
1008 flush
1009 </dt>
1010 <dd>
1011 <p>
1012         Used with <code>--buffer</code> to execute all preceding commands that were issued
1013         since the beginning or since the last flush was issued. When <code>--buffer</code>
1014         is used, no output will come until a <code>flush</code> is issued. When <code>--buffer</code>
1015         is not used, commands are flushed each time without issuing <code>flush</code>.
1016 </p>
1017 </dd>
1018 </dl></div>
1019 </div></div>
1020 </dd>
1021 <dt class="hdlist1">
1022 --batch-all-objects
1023 </dt>
1024 <dd>
1025 <p>
1026         Instead of reading a list of objects on stdin, perform the
1027         requested batch operation on all objects in the repository and
1028         any alternate object stores (not just reachable objects).
1029         Requires <code>--batch</code> or <code>--batch-check</code> be specified. By default,
1030         the objects are visited in order sorted by their hashes; see
1031         also <code>--unordered</code> below. Objects are presented as-is, without
1032         respecting the "replace" mechanism of <a href="git-replace.html">git-replace(1)</a>.
1033 </p>
1034 </dd>
1035 <dt class="hdlist1">
1036 --buffer
1037 </dt>
1038 <dd>
1039 <p>
1040         Normally batch output is flushed after each object is output, so
1041         that a process can interactively read and write from
1042         <code>cat-file</code>. With this option, the output uses normal stdio
1043         buffering; this is much more efficient when invoking
1044         <code>--batch-check</code> or <code>--batch-command</code> on a large number of objects.
1045 </p>
1046 </dd>
1047 <dt class="hdlist1">
1048 --unordered
1049 </dt>
1050 <dd>
1051 <p>
1052         When <code>--batch-all-objects</code> is in use, visit objects in an
1053         order which may be more efficient for accessing the object
1054         contents than hash order. The exact details of the order are
1055         unspecified, but if you do not require a specific order, this
1056         should generally result in faster output, especially with
1057         <code>--batch</code>.  Note that <code>cat-file</code> will still show each object
1058         only once, even if it is stored multiple times in the
1059         repository.
1060 </p>
1061 </dd>
1062 <dt class="hdlist1">
1063 --allow-unknown-type
1064 </dt>
1065 <dd>
1066 <p>
1067         Allow <code>-s</code> or <code>-t</code> to query broken/corrupt objects of unknown type.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 --follow-symlinks
1072 </dt>
1073 <dd>
1074 <p>
1075         With <code>--batch</code> or <code>--batch-check</code>, follow symlinks inside the
1076         repository when requesting objects with extended SHA-1
1077         expressions of the form tree-ish:path-in-tree.  Instead of
1078         providing output about the link itself, provide output about
1079         the linked-to object.  If a symlink points outside the
1080         tree-ish (e.g. a link to <code>/foo</code> or a root-level link to <code>../foo</code>),
1081         the portion of the link which is outside the tree will be
1082         printed.
1083 </p>
1084 <div class="paragraph"><p>This option does not (currently) work correctly when an object in the
1085 index is specified (e.g. <code>:link</code> instead of <code>HEAD:link</code>) rather than
1086 one in the tree.</p></div>
1087 <div class="paragraph"><p>This option cannot (currently) be used unless <code>--batch</code> or
1088 <code>--batch-check</code> is used.</p></div>
1089 <div class="paragraph"><p>For example, consider a git repository containing:</p></div>
1090 <div class="openblock">
1091 <div class="content">
1092 <div class="literalblock">
1093 <div class="content">
1094 <pre><code>f: a file containing "hello\n"
1095 link: a symlink to f
1096 dir/link: a symlink to ../f
1097 plink: a symlink to ../f
1098 alink: a symlink to /etc/passwd</code></pre>
1099 </div></div>
1100 </div></div>
1101 <div class="paragraph"><p>For a regular file <code>f</code>, <code>echo HEAD:f | git cat-file --batch</code> would print</p></div>
1102 <div class="openblock">
1103 <div class="content">
1104 <div class="literalblock">
1105 <div class="content">
1106 <pre><code>ce013625030ba8dba906f756967f9e9ca394464a blob 6</code></pre>
1107 </div></div>
1108 </div></div>
1109 <div class="paragraph"><p>And <code>echo HEAD:link | git cat-file --batch --follow-symlinks</code> would
1110 print the same thing, as would <code>HEAD:dir/link</code>, as they both point at
1111 <code>HEAD:f</code>.</p></div>
1112 <div class="paragraph"><p>Without <code>--follow-symlinks</code>, these would print data about the symlink
1113 itself.  In the case of <code>HEAD:link</code>, you would see</p></div>
1114 <div class="openblock">
1115 <div class="content">
1116 <div class="literalblock">
1117 <div class="content">
1118 <pre><code>4d1ae35ba2c8ec712fa2a379db44ad639ca277bd blob 1</code></pre>
1119 </div></div>
1120 </div></div>
1121 <div class="paragraph"><p>Both <code>plink</code> and <code>alink</code> point outside the tree, so they would
1122 respectively print:</p></div>
1123 <div class="openblock">
1124 <div class="content">
1125 <div class="literalblock">
1126 <div class="content">
1127 <pre><code>symlink 4
1128 ../f</code></pre>
1129 </div></div>
1130 <div class="literalblock">
1131 <div class="content">
1132 <pre><code>symlink 11
1133 /etc/passwd</code></pre>
1134 </div></div>
1135 </div></div>
1136 </dd>
1137 <dt class="hdlist1">
1138 -Z
1139 </dt>
1140 <dd>
1141 <p>
1142         Only meaningful with <code>--batch</code>, <code>--batch-check</code>, or
1143         <code>--batch-command</code>; input and output is NUL-delimited instead of
1144         newline-delimited.
1145 </p>
1146 </dd>
1147 <dt class="hdlist1">
1148 -z
1149 </dt>
1150 <dd>
1151 <p>
1152         Only meaningful with <code>--batch</code>, <code>--batch-check</code>, or
1153         <code>--batch-command</code>; input is NUL-delimited instead of
1154         newline-delimited. This option is deprecated in favor of
1155         <code>-Z</code> as the output can otherwise be ambiguous.
1156 </p>
1157 </dd>
1158 </dl></div>
1159 </div>
1160 </div>
1161 <div class="sect1">
1162 <h2 id="_output">OUTPUT</h2>
1163 <div class="sectionbody">
1164 <div class="paragraph"><p>If <code>-t</code> is specified, one of the <code>&lt;type&gt;</code>.</p></div>
1165 <div class="paragraph"><p>If <code>-s</code> is specified, the size of the <code>&lt;object&gt;</code> in bytes.</p></div>
1166 <div class="paragraph"><p>If <code>-e</code> is specified, no output, unless the <code>&lt;object&gt;</code> is malformed.</p></div>
1167 <div class="paragraph"><p>If <code>-p</code> is specified, the contents of <code>&lt;object&gt;</code> are pretty-printed.</p></div>
1168 <div class="paragraph"><p>If <code>&lt;type&gt;</code> is specified, the raw (though uncompressed) contents of the <code>&lt;object&gt;</code>
1169 will be returned.</p></div>
1170 </div>
1171 </div>
1172 <div class="sect1">
1173 <h2 id="_batch_output">BATCH OUTPUT</h2>
1174 <div class="sectionbody">
1175 <div class="paragraph"><p>If <code>--batch</code> or <code>--batch-check</code> is given, <code>cat-file</code> will read objects
1176 from stdin, one per line, and print information about them. By default,
1177 the whole line is considered as an object, as if it were fed to
1178 <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p></div>
1179 <div class="paragraph"><p>When <code>--batch-command</code> is given, <code>cat-file</code> will read commands from stdin,
1180 one per line, and print information based on the command given. With
1181 <code>--batch-command</code>, the <code>info</code> command followed by an object will print
1182 information about the object the same way <code>--batch-check</code> would, and the
1183 <code>contents</code> command followed by an object prints contents in the same way
1184 <code>--batch</code> would.</p></div>
1185 <div class="paragraph"><p>You can specify the information shown for each object by using a custom
1186 <code>&lt;format&gt;</code>. The <code>&lt;format&gt;</code> is copied literally to stdout for each
1187 object, with placeholders of the form <code>%(atom)</code> expanded, followed by a
1188 newline. The available atoms are:</p></div>
1189 <div class="dlist"><dl>
1190 <dt class="hdlist1">
1191 <code>objectname</code>
1192 </dt>
1193 <dd>
1194 <p>
1195         The full hex representation of the object name.
1196 </p>
1197 </dd>
1198 <dt class="hdlist1">
1199 <code>objecttype</code>
1200 </dt>
1201 <dd>
1202 <p>
1203         The type of the object (the same as <code>cat-file -t</code> reports).
1204 </p>
1205 </dd>
1206 <dt class="hdlist1">
1207 <code>objectsize</code>
1208 </dt>
1209 <dd>
1210 <p>
1211         The size, in bytes, of the object (the same as <code>cat-file -s</code>
1212         reports).
1213 </p>
1214 </dd>
1215 <dt class="hdlist1">
1216 <code>objectsize:disk</code>
1217 </dt>
1218 <dd>
1219 <p>
1220         The size, in bytes, that the object takes up on disk. See the
1221         note about on-disk sizes in the <code>CAVEATS</code> section below.
1222 </p>
1223 </dd>
1224 <dt class="hdlist1">
1225 <code>deltabase</code>
1226 </dt>
1227 <dd>
1228 <p>
1229         If the object is stored as a delta on-disk, this expands to the
1230         full hex representation of the delta base object name.
1231         Otherwise, expands to the null OID (all zeroes). See <code>CAVEATS</code>
1232         below.
1233 </p>
1234 </dd>
1235 <dt class="hdlist1">
1236 <code>rest</code>
1237 </dt>
1238 <dd>
1239 <p>
1240         If this atom is used in the output string, input lines are split
1241         at the first whitespace boundary. All characters before that
1242         whitespace are considered to be the object name; characters
1243         after that first run of whitespace (i.e., the "rest" of the
1244         line) are output in place of the <code>%(rest)</code> atom.
1245 </p>
1246 </dd>
1247 </dl></div>
1248 <div class="paragraph"><p>If no format is specified, the default format is <code>%(objectname)
1249 %(objecttype) %(objectsize)</code>.</p></div>
1250 <div class="paragraph"><p>If <code>--batch</code> is specified, or if <code>--batch-command</code> is used with the <code>contents</code>
1251 command, the object information is followed by the object contents (consisting
1252 of <code>%(objectsize)</code> bytes), followed by a newline.</p></div>
1253 <div class="paragraph"><p>For example, <code>--batch</code> without a custom format would produce:</p></div>
1254 <div class="listingblock">
1255 <div class="content">
1256 <pre><code>&lt;oid&gt; SP &lt;type&gt; SP &lt;size&gt; LF
1257 &lt;contents&gt; LF</code></pre>
1258 </div></div>
1259 <div class="paragraph"><p>Whereas <code>--batch-check='%(objectname) %(objecttype)'</code> would produce:</p></div>
1260 <div class="listingblock">
1261 <div class="content">
1262 <pre><code>&lt;oid&gt; SP &lt;type&gt; LF</code></pre>
1263 </div></div>
1264 <div class="paragraph"><p>If a name is specified on stdin that cannot be resolved to an object in
1265 the repository, then <code>cat-file</code> will ignore any custom format and print:</p></div>
1266 <div class="listingblock">
1267 <div class="content">
1268 <pre><code>&lt;object&gt; SP missing LF</code></pre>
1269 </div></div>
1270 <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>
1271 <div class="listingblock">
1272 <div class="content">
1273 <pre><code>&lt;object&gt; SP ambiguous LF</code></pre>
1274 </div></div>
1275 <div class="paragraph"><p>If <code>--follow-symlinks</code> is used, and a symlink in the repository points
1276 outside the repository, then <code>cat-file</code> will ignore any custom format
1277 and print:</p></div>
1278 <div class="listingblock">
1279 <div class="content">
1280 <pre><code>symlink SP &lt;size&gt; LF
1281 &lt;symlink&gt; LF</code></pre>
1282 </div></div>
1283 <div class="paragraph"><p>The symlink will either be absolute (beginning with a <code>/</code>), or relative
1284 to the tree root.  For instance, if dir/link points to <code>../../foo</code>, then
1285 <code>&lt;symlink&gt;</code> will be <code>../foo</code>.  <code>&lt;size&gt;</code> is the size of the symlink in bytes.</p></div>
1286 <div class="paragraph"><p>If <code>--follow-symlinks</code> is used, the following error messages will be
1287 displayed:</p></div>
1288 <div class="listingblock">
1289 <div class="content">
1290 <pre><code>&lt;object&gt; SP missing LF</code></pre>
1291 </div></div>
1292 <div class="paragraph"><p>is printed when the initial symlink requested does not exist.</p></div>
1293 <div class="listingblock">
1294 <div class="content">
1295 <pre><code>dangling SP &lt;size&gt; LF
1296 &lt;object&gt; LF</code></pre>
1297 </div></div>
1298 <div class="paragraph"><p>is printed when the initial symlink exists, but something that
1299 it (transitive-of) points to does not.</p></div>
1300 <div class="listingblock">
1301 <div class="content">
1302 <pre><code>loop SP &lt;size&gt; LF
1303 &lt;object&gt; LF</code></pre>
1304 </div></div>
1305 <div class="paragraph"><p>is printed for symlink loops (or any symlinks that
1306 require more than 40 link resolutions to resolve).</p></div>
1307 <div class="listingblock">
1308 <div class="content">
1309 <pre><code>notdir SP &lt;size&gt; LF
1310 &lt;object&gt; LF</code></pre>
1311 </div></div>
1312 <div class="paragraph"><p>is printed when, during symlink resolution, a file is used as a
1313 directory name.</p></div>
1314 <div class="paragraph"><p>Alternatively, when <code>-Z</code> is passed, the line feeds in any of the above examples
1315 are replaced with NUL terminators. This ensures that output will be parsable if
1316 the output itself would contain a linefeed and is thus recommended for
1317 scripting purposes.</p></div>
1318 </div>
1319 </div>
1320 <div class="sect1">
1321 <h2 id="_caveats">CAVEATS</h2>
1322 <div class="sectionbody">
1323 <div class="paragraph"><p>Note that the sizes of objects on disk are reported accurately, but care
1324 should be taken in drawing conclusions about which refs or objects are
1325 responsible for disk usage. The size of a packed non-delta object may be
1326 much larger than the size of objects which delta against it, but the
1327 choice of which object is the base and which is the delta is arbitrary
1328 and is subject to change during a repack.</p></div>
1329 <div class="paragraph"><p>Note also that multiple copies of an object may be present in the object
1330 database; in this case, it is undefined which copy&#8217;s size or delta base
1331 will be reported.</p></div>
1332 </div>
1333 </div>
1334 <div class="sect1">
1335 <h2 id="_git">GIT</h2>
1336 <div class="sectionbody">
1337 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1338 </div>
1339 </div>
1340 </div>
1341 <div id="footnotes"><hr /></div>
1342 <div id="footer">
1343 <div id="footer-text">
1344 Last updated
1345  2023-10-18 13:44:22 PDT
1346 </div>
1347 </div>
1348 </body>
1349 </html>