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