ls-remote: use parse-options api
[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]
40a88529 12'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
80b17e58 13 [-q | --quiet] [--exit-code] [--get-url] [<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
40a88529
TG
32--refs::
33 Do not show peeled tags or pseudorefs like HEAD in the output.
34
54813bdd
TG
35-q::
36--quiet::
37 Do not print remote URL to stderr.
38
3240240f 39--upload-pack=<exec>::
ba020ef5 40 Specify the full path of 'git-upload-pack' on the remote
0dde6899 41 host. This allows listing references from repositories accessed via
23bfbb81 42 SSH and where the SSH daemon does not use the PATH configured by the
f0294272 43 user.
0dde6899 44
a8724773
MS
45--exit-code::
46 Exit with status "2" when no matching refs are found in the remote
47 repository. Usually the command exits with status "0" to indicate
48 it successfully talked with the remote repository, whether it
49 found any matching refs.
50
2303cad2
SN
51--get-url::
52 Expand the URL of the given remote repository taking into account any
53 "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
54 exit without talking to the remote.
55
972b6fe7 56<repository>::
88e36141
RR
57 The "remote" repository to query. This parameter can be
58 either a URL or the name of a remote (see the GIT URLS and
59 REMOTES sections of linkgit:git-fetch[1]).
972b6fe7
JH
60
61<refs>...::
62 When unspecified, all references, after filtering done
63 with --heads and --tags, are shown. When <refs>... are
64 specified, only references matching the given patterns
65 are displayed.
66
67EXAMPLES
68--------
69
70 $ git ls-remote --tags ./.
71 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
72 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
73 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
74 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
75 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub
76 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
77 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
78 c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu
f0779aef
RR
79 $ git remote add korg http://www.kernel.org/pub/scm/git/git.git
80 $ git ls-remote --tags korg v\*
972b6fe7
JH
81 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
82 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
83 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
84 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
85
972b6fe7
JH
86GIT
87---
9e1f0a85 88Part of the linkgit:git[1] suite