"Fossies" - the Fresh Open Source Software Archive

Member "git-for-each-ref.html" (15 Dec 2018, 35634 Bytes) of package /linux/misc/git-htmldocs-2.20.1.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

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