git-for-each-ref.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-for-each-ref(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-for-each-ref(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-for-each-ref -
 743    Output information on each ref
 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 for-each-ref</em> [--count=&lt;count&gt;] [--shell|--perl|--python|--tcl]
 753                    [(--sort=&lt;key&gt;)&#8230;] [--format=&lt;format&gt;]
 754                    [ --stdin | &lt;pattern&gt;&#8230; ]
 755                    [--points-at=&lt;object&gt;]
 756                    [--merged[=&lt;object&gt;]] [--no-merged[=&lt;object&gt;]]
 757                    [--contains[=&lt;object&gt;]] [--no-contains[=&lt;object&gt;]]
 758                    [--exclude=&lt;pattern&gt; &#8230;]</pre>
 759 <div class="attribution">
 760 </div></div>
 761 </div>
 762 </div>
 763 <div class="sect1">
 764 <h2 id="_description">DESCRIPTION</h2>
 765 <div class="sectionbody">
 766 <div class="paragraph"><p>Iterate over all refs that match <code>&lt;pattern&gt;</code> and show them
 767 according to the given <code>&lt;format&gt;</code>, after sorting them according
 768 to the given set of <code>&lt;key&gt;</code>.  If <code>&lt;count&gt;</code> is given, stop after
 769 showing that many refs.  The interpolated values in <code>&lt;format&gt;</code>
 770 can optionally be quoted as string literals in the specified
 771 host language allowing their direct evaluation in that language.</p></div>
 772 </div>
 773 </div>
 774 <div class="sect1">
 775 <h2 id="_options">OPTIONS</h2>
 776 <div class="sectionbody">
 777 <div class="dlist"><dl>
 778 <dt class="hdlist1">
 779 &lt;pattern&gt;&#8230;
 780 </dt>
 781 <dd>
 782 <p>
 783         If one or more patterns are given, only refs are shown that
 784         match against at least one pattern, either using fnmatch(3) or
 785         literally, in the latter case matching completely or from the
 786         beginning up to a slash.
 787 </p>
 788 </dd>
 789 <dt class="hdlist1">
 790 --stdin
 791 </dt>
 792 <dd>
 793 <p>
 794         If <code>--stdin</code> is supplied, then the list of patterns is read from
 795         standard input instead of from the argument list.
 796 </p>
 797 </dd>
 798 <dt class="hdlist1">
 799 --count=&lt;count&gt;
 800 </dt>
 801 <dd>
 802 <p>
 803         By default the command shows all refs that match
 804         <code>&lt;pattern&gt;</code>.  This option makes it stop after showing
 805         that many refs.
 806 </p>
 807 </dd>
 808 <dt class="hdlist1">
 809 --sort=&lt;key&gt;
 810 </dt>
 811 <dd>
 812 <p>
 813         A field name to sort on.  Prefix <code>-</code> to sort in
 814         descending order of the value.  When unspecified,
 815         <code>refname</code> is used.  You may use the --sort=&lt;key&gt; option
 816         multiple times, in which case the last key becomes the primary
 817         key.
 818 </p>
 819 </dd>
 820 <dt class="hdlist1">
 821 --format=&lt;format&gt;
 822 </dt>
 823 <dd>
 824 <p>
 825         A string that interpolates <code>%(fieldname)</code> from a ref being shown
 826         and the object it points at.  If <code>fieldname</code>
 827         is prefixed with an asterisk (<code>*</code>) and the ref points
 828         at a tag object, use the value for the field in the object
 829         which the tag object refers to (instead of the field in the tag object).
 830         When unspecified, <code>&lt;format&gt;</code> defaults to
 831         <code>%(objectname) SPC %(objecttype) TAB %(refname)</code>.
 832         It also interpolates <code>%%</code> to <code>%</code>, and <code>%xx</code> where <code>xx</code>
 833         are hex digits interpolates to character with hex code
 834         <code>xx</code>; for example <code>%00</code> interpolates to <code>\0</code> (NUL),
 835         <code>%09</code> to <code>\t</code> (TAB) and <code>%0a</code> to <code>\n</code> (LF).
 836 </p>
 837 </dd>
 838 <dt class="hdlist1">
 839 --color[=&lt;when&gt;]
 840 </dt>
 841 <dd>
 842 <p>
 843         Respect any colors specified in the <code>--format</code> option. The
 844         <code>&lt;when&gt;</code> field must be one of <code>always</code>, <code>never</code>, or <code>auto</code> (if
 845         <code>&lt;when&gt;</code> is absent, behave as if <code>always</code> was given).
 846 </p>
 847 </dd>
 848 <dt class="hdlist1">
 849 --shell
 850 </dt>
 851 <dt class="hdlist1">
 852 --perl
 853 </dt>
 854 <dt class="hdlist1">
 855 --python
 856 </dt>
 857 <dt class="hdlist1">
 858 --tcl
 859 </dt>
 860 <dd>
 861 <p>
 862         If given, strings that substitute <code>%(fieldname)</code>
 863         placeholders are quoted as string literals suitable for
 864         the specified host language.  This is meant to produce
 865         a scriptlet that can directly be `eval`ed.
 866 </p>
 867 </dd>
 868 <dt class="hdlist1">
 869 --points-at=&lt;object&gt;
 870 </dt>
 871 <dd>
 872 <p>
 873         Only list refs which points at the given object.
 874 </p>
 875 </dd>
 876 <dt class="hdlist1">
 877 --merged[=&lt;object&gt;]
 878 </dt>
 879 <dd>
 880 <p>
 881         Only list refs whose tips are reachable from the
 882         specified commit (HEAD if not specified).
 883 </p>
 884 </dd>
 885 <dt class="hdlist1">
 886 --no-merged[=&lt;object&gt;]
 887 </dt>
 888 <dd>
 889 <p>
 890         Only list refs whose tips are not reachable from the
 891         specified commit (HEAD if not specified).
 892 </p>
 893 </dd>
 894 <dt class="hdlist1">
 895 --contains[=&lt;object&gt;]
 896 </dt>
 897 <dd>
 898 <p>
 899         Only list refs which contain the specified commit (HEAD if not
 900         specified).
 901 </p>
 902 </dd>
 903 <dt class="hdlist1">
 904 --no-contains[=&lt;object&gt;]
 905 </dt>
 906 <dd>
 907 <p>
 908         Only list refs which don&#8217;t contain the specified commit (HEAD
 909         if not specified).
 910 </p>
 911 </dd>
 912 <dt class="hdlist1">
 913 --ignore-case
 914 </dt>
 915 <dd>
 916 <p>
 917         Sorting and filtering refs are case insensitive.
 918 </p>
 919 </dd>
 920 <dt class="hdlist1">
 921 --omit-empty
 922 </dt>
 923 <dd>
 924 <p>
 925         Do not print a newline after formatted refs where the format expands
 926         to the empty string.
 927 </p>
 928 </dd>
 929 <dt class="hdlist1">
 930 --exclude=&lt;pattern&gt;
 931 </dt>
 932 <dd>
 933 <p>
 934         If one or more patterns are given, only refs which do not match
 935         any excluded pattern(s) are shown. Matching is done using the
 936         same rules as <code>&lt;pattern&gt;</code> above.
 937 </p>
 938 </dd>
 939 </dl></div>
 940 </div>
 941 </div>
 942 <div class="sect1">
 943 <h2 id="_field_names">FIELD NAMES</h2>
 944 <div class="sectionbody">
 945 <div class="paragraph"><p>Various values from structured fields in referenced objects can
 946 be used to interpolate into the resulting output, or as sort
 947 keys.</p></div>
 948 <div class="paragraph"><p>For all objects, the following names can be used:</p></div>
 949 <div class="dlist"><dl>
 950 <dt class="hdlist1">
 951 refname
 952 </dt>
 953 <dd>
 954 <p>
 955         The name of the ref (the part after $GIT_DIR/).
 956         For a non-ambiguous short name of the ref append <code>:short</code>.
 957         The option core.warnAmbiguousRefs is used to select the strict
 958         abbreviation mode. If <code>lstrip=&lt;N&gt;</code> (<code>rstrip=&lt;N&gt;</code>) is appended, strips <code>&lt;N&gt;</code>
 959         slash-separated path components from the front (back) of the refname
 960         (e.g. <code>%(refname:lstrip=2)</code> turns <code>refs/tags/foo</code> into <code>foo</code> and
 961         <code>%(refname:rstrip=2)</code> turns <code>refs/tags/foo</code> into <code>refs</code>).
 962         If <code>&lt;N&gt;</code> is a negative number, strip as many path components as
 963         necessary from the specified end to leave <code>-&lt;N&gt;</code> path components
 964         (e.g. <code>%(refname:lstrip=-2)</code> turns
 965         <code>refs/tags/foo</code> into <code>tags/foo</code> and <code>%(refname:rstrip=-1)</code>
 966         turns <code>refs/tags/foo</code> into <code>refs</code>). When the ref does not have
 967         enough components, the result becomes an empty string if
 968         stripping with positive &lt;N&gt;, or it becomes the full refname if
 969         stripping with negative &lt;N&gt;.  Neither is an error.
 970 </p>
 971 <div class="paragraph"><p><code>strip</code> can be used as a synonym to <code>lstrip</code>.</p></div>
 972 </dd>
 973 <dt class="hdlist1">
 974 objecttype
 975 </dt>
 976 <dd>
 977 <p>
 978         The type of the object (<code>blob</code>, <code>tree</code>, <code>commit</code>, <code>tag</code>).
 979 </p>
 980 </dd>
 981 <dt class="hdlist1">
 982 objectsize
 983 </dt>
 984 <dd>
 985 <p>
 986         The size of the object (the same as <em>git cat-file -s</em> reports).
 987         Append <code>:disk</code> to get the size, in bytes, that the object takes up on
 988         disk. See the note about on-disk sizes in the <code>CAVEATS</code> section below.
 989 </p>
 990 </dd>
 991 <dt class="hdlist1">
 992 objectname
 993 </dt>
 994 <dd>
 995 <p>
 996         The object name (aka SHA-1).
 997         For a non-ambiguous abbreviation of the object name append <code>:short</code>.
 998         For an abbreviation of the object name with desired length append
 999         <code>:short=&lt;length&gt;</code>, where the minimum length is MINIMUM_ABBREV. The
1000         length may be exceeded to ensure unique object names.
1001 </p>
1002 </dd>
1003 <dt class="hdlist1">
1004 deltabase
1005 </dt>
1006 <dd>
1007 <p>
1008         This expands to the object name of the delta base for the
1009         given object, if it is stored as a delta.  Otherwise it
1010         expands to the null object name (all zeroes).
1011 </p>
1012 </dd>
1013 <dt class="hdlist1">
1014 upstream
1015 </dt>
1016 <dd>
1017 <p>
1018         The name of a local ref which can be considered &#8220;upstream&#8221;
1019         from the displayed ref. Respects <code>:short</code>, <code>:lstrip</code> and
1020         <code>:rstrip</code> in the same way as <code>refname</code> above.  Additionally
1021         respects <code>:track</code> to show "[ahead N, behind M]" and
1022         <code>:trackshort</code> to show the terse version: "&gt;" (ahead), "&lt;"
1023         (behind), "&lt;&gt;" (ahead and behind), or "=" (in sync). <code>:track</code>
1024         also prints "[gone]" whenever unknown upstream ref is
1025         encountered. Append <code>:track,nobracket</code> to show tracking
1026         information without brackets (i.e "ahead N, behind M").
1027 </p>
1028 <div class="paragraph"><p>For any remote-tracking branch <code>%(upstream)</code>, <code>%(upstream:remotename)</code>
1029 and <code>%(upstream:remoteref)</code> refer to the name of the remote and the
1030 name of the tracked remote ref, respectively. In other words, the
1031 remote-tracking branch can be updated explicitly and individually by
1032 using the refspec <code>%(upstream:remoteref):%(upstream)</code> to fetch from
1033 <code>%(upstream:remotename)</code>.</p></div>
1034 <div class="paragraph"><p>Has no effect if the ref does not have tracking information associated
1035 with it.  All the options apart from <code>nobracket</code> are mutually exclusive,
1036 but if used together the last option is selected.</p></div>
1037 </dd>
1038 <dt class="hdlist1">
1039 push
1040 </dt>
1041 <dd>
1042 <p>
1043         The name of a local ref which represents the <code>@{push}</code>
1044         location for the displayed ref. Respects <code>:short</code>, <code>:lstrip</code>,
1045         <code>:rstrip</code>, <code>:track</code>, <code>:trackshort</code>, <code>:remotename</code>, and <code>:remoteref</code>
1046         options as <code>upstream</code> does. Produces an empty string if no <code>@{push}</code>
1047         ref is configured.
1048 </p>
1049 </dd>
1050 <dt class="hdlist1">
1051 HEAD
1052 </dt>
1053 <dd>
1054 <p>
1055         <em>*</em> if HEAD matches current ref (the checked out branch), ' '
1056         otherwise.
1057 </p>
1058 </dd>
1059 <dt class="hdlist1">
1060 color
1061 </dt>
1062 <dd>
1063 <p>
1064         Change output color. Followed by <code>:&lt;colorname&gt;</code>, where color
1065         names are described under Values in the "CONFIGURATION FILE"
1066         section of <a href="git-config.html">git-config(1)</a>.  For example,
1067         <code>%(color:bold red)</code>.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 align
1072 </dt>
1073 <dd>
1074 <p>
1075         Left-, middle-, or right-align the content between
1076         %(align:&#8230;) and %(end). The "align:" is followed by
1077         <code>width=&lt;width&gt;</code> and <code>position=&lt;position&gt;</code> in any order
1078         separated by a comma, where the <code>&lt;position&gt;</code> is either left,
1079         right or middle, default being left and <code>&lt;width&gt;</code> is the total
1080         length of the content with alignment. For brevity, the
1081         "width=" and/or "position=" prefixes may be omitted, and bare
1082         &lt;width&gt; and &lt;position&gt; used instead.  For instance,
1083         <code>%(align:&lt;width&gt;,&lt;position&gt;)</code>. If the contents length is more
1084         than the width then no alignment is performed. If used with
1085         <code>--quote</code> everything in between %(align:&#8230;) and %(end) is
1086         quoted, but if nested then only the topmost level performs
1087         quoting.
1088 </p>
1089 </dd>
1090 <dt class="hdlist1">
1091 if
1092 </dt>
1093 <dd>
1094 <p>
1095         Used as %(if)&#8230;%(then)&#8230;%(end) or
1096         %(if)&#8230;%(then)&#8230;%(else)&#8230;%(end).  If there is an atom with
1097         value or string literal after the %(if) then everything after
1098         the %(then) is printed, else if the %(else) atom is used, then
1099         everything after %(else) is printed. We ignore space when
1100         evaluating the string before %(then), this is useful when we
1101         use the %(HEAD) atom which prints either "*" or " " and we
1102         want to apply the <em>if</em> condition only on the <em>HEAD</em> ref.
1103         Append ":equals=&lt;string&gt;" or ":notequals=&lt;string&gt;" to compare
1104         the value between the %(if:&#8230;) and %(then) atoms with the
1105         given string.
1106 </p>
1107 </dd>
1108 <dt class="hdlist1">
1109 symref
1110 </dt>
1111 <dd>
1112 <p>
1113         The ref which the given symbolic ref refers to. If not a
1114         symbolic ref, nothing is printed. Respects the <code>:short</code>,
1115         <code>:lstrip</code> and <code>:rstrip</code> options in the same way as <code>refname</code>
1116         above.
1117 </p>
1118 </dd>
1119 <dt class="hdlist1">
1120 signature
1121 </dt>
1122 <dd>
1123 <p>
1124         The GPG signature of a commit.
1125 </p>
1126 </dd>
1127 <dt class="hdlist1">
1128 signature:grade
1129 </dt>
1130 <dd>
1131 <p>
1132         Show "G" for a good (valid) signature, "B" for a bad
1133         signature, "U" for a good signature with unknown validity, "X"
1134         for a good signature that has expired, "Y" for a good
1135         signature made by an expired key, "R" for a good signature
1136         made by a revoked key, "E" if the signature cannot be
1137         checked (e.g. missing key) and "N" for no signature.
1138 </p>
1139 </dd>
1140 <dt class="hdlist1">
1141 signature:signer
1142 </dt>
1143 <dd>
1144 <p>
1145         The signer of the GPG signature of a commit.
1146 </p>
1147 </dd>
1148 <dt class="hdlist1">
1149 signature:key
1150 </dt>
1151 <dd>
1152 <p>
1153         The key of the GPG signature of a commit.
1154 </p>
1155 </dd>
1156 <dt class="hdlist1">
1157 signature:fingerprint
1158 </dt>
1159 <dd>
1160 <p>
1161         The fingerprint of the GPG signature of a commit.
1162 </p>
1163 </dd>
1164 <dt class="hdlist1">
1165 signature:primarykeyfingerprint
1166 </dt>
1167 <dd>
1168 <p>
1169         The primary key fingerprint of the GPG signature of a commit.
1170 </p>
1171 </dd>
1172 <dt class="hdlist1">
1173 signature:trustlevel
1174 </dt>
1175 <dd>
1176 <p>
1177         The trust level of the GPG signature of a commit. Possible
1178         outputs are <code>ultimate</code>, <code>fully</code>, <code>marginal</code>, <code>never</code> and <code>undefined</code>.
1179 </p>
1180 </dd>
1181 <dt class="hdlist1">
1182 worktreepath
1183 </dt>
1184 <dd>
1185 <p>
1186         The absolute path to the worktree in which the ref is checked
1187         out, if it is checked out in any linked worktree. Empty string
1188         otherwise.
1189 </p>
1190 </dd>
1191 <dt class="hdlist1">
1192 ahead-behind:&lt;committish&gt;
1193 </dt>
1194 <dd>
1195 <p>
1196         Two integers, separated by a space, demonstrating the number of
1197         commits ahead and behind, respectively, when comparing the output
1198         ref to the <code>&lt;committish&gt;</code> specified in the format.
1199 </p>
1200 </dd>
1201 <dt class="hdlist1">
1202 describe[:options]
1203 </dt>
1204 <dd>
1205 <p>
1206         A human-readable name, like <a href="git-describe.html">git-describe(1)</a>;
1207         empty string for undescribable commits. The <code>describe</code> string may
1208         be followed by a colon and one or more comma-separated options.
1209 </p>
1210 <div class="openblock">
1211 <div class="content">
1212 <div class="dlist"><dl>
1213 <dt class="hdlist1">
1214 tags=&lt;bool-value&gt;
1215 </dt>
1216 <dd>
1217 <p>
1218         Instead of only considering annotated tags, consider
1219         lightweight tags as well; see the corresponding option in
1220         <a href="git-describe.html">git-describe(1)</a> for details.
1221 </p>
1222 </dd>
1223 <dt class="hdlist1">
1224 abbrev=&lt;number&gt;
1225 </dt>
1226 <dd>
1227 <p>
1228         Use at least &lt;number&gt; hexadecimal digits; see the corresponding
1229         option in <a href="git-describe.html">git-describe(1)</a> for details.
1230 </p>
1231 </dd>
1232 <dt class="hdlist1">
1233 match=&lt;pattern&gt;
1234 </dt>
1235 <dd>
1236 <p>
1237         Only consider tags matching the given <code>glob(7)</code> pattern,
1238         excluding the "refs/tags/" prefix; see the corresponding option
1239         in <a href="git-describe.html">git-describe(1)</a> for details.
1240 </p>
1241 </dd>
1242 <dt class="hdlist1">
1243 exclude=&lt;pattern&gt;
1244 </dt>
1245 <dd>
1246 <p>
1247         Do not consider tags matching the given <code>glob(7)</code> pattern,
1248         excluding the "refs/tags/" prefix; see the corresponding option
1249         in <a href="git-describe.html">git-describe(1)</a> for details.
1250 </p>
1251 </dd>
1252 </dl></div>
1253 </div></div>
1254 </dd>
1255 </dl></div>
1256 <div class="paragraph"><p>In addition to the above, for commit and tag objects, the header
1257 field names (<code>tree</code>, <code>parent</code>, <code>object</code>, <code>type</code>, and <code>tag</code>) can
1258 be used to specify the value in the header field.
1259 Fields <code>tree</code> and <code>parent</code> can also be used with modifier <code>:short</code> and
1260 <code>:short=&lt;length&gt;</code> just like <code>objectname</code>.</p></div>
1261 <div class="paragraph"><p>For commit and tag objects, the special <code>creatordate</code> and <code>creator</code>
1262 fields will correspond to the appropriate date or name-email-date tuple
1263 from the <code>committer</code> or <code>tagger</code> fields depending on the object type.
1264 These are intended for working on a mix of annotated and lightweight tags.</p></div>
1265 <div class="paragraph"><p>Fields that have name-email-date tuple as its value (<code>author</code>,
1266 <code>committer</code>, and <code>tagger</code>) can be suffixed with <code>name</code>, <code>email</code>,
1267 and <code>date</code> to extract the named component.  For email fields (<code>authoremail</code>,
1268 <code>committeremail</code> and <code>taggeremail</code>), <code>:trim</code> can be appended to get the email
1269 without angle brackets, and <code>:localpart</code> to get the part before the <code>@</code> symbol
1270 out of the trimmed email. In addition to these, the <code>:mailmap</code> option and the
1271 corresponding <code>:mailmap,trim</code> and <code>:mailmap,localpart</code> can be used (order does
1272 not matter) to get values of the name and email according to the .mailmap file
1273 or according to the file set in the mailmap.file or mailmap.blob configuration
1274 variable (see <a href="gitmailmap.html">gitmailmap(5)</a>).</p></div>
1275 <div class="paragraph"><p>The raw data in an object is <code>raw</code>.</p></div>
1276 <div class="dlist"><dl>
1277 <dt class="hdlist1">
1278 raw:size
1279 </dt>
1280 <dd>
1281 <p>
1282         The raw data size of the object.
1283 </p>
1284 </dd>
1285 </dl></div>
1286 <div class="paragraph"><p>Note that <code>--format=%(raw)</code> can not be used with <code>--python</code>, <code>--shell</code>, <code>--tcl</code>,
1287 because such language may not support arbitrary binary data in their string
1288 variable type.</p></div>
1289 <div class="paragraph"><p>The message in a commit or a tag object is <code>contents</code>, from which
1290 <code>contents:&lt;part&gt;</code> can be used to extract various parts out of:</p></div>
1291 <div class="dlist"><dl>
1292 <dt class="hdlist1">
1293 contents:size
1294 </dt>
1295 <dd>
1296 <p>
1297         The size in bytes of the commit or tag message.
1298 </p>
1299 </dd>
1300 <dt class="hdlist1">
1301 contents:subject
1302 </dt>
1303 <dd>
1304 <p>
1305         The first paragraph of the message, which typically is a
1306         single line, is taken as the "subject" of the commit or the
1307         tag message.
1308         Instead of <code>contents:subject</code>, field <code>subject</code> can also be used to
1309         obtain same results. <code>:sanitize</code> can be appended to <code>subject</code> for
1310         subject line suitable for filename.
1311 </p>
1312 </dd>
1313 <dt class="hdlist1">
1314 contents:body
1315 </dt>
1316 <dd>
1317 <p>
1318         The remainder of the commit or the tag message that follows
1319         the "subject".
1320 </p>
1321 </dd>
1322 <dt class="hdlist1">
1323 contents:signature
1324 </dt>
1325 <dd>
1326 <p>
1327         The optional GPG signature of the tag.
1328 </p>
1329 </dd>
1330 <dt class="hdlist1">
1331 contents:lines=N
1332 </dt>
1333 <dd>
1334 <p>
1335         The first <code>N</code> lines of the message.
1336 </p>
1337 </dd>
1338 </dl></div>
1339 <div class="paragraph"><p>Additionally, the trailers as interpreted by <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>
1340 are obtained as <code>trailers[:options]</code> (or by using the historical alias
1341 <code>contents:trailers[:options]</code>). For valid [:option] values see <code>trailers</code>
1342 section of <a href="git-log.html">git-log(1)</a>.</p></div>
1343 <div class="paragraph"><p>For sorting purposes, fields with numeric values sort in numeric order
1344 (<code>objectsize</code>, <code>authordate</code>, <code>committerdate</code>, <code>creatordate</code>, <code>taggerdate</code>).
1345 All other fields are used to sort in their byte-value order.</p></div>
1346 <div class="paragraph"><p>There is also an option to sort by versions, this can be done by using
1347 the fieldname <code>version:refname</code> or its alias <code>v:refname</code>.</p></div>
1348 <div class="paragraph"><p>In any case, a field name that refers to a field inapplicable to
1349 the object referred by the ref does not cause an error.  It
1350 returns an empty string instead.</p></div>
1351 <div class="paragraph"><p>As a special case for the date-type fields, you may specify a format for
1352 the date by adding <code>:</code> followed by date format name (see the
1353 values the <code>--date</code> option to <a href="git-rev-list.html">git-rev-list(1)</a> takes).</p></div>
1354 <div class="paragraph"><p>Some atoms like %(align) and %(if) always require a matching %(end).
1355 We call them "opening atoms" and sometimes denote them as %($open).</p></div>
1356 <div class="paragraph"><p>When a scripting language specific quoting is in effect, everything
1357 between a top-level opening atom and its matching %(end) is evaluated
1358 according to the semantics of the opening atom and only its result
1359 from the top-level is quoted.</p></div>
1360 </div>
1361 </div>
1362 <div class="sect1">
1363 <h2 id="_examples">EXAMPLES</h2>
1364 <div class="sectionbody">
1365 <div class="paragraph"><p>An example directly producing formatted text.  Show the most recent
1366 3 tagged commits:</p></div>
1367 <div class="listingblock">
1368 <div class="content">
1369 <pre><code>#!/bin/sh
1370
1371 git for-each-ref --count=3 --sort='-*authordate' \
1372 --format='From: %(*authorname) %(*authoremail)
1373 Subject: %(*subject)
1374 Date: %(*authordate)
1375 Ref: %(*refname)
1376
1377 %(*body)
1378 ' 'refs/tags'</code></pre>
1379 </div></div>
1380 <div class="paragraph"><p>A simple example showing the use of shell eval on the output,
1381 demonstrating the use of --shell.  List the prefixes of all heads:</p></div>
1382 <div class="listingblock">
1383 <div class="content">
1384 <pre><code>#!/bin/sh
1385
1386 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
1387 while read entry
1388 do
1389         eval "$entry"
1390         echo `dirname $ref`
1391 done</code></pre>
1392 </div></div>
1393 <div class="paragraph"><p>A bit more elaborate report on tags, demonstrating that the format
1394 may be an entire script:</p></div>
1395 <div class="listingblock">
1396 <div class="content">
1397 <pre><code>#!/bin/sh
1398
1399 fmt='
1400         r=%(refname)
1401         t=%(*objecttype)
1402         T=${r#refs/tags/}
1403
1404         o=%(*objectname)
1405         n=%(*authorname)
1406         e=%(*authoremail)
1407         s=%(*subject)
1408         d=%(*authordate)
1409         b=%(*body)
1410
1411         kind=Tag
1412         if test "z$t" = z
1413         then
1414                 # could be a lightweight tag
1415                 t=%(objecttype)
1416                 kind="Lightweight tag"
1417                 o=%(objectname)
1418                 n=%(authorname)
1419                 e=%(authoremail)
1420                 s=%(subject)
1421                 d=%(authordate)
1422                 b=%(body)
1423         fi
1424         echo "$kind $T points at a $t object $o"
1425         if test "z$t" = zcommit
1426         then
1427                 echo "The commit was authored by $n $e
1428 at $d, and titled
1429
1430     $s
1431
1432 Its message reads as:
1433 "
1434                 echo "$b" | sed -e "s/^/    /"
1435                 echo
1436         fi
1437 '
1438
1439 eval=`git for-each-ref --shell --format="$fmt" \
1440         --sort='*objecttype' \
1441         --sort=-taggerdate \
1442         refs/tags`
1443 eval "$eval"</code></pre>
1444 </div></div>
1445 <div class="paragraph"><p>An example to show the usage of %(if)&#8230;%(then)&#8230;%(else)&#8230;%(end).
1446 This prefixes the current branch with a star.</p></div>
1447 <div class="listingblock">
1448 <div class="content">
1449 <pre><code>git for-each-ref --format="%(if)%(HEAD)%(then)* %(else)  %(end)%(refname:short)" refs/heads/</code></pre>
1450 </div></div>
1451 <div class="paragraph"><p>An example to show the usage of %(if)&#8230;%(then)&#8230;%(end).
1452 This prints the authorname, if present.</p></div>
1453 <div class="listingblock">
1454 <div class="content">
1455 <pre><code>git for-each-ref --format="%(refname)%(if)%(authorname)%(then) Authored by: %(authorname)%(end)"</code></pre>
1456 </div></div>
1457 </div>
1458 </div>
1459 <div class="sect1">
1460 <h2 id="_caveats">CAVEATS</h2>
1461 <div class="sectionbody">
1462 <div class="paragraph"><p>Note that the sizes of objects on disk are reported accurately, but care
1463 should be taken in drawing conclusions about which refs or objects are
1464 responsible for disk usage. The size of a packed non-delta object may be
1465 much larger than the size of objects which delta against it, but the
1466 choice of which object is the base and which is the delta is arbitrary
1467 and is subject to change during a repack.</p></div>
1468 <div class="paragraph"><p>Note also that multiple copies of an object may be present in the object
1469 database; in this case, it is undefined which copy&#8217;s size or delta base
1470 will be reported.</p></div>
1471 </div>
1472 </div>
1473 <div class="sect1">
1474 <h2 id="_notes">NOTES</h2>
1475 <div class="sectionbody">
1476 <div class="paragraph"><p>When combining multiple <code>--contains</code> and <code>--no-contains</code> filters, only
1477 references that contain at least one of the <code>--contains</code> commits and
1478 contain none of the <code>--no-contains</code> commits are shown.</p></div>
1479 <div class="paragraph"><p>When combining multiple <code>--merged</code> and <code>--no-merged</code> filters, only
1480 references that are reachable from at least one of the <code>--merged</code>
1481 commits and from none of the <code>--no-merged</code> commits are shown.</p></div>
1482 </div>
1483 </div>
1484 <div class="sect1">
1485 <h2 id="_see_also">SEE ALSO</h2>
1486 <div class="sectionbody">
1487 <div class="paragraph"><p><a href="git-show-ref.html">git-show-ref(1)</a></p></div>
1488 </div>
1489 </div>
1490 <div class="sect1">
1491 <h2 id="_git">GIT</h2>
1492 <div class="sectionbody">
1493 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1494 </div>
1495 </div>
1496 </div>
1497 <div id="footnotes"><hr /></div>
1498 <div id="footer">
1499 <div id="footer-text">
1500 Last updated
1501  2023-10-05 07:43:56 JST
1502 </div>
1503 </div>
1504 </body>
1505 </html>