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