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