[thirdparty/git.git] / Documentation / git-fetch-pack.txt

git-fetch-pack(1)
=================

NAME
----
git-fetch-pack - Receive missing objects from another repository


SYNOPSIS
--------
'git-fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]

DESCRIPTION
-----------
Usually you would want to use gitlink:git-fetch[1] which is a
higher level wrapper of this command instead.

Invokes 'git-upload-pack' on a potentially remote repository,
and asks it to send objects missing from this repository, to
update the named heads.  The list of commits available locally
is found out by scanning local $GIT_DIR/refs/ and sent to
'git-upload-pack' running on the other end.

This command degenerates to download everything to complete the
asked refs from the remote side when the local side does not
have a common ancestor commit.


OPTIONS
-------
\--all::
	Fetch all remote refs.

\--quiet, \-q::
	Pass '-q' flag to 'git-unpack-objects'; this makes the
	cloning process less verbose.

\--keep, \-k::
	Do not invoke 'git-unpack-objects' on received data, but
	create a single packfile out of it instead, and store it
	in the object database. If provided twice then the pack is
	locked against repacking.

\--thin::
	Spend extra cycles to minimize the number of objects to be sent.
	Use it on slower connection.

\--upload-pack=<git-upload-pack>::
	Use this to specify the path to 'git-upload-pack' on the
	remote side, if is not found on your $PATH.
	Installations of sshd ignores the user's environment
	setup scripts for login shells (e.g. .bash_profile) and
	your privately installed git may not be found on the system
	default $PATH.  Another workaround suggested is to set
	up your $PATH in ".bashrc", but this flag is for people
	who do not want to pay the overhead for non-interactive
	shells by having a lean .bashrc file (they set most of
	the things up in .bash_profile).

\--exec=<git-upload-pack>::
	Same as \--upload-pack=<git-upload-pack>.

\--depth=<n>::
	Limit fetching to ancestor-chains not longer than n.

\--no-progress::
	Do not show the progress.

\-v::
	Run verbosely.

<host>::
	A remote host that houses the repository.  When this
	part is specified, 'git-upload-pack' is invoked via
	ssh.

<directory>::
	The repository to sync from.

<refs>...::
	The remote heads to update from. This is relative to
	$GIT_DIR (e.g. "HEAD", "refs/heads/master").  When
	unspecified, update from all heads the remote side has.


Author
------
Written by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by Junio C Hamano.

GIT
---
Part of the gitlink:git[7] suite
Commit	Line	Data
8b3d9dc0 JH	1	git-fetch-pack(1)
8b3d9dc0 JH	2	=================
8b3d9dc0 JH	3
	4	NAME
	5	----
7bd7f280	6	git-fetch-pack - Receive missing objects from another repository
8b3d9dc0 JH	7
	8
	9	SYNOPSIS
	10	--------
83a5ad61	11	'git-fetch-pack' [--all] [--quiet\|-q] [--keep\|-k] [--thin] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
8b3d9dc0 JH	12
	13	DESCRIPTION
	14	-----------
5cb545fa JH	15	Usually you would want to use gitlink:git-fetch[1] which is a
	16	higher level wrapper of this command instead.
	17
8b3d9dc0 JH	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
33b83034 JH	21	is found out by scanning local $GIT_DIR/refs/ and sent to
33b83034 JH	22	'git-upload-pack' running on the other end.
8b3d9dc0	23
33b83034 JH	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.
8b3d9dc0 JH	27
	28
	29	OPTIONS
	30	-------
18bd8821 UKK	31	\--all::
	32	Fetch all remote refs.
	33
	34	\--quiet, \-q::
8b3d9dc0 JH	35	Pass '-q' flag to 'git-unpack-objects'; this makes the
	36	cloning process less verbose.
	37
18bd8821	38	\--keep, \-k::
ad897215 JH	39	Do not invoke 'git-unpack-objects' on received data, but
ad897215 JH	40	create a single packfile out of it instead, and store it
da093d37 NP	41	in the object database. If provided twice then the pack is
da093d37 NP	42	locked against repacking.
ad897215	43
18bd8821 UKK	44	\--thin::
	45	Spend extra cycles to minimize the number of objects to be sent.
	46	Use it on slower connection.
	47
27dca07f	48	\--upload-pack=<git-upload-pack>::
8b3d9dc0 JH	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
72e9340c	53	your privately installed git may not be found on the system
8b3d9dc0 JH	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).
	59
27dca07f UKK	60	\--exec=<git-upload-pack>::
	61	Same as \--upload-pack=<git-upload-pack>.
	62
18bd8821 UKK	63	\--depth=<n>::
	64	Limit fetching to ancestor-chains not longer than n.
	65
83a5ad61 JS	66	\--no-progress::
	67	Do not show the progress.
	68
18bd8821 UKK	69	\-v::
	70	Run verbosely.
	71
8b3d9dc0 JH	72	<host>::
	73	A remote host that houses the repository. When this
	74	part is specified, 'git-upload-pack' is invoked via
	75	ssh.
	76
	77	<directory>::
	78	The repository to sync from.
	79
33b83034	80	<refs>...::
8b3d9dc0 JH	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.
	84
8b3d9dc0 JH	85
	86	Author
	87	------
	88	Written by Linus Torvalds <torvalds@osdl.org>
	89
	90	Documentation
	91	--------------
	92	Documentation by Junio C Hamano.
	93
	94	GIT
	95	---
a7154e91	96	Part of the gitlink:git[7] suite