Autogenerated HTML docs for v1.4.0-rc2-g5e3a6
[git.git] / git-clone.html
index f83caa1..02e4ee4 100644 (file)
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 7.0.1" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
 <style type="text/css">\r
 /* Debug borders */\r
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
@@ -266,13 +266,16 @@ git-clone(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>git-clone -\r
-   Clones a repository.\r
+   Clones a repository\r
 </p>\r
 </div>\r
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-clone</em> [-l [-s]] [-q] [-n] [-o &lt;name&gt;] [-u &lt;upload-pack&gt;] &lt;repository&gt; [&lt;directory&gt;]</p>\r
+<div class="verseblock">\r
+<div class="content"><em>git-clone</em> [--template=&lt;template_directory&gt;] [-l [-s]] [-q] [-n] [--bare]\r
+          [-o &lt;name&gt;] [-u &lt;upload-pack&gt;] [--reference &lt;repository&gt;]\r
+          [--use-separate-remote] &lt;repository&gt; [&lt;directory&gt;]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
@@ -321,12 +324,25 @@ branch you are currently working on.  Remote branches other than
 <p>\r
         When the repository to clone is on the local machine,\r
         instead of using hard links, automatically setup\r
-        .git/objects/info/alternatives to share the objects\r
+        .git/objects/info/alternates to share the objects\r
         with the source repository.  The resulting repository\r
         starts out without any object of its own.\r
 </p>\r
 </dd>\r
 <dt>\r
+--reference &lt;repository&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        If the reference repository is on the local machine\r
+        automatically setup .git/objects/info/alternates to\r
+        obtain objects from the reference repository.  Using\r
+        an already existing repository as an alternate will\r
+        require less objects to be copied from the repository\r
+        being cloned, reducing network and local storage costs.\r
+</p>\r
+</dd>\r
+<dt>\r
 --quiet\r
 </dt>\r
 <dt>\r
@@ -347,6 +363,19 @@ branch you are currently working on.  Remote branches other than
 </p>\r
 </dd>\r
 <dt>\r
+--bare\r
+</dt>\r
+<dd>\r
+<p>\r
+        Make a <em>bare</em> GIT repository.  That is, instead of\r
+        creating <tt>&lt;directory&gt;</tt> and placing the administrative\r
+        files in <tt>&lt;directory&gt;/.git</tt>, make the <tt>&lt;directory&gt;</tt>\r
+        itself the <tt>$GIT_DIR</tt>. This implies <tt>-n</tt> option.  When\r
+        this option is used, neither the <tt>origin</tt> branch nor the\r
+        default <tt>remotes/origin</tt> file is created.\r
+</p>\r
+</dd>\r
+<dt>\r
 -o &lt;name&gt;\r
 </dt>\r
 <dd>\r
@@ -373,6 +402,26 @@ branch you are currently working on.  Remote branches other than
 </p>\r
 </dd>\r
 <dt>\r
+--template=&lt;template_directory&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Specify the directory from which templates will be used;\r
+        if unset the templates are taken from the installation\r
+        defined default, typically <tt>/usr/share/git-core/templates</tt>.\r
+</p>\r
+</dd>\r
+<dt>\r
+--use-separate-remote\r
+</dt>\r
+<dd>\r
+<p>\r
+        Save remotes heads under <tt>$GIT_DIR/remotes/origin/</tt> instead\r
+        of <tt>$GIT_DIR/refs/heads/</tt>.  Only the master branch is saved\r
+        in the latter.\r
+</p>\r
+</dd>\r
+<dt>\r
 &lt;repository&gt;\r
 </dt>\r
 <dd>\r
@@ -394,7 +443,9 @@ branch you are currently working on.  Remote branches other than
 </p>\r
 </dd>\r
 </dl>\r
-<h3>Examples</h3>\r
+</div>\r
+<h2>Examples</h2>\r
+<div class="sectionbody">\r
 <dl>\r
 <dt>\r
 Clone from upstream\r
@@ -418,6 +469,37 @@ $ cd copy
 $ git show-branch</tt></pre>\r
 </div></div>\r
 </dd>\r
+<dt>\r
+Clone from upstream while borrowing from an existing local directory\r
+</dt>\r
+<dd>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git clone --reference my2.6 \\r
+        git://git.kernel.org/pub/scm/.../linux-2.7 \\r
+        my2.7\r
+$ cd my2.7</tt></pre>\r
+</div></div>\r
+</dd>\r
+<dt>\r
+Create a bare repository to publish your changes to the public\r
+</dt>\r
+<dd>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git</tt></pre>\r
+</div></div>\r
+</dd>\r
+<dt>\r
+Create a repository on the kernel.org machine that borrows from Linus\r
+</dt>\r
+<dd>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \\r
+    /pub/scm/.../me/subsys-2.6.git</tt></pre>\r
+</div></div>\r
+</dd>\r
 </dl>\r
 </div>\r
 <h2>Author</h2>\r
@@ -434,7 +516,7 @@ $ git show-branch</tt></pre>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 27-Dec-2005 00:15:54 PDT\r
+Last updated 10-Jun-2006 09:29:19 UTC\r
 </div>\r
 </div>\r
 </body>\r