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]  [-u &lt;exec&gt; | --upload-pack &lt;exec&gt;]\r
  17               [--exit-code] &lt;repository&gt; [&lt;refs&gt;&#8230;]</literallayout>\r
  18 </blockquote>\r
  19 </simplesect>\r
  20 <simplesect id="git-ls-remote(1)__description">\r
  21 <title>DESCRIPTION</title>\r
  22 <simpara>Displays references available in a remote repository along with the associated\r
  23 commit IDs.</simpara>\r
  24 </simplesect>\r
  25 <simplesect id="git-ls-remote(1)__options">\r
  26 <title>OPTIONS</title>\r
  27 <variablelist>\r
  28 <varlistentry>\r
  29 <term>\r
  30 -h\r
  31 </term>\r
  32 <term>\r
  33 --heads\r
  34 </term>\r
  35 <term>\r
  36 -t\r
  37 </term>\r
  38 <term>\r
  39 --tags\r
  40 </term>\r
  41 <listitem>\r
  42 <simpara>\r
  43         Limit to only refs/heads and refs/tags, respectively.\r
  44         These options are <emphasis>not</emphasis> mutually exclusive; when given\r
  45         both, references stored in refs/heads and refs/tags are\r
  46         displayed.\r
  47 </simpara>\r
  48 </listitem>\r
  49 </varlistentry>\r
  50 <varlistentry>\r
  51 <term>\r
  52 -u &lt;exec&gt;\r
  53 </term>\r
  54 <term>\r
  55 --upload-pack=&lt;exec&gt;\r
  56 </term>\r
  57 <listitem>\r
  58 <simpara>\r
  59         Specify the full path of <emphasis>git-upload-pack</emphasis> on the remote\r
  60         host. This allows listing references from repositories accessed via\r
  61         SSH and where the SSH daemon does not use the PATH configured by the\r
  62         user.\r
  63 </simpara>\r
  64 </listitem>\r
  65 </varlistentry>\r
  66 <varlistentry>\r
  67 <term>\r
  68 --exit-code\r
  69 </term>\r
  70 <listitem>\r
  71 <simpara>\r
  72         Exit with status "2" when no matching refs are found in the remote\r
  73         repository. Usually the command exits with status "0" to indicate\r
  74         it successfully talked with the remote repository, whether it\r
  75         found any matching refs.\r
  76 </simpara>\r
  77 </listitem>\r
  78 </varlistentry>\r
  79 <varlistentry>\r
  80 <term>\r
  81 --get-url\r
  82 </term>\r
  83 <listitem>\r
  84 <simpara>\r
  85         Expand the URL of the given remote repository taking into account any\r
  86         "url.&lt;base&gt;.insteadOf" config setting (See <xref linkend="git-config(1)" />) and\r
  87         exit without talking to the remote.\r
  88 </simpara>\r
  89 </listitem>\r
  90 </varlistentry>\r
  91 <varlistentry>\r
  92 <term>\r
  93 &lt;repository&gt;\r
  94 </term>\r
  95 <listitem>\r
  96 <simpara>\r
  97         Location of the repository.  The shorthand defined in\r
  98         $GIT_DIR/branches/ can be used. Use "." (dot) to list references in\r
  99         the local repository.\r
 100 </simpara>\r
 101 </listitem>\r
 102 </varlistentry>\r
 103 <varlistentry>\r
 104 <term>\r
 105 &lt;refs&gt;&#8230;\r
 106 </term>\r
 107 <listitem>\r
 108 <simpara>\r
 109         When unspecified, all references, after filtering done\r
 110         with --heads and --tags, are shown.  When &lt;refs&gt;&#8230; are\r
 111         specified, only references matching the given patterns\r
 112         are displayed.\r
 113 </simpara>\r
 114 </listitem>\r
 115 </varlistentry>\r
 116 </variablelist>\r
 117 </simplesect>\r
 118 <simplesect id="git-ls-remote(1)__examples">\r
 119 <title>EXAMPLES</title>\r
 120 <literallayout class="monospaced">$ git ls-remote --tags ./.\r
 121 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 122 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 123 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3\r
 124 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 125 0918385dbd9656cab0d1d81ba7453d49bbc16250        refs/tags/junio-gpg-pub\r
 126 $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc\r
 127 5fe978a5381f1fbad26a80e682ddd2a401966740        refs/heads/master\r
 128 c781a84b5204fb294c9ccc79f8b3baceeb32c061        refs/heads/pu\r
 129 b1d096f2926c4e37c9c0b6a7bf2119bedaa277cb        refs/heads/rc\r
 130 $ echo http://www.kernel.org/pub/scm/git/git.git &gt;.git/branches/public\r
 131 $ git ls-remote --tags public v\*\r
 132 d6602ec5194c87b0fc87103ca4d67251c76f233a        refs/tags/v0.99\r
 133 f25a265a342aed6041ab0cc484224d9ca54b6f41        refs/tags/v0.99.1\r
 134 c5db5456ae3b0873fc659c19fafdde22313cc441        refs/tags/v0.99.2\r
 135 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e        refs/tags/v0.99.3</literallayout>\r
 136 </simplesect>\r
 137 <simplesect id="git-ls-remote(1)__git">\r
 138 <title>GIT</title>\r
 139 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 140 </simplesect>\r
 141 </sect2>\r