scripts: Add placeholders for OPTIONS_SPEC
[git/git-svn.git] / Documentation / git-fetch-pack.txt
bloba99a5b321f763911b0d5d233a8135c5b60be6e3b
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] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
13 DESCRIPTION
14 -----------
15 Usually you would want to use gitlink: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 \--upload-pack=<git-upload-pack>::
49         Use this to specify the path to 'git-upload-pack' on the
50         remote side, if is not found on your $PATH.
51         Installations of sshd ignores the user's environment
52         setup scripts for login shells (e.g. .bash_profile) and
53         your privately installed git may not be found on the system
54         default $PATH.  Another workaround suggested is to set
55         up your $PATH in ".bashrc", but this flag is for people
56         who do not want to pay the overhead for non-interactive
57         shells by having a lean .bashrc file (they set most of
58         the things up in .bash_profile).
60 \--exec=<git-upload-pack>::
61         Same as \--upload-pack=<git-upload-pack>.
63 \--depth=<n>::
64         Limit fetching to ancestor-chains not longer than n.
66 \--no-progress::
67         Do not show the progress.
69 \-v::
70         Run verbosely.
72 <host>::
73         A remote host that houses the repository.  When this
74         part is specified, 'git-upload-pack' is invoked via
75         ssh.
77 <directory>::
78         The repository to sync from.
80 <refs>...::
81         The remote heads to update from. This is relative to
82         $GIT_DIR (e.g. "HEAD", "refs/heads/master").  When
83         unspecified, update from all heads the remote side has.
86 Author
87 ------
88 Written by Linus Torvalds <torvalds@osdl.org>
90 Documentation
91 --------------
92 Documentation by Junio C Hamano.
94 GIT
95 ---
96 Part of the gitlink:git[7] suite