]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/config.txt
builtin/blame: dim uninteresting metadata lines
[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
f3673988
BG
1091color.branch::
1092 A boolean to enable/disable color in the output of
5162e697 1093 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 1094 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1095 only when the output is to a terminal. If unset, then the
1096 value of `color.ui` is used (`auto` by default).
f3673988
BG
1097
1098color.branch.<slot>::
1099 Use customized color for branch coloration. `<slot>` is one of
1100 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
1101 `remote` (a remote-tracking branch in refs/remotes/),
1102 `upstream` (upstream tracking branch), `plain` (other
4f193f20 1103 refs).
f3673988 1104
a159ca0c 1105color.diff::
6999c540
MG
1106 Whether to use ANSI escape sequences to add color to patches.
1107 If this is set to `always`, linkgit:git-diff[1],
1108 linkgit:git-log[1], and linkgit:git-show[1] will use color
1109 for all patches. If it is set to `true` or `auto`, those
1110 commands will only use color when output is to the terminal.
14d16e2b
MM
1111 If unset, then the value of `color.ui` is used (`auto` by
1112 default).
6999c540 1113+
a58088ab 1114This does not affect linkgit:git-format-patch[1] or the
6999c540
MG
1115'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1116command line with the `--color[=<when>]` option.
b5376648 1117
61e89eaa
SB
1118diff.colorMoved::
1119 If set to either a valid `<mode>` or a true value, moved lines
1120 in a diff are colored differently, for details of valid modes
1121 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1122 true the default color mode will be used. When set to false,
1123 moved lines are not colored.
1124
a159ca0c 1125color.diff.<slot>::
4f193f20
MW
1126 Use customized color for diff colorization. `<slot>` specifies
1127 which part of the patch to use the specified color, and is one
74b15bfb
JK
1128 of `context` (context text - `plain` is a historical synonym),
1129 `meta` (metainformation), `frag`
89cb73a1 1130 (hunk header), 'func' (function in hunk header), `old` (removed lines),
61e89eaa
SB
1131 `new` (added lines), `commit` (commit headers), `whitespace`
1132 (highlighting whitespace errors), `oldMoved` (deleted lines),
1133 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1134 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1135 and `newMovedAlternativeDimmed` (See the '<mode>'
1136 setting of '--color-moved' in linkgit:git-diff[1] for details).
b5376648 1137
5e11bee6
NR
1138color.decorate.<slot>::
1139 Use customized color for 'git log --decorate' output. `<slot>` is one
1140 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 1141 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 1142
7e8f59d5
RS
1143color.grep::
1144 When set to `always`, always highlight matches. When `false` (or
1145 `never`), never. When set to `true` or `auto`, use color only
14d16e2b
MM
1146 when the output is written to the terminal. If unset, then the
1147 value of `color.ui` is used (`auto` by default).
7e8f59d5 1148
55f638bd
ML
1149color.grep.<slot>::
1150 Use customized color for grep colorization. `<slot>` specifies which
1151 part of the line to use the specified color, and is one of
1152+
1153--
00588bb5
ML
1154`context`;;
1155 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
1156`filename`;;
1157 filename prefix (when not using `-h`)
00588bb5
ML
1158`function`;;
1159 function name lines (when using `-p`)
55f638bd
ML
1160`linenumber`;;
1161 line number prefix (when using `-n`)
1162`match`;;
79a77109
RS
1163 matching text (same as setting `matchContext` and `matchSelected`)
1164`matchContext`;;
1165 matching text in context lines
1166`matchSelected`;;
1167 matching text in selected lines
00588bb5
ML
1168`selected`;;
1169 non-matching text in selected lines
55f638bd
ML
1170`separator`;;
1171 separators between fields on a line (`:`, `-`, and `=`)
1172 and between hunks (`--`)
1173--
7e8f59d5 1174
b4c61ed6 1175color.interactive::
47ee06f1 1176 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
1177 and displays (such as those used by "git-add --interactive" and
1178 "git-clean --interactive"). When false (or `never`), never.
1179 When set to `true` or `auto`, use colors only when the output is
14d16e2b
MM
1180 to the terminal. If unset, then the value of `color.ui` is
1181 used (`auto` by default).
b4c61ed6
JH
1182
1183color.interactive.<slot>::
7a9b0b80
JX
1184 Use customized color for 'git add --interactive' and 'git clean
1185 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1186 or `error`, for four distinct types of normal output from
b92c1a28 1187 interactive commands.
b4c61ed6 1188
1d77043b
JH
1189color.pager::
1190 A boolean to enable/disable colored output when the pager is in
1191 use (default is true).
1192
da0005b8 1193color.showBranch::
ab07ba2a
MH
1194 A boolean to enable/disable color in the output of
1195 linkgit:git-show-branch[1]. May be set to `always`,
1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1197 only when the output is to a terminal. If unset, then the
1198 value of `color.ui` is used (`auto` by default).
ab07ba2a 1199
1d77043b
JH
1200color.status::
1201 A boolean to enable/disable color in the output of
5162e697 1202 linkgit:git-status[1]. May be set to `always`,
cec99d8c 1203 `false` (or `never`) or `auto` (or `true`), in which case colors are used
14d16e2b
MM
1204 only when the output is to a terminal. If unset, then the
1205 value of `color.ui` is used (`auto` by default).
1d77043b
JH
1206
1207color.status.<slot>::
1208 Use customized color for status colorization. `<slot>` is
1209 one of `header` (the header text of the status message),
82dca848
SP
1210 `added` or `updated` (files which are added but not committed),
1211 `changed` (files which are changed but not added in the index),
2de9b711 1212 `untracked` (files which are not tracked by Git),
0d6accc0 1213 `branch` (the current branch),
950ce2e2 1214 `nobranch` (the color the 'no branch' warning is shown in, defaulting
93fdf301
SK
1215 to red),
1216 `localBranch` or `remoteBranch` (the local and remote branch names,
1217 respectively, when branch and tracking information is displayed in the
1218 status short-format), or
0d6accc0 1219 `unmerged` (files which have unmerged changes).
1d77043b 1220
cdc2d5f1
SB
1221color.blame.repeatedLines::
1222 Use the customized color for the part of git-blame output that
1223 is repeated meta information per line (such as commit id,
1224 author name, date and timezone). Defaults to cyan.
1225
6b2f2d98 1226color.ui::
6999c540
MG
1227 This variable determines the default value for variables such
1228 as `color.diff` and `color.grep` that control the use of color
1229 per command family. Its scope will expand as more commands learn
1230 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
1231 to `false` or `never` if you prefer Git commands not to use
1232 color unless enabled explicitly with some other configuration
1233 or the `--color` option. Set it to `always` if you want all
1234 output not intended for machine consumption to use color, to
1235 `true` or `auto` (this is the default since Git 1.8.4) if you
1236 want such output to use color when written to the terminal.
6b2f2d98 1237
7e29b825
NTND
1238column.ui::
1239 Specify whether supported commands should output in columns.
1240 This variable consists of a list of tokens separated by spaces
1241 or commas:
1242+
5e62cc14
RR
1243These options control when the feature should be enabled
1244(defaults to 'never'):
1245+
7e29b825
NTND
1246--
1247`always`;;
1248 always show in columns
1249`never`;;
1250 never show in columns
1251`auto`;;
1252 show in columns if the output is to the terminal
5e62cc14
RR
1253--
1254+
1255These options control layout (defaults to 'column'). Setting any
1256of these implies 'always' if none of 'always', 'never', or 'auto' are
1257specified.
1258+
1259--
077539d7 1260`column`;;
5e62cc14 1261 fill columns before rows
077539d7
NTND
1262`row`;;
1263 fill rows before columns
7e29b825
NTND
1264`plain`;;
1265 show in one column
5e62cc14
RR
1266--
1267+
1268Finally, these options can be combined with a layout option (defaults
1269to 'nodense'):
1270+
1271--
3f8eccbe
NTND
1272`dense`;;
1273 make unequal size columns to utilize more space
1274`nodense`;;
1275 make equal size columns
7e29b825 1276--
7e29b825 1277
ebe31ef2
NTND
1278column.branch::
1279 Specify whether to output branch listing in `git branch` in columns.
1280 See `column.ui` for details.
1281
1b8fd467
JX
1282column.clean::
1283 Specify the layout when list items in `git clean -i`, which always
1284 shows files and directories in columns. See `column.ui` for details.
1285
323d0530
NTND
1286column.status::
1287 Specify whether to output untracked files in `git status` in columns.
1288 See `column.ui` for details.
1289
d96e3c15
NTND
1290column.tag::
1291 Specify whether to output tag listing in `git tag` in columns.
1292 See `column.ui` for details.
1293
51fb3a3d
RT
1294commit.cleanup::
1295 This setting overrides the default of the `--cleanup` option in
1296 `git commit`. See linkgit:git-commit[1] for details. Changing the
1297 default can be useful when you always want to keep lines that begin
1298 with comment character `#` in your log message, in which case you
1299 would do `git config commit.cleanup whitespace` (note that you will
1300 have to remove the help lines that begin with `#` in the commit log
1301 template yourself, if you do this).
1302
da0005b8 1303commit.gpgSign::
d95bfb12
NV
1304
1305 A boolean to specify whether all commits should be GPG signed.
1306 Use of this option when doing operations such as rebase can
1307 result in a large number of commits being signed. It may be
1308 convenient to use an agent to avoid typing your GPG passphrase
1309 several times.
1310
88955ed2 1311commit.status::
bed575e4
JHI
1312 A boolean to enable/disable inclusion of status information in the
1313 commit message template when using an editor to prepare the commit
1314 message. Defaults to true.
1315
b0f34c3d 1316commit.template::
dca83abd
JH
1317 Specify the pathname of a file to use as the template for
1318 new commit messages.
b0f34c3d 1319
aaab8420
PB
1320commit.verbose::
1321 A boolean or int to specify the level of verbose with `git commit`.
1322 See linkgit:git-commit[1].
1323
a6fc9fd3
JK
1324credential.helper::
1325 Specify an external helper to be called when a username or
1326 password credential is needed; the helper may consult external
24321375
JK
1327 storage to avoid prompting the user for the credentials. Note
1328 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1329 for details.
a6fc9fd3
JK
1330
1331credential.useHttpPath::
1332 When acquiring credentials, consider the "path" component of an http
1333 or https URL to be important. Defaults to false. See
1334 linkgit:gitcredentials[7] for more information.
1335
1336credential.username::
1337 If no username is set for a network authentication, use this username
1338 by default. See credential.<context>.* below, and
1339 linkgit:gitcredentials[7].
1340
1341credential.<url>.*::
1342 Any of the credential.* options above can be applied selectively to
1343 some credentials. For example "credential.https://example.com.username"
1344 would set the default username only for https connections to
1345 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1346 matched.
1347
7f4d4746
NP
1348credentialCache.ignoreSIGHUP::
1349 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1350
19299a84 1351include::diff-config.txt[]
afcbc8e7
DA
1352
1353difftool.<tool>.path::
1354 Override the path for the given tool. This is useful in case
1355 your tool is not in the PATH.
1356
1357difftool.<tool>.cmd::
1358 Specify the command to invoke the specified diff tool.
1359 The specified command is evaluated in shell with the following
1360 variables available: 'LOCAL' is set to the name of the temporary
1361 file containing the contents of the diff pre-image and 'REMOTE'
1362 is set to the name of the temporary file containing the contents
1363 of the diff post-image.
1364
a904392e
DA
1365difftool.prompt::
1366 Prompt before each invocation of the diff tool.
1367
d9545c7f
EW
1368fastimport.unpackLimit::
1369 If the number of objects imported by linkgit:git-fast-import[1]
1370 is below this limit, then the objects will be unpacked into
1371 loose object files. However if the number of imported objects
1372 equals or exceeds this limit then the pack will be stored as a
1373 pack. Storing the pack from a fast-import can make the import
1374 operation complete faster, especially on slow filesystems. If
1375 not set, the value of `transfer.unpackLimit` is used instead.
1376
be254a0e 1377fetch.recurseSubmodules::
1fb25502
JL
1378 This option can be either set to a boolean value or to 'on-demand'.
1379 Setting it to a boolean changes the behavior of fetch and pull to
1380 unconditionally recurse into submodules when set to true or to not
1381 recurse at all when set to false. When set to 'on-demand' (the default
1382 value), fetch and pull will only recurse into a populated submodule
1383 when its superproject retrieves a commit that updates the submodule's
1384 reference.
be254a0e 1385
5e838ea7
JH
1386fetch.fsckObjects::
1387 If it is set to true, git-fetch-pack will check all fetched
1388 objects. It will abort in the case of a malformed object or a
1389 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1390 Defaults to false. If not set, the value of `transfer.fsckObjects`
1391 is used instead.
5e838ea7 1392
af7cf268 1393fetch.unpackLimit::
2de9b711 1394 If the number of objects fetched over the Git native
af7cf268
JH
1395 transfer is below this
1396 limit, then the objects will be unpacked into loose object
1397 files. However if the number of received objects equals or
1398 exceeds this limit then the received pack will be stored as
1399 a pack, after adding any missing delta bases. Storing the
1400 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1401 especially on slow filesystems. If not set, the value of
1402 `transfer.unpackLimit` is used instead.
af7cf268 1403
737c5a9c
MS
1404fetch.prune::
1405 If true, fetch will automatically behave as if the `--prune`
1406 option was given on the command line. See also `remote.<name>.prune`.
1407
bc437d10
NTND
1408fetch.output::
1409 Control how ref update status is printed. Valid values are
1410 `full` and `compact`. Default value is `full`. See section
1411 OUTPUT in linkgit:git-fetch[1] for detail.
1412
48d3448d
SB
1413format.attach::
1414 Enable multipart/mixed attachments as the default for
1415 'format-patch'. The value can also be a double quoted string
1416 which will enable attachments as the default and set the
1417 value as the boundary. See the --attach option in
1418 linkgit:git-format-patch[1].
1419
6bc6b6c0
JT
1420format.from::
1421 Provides the default value for the `--from` option to format-patch.
1422 Accepts a boolean value, or a name and email address. If false,
1423 format-patch defaults to `--no-from`, using commit authors directly in
1424 the "From:" field of patch mails. If true, format-patch defaults to
1425 `--from`, using your committer identity in the "From:" field of patch
1426 mails and including a "From:" field in the body of the patch mail if
1427 different. If set to a non-boolean value, format-patch uses that
1428 value instead of your committer identity. Defaults to false.
1429
49604a4d 1430format.numbered::
a567fdcb
BG
1431 A boolean which can enable or disable sequence numbers in patch
1432 subjects. It defaults to "auto" which enables it only if there
1433 is more than one patch. It can be enabled or disabled for all
1434 messages by setting it to "true" or "false". See --numbered
1435 option in linkgit:git-format-patch[1].
49604a4d 1436
1ab661dd
PB
1437format.headers::
1438 Additional email headers to include in a patch to be submitted
5162e697 1439 by mail. See linkgit:git-format-patch[1].
1ab661dd 1440
312a30eb 1441format.to::
48d3448d 1442format.cc::
312a30eb
MV
1443 Additional recipients to include in a patch to be submitted
1444 by mail. See the --to and --cc options in
1445 linkgit:git-format-patch[1].
48d3448d 1446
da0005b8 1447format.subjectPrefix::
48d3448d
SB
1448 The default for format-patch is to output files with the '[PATCH]'
1449 subject prefix. Use this variable to change that prefix.
1450
6622d9c7
SB
1451format.signature::
1452 The default for format-patch is to output a signature containing
2de9b711 1453 the Git version number. Use this variable to change that default.
6622d9c7
SB
1454 Set this variable to the empty string ("") to suppress
1455 signature generation.
1456
da0005b8 1457format.signatureFile::
7022650f
JM
1458 Works just like format.signature except the contents of the
1459 file specified by this variable will be used as the signature.
1460
78cb59c8
JS
1461format.suffix::
1462 The default for format-patch is to output files with the suffix
1463 `.patch`. Use this variable to change that suffix (make sure to
1464 include the dot if you want it).
1ab661dd 1465
94c22a5e
CR
1466format.pretty::
1467 The default pretty format for log/show/whatchanged command,
1468 See linkgit:git-log[1], linkgit:git-show[1],
1469 linkgit:git-whatchanged[1].
1470
30984ed2 1471format.thread::
0b444cdb 1472 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1473 a boolean value, or `shallow` or `deep`. `shallow` threading
1474 makes every mail a reply to the head of the series,
30984ed2 1475 where the head is chosen from the cover letter, the
6cf378f0 1476 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1477 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1478 A true boolean value is the same as `shallow`, and a false
1479 value disables threading.
1480
da0005b8 1481format.signOff::
240ae2b8
FC
1482 A boolean value which lets you enable the `-s/--signoff` option of
1483 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1484 patch should be a conscious act and means that you certify you have
1485 the rights to submit this work under the same open source license.
1486 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1487
2a4c2607
FC
1488format.coverLetter::
1489 A boolean that controls whether to generate a cover-letter when
1490 format-patch is invoked, but in addition can be set to "auto", to
1491 generate a cover-letter only when there's more than one patch.
1492
bc6bf2d7
AK
1493format.outputDirectory::
1494 Set a custom directory to store the resulting files instead of the
1495 current working directory.
1496
bb52995f
XY
1497format.useAutoBase::
1498 A boolean value which lets you enable the `--base=auto` option of
1499 format-patch by default.
1500
26488f59
RR
1501filter.<driver>.clean::
1502 The command which is used to convert the content of a worktree
1503 file to a blob upon checkin. See linkgit:gitattributes[5] for
1504 details.
1505
1506filter.<driver>.smudge::
1507 The command which is used to convert the content of a blob
1508 object to a worktree file upon checkout. See
1509 linkgit:gitattributes[5] for details.
1510
2becf00f
JS
1511fsck.<msg-id>::
1512 Allows overriding the message type (error, warn or ignore) of a
1513 specific message ID such as `missingEmail`.
1514+
1515For convenience, fsck prefixes the error/warning with the message ID,
1516e.g. "missingEmail: invalid author/committer line - missing email" means
1517that setting `fsck.missingEmail = ignore` will hide that issue.
1518+
1519This feature is intended to support working with legacy repositories
1520which cannot be repaired without disruptive changes.
1521
1335f732
JS
1522fsck.skipList::
1523 The path to a sorted list of object names (i.e. one SHA-1 per
1524 line) that are known to be broken in a non-fatal way and should
1525 be ignored. This feature is useful when an established project
1526 should be accepted despite early commits containing errors that
1527 can be safely ignored such as invalid committer email addresses.
1528 Note: corrupt objects cannot be skipped with this setting.
1529
125f8146
NTND
1530gc.aggressiveDepth::
1531 The depth parameter used in the delta compression
1532 algorithm used by 'git gc --aggressive'. This defaults
07e7dbf0 1533 to 50.
125f8146 1534
0d7566a5
TT
1535gc.aggressiveWindow::
1536 The window size parameter used in the delta compression
0b444cdb 1537 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1538 to 250.
0d7566a5 1539
e9831e83
JH
1540gc.auto::
1541 When there are approximately more than this many loose
1542 objects in the repository, `git gc --auto` will pack them.
1543 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1544 light-weight garbage collection from time to time. The
1545 default value is 6700. Setting this to 0 disables it.
e9831e83 1546
da0005b8 1547gc.autoPackLimit::
17815501
JH
1548 When there are more than this many packs that are not
1549 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1550 --auto` consolidates them into one larger pack. The
97063974 1551 default value is 50. Setting this to 0 disables it.
17815501 1552
da0005b8 1553gc.autoDetach::
f745acb0 1554 Make `git gc --auto` return immediately and run in background
9f673f94
NTND
1555 if the system supports it. Default is true.
1556
a831c06a
DT
1557gc.logExpiry::
1558 If the file gc.log exists, then `git gc --auto` won't run
1559 unless that file is more than 'gc.logExpiry' old. Default is
1560 "1.day". See `gc.pruneExpire` for more ways to specify its
1561 value.
1562
da0005b8 1563gc.packRefs::
efc266e8
JN
1564 Running `git pack-refs` in a repository renders it
1565 unclonable by Git versions prior to 1.5.1.2 over dumb
1566 transports such as HTTP. This variable determines whether
4be0c352 1567 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1568 to enable it within all non-bare repos or it can be set to a
1569 boolean value. The default is `true`.
c2120e5e 1570
da0005b8 1571gc.pruneExpire::
0b444cdb 1572 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33 1573 Override the grace period with this config variable. The value
8cc88166
ES
1574 "now" may be used to disable this grace period and always prune
1575 unreachable objects immediately, or "never" may be used to
f1350d0c
MM
1576 suppress pruning. This feature helps prevent corruption when
1577 'git gc' runs concurrently with another process writing to the
1578 repository; see the "NOTES" section of linkgit:git-gc[1].
25ee9731 1579
114ff888 1580gc.worktreePruneExpire::
b07244f4 1581 When 'git gc' is run, it calls
fe819b4b 1582 'git worktree prune --expire 3.months.ago'.
b07244f4
MH
1583 This config variable can be used to set a different grace
1584 period. The value "now" may be used to disable the grace
f212dcc7 1585 period and prune `$GIT_DIR/worktrees` immediately, or "never"
8cc88166 1586 may be used to suppress pruning.
e3df33bb 1587
da0005b8
NTND
1588gc.reflogExpire::
1589gc.<pattern>.reflogExpire::
0b444cdb 1590 'git reflog expire' removes reflog entries older than
8cc88166
ES
1591 this time; defaults to 90 days. The value "now" expires all
1592 entries immediately, and "never" suppresses expiration
1593 altogether. With "<pattern>" (e.g.
eb523a8d
JH
1594 "refs/stash") in the middle the setting applies only to
1595 the refs that match the <pattern>.
4aec56d1 1596
da0005b8 1597gc.reflogExpireUnreachable::
f04c6904 1598gc.<pattern>.reflogExpireUnreachable::
0b444cdb 1599 'git reflog expire' removes reflog entries older than
4aec56d1 1600 this time and are not reachable from the current tip;
8cc88166
ES
1601 defaults to 30 days. The value "now" expires all entries
1602 immediately, and "never" suppresses expiration altogether.
1603 With "<pattern>" (e.g. "refs/stash")
eb523a8d
JH
1604 in the middle, the setting applies only to the refs that
1605 match the <pattern>.
4aec56d1 1606
da0005b8 1607gc.rerereResolved::
48c32424 1608 Records of conflicted merge you resolved earlier are
0b444cdb 1609 kept for this many days when 'git rerere gc' is run.
6e96cb52 1610 You can also use more human-readable "1.month.ago", etc.
5162e697 1611 The default is 60 days. See linkgit:git-rerere[1].
48c32424 1612
da0005b8 1613gc.rerereUnresolved::
48c32424 1614 Records of conflicted merge you have not resolved are
0b444cdb 1615 kept for this many days when 'git rerere gc' is run.
6e96cb52 1616 You can also use more human-readable "1.month.ago", etc.
5162e697 1617 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1618
da0005b8 1619gitcvs.commitMsgAnnotation::
280514e1
FE
1620 Append this string to each commit message. Set to empty string
1621 to disable this feature. Defaults to "via git-CVS emulator".
1622
1ab661dd 1623gitcvs.enabled::
db218723 1624 Whether the CVS server interface is enabled for this repository.
5162e697 1625 See linkgit:git-cvsserver[1].
1ab661dd 1626
da0005b8 1627gitcvs.logFile::
db218723 1628 Path to a log file where the CVS server interface well... logs
5162e697 1629 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1630
1707adb7 1631gitcvs.usecrlfattr::
5ec3e670 1632 If true, the server will look up the end-of-line conversion
23f8239b 1633 attributes for files to determine the `-k` modes to use. If
2de9b711 1634 the attributes force Git to treat a file as text,
23f8239b 1635 the `-k` mode will be left blank so CVS clients will
5ec3e670 1636 treat it as text. If they suppress text conversion, the file
1168d402 1637 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670 1638 the client might otherwise do. If the attributes do not allow
ae9f6311 1639 the file type to be determined, then `gitcvs.allBinary` is
5ec3e670 1640 used. See linkgit:gitattributes[5].
8a06a632 1641
da0005b8 1642gitcvs.allBinary::
ae9f6311 1643 This is used if `gitcvs.usecrlfattr` does not resolve
90948a42
MO
1644 the correct '-kb' mode to use. If true, all
1645 unresolved files are sent to the client in
1646 mode '-kb'. This causes the client to treat them
1647 as binary files, which suppresses any newline munging it
1648 otherwise might do. Alternatively, if it is set to "guess",
1649 then the contents of the file are examined to decide if
ae9f6311 1650 it is binary, similar to `core.autocrlf`.
abbf5947 1651
da0005b8 1652gitcvs.dbName::
04752868 1653 Database used by git-cvsserver to cache revision information
2de9b711 1654 derived from the Git repository. The exact meaning depends on the
04752868
FL
1655 used database driver, for SQLite (which is the default driver) this
1656 is a filename. Supports variable substitution (see
5162e697 1657 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1658 Default: '%Ggitcvs.%m.sqlite'
1659
da0005b8 1660gitcvs.dbDriver::
04752868 1661 Used Perl DBI driver. You can specify any available driver
240ae2b8 1662 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1663 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1664 reported *not* to work with 'DBD::mysql'. Experimental feature.
1665 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1666 See linkgit:git-cvsserver[1].
eabb0bfd 1667
da0005b8 1668gitcvs.dbUser, gitcvs.dbPass::
ae9f6311 1669 Database user and password. Only useful if setting `gitcvs.dbDriver`,
04752868 1670 since SQLite has no concept of database users and/or passwords.
da0005b8 1671 'gitcvs.dbUser' supports variable substitution (see
5162e697 1672 linkgit:git-cvsserver[1] for details).
04752868 1673
6aeeffd1
JE
1674gitcvs.dbTableNamePrefix::
1675 Database table name prefix. Prepended to the names of any
1676 database tables used, allowing a single database to be used
1677 for several repositories. Supports variable substitution (see
1678 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1679 characters will be replaced with underscores.
1680
ae9f6311
TR
1681All gitcvs variables except for `gitcvs.usecrlfattr` and
1682`gitcvs.allBinary` can also be specified as
8a06a632 1683'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1684is one of "ext" and "pserver") to make them apply only for the given
1685access method.
04752868 1686
cd82323f
JN
1687gitweb.category::
1688gitweb.description::
1689gitweb.owner::
1690gitweb.url::
1691 See linkgit:gitweb[1] for description.
1692
1693gitweb.avatar::
1694gitweb.blame::
1695gitweb.grep::
1696gitweb.highlight::
1697gitweb.patches::
1698gitweb.pickaxe::
1699gitweb.remote_heads::
da0005b8 1700gitweb.showSizes::
cd82323f
JN
1701gitweb.snapshot::
1702 See linkgit:gitweb.conf[5] for description.
1703
b22520a3 1704grep.lineNumber::
23f8239b 1705 If set to true, enable `-n` option by default.
b22520a3 1706
84befcd0
S
1707grep.patternType::
1708 Set the default matching behavior. Using a value of 'basic', 'extended',
bcf9626a
MM
1709 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1710 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
84befcd0
S
1711 value 'default' will return to the default matching behavior.
1712
b22520a3 1713grep.extendedRegexp::
bcf9626a 1714 If set to true, enable `--extended-regexp` option by default. This
ae9f6311 1715 option is ignored when the `grep.patternType` option is set to a value
84befcd0 1716 other than 'default'.
b22520a3 1717
89f09dd3
VL
1718grep.threads::
1719 Number of grep worker threads to use.
1720 See `grep.threads` in linkgit:git-grep[1] for more information.
1721
ecd9ba61
TG
1722grep.fallbackToNoIndex::
1723 If set to true, fall back to git grep --no-index if git grep
1724 is executed outside of a git repository. Defaults to false.
1725
0c5e70f0 1726gpg.program::
f212dcc7 1727 Use this custom program instead of "`gpg`" found on `$PATH` when
0c5e70f0 1728 making or verifying a PGP signature. The program must support the
06ab60c0 1729 same command-line interface as GPG, namely, to verify a detached
f212dcc7 1730 signature, "`gpg --verify $file - <$signature`" is run, and the
0c5e70f0 1731 program is expected to signal a good signature by exiting with
f745acb0 1732 code 0, and to generate an ASCII-armored detached signature, the
f212dcc7 1733 standard input of "`gpg -bsau $key`" is fed with the contents to be
0c5e70f0
JH
1734 signed, and the program is expected to send the result to its
1735 standard output.
1736
da0005b8 1737gui.commitMsgWidth::
d84ae0db
GH
1738 Defines how wide the commit message window is in the
1739 linkgit:git-gui[1]. "75" is the default.
1740
da0005b8 1741gui.diffContext::
d84ae0db
GH
1742 Specifies how many context lines should be used in calls to diff
1743 made by the linkgit:git-gui[1]. The default is "5".
1744
da0005b8 1745gui.displayUntracked::
1cca17df 1746 Determines if linkgit:git-gui[1] shows untracked files
ec9fa62a
MK
1747 in the file list. The default is "true".
1748
a2df1fb2
AG
1749gui.encoding::
1750 Specifies the default encoding to use for displaying of
1751 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1752 It can be overridden by setting the 'encoding' attribute
1753 for relevant files (see linkgit:gitattributes[5]).
1754 If this option is not set, the tools default to the
1755 locale encoding.
1756
da0005b8 1757gui.matchTrackingBranch::
d84ae0db
GH
1758 Determines if new branches created with linkgit:git-gui[1] should
1759 default to tracking remote branches with matching names or
1760 not. Default: "false".
1761
da0005b8 1762gui.newBranchTemplate::
d84ae0db
GH
1763 Is used as suggested name when creating new branches using the
1764 linkgit:git-gui[1].
1765
da0005b8 1766gui.pruneDuringFetch::
8b3f3f84 1767 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1768 performing a fetch. The default value is "false".
1769
1770gui.trustmtime::
1771 Determines if linkgit:git-gui[1] should trust the file modification
1772 timestamp or not. By default the timestamps are not trusted.
1773
da0005b8 1774gui.spellingDictionary::
d84ae0db
GH
1775 Specifies the dictionary used for spell checking commit messages in
1776 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1777 off.
1778
da0005b8 1779gui.fastCopyBlame::
ca768288 1780 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1781 location detection. It makes blame significantly faster on huge
1782 repositories at the expense of less thorough copy detection.
1783
da0005b8 1784gui.copyBlameThreshold::
76bac890 1785 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1786 detection, measured in alphanumeric characters. See the
1787 linkgit:git-blame[1] manual for more information on copy detection.
1788
1789gui.blamehistoryctx::
1790 Specifies the radius of history context in days to show in
1791 linkgit:gitk[1] for the selected commit, when the `Show History
1792 Context` menu item is invoked from 'git gui blame'. If this
1793 variable is set to zero, the whole history is shown.
1794
390c3480
AG
1795guitool.<name>.cmd::
1796 Specifies the shell command line to execute when the corresponding item
1797 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1798 mandatory for every tool. The command is executed from the root of
1799 the working directory, and in the environment it receives the name of
eee7f4a2 1800 the tool as `GIT_GUITOOL`, the name of the currently selected file as
390c3480
AG
1801 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1802 the head is detached, 'CUR_BRANCH' is empty).
1803
da0005b8 1804guitool.<name>.needsFile::
390c3480
AG
1805 Run the tool only if a diff is selected in the GUI. It guarantees
1806 that 'FILENAME' is not empty.
1807
da0005b8 1808guitool.<name>.noConsole::
390c3480
AG
1809 Run the command silently, without creating a window to display its
1810 output.
1811
da0005b8 1812guitool.<name>.noRescan::
390c3480
AG
1813 Don't rescan the working directory for changes after the tool
1814 finishes execution.
1815
1816guitool.<name>.confirm::
1817 Show a confirmation dialog before actually running the tool.
1818
da0005b8 1819guitool.<name>.argPrompt::
390c3480 1820 Request a string argument from the user, and pass it to the tool
47d81b5c 1821 through the `ARGS` environment variable. Since requesting an
390c3480
AG
1822 argument implies confirmation, the 'confirm' option has no effect
1823 if this is enabled. If the option is set to 'true', 'yes', or '1',
1824 the dialog uses a built-in generic prompt; otherwise the exact
1825 value of the variable is used.
1826
da0005b8 1827guitool.<name>.revPrompt::
390c3480 1828 Request a single valid revision from the user, and set the
47d81b5c 1829 `REVISION` environment variable. In other aspects this option
da0005b8 1830 is similar to 'argPrompt', and can be used together with it.
390c3480 1831
da0005b8
NTND
1832guitool.<name>.revUnmerged::
1833 Show only unmerged branches in the 'revPrompt' subdialog.
390c3480
AG
1834 This is useful for tools similar to merge or rebase, but not
1835 for things like checkout or reset.
1836
1837guitool.<name>.title::
1838 Specifies the title to use for the prompt dialog. The default
1839 is the tool name.
1840
1841guitool.<name>.prompt::
1842 Specifies the general prompt string to display at the top of
da0005b8 1843 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
390c3480
AG
1844 The default value includes the actual command.
1845
983a9eeb
CC
1846help.browser::
1847 Specify the browser that will be used to display help in the
1848 'web' format. See linkgit:git-help[1].
1849
1850help.format::
1851 Override the default help format used by linkgit:git-help[1].
1852 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1853 the default. 'web' and 'html' are the same.
1854
da0005b8 1855help.autoCorrect::
f0e90716
AR
1856 Automatically correct and execute mistyped commands after
1857 waiting for the given number of deciseconds (0.1 sec). If more
1858 than one command can be deduced from the entered text, nothing
1859 will be executed. If the value of this option is negative,
1860 the corrected command will be executed immediately. If the
1861 value is 0 - the command will be just shown but not executed.
1862 This is the default.
1863
da0005b8 1864help.htmlPath::
b1f809d0
SS
1865 Specify the path where the HTML documentation resides. File system paths
1866 and URLs are supported. HTML pages will be prefixed with this path when
1867 help is displayed in the 'web' format. This defaults to the documentation
1868 path of your Git installation.
1869
9c5665aa 1870http.proxy::
b2c8c6d9 1871 Override the HTTP proxy, normally configured using the 'http_proxy',
372370f1
KF
1872 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1873 addition to the syntax understood by curl, it is possible to specify a
1874 proxy string with a user name but no password, in which case git will
1875 attempt to acquire one in the same way it does for other credentials. See
1876 linkgit:gitcredentials[7] for more information. The syntax thus is
1877 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1878 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1879
ef976395
KF
1880http.proxyAuthMethod::
1881 Set the method with which to authenticate against the HTTP proxy. This
1882 only takes effect if the configured proxy string contains a user name part
1883 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1884 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
eee7f4a2 1885 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
ef976395
KF
1886 variable. Possible values are:
1887+
1888--
1889* `anyauth` - Automatically pick a suitable authentication method. It is
1890 assumed that the proxy answers an unauthenticated request with a 407
1891 status code and one or more Proxy-authenticate headers with supported
1892 authentication methods. This is the default.
1893* `basic` - HTTP Basic authentication
1894* `digest` - HTTP Digest authentication; this prevents the password from being
1895 transmitted to the proxy in clear text
1896* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1897 of `curl(1)`)
1898* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1899--
9c5665aa 1900
121061f6 1901http.emptyAuth::
1902 Attempt authentication without seeking a username or password. This
1903 can be used to attempt GSS-Negotiate authentication without specifying
1904 a username in the URL, as libcurl normally requires a username for
1905 authentication.
1906
26a7b234
PS
1907http.delegation::
1908 Control GSSAPI credential delegation. The delegation is disabled
1909 by default in libcurl since version 7.21.7. Set parameter to tell
1910 the server what it is allowed to delegate when it comes to user
1911 credentials. Used with GSS/kerberos. Possible values are:
1912+
1913--
1914* `none` - Don't allow any delegation.
1915* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1916 Kerberos service ticket, which is a matter of realm policy.
1917* `always` - Unconditionally allow the server to delegate.
1918--
1919
1920
8cb01e2f
JS
1921http.extraHeader::
1922 Pass an additional HTTP header when communicating with a server. If
1923 more than one such entry exists, all of them are added as extra
1924 headers. To allow overriding the settings inherited from the system
1925 config, an empty value will reset the extra headers to the empty list.
1926
da0005b8 1927http.cookieFile::
e5a39ad8
BN
1928 The pathname of a file containing previously stored cookie lines,
1929 which should be used
2de9b711 1930 in the Git http session, if they match the server. The file format
bcfb95dd 1931 of the file to read cookies from should be plain HTTP headers or
1cca17df 1932 the Netscape/Mozilla cookie file format (see `curl(1)`).
06ea368b 1933 NOTE that the file specified with http.cookieFile is used only as
912b2acf
DB
1934 input unless http.saveCookies is set.
1935
da0005b8 1936http.saveCookies::
912b2acf 1937 If set, store cookies received during requests to the file specified by
da0005b8 1938 http.cookieFile. Has no effect if http.cookieFile is unset.
bcfb95dd 1939
01861cb7
EP
1940http.sslVersion::
1941 The SSL version to use when negotiating an SSL connection, if you
1942 want to force the default. The available and default version
1943 depend on whether libcurl was built against NSS or OpenSSL and the
1944 particular configuration of the crypto library in use. Internally
1945 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1946 documentation for more details on the format of this option and
1947 for the ssl version supported. Actually the possible values of
1948 this option are:
1949
1950 - sslv2
1951 - sslv3
1952 - tlsv1
1953 - tlsv1.0
1954 - tlsv1.1
1955 - tlsv1.2
1956
1957+
eee7f4a2 1958Can be overridden by the `GIT_SSL_VERSION` environment variable.
01861cb7 1959To force git to use libcurl's default ssl version and ignore any
eee7f4a2 1960explicit http.sslversion option, set `GIT_SSL_VERSION` to the
01861cb7
EP
1961empty string.
1962
f6f2a9e4
LKS
1963http.sslCipherList::
1964 A list of SSL ciphers to use when negotiating an SSL connection.
1965 The available ciphers depend on whether libcurl was built against
1966 NSS or OpenSSL and the particular configuration of the crypto
1967 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1968 option; see the libcurl documentation for more details on the format
1969 of this list.
1970+
eee7f4a2 1971Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
f6f2a9e4 1972To force git to use libcurl's default cipher list and ignore any
eee7f4a2 1973explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
f6f2a9e4
LKS
1974empty string.
1975
1ab661dd
PB
1976http.sslVerify::
1977 Whether to verify the SSL certificate when fetching or pushing
dec366c9
SR
1978 over HTTPS. Defaults to true. Can be overridden by the
1979 `GIT_SSL_NO_VERIFY` environment variable.
1ab661dd
PB
1980
1981http.sslCert::
1982 File containing the SSL certificate when fetching or pushing
eee7f4a2 1983 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1ab661dd
PB
1984 variable.
1985
1986http.sslKey::
1987 File containing the SSL private key when fetching or pushing
eee7f4a2 1988 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1ab661dd
PB
1989 variable.
1990
754ae192 1991http.sslCertPasswordProtected::
2de9b711 1992 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
1993 OpenSSL will prompt the user, possibly many times, if the
1994 certificate or private key is encrypted. Can be overridden by the
eee7f4a2 1995 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
754ae192 1996
1ab661dd
PB
1997http.sslCAInfo::
1998 File containing the certificates to verify the peer with when
abda1ef5 1999 fetching or pushing over HTTPS. Can be overridden by the
eee7f4a2 2000 `GIT_SSL_CAINFO` environment variable.
1ab661dd
PB
2001
2002http.sslCAPath::
2003 Path containing files with the CA certificates to verify the peer
37425065 2004 with when fetching or pushing over HTTPS. Can be overridden
eee7f4a2 2005 by the `GIT_SSL_CAPATH` environment variable.
1ab661dd 2006
aeff8a61
CE
2007http.pinnedpubkey::
2008 Public key of the https service. It may either be the filename of
2009 a PEM or DER encoded public key file or a string starting with
2010 'sha256//' followed by the base64 encoded sha256 hash of the
2011 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2012 exit with an error if this option is set but not supported by
2013 cURL.
2014
4bc444eb
MV
2015http.sslTry::
2016 Attempt to use AUTH SSL/TLS and encrypted data transfers
2017 when connecting via regular FTP protocol. This might be needed
2018 if the FTP server requires it for security reasons or you wish
2019 to connect securely whenever remote FTP server supports it.
2020 Default is false since it might trigger certificate verification
2021 errors on misconfigured servers.
2022
1ab661dd 2023http.maxRequests::
abda1ef5 2024 How many HTTP requests to launch in parallel. Can be overridden
eee7f4a2 2025 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1ab661dd 2026
ad75ebe5
TRC
2027http.minSessions::
2028 The number of curl sessions (counted across slots) to be kept across
2029 requests. They will not be ended with curl_easy_cleanup() until
2030 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2031 value will be capped at 1. Defaults to 1.
2032
de1a2fdd
SP
2033http.postBuffer::
2034 Maximum size in bytes of the buffer used by smart HTTP
2035 transports when POSTing data to the remote system.
2036 For requests larger than this buffer size, HTTP/1.1 and
2037 Transfer-Encoding: chunked is used to avoid creating a
2038 massive pack file locally. Default is 1 MiB, which is
2039 sufficient for most requests.
2040
1ab661dd
PB
2041http.lowSpeedLimit, http.lowSpeedTime::
2042 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2043 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
eee7f4a2
TR
2044 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2045 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1ab661dd 2046
3ea099d4
SK
2047http.noEPSV::
2048 A boolean which disables using of EPSV ftp command by curl.
befc9c42 2049 This can helpful with some "poor" ftp servers which don't
eee7f4a2 2050 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
3ea099d4
SK
2051 environment variable. Default is false (curl will use EPSV).
2052
da0005b8 2053http.userAgent::
b1d1058c 2054 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 2055 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
2056 This option allows you to override this value to a more common value
2057 such as Mozilla/4.0. This may be necessary, for instance, if
2058 connecting through a firewall that restricts HTTP connections to a set
2059 of common USER_AGENT strings (but not including those like git/1.7.1).
eee7f4a2 2060 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
b1d1058c 2061
50d34137
JK
2062http.followRedirects::
2063 Whether git should follow HTTP redirects. If set to `true`, git
2064 will transparently follow any redirect issued by a server it
2065 encounters. If set to `false`, git will treat all redirects as
2066 errors. If set to `initial`, git will follow redirects only for
2067 the initial request to a remote, but not for subsequent
2068 follow-up HTTP requests. Since git uses the redirected URL as
2069 the base for the follow-up requests, this is generally
2070 sufficient. The default is `initial`.
2071
6a56993b 2072http.<url>.*::
f745acb0 2073 Any of the http.* options above can be applied selectively to some URLs.
6a56993b
KM
2074 For a config key to match a URL, each element of the config key is
2075 compared to that of the URL, in the following order:
2076+
2077--
2078. Scheme (e.g., `https` in `https://example.com/`). This field
2079 must match exactly between the config key and the URL.
2080
2081. Host/domain name (e.g., `example.com` in `https://example.com/`).
a272b9e7
PS
2082 This field must match between the config key and the URL. It is
2083 possible to specify a `*` as part of the host name to match all subdomains
2084 at this level. `https://*.example.com/` for example would match
2085 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
6a56993b
KM
2086
2087. Port number (e.g., `8080` in `http://example.com:8080/`).
2088 This field must match exactly between the config key and the URL.
2089 Omitted port numbers are automatically converted to the correct
2090 default for the scheme before matching.
2091
2092. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2093 path field of the config key must match the path field of the URL
2094 either exactly or as a prefix of slash-delimited path elements. This means
2095 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2096 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2097 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2098 key with just path `foo/`).
2099
2100. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2101 the config key has a user name it must match the user name in the
2102 URL exactly. If the config key does not have a user name, that
2103 config key will match a URL with any user name (including none),
2104 but at a lower precedence than a config key with a user name.
2105--
2106+
2107The list above is ordered by decreasing precedence; a URL that matches
2108a config key's path is preferred to one that matches its user name. For example,
2109if the URL is `https://user@example.com/foo/bar` a config key match of
2110`https://example.com/foo` will be preferred over a config key match of
2111`https://user@example.com`.
2112+
2113All URLs are normalized before attempting any matching (the password part,
2114if embedded in the URL, is always ignored for matching purposes) so that
f745acb0
TA
2115equivalent URLs that are simply spelled differently will match properly.
2116Environment variable settings always override any matches. The URLs that are
6a56993b
KM
2117matched against are those given directly to Git commands. This means any URLs
2118visited as a result of a redirection do not participate in matching.
2119
dd33e077 2120ssh.variant::
0da0e49b
JN
2121 By default, Git determines the command line arguments to use
2122 based on the basename of the configured SSH command (configured
2123 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2124 the config setting `core.sshCommand`). If the basename is
2125 unrecognized, Git will attempt to detect support of OpenSSH
2126 options by first invoking the configured SSH command with the
2127 `-G` (print configuration) option and will subsequently use
2128 OpenSSH options (if that is successful) or no options besides
2129 the host and remote command (if it fails).
2130+
2131The config variable `ssh.variant` can be set to override this detection.
2132Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2133`tortoiseplink`, `simple` (no options except the host and remote command).
2134The default auto-detection can be explicitly requested using the value
2135`auto`. Any other value is treated as `ssh`. This setting can also be
2136overridden via the environment variable `GIT_SSH_VARIANT`.
94b8ae5a
BW
2137+
2138The current command-line parameters used for each variant are as
2139follows:
2140+
2141--
2142
2143* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2144
2145* `simple` - [username@]host command
2146
2147* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2148
2149* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2150
2151--
2152+
2153Except for the `simple` variant, command-line parameters are likely to
2154change as git gains new features.
dd33e077 2155
1ab661dd 2156i18n.commitEncoding::
2de9b711 2157 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
2158 does not care per se, but this information is necessary e.g. when
2159 importing commits from emails or in the gitk graphical history
2160 browser (and possibly at other places in the future or in other
5162e697 2161 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 2162
d2c11a38
JH
2163i18n.logOutputEncoding::
2164 Character encoding the commit messages are converted to when
0b444cdb 2165 running 'git log' and friends.
d2c11a38 2166
b0f34c3d
MM
2167imap::
2168 The configuration variables in the 'imap' section are described
2169 in linkgit:git-imap-send[1].
2170
3c09d684
TG
2171index.version::
2172 Specify the version with which new index files should be
2173 initialized. This does not affect existing repositories.
2174
da0005b8 2175init.templateDir::
d8a8488d
SD
2176 Specify the directory from which templates will be copied.
2177 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2178
983a9eeb
CC
2179instaweb.browser::
2180 Specify the program that will be used to browse your working
2181 repository in gitweb. See linkgit:git-instaweb[1].
2182
2183instaweb.httpd::
2184 The HTTP daemon command-line to start gitweb on your working
2185 repository. See linkgit:git-instaweb[1].
2186
2187instaweb.local::
2188 If true the web server started by linkgit:git-instaweb[1] will
2189 be bound to the local IP (127.0.0.1).
2190
da0005b8 2191instaweb.modulePath::
6b677a28
VS
2192 The default module path for linkgit:git-instaweb[1] to use
2193 instead of /usr/lib/apache2/modules. Only used if httpd
2194 is Apache.
983a9eeb
CC
2195
2196instaweb.port::
2197 The port number to bind the gitweb httpd to. See
2198 linkgit:git-instaweb[1].
2199
da0005b8 2200interactive.singleKey::
57f6ec02 2201 In interactive commands, allow the user to provide one-letter
ca6ac7f1 2202 input with a single key (i.e., without hitting enter).
6cf378f0 2203 Currently this is used by the `--patch` mode of
e6b57a8a
CI
2204 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2205 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2206 setting is silently ignored if portable keystroke input
8358f1ac 2207 is not available; requires the Perl module Term::ReadKey.
ca6ac7f1 2208
01143847
JK
2209interactive.diffFilter::
2210 When an interactive command (such as `git add --patch`) shows
2211 a colorized diff, git will pipe the diff through the shell
2212 command defined by this configuration variable. The command may
2213 mark up the diff further for human consumption, provided that it
2214 retains a one-to-one correspondence with the lines in the
2215 original diff. Defaults to disabled (no filtering).
2216
0c47695a
JS
2217log.abbrevCommit::
2218 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
2219 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2220 override this option with `--no-abbrev-commit`.
0c47695a 2221
dd0ffd5b 2222log.date::
e860795d
JN
2223 Set the default date-time mode for the 'log' command.
2224 Setting a value for log.date is similar to using 'git log''s
78a84416 2225 `--date` option. See linkgit:git-log[1] for details.
dd0ffd5b 2226
eb734454
SD
2227log.decorate::
2228 Print out the ref names of any commits that are shown by the log
2229 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2230 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2231 specified, the full ref name (including prefix) will be printed.
462cbb41
RJ
2232 If 'auto' is specified, then if the output is going to a terminal,
2233 the ref names are shown as if 'short' were given, otherwise no ref
ce18123c 2234 names are shown. This is the same as the `--decorate` option
462cbb41 2235 of the `git log`.
eb734454 2236
fd8d07ef
EVW
2237log.follow::
2238 If `true`, `git log` will act as if the `--follow` option was used when
2239 a single <path> is given. This has the same limitations as `--follow`,
2240 i.e. it cannot be used to follow multiple files and does not work well
2241 on non-linear history.
2242
73c727d6
NTND
2243log.graphColors::
2244 A list of colors, separated by commas, that can be used to draw
2245 history lines in `git log --graph`.
2246
da0005b8 2247log.showRoot::
0f03ca94
PB
2248 If true, the initial commit will be shown as a big creation event.
2249 This is equivalent to a diff against an empty tree.
5162e697 2250 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
2251 normally hide the root commit will now show it. True by default.
2252
ba4dce78
KM
2253log.showSignature::
2254 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2255 linkgit:git-whatchanged[1] assume `--show-signature`.
2256
e6bb5f78
AP
2257log.mailmap::
2258 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2259 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2260
d5c4b185
MM
2261mailinfo.scissors::
2262 If true, makes linkgit:git-mailinfo[1] (and therefore
2263 linkgit:git-am[1]) act by default as if the --scissors option
2264 was provided on the command-line. When active, this features
2265 removes everything from the message body before a scissors
2266 line (i.e. consisting mainly of ">8", "8<" and "-").
2267
d551a488
MSO
2268mailmap.file::
2269 The location of an augmenting mailmap file. The default
2270 mailmap, located in the root of the repository, is loaded
2271 first, then the mailmap file pointed to by this variable.
2272 The location of the mailmap file may be in a repository
2273 subdirectory, or somewhere outside of the repository itself.
2274 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2275
08610900
JK
2276mailmap.blob::
2277 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
2278 blob in the repository. If both `mailmap.file` and
2279 `mailmap.blob` are given, both are parsed, with entries from
2280 `mailmap.file` taking precedence. In a bare repository, this
2281 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2282 defaults to empty.
08610900 2283
b5578f33 2284man.viewer::
b8322ea8 2285 Specify the programs that may be used to display help in the
b5578f33
CC
2286 'man' format. See linkgit:git-help[1].
2287
0bb64009
CC
2288man.<tool>.cmd::
2289 Specify the command to invoke the specified man viewer. The
2290 specified command is evaluated in shell with the man page
2291 passed as argument. (See linkgit:git-help[1].)
2292
7e8114c0
CC
2293man.<tool>.path::
2294 Override the path for the given tool that may be used to
2295 display help in the 'man' format. See linkgit:git-help[1].
2296
b0f34c3d 2297include::merge-config.txt[]
b5412484 2298
77680caa
JS
2299mergetool.<tool>.path::
2300 Override the path for the given tool. This is useful in case
2301 your tool is not in the PATH.
2302
964473a0
CB
2303mergetool.<tool>.cmd::
2304 Specify the command to invoke the specified merge tool. The
2305 specified command is evaluated in shell with the following
2306 variables available: 'BASE' is the name of a temporary file
2307 containing the common base of the files to be merged, if available;
2308 'LOCAL' is the name of a temporary file containing the contents of
2309 the file on the current branch; 'REMOTE' is the name of a temporary
2310 file containing the contents of the file from the branch being
2311 merged; 'MERGED' contains the name of the file to which the merge
2312 tool should write the results of a successful merge.
2313
2314mergetool.<tool>.trustExitCode::
2315 For a custom merge command, specify whether the exit code of
2316 the merge command can be used to determine whether the merge was
2317 successful. If this is not set to true then the merge target file
2318 timestamp is checked and the merge assumed to have been successful
2319 if the file has been updated, otherwise the user is prompted to
2320 indicate the success of the merge.
2321
b12d0450
DA
2322mergetool.meld.hasOutput::
2323 Older versions of `meld` do not support the `--output` option.
2324 Git will attempt to detect whether `meld` supports `--output`
2325 by inspecting the output of `meld --help`. Configuring
2326 `mergetool.meld.hasOutput` will make Git skip these checks and
2327 use the configured value instead. Setting `mergetool.meld.hasOutput`
2328 to `true` tells Git to unconditionally use the `--output` option,
2329 and `false` avoids using `--output`.
2330
44c36d1c
CB
2331mergetool.keepBackup::
2332 After performing a merge, the original file with conflict markers
2333 can be saved as a file with a `.orig` extension. If this variable
2334 is set to `false` then this file is not preserved. Defaults to
2335 `true` (i.e. keep the backup files).
2336
162eba8b 2337mergetool.keepTemporaries::
2de9b711 2338 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
2339 files to pass to the tool. If the tool returns an error and this
2340 variable is set to `true`, then these temporary files will be
2341 preserved, otherwise they will be removed after the tool has
2342 exited. Defaults to `false`.
2343
8f0cb41d
DA
2344mergetool.writeToTemp::
2345 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2346 conflicting files in the worktree by default. Git will attempt
2347 to use a temporary directory for these files when set `true`.
2348 Defaults to `false`.
2349
682b451f
CB
2350mergetool.prompt::
2351 Prompt before each invocation of the merge resolution program.
2352
d2d68d99
JK
2353notes.mergeStrategy::
2354 Which merge strategy to choose by default when resolving notes
2355 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2356 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2357 section of linkgit:git-notes[1] for more information on each strategy.
2358
4f655e22
JK
2359notes.<name>.mergeStrategy::
2360 Which merge strategy to choose when doing a notes merge into
2361 refs/notes/<name>. This overrides the more general
2362 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2363 linkgit:git-notes[1] for more information on the available strategies.
2364
894a9d33
TR
2365notes.displayRef::
2366 The (fully qualified) refname from which to show notes when
2367 showing commit messages. The value of this variable can be set
2368 to a glob, in which case notes from all matching refs will be
2369 shown. You may also specify this configuration variable
2370 several times. A warning will be issued for refs that do not
2371 exist, but a glob that does not match any refs is silently
2372 ignored.
2373+
2374This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2375environment variable, which must be a colon separated list of refs or
2376globs.
2377+
2378The effective value of "core.notesRef" (possibly overridden by
2379GIT_NOTES_REF) is also implicitly added to the list of refs to be
2380displayed.
2381
6956f858
TR
2382notes.rewrite.<command>::
2383 When rewriting commits with <command> (currently `amend` or
2de9b711 2384 `rebase`) and this variable is set to `true`, Git
6956f858
TR
2385 automatically copies your notes from the original to the
2386 rewritten commit. Defaults to `true`, but see
2387 "notes.rewriteRef" below.
6956f858
TR
2388
2389notes.rewriteMode::
2390 When copying notes during a rewrite (see the
2391 "notes.rewrite.<command>" option), determines what to do if
2392 the target commit already has a note. Must be one of
e48ad1b9
JK
2393 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2394 Defaults to `concatenate`.
6956f858
TR
2395+
2396This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2397environment variable.
2398
2399notes.rewriteRef::
2400 When copying notes during a rewrite, specifies the (fully
2401 qualified) ref whose notes should be copied. The ref may be a
2402 glob, in which case notes in all matching refs will be copied.
2403 You may also specify this configuration several times.
2404+
2405Does not have a default value; you must configure this variable to
2b4aa89c
TR
2406enable note rewriting. Set it to `refs/notes/commits` to enable
2407rewriting for the default commit notes.
cfb88e9a
LAS
2408+
2409This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2410environment variable, which must be a colon separated list of refs or
2411globs.
6956f858 2412
4812a93a 2413pack.window::
5162e697 2414 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
2415 window size is given on the command line. Defaults to 10.
2416
842aaf93 2417pack.depth::
5162e697 2418 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 2419 maximum depth is given on the command line. Defaults to 50.
842aaf93 2420
e93b15cd 2421pack.windowMemory::
f4694a8c
RB
2422 The maximum size of memory that is consumed by each thread
2423 in linkgit:git-pack-objects[1] for pack window memory when
2424 no limit is given on the command line. The value can be
2425 suffixed with "k", "m", or "g". When left unconfigured (or
2426 set explicitly to 0), there will be no limit.
e93b15cd 2427
960ccca6
DH
2428pack.compression::
2429 An integer -1..9, indicating the compression level for objects
2430 in a pack file. -1 is the zlib default. 0 means no
2431 compression, and 1..9 are various speed/size tradeoffs, 9 being
2432 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
2433 not set, defaults to -1, the zlib default, which is "a default
2434 compromise between speed and compression (currently equivalent
2435 to level 6)."
89d71f75
JK
2436+
2437Note that changing the compression level will not automatically recompress
2438all existing objects. You can force recompression by passing the -F option
2439to linkgit:git-repack[1].
960ccca6 2440
074b2eea 2441pack.deltaCacheSize::
02783075 2442 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
2443 linkgit:git-pack-objects[1] before writing them out to a pack.
2444 This cache is used to speed up the writing object phase by not
2445 having to recompute the final delta result once the best match
2446 for all objects is found. Repacking large repositories on machines
2447 which are tight with memory might be badly impacted by this though,
2448 especially if this cache pushes the system into swapping.
2449 A value of 0 means no limit. The smallest size of 1 byte may be
2450 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 2451
e3dfddb3 2452pack.deltaCacheLimit::
693b86ff 2453 The maximum size of a delta, that is cached in
5749b0b2
NP
2454 linkgit:git-pack-objects[1]. This cache is used to speed up the
2455 writing object phase by not having to recompute the final delta
2456 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 2457
693b86ff
NP
2458pack.threads::
2459 Specifies the number of threads to spawn when searching for best
5162e697 2460 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
2461 be compiled with pthreads otherwise this option is ignored with a
2462 warning. This is meant to reduce packing time on multiprocessor
2463 machines. The required amount of memory for the delta search window
2464 is however multiplied by the number of threads.
2de9b711 2465 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 2466 and set the number of threads accordingly.
693b86ff 2467
4d00bda2
NP
2468pack.indexVersion::
2469 Specify the default pack index version. Valid values are 1 for
2470 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2471 the new pack index with capabilities for packs larger than 4 GB
2472 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
2473 packs. Version 2 is the default. Note that version 2 is enforced
2474 and this config option ignored whenever the corresponding pack is
2475 larger than 2 GB.
2476+
2de9b711 2477If you have an old Git that does not understand the version 2 `*.idx` file,
0d0bac67 2478cloning or fetching over a non native protocol (e.g. "http")
6cf378f0 2479that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 2480other side may give you a repository that cannot be accessed with your
2de9b711 2481older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 2482you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 2483the `*.idx` file.
4d00bda2 2484
dbdbfec4 2485pack.packSizeLimit::
07cf0f24
NP
2486 The maximum size of a pack. This setting only affects
2487 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 2488 is unaffected. It can be overridden by the `--max-pack-size`
9cea46cd
EW
2489 option of linkgit:git-repack[1]. Reaching this limit results
2490 in the creation of multiple packfiles; which in turn prevents
2491 bitmaps from being created.
2492 The minimum size allowed is limited to 1 MiB.
2493 The default is unlimited.
07cf0f24
NP
2494 Common unit suffixes of 'k', 'm', or 'g' are
2495 supported.
2b84b5a8 2496
6b8fda2d
VM
2497pack.useBitmaps::
2498 When true, git will use pack bitmaps (if available) when packing
2499 to stdout (e.g., during the server side of a fetch). Defaults to
2500 true. You should not generally need to turn this off unless
2501 you are debugging pack bitmaps.
2502
da0005b8 2503pack.writeBitmaps (deprecated)::
71d76cb4 2504 This is a deprecated synonym for `repack.writeBitmaps`.
7cc8f971 2505
ae4f07fb
VM
2506pack.writeBitmapHashCache::
2507 When true, git will include a "hash cache" section in the bitmap
2508 index (if one is written). This cache can be used to feed git's
2509 delta heuristics, potentially leading to better deltas between
2510 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2511 between an older, bitmapped pack and objects that have been
2512 pushed since the last gc). The downside is that it consumes 4
2513 bytes per object of disk space, and that JGit's bitmap
2514 implementation does not understand it, causing it to complain if
2515 Git and JGit are used on the same repository. Defaults to false.
2516
4370c2d6 2517pager.<cmd>::
9bad7233 2518 If the value is boolean, turns on or off pagination of the
2de9b711 2519 output of a particular Git subcommand when writing to a tty.
9bad7233 2520 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
2521 pager specified by the value of `pager.<cmd>`. If `--paginate`
2522 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
2523 precedence over this option. To disable pagination for all
2524 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 2525
8028184e
WP
2526pretty.<name>::
2527 Alias for a --pretty= format string, as specified in
2528 linkgit:git-log[1]. Any aliases defined here can be used just
2529 as the built-in pretty formats could. For example,
6cf378f0 2530 running `git config pretty.changelog "format:* %H %s"`
8028184e 2531 would cause the invocation `git log --pretty=changelog`
6cf378f0 2532 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
2533 Note that an alias with the same name as a built-in format
2534 will be silently ignored.
2535
f1762d77
BW
2536protocol.allow::
2537 If set, provide a user defined default policy for all protocols which
2538 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2539 if unset, known-safe protocols (http, https, git, ssh, file) have a
2540 default policy of `always`, known-dangerous protocols (ext) have a
2541 default policy of `never`, and all other protocols have a default
2542 policy of `user`. Supported policies:
2543+
2544--
2545
2546* `always` - protocol is always able to be used.
2547
2548* `never` - protocol is never able to be used.
2549
2550* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2551 either unset or has a value of 1. This policy should be used when you want a
2552 protocol to be directly usable by the user but don't want it used by commands which
2553 execute clone/fetch/push commands without user input, e.g. recursive
2554 submodule initialization.
2555
2556--
2557
2558protocol.<name>.allow::
2559 Set a policy to be used by protocol `<name>` with clone/fetch/push
2560 commands. See `protocol.allow` above for the available policies.
2561+
2562The protocol names currently used by git are:
2563+
2564--
2565 - `file`: any local file-based path (including `file://` URLs,
2566 or local paths)
2567
2568 - `git`: the anonymous git protocol over a direct TCP
2569 connection (or proxy, if configured)
2570
2571 - `ssh`: git over ssh (including `host:path` syntax,
2572 `ssh://`, etc).
2573
2574 - `http`: git over http, both "smart http" and "dumb http".
2575 Note that this does _not_ include `https`; if you want to configure
2576 both, you must do so individually.
2577
2578 - any external helpers are named by their protocol (e.g., use
2579 `hg` to allow the `git-remote-hg` helper)
2580--
2581
373d70ef
BW
2582protocol.version::
2583 Experimental. If set, clients will attempt to communicate with a
2584 server using the specified protocol version. If unset, no
2585 attempt will be made by the client to communicate using a
2586 particular protocol version, this results in protocol version 0
2587 being used.
2588 Supported versions:
2589+
2590--
2591
2592* `0` - the original wire protocol.
2593
2594* `1` - the original wire protocol with the addition of a version string
2595 in the initial response from the server.
2596
2597--
2598
b814da89
DA
2599pull.ff::
2600 By default, Git does not create an extra merge commit when merging
2601 a commit that is a descendant of the current commit. Instead, the
2602 tip of the current branch is fast-forwarded. When set to `false`,
2603 this variable tells Git to create an extra merge commit in such
2604 a case (equivalent to giving the `--no-ff` option from the command
2605 line). When set to `only`, only such fast-forward merges are
2606 allowed (equivalent to giving the `--ff-only` option from the
eb8dc05c 2607 command line). This setting overrides `merge.ff` when pulling.
b814da89 2608
6b37dff1
ÆAB
2609pull.rebase::
2610 When true, rebase branches on top of the fetched branch, instead
2611 of merging the default branch from the default remote when "git
2612 pull" is run. See "branch.<name>.rebase" for setting this on a
2613 per-branch basis.
66713ef3 2614+
d2387107
AS
2615When preserve, also pass `--preserve-merges` along to 'git rebase'
2616so that locally committed merge commits will not be flattened
2617by running 'git pull'.
6b37dff1 2618+
f5eb87b9
JS
2619When the value is `interactive`, the rebase is run in interactive mode.
2620+
6b37dff1
ÆAB
2621*NOTE*: this is a possibly dangerous operation; do *not* use
2622it unless you understand the implications (see linkgit:git-rebase[1]
2623for details).
2624
1ab661dd
PB
2625pull.octopus::
2626 The default merge strategy to use when pulling multiple branches
2627 at once.
2628
2629pull.twohead::
2630 The default merge strategy to use when pulling a single branch.
2631
52153747 2632push.default::
87a70e4c
RR
2633 Defines the action `git push` should take if no refspec is
2634 explicitly given. Different values are well-suited for
2635 specific workflows; for instance, in a purely central workflow
2636 (i.e. the fetch source is equal to the push destination),
2637 `upstream` is probably what you want. Possible values are:
52153747 2638+
b1290514 2639--
87a70e4c
RR
2640
2641* `nothing` - do not push anything (error out) unless a refspec is
2642 explicitly given. This is primarily meant for people who want to
2643 avoid mistakes by always being explicit.
2644
2645* `current` - push the current branch to update a branch with the same
2646 name on the receiving end. Works in both central and non-central
2647 workflows.
2648
2649* `upstream` - push the current branch back to the branch whose
2650 changes are usually integrated into the current branch (which is
2651 called `@{upstream}`). This mode only makes sense if you are
2652 pushing to the same repository you would normally pull from
2653 (i.e. central workflow).
2654
e4e016f6
ÆAB
2655* `tracking` - This is a deprecated synonym for `upstream`.
2656
ed2b1829
RR
2657* `simple` - in centralized workflow, work like `upstream` with an
2658 added safety to refuse to push if the upstream branch's name is
2659 different from the local one.
b1290514 2660+
ed2b1829
RR
2661When pushing to a remote that is different from the remote you normally
2662pull from, work as `current`. This is the safest option and is suited
2663for beginners.
b1290514 2664+
009055f3 2665This mode has become the default in Git 2.0.
87a70e4c
RR
2666
2667* `matching` - push all branches having the same name on both ends.
2668 This makes the repository you are pushing to remember the set of
2669 branches that will be pushed out (e.g. if you always push 'maint'
2670 and 'master' there and no other branches, the repository you push
2671 to will have these two branches, and your local 'maint' and
2672 'master' will be pushed there).
2673+
2674To use this mode effectively, you have to make sure _all_ the
2675branches you would push out are ready to be pushed out before
2676running 'git push', as the whole point of this mode is to allow you
2677to push all of the branches in one go. If you usually finish work
2678on only one branch and push out the result, while other branches are
2679unfinished, this mode is not for you. Also this mode is not
2680suitable for pushing into a shared central repository, as other
2681people may add new branches there, or update the tip of existing
2682branches outside your control.
2683+
009055f3
JH
2684This used to be the default, but not since Git 2.0 (`simple` is the
2685new default).
87a70e4c
RR
2686
2687--
52153747 2688
a8bc269f 2689push.followTags::
bcf9626a 2690 If set to true enable `--follow-tags` option by default. You
a8bc269f 2691 may override this configuration at time of push by specifying
bcf9626a 2692 `--no-follow-tags`.
a8bc269f 2693
68c757f2
DB
2694push.gpgSign::
2695 May be set to a boolean value, or the string 'if-asked'. A true
bcf9626a 2696 value causes all pushes to be GPG signed, as if `--signed` is
68c757f2
DB
2697 passed to linkgit:git-push[1]. The string 'if-asked' causes
2698 pushes to be signed if the server supports it, as if
bcf9626a 2699 `--signed=if-asked` is passed to 'git push'. A false value may
68c757f2
DB
2700 override a value from a lower-priority config file. An explicit
2701 command-line flag always overrides this config option.
a8bc269f 2702
d8052750
MP
2703push.pushOption::
2704 When no `--push-option=<option>` argument is given from the
2705 command line, `git push` behaves as if each <value> of
2706 this variable is given as `--push-option=<value>`.
2707+
2708This is a multi-valued variable, and an empty value can be used in a
2709higher priority configuration file (e.g. `.git/config` in a
2710repository) to clear the values inherited from a lower priority
2711configuration files (e.g. `$HOME/.gitconfig`).
2712+
2713--
2714
2715Example:
2716
2717/etc/gitconfig
2718 push.pushoption = a
2719 push.pushoption = b
2720
2721~/.gitconfig
2722 push.pushoption = c
2723
2724repo/.git/config
2725 push.pushoption =
2726 push.pushoption = b
2727
2728This will result in only b (a and c are cleared).
2729
2730--
2731
b33a15b0
MC
2732push.recurseSubmodules::
2733 Make sure all submodule commits used by the revisions to be pushed
2734 are available on a remote-tracking branch. If the value is 'check'
2735 then Git will verify that all submodule commits that changed in the
2736 revisions to be pushed are available on at least one remote of the
2737 submodule. If any commits are missing, the push will be aborted and
2738 exit with non-zero status. If the value is 'on-demand' then all
2739 submodules that changed in the revisions to be pushed will be
2740 pushed. If on-demand was not able to push all necessary revisions
2741 it will also be aborted and exit with non-zero status. If the value
2742 is 'no' then default behavior of ignoring submodules when pushing
2743 is retained. You may override this configuration at time of push by
2744 specifying '--recurse-submodules=check|on-demand|no'.
2745
946a9f20 2746include::rebase-config.txt[]
16cf51c7 2747
da0005b8 2748receive.advertiseAtomic::
04b39f19 2749 By default, git-receive-pack will advertise the atomic push
c714e45f
SB
2750 capability to its clients. If you don't want to advertise this
2751 capability, set this variable to false.
2752
2753receive.advertisePushOptions::
b7b744f2
JT
2754 When set to true, git-receive-pack will advertise the push options
2755 capability to its clients. False by default.
04b39f19 2756
77e3efbf
JH
2757receive.autogc::
2758 By default, git-receive-pack will run "git-gc --auto" after
2759 receiving data from git-push and updating refs. You can stop
2760 it by setting this variable to false.
2761
da0005b8 2762receive.certNonceSeed::
b89363e4
JH
2763 By setting this variable to a string, `git receive-pack`
2764 will accept a `git push --signed` and verifies it by using
2765 a "nonce" protected by HMAC using this string as a secret
2766 key.
2767
da0005b8 2768receive.certNonceSlop::
5732373d
JH
2769 When a `git push --signed` sent a push certificate with a
2770 "nonce" that was issued by a receive-pack serving the same
2771 repository within this many seconds, export the "nonce"
2772 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2773 hooks (instead of what the receive-pack asked the sending
2774 side to include). This may allow writing checks in
2775 `pre-receive` and `post-receive` a bit easier. Instead of
2776 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2777 that records by how many seconds the nonce is stale to
2778 decide if they want to accept the certificate, they only
2779 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2780
b0f34c3d
MM
2781receive.fsckObjects::
2782 If it is set to true, git-receive-pack will check all received
2783 objects. It will abort in the case of a malformed object or a
2784 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
2785 Defaults to false. If not set, the value of `transfer.fsckObjects`
2786 is used instead.
b0f34c3d 2787
4b55b9b4
JS
2788receive.fsck.<msg-id>::
2789 When `receive.fsckObjects` is set to true, errors can be switched
2790 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2791 setting where the `<msg-id>` is the fsck message ID and the value
2792 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2793 the error/warning with the message ID, e.g. "missingEmail: invalid
2794 author/committer line - missing email" means that setting
2795 `receive.fsck.missingEmail = ignore` will hide that issue.
2796+
2797This feature is intended to support working with legacy repositories
2798which would not pass pushing when `receive.fsckObjects = true`, allowing
2799the host to accept repositories with certain known issues but still catch
2800other issues.
2801
cd94c6f9
JS
2802receive.fsck.skipList::
2803 The path to a sorted list of object names (i.e. one SHA-1 per
2804 line) that are known to be broken in a non-fatal way and should
2805 be ignored. This feature is useful when an established project
2806 should be accepted despite early commits containing errors that
2807 can be safely ignored such as invalid committer email addresses.
2808 Note: corrupt objects cannot be skipped with this setting.
2809
83558686
JK
2810receive.keepAlive::
2811 After receiving the pack from the client, `receive-pack` may
2812 produce no output (if `--quiet` was specified) while processing
2813 the pack, causing some networks to drop the TCP connection.
2814 With this option set, if `receive-pack` does not transmit
2815 any data in this phase for `receive.keepAlive` seconds, it will
2816 send a short keepalive packet. The default is 5 seconds; set
2817 to 0 to disable keepalives entirely.
2818
b0f34c3d
MM
2819receive.unpackLimit::
2820 If the number of objects received in a push is below this
2821 limit then the objects will be unpacked into loose object
2822 files. However if the number of received objects equals or
2823 exceeds this limit then the received pack will be stored as
2824 a pack, after adding any missing delta bases. Storing the
2825 pack from a push can make the push operation complete faster,
2826 especially on slow filesystems. If not set, the value of
2827 `transfer.unpackLimit` is used instead.
2828
c08db5a2
JK
2829receive.maxInputSize::
2830 If the size of the incoming pack stream is larger than this
2831 limit, then git-receive-pack will error out, instead of
2832 accepting the pack file. If not set or set to 0, then the size
2833 is unlimited.
2834
42fc11c1
JH
2835receive.denyDeletes::
2836 If set to true, git-receive-pack will deny a ref update that deletes
2837 the ref. Use this to prevent such a ref deletion via a push.
2838
662c83ff
TR
2839receive.denyDeleteCurrent::
2840 If set to true, git-receive-pack will deny a ref update that
2841 deletes the currently checked out branch of a non-bare repository.
2842
42fc11c1 2843receive.denyCurrentBranch::
f3838ce1 2844 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
2845 to the currently checked out branch of a non-bare repository.
2846 Such a push is potentially dangerous because it brings the HEAD
2847 out of sync with the index and working tree. If set to "warn",
2848 print a warning of such a push to stderr, but allow the push to
2849 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 2850 message. Defaults to "refuse".
1404bcbb
JS
2851+
2852Another option is "updateInstead" which will update the working
08553319 2853tree if pushing into the current branch. This option is
1404bcbb
JS
2854intended for synchronizing working directories when one side is not easily
2855accessible via interactive ssh (e.g. a live web site, hence the requirement
2856that the working directory be clean). This mode also comes in handy when
2857developing inside a VM to test and fix code on different Operating Systems.
08553319
JH
2858+
2859By default, "updateInstead" will refuse the push if the working tree or
2860the index have any difference from the HEAD, but the `push-to-checkout`
2861hook can be used to customize this. See linkgit:githooks[5].
42fc11c1 2862
b0f34c3d
MM
2863receive.denyNonFastForwards::
2864 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 2865 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
2866 even if that push is forced. This configuration variable is
2867 set when initializing a shared repository.
2868
da0005b8 2869receive.hideRefs::
cc118a65
JK
2870 This variable is the same as `transfer.hideRefs`, but applies
2871 only to `receive-pack` (and so affects pushes, but not fetches).
2872 An attempt to update or delete a hidden ref by `git push` is
2873 rejected.
daebaa78 2874
da0005b8 2875receive.updateServerInfo::
77e3efbf
JH
2876 If set to true, git-receive-pack will run git-update-server-info
2877 after receiving data from git-push and updating refs.
2878
da0005b8 2879receive.shallowUpdate::
0a1bc12b
NTND
2880 If set to true, .git/shallow can be updated when new refs
2881 require new shallow roots. Otherwise those refs are rejected.
2882
da0005b8 2883remote.pushDefault::
224c2171 2884 The remote to push to by default. Overrides
9f765ce6 2885 `branch.<name>.remote` for all branches, and is overridden by
da0005b8 2886 `branch.<name>.pushRemote` for specific branches.
224c2171 2887
0cc6d346 2888remote.<name>.url::
5162e697
DM
2889 The URL of a remote repository. See linkgit:git-fetch[1] or
2890 linkgit:git-push[1].
0cc6d346 2891
20346234
MG
2892remote.<name>.pushurl::
2893 The push URL of a remote repository. See linkgit:git-push[1].
2894
14c98218
SV
2895remote.<name>.proxy::
2896 For remotes that require curl (http, https and ftp), the URL to
2897 the proxy to use for that remote. Set to the empty string to
2898 disable proxying for that remote.
2899
ef976395
KF
2900remote.<name>.proxyAuthMethod::
2901 For remotes that require curl (http, https and ftp), the method to use for
2902 authenticating against the proxy in use (probably set in
2903 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2904
0cc6d346 2905remote.<name>.fetch::
5162e697
DM
2906 The default set of "refspec" for linkgit:git-fetch[1]. See
2907 linkgit:git-fetch[1].
0cc6d346
SB
2908
2909remote.<name>.push::
5162e697
DM
2910 The default set of "refspec" for linkgit:git-push[1]. See
2911 linkgit:git-push[1].
0cc6d346 2912
84bb2dfd
PB
2913remote.<name>.mirror::
2914 If true, pushing to this remote will automatically behave
6cf378f0 2915 as if the `--mirror` option was given on the command line.
84bb2dfd 2916
1918278e
TT
2917remote.<name>.skipDefaultUpdate::
2918 If true, this remote will be skipped by default when updating
7cc91a2f
BG
2919 using linkgit:git-fetch[1] or the `update` subcommand of
2920 linkgit:git-remote[1].
2921
2922remote.<name>.skipFetchAll::
2923 If true, this remote will be skipped by default when updating
2924 using linkgit:git-fetch[1] or the `update` subcommand of
2925 linkgit:git-remote[1].
1918278e 2926
060aafc1 2927remote.<name>.receivepack::
5dee29ac 2928 The default program to execute on the remote side when pushing. See
1c262bb7 2929 option --receive-pack of linkgit:git-push[1].
060aafc1 2930
5dee29ac
UKK
2931remote.<name>.uploadpack::
2932 The default program to execute on the remote side when fetching. See
1c262bb7 2933 option --upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 2934
da0005b8 2935remote.<name>.tagOpt::
1c262bb7
JK
2936 Setting this value to --no-tags disables automatic tag following when
2937 fetching from remote <name>. Setting it to --tags will fetch every
944163a4 2938 tag from remote <name>, even if they are not reachable from remote
ed368546 2939 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1c262bb7 2940 override this setting. See options --tags and --no-tags of
ed368546 2941 linkgit:git-fetch[1].
047f636d 2942
c578f51d 2943remote.<name>.vcs::
2de9b711 2944 Setting this to a value <vcs> will cause Git to interact with
c578f51d
DB
2945 the remote with the git-remote-<vcs> helper.
2946
737c5a9c
MS
2947remote.<name>.prune::
2948 When set to true, fetching from this remote by default will also
0838bf47
MH
2949 remove any remote-tracking references that no longer exist on the
2950 remote (as if the `--prune` option was given on the command line).
737c5a9c
MS
2951 Overrides `fetch.prune` settings, if any.
2952
1918278e
TT
2953remotes.<group>::
2954 The list of remotes which are fetched by "git remote update
5162e697 2955 <group>". See linkgit:git-remote[1].
1918278e 2956
da0005b8 2957repack.useDeltaBaseOffset::
22c79eab
NP
2958 By default, linkgit:git-repack[1] creates packs that use
2959 delta-base offset. If you need to share your repository with
2de9b711 2960 Git older than version 1.4.4, either directly or via a dumb
22c79eab 2961 protocol such as http, then you need to set this option to
2de9b711 2962 "false" and repack. Access from old Git versions over the
22c79eab 2963 native protocol are unaffected by this option.
b6945f57 2964
ee34a2be
JK
2965repack.packKeptObjects::
2966 If set to true, makes `git repack` act as if
2967 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2968 details. Defaults to `false` normally, but `true` if a bitmap
2969 index is being written (either via `--write-bitmap-index` or
71d76cb4
JK
2970 `repack.writeBitmaps`).
2971
2972repack.writeBitmaps::
2973 When true, git will write a bitmap index when packing all
2974 objects to disk (e.g., when `git repack -a` is run). This
2975 index can speed up the "counting objects" phase of subsequent
2976 packs created for clones and fetches, at the cost of some disk
9cea46cd
EW
2977 space and extra time spent on the initial repack. This has
2978 no effect if multiple packfiles are created.
2979 Defaults to false.
ee34a2be 2980
da0005b8 2981rerere.autoUpdate::
b0f34c3d
MM
2982 When set to true, `git-rerere` updates the index with the
2983 resulting contents after it cleanly resolves conflicts using
2984 previously recorded resolution. Defaults to false.
2985
2986rerere.enabled::
2987 Activate recording of resolved conflicts, so that identical
07b88a00
TR
2988 conflict hunks can be resolved automatically, should they be
2989 encountered again. By default, linkgit:git-rerere[1] is
2990 enabled if there is an `rr-cache` directory under the
b6fb7fed
JH
2991 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2992 repository.
b0f34c3d 2993
65180c66
YD
2994sendemail.identity::
2995 A configuration identity. When given, causes values in the
2996 'sendemail.<identity>' subsection to take precedence over
2997 values in the 'sendemail' section. The default identity is
ae9f6311 2998 the value of `sendemail.identity`.
65180c66 2999
da0005b8 3000sendemail.smtpEncryption::
65180c66
YD
3001 See linkgit:git-send-email[1] for description. Note that this
3002 setting is not subject to the 'identity' mechanism.
3003
502e7f98 3004sendemail.smtpssl (deprecated)::
da0005b8 3005 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
65180c66 3006
35035bbf
RR
3007sendemail.smtpsslcertpath::
3008 Path to ca-certificates (either a directory or a single file).
3009 Set it to an empty string to disable certificate verification.
3010
65180c66
YD
3011sendemail.<identity>.*::
3012 Identity-specific versions of the 'sendemail.*' parameters
4e36907f
JK
3013 found below, taking precedence over those when this
3014 identity is selected, through either the command-line or
ae9f6311 3015 `sendemail.identity`.
65180c66 3016
da0005b8
NTND
3017sendemail.aliasesFile::
3018sendemail.aliasFileType::
402596aa 3019sendemail.annotate::
65180c66
YD
3020sendemail.bcc::
3021sendemail.cc::
da0005b8
NTND
3022sendemail.ccCmd::
3023sendemail.chainReplyTo::
65180c66 3024sendemail.confirm::
da0005b8 3025sendemail.envelopeSender::
65180c66 3026sendemail.from::
da0005b8 3027sendemail.multiEdit::
65180c66 3028sendemail.signedoffbycc::
da0005b8 3029sendemail.smtpPass::
65180c66 3030sendemail.suppresscc::
da0005b8 3031sendemail.suppressFrom::
65180c66 3032sendemail.to::
1b396877 3033sendemail.tocmd::
da0005b8
NTND
3034sendemail.smtpDomain::
3035sendemail.smtpServer::
3036sendemail.smtpServerPort::
3037sendemail.smtpServerOption::
3038sendemail.smtpUser::
65180c66 3039sendemail.thread::
da0005b8 3040sendemail.transferEncoding::
65180c66 3041sendemail.validate::
ac1596a6 3042sendemail.xmailer::
65180c66
YD
3043 See linkgit:git-send-email[1] for description.
3044
502e7f98 3045sendemail.signedoffcc (deprecated)::
ae9f6311 3046 Deprecated alias for `sendemail.signedoffbycc`.
65180c66 3047
5453b83b 3048sendemail.smtpBatchSize::
3049 Number of messages to be sent per connection, after that a relogin
3050 will happen. If the value is 0 or undefined, send all messages in
3051 one connection.
3052 See also the `--batch-size` option of linkgit:git-send-email[1].
3053
3054sendemail.smtpReloginDelay::
3055 Seconds wait before reconnecting to smtp server.
3056 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3057
1ab661dd 3058showbranch.default::
5162e697
DM
3059 The default set of branches for linkgit:git-show-branch[1].
3060 See linkgit:git-show-branch[1].
1ab661dd 3061
e77cf4ee
CC
3062splitIndex.maxPercentChange::
3063 When the split index feature is used, this specifies the
3064 percent of entries the split index can contain compared to the
3065 total number of entries in both the split index and the shared
3066 index before a new shared index is written.
3067 The value should be between 0 and 100. If the value is 0 then
3068 a new shared index is always written, if it is 100 a new
3069 shared index is never written.
3070 By default the value is 20, so a new shared index is written
3071 if the number of entries in the split index would be greater
3072 than 20 percent of the total number of entries.
3073 See linkgit:git-update-index[1].
3074
b2dd1c5c
CC
3075splitIndex.sharedIndexExpire::
3076 When the split index feature is used, shared index files that
3077 were not modified since the time this variable specifies will
3078 be removed when a new shared index file is created. The value
3079 "now" expires all entries immediately, and "never" suppresses
3080 expiration altogether.
3081 The default value is "2.weeks.ago".
3082 Note that a shared index file is considered modified (for the
3083 purpose of expiration) each time a new split-index file is
b4601395 3084 either created based on it or read from it.
b2dd1c5c
CC
3085 See linkgit:git-update-index[1].
3086
46f721c8 3087status.relativePaths::
5162e697 3088 By default, linkgit:git-status[1] shows paths relative to the
46f721c8 3089 current directory. Setting this variable to `false` shows paths
2de9b711 3090 relative to the repository root (this was the default for Git
46f721c8
JK
3091 prior to v1.5.4).
3092
4fb5166a
JJGG
3093status.short::
3094 Set to true to enable --short by default in linkgit:git-status[1].
3095 The option --no-short takes precedence over this variable.
3096
ec85d070
JJGG
3097status.branch::
3098 Set to true to enable --branch by default in linkgit:git-status[1].
3099 The option --no-branch takes precedence over this variable.
3100
2556b996
MM
3101status.displayCommentPrefix::
3102 If set to true, linkgit:git-status[1] will insert a comment
3103 prefix before each output line (starting with
3104 `core.commentChar`, i.e. `#` by default). This was the
3105 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3106 Defaults to false.
3107
c1b5d019
LB
3108status.showStash::
3109 If set to true, linkgit:git-status[1] will display the number of
3110 entries currently stashed away.
3111 Defaults to false.
3112
d6293d1f
MSO
3113status.showUntrackedFiles::
3114 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3115 files which are not currently tracked by Git. Directories which
3116 contain only untracked files, are shown with the directory name
3117 only. Showing untracked files means that Git needs to lstat() all
71069cdf 3118 the files in the whole repository, which might be slow on some
d6293d1f
MSO
3119 systems. So, this variable controls how the commands displays
3120 the untracked files. Possible values are:
3121+
3122--
9373bdc4
CF
3123* `no` - Show no untracked files.
3124* `normal` - Show untracked files and directories.
3125* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
3126--
3127+
3128If this variable is not specified, it defaults to 'normal'.
3129This variable can be overridden with the -u|--untracked-files option
3130of linkgit:git-status[1] and linkgit:git-commit[1].
3131
da0005b8 3132status.submoduleSummary::
4b2343fa
MG
3133 Defaults to false.
3134 If this is set to a non zero number or true (identical to -1 or an
3135 unlimited number), the submodule summary will be enabled and a
3136 summary of commits for modified submodules will be shown (see
bb58b696
JL
3137 --summary-limit option of linkgit:git-submodule[1]). Please note
3138 that the summary output command will be suppressed for all
3139 submodules when `diff.ignoreSubmodules` is set to 'all' or only
1d2f393a
JL
3140 for those submodules where `submodule.<name>.ignore=all`. The only
3141 exception to that rule is that status and commit will show staged
3142 submodule changes. To
bb58b696 3143 also view the summary for ignored submodules you can either use
06ab60c0 3144 the --ignore-submodules=dirty command-line option or the 'git
bb58b696
JL
3145 submodule summary' command, which shows a similar output but does
3146 not honor these settings.
4b2343fa 3147
3086c064
NK
3148stash.showPatch::
3149 If this is set to true, the `git stash show` command without an
e01db917 3150 option will show the stash entry in patch form. Defaults to false.
3086c064
NK
3151 See description of 'show' command in linkgit:git-stash[1].
3152
3153stash.showStat::
3154 If this is set to true, the `git stash show` command without an
e01db917 3155 option will show diffstat of the stash entry. Defaults to true.
3086c064
NK
3156 See description of 'show' command in linkgit:git-stash[1].
3157
0ad0a61f 3158submodule.<name>.url::
72710165
SB
3159 The URL for a submodule. This variable is copied from the .gitmodules
3160 file to the git config via 'git submodule init'. The user can change
3161 the configured URL before obtaining the submodule via 'git submodule
a086f921
BW
3162 update'. If neither submodule.<name>.active or submodule.active are
3163 set, the presence of this variable is used as a fallback to indicate
3164 whether the submodule is of interest to git commands.
72710165 3165 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
5c31acfb 3166
0ad0a61f 3167submodule.<name>.update::
d3a44f63
SB
3168 The method by which a submodule is updated by 'git submodule update',
3169 which is the only affected command, others such as
3170 'git checkout --recurse-submodules' are unaffected. It exists for
3171 historical reasons, when 'git submodule' was the only command to
3172 interact with submodules; settings like `submodule.active`
3173 and `pull.rebase` are more specific. It is populated by
3174 `git submodule init` from the linkgit:gitmodules[5] file.
3175 See description of 'update' command in linkgit:git-submodule[1].
0ad0a61f 3176
06b1abb5
TK
3177submodule.<name>.branch::
3178 The remote branch name for a submodule, used by `git submodule
3179 update --remote`. Set this option to override the value found in
3180 the `.gitmodules` file. See linkgit:git-submodule[1] and
3181 linkgit:gitmodules[5] for details.
3182
c1a3c364 3183submodule.<name>.fetchRecurseSubmodules::
bf42b384 3184 This option can be used to control recursive fetching of this
469bfc96 3185 submodule. It can be overridden by using the --[no-]recurse-submodules
06ab60c0 3186 command-line option to "git fetch" and "git pull".
c1a3c364
JL
3187 This setting will override that from in the linkgit:gitmodules[5]
3188 file.
3189
aee9c7d6
JL
3190submodule.<name>.ignore::
3191 Defines under what circumstances "git status" and the diff family show
3192 a submodule as modified. When set to "all", it will never be considered
1d2f393a
JL
3193 modified (but it will nonetheless show up in the output of status and
3194 commit when it has been staged), "dirty" will ignore all changes
3195 to the submodules work tree and
aee9c7d6
JL
3196 takes only differences between the HEAD of the submodule and the commit
3197 recorded in the superproject into account. "untracked" will additionally
3198 let submodules with modified tracked files in their work tree show up.
3199 Using "none" (the default when this option is not set) also shows
3200 submodules that have untracked files in their work tree as changed.
302ad7a9 3201 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 3202 both settings can be overridden on the command line by using the
bb58b696
JL
3203 "--ignore-submodules" option. The 'git submodule' commands are not
3204 affected by this setting.
aee9c7d6 3205
a086f921
BW
3206submodule.<name>.active::
3207 Boolean value indicating if the submodule is of interest to git
3208 commands. This config option takes precedence over the
3209 submodule.active config option.
3210
3211submodule.active::
3212 A repeated field which contains a pathspec used to match against a
3213 submodule's path to determine if the submodule is of interest to git
3214 commands.
3215
046b4823
SB
3216submodule.recurse::
3217 Specifies if commands recurse into submodules by default. This
3218 applies to all commands that have a `--recurse-submodules` option.
3219 Defaults to false.
3220
a028a193
SB
3221submodule.fetchJobs::
3222 Specifies how many submodules are fetched/cloned at the same time.
3223 A positive integer allows up to that number of submodules fetched
3224 in parallel. A value of 0 will give some reasonable default.
3225 If unset, it defaults to 1.
3226
31224cbd
SB
3227submodule.alternateLocation::
3228 Specifies how the submodules obtain alternates when submodules are
3229 cloned. Possible values are `no`, `superproject`.
3230 By default `no` is assumed, which doesn't add references. When the
3231 value is set to `superproject` the submodule to be cloned computes
3232 its alternates location relative to the superprojects alternate.
3233
8ab9740d 3234submodule.alternateErrorStrategy::
31224cbd
SB
3235 Specifies how to treat errors with the alternates for a submodule
3236 as computed via `submodule.alternateLocation`. Possible values are
3237 `ignore`, `info`, `die`. Default is `die`.
3238
61c2fe0c
LA
3239tag.forceSignAnnotated::
3240 A boolean to specify whether annotated tags created should be GPG signed.
3241 If `--annotate` is specified on the command line, it takes
3242 precedence over this option.
3243
b150794d
JK
3244tag.sort::
3245 This variable controls the sort ordering of tags when displayed by
3246 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3247 value of this variable will be used as the default.
3248
ce1a79b6 3249tar.umask::
687157c7
RS
3250 This variable can be used to restrict the permission bits of
3251 tar archive entries. The default is 0002, which turns off the
3252 world write bit. The special value "user" indicates that the
3253 archiving user's umask will be used instead. See umask(2) and
5162e697 3254 linkgit:git-archive[1].
ce1a79b6 3255
dab76d3a
JH
3256transfer.fsckObjects::
3257 When `fetch.fsckObjects` or `receive.fsckObjects` are
3258 not set, the value of this variable is used instead.
3259 Defaults to false.
3260
da0005b8 3261transfer.hideRefs::
cc118a65
JK
3262 String(s) `receive-pack` and `upload-pack` use to decide which
3263 refs to omit from their initial advertisements. Use more than
3264 one definition to specify multiple prefix strings. A ref that is
3265 under the hierarchies listed in the value of this variable is
3266 excluded, and is hidden when responding to `git push` or `git
3267 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3268 program-specific versions of this config.
2bc31d16
JK
3269+
3270You may also include a `!` in front of the ref name to negate the entry,
3271explicitly exposing it, even if an earlier entry marked it as hidden.
3272If you have multiple hideRefs values, later entries override earlier ones
3273(and entries in more-specific config files override less-specific ones).
92cab492
LF
3274+
3275If a namespace is in use, the namespace prefix is stripped from each
3276reference before it is matched against `transfer.hiderefs` patterns.
3277For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3278the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3279is omitted from the advertisements but `refs/heads/master` and
3280`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
78a766ab
LF
3281"have" lines. In order to match refs before stripping, add a `^` in front of
3282the ref name. If you combine `!` and `^`, `!` must be specified first.
235ec243
MM
3283+
3284Even if you hide refs, a client may still be able to steal the target
3285objects via the techniques described in the "SECURITY" section of the
3286linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3287separate repository.
daebaa78 3288
b0f34c3d
MM
3289transfer.unpackLimit::
3290 When `fetch.unpackLimit` or `receive.unpackLimit` are
3291 not set, the value of this variable is used instead.
3292 The default value is 100.
3293
7671b632
SG
3294uploadarchive.allowUnreachable::
3295 If true, allow clients to use `git archive --remote` to request
3296 any tree, whether reachable from the ref tips or not. See the
235ec243 3297 discussion in the "SECURITY" section of
7671b632
SG
3298 linkgit:git-upload-archive[1] for more details. Defaults to
3299 `false`.
3300
da0005b8 3301uploadpack.hideRefs::
cc118a65
JK
3302 This variable is the same as `transfer.hideRefs`, but applies
3303 only to `upload-pack` (and so affects only fetches, not pushes).
3304 An attempt to fetch a hidden ref by `git fetch` will fail. See
3305 also `uploadpack.allowTipSHA1InWant`.
390eb36b 3306
bc0a4741 3307uploadpack.allowTipSHA1InWant::
da0005b8 3308 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
390eb36b
JH
3309 to accept a fetch request that asks for an object at the tip
3310 of a hidden ref (by default, such a request is rejected).
235ec243
MM
3311 See also `uploadpack.hideRefs`. Even if this is false, a client
3312 may be able to steal objects via the techniques described in the
3313 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3314 best to keep private data in a separate repository.
daebaa78 3315
68ee6289
FM
3316uploadpack.allowReachableSHA1InWant::
3317 Allow `upload-pack` to accept a fetch request that asks for an
3318 object that is reachable from any ref tip. However, note that
3319 calculating object reachability is computationally expensive.
235ec243
MM
3320 Defaults to `false`. Even if this is false, a client may be able
3321 to steal objects via the techniques described in the "SECURITY"
3322 section of the linkgit:gitnamespaces[7] man page; it's best to
3323 keep private data in a separate repository.
68ee6289 3324
f8edeaa0
DT
3325uploadpack.allowAnySHA1InWant::
3326 Allow `upload-pack` to accept a fetch request that asks for any
3327 object at all.
3328 Defaults to `false`.
3329
da0005b8 3330uploadpack.keepAlive::
05e95155
JK
3331 When `upload-pack` has started `pack-objects`, there may be a
3332 quiet period while `pack-objects` prepares the pack. Normally
3333 it would output progress information, but if `--quiet` was used
3334 for the fetch, `pack-objects` will output nothing at all until
3335 the pack data begins. Some clients and networks may consider
3336 the server to be hung and give up. Setting this option instructs
3337 `upload-pack` to send an empty keepalive packet every
da0005b8 3338 `uploadpack.keepAlive` seconds. Setting this option to 0
115dedd7 3339 disables keepalive packets entirely. The default is 5 seconds.
05e95155 3340
20b20a22
JK
3341uploadpack.packObjectsHook::
3342 If this option is set, when `upload-pack` would run
3343 `git pack-objects` to create a packfile for a client, it will
3344 run this shell command instead. The `pack-objects` command and
3345 arguments it _would_ have run (including the `git pack-objects`
3346 at the beginning) are appended to the shell command. The stdin
3347 and stdout of the hook are treated as if `pack-objects` itself
3348 was run. I.e., `upload-pack` will feed input intended for
3349 `pack-objects` to the hook, and expects a completed packfile on
3350 stdout.
3351+
3352Note that this configuration variable is ignored if it is seen in the
3353repository-level config (this is a safety measure against fetching from
3354untrusted repositories).
3355
55029ae4
DB
3356url.<base>.insteadOf::
3357 Any URL that starts with this value will be rewritten to
3358 start, instead, with <base>. In cases where some site serves a
3359 large number of repositories, and serves them with multiple
3360 access methods, and some users need to use different access
3361 methods, this feature allows people to specify any of the
2de9b711 3362 equivalent URLs and have Git automatically rewrite the URL to
55029ae4 3363 the best alternative for the particular user, even for a
844112ca
JH
3364 never-before-seen repository on the site. When more than one
3365 insteadOf strings match a given URL, the longest match is used.
2c9a2ae2
JK
3366+
3367Note that any protocol restrictions will be applied to the rewritten
3368URL. If the rewrite changes the URL to use a custom protocol or remote
3369helper, you may need to adjust the `protocol.*.allow` config to permit
3370the request. In particular, protocols you expect to use for submodules
3371must be set to `always` rather than the default of `user`. See the
3372description of `protocol.allow` above.
55029ae4 3373
1c2eafb8
JT
3374url.<base>.pushInsteadOf::
3375 Any URL that starts with this value will not be pushed to;
3376 instead, it will be rewritten to start with <base>, and the
3377 resulting URL will be pushed to. In cases where some site serves
3378 a large number of repositories, and serves them with multiple
3379 access methods, some of which do not allow push, this feature
2de9b711 3380 allows people to specify a pull-only URL and have Git
1c2eafb8
JT
3381 automatically use an appropriate URL to push, even for a
3382 never-before-seen repository on the site. When more than one
3383 pushInsteadOf strings match a given URL, the longest match is
2de9b711 3384 used. If a remote has an explicit pushurl, Git will ignore this
1c2eafb8
JT
3385 setting for that remote.
3386
1ab661dd
PB
3387user.email::
3388 Your email address to be recorded in any newly created commits.
eee7f4a2 3389 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
47d81b5c 3390 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
3391
3392user.name::
3393 Your full name to be recorded in any newly created commits.
eee7f4a2 3394 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
5162e697 3395 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 3396
4d5c2956 3397user.useConfigOnly::
ae9f6311
TR
3398 Instruct Git to avoid trying to guess defaults for `user.email`
3399 and `user.name`, and instead retrieve the values only from the
4d5c2956
DA
3400 configuration. For example, if you have multiple email addresses
3401 and would like to use a different one for each repository, then
3402 with this configuration option set to `true` in the global config
3403 along with a name, Git will prompt you to set up an email before
3404 making new commits in a newly cloned repository.
3405 Defaults to `false`.
3406
da0005b8 3407user.signingKey::
f0551693
NV
3408 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3409 key you want it to automatically when creating a signed tag or
3410 commit, you can override the default selection with this variable.
3411 This option is passed unchanged to gpg's --local-user parameter,
3412 so you may specify a key using any method that gpg supports.
d67778ec 3413
c026557a
SG
3414versionsort.prereleaseSuffix (deprecated)::
3415 Deprecated alias for `versionsort.suffix`. Ignored if
3416 `versionsort.suffix` is set.
3417
3418versionsort.suffix::
3419 Even when version sort is used in linkgit:git-tag[1], tagnames
3420 with the same base version but different suffixes are still sorted
3421 lexicographically, resulting e.g. in prerelease tags appearing
3422 after the main release (e.g. "1.0-rc1" after "1.0"). This
3423 variable can be specified to determine the sorting order of tags
3424 with different suffixes.
3425+
3426By specifying a single suffix in this variable, any tagname containing
3427that suffix will appear before the corresponding main release. E.g. if
3428the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3429"1.0". If specified multiple times, once per suffix, then the order of
3430suffixes in the configuration will determine the sorting order of tagnames
3431with those suffixes. E.g. if "-pre" appears before "-rc" in the
3432configuration, then all "1.0-preX" tags will be listed before any
3433"1.0-rcX" tags. The placement of the main release tag relative to tags
3434with various suffixes can be determined by specifying the empty suffix
3435among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3436"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3437are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3438"v4.8-bfsX".
3439+
b8231660 3440If more than one suffixes match the same tagname, then that tagname will
51acfa9d
SG
3441be sorted according to the suffix which starts at the earliest position in
3442the tagname. If more than one different matching suffixes start at
3443that earliest position, then that tagname will be sorted according to the
3444longest of those suffixes.
b8231660
SG
3445The sorting order between different suffixes is undefined if they are
3446in multiple config files.
d811c8e1 3447
983a9eeb
CC
3448web.browser::
3449 Specify a web browser that may be used by some commands.
3450 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3451 may use it.
e92445a7
TG
3452
3453worktree.guessRemote::
3454 With `add`, if no branch argument, and neither of `-b` nor
3455 `-B` nor `--detach` are given, the command defaults to
3456 creating a new branch from HEAD. If `worktree.guessRemote` is
3457 set to true, `worktree add` tries to find a remote-tracking
3458 branch whose name uniquely matches the new branch name. If
3459 such a branch exists, it is checked out and set as "upstream"
3460 for the new branch. If no such match can be found, it falls
3461 back to creating a new branch from the current HEAD.