[PATCH] Update git-clone documentation
[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 [-s]] [-q] [-n] [-u <upload-pack>] <repository> <directory>
13
14 DESCRIPTION
15 -----------
16 Clones a repository into a newly created directory.
17
18 OPTIONS
19 -------
20 --local::
21 -l::
22         When the repository to clone from is on a local machine,
23         this flag bypasses normal "git aware" transport
24         mechanism and clones the repository by making a copy of
25         HEAD and everything under objects and refs directories.
26         The files under .git/objects/ directory are hardlinked
27         to save space when possible.
28
29 --shared::
30 -s::
31         When the repository to clone is on the local machine,
32         instead of using hard links automatically setup
33         .git/objects/info/alternatives to share the objects
34         with the source repository
35
36 --quiet::
37 -q::
38         Operate quietly.  This flag is passed to "rsync" and
39         "git-clone-pack" commands when given.
40
41 -n::
42         No checkout of HEAD is performed after the clone is complete.
43
44 --upload-pack <upload-pack>::
45 -u <upload-pack>::
46         When given, and the repository to clone from is handled
47         by 'git-clone-pack', '--exec=<upload-pack>' is passed to
48         the command to specify non-default path for the command
49         run on the other end.
50
51 <repository>::
52         The (possibly remote) repository to clone from.  It can
53         be an "rsync://host/dir" URL, an "http://host/dir" URL,
54         or [<host>:]/dir notation that is used by 'git-clone-pack'.
55         Currently http transport is not supported.
56
57 <directory>::
58         The name of a new directory to be cloned into.  It is an
59         error to specify an existing directory.
60
61 Author
62 ------
63 Written by Linus Torvalds <torvalds@osdl.org>
64
65 Documentation
66 --------------
67 Documentation by Junio C Hamano.
68
69
70 GIT
71 ---
72 Part of the gitlink:git[7] suite
73