<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
<meta name="generator" content="AsciiDoc 8.5.2" /> | |
<title>git-for-each-ref(1)</title> | |
<style type="text/css"> | |
/* Debug borders */ | |
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { | |
/* | |
border: 1px solid red; | |
*/ | |
} | |
body { | |
margin: 1em 5% 1em 5%; | |
} | |
a { | |
color: blue; | |
text-decoration: underline; | |
} | |
a:visited { | |
color: fuchsia; | |
} | |
em { | |
font-style: italic; | |
color: navy; | |
} | |
strong { | |
font-weight: bold; | |
color: #083194; | |
} | |
tt { | |
color: navy; | |
} | |
h1, h2, h3, h4, h5, h6 { | |
color: #527bbd; | |
font-family: sans-serif; | |
margin-top: 1.2em; | |
margin-bottom: 0.5em; | |
line-height: 1.3; | |
} | |
h1, h2, h3 { | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
padding-top: 0.5em; | |
} | |
h3 { | |
float: left; | |
} | |
h3 + * { | |
clear: left; | |
} | |
div.sectionbody { | |
font-family: serif; | |
margin-left: 0; | |
} | |
hr { | |
border: 1px solid silver; | |
} | |
p { | |
margin-top: 0.5em; | |
margin-bottom: 0.5em; | |
} | |
ul, ol, li > p { | |
margin-top: 0; | |
} | |
pre { | |
padding: 0; | |
margin: 0; | |
} | |
span#author { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
font-size: 1.1em; | |
} | |
span#email { | |
} | |
span#revnumber, span#revdate, span#revremark { | |
font-family: sans-serif; | |
} | |
div#footer { | |
font-family: sans-serif; | |
font-size: small; | |
border-top: 2px solid silver; | |
padding-top: 0.5em; | |
margin-top: 4.0em; | |
} | |
div#footer-text { | |
float: left; | |
padding-bottom: 0.5em; | |
} | |
div#footer-badges { | |
float: right; | |
padding-bottom: 0.5em; | |
} | |
div#preamble { | |
margin-top: 1.5em; | |
margin-bottom: 1.5em; | |
} | |
div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
div.admonitionblock { | |
margin-top: 1.0em; | |
margin-bottom: 1.5em; | |
} | |
div.admonitionblock { | |
margin-top: 2.0em; | |
margin-bottom: 2.0em; | |
margin-right: 10%; | |
color: #606060; | |
} | |
div.content { /* Block element content. */ | |
padding: 0; | |
} | |
/* Block element titles. */ | |
div.title, caption.title { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
text-align: left; | |
margin-top: 1.0em; | |
margin-bottom: 0.5em; | |
} | |
div.title + * { | |
margin-top: 0; | |
} | |
td div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content + div.title { | |
margin-top: 0.0em; | |
} | |
div.sidebarblock > div.content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.listingblock > div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock, div.verseblock { | |
padding-left: 1.0em; | |
margin-left: 1.0em; | |
margin-right: 10%; | |
border-left: 5px solid #dddddd; | |
color: #777777; | |
} | |
div.quoteblock > div.attribution { | |
padding-top: 0.5em; | |
text-align: right; | |
} | |
div.verseblock > div.content { | |
white-space: pre; | |
} | |
div.verseblock > div.attribution { | |
padding-top: 0.75em; | |
text-align: left; | |
} | |
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
div.verseblock + div.attribution { | |
text-align: left; | |
} | |
div.admonitionblock .icon { | |
vertical-align: top; | |
font-size: 1.1em; | |
font-weight: bold; | |
text-decoration: underline; | |
color: #527bbd; | |
padding-right: 0.5em; | |
} | |
div.admonitionblock td.content { | |
padding-left: 0.5em; | |
border-left: 3px solid #dddddd; | |
} | |
div.exampleblock > div.content { | |
border-left: 3px solid #dddddd; | |
padding-left: 0.5em; | |
} | |
div.imageblock div.content { padding-left: 0; } | |
span.image img { border-style: none; } | |
a.image:visited { color: white; } | |
dl { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
dt { | |
margin-top: 0.5em; | |
margin-bottom: 0; | |
font-style: normal; | |
color: navy; | |
} | |
dd > *:first-child { | |
margin-top: 0.1em; | |
} | |
ul, ol { | |
list-style-position: outside; | |
} | |
ol.arabic { | |
list-style-type: decimal; | |
} | |
ol.loweralpha { | |
list-style-type: lower-alpha; | |
} | |
ol.upperalpha { | |
list-style-type: upper-alpha; | |
} | |
ol.lowerroman { | |
list-style-type: lower-roman; | |
} | |
ol.upperroman { | |
list-style-type: upper-roman; | |
} | |
div.compact ul, div.compact ol, | |
div.compact p, div.compact p, | |
div.compact div, div.compact div { | |
margin-top: 0.1em; | |
margin-bottom: 0.1em; | |
} | |
div.tableblock > table { | |
border: 3px solid #527bbd; | |
} | |
thead, p.table.header { | |
font-family: sans-serif; | |
font-weight: bold; | |
} | |
tfoot { | |
font-weight: bold; | |
} | |
td > div.verse { | |
white-space: pre; | |
} | |
p.table { | |
margin-top: 0; | |
} | |
/* Because the table frame attribute is overriden by CSS in most browsers. */ | |
div.tableblock > table[frame="void"] { | |
border-style: none; | |
} | |
div.tableblock > table[frame="hsides"] { | |
border-left-style: none; | |
border-right-style: none; | |
} | |
div.tableblock > table[frame="vsides"] { | |
border-top-style: none; | |
border-bottom-style: none; | |
} | |
div.hdlist { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
div.hdlist tr { | |
padding-bottom: 15px; | |
} | |
dt.hdlist1.strong, td.hdlist1.strong { | |
font-weight: bold; | |
} | |
td.hdlist1 { | |
vertical-align: top; | |
font-style: normal; | |
padding-right: 0.8em; | |
color: navy; | |
} | |
td.hdlist2 { | |
vertical-align: top; | |
} | |
div.hdlist.compact tr { | |
margin: 0; | |
padding-bottom: 0; | |
} | |
.comment { | |
background: yellow; | |
} | |
.footnote, .footnoteref { | |
font-size: 0.8em; | |
} | |
span.footnote, span.footnoteref { | |
vertical-align: super; | |
} | |
#footnotes { | |
margin: 20px 0 20px 0; | |
padding: 7px 0 0 0; | |
} | |
#footnotes div.footnote { | |
margin: 0 0 5px 0; | |
} | |
#footnotes hr { | |
border: none; | |
border-top: 1px solid silver; | |
height: 1px; | |
text-align: left; | |
margin-left: 0; | |
width: 20%; | |
min-width: 100px; | |
} | |
@media print { | |
div#footer-badges { display: none; } | |
} | |
div#toc { | |
margin-bottom: 2.5em; | |
} | |
div#toctitle { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-size: 1.1em; | |
font-weight: bold; | |
margin-top: 1.0em; | |
margin-bottom: 0.1em; | |
} | |
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
margin-top: 0; | |
margin-bottom: 0; | |
} | |
div.toclevel2 { | |
margin-left: 2em; | |
font-size: 0.9em; | |
} | |
div.toclevel3 { | |
margin-left: 4em; | |
font-size: 0.9em; | |
} | |
div.toclevel4 { | |
margin-left: 6em; | |
font-size: 0.9em; | |
} | |
/* Overrides for manpage documents */ | |
h1 { | |
padding-top: 0.5em; | |
padding-bottom: 0.5em; | |
border-top: 2px solid silver; | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
border-style: none; | |
} | |
div.sectionbody { | |
margin-left: 5%; | |
} | |
@media print { | |
div#toc { display: none; } | |
} | |
/* Workarounds for IE6's broken and incomplete CSS2. */ | |
div.sidebar-content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.sidebar-title, div.image-title { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
margin-top: 0.0em; | |
margin-bottom: 0.5em; | |
} | |
div.listingblock div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock-attribution { | |
padding-top: 0.5em; | |
text-align: right; | |
} | |
div.verseblock-content { | |
white-space: pre; | |
} | |
div.verseblock-attribution { | |
padding-top: 0.75em; | |
text-align: left; | |
} | |
div.exampleblock-content { | |
border-left: 3px solid #dddddd; | |
padding-left: 0.5em; | |
} | |
/* IE6 sets dynamically generated links as visited. */ | |
div#toc a:visited { color: blue; } | |
</style> | |
<script type="text/javascript"> | |
/*<+'])'); | |
// Function that scans the DOM tree for header elements (the DOM2 | |
// nodeIterator API would be a better technique but not supported by all | |
// browsers). | |
var iterate = function (el) { | |
for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
var mo = re.exec(i.tagName); | |
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
} | |
iterate(i); | |
} | |
} | |
} | |
iterate(el); | |
return result; | |
} | |
var toc = document.getElementById("toc"); | |
var entries = tocEntries(document.getElementById("content"), toclevels); | |
for (var i = 0; i < entries.length; ++i) { | |
var entry = entries[i]; | |
if (entry.element.id == "") | |
entry.element.id = "_toc_" + i; | |
var a = document.createElement("a"); | |
a.href = "#" + entry.element.id; | |
a.appendChild(document.createTextNode(entry.text)); | |
var div = document.createElement("div"); | |
div.appendChild(a); | |
div.className = "toclevel" + entry.toclevel; | |
toc.appendChild(div); | |
} | |
if (entries.length == 0) | |
toc.parentNode.removeChild(toc); | |
}, | |
///////////////////////////////////////////////////////////////////// | |
// Footnotes generator | |
///////////////////////////////////////////////////////////////////// | |
/* Based on footnote generation code from: | |
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
*/ | |
footnotes: function () { | |
var cont = document.getElementById("content"); | |
var noteholder = document.getElementById("footnotes"); | |
var spans = cont.getElementsByTagName("span"); | |
var refs = {}; | |
var n = 0; | |
for (i=0; i<spans.length; i++) { | |
if (spans[i].className == "footnote") { | |
n++; | |
// Use [\s\S] in place of . so multi-line matches work. | |
// Because JavaScript has no s (dotall) regex flag. | |
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
noteholder.innerHTML += | |
"<div class='footnote' id='_footnote_" + n + "'>" + | |
"<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
n + "</a>. " + note + "</div>"; | |
spans[i].innerHTML = | |
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
"' title='View footnote' class='footnote'>" + n + "</a>]"; | |
var id =spans[i].getAttribute("id"); | |
if (id != null) refs["#"+id] = n; | |
} | |
} | |
if (n == 0) | |
noteholder.parentNode.removeChild(noteholder); | |
else { | |
// Process footnoterefs. | |
for (i=0; i<spans.length; i++) { | |
if (spans[i].className == "footnoteref") { | |
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
href = href.match(/#.*/)[0]; // Because IE return full URL. | |
n = refs[href]; | |
spans[i].innerHTML = | |
"[<a href='#_footnote_" + n + | |
"' title='View footnote' class='footnote'>" + n + "</a>]"; | |
} | |
} | |
} | |
} | |
} | |
/*]]>*/ | |
</script> | |
</head> | |
<body> | |
<div id="header"> | |
<h1> | |
git-for-each-ref(1) Manual Page | |
</h1> | |
<h2>NAME</h2> | |
<div class="sectionbody"> | |
<p>git-for-each-ref - | |
Output information on each ref | |
</p> | |
</div> | |
</div> | |
<div id="content"> | |
<h2 id="_synopsis">SYNOPSIS</h2> | |
<div class="sectionbody"> | |
<div class="verseblock"> | |
<div class="verseblock-content"><em>git for-each-ref</em> [--count=<count>] [--shell|--perl|--python|--tcl] | |
[(--sort=<key>)…] [--format=<format>] [<pattern>…]</div> | |
<div class="verseblock-attribution"> | |
</div></div> | |
</div> | |
<h2 id="_description">DESCRIPTION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Iterate over all refs that match <tt><pattern></tt> and show them | |
according to the given <tt><format></tt>, after sorting them according | |
to the given set of <tt><key></tt>. If <tt><count></tt> is given, stop after | |
showing that many refs. The interpolated values in <tt><format></tt> | |
can optionally be quoted as string literals in the specified | |
host language allowing their direct evaluation in that language.</p></div> | |
</div> | |
<h2 id="_options">OPTIONS</h2> | |
<div class="sectionbody"> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
<count> | |
</dt> | |
<dd> | |
<p> | |
By default the command shows all refs that match | |
<tt><pattern></tt>. This option makes it stop after showing | |
that many refs. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
<key> | |
</dt> | |
<dd> | |
<p> | |
A field name to sort on. Prefix <tt>-</tt> to sort in | |
descending order of the value. When unspecified, | |
<tt>refname</tt> is used. You may use the --sort=<key> option | |
multiple times, in which case the last key becomes the primary | |
key. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
<format> | |
</dt> | |
<dd> | |
<p> | |
A string that interpolates <tt>%(fieldname)</tt> from the | |
object pointed at by a ref being shown. If <tt>fieldname</tt> | |
is prefixed with an asterisk (<tt>*</tt>) and the ref points | |
at a tag object, the value for the field in the object | |
tag refers is used. When unspecified, defaults to | |
<tt>%(objectname) SPC %(objecttype) TAB %(refname)</tt>. | |
It also interpolates <tt>%%</tt> to <tt>%</tt>, and <tt>%xx</tt> where <tt>xx</tt> | |
are hex digits interpolates to character with hex code | |
<tt>xx</tt>; for example <tt>%00</tt> interpolates to <tt>\0</tt> (NUL), | |
<tt>%09</tt> to <tt>\t</tt> (TAB) and <tt>%0a</tt> to <tt>\n</tt> (LF). | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
<pattern>… | |
</dt> | |
<dd> | |
<p> | |
If one or more patterns are given, only refs are shown that | |
match against at least one pattern, either using fnmatch(3) or | |
literally, in the latter case matching completely or from the | |
beginning up to a slash. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--shell | |
</dt> | |
<dt class="hdlist1"> | |
--perl | |
</dt> | |
<dt class="hdlist1"> | |
--python | |
</dt> | |
<dt class="hdlist1"> | |
--tcl | |
</dt> | |
<dd> | |
<p> | |
If given, strings that substitute <tt>%(fieldname)</tt> | |
placeholders are quoted as string literals suitable for | |
the specified host language. This is meant to produce | |
a scriptlet that can directly be `eval`ed. | |
</p> | |
</dd> | |
</dl></div> | |
</div> | |
<h2 id="_field_names">FIELD NAMES</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Various values from structured fields in referenced objects can | |
be used to interpolate into the resulting output, or as sort | |
keys.</p></div> | |
<div class="paragraph"><p>For all objects, the following names can be used:</p></div> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
refname | |
</dt> | |
<dd> | |
<p> | |
The name of the ref (the part after $GIT_DIR/). | |
For a non-ambiguous short name of the ref append <tt>:short</tt>. | |
The option core.warnAmbiguousRefs is used to select the strict | |
abbreviation mode. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
objecttype | |
</dt> | |
<dd> | |
<p> | |
The type of the object (<tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>, <tt>tag</tt>). | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
objectsize | |
</dt> | |
<dd> | |
<p> | |
The size of the object (the same as <em>git cat-file -s</em> reports). | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
objectname | |
</dt> | |
<dd> | |
<p> | |
The object name (aka SHA-1). | |
For a non-ambiguous abbreviation of the object name append <tt>:short</tt>. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
upstream | |
</dt> | |
<dd> | |
<p> | |
The name of a local ref which can be considered <tt>`upstream'' | |
from the displayed ref. Respects `:short</tt> in the same way as | |
<tt>refname</tt> above. | |
</p> | |
</dd> | |
</dl></div> | |
<div class="paragraph"><p>In addition to the above, for commit and tag objects, the header | |
field names (<tt>tree</tt>, <tt>parent</tt>, <tt>object</tt>, <tt>type</tt>, and <tt>tag</tt>) can | |
be used to specify the value in the header field.</p></div> | |
<div class="paragraph"><p>Fields that have name-email-date tuple as its value (<tt>author</tt>, | |
<tt>committer</tt>, and <tt>tagger</tt>) can be suffixed with <tt>name</tt>, <tt>email</tt>, | |
and <tt>date</tt> to extract the named component.</p></div> | |
<div class="paragraph"><p>The complete message in a commit and tag object is <tt>contents</tt>. | |
Its first line is <tt>contents:subject</tt>, the remaining lines | |
are <tt>contents:body</tt> and the optional GPG signature | |
is <tt>contents:signature</tt>.</p></div> | |
<div class="paragraph"><p>For sorting purposes, fields with numeric values sort in numeric | |
order (<tt>objectsize</tt>, <tt>authordate</tt>, <tt>committerdate</tt>, <tt>taggerdate</tt>). | |
All other fields are used to sort in their byte-value order.</p></div> | |
<div class="paragraph"><p>In any case, a field name that refers to a field inapplicable to | |
the object referred by the ref does not cause an error. It | |
returns an empty string instead.</p></div> | |
<div class="paragraph"><p>As a special case for the date-type fields, you may specify a format for | |
the date by adding one of <tt>:default</tt>, <tt>:relative</tt>, <tt>:short</tt>, <tt>:local</tt>, | |
<tt>:iso8601</tt> or <tt>:rfc2822</tt> to the end of the fieldname; e.g. | |
<tt>%(taggerdate:relative)</tt>.</p></div> | |
</div> | |
<h2 id="_examples">EXAMPLES</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>An example directly producing formatted text. Show the most recent | |
3 tagged commits:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt>#!/bin/sh | |
git for-each-ref --count=3 --sort='-*authordate' \ | |
--format='From: %(*authorname) %(*authoremail) | |
Subject: %(*subject) | |
Date: %(*authordate) | |
Ref: %(*refname) | |
%(*body) | |
' 'refs/tags'</tt></pre> | |
</div></div> | |
<div class="paragraph"><p>A simple example showing the use of shell eval on the output, | |
demonstrating the use of --shell. List the prefixes of all heads:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt>#!/bin/sh | |
git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ | |
while read entry | |
do | |
eval "$entry" | |
echo `dirname $ref` | |
done</tt></pre> | |
</div></div> | |
<div class="paragraph"><p>A bit more elaborate report on tags, demonstrating that the format | |
may be an entire script:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt>#!/bin/sh | |
fmt=' | |
r=%(refname) | |
t=%(*objecttype) | |
T=${r#refs/tags/} | |
o=%(*objectname) | |
n=%(*authorname) | |
e=%(*authoremail) | |
s=%(*subject) | |
d=%(*authordate) | |
b=%(*body) | |
kind=Tag | |
if test "z$t" = z | |
then | |
# could be a lightweight tag | |
t=%(objecttype) | |
kind="Lightweight tag" | |
o=%(objectname) | |
n=%(authorname) | |
e=%(authoremail) | |
s=%(subject) | |
d=%(authordate) | |
b=%(body) | |
fi | |
echo "$kind $T points at a $t object $o" | |
if test "z$t" = zcommit | |
then | |
echo "The commit was authored by $n $e | |
at $d, and titled | |
$s | |
Its message reads as: | |
" | |
echo "$b" | sed -e "s/^/ /" | |
echo | |
fi | |
' | |
eval=`git for-each-ref --shell --format="$fmt" \ | |
--sort='*objecttype' \ | |
--sort=-taggerdate \ | |
refs/tags` | |
eval "$eval"</tt></pre> | |
</div></div> | |
</div> | |
<h2 id="_author">Author</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Written by Junio C Hamano <<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>>.</p></div> | |
</div> | |
<h2 id="_documentation">Documentation</h2> | |
<div class="sectionbody"> | |
<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> | |
</div> | |
<h2 id="_git">GIT</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
</div> | |
</div> | |
<div id="footnotes"><hr /></div> | |
<div id="footer"> | |
<div id="footer-text"> | |
Last updated 2011-11-15 13:45:02 PDT | |
</div> | |
</div> | |
</body> | |
</html> |