help: add --config to list all available config
[gitweb.git] / Documentation / git-ls-remote.txt
index d510c05e11d3cbfb7fd1393331306e70bb7645db..b9fd3770a6ce19c341c421e07b68985d89d94df5 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>]
-             [--exit-code] <repository> [<refs>...]
+'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
+             [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
+             [--symref] [<repository> [<refs>...]]
 
 DESCRIPTION
 -----------
@@ -29,6 +30,13 @@ 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.
+
 --upload-pack=<exec>::
        Specify the full path of 'git-upload-pack' on the remote
        host. This allows listing references from repositories accessed via
@@ -46,6 +54,30 @@ 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.
+
+--sort=<key>::
+       Sort based on the key given. Prefix `-` to sort in descending order
+       of the value. Supports "version:refname" or "v:refname" (tag names
+       are treated as versions). The "version:refname" sort order can also
+       be affected by the "versionsort.suffix" configuration variable.
+       See linkgit:git-for-each-ref[1] for more sort options, but be aware
+       keys like `committerdate` that require access to the objects
+       themselves will not work for refs whose objects have not yet been
+       fetched from the remote, and will give a `missing object` error.
+
+-o <option>::
+--server-option=<option>::
+       Transmit the given string to the server when communicating using
+       protocol version 2.  The given string must not contain a NUL or LF
+       character.
+       When multiple `--server-option=<option>` are given, they are all
+       sent to the other side in the order listed on the command line.
+
 <repository>::
        The "remote" repository to query.  This parameter can be
        either a URL or the name of a remote (see the GIT URLS and
@@ -76,6 +108,10 @@ EXAMPLES
        c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
        7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3
 
+SEE ALSO
+--------
+linkgit:git-check-ref-format[1].
+
 GIT
 ---
 Part of the linkgit:git[1] suite