Merge commit 'refs/top-bases/girocco' into girocco
[git/repo.git] / Documentation / git-ls-remote.txt
blobabe7bf9ff9eb9a3ddb1924938de071291520797a
1 git-ls-remote(1)
2 ================
4 NAME
5 ----
6 git-ls-remote - List references in a remote repository
9 SYNOPSIS
10 --------
11 [verse]
12 'git ls-remote' [--heads] [--tags]  [-u <exec> | --upload-pack <exec>]
13               <repository> <refs>...
15 DESCRIPTION
16 -----------
17 Displays references available in a remote repository along with the associated
18 commit IDs.
21 OPTIONS
22 -------
23 -h::
24 --heads::
25 -t::
26 --tags::
27         Limit to only refs/heads and refs/tags, respectively.
28         These options are _not_ mutually exclusive; when given
29         both, references stored in refs/heads and refs/tags are
30         displayed.
32 -u <exec>::
33 --upload-pack=<exec>::
34         Specify the full path of 'git-upload-pack' on the remote
35         host. This allows listing references from repositories accessed via
36         SSH and where the SSH daemon does not use the PATH configured by the
37         user.
39 <repository>::
40         Location of the repository.  The shorthand defined in
41         $GIT_DIR/branches/ can be used. Use "." (dot) to list references in
42         the local repository.
44 <refs>...::
45         When unspecified, all references, after filtering done
46         with --heads and --tags, are shown.  When <refs>... are
47         specified, only references matching the given patterns
48         are displayed.
50 EXAMPLES
51 --------
53         $ git ls-remote --tags ./.
54         d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99
55         f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1
56         7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3
57         c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
58         0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio-gpg-pub
59         $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
60         5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master
61         c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/pu
62         b1d096f2926c4e37c9c0b6a7bf2119bedaa277cb        refs/heads/rc
63         $ echo http://www.kernel.org/pub/scm/git/git.git >.git/branches/public
64         $ git ls-remote --tags public v\*
65         d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99
66         f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1
67         c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
68         7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3
70 Author
71 ------
72 Written by Junio C Hamano <gitster@pobox.com>
74 GIT
75 ---
76 Part of the linkgit:git[1] suite