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