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