Google Git
Sign in
chromium / external / gitster / git-htmldocs / 4060a6a703de464eb99764be3a8ca46c6a2b42e7 / . / git-show-ref.html
blob: c64a4369d8e2f674e2860855ac8cedd54be45096 [file] [log] [blame]
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]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" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]306</style>
307<title>git-show-ref(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-show-ref(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-show-ref -
317 List references in a local repository
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
323<div class="verseblock">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]324<div class="content"><em>git show-ref</em> [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
Junio C Hamanoc3f1dbf2007-04-10 21:31:32[diff] [blame]325 [-s|--hash] [--abbrev] [--tags] [--heads] [--] &lt;pattern&gt;&#8230;
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]326<em>git show-ref</em> --exclude-existing[=pattern]</div></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]327</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]328<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]329<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]330<div class="para"><p>Displays references available in a local repository along with the associated
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]331commit IDs. Results can be filtered using a pattern and tags can be
332dereferenced into object IDs. Additionally, it can be used to test whether a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]333particular ref exists.</p></div>
334<div class="para"><p>The --exclude-existing form is a filter that does the inverse, it shows the
335refs from stdin that don't exist in the local repository.</p></div>
336<div class="para"><p>Use of this utility is encouraged in favor of directly accessing files under
337in the <tt>.git</tt> directory.</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]338</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]339<h2 id="_options">OPTIONS</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]340<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341<div class="vlist"><dl>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]342<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]343-h
344</dt>
345<dt>
346--head
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]347</dt>
348<dd>
349<p>
350 Show the HEAD reference.
351</p>
352</dd>
353<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]354--tags
355</dt>
356<dt>
357--heads
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]358</dt>
359<dd>
360<p>
361 Limit to only "refs/heads" and "refs/tags", respectively. These
362 options are not mutually exclusive; when given both, references stored
363 in "refs/heads" and "refs/tags" are displayed.
364</p>
365</dd>
366<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]367-d
368</dt>
369<dt>
370--dereference
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]371</dt>
372<dd>
373<p>
374 Dereference tags into object IDs as well. They will be shown with "^{}"
375 appended.
376</p>
377</dd>
378<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]379-s
380</dt>
381<dt>
382--hash
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]383</dt>
384<dd>
385<p>
386 Only show the SHA1 hash, not the reference name. When also using
387 --dereference the dereferenced tag will still be shown after the SHA1.
388</p>
389</dd>
390<dt>
391--verify
392</dt>
393<dd>
394<p>
395 Enable stricter reference checking by requiring an exact ref path.
396 Aside from returning an error code of 1, it will also print an error
397 message if <em>--quiet</em> was not specified.
398</p>
399</dd>
400<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]401--abbrev
402</dt>
403<dt>
404--abbrev=len
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]405</dt>
406<dd>
407<p>
408 Abbreviate the object name. When using <tt>--hash</tt>, you do
409 not have to say <tt>--hash --abbrev</tt>; <tt>--hash=len</tt> would do.
410</p>
411</dd>
412<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]413-q
414</dt>
415<dt>
416--quiet
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]417</dt>
418<dd>
419<p>
420 Do not print any results to stdout. When combined with <em>--verify</em> this
421 can be used to silently check if a reference exists.
422</p>
423</dd>
424<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]425--exclude-existing
426</dt>
427<dt>
428--exclude-existing=pattern
Junio C Hamanoc3f1dbf2007-04-10 21:31:32[diff] [blame]429</dt>
430<dd>
431<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432 Make <em>git-show-ref</em> act as a filter that reads refs from stdin of the
Junio C Hamanoc3f1dbf2007-04-10 21:31:32[diff] [blame]433 form "<sup>(?:&lt;anything&gt;\s)?&lt;refname&gt;(?:\</sup>{})?$" and performs the
434 following actions on each:
435 (1) strip "^{}" at the end of line if any;
436 (2) ignore if pattern is provided and does not head-match refname;
437 (3) warn if refname is not a well-formed refname and skip;
438 (4) ignore if refname is a ref that exists in the local repository;
439 (5) otherwise output the line.
440</p>
441</dd>
442<dt>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]443&lt;pattern&gt;&#8230;
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]444</dt>
445<dd>
446<p>
447 Show references matching one or more patterns.
448</p>
449</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]450</dl></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]451</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]452<h2 id="_output">OUTPUT</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]453<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]454<div class="para"><p>The output is in the format: <em>&lt;SHA-1 ID&gt;</em> <em>&lt;space&gt;</em> <em>&lt;reference name&gt;</em>.</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]455<div class="listingblock">
456<div class="content">
457<pre><tt>$ git show-ref --head --dereference
458832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
459832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
460832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
4613521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
4626ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
463055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
464423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
465...</tt></pre>
466</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]467<div class="para"><p>When using --hash (and not --dereference) the output format is: <em>&lt;SHA-1 ID&gt;</em></p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]468<div class="listingblock">
469<div class="content">
470<pre><tt>$ git show-ref --heads --hash
4712e3ba0114a1f52b47df29743d6915d056be13278
472185008ae97960c8d551adcd9e23565194651b5d1
47303adf42c988195b50e1a1935ba5fcbc39b2b029b
474...</tt></pre>
475</div></div>
476</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]477<h2 id="_example">EXAMPLE</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]478<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]479<div class="para"><p>To show all references called "master", whether tags or heads or anything
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]480else, and regardless of how deep in the reference naming hierarchy they are,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]481use:</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]482<div class="listingblock">
483<div class="content">
484<pre><tt> git show-ref master</tt></pre>
485</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]486<div class="para"><p>This will show "refs/heads/master" but also "refs/remote/other-repo/master",
487if such references exists.</p></div>
488<div class="para"><p>When using the <em>--verify</em> flag, the command requires an exact path:</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]489<div class="listingblock">
490<div class="content">
491<pre><tt> git show-ref --verify refs/heads/master</tt></pre>
492</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]493<div class="para"><p>will only match the exact branch called "master".</p></div>
494<div class="para"><p>If nothing matches, <em>git-show-ref</em> will return an error code of 1,
495and in the case of verification, it will show an error message.</p></div>
496<div class="para"><p>For scripting, you can ask it to be quiet with the "--quiet" flag, which
497allows you to do things like</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]498<div class="listingblock">
499<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]500<pre><tt> git show-ref --quiet --verify -- "refs/heads/$headname" ||
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]501 echo "$headname is not a valid branch"</tt></pre>
502</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]503<div class="para"><p>to check whether a particular branch exists or not (notice how we don't
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]504actually want to show any results, and we want to use the full refname for it
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]505in order to not trigger the problem with ambiguous partial matches).</p></div>
506<div class="para"><p>To show only tags, or only proper branch heads, use "--tags" and/or "--heads"
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]507respectively (using both means that it shows tags and heads, but not other
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]508random references under the refs/ subdirectory).</p></div>
509<div class="para"><p>To do automatic tag object dereferencing, use the "-d" or "--dereference"
510flag, so you can do</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]511<div class="listingblock">
512<div class="content">
513<pre><tt> git show-ref --tags --dereference</tt></pre>
514</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]515<div class="para"><p>to get a listing of all tags together with what they dereference.</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]516</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]517<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]518<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]519<div class="para"><p><a href="git-ls-remote.html">git-ls-remote(1)</a></p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]520</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]521<h2 id="_authors">AUTHORS</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]522<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]523<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;.
524Man page by Jonas Fonseca &lt;fonseca@diku.dk&gt;.</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]525</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]526<h2 id="_git">GIT</h2>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]527<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]528<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]529</div>
530<div id="footer">
531<div id="footer-text">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]532Last updated 2008-09-19 06:33:13 UTC
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]533</div>
534</div>
535</body>
536</html>