1git-show-ref(1) 2=============== 3 4NAME 5---- 6git-show-ref - List references in a local repository 7 8SYNOPSIS 9-------- 10[verse] 11'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference] 12 [-s|--hash] [--tags] [--heads] [--] <pattern>... 13 14DESCRIPTION 15----------- 16 17Displays references available in a local repository along with the associated 18commit IDs. Results can be filtered using a pattern and tags can be 19dereferenced into object IDs. Additionally, it can be used to test whether a 20particular ref exists. 21 22Use of this utility is encouraged in favor of directly accessing files under 23in the `.git` directory. 24 25OPTIONS 26------- 27 28-h, --head:: 29 30 Show the HEAD reference. 31 32--tags, --heads:: 33 34 Limit to only "refs/heads" and "refs/tags", respectively. These 35 options are not mutually exclusive; when given both, references stored 36 in "refs/heads" and "refs/tags" are displayed. 37 38-d, --dereference:: 39 40 Dereference tags into object IDs. They will be shown with "^{}" 41 appended. 42 43-s, --hash:: 44 45 Only show the SHA1 hash, not the reference name. When also using 46 --dereference the dereferenced tag will still be shown after the SHA1, 47 this maybe a bug. 48 49--verify:: 50 51 Enable stricter reference checking by requiring an exact ref path. 52 Aside from returning an error code of 1, it will also print an error 53 message if '--quiet' was not specified. 54 55-q, --quiet:: 56 57 Do not print any results to stdout. When combined with '--verify' this 58 can be used to silently check if a reference exists. 59 60<pattern>:: 61 62 Show references matching one or more patterns. 63 64OUTPUT 65------ 66 67The output is in the format: '<SHA-1 ID>' '<space>' '<reference name>'. 68 69----------------------------------------------------------------------------- 70$ git show-ref --head --dereference 71832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD 72832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master 73832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin 743521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c 756ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{} 76055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4 77423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{} 78... 79----------------------------------------------------------------------------- 80 81When using --hash (and not --dereference) the output format is: '<SHA-1 ID>' 82 83----------------------------------------------------------------------------- 84$ git show-ref --heads --hash 852e3ba0114a1f52b47df29743d6915d056be13278 86185008ae97960c8d551adcd9e23565194651b5d1 8703adf42c988195b50e1a1935ba5fcbc39b2b029b 88... 89----------------------------------------------------------------------------- 90 91EXAMPLE 92------- 93 94To show all references called "master", whether tags or heads or anything 95else, and regardless of how deep in the reference naming hierarchy they are, 96use: 97 98----------------------------------------------------------------------------- 99 git show-ref master 100----------------------------------------------------------------------------- 101 102This will show "refs/heads/master" but also "refs/remote/other-repo/master", 103if such references exists. 104 105When using the '--verify' flag, the command requires an exact path: 106 107----------------------------------------------------------------------------- 108 git show-ref --verify refs/heads/master 109----------------------------------------------------------------------------- 110 111will only match the exact branch called "master". 112 113If nothing matches, gitlink:git-show-ref[1] will return an error code of 1, 114and in the case of verification, it will show an error message. 115 116For scripting, you can ask it to be quiet with the "--quiet" flag, which 117allows you to do things like 118 119----------------------------------------------------------------------------- 120 git-show-ref --quiet --verify -- "refs/heads/$headname" || 121 echo "$headname is not a valid branch" 122----------------------------------------------------------------------------- 123 124to check whether a particular branch exists or not (notice how we don't 125actually want to show any results, and we want to use the full refname for it 126in order to not trigger the problem with ambiguous partial matches). 127 128To show only tags, or only proper branch heads, use "--tags" and/or "--heads" 129respectively (using both means that it shows tags and heads, but not other 130random references under the refs/ subdirectory). 131 132To do automatic tag object dereferencing, use the "-d" or "--dereference" 133flag, so you can do 134 135----------------------------------------------------------------------------- 136 git show-ref --tags --dereference 137----------------------------------------------------------------------------- 138 139to get a listing of all tags together with what they dereference. 140 141SEE ALSO 142-------- 143gitlink:git-ls-remote[1], gitlink:git-peek-remote[1] 144 145AUTHORS 146------- 147Written by Linus Torvalds <torvalds@osdl.org>. 148Man page by Jonas Fonseca <fonseca@diku.dk>. 149 150GIT 151--- 152Part of the gitlink:git[7] suite