branch: support configuring --sort via .gitconfig
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
2de9b711
TA
4The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
66e35fcb
SB
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
773002a7 8fallback values for the `.git/config` file. The file `/etc/gitconfig`
66e35fcb 9can be used to store a system-wide default configuration.
5ea5621f 10
2de9b711 11The configuration variables are used by both the Git plumbing
b7ee2266
SB
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
1ab661dd 14dot-separated segment and the section name is everything before the last
e0a4aae8
LP
15dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
a5285b6c
JH
17variables may appear multiple times; we say then that the variable is
18multivalued.
1ab661dd 19
e136f33b
JN
20Syntax
21~~~~~~
22
1ab661dd 23The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
24ignored. The '#' and ';' characters begin comments to the end of line,
25blank lines are ignored.
26
27The file consists of sections and variables. A section begins with
28the name of the section in square brackets and continues until the next
05c3e5c7 29section begins. Section names are case-insensitive. Only alphanumeric
dcb11263 30characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
31must belong to some section, which means that there must be a section
32header before the first setting of a variable.
e136f33b
JN
33
34Sections can be further divided into subsections. To begin a subsection
35put its name in double quotes, separated by space from the section name,
773002a7 36in the section header, like in the example below:
e136f33b
JN
37
38--------
39 [section "subsection"]
40
41--------
42
b7ee2266 43Subsection names are case sensitive and can contain any characters except
1feb0617
DB
44newline and the null byte. Doublequote `"` and backslash can be included
45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46other characters are dropped when reading; for example, `\t` is read as
47`t` and `\0` is read as `0` Section headers cannot span multiple lines.
48Variables may belong directly to a section or to a given subsection. You
49can have `[section]` if you have `[section "subsection"]`, but you don't
50need to.
e136f33b 51
f7376329
CMN
52There is also a deprecated `[section.subsection]` syntax. With this
53syntax, the subsection name is converted to lower-case and is also
54compared case sensitively. These subsection names follow the same
55restrictions as section names.
e136f33b 56
2ceb639f
NS
57All the other lines (and the remainder of the line after the section
58header) are recognized as setting variables, in the form
1c448b3b
JH
59'name = value' (or just 'name', which is a short-hand to say that
60the variable is the boolean "true").
e0a4aae8 61The variable names are case-insensitive, allow only alphanumeric characters
a5285b6c 62and `-`, and must start with an alphabetic character.
e136f33b 63
ff5507ed
JH
64A line that defines a value can be continued to the next line by
65ending it with a `\`; the backquote and the end-of-line are
66stripped. Leading whitespaces after 'name =', the remainder of the
67line after the first comment character '#' or ';', and trailing
68whitespaces of the line are discarded unless they are enclosed in
69double quotes. Internal whitespaces within the value are retained
70verbatim.
e136f33b 71
ff5507ed
JH
72Inside double quotes, double quote `"` and backslash `\` characters
73must be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 74
dcb11263
CJ
75The following escape sequences (beside `\"` and `\\`) are recognized:
76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
a58088ab
JL
77and `\b` for backspace (BS). Other char escape sequences (including octal
78escape sequences) are invalid.
e136f33b 79
1ab661dd 80
9b25a0b5
JK
81Includes
82~~~~~~~~
83
9d71d94d
JK
84The `include` and `includeIf` sections allow you to include config
85directives from another source. These sections behave identically to
86each other with the exception that `includeIf` sections may be ignored
87if their condition does not evaluate to true; see "Conditional includes"
88below.
89
df0233be 90You can include a config file from another by setting the special
9d71d94d
JK
91`include.path` (or `includeIf.*.path`) variable to the name of the file
92to be included. The variable takes a pathname as its value, and is
93subject to tilde expansion. These variables can be given multiple times.
dca83abd 94
a076df28
JK
95The contents of the included file are inserted immediately, as if they
96had been found at the location of the include directive. If the value of the
9d71d94d 97variable is a relative path, the path is considered to
1050e987
NTND
98be relative to the configuration file in which the include directive
99was found. See below for examples.
dca83abd 100
3efd0bed
NTND
101Conditional includes
102~~~~~~~~~~~~~~~~~~~~
103
104You can include a config file from another conditionally by setting a
105`includeIf.<condition>.path` variable to the name of the file to be
9d71d94d 106included.
3efd0bed
NTND
107
108The condition starts with a keyword followed by a colon and some data
109whose format and meaning depends on the keyword. Supported keywords
110are:
111
112`gitdir`::
113
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
117+
118The .git location may be auto-discovered, or come from `$GIT_DIR`
119environment variable. If the repository is auto discovered via a .git
120file (e.g. from submodules, or a linked worktree), the .git location
121would be the final location where the .git directory is, not where the
122.git file is.
123+
124The pattern can contain standard globbing wildcards and two additional
125ones, `**/` and `/**`, that can match multiple path components. Please
126refer to linkgit:gitignore[5] for details. For convenience:
127
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
130
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
133
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
137
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
141
142`gitdir/i`::
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
145
146A few more notes on matching via `gitdir` and `gitdir/i`:
147
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
149
0624c63c
ÆAB
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
153 will match.
154+
155This was not the case in the initial release of this feature in
156v2.13.0, which only matched the realpath version. Configuration that
157wants to be compatible with the initial release of this feature needs
158to either specify only the realpath version, or both versions.
159
3efd0bed
NTND
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
9b25a0b5 162
1ab661dd
PB
163Example
164~~~~~~~
165
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
170
171 # Our diff algorithm
172 [diff]
6bb9e51b 173 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
174 renames = true
175
910c00c8
AK
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
179
e136f33b
JN
180 # Proxy settings
181 [core]
29093c28 182 gitProxy="ssh" for "kernel.org"
e136f33b 183 gitProxy=default-proxy ; for the rest
910c00c8 184
9b25a0b5
JK
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
ce933ebd
JK
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
9b25a0b5 189
3efd0bed
NTND
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
193
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
197
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
5f7b91ba 201
994cd6c7
JK
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
206 path = foo.inc
207
5f7b91ba
JH
208Values
209~~~~~~
210
211Values of many variables are treated as a simple string, but there
212are variables that take values of specific types and there are rules
213as to how to spell them.
214
215boolean::
216
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
219 case-insensitive.
220
7f0a02be
AH
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
5f7b91ba
JH
223 is taken as true.
224
7f0a02be
AH
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
5f7b91ba 227+
bcf9626a 228When converting value to the canonical form using `--bool` type
7f0a02be 229specifier, 'git config' will ensure that the output is "true" or
5f7b91ba
JH
230"false" (spelled in lowercase).
231
232integer::
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
236
b92c1a28 237color::
adb33566
JK
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
5f456b3c 241+
adb33566
JK
242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243`blue`, `magenta`, `cyan` and `white`. The first color given is the
244foreground; the second is the background.
5ee87585 245+
adb33566
JK
246Colors may also be given as numbers between 0 and 255; these use ANSI
247256-color mode (but note that not all terminals may support this). If
248your terminal supports it, you may also specify 24-bit RGB values as
249hex, like `#ff0ab3`.
250+
9dc3515c
JK
251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
253The position of any attributes with respect to the colors
54590a0e
JK
254(before, after, or in between), doesn't matter. Specific attributes may
255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256`no-ul`, etc).
adb33566 257+
512aba26
JK
258An empty color string produces no color effect at all. This can be used
259to avoid coloring specific elements without disabling color entirely.
260+
adb33566
JK
261For git's pre-defined color slots, the attributes are meant to be reset
262at the beginning of each item in the colored output. So setting
263`color.decorate.branch` to `black` will paint that branch name in a
264plain `black`, even if the previous thing on the same output line (e.g.
265opening parenthesis before the list of branch names in `log --decorate`
266output) is set to be painted with `bold` or some other attribute.
267However, custom log formats may do more complicated and layered
268coloring, and the negated forms may be useful there.
b92c1a28 269
dca83abd
JH
270pathname::
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
276
5f7b91ba 277
1ab661dd
PB
278Variables
279~~~~~~~~~
280
281Note that this list is non-comprehensive and not necessarily complete.
b8936cf0 282For command-specific variables, you will find a more detailed description
93728b23
CA
283in the appropriate manual page.
284
285Other git-related tools may and do use their own variables. When
286inventing new variables for use in your own tool, make sure their
287names do not conflict with those that are used by Git itself and
288other popular tools, and describe them in your documentation.
289
1ab661dd 290
75194438 291advice.*::
26e94af0
JH
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
75194438
JK
295+
296--
1184564e 297 pushUpdateRejected::
f25950f3 298 Set this variable to 'false' if you want to disable
009055f3 299 'pushNonFFCurrent',
75e5c0dc
JH
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
b4505682 302 simultaneously.
f25950f3
CT
303 pushNonFFCurrent::
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
f25950f3
CT
306 pushNonFFMatching::
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
b4505682
CR
311 pushAlreadyExists::
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
75e5c0dc
JH
314 pushFetchFirst::
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
318 pushNeedsForce::
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
a8a5406a
RH
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
edf563fb 323 statusHints::
83c750ac 324 Show directions on how to proceed from the current
552755a8 325 state in the output of linkgit:git-status[1], in
83c750ac 326 the template shown when writing commit messages in
552755a8
MM
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
6a38ef2c
NTND
329 statusUoption::
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
332 files.
4c371f91
MM
333 commitBeforeMerge::
334 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 335 merge to avoid overwriting local changes.
d38a30df 336 resolveConflict::
4f021b34 337 Advice shown by various commands when conflicts
d38a30df 338 prevent the operation from being performed.
b706fcfe
JK
339 implicitIdentity::
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
26e94af0 342 domain name.
13be3e31 343 detachedHead::
26e94af0 344 Advice shown when you used linkgit:git-checkout[1] to
13be3e31 345 move to the detach HEAD state, to instruct how to create
26e94af0 346 a local branch after the fact.
ad8d5104
ÆAB
347 checkoutAmbiguousRemoteBranchName::
348 Advice shown when the argument to
349 linkgit:git-checkout[1] ambiguously resolves to a
350 remote tracking branch on more than one remote in
351 situations where an unambiguous argument would have
352 otherwise caused a remote-tracking branch to be
8d7b558b
ÆAB
353 checked out. See the `checkout.defaultRemote`
354 configuration variable for how to set a given remote
355 to used by default in some situations where this
356 advice would be printed.
14bf2d58
PG
357 amWorkDir::
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
7e309446
MLM
360 rmHints::
361 In case of failure in the output of linkgit:git-rm[1],
362 show directions on how to proceed from the current state.
53213994
JK
363 addEmbeddedRepo::
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
f805a00a 366 ignoredHook::
928f0ab4 367 Advice shown if a hook is ignored because the hook is not
f805a00a 368 set as executable.
abfb04d0
LS
369 waitingForEditor::
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
75194438
JK
372--
373
1ab661dd 374core.fileMode::
ecdab412
TB
375 Tells Git if the executable bit of files in the working tree
376 is to be honored.
7b357240 377+
ecdab412 378Some filesystems lose the executable bit when a file that is
449456ad 379marked as executable is checked out, or checks out a
ecdab412
TB
380non-executable file with executable bit on.
381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382to see if it handles the executable bit correctly
383and this variable is automatically set as necessary.
384+
385A repository, however, may be on a filesystem that handles
386the filemode correctly, and this variable is set to 'true'
387when created, but later may be made accessible from another
388environment that loses the filemode (e.g. exporting ext4 via
389CIFS mount, visiting a Cygwin created repository with
390Git for Windows or Eclipse).
391In such a case it may be necessary to set this variable to 'false'.
392See linkgit:git-update-index[1].
393+
394The default is true (when core.filemode is not specified in the config file).
1ab661dd 395
f30afdab
JS
396core.hideDotFiles::
397 (Windows-only) If true, mark newly-created directories and files whose
398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
399 directory is hidden, but no other files starting with a dot. The
400 default mode is 'dotGitOnly'.
401
da0005b8 402core.ignoreCase::
48294b51 403 Internal variable which enables various workarounds to enable
2de9b711 404 Git to work better on filesystems that are not case sensitive,
48294b51
MS
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
7b357240
MO
407 it is really the same file, and continue to remember it as
408 "Makefile".
409+
410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
da0005b8 411will probe and set core.ignoreCase true if appropriate when the repository
7b357240 412is created.
48294b51
MS
413+
414Git relies on the proper configuration of this variable for your operating
415and file system. Modifying this value may result in unexpected behavior.
7b357240 416
da0005b8 417core.precomposeUnicode::
2de9b711 418 This option is only used by Mac OS implementation of Git.
da0005b8 419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
76759c7d
TB
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
2de9b711
TA
422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
423 When false, file names are handled fully transparent by Git,
424 which is backward compatible with older versions of Git.
76759c7d 425
a42643aa
JK
426core.protectHFS::
427 If set to true, do not allow checkout of paths that would
428 be considered equivalent to `.git` on an HFS+ filesystem.
429 Defaults to `true` on Mac OS, and `false` elsewhere.
430
2b4c6efc
JS
431core.protectNTFS::
432 If set to true, do not allow checkout of paths that would
433 cause problems with the NTFS filesystem, e.g. conflict with
434 8.3 "short" names.
435 Defaults to `true` on Windows, and `false` elsewhere.
436
780494b1
BP
437core.fsmonitor::
438 If set, the value of this variable is used as a command which
439 will identify all files that may have changed since the
440 requested date/time. This information is used to speed up git by
441 avoiding unnecessary processing of files that have not changed.
442 See the "fsmonitor-watchman" section of linkgit:githooks[5].
443
1ce4790b
AR
444core.trustctime::
445 If false, the ctime differences between the index and the
f7d650c0 446 working tree are ignored; useful when the inode change time
1ce4790b
AR
447 is regularly modified by something outside Git (file system
448 crawlers and some backup systems).
449 See linkgit:git-update-index[1]. True by default.
450
66f9e7a6
CC
451core.splitIndex::
452 If true, the split-index feature of the index will be used.
453 See linkgit:git-update-index[1]. False by default.
454
435ec090
CC
455core.untrackedCache::
456 Determines what to do about the untracked cache feature of the
457 index. It will be kept, if this variable is unset or set to
458 `keep`. It will automatically be added if set to `true`. And
459 it will automatically be removed, if set to `false`. Before
460 setting it to `true`, you should check that mtime is working
461 properly on your system.
462 See linkgit:git-update-index[1]. `keep` by default.
463
da0005b8 464core.checkStat::
c08e4d5b
RR
465 Determines which stat fields to match between the index
466 and work tree. The user can set this to 'default' or
467 'minimal'. Default (or explicitly 'default'), is to check
468 all fields, including the sub-second part of mtime and ctime.
469
da0005b8 470core.quotePath::
860cd699
AH
471 Commands that output paths (e.g. 'ls-files', 'diff'), will
472 quote "unusual" characters in the pathname by enclosing the
473 pathname in double-quotes and escaping those characters with
474 backslashes in the same way C escapes control characters (e.g.
475 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
476 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
477 UTF-8). If this variable is set to false, bytes higher than
478 0x80 are not considered "unusual" any more. Double-quotes,
479 backslash and control characters are always escaped regardless
480 of the setting of this variable. A simple space character is
481 not considered "unusual". Many commands can output pathnames
482 completely verbatim using the `-z` option. The default value
483 is true.
9378c161 484
942e7747
EB
485core.eol::
486 Sets the line ending type to use in the working directory for
70ad8c8d
TB
487 files that have the `text` property set when core.autocrlf is false.
488 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
489 native line ending. The default value is `native`. See
942e7747
EB
490 linkgit:gitattributes[5] for more information on end-of-line
491 conversion.
5cb71f82 492
21e5ad50 493core.safecrlf::
2de9b711 494 If true, makes Git check if converting `CRLF` is reversible when
fd6cce9e 495 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
496 modifies a file in the work tree either directly or indirectly.
497 For example, committing a file followed by checking out the
498 same file should yield the original file in the work tree. If
499 this is not the case for the current setting of
2de9b711
TA
500 `core.autocrlf`, Git will reject the file. The variable can
501 be set to "warn", in which case Git will only warn about an
21e5ad50
SP
502 irreversible conversion but continue the operation.
503+
504CRLF conversion bears a slight chance of corrupting data.
2de9b711 505When it is enabled, Git will convert CRLF to LF during commit and LF to
21e5ad50 506CRLF during checkout. A file that contains a mixture of LF and
2de9b711 507CRLF before the commit cannot be recreated by Git. For text
21e5ad50
SP
508files this is the right thing to do: it corrects line endings
509such that we have only LF line endings in the repository.
510But for binary files that are accidentally classified as text the
511conversion can corrupt data.
512+
513If you recognize such corruption early you can easily fix it by
514setting the conversion type explicitly in .gitattributes. Right
515after committing you still have the original file in your work
516tree and this file is not yet corrupted. You can explicitly tell
2de9b711 517Git that this file is binary and Git will handle the file
21e5ad50
SP
518appropriately.
519+
520Unfortunately, the desired effect of cleaning up text files with
521mixed line endings and the undesired effect of corrupting binary
522files cannot be distinguished. In both cases CRLFs are removed
523in an irreversible way. For text files this is the right thing
524to do because CRLFs are line endings, while for binary files
525converting CRLFs corrupts data.
526+
527Note, this safety check does not mean that a checkout will generate a
528file identical to the original file for a different setting of
942e7747
EB
529`core.eol` and `core.autocrlf`, but only for the current one. For
530example, a text file with `LF` would be accepted with `core.eol=lf`
531and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
532resulting file would contain `CRLF`, although the original file
533contained `LF`. However, in both work trees the line endings would be
534consistent, that is either all `LF` or all `CRLF`, but never mixed. A
535file with mixed line endings would be reported by the `core.safecrlf`
536mechanism.
537
942e7747 538core.autocrlf::
65237284
TB
539 Setting this variable to "true" is the same as setting
540 the `text` attribute to "auto" on all files and core.eol to "crlf".
541 Set to true if you want to have `CRLF` line endings in your
542 working directory and the repository has LF line endings.
543 This variable can be set to 'input',
942e7747
EB
544 in which case no output conversion is performed.
545
e92d6225
LS
546core.checkRoundtripEncoding::
547 A comma and/or whitespace separated list of encodings that Git
548 performs UTF-8 round trip checks on if they are used in an
549 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
550 The default value is `SHIFT-JIS`.
551
78a8d641
JS
552core.symlinks::
553 If false, symbolic links are checked out as small plain files that
5162e697
DM
554 contain the link text. linkgit:git-update-index[1] and
555 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 556 file. Useful on filesystems like FAT that do not support
7b357240
MO
557 symbolic links.
558+
559The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
560will probe and set core.symlinks false if appropriate when the repository
561is created.
78a8d641 562
1ab661dd
PB
563core.gitProxy::
564 A "proxy command" to execute (as 'command host port') instead
565 of establishing direct connection to the remote server when
2de9b711 566 using the Git protocol for fetching. If the variable value is
1ab661dd
PB
567 in the "COMMAND for DOMAIN" format, the command is applied only
568 on hostnames ending with the specified domain string. This variable
569 may be set multiple times and is matched in the given order;
570 the first match wins.
b8936cf0 571+
eee7f4a2 572Can be overridden by the `GIT_PROXY_COMMAND` environment variable
b8936cf0
FD
573(which always applies universally, without the special "for"
574handling).
642d0844
ES
575+
576The special string `none` can be used as the proxy command to
577specify that no proxy be used for a given domain pattern.
578This is useful for excluding servers inside a firewall from
579proxy use, while defaulting to a common proxy for external domains.
1ab661dd 580
3c8ede3f
NTND
581core.sshCommand::
582 If this variable is set, `git fetch` and `git push` will
583 use the specified command instead of `ssh` when they need to
584 connect to a remote system. The command is in the same form as
585 the `GIT_SSH_COMMAND` environment variable and is overridden
586 when the environment variable is set.
587
1ab661dd 588core.ignoreStat::
92be938e
PO
589 If true, Git will avoid using lstat() calls to detect if files have
590 changed by setting the "assume-unchanged" bit for those tracked files
591 which it has updated identically in both the index and working tree.
592+
593When files are modified outside of Git, the user will need to stage
594the modified files explicitly (e.g. see 'Examples' section in
595linkgit:git-update-index[1]).
596Git will not normally detect changes to those files.
597+
598This is useful on systems where lstat() calls are very slow, such as
599CIFS/Microsoft Windows.
600+
601False by default.
1ab661dd 602
9f0bb90d
JH
603core.preferSymlinkRefs::
604 Instead of the default "symref" format for HEAD
605 and other symbolic reference files, use symbolic links.
606 This is sometimes needed to work with old scripts that
607 expect HEAD to be a symbolic link.
1ab661dd 608
e4a15f40
SP
609core.bare::
610 If true this repository is assumed to be 'bare' and has no
611 working directory associated with it. If this is the case a
612 number of commands that require a working directory will be
5162e697 613 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 614+
5162e697
DM
615This setting is automatically guessed by linkgit:git-clone[1] or
616linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
617repository that ends in "/.git" is assumed to be not bare (bare =
618false), while all other repositories are assumed to be bare (bare
619= true).
620
892c41b9 621core.worktree::
ea472c1e 622 Set the path to the root of the working tree.
47d81b5c 623 If `GIT_COMMON_DIR` environment variable is set, core.worktree
31e26ebc 624 is ignored and not used for determining the root of working tree.
47d81b5c 625 This can be overridden by the `GIT_WORK_TREE` environment
bcf9626a 626 variable and the `--work-tree` command-line option.
d424a47e 627 The value can be an absolute path or relative to the path to
ea472c1e
JH
628 the .git directory, which is either specified by --git-dir
629 or GIT_DIR, or automatically discovered.
630 If --git-dir or GIT_DIR is specified but none of
302cc11a 631 --work-tree, GIT_WORK_TREE and core.worktree is specified,
ea472c1e 632 the current working directory is regarded as the top level
98acf759 633 of your working tree.
ea472c1e
JH
634+
635Note that this variable is honored even when set in a configuration
636file in a ".git" subdirectory of a directory and its value differs
637from the latter directory (e.g. "/path/to/.git/config" has
638core.worktree set to "/different/path"), which is most likely a
2de9b711 639misconfiguration. Running Git commands in the "/path/to" directory will
ea472c1e
JH
640still use "/different/path" as the root of the work tree and can cause
641confusion unless you know what you are doing (e.g. you are creating a
642read-only snapshot of the same index to a location different from the
643repository's usual working tree).
892c41b9 644
6de08ae6 645core.logAllRefUpdates::
14cd5607 646 Enable the reflog. Updates to a ref <ref> is logged to the file
f212dcc7 647 "`$GIT_DIR/logs/<ref>`", by appending the new and old
d5fa1f1a 648 SHA-1, the date/time and the reason of the update, but
4057deb5 649 only when the file exists. If this configuration
d0c93194 650 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
cd8e3711 651 file is automatically created for branch heads (i.e. under
d0c93194
CW
652 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
653 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
341fb286
CW
654 If it is set to `always`, then a missing reflog is automatically
655 created for any ref under `refs/`.
a862f97e
JH
656+
657This information can be used to determine what commit
658was the tip of a branch "2 days ago".
659+
660This value is true by default in a repository that has
661a working directory associated with it, and false by
662default in a bare repository.
6de08ae6 663
1ab661dd
PB
664core.repositoryFormatVersion::
665 Internal variable identifying the repository format and layout
666 version.
667
668core.sharedRepository::
d5dc6a76
JF
669 When 'group' (or 'true'), the repository is made shareable between
670 several users in a group (making sure all the files and objects are
671 group-writable). When 'all' (or 'world' or 'everybody'), the
672 repository will be readable by all users, additionally to being
2de9b711 673 group-shareable. When 'umask' (or 'false'), Git will use permissions
06cbe855
HO
674 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
675 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
676 user's umask value (whereas the other options will only override
677 requested parts of the user's umask value). Examples: '0660' will make
678 the repo read/write-able for the owner and group, but inaccessible to
679 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
680 repository that is group-readable but not group-writable.
681 See linkgit:git-init[1]. False by default.
1ab661dd
PB
682
683core.warnAmbiguousRefs::
2de9b711 684 If true, Git will warn you if the ref name you passed it is ambiguous
48dfe969 685 and might match multiple refs in the repository. True by default.
1ab661dd 686
3d3e95af 687core.compression::
960ccca6
DH
688 An integer -1..9, indicating a default compression level.
689 -1 is the zlib default. 0 means no compression,
690 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309 691 If set, this provides a default to other compression variables,
ae9f6311 692 such as `core.looseCompression` and `pack.compression`.
960ccca6 693
da0005b8 694core.looseCompression::
12f6c308 695 An integer -1..9, indicating the compression level for objects that
960ccca6 696 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 697 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 698 slowest. If not set, defaults to core.compression. If that is
de1b2460 699 not set, defaults to 1 (best speed).
12f6c308 700
60bb8b14
SP
701core.packedGitWindowSize::
702 Number of bytes of a pack file to map into memory in a
703 single mapping operation. Larger window sizes may allow
704 your system to process a smaller number of large pack files
705 more quickly. Smaller window sizes will negatively affect
eb92242f 706 performance due to increased calls to the operating system's
60bb8b14 707 memory manager, but may improve performance when accessing
22bac0ea
SP
708 a large number of large pack files.
709+
710Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
711MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
712be reasonable for all users/operating systems. You probably do
713not need to adjust this value.
eb92242f
SP
714+
715Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 716
77ccc5bb
SP
717core.packedGitLimit::
718 Maximum number of bytes to map simultaneously into memory
719 from pack files. If Git needs to access more than this many
720 bytes at once to complete an operation it will unmap existing
721 regions to reclaim virtual address space within the process.
22bac0ea 722+
b24a8db1
JK
723Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
724unlimited) on 64 bit platforms.
22bac0ea
SP
725This should be reasonable for all users/operating systems, except on
726the largest projects. You probably do not need to adjust this value.
eb92242f
SP
727+
728Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 729
18bdec11
SP
730core.deltaBaseCacheLimit::
731 Maximum number of bytes to reserve for caching base objects
6b677a28 732 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
733 entire decompressed base objects in a cache Git is able
734 to avoid unpacking and decompressing frequently used base
735 objects multiple times.
736+
4874f544 737Default is 96 MiB on all platforms. This should be reasonable
18bdec11
SP
738for all users/operating systems, except on the largest projects.
739You probably do not need to adjust this value.
740+
741Common unit suffixes of 'k', 'm', or 'g' are supported.
742
5eef828b
SP
743core.bigFileThreshold::
744 Files larger than this size are stored deflated, without
745 attempting delta compression. Storing large files without
746 delta compression avoids excessive memory usage, at the
6bf3b813
NTND
747 slight expense of increased disk usage. Additionally files
748 larger than this size are always treated as binary.
5eef828b
SP
749+
750Default is 512 MiB on all platforms. This should be reasonable
751for most projects as source code and other text files can still
752be delta compressed, but larger binary media files won't be.
753+
754Common unit suffixes of 'k', 'm', or 'g' are supported.
5eef828b 755
da0005b8 756core.excludesFile::
dca83abd
JH
757 Specifies the pathname to the file that contains patterns to
758 describe paths that are not meant to be tracked, in addition
759 to '.gitignore' (per-directory) and '.git/info/exclude'.
f212dcc7
BN
760 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
761 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
dc79687e 762 is used instead. See linkgit:gitignore[5].
0ba956d3 763
da0005b8 764core.askPass::
d3e7da89
AK
765 Some commands (e.g. svn and http interfaces) that interactively
766 ask for a password can be told to use an external program given
eee7f4a2 767 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
453842c9 768 environment variable. If not set, fall back to the value of the
47d81b5c 769 `SSH_ASKPASS` environment variable or, failing that, a simple password
453842c9 770 prompt. The external program shall be given a suitable prompt as
06ab60c0 771 command-line argument and write the password on its STDOUT.
d3e7da89 772
da0005b8 773core.attributesFile::
6df42ab9 774 In addition to '.gitattributes' (per-directory) and
2de9b711 775 '.git/info/attributes', Git looks into this file for attributes
6df42ab9 776 (see linkgit:gitattributes[5]). Path expansions are made the same
da0005b8 777 way as for `core.excludesFile`. Its default value is
f212dcc7
BN
778 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
779 set or empty, `$HOME/.config/git/attributes` is used instead.
6df42ab9 780
867ad08a
ÆAB
781core.hooksPath::
782 By default Git will look for your hooks in the
783 '$GIT_DIR/hooks' directory. Set this to different path,
784 e.g. '/etc/git/hooks', and Git will try to find your hooks in
785 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
786 in '$GIT_DIR/hooks/pre-receive'.
787+
788The path can be either absolute or relative. A relative path is
789taken as relative to the directory where the hooks are run (see
790the "DESCRIPTION" section of linkgit:githooks[5]).
791+
792This configuration variable is useful in cases where you'd like to
793centrally configure your Git hooks instead of configuring them on a
794per-repository basis, or as a more flexible and centralized
795alternative to having an `init.templateDir` where you've changed
796default hooks.
797
ef0c2abf 798core.editor::
e7e183d6
KM
799 Commands such as `commit` and `tag` that let you edit
800 messages by launching an editor use the value of this
ef0c2abf 801 variable when it is set, and the environment variable
b4479f07 802 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 803
da0005b8 804core.commentChar::
e7e183d6 805 Commands such as `commit` and `tag` that let you edit
eff80a9f
JH
806 messages consider a line that begins with this character
807 commented, and removes them after the editor returns
808 (default '#').
84c9dc2c
NTND
809+
810If set to "auto", `git-commit` would select a character that is not
811the beginning character of any line in existing commit messages.
eff80a9f 812
4ff0f01c
MH
813core.filesRefLockTimeout::
814 The length of time, in milliseconds, to retry when trying to
815 lock an individual reference. Value 0 means not to retry at
816 all; -1 means to try indefinitely. Default is 100 (i.e.,
817 retry for 100ms).
818
f4ab4f3a
MH
819core.packedRefsTimeout::
820 The length of time, in milliseconds, to retry when trying to
821 lock the `packed-refs` file. Value 0 means not to retry at
822 all; -1 means to try indefinitely. Default is 1000 (i.e.,
823 retry for 1 second).
824
821881d8 825sequence.editor::
3322ad42 826 Text editor used by `git rebase -i` for editing the rebase instruction file.
821881d8
PO
827 The value is meant to be interpreted by the shell when it is used.
828 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
829 When not configured the default commit message editor is used instead.
830
54adf370 831core.pager::
97d01f2a
JH
832 Text viewer for use by Git commands (e.g., 'less'). The value
833 is meant to be interpreted by the shell. The order of preference
834 is the `$GIT_PAGER` environment variable, then `core.pager`
835 configuration, then `$PAGER`, and then the default chosen at
836 compile time (usually 'less').
837+
b3275838 838When the `LESS` environment variable is unset, Git sets it to `FRX`
97d01f2a
JH
839(if `LESS` environment variable is set, Git does not change it at
840all). If you want to selectively override Git's default setting
b3275838 841for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
97d01f2a 842be passed to the shell by Git, which will translate the final
b3275838
MM
843command to `LESS=FRX less -S`. The environment does not set the
844`S` option but the command line does, instructing less to truncate
845long lines. Similarly, setting `core.pager` to `less -+F` will
846deactivate the `F` option specified by the environment from the
847command-line, deactivating the "quit if one screen" behavior of
848`less`. One can specifically activate some flags for particular
849commands: for example, setting `pager.blame` to `less -S` enables
850line truncation only for `git blame`.
e54c1f2d
JN
851+
852Likewise, when the `LV` environment variable is unset, Git sets it
853to `-c`. You can override this setting by exporting `LV` with
854another value or setting `core.pager` to `lv +c`.
54adf370 855
91af7ae5
JH
856core.whitespace::
857 A comma separated list of common whitespace problems to
0b444cdb
TR
858 notice. 'git diff' will use `color.diff.whitespace` to
859 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
860 consider them as errors. You can prefix `-` to disable
861 any of them (e.g. `-trailing-space`):
91af7ae5 862+
aeb84b05 863* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
864 as an error (enabled by default).
865* `space-before-tab` treats a space character that appears immediately
866 before a tab character in the initial indent part of the line as an
867 error (enabled by default).
2ce4fee8
WL
868* `indent-with-non-tab` treats a line that is indented with space
869 characters instead of the equivalent tabs as an error (not enabled by
870 default).
3e3ec2ab
CW
871* `tab-in-indent` treats a tab character in the initial indent part of
872 the line as an error (not enabled by default).
77b15bbd
JH
873* `blank-at-eof` treats blank lines added at the end of file as an error
874 (enabled by default).
aeb84b05
JH
875* `trailing-space` is a short-hand to cover both `blank-at-eol` and
876 `blank-at-eof`.
b2979ff5
JH
877* `cr-at-eol` treats a carriage-return at the end of line as
878 part of the line terminator, i.e. with it, `trailing-space`
879 does not trigger if the character before such a carriage-return
880 is not a whitespace (not enabled by default).
f4b05a49 881* `tabwidth=<n>` tells how many character positions a tab occupies; this
2de9b711 882 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
f4b05a49 883 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 884
da0005b8 885core.fsyncObjectFiles::
aafe9fba
LT
886 This boolean will enable 'fsync()' when writing object files.
887+
888This is a total waste of time and effort on a filesystem that orders
889data writes properly, but can be useful for filesystems that do not use
890journalling (traditional UNIX filesystems) or that only journal metadata
891and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
892
da0005b8 893core.preloadIndex::
671c9b7e
LT
894 Enable parallel index preload for operations like 'git diff'
895+
896This can speed up operations like 'git diff' and 'git status' especially
897on filesystems like NFS that have weak caching semantics and thus
299e2987 898relatively high IO latencies. When enabled, Git will do the
671c9b7e 899index comparison to the filesystem data in parallel, allowing
299e2987 900overlapping IO's. Defaults to true.
671c9b7e 901
348df166
JS
902core.createObject::
903 You can set this to 'link', in which case a hardlink followed by
904 a delete of the source are used to make sure that object creation
905 will not overwrite existing objects.
906+
907On some file system/operating system combinations, this is unreliable.
908Set this config setting to 'rename' there; However, This will remove the
909check that makes sure that existing object files will not get overwritten.
be66a6c4 910
a97a7468
JS
911core.notesRef::
912 When showing commit messages, also show notes which are stored in
9eb3f816
JN
913 the given ref. The ref must be fully qualified. If the given
914 ref does not exist, it is not an error but means that no
915 notes should be printed.
a97a7468 916+
9eb3f816 917This setting defaults to "refs/notes/commits", and it can be overridden by
eee7f4a2 918the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
a97a7468 919
d5d5d7b6
DS
920gc.commitGraph::
921 If true, then gc will rewrite the commit-graph file when
922 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
923 '--auto' the commit-graph will be updated if housekeeping is
924 required. Default is false. See linkgit:git-commit-graph[1]
925 for details.
1b70dfd5 926
da4398d6
JK
927core.useReplaceRefs::
928 If set to `false`, behave as if the `--no-replace-objects`
929 option was given on the command line. See linkgit:git[1] and
930 linkgit:git-replace[1] for more information.
931
08aefc9e
NTND
932core.sparseCheckout::
933 Enable "sparse checkout" feature. See section "Sparse checkout" in
934 linkgit:git-read-tree[1] for more information.
935
a71f09fe 936core.abbrev::
48d5014d
JH
937 Set the length object names are abbreviated to. If
938 unspecified or set to "auto", an appropriate value is
939 computed based on the approximate number of packed objects
940 in your repository, which hopefully is enough for
941 abbreviated object names to stay unique for some time.
fb87327a 942 The minimum length is 4.
dce96489 943
6b3020a2 944add.ignoreErrors::
502e7f98 945add.ignore-errors (deprecated)::
0b444cdb 946 Tells 'git add' to continue adding files when some files cannot be
bcf9626a 947 added due to indexing errors. Equivalent to the `--ignore-errors`
394e1505
JH
948 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
949 as it does not follow the usual naming convention for configuration
950 variables.
13bd2134 951
4514ad4f 952alias.*::
5162e697 953 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
954 after defining "alias.last = cat-file commit HEAD", the invocation
955 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84 956 confusion and troubles with script usage, aliases that
2de9b711 957 hide existing Git commands are ignored. Arguments are split by
99b41c84 958 spaces, the usual shell quoting and escaping is supported.
a79c3a1b 959 A quote pair or a backslash can be used to quote them.
f368f5a6
JH
960+
961If the alias expansion is prefixed with an exclamation point,
962it will be treated as a shell command. For example, defining
963"alias.new = !gitk --all --not ORIG_HEAD", the invocation
964"git new" is equivalent to running the shell command
595b8dbf
SC
965"gitk --all --not ORIG_HEAD". Note that shell commands will be
966executed from the top-level directory of a repository, which may
967not necessarily be the current directory.
eee7f4a2 968`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
7cf16a14 969from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 970
e80d4cbe
SH
971am.keepcr::
972 If true, git-am will call git-mailsplit for patches in mbox format
bcf9626a 973 with parameter `--keep-cr`. In this case git-mailsplit will
6b677a28 974 not remove `\r` from lines ending with `\r\n`. Can be overridden
bcf9626a 975 by giving `--no-keep-cr` from the command line.
e80d4cbe
SH
976 See linkgit:git-am[1], linkgit:git-mailsplit[1].
977
e97a5e76
RL
978am.threeWay::
979 By default, `git am` will fail if the patch does not apply cleanly. When
980 set to true, this setting tells `git am` to fall back on 3-way merge if
981 the patch records the identity of blobs it is supposed to apply to and
982 we have those blobs available locally (equivalent to giving the `--3way`
983 option from the command line). Defaults to `false`.
984 See linkgit:git-am[1].
985
da0005b8 986apply.ignoreWhitespace::
0b444cdb 987 When set to 'change', tells 'git apply' to ignore changes in
bcf9626a 988 whitespace, in the same way as the `--ignore-space-change`
86c91f91 989 option.
0b444cdb 990 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
991 respect all whitespace differences.
992 See linkgit:git-apply[1].
993
1ab661dd 994apply.whitespace::
0b444cdb 995 Tells 'git apply' how to handle whitespaces, in the same way
bcf9626a 996 as the `--whitespace` option. See linkgit:git-apply[1].
1ab661dd 997
de0bc11d
SB
998blame.showRoot::
999 Do not treat root commits as boundaries in linkgit:git-blame[1].
1000 This option defaults to false.
1001
1002blame.blankBoundary::
1003 Show blank commit object name for boundary commits in
1004 linkgit:git-blame[1]. This option defaults to false.
1005
1006blame.showEmail::
1007 Show the author email instead of author name in linkgit:git-blame[1].
1008 This option defaults to false.
1009
1010blame.date::
1011 Specifies the format used to output dates in linkgit:git-blame[1].
1012 If unset the iso format is used. For supported values,
1013 see the discussion of the `--date` option at linkgit:git-log[1].
1014
da0005b8 1015branch.autoSetupMerge::
add0951a 1016 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
1017 so that linkgit:git-pull[1] will appropriately merge from the
1018 starting point branch. Note that even if this option is not set,
9902387d 1019 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
1020 and `--no-track` options. The valid settings are: `false` -- no
1021 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
1022 starting point is a remote-tracking branch; `always` --
1023 automatic setup is done when the starting point is either a
1024 local branch or remote-tracking
572fc81d 1025 branch. This option defaults to true.
9902387d 1026
da0005b8 1027branch.autoSetupRebase::
0b444cdb 1028 When a new branch is created with 'git branch' or 'git checkout'
2de9b711 1029 that tracks another branch, this variable tells Git to set
c998ae9b
DS
1030 up pull to rebase instead of merge (see "branch.<name>.rebase").
1031 When `never`, rebase is never automatically set to true.
1032 When `local`, rebase is set to true for tracked branches of
1033 other local branches.
1034 When `remote`, rebase is set to true for tracked branches of
29b9a66f 1035 remote-tracking branches.
c998ae9b
DS
1036 When `always`, rebase will be set to true for all tracking
1037 branches.
da0005b8 1038 See "branch.autoSetupMerge" for details on how to set up a
c998ae9b
DS
1039 branch to track another branch.
1040 This option defaults to never.
1041
560ae1c1
SM
1042branch.sort::
1043 This variable controls the sort ordering of branches when displayed by
1044 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1045 value of this variable will be used as the default.
1046 See linkgit:git-for-each-ref[1] field names for valid values.
1047
648ad18f 1048branch.<name>.remote::
224c2171
RR
1049 When on branch <name>, it tells 'git fetch' and 'git push'
1050 which remote to fetch from/push to. The remote to push to
da0005b8 1051 may be overridden with `remote.pushDefault` (for all branches).
9f765ce6 1052 The remote to push to, for the current branch, may be further
da0005b8 1053 overridden by `branch.<name>.pushRemote`. If no remote is
9f765ce6 1054 configured, or if you are not on any branch, it defaults to
da0005b8 1055 `origin` for fetching and `remote.pushDefault` for pushing.
b85ecea6
PO
1056 Additionally, `.` (a period) is the current local repository
1057 (a dot-repository), see `branch.<name>.merge`'s final note below.
9f765ce6 1058
da0005b8 1059branch.<name>.pushRemote::
9f765ce6 1060 When on branch <name>, it overrides `branch.<name>.remote` for
da0005b8 1061 pushing. It also overrides `remote.pushDefault` for pushing
9f765ce6
RR
1062 from branch <name>. When you pull from one place (e.g. your
1063 upstream) and push to another place (e.g. your own publishing
da0005b8 1064 repository), you would want to set `remote.pushDefault` to
9f765ce6
RR
1065 specify the remote to push to for all branches, and use this
1066 option to override it for a specific branch.
648ad18f 1067
5372806a 1068branch.<name>.merge::
76d3cc50 1069 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 1070 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
1071 branch to merge and can also affect 'git push' (see push.default).
1072 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
1073 refspec to be marked for merging in FETCH_HEAD. The value is
1074 handled like the remote part of a refspec, and must match a
1075 ref which is fetched from the remote given by
1076 "branch.<name>.remote".
0b444cdb
TR
1077 The merge information is used by 'git pull' (which at first calls
1078 'git fetch') to lookup the default branch for merging. Without
1079 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 1080 Specify multiple values to get an octopus merge.
0b444cdb 1081 If you wish to setup 'git pull' so that it merges into <name> from
9debc324 1082 another branch in the local repository, you can point
b85ecea6
PO
1083 branch.<name>.merge to the desired branch, and use the relative path
1084 setting `.` (a period) for branch.<name>.remote.
5372806a 1085
da0005b8 1086branch.<name>.mergeOptions::
aec7b362 1087 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 1088 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
1089 option values containing whitespace characters are currently not
1090 supported.
1091
cd67e4d4
JS
1092branch.<name>.rebase::
1093 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 1094 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
1095 "git pull" is run. See "pull.rebase" for doing this in a non
1096 branch-specific manner.
66713ef3 1097+
1131ec98
JS
1098When `merges`, pass the `--rebase-merges` option to 'git rebase'
1099so that the local merge commits are included in the rebase (see
1100linkgit:git-rebase[1] for details).
1101+
d2387107
AS
1102When preserve, also pass `--preserve-merges` along to 'git rebase'
1103so that locally committed merge commits will not be flattened
1104by running 'git pull'.
6b37dff1 1105+
f5eb87b9
JS
1106When the value is `interactive`, the rebase is run in interactive mode.
1107+
6b37dff1
ÆAB
1108*NOTE*: this is a possibly dangerous operation; do *not* use
1109it unless you understand the implications (see linkgit:git-rebase[1]
1110for details).
cd67e4d4 1111
a5ba2cbe
NTND
1112branch.<name>.description::
1113 Branch description, can be edited with
1114 `git branch --edit-description`. Branch description is
1115 automatically added in the format-patch cover letter or
1116 request-pull summary.
1117
1658c614
CC
1118browser.<tool>.cmd::
1119 Specify the command to invoke the specified browser. The
1120 specified command is evaluated in shell with the URLs passed
565e135a 1121 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 1122
584627b4
CC
1123browser.<tool>.path::
1124 Override the path for the given tool that may be used to
23f8239b 1125 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
ab989adf 1126 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 1127
8d7b558b
ÆAB
1128checkout.defaultRemote::
1129 When you run 'git checkout <something>' and only have one
1130 remote, it may implicitly fall back on checking out and
1131 tracking e.g. 'origin/<something>'. This stops working as soon
1132 as you have more than one remote with a '<something>'
1133 reference. This setting allows for setting the name of a
1134 preferred remote that should always win when it comes to
1135 disambiguation. The typical use-case is to set this to
1136 `origin`.
1137+
1138Currently this is used by linkgit:git-checkout[1] when 'git checkout
1139<something>' will checkout the '<something>' branch on another remote,
1140and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1141remote branch. This setting might be used for other checkout-like
1142commands or functionality in the future.
1143
2122591b 1144clean.requireForce::
f85f7947
JX
1145 A boolean to make git-clean do nothing unless given -f,
1146 -i or -n. Defaults to true.
2122591b 1147
79f62e7d
JS
1148color.advice::
1149 A boolean to enable/disable color in hints (e.g. when a push
1150 failed, see `advice.*` for a list). May be set to `always`,
1151 `false` (or `never`) or `auto` (or `true`), in which case colors
1152 are used only when the error output goes to a terminal. If
1153 unset, then the value of `color.ui` is used (`auto` by default).
1154
1155color.advice.hint::
1156 Use customized color for hints.
1157
f3673988
BG
1158color.branch::
1159 A boolean to enable/disable color in the output of
5162e697 1160 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 1161 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1162 only when the output is to a terminal. If unset, then the
1163 value of `color.ui` is used (`auto` by default).
f3673988
BG
1164
1165color.branch.<slot>::
1166 Use customized color for branch coloration. `<slot>` is one of
1167 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
1168 `remote` (a remote-tracking branch in refs/remotes/),
1169 `upstream` (upstream tracking branch), `plain` (other
4f193f20 1170 refs).
f3673988 1171
a159ca0c 1172color.diff::
6999c540
MG
1173 Whether to use ANSI escape sequences to add color to patches.
1174 If this is set to `always`, linkgit:git-diff[1],
1175 linkgit:git-log[1], and linkgit:git-show[1] will use color
1176 for all patches. If it is set to `true` or `auto`, those
1177 commands will only use color when output is to the terminal.
14d16e2b
MM
1178 If unset, then the value of `color.ui` is used (`auto` by
1179 default).
6999c540 1180+
a58088ab 1181This does not affect linkgit:git-format-patch[1] or the
6999c540
MG
1182'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1183command line with the `--color[=<when>]` option.
b5376648 1184
61e89eaa
SB
1185diff.colorMoved::
1186 If set to either a valid `<mode>` or a true value, moved lines
1187 in a diff are colored differently, for details of valid modes
1188 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1189 true the default color mode will be used. When set to false,
1190 moved lines are not colored.
1191
626c0b5d
SB
1192diff.colorMovedWS::
1193 When moved lines are colored using e.g. the `diff.colorMoved` setting,
1194 this option controls the `<mode>` how spaces are treated
1195 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1196
a159ca0c 1197color.diff.<slot>::
4f193f20
MW
1198 Use customized color for diff colorization. `<slot>` specifies
1199 which part of the patch to use the specified color, and is one
74b15bfb
JK
1200 of `context` (context text - `plain` is a historical synonym),
1201 `meta` (metainformation), `frag`
89cb73a1 1202 (hunk header), 'func' (function in hunk header), `old` (removed lines),
61e89eaa
SB
1203 `new` (added lines), `commit` (commit headers), `whitespace`
1204 (highlighting whitespace errors), `oldMoved` (deleted lines),
1205 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1206 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1207 and `newMovedAlternativeDimmed` (See the '<mode>'
1208 setting of '--color-moved' in linkgit:git-diff[1] for details).
b5376648 1209
5e11bee6
NR
1210color.decorate.<slot>::
1211 Use customized color for 'git log --decorate' output. `<slot>` is one
1212 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
09c4ba41
NTND
1213 branches, remote-tracking branches, tags, stash and HEAD, respectively
1214 and `grafted` for grafted commits.
5e11bee6 1215
7e8f59d5
RS
1216color.grep::
1217 When set to `always`, always highlight matches. When `false` (or
1218 `never`), never. When set to `true` or `auto`, use color only
14d16e2b
MM
1219 when the output is written to the terminal. If unset, then the
1220 value of `color.ui` is used (`auto` by default).
7e8f59d5 1221
55f638bd
ML
1222color.grep.<slot>::
1223 Use customized color for grep colorization. `<slot>` specifies which
1224 part of the line to use the specified color, and is one of
1225+
1226--
00588bb5
ML
1227`context`;;
1228 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
1229`filename`;;
1230 filename prefix (when not using `-h`)
00588bb5
ML
1231`function`;;
1232 function name lines (when using `-p`)
f8a0c6e7 1233`lineNumber`;;
55f638bd 1234 line number prefix (when using `-n`)
6653fec3
TB
1235`column`;;
1236 column number prefix (when using `--column`)
55f638bd 1237`match`;;
79a77109
RS
1238 matching text (same as setting `matchContext` and `matchSelected`)
1239`matchContext`;;
1240 matching text in context lines
1241`matchSelected`;;
1242 matching text in selected lines
00588bb5
ML
1243`selected`;;
1244 non-matching text in selected lines
55f638bd
ML
1245`separator`;;
1246 separators between fields on a line (`:`, `-`, and `=`)
1247 and between hunks (`--`)
1248--
7e8f59d5 1249
b4c61ed6 1250color.interactive::
47ee06f1 1251 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
1252 and displays (such as those used by "git-add --interactive" and
1253 "git-clean --interactive"). When false (or `never`), never.
1254 When set to `true` or `auto`, use colors only when the output is
14d16e2b
MM
1255 to the terminal. If unset, then the value of `color.ui` is
1256 used (`auto` by default).
b4c61ed6
JH
1257
1258color.interactive.<slot>::
7a9b0b80
JX
1259 Use customized color for 'git add --interactive' and 'git clean
1260 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1261 or `error`, for four distinct types of normal output from
b92c1a28 1262 interactive commands.
b4c61ed6 1263
1d77043b
JH
1264color.pager::
1265 A boolean to enable/disable colored output when the pager is in
1266 use (default is true).
1267
79f62e7d
JS
1268color.push::
1269 A boolean to enable/disable color in push errors. May be set to
1270 `always`, `false` (or `never`) or `auto` (or `true`), in which
1271 case colors are used only when the error output goes to a terminal.
1272 If unset, then the value of `color.ui` is used (`auto` by default).
1273
1274color.push.error::
1275 Use customized color for push errors.
1276
da0005b8 1277color.showBranch::
ab07ba2a
MH
1278 A boolean to enable/disable color in the output of
1279 linkgit:git-show-branch[1]. May be set to `always`,
1280 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1281 only when the output is to a terminal. If unset, then the
1282 value of `color.ui` is used (`auto` by default).
ab07ba2a 1283
1d77043b
JH
1284color.status::
1285 A boolean to enable/disable color in the output of
5162e697 1286 linkgit:git-status[1]. May be set to `always`,
cec99d8c 1287 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1288 only when the output is to a terminal. If unset, then the
1289 value of `color.ui` is used (`auto` by default).
1d77043b
JH
1290
1291color.status.<slot>::
1292 Use customized color for status colorization. `<slot>` is
1293 one of `header` (the header text of the status message),
82dca848
SP
1294 `added` or `updated` (files which are added but not committed),
1295 `changed` (files which are changed but not added in the index),
2de9b711 1296 `untracked` (files which are not tracked by Git),
0d6accc0 1297 `branch` (the current branch),
950ce2e2 1298 `nobranch` (the color the 'no branch' warning is shown in, defaulting
93fdf301
SK
1299 to red),
1300 `localBranch` or `remoteBranch` (the local and remote branch names,
1301 respectively, when branch and tracking information is displayed in the
1302 status short-format), or
0d6accc0 1303 `unmerged` (files which have unmerged changes).
1d77043b 1304
cdc2d5f1
SB
1305color.blame.repeatedLines::
1306 Use the customized color for the part of git-blame output that
1307 is repeated meta information per line (such as commit id,
1308 author name, date and timezone). Defaults to cyan.
1309
25d5f529
SB
1310color.blame.highlightRecent::
1311 This can be used to color the metadata of a blame line depending
1312 on age of the line.
1313+
1314This setting should be set to a comma-separated list of color and date settings,
1315starting and ending with a color, the dates should be set from oldest to newest.
1316The metadata will be colored given the colors if the the line was introduced
1317before the given timestamp, overwriting older timestamped colors.
1318+
1319Instead of an absolute timestamp relative timestamps work as well, e.g.
13202.weeks.ago is valid to address anything older than 2 weeks.
1321+
1322It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1323everything older than one year blue, recent changes between one month and
1324one year old are kept white, and lines introduced within the last month are
1325colored red.
1326
0dc95a4d
SB
1327blame.coloring::
1328 This determines the coloring scheme to be applied to blame
1329 output. It can be 'repeatedLines', 'highlightRecent',
1330 or 'none' which is the default.
1331
79f62e7d
JS
1332color.transport::
1333 A boolean to enable/disable color when pushes are rejected. May be
1334 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1335 case colors are used only when the error output goes to a terminal.
1336 If unset, then the value of `color.ui` is used (`auto` by default).
1337
1338color.transport.rejected::
1339 Use customized color when a push was rejected.
1340
6b2f2d98 1341color.ui::
6999c540
MG
1342 This variable determines the default value for variables such
1343 as `color.diff` and `color.grep` that control the use of color
1344 per command family. Its scope will expand as more commands learn
1345 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
1346 to `false` or `never` if you prefer Git commands not to use
1347 color unless enabled explicitly with some other configuration
1348 or the `--color` option. Set it to `always` if you want all
1349 output not intended for machine consumption to use color, to
1350 `true` or `auto` (this is the default since Git 1.8.4) if you
1351 want such output to use color when written to the terminal.
6b2f2d98 1352
7e29b825
NTND
1353column.ui::
1354 Specify whether supported commands should output in columns.
1355 This variable consists of a list of tokens separated by spaces
1356 or commas:
1357+
5e62cc14
RR
1358These options control when the feature should be enabled
1359(defaults to 'never'):
1360+
7e29b825
NTND
1361--
1362`always`;;
1363 always show in columns
1364`never`;;
1365 never show in columns
1366`auto`;;
1367 show in columns if the output is to the terminal
5e62cc14
RR
1368--
1369+
1370These options control layout (defaults to 'column'). Setting any
1371of these implies 'always' if none of 'always', 'never', or 'auto' are
1372specified.
1373+
1374--
077539d7 1375`column`;;
5e62cc14 1376 fill columns before rows
077539d7
NTND
1377`row`;;
1378 fill rows before columns
7e29b825
NTND
1379`plain`;;
1380 show in one column
5e62cc14
RR
1381--
1382+
1383Finally, these options can be combined with a layout option (defaults
1384to 'nodense'):
1385+
1386--
3f8eccbe
NTND
1387`dense`;;
1388 make unequal size columns to utilize more space
1389`nodense`;;
1390 make equal size columns
7e29b825 1391--
7e29b825 1392
ebe31ef2
NTND
1393column.branch::
1394 Specify whether to output branch listing in `git branch` in columns.
1395 See `column.ui` for details.
1396
1b8fd467
JX
1397column.clean::
1398 Specify the layout when list items in `git clean -i`, which always
1399 shows files and directories in columns. See `column.ui` for details.
1400
323d0530
NTND
1401column.status::
1402 Specify whether to output untracked files in `git status` in columns.
1403 See `column.ui` for details.
1404
d96e3c15
NTND
1405column.tag::
1406 Specify whether to output tag listing in `git tag` in columns.
1407 See `column.ui` for details.
1408
51fb3a3d
RT
1409commit.cleanup::
1410 This setting overrides the default of the `--cleanup` option in
1411 `git commit`. See linkgit:git-commit[1] for details. Changing the
1412 default can be useful when you always want to keep lines that begin
1413 with comment character `#` in your log message, in which case you
1414 would do `git config commit.cleanup whitespace` (note that you will
1415 have to remove the help lines that begin with `#` in the commit log
1416 template yourself, if you do this).
1417
da0005b8 1418commit.gpgSign::
d95bfb12
NV
1419
1420 A boolean to specify whether all commits should be GPG signed.
1421 Use of this option when doing operations such as rebase can
1422 result in a large number of commits being signed. It may be
1423 convenient to use an agent to avoid typing your GPG passphrase
1424 several times.
1425
88955ed2 1426commit.status::
bed575e4
JHI
1427 A boolean to enable/disable inclusion of status information in the
1428 commit message template when using an editor to prepare the commit
1429 message. Defaults to true.
1430
b0f34c3d 1431commit.template::
dca83abd
JH
1432 Specify the pathname of a file to use as the template for
1433 new commit messages.
b0f34c3d 1434
aaab8420
PB
1435commit.verbose::
1436 A boolean or int to specify the level of verbose with `git commit`.
1437 See linkgit:git-commit[1].
1438
a6fc9fd3
JK
1439credential.helper::
1440 Specify an external helper to be called when a username or
1441 password credential is needed; the helper may consult external
24321375
JK
1442 storage to avoid prompting the user for the credentials. Note
1443 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1444 for details.
a6fc9fd3
JK
1445
1446credential.useHttpPath::
1447 When acquiring credentials, consider the "path" component of an http
1448 or https URL to be important. Defaults to false. See
1449 linkgit:gitcredentials[7] for more information.
1450
1451credential.username::
1452 If no username is set for a network authentication, use this username
1453 by default. See credential.<context>.* below, and
1454 linkgit:gitcredentials[7].
1455
1456credential.<url>.*::
1457 Any of the credential.* options above can be applied selectively to
1458 some credentials. For example "credential.https://example.com.username"
1459 would set the default username only for https connections to
1460 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1461 matched.
1462
7f4d4746
NP
1463credentialCache.ignoreSIGHUP::
1464 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1465
6532f374
NTND
1466completion.commands::
1467 This is only used by git-completion.bash to add or remove
1468 commands from the list of completed commands. Normally only
1469 porcelain commands and a few select others are completed. You
1470 can add more commands, separated by space, in this
1471 variable. Prefixing the command with '-' will remove it from
1472 the existing list.
1473
19299a84 1474include::diff-config.txt[]
afcbc8e7
DA
1475
1476difftool.<tool>.path::
1477 Override the path for the given tool. This is useful in case
1478 your tool is not in the PATH.
1479
1480difftool.<tool>.cmd::
1481 Specify the command to invoke the specified diff tool.
1482 The specified command is evaluated in shell with the following
1483 variables available: 'LOCAL' is set to the name of the temporary
1484 file containing the contents of the diff pre-image and 'REMOTE'
1485 is set to the name of the temporary file containing the contents
1486 of the diff post-image.
1487
a904392e
DA
1488difftool.prompt::
1489 Prompt before each invocation of the diff tool.
1490
d9545c7f
EW
1491fastimport.unpackLimit::
1492 If the number of objects imported by linkgit:git-fast-import[1]
1493 is below this limit, then the objects will be unpacked into
1494 loose object files. However if the number of imported objects
1495 equals or exceeds this limit then the pack will be stored as a
1496 pack. Storing the pack from a fast-import can make the import
1497 operation complete faster, especially on slow filesystems. If
1498 not set, the value of `transfer.unpackLimit` is used instead.
1499
be254a0e 1500fetch.recurseSubmodules::
1fb25502
JL
1501 This option can be either set to a boolean value or to 'on-demand'.
1502 Setting it to a boolean changes the behavior of fetch and pull to
1503 unconditionally recurse into submodules when set to true or to not
1504 recurse at all when set to false. When set to 'on-demand' (the default
1505 value), fetch and pull will only recurse into a populated submodule
1506 when its superproject retrieves a commit that updates the submodule's
1507 reference.
be254a0e 1508
5e838ea7
JH
1509fetch.fsckObjects::
1510 If it is set to true, git-fetch-pack will check all fetched
1511 objects. It will abort in the case of a malformed object or a
1512 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1513 Defaults to false. If not set, the value of `transfer.fsckObjects`
1514 is used instead.
5e838ea7 1515
af7cf268 1516fetch.unpackLimit::
2de9b711 1517 If the number of objects fetched over the Git native
af7cf268
JH
1518 transfer is below this
1519 limit, then the objects will be unpacked into loose object
1520 files. However if the number of received objects equals or
1521 exceeds this limit then the received pack will be stored as
1522 a pack, after adding any missing delta bases. Storing the
1523 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1524 especially on slow filesystems. If not set, the value of
1525 `transfer.unpackLimit` is used instead.
af7cf268 1526
737c5a9c
MS
1527fetch.prune::
1528 If true, fetch will automatically behave as if the `--prune`
627a129b
ÆAB
1529 option was given on the command line. See also `remote.<name>.prune`
1530 and the PRUNING section of linkgit:git-fetch[1].
737c5a9c 1531
97716d21
ÆAB
1532fetch.pruneTags::
1533 If true, fetch will automatically behave as if the
1534 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1535 if not set already. This allows for setting both this option
1536 and `fetch.prune` to maintain a 1=1 mapping to upstream
1537 refs. See also `remote.<name>.pruneTags` and the PRUNING
1538 section of linkgit:git-fetch[1].
737c5a9c 1539
bc437d10
NTND
1540fetch.output::
1541 Control how ref update status is printed. Valid values are
1542 `full` and `compact`. Default value is `full`. See section
1543 OUTPUT in linkgit:git-fetch[1] for detail.
1544
42cc7485
JT
1545fetch.negotiationAlgorithm::
1546 Control how information about the commits in the local repository is
1547 sent when negotiating the contents of the packfile to be sent by the
1548 server. Set to "skipping" to use an algorithm that skips commits in an
1549 effort to converge faster, but may result in a larger-than-necessary
1550 packfile; any other value instructs Git to use the default algorithm
1551 that never skips commits (unless the server has acknowledged it or one
1552 of its descendants).
1553
48d3448d
SB
1554format.attach::
1555 Enable multipart/mixed attachments as the default for
1556 'format-patch'. The value can also be a double quoted string
1557 which will enable attachments as the default and set the
1558 value as the boundary. See the --attach option in
1559 linkgit:git-format-patch[1].
1560
6bc6b6c0
JT
1561format.from::
1562 Provides the default value for the `--from` option to format-patch.
1563 Accepts a boolean value, or a name and email address. If false,
1564 format-patch defaults to `--no-from`, using commit authors directly in
1565 the "From:" field of patch mails. If true, format-patch defaults to
1566 `--from`, using your committer identity in the "From:" field of patch
1567 mails and including a "From:" field in the body of the patch mail if
1568 different. If set to a non-boolean value, format-patch uses that
1569 value instead of your committer identity. Defaults to false.
1570
49604a4d 1571format.numbered::
a567fdcb
BG
1572 A boolean which can enable or disable sequence numbers in patch
1573 subjects. It defaults to "auto" which enables it only if there
1574 is more than one patch. It can be enabled or disabled for all
1575 messages by setting it to "true" or "false". See --numbered
1576 option in linkgit:git-format-patch[1].
49604a4d 1577
1ab661dd
PB
1578format.headers::
1579 Additional email headers to include in a patch to be submitted
5162e697 1580 by mail. See linkgit:git-format-patch[1].
1ab661dd 1581
312a30eb 1582format.to::
48d3448d 1583format.cc::
312a30eb
MV
1584 Additional recipients to include in a patch to be submitted
1585 by mail. See the --to and --cc options in
1586 linkgit:git-format-patch[1].
48d3448d 1587
da0005b8 1588format.subjectPrefix::
48d3448d
SB
1589 The default for format-patch is to output files with the '[PATCH]'
1590 subject prefix. Use this variable to change that prefix.
1591
6622d9c7
SB
1592format.signature::
1593 The default for format-patch is to output a signature containing
2de9b711 1594 the Git version number. Use this variable to change that default.
6622d9c7
SB
1595 Set this variable to the empty string ("") to suppress
1596 signature generation.
1597
da0005b8 1598format.signatureFile::
7022650f
JM
1599 Works just like format.signature except the contents of the
1600 file specified by this variable will be used as the signature.
1601
78cb59c8
JS
1602format.suffix::
1603 The default for format-patch is to output files with the suffix
1604 `.patch`. Use this variable to change that suffix (make sure to
1605 include the dot if you want it).
1ab661dd 1606
94c22a5e
CR
1607format.pretty::
1608 The default pretty format for log/show/whatchanged command,
1609 See linkgit:git-log[1], linkgit:git-show[1],
1610 linkgit:git-whatchanged[1].
1611
30984ed2 1612format.thread::
0b444cdb 1613 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1614 a boolean value, or `shallow` or `deep`. `shallow` threading
1615 makes every mail a reply to the head of the series,
30984ed2 1616 where the head is chosen from the cover letter, the
6cf378f0 1617 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1618 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1619 A true boolean value is the same as `shallow`, and a false
1620 value disables threading.
1621
da0005b8 1622format.signOff::
240ae2b8
FC
1623 A boolean value which lets you enable the `-s/--signoff` option of
1624 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1625 patch should be a conscious act and means that you certify you have
1626 the rights to submit this work under the same open source license.
1627 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1628
2a4c2607
FC
1629format.coverLetter::
1630 A boolean that controls whether to generate a cover-letter when
1631 format-patch is invoked, but in addition can be set to "auto", to
1632 generate a cover-letter only when there's more than one patch.
1633
bc6bf2d7
AK
1634format.outputDirectory::
1635 Set a custom directory to store the resulting files instead of the
1636 current working directory.
1637
bb52995f
XY
1638format.useAutoBase::
1639 A boolean value which lets you enable the `--base=auto` option of
1640 format-patch by default.
1641
26488f59
RR
1642filter.<driver>.clean::
1643 The command which is used to convert the content of a worktree
1644 file to a blob upon checkin. See linkgit:gitattributes[5] for
1645 details.
1646
1647filter.<driver>.smudge::
1648 The command which is used to convert the content of a blob
1649 object to a worktree file upon checkout. See
1650 linkgit:gitattributes[5] for details.
1651
2becf00f
JS
1652fsck.<msg-id>::
1653 Allows overriding the message type (error, warn or ignore) of a
1654 specific message ID such as `missingEmail`.
1655+
1656For convenience, fsck prefixes the error/warning with the message ID,
1657e.g. "missingEmail: invalid author/committer line - missing email" means
1658that setting `fsck.missingEmail = ignore` will hide that issue.
1659+
1660This feature is intended to support working with legacy repositories
1661which cannot be repaired without disruptive changes.
1662
1335f732
JS
1663fsck.skipList::
1664 The path to a sorted list of object names (i.e. one SHA-1 per
1665 line) that are known to be broken in a non-fatal way and should
1666 be ignored. This feature is useful when an established project
1667 should be accepted despite early commits containing errors that
1668 can be safely ignored such as invalid committer email addresses.
1669 Note: corrupt objects cannot be skipped with this setting.
1670
125f8146
NTND
1671gc.aggressiveDepth::
1672 The depth parameter used in the delta compression
1673 algorithm used by 'git gc --aggressive'. This defaults
07e7dbf0 1674 to 50.
125f8146 1675
0d7566a5
TT
1676gc.aggressiveWindow::
1677 The window size parameter used in the delta compression
0b444cdb 1678 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1679 to 250.
0d7566a5 1680
e9831e83
JH
1681gc.auto::
1682 When there are approximately more than this many loose
1683 objects in the repository, `git gc --auto` will pack them.
1684 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1685 light-weight garbage collection from time to time. The
1686 default value is 6700. Setting this to 0 disables it.
e9831e83 1687
da0005b8 1688gc.autoPackLimit::
17815501
JH
1689 When there are more than this many packs that are not
1690 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1691 --auto` consolidates them into one larger pack. The
97063974 1692 default value is 50. Setting this to 0 disables it.
17815501 1693
da0005b8 1694gc.autoDetach::
f745acb0 1695 Make `git gc --auto` return immediately and run in background
9f673f94
NTND
1696 if the system supports it. Default is true.
1697
55dfe13d
NTND
1698gc.bigPackThreshold::
1699 If non-zero, all packs larger than this limit are kept when
1700 `git gc` is run. This is very similar to `--keep-base-pack`
1701 except that all packs that meet the threshold are kept, not
1702 just the base pack. Defaults to zero. Common unit suffixes of
1703 'k', 'm', or 'g' are supported.
8fc67762
NTND
1704+
1705Note that if the number of kept packs is more than gc.autoPackLimit,
1706this configuration variable is ignored, all packs except the base pack
1707will be repacked. After this the number of packs should go below
1708gc.autoPackLimit and gc.bigPackThreshold should be respected again.
55dfe13d 1709
a831c06a
DT
1710gc.logExpiry::
1711 If the file gc.log exists, then `git gc --auto` won't run
1712 unless that file is more than 'gc.logExpiry' old. Default is
1713 "1.day". See `gc.pruneExpire` for more ways to specify its
1714 value.
1715
da0005b8 1716gc.packRefs::
efc266e8
JN
1717 Running `git pack-refs` in a repository renders it
1718 unclonable by Git versions prior to 1.5.1.2 over dumb
1719 transports such as HTTP. This variable determines whether
4be0c352 1720 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1721 to enable it within all non-bare repos or it can be set to a
1722 boolean value. The default is `true`.
c2120e5e 1723
da0005b8 1724gc.pruneExpire::
0b444cdb 1725 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33 1726 Override the grace period with this config variable. The value
8cc88166
ES
1727 "now" may be used to disable this grace period and always prune
1728 unreachable objects immediately, or "never" may be used to
f1350d0c
MM
1729 suppress pruning. This feature helps prevent corruption when
1730 'git gc' runs concurrently with another process writing to the
1731 repository; see the "NOTES" section of linkgit:git-gc[1].
25ee9731 1732
114ff888 1733gc.worktreePruneExpire::
b07244f4 1734 When 'git gc' is run, it calls
fe819b4b 1735 'git worktree prune --expire 3.months.ago'.
b07244f4
MH
1736 This config variable can be used to set a different grace
1737 period. The value "now" may be used to disable the grace
f212dcc7 1738 period and prune `$GIT_DIR/worktrees` immediately, or "never"
8cc88166 1739 may be used to suppress pruning.
e3df33bb 1740
da0005b8
NTND
1741gc.reflogExpire::
1742gc.<pattern>.reflogExpire::
0b444cdb 1743 'git reflog expire' removes reflog entries older than
8cc88166
ES
1744 this time; defaults to 90 days. The value "now" expires all
1745 entries immediately, and "never" suppresses expiration
1746 altogether. With "<pattern>" (e.g.
eb523a8d
JH
1747 "refs/stash") in the middle the setting applies only to
1748 the refs that match the <pattern>.
4aec56d1 1749
da0005b8 1750gc.reflogExpireUnreachable::
f04c6904 1751gc.<pattern>.reflogExpireUnreachable::
0b444cdb 1752 'git reflog expire' removes reflog entries older than
4aec56d1 1753 this time and are not reachable from the current tip;
8cc88166
ES
1754 defaults to 30 days. The value "now" expires all entries
1755 immediately, and "never" suppresses expiration altogether.
1756 With "<pattern>" (e.g. "refs/stash")
eb523a8d
JH
1757 in the middle, the setting applies only to the refs that
1758 match the <pattern>.
4aec56d1 1759
da0005b8 1760gc.rerereResolved::
48c32424 1761 Records of conflicted merge you resolved earlier are
0b444cdb 1762 kept for this many days when 'git rerere gc' is run.
6e96cb52 1763 You can also use more human-readable "1.month.ago", etc.
5162e697 1764 The default is 60 days. See linkgit:git-rerere[1].
48c32424 1765
da0005b8 1766gc.rerereUnresolved::
48c32424 1767 Records of conflicted merge you have not resolved are
0b444cdb 1768 kept for this many days when 'git rerere gc' is run.
6e96cb52 1769 You can also use more human-readable "1.month.ago", etc.
5162e697 1770 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1771
da0005b8 1772gitcvs.commitMsgAnnotation::
280514e1
FE
1773 Append this string to each commit message. Set to empty string
1774 to disable this feature. Defaults to "via git-CVS emulator".
1775
1ab661dd 1776gitcvs.enabled::
db218723 1777 Whether the CVS server interface is enabled for this repository.
5162e697 1778 See linkgit:git-cvsserver[1].
1ab661dd 1779
da0005b8 1780gitcvs.logFile::
db218723 1781 Path to a log file where the CVS server interface well... logs
5162e697 1782 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1783
1707adb7 1784gitcvs.usecrlfattr::
5ec3e670 1785 If true, the server will look up the end-of-line conversion
23f8239b 1786 attributes for files to determine the `-k` modes to use. If
2de9b711 1787 the attributes force Git to treat a file as text,
23f8239b 1788 the `-k` mode will be left blank so CVS clients will
5ec3e670 1789 treat it as text. If they suppress text conversion, the file
1168d402 1790 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670 1791 the client might otherwise do. If the attributes do not allow
ae9f6311 1792 the file type to be determined, then `gitcvs.allBinary` is
5ec3e670 1793 used. See linkgit:gitattributes[5].
8a06a632 1794
da0005b8 1795gitcvs.allBinary::
ae9f6311 1796 This is used if `gitcvs.usecrlfattr` does not resolve
90948a42
MO
1797 the correct '-kb' mode to use. If true, all
1798 unresolved files are sent to the client in
1799 mode '-kb'. This causes the client to treat them
1800 as binary files, which suppresses any newline munging it
1801 otherwise might do. Alternatively, if it is set to "guess",
1802 then the contents of the file are examined to decide if
ae9f6311 1803 it is binary, similar to `core.autocrlf`.
abbf5947 1804
da0005b8 1805gitcvs.dbName::
04752868 1806 Database used by git-cvsserver to cache revision information
2de9b711 1807 derived from the Git repository. The exact meaning depends on the
04752868
FL
1808 used database driver, for SQLite (which is the default driver) this
1809 is a filename. Supports variable substitution (see
5162e697 1810 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1811 Default: '%Ggitcvs.%m.sqlite'
1812
da0005b8 1813gitcvs.dbDriver::
04752868 1814 Used Perl DBI driver. You can specify any available driver
240ae2b8 1815 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1816 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1817 reported *not* to work with 'DBD::mysql'. Experimental feature.
1818 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1819 See linkgit:git-cvsserver[1].
eabb0bfd 1820
da0005b8 1821gitcvs.dbUser, gitcvs.dbPass::
ae9f6311 1822 Database user and password. Only useful if setting `gitcvs.dbDriver`,
04752868 1823 since SQLite has no concept of database users and/or passwords.
da0005b8 1824 'gitcvs.dbUser' supports variable substitution (see
5162e697 1825 linkgit:git-cvsserver[1] for details).
04752868 1826
6aeeffd1
JE
1827gitcvs.dbTableNamePrefix::
1828 Database table name prefix. Prepended to the names of any
1829 database tables used, allowing a single database to be used
1830 for several repositories. Supports variable substitution (see
1831 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1832 characters will be replaced with underscores.
1833
ae9f6311
TR
1834All gitcvs variables except for `gitcvs.usecrlfattr` and
1835`gitcvs.allBinary` can also be specified as
8a06a632 1836'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1837is one of "ext" and "pserver") to make them apply only for the given
1838access method.
04752868 1839
cd82323f
JN
1840gitweb.category::
1841gitweb.description::
1842gitweb.owner::
1843gitweb.url::
1844 See linkgit:gitweb[1] for description.
1845
1846gitweb.avatar::
1847gitweb.blame::
1848gitweb.grep::
1849gitweb.highlight::
1850gitweb.patches::
1851gitweb.pickaxe::
1852gitweb.remote_heads::
da0005b8 1853gitweb.showSizes::
cd82323f
JN
1854gitweb.snapshot::
1855 See linkgit:gitweb.conf[5] for description.
1856
b22520a3 1857grep.lineNumber::
23f8239b 1858 If set to true, enable `-n` option by default.
b22520a3 1859
6653fec3
TB
1860grep.column::
1861 If set to true, enable the `--column` option by default.
1862
84befcd0
S
1863grep.patternType::
1864 Set the default matching behavior. Using a value of 'basic', 'extended',
bcf9626a
MM
1865 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1866 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
84befcd0
S
1867 value 'default' will return to the default matching behavior.
1868
b22520a3 1869grep.extendedRegexp::
bcf9626a 1870 If set to true, enable `--extended-regexp` option by default. This
ae9f6311 1871 option is ignored when the `grep.patternType` option is set to a value
84befcd0 1872 other than 'default'.
b22520a3 1873
89f09dd3
VL
1874grep.threads::
1875 Number of grep worker threads to use.
1876 See `grep.threads` in linkgit:git-grep[1] for more information.
1877
ecd9ba61
TG
1878grep.fallbackToNoIndex::
1879 If set to true, fall back to git grep --no-index if git grep
1880 is executed outside of a git repository. Defaults to false.
1881
0c5e70f0 1882gpg.program::
f212dcc7 1883 Use this custom program instead of "`gpg`" found on `$PATH` when
0c5e70f0 1884 making or verifying a PGP signature. The program must support the
06ab60c0 1885 same command-line interface as GPG, namely, to verify a detached
f212dcc7 1886 signature, "`gpg --verify $file - <$signature`" is run, and the
0c5e70f0 1887 program is expected to signal a good signature by exiting with
f745acb0 1888 code 0, and to generate an ASCII-armored detached signature, the
f212dcc7 1889 standard input of "`gpg -bsau $key`" is fed with the contents to be
0c5e70f0
JH
1890 signed, and the program is expected to send the result to its
1891 standard output.
1892
57a8dd75
HS
1893gpg.format::
1894 Specifies which key format to use when signing with `--gpg-sign`.
1e7adb97 1895 Default is "openpgp" and another possible value is "x509".
57a8dd75 1896
b02f51b1
HS
1897gpg.<format>.program::
1898 Use this to customize the program used for the signing format you
1899 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1e7adb97
HS
1900 be used as a legacy synonym for `gpg.openpgp.program`. The default
1901 value for `gpg.x509.program` is "gpgsm".
b02f51b1 1902
da0005b8 1903gui.commitMsgWidth::
d84ae0db
GH
1904 Defines how wide the commit message window is in the
1905 linkgit:git-gui[1]. "75" is the default.
1906
da0005b8 1907gui.diffContext::
d84ae0db
GH
1908 Specifies how many context lines should be used in calls to diff
1909 made by the linkgit:git-gui[1]. The default is "5".
1910
da0005b8 1911gui.displayUntracked::
1cca17df 1912 Determines if linkgit:git-gui[1] shows untracked files
ec9fa62a
MK
1913 in the file list. The default is "true".
1914
a2df1fb2
AG
1915gui.encoding::
1916 Specifies the default encoding to use for displaying of
1917 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1918 It can be overridden by setting the 'encoding' attribute
1919 for relevant files (see linkgit:gitattributes[5]).
1920 If this option is not set, the tools default to the
1921 locale encoding.
1922
da0005b8 1923gui.matchTrackingBranch::
d84ae0db
GH
1924 Determines if new branches created with linkgit:git-gui[1] should
1925 default to tracking remote branches with matching names or
1926 not. Default: "false".
1927
da0005b8 1928gui.newBranchTemplate::
d84ae0db
GH
1929 Is used as suggested name when creating new branches using the
1930 linkgit:git-gui[1].
1931
da0005b8 1932gui.pruneDuringFetch::
8b3f3f84 1933 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1934 performing a fetch. The default value is "false".
1935
1936gui.trustmtime::
1937 Determines if linkgit:git-gui[1] should trust the file modification
1938 timestamp or not. By default the timestamps are not trusted.
1939
da0005b8 1940gui.spellingDictionary::
d84ae0db
GH
1941 Specifies the dictionary used for spell checking commit messages in
1942 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1943 off.
1944
da0005b8 1945gui.fastCopyBlame::
ca768288 1946 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1947 location detection. It makes blame significantly faster on huge
1948 repositories at the expense of less thorough copy detection.
1949
da0005b8 1950gui.copyBlameThreshold::
76bac890 1951 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1952 detection, measured in alphanumeric characters. See the
1953 linkgit:git-blame[1] manual for more information on copy detection.
1954
1955gui.blamehistoryctx::
1956 Specifies the radius of history context in days to show in
1957 linkgit:gitk[1] for the selected commit, when the `Show History
1958 Context` menu item is invoked from 'git gui blame'. If this
1959 variable is set to zero, the whole history is shown.
1960
390c3480
AG
1961guitool.<name>.cmd::
1962 Specifies the shell command line to execute when the corresponding item
1963 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1964 mandatory for every tool. The command is executed from the root of
1965 the working directory, and in the environment it receives the name of
eee7f4a2 1966 the tool as `GIT_GUITOOL`, the name of the currently selected file as
390c3480
AG
1967 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1968 the head is detached, 'CUR_BRANCH' is empty).
1969
da0005b8 1970guitool.<name>.needsFile::
390c3480
AG
1971 Run the tool only if a diff is selected in the GUI. It guarantees
1972 that 'FILENAME' is not empty.
1973
da0005b8 1974guitool.<name>.noConsole::
390c3480
AG
1975 Run the command silently, without creating a window to display its
1976 output.
1977
da0005b8 1978guitool.<name>.noRescan::
390c3480
AG
1979 Don't rescan the working directory for changes after the tool
1980 finishes execution.
1981
1982guitool.<name>.confirm::
1983 Show a confirmation dialog before actually running the tool.
1984
da0005b8 1985guitool.<name>.argPrompt::
390c3480 1986 Request a string argument from the user, and pass it to the tool
47d81b5c 1987 through the `ARGS` environment variable. Since requesting an
390c3480
AG
1988 argument implies confirmation, the 'confirm' option has no effect
1989 if this is enabled. If the option is set to 'true', 'yes', or '1',
1990 the dialog uses a built-in generic prompt; otherwise the exact
1991 value of the variable is used.
1992
da0005b8 1993guitool.<name>.revPrompt::
390c3480 1994 Request a single valid revision from the user, and set the
47d81b5c 1995 `REVISION` environment variable. In other aspects this option
da0005b8 1996 is similar to 'argPrompt', and can be used together with it.
390c3480 1997
da0005b8
NTND
1998guitool.<name>.revUnmerged::
1999 Show only unmerged branches in the 'revPrompt' subdialog.
390c3480
AG
2000 This is useful for tools similar to merge or rebase, but not
2001 for things like checkout or reset.
2002
2003guitool.<name>.title::
2004 Specifies the title to use for the prompt dialog. The default
2005 is the tool name.
2006
2007guitool.<name>.prompt::
2008 Specifies the general prompt string to display at the top of
da0005b8 2009 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
390c3480
AG
2010 The default value includes the actual command.
2011
983a9eeb
CC
2012help.browser::
2013 Specify the browser that will be used to display help in the
2014 'web' format. See linkgit:git-help[1].
2015
2016help.format::
2017 Override the default help format used by linkgit:git-help[1].
2018 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2019 the default. 'web' and 'html' are the same.
2020
da0005b8 2021help.autoCorrect::
f0e90716
AR
2022 Automatically correct and execute mistyped commands after
2023 waiting for the given number of deciseconds (0.1 sec). If more
2024 than one command can be deduced from the entered text, nothing
2025 will be executed. If the value of this option is negative,
2026 the corrected command will be executed immediately. If the
2027 value is 0 - the command will be just shown but not executed.
2028 This is the default.
2029
da0005b8 2030help.htmlPath::
b1f809d0
SS
2031 Specify the path where the HTML documentation resides. File system paths
2032 and URLs are supported. HTML pages will be prefixed with this path when
2033 help is displayed in the 'web' format. This defaults to the documentation
2034 path of your Git installation.
2035
9c5665aa 2036http.proxy::
b2c8c6d9 2037 Override the HTTP proxy, normally configured using the 'http_proxy',
372370f1
KF
2038 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2039 addition to the syntax understood by curl, it is possible to specify a
2040 proxy string with a user name but no password, in which case git will
2041 attempt to acquire one in the same way it does for other credentials. See
2042 linkgit:gitcredentials[7] for more information. The syntax thus is
2043 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2044 on a per-remote basis; see remote.<name>.proxy
9c5665aa 2045
ef976395
KF
2046http.proxyAuthMethod::
2047 Set the method with which to authenticate against the HTTP proxy. This
2048 only takes effect if the configured proxy string contains a user name part
2049 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2050 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
eee7f4a2 2051 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
ef976395
KF
2052 variable. Possible values are:
2053+
2054--
2055* `anyauth` - Automatically pick a suitable authentication method. It is
2056 assumed that the proxy answers an unauthenticated request with a 407
2057 status code and one or more Proxy-authenticate headers with supported
2058 authentication methods. This is the default.
2059* `basic` - HTTP Basic authentication
2060* `digest` - HTTP Digest authentication; this prevents the password from being
2061 transmitted to the proxy in clear text
2062* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2063 of `curl(1)`)
2064* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2065--
9c5665aa 2066
121061f6 2067http.emptyAuth::
2068 Attempt authentication without seeking a username or password. This
2069 can be used to attempt GSS-Negotiate authentication without specifying
2070 a username in the URL, as libcurl normally requires a username for
2071 authentication.
2072
26a7b234
PS
2073http.delegation::
2074 Control GSSAPI credential delegation. The delegation is disabled
2075 by default in libcurl since version 7.21.7. Set parameter to tell
2076 the server what it is allowed to delegate when it comes to user
2077 credentials. Used with GSS/kerberos. Possible values are:
2078+
2079--
2080* `none` - Don't allow any delegation.
2081* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2082 Kerberos service ticket, which is a matter of realm policy.
2083* `always` - Unconditionally allow the server to delegate.
2084--
2085
2086
8cb01e2f
JS
2087http.extraHeader::
2088 Pass an additional HTTP header when communicating with a server. If
2089 more than one such entry exists, all of them are added as extra
2090 headers. To allow overriding the settings inherited from the system
2091 config, an empty value will reset the extra headers to the empty list.
2092
da0005b8 2093http.cookieFile::
e5a39ad8
BN
2094 The pathname of a file containing previously stored cookie lines,
2095 which should be used
2de9b711 2096 in the Git http session, if they match the server. The file format
bcfb95dd 2097 of the file to read cookies from should be plain HTTP headers or
1cca17df 2098 the Netscape/Mozilla cookie file format (see `curl(1)`).
06ea368b 2099 NOTE that the file specified with http.cookieFile is used only as
912b2acf
DB
2100 input unless http.saveCookies is set.
2101
da0005b8 2102http.saveCookies::
912b2acf 2103 If set, store cookies received during requests to the file specified by
da0005b8 2104 http.cookieFile. Has no effect if http.cookieFile is unset.
bcfb95dd 2105
01861cb7
EP
2106http.sslVersion::
2107 The SSL version to use when negotiating an SSL connection, if you
2108 want to force the default. The available and default version
2109 depend on whether libcurl was built against NSS or OpenSSL and the
2110 particular configuration of the crypto library in use. Internally
2111 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2112 documentation for more details on the format of this option and
2113 for the ssl version supported. Actually the possible values of
2114 this option are:
2115
2116 - sslv2
2117 - sslv3
2118 - tlsv1
2119 - tlsv1.0
2120 - tlsv1.1
2121 - tlsv1.2
d81b651f 2122 - tlsv1.3
01861cb7
EP
2123
2124+
eee7f4a2 2125Can be overridden by the `GIT_SSL_VERSION` environment variable.
01861cb7 2126To force git to use libcurl's default ssl version and ignore any
eee7f4a2 2127explicit http.sslversion option, set `GIT_SSL_VERSION` to the
01861cb7
EP
2128empty string.
2129
f6f2a9e4
LKS
2130http.sslCipherList::
2131 A list of SSL ciphers to use when negotiating an SSL connection.
2132 The available ciphers depend on whether libcurl was built against
2133 NSS or OpenSSL and the particular configuration of the crypto
2134 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2135 option; see the libcurl documentation for more details on the format
2136 of this list.
2137+
eee7f4a2 2138Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
f6f2a9e4 2139To force git to use libcurl's default cipher list and ignore any
eee7f4a2 2140explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
f6f2a9e4
LKS
2141empty string.
2142
1ab661dd
PB
2143http.sslVerify::
2144 Whether to verify the SSL certificate when fetching or pushing
dec366c9
SR
2145 over HTTPS. Defaults to true. Can be overridden by the
2146 `GIT_SSL_NO_VERIFY` environment variable.
1ab661dd
PB
2147
2148http.sslCert::
2149 File containing the SSL certificate when fetching or pushing
eee7f4a2 2150 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1ab661dd
PB
2151 variable.
2152
2153http.sslKey::
2154 File containing the SSL private key when fetching or pushing
eee7f4a2 2155 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1ab661dd
PB
2156 variable.
2157
754ae192 2158http.sslCertPasswordProtected::
2de9b711 2159 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
2160 OpenSSL will prompt the user, possibly many times, if the
2161 certificate or private key is encrypted. Can be overridden by the
eee7f4a2 2162 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
754ae192 2163
1ab661dd
PB
2164http.sslCAInfo::
2165 File containing the certificates to verify the peer with when
abda1ef5 2166 fetching or pushing over HTTPS. Can be overridden by the
eee7f4a2 2167 `GIT_SSL_CAINFO` environment variable.
1ab661dd
PB
2168
2169http.sslCAPath::
2170 Path containing files with the CA certificates to verify the peer
37425065 2171 with when fetching or pushing over HTTPS. Can be overridden
eee7f4a2 2172 by the `GIT_SSL_CAPATH` environment variable.
1ab661dd 2173
aeff8a61
CE
2174http.pinnedpubkey::
2175 Public key of the https service. It may either be the filename of
2176 a PEM or DER encoded public key file or a string starting with
2177 'sha256//' followed by the base64 encoded sha256 hash of the
2178 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2179 exit with an error if this option is set but not supported by
2180 cURL.
2181
4bc444eb
MV
2182http.sslTry::
2183 Attempt to use AUTH SSL/TLS and encrypted data transfers
2184 when connecting via regular FTP protocol. This might be needed
2185 if the FTP server requires it for security reasons or you wish
2186 to connect securely whenever remote FTP server supports it.
2187 Default is false since it might trigger certificate verification
2188 errors on misconfigured servers.
2189
1ab661dd 2190http.maxRequests::
abda1ef5 2191 How many HTTP requests to launch in parallel. Can be overridden
eee7f4a2 2192 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1ab661dd 2193
ad75ebe5
TRC
2194http.minSessions::
2195 The number of curl sessions (counted across slots) to be kept across
2196 requests. They will not be ended with curl_easy_cleanup() until
2197 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2198 value will be capped at 1. Defaults to 1.
2199
de1a2fdd
SP
2200http.postBuffer::
2201 Maximum size in bytes of the buffer used by smart HTTP
2202 transports when POSTing data to the remote system.
2203 For requests larger than this buffer size, HTTP/1.1 and
2204 Transfer-Encoding: chunked is used to avoid creating a
2205 massive pack file locally. Default is 1 MiB, which is
2206 sufficient for most requests.
2207
1ab661dd
PB
2208http.lowSpeedLimit, http.lowSpeedTime::
2209 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2210 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
eee7f4a2
TR
2211 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2212 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1ab661dd 2213
3ea099d4
SK
2214http.noEPSV::
2215 A boolean which disables using of EPSV ftp command by curl.
befc9c42 2216 This can helpful with some "poor" ftp servers which don't
eee7f4a2 2217 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
3ea099d4
SK
2218 environment variable. Default is false (curl will use EPSV).
2219
da0005b8 2220http.userAgent::
b1d1058c 2221 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 2222 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
2223 This option allows you to override this value to a more common value
2224 such as Mozilla/4.0. This may be necessary, for instance, if
2225 connecting through a firewall that restricts HTTP connections to a set
2226 of common USER_AGENT strings (but not including those like git/1.7.1).
eee7f4a2 2227 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
b1d1058c 2228
50d34137
JK
2229http.followRedirects::
2230 Whether git should follow HTTP redirects. If set to `true`, git
2231 will transparently follow any redirect issued by a server it
2232 encounters. If set to `false`, git will treat all redirects as
2233 errors. If set to `initial`, git will follow redirects only for
2234 the initial request to a remote, but not for subsequent
2235 follow-up HTTP requests. Since git uses the redirected URL as
2236 the base for the follow-up requests, this is generally
2237 sufficient. The default is `initial`.
2238
6a56993b 2239http.<url>.*::
f745acb0 2240 Any of the http.* options above can be applied selectively to some URLs.
6a56993b
KM
2241 For a config key to match a URL, each element of the config key is
2242 compared to that of the URL, in the following order:
2243+
2244--
2245. Scheme (e.g., `https` in `https://example.com/`). This field
2246 must match exactly between the config key and the URL.
2247
2248. Host/domain name (e.g., `example.com` in `https://example.com/`).
a272b9e7
PS
2249 This field must match between the config key and the URL. It is
2250 possible to specify a `*` as part of the host name to match all subdomains
2251 at this level. `https://*.example.com/` for example would match
2252 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
6a56993b
KM
2253
2254. Port number (e.g., `8080` in `http://example.com:8080/`).
2255 This field must match exactly between the config key and the URL.
2256 Omitted port numbers are automatically converted to the correct
2257 default for the scheme before matching.
2258
2259. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2260 path field of the config key must match the path field of the URL
2261 either exactly or as a prefix of slash-delimited path elements. This means
2262 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2263 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2264 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2265 key with just path `foo/`).
2266
2267. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2268 the config key has a user name it must match the user name in the
2269 URL exactly. If the config key does not have a user name, that
2270 config key will match a URL with any user name (including none),
2271 but at a lower precedence than a config key with a user name.
2272--
2273+
2274The list above is ordered by decreasing precedence; a URL that matches
2275a config key's path is preferred to one that matches its user name. For example,
2276if the URL is `https://user@example.com/foo/bar` a config key match of
2277`https://example.com/foo` will be preferred over a config key match of
2278`https://user@example.com`.
2279+
2280All URLs are normalized before attempting any matching (the password part,
2281if embedded in the URL, is always ignored for matching purposes) so that
f745acb0
TA
2282equivalent URLs that are simply spelled differently will match properly.
2283Environment variable settings always override any matches. The URLs that are
6a56993b
KM
2284matched against are those given directly to Git commands. This means any URLs
2285visited as a result of a redirection do not participate in matching.
2286
dd33e077 2287ssh.variant::
0da0e49b
JN
2288 By default, Git determines the command line arguments to use
2289 based on the basename of the configured SSH command (configured
2290 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2291 the config setting `core.sshCommand`). If the basename is
2292 unrecognized, Git will attempt to detect support of OpenSSH
2293 options by first invoking the configured SSH command with the
2294 `-G` (print configuration) option and will subsequently use
2295 OpenSSH options (if that is successful) or no options besides
2296 the host and remote command (if it fails).
2297+
2298The config variable `ssh.variant` can be set to override this detection.
2299Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2300`tortoiseplink`, `simple` (no options except the host and remote command).
2301The default auto-detection can be explicitly requested using the value
2302`auto`. Any other value is treated as `ssh`. This setting can also be
2303overridden via the environment variable `GIT_SSH_VARIANT`.
94b8ae5a
BW
2304+
2305The current command-line parameters used for each variant are as
2306follows:
2307+
2308--
2309
2310* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2311
2312* `simple` - [username@]host command
2313
2314* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2315
2316* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2317
2318--
2319+
2320Except for the `simple` variant, command-line parameters are likely to
2321change as git gains new features.
dd33e077 2322
1ab661dd 2323i18n.commitEncoding::
2de9b711 2324 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
2325 does not care per se, but this information is necessary e.g. when
2326 importing commits from emails or in the gitk graphical history
2327 browser (and possibly at other places in the future or in other
5162e697 2328 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 2329
d2c11a38
JH
2330i18n.logOutputEncoding::
2331 Character encoding the commit messages are converted to when
0b444cdb 2332 running 'git log' and friends.
d2c11a38 2333
b0f34c3d
MM
2334imap::
2335 The configuration variables in the 'imap' section are described
2336 in linkgit:git-imap-send[1].
2337
3c09d684
TG
2338index.version::
2339 Specify the version with which new index files should be
2340 initialized. This does not affect existing repositories.
2341
da0005b8 2342init.templateDir::
d8a8488d
SD
2343 Specify the directory from which templates will be copied.
2344 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2345
983a9eeb
CC
2346instaweb.browser::
2347 Specify the program that will be used to browse your working
2348 repository in gitweb. See linkgit:git-instaweb[1].
2349
2350instaweb.httpd::
2351 The HTTP daemon command-line to start gitweb on your working
2352 repository. See linkgit:git-instaweb[1].
2353
2354instaweb.local::
2355 If true the web server started by linkgit:git-instaweb[1] will
2356 be bound to the local IP (127.0.0.1).
2357
da0005b8 2358instaweb.modulePath::
6b677a28
VS
2359 The default module path for linkgit:git-instaweb[1] to use
2360 instead of /usr/lib/apache2/modules. Only used if httpd
2361 is Apache.
983a9eeb
CC
2362
2363instaweb.port::
2364 The port number to bind the gitweb httpd to. See
2365 linkgit:git-instaweb[1].
2366
da0005b8 2367interactive.singleKey::
57f6ec02 2368 In interactive commands, allow the user to provide one-letter
ca6ac7f1 2369 input with a single key (i.e., without hitting enter).
6cf378f0 2370 Currently this is used by the `--patch` mode of
e6b57a8a
CI
2371 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2372 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2373 setting is silently ignored if portable keystroke input
8358f1ac 2374 is not available; requires the Perl module Term::ReadKey.
ca6ac7f1 2375
01143847
JK
2376interactive.diffFilter::
2377 When an interactive command (such as `git add --patch`) shows
2378 a colorized diff, git will pipe the diff through the shell
2379 command defined by this configuration variable. The command may
2380 mark up the diff further for human consumption, provided that it
2381 retains a one-to-one correspondence with the lines in the
2382 original diff. Defaults to disabled (no filtering).
2383
0c47695a
JS
2384log.abbrevCommit::
2385 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
2386 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2387 override this option with `--no-abbrev-commit`.
0c47695a 2388
dd0ffd5b 2389log.date::
e860795d
JN
2390 Set the default date-time mode for the 'log' command.
2391 Setting a value for log.date is similar to using 'git log''s
78a84416 2392 `--date` option. See linkgit:git-log[1] for details.
dd0ffd5b 2393
eb734454
SD
2394log.decorate::
2395 Print out the ref names of any commits that are shown by the log
2396 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2397 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2398 specified, the full ref name (including prefix) will be printed.
462cbb41
RJ
2399 If 'auto' is specified, then if the output is going to a terminal,
2400 the ref names are shown as if 'short' were given, otherwise no ref
ce18123c 2401 names are shown. This is the same as the `--decorate` option
462cbb41 2402 of the `git log`.
eb734454 2403
fd8d07ef
EVW
2404log.follow::
2405 If `true`, `git log` will act as if the `--follow` option was used when
2406 a single <path> is given. This has the same limitations as `--follow`,
2407 i.e. it cannot be used to follow multiple files and does not work well
2408 on non-linear history.
2409
73c727d6
NTND
2410log.graphColors::
2411 A list of colors, separated by commas, that can be used to draw
2412 history lines in `git log --graph`.
2413
da0005b8 2414log.showRoot::
0f03ca94
PB
2415 If true, the initial commit will be shown as a big creation event.
2416 This is equivalent to a diff against an empty tree.
5162e697 2417 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
2418 normally hide the root commit will now show it. True by default.
2419
ba4dce78
KM
2420log.showSignature::
2421 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2422 linkgit:git-whatchanged[1] assume `--show-signature`.
2423
e6bb5f78
AP
2424log.mailmap::
2425 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2426 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2427
d5c4b185
MM
2428mailinfo.scissors::
2429 If true, makes linkgit:git-mailinfo[1] (and therefore
2430 linkgit:git-am[1]) act by default as if the --scissors option
2431 was provided on the command-line. When active, this features
2432 removes everything from the message body before a scissors
2433 line (i.e. consisting mainly of ">8", "8<" and "-").
2434
d551a488
MSO
2435mailmap.file::
2436 The location of an augmenting mailmap file. The default
2437 mailmap, located in the root of the repository, is loaded
2438 first, then the mailmap file pointed to by this variable.
2439 The location of the mailmap file may be in a repository
2440 subdirectory, or somewhere outside of the repository itself.
2441 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2442
08610900
JK
2443mailmap.blob::
2444 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
2445 blob in the repository. If both `mailmap.file` and
2446 `mailmap.blob` are given, both are parsed, with entries from
2447 `mailmap.file` taking precedence. In a bare repository, this
2448 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2449 defaults to empty.
08610900 2450
b5578f33 2451man.viewer::
b8322ea8 2452 Specify the programs that may be used to display help in the
b5578f33
CC
2453 'man' format. See linkgit:git-help[1].
2454
0bb64009
CC
2455man.<tool>.cmd::
2456 Specify the command to invoke the specified man viewer. The
2457 specified command is evaluated in shell with the man page
2458 passed as argument. (See linkgit:git-help[1].)
2459
7e8114c0
CC
2460man.<tool>.path::
2461 Override the path for the given tool that may be used to
2462 display help in the 'man' format. See linkgit:git-help[1].
2463
b0f34c3d 2464include::merge-config.txt[]
b5412484 2465
77680caa
JS
2466mergetool.<tool>.path::
2467 Override the path for the given tool. This is useful in case
2468 your tool is not in the PATH.
2469
964473a0
CB
2470mergetool.<tool>.cmd::
2471 Specify the command to invoke the specified merge tool. The
2472 specified command is evaluated in shell with the following
2473 variables available: 'BASE' is the name of a temporary file
2474 containing the common base of the files to be merged, if available;
2475 'LOCAL' is the name of a temporary file containing the contents of
2476 the file on the current branch; 'REMOTE' is the name of a temporary
2477 file containing the contents of the file from the branch being
2478 merged; 'MERGED' contains the name of the file to which the merge
2479 tool should write the results of a successful merge.
2480
2481mergetool.<tool>.trustExitCode::
2482 For a custom merge command, specify whether the exit code of
2483 the merge command can be used to determine whether the merge was
2484 successful. If this is not set to true then the merge target file
2485 timestamp is checked and the merge assumed to have been successful
2486 if the file has been updated, otherwise the user is prompted to
2487 indicate the success of the merge.
2488
b12d0450
DA
2489mergetool.meld.hasOutput::
2490 Older versions of `meld` do not support the `--output` option.
2491 Git will attempt to detect whether `meld` supports `--output`
2492 by inspecting the output of `meld --help`. Configuring
2493 `mergetool.meld.hasOutput` will make Git skip these checks and
2494 use the configured value instead. Setting `mergetool.meld.hasOutput`
2495 to `true` tells Git to unconditionally use the `--output` option,
2496 and `false` avoids using `--output`.
2497
44c36d1c
CB
2498mergetool.keepBackup::
2499 After performing a merge, the original file with conflict markers
2500 can be saved as a file with a `.orig` extension. If this variable
2501 is set to `false` then this file is not preserved. Defaults to
2502 `true` (i.e. keep the backup files).
2503
162eba8b 2504mergetool.keepTemporaries::
2de9b711 2505 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
2506 files to pass to the tool. If the tool returns an error and this
2507 variable is set to `true`, then these temporary files will be
2508 preserved, otherwise they will be removed after the tool has
2509 exited. Defaults to `false`.
2510
8f0cb41d
DA
2511mergetool.writeToTemp::
2512 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2513 conflicting files in the worktree by default. Git will attempt
2514 to use a temporary directory for these files when set `true`.
2515 Defaults to `false`.
2516
682b451f
CB
2517mergetool.prompt::
2518 Prompt before each invocation of the merge resolution program.
2519
d2d68d99
JK
2520notes.mergeStrategy::
2521 Which merge strategy to choose by default when resolving notes
2522 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2523 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2524 section of linkgit:git-notes[1] for more information on each strategy.
2525
4f655e22
JK
2526notes.<name>.mergeStrategy::
2527 Which merge strategy to choose when doing a notes merge into
2528 refs/notes/<name>. This overrides the more general
2529 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2530 linkgit:git-notes[1] for more information on the available strategies.
2531
894a9d33
TR
2532notes.displayRef::
2533 The (fully qualified) refname from which to show notes when
2534 showing commit messages. The value of this variable can be set
2535 to a glob, in which case notes from all matching refs will be
2536 shown. You may also specify this configuration variable
2537 several times. A warning will be issued for refs that do not
2538 exist, but a glob that does not match any refs is silently
2539 ignored.
2540+
2541This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2542environment variable, which must be a colon separated list of refs or
2543globs.
2544+
2545The effective value of "core.notesRef" (possibly overridden by
2546GIT_NOTES_REF) is also implicitly added to the list of refs to be
2547displayed.
2548
6956f858
TR
2549notes.rewrite.<command>::
2550 When rewriting commits with <command> (currently `amend` or
2de9b711 2551 `rebase`) and this variable is set to `true`, Git
6956f858
TR
2552 automatically copies your notes from the original to the
2553 rewritten commit. Defaults to `true`, but see
2554 "notes.rewriteRef" below.
6956f858
TR
2555
2556notes.rewriteMode::
2557 When copying notes during a rewrite (see the
2558 "notes.rewrite.<command>" option), determines what to do if
2559 the target commit already has a note. Must be one of
e48ad1b9
JK
2560 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2561 Defaults to `concatenate`.
6956f858
TR
2562+
2563This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2564environment variable.
2565
2566notes.rewriteRef::
2567 When copying notes during a rewrite, specifies the (fully
2568 qualified) ref whose notes should be copied. The ref may be a
2569 glob, in which case notes in all matching refs will be copied.
2570 You may also specify this configuration several times.
2571+
2572Does not have a default value; you must configure this variable to
2b4aa89c
TR
2573enable note rewriting. Set it to `refs/notes/commits` to enable
2574rewriting for the default commit notes.
cfb88e9a
LAS
2575+
2576This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2577environment variable, which must be a colon separated list of refs or
2578globs.
6956f858 2579
4812a93a 2580pack.window::
5162e697 2581 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
2582 window size is given on the command line. Defaults to 10.
2583
842aaf93 2584pack.depth::
5162e697 2585 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 2586 maximum depth is given on the command line. Defaults to 50.
b5c0cbd8 2587 Maximum value is 4095.
842aaf93 2588
e93b15cd 2589pack.windowMemory::
f4694a8c
RB
2590 The maximum size of memory that is consumed by each thread
2591 in linkgit:git-pack-objects[1] for pack window memory when
2592 no limit is given on the command line. The value can be
2593 suffixed with "k", "m", or "g". When left unconfigured (or
2594 set explicitly to 0), there will be no limit.
e93b15cd 2595
960ccca6
DH
2596pack.compression::
2597 An integer -1..9, indicating the compression level for objects
2598 in a pack file. -1 is the zlib default. 0 means no
2599 compression, and 1..9 are various speed/size tradeoffs, 9 being
2600 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
2601 not set, defaults to -1, the zlib default, which is "a default
2602 compromise between speed and compression (currently equivalent
2603 to level 6)."
89d71f75
JK
2604+
2605Note that changing the compression level will not automatically recompress
2606all existing objects. You can force recompression by passing the -F option
2607to linkgit:git-repack[1].
960ccca6 2608
074b2eea 2609pack.deltaCacheSize::
02783075 2610 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
2611 linkgit:git-pack-objects[1] before writing them out to a pack.
2612 This cache is used to speed up the writing object phase by not
2613 having to recompute the final delta result once the best match
2614 for all objects is found. Repacking large repositories on machines
2615 which are tight with memory might be badly impacted by this though,
2616 especially if this cache pushes the system into swapping.
2617 A value of 0 means no limit. The smallest size of 1 byte may be
2618 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 2619
e3dfddb3 2620pack.deltaCacheLimit::
693b86ff 2621 The maximum size of a delta, that is cached in
5749b0b2
NP
2622 linkgit:git-pack-objects[1]. This cache is used to speed up the
2623 writing object phase by not having to recompute the final delta
0cb3c142
NTND
2624 result once the best match for all objects is found.
2625 Defaults to 1000. Maximum value is 65535.
e3dfddb3 2626
693b86ff
NP
2627pack.threads::
2628 Specifies the number of threads to spawn when searching for best
5162e697 2629 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
2630 be compiled with pthreads otherwise this option is ignored with a
2631 warning. This is meant to reduce packing time on multiprocessor
2632 machines. The required amount of memory for the delta search window
2633 is however multiplied by the number of threads.
2de9b711 2634 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 2635 and set the number of threads accordingly.
693b86ff 2636
4d00bda2
NP
2637pack.indexVersion::
2638 Specify the default pack index version. Valid values are 1 for
2639 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2640 the new pack index with capabilities for packs larger than 4 GB
2641 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
2642 packs. Version 2 is the default. Note that version 2 is enforced
2643 and this config option ignored whenever the corresponding pack is
2644 larger than 2 GB.
2645+
2de9b711 2646If you have an old Git that does not understand the version 2 `*.idx` file,
0d0bac67 2647cloning or fetching over a non native protocol (e.g. "http")
6cf378f0 2648that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 2649other side may give you a repository that cannot be accessed with your
2de9b711 2650older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 2651you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 2652the `*.idx` file.
4d00bda2 2653
dbdbfec4 2654pack.packSizeLimit::
07cf0f24
NP
2655 The maximum size of a pack. This setting only affects
2656 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 2657 is unaffected. It can be overridden by the `--max-pack-size`
9cea46cd
EW
2658 option of linkgit:git-repack[1]. Reaching this limit results
2659 in the creation of multiple packfiles; which in turn prevents
2660 bitmaps from being created.
2661 The minimum size allowed is limited to 1 MiB.
2662 The default is unlimited.
07cf0f24
NP
2663 Common unit suffixes of 'k', 'm', or 'g' are
2664 supported.
2b84b5a8 2665
6b8fda2d
VM
2666pack.useBitmaps::
2667 When true, git will use pack bitmaps (if available) when packing
2668 to stdout (e.g., during the server side of a fetch). Defaults to
2669 true. You should not generally need to turn this off unless
2670 you are debugging pack bitmaps.
2671
da0005b8 2672pack.writeBitmaps (deprecated)::
71d76cb4 2673 This is a deprecated synonym for `repack.writeBitmaps`.
7cc8f971 2674
ae4f07fb
VM
2675pack.writeBitmapHashCache::
2676 When true, git will include a "hash cache" section in the bitmap
2677 index (if one is written). This cache can be used to feed git's
2678 delta heuristics, potentially leading to better deltas between
2679 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2680 between an older, bitmapped pack and objects that have been
2681 pushed since the last gc). The downside is that it consumes 4
2682 bytes per object of disk space, and that JGit's bitmap
2683 implementation does not understand it, causing it to complain if
2684 Git and JGit are used on the same repository. Defaults to false.
2685
4370c2d6 2686pager.<cmd>::
9bad7233 2687 If the value is boolean, turns on or off pagination of the
2de9b711 2688 output of a particular Git subcommand when writing to a tty.
9bad7233 2689 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
2690 pager specified by the value of `pager.<cmd>`. If `--paginate`
2691 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
2692 precedence over this option. To disable pagination for all
2693 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 2694
8028184e
WP
2695pretty.<name>::
2696 Alias for a --pretty= format string, as specified in
2697 linkgit:git-log[1]. Any aliases defined here can be used just
2698 as the built-in pretty formats could. For example,
6cf378f0 2699 running `git config pretty.changelog "format:* %H %s"`
8028184e 2700 would cause the invocation `git log --pretty=changelog`
6cf378f0 2701 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
2702 Note that an alias with the same name as a built-in format
2703 will be silently ignored.
2704
f1762d77
BW
2705protocol.allow::
2706 If set, provide a user defined default policy for all protocols which
2707 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2708 if unset, known-safe protocols (http, https, git, ssh, file) have a
2709 default policy of `always`, known-dangerous protocols (ext) have a
2710 default policy of `never`, and all other protocols have a default
2711 policy of `user`. Supported policies:
2712+
2713--
2714
2715* `always` - protocol is always able to be used.
2716
2717* `never` - protocol is never able to be used.
2718
2719* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2720 either unset or has a value of 1. This policy should be used when you want a
2721 protocol to be directly usable by the user but don't want it used by commands which
2722 execute clone/fetch/push commands without user input, e.g. recursive
2723 submodule initialization.
2724
2725--
2726
2727protocol.<name>.allow::
2728 Set a policy to be used by protocol `<name>` with clone/fetch/push
2729 commands. See `protocol.allow` above for the available policies.
2730+
2731The protocol names currently used by git are:
2732+
2733--
2734 - `file`: any local file-based path (including `file://` URLs,
2735 or local paths)
2736
2737 - `git`: the anonymous git protocol over a direct TCP
2738 connection (or proxy, if configured)
2739
2740 - `ssh`: git over ssh (including `host:path` syntax,
2741 `ssh://`, etc).
2742
2743 - `http`: git over http, both "smart http" and "dumb http".
2744 Note that this does _not_ include `https`; if you want to configure
2745 both, you must do so individually.
2746
2747 - any external helpers are named by their protocol (e.g., use
2748 `hg` to allow the `git-remote-hg` helper)
2749--
2750
373d70ef
BW
2751protocol.version::
2752 Experimental. If set, clients will attempt to communicate with a
2753 server using the specified protocol version. If unset, no
2754 attempt will be made by the client to communicate using a
2755 particular protocol version, this results in protocol version 0
2756 being used.
2757 Supported versions:
2758+
2759--
2760
2761* `0` - the original wire protocol.
2762
2763* `1` - the original wire protocol with the addition of a version string
2764 in the initial response from the server.
2765
2766--
2767
b814da89
DA
2768pull.ff::
2769 By default, Git does not create an extra merge commit when merging
2770 a commit that is a descendant of the current commit. Instead, the
2771 tip of the current branch is fast-forwarded. When set to `false`,
2772 this variable tells Git to create an extra merge commit in such
2773 a case (equivalent to giving the `--no-ff` option from the command
2774 line). When set to `only`, only such fast-forward merges are
2775 allowed (equivalent to giving the `--ff-only` option from the
eb8dc05c 2776 command line). This setting overrides `merge.ff` when pulling.
b814da89 2777
6b37dff1
ÆAB
2778pull.rebase::
2779 When true, rebase branches on top of the fetched branch, instead
2780 of merging the default branch from the default remote when "git
2781 pull" is run. See "branch.<name>.rebase" for setting this on a
2782 per-branch basis.
66713ef3 2783+
1131ec98
JS
2784When `merges`, pass the `--rebase-merges` option to 'git rebase'
2785so that the local merge commits are included in the rebase (see
2786linkgit:git-rebase[1] for details).
2787+
d2387107
AS
2788When preserve, also pass `--preserve-merges` along to 'git rebase'
2789so that locally committed merge commits will not be flattened
2790by running 'git pull'.
6b37dff1 2791+
f5eb87b9
JS
2792When the value is `interactive`, the rebase is run in interactive mode.
2793+
6b37dff1
ÆAB
2794*NOTE*: this is a possibly dangerous operation; do *not* use
2795it unless you understand the implications (see linkgit:git-rebase[1]
2796for details).
2797
1ab661dd
PB
2798pull.octopus::
2799 The default merge strategy to use when pulling multiple branches
2800 at once.
2801
2802pull.twohead::
2803 The default merge strategy to use when pulling a single branch.
2804
52153747 2805push.default::
87a70e4c
RR
2806 Defines the action `git push` should take if no refspec is
2807 explicitly given. Different values are well-suited for
2808 specific workflows; for instance, in a purely central workflow
2809 (i.e. the fetch source is equal to the push destination),
2810 `upstream` is probably what you want. Possible values are:
52153747 2811+
b1290514 2812--
87a70e4c
RR
2813
2814* `nothing` - do not push anything (error out) unless a refspec is
2815 explicitly given. This is primarily meant for people who want to
2816 avoid mistakes by always being explicit.
2817
2818* `current` - push the current branch to update a branch with the same
2819 name on the receiving end. Works in both central and non-central
2820 workflows.
2821
2822* `upstream` - push the current branch back to the branch whose
2823 changes are usually integrated into the current branch (which is
2824 called `@{upstream}`). This mode only makes sense if you are
2825 pushing to the same repository you would normally pull from
2826 (i.e. central workflow).
2827
e4e016f6
ÆAB
2828* `tracking` - This is a deprecated synonym for `upstream`.
2829
ed2b1829
RR
2830* `simple` - in centralized workflow, work like `upstream` with an
2831 added safety to refuse to push if the upstream branch's name is
2832 different from the local one.
b1290514 2833+
ed2b1829
RR
2834When pushing to a remote that is different from the remote you normally
2835pull from, work as `current`. This is the safest option and is suited
2836for beginners.
b1290514 2837+
009055f3 2838This mode has become the default in Git 2.0.
87a70e4c
RR
2839
2840* `matching` - push all branches having the same name on both ends.
2841 This makes the repository you are pushing to remember the set of
2842 branches that will be pushed out (e.g. if you always push 'maint'
2843 and 'master' there and no other branches, the repository you push
2844 to will have these two branches, and your local 'maint' and
2845 'master' will be pushed there).
2846+
2847To use this mode effectively, you have to make sure _all_ the
2848branches you would push out are ready to be pushed out before
2849running 'git push', as the whole point of this mode is to allow you
2850to push all of the branches in one go. If you usually finish work
2851on only one branch and push out the result, while other branches are
2852unfinished, this mode is not for you. Also this mode is not
2853suitable for pushing into a shared central repository, as other
2854people may add new branches there, or update the tip of existing
2855branches outside your control.
2856+
009055f3
JH
2857This used to be the default, but not since Git 2.0 (`simple` is the
2858new default).
87a70e4c
RR
2859
2860--
52153747 2861
a8bc269f 2862push.followTags::
bcf9626a 2863 If set to true enable `--follow-tags` option by default. You
a8bc269f 2864 may override this configuration at time of push by specifying
bcf9626a 2865 `--no-follow-tags`.
a8bc269f 2866
68c757f2
DB
2867push.gpgSign::
2868 May be set to a boolean value, or the string 'if-asked'. A true
bcf9626a 2869 value causes all pushes to be GPG signed, as if `--signed` is
68c757f2
DB
2870 passed to linkgit:git-push[1]. The string 'if-asked' causes
2871 pushes to be signed if the server supports it, as if
bcf9626a 2872 `--signed=if-asked` is passed to 'git push'. A false value may
68c757f2
DB
2873 override a value from a lower-priority config file. An explicit
2874 command-line flag always overrides this config option.
a8bc269f 2875
d8052750
MP
2876push.pushOption::
2877 When no `--push-option=<option>` argument is given from the
2878 command line, `git push` behaves as if each <value> of
2879 this variable is given as `--push-option=<value>`.
2880+
2881This is a multi-valued variable, and an empty value can be used in a
2882higher priority configuration file (e.g. `.git/config` in a
2883repository) to clear the values inherited from a lower priority
2884configuration files (e.g. `$HOME/.gitconfig`).
2885+
2886--
2887
2888Example:
2889
2890/etc/gitconfig
2891 push.pushoption = a
2892 push.pushoption = b
2893
2894~/.gitconfig
2895 push.pushoption = c
2896
2897repo/.git/config
2898 push.pushoption =
2899 push.pushoption = b
2900
2901This will result in only b (a and c are cleared).
2902
2903--
2904
b33a15b0
MC
2905push.recurseSubmodules::
2906 Make sure all submodule commits used by the revisions to be pushed
2907 are available on a remote-tracking branch. If the value is 'check'
2908 then Git will verify that all submodule commits that changed in the
2909 revisions to be pushed are available on at least one remote of the
2910 submodule. If any commits are missing, the push will be aborted and
2911 exit with non-zero status. If the value is 'on-demand' then all
2912 submodules that changed in the revisions to be pushed will be
2913 pushed. If on-demand was not able to push all necessary revisions
2914 it will also be aborted and exit with non-zero status. If the value
2915 is 'no' then default behavior of ignoring submodules when pushing
2916 is retained. You may override this configuration at time of push by
2917 specifying '--recurse-submodules=check|on-demand|no'.
2918
946a9f20 2919include::rebase-config.txt[]
16cf51c7 2920
da0005b8 2921receive.advertiseAtomic::
04b39f19 2922 By default, git-receive-pack will advertise the atomic push
c714e45f
SB
2923 capability to its clients. If you don't want to advertise this
2924 capability, set this variable to false.
2925
2926receive.advertisePushOptions::
b7b744f2
JT
2927 When set to true, git-receive-pack will advertise the push options
2928 capability to its clients. False by default.
04b39f19 2929
77e3efbf
JH
2930receive.autogc::
2931 By default, git-receive-pack will run "git-gc --auto" after
2932 receiving data from git-push and updating refs. You can stop
2933 it by setting this variable to false.
2934
da0005b8 2935receive.certNonceSeed::
b89363e4
JH
2936 By setting this variable to a string, `git receive-pack`
2937 will accept a `git push --signed` and verifies it by using
2938 a "nonce" protected by HMAC using this string as a secret
2939 key.
2940
da0005b8 2941receive.certNonceSlop::
5732373d
JH
2942 When a `git push --signed` sent a push certificate with a
2943 "nonce" that was issued by a receive-pack serving the same
2944 repository within this many seconds, export the "nonce"
2945 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2946 hooks (instead of what the receive-pack asked the sending
2947 side to include). This may allow writing checks in
2948 `pre-receive` and `post-receive` a bit easier. Instead of
2949 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2950 that records by how many seconds the nonce is stale to
2951 decide if they want to accept the certificate, they only
2952 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2953
b0f34c3d
MM
2954receive.fsckObjects::
2955 If it is set to true, git-receive-pack will check all received
2956 objects. It will abort in the case of a malformed object or a
2957 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
2958 Defaults to false. If not set, the value of `transfer.fsckObjects`
2959 is used instead.
b0f34c3d 2960
4b55b9b4
JS
2961receive.fsck.<msg-id>::
2962 When `receive.fsckObjects` is set to true, errors can be switched
2963 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2964 setting where the `<msg-id>` is the fsck message ID and the value
2965 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2966 the error/warning with the message ID, e.g. "missingEmail: invalid
2967 author/committer line - missing email" means that setting
2968 `receive.fsck.missingEmail = ignore` will hide that issue.
2969+
2970This feature is intended to support working with legacy repositories
2971which would not pass pushing when `receive.fsckObjects = true`, allowing
2972the host to accept repositories with certain known issues but still catch
2973other issues.
2974
cd94c6f9
JS
2975receive.fsck.skipList::
2976 The path to a sorted list of object names (i.e. one SHA-1 per
2977 line) that are known to be broken in a non-fatal way and should
2978 be ignored. This feature is useful when an established project
2979 should be accepted despite early commits containing errors that
2980 can be safely ignored such as invalid committer email addresses.
2981 Note: corrupt objects cannot be skipped with this setting.
2982
83558686
JK
2983receive.keepAlive::
2984 After receiving the pack from the client, `receive-pack` may
2985 produce no output (if `--quiet` was specified) while processing
2986 the pack, causing some networks to drop the TCP connection.
2987 With this option set, if `receive-pack` does not transmit
2988 any data in this phase for `receive.keepAlive` seconds, it will
2989 send a short keepalive packet. The default is 5 seconds; set
2990 to 0 to disable keepalives entirely.
2991
b0f34c3d
MM
2992receive.unpackLimit::
2993 If the number of objects received in a push is below this
2994 limit then the objects will be unpacked into loose object
2995 files. However if the number of received objects equals or
2996 exceeds this limit then the received pack will be stored as
2997 a pack, after adding any missing delta bases. Storing the
2998 pack from a push can make the push operation complete faster,
2999 especially on slow filesystems. If not set, the value of
3000 `transfer.unpackLimit` is used instead.
3001
c08db5a2
JK
3002receive.maxInputSize::
3003 If the size of the incoming pack stream is larger than this
3004 limit, then git-receive-pack will error out, instead of
3005 accepting the pack file. If not set or set to 0, then the size
3006 is unlimited.
3007
42fc11c1
JH
3008receive.denyDeletes::
3009 If set to true, git-receive-pack will deny a ref update that deletes
3010 the ref. Use this to prevent such a ref deletion via a push.
3011
662c83ff
TR
3012receive.denyDeleteCurrent::
3013 If set to true, git-receive-pack will deny a ref update that
3014 deletes the currently checked out branch of a non-bare repository.
3015
42fc11c1 3016receive.denyCurrentBranch::
f3838ce1 3017 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
3018 to the currently checked out branch of a non-bare repository.
3019 Such a push is potentially dangerous because it brings the HEAD
3020 out of sync with the index and working tree. If set to "warn",
3021 print a warning of such a push to stderr, but allow the push to
3022 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 3023 message. Defaults to "refuse".
1404bcbb
JS
3024+
3025Another option is "updateInstead" which will update the working
08553319 3026tree if pushing into the current branch. This option is
1404bcbb
JS
3027intended for synchronizing working directories when one side is not easily
3028accessible via interactive ssh (e.g. a live web site, hence the requirement
3029that the working directory be clean). This mode also comes in handy when
3030developing inside a VM to test and fix code on different Operating Systems.
08553319
JH
3031+
3032By default, "updateInstead" will refuse the push if the working tree or
3033the index have any difference from the HEAD, but the `push-to-checkout`
3034hook can be used to customize this. See linkgit:githooks[5].
42fc11c1 3035
b0f34c3d
MM
3036receive.denyNonFastForwards::
3037 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 3038 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
3039 even if that push is forced. This configuration variable is
3040 set when initializing a shared repository.
3041
da0005b8 3042receive.hideRefs::
cc118a65
JK
3043 This variable is the same as `transfer.hideRefs`, but applies
3044 only to `receive-pack` (and so affects pushes, but not fetches).
3045 An attempt to update or delete a hidden ref by `git push` is
3046 rejected.
daebaa78 3047
da0005b8 3048receive.updateServerInfo::
77e3efbf
JH
3049 If set to true, git-receive-pack will run git-update-server-info
3050 after receiving data from git-push and updating refs.
3051
da0005b8 3052receive.shallowUpdate::
0a1bc12b
NTND
3053 If set to true, .git/shallow can be updated when new refs
3054 require new shallow roots. Otherwise those refs are rejected.
3055
da0005b8 3056remote.pushDefault::
224c2171 3057 The remote to push to by default. Overrides
9f765ce6 3058 `branch.<name>.remote` for all branches, and is overridden by
da0005b8 3059 `branch.<name>.pushRemote` for specific branches.
224c2171 3060
0cc6d346 3061remote.<name>.url::
5162e697
DM
3062 The URL of a remote repository. See linkgit:git-fetch[1] or
3063 linkgit:git-push[1].
0cc6d346 3064
20346234
MG
3065remote.<name>.pushurl::
3066 The push URL of a remote repository. See linkgit:git-push[1].
3067
14c98218
SV
3068remote.<name>.proxy::
3069 For remotes that require curl (http, https and ftp), the URL to
3070 the proxy to use for that remote. Set to the empty string to
3071 disable proxying for that remote.
3072
ef976395
KF
3073remote.<name>.proxyAuthMethod::
3074 For remotes that require curl (http, https and ftp), the method to use for
3075 authenticating against the proxy in use (probably set in
3076 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3077
0cc6d346 3078remote.<name>.fetch::
5162e697
DM
3079 The default set of "refspec" for linkgit:git-fetch[1]. See
3080 linkgit:git-fetch[1].
0cc6d346
SB
3081
3082remote.<name>.push::
5162e697
DM
3083 The default set of "refspec" for linkgit:git-push[1]. See
3084 linkgit:git-push[1].
0cc6d346 3085
84bb2dfd
PB
3086remote.<name>.mirror::
3087 If true, pushing to this remote will automatically behave
6cf378f0 3088 as if the `--mirror` option was given on the command line.
84bb2dfd 3089
1918278e
TT
3090remote.<name>.skipDefaultUpdate::
3091 If true, this remote will be skipped by default when updating
7cc91a2f
BG
3092 using linkgit:git-fetch[1] or the `update` subcommand of
3093 linkgit:git-remote[1].
3094
3095remote.<name>.skipFetchAll::
3096 If true, this remote will be skipped by default when updating
3097 using linkgit:git-fetch[1] or the `update` subcommand of
3098 linkgit:git-remote[1].
1918278e 3099
060aafc1 3100remote.<name>.receivepack::
5dee29ac 3101 The default program to execute on the remote side when pushing. See
1c262bb7 3102 option --receive-pack of linkgit:git-push[1].
060aafc1 3103
5dee29ac
UKK
3104remote.<name>.uploadpack::
3105 The default program to execute on the remote side when fetching. See
1c262bb7 3106 option --upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 3107
da0005b8 3108remote.<name>.tagOpt::
1c262bb7
JK
3109 Setting this value to --no-tags disables automatic tag following when
3110 fetching from remote <name>. Setting it to --tags will fetch every
944163a4 3111 tag from remote <name>, even if they are not reachable from remote
ed368546 3112 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1c262bb7 3113 override this setting. See options --tags and --no-tags of
ed368546 3114 linkgit:git-fetch[1].
047f636d 3115
c578f51d 3116remote.<name>.vcs::
2de9b711 3117 Setting this to a value <vcs> will cause Git to interact with
c578f51d
DB
3118 the remote with the git-remote-<vcs> helper.
3119
737c5a9c
MS
3120remote.<name>.prune::
3121 When set to true, fetching from this remote by default will also
0838bf47
MH
3122 remove any remote-tracking references that no longer exist on the
3123 remote (as if the `--prune` option was given on the command line).
737c5a9c
MS
3124 Overrides `fetch.prune` settings, if any.
3125
97716d21
ÆAB
3126remote.<name>.pruneTags::
3127 When set to true, fetching from this remote by default will also
3128 remove any local tags that no longer exist on the remote if pruning
3129 is activated in general via `remote.<name>.prune`, `fetch.prune` or
3130 `--prune`. Overrides `fetch.pruneTags` settings, if any.
627a129b
ÆAB
3131+
3132See also `remote.<name>.prune` and the PRUNING section of
3133linkgit:git-fetch[1].
737c5a9c 3134
1918278e
TT
3135remotes.<group>::
3136 The list of remotes which are fetched by "git remote update
5162e697 3137 <group>". See linkgit:git-remote[1].
1918278e 3138
da0005b8 3139repack.useDeltaBaseOffset::
22c79eab
NP
3140 By default, linkgit:git-repack[1] creates packs that use
3141 delta-base offset. If you need to share your repository with
2de9b711 3142 Git older than version 1.4.4, either directly or via a dumb
22c79eab 3143 protocol such as http, then you need to set this option to
2de9b711 3144 "false" and repack. Access from old Git versions over the
22c79eab 3145 native protocol are unaffected by this option.
b6945f57 3146
ee34a2be
JK
3147repack.packKeptObjects::
3148 If set to true, makes `git repack` act as if
3149 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3150 details. Defaults to `false` normally, but `true` if a bitmap
3151 index is being written (either via `--write-bitmap-index` or
71d76cb4
JK
3152 `repack.writeBitmaps`).
3153
3154repack.writeBitmaps::
3155 When true, git will write a bitmap index when packing all
3156 objects to disk (e.g., when `git repack -a` is run). This
3157 index can speed up the "counting objects" phase of subsequent
3158 packs created for clones and fetches, at the cost of some disk
9cea46cd
EW
3159 space and extra time spent on the initial repack. This has
3160 no effect if multiple packfiles are created.
3161 Defaults to false.
ee34a2be 3162
da0005b8 3163rerere.autoUpdate::
b0f34c3d
MM
3164 When set to true, `git-rerere` updates the index with the
3165 resulting contents after it cleanly resolves conflicts using
3166 previously recorded resolution. Defaults to false.
3167
3168rerere.enabled::
3169 Activate recording of resolved conflicts, so that identical
07b88a00
TR