doc/source/en/TortoiseGit/git_doc/git-ls-remote.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-ls-remote(1)">\r
   5     <title>git-ls-remote(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-ls-remote(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-ls-remote(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-ls-remote - List references in a remote repository</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-ls-remote(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git ls-remote</emphasis> [--heads] [--tags] [--refs] [--upload-pack=&lt;exec&gt;]\r
  17               [-q | --quiet] [--exit-code] [--get-url]\r
  18               [--symref] [&lt;repository&gt; [&lt;refs&gt;&#8230;]]</literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="git-ls-remote(1)__description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>Displays references available in a remote repository along with the associated\r
  24 commit IDs.</simpara>\r
  25 </simplesect>\r
  26 <simplesect id="git-ls-remote(1)__options">\r
  27 <title>OPTIONS</title>\r
  28 <variablelist>\r
  29 <varlistentry>\r
  30 <term>\r
  31 -h\r
  32 </term>\r
  33 <term>\r
  34 --heads\r
  35 </term>\r
  36 <term>\r
  37 -t\r
  38 </term>\r
  39 <term>\r
  40 --tags\r
  41 </term>\r
  42 <listitem>\r
  43 <simpara>\r
  44         Limit to only refs/heads and refs/tags, respectively.\r
  45         These options are <emphasis>not</emphasis> mutually exclusive; when given\r
  46         both, references stored in refs/heads and refs/tags are\r
  47         displayed.\r
  48 </simpara>\r
  49 </listitem>\r
  50 </varlistentry>\r
  51 <varlistentry>\r
  52 <term>\r
  53 --refs\r
  54 </term>\r
  55 <listitem>\r
  56 <simpara>\r
  57         Do not show peeled tags or pseudorefs like HEAD in the output.\r
  58 </simpara>\r
  59 </listitem>\r
  60 </varlistentry>\r
  61 <varlistentry>\r
  62 <term>\r
  63 -q\r
  64 </term>\r
  65 <term>\r
  66 --quiet\r
  67 </term>\r
  68 <listitem>\r
  69 <simpara>\r
  70         Do not print remote URL to stderr.\r
  71 </simpara>\r
  72 </listitem>\r
  73 </varlistentry>\r
  74 <varlistentry>\r
  75 <term>\r
  76 --upload-pack=&lt;exec&gt;\r
  77 </term>\r
  78 <listitem>\r
  79 <simpara>\r
  80         Specify the full path of <emphasis>git-upload-pack</emphasis> on the remote\r
  81         host. This allows listing references from repositories accessed via\r
  82         SSH and where the SSH daemon does not use the PATH configured by the\r
  83         user.\r
  84 </simpara>\r
  85 </listitem>\r
  86 </varlistentry>\r
  87 <varlistentry>\r
  88 <term>\r
  89 --exit-code\r
  90 </term>\r
  91 <listitem>\r
  92 <simpara>\r
  93         Exit with status "2" when no matching refs are found in the remote\r
  94         repository. Usually the command exits with status "0" to indicate\r
  95         it successfully talked with the remote repository, whether it\r
  96         found any matching refs.\r
  97 </simpara>\r
  98 </listitem>\r
  99 </varlistentry>\r
 100 <varlistentry>\r
 101 <term>\r
 102 --get-url\r
 103 </term>\r
 104 <listitem>\r
 105 <simpara>\r
 106         Expand the URL of the given remote repository taking into account any\r
 107         "url.&lt;base&gt;.insteadOf" config setting (See <xref linkend="git-config(1)" />) and\r
 108         exit without talking to the remote.\r
 109 </simpara>\r
 110 </listitem>\r
 111 </varlistentry>\r
 112 <varlistentry>\r
 113 <term>\r
 114 --symref\r
 115 </term>\r
 116 <listitem>\r
 117 <simpara>\r
 118         In addition to the object pointed by it, show the underlying\r
 119         ref pointed by it when showing a symbolic ref.  Currently,\r
 120         upload-pack only shows the symref HEAD, so it will be the only\r
 121         one shown by ls-remote.\r
 122 </simpara>\r
 123 </listitem>\r
 124 </varlistentry>\r
 125 <varlistentry>\r
 126 <term>\r
 127 &lt;repository&gt;\r
 128 </term>\r
 129 <listitem>\r
 130 <simpara>\r
 131         The "remote" repository to query.  This parameter can be\r
 132         either a URL or the name of a remote (see the GIT URLS and\r
 133         REMOTES sections of <xref linkend="git-fetch(1)" />).\r
 134 </simpara>\r
 135 </listitem>\r
 136 </varlistentry>\r
 137 <varlistentry>\r
 138 <term>\r
 139 &lt;refs&gt;&#8230;\r
 140 </term>\r
 141 <listitem>\r
 142 <simpara>\r
 143         When unspecified, all references, after filtering done\r
 144         with --heads and --tags, are shown.  When &lt;refs&gt;&#8230; are\r
 145         specified, only references matching the given patterns\r
 146         are displayed.\r
 147 </simpara>\r
 148 </listitem>\r
 149 </varlistentry>\r
 150 </variablelist>\r
 151 </simplesect>\r
 152 <simplesect id="git-ls-remote(1)__examples">\r
 153 <title>EXAMPLES</title>\r
 154 <literallayout class="monospaced">$ git ls-remote --tags ./.\r
 155 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 156 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 157 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3\r
 158 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 159 0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio-gpg-pub\r
 160 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc\r
 161 5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master\r
 162 c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/pu\r
 163 $ git remote add korg http://www.kernel.org/pub/scm/git/git.git\r
 164 $ git ls-remote --tags korg v\*\r
 165 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 166 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 167 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 168 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3</literallayout>\r
 169 </simplesect>\r
 170 <simplesect id="git-ls-remote(1)__git">\r
 171 <title>GIT</title>\r
 172 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 173 </simplesect>\r
 174 </sect2>\r