man1/git-show-ref.1

   1 '\" t
   2 .\"     Title: git-show-ref
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 01/17/2023
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.39.1.231.ga7caae2729
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SHOW\-REF" "1" "01/17/2023" "Git 2\&.39\&.1\&.231\&.ga7caae" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-show-ref \- List references in a local repository
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit show\-ref\fR [\-q | \-\-quiet] [\-\-verify] [\-\-head] [\-d | \-\-dereference]
  36              [\-s | \-\-hash[=<n>]] [\-\-abbrev[=<n>]] [\-\-tags]
  37              [\-\-heads] [\-\-] [<pattern>\&...]
  38 \fIgit show\-ref\fR \-\-exclude\-existing[=<pattern>]
  39 .fi
  40 .sp
  41 .SH "DESCRIPTION"
  42 .sp
  43 Displays references available in a local repository along with the associated commit IDs\&. Results can be filtered using a pattern and tags can be dereferenced into object IDs\&. Additionally, it can be used to test whether a particular ref exists\&.
  44 .sp
  45 By default, shows the tags, heads, and remote refs\&.
  46 .sp
  47 The \-\-exclude\-existing form is a filter that does the inverse\&. It reads refs from stdin, one ref per line, and shows those that don\(cqt exist in the local repository\&.
  48 .sp
  49 Use of this utility is encouraged in favor of directly accessing files under the \fB\&.git\fR directory\&.
  50 .SH "OPTIONS"
  51 .PP
  52 \-\-head
  53 .RS 4
  54 Show the HEAD reference, even if it would normally be filtered out\&.
  55 .RE
  56 .PP
  57 \-\-heads, \-\-tags
  58 .RS 4
  59 Limit to "refs/heads" and "refs/tags", respectively\&. These options are not mutually exclusive; when given both, references stored in "refs/heads" and "refs/tags" are displayed\&.
  60 .RE
  61 .PP
  62 \-d, \-\-dereference
  63 .RS 4
  64 Dereference tags into object IDs as well\&. They will be shown with "^{}" appended\&.
  65 .RE
  66 .PP
  67 \-s, \-\-hash[=<n>]
  68 .RS 4
  69 Only show the SHA\-1 hash, not the reference name\&. When combined with \-\-dereference the dereferenced tag will still be shown after the SHA\-1\&.
  70 .RE
  71 .PP
  72 \-\-verify
  73 .RS 4
  74 Enable stricter reference checking by requiring an exact ref path\&. Aside from returning an error code of 1, it will also print an error message if
  75 \fB\-\-quiet\fR
  76 was not specified\&.
  77 .RE
  78 .PP
  79 \-\-abbrev[=<n>]
  80 .RS 4
  81 Abbreviate the object name\&. When using
  82 \fB\-\-hash\fR, you do not have to say
  83 \fB\-\-hash \-\-abbrev\fR;
  84 \fB\-\-hash=n\fR
  85 would do\&.
  86 .RE
  87 .PP
  88 \-q, \-\-quiet
  89 .RS 4
  90 Do not print any results to stdout\&. When combined with
  91 \fB\-\-verify\fR
  92 this can be used to silently check if a reference exists\&.
  93 .RE
  94 .PP
  95 \-\-exclude\-existing[=<pattern>]
  96 .RS 4
  97 Make
  98 \fIgit show\-ref\fR
  99 act as a filter that reads refs from stdin of the form "\fB^(?:<anything>\es)?<refname>(?:\e^{})?$\fR" and performs the following actions on each: (1) strip "^{}" at the end of line if any; (2) ignore if pattern is provided and does not head\-match refname; (3) warn if refname is not a well\-formed refname and skip; (4) ignore if refname is a ref that exists in the local repository; (5) otherwise output the line\&.
 100 .RE
 101 .PP
 102 <pattern>\&...
 103 .RS 4
 104 Show references matching one or more patterns\&. Patterns are matched from the end of the full name, and only complete parts are matched, e\&.g\&.
 105 \fImaster\fR
 106 matches
 107 \fIrefs/heads/master\fR,
 108 \fIrefs/remotes/origin/master\fR,
 109 \fIrefs/tags/jedi/master\fR
 110 but not
 111 \fIrefs/heads/mymaster\fR
 112 or
 113 \fIrefs/remotes/master/jedi\fR\&.
 114 .RE
 115 .SH "OUTPUT"
 116 .sp
 117 The output is in the format: \fI<SHA\-1 ID>\fR \fI<space>\fR \fI<reference name>\fR\&.
 118 .sp
 119 .if n \{\
 120 .RS 4
 121 .\}
 122 .nf
 123 $ git show\-ref \-\-head \-\-dereference
 124 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
 125 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
 126 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
 127 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0\&.99\&.9c
 128 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0\&.99\&.9c^{}
 129 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1\&.0rc4
 130 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1\&.0rc4^{}
 131 \&.\&.\&.
 132 .fi
 133 .if n \{\
 134 .RE
 135 .\}
 136 .sp
 137 .sp
 138 When using \-\-hash (and not \-\-dereference) the output format is: \fI<SHA\-1 ID>\fR
 139 .sp
 140 .if n \{\
 141 .RS 4
 142 .\}
 143 .nf
 144 $ git show\-ref \-\-heads \-\-hash
 145 2e3ba0114a1f52b47df29743d6915d056be13278
 146 185008ae97960c8d551adcd9e23565194651b5d1
 147 03adf42c988195b50e1a1935ba5fcbc39b2b029b
 148 \&.\&.\&.
 149 .fi
 150 .if n \{\
 151 .RE
 152 .\}
 153 .sp
 154 .SH "EXAMPLES"
 155 .sp
 156 To show all references called "master", whether tags or heads or anything else, and regardless of how deep in the reference naming hierarchy they are, use:
 157 .sp
 158 .if n \{\
 159 .RS 4
 160 .\}
 161 .nf
 162         git show\-ref master
 163 .fi
 164 .if n \{\
 165 .RE
 166 .\}
 167 .sp
 168 .sp
 169 This will show "refs/heads/master" but also "refs/remote/other\-repo/master", if such references exists\&.
 170 .sp
 171 When using the \fB\-\-verify\fR flag, the command requires an exact path:
 172 .sp
 173 .if n \{\
 174 .RS 4
 175 .\}
 176 .nf
 177         git show\-ref \-\-verify refs/heads/master
 178 .fi
 179 .if n \{\
 180 .RE
 181 .\}
 182 .sp
 183 .sp
 184 will only match the exact branch called "master"\&.
 185 .sp
 186 If nothing matches, \fIgit show\-ref\fR will return an error code of 1, and in the case of verification, it will show an error message\&.
 187 .sp
 188 For scripting, you can ask it to be quiet with the "\-\-quiet" flag, which allows you to do things like
 189 .sp
 190 .if n \{\
 191 .RS 4
 192 .\}
 193 .nf
 194         git show\-ref \-\-quiet \-\-verify \-\- "refs/heads/$headname" ||
 195                 echo "$headname is not a valid branch"
 196 .fi
 197 .if n \{\
 198 .RE
 199 .\}
 200 .sp
 201 .sp
 202 to check whether a particular branch exists or not (notice how we don\(cqt actually want to show any results, and we want to use the full refname for it in order to not trigger the problem with ambiguous partial matches)\&.
 203 .sp
 204 To show only tags, or only proper branch heads, use "\-\-tags" and/or "\-\-heads" respectively (using both means that it shows tags and heads, but not other random references under the refs/ subdirectory)\&.
 205 .sp
 206 To do automatic tag object dereferencing, use the "\-d" or "\-\-dereference" flag, so you can do
 207 .sp
 208 .if n \{\
 209 .RS 4
 210 .\}
 211 .nf
 212         git show\-ref \-\-tags \-\-dereference
 213 .fi
 214 .if n \{\
 215 .RE
 216 .\}
 217 .sp
 218 .sp
 219 to get a listing of all tags together with what they dereference\&.
 220 .SH "FILES"
 221 .sp
 222 \fB\&.git/refs/*\fR, \fB\&.git/packed\-refs\fR
 223 .SH "SEE ALSO"
 224 .sp
 225 \fBgit-for-each-ref\fR(1), \fBgit-ls-remote\fR(1), \fBgit-update-ref\fR(1), \fBgitrepository-layout\fR(5)
 226 .SH "GIT"
 227 .sp
 228 Part of the \fBgit\fR(1) suite