1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 amWorkDir:: 348 Advice that shows the location of the patch file when 349 linkgit:git-am[1] fails to apply it. 350 rmHints:: 351 In case of failure in the output of linkgit:git-rm[1], 352 show directions on how to proceed from the current state. 353 addEmbeddedRepo:: 354 Advice on what to do when you've accidentally added one 355 git repo inside of another. 356 ignoredHook:: 357 Advice shown if an hook is ignored because the hook is not 358 set as executable. 359 waitingForEditor:: 360 Print a message to the terminal whenever Git is waiting for 361 editor input from the user. 362-- 363 364core.fileMode:: 365 Tells Git if the executable bit of files in the working tree 366 is to be honored. 367+ 368Some filesystems lose the executable bit when a file that is 369marked as executable is checked out, or checks out a 370non-executable file with executable bit on. 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 372to see if it handles the executable bit correctly 373and this variable is automatically set as necessary. 374+ 375A repository, however, may be on a filesystem that handles 376the filemode correctly, and this variable is set to 'true' 377when created, but later may be made accessible from another 378environment that loses the filemode (e.g. exporting ext4 via 379CIFS mount, visiting a Cygwin created repository with 380Git for Windows or Eclipse). 381In such a case it may be necessary to set this variable to 'false'. 382See linkgit:git-update-index[1]. 383+ 384The default is true (when core.filemode is not specified in the config file). 385 386core.hideDotFiles:: 387 (Windows-only) If true, mark newly-created directories and files whose 388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 389 directory is hidden, but no other files starting with a dot. The 390 default mode is 'dotGitOnly'. 391 392core.ignoreCase:: 393 If true, this option enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like FAT. For example, if a directory listing finds 396 "makefile" when Git expects "Makefile", Git will assume 397 it is really the same file, and continue to remember it as 398 "Makefile". 399+ 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 401will probe and set core.ignoreCase true if appropriate when the repository 402is created. 403 404core.precomposeUnicode:: 405 This option is only used by Mac OS implementation of Git. 406 When core.precomposeUnicode=true, Git reverts the unicode decomposition 407 of filenames done by Mac OS. This is useful when sharing a repository 408 between Mac OS and Linux or Windows. 409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 410 When false, file names are handled fully transparent by Git, 411 which is backward compatible with older versions of Git. 412 413core.protectHFS:: 414 If set to true, do not allow checkout of paths that would 415 be considered equivalent to `.git` on an HFS+ filesystem. 416 Defaults to `true` on Mac OS, and `false` elsewhere. 417 418core.protectNTFS:: 419 If set to true, do not allow checkout of paths that would 420 cause problems with the NTFS filesystem, e.g. conflict with 421 8.3 "short" names. 422 Defaults to `true` on Windows, and `false` elsewhere. 423 424core.fsmonitor:: 425 If set, the value of this variable is used as a command which 426 will identify all files that may have changed since the 427 requested date/time. This information is used to speed up git by 428 avoiding unnecessary processing of files that have not changed. 429 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 430 431core.trustctime:: 432 If false, the ctime differences between the index and the 433 working tree are ignored; useful when the inode change time 434 is regularly modified by something outside Git (file system 435 crawlers and some backup systems). 436 See linkgit:git-update-index[1]. True by default. 437 438core.splitIndex:: 439 If true, the split-index feature of the index will be used. 440 See linkgit:git-update-index[1]. False by default. 441 442core.untrackedCache:: 443 Determines what to do about the untracked cache feature of the 444 index. It will be kept, if this variable is unset or set to 445 `keep`. It will automatically be added if set to `true`. And 446 it will automatically be removed, if set to `false`. Before 447 setting it to `true`, you should check that mtime is working 448 properly on your system. 449 See linkgit:git-update-index[1]. `keep` by default. 450 451core.checkStat:: 452 Determines which stat fields to match between the index 453 and work tree. The user can set this to 'default' or 454 'minimal'. Default (or explicitly 'default'), is to check 455 all fields, including the sub-second part of mtime and ctime. 456 457core.quotePath:: 458 Commands that output paths (e.g. 'ls-files', 'diff'), will 459 quote "unusual" characters in the pathname by enclosing the 460 pathname in double-quotes and escaping those characters with 461 backslashes in the same way C escapes control characters (e.g. 462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 464 UTF-8). If this variable is set to false, bytes higher than 465 0x80 are not considered "unusual" any more. Double-quotes, 466 backslash and control characters are always escaped regardless 467 of the setting of this variable. A simple space character is 468 not considered "unusual". Many commands can output pathnames 469 completely verbatim using the `-z` option. The default value 470 is true. 471 472core.eol:: 473 Sets the line ending type to use in the working directory for 474 files that have the `text` property set when core.autocrlf is false. 475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 476 native line ending. The default value is `native`. See 477 linkgit:gitattributes[5] for more information on end-of-line 478 conversion. 479 480core.safecrlf:: 481 If true, makes Git check if converting `CRLF` is reversible when 482 end-of-line conversion is active. Git will verify if a command 483 modifies a file in the work tree either directly or indirectly. 484 For example, committing a file followed by checking out the 485 same file should yield the original file in the work tree. If 486 this is not the case for the current setting of 487 `core.autocrlf`, Git will reject the file. The variable can 488 be set to "warn", in which case Git will only warn about an 489 irreversible conversion but continue the operation. 490+ 491CRLF conversion bears a slight chance of corrupting data. 492When it is enabled, Git will convert CRLF to LF during commit and LF to 493CRLF during checkout. A file that contains a mixture of LF and 494CRLF before the commit cannot be recreated by Git. For text 495files this is the right thing to do: it corrects line endings 496such that we have only LF line endings in the repository. 497But for binary files that are accidentally classified as text the 498conversion can corrupt data. 499+ 500If you recognize such corruption early you can easily fix it by 501setting the conversion type explicitly in .gitattributes. Right 502after committing you still have the original file in your work 503tree and this file is not yet corrupted. You can explicitly tell 504Git that this file is binary and Git will handle the file 505appropriately. 506+ 507Unfortunately, the desired effect of cleaning up text files with 508mixed line endings and the undesired effect of corrupting binary 509files cannot be distinguished. In both cases CRLFs are removed 510in an irreversible way. For text files this is the right thing 511to do because CRLFs are line endings, while for binary files 512converting CRLFs corrupts data. 513+ 514Note, this safety check does not mean that a checkout will generate a 515file identical to the original file for a different setting of 516`core.eol` and `core.autocrlf`, but only for the current one. For 517example, a text file with `LF` would be accepted with `core.eol=lf` 518and could later be checked out with `core.eol=crlf`, in which case the 519resulting file would contain `CRLF`, although the original file 520contained `LF`. However, in both work trees the line endings would be 521consistent, that is either all `LF` or all `CRLF`, but never mixed. A 522file with mixed line endings would be reported by the `core.safecrlf` 523mechanism. 524 525core.autocrlf:: 526 Setting this variable to "true" is the same as setting 527 the `text` attribute to "auto" on all files and core.eol to "crlf". 528 Set to true if you want to have `CRLF` line endings in your 529 working directory and the repository has LF line endings. 530 This variable can be set to 'input', 531 in which case no output conversion is performed. 532 533core.checkRoundtripEncoding:: 534 A comma and/or whitespace separated list of encodings that Git 535 performs UTF-8 round trip checks on if they are used in an 536 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 537 The default value is `SHIFT-JIS`. 538 539core.symlinks:: 540 If false, symbolic links are checked out as small plain files that 541 contain the link text. linkgit:git-update-index[1] and 542 linkgit:git-add[1] will not change the recorded type to regular 543 file. Useful on filesystems like FAT that do not support 544 symbolic links. 545+ 546The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 547will probe and set core.symlinks false if appropriate when the repository 548is created. 549 550core.gitProxy:: 551 A "proxy command" to execute (as 'command host port') instead 552 of establishing direct connection to the remote server when 553 using the Git protocol for fetching. If the variable value is 554 in the "COMMAND for DOMAIN" format, the command is applied only 555 on hostnames ending with the specified domain string. This variable 556 may be set multiple times and is matched in the given order; 557 the first match wins. 558+ 559Can be overridden by the `GIT_PROXY_COMMAND` environment variable 560(which always applies universally, without the special "for" 561handling). 562+ 563The special string `none` can be used as the proxy command to 564specify that no proxy be used for a given domain pattern. 565This is useful for excluding servers inside a firewall from 566proxy use, while defaulting to a common proxy for external domains. 567 568core.sshCommand:: 569 If this variable is set, `git fetch` and `git push` will 570 use the specified command instead of `ssh` when they need to 571 connect to a remote system. The command is in the same form as 572 the `GIT_SSH_COMMAND` environment variable and is overridden 573 when the environment variable is set. 574 575core.ignoreStat:: 576 If true, Git will avoid using lstat() calls to detect if files have 577 changed by setting the "assume-unchanged" bit for those tracked files 578 which it has updated identically in both the index and working tree. 579+ 580When files are modified outside of Git, the user will need to stage 581the modified files explicitly (e.g. see 'Examples' section in 582linkgit:git-update-index[1]). 583Git will not normally detect changes to those files. 584+ 585This is useful on systems where lstat() calls are very slow, such as 586CIFS/Microsoft Windows. 587+ 588False by default. 589 590core.preferSymlinkRefs:: 591 Instead of the default "symref" format for HEAD 592 and other symbolic reference files, use symbolic links. 593 This is sometimes needed to work with old scripts that 594 expect HEAD to be a symbolic link. 595 596core.bare:: 597 If true this repository is assumed to be 'bare' and has no 598 working directory associated with it. If this is the case a 599 number of commands that require a working directory will be 600 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 601+ 602This setting is automatically guessed by linkgit:git-clone[1] or 603linkgit:git-init[1] when the repository was created. By default a 604repository that ends in "/.git" is assumed to be not bare (bare = 605false), while all other repositories are assumed to be bare (bare 606= true). 607 608core.worktree:: 609 Set the path to the root of the working tree. 610 If `GIT_COMMON_DIR` environment variable is set, core.worktree 611 is ignored and not used for determining the root of working tree. 612 This can be overridden by the `GIT_WORK_TREE` environment 613 variable and the `--work-tree` command-line option. 614 The value can be an absolute path or relative to the path to 615 the .git directory, which is either specified by --git-dir 616 or GIT_DIR, or automatically discovered. 617 If --git-dir or GIT_DIR is specified but none of 618 --work-tree, GIT_WORK_TREE and core.worktree is specified, 619 the current working directory is regarded as the top level 620 of your working tree. 621+ 622Note that this variable is honored even when set in a configuration 623file in a ".git" subdirectory of a directory and its value differs 624from the latter directory (e.g. "/path/to/.git/config" has 625core.worktree set to "/different/path"), which is most likely a 626misconfiguration. Running Git commands in the "/path/to" directory will 627still use "/different/path" as the root of the work tree and can cause 628confusion unless you know what you are doing (e.g. you are creating a 629read-only snapshot of the same index to a location different from the 630repository's usual working tree). 631 632core.logAllRefUpdates:: 633 Enable the reflog. Updates to a ref <ref> is logged to the file 634 "`$GIT_DIR/logs/<ref>`", by appending the new and old 635 SHA-1, the date/time and the reason of the update, but 636 only when the file exists. If this configuration 637 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 638 file is automatically created for branch heads (i.e. under 639 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 640 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 641 If it is set to `always`, then a missing reflog is automatically 642 created for any ref under `refs/`. 643+ 644This information can be used to determine what commit 645was the tip of a branch "2 days ago". 646+ 647This value is true by default in a repository that has 648a working directory associated with it, and false by 649default in a bare repository. 650 651core.repositoryFormatVersion:: 652 Internal variable identifying the repository format and layout 653 version. 654 655core.sharedRepository:: 656 When 'group' (or 'true'), the repository is made shareable between 657 several users in a group (making sure all the files and objects are 658 group-writable). When 'all' (or 'world' or 'everybody'), the 659 repository will be readable by all users, additionally to being 660 group-shareable. When 'umask' (or 'false'), Git will use permissions 661 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 662 files in the repository will have this mode value. '0xxx' will override 663 user's umask value (whereas the other options will only override 664 requested parts of the user's umask value). Examples: '0660' will make 665 the repo read/write-able for the owner and group, but inaccessible to 666 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 667 repository that is group-readable but not group-writable. 668 See linkgit:git-init[1]. False by default. 669 670core.warnAmbiguousRefs:: 671 If true, Git will warn you if the ref name you passed it is ambiguous 672 and might match multiple refs in the repository. True by default. 673 674core.compression:: 675 An integer -1..9, indicating a default compression level. 676 -1 is the zlib default. 0 means no compression, 677 and 1..9 are various speed/size tradeoffs, 9 being slowest. 678 If set, this provides a default to other compression variables, 679 such as `core.looseCompression` and `pack.compression`. 680 681core.looseCompression:: 682 An integer -1..9, indicating the compression level for objects that 683 are not in a pack file. -1 is the zlib default. 0 means no 684 compression, and 1..9 are various speed/size tradeoffs, 9 being 685 slowest. If not set, defaults to core.compression. If that is 686 not set, defaults to 1 (best speed). 687 688core.packedGitWindowSize:: 689 Number of bytes of a pack file to map into memory in a 690 single mapping operation. Larger window sizes may allow 691 your system to process a smaller number of large pack files 692 more quickly. Smaller window sizes will negatively affect 693 performance due to increased calls to the operating system's 694 memory manager, but may improve performance when accessing 695 a large number of large pack files. 696+ 697Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 698MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 699be reasonable for all users/operating systems. You probably do 700not need to adjust this value. 701+ 702Common unit suffixes of 'k', 'm', or 'g' are supported. 703 704core.packedGitLimit:: 705 Maximum number of bytes to map simultaneously into memory 706 from pack files. If Git needs to access more than this many 707 bytes at once to complete an operation it will unmap existing 708 regions to reclaim virtual address space within the process. 709+ 710Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 711unlimited) on 64 bit platforms. 712This should be reasonable for all users/operating systems, except on 713the largest projects. You probably do not need to adjust this value. 714+ 715Common unit suffixes of 'k', 'm', or 'g' are supported. 716 717core.deltaBaseCacheLimit:: 718 Maximum number of bytes to reserve for caching base objects 719 that may be referenced by multiple deltified objects. By storing the 720 entire decompressed base objects in a cache Git is able 721 to avoid unpacking and decompressing frequently used base 722 objects multiple times. 723+ 724Default is 96 MiB on all platforms. This should be reasonable 725for all users/operating systems, except on the largest projects. 726You probably do not need to adjust this value. 727+ 728Common unit suffixes of 'k', 'm', or 'g' are supported. 729 730core.bigFileThreshold:: 731 Files larger than this size are stored deflated, without 732 attempting delta compression. Storing large files without 733 delta compression avoids excessive memory usage, at the 734 slight expense of increased disk usage. Additionally files 735 larger than this size are always treated as binary. 736+ 737Default is 512 MiB on all platforms. This should be reasonable 738for most projects as source code and other text files can still 739be delta compressed, but larger binary media files won't be. 740+ 741Common unit suffixes of 'k', 'm', or 'g' are supported. 742 743core.excludesFile:: 744 Specifies the pathname to the file that contains patterns to 745 describe paths that are not meant to be tracked, in addition 746 to '.gitignore' (per-directory) and '.git/info/exclude'. 747 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 748 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 749 is used instead. See linkgit:gitignore[5]. 750 751core.askPass:: 752 Some commands (e.g. svn and http interfaces) that interactively 753 ask for a password can be told to use an external program given 754 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 755 environment variable. If not set, fall back to the value of the 756 `SSH_ASKPASS` environment variable or, failing that, a simple password 757 prompt. The external program shall be given a suitable prompt as 758 command-line argument and write the password on its STDOUT. 759 760core.attributesFile:: 761 In addition to '.gitattributes' (per-directory) and 762 '.git/info/attributes', Git looks into this file for attributes 763 (see linkgit:gitattributes[5]). Path expansions are made the same 764 way as for `core.excludesFile`. Its default value is 765 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 766 set or empty, `$HOME/.config/git/attributes` is used instead. 767 768core.hooksPath:: 769 By default Git will look for your hooks in the 770 '$GIT_DIR/hooks' directory. Set this to different path, 771 e.g. '/etc/git/hooks', and Git will try to find your hooks in 772 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 773 in '$GIT_DIR/hooks/pre-receive'. 774+ 775The path can be either absolute or relative. A relative path is 776taken as relative to the directory where the hooks are run (see 777the "DESCRIPTION" section of linkgit:githooks[5]). 778+ 779This configuration variable is useful in cases where you'd like to 780centrally configure your Git hooks instead of configuring them on a 781per-repository basis, or as a more flexible and centralized 782alternative to having an `init.templateDir` where you've changed 783default hooks. 784 785core.editor:: 786 Commands such as `commit` and `tag` that let you edit 787 messages by launching an editor use the value of this 788 variable when it is set, and the environment variable 789 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 790 791core.commentChar:: 792 Commands such as `commit` and `tag` that let you edit 793 messages consider a line that begins with this character 794 commented, and removes them after the editor returns 795 (default '#'). 796+ 797If set to "auto", `git-commit` would select a character that is not 798the beginning character of any line in existing commit messages. 799 800core.filesRefLockTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock an individual reference. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 100 (i.e., 804 retry for 100ms). 805 806core.packedRefsTimeout:: 807 The length of time, in milliseconds, to retry when trying to 808 lock the `packed-refs` file. Value 0 means not to retry at 809 all; -1 means to try indefinitely. Default is 1000 (i.e., 810 retry for 1 second). 811 812sequence.editor:: 813 Text editor used by `git rebase -i` for editing the rebase instruction file. 814 The value is meant to be interpreted by the shell when it is used. 815 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 816 When not configured the default commit message editor is used instead. 817 818core.pager:: 819 Text viewer for use by Git commands (e.g., 'less'). The value 820 is meant to be interpreted by the shell. The order of preference 821 is the `$GIT_PAGER` environment variable, then `core.pager` 822 configuration, then `$PAGER`, and then the default chosen at 823 compile time (usually 'less'). 824+ 825When the `LESS` environment variable is unset, Git sets it to `FRX` 826(if `LESS` environment variable is set, Git does not change it at 827all). If you want to selectively override Git's default setting 828for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 829be passed to the shell by Git, which will translate the final 830command to `LESS=FRX less -S`. The environment does not set the 831`S` option but the command line does, instructing less to truncate 832long lines. Similarly, setting `core.pager` to `less -+F` will 833deactivate the `F` option specified by the environment from the 834command-line, deactivating the "quit if one screen" behavior of 835`less`. One can specifically activate some flags for particular 836commands: for example, setting `pager.blame` to `less -S` enables 837line truncation only for `git blame`. 838+ 839Likewise, when the `LV` environment variable is unset, Git sets it 840to `-c`. You can override this setting by exporting `LV` with 841another value or setting `core.pager` to `lv +c`. 842 843core.whitespace:: 844 A comma separated list of common whitespace problems to 845 notice. 'git diff' will use `color.diff.whitespace` to 846 highlight them, and 'git apply --whitespace=error' will 847 consider them as errors. You can prefix `-` to disable 848 any of them (e.g. `-trailing-space`): 849+ 850* `blank-at-eol` treats trailing whitespaces at the end of the line 851 as an error (enabled by default). 852* `space-before-tab` treats a space character that appears immediately 853 before a tab character in the initial indent part of the line as an 854 error (enabled by default). 855* `indent-with-non-tab` treats a line that is indented with space 856 characters instead of the equivalent tabs as an error (not enabled by 857 default). 858* `tab-in-indent` treats a tab character in the initial indent part of 859 the line as an error (not enabled by default). 860* `blank-at-eof` treats blank lines added at the end of file as an error 861 (enabled by default). 862* `trailing-space` is a short-hand to cover both `blank-at-eol` and 863 `blank-at-eof`. 864* `cr-at-eol` treats a carriage-return at the end of line as 865 part of the line terminator, i.e. with it, `trailing-space` 866 does not trigger if the character before such a carriage-return 867 is not a whitespace (not enabled by default). 868* `tabwidth=<n>` tells how many character positions a tab occupies; this 869 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 870 errors. The default tab width is 8. Allowed values are 1 to 63. 871 872core.fsyncObjectFiles:: 873 This boolean will enable 'fsync()' when writing object files. 874+ 875This is a total waste of time and effort on a filesystem that orders 876data writes properly, but can be useful for filesystems that do not use 877journalling (traditional UNIX filesystems) or that only journal metadata 878and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 879 880core.preloadIndex:: 881 Enable parallel index preload for operations like 'git diff' 882+ 883This can speed up operations like 'git diff' and 'git status' especially 884on filesystems like NFS that have weak caching semantics and thus 885relatively high IO latencies. When enabled, Git will do the 886index comparison to the filesystem data in parallel, allowing 887overlapping IO's. Defaults to true. 888 889core.createObject:: 890 You can set this to 'link', in which case a hardlink followed by 891 a delete of the source are used to make sure that object creation 892 will not overwrite existing objects. 893+ 894On some file system/operating system combinations, this is unreliable. 895Set this config setting to 'rename' there; However, This will remove the 896check that makes sure that existing object files will not get overwritten. 897 898core.notesRef:: 899 When showing commit messages, also show notes which are stored in 900 the given ref. The ref must be fully qualified. If the given 901 ref does not exist, it is not an error but means that no 902 notes should be printed. 903+ 904This setting defaults to "refs/notes/commits", and it can be overridden by 905the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 906 907core.commitGraph:: 908 Enable git commit graph feature. Allows reading from the 909 commit-graph file. 910 911core.sparseCheckout:: 912 Enable "sparse checkout" feature. See section "Sparse checkout" in 913 linkgit:git-read-tree[1] for more information. 914 915core.abbrev:: 916 Set the length object names are abbreviated to. If 917 unspecified or set to "auto", an appropriate value is 918 computed based on the approximate number of packed objects 919 in your repository, which hopefully is enough for 920 abbreviated object names to stay unique for some time. 921 The minimum length is 4. 922 923add.ignoreErrors:: 924add.ignore-errors (deprecated):: 925 Tells 'git add' to continue adding files when some files cannot be 926 added due to indexing errors. Equivalent to the `--ignore-errors` 927 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 928 as it does not follow the usual naming convention for configuration 929 variables. 930 931alias.*:: 932 Command aliases for the linkgit:git[1] command wrapper - e.g. 933 after defining "alias.last = cat-file commit HEAD", the invocation 934 "git last" is equivalent to "git cat-file commit HEAD". To avoid 935 confusion and troubles with script usage, aliases that 936 hide existing Git commands are ignored. Arguments are split by 937 spaces, the usual shell quoting and escaping is supported. 938 A quote pair or a backslash can be used to quote them. 939+ 940If the alias expansion is prefixed with an exclamation point, 941it will be treated as a shell command. For example, defining 942"alias.new = !gitk --all --not ORIG_HEAD", the invocation 943"git new" is equivalent to running the shell command 944"gitk --all --not ORIG_HEAD". Note that shell commands will be 945executed from the top-level directory of a repository, which may 946not necessarily be the current directory. 947`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 948from the original current directory. See linkgit:git-rev-parse[1]. 949 950am.keepcr:: 951 If true, git-am will call git-mailsplit for patches in mbox format 952 with parameter `--keep-cr`. In this case git-mailsplit will 953 not remove `\r` from lines ending with `\r\n`. Can be overridden 954 by giving `--no-keep-cr` from the command line. 955 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 956 957am.threeWay:: 958 By default, `git am` will fail if the patch does not apply cleanly. When 959 set to true, this setting tells `git am` to fall back on 3-way merge if 960 the patch records the identity of blobs it is supposed to apply to and 961 we have those blobs available locally (equivalent to giving the `--3way` 962 option from the command line). Defaults to `false`. 963 See linkgit:git-am[1]. 964 965apply.ignoreWhitespace:: 966 When set to 'change', tells 'git apply' to ignore changes in 967 whitespace, in the same way as the `--ignore-space-change` 968 option. 969 When set to one of: no, none, never, false tells 'git apply' to 970 respect all whitespace differences. 971 See linkgit:git-apply[1]. 972 973apply.whitespace:: 974 Tells 'git apply' how to handle whitespaces, in the same way 975 as the `--whitespace` option. See linkgit:git-apply[1]. 976 977blame.showRoot:: 978 Do not treat root commits as boundaries in linkgit:git-blame[1]. 979 This option defaults to false. 980 981blame.blankBoundary:: 982 Show blank commit object name for boundary commits in 983 linkgit:git-blame[1]. This option defaults to false. 984 985blame.showEmail:: 986 Show the author email instead of author name in linkgit:git-blame[1]. 987 This option defaults to false. 988 989blame.date:: 990 Specifies the format used to output dates in linkgit:git-blame[1]. 991 If unset the iso format is used. For supported values, 992 see the discussion of the `--date` option at linkgit:git-log[1]. 993 994branch.autoSetupMerge:: 995 Tells 'git branch' and 'git checkout' to set up new branches 996 so that linkgit:git-pull[1] will appropriately merge from the 997 starting point branch. Note that even if this option is not set, 998 this behavior can be chosen per-branch using the `--track` 999 and `--no-track` options. The valid settings are: `false` -- no1000 automatic setup is done; `true` -- automatic setup is done when the1001 starting point is a remote-tracking branch; `always` --1002 automatic setup is done when the starting point is either a1003 local branch or remote-tracking1004 branch. This option defaults to true.10051006branch.autoSetupRebase::1007 When a new branch is created with 'git branch' or 'git checkout'1008 that tracks another branch, this variable tells Git to set1009 up pull to rebase instead of merge (see "branch.<name>.rebase").1010 When `never`, rebase is never automatically set to true.1011 When `local`, rebase is set to true for tracked branches of1012 other local branches.1013 When `remote`, rebase is set to true for tracked branches of1014 remote-tracking branches.1015 When `always`, rebase will be set to true for all tracking1016 branches.1017 See "branch.autoSetupMerge" for details on how to set up a1018 branch to track another branch.1019 This option defaults to never.10201021branch.<name>.remote::1022 When on branch <name>, it tells 'git fetch' and 'git push'1023 which remote to fetch from/push to. The remote to push to1024 may be overridden with `remote.pushDefault` (for all branches).1025 The remote to push to, for the current branch, may be further1026 overridden by `branch.<name>.pushRemote`. If no remote is1027 configured, or if you are not on any branch, it defaults to1028 `origin` for fetching and `remote.pushDefault` for pushing.1029 Additionally, `.` (a period) is the current local repository1030 (a dot-repository), see `branch.<name>.merge`'s final note below.10311032branch.<name>.pushRemote::1033 When on branch <name>, it overrides `branch.<name>.remote` for1034 pushing. It also overrides `remote.pushDefault` for pushing1035 from branch <name>. When you pull from one place (e.g. your1036 upstream) and push to another place (e.g. your own publishing1037 repository), you would want to set `remote.pushDefault` to1038 specify the remote to push to for all branches, and use this1039 option to override it for a specific branch.10401041branch.<name>.merge::1042 Defines, together with branch.<name>.remote, the upstream branch1043 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1044 branch to merge and can also affect 'git push' (see push.default).1045 When in branch <name>, it tells 'git fetch' the default1046 refspec to be marked for merging in FETCH_HEAD. The value is1047 handled like the remote part of a refspec, and must match a1048 ref which is fetched from the remote given by1049 "branch.<name>.remote".1050 The merge information is used by 'git pull' (which at first calls1051 'git fetch') to lookup the default branch for merging. Without1052 this option, 'git pull' defaults to merge the first refspec fetched.1053 Specify multiple values to get an octopus merge.1054 If you wish to setup 'git pull' so that it merges into <name> from1055 another branch in the local repository, you can point1056 branch.<name>.merge to the desired branch, and use the relative path1057 setting `.` (a period) for branch.<name>.remote.10581059branch.<name>.mergeOptions::1060 Sets default options for merging into branch <name>. The syntax and1061 supported options are the same as those of linkgit:git-merge[1], but1062 option values containing whitespace characters are currently not1063 supported.10641065branch.<name>.rebase::1066 When true, rebase the branch <name> on top of the fetched branch,1067 instead of merging the default branch from the default remote when1068 "git pull" is run. See "pull.rebase" for doing this in a non1069 branch-specific manner.1070+1071When `merges`, pass the `--rebase-merges` option to 'git rebase'1072so that the local merge commits are included in the rebase (see1073linkgit:git-rebase[1] for details).1074+1075When preserve, also pass `--preserve-merges` along to 'git rebase'1076so that locally committed merge commits will not be flattened1077by running 'git pull'.1078+1079When the value is `interactive`, the rebase is run in interactive mode.1080+1081*NOTE*: this is a possibly dangerous operation; do *not* use1082it unless you understand the implications (see linkgit:git-rebase[1]1083for details).10841085branch.<name>.description::1086 Branch description, can be edited with1087 `git branch --edit-description`. Branch description is1088 automatically added in the format-patch cover letter or1089 request-pull summary.10901091browser.<tool>.cmd::1092 Specify the command to invoke the specified browser. The1093 specified command is evaluated in shell with the URLs passed1094 as arguments. (See linkgit:git-web{litdd}browse[1].)10951096browser.<tool>.path::1097 Override the path for the given tool that may be used to1098 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1099 working repository in gitweb (see linkgit:git-instaweb[1]).11001101clean.requireForce::1102 A boolean to make git-clean do nothing unless given -f,1103 -i or -n. Defaults to true.11041105color.advice::1106 A boolean to enable/disable color in hints (e.g. when a push1107 failed, see `advice.*` for a list). May be set to `always`,1108 `false` (or `never`) or `auto` (or `true`), in which case colors1109 are used only when the error output goes to a terminal. If1110 unset, then the value of `color.ui` is used (`auto` by default).11111112color.advice.hint::1113 Use customized color for hints.11141115color.branch::1116 A boolean to enable/disable color in the output of1117 linkgit:git-branch[1]. May be set to `always`,1118 `false` (or `never`) or `auto` (or `true`), in which case colors are used1119 only when the output is to a terminal. If unset, then the1120 value of `color.ui` is used (`auto` by default).11211122color.branch.<slot>::1123 Use customized color for branch coloration. `<slot>` is one of1124 `current` (the current branch), `local` (a local branch),1125 `remote` (a remote-tracking branch in refs/remotes/),1126 `upstream` (upstream tracking branch), `plain` (other1127 refs).11281129color.diff::1130 Whether to use ANSI escape sequences to add color to patches.1131 If this is set to `always`, linkgit:git-diff[1],1132 linkgit:git-log[1], and linkgit:git-show[1] will use color1133 for all patches. If it is set to `true` or `auto`, those1134 commands will only use color when output is to the terminal.1135 If unset, then the value of `color.ui` is used (`auto` by1136 default).1137+1138This does not affect linkgit:git-format-patch[1] or the1139'git-diff-{asterisk}' plumbing commands. Can be overridden on the1140command line with the `--color[=<when>]` option.11411142diff.colorMoved::1143 If set to either a valid `<mode>` or a true value, moved lines1144 in a diff are colored differently, for details of valid modes1145 see '--color-moved' in linkgit:git-diff[1]. If simply set to1146 true the default color mode will be used. When set to false,1147 moved lines are not colored.11481149color.diff.<slot>::1150 Use customized color for diff colorization. `<slot>` specifies1151 which part of the patch to use the specified color, and is one1152 of `context` (context text - `plain` is a historical synonym),1153 `meta` (metainformation), `frag`1154 (hunk header), 'func' (function in hunk header), `old` (removed lines),1155 `new` (added lines), `commit` (commit headers), `whitespace`1156 (highlighting whitespace errors), `oldMoved` (deleted lines),1157 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1158 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1159 and `newMovedAlternativeDimmed` (See the '<mode>'1160 setting of '--color-moved' in linkgit:git-diff[1] for details).11611162color.decorate.<slot>::1163 Use customized color for 'git log --decorate' output. `<slot>` is one1164 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1165 branches, remote-tracking branches, tags, stash and HEAD, respectively.11661167color.grep::1168 When set to `always`, always highlight matches. When `false` (or1169 `never`), never. When set to `true` or `auto`, use color only1170 when the output is written to the terminal. If unset, then the1171 value of `color.ui` is used (`auto` by default).11721173color.grep.<slot>::1174 Use customized color for grep colorization. `<slot>` specifies which1175 part of the line to use the specified color, and is one of1176+1177--1178`context`;;1179 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1180`filename`;;1181 filename prefix (when not using `-h`)1182`function`;;1183 function name lines (when using `-p`)1184`linenumber`;;1185 line number prefix (when using `-n`)1186`match`;;1187 matching text (same as setting `matchContext` and `matchSelected`)1188`matchContext`;;1189 matching text in context lines1190`matchSelected`;;1191 matching text in selected lines1192`selected`;;1193 non-matching text in selected lines1194`separator`;;1195 separators between fields on a line (`:`, `-`, and `=`)1196 and between hunks (`--`)1197--11981199color.interactive::1200 When set to `always`, always use colors for interactive prompts1201 and displays (such as those used by "git-add --interactive" and1202 "git-clean --interactive"). When false (or `never`), never.1203 When set to `true` or `auto`, use colors only when the output is1204 to the terminal. If unset, then the value of `color.ui` is1205 used (`auto` by default).12061207color.interactive.<slot>::1208 Use customized color for 'git add --interactive' and 'git clean1209 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1210 or `error`, for four distinct types of normal output from1211 interactive commands.12121213color.pager::1214 A boolean to enable/disable colored output when the pager is in1215 use (default is true).12161217color.push::1218 A boolean to enable/disable color in push errors. May be set to1219 `always`, `false` (or `never`) or `auto` (or `true`), in which1220 case colors are used only when the error output goes to a terminal.1221 If unset, then the value of `color.ui` is used (`auto` by default).12221223color.push.error::1224 Use customized color for push errors.12251226color.showBranch::1227 A boolean to enable/disable color in the output of1228 linkgit:git-show-branch[1]. May be set to `always`,1229 `false` (or `never`) or `auto` (or `true`), in which case colors are used1230 only when the output is to a terminal. If unset, then the1231 value of `color.ui` is used (`auto` by default).12321233color.status::1234 A boolean to enable/disable color in the output of1235 linkgit:git-status[1]. May be set to `always`,1236 `false` (or `never`) or `auto` (or `true`), in which case colors are used1237 only when the output is to a terminal. If unset, then the1238 value of `color.ui` is used (`auto` by default).12391240color.status.<slot>::1241 Use customized color for status colorization. `<slot>` is1242 one of `header` (the header text of the status message),1243 `added` or `updated` (files which are added but not committed),1244 `changed` (files which are changed but not added in the index),1245 `untracked` (files which are not tracked by Git),1246 `branch` (the current branch),1247 `nobranch` (the color the 'no branch' warning is shown in, defaulting1248 to red),1249 `localBranch` or `remoteBranch` (the local and remote branch names,1250 respectively, when branch and tracking information is displayed in the1251 status short-format), or1252 `unmerged` (files which have unmerged changes).12531254color.blame.repeatedLines::1255 Use the customized color for the part of git-blame output that1256 is repeated meta information per line (such as commit id,1257 author name, date and timezone). Defaults to cyan.12581259color.blame.highlightRecent::1260 This can be used to color the metadata of a blame line depending1261 on age of the line.1262+1263This setting should be set to a comma-separated list of color and date settings,1264starting and ending with a color, the dates should be set from oldest to newest.1265The metadata will be colored given the colors if the the line was introduced1266before the given timestamp, overwriting older timestamped colors.1267+1268Instead of an absolute timestamp relative timestamps work as well, e.g.12692.weeks.ago is valid to address anything older than 2 weeks.1270+1271It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1272everything older than one year blue, recent changes between one month and1273one year old are kept white, and lines introduced within the last month are1274colored red.12751276blame.coloring::1277 This determines the coloring scheme to be applied to blame1278 output. It can be 'repeatedLines', 'highlightRecent',1279 or 'none' which is the default.12801281color.transport::1282 A boolean to enable/disable color when pushes are rejected. May be1283 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1284 case colors are used only when the error output goes to a terminal.1285 If unset, then the value of `color.ui` is used (`auto` by default).12861287color.transport.rejected::1288 Use customized color when a push was rejected.12891290color.ui::1291 This variable determines the default value for variables such1292 as `color.diff` and `color.grep` that control the use of color1293 per command family. Its scope will expand as more commands learn1294 configuration to set a default for the `--color` option. Set it1295 to `false` or `never` if you prefer Git commands not to use1296 color unless enabled explicitly with some other configuration1297 or the `--color` option. Set it to `always` if you want all1298 output not intended for machine consumption to use color, to1299 `true` or `auto` (this is the default since Git 1.8.4) if you1300 want such output to use color when written to the terminal.13011302column.ui::1303 Specify whether supported commands should output in columns.1304 This variable consists of a list of tokens separated by spaces1305 or commas:1306+1307These options control when the feature should be enabled1308(defaults to 'never'):1309+1310--1311`always`;;1312 always show in columns1313`never`;;1314 never show in columns1315`auto`;;1316 show in columns if the output is to the terminal1317--1318+1319These options control layout (defaults to 'column'). Setting any1320of these implies 'always' if none of 'always', 'never', or 'auto' are1321specified.1322+1323--1324`column`;;1325 fill columns before rows1326`row`;;1327 fill rows before columns1328`plain`;;1329 show in one column1330--1331+1332Finally, these options can be combined with a layout option (defaults1333to 'nodense'):1334+1335--1336`dense`;;1337 make unequal size columns to utilize more space1338`nodense`;;1339 make equal size columns1340--13411342column.branch::1343 Specify whether to output branch listing in `git branch` in columns.1344 See `column.ui` for details.13451346column.clean::1347 Specify the layout when list items in `git clean -i`, which always1348 shows files and directories in columns. See `column.ui` for details.13491350column.status::1351 Specify whether to output untracked files in `git status` in columns.1352 See `column.ui` for details.13531354column.tag::1355 Specify whether to output tag listing in `git tag` in columns.1356 See `column.ui` for details.13571358commit.cleanup::1359 This setting overrides the default of the `--cleanup` option in1360 `git commit`. See linkgit:git-commit[1] for details. Changing the1361 default can be useful when you always want to keep lines that begin1362 with comment character `#` in your log message, in which case you1363 would do `git config commit.cleanup whitespace` (note that you will1364 have to remove the help lines that begin with `#` in the commit log1365 template yourself, if you do this).13661367commit.gpgSign::13681369 A boolean to specify whether all commits should be GPG signed.1370 Use of this option when doing operations such as rebase can1371 result in a large number of commits being signed. It may be1372 convenient to use an agent to avoid typing your GPG passphrase1373 several times.13741375commit.status::1376 A boolean to enable/disable inclusion of status information in the1377 commit message template when using an editor to prepare the commit1378 message. Defaults to true.13791380commit.template::1381 Specify the pathname of a file to use as the template for1382 new commit messages.13831384commit.verbose::1385 A boolean or int to specify the level of verbose with `git commit`.1386 See linkgit:git-commit[1].13871388credential.helper::1389 Specify an external helper to be called when a username or1390 password credential is needed; the helper may consult external1391 storage to avoid prompting the user for the credentials. Note1392 that multiple helpers may be defined. See linkgit:gitcredentials[7]1393 for details.13941395credential.useHttpPath::1396 When acquiring credentials, consider the "path" component of an http1397 or https URL to be important. Defaults to false. See1398 linkgit:gitcredentials[7] for more information.13991400credential.username::1401 If no username is set for a network authentication, use this username1402 by default. See credential.<context>.* below, and1403 linkgit:gitcredentials[7].14041405credential.<url>.*::1406 Any of the credential.* options above can be applied selectively to1407 some credentials. For example "credential.https://example.com.username"1408 would set the default username only for https connections to1409 example.com. See linkgit:gitcredentials[7] for details on how URLs are1410 matched.14111412credentialCache.ignoreSIGHUP::1413 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14141415completion.commands::1416 This is only used by git-completion.bash to add or remove1417 commands from the list of completed commands. Normally only1418 porcelain commands and a few select others are completed. You1419 can add more commands, separated by space, in this1420 variable. Prefixing the command with '-' will remove it from1421 the existing list.14221423include::diff-config.txt[]14241425difftool.<tool>.path::1426 Override the path for the given tool. This is useful in case1427 your tool is not in the PATH.14281429difftool.<tool>.cmd::1430 Specify the command to invoke the specified diff tool.1431 The specified command is evaluated in shell with the following1432 variables available: 'LOCAL' is set to the name of the temporary1433 file containing the contents of the diff pre-image and 'REMOTE'1434 is set to the name of the temporary file containing the contents1435 of the diff post-image.14361437difftool.prompt::1438 Prompt before each invocation of the diff tool.14391440fastimport.unpackLimit::1441 If the number of objects imported by linkgit:git-fast-import[1]1442 is below this limit, then the objects will be unpacked into1443 loose object files. However if the number of imported objects1444 equals or exceeds this limit then the pack will be stored as a1445 pack. Storing the pack from a fast-import can make the import1446 operation complete faster, especially on slow filesystems. If1447 not set, the value of `transfer.unpackLimit` is used instead.14481449fetch.recurseSubmodules::1450 This option can be either set to a boolean value or to 'on-demand'.1451 Setting it to a boolean changes the behavior of fetch and pull to1452 unconditionally recurse into submodules when set to true or to not1453 recurse at all when set to false. When set to 'on-demand' (the default1454 value), fetch and pull will only recurse into a populated submodule1455 when its superproject retrieves a commit that updates the submodule's1456 reference.14571458fetch.fsckObjects::1459 If it is set to true, git-fetch-pack will check all fetched1460 objects. It will abort in the case of a malformed object or a1461 broken link. The result of an abort are only dangling objects.1462 Defaults to false. If not set, the value of `transfer.fsckObjects`1463 is used instead.14641465fetch.unpackLimit::1466 If the number of objects fetched over the Git native1467 transfer is below this1468 limit, then the objects will be unpacked into loose object1469 files. However if the number of received objects equals or1470 exceeds this limit then the received pack will be stored as1471 a pack, after adding any missing delta bases. Storing the1472 pack from a push can make the push operation complete faster,1473 especially on slow filesystems. If not set, the value of1474 `transfer.unpackLimit` is used instead.14751476fetch.prune::1477 If true, fetch will automatically behave as if the `--prune`1478 option was given on the command line. See also `remote.<name>.prune`1479 and the PRUNING section of linkgit:git-fetch[1].14801481fetch.pruneTags::1482 If true, fetch will automatically behave as if the1483 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1484 if not set already. This allows for setting both this option1485 and `fetch.prune` to maintain a 1=1 mapping to upstream1486 refs. See also `remote.<name>.pruneTags` and the PRUNING1487 section of linkgit:git-fetch[1].14881489fetch.output::1490 Control how ref update status is printed. Valid values are1491 `full` and `compact`. Default value is `full`. See section1492 OUTPUT in linkgit:git-fetch[1] for detail.14931494format.attach::1495 Enable multipart/mixed attachments as the default for1496 'format-patch'. The value can also be a double quoted string1497 which will enable attachments as the default and set the1498 value as the boundary. See the --attach option in1499 linkgit:git-format-patch[1].15001501format.from::1502 Provides the default value for the `--from` option to format-patch.1503 Accepts a boolean value, or a name and email address. If false,1504 format-patch defaults to `--no-from`, using commit authors directly in1505 the "From:" field of patch mails. If true, format-patch defaults to1506 `--from`, using your committer identity in the "From:" field of patch1507 mails and including a "From:" field in the body of the patch mail if1508 different. If set to a non-boolean value, format-patch uses that1509 value instead of your committer identity. Defaults to false.15101511format.numbered::1512 A boolean which can enable or disable sequence numbers in patch1513 subjects. It defaults to "auto" which enables it only if there1514 is more than one patch. It can be enabled or disabled for all1515 messages by setting it to "true" or "false". See --numbered1516 option in linkgit:git-format-patch[1].15171518format.headers::1519 Additional email headers to include in a patch to be submitted1520 by mail. See linkgit:git-format-patch[1].15211522format.to::1523format.cc::1524 Additional recipients to include in a patch to be submitted1525 by mail. See the --to and --cc options in1526 linkgit:git-format-patch[1].15271528format.subjectPrefix::1529 The default for format-patch is to output files with the '[PATCH]'1530 subject prefix. Use this variable to change that prefix.15311532format.signature::1533 The default for format-patch is to output a signature containing1534 the Git version number. Use this variable to change that default.1535 Set this variable to the empty string ("") to suppress1536 signature generation.15371538format.signatureFile::1539 Works just like format.signature except the contents of the1540 file specified by this variable will be used as the signature.15411542format.suffix::1543 The default for format-patch is to output files with the suffix1544 `.patch`. Use this variable to change that suffix (make sure to1545 include the dot if you want it).15461547format.pretty::1548 The default pretty format for log/show/whatchanged command,1549 See linkgit:git-log[1], linkgit:git-show[1],1550 linkgit:git-whatchanged[1].15511552format.thread::1553 The default threading style for 'git format-patch'. Can be1554 a boolean value, or `shallow` or `deep`. `shallow` threading1555 makes every mail a reply to the head of the series,1556 where the head is chosen from the cover letter, the1557 `--in-reply-to`, and the first patch mail, in this order.1558 `deep` threading makes every mail a reply to the previous one.1559 A true boolean value is the same as `shallow`, and a false1560 value disables threading.15611562format.signOff::1563 A boolean value which lets you enable the `-s/--signoff` option of1564 format-patch by default. *Note:* Adding the Signed-off-by: line to a1565 patch should be a conscious act and means that you certify you have1566 the rights to submit this work under the same open source license.1567 Please see the 'SubmittingPatches' document for further discussion.15681569format.coverLetter::1570 A boolean that controls whether to generate a cover-letter when1571 format-patch is invoked, but in addition can be set to "auto", to1572 generate a cover-letter only when there's more than one patch.15731574format.outputDirectory::1575 Set a custom directory to store the resulting files instead of the1576 current working directory.15771578format.useAutoBase::1579 A boolean value which lets you enable the `--base=auto` option of1580 format-patch by default.15811582filter.<driver>.clean::1583 The command which is used to convert the content of a worktree1584 file to a blob upon checkin. See linkgit:gitattributes[5] for1585 details.15861587filter.<driver>.smudge::1588 The command which is used to convert the content of a blob1589 object to a worktree file upon checkout. See1590 linkgit:gitattributes[5] for details.15911592fsck.<msg-id>::1593 Allows overriding the message type (error, warn or ignore) of a1594 specific message ID such as `missingEmail`.1595+1596For convenience, fsck prefixes the error/warning with the message ID,1597e.g. "missingEmail: invalid author/committer line - missing email" means1598that setting `fsck.missingEmail = ignore` will hide that issue.1599+1600This feature is intended to support working with legacy repositories1601which cannot be repaired without disruptive changes.16021603fsck.skipList::1604 The path to a sorted list of object names (i.e. one SHA-1 per1605 line) that are known to be broken in a non-fatal way and should1606 be ignored. This feature is useful when an established project1607 should be accepted despite early commits containing errors that1608 can be safely ignored such as invalid committer email addresses.1609 Note: corrupt objects cannot be skipped with this setting.16101611gc.aggressiveDepth::1612 The depth parameter used in the delta compression1613 algorithm used by 'git gc --aggressive'. This defaults1614 to 50.16151616gc.aggressiveWindow::1617 The window size parameter used in the delta compression1618 algorithm used by 'git gc --aggressive'. This defaults1619 to 250.16201621gc.auto::1622 When there are approximately more than this many loose1623 objects in the repository, `git gc --auto` will pack them.1624 Some Porcelain commands use this command to perform a1625 light-weight garbage collection from time to time. The1626 default value is 6700. Setting this to 0 disables it.16271628gc.autoPackLimit::1629 When there are more than this many packs that are not1630 marked with `*.keep` file in the repository, `git gc1631 --auto` consolidates them into one larger pack. The1632 default value is 50. Setting this to 0 disables it.16331634gc.autoDetach::1635 Make `git gc --auto` return immediately and run in background1636 if the system supports it. Default is true.16371638gc.bigPackThreshold::1639 If non-zero, all packs larger than this limit are kept when1640 `git gc` is run. This is very similar to `--keep-base-pack`1641 except that all packs that meet the threshold are kept, not1642 just the base pack. Defaults to zero. Common unit suffixes of1643 'k', 'm', or 'g' are supported.1644+1645Note that if the number of kept packs is more than gc.autoPackLimit,1646this configuration variable is ignored, all packs except the base pack1647will be repacked. After this the number of packs should go below1648gc.autoPackLimit and gc.bigPackThreshold should be respected again.16491650gc.logExpiry::1651 If the file gc.log exists, then `git gc --auto` won't run1652 unless that file is more than 'gc.logExpiry' old. Default is1653 "1.day". See `gc.pruneExpire` for more ways to specify its1654 value.16551656gc.packRefs::1657 Running `git pack-refs` in a repository renders it1658 unclonable by Git versions prior to 1.5.1.2 over dumb1659 transports such as HTTP. This variable determines whether1660 'git gc' runs `git pack-refs`. This can be set to `notbare`1661 to enable it within all non-bare repos or it can be set to a1662 boolean value. The default is `true`.16631664gc.pruneExpire::1665 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1666 Override the grace period with this config variable. The value1667 "now" may be used to disable this grace period and always prune1668 unreachable objects immediately, or "never" may be used to1669 suppress pruning. This feature helps prevent corruption when1670 'git gc' runs concurrently with another process writing to the1671 repository; see the "NOTES" section of linkgit:git-gc[1].16721673gc.worktreePruneExpire::1674 When 'git gc' is run, it calls1675 'git worktree prune --expire 3.months.ago'.1676 This config variable can be used to set a different grace1677 period. The value "now" may be used to disable the grace1678 period and prune `$GIT_DIR/worktrees` immediately, or "never"1679 may be used to suppress pruning.16801681gc.reflogExpire::1682gc.<pattern>.reflogExpire::1683 'git reflog expire' removes reflog entries older than1684 this time; defaults to 90 days. The value "now" expires all1685 entries immediately, and "never" suppresses expiration1686 altogether. With "<pattern>" (e.g.1687 "refs/stash") in the middle the setting applies only to1688 the refs that match the <pattern>.16891690gc.reflogExpireUnreachable::1691gc.<pattern>.reflogExpireUnreachable::1692 'git reflog expire' removes reflog entries older than1693 this time and are not reachable from the current tip;1694 defaults to 30 days. The value "now" expires all entries1695 immediately, and "never" suppresses expiration altogether.1696 With "<pattern>" (e.g. "refs/stash")1697 in the middle, the setting applies only to the refs that1698 match the <pattern>.16991700gc.rerereResolved::1701 Records of conflicted merge you resolved earlier are1702 kept for this many days when 'git rerere gc' is run.1703 You can also use more human-readable "1.month.ago", etc.1704 The default is 60 days. See linkgit:git-rerere[1].17051706gc.rerereUnresolved::1707 Records of conflicted merge you have not resolved are1708 kept for this many days when 'git rerere gc' is run.1709 You can also use more human-readable "1.month.ago", etc.1710 The default is 15 days. See linkgit:git-rerere[1].17111712gitcvs.commitMsgAnnotation::1713 Append this string to each commit message. Set to empty string1714 to disable this feature. Defaults to "via git-CVS emulator".17151716gitcvs.enabled::1717 Whether the CVS server interface is enabled for this repository.1718 See linkgit:git-cvsserver[1].17191720gitcvs.logFile::1721 Path to a log file where the CVS server interface well... logs1722 various stuff. See linkgit:git-cvsserver[1].17231724gitcvs.usecrlfattr::1725 If true, the server will look up the end-of-line conversion1726 attributes for files to determine the `-k` modes to use. If1727 the attributes force Git to treat a file as text,1728 the `-k` mode will be left blank so CVS clients will1729 treat it as text. If they suppress text conversion, the file1730 will be set with '-kb' mode, which suppresses any newline munging1731 the client might otherwise do. If the attributes do not allow1732 the file type to be determined, then `gitcvs.allBinary` is1733 used. See linkgit:gitattributes[5].17341735gitcvs.allBinary::1736 This is used if `gitcvs.usecrlfattr` does not resolve1737 the correct '-kb' mode to use. If true, all1738 unresolved files are sent to the client in1739 mode '-kb'. This causes the client to treat them1740 as binary files, which suppresses any newline munging it1741 otherwise might do. Alternatively, if it is set to "guess",1742 then the contents of the file are examined to decide if1743 it is binary, similar to `core.autocrlf`.17441745gitcvs.dbName::1746 Database used by git-cvsserver to cache revision information1747 derived from the Git repository. The exact meaning depends on the1748 used database driver, for SQLite (which is the default driver) this1749 is a filename. Supports variable substitution (see1750 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1751 Default: '%Ggitcvs.%m.sqlite'17521753gitcvs.dbDriver::1754 Used Perl DBI driver. You can specify any available driver1755 for this here, but it might not work. git-cvsserver is tested1756 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1757 reported *not* to work with 'DBD::mysql'. Experimental feature.1758 May not contain double colons (`:`). Default: 'SQLite'.1759 See linkgit:git-cvsserver[1].17601761gitcvs.dbUser, gitcvs.dbPass::1762 Database user and password. Only useful if setting `gitcvs.dbDriver`,1763 since SQLite has no concept of database users and/or passwords.1764 'gitcvs.dbUser' supports variable substitution (see1765 linkgit:git-cvsserver[1] for details).17661767gitcvs.dbTableNamePrefix::1768 Database table name prefix. Prepended to the names of any1769 database tables used, allowing a single database to be used1770 for several repositories. Supports variable substitution (see1771 linkgit:git-cvsserver[1] for details). Any non-alphabetic1772 characters will be replaced with underscores.17731774All gitcvs variables except for `gitcvs.usecrlfattr` and1775`gitcvs.allBinary` can also be specified as1776'gitcvs.<access_method>.<varname>' (where 'access_method'1777is one of "ext" and "pserver") to make them apply only for the given1778access method.17791780gitweb.category::1781gitweb.description::1782gitweb.owner::1783gitweb.url::1784 See linkgit:gitweb[1] for description.17851786gitweb.avatar::1787gitweb.blame::1788gitweb.grep::1789gitweb.highlight::1790gitweb.patches::1791gitweb.pickaxe::1792gitweb.remote_heads::1793gitweb.showSizes::1794gitweb.snapshot::1795 See linkgit:gitweb.conf[5] for description.17961797grep.lineNumber::1798 If set to true, enable `-n` option by default.17991800grep.patternType::1801 Set the default matching behavior. Using a value of 'basic', 'extended',1802 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1803 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1804 value 'default' will return to the default matching behavior.18051806grep.extendedRegexp::1807 If set to true, enable `--extended-regexp` option by default. This1808 option is ignored when the `grep.patternType` option is set to a value1809 other than 'default'.18101811grep.threads::1812 Number of grep worker threads to use.1813 See `grep.threads` in linkgit:git-grep[1] for more information.18141815grep.fallbackToNoIndex::1816 If set to true, fall back to git grep --no-index if git grep1817 is executed outside of a git repository. Defaults to false.18181819gpg.program::1820 Use this custom program instead of "`gpg`" found on `$PATH` when1821 making or verifying a PGP signature. The program must support the1822 same command-line interface as GPG, namely, to verify a detached1823 signature, "`gpg --verify $file - <$signature`" is run, and the1824 program is expected to signal a good signature by exiting with1825 code 0, and to generate an ASCII-armored detached signature, the1826 standard input of "`gpg -bsau $key`" is fed with the contents to be1827 signed, and the program is expected to send the result to its1828 standard output.18291830gui.commitMsgWidth::1831 Defines how wide the commit message window is in the1832 linkgit:git-gui[1]. "75" is the default.18331834gui.diffContext::1835 Specifies how many context lines should be used in calls to diff1836 made by the linkgit:git-gui[1]. The default is "5".18371838gui.displayUntracked::1839 Determines if linkgit:git-gui[1] shows untracked files1840 in the file list. The default is "true".18411842gui.encoding::1843 Specifies the default encoding to use for displaying of1844 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1845 It can be overridden by setting the 'encoding' attribute1846 for relevant files (see linkgit:gitattributes[5]).1847 If this option is not set, the tools default to the1848 locale encoding.18491850gui.matchTrackingBranch::1851 Determines if new branches created with linkgit:git-gui[1] should1852 default to tracking remote branches with matching names or1853 not. Default: "false".18541855gui.newBranchTemplate::1856 Is used as suggested name when creating new branches using the1857 linkgit:git-gui[1].18581859gui.pruneDuringFetch::1860 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1861 performing a fetch. The default value is "false".18621863gui.trustmtime::1864 Determines if linkgit:git-gui[1] should trust the file modification1865 timestamp or not. By default the timestamps are not trusted.18661867gui.spellingDictionary::1868 Specifies the dictionary used for spell checking commit messages in1869 the linkgit:git-gui[1]. When set to "none" spell checking is turned1870 off.18711872gui.fastCopyBlame::1873 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1874 location detection. It makes blame significantly faster on huge1875 repositories at the expense of less thorough copy detection.18761877gui.copyBlameThreshold::1878 Specifies the threshold to use in 'git gui blame' original location1879 detection, measured in alphanumeric characters. See the1880 linkgit:git-blame[1] manual for more information on copy detection.18811882gui.blamehistoryctx::1883 Specifies the radius of history context in days to show in1884 linkgit:gitk[1] for the selected commit, when the `Show History1885 Context` menu item is invoked from 'git gui blame'. If this1886 variable is set to zero, the whole history is shown.18871888guitool.<name>.cmd::1889 Specifies the shell command line to execute when the corresponding item1890 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1891 mandatory for every tool. The command is executed from the root of1892 the working directory, and in the environment it receives the name of1893 the tool as `GIT_GUITOOL`, the name of the currently selected file as1894 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1895 the head is detached, 'CUR_BRANCH' is empty).18961897guitool.<name>.needsFile::1898 Run the tool only if a diff is selected in the GUI. It guarantees1899 that 'FILENAME' is not empty.19001901guitool.<name>.noConsole::1902 Run the command silently, without creating a window to display its1903 output.19041905guitool.<name>.noRescan::1906 Don't rescan the working directory for changes after the tool1907 finishes execution.19081909guitool.<name>.confirm::1910 Show a confirmation dialog before actually running the tool.19111912guitool.<name>.argPrompt::1913 Request a string argument from the user, and pass it to the tool1914 through the `ARGS` environment variable. Since requesting an1915 argument implies confirmation, the 'confirm' option has no effect1916 if this is enabled. If the option is set to 'true', 'yes', or '1',1917 the dialog uses a built-in generic prompt; otherwise the exact1918 value of the variable is used.19191920guitool.<name>.revPrompt::1921 Request a single valid revision from the user, and set the1922 `REVISION` environment variable. In other aspects this option1923 is similar to 'argPrompt', and can be used together with it.19241925guitool.<name>.revUnmerged::1926 Show only unmerged branches in the 'revPrompt' subdialog.1927 This is useful for tools similar to merge or rebase, but not1928 for things like checkout or reset.19291930guitool.<name>.title::1931 Specifies the title to use for the prompt dialog. The default1932 is the tool name.19331934guitool.<name>.prompt::1935 Specifies the general prompt string to display at the top of1936 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1937 The default value includes the actual command.19381939help.browser::1940 Specify the browser that will be used to display help in the1941 'web' format. See linkgit:git-help[1].19421943help.format::1944 Override the default help format used by linkgit:git-help[1].1945 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1946 the default. 'web' and 'html' are the same.19471948help.autoCorrect::1949 Automatically correct and execute mistyped commands after1950 waiting for the given number of deciseconds (0.1 sec). If more1951 than one command can be deduced from the entered text, nothing1952 will be executed. If the value of this option is negative,1953 the corrected command will be executed immediately. If the1954 value is 0 - the command will be just shown but not executed.1955 This is the default.19561957help.htmlPath::1958 Specify the path where the HTML documentation resides. File system paths1959 and URLs are supported. HTML pages will be prefixed with this path when1960 help is displayed in the 'web' format. This defaults to the documentation1961 path of your Git installation.19621963http.proxy::1964 Override the HTTP proxy, normally configured using the 'http_proxy',1965 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1966 addition to the syntax understood by curl, it is possible to specify a1967 proxy string with a user name but no password, in which case git will1968 attempt to acquire one in the same way it does for other credentials. See1969 linkgit:gitcredentials[7] for more information. The syntax thus is1970 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1971 on a per-remote basis; see remote.<name>.proxy19721973http.proxyAuthMethod::1974 Set the method with which to authenticate against the HTTP proxy. This1975 only takes effect if the configured proxy string contains a user name part1976 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1977 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1978 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1979 variable. Possible values are:1980+1981--1982* `anyauth` - Automatically pick a suitable authentication method. It is1983 assumed that the proxy answers an unauthenticated request with a 4071984 status code and one or more Proxy-authenticate headers with supported1985 authentication methods. This is the default.1986* `basic` - HTTP Basic authentication1987* `digest` - HTTP Digest authentication; this prevents the password from being1988 transmitted to the proxy in clear text1989* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1990 of `curl(1)`)1991* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1992--19931994http.emptyAuth::1995 Attempt authentication without seeking a username or password. This1996 can be used to attempt GSS-Negotiate authentication without specifying1997 a username in the URL, as libcurl normally requires a username for1998 authentication.19992000http.delegation::2001 Control GSSAPI credential delegation. The delegation is disabled2002 by default in libcurl since version 7.21.7. Set parameter to tell2003 the server what it is allowed to delegate when it comes to user2004 credentials. Used with GSS/kerberos. Possible values are:2005+2006--2007* `none` - Don't allow any delegation.2008* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2009 Kerberos service ticket, which is a matter of realm policy.2010* `always` - Unconditionally allow the server to delegate.2011--201220132014http.extraHeader::2015 Pass an additional HTTP header when communicating with a server. If2016 more than one such entry exists, all of them are added as extra2017 headers. To allow overriding the settings inherited from the system2018 config, an empty value will reset the extra headers to the empty list.20192020http.cookieFile::2021 The pathname of a file containing previously stored cookie lines,2022 which should be used2023 in the Git http session, if they match the server. The file format2024 of the file to read cookies from should be plain HTTP headers or2025 the Netscape/Mozilla cookie file format (see `curl(1)`).2026 NOTE that the file specified with http.cookieFile is used only as2027 input unless http.saveCookies is set.20282029http.saveCookies::2030 If set, store cookies received during requests to the file specified by2031 http.cookieFile. Has no effect if http.cookieFile is unset.20322033http.sslVersion::2034 The SSL version to use when negotiating an SSL connection, if you2035 want to force the default. The available and default version2036 depend on whether libcurl was built against NSS or OpenSSL and the2037 particular configuration of the crypto library in use. Internally2038 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2039 documentation for more details on the format of this option and2040 for the ssl version supported. Actually the possible values of2041 this option are:20422043 - sslv22044 - sslv32045 - tlsv12046 - tlsv1.02047 - tlsv1.12048 - tlsv1.22049 - tlsv1.320502051+2052Can be overridden by the `GIT_SSL_VERSION` environment variable.2053To force git to use libcurl's default ssl version and ignore any2054explicit http.sslversion option, set `GIT_SSL_VERSION` to the2055empty string.20562057http.sslCipherList::2058 A list of SSL ciphers to use when negotiating an SSL connection.2059 The available ciphers depend on whether libcurl was built against2060 NSS or OpenSSL and the particular configuration of the crypto2061 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2062 option; see the libcurl documentation for more details on the format2063 of this list.2064+2065Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2066To force git to use libcurl's default cipher list and ignore any2067explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2068empty string.20692070http.sslVerify::2071 Whether to verify the SSL certificate when fetching or pushing2072 over HTTPS. Defaults to true. Can be overridden by the2073 `GIT_SSL_NO_VERIFY` environment variable.20742075http.sslCert::2076 File containing the SSL certificate when fetching or pushing2077 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2078 variable.20792080http.sslKey::2081 File containing the SSL private key when fetching or pushing2082 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2083 variable.20842085http.sslCertPasswordProtected::2086 Enable Git's password prompt for the SSL certificate. Otherwise2087 OpenSSL will prompt the user, possibly many times, if the2088 certificate or private key is encrypted. Can be overridden by the2089 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20902091http.sslCAInfo::2092 File containing the certificates to verify the peer with when2093 fetching or pushing over HTTPS. Can be overridden by the2094 `GIT_SSL_CAINFO` environment variable.20952096http.sslCAPath::2097 Path containing files with the CA certificates to verify the peer2098 with when fetching or pushing over HTTPS. Can be overridden2099 by the `GIT_SSL_CAPATH` environment variable.21002101http.pinnedpubkey::2102 Public key of the https service. It may either be the filename of2103 a PEM or DER encoded public key file or a string starting with2104 'sha256//' followed by the base64 encoded sha256 hash of the2105 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2106 exit with an error if this option is set but not supported by2107 cURL.21082109http.sslTry::2110 Attempt to use AUTH SSL/TLS and encrypted data transfers2111 when connecting via regular FTP protocol. This might be needed2112 if the FTP server requires it for security reasons or you wish2113 to connect securely whenever remote FTP server supports it.2114 Default is false since it might trigger certificate verification2115 errors on misconfigured servers.21162117http.maxRequests::2118 How many HTTP requests to launch in parallel. Can be overridden2119 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21202121http.minSessions::2122 The number of curl sessions (counted across slots) to be kept across2123 requests. They will not be ended with curl_easy_cleanup() until2124 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2125 value will be capped at 1. Defaults to 1.21262127http.postBuffer::2128 Maximum size in bytes of the buffer used by smart HTTP2129 transports when POSTing data to the remote system.2130 For requests larger than this buffer size, HTTP/1.1 and2131 Transfer-Encoding: chunked is used to avoid creating a2132 massive pack file locally. Default is 1 MiB, which is2133 sufficient for most requests.21342135http.lowSpeedLimit, http.lowSpeedTime::2136 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2137 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2138 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2139 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21402141http.noEPSV::2142 A boolean which disables using of EPSV ftp command by curl.2143 This can helpful with some "poor" ftp servers which don't2144 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2145 environment variable. Default is false (curl will use EPSV).21462147http.userAgent::2148 The HTTP USER_AGENT string presented to an HTTP server. The default2149 value represents the version of the client Git such as git/1.7.1.2150 This option allows you to override this value to a more common value2151 such as Mozilla/4.0. This may be necessary, for instance, if2152 connecting through a firewall that restricts HTTP connections to a set2153 of common USER_AGENT strings (but not including those like git/1.7.1).2154 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21552156http.followRedirects::2157 Whether git should follow HTTP redirects. If set to `true`, git2158 will transparently follow any redirect issued by a server it2159 encounters. If set to `false`, git will treat all redirects as2160 errors. If set to `initial`, git will follow redirects only for2161 the initial request to a remote, but not for subsequent2162 follow-up HTTP requests. Since git uses the redirected URL as2163 the base for the follow-up requests, this is generally2164 sufficient. The default is `initial`.21652166http.<url>.*::2167 Any of the http.* options above can be applied selectively to some URLs.2168 For a config key to match a URL, each element of the config key is2169 compared to that of the URL, in the following order:2170+2171--2172. Scheme (e.g., `https` in `https://example.com/`). This field2173 must match exactly between the config key and the URL.21742175. Host/domain name (e.g., `example.com` in `https://example.com/`).2176 This field must match between the config key and the URL. It is2177 possible to specify a `*` as part of the host name to match all subdomains2178 at this level. `https://*.example.com/` for example would match2179 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21802181. Port number (e.g., `8080` in `http://example.com:8080/`).2182 This field must match exactly between the config key and the URL.2183 Omitted port numbers are automatically converted to the correct2184 default for the scheme before matching.21852186. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2187 path field of the config key must match the path field of the URL2188 either exactly or as a prefix of slash-delimited path elements. This means2189 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2190 match on a slash (`/`) boundary. Longer matches take precedence (so a config2191 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2192 key with just path `foo/`).21932194. User name (e.g., `user` in `https://user@example.com/repo.git`). If2195 the config key has a user name it must match the user name in the2196 URL exactly. If the config key does not have a user name, that2197 config key will match a URL with any user name (including none),2198 but at a lower precedence than a config key with a user name.2199--2200+2201The list above is ordered by decreasing precedence; a URL that matches2202a config key's path is preferred to one that matches its user name. For example,2203if the URL is `https://user@example.com/foo/bar` a config key match of2204`https://example.com/foo` will be preferred over a config key match of2205`https://user@example.com`.2206+2207All URLs are normalized before attempting any matching (the password part,2208if embedded in the URL, is always ignored for matching purposes) so that2209equivalent URLs that are simply spelled differently will match properly.2210Environment variable settings always override any matches. The URLs that are2211matched against are those given directly to Git commands. This means any URLs2212visited as a result of a redirection do not participate in matching.22132214ssh.variant::2215 By default, Git determines the command line arguments to use2216 based on the basename of the configured SSH command (configured2217 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2218 the config setting `core.sshCommand`). If the basename is2219 unrecognized, Git will attempt to detect support of OpenSSH2220 options by first invoking the configured SSH command with the2221 `-G` (print configuration) option and will subsequently use2222 OpenSSH options (if that is successful) or no options besides2223 the host and remote command (if it fails).2224+2225The config variable `ssh.variant` can be set to override this detection.2226Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2227`tortoiseplink`, `simple` (no options except the host and remote command).2228The default auto-detection can be explicitly requested using the value2229`auto`. Any other value is treated as `ssh`. This setting can also be2230overridden via the environment variable `GIT_SSH_VARIANT`.2231+2232The current command-line parameters used for each variant are as2233follows:2234+2235--22362237* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22382239* `simple` - [username@]host command22402241* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22422243* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22442245--2246+2247Except for the `simple` variant, command-line parameters are likely to2248change as git gains new features.22492250i18n.commitEncoding::2251 Character encoding the commit messages are stored in; Git itself2252 does not care per se, but this information is necessary e.g. when2253 importing commits from emails or in the gitk graphical history2254 browser (and possibly at other places in the future or in other2255 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22562257i18n.logOutputEncoding::2258 Character encoding the commit messages are converted to when2259 running 'git log' and friends.22602261imap::2262 The configuration variables in the 'imap' section are described2263 in linkgit:git-imap-send[1].22642265index.version::2266 Specify the version with which new index files should be2267 initialized. This does not affect existing repositories.22682269init.templateDir::2270 Specify the directory from which templates will be copied.2271 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22722273instaweb.browser::2274 Specify the program that will be used to browse your working2275 repository in gitweb. See linkgit:git-instaweb[1].22762277instaweb.httpd::2278 The HTTP daemon command-line to start gitweb on your working2279 repository. See linkgit:git-instaweb[1].22802281instaweb.local::2282 If true the web server started by linkgit:git-instaweb[1] will2283 be bound to the local IP (127.0.0.1).22842285instaweb.modulePath::2286 The default module path for linkgit:git-instaweb[1] to use2287 instead of /usr/lib/apache2/modules. Only used if httpd2288 is Apache.22892290instaweb.port::2291 The port number to bind the gitweb httpd to. See2292 linkgit:git-instaweb[1].22932294interactive.singleKey::2295 In interactive commands, allow the user to provide one-letter2296 input with a single key (i.e., without hitting enter).2297 Currently this is used by the `--patch` mode of2298 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2299 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2300 setting is silently ignored if portable keystroke input2301 is not available; requires the Perl module Term::ReadKey.23022303interactive.diffFilter::2304 When an interactive command (such as `git add --patch`) shows2305 a colorized diff, git will pipe the diff through the shell2306 command defined by this configuration variable. The command may2307 mark up the diff further for human consumption, provided that it2308 retains a one-to-one correspondence with the lines in the2309 original diff. Defaults to disabled (no filtering).23102311log.abbrevCommit::2312 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2313 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2314 override this option with `--no-abbrev-commit`.23152316log.date::2317 Set the default date-time mode for the 'log' command.2318 Setting a value for log.date is similar to using 'git log''s2319 `--date` option. See linkgit:git-log[1] for details.23202321log.decorate::2322 Print out the ref names of any commits that are shown by the log2323 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2324 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2325 specified, the full ref name (including prefix) will be printed.2326 If 'auto' is specified, then if the output is going to a terminal,2327 the ref names are shown as if 'short' were given, otherwise no ref2328 names are shown. This is the same as the `--decorate` option2329 of the `git log`.23302331log.follow::2332 If `true`, `git log` will act as if the `--follow` option was used when2333 a single <path> is given. This has the same limitations as `--follow`,2334 i.e. it cannot be used to follow multiple files and does not work well2335 on non-linear history.23362337log.graphColors::2338 A list of colors, separated by commas, that can be used to draw2339 history lines in `git log --graph`.23402341log.showRoot::2342 If true, the initial commit will be shown as a big creation event.2343 This is equivalent to a diff against an empty tree.2344 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2345 normally hide the root commit will now show it. True by default.23462347log.showSignature::2348 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2349 linkgit:git-whatchanged[1] assume `--show-signature`.23502351log.mailmap::2352 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2353 linkgit:git-whatchanged[1] assume `--use-mailmap`.23542355mailinfo.scissors::2356 If true, makes linkgit:git-mailinfo[1] (and therefore2357 linkgit:git-am[1]) act by default as if the --scissors option2358 was provided on the command-line. When active, this features2359 removes everything from the message body before a scissors2360 line (i.e. consisting mainly of ">8", "8<" and "-").23612362mailmap.file::2363 The location of an augmenting mailmap file. The default2364 mailmap, located in the root of the repository, is loaded2365 first, then the mailmap file pointed to by this variable.2366 The location of the mailmap file may be in a repository2367 subdirectory, or somewhere outside of the repository itself.2368 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23692370mailmap.blob::2371 Like `mailmap.file`, but consider the value as a reference to a2372 blob in the repository. If both `mailmap.file` and2373 `mailmap.blob` are given, both are parsed, with entries from2374 `mailmap.file` taking precedence. In a bare repository, this2375 defaults to `HEAD:.mailmap`. In a non-bare repository, it2376 defaults to empty.23772378man.viewer::2379 Specify the programs that may be used to display help in the2380 'man' format. See linkgit:git-help[1].23812382man.<tool>.cmd::2383 Specify the command to invoke the specified man viewer. The2384 specified command is evaluated in shell with the man page2385 passed as argument. (See linkgit:git-help[1].)23862387man.<tool>.path::2388 Override the path for the given tool that may be used to2389 display help in the 'man' format. See linkgit:git-help[1].23902391include::merge-config.txt[]23922393mergetool.<tool>.path::2394 Override the path for the given tool. This is useful in case2395 your tool is not in the PATH.23962397mergetool.<tool>.cmd::2398 Specify the command to invoke the specified merge tool. The2399 specified command is evaluated in shell with the following2400 variables available: 'BASE' is the name of a temporary file2401 containing the common base of the files to be merged, if available;2402 'LOCAL' is the name of a temporary file containing the contents of2403 the file on the current branch; 'REMOTE' is the name of a temporary2404 file containing the contents of the file from the branch being2405 merged; 'MERGED' contains the name of the file to which the merge2406 tool should write the results of a successful merge.24072408mergetool.<tool>.trustExitCode::2409 For a custom merge command, specify whether the exit code of2410 the merge command can be used to determine whether the merge was2411 successful. If this is not set to true then the merge target file2412 timestamp is checked and the merge assumed to have been successful2413 if the file has been updated, otherwise the user is prompted to2414 indicate the success of the merge.24152416mergetool.meld.hasOutput::2417 Older versions of `meld` do not support the `--output` option.2418 Git will attempt to detect whether `meld` supports `--output`2419 by inspecting the output of `meld --help`. Configuring2420 `mergetool.meld.hasOutput` will make Git skip these checks and2421 use the configured value instead. Setting `mergetool.meld.hasOutput`2422 to `true` tells Git to unconditionally use the `--output` option,2423 and `false` avoids using `--output`.24242425mergetool.keepBackup::2426 After performing a merge, the original file with conflict markers2427 can be saved as a file with a `.orig` extension. If this variable2428 is set to `false` then this file is not preserved. Defaults to2429 `true` (i.e. keep the backup files).24302431mergetool.keepTemporaries::2432 When invoking a custom merge tool, Git uses a set of temporary2433 files to pass to the tool. If the tool returns an error and this2434 variable is set to `true`, then these temporary files will be2435 preserved, otherwise they will be removed after the tool has2436 exited. Defaults to `false`.24372438mergetool.writeToTemp::2439 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2440 conflicting files in the worktree by default. Git will attempt2441 to use a temporary directory for these files when set `true`.2442 Defaults to `false`.24432444mergetool.prompt::2445 Prompt before each invocation of the merge resolution program.24462447notes.mergeStrategy::2448 Which merge strategy to choose by default when resolving notes2449 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2450 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2451 section of linkgit:git-notes[1] for more information on each strategy.24522453notes.<name>.mergeStrategy::2454 Which merge strategy to choose when doing a notes merge into2455 refs/notes/<name>. This overrides the more general2456 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2457 linkgit:git-notes[1] for more information on the available strategies.24582459notes.displayRef::2460 The (fully qualified) refname from which to show notes when2461 showing commit messages. The value of this variable can be set2462 to a glob, in which case notes from all matching refs will be2463 shown. You may also specify this configuration variable2464 several times. A warning will be issued for refs that do not2465 exist, but a glob that does not match any refs is silently2466 ignored.2467+2468This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2469environment variable, which must be a colon separated list of refs or2470globs.2471+2472The effective value of "core.notesRef" (possibly overridden by2473GIT_NOTES_REF) is also implicitly added to the list of refs to be2474displayed.24752476notes.rewrite.<command>::2477 When rewriting commits with <command> (currently `amend` or2478 `rebase`) and this variable is set to `true`, Git2479 automatically copies your notes from the original to the2480 rewritten commit. Defaults to `true`, but see2481 "notes.rewriteRef" below.24822483notes.rewriteMode::2484 When copying notes during a rewrite (see the2485 "notes.rewrite.<command>" option), determines what to do if2486 the target commit already has a note. Must be one of2487 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2488 Defaults to `concatenate`.2489+2490This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2491environment variable.24922493notes.rewriteRef::2494 When copying notes during a rewrite, specifies the (fully2495 qualified) ref whose notes should be copied. The ref may be a2496 glob, in which case notes in all matching refs will be copied.2497 You may also specify this configuration several times.2498+2499Does not have a default value; you must configure this variable to2500enable note rewriting. Set it to `refs/notes/commits` to enable2501rewriting for the default commit notes.2502+2503This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2504environment variable, which must be a colon separated list of refs or2505globs.25062507pack.window::2508 The size of the window used by linkgit:git-pack-objects[1] when no2509 window size is given on the command line. Defaults to 10.25102511pack.depth::2512 The maximum delta depth used by linkgit:git-pack-objects[1] when no2513 maximum depth is given on the command line. Defaults to 50.2514 Maximum value is 4095.25152516pack.windowMemory::2517 The maximum size of memory that is consumed by each thread2518 in linkgit:git-pack-objects[1] for pack window memory when2519 no limit is given on the command line. The value can be2520 suffixed with "k", "m", or "g". When left unconfigured (or2521 set explicitly to 0), there will be no limit.25222523pack.compression::2524 An integer -1..9, indicating the compression level for objects2525 in a pack file. -1 is the zlib default. 0 means no2526 compression, and 1..9 are various speed/size tradeoffs, 9 being2527 slowest. If not set, defaults to core.compression. If that is2528 not set, defaults to -1, the zlib default, which is "a default2529 compromise between speed and compression (currently equivalent2530 to level 6)."2531+2532Note that changing the compression level will not automatically recompress2533all existing objects. You can force recompression by passing the -F option2534to linkgit:git-repack[1].25352536pack.deltaCacheSize::2537 The maximum memory in bytes used for caching deltas in2538 linkgit:git-pack-objects[1] before writing them out to a pack.2539 This cache is used to speed up the writing object phase by not2540 having to recompute the final delta result once the best match2541 for all objects is found. Repacking large repositories on machines2542 which are tight with memory might be badly impacted by this though,2543 especially if this cache pushes the system into swapping.2544 A value of 0 means no limit. The smallest size of 1 byte may be2545 used to virtually disable this cache. Defaults to 256 MiB.25462547pack.deltaCacheLimit::2548 The maximum size of a delta, that is cached in2549 linkgit:git-pack-objects[1]. This cache is used to speed up the2550 writing object phase by not having to recompute the final delta2551 result once the best match for all objects is found.2552 Defaults to 1000. Maximum value is 65535.25532554pack.threads::2555 Specifies the number of threads to spawn when searching for best2556 delta matches. This requires that linkgit:git-pack-objects[1]2557 be compiled with pthreads otherwise this option is ignored with a2558 warning. This is meant to reduce packing time on multiprocessor2559 machines. The required amount of memory for the delta search window2560 is however multiplied by the number of threads.2561 Specifying 0 will cause Git to auto-detect the number of CPU's2562 and set the number of threads accordingly.25632564pack.indexVersion::2565 Specify the default pack index version. Valid values are 1 for2566 legacy pack index used by Git versions prior to 1.5.2, and 2 for2567 the new pack index with capabilities for packs larger than 4 GB2568 as well as proper protection against the repacking of corrupted2569 packs. Version 2 is the default. Note that version 2 is enforced2570 and this config option ignored whenever the corresponding pack is2571 larger than 2 GB.2572+2573If you have an old Git that does not understand the version 2 `*.idx` file,2574cloning or fetching over a non native protocol (e.g. "http")2575that will copy both `*.pack` file and corresponding `*.idx` file from the2576other side may give you a repository that cannot be accessed with your2577older version of Git. If the `*.pack` file is smaller than 2 GB, however,2578you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2579the `*.idx` file.25802581pack.packSizeLimit::2582 The maximum size of a pack. This setting only affects2583 packing to a file when repacking, i.e. the git:// protocol2584 is unaffected. It can be overridden by the `--max-pack-size`2585 option of linkgit:git-repack[1]. Reaching this limit results2586 in the creation of multiple packfiles; which in turn prevents2587 bitmaps from being created.2588 The minimum size allowed is limited to 1 MiB.2589 The default is unlimited.2590 Common unit suffixes of 'k', 'm', or 'g' are2591 supported.25922593pack.useBitmaps::2594 When true, git will use pack bitmaps (if available) when packing2595 to stdout (e.g., during the server side of a fetch). Defaults to2596 true. You should not generally need to turn this off unless2597 you are debugging pack bitmaps.25982599pack.writeBitmaps (deprecated)::2600 This is a deprecated synonym for `repack.writeBitmaps`.26012602pack.writeBitmapHashCache::2603 When true, git will include a "hash cache" section in the bitmap2604 index (if one is written). This cache can be used to feed git's2605 delta heuristics, potentially leading to better deltas between2606 bitmapped and non-bitmapped objects (e.g., when serving a fetch2607 between an older, bitmapped pack and objects that have been2608 pushed since the last gc). The downside is that it consumes 42609 bytes per object of disk space, and that JGit's bitmap2610 implementation does not understand it, causing it to complain if2611 Git and JGit are used on the same repository. Defaults to false.26122613pager.<cmd>::2614 If the value is boolean, turns on or off pagination of the2615 output of a particular Git subcommand when writing to a tty.2616 Otherwise, turns on pagination for the subcommand using the2617 pager specified by the value of `pager.<cmd>`. If `--paginate`2618 or `--no-pager` is specified on the command line, it takes2619 precedence over this option. To disable pagination for all2620 commands, set `core.pager` or `GIT_PAGER` to `cat`.26212622pretty.<name>::2623 Alias for a --pretty= format string, as specified in2624 linkgit:git-log[1]. Any aliases defined here can be used just2625 as the built-in pretty formats could. For example,2626 running `git config pretty.changelog "format:* %H %s"`2627 would cause the invocation `git log --pretty=changelog`2628 to be equivalent to running `git log "--pretty=format:* %H %s"`.2629 Note that an alias with the same name as a built-in format2630 will be silently ignored.26312632protocol.allow::2633 If set, provide a user defined default policy for all protocols which2634 don't explicitly have a policy (`protocol.<name>.allow`). By default,2635 if unset, known-safe protocols (http, https, git, ssh, file) have a2636 default policy of `always`, known-dangerous protocols (ext) have a2637 default policy of `never`, and all other protocols have a default2638 policy of `user`. Supported policies:2639+2640--26412642* `always` - protocol is always able to be used.26432644* `never` - protocol is never able to be used.26452646* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2647 either unset or has a value of 1. This policy should be used when you want a2648 protocol to be directly usable by the user but don't want it used by commands which2649 execute clone/fetch/push commands without user input, e.g. recursive2650 submodule initialization.26512652--26532654protocol.<name>.allow::2655 Set a policy to be used by protocol `<name>` with clone/fetch/push2656 commands. See `protocol.allow` above for the available policies.2657+2658The protocol names currently used by git are:2659+2660--2661 - `file`: any local file-based path (including `file://` URLs,2662 or local paths)26632664 - `git`: the anonymous git protocol over a direct TCP2665 connection (or proxy, if configured)26662667 - `ssh`: git over ssh (including `host:path` syntax,2668 `ssh://`, etc).26692670 - `http`: git over http, both "smart http" and "dumb http".2671 Note that this does _not_ include `https`; if you want to configure2672 both, you must do so individually.26732674 - any external helpers are named by their protocol (e.g., use2675 `hg` to allow the `git-remote-hg` helper)2676--26772678protocol.version::2679 Experimental. If set, clients will attempt to communicate with a2680 server using the specified protocol version. If unset, no2681 attempt will be made by the client to communicate using a2682 particular protocol version, this results in protocol version 02683 being used.2684 Supported versions:2685+2686--26872688* `0` - the original wire protocol.26892690* `1` - the original wire protocol with the addition of a version string2691 in the initial response from the server.26922693--26942695pull.ff::2696 By default, Git does not create an extra merge commit when merging2697 a commit that is a descendant of the current commit. Instead, the2698 tip of the current branch is fast-forwarded. When set to `false`,2699 this variable tells Git to create an extra merge commit in such2700 a case (equivalent to giving the `--no-ff` option from the command2701 line). When set to `only`, only such fast-forward merges are2702 allowed (equivalent to giving the `--ff-only` option from the2703 command line). This setting overrides `merge.ff` when pulling.27042705pull.rebase::2706 When true, rebase branches on top of the fetched branch, instead2707 of merging the default branch from the default remote when "git2708 pull" is run. See "branch.<name>.rebase" for setting this on a2709 per-branch basis.2710+2711When `merges`, pass the `--rebase-merges` option to 'git rebase'2712so that the local merge commits are included in the rebase (see2713linkgit:git-rebase[1] for details).2714+2715When preserve, also pass `--preserve-merges` along to 'git rebase'2716so that locally committed merge commits will not be flattened2717by running 'git pull'.2718+2719When the value is `interactive`, the rebase is run in interactive mode.2720+2721*NOTE*: this is a possibly dangerous operation; do *not* use2722it unless you understand the implications (see linkgit:git-rebase[1]2723for details).27242725pull.octopus::2726 The default merge strategy to use when pulling multiple branches2727 at once.27282729pull.twohead::2730 The default merge strategy to use when pulling a single branch.27312732push.default::2733 Defines the action `git push` should take if no refspec is2734 explicitly given. Different values are well-suited for2735 specific workflows; for instance, in a purely central workflow2736 (i.e. the fetch source is equal to the push destination),2737 `upstream` is probably what you want. Possible values are:2738+2739--27402741* `nothing` - do not push anything (error out) unless a refspec is2742 explicitly given. This is primarily meant for people who want to2743 avoid mistakes by always being explicit.27442745* `current` - push the current branch to update a branch with the same2746 name on the receiving end. Works in both central and non-central2747 workflows.27482749* `upstream` - push the current branch back to the branch whose2750 changes are usually integrated into the current branch (which is2751 called `@{upstream}`). This mode only makes sense if you are2752 pushing to the same repository you would normally pull from2753 (i.e. central workflow).27542755* `tracking` - This is a deprecated synonym for `upstream`.27562757* `simple` - in centralized workflow, work like `upstream` with an2758 added safety to refuse to push if the upstream branch's name is2759 different from the local one.2760+2761When pushing to a remote that is different from the remote you normally2762pull from, work as `current`. This is the safest option and is suited2763for beginners.2764+2765This mode has become the default in Git 2.0.27662767* `matching` - push all branches having the same name on both ends.2768 This makes the repository you are pushing to remember the set of2769 branches that will be pushed out (e.g. if you always push 'maint'2770 and 'master' there and no other branches, the repository you push2771 to will have these two branches, and your local 'maint' and2772 'master' will be pushed there).2773+2774To use this mode effectively, you have to make sure _all_ the2775branches you would push out are ready to be pushed out before2776running 'git push', as the whole point of this mode is to allow you2777to push all of the branches in one go. If you usually finish work2778on only one branch and push out the result, while other branches are2779unfinished, this mode is not for you. Also this mode is not2780suitable for pushing into a shared central repository, as other2781people may add new branches there, or update the tip of existing2782branches outside your control.2783+2784This used to be the default, but not since Git 2.0 (`simple` is the2785new default).27862787--27882789push.followTags::2790 If set to true enable `--follow-tags` option by default. You2791 may override this configuration at time of push by specifying2792 `--no-follow-tags`.27932794push.gpgSign::2795 May be set to a boolean value, or the string 'if-asked'. A true2796 value causes all pushes to be GPG signed, as if `--signed` is2797 passed to linkgit:git-push[1]. The string 'if-asked' causes2798 pushes to be signed if the server supports it, as if2799 `--signed=if-asked` is passed to 'git push'. A false value may2800 override a value from a lower-priority config file. An explicit2801 command-line flag always overrides this config option.28022803push.pushOption::2804 When no `--push-option=<option>` argument is given from the2805 command line, `git push` behaves as if each <value> of2806 this variable is given as `--push-option=<value>`.2807+2808This is a multi-valued variable, and an empty value can be used in a2809higher priority configuration file (e.g. `.git/config` in a2810repository) to clear the values inherited from a lower priority2811configuration files (e.g. `$HOME/.gitconfig`).2812+2813--28142815Example:28162817/etc/gitconfig2818 push.pushoption = a2819 push.pushoption = b28202821~/.gitconfig2822 push.pushoption = c28232824repo/.git/config2825 push.pushoption =2826 push.pushoption = b28272828This will result in only b (a and c are cleared).28292830--28312832push.recurseSubmodules::2833 Make sure all submodule commits used by the revisions to be pushed2834 are available on a remote-tracking branch. If the value is 'check'2835 then Git will verify that all submodule commits that changed in the2836 revisions to be pushed are available on at least one remote of the2837 submodule. If any commits are missing, the push will be aborted and2838 exit with non-zero status. If the value is 'on-demand' then all2839 submodules that changed in the revisions to be pushed will be2840 pushed. If on-demand was not able to push all necessary revisions2841 it will also be aborted and exit with non-zero status. If the value2842 is 'no' then default behavior of ignoring submodules when pushing2843 is retained. You may override this configuration at time of push by2844 specifying '--recurse-submodules=check|on-demand|no'.28452846include::rebase-config.txt[]28472848receive.advertiseAtomic::2849 By default, git-receive-pack will advertise the atomic push2850 capability to its clients. If you don't want to advertise this2851 capability, set this variable to false.28522853receive.advertisePushOptions::2854 When set to true, git-receive-pack will advertise the push options2855 capability to its clients. False by default.28562857receive.autogc::2858 By default, git-receive-pack will run "git-gc --auto" after2859 receiving data from git-push and updating refs. You can stop2860 it by setting this variable to false.28612862receive.certNonceSeed::2863 By setting this variable to a string, `git receive-pack`2864 will accept a `git push --signed` and verifies it by using2865 a "nonce" protected by HMAC using this string as a secret2866 key.28672868receive.certNonceSlop::2869 When a `git push --signed` sent a push certificate with a2870 "nonce" that was issued by a receive-pack serving the same2871 repository within this many seconds, export the "nonce"2872 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2873 hooks (instead of what the receive-pack asked the sending2874 side to include). This may allow writing checks in2875 `pre-receive` and `post-receive` a bit easier. Instead of2876 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2877 that records by how many seconds the nonce is stale to2878 decide if they want to accept the certificate, they only2879 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28802881receive.fsckObjects::2882 If it is set to true, git-receive-pack will check all received2883 objects. It will abort in the case of a malformed object or a2884 broken link. The result of an abort are only dangling objects.2885 Defaults to false. If not set, the value of `transfer.fsckObjects`2886 is used instead.28872888receive.fsck.<msg-id>::2889 When `receive.fsckObjects` is set to true, errors can be switched2890 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2891 setting where the `<msg-id>` is the fsck message ID and the value2892 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2893 the error/warning with the message ID, e.g. "missingEmail: invalid2894 author/committer line - missing email" means that setting2895 `receive.fsck.missingEmail = ignore` will hide that issue.2896+2897This feature is intended to support working with legacy repositories2898which would not pass pushing when `receive.fsckObjects = true`, allowing2899the host to accept repositories with certain known issues but still catch2900other issues.29012902receive.fsck.skipList::2903 The path to a sorted list of object names (i.e. one SHA-1 per2904 line) that are known to be broken in a non-fatal way and should2905 be ignored. This feature is useful when an established project2906 should be accepted despite early commits containing errors that2907 can be safely ignored such as invalid committer email addresses.2908 Note: corrupt objects cannot be skipped with this setting.29092910receive.keepAlive::2911 After receiving the pack from the client, `receive-pack` may2912 produce no output (if `--quiet` was specified) while processing2913 the pack, causing some networks to drop the TCP connection.2914 With this option set, if `receive-pack` does not transmit2915 any data in this phase for `receive.keepAlive` seconds, it will2916 send a short keepalive packet. The default is 5 seconds; set2917 to 0 to disable keepalives entirely.29182919receive.unpackLimit::2920 If the number of objects received in a push is below this2921 limit then the objects will be unpacked into loose object2922 files. However if the number of received objects equals or2923 exceeds this limit then the received pack will be stored as2924 a pack, after adding any missing delta bases. Storing the2925 pack from a push can make the push operation complete faster,2926 especially on slow filesystems. If not set, the value of2927 `transfer.unpackLimit` is used instead.29282929receive.maxInputSize::2930 If the size of the incoming pack stream is larger than this2931 limit, then git-receive-pack will error out, instead of2932 accepting the pack file. If not set or set to 0, then the size2933 is unlimited.29342935receive.denyDeletes::2936 If set to true, git-receive-pack will deny a ref update that deletes2937 the ref. Use this to prevent such a ref deletion via a push.29382939receive.denyDeleteCurrent::2940 If set to true, git-receive-pack will deny a ref update that2941 deletes the currently checked out branch of a non-bare repository.29422943receive.denyCurrentBranch::2944 If set to true or "refuse", git-receive-pack will deny a ref update2945 to the currently checked out branch of a non-bare repository.2946 Such a push is potentially dangerous because it brings the HEAD2947 out of sync with the index and working tree. If set to "warn",2948 print a warning of such a push to stderr, but allow the push to2949 proceed. If set to false or "ignore", allow such pushes with no2950 message. Defaults to "refuse".2951+2952Another option is "updateInstead" which will update the working2953tree if pushing into the current branch. This option is2954intended for synchronizing working directories when one side is not easily2955accessible via interactive ssh (e.g. a live web site, hence the requirement2956that the working directory be clean). This mode also comes in handy when2957developing inside a VM to test and fix code on different Operating Systems.2958+2959By default, "updateInstead" will refuse the push if the working tree or2960the index have any difference from the HEAD, but the `push-to-checkout`2961hook can be used to customize this. See linkgit:githooks[5].29622963receive.denyNonFastForwards::2964 If set to true, git-receive-pack will deny a ref update which is2965 not a fast-forward. Use this to prevent such an update via a push,2966 even if that push is forced. This configuration variable is2967 set when initializing a shared repository.29682969receive.hideRefs::2970 This variable is the same as `transfer.hideRefs`, but applies2971 only to `receive-pack` (and so affects pushes, but not fetches).2972 An attempt to update or delete a hidden ref by `git push` is2973 rejected.29742975receive.updateServerInfo::2976 If set to true, git-receive-pack will run git-update-server-info2977 after receiving data from git-push and updating refs.29782979receive.shallowUpdate::2980 If set to true, .git/shallow can be updated when new refs2981 require new shallow roots. Otherwise those refs are rejected.29822983remote.pushDefault::2984 The remote to push to by default. Overrides2985 `branch.<name>.remote` for all branches, and is overridden by2986 `branch.<name>.pushRemote` for specific branches.29872988remote.<name>.url::2989 The URL of a remote repository. See linkgit:git-fetch[1] or2990 linkgit:git-push[1].29912992remote.<name>.pushurl::2993 The push URL of a remote repository. See linkgit:git-push[1].29942995remote.<name>.proxy::2996 For remotes that require curl (http, https and ftp), the URL to2997 the proxy to use for that remote. Set to the empty string to2998 disable proxying for that remote.29993000remote.<name>.proxyAuthMethod::3001 For remotes that require curl (http, https and ftp), the method to use for3002 authenticating against the proxy in use (probably set in3003 `remote.<name>.proxy`). See `http.proxyAuthMethod`.30043005remote.<name>.fetch::3006 The default set of "refspec" for linkgit:git-fetch[1]. See3007 linkgit:git-fetch[1].30083009remote.<name>.push::3010 The default set of "refspec" for linkgit:git-push[1]. See3011 linkgit:git-push[1].30123013remote.<name>.mirror::3014 If true, pushing to this remote will automatically behave3015 as if the `--mirror` option was given on the command line.30163017remote.<name>.skipDefaultUpdate::3018 If true, this remote will be skipped by default when updating3019 using linkgit:git-fetch[1] or the `update` subcommand of3020 linkgit:git-remote[1].30213022remote.<name>.skipFetchAll::3023 If true, this remote will be skipped by default when updating3024 using linkgit:git-fetch[1] or the `update` subcommand of3025 linkgit:git-remote[1].30263027remote.<name>.receivepack::3028 The default program to execute on the remote side when pushing. See3029 option --receive-pack of linkgit:git-push[1].30303031remote.<name>.uploadpack::3032 The default program to execute on the remote side when fetching. See3033 option --upload-pack of linkgit:git-fetch-pack[1].30343035remote.<name>.tagOpt::3036 Setting this value to --no-tags disables automatic tag following when3037 fetching from remote <name>. Setting it to --tags will fetch every3038 tag from remote <name>, even if they are not reachable from remote3039 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3040 override this setting. See options --tags and --no-tags of3041 linkgit:git-fetch[1].30423043remote.<name>.vcs::3044 Setting this to a value <vcs> will cause Git to interact with3045 the remote with the git-remote-<vcs> helper.30463047remote.<name>.prune::3048 When set to true, fetching from this remote by default will also3049 remove any remote-tracking references that no longer exist on the3050 remote (as if the `--prune` option was given on the command line).3051 Overrides `fetch.prune` settings, if any.30523053remote.<name>.pruneTags::3054 When set to true, fetching from this remote by default will also3055 remove any local tags that no longer exist on the remote if pruning3056 is activated in general via `remote.<name>.prune`, `fetch.prune` or3057 `--prune`. Overrides `fetch.pruneTags` settings, if any.3058+3059See also `remote.<name>.prune` and the PRUNING section of3060linkgit:git-fetch[1].30613062remotes.<group>::3063 The list of remotes which are fetched by "git remote update3064 <group>". See linkgit:git-remote[1].30653066repack.useDeltaBaseOffset::3067 By default, linkgit:git-repack[1] creates packs that use3068 delta-base offset. If you need to share your repository with3069 Git older than version 1.4.4, either directly or via a dumb3070 protocol such as http, then you need to set this option to3071 "false" and repack. Access from old Git versions over the3072 native protocol are unaffected by this option.30733074repack.packKeptObjects::3075 If set to true, makes `git repack` act as if3076 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3077 details. Defaults to `false` normally, but `true` if a bitmap3078 index is being written (either via `--write-bitmap-index` or3079 `repack.writeBitmaps`).30803081repack.writeBitmaps::3082 When true, git will write a bitmap index when packing all3083 objects to disk (e.g., when `git repack -a` is run). This3084 index can speed up the "counting objects" phase of subsequent3085 packs created for clones and fetches, at the cost of some disk3086 space and extra time spent on the initial repack. This has3087 no effect if multiple packfiles are created.3088 Defaults to false.30893090rerere.autoUpdate::3091 When set to true, `git-rerere` updates the index with the3092 resulting contents after it cleanly resolves conflicts using3093 previously recorded resolution. Defaults to false.30943095rerere.enabled::3096 Activate recording of resolved conflicts, so that identical3097 conflict hunks can be resolved automatically, should they be3098 encountered again. By default, linkgit:git-rerere[1] is3099 enabled if there is an `rr-cache` directory under the3100 `$GIT_DIR`, e.g. if "rerere" was previously used in the3101 repository.31023103sendemail.identity::3104 A configuration identity. When given, causes values in the3105 'sendemail.<identity>' subsection to take precedence over3106 values in the 'sendemail' section. The default identity is3107 the value of `sendemail.identity`.31083109sendemail.smtpEncryption::3110 See linkgit:git-send-email[1] for description. Note that this3111 setting is not subject to the 'identity' mechanism.31123113sendemail.smtpssl (deprecated)::3114 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31153116sendemail.smtpsslcertpath::3117 Path to ca-certificates (either a directory or a single file).3118 Set it to an empty string to disable certificate verification.31193120sendemail.<identity>.*::3121 Identity-specific versions of the 'sendemail.*' parameters3122 found below, taking precedence over those when this3123 identity is selected, through either the command-line or3124 `sendemail.identity`.31253126sendemail.aliasesFile::3127sendemail.aliasFileType::3128sendemail.annotate::3129sendemail.bcc::3130sendemail.cc::3131sendemail.ccCmd::3132sendemail.chainReplyTo::3133sendemail.confirm::3134sendemail.envelopeSender::3135sendemail.from::3136sendemail.multiEdit::3137sendemail.signedoffbycc::3138sendemail.smtpPass::3139sendemail.suppresscc::3140sendemail.suppressFrom::3141sendemail.to::3142sendemail.tocmd::3143sendemail.smtpDomain::3144sendemail.smtpServer::3145sendemail.smtpServerPort::3146sendemail.smtpServerOption::3147sendemail.smtpUser::3148sendemail.thread::3149sendemail.transferEncoding::3150sendemail.validate::3151sendemail.xmailer::3152 See linkgit:git-send-email[1] for description.31533154sendemail.signedoffcc (deprecated)::3155 Deprecated alias for `sendemail.signedoffbycc`.31563157sendemail.smtpBatchSize::3158 Number of messages to be sent per connection, after that a relogin3159 will happen. If the value is 0 or undefined, send all messages in3160 one connection.3161 See also the `--batch-size` option of linkgit:git-send-email[1].31623163sendemail.smtpReloginDelay::3164 Seconds wait before reconnecting to smtp server.3165 See also the `--relogin-delay` option of linkgit:git-send-email[1].31663167showbranch.default::3168 The default set of branches for linkgit:git-show-branch[1].3169 See linkgit:git-show-branch[1].31703171splitIndex.maxPercentChange::3172 When the split index feature is used, this specifies the3173 percent of entries the split index can contain compared to the3174 total number of entries in both the split index and the shared3175 index before a new shared index is written.3176 The value should be between 0 and 100. If the value is 0 then3177 a new shared index is always written, if it is 100 a new3178 shared index is never written.3179 By default the value is 20, so a new shared index is written3180 if the number of entries in the split index would be greater3181 than 20 percent of the total number of entries.3182 See linkgit:git-update-index[1].31833184splitIndex.sharedIndexExpire::3185 When the split index feature is used, shared index files that3186 were not modified since the time this variable specifies will3187 be removed when a new shared index file is created. The value3188 "now" expires all entries immediately, and "never" suppresses3189 expiration altogether.3190 The default value is "2.weeks.ago".3191 Note that a shared index file is considered modified (for the3192 purpose of expiration) each time a new split-index file is3193 either created based on it or read from it.3194 See linkgit:git-update-index[1].31953196status.relativePaths::3197 By default, linkgit:git-status[1] shows paths relative to the3198 current directory. Setting this variable to `false` shows paths3199 relative to the repository root (this was the default for Git3200 prior to v1.5.4).32013202status.short::3203 Set to true to enable --short by default in linkgit:git-status[1].3204 The option --no-short takes precedence over this variable.32053206status.branch::3207 Set to true to enable --branch by default in linkgit:git-status[1].3208 The option --no-branch takes precedence over this variable.32093210status.displayCommentPrefix::3211 If set to true, linkgit:git-status[1] will insert a comment3212 prefix before each output line (starting with3213 `core.commentChar`, i.e. `#` by default). This was the3214 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3215 Defaults to false.32163217status.renameLimit::3218 The number of files to consider when performing rename detection3219 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3220 the value of diff.renameLimit.32213222status.renames::3223 Whether and how Git detects renames in linkgit:git-status[1] and3224 linkgit:git-commit[1] . If set to "false", rename detection is3225 disabled. If set to "true", basic rename detection is enabled.3226 If set to "copies" or "copy", Git will detect copies, as well.3227 Defaults to the value of diff.renames.32283229status.showStash::3230 If set to true, linkgit:git-status[1] will display the number of3231 entries currently stashed away.3232 Defaults to false.32333234status.showUntrackedFiles::3235 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3236 files which are not currently tracked by Git. Directories which3237 contain only untracked files, are shown with the directory name3238 only. Showing untracked files means that Git needs to lstat() all3239 the files in the whole repository, which might be slow on some3240 systems. So, this variable controls how the commands displays3241 the untracked files. Possible values are:3242+3243--3244* `no` - Show no untracked files.3245* `normal` - Show untracked files and directories.3246* `all` - Show also individual files in untracked directories.3247--3248+3249If this variable is not specified, it defaults to 'normal'.3250This variable can be overridden with the -u|--untracked-files option3251of linkgit:git-status[1] and linkgit:git-commit[1].32523253status.submoduleSummary::3254 Defaults to false.3255 If this is set to a non zero number or true (identical to -1 or an3256 unlimited number), the submodule summary will be enabled and a3257 summary of commits for modified submodules will be shown (see3258 --summary-limit option of linkgit:git-submodule[1]). Please note3259 that the summary output command will be suppressed for all3260 submodules when `diff.ignoreSubmodules` is set to 'all' or only3261 for those submodules where `submodule.<name>.ignore=all`. The only3262 exception to that rule is that status and commit will show staged3263 submodule changes. To3264 also view the summary for ignored submodules you can either use3265 the --ignore-submodules=dirty command-line option or the 'git3266 submodule summary' command, which shows a similar output but does3267 not honor these settings.32683269stash.showPatch::3270 If this is set to true, the `git stash show` command without an3271 option will show the stash entry in patch form. Defaults to false.3272 See description of 'show' command in linkgit:git-stash[1].32733274stash.showStat::3275 If this is set to true, the `git stash show` command without an3276 option will show diffstat of the stash entry. Defaults to true.3277 See description of 'show' command in linkgit:git-stash[1].32783279submodule.<name>.url::3280 The URL for a submodule. This variable is copied from the .gitmodules3281 file to the git config via 'git submodule init'. The user can change3282 the configured URL before obtaining the submodule via 'git submodule3283 update'. If neither submodule.<name>.active or submodule.active are3284 set, the presence of this variable is used as a fallback to indicate3285 whether the submodule is of interest to git commands.3286 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32873288submodule.<name>.update::3289 The method by which a submodule is updated by 'git submodule update',3290 which is the only affected command, others such as3291 'git checkout --recurse-submodules' are unaffected. It exists for3292 historical reasons, when 'git submodule' was the only command to3293 interact with submodules; settings like `submodule.active`3294 and `pull.rebase` are more specific. It is populated by3295 `git submodule init` from the linkgit:gitmodules[5] file.3296 See description of 'update' command in linkgit:git-submodule[1].32973298submodule.<name>.branch::3299 The remote branch name for a submodule, used by `git submodule3300 update --remote`. Set this option to override the value found in3301 the `.gitmodules` file. See linkgit:git-submodule[1] and3302 linkgit:gitmodules[5] for details.33033304submodule.<name>.fetchRecurseSubmodules::3305 This option can be used to control recursive fetching of this3306 submodule. It can be overridden by using the --[no-]recurse-submodules3307 command-line option to "git fetch" and "git pull".3308 This setting will override that from in the linkgit:gitmodules[5]3309 file.33103311submodule.<name>.ignore::3312 Defines under what circumstances "git status" and the diff family show3313 a submodule as modified. When set to "all", it will never be considered3314 modified (but it will nonetheless show up in the output of status and3315 commit when it has been staged), "dirty" will ignore all changes3316 to the submodules work tree and3317 takes only differences between the HEAD of the submodule and the commit3318 recorded in the superproject into account. "untracked" will additionally3319 let submodules with modified tracked files in their work tree show up.3320 Using "none" (the default when this option is not set) also shows3321 submodules that have untracked files in their work tree as changed.3322 This setting overrides any setting made in .gitmodules for this submodule,3323 both settings can be overridden on the command line by using the3324 "--ignore-submodules" option. The 'git submodule' commands are not3325 affected by this setting.33263327submodule.<name>.active::3328 Boolean value indicating if the submodule is of interest to git3329 commands. This config option takes precedence over the3330 submodule.active config option.33313332submodule.active::3333 A repeated field which contains a pathspec used to match against a3334 submodule's path to determine if the submodule is of interest to git3335 commands.33363337submodule.recurse::3338 Specifies if commands recurse into submodules by default. This3339 applies to all commands that have a `--recurse-submodules` option,3340 except `clone`.3341 Defaults to false.33423343submodule.fetchJobs::3344 Specifies how many submodules are fetched/cloned at the same time.3345 A positive integer allows up to that number of submodules fetched3346 in parallel. A value of 0 will give some reasonable default.3347 If unset, it defaults to 1.33483349submodule.alternateLocation::3350 Specifies how the submodules obtain alternates when submodules are3351 cloned. Possible values are `no`, `superproject`.3352 By default `no` is assumed, which doesn't add references. When the3353 value is set to `superproject` the submodule to be cloned computes3354 its alternates location relative to the superprojects alternate.33553356submodule.alternateErrorStrategy::3357 Specifies how to treat errors with the alternates for a submodule3358 as computed via `submodule.alternateLocation`. Possible values are3359 `ignore`, `info`, `die`. Default is `die`.33603361tag.forceSignAnnotated::3362 A boolean to specify whether annotated tags created should be GPG signed.3363 If `--annotate` is specified on the command line, it takes3364 precedence over this option.33653366tag.sort::3367 This variable controls the sort ordering of tags when displayed by3368 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3369 value of this variable will be used as the default.33703371tar.umask::3372 This variable can be used to restrict the permission bits of3373 tar archive entries. The default is 0002, which turns off the3374 world write bit. The special value "user" indicates that the3375 archiving user's umask will be used instead. See umask(2) and3376 linkgit:git-archive[1].33773378transfer.fsckObjects::3379 When `fetch.fsckObjects` or `receive.fsckObjects` are3380 not set, the value of this variable is used instead.3381 Defaults to false.33823383transfer.hideRefs::3384 String(s) `receive-pack` and `upload-pack` use to decide which3385 refs to omit from their initial advertisements. Use more than3386 one definition to specify multiple prefix strings. A ref that is3387 under the hierarchies listed in the value of this variable is3388 excluded, and is hidden when responding to `git push` or `git3389 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3390 program-specific versions of this config.3391+3392You may also include a `!` in front of the ref name to negate the entry,3393explicitly exposing it, even if an earlier entry marked it as hidden.3394If you have multiple hideRefs values, later entries override earlier ones3395(and entries in more-specific config files override less-specific ones).3396+3397If a namespace is in use, the namespace prefix is stripped from each3398reference before it is matched against `transfer.hiderefs` patterns.3399For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3400the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3401is omitted from the advertisements but `refs/heads/master` and3402`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3403"have" lines. In order to match refs before stripping, add a `^` in front of3404the ref name. If you combine `!` and `^`, `!` must be specified first.3405+3406Even if you hide refs, a client may still be able to steal the target3407objects via the techniques described in the "SECURITY" section of the3408linkgit:gitnamespaces[7] man page; it's best to keep private data in a3409separate repository.34103411transfer.unpackLimit::3412 When `fetch.unpackLimit` or `receive.unpackLimit` are3413 not set, the value of this variable is used instead.3414 The default value is 100.34153416uploadarchive.allowUnreachable::3417 If true, allow clients to use `git archive --remote` to request3418 any tree, whether reachable from the ref tips or not. See the3419 discussion in the "SECURITY" section of3420 linkgit:git-upload-archive[1] for more details. Defaults to3421 `false`.34223423uploadpack.hideRefs::3424 This variable is the same as `transfer.hideRefs`, but applies3425 only to `upload-pack` (and so affects only fetches, not pushes).3426 An attempt to fetch a hidden ref by `git fetch` will fail. See3427 also `uploadpack.allowTipSHA1InWant`.34283429uploadpack.allowTipSHA1InWant::3430 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3431 to accept a fetch request that asks for an object at the tip3432 of a hidden ref (by default, such a request is rejected).3433 See also `uploadpack.hideRefs`. Even if this is false, a client3434 may be able to steal objects via the techniques described in the3435 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3436 best to keep private data in a separate repository.34373438uploadpack.allowReachableSHA1InWant::3439 Allow `upload-pack` to accept a fetch request that asks for an3440 object that is reachable from any ref tip. However, note that3441 calculating object reachability is computationally expensive.3442 Defaults to `false`. Even if this is false, a client may be able3443 to steal objects via the techniques described in the "SECURITY"3444 section of the linkgit:gitnamespaces[7] man page; it's best to3445 keep private data in a separate repository.34463447uploadpack.allowAnySHA1InWant::3448 Allow `upload-pack` to accept a fetch request that asks for any3449 object at all.3450 Defaults to `false`.34513452uploadpack.keepAlive::3453 When `upload-pack` has started `pack-objects`, there may be a3454 quiet period while `pack-objects` prepares the pack. Normally3455 it would output progress information, but if `--quiet` was used3456 for the fetch, `pack-objects` will output nothing at all until3457 the pack data begins. Some clients and networks may consider3458 the server to be hung and give up. Setting this option instructs3459 `upload-pack` to send an empty keepalive packet every3460 `uploadpack.keepAlive` seconds. Setting this option to 03461 disables keepalive packets entirely. The default is 5 seconds.34623463uploadpack.packObjectsHook::3464 If this option is set, when `upload-pack` would run3465 `git pack-objects` to create a packfile for a client, it will3466 run this shell command instead. The `pack-objects` command and3467 arguments it _would_ have run (including the `git pack-objects`3468 at the beginning) are appended to the shell command. The stdin3469 and stdout of the hook are treated as if `pack-objects` itself3470 was run. I.e., `upload-pack` will feed input intended for3471 `pack-objects` to the hook, and expects a completed packfile on3472 stdout.34733474uploadpack.allowFilter::3475 If this option is set, `upload-pack` will support partial3476 clone and partial fetch object filtering.3477+3478Note that this configuration variable is ignored if it is seen in the3479repository-level config (this is a safety measure against fetching from3480untrusted repositories).34813482url.<base>.insteadOf::3483 Any URL that starts with this value will be rewritten to3484 start, instead, with <base>. In cases where some site serves a3485 large number of repositories, and serves them with multiple3486 access methods, and some users need to use different access3487 methods, this feature allows people to specify any of the3488 equivalent URLs and have Git automatically rewrite the URL to3489 the best alternative for the particular user, even for a3490 never-before-seen repository on the site. When more than one3491 insteadOf strings match a given URL, the longest match is used.3492+3493Note that any protocol restrictions will be applied to the rewritten3494URL. If the rewrite changes the URL to use a custom protocol or remote3495helper, you may need to adjust the `protocol.*.allow` config to permit3496the request. In particular, protocols you expect to use for submodules3497must be set to `always` rather than the default of `user`. See the3498description of `protocol.allow` above.34993500url.<base>.pushInsteadOf::3501 Any URL that starts with this value will not be pushed to;3502 instead, it will be rewritten to start with <base>, and the3503 resulting URL will be pushed to. In cases where some site serves3504 a large number of repositories, and serves them with multiple3505 access methods, some of which do not allow push, this feature3506 allows people to specify a pull-only URL and have Git3507 automatically use an appropriate URL to push, even for a3508 never-before-seen repository on the site. When more than one3509 pushInsteadOf strings match a given URL, the longest match is3510 used. If a remote has an explicit pushurl, Git will ignore this3511 setting for that remote.35123513user.email::3514 Your email address to be recorded in any newly created commits.3515 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3516 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35173518user.name::3519 Your full name to be recorded in any newly created commits.3520 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3521 environment variables. See linkgit:git-commit-tree[1].35223523user.useConfigOnly::3524 Instruct Git to avoid trying to guess defaults for `user.email`3525 and `user.name`, and instead retrieve the values only from the3526 configuration. For example, if you have multiple email addresses3527 and would like to use a different one for each repository, then3528 with this configuration option set to `true` in the global config3529 along with a name, Git will prompt you to set up an email before3530 making new commits in a newly cloned repository.3531 Defaults to `false`.35323533user.signingKey::3534 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3535 key you want it to automatically when creating a signed tag or3536 commit, you can override the default selection with this variable.3537 This option is passed unchanged to gpg's --local-user parameter,3538 so you may specify a key using any method that gpg supports.35393540versionsort.prereleaseSuffix (deprecated)::3541 Deprecated alias for `versionsort.suffix`. Ignored if3542 `versionsort.suffix` is set.35433544versionsort.suffix::3545 Even when version sort is used in linkgit:git-tag[1], tagnames3546 with the same base version but different suffixes are still sorted3547 lexicographically, resulting e.g. in prerelease tags appearing3548 after the main release (e.g. "1.0-rc1" after "1.0"). This3549 variable can be specified to determine the sorting order of tags3550 with different suffixes.3551+3552By specifying a single suffix in this variable, any tagname containing3553that suffix will appear before the corresponding main release. E.g. if3554the variable is set to "-rc", then all "1.0-rcX" tags will appear before3555"1.0". If specified multiple times, once per suffix, then the order of3556suffixes in the configuration will determine the sorting order of tagnames3557with those suffixes. E.g. if "-pre" appears before "-rc" in the3558configuration, then all "1.0-preX" tags will be listed before any3559"1.0-rcX" tags. The placement of the main release tag relative to tags3560with various suffixes can be determined by specifying the empty suffix3561among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3562"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3563are listed first, followed by "v4.8", then "v4.8-ckX" and finally3564"v4.8-bfsX".3565+3566If more than one suffixes match the same tagname, then that tagname will3567be sorted according to the suffix which starts at the earliest position in3568the tagname. If more than one different matching suffixes start at3569that earliest position, then that tagname will be sorted according to the3570longest of those suffixes.3571The sorting order between different suffixes is undefined if they are3572in multiple config files.35733574web.browser::3575 Specify a web browser that may be used by some commands.3576 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3577 may use it.35783579worktree.guessRemote::3580 With `add`, if no branch argument, and neither of `-b` nor3581 `-B` nor `--detach` are given, the command defaults to3582 creating a new branch from HEAD. If `worktree.guessRemote` is3583 set to true, `worktree add` tries to find a remote-tracking3584 branch whose name uniquely matches the new branch name. If3585 such a branch exists, it is checked out and set as "upstream"3586 for the new branch. If no such match can be found, it falls3587 back to creating a new branch from the current HEAD.