Documentation: format full commands in typewriter font
[git/git.git] / Documentation / fetch-options.txt
CommitLineData
9c4a036b
BG
1--all::
2 Fetch all remotes.
3
3240240f
SB
4-a::
5--append::
93d69d86
JL
6 Append ref names and object names of fetched refs to the
7 existing contents of `.git/FETCH_HEAD`. Without this
8 option old data in `.git/FETCH_HEAD` will be overwritten.
9
6b276e19
JA
10--depth=<depth>::
11 Deepen the history of a 'shallow' repository created by
12 `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13 by the specified number of commits.
2c620a1a 14
28a15401
JS
15ifndef::git-pull[]
16--dry-run::
17 Show what would be done, without making any changes.
18endif::git-pull[]
19
3240240f
SB
20-f::
21--force::
ba020ef5 22 When 'git-fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
23 refspec, it refuses to update the local branch
24 `<lbranch>` unless the remote branch `<rbranch>` it
25 fetches is a descendant of `<lbranch>`. This option
26 overrides that check.
93d69d86 27
6b276e19
JA
28-k::
29--keep::
30 Keep downloaded pack.
31
16679e37
BG
32ifndef::git-pull[]
33--multiple::
34 Allow several <repository> and <group> arguments to be
35 specified. No <refspec>s may be specified.
f360d844
JS
36
37--prune::
38 After fetching, remove any remote tracking branches which
39 no longer exist on the remote.
16679e37
BG
40endif::git-pull[]
41
10eb64f5 42ifdef::git-pull[]
3240240f 43--no-tags::
10eb64f5
MV
44endif::git-pull[]
45ifndef::git-pull[]
3240240f
SB
46-n::
47--no-tags::
10eb64f5
MV
48endif::git-pull[]
49 By default, tags that point at objects that are downloaded
50 from the remote repository are fetched and stored locally.
51 This option disables this automatic tag following.
03febf99 52
3240240f
SB
53-t::
54--tags::
03febf99
JH
55 Most of the tags are fetched automatically as branch
56 heads are downloaded, but tags that do not point at
57 objects reachable from the branch heads that are being
58 tracked will not be fetched by this mechanism. This
59 flag lets all tags and their associated objects be
60 downloaded.
93d69d86 61
3240240f
SB
62-u::
63--update-head-ok::
ba020ef5 64 By default 'git-fetch' refuses to update the head which
93d69d86 65 corresponds to the current branch. This flag disables the
ba020ef5
JN
66 check. This is purely for the internal use for 'git-pull'
67 to communicate with 'git-fetch', and unless you are
a597fb0e
JH
68 implementing your own Porcelain you are not supposed to
69 use it.
03febf99 70
6b276e19
JA
71--upload-pack <upload-pack>::
72 When given, and the repository to fetch from is handled
73 by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
74 the command to specify non-default path for the command
75 run on the other end.
76
77ifndef::git-pull[]
78-q::
79--quiet::
80 Pass --quiet to git-fetch-pack and silence any other internally
81 used git commands.
82
83-v::
84--verbose::
85 Be verbose.
86endif::git-pull[]