summaryrefslogtreecommitdiff
path: root/Documentation/git-clone-pack.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-pack.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-pack.txt')
-rw-r--r--Documentation/git-clone-pack.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/Documentation/git-clone-pack.txt b/Documentation/git-clone-pack.txt
new file mode 100644
index 0000000..81c86e2
--- /dev/null
+++ b/Documentation/git-clone-pack.txt
@@ -0,0 +1,60 @@
+git-clone-pack(1)
+=================
+v0.1, July 2005
+
+NAME
+----
+git-clone-pack - Clones a repository by receiving packed objects.
+
+
+SYNOPSIS
+--------
+'git-clone-pack' [-q] [--exec=<git-upload-pack>] [<host>:]<directory> [<heads>...]
+
+DESCRIPTION
+-----------
+Clones a repository into the current repository by invoking
+'git-upload-pack', possibly on the remote host via ssh, in
+the named repository, and invoking 'git-unpack-objects' locally
+to receive the pack.
+
+OPTIONS
+-------
+-q::
+ Pass '-q' flag to 'git-unpack-objects'; this makes the
+ cloning process less verbose.
+
+--exec=<git-upload-pack>::
+ Use this to specify the path to 'git-upload-pack' on the
+ remote side, if is not found on your $PATH.
+ Installations of sshd ignores the user's environment
+ setup scripts for login shells (e.g. .bash_profile) and
+ your privately installed GIT may not be found on the system
+ default $PATH. Another workaround suggested is to set
+ up your $PATH in ".bashrc", but this flag is for people
+ who do not want to pay the overhead for non-interactive
+ shells by having a lean .bashrc file (they set most of
+ the things up in .bash_profile).
+
+[<host>:]<directory::
+ The (possibly remote) repository to clone from.
+
+<heads>...::
+ The heads to update. This is relative to $GIT_DIR
+ (e.g. "HEAD", "refs/heads/master"). When unspecified,
+ all heads are updated to match the remote repository.
+
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+
+GIT
+---
+Part of the link:git.html[git] suite
+