summaryrefslogtreecommitdiff
path: root/Documentation/git-clone-script.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-07-14 03:25:54 (GMT)
committerLinus Torvalds <torvalds@g5.osdl.org>2005-07-14 03:42:26 (GMT)
commit6ec311da34cbbc8a571bf889b6ef00c4efb441b5 (patch)
treec3233ceedd0e36f84b4265f91ad4fb972cdef44a /Documentation/git-clone-script.txt
parentd46ad9c989c0c4afc9507b48206f26f75a2fbd24 (diff)
downloadgit-6ec311da34cbbc8a571bf889b6ef00c4efb441b5.zip
git-6ec311da34cbbc8a571bf889b6ef00c4efb441b5.tar.gz
git-6ec311da34cbbc8a571bf889b6ef00c4efb441b5.tar.bz2
[PATCH] clone-pack and clone-script: documentation and add a missing parameter.
While adding the documentation for these two commands, I noticed that the name of the program on the other end (git-upload-pack) is already almost configurable but git-clone-pack lacked command line parameter parsing to actually use anything but default, so I introduced --exec= like other remote commands while I was at it. Signed-off-by: Junio C Hamano <junkio@cox.net> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation/git-clone-script.txt')
-rw-r--r--Documentation/git-clone-script.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/Documentation/git-clone-script.txt b/Documentation/git-clone-script.txt
new file mode 100644
index 0000000..afb25bd
--- /dev/null
+++ b/Documentation/git-clone-script.txt
@@ -0,0 +1,60 @@
+git-clone-script(1)
+===================
+v0.1, July 2005
+
+NAME
+----
+git-clone-script - Clones a repository.
+
+
+SYNOPSIS
+--------
+'git clone' [-l] [-u <upload-pack>] [-q] <repository> <directory>
+
+DESCRIPTION
+-----------
+Clones a repository into a newly created directory.
+
+OPTIONS
+-------
+-l::
+ When the repository to clone from is on a local machine,
+ this flag bypasses normal "git aware" transport
+ mechanism and clones the repository by making a copy of
+ HEAD and everything under objects and refs directories.
+ The files under .git/objects/ directory are hardlinked
+ to save space when possible.
+
+-q::
+ Operate quietly. This flag is passed to "rsync" and
+ "git-clone-pack" commands when given.
+
+-u <upload-pack>::
+ When given, and the repository to clone from is handled
+ by 'git-clone-pack', '--exec=<upload-pack>' is passed to
+ the command to specify non-default path for the command
+ run on the other end.
+
+<repository>::
+ The (possibly remote) repository to clone from. It can
+ be an "rsync://host/dir" URL, an "http://host/dir" URL,
+ or [<host>:]/dir notation that is used by 'git-clone-pack'.
+ Currently http transport is not supported.
+
+<directory>::
+ The name of a new directory to be cloned into. It is an
+ error to specify an existing directory.
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+
+GIT
+---
+Part of the link:git.html[git] suite
+