ls-remote doc: rewrite <repository> paragraph
[git/git.git] / Documentation / git-ls-remote.txt
CommitLineData
215a7ad1
JH
1git-ls-remote(1)
2================
972b6fe7
JH
3
4NAME
5----
0dde6899 6git-ls-remote - List references in a remote repository
972b6fe7
JH
7
8
9SYNOPSIS
10--------
0dde6899 11[verse]
b1889c36 12'git ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>]
a8724773 13 [--exit-code] <repository> [<refs>...]
972b6fe7
JH
14
15DESCRIPTION
16-----------
0dde6899
JF
17Displays references available in a remote repository along with the associated
18commit IDs.
972b6fe7
JH
19
20
21OPTIONS
22-------
3240240f
SB
23-h::
24--heads::
25-t::
26--tags::
972b6fe7
JH
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.
31
3240240f
SB
32-u <exec>::
33--upload-pack=<exec>::
ba020ef5 34 Specify the full path of 'git-upload-pack' on the remote
0dde6899 35 host. This allows listing references from repositories accessed via
23bfbb81 36 SSH and where the SSH daemon does not use the PATH configured by the
f0294272 37 user.
0dde6899 38
a8724773
MS
39--exit-code::
40 Exit with status "2" when no matching refs are found in the remote
41 repository. Usually the command exits with status "0" to indicate
42 it successfully talked with the remote repository, whether it
43 found any matching refs.
44
2303cad2
SN
45--get-url::
46 Expand the URL of the given remote repository taking into account any
47 "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
48 exit without talking to the remote.
49
972b6fe7 50<repository>::
88e36141
RR
51 The "remote" repository to query. This parameter can be
52 either a URL or the name of a remote (see the GIT URLS and
53 REMOTES sections of linkgit:git-fetch[1]).
972b6fe7
JH
54
55<refs>...::
56 When unspecified, all references, after filtering done
57 with --heads and --tags, are shown. When <refs>... are
58 specified, only references matching the given patterns
59 are displayed.
60
61EXAMPLES
62--------
63
64 $ git ls-remote --tags ./.
65 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
66 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
67 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
68 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
69 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub
70 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
71 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
72 c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu
972b6fe7
JH
73 $ echo http://www.kernel.org/pub/scm/git/git.git >.git/branches/public
74 $ git ls-remote --tags public v\*
75 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
76 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
77 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
78 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
79
972b6fe7
JH
80GIT
81---
9e1f0a85 82Part of the linkgit:git[1] suite