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