Documentation: spell.
[git.git] / Documentation / git-clone-pack.txt
blob39906fc450150ee0e9213a31c8a7c3e50d01b5b3
1 git-clone-pack(1)
2 =================
4 NAME
5 ----
6 git-clone-pack - Clones a repository by receiving packed objects.
9 SYNOPSIS
10 --------
11 'git-clone-pack' [--exec=<git-upload-pack>] [<host>:]<directory> [<head>...]
13 DESCRIPTION
14 -----------
15 Clones a repository into the current repository by invoking
16 'git-upload-pack', possibly on the remote host via ssh, in
17 the named repository, and stores the sent pack in the local
18 repository.
20 OPTIONS
21 -------
22 --exec=<git-upload-pack>::
23         Use this to specify the path to 'git-upload-pack' on the
24         remote side, if it is not found on your $PATH.
25         Installations of sshd ignore the user's environment
26         setup scripts for login shells (e.g. .bash_profile) and
27         your privately installed git may not be found on the system
28         default $PATH.  Another workaround suggested is to set
29         up your $PATH in ".bashrc", but this flag is for people
30         who do not want to pay the overhead for non-interactive
31         shells by having a lean .bashrc file (they set most of
32         the things up in .bash_profile).
34 <host>::
35         A remote host that houses the repository.  When this
36         part is specified, 'git-upload-pack' is invoked via
37         ssh.
39 <directory>::
40         The repository to sync from.
42 <head>...::
43         The heads to update.  This is relative to $GIT_DIR
44         (e.g. "HEAD", "refs/heads/master").  When unspecified,
45         all heads are updated to match the remote repository.
47 Usually all the refs from existing repository are stored
48 under the same name in the new repository.  Giving explicit
49 <head> arguments instead writes the object names and refs to
50 the standard output, just like get-fetch-pack does.
52 Author
53 ------
54 Written by Linus Torvalds <torvalds@osdl.org>
56 Documentation
57 --------------
58 Documentation by Junio C Hamano.
61 GIT
62 ---
63 Part of the gitlink:git[7] suite