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

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.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] [--sort=&lt;key&gt;]\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.  Note that <emphasis>git ls-remote -h</emphasis> used without\r
  48         anything else on the command line gives help, consistent\r
  49         with other git subcommands.\r
  50 </simpara>\r
  51 </listitem>\r
  52 </varlistentry>\r
  53 <varlistentry>\r
  54 <term>\r
  55 --refs\r
  56 </term>\r
  57 <listitem>\r
  58 <simpara>\r
  59         Do not show peeled tags or pseudorefs like <emphasis>HEAD</emphasis> in the output.\r
  60 </simpara>\r
  61 </listitem>\r
  62 </varlistentry>\r
  63 <varlistentry>\r
  64 <term>\r
  65 -q\r
  66 </term>\r
  67 <term>\r
  68 --quiet\r
  69 </term>\r
  70 <listitem>\r
  71 <simpara>\r
  72         Do not print remote URL to stderr.\r
  73 </simpara>\r
  74 </listitem>\r
  75 </varlistentry>\r
  76 <varlistentry>\r
  77 <term>\r
  78 --upload-pack=&lt;exec&gt;\r
  79 </term>\r
  80 <listitem>\r
  81 <simpara>\r
  82         Specify the full path of <emphasis>git-upload-pack</emphasis> on the remote\r
  83         host. This allows listing references from repositories accessed via\r
  84         SSH and where the SSH daemon does not use the PATH configured by the\r
  85         user.\r
  86 </simpara>\r
  87 </listitem>\r
  88 </varlistentry>\r
  89 <varlistentry>\r
  90 <term>\r
  91 --exit-code\r
  92 </term>\r
  93 <listitem>\r
  94 <simpara>\r
  95         Exit with status "2" when no matching refs are found in the remote\r
  96         repository. Usually the command exits with status "0" to indicate\r
  97         it successfully talked with the remote repository, whether it\r
  98         found any matching refs.\r
  99 </simpara>\r
 100 </listitem>\r
 101 </varlistentry>\r
 102 <varlistentry>\r
 103 <term>\r
 104 --get-url\r
 105 </term>\r
 106 <listitem>\r
 107 <simpara>\r
 108         Expand the URL of the given remote repository taking into account any\r
 109         "url.&lt;base&gt;.insteadOf" config setting (See <xref linkend="git-config(1)" />) and\r
 110         exit without talking to the remote.\r
 111 </simpara>\r
 112 </listitem>\r
 113 </varlistentry>\r
 114 <varlistentry>\r
 115 <term>\r
 116 --symref\r
 117 </term>\r
 118 <listitem>\r
 119 <simpara>\r
 120         In addition to the object pointed by it, show the underlying\r
 121         ref pointed by it when showing a symbolic ref.  Currently,\r
 122         upload-pack only shows the symref HEAD, so it will be the only\r
 123         one shown by ls-remote.\r
 124 </simpara>\r
 125 </listitem>\r
 126 </varlistentry>\r
 127 <varlistentry>\r
 128 <term>\r
 129 --sort=&lt;key&gt;\r
 130 </term>\r
 131 <listitem>\r
 132 <simpara>\r
 133         Sort based on the key given. Prefix <emphasis>-</emphasis> to sort in descending order\r
 134         of the value. Supports "version:refname" or "v:refname" (tag names\r
 135         are treated as versions). The "version:refname" sort order can also\r
 136         be affected by the "versionsort.suffix" configuration variable.\r
 137         See <xref linkend="git-for-each-ref(1)" /> for more sort options, but be aware\r
 138         keys like <emphasis>committerdate</emphasis> that require access to the objects\r
 139         themselves will not work for refs whose objects have not yet been\r
 140         fetched from the remote, and will give a <emphasis>missing object</emphasis> error.\r
 141 </simpara>\r
 142 </listitem>\r
 143 </varlistentry>\r
 144 <varlistentry>\r
 145 <term>\r
 146 -o &lt;option&gt;\r
 147 </term>\r
 148 <term>\r
 149 --server-option=&lt;option&gt;\r
 150 </term>\r
 151 <listitem>\r
 152 <simpara>\r
 153         Transmit the given string to the server when communicating using\r
 154         protocol version 2.  The given string must not contain a NUL or LF\r
 155         character.\r
 156         When multiple <emphasis>--server-option=&lt;option&gt;</emphasis> are given, they are all\r
 157         sent to the other side in the order listed on the command line.\r
 158 </simpara>\r
 159 </listitem>\r
 160 </varlistentry>\r
 161 <varlistentry>\r
 162 <term>\r
 163 &lt;repository&gt;\r
 164 </term>\r
 165 <listitem>\r
 166 <simpara>\r
 167         The "remote" repository to query.  This parameter can be\r
 168         either a URL or the name of a remote (see the GIT URLS and\r
 169         REMOTES sections of <xref linkend="git-fetch(1)" />).\r
 170 </simpara>\r
 171 </listitem>\r
 172 </varlistentry>\r
 173 <varlistentry>\r
 174 <term>\r
 175 &lt;refs&gt;&#8230;\r
 176 </term>\r
 177 <listitem>\r
 178 <simpara>\r
 179         When unspecified, all references, after filtering done\r
 180         with --heads and --tags, are shown.  When &lt;refs&gt;&#8230; are\r
 181         specified, only references matching the given patterns\r
 182         are displayed.\r
 183 </simpara>\r
 184 </listitem>\r
 185 </varlistentry>\r
 186 </variablelist>\r
 187 </simplesect>\r
 188 <simplesect id="git-ls-remote(1)__examples">\r
 189 <title>EXAMPLES</title>\r
 190 <screen>$ git ls-remote --tags ./.\r
 191 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 192 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 193 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3\r
 194 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 195 0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio-gpg-pub\r
 196 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc\r
 197 5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master\r
 198 c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/seen\r
 199 $ git remote add korg http://www.kernel.org/pub/scm/git/git.git\r
 200 $ git ls-remote --tags korg v\*\r
 201 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 202 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 203 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 204 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3</screen>\r
 205 </simplesect>\r
 206 <simplesect id="git-ls-remote(1)__see_also">\r
 207 <title>SEE ALSO</title>\r
 208 <simpara><xref linkend="git-check-ref-format(1)" />.</simpara>\r
 209 </simplesect>\r
 210 <simplesect id="git-ls-remote(1)__git">\r
 211 <title>GIT</title>\r
 212 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 213 </simplesect>\r
 214 </sect2>\r