Documentation / git-ls-remote.txton commit ls-remote: fix synopsis (80b17e5)
   1git-ls-remote(1)
   2================
   3
   4NAME
   5----
   6git-ls-remote - List references in a remote repository
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
  13              [-q | --quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]
  14
  15DESCRIPTION
  16-----------
  17Displays references available in a remote repository along with the associated
  18commit IDs.
  19
  20
  21OPTIONS
  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--refs::
  33        Do not show peeled tags or pseudorefs like HEAD in the output.
  34
  35-q::
  36--quiet::
  37        Do not print remote URL to stderr.
  38
  39--upload-pack=<exec>::
  40        Specify the full path of 'git-upload-pack' on the remote
  41        host. This allows listing references from repositories accessed via
  42        SSH and where the SSH daemon does not use the PATH configured by the
  43        user.
  44
  45--exit-code::
  46        Exit with status "2" when no matching refs are found in the remote
  47        repository. Usually the command exits with status "0" to indicate
  48        it successfully talked with the remote repository, whether it
  49        found any matching refs.
  50
  51--get-url::
  52        Expand the URL of the given remote repository taking into account any
  53        "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
  54        exit without talking to the remote.
  55
  56<repository>::
  57        The "remote" repository to query.  This parameter can be
  58        either a URL or the name of a remote (see the GIT URLS and
  59        REMOTES sections of linkgit:git-fetch[1]).
  60
  61<refs>...::
  62        When unspecified, all references, after filtering done
  63        with --heads and --tags, are shown.  When <refs>... are
  64        specified, only references matching the given patterns
  65        are displayed.
  66
  67EXAMPLES
  68--------
  69
  70        $ git ls-remote --tags ./.
  71        d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99
  72        f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1
  73        7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3
  74        c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
  75        0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio-gpg-pub
  76        $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc
  77        5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master
  78        c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/pu
  79        $ git remote add korg http://www.kernel.org/pub/scm/git/git.git
  80        $ git ls-remote --tags korg v\*
  81        d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99
  82        f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1
  83        c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2
  84        7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3
  85
  86GIT
  87---
  88Part of the linkgit:git[1] suite