Autogenerated man pages for v1.3.3-ged90
[git.git] / man1 / git-clone.1
index fb56e48..772f953 100755 (executable)
@@ -24,6 +24,7 @@ git-clone \- Clones a repository
 
 .nf
 \fIgit\-clone\fR [\-l [\-s]] [\-q] [\-n] [\-\-bare] [\-o <name>] [\-u <upload\-pack>]
+          [\-\-reference <repository>]
           <repository> [<directory>]
 .fi
 
@@ -50,7 +51,11 @@ When the repository to clone from is on a local machine, this flag bypasses norm
 
 .TP
 \-\-shared, \-s
-When the repository to clone is on the local machine, instead of using hard links, automatically setup \&.git/objects/info/alternatives to share the objects with the source repository\&. The resulting repository starts out without any object of its own\&.
+When the repository to clone is on the local machine, instead of using hard links, automatically setup \&.git/objects/info/alternates to share the objects with the source repository\&. The resulting repository starts out without any object of its own\&.
+
+.TP
+\-\-reference <repository>
+If the reference repository is on the local machine automatically setup \&.git/objects/info/alternates to obtain objects from the reference repository\&. Using an already existing repository as an alternate will require less objects to be copied from the repository being cloned, reducing network and local storage costs\&.
 
 .TP
 \-\-quiet, \-q
@@ -80,7 +85,7 @@ The (possibly remote) repository to clone from\&. It can be any URL git\-fetch s
 <directory>
 The name of a new directory to clone into\&. The "humanish" part of the source repository is used if no directory is explicitly given ("repo" for "/path/to/repo\&.git" and "foo" for "host\&.xz:foo/\&.git")\&. Cloning into an existing directory is not allowed\&.
 
-.SS "Examples"
+.SH "EXAMPLES"
 
 .TP
 Clone from upstream
@@ -101,6 +106,16 @@ $ git show\-branch
 .fi
 
 .TP
+Clone from upstream while borrowing from an existing local directory
+
+.nf
+$ git clone \-\-reference my2\&.6 \\
+        git://git\&.kernel\&.org/pub/scm/\&.\&.\&./linux\-2\&.7 \\
+        my2\&.7
+$ cd my2\&.7
+.fi
+
+.TP
 Create a bare repository to publish your changes to the public
 
 .nf