Merge branch 'jc/cherry-pick' (early part)
[git/jnareb-git/bp-gitweb.git] / Documentation / git-fetch-pack.txt
blob57598eb0566c8eabc3537fb67b7841c65bcf5c2c
1 git-fetch-pack(1)
2 =================
4 NAME
5 ----
6 git-fetch-pack - Receive missing objects from another repository
9 SYNOPSIS
10 --------
11 'git-fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
13 DESCRIPTION
14 -----------
15 Usually you would want to use linkgit:git-fetch[1] which is a
16 higher level wrapper of this command instead.
18 Invokes 'git-upload-pack' on a potentially remote repository,
19 and asks it to send objects missing from this repository, to
20 update the named heads.  The list of commits available locally
21 is found out by scanning local $GIT_DIR/refs/ and sent to
22 'git-upload-pack' running on the other end.
24 This command degenerates to download everything to complete the
25 asked refs from the remote side when the local side does not
26 have a common ancestor commit.
29 OPTIONS
30 -------
31 \--all::
32         Fetch all remote refs.
34 \--quiet, \-q::
35         Pass '-q' flag to 'git-unpack-objects'; this makes the
36         cloning process less verbose.
38 \--keep, \-k::
39         Do not invoke 'git-unpack-objects' on received data, but
40         create a single packfile out of it instead, and store it
41         in the object database. If provided twice then the pack is
42         locked against repacking.
44 \--thin::
45         Spend extra cycles to minimize the number of objects to be sent.
46         Use it on slower connection.
48 \--include-tag::
49         If the remote side supports it, annotated tags objects will
50         be downloaded on the same connection as the other objects if
51         the object the tag references is downloaded.  The caller must
52         otherwise determine the tags this option made available.
54 \--upload-pack=<git-upload-pack>::
55         Use this to specify the path to 'git-upload-pack' on the
56         remote side, if is not found on your $PATH.
57         Installations of sshd ignores the user's environment
58         setup scripts for login shells (e.g. .bash_profile) and
59         your privately installed git may not be found on the system
60         default $PATH.  Another workaround suggested is to set
61         up your $PATH in ".bashrc", but this flag is for people
62         who do not want to pay the overhead for non-interactive
63         shells by having a lean .bashrc file (they set most of
64         the things up in .bash_profile).
66 \--exec=<git-upload-pack>::
67         Same as \--upload-pack=<git-upload-pack>.
69 \--depth=<n>::
70         Limit fetching to ancestor-chains not longer than n.
72 \--no-progress::
73         Do not show the progress.
75 \-v::
76         Run verbosely.
78 <host>::
79         A remote host that houses the repository.  When this
80         part is specified, 'git-upload-pack' is invoked via
81         ssh.
83 <directory>::
84         The repository to sync from.
86 <refs>...::
87         The remote heads to update from. This is relative to
88         $GIT_DIR (e.g. "HEAD", "refs/heads/master").  When
89         unspecified, update from all heads the remote side has.
92 Author
93 ------
94 Written by Linus Torvalds <torvalds@osdl.org>
96 Documentation
97 --------------
98 Documentation by Junio C Hamano.
102 Part of the linkgit:git[7] suite