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">
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 */
14 font-family: Georgia,serif;
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
22 #author, #revnumber, #revdate, #revremark,
24 font-family: Arial,Helvetica,sans-serif;
28 margin:
1em
5%
1em
5%;
33 text-decoration: underline;
49 h1, h2, h3, h4, h5, h6 {
57 border-bottom:
2px solid silver;
77 border:
1px solid silver;
88 ul
> li { color: #aaa; }
89 ul
> li
> * { color: black; }
91 .monospaced, code, pre {
92 font-family:
"Courier New", Courier, monospace;
99 white-space: pre-wrap;
109 #revnumber, #revdate, #revremark {
114 border-top:
2px solid silver;
120 padding-bottom:
0.5em;
124 padding-bottom:
0.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 {
135 margin-bottom:
1.5em;
137 div.admonitionblock {
139 margin-bottom:
2.0em;
144 div.content { /* Block element content. */
148 /* Block element titles. */
149 div.title, caption.title {
154 margin-bottom:
0.5em;
160 td div.title:first-child {
163 div.content div.title:first-child {
166 div.content + div.title {
170 div.sidebarblock
> div.content {
172 border:
1px solid #dddddd;
173 border-left:
4px solid #f0f0f0;
177 div.listingblock
> div.content {
178 border:
1px solid #dddddd;
179 border-left:
5px solid #f0f0f0;
184 div.quoteblock, div.verseblock {
188 border-left:
5px solid #f0f0f0;
192 div.quoteblock
> div.attribution {
197 div.verseblock
> pre.content {
198 font-family: inherit;
201 div.verseblock
> div.attribution {
205 /* DEPRECATED: Pre version
8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
210 div.admonitionblock .icon {
214 text-decoration: underline;
216 padding-right:
0.5em;
218 div.admonitionblock td.content {
220 border-left:
3px solid #dddddd;
223 div.exampleblock
> div.content {
224 border-left:
3px solid #dddddd;
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; }
234 margin-bottom:
0.8em;
247 list-style-position: outside;
250 list-style-type: decimal;
253 list-style-type: lower-alpha;
256 list-style-type: upper-alpha;
259 list-style-type: lower-roman;
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 {
269 margin-bottom:
0.1em;
281 margin-bottom:
0.8em;
284 padding-bottom:
15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
292 padding-right:
0.8em;
298 div.hdlist.compact tr {
307 .footnote, .footnoteref {
311 span.footnote, span.footnoteref {
312 vertical-align: super;
316 margin:
20px
0 20px
0;
320 #footnotes div.footnote {
326 border-top:
1px solid silver;
335 padding-right:
0.5em;
336 padding-bottom:
0.3em;
344 #footer-badges { display: none; }
348 margin-bottom:
2.5em;
356 margin-bottom:
0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
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; }
427 margin-bottom:
1.5em;
429 div.tableblock
> table {
430 border:
3px solid #
527bbd;
432 thead, p.table.header {
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock
> table[
frame=
"void"] {
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;
460 margin-bottom:
1.5em;
462 thead, p.tableblock.header {
473 border-color: #
527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
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 {
498 th.tableblock.halign-center, td.tableblock.halign-center {
501 th.tableblock.halign-right, td.tableblock.halign-right {
505 th.tableblock.valign-top, td.tableblock.valign-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;
523 padding-bottom:
0.5em;
524 border-top:
2px solid silver;
525 border-bottom:
2px solid silver;
530 body.manpage div.sectionbody {
535 body.manpage div#toc { display: none; }
540 <script type=
"text/javascript">
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
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 */
562 toc: function (toclevels) {
564 function getText(el) {
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType ==
3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 else if (i.firstChild != null)
575 function TocEntry(el, text, toclevel) {
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
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);
602 var toc = document.getElementById(
"toc");
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
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");
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.
651 var noteholder = document.getElementById(
"footnotes");
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");
670 for (i=
0; i
<spans.length; i++) {
671 if (spans[i].className ==
"footnote") {
673 var note = spans[i].getAttribute(
"data-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];
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;
692 noteholder.parentNode.removeChild(noteholder);
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.
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n +
"</a>]";
708 install: function(toclevels) {
711 function reinstall() {
712 asciidoc.footnotes();
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
723 timerId = setInterval(reinstall,
500);
724 if (document.addEventListener)
725 document.addEventListener(
"DOMContentLoaded", reinstallAndRemoveTimer, false);
727 window.onload = reinstallAndRemoveTimer;
735 <body class=
"manpage">
738 git-show-ref(
1) Manual Page
741 <div class=
"sectionbody">
743 List references in a local repository
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[=
<n
>]] [--abbrev[=
<n
>]] [--tags]
754 [--heads] [--] [
<pattern
>…]
755 <em>git show-ref
</em> --verify [-q | --quiet] [-d | --dereference]
756 [-s | --hash[=
<n
>]] [--abbrev[=
<n
>]]
757 [--] [
<ref
>…]
758 <em>git show-ref
</em> --exclude-existing[=
<pattern
>]
759 <em>git show-ref
</em> --exists
<ref
></pre>
760 <div class=
"attribution">
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
’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>
783 <h2 id=
"_options">OPTIONS
</h2>
784 <div class=
"sectionbody">
785 <div class=
"dlist"><dl>
791 Show the HEAD reference, even if it would normally be filtered out.
802 Limit to
"refs/heads" and
"refs/tags", respectively. These options
803 are not mutually exclusive; when given both, references stored in
804 "refs/heads" and
"refs/tags" are displayed.
815 Dereference tags into object IDs as well. They will be shown with
<code>^{}
</code>
827 Only show the OID, not the reference name. When combined with
828 <code>--dereference
</code>, the dereferenced tag will still be shown after the OID.
836 Enable stricter reference checking by requiring an exact ref path.
837 Aside from returning an error code of
1, it will also print an error
838 message if
<code>--quiet
</code> was not specified.
846 Check whether the given reference exists. Returns an exit code of
0 if
847 it does,
2 if it is missing, and
1 in case looking up the reference
848 failed with an error other than the reference being missing.
856 Abbreviate the object name. When using
<code>--hash
</code>, you do
857 not have to say
<code>--hash --abbrev
</code>;
<code>--hash=n
</code> would do.
868 Do not print any results to stdout. Can be used with
<code>--verify
</code> to
869 silently check if a reference exists.
873 --exclude-existing[=
<pattern
>]
877 Make
<code>git show-ref
</code> act as a filter that reads refs from stdin of the
878 form
<code>^(?:
<anything
>\s)?
<refname
>(?:\^{})?$
</code>
879 and performs the following actions on each:
880 (
1) strip
<code>^{}
</code> at the end of line if any;
881 (
2) ignore if pattern is provided and does not head-match refname;
882 (
3) warn if refname is not a well-formed refname and skip;
883 (
4) ignore if refname is a ref that exists in the local repository;
884 (
5) otherwise output the line.
888 <pattern
>…
892 Show references matching one or more patterns. Patterns are matched from
893 the end of the full name, and only complete parts are matched, e.g.
894 <em>master
</em> matches
<em>refs/heads/master
</em>,
<em>refs/remotes/origin/master
</em>,
895 <em>refs/tags/jedi/master
</em> but not
<em>refs/heads/mymaster
</em> or
896 <em>refs/remotes/master/jedi
</em>.
903 <h2 id=
"_output">OUTPUT
</h2>
904 <div class=
"sectionbody">
905 <div class=
"paragraph"><p>The output is in the format:
</p></div>
906 <div class=
"listingblock">
907 <div class=
"content">
908 <pre><code><oid
> SP
<ref
> LF
</code></pre>
910 <div class=
"paragraph"><p>For example,
</p></div>
911 <div class=
"listingblock">
912 <div class=
"content">
913 <pre><code>$ git show-ref --head --dereference
914 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
915 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
916 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
917 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99
.9c
918 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99
.9c^{}
919 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4
920 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{}
923 <div class=
"paragraph"><p>When using
<code>--hash
</code> (and not
<code>--dereference
</code>), the output is in the format:
</p></div>
924 <div class=
"listingblock">
925 <div class=
"content">
926 <pre><code><oid
> LF
</code></pre>
928 <div class=
"paragraph"><p>For example,
</p></div>
929 <div class=
"listingblock">
930 <div class=
"content">
931 <pre><code>$ git show-ref --heads --hash
932 2e3ba0114a1f52b47df29743d6915d056be13278
933 185008ae97960c8d551adcd9e23565194651b5d1
934 03adf42c988195b50e1a1935ba5fcbc39b2b029b
940 <h2 id=
"_examples">EXAMPLES
</h2>
941 <div class=
"sectionbody">
942 <div class=
"paragraph"><p>To show all references called
"master", whether tags or heads or anything
943 else, and regardless of how deep in the reference naming hierarchy they are,
945 <div class=
"listingblock">
946 <div class=
"content">
947 <pre><code> git show-ref master
</code></pre>
949 <div class=
"paragraph"><p>This will show
"refs/heads/master" but also
"refs/remote/other-repo/master",
950 if such references exist.
</p></div>
951 <div class=
"paragraph"><p>When using the
<code>--verify
</code> flag, the command requires an exact path:
</p></div>
952 <div class=
"listingblock">
953 <div class=
"content">
954 <pre><code> git show-ref --verify refs/heads/master
</code></pre>
956 <div class=
"paragraph"><p>will only match the exact branch called
"master".
</p></div>
957 <div class=
"paragraph"><p>If nothing matches,
<code>git show-ref
</code> will return an error code of
1,
958 and in the case of verification, it will show an error message.
</p></div>
959 <div class=
"paragraph"><p>For scripting, you can ask it to be quiet with the
<code>--quiet
</code> flag, which
960 allows you to do things like
</p></div>
961 <div class=
"listingblock">
962 <div class=
"content">
963 <pre><code> git show-ref --quiet --verify --
"refs/heads/$headname" ||
964 echo
"$headname is not a valid branch"</code></pre>
966 <div class=
"paragraph"><p>to check whether a particular branch exists or not (notice how we don
’t
967 actually want to show any results, and we want to use the full refname for it
968 in order to not trigger the problem with ambiguous partial matches).
</p></div>
969 <div class=
"paragraph"><p>To show only tags, or only proper branch heads, use
<code>--tags
</code> and/or
<code>--heads
</code>
970 respectively (using both means that it shows tags and heads, but not other
971 random references under the refs/ subdirectory).
</p></div>
972 <div class=
"paragraph"><p>To do automatic tag object dereferencing, use the
<code>-d
</code> or
<code>--dereference
</code>
973 flag, so you can do
</p></div>
974 <div class=
"listingblock">
975 <div class=
"content">
976 <pre><code> git show-ref --tags --dereference
</code></pre>
978 <div class=
"paragraph"><p>to get a listing of all tags together with what they dereference.
</p></div>
982 <h2 id=
"_files">FILES
</h2>
983 <div class=
"sectionbody">
984 <div class=
"paragraph"><p><code>.git/refs/*
</code>,
<code>.git/packed-refs
</code></p></div>
988 <h2 id=
"_see_also">SEE ALSO
</h2>
989 <div class=
"sectionbody">
990 <div class=
"paragraph"><p><a href=
"git-for-each-ref.html">git-for-each-ref(
1)
</a>,
991 <a href=
"git-ls-remote.html">git-ls-remote(
1)
</a>,
992 <a href=
"git-update-ref.html">git-update-ref(
1)
</a>,
993 <a href=
"gitrepository-layout.html">gitrepository-layout(
5)
</a></p></div>
997 <h2 id=
"_git">GIT
</h2>
998 <div class=
"sectionbody">
999 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
1003 <div id=
"footnotes"><hr /></div>
1005 <div id=
"footer-text">
1007 2023-
11-
08 09:
04:
31 PST