Merge branch 'jt/merge-recursive-symlink-is-not-a-dir-in-way'
[alt-git.git] / Documentation / config / remote.txt
bloba8e6437a903592934198fb212ede8241d6acebca
1 remote.pushDefault::
2         The remote to push to by default.  Overrides
3         `branch.<name>.remote` for all branches, and is overridden by
4         `branch.<name>.pushRemote` for specific branches.
6 remote.<name>.url::
7         The URL of a remote repository.  See linkgit:git-fetch[1] or
8         linkgit:git-push[1].
10 remote.<name>.pushurl::
11         The push URL of a remote repository.  See linkgit:git-push[1].
13 remote.<name>.proxy::
14         For remotes that require curl (http, https and ftp), the URL to
15         the proxy to use for that remote.  Set to the empty string to
16         disable proxying for that remote.
18 remote.<name>.proxyAuthMethod::
19         For remotes that require curl (http, https and ftp), the method to use for
20         authenticating against the proxy in use (probably set in
21         `remote.<name>.proxy`). See `http.proxyAuthMethod`.
23 remote.<name>.fetch::
24         The default set of "refspec" for linkgit:git-fetch[1]. See
25         linkgit:git-fetch[1].
27 remote.<name>.push::
28         The default set of "refspec" for linkgit:git-push[1]. See
29         linkgit:git-push[1].
31 remote.<name>.mirror::
32         If true, pushing to this remote will automatically behave
33         as if the `--mirror` option was given on the command line.
35 remote.<name>.skipDefaultUpdate::
36         If true, this remote will be skipped by default when updating
37         using linkgit:git-fetch[1] or the `update` subcommand of
38         linkgit:git-remote[1].
40 remote.<name>.skipFetchAll::
41         If true, this remote will be skipped by default when updating
42         using linkgit:git-fetch[1] or the `update` subcommand of
43         linkgit:git-remote[1].
45 remote.<name>.receivepack::
46         The default program to execute on the remote side when pushing.  See
47         option --receive-pack of linkgit:git-push[1].
49 remote.<name>.uploadpack::
50         The default program to execute on the remote side when fetching.  See
51         option --upload-pack of linkgit:git-fetch-pack[1].
53 remote.<name>.tagOpt::
54         Setting this value to --no-tags disables automatic tag following when
55         fetching from remote <name>. Setting it to --tags will fetch every
56         tag from remote <name>, even if they are not reachable from remote
57         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
58         override this setting. See options --tags and --no-tags of
59         linkgit:git-fetch[1].
61 remote.<name>.vcs::
62         Setting this to a value <vcs> will cause Git to interact with
63         the remote with the git-remote-<vcs> helper.
65 remote.<name>.prune::
66         When set to true, fetching from this remote by default will also
67         remove any remote-tracking references that no longer exist on the
68         remote (as if the `--prune` option was given on the command line).
69         Overrides `fetch.prune` settings, if any.
71 remote.<name>.pruneTags::
72         When set to true, fetching from this remote by default will also
73         remove any local tags that no longer exist on the remote if pruning
74         is activated in general via `remote.<name>.prune`, `fetch.prune` or
75         `--prune`. Overrides `fetch.pruneTags` settings, if any.
77 See also `remote.<name>.prune` and the PRUNING section of
78 linkgit:git-fetch[1].
80 remote.<name>.promisor::
81         When set to true, this remote will be used to fetch promisor
82         objects.
84 remote.<name>.partialclonefilter::
85         The filter that will be applied when fetching from this
86         promisor remote.