Autogenerated HTML docs for v2.46.0-rc0-75-g04f5a5
[git-htmldocs.git] / git-show-ref.html
blobf4c0169914a9002f25afcfc4753874390fd681a2
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 10.2.0" />
8 <title>git-show-ref(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
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;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
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;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
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;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
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;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
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;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
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;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
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; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
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;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
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;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
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; }
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; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
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;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
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.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
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);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
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);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
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);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
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);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
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;
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);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
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);
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;
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>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-show-ref(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-show-ref -
743 List references in a local repository
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 show-ref</em> [--head] [-d | --dereference]
753 [-s | --hash[=&lt;n&gt;]] [--abbrev[=&lt;n&gt;]] [--branches] [--tags]
754 [--] [&lt;pattern&gt;&#8230;]
755 <em>git show-ref</em> --verify [-q | --quiet] [-d | --dereference]
756 [-s | --hash[=&lt;n&gt;]] [--abbrev[=&lt;n&gt;]]
757 [--] [&lt;ref&gt;&#8230;]
758 <em>git show-ref</em> --exclude-existing[=&lt;pattern&gt;]
759 <em>git show-ref</em> --exists &lt;ref&gt;</pre>
760 <div class="attribution">
761 </div></div>
762 </div>
763 </div>
764 <div class="sect1">
765 <h2 id="_description">DESCRIPTION</h2>
766 <div class="sectionbody">
767 <div class="paragraph"><p>Displays references available in a local repository along with the associated
768 commit IDs. Results can be filtered using a pattern and tags can be
769 dereferenced into object IDs. Additionally, it can be used to test whether a
770 particular ref exists.</p></div>
771 <div class="paragraph"><p>By default, shows the tags, heads, and remote refs.</p></div>
772 <div class="paragraph"><p>The <code>--exclude-existing</code> form is a filter that does the inverse. It reads
773 refs from stdin, one ref per line, and shows those that don&#8217;t exist in
774 the local repository.</p></div>
775 <div class="paragraph"><p>The <code>--exists</code> form can be used to check for the existence of a single
776 references. This form does not verify whether the reference resolves to an
777 actual object.</p></div>
778 <div class="paragraph"><p>Use of this utility is encouraged in favor of directly accessing files under
779 the <code>.git</code> directory.</p></div>
780 </div>
781 </div>
782 <div class="sect1">
783 <h2 id="_options">OPTIONS</h2>
784 <div class="sectionbody">
785 <div class="dlist"><dl>
786 <dt class="hdlist1">
787 --head
788 </dt>
789 <dd>
791 Show the HEAD reference, even if it would normally be filtered out.
792 </p>
793 </dd>
794 <dt class="hdlist1">
795 --branches
796 </dt>
797 <dt class="hdlist1">
798 --tags
799 </dt>
800 <dd>
802 Limit to local branches and local tags, respectively. These options
803 are not mutually exclusive; when given both, references stored in
804 "refs/heads" and "refs/tags" are displayed. Note that <code>--heads</code>
805 is a deprecated synonym for <code>--branches</code> and may be removed
806 in the future.
807 </p>
808 </dd>
809 <dt class="hdlist1">
811 </dt>
812 <dt class="hdlist1">
813 --dereference
814 </dt>
815 <dd>
817 Dereference tags into object IDs as well. They will be shown with <code>^{}</code>
818 appended.
819 </p>
820 </dd>
821 <dt class="hdlist1">
823 </dt>
824 <dt class="hdlist1">
825 --hash[=&lt;n&gt;]
826 </dt>
827 <dd>
829 Only show the OID, not the reference name. When combined with
830 <code>--dereference</code>, the dereferenced tag will still be shown after the OID.
831 </p>
832 </dd>
833 <dt class="hdlist1">
834 --verify
835 </dt>
836 <dd>
838 Enable stricter reference checking by requiring an exact ref path.
839 Aside from returning an error code of 1, it will also print an error
840 message if <code>--quiet</code> was not specified.
841 </p>
842 </dd>
843 <dt class="hdlist1">
844 --exists
845 </dt>
846 <dd>
848 Check whether the given reference exists. Returns an exit code of 0 if
849 it does, 2 if it is missing, and 1 in case looking up the reference
850 failed with an error other than the reference being missing.
851 </p>
852 </dd>
853 <dt class="hdlist1">
854 --abbrev[=&lt;n&gt;]
855 </dt>
856 <dd>
858 Abbreviate the object name. When using <code>--hash</code>, you do
859 not have to say <code>--hash --abbrev</code>; <code>--hash=n</code> would do.
860 </p>
861 </dd>
862 <dt class="hdlist1">
864 </dt>
865 <dt class="hdlist1">
866 --quiet
867 </dt>
868 <dd>
870 Do not print any results to stdout. Can be used with <code>--verify</code> to
871 silently check if a reference exists.
872 </p>
873 </dd>
874 <dt class="hdlist1">
875 --exclude-existing[=&lt;pattern&gt;]
876 </dt>
877 <dd>
879 Make <code>git show-ref</code> act as a filter that reads refs from stdin of the
880 form <code>^(?:&lt;anything&gt;\s)?&lt;refname&gt;(?:\^{})?$</code>
881 and performs the following actions on each:
882 (1) strip <code>^{}</code> at the end of line if any;
883 (2) ignore if pattern is provided and does not head-match refname;
884 (3) warn if refname is not a well-formed refname and skip;
885 (4) ignore if refname is a ref that exists in the local repository;
886 (5) otherwise output the line.
887 </p>
888 </dd>
889 <dt class="hdlist1">
890 &lt;pattern&gt;&#8230;
891 </dt>
892 <dd>
894 Show references matching one or more patterns. Patterns are matched from
895 the end of the full name, and only complete parts are matched, e.g.
896 <em>master</em> matches <em>refs/heads/master</em>, <em>refs/remotes/origin/master</em>,
897 <em>refs/tags/jedi/master</em> but not <em>refs/heads/mymaster</em> or
898 <em>refs/remotes/master/jedi</em>.
899 </p>
900 </dd>
901 </dl></div>
902 </div>
903 </div>
904 <div class="sect1">
905 <h2 id="_output">OUTPUT</h2>
906 <div class="sectionbody">
907 <div class="paragraph"><p>The output is in the format:</p></div>
908 <div class="listingblock">
909 <div class="content">
910 <pre><code>&lt;oid&gt; SP &lt;ref&gt; LF</code></pre>
911 </div></div>
912 <div class="paragraph"><p>For example,</p></div>
913 <div class="listingblock">
914 <div class="content">
915 <pre><code>$ git show-ref --head --dereference
916 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
917 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
918 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
919 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c
920 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{}
921 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
922 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
923 ...</code></pre>
924 </div></div>
925 <div class="paragraph"><p>When using <code>--hash</code> (and not <code>--dereference</code>), the output is in the format:</p></div>
926 <div class="listingblock">
927 <div class="content">
928 <pre><code>&lt;oid&gt; LF</code></pre>
929 </div></div>
930 <div class="paragraph"><p>For example,</p></div>
931 <div class="listingblock">
932 <div class="content">
933 <pre><code>$ git show-ref --branches --hash
934 2e3ba0114a1f52b47df29743d6915d056be13278
935 185008ae97960c8d551adcd9e23565194651b5d1
936 03adf42c988195b50e1a1935ba5fcbc39b2b029b
937 ...</code></pre>
938 </div></div>
939 </div>
940 </div>
941 <div class="sect1">
942 <h2 id="_examples">EXAMPLES</h2>
943 <div class="sectionbody">
944 <div class="paragraph"><p>To show all references called "master", whether tags or heads or anything
945 else, and regardless of how deep in the reference naming hierarchy they are,
946 use:</p></div>
947 <div class="listingblock">
948 <div class="content">
949 <pre><code> git show-ref master</code></pre>
950 </div></div>
951 <div class="paragraph"><p>This will show "refs/heads/master" but also "refs/remote/other-repo/master",
952 if such references exist.</p></div>
953 <div class="paragraph"><p>When using the <code>--verify</code> flag, the command requires an exact path:</p></div>
954 <div class="listingblock">
955 <div class="content">
956 <pre><code> git show-ref --verify refs/heads/master</code></pre>
957 </div></div>
958 <div class="paragraph"><p>will only match the exact branch called "master".</p></div>
959 <div class="paragraph"><p>If nothing matches, <code>git show-ref</code> will return an error code of 1,
960 and in the case of verification, it will show an error message.</p></div>
961 <div class="paragraph"><p>For scripting, you can ask it to be quiet with the <code>--quiet</code> flag, which
962 allows you to do things like</p></div>
963 <div class="listingblock">
964 <div class="content">
965 <pre><code> git show-ref --quiet --verify -- "refs/heads/$headname" ||
966 echo "$headname is not a valid branch"</code></pre>
967 </div></div>
968 <div class="paragraph"><p>to check whether a particular branch exists or not (notice how we don&#8217;t
969 actually want to show any results, and we want to use the full refname for it
970 in order to not trigger the problem with ambiguous partial matches).</p></div>
971 <div class="paragraph"><p>To show only tags, or only proper branch heads, use <code>--tags</code> and/or <code>--branches</code>
972 respectively (using both means that it shows tags and branches, but not other
973 random references under the refs/ subdirectory).</p></div>
974 <div class="paragraph"><p>To do automatic tag object dereferencing, use the <code>-d</code> or <code>--dereference</code>
975 flag, so you can do</p></div>
976 <div class="listingblock">
977 <div class="content">
978 <pre><code> git show-ref --tags --dereference</code></pre>
979 </div></div>
980 <div class="paragraph"><p>to get a listing of all tags together with what they dereference.</p></div>
981 </div>
982 </div>
983 <div class="sect1">
984 <h2 id="_files">FILES</h2>
985 <div class="sectionbody">
986 <div class="paragraph"><p><code>.git/refs/*</code>, <code>.git/packed-refs</code></p></div>
987 </div>
988 </div>
989 <div class="sect1">
990 <h2 id="_see_also">SEE ALSO</h2>
991 <div class="sectionbody">
992 <div class="paragraph"><p><a href="git-for-each-ref.html">git-for-each-ref(1)</a>,
993 <a href="git-ls-remote.html">git-ls-remote(1)</a>,
994 <a href="git-update-ref.html">git-update-ref(1)</a>,
995 <a href="gitrepository-layout.html">gitrepository-layout(5)</a></p></div>
996 </div>
997 </div>
998 <div class="sect1">
999 <h2 id="_git">GIT</h2>
1000 <div class="sectionbody">
1001 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1002 </div>
1003 </div>
1004 </div>
1005 <div id="footnotes"><hr /></div>
1006 <div id="footer">
1007 <div id="footer-text">
1008 Last updated
1009 2024-06-20 16:27:24 PDT
1010 </div>
1011 </div>
1012 </body>
1013 </html>