git-for-each-ref.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.5.2" />
   7 <title>git-for-each-ref(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.0em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.0em;
 126   margin-bottom: 2.0em;
 127   margin-right: 10%;
 128   color: #606060;
 129 }
 130
 131 div.content { /* Block element content. */
 132   padding: 0;
 133 }
 134
 135 /* Block element titles. */
 136 div.title, caption.title {
 137   color: #527bbd;
 138   font-family: sans-serif;
 139   font-weight: bold;
 140   text-align: left;
 141   margin-top: 1.0em;
 142   margin-bottom: 0.5em;
 143 }
 144 div.title + * {
 145   margin-top: 0;
 146 }
 147
 148 td div.title:first-child {
 149   margin-top: 0.0em;
 150 }
 151 div.content div.title:first-child {
 152   margin-top: 0.0em;
 153 }
 154 div.content + div.title {
 155   margin-top: 0.0em;
 156 }
 157
 158 div.sidebarblock > div.content {
 159   background: #ffffee;
 160   border: 1px solid silver;
 161   padding: 0.5em;
 162 }
 163
 164 div.listingblock > div.content {
 165   border: 1px solid silver;
 166   background: #f4f4f4;
 167   padding: 0.5em;
 168 }
 169
 170 div.quoteblock, div.verseblock {
 171   padding-left: 1.0em;
 172   margin-left: 1.0em;
 173   margin-right: 10%;
 174   border-left: 5px solid #dddddd;
 175   color: #777777;
 176 }
 177
 178 div.quoteblock > div.attribution {
 179   padding-top: 0.5em;
 180   text-align: right;
 181 }
 182
 183 div.verseblock > div.content {
 184   white-space: pre;
 185 }
 186 div.verseblock > div.attribution {
 187   padding-top: 0.75em;
 188   text-align: left;
 189 }
 190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 191 div.verseblock + div.attribution {
 192   text-align: left;
 193 }
 194
 195 div.admonitionblock .icon {
 196   vertical-align: top;
 197   font-size: 1.1em;
 198   font-weight: bold;
 199   text-decoration: underline;
 200   color: #527bbd;
 201   padding-right: 0.5em;
 202 }
 203 div.admonitionblock td.content {
 204   padding-left: 0.5em;
 205   border-left: 3px solid #dddddd;
 206 }
 207
 208 div.exampleblock > div.content {
 209   border-left: 3px solid #dddddd;
 210   padding-left: 0.5em;
 211 }
 212
 213 div.imageblock div.content { padding-left: 0; }
 214 span.image img { border-style: none; }
 215 a.image:visited { color: white; }
 216
 217 dl {
 218   margin-top: 0.8em;
 219   margin-bottom: 0.8em;
 220 }
 221 dt {
 222   margin-top: 0.5em;
 223   margin-bottom: 0;
 224   font-style: normal;
 225   color: navy;
 226 }
 227 dd > *:first-child {
 228   margin-top: 0.1em;
 229 }
 230
 231 ul, ol {
 232     list-style-position: outside;
 233 }
 234 ol.arabic {
 235   list-style-type: decimal;
 236 }
 237 ol.loweralpha {
 238   list-style-type: lower-alpha;
 239 }
 240 ol.upperalpha {
 241   list-style-type: upper-alpha;
 242 }
 243 ol.lowerroman {
 244   list-style-type: lower-roman;
 245 }
 246 ol.upperroman {
 247   list-style-type: upper-roman;
 248 }
 249
 250 div.compact ul, div.compact ol,
 251 div.compact p, div.compact p,
 252 div.compact div, div.compact div {
 253   margin-top: 0.1em;
 254   margin-bottom: 0.1em;
 255 }
 256
 257 div.tableblock > table {
 258   border: 3px solid #527bbd;
 259 }
 260 thead, p.table.header {
 261   font-family: sans-serif;
 262   font-weight: bold;
 263 }
 264 tfoot {
 265   font-weight: bold;
 266 }
 267 td > div.verse {
 268   white-space: pre;
 269 }
 270 p.table {
 271   margin-top: 0;
 272 }
 273 /* Because the table frame attribute is overriden by CSS in most browsers. */
 274 div.tableblock > table[frame="void"] {
 275   border-style: none;
 276 }
 277 div.tableblock > table[frame="hsides"] {
 278   border-left-style: none;
 279   border-right-style: none;
 280 }
 281 div.tableblock > table[frame="vsides"] {
 282   border-top-style: none;
 283   border-bottom-style: none;
 284 }
 285
 286
 287 div.hdlist {
 288   margin-top: 0.8em;
 289   margin-bottom: 0.8em;
 290 }
 291 div.hdlist tr {
 292   padding-bottom: 15px;
 293 }
 294 dt.hdlist1.strong, td.hdlist1.strong {
 295   font-weight: bold;
 296 }
 297 td.hdlist1 {
 298   vertical-align: top;
 299   font-style: normal;
 300   padding-right: 0.8em;
 301   color: navy;
 302 }
 303 td.hdlist2 {
 304   vertical-align: top;
 305 }
 306 div.hdlist.compact tr {
 307   margin: 0;
 308   padding-bottom: 0;
 309 }
 310
 311 .comment {
 312   background: yellow;
 313 }
 314
 315 .footnote, .footnoteref {
 316   font-size: 0.8em;
 317 }
 318
 319 span.footnote, span.footnoteref {
 320   vertical-align: super;
 321 }
 322
 323 #footnotes {
 324   margin: 20px 0 20px 0;
 325   padding: 7px 0 0 0;
 326 }
 327
 328 #footnotes div.footnote {
 329   margin: 0 0 5px 0;
 330 }
 331
 332 #footnotes hr {
 333   border: none;
 334   border-top: 1px solid silver;
 335   height: 1px;
 336   text-align: left;
 337   margin-left: 0;
 338   width: 20%;
 339   min-width: 100px;
 340 }
 341
 342
 343 @media print {
 344   div#footer-badges { display: none; }
 345 }
 346
 347 div#toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 div#toctitle {
 352   color: #527bbd;
 353   font-family: sans-serif;
 354   font-size: 1.1em;
 355   font-weight: bold;
 356   margin-top: 1.0em;
 357   margin-bottom: 0.1em;
 358 }
 359
 360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 361   margin-top: 0;
 362   margin-bottom: 0;
 363 }
 364 div.toclevel2 {
 365   margin-left: 2em;
 366   font-size: 0.9em;
 367 }
 368 div.toclevel3 {
 369   margin-left: 4em;
 370   font-size: 0.9em;
 371 }
 372 div.toclevel4 {
 373   margin-left: 6em;
 374   font-size: 0.9em;
 375 }
 376 /* Overrides for manpage documents */
 377 h1 {
 378   padding-top: 0.5em;
 379   padding-bottom: 0.5em;
 380   border-top: 2px solid silver;
 381   border-bottom: 2px solid silver;
 382 }
 383 h2 {
 384   border-style: none;
 385 }
 386 div.sectionbody {
 387   margin-left: 5%;
 388 }
 389
 390 @media print {
 391   div#toc { display: none; }
 392 }
 393
 394 /* Workarounds for IE6's broken and incomplete CSS2. */
 395
 396 div.sidebar-content {
 397   background: #ffffee;
 398   border: 1px solid silver;
 399   padding: 0.5em;
 400 }
 401 div.sidebar-title, div.image-title {
 402   color: #527bbd;
 403   font-family: sans-serif;
 404   font-weight: bold;
 405   margin-top: 0.0em;
 406   margin-bottom: 0.5em;
 407 }
 408
 409 div.listingblock div.content {
 410   border: 1px solid silver;
 411   background: #f4f4f4;
 412   padding: 0.5em;
 413 }
 414
 415 div.quoteblock-attribution {
 416   padding-top: 0.5em;
 417   text-align: right;
 418 }
 419
 420 div.verseblock-content {
 421   white-space: pre;
 422 }
 423 div.verseblock-attribution {
 424   padding-top: 0.75em;
 425   text-align: left;
 426 }
 427
 428 div.exampleblock-content {
 429   border-left: 3px solid #dddddd;
 430   padding-left: 0.5em;
 431 }
 432
 433 /* IE6 sets dynamically generated links as visited. */
 434 div#toc a:visited { color: blue; }
 435 </style>
 436 <script type="text/javascript">
 437 /*<![CDATA[*/
 438 window.onload = function(){asciidoc.footnotes();}
 439 var asciidoc = {  // Namespace.
 440
 441 /////////////////////////////////////////////////////////////////////
 442 // Table Of Contents generator
 443 /////////////////////////////////////////////////////////////////////
 444
 445 /* Author: Mihai Bazon, September 2002
 446  * http://students.infoiasi.ro/~mishoo
 447  *
 448  * Table Of Content generator
 449  * Version: 0.4
 450  *
 451  * Feel free to use this script under the terms of the GNU General Public
 452  * License, as long as you do not remove or alter this notice.
 453  */
 454
 455  /* modified by Troy D. Hanson, September 2006. License: GPL */
 456  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 457
 458 // toclevels = 1..4.
 459 toc: function (toclevels) {
 460
 461   function getText(el) {
 462     var text = "";
 463     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 464       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 465         text += i.data;
 466       else if (i.firstChild != null)
 467         text += getText(i);
 468     }
 469     return text;
 470   }
 471
 472   function TocEntry(el, text, toclevel) {
 473     this.element = el;
 474     this.text = text;
 475     this.toclevel = toclevel;
 476   }
 477
 478   function tocEntries(el, toclevels) {
 479     var result = new Array;
 480     var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
 481     // Function that scans the DOM tree for header elements (the DOM2
 482     // nodeIterator API would be a better technique but not supported by all
 483     // browsers).
 484     var iterate = function (el) {
 485       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 486         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 487           var mo = re.exec(i.tagName);
 488           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 489             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 490           }
 491           iterate(i);
 492         }
 493       }
 494     }
 495     iterate(el);
 496     return result;
 497   }
 498
 499   var toc = document.getElementById("toc");
 500   var entries = tocEntries(document.getElementById("content"), toclevels);
 501   for (var i = 0; i < entries.length; ++i) {
 502     var entry = entries[i];
 503     if (entry.element.id == "")
 504       entry.element.id = "_toc_" + i;
 505     var a = document.createElement("a");
 506     a.href = "#" + entry.element.id;
 507     a.appendChild(document.createTextNode(entry.text));
 508     var div = document.createElement("div");
 509     div.appendChild(a);
 510     div.className = "toclevel" + entry.toclevel;
 511     toc.appendChild(div);
 512   }
 513   if (entries.length == 0)
 514     toc.parentNode.removeChild(toc);
 515 },
 516
 517
 518 /////////////////////////////////////////////////////////////////////
 519 // Footnotes generator
 520 /////////////////////////////////////////////////////////////////////
 521
 522 /* Based on footnote generation code from:
 523  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 524  */
 525
 526 footnotes: function () {
 527   var cont = document.getElementById("content");
 528   var noteholder = document.getElementById("footnotes");
 529   var spans = cont.getElementsByTagName("span");
 530   var refs = {};
 531   var n = 0;
 532   for (i=0; i<spans.length; i++) {
 533     if (spans[i].className == "footnote") {
 534       n++;
 535       // Use [\s\S] in place of . so multi-line matches work.
 536       // Because JavaScript has no s (dotall) regex flag.
 537       note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 538       noteholder.innerHTML +=
 539         "<div class='footnote' id='_footnote_" + n + "'>" +
 540         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 541         n + "</a>. " + note + "</div>";
 542       spans[i].innerHTML =
 543         "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 544         "' title='View footnote' class='footnote'>" + n + "</a>]";
 545       var id =spans[i].getAttribute("id");
 546       if (id != null) refs["#"+id] = n;
 547     }
 548   }
 549   if (n == 0)
 550     noteholder.parentNode.removeChild(noteholder);
 551   else {
 552     // Process footnoterefs.
 553     for (i=0; i<spans.length; i++) {
 554       if (spans[i].className == "footnoteref") {
 555         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 556         href = href.match(/#.*/)[0];  // Because IE return full URL.
 557         n = refs[href];
 558         spans[i].innerHTML =
 559           "[<a href='#_footnote_" + n +
 560           "' title='View footnote' class='footnote'>" + n + "</a>]";
 561       }
 562     }
 563   }
 564 }
 565
 566 }
 567 /*]]>*/
 568 </script>
 569 </head>
 570 <body>
 571 <div id="header">
 572 <h1>
 573 git-for-each-ref(1) Manual Page
 574 </h1>
 575 <h2>NAME</h2>
 576 <div class="sectionbody">
 577 <p>git-for-each-ref -
 578    Output information on each ref
 579 </p>
 580 </div>
 581 </div>
 582 <div id="content">
 583 <h2 id="_synopsis">SYNOPSIS</h2>
 584 <div class="sectionbody">
 585 <div class="verseblock">
 586 <div class="verseblock-content"><em>git for-each-ref</em> [--count=&lt;count&gt;] [--shell|--perl|--python|--tcl]
 587                    [(--sort=&lt;key&gt;)&#8230;] [--format=&lt;format&gt;] [&lt;pattern&gt;&#8230;]</div>
 588 <div class="verseblock-attribution">
 589 </div></div>
 590 </div>
 591 <h2 id="_description">DESCRIPTION</h2>
 592 <div class="sectionbody">
 593 <div class="paragraph"><p>Iterate over all refs that match <tt>&lt;pattern&gt;</tt> and show them
 594 according to the given <tt>&lt;format&gt;</tt>, after sorting them according
 595 to the given set of <tt>&lt;key&gt;</tt>.  If <tt>&lt;count&gt;</tt> is given, stop after
 596 showing that many refs.  The interpolated values in <tt>&lt;format&gt;</tt>
 597 can optionally be quoted as string literals in the specified
 598 host language allowing their direct evaluation in that language.</p></div>
 599 </div>
 600 <h2 id="_options">OPTIONS</h2>
 601 <div class="sectionbody">
 602 <div class="dlist"><dl>
 603 <dt class="hdlist1">
 604 &lt;count&gt;
 605 </dt>
 606 <dd>
 607 <p>
 608         By default the command shows all refs that match
 609         <tt>&lt;pattern&gt;</tt>.  This option makes it stop after showing
 610         that many refs.
 611 </p>
 612 </dd>
 613 <dt class="hdlist1">
 614 &lt;key&gt;
 615 </dt>
 616 <dd>
 617 <p>
 618         A field name to sort on.  Prefix <tt>-</tt> to sort in
 619         descending order of the value.  When unspecified,
 620         <tt>refname</tt> is used.  You may use the --sort=&lt;key&gt; option
 621         multiple times, in which case the last key becomes the primary
 622         key.
 623 </p>
 624 </dd>
 625 <dt class="hdlist1">
 626 &lt;format&gt;
 627 </dt>
 628 <dd>
 629 <p>
 630         A string that interpolates <tt>%(fieldname)</tt> from the
 631         object pointed at by a ref being shown.  If <tt>fieldname</tt>
 632         is prefixed with an asterisk (<tt>*</tt>) and the ref points
 633         at a tag object, the value for the field in the object
 634         tag refers is used.  When unspecified, defaults to
 635         <tt>%(objectname) SPC %(objecttype) TAB %(refname)</tt>.
 636         It also interpolates <tt>%%</tt> to <tt>%</tt>, and <tt>%xx</tt> where <tt>xx</tt>
 637         are hex digits interpolates to character with hex code
 638         <tt>xx</tt>; for example <tt>%00</tt> interpolates to <tt>\0</tt> (NUL),
 639         <tt>%09</tt> to <tt>\t</tt> (TAB) and <tt>%0a</tt> to <tt>\n</tt> (LF).
 640 </p>
 641 </dd>
 642 <dt class="hdlist1">
 643 &lt;pattern&gt;&#8230;
 644 </dt>
 645 <dd>
 646 <p>
 647         If one or more patterns are given, only refs are shown that
 648         match against at least one pattern, either using fnmatch(3) or
 649         literally, in the latter case matching completely or from the
 650         beginning up to a slash.
 651 </p>
 652 </dd>
 653 <dt class="hdlist1">
 654 --shell
 655 </dt>
 656 <dt class="hdlist1">
 657 --perl
 658 </dt>
 659 <dt class="hdlist1">
 660 --python
 661 </dt>
 662 <dt class="hdlist1">
 663 --tcl
 664 </dt>
 665 <dd>
 666 <p>
 667         If given, strings that substitute <tt>%(fieldname)</tt>
 668         placeholders are quoted as string literals suitable for
 669         the specified host language.  This is meant to produce
 670         a scriptlet that can directly be `eval`ed.
 671 </p>
 672 </dd>
 673 </dl></div>
 674 </div>
 675 <h2 id="_field_names">FIELD NAMES</h2>
 676 <div class="sectionbody">
 677 <div class="paragraph"><p>Various values from structured fields in referenced objects can
 678 be used to interpolate into the resulting output, or as sort
 679 keys.</p></div>
 680 <div class="paragraph"><p>For all objects, the following names can be used:</p></div>
 681 <div class="dlist"><dl>
 682 <dt class="hdlist1">
 683 refname
 684 </dt>
 685 <dd>
 686 <p>
 687         The name of the ref (the part after $GIT_DIR/).
 688         For a non-ambiguous short name of the ref append <tt>:short</tt>.
 689         The option core.warnAmbiguousRefs is used to select the strict
 690         abbreviation mode.
 691 </p>
 692 </dd>
 693 <dt class="hdlist1">
 694 objecttype
 695 </dt>
 696 <dd>
 697 <p>
 698         The type of the object (<tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, <tt>tag</tt>).
 699 </p>
 700 </dd>
 701 <dt class="hdlist1">
 702 objectsize
 703 </dt>
 704 <dd>
 705 <p>
 706         The size of the object (the same as <em>git cat-file -s</em> reports).
 707 </p>
 708 </dd>
 709 <dt class="hdlist1">
 710 objectname
 711 </dt>
 712 <dd>
 713 <p>
 714         The object name (aka SHA-1).
 715         For a non-ambiguous abbreviation of the object name append <tt>:short</tt>.
 716 </p>
 717 </dd>
 718 <dt class="hdlist1">
 719 upstream
 720 </dt>
 721 <dd>
 722 <p>
 723         The name of a local ref which can be considered &#8220;upstream&#8221;
 724         from the displayed ref. Respects <tt>:short</tt> in the same way as
 725         <tt>refname</tt> above.
 726 </p>
 727 </dd>
 728 </dl></div>
 729 <div class="paragraph"><p>In addition to the above, for commit and tag objects, the header
 730 field names (<tt>tree</tt>, <tt>parent</tt>, <tt>object</tt>, <tt>type</tt>, and <tt>tag</tt>) can
 731 be used to specify the value in the header field.</p></div>
 732 <div class="paragraph"><p>Fields that have name-email-date tuple as its value (<tt>author</tt>,
 733 <tt>committer</tt>, and <tt>tagger</tt>) can be suffixed with <tt>name</tt>, <tt>email</tt>,
 734 and <tt>date</tt> to extract the named component.</p></div>
 735 <div class="paragraph"><p>The first line of the message in a commit and tag object is
 736 <tt>subject</tt>, the remaining lines are <tt>body</tt>.  The whole message
 737 is <tt>contents</tt>.</p></div>
 738 <div class="paragraph"><p>For sorting purposes, fields with numeric values sort in numeric
 739 order (<tt>objectsize</tt>, <tt>authordate</tt>, <tt>committerdate</tt>, <tt>taggerdate</tt>).
 740 All other fields are used to sort in their byte-value order.</p></div>
 741 <div class="paragraph"><p>In any case, a field name that refers to a field inapplicable to
 742 the object referred by the ref does not cause an error.  It
 743 returns an empty string instead.</p></div>
 744 <div class="paragraph"><p>As a special case for the date-type fields, you may specify a format for
 745 the date by adding one of <tt>:default</tt>, <tt>:relative</tt>, <tt>:short</tt>, <tt>:local</tt>,
 746 <tt>:iso8601</tt> or <tt>:rfc2822</tt> to the end of the fieldname; e.g.
 747 <tt>%(taggerdate:relative)</tt>.</p></div>
 748 </div>
 749 <h2 id="_examples">EXAMPLES</h2>
 750 <div class="sectionbody">
 751 <div class="paragraph"><p>An example directly producing formatted text.  Show the most recent
 752 3 tagged commits:</p></div>
 753 <div class="listingblock">
 754 <div class="content">
 755 <pre><tt>#!/bin/sh
 756
 757 git for-each-ref --count=3 --sort='-*authordate' \
 758 --format='From: %(*authorname) %(*authoremail)
 759 Subject: %(*subject)
 760 Date: %(*authordate)
 761 Ref: %(*refname)
 762
 763 %(*body)
 764 ' 'refs/tags'</tt></pre>
 765 </div></div>
 766 <div class="paragraph"><p>A simple example showing the use of shell eval on the output,
 767 demonstrating the use of --shell.  List the prefixes of all heads:</p></div>
 768 <div class="listingblock">
 769 <div class="content">
 770 <pre><tt>#!/bin/sh
 771
 772 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
 773 while read entry
 774 do
 775         eval "$entry"
 776         echo `dirname $ref`
 777 done</tt></pre>
 778 </div></div>
 779 <div class="paragraph"><p>A bit more elaborate report on tags, demonstrating that the format
 780 may be an entire script:</p></div>
 781 <div class="listingblock">
 782 <div class="content">
 783 <pre><tt>#!/bin/sh
 784
 785 fmt='
 786         r=%(refname)
 787         t=%(*objecttype)
 788         T=${r#refs/tags/}
 789
 790         o=%(*objectname)
 791         n=%(*authorname)
 792         e=%(*authoremail)
 793         s=%(*subject)
 794         d=%(*authordate)
 795         b=%(*body)
 796
 797         kind=Tag
 798         if test "z$t" = z
 799         then
 800                 # could be a lightweight tag
 801                 t=%(objecttype)
 802                 kind="Lightweight tag"
 803                 o=%(objectname)
 804                 n=%(authorname)
 805                 e=%(authoremail)
 806                 s=%(subject)
 807                 d=%(authordate)
 808                 b=%(body)
 809         fi
 810         echo "$kind $T points at a $t object $o"
 811         if test "z$t" = zcommit
 812         then
 813                 echo "The commit was authored by $n $e
 814 at $d, and titled
 815
 816     $s
 817
 818 Its message reads as:
 819 "
 820                 echo "$b" | sed -e "s/^/    /"
 821                 echo
 822         fi
 823 '
 824
 825 eval=`git for-each-ref --shell --format="$fmt" \
 826         --sort='*objecttype' \
 827         --sort=-taggerdate \
 828         refs/tags`
 829 eval "$eval"</tt></pre>
 830 </div></div>
 831 </div>
 832 <h2 id="_author">Author</h2>
 833 <div class="sectionbody">
 834 <div class="paragraph"><p>Written by Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt;.</p></div>
 835 </div>
 836 <h2 id="_documentation">Documentation</h2>
 837 <div class="sectionbody">
 838 <div class="paragraph"><p>Documentation by Junio C Hamano and the git-list &lt;<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>&gt;.</p></div>
 839 </div>
 840 <h2 id="_git">GIT</h2>
 841 <div class="sectionbody">
 842 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 843 </div>
 844 </div>
 845 <div id="footnotes"><hr /></div>
 846 <div id="footer">
 847 <div id="footer-text">
 848 Last updated 2011-09-21 23:01:14 PDT
 849 </div>
 850 </div>
 851 </body>
 852 </html>