bd53ef430dd83adc8f0940fe130ced3fe1693ab0
[git.git] / Documentation / git-clone.txt
1 git-clone(1)
2 ============
3 v0.1, July 2005
4
5 NAME
6 ----
7 git-clone - Clones a repository.
8
9
10 SYNOPSIS
11 --------
12 'git clone' [-l] [-u <upload-pack>] [-q] <repository> <directory>
13
14 DESCRIPTION
15 -----------
16 Clones a repository into a newly created directory.
17
18 OPTIONS
19 -------
20 -l::
21         When the repository to clone from is on a local machine,
22         this flag bypasses normal "git aware" transport
23         mechanism and clones the repository by making a copy of
24         HEAD and everything under objects and refs directories.
25         The files under .git/objects/ directory are hardlinked
26         to save space when possible.
27
28 -q::
29         Operate quietly.  This flag is passed to "rsync" and
30         "git-clone-pack" commands when given.
31
32 -u <upload-pack>::
33         When given, and the repository to clone from is handled
34         by 'git-clone-pack', '--exec=<upload-pack>' is passed to
35         the command to specify non-default path for the command
36         run on the other end.
37
38 <repository>::
39         The (possibly remote) repository to clone from.  It can
40         be an "rsync://host/dir" URL, an "http://host/dir" URL,
41         or [<host>:]/dir notation that is used by 'git-clone-pack'.
42         Currently http transport is not supported.
43
44 <directory>::
45         The name of a new directory to be cloned into.  It is an
46         error to specify an existing directory.
47
48 Author
49 ------
50 Written by Linus Torvalds <torvalds@osdl.org>
51
52 Documentation
53 --------------
54 Documentation by Junio C Hamano.
55
56
57 GIT
58 ---
59 Part of the gitlink:git[7] suite
60