Merge branch 'jc/exclusion-doc'
[gitweb.git] / Documentation / git-ls-remote.txt
index 27380de2a5c4200d6e49e699e225bbd61b3f5415..5f2628c8f86a65b0bfe8e29995fa2176927a30f0 100644 (file)
@@ -9,8 +9,9 @@ git-ls-remote - List references in a remote repository
 SYNOPSIS
 --------
 [verse]
-'git ls-remote' [--heads] [--tags]  [--upload-pack=<exec>]
-             [-q | --quiet] [--exit-code] <repository> [<refs>...]
+'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
+             [-q | --quiet] [--exit-code] [--get-url]
+             [--symref] [<repository> [<refs>...]]
 
 DESCRIPTION
 -----------
@@ -29,6 +30,9 @@ OPTIONS
        both, references stored in refs/heads and refs/tags are
        displayed.
 
+--refs::
+       Do not show peeled tags or pseudorefs like HEAD in the output.
+
 -q::
 --quiet::
        Do not print remote URL to stderr.
@@ -50,6 +54,12 @@ OPTIONS
        "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
        exit without talking to the remote.
 
+--symref::
+       In addition to the object pointed by it, show the underlying
+       ref pointed by it when showing a symbolic ref.  Currently,
+       upload-pack only shows the symref HEAD, so it will be the only
+       one shown by ls-remote.
+
 <repository>::
        The "remote" repository to query.  This parameter can be
        either a URL or the name of a remote (see the GIT URLS and