Documentation: use [verse] for SYNOPSIS sections
[alt-git.git] / Documentation / git-fetch-pack.txt
blobed1bdaacd10788ab35a2ae1de870d5972e30d432
1 git-fetch-pack(1)
2 =================
4 NAME
5 ----
6 git-fetch-pack - Receive missing objects from another repository
9 SYNOPSIS
10 --------
11 [verse]
12 'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
14 DESCRIPTION
15 -----------
16 Usually you would want to use 'git fetch', which is a
17 higher level wrapper of this command, instead.
19 Invokes 'git-upload-pack' on a possibly remote repository
20 and asks it to send objects missing from this repository, to
21 update the named heads.  The list of commits available locally
22 is found out by scanning the local refs/ hierarchy and sent to
23 'git-upload-pack' running on the other end.
25 This command degenerates to download everything to complete the
26 asked refs from the remote side when the local side does not
27 have a common ancestor commit.
30 OPTIONS
31 -------
32 --all::
33         Fetch all remote refs.
35 -q::
36 --quiet::
37         Pass '-q' flag to 'git unpack-objects'; this makes the
38         cloning process less verbose.
40 -k::
41 --keep::
42         Do not invoke 'git unpack-objects' on received data, but
43         create a single packfile out of it instead, and store it
44         in the object database. If provided twice then the pack is
45         locked against repacking.
47 --thin::
48         Fetch a "thin" pack, which records objects in deltified form based
49         on objects not included in the pack to reduce network traffic.
51 --include-tag::
52         If the remote side supports it, annotated tags objects will
53         be downloaded on the same connection as the other objects if
54         the object the tag references is downloaded.  The caller must
55         otherwise determine the tags this option made available.
57 --upload-pack=<git-upload-pack>::
58         Use this to specify the path to 'git-upload-pack' on the
59         remote side, if is not found on your $PATH.
60         Installations of sshd ignores the user's environment
61         setup scripts for login shells (e.g. .bash_profile) and
62         your privately installed git may not be found on the system
63         default $PATH.  Another workaround suggested is to set
64         up your $PATH in ".bashrc", but this flag is for people
65         who do not want to pay the overhead for non-interactive
66         shells by having a lean .bashrc file (they set most of
67         the things up in .bash_profile).
69 --exec=<git-upload-pack>::
70         Same as \--upload-pack=<git-upload-pack>.
72 --depth=<n>::
73         Limit fetching to ancestor-chains not longer than n.
75 --no-progress::
76         Do not show the progress.
78 -v::
79         Run verbosely.
81 <host>::
82         A remote host that houses the repository.  When this
83         part is specified, 'git-upload-pack' is invoked via
84         ssh.
86 <directory>::
87         The repository to sync from.
89 <refs>...::
90         The remote heads to update from. This is relative to
91         $GIT_DIR (e.g. "HEAD", "refs/heads/master").  When
92         unspecified, update from all heads the remote side has.
94 GIT
95 ---
96 Part of the linkgit:git[1] suite