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">
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">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.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
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.5em;
129 div
.content
{ /* Block element content. */
133 /* Block element titles. */
134 div
.title
, caption
.title
{
136 font-family: sans-serif
;
140 margin-bottom: 0.5em;
146 td div
.title:first-child
{
149 div
.content div
.title:first-child
{
152 div
.content
+ div
.title
{
156 div
.sidebarblock
> div
.content
{
158 border: 1px solid silver
;
162 div
.listingblock
> div
.content
{
163 border: 1px solid silver
;
172 div
.quoteblock
> div
.attribution
{
181 div
.verseblock
> div
.content
{
184 div
.verseblock
> div
.attribution
{
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div
.verseblock
+ div
.attribution
{
193 div
.admonitionblock
.icon
{
197 text-decoration: underline
;
199 padding-right: 0.5em;
201 div
.admonitionblock td
.content
{
203 border-left: 2px solid silver
;
206 div
.exampleblock
> div
.content
{
207 border-left: 2px solid silver
;
211 div
.imageblock div
.content
{ padding-left: 0; }
212 span
.image img
{ border-style: none
; }
213 a
.image:visited
{ color: white
; }
217 margin-bottom: 0.8em;
230 list-style-position: outside
;
233 list-style-type: decimal
;
236 list-style-type: lower-alpha
;
239 list-style-type: upper-alpha
;
242 list-style-type: lower-roman
;
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
{
252 margin-bottom: 0.1em;
255 div
.tableblock
> table
{
256 border: 3px solid
#527bbd;
259 font-family: sans-serif
;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div
.tableblock
> table
[frame
="void"] {
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
;
287 margin-bottom: 0.8em;
290 padding-bottom: 15px;
292 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
298 padding-right: 0.8em;
304 div
.hdlist
.compact tr
{
314 div#footer-badges
{ display: none
; }
319 font-family: sans-serif
;
323 margin-bottom: 0.1em;
326 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
342 /* Overrides for manpage documents */
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver
;
347 border-bottom: 2px solid silver
;
357 div#toc
{ display: none
; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div
.sidebar-content
{
364 border: 1px solid silver
;
367 div
.sidebar-title
, div
.image-title
{
369 font-family: sans-serif
;
372 margin-bottom: 0.5em;
375 div
.listingblock div
.content
{
376 border: 1px solid silver
;
381 div
.quoteblock-attribution
{
386 div
.verseblock-content
{
389 div
.verseblock-attribution
{
394 div
.exampleblock-content
{
395 border-left: 2px solid silver
;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc
a:visited
{ color: blue
; }
406 git-for-each-ref(
1) Manual Page
409 <div class=
"sectionbody">
410 <p>git-for-each-ref -
411 Output information on each ref
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=
<count
>] [--shell|--perl|--python|--tcl]
419 [(--sort=
<key
>)
…] [--format=
<format
>] [
<pattern
>…]
</div>
420 <div class=
"verseblock-attribution">
423 <h2 id=
"_description">DESCRIPTION
</h2>
424 <div class=
"sectionbody">
425 <div class=
"paragraph"><p>Iterate over all refs that match
<tt><pattern
></tt> and show them
426 according to the given
<tt><format
></tt>, after sorting them according
427 to the given set of
<tt><key
></tt>. If
<tt><count
></tt> is given, stop after
428 showing that many refs. The interpolated values in
<tt><format
></tt>
429 can optionally be quoted as string literals in the specified
430 host language allowing their direct evaluation in that language.
</p></div>
432 <h2 id=
"_options">OPTIONS
</h2>
433 <div class=
"sectionbody">
434 <div class=
"dlist"><dl>
440 By default the command shows all refs that match
441 <tt><pattern
></tt>. This option makes it stop after showing
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=
<key
> option
453 multiple times, in which case the last key becomes the primary
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).
475 <pattern
>…
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.
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.
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
512 <div class=
"paragraph"><p>For all objects, the following names can be used:
</p></div>
513 <div class=
"dlist"><dl>
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
530 The type of the object (
<tt>blob
</tt>,
<tt>tree
</tt>,
<tt>commit
</tt>,
<tt>tag
</tt>).
538 The size of the object (the same as
<em>git cat-file -s
</em> reports).
546 The object name (aka SHA-
1).
547 For a non-ambiguous abbreviation of the object name append
<tt>:short
</tt>.
555 The name of a local ref which can be considered
“upstream
”
556 from the displayed ref. Respects
<tt>:short
</tt> in the same way as
557 <tt>refname
</tt> above.
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>
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">
589 git for-each-ref --count=
3 --sort='-*authordate' \
590 --format='From: %(*authorname) %(*authoremail)
596 ' 'refs/tags'
</tt></pre>
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">
604 git for-each-ref --shell
--format=
"ref=%(refname)" refs/heads | \
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">
632 # could be a lightweight tag
634 kind=
"Lightweight tag"
642 echo
"$kind $T points at a $t object $o"
643 if test
"z$t" = zcommit
645 echo
"The commit was authored by $n $e
650 Its message reads as:
652 echo
"$b" | sed -e
"s/^/ /"
657 eval=`git for-each-ref --shell
--format=
"$fmt" \
658 --sort='*objecttype' \
661 eval
"$eval"</tt></pre>
664 <h2 id=
"_author">Author
</h2>
665 <div class=
"sectionbody">
666 <div class=
"paragraph"><p>Written by Junio C Hamano
<<a href=
"mailto:gitster@pobox.com">gitster@pobox.com
</a>>.
</p></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
<<a href=
"mailto:git@vger.kernel.org">git@vger.kernel.org
</a>>.
</p></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>
677 <div id=
"footer-text">
678 Last updated
2011-
03-
10 01:
17:
52 UTC