Merge branch 'maint'
[gitweb.git] / Documentation / git-ls-remote.txt
index c0a80d4089d88417d0d91dbf44f728608ea1c467..abe7bf9ff9eb9a3ddb1924938de071291520797a 100644 (file)
@@ -3,29 +3,43 @@ git-ls-remote(1)
 
 NAME
 ----
-git-ls-remote - Look at references other repository has.
+git-ls-remote - List references in a remote repository
 
 
 SYNOPSIS
 --------
-'git-ls-remote' [--heads] [--tags] <repository> <refs>...
+[verse]
+'git ls-remote' [--heads] [--tags]  [-u <exec> | --upload-pack <exec>]
+             <repository> <refs>...
 
 DESCRIPTION
 -----------
-Displays the references other repository has.
+Displays references available in a remote repository along with the associated
+commit IDs.
 
 
 OPTIONS
 -------
---heads --tags::
+-h::
+--heads::
+-t::
+--tags::
        Limit to only refs/heads and refs/tags, respectively.
        These options are _not_ mutually exclusive; when given
        both, references stored in refs/heads and refs/tags are
        displayed.
 
+-u <exec>::
+--upload-pack=<exec>::
+       Specify the full path of 'git-upload-pack' on the remote
+       host. This allows listing references from repositories accessed via
+       SSH and where the SSH daemon does not use the PATH configured by the
+       user.
+
 <repository>::
        Location of the repository.  The shorthand defined in
-       $GIT_DIR/branches/ can be used.
+       $GIT_DIR/branches/ can be used. Use "." (dot) to list references in
+       the local repository.
 
 <refs>...::
        When unspecified, all references, after filtering done
@@ -55,9 +69,8 @@ EXAMPLES
 
 Author
 ------
-Written by Junio C Hamano <junkio@cox.net>
+Written by Junio C Hamano <gitster@pobox.com>
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite