Merge branch 'maint'
[gitweb.git] / Documentation / git-fetch-pack.txt
index 1d281820cfe7f492cb32369b8b8cb60a5d040d89..4a8487c1547abc156c8fad9e7cafe4d3c5a535f6 100644 (file)
@@ -1,22 +1,24 @@
 git-fetch-pack(1)
 =================
-v0.1, July 2005
 
 NAME
 ----
-git-fetch-pack - Receive missing objects from another repository.
+git-fetch-pack - Receive missing objects from another repository
 
 
 SYNOPSIS
 --------
-git-fetch-pack [-q] [--exec=<git-upload-pack>] [<host>:]<directory> [<refs>...]
+'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
 
 DESCRIPTION
 -----------
-Invokes 'git-upload-pack' on a potentially remote repository,
+Usually you would want to use 'git fetch', which is a
+higher level wrapper of this command, instead.
+
+Invokes 'git-upload-pack' on a possibly 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
+is found out by scanning the local refs/ hierarchy and sent to
 'git-upload-pack' running on the other end.
 
 This command degenerates to download everything to complete the
@@ -26,22 +28,55 @@ have a common ancestor commit.
 
 OPTIONS
 -------
+--all::
+       Fetch all remote refs.
+
 -q::
-       Pass '-q' flag to 'git-unpack-objects'; this makes the
+--quiet::
+       Pass '-q' flag to 'git unpack-objects'; this makes the
        cloning process less verbose.
 
---exec=<git-upload-pack>::
+-k::
+--keep::
+       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::
+       Fetch a "thin" pack, which records objects in deltified form based
+       on objects not included in the pack to reduce network traffic.
+
+--include-tag::
+       If the remote side supports it, annotated tags objects will
+       be downloaded on the same connection as the other objects if
+       the object the tag references is downloaded.  The caller must
+       otherwise determine the tags this option made available.
+
+--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
+       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
@@ -66,4 +101,4 @@ Documentation by Junio C Hamano.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite