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 v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.506.ged155187b4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SHOW\-REF" "1" "2024-09-13" "Git 2\&.46\&.1\&.506\&.ged1551" "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 [\-\-head] [\-d | \-\-dereference]
  36              [\-s | \-\-hash[=<n>]] [\-\-abbrev[=<n>]] [\-\-branches] [\-\-tags]
  37              [\-\-] [<pattern>\&...\:]
  38 \fIgit show\-ref\fR \-\-verify [\-q | \-\-quiet] [\-d | \-\-dereference]
  39              [\-s | \-\-hash[=<n>]] [\-\-abbrev[=<n>]]
  40              [\-\-] [<ref>\&...\:]
  41 \fIgit show\-ref\fR \-\-exclude\-existing[=<pattern>]
  42 \fIgit show\-ref\fR \-\-exists <ref>
  43 .fi
  44 .SH "DESCRIPTION"
  45 .sp
  46 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\&.
  47 .sp
  48 By default, shows the tags, heads, and remote refs\&.
  49 .sp
  50 The \fB\-\-exclude\-existing\fR 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\&.
  51 .sp
  52 The \fB\-\-exists\fR form can be used to check for the existence of a single references\&. This form does not verify whether the reference resolves to an actual object\&.
  53 .sp
  54 Use of this utility is encouraged in favor of directly accessing files under the \fB\&.git\fR directory\&.
  55 .SH "OPTIONS"
  56 .PP
  57 \-\-head
  58 .RS 4
  59 Show the HEAD reference, even if it would normally be filtered out\&.
  60 .RE
  61 .PP
  62 \-\-branches, \-\-tags
  63 .RS 4
  64 Limit to local branches and local tags, respectively\&. These options are not mutually exclusive; when given both, references stored in "refs/heads" and "refs/tags" are displayed\&. Note that
  65 \fB\-\-heads\fR
  66 is a deprecated synonym for
  67 \fB\-\-branches\fR
  68 and may be removed in the future\&.
  69 .RE
  70 .PP
  71 \-d, \-\-dereference
  72 .RS 4
  73 Dereference tags into object IDs as well\&. They will be shown with
  74 \fB^{}\fR
  75 appended\&.
  76 .RE
  77 .PP
  78 \-s, \-\-hash[=<n>]
  79 .RS 4
  80 Only show the OID, not the reference name\&. When combined with
  81 \fB\-\-dereference\fR, the dereferenced tag will still be shown after the OID\&.
  82 .RE
  83 .PP
  84 \-\-verify
  85 .RS 4
  86 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
  87 \fB\-\-quiet\fR
  88 was not specified\&.
  89 .RE
  90 .PP
  91 \-\-exists
  92 .RS 4
  93 Check whether the given reference exists\&. Returns an exit code of 0 if it does, 2 if it is missing, and 1 in case looking up the reference failed with an error other than the reference being missing\&.
  94 .RE
  95 .PP
  96 \-\-abbrev[=<n>]
  97 .RS 4
  98 Abbreviate the object name\&. When using
  99 \fB\-\-hash\fR, you do not have to say
 100 \fB\-\-hash \-\-abbrev\fR;
 101 \fB\-\-hash=n\fR
 102 would do\&.
 103 .RE
 104 .PP
 105 \-q, \-\-quiet
 106 .RS 4
 107 Do not print any results to stdout\&. Can be used with
 108 \fB\-\-verify\fR
 109 to silently check if a reference exists\&.
 110 .RE
 111 .PP
 112 \-\-exclude\-existing[=<pattern>]
 113 .RS 4
 114 Make
 115 \fBgit show\-ref\fR
 116 act as a filter that reads refs from stdin of the form
 117 \fB^(?:<anything>\es)?<refname>(?:\e^{})?$\fR
 118 and performs the following actions on each: (1) strip
 119 \fB^{}\fR
 120 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\&.
 121 .RE
 122 .PP
 123 <pattern>\&...\:
 124 .RS 4
 125 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\&.
 126 \fImaster\fR
 127 matches
 128 \fIrefs/heads/master\fR,
 129 \fIrefs/remotes/origin/master\fR,
 130 \fIrefs/tags/jedi/master\fR
 131 but not
 132 \fIrefs/heads/mymaster\fR
 133 or
 134 \fIrefs/remotes/master/jedi\fR\&.
 135 .RE
 136 .SH "OUTPUT"
 137 .sp
 138 The output is in the format:
 139 .sp
 140 .if n \{\
 141 .RS 4
 142 .\}
 143 .nf
 144 <oid> SP <ref> LF
 145 .fi
 146 .if n \{\
 147 .RE
 148 .\}
 149 .sp
 150 For example,
 151 .sp
 152 .if n \{\
 153 .RS 4
 154 .\}
 155 .nf
 156 $ git show\-ref \-\-head \-\-dereference
 157 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD
 158 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master
 159 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin
 160 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0\&.99\&.9c
 161 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0\&.99\&.9c^{}
 162 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1\&.0rc4
 163 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1\&.0rc4^{}
 164 \&.\&.\&.
 165 .fi
 166 .if n \{\
 167 .RE
 168 .\}
 169 .sp
 170 When using \fB\-\-hash\fR (and not \fB\-\-dereference\fR), the output is in the format:
 171 .sp
 172 .if n \{\
 173 .RS 4
 174 .\}
 175 .nf
 176 <oid> LF
 177 .fi
 178 .if n \{\
 179 .RE
 180 .\}
 181 .sp
 182 For example,
 183 .sp
 184 .if n \{\
 185 .RS 4
 186 .\}
 187 .nf
 188 $ git show\-ref \-\-branches \-\-hash
 189 2e3ba0114a1f52b47df29743d6915d056be13278
 190 185008ae97960c8d551adcd9e23565194651b5d1
 191 03adf42c988195b50e1a1935ba5fcbc39b2b029b
 192 \&.\&.\&.
 193 .fi
 194 .if n \{\
 195 .RE
 196 .\}
 197 .SH "EXAMPLES"
 198 .sp
 199 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:
 200 .sp
 201 .if n \{\
 202 .RS 4
 203 .\}
 204 .nf
 205         git show\-ref master
 206 .fi
 207 .if n \{\
 208 .RE
 209 .\}
 210 .sp
 211 This will show "refs/heads/master" but also "refs/remote/other\-repo/master", if such references exist\&.
 212 .sp
 213 When using the \fB\-\-verify\fR flag, the command requires an exact path:
 214 .sp
 215 .if n \{\
 216 .RS 4
 217 .\}
 218 .nf
 219         git show\-ref \-\-verify refs/heads/master
 220 .fi
 221 .if n \{\
 222 .RE
 223 .\}
 224 .sp
 225 will only match the exact branch called "master"\&.
 226 .sp
 227 If nothing matches, \fBgit show\-ref\fR will return an error code of 1, and in the case of verification, it will show an error message\&.
 228 .sp
 229 For scripting, you can ask it to be quiet with the \fB\-\-quiet\fR flag, which allows you to do things like
 230 .sp
 231 .if n \{\
 232 .RS 4
 233 .\}
 234 .nf
 235         git show\-ref \-\-quiet \-\-verify \-\- "refs/heads/$headname" ||
 236                 echo "$headname is not a valid branch"
 237 .fi
 238 .if n \{\
 239 .RE
 240 .\}
 241 .sp
 242 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)\&.
 243 .sp
 244 To show only tags, or only proper branch heads, use \fB\-\-tags\fR and/or \fB\-\-branches\fR respectively (using both means that it shows tags and branches, but not other random references under the refs/ subdirectory)\&.
 245 .sp
 246 To do automatic tag object dereferencing, use the \fB\-d\fR or \fB\-\-dereference\fR flag, so you can do
 247 .sp
 248 .if n \{\
 249 .RS 4
 250 .\}
 251 .nf
 252         git show\-ref \-\-tags \-\-dereference
 253 .fi
 254 .if n \{\
 255 .RE
 256 .\}
 257 .sp
 258 to get a listing of all tags together with what they dereference\&.
 259 .SH "FILES"
 260 .sp
 261 \fB\&.git/refs/*\fR, \fB\&.git/packed\-refs\fR
 262 .SH "SEE ALSO"
 263 .sp
 264 \fBgit-for-each-ref\fR(1), \fBgit-ls-remote\fR(1), \fBgit-update-ref\fR(1), \fBgitrepository-layout\fR(5)
 265 .SH "GIT"
 266 .sp
 267 Part of the \fBgit\fR(1) suite