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