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