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