Autogenerated HTML docs for v1.4.0-rc2
[git.git] / git-clone.txt
index 684e4bd..94d9393 100644 (file)
@@ -3,13 +3,14 @@ git-clone(1)
 
 NAME
 ----
 
 NAME
 ----
-git-clone - Clones a repository.
+git-clone - Clones a repository
 
 
 SYNOPSIS
 --------
 [verse]
 
 
 SYNOPSIS
 --------
 [verse]
-'git-clone' [-l [-s]] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>]
+'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
+         [-o <name>] [-u <upload-pack>] [--reference <repository>]
          <repository> [<directory>]
 
 DESCRIPTION
          <repository> [<directory>]
 
 DESCRIPTION
@@ -46,10 +47,18 @@ OPTIONS
 -s::
        When the repository to clone is on the local machine,
        instead of using hard links, automatically setup
 -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
+       .git/objects/info/alternates to share the objects
        with the source repository.  The resulting repository
        starts out without any object of its own.
 
        with the source repository.  The resulting repository
        starts out without any object of its own.
 
+--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.
+
 --quiet::
 -q::
        Operate quietly.  This flag is passed to "rsync" and
 --quiet::
 -q::
        Operate quietly.  This flag is passed to "rsync" and
@@ -80,6 +89,11 @@ OPTIONS
        the command to specify non-default path for the command
        run on the other end.
 
        the command to specify non-default path for the command
        run on the other end.
 
+--template=<template_directory>::
+       Specify the directory from which templates will be used;
+       if unset the templates are taken from the installation
+       defined default, typically `/usr/share/git-core/templates`.
+
 <repository>::
        The (possibly remote) repository to clone from.  It can
        be any URL git-fetch supports.
 <repository>::
        The (possibly remote) repository to clone from.  It can
        be any URL git-fetch supports.
@@ -92,7 +106,7 @@ OPTIONS
        is not allowed.
 
 Examples
        is not allowed.
 
 Examples
-~~~~~~~~
+--------
 
 Clone from upstream::
 +
 
 Clone from upstream::
 +
@@ -112,6 +126,16 @@ $ git show-branch
 ------------
 
 
 ------------
 
 
+Clone from upstream while borrowing from an existing local directory::
++
+------------
+$ git clone --reference my2.6 \
+       git://git.kernel.org/pub/scm/.../linux-2.7 \
+       my2.7
+$ cd my2.7
+------------
+
+
 Create a bare repository to publish your changes to the public::
 +
 ------------
 Create a bare repository to publish your changes to the public::
 +
 ------------