Autogenerated HTML docs for v1.7.5-52-ge839f
[git/jnareb-git.git] / git-for-each-ref.html
blob5822a3c046c6c166ffe19910c0497b3768700816
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.4.5" />
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 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-for-each-ref(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-for-each-ref -
411 Output information on each ref
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git for-each-ref</em> [--count=&lt;count&gt;] [--shell|--perl|--python|--tcl]
419 [(--sort=&lt;key&gt;)&#8230;] [--format=&lt;format&gt;] [&lt;pattern&gt;&#8230;]</div>
420 <div class="verseblock-attribution">
421 </div></div>
422 </div>
423 <h2 id="_description">DESCRIPTION</h2>
424 <div class="sectionbody">
425 <div class="paragraph"><p>Iterate over all refs that match <tt>&lt;pattern&gt;</tt> and show them
426 according to the given <tt>&lt;format&gt;</tt>, after sorting them according
427 to the given set of <tt>&lt;key&gt;</tt>. If <tt>&lt;count&gt;</tt> is given, stop after
428 showing that many refs. The interpolated values in <tt>&lt;format&gt;</tt>
429 can optionally be quoted as string literals in the specified
430 host language allowing their direct evaluation in that language.</p></div>
431 </div>
432 <h2 id="_options">OPTIONS</h2>
433 <div class="sectionbody">
434 <div class="dlist"><dl>
435 <dt class="hdlist1">
436 &lt;count&gt;
437 </dt>
438 <dd>
440 By default the command shows all refs that match
441 <tt>&lt;pattern&gt;</tt>. This option makes it stop after showing
442 that many refs.
443 </p>
444 </dd>
445 <dt class="hdlist1">
446 &lt;key&gt;
447 </dt>
448 <dd>
450 A field name to sort on. Prefix <tt>-</tt> to sort in
451 descending order of the value. When unspecified,
452 <tt>refname</tt> is used. You may use the --sort=&lt;key&gt; option
453 multiple times, in which case the last key becomes the primary
454 key.
455 </p>
456 </dd>
457 <dt class="hdlist1">
458 &lt;format&gt;
459 </dt>
460 <dd>
462 A string that interpolates <tt>%(fieldname)</tt> from the
463 object pointed at by a ref being shown. If <tt>fieldname</tt>
464 is prefixed with an asterisk (<tt>*</tt>) and the ref points
465 at a tag object, the value for the field in the object
466 tag refers is used. When unspecified, defaults to
467 <tt>%(objectname) SPC %(objecttype) TAB %(refname)</tt>.
468 It also interpolates <tt>%%</tt> to <tt>%</tt>, and <tt>%xx</tt> where <tt>xx</tt>
469 are hex digits interpolates to character with hex code
470 <tt>xx</tt>; for example <tt>%00</tt> interpolates to <tt>\0</tt> (NUL),
471 <tt>%09</tt> to <tt>\t</tt> (TAB) and <tt>%0a</tt> to <tt>\n</tt> (LF).
472 </p>
473 </dd>
474 <dt class="hdlist1">
475 &lt;pattern&gt;&#8230;
476 </dt>
477 <dd>
479 If one or more patterns are given, only refs are shown that
480 match against at least one pattern, either using fnmatch(3) or
481 literally, in the latter case matching completely or from the
482 beginning up to a slash.
483 </p>
484 </dd>
485 <dt class="hdlist1">
486 --shell
487 </dt>
488 <dt class="hdlist1">
489 --perl
490 </dt>
491 <dt class="hdlist1">
492 --python
493 </dt>
494 <dt class="hdlist1">
495 --tcl
496 </dt>
497 <dd>
499 If given, strings that substitute <tt>%(fieldname)</tt>
500 placeholders are quoted as string literals suitable for
501 the specified host language. This is meant to produce
502 a scriptlet that can directly be `eval`ed.
503 </p>
504 </dd>
505 </dl></div>
506 </div>
507 <h2 id="_field_names">FIELD NAMES</h2>
508 <div class="sectionbody">
509 <div class="paragraph"><p>Various values from structured fields in referenced objects can
510 be used to interpolate into the resulting output, or as sort
511 keys.</p></div>
512 <div class="paragraph"><p>For all objects, the following names can be used:</p></div>
513 <div class="dlist"><dl>
514 <dt class="hdlist1">
515 refname
516 </dt>
517 <dd>
519 The name of the ref (the part after $GIT_DIR/).
520 For a non-ambiguous short name of the ref append <tt>:short</tt>.
521 The option core.warnAmbiguousRefs is used to select the strict
522 abbreviation mode.
523 </p>
524 </dd>
525 <dt class="hdlist1">
526 objecttype
527 </dt>
528 <dd>
530 The type of the object (<tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, <tt>tag</tt>).
531 </p>
532 </dd>
533 <dt class="hdlist1">
534 objectsize
535 </dt>
536 <dd>
538 The size of the object (the same as <em>git cat-file -s</em> reports).
539 </p>
540 </dd>
541 <dt class="hdlist1">
542 objectname
543 </dt>
544 <dd>
546 The object name (aka SHA-1).
547 For a non-ambiguous abbreviation of the object name append <tt>:short</tt>.
548 </p>
549 </dd>
550 <dt class="hdlist1">
551 upstream
552 </dt>
553 <dd>
555 The name of a local ref which can be considered &#8220;upstream&#8221;
556 from the displayed ref. Respects <tt>:short</tt> in the same way as
557 <tt>refname</tt> above.
558 </p>
559 </dd>
560 </dl></div>
561 <div class="paragraph"><p>In addition to the above, for commit and tag objects, the header
562 field names (<tt>tree</tt>, <tt>parent</tt>, <tt>object</tt>, <tt>type</tt>, and <tt>tag</tt>) can
563 be used to specify the value in the header field.</p></div>
564 <div class="paragraph"><p>Fields that have name-email-date tuple as its value (<tt>author</tt>,
565 <tt>committer</tt>, and <tt>tagger</tt>) can be suffixed with <tt>name</tt>, <tt>email</tt>,
566 and <tt>date</tt> to extract the named component.</p></div>
567 <div class="paragraph"><p>The first line of the message in a commit and tag object is
568 <tt>subject</tt>, the remaining lines are <tt>body</tt>. The whole message
569 is <tt>contents</tt>.</p></div>
570 <div class="paragraph"><p>For sorting purposes, fields with numeric values sort in numeric
571 order (<tt>objectsize</tt>, <tt>authordate</tt>, <tt>committerdate</tt>, <tt>taggerdate</tt>).
572 All other fields are used to sort in their byte-value order.</p></div>
573 <div class="paragraph"><p>In any case, a field name that refers to a field inapplicable to
574 the object referred by the ref does not cause an error. It
575 returns an empty string instead.</p></div>
576 <div class="paragraph"><p>As a special case for the date-type fields, you may specify a format for
577 the date by adding one of <tt>:default</tt>, <tt>:relative</tt>, <tt>:short</tt>, <tt>:local</tt>,
578 <tt>:iso8601</tt> or <tt>:rfc2822</tt> to the end of the fieldname; e.g.
579 <tt>%(taggerdate:relative)</tt>.</p></div>
580 </div>
581 <h2 id="_examples">EXAMPLES</h2>
582 <div class="sectionbody">
583 <div class="paragraph"><p>An example directly producing formatted text. Show the most recent
584 3 tagged commits:</p></div>
585 <div class="listingblock">
586 <div class="content">
587 <pre><tt>#!/bin/sh
589 git for-each-ref --count=3 --sort='-*authordate' \
590 --format='From: %(*authorname) %(*authoremail)
591 Subject: %(*subject)
592 Date: %(*authordate)
593 Ref: %(*refname)
595 %(*body)
596 ' 'refs/tags'</tt></pre>
597 </div></div>
598 <div class="paragraph"><p>A simple example showing the use of shell eval on the output,
599 demonstrating the use of --shell. List the prefixes of all heads:</p></div>
600 <div class="listingblock">
601 <div class="content">
602 <pre><tt>#!/bin/sh
604 git for-each-ref --shell --format="ref=%(refname)" refs/heads | \
605 while read entry
607 eval "$entry"
608 echo `dirname $ref`
609 done</tt></pre>
610 </div></div>
611 <div class="paragraph"><p>A bit more elaborate report on tags, demonstrating that the format
612 may be an entire script:</p></div>
613 <div class="listingblock">
614 <div class="content">
615 <pre><tt>#!/bin/sh
617 fmt='
618 r=%(refname)
619 t=%(*objecttype)
620 T=${r#refs/tags/}
622 o=%(*objectname)
623 n=%(*authorname)
624 e=%(*authoremail)
625 s=%(*subject)
626 d=%(*authordate)
627 b=%(*body)
629 kind=Tag
630 if test "z$t" = z
631 then
632 # could be a lightweight tag
633 t=%(objecttype)
634 kind="Lightweight tag"
635 o=%(objectname)
636 n=%(authorname)
637 e=%(authoremail)
638 s=%(subject)
639 d=%(authordate)
640 b=%(body)
642 echo "$kind $T points at a $t object $o"
643 if test "z$t" = zcommit
644 then
645 echo "The commit was authored by $n $e
646 at $d, and titled
650 Its message reads as:
652 echo "$b" | sed -e "s/^/ /"
653 echo
657 eval=`git for-each-ref --shell --format="$fmt" \
658 --sort='*objecttype' \
659 --sort=-taggerdate \
660 refs/tags`
661 eval "$eval"</tt></pre>
662 </div></div>
663 </div>
664 <h2 id="_author">Author</h2>
665 <div class="sectionbody">
666 <div class="paragraph"><p>Written by Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt;.</p></div>
667 </div>
668 <h2 id="_documentation">Documentation</h2>
669 <div class="sectionbody">
670 <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>
671 </div>
672 <h2 id="_git">GIT</h2>
673 <div class="sectionbody">
674 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
675 </div>
676 <div id="footer">
677 <div id="footer-text">
678 Last updated 2011-03-10 01:17:52 UTC
679 </div>
680 </div>
681 </body>
682 </html>