1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.2.5" />
7 <style type=
"text/css">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-clone(
1)
</title>
312 git-clone(
1) Manual Page
315 <div class=
"sectionbody">
317 Clone a repository into a new directory
322 <div class=
"sectionbody">
323 <div class=
"verseblock">
324 <div class=
"content"><em>git clone
</em> [--template=
<template_directory
>]
325 [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
326 [-o
<name
>] [-u
<upload-pack
>] [--reference
<repository
>]
327 [--depth
<depth
>] [--]
<repository
> [
<directory
>]
</div></div>
329 <h2 id=
"_description">DESCRIPTION
</h2>
330 <div class=
"sectionbody">
331 <div class=
"para"><p>Clones a repository into a newly created directory, creates
332 remote-tracking branches for each branch in the cloned repository
333 (visible using
<tt>git branch -r
</tt>), and creates and checks out an initial
334 branch equal to the cloned repository's currently active branch.
</p></div>
335 <div class=
"para"><p>After the clone, a plain
<tt>git fetch
</tt> without arguments will update
336 all the remote-tracking branches, and a
<tt>git pull
</tt> without
337 arguments will in addition merge the remote master branch into the
338 current master branch, if any.
</p></div>
339 <div class=
"para"><p>This default configuration is achieved by creating references to
340 the remote branch heads under
<tt>$GIT_DIR/refs/remotes/origin
</tt> and
341 by initializing
<tt>remote.origin.url
</tt> and
<tt>remote.origin.fetch
</tt>
342 configuration variables.
</p></div>
344 <h2 id=
"_options">OPTIONS
</h2>
345 <div class=
"sectionbody">
346 <div class=
"vlist"><dl>
355 When the repository to clone from is on a local machine,
356 this flag bypasses normal
"git aware" transport
357 mechanism and clones the repository by making a copy of
358 HEAD and everything under objects and refs directories.
359 The files under
<tt>.git/objects/
</tt> directory are hardlinked
360 to save space when possible. This is now the default when
361 the source repository is specified with
<tt>/path/to/repo
</tt>
362 syntax, so it essentially is a no-op option. To force
363 copying instead of hardlinking (which may be desirable
364 if you are trying to make a back-up of your repository),
365 but still avoid the usual
"git aware" transport
366 mechanism,
<tt>--no-hardlinks
</tt> can be used.
374 Optimize the cloning process from a repository on a
375 local filesystem by copying files under
<tt>.git/objects
</tt>
387 When the repository to clone is on the local machine,
388 instead of using hard links, automatically setup
389 .git/objects/info/alternates to share the objects
390 with the source repository. The resulting repository
391 starts out without any object of its own.
393 <div class=
"para"><p><strong>NOTE
</strong>: this is a possibly dangerous operation; do
<strong>not
</strong> use
394 it unless you understand what it does. If you clone your
395 repository using this option and then delete branches (or use any
396 other git command that makes any existing commit unreferenced) in the
397 source repository, some objects may become unreferenced (or dangling).
398 These objects may be removed by normal git operations (such as
<em>git-commit
</em>)
399 which automatically call
<tt>git gc --auto
</tt>. (See
<a href=
"git-gc.html">git-gc(
1)
</a>.)
400 If these objects are removed and were referenced by the cloned repository,
401 then the cloned repository will become corrupt.
</p></div>
404 --reference
<repository
>
408 If the reference repository is on the local machine
409 automatically setup .git/objects/info/alternates to
410 obtain objects from the reference repository. Using
411 an already existing repository as an alternate will
412 require fewer objects to be copied from the repository
413 being cloned, reducing network and local storage costs.
415 <div class=
"para"><p><strong>NOTE
</strong>: see NOTE to --shared option.
</p></div>
425 Operate quietly. This flag is also passed to the `rsync'
437 Display the progressbar, even in case the standard output is not
449 No checkout of HEAD is performed after the clone is complete.
457 Make a
<em>bare
</em> GIT repository. That is, instead of
458 creating
<tt><directory
></tt> and placing the administrative
459 files in
<tt><directory
>/.git
</tt>, make the
<tt><directory
></tt>
460 itself the
<tt>$GIT_DIR
</tt>. This obviously implies the
<tt>-n
</tt>
461 because there is nowhere to check out the working tree.
462 Also the branch heads at the remote are copied directly
463 to corresponding local branch heads, without mapping
464 them to
<tt>refs/remotes/origin/
</tt>. When this option is
465 used, neither remote-tracking branches nor the related
466 configuration variables are created.
474 Set up a mirror of the remote repository. This implies --bare.
478 --origin
<name
>
485 Instead of using the remote name
<em>origin
</em> to keep track
486 of the upstream repository, use
<name
>.
490 --upload-pack
<upload-pack
>
493 -u
<upload-pack
>
497 When given, and the repository to clone from is accessed
498 via ssh, this specifies a non-default path for the command
499 run on the other end.
503 --template=
<template_directory
>
507 Specify the directory from which templates will be used;
508 if unset the templates are taken from the installation
509 defined default, typically
<tt>/usr/share/git-core/templates
</tt>.
513 --depth
<depth
>
517 Create a
<em>shallow
</em> clone with a history truncated to the
518 specified number of revisions. A shallow repository has a
519 number of limitations (you cannot clone or fetch from
520 it, nor push from nor into it), but is adequate if you
521 are only interested in the recent history of a large project
522 with a long history, and would want to send in fixes
531 The (possibly remote) repository to clone from. See the
532 <a href=
"#URLS">URLS
</a> section below for more information on specifying
541 The name of a new directory to clone into. The
"humanish"
542 part of the source repository is used if no directory is
543 explicitly given (
"repo" for
"/path/to/repo.git" and
"foo"
544 for
"host.xz:foo/.git"). Cloning into an existing directory
545 is only allowed if the directory is empty.
550 <h2 id=
"_git_urls_a_id_urls_a">GIT URLS
<a id=
"URLS"></a></h2>
551 <div class=
"sectionbody">
552 <div class=
"para"><p>One of the following notations can be used
553 to name the remote repository:
</p></div>
554 <div class=
"exampleblock">
555 <div class=
"exampleblock-content">
556 <div class=
"ilist"><ul>
559 rsync://host.xz/path/to/repo.git/
564 http://host.xz
[:port
]/path/to/repo.git/
569 https://host.xz
[:port
]/path/to/repo.git/
574 git://host.xz
[:port
]/path/to/repo.git/
579 git://host.xz
[:port
]/~user/path/to/repo.git/
584 ssh://
[user@
]host.xz
[:port
]/path/to/repo.git/
589 ssh://
[user@
]host.xz/path/to/repo.git/
594 ssh://
[user@
]host.xz/~user/path/to/repo.git/
599 ssh://
[user@
]host.xz/~/path/to/repo.git
604 <div class=
"para"><p>SSH is the default transport protocol over the network. You can
605 optionally specify which user to log-in as, and an alternate,
606 scp-like syntax is also supported. Both syntaxes support
607 username expansion, as does the native git protocol, but
608 only the former supports port specification. The following
609 three are identical to the last three above, respectively:
</p></div>
610 <div class=
"exampleblock">
611 <div class=
"exampleblock-content">
612 <div class=
"ilist"><ul>
615 [user@
]host.xz:/path/to/repo.git/
620 [user@
]host.xz:~user/path/to/repo.git/
625 [user@
]host.xz:path/to/repo.git
630 <div class=
"para"><p>To sync with a local directory, you can use:
</p></div>
631 <div class=
"exampleblock">
632 <div class=
"exampleblock-content">
633 <div class=
"ilist"><ul>
641 file:///path/to/repo.git/
646 <div class=
"para"><p>They are equivalent, except the former implies --local option.
</p></div>
647 <div class=
"para"><p>If there are a large number of similarly-named remote repositories and
648 you want to use a different format for them (such that the URLs you
649 use will be rewritten into URLs that work), you can create a
650 configuration section of the form:
</p></div>
651 <div class=
"listingblock">
652 <div class=
"content">
653 <pre><tt> [url
"<actual url base>"]
654 insteadOf =
<other url base
></tt></pre>
656 <div class=
"para"><p>For example, with this:
</p></div>
657 <div class=
"listingblock">
658 <div class=
"content">
659 <pre><tt> [url
"git://git.host.xz/"]
660 insteadOf = host.xz:/path/to/
661 insteadOf = work:
</tt></pre>
663 <div class=
"para"><p>a URL like
"work:repo.git" or like
"host.xz:/path/to/repo.git" will be
664 rewritten in any context that takes a URL to be
"git://git.host.xz/repo.git".
</p></div>
666 <h2 id=
"_examples">Examples
</h2>
667 <div class=
"sectionbody">
668 <div class=
"vlist"><dl>
673 <div class=
"listingblock">
674 <div class=
"content">
675 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-
2.6 my2.6
681 Make a local clone that borrows from the current directory, without checking things out
684 <div class=
"listingblock">
685 <div class=
"content">
686 <pre><tt>$ git clone -l -s -n . ../copy
688 $ git show-branch
</tt></pre>
692 Clone from upstream while borrowing from an existing local directory
695 <div class=
"listingblock">
696 <div class=
"content">
697 <pre><tt>$ git clone --reference my2.6 \
698 git://git.kernel.org/pub/scm/.../linux-
2.7 \
700 $ cd my2.7
</tt></pre>
704 Create a bare repository to publish your changes to the public
707 <div class=
"listingblock">
708 <div class=
"content">
709 <pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
</tt></pre>
713 Create a repository on the kernel.org machine that borrows from Linus
716 <div class=
"listingblock">
717 <div class=
"content">
718 <pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-
2.6.git \
719 /pub/scm/.../me/subsys-
2.6.git
</tt></pre>
724 <h2 id=
"_author">Author
</h2>
725 <div class=
"sectionbody">
726 <div class=
"para"><p>Written by Linus Torvalds
<torvalds@osdl.org
></p></div>
728 <h2 id=
"_documentation">Documentation
</h2>
729 <div class=
"sectionbody">
730 <div class=
"para"><p>Documentation by Junio C Hamano and the git-list
<git@vger.kernel.org
>.
</p></div>
732 <h2 id=
"_git">GIT
</h2>
733 <div class=
"sectionbody">
734 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
737 <div id=
"footer-text">
738 Last updated
2009-
07-
01 02:
30:
45 UTC