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