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