Documentation: a few spelling fixes
[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 <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|--heads, -t|--tags::
24 Limit to only refs/heads and refs/tags, respectively.
25 These options are _not_ mutually exclusive; when given
26 both, references stored in refs/heads and refs/tags are
27 displayed.
28
29 -u <exec>, --upload-pack=<exec>::
30 Specify the full path of gitlink:git-upload-pack[1] on the remote
31 host. This allows listing references from repositories accessed via
32 SSH and where the SSH daemon does not use the PATH configured by the
33 user. Also see the '--exec' option for gitlink:git-peek-remote[1].
34
35 <repository>::
36 Location of the repository. The shorthand defined in
37 $GIT_DIR/branches/ can be used. Use "." (dot) to list references in
38 the local repository.
39
40 <refs>...::
41 When unspecified, all references, after filtering done
42 with --heads and --tags, are shown. When <refs>... are
43 specified, only references matching the given patterns
44 are displayed.
45
46 EXAMPLES
47 --------
48
49 $ git ls-remote --tags ./.
50 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
51 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
52 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
53 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
54 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub
55 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
56 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
57 c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu
58 b1d096f2926c4e37c9c0b6a7bf2119bedaa277cb refs/heads/rc
59 $ echo http://www.kernel.org/pub/scm/git/git.git >.git/branches/public
60 $ git ls-remote --tags public v\*
61 d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99
62 f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1
63 c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
64 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
65
66 Author
67 ------
68 Written by Junio C Hamano <junkio@cox.net>
69
70 GIT
71 ---
72 Part of the gitlink:git[7] suite
73