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