b58165a5fc03a8556217599ef6a6f24f2f87f696
[git/git.git] / Documentation / git-clone-pack.txt
1 git-clone-pack(1)
2 =================
3
4 NAME
5 ----
6 git-clone-pack - Clones a repository by receiving packed objects.
7
8
9 SYNOPSIS
10 --------
11 'git-clone-pack' [-q] [--keep] [--exec=<git-upload-pack>] [<host>:]<directory> [<head>...]
12
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 invoking 'git-unpack-objects' locally
18 to receive the pack.
19
20 OPTIONS
21 -------
22 -q::
23 Pass '-q' flag to 'git-unpack-objects'; this makes the
24 cloning process less verbose.
25
26 --keep::
27 Do not invoke 'git-unpack-objects' on received data, but
28 create a single packfile out of it instead, and store it
29 in the object database.
30
31 --exec=<git-upload-pack>::
32 Use this to specify the path to 'git-upload-pack' on the
33 remote side, if it is not found on your $PATH.
34 Installations of sshd ignore the user's environment
35 setup scripts for login shells (e.g. .bash_profile) and
36 your privately installed git may not be found on the system
37 default $PATH. Another workaround suggested is to set
38 up your $PATH in ".bashrc", but this flag is for people
39 who do not want to pay the overhead for non-interactive
40 shells by having a lean .bashrc file (they set most of
41 the things up in .bash_profile).
42
43 <host>::
44 A remote host that houses the repository. When this
45 part is specified, 'git-upload-pack' is invoked via
46 ssh.
47
48 <directory>::
49 The repository to sync from.
50
51 <head>...::
52 The heads to update. This is relative to $GIT_DIR
53 (e.g. "HEAD", "refs/heads/master"). When unspecified,
54 all heads are updated to match the remote repository.
55
56
57 Author
58 ------
59 Written by Linus Torvalds <torvalds@osdl.org>
60
61 Documentation
62 --------------
63 Documentation by Junio C Hamano.
64
65
66 GIT
67 ---
68 Part of the gitlink:git[7] suite
69