ls-remote doc: rewrite <repository> paragraph
[git/git.git] / Documentation / git-ls-remote.txt
1 git-ls-remote(1)
2 ================
3
4 NAME
5 ----
6 git-ls-remote - List references in a remote repository
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>]
13 [--exit-code] <repository> [<refs>...]
14
15 DESCRIPTION
16 -----------
17 Displays references available in a remote repository along with the associated
18 commit IDs.
19
20
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.
31
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.
38
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
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
50 <repository>::
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]).
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
61 EXAMPLES
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
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
80 GIT
81 ---
82 Part of the linkgit:git[1] suite