git-show-ref.html

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