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 checkoutAmbiguousRemoteBranchName:: 348 Advice shown when the argument to 349 linkgit:git-checkout[1] ambiguously resolves to a 350 remote tracking branch on more than one remote in 351 situations where an unambiguous argument would have 352 otherwise caused a remote-tracking branch to be 353 checked out. See the `checkout.defaultRemote` 354 configuration variable for how to set a given remote 355 to used by default in some situations where this 356 advice would be printed. 357 amWorkDir:: 358 Advice that shows the location of the patch file when 359 linkgit:git-am[1] fails to apply it. 360 rmHints:: 361 In case of failure in the output of linkgit:git-rm[1], 362 show directions on how to proceed from the current state. 363 addEmbeddedRepo:: 364 Advice on what to do when you've accidentally added one 365 git repo inside of another. 366 ignoredHook:: 367 Advice shown if a hook is ignored because the hook is not 368 set as executable. 369 waitingForEditor:: 370 Print a message to the terminal whenever Git is waiting for 371 editor input from the user. 372-- 373 374core.fileMode:: 375 Tells Git if the executable bit of files in the working tree 376 is to be honored. 377+ 378Some filesystems lose the executable bit when a file that is 379marked as executable is checked out, or checks out a 380non-executable file with executable bit on. 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 382to see if it handles the executable bit correctly 383and this variable is automatically set as necessary. 384+ 385A repository, however, may be on a filesystem that handles 386the filemode correctly, and this variable is set to 'true' 387when created, but later may be made accessible from another 388environment that loses the filemode (e.g. exporting ext4 via 389CIFS mount, visiting a Cygwin created repository with 390Git for Windows or Eclipse). 391In such a case it may be necessary to set this variable to 'false'. 392See linkgit:git-update-index[1]. 393+ 394The default is true (when core.filemode is not specified in the config file). 395 396core.hideDotFiles:: 397 (Windows-only) If true, mark newly-created directories and files whose 398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 399 directory is hidden, but no other files starting with a dot. The 400 default mode is 'dotGitOnly'. 401 402core.ignoreCase:: 403 Internal variable which enables various workarounds to enable 404 Git to work better on filesystems that are not case sensitive, 405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 406 finds "makefile" when Git expects "Makefile", Git will assume 407 it is really the same file, and continue to remember it as 408 "Makefile". 409+ 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 411will probe and set core.ignoreCase true if appropriate when the repository 412is created. 413+ 414Git relies on the proper configuration of this variable for your operating 415and file system. Modifying this value may result in unexpected behavior. 416 417core.precomposeUnicode:: 418 This option is only used by Mac OS implementation of Git. 419 When core.precomposeUnicode=true, Git reverts the unicode decomposition 420 of filenames done by Mac OS. This is useful when sharing a repository 421 between Mac OS and Linux or Windows. 422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 423 When false, file names are handled fully transparent by Git, 424 which is backward compatible with older versions of Git. 425 426core.protectHFS:: 427 If set to true, do not allow checkout of paths that would 428 be considered equivalent to `.git` on an HFS+ filesystem. 429 Defaults to `true` on Mac OS, and `false` elsewhere. 430 431core.protectNTFS:: 432 If set to true, do not allow checkout of paths that would 433 cause problems with the NTFS filesystem, e.g. conflict with 434 8.3 "short" names. 435 Defaults to `true` on Windows, and `false` elsewhere. 436 437core.fsmonitor:: 438 If set, the value of this variable is used as a command which 439 will identify all files that may have changed since the 440 requested date/time. This information is used to speed up git by 441 avoiding unnecessary processing of files that have not changed. 442 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 443 444core.trustctime:: 445 If false, the ctime differences between the index and the 446 working tree are ignored; useful when the inode change time 447 is regularly modified by something outside Git (file system 448 crawlers and some backup systems). 449 See linkgit:git-update-index[1]. True by default. 450 451core.splitIndex:: 452 If true, the split-index feature of the index will be used. 453 See linkgit:git-update-index[1]. False by default. 454 455core.untrackedCache:: 456 Determines what to do about the untracked cache feature of the 457 index. It will be kept, if this variable is unset or set to 458 `keep`. It will automatically be added if set to `true`. And 459 it will automatically be removed, if set to `false`. Before 460 setting it to `true`, you should check that mtime is working 461 properly on your system. 462 See linkgit:git-update-index[1]. `keep` by default. 463 464core.checkStat:: 465 Determines which stat fields to match between the index 466 and work tree. The user can set this to 'default' or 467 'minimal'. Default (or explicitly 'default'), is to check 468 all fields, including the sub-second part of mtime and ctime. 469 470core.quotePath:: 471 Commands that output paths (e.g. 'ls-files', 'diff'), will 472 quote "unusual" characters in the pathname by enclosing the 473 pathname in double-quotes and escaping those characters with 474 backslashes in the same way C escapes control characters (e.g. 475 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 476 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 477 UTF-8). If this variable is set to false, bytes higher than 478 0x80 are not considered "unusual" any more. Double-quotes, 479 backslash and control characters are always escaped regardless 480 of the setting of this variable. A simple space character is 481 not considered "unusual". Many commands can output pathnames 482 completely verbatim using the `-z` option. The default value 483 is true. 484 485core.eol:: 486 Sets the line ending type to use in the working directory for 487 files that have the `text` property set when core.autocrlf is false. 488 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 489 native line ending. The default value is `native`. See 490 linkgit:gitattributes[5] for more information on end-of-line 491 conversion. 492 493core.safecrlf:: 494 If true, makes Git check if converting `CRLF` is reversible when 495 end-of-line conversion is active. Git will verify if a command 496 modifies a file in the work tree either directly or indirectly. 497 For example, committing a file followed by checking out the 498 same file should yield the original file in the work tree. If 499 this is not the case for the current setting of 500 `core.autocrlf`, Git will reject the file. The variable can 501 be set to "warn", in which case Git will only warn about an 502 irreversible conversion but continue the operation. 503+ 504CRLF conversion bears a slight chance of corrupting data. 505When it is enabled, Git will convert CRLF to LF during commit and LF to 506CRLF during checkout. A file that contains a mixture of LF and 507CRLF before the commit cannot be recreated by Git. For text 508files this is the right thing to do: it corrects line endings 509such that we have only LF line endings in the repository. 510But for binary files that are accidentally classified as text the 511conversion can corrupt data. 512+ 513If you recognize such corruption early you can easily fix it by 514setting the conversion type explicitly in .gitattributes. Right 515after committing you still have the original file in your work 516tree and this file is not yet corrupted. You can explicitly tell 517Git that this file is binary and Git will handle the file 518appropriately. 519+ 520Unfortunately, the desired effect of cleaning up text files with 521mixed line endings and the undesired effect of corrupting binary 522files cannot be distinguished. In both cases CRLFs are removed 523in an irreversible way. For text files this is the right thing 524to do because CRLFs are line endings, while for binary files 525converting CRLFs corrupts data. 526+ 527Note, this safety check does not mean that a checkout will generate a 528file identical to the original file for a different setting of 529`core.eol` and `core.autocrlf`, but only for the current one. For 530example, a text file with `LF` would be accepted with `core.eol=lf` 531and could later be checked out with `core.eol=crlf`, in which case the 532resulting file would contain `CRLF`, although the original file 533contained `LF`. However, in both work trees the line endings would be 534consistent, that is either all `LF` or all `CRLF`, but never mixed. A 535file with mixed line endings would be reported by the `core.safecrlf` 536mechanism. 537 538core.autocrlf:: 539 Setting this variable to "true" is the same as setting 540 the `text` attribute to "auto" on all files and core.eol to "crlf". 541 Set to true if you want to have `CRLF` line endings in your 542 working directory and the repository has LF line endings. 543 This variable can be set to 'input', 544 in which case no output conversion is performed. 545 546core.checkRoundtripEncoding:: 547 A comma and/or whitespace separated list of encodings that Git 548 performs UTF-8 round trip checks on if they are used in an 549 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 550 The default value is `SHIFT-JIS`. 551 552core.symlinks:: 553 If false, symbolic links are checked out as small plain files that 554 contain the link text. linkgit:git-update-index[1] and 555 linkgit:git-add[1] will not change the recorded type to regular 556 file. Useful on filesystems like FAT that do not support 557 symbolic links. 558+ 559The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 560will probe and set core.symlinks false if appropriate when the repository 561is created. 562 563core.gitProxy:: 564 A "proxy command" to execute (as 'command host port') instead 565 of establishing direct connection to the remote server when 566 using the Git protocol for fetching. If the variable value is 567 in the "COMMAND for DOMAIN" format, the command is applied only 568 on hostnames ending with the specified domain string. This variable 569 may be set multiple times and is matched in the given order; 570 the first match wins. 571+ 572Can be overridden by the `GIT_PROXY_COMMAND` environment variable 573(which always applies universally, without the special "for" 574handling). 575+ 576The special string `none` can be used as the proxy command to 577specify that no proxy be used for a given domain pattern. 578This is useful for excluding servers inside a firewall from 579proxy use, while defaulting to a common proxy for external domains. 580 581core.sshCommand:: 582 If this variable is set, `git fetch` and `git push` will 583 use the specified command instead of `ssh` when they need to 584 connect to a remote system. The command is in the same form as 585 the `GIT_SSH_COMMAND` environment variable and is overridden 586 when the environment variable is set. 587 588core.ignoreStat:: 589 If true, Git will avoid using lstat() calls to detect if files have 590 changed by setting the "assume-unchanged" bit for those tracked files 591 which it has updated identically in both the index and working tree. 592+ 593When files are modified outside of Git, the user will need to stage 594the modified files explicitly (e.g. see 'Examples' section in 595linkgit:git-update-index[1]). 596Git will not normally detect changes to those files. 597+ 598This is useful on systems where lstat() calls are very slow, such as 599CIFS/Microsoft Windows. 600+ 601False by default. 602 603core.preferSymlinkRefs:: 604 Instead of the default "symref" format for HEAD 605 and other symbolic reference files, use symbolic links. 606 This is sometimes needed to work with old scripts that 607 expect HEAD to be a symbolic link. 608 609core.bare:: 610 If true this repository is assumed to be 'bare' and has no 611 working directory associated with it. If this is the case a 612 number of commands that require a working directory will be 613 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 614+ 615This setting is automatically guessed by linkgit:git-clone[1] or 616linkgit:git-init[1] when the repository was created. By default a 617repository that ends in "/.git" is assumed to be not bare (bare = 618false), while all other repositories are assumed to be bare (bare 619= true). 620 621core.worktree:: 622 Set the path to the root of the working tree. 623 If `GIT_COMMON_DIR` environment variable is set, core.worktree 624 is ignored and not used for determining the root of working tree. 625 This can be overridden by the `GIT_WORK_TREE` environment 626 variable and the `--work-tree` command-line option. 627 The value can be an absolute path or relative to the path to 628 the .git directory, which is either specified by --git-dir 629 or GIT_DIR, or automatically discovered. 630 If --git-dir or GIT_DIR is specified but none of 631 --work-tree, GIT_WORK_TREE and core.worktree is specified, 632 the current working directory is regarded as the top level 633 of your working tree. 634+ 635Note that this variable is honored even when set in a configuration 636file in a ".git" subdirectory of a directory and its value differs 637from the latter directory (e.g. "/path/to/.git/config" has 638core.worktree set to "/different/path"), which is most likely a 639misconfiguration. Running Git commands in the "/path/to" directory will 640still use "/different/path" as the root of the work tree and can cause 641confusion unless you know what you are doing (e.g. you are creating a 642read-only snapshot of the same index to a location different from the 643repository's usual working tree). 644 645core.logAllRefUpdates:: 646 Enable the reflog. Updates to a ref <ref> is logged to the file 647 "`$GIT_DIR/logs/<ref>`", by appending the new and old 648 SHA-1, the date/time and the reason of the update, but 649 only when the file exists. If this configuration 650 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 651 file is automatically created for branch heads (i.e. under 652 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 653 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 654 If it is set to `always`, then a missing reflog is automatically 655 created for any ref under `refs/`. 656+ 657This information can be used to determine what commit 658was the tip of a branch "2 days ago". 659+ 660This value is true by default in a repository that has 661a working directory associated with it, and false by 662default in a bare repository. 663 664core.repositoryFormatVersion:: 665 Internal variable identifying the repository format and layout 666 version. 667 668core.sharedRepository:: 669 When 'group' (or 'true'), the repository is made shareable between 670 several users in a group (making sure all the files and objects are 671 group-writable). When 'all' (or 'world' or 'everybody'), the 672 repository will be readable by all users, additionally to being 673 group-shareable. When 'umask' (or 'false'), Git will use permissions 674 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 675 files in the repository will have this mode value. '0xxx' will override 676 user's umask value (whereas the other options will only override 677 requested parts of the user's umask value). Examples: '0660' will make 678 the repo read/write-able for the owner and group, but inaccessible to 679 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 680 repository that is group-readable but not group-writable. 681 See linkgit:git-init[1]. False by default. 682 683core.warnAmbiguousRefs:: 684 If true, Git will warn you if the ref name you passed it is ambiguous 685 and might match multiple refs in the repository. True by default. 686 687core.compression:: 688 An integer -1..9, indicating a default compression level. 689 -1 is the zlib default. 0 means no compression, 690 and 1..9 are various speed/size tradeoffs, 9 being slowest. 691 If set, this provides a default to other compression variables, 692 such as `core.looseCompression` and `pack.compression`. 693 694core.looseCompression:: 695 An integer -1..9, indicating the compression level for objects that 696 are not in a pack file. -1 is the zlib default. 0 means no 697 compression, and 1..9 are various speed/size tradeoffs, 9 being 698 slowest. If not set, defaults to core.compression. If that is 699 not set, defaults to 1 (best speed). 700 701core.packedGitWindowSize:: 702 Number of bytes of a pack file to map into memory in a 703 single mapping operation. Larger window sizes may allow 704 your system to process a smaller number of large pack files 705 more quickly. Smaller window sizes will negatively affect 706 performance due to increased calls to the operating system's 707 memory manager, but may improve performance when accessing 708 a large number of large pack files. 709+ 710Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 711MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 712be reasonable for all users/operating systems. You probably do 713not need to adjust this value. 714+ 715Common unit suffixes of 'k', 'm', or 'g' are supported. 716 717core.packedGitLimit:: 718 Maximum number of bytes to map simultaneously into memory 719 from pack files. If Git needs to access more than this many 720 bytes at once to complete an operation it will unmap existing 721 regions to reclaim virtual address space within the process. 722+ 723Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 724unlimited) on 64 bit platforms. 725This should be reasonable for all users/operating systems, except on 726the largest projects. You probably do not need to adjust this value. 727+ 728Common unit suffixes of 'k', 'm', or 'g' are supported. 729 730core.deltaBaseCacheLimit:: 731 Maximum number of bytes to reserve for caching base objects 732 that may be referenced by multiple deltified objects. By storing the 733 entire decompressed base objects in a cache Git is able 734 to avoid unpacking and decompressing frequently used base 735 objects multiple times. 736+ 737Default is 96 MiB on all platforms. This should be reasonable 738for all users/operating systems, except on the largest projects. 739You probably do not need to adjust this value. 740+ 741Common unit suffixes of 'k', 'm', or 'g' are supported. 742 743core.bigFileThreshold:: 744 Files larger than this size are stored deflated, without 745 attempting delta compression. Storing large files without 746 delta compression avoids excessive memory usage, at the 747 slight expense of increased disk usage. Additionally files 748 larger than this size are always treated as binary. 749+ 750Default is 512 MiB on all platforms. This should be reasonable 751for most projects as source code and other text files can still 752be delta compressed, but larger binary media files won't be. 753+ 754Common unit suffixes of 'k', 'm', or 'g' are supported. 755 756core.excludesFile:: 757 Specifies the pathname to the file that contains patterns to 758 describe paths that are not meant to be tracked, in addition 759 to '.gitignore' (per-directory) and '.git/info/exclude'. 760 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 761 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 762 is used instead. See linkgit:gitignore[5]. 763 764core.askPass:: 765 Some commands (e.g. svn and http interfaces) that interactively 766 ask for a password can be told to use an external program given 767 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 768 environment variable. If not set, fall back to the value of the 769 `SSH_ASKPASS` environment variable or, failing that, a simple password 770 prompt. The external program shall be given a suitable prompt as 771 command-line argument and write the password on its STDOUT. 772 773core.attributesFile:: 774 In addition to '.gitattributes' (per-directory) and 775 '.git/info/attributes', Git looks into this file for attributes 776 (see linkgit:gitattributes[5]). Path expansions are made the same 777 way as for `core.excludesFile`. Its default value is 778 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 779 set or empty, `$HOME/.config/git/attributes` is used instead. 780 781core.hooksPath:: 782 By default Git will look for your hooks in the 783 '$GIT_DIR/hooks' directory. Set this to different path, 784 e.g. '/etc/git/hooks', and Git will try to find your hooks in 785 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 786 in '$GIT_DIR/hooks/pre-receive'. 787+ 788The path can be either absolute or relative. A relative path is 789taken as relative to the directory where the hooks are run (see 790the "DESCRIPTION" section of linkgit:githooks[5]). 791+ 792This configuration variable is useful in cases where you'd like to 793centrally configure your Git hooks instead of configuring them on a 794per-repository basis, or as a more flexible and centralized 795alternative to having an `init.templateDir` where you've changed 796default hooks. 797 798core.editor:: 799 Commands such as `commit` and `tag` that let you edit 800 messages by launching an editor use the value of this 801 variable when it is set, and the environment variable 802 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 803 804core.commentChar:: 805 Commands such as `commit` and `tag` that let you edit 806 messages consider a line that begins with this character 807 commented, and removes them after the editor returns 808 (default '#'). 809+ 810If set to "auto", `git-commit` would select a character that is not 811the beginning character of any line in existing commit messages. 812 813core.filesRefLockTimeout:: 814 The length of time, in milliseconds, to retry when trying to 815 lock an individual reference. Value 0 means not to retry at 816 all; -1 means to try indefinitely. Default is 100 (i.e., 817 retry for 100ms). 818 819core.packedRefsTimeout:: 820 The length of time, in milliseconds, to retry when trying to 821 lock the `packed-refs` file. Value 0 means not to retry at 822 all; -1 means to try indefinitely. Default is 1000 (i.e., 823 retry for 1 second). 824 825sequence.editor:: 826 Text editor used by `git rebase -i` for editing the rebase instruction file. 827 The value is meant to be interpreted by the shell when it is used. 828 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 829 When not configured the default commit message editor is used instead. 830 831core.pager:: 832 Text viewer for use by Git commands (e.g., 'less'). The value 833 is meant to be interpreted by the shell. The order of preference 834 is the `$GIT_PAGER` environment variable, then `core.pager` 835 configuration, then `$PAGER`, and then the default chosen at 836 compile time (usually 'less'). 837+ 838When the `LESS` environment variable is unset, Git sets it to `FRX` 839(if `LESS` environment variable is set, Git does not change it at 840all). If you want to selectively override Git's default setting 841for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 842be passed to the shell by Git, which will translate the final 843command to `LESS=FRX less -S`. The environment does not set the 844`S` option but the command line does, instructing less to truncate 845long lines. Similarly, setting `core.pager` to `less -+F` will 846deactivate the `F` option specified by the environment from the 847command-line, deactivating the "quit if one screen" behavior of 848`less`. One can specifically activate some flags for particular 849commands: for example, setting `pager.blame` to `less -S` enables 850line truncation only for `git blame`. 851+ 852Likewise, when the `LV` environment variable is unset, Git sets it 853to `-c`. You can override this setting by exporting `LV` with 854another value or setting `core.pager` to `lv +c`. 855 856core.whitespace:: 857 A comma separated list of common whitespace problems to 858 notice. 'git diff' will use `color.diff.whitespace` to 859 highlight them, and 'git apply --whitespace=error' will 860 consider them as errors. You can prefix `-` to disable 861 any of them (e.g. `-trailing-space`): 862+ 863* `blank-at-eol` treats trailing whitespaces at the end of the line 864 as an error (enabled by default). 865* `space-before-tab` treats a space character that appears immediately 866 before a tab character in the initial indent part of the line as an 867 error (enabled by default). 868* `indent-with-non-tab` treats a line that is indented with space 869 characters instead of the equivalent tabs as an error (not enabled by 870 default). 871* `tab-in-indent` treats a tab character in the initial indent part of 872 the line as an error (not enabled by default). 873* `blank-at-eof` treats blank lines added at the end of file as an error 874 (enabled by default). 875* `trailing-space` is a short-hand to cover both `blank-at-eol` and 876 `blank-at-eof`. 877* `cr-at-eol` treats a carriage-return at the end of line as 878 part of the line terminator, i.e. with it, `trailing-space` 879 does not trigger if the character before such a carriage-return 880 is not a whitespace (not enabled by default). 881* `tabwidth=<n>` tells how many character positions a tab occupies; this 882 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 883 errors. The default tab width is 8. Allowed values are 1 to 63. 884 885core.fsyncObjectFiles:: 886 This boolean will enable 'fsync()' when writing object files. 887+ 888This is a total waste of time and effort on a filesystem that orders 889data writes properly, but can be useful for filesystems that do not use 890journalling (traditional UNIX filesystems) or that only journal metadata 891and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 892 893core.preloadIndex:: 894 Enable parallel index preload for operations like 'git diff' 895+ 896This can speed up operations like 'git diff' and 'git status' especially 897on filesystems like NFS that have weak caching semantics and thus 898relatively high IO latencies. When enabled, Git will do the 899index comparison to the filesystem data in parallel, allowing 900overlapping IO's. Defaults to true. 901 902core.createObject:: 903 You can set this to 'link', in which case a hardlink followed by 904 a delete of the source are used to make sure that object creation 905 will not overwrite existing objects. 906+ 907On some file system/operating system combinations, this is unreliable. 908Set this config setting to 'rename' there; However, This will remove the 909check that makes sure that existing object files will not get overwritten. 910 911core.notesRef:: 912 When showing commit messages, also show notes which are stored in 913 the given ref. The ref must be fully qualified. If the given 914 ref does not exist, it is not an error but means that no 915 notes should be printed. 916+ 917This setting defaults to "refs/notes/commits", and it can be overridden by 918the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 919 920gc.commitGraph:: 921 If true, then gc will rewrite the commit-graph file when 922 linkgit:git-gc[1] is run. When using linkgit:git-gc[1] 923 '--auto' the commit-graph will be updated if housekeeping is 924 required. Default is false. See linkgit:git-commit-graph[1] 925 for details. 926 927core.useReplaceRefs:: 928 If set to `false`, behave as if the `--no-replace-objects` 929 option was given on the command line. See linkgit:git[1] and 930 linkgit:git-replace[1] for more information. 931 932core.sparseCheckout:: 933 Enable "sparse checkout" feature. See section "Sparse checkout" in 934 linkgit:git-read-tree[1] for more information. 935 936core.abbrev:: 937 Set the length object names are abbreviated to. If 938 unspecified or set to "auto", an appropriate value is 939 computed based on the approximate number of packed objects 940 in your repository, which hopefully is enough for 941 abbreviated object names to stay unique for some time. 942 The minimum length is 4. 943 944add.ignoreErrors:: 945add.ignore-errors (deprecated):: 946 Tells 'git add' to continue adding files when some files cannot be 947 added due to indexing errors. Equivalent to the `--ignore-errors` 948 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 949 as it does not follow the usual naming convention for configuration 950 variables. 951 952alias.*:: 953 Command aliases for the linkgit:git[1] command wrapper - e.g. 954 after defining "alias.last = cat-file commit HEAD", the invocation 955 "git last" is equivalent to "git cat-file commit HEAD". To avoid 956 confusion and troubles with script usage, aliases that 957 hide existing Git commands are ignored. Arguments are split by 958 spaces, the usual shell quoting and escaping is supported. 959 A quote pair or a backslash can be used to quote them. 960+ 961If the alias expansion is prefixed with an exclamation point, 962it will be treated as a shell command. For example, defining 963"alias.new = !gitk --all --not ORIG_HEAD", the invocation 964"git new" is equivalent to running the shell command 965"gitk --all --not ORIG_HEAD". Note that shell commands will be 966executed from the top-level directory of a repository, which may 967not necessarily be the current directory. 968`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 969from the original current directory. See linkgit:git-rev-parse[1]. 970 971am.keepcr:: 972 If true, git-am will call git-mailsplit for patches in mbox format 973 with parameter `--keep-cr`. In this case git-mailsplit will 974 not remove `\r` from lines ending with `\r\n`. Can be overridden 975 by giving `--no-keep-cr` from the command line. 976 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 977 978am.threeWay:: 979 By default, `git am` will fail if the patch does not apply cleanly. When 980 set to true, this setting tells `git am` to fall back on 3-way merge if 981 the patch records the identity of blobs it is supposed to apply to and 982 we have those blobs available locally (equivalent to giving the `--3way` 983 option from the command line). Defaults to `false`. 984 See linkgit:git-am[1]. 985 986apply.ignoreWhitespace:: 987 When set to 'change', tells 'git apply' to ignore changes in 988 whitespace, in the same way as the `--ignore-space-change` 989 option. 990 When set to one of: no, none, never, false tells 'git apply' to 991 respect all whitespace differences. 992 See linkgit:git-apply[1]. 993 994apply.whitespace:: 995 Tells 'git apply' how to handle whitespaces, in the same way 996 as the `--whitespace` option. See linkgit:git-apply[1]. 997 998blame.showRoot:: 999 Do not treat root commits as boundaries in linkgit:git-blame[1].1000 This option defaults to false.10011002blame.blankBoundary::1003 Show blank commit object name for boundary commits in1004 linkgit:git-blame[1]. This option defaults to false.10051006blame.showEmail::1007 Show the author email instead of author name in linkgit:git-blame[1].1008 This option defaults to false.10091010blame.date::1011 Specifies the format used to output dates in linkgit:git-blame[1].1012 If unset the iso format is used. For supported values,1013 see the discussion of the `--date` option at linkgit:git-log[1].10141015branch.autoSetupMerge::1016 Tells 'git branch' and 'git checkout' to set up new branches1017 so that linkgit:git-pull[1] will appropriately merge from the1018 starting point branch. Note that even if this option is not set,1019 this behavior can be chosen per-branch using the `--track`1020 and `--no-track` options. The valid settings are: `false` -- no1021 automatic setup is done; `true` -- automatic setup is done when the1022 starting point is a remote-tracking branch; `always` --1023 automatic setup is done when the starting point is either a1024 local branch or remote-tracking1025 branch. This option defaults to true.10261027branch.autoSetupRebase::1028 When a new branch is created with 'git branch' or 'git checkout'1029 that tracks another branch, this variable tells Git to set1030 up pull to rebase instead of merge (see "branch.<name>.rebase").1031 When `never`, rebase is never automatically set to true.1032 When `local`, rebase is set to true for tracked branches of1033 other local branches.1034 When `remote`, rebase is set to true for tracked branches of1035 remote-tracking branches.1036 When `always`, rebase will be set to true for all tracking1037 branches.1038 See "branch.autoSetupMerge" for details on how to set up a1039 branch to track another branch.1040 This option defaults to never.10411042branch.sort::1043 This variable controls the sort ordering of branches when displayed by1044 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the1045 value of this variable will be used as the default.1046 See linkgit:git-for-each-ref[1] field names for valid values.10471048branch.<name>.remote::1049 When on branch <name>, it tells 'git fetch' and 'git push'1050 which remote to fetch from/push to. The remote to push to1051 may be overridden with `remote.pushDefault` (for all branches).1052 The remote to push to, for the current branch, may be further1053 overridden by `branch.<name>.pushRemote`. If no remote is1054 configured, or if you are not on any branch, it defaults to1055 `origin` for fetching and `remote.pushDefault` for pushing.1056 Additionally, `.` (a period) is the current local repository1057 (a dot-repository), see `branch.<name>.merge`'s final note below.10581059branch.<name>.pushRemote::1060 When on branch <name>, it overrides `branch.<name>.remote` for1061 pushing. It also overrides `remote.pushDefault` for pushing1062 from branch <name>. When you pull from one place (e.g. your1063 upstream) and push to another place (e.g. your own publishing1064 repository), you would want to set `remote.pushDefault` to1065 specify the remote to push to for all branches, and use this1066 option to override it for a specific branch.10671068branch.<name>.merge::1069 Defines, together with branch.<name>.remote, the upstream branch1070 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1071 branch to merge and can also affect 'git push' (see push.default).1072 When in branch <name>, it tells 'git fetch' the default1073 refspec to be marked for merging in FETCH_HEAD. The value is1074 handled like the remote part of a refspec, and must match a1075 ref which is fetched from the remote given by1076 "branch.<name>.remote".1077 The merge information is used by 'git pull' (which at first calls1078 'git fetch') to lookup the default branch for merging. Without1079 this option, 'git pull' defaults to merge the first refspec fetched.1080 Specify multiple values to get an octopus merge.1081 If you wish to setup 'git pull' so that it merges into <name> from1082 another branch in the local repository, you can point1083 branch.<name>.merge to the desired branch, and use the relative path1084 setting `.` (a period) for branch.<name>.remote.10851086branch.<name>.mergeOptions::1087 Sets default options for merging into branch <name>. The syntax and1088 supported options are the same as those of linkgit:git-merge[1], but1089 option values containing whitespace characters are currently not1090 supported.10911092branch.<name>.rebase::1093 When true, rebase the branch <name> on top of the fetched branch,1094 instead of merging the default branch from the default remote when1095 "git pull" is run. See "pull.rebase" for doing this in a non1096 branch-specific manner.1097+1098When `merges`, pass the `--rebase-merges` option to 'git rebase'1099so that the local merge commits are included in the rebase (see1100linkgit:git-rebase[1] for details).1101+1102When preserve, also pass `--preserve-merges` along to 'git rebase'1103so that locally committed merge commits will not be flattened1104by running 'git pull'.1105+1106When the value is `interactive`, the rebase is run in interactive mode.1107+1108*NOTE*: this is a possibly dangerous operation; do *not* use1109it unless you understand the implications (see linkgit:git-rebase[1]1110for details).11111112branch.<name>.description::1113 Branch description, can be edited with1114 `git branch --edit-description`. Branch description is1115 automatically added in the format-patch cover letter or1116 request-pull summary.11171118browser.<tool>.cmd::1119 Specify the command to invoke the specified browser. The1120 specified command is evaluated in shell with the URLs passed1121 as arguments. (See linkgit:git-web{litdd}browse[1].)11221123browser.<tool>.path::1124 Override the path for the given tool that may be used to1125 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1126 working repository in gitweb (see linkgit:git-instaweb[1]).11271128checkout.defaultRemote::1129 When you run 'git checkout <something>' and only have one1130 remote, it may implicitly fall back on checking out and1131 tracking e.g. 'origin/<something>'. This stops working as soon1132 as you have more than one remote with a '<something>'1133 reference. This setting allows for setting the name of a1134 preferred remote that should always win when it comes to1135 disambiguation. The typical use-case is to set this to1136 `origin`.1137+1138Currently this is used by linkgit:git-checkout[1] when 'git checkout1139<something>' will checkout the '<something>' branch on another remote,1140and by linkgit:git-worktree[1] when 'git worktree add' refers to a1141remote branch. This setting might be used for other checkout-like1142commands or functionality in the future.11431144clean.requireForce::1145 A boolean to make git-clean do nothing unless given -f,1146 -i or -n. Defaults to true.11471148color.advice::1149 A boolean to enable/disable color in hints (e.g. when a push1150 failed, see `advice.*` for a list). May be set to `always`,1151 `false` (or `never`) or `auto` (or `true`), in which case colors1152 are used only when the error output goes to a terminal. If1153 unset, then the value of `color.ui` is used (`auto` by default).11541155color.advice.hint::1156 Use customized color for hints.11571158color.branch::1159 A boolean to enable/disable color in the output of1160 linkgit:git-branch[1]. May be set to `always`,1161 `false` (or `never`) or `auto` (or `true`), in which case colors are used1162 only when the output is to a terminal. If unset, then the1163 value of `color.ui` is used (`auto` by default).11641165color.branch.<slot>::1166 Use customized color for branch coloration. `<slot>` is one of1167 `current` (the current branch), `local` (a local branch),1168 `remote` (a remote-tracking branch in refs/remotes/),1169 `upstream` (upstream tracking branch), `plain` (other1170 refs).11711172color.diff::1173 Whether to use ANSI escape sequences to add color to patches.1174 If this is set to `always`, linkgit:git-diff[1],1175 linkgit:git-log[1], and linkgit:git-show[1] will use color1176 for all patches. If it is set to `true` or `auto`, those1177 commands will only use color when output is to the terminal.1178 If unset, then the value of `color.ui` is used (`auto` by1179 default).1180+1181This does not affect linkgit:git-format-patch[1] or the1182'git-diff-{asterisk}' plumbing commands. Can be overridden on the1183command line with the `--color[=<when>]` option.11841185diff.colorMoved::1186 If set to either a valid `<mode>` or a true value, moved lines1187 in a diff are colored differently, for details of valid modes1188 see '--color-moved' in linkgit:git-diff[1]. If simply set to1189 true the default color mode will be used. When set to false,1190 moved lines are not colored.11911192diff.colorMovedWS::1193 When moved lines are colored using e.g. the `diff.colorMoved` setting,1194 this option controls the `<mode>` how spaces are treated1195 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].11961197color.diff.<slot>::1198 Use customized color for diff colorization. `<slot>` specifies1199 which part of the patch to use the specified color, and is one1200 of `context` (context text - `plain` is a historical synonym),1201 `meta` (metainformation), `frag`1202 (hunk header), 'func' (function in hunk header), `old` (removed lines),1203 `new` (added lines), `commit` (commit headers), `whitespace`1204 (highlighting whitespace errors), `oldMoved` (deleted lines),1205 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1206 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1207 and `newMovedAlternativeDimmed` (See the '<mode>'1208 setting of '--color-moved' in linkgit:git-diff[1] for details).12091210color.decorate.<slot>::1211 Use customized color for 'git log --decorate' output. `<slot>` is one1212 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1213 branches, remote-tracking branches, tags, stash and HEAD, respectively1214 and `grafted` for grafted commits.12151216color.grep::1217 When set to `always`, always highlight matches. When `false` (or1218 `never`), never. When set to `true` or `auto`, use color only1219 when the output is written to the terminal. If unset, then the1220 value of `color.ui` is used (`auto` by default).12211222color.grep.<slot>::1223 Use customized color for grep colorization. `<slot>` specifies which1224 part of the line to use the specified color, and is one of1225+1226--1227`context`;;1228 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1229`filename`;;1230 filename prefix (when not using `-h`)1231`function`;;1232 function name lines (when using `-p`)1233`lineNumber`;;1234 line number prefix (when using `-n`)1235`column`;;1236 column number prefix (when using `--column`)1237`match`;;1238 matching text (same as setting `matchContext` and `matchSelected`)1239`matchContext`;;1240 matching text in context lines1241`matchSelected`;;1242 matching text in selected lines1243`selected`;;1244 non-matching text in selected lines1245`separator`;;1246 separators between fields on a line (`:`, `-`, and `=`)1247 and between hunks (`--`)1248--12491250color.interactive::1251 When set to `always`, always use colors for interactive prompts1252 and displays (such as those used by "git-add --interactive" and1253 "git-clean --interactive"). When false (or `never`), never.1254 When set to `true` or `auto`, use colors only when the output is1255 to the terminal. If unset, then the value of `color.ui` is1256 used (`auto` by default).12571258color.interactive.<slot>::1259 Use customized color for 'git add --interactive' and 'git clean1260 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1261 or `error`, for four distinct types of normal output from1262 interactive commands.12631264color.pager::1265 A boolean to enable/disable colored output when the pager is in1266 use (default is true).12671268color.push::1269 A boolean to enable/disable color in push errors. May be set to1270 `always`, `false` (or `never`) or `auto` (or `true`), in which1271 case colors are used only when the error output goes to a terminal.1272 If unset, then the value of `color.ui` is used (`auto` by default).12731274color.push.error::1275 Use customized color for push errors.12761277color.showBranch::1278 A boolean to enable/disable color in the output of1279 linkgit:git-show-branch[1]. May be set to `always`,1280 `false` (or `never`) or `auto` (or `true`), in which case colors are used1281 only when the output is to a terminal. If unset, then the1282 value of `color.ui` is used (`auto` by default).12831284color.status::1285 A boolean to enable/disable color in the output of1286 linkgit:git-status[1]. May be set to `always`,1287 `false` (or `never`) or `auto` (or `true`), in which case colors are used1288 only when the output is to a terminal. If unset, then the1289 value of `color.ui` is used (`auto` by default).12901291color.status.<slot>::1292 Use customized color for status colorization. `<slot>` is1293 one of `header` (the header text of the status message),1294 `added` or `updated` (files which are added but not committed),1295 `changed` (files which are changed but not added in the index),1296 `untracked` (files which are not tracked by Git),1297 `branch` (the current branch),1298 `nobranch` (the color the 'no branch' warning is shown in, defaulting1299 to red),1300 `localBranch` or `remoteBranch` (the local and remote branch names,1301 respectively, when branch and tracking information is displayed in the1302 status short-format), or1303 `unmerged` (files which have unmerged changes).13041305color.blame.repeatedLines::1306 Use the customized color for the part of git-blame output that1307 is repeated meta information per line (such as commit id,1308 author name, date and timezone). Defaults to cyan.13091310color.blame.highlightRecent::1311 This can be used to color the metadata of a blame line depending1312 on age of the line.1313+1314This setting should be set to a comma-separated list of color and date settings,1315starting and ending with a color, the dates should be set from oldest to newest.1316The metadata will be colored given the colors if the the line was introduced1317before the given timestamp, overwriting older timestamped colors.1318+1319Instead of an absolute timestamp relative timestamps work as well, e.g.13202.weeks.ago is valid to address anything older than 2 weeks.1321+1322It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1323everything older than one year blue, recent changes between one month and1324one year old are kept white, and lines introduced within the last month are1325colored red.13261327blame.coloring::1328 This determines the coloring scheme to be applied to blame1329 output. It can be 'repeatedLines', 'highlightRecent',1330 or 'none' which is the default.13311332color.transport::1333 A boolean to enable/disable color when pushes are rejected. May be1334 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1335 case colors are used only when the error output goes to a terminal.1336 If unset, then the value of `color.ui` is used (`auto` by default).13371338color.transport.rejected::1339 Use customized color when a push was rejected.13401341color.ui::1342 This variable determines the default value for variables such1343 as `color.diff` and `color.grep` that control the use of color1344 per command family. Its scope will expand as more commands learn1345 configuration to set a default for the `--color` option. Set it1346 to `false` or `never` if you prefer Git commands not to use1347 color unless enabled explicitly with some other configuration1348 or the `--color` option. Set it to `always` if you want all1349 output not intended for machine consumption to use color, to1350 `true` or `auto` (this is the default since Git 1.8.4) if you1351 want such output to use color when written to the terminal.13521353column.ui::1354 Specify whether supported commands should output in columns.1355 This variable consists of a list of tokens separated by spaces1356 or commas:1357+1358These options control when the feature should be enabled1359(defaults to 'never'):1360+1361--1362`always`;;1363 always show in columns1364`never`;;1365 never show in columns1366`auto`;;1367 show in columns if the output is to the terminal1368--1369+1370These options control layout (defaults to 'column'). Setting any1371of these implies 'always' if none of 'always', 'never', or 'auto' are1372specified.1373+1374--1375`column`;;1376 fill columns before rows1377`row`;;1378 fill rows before columns1379`plain`;;1380 show in one column1381--1382+1383Finally, these options can be combined with a layout option (defaults1384to 'nodense'):1385+1386--1387`dense`;;1388 make unequal size columns to utilize more space1389`nodense`;;1390 make equal size columns1391--13921393column.branch::1394 Specify whether to output branch listing in `git branch` in columns.1395 See `column.ui` for details.13961397column.clean::1398 Specify the layout when list items in `git clean -i`, which always1399 shows files and directories in columns. See `column.ui` for details.14001401column.status::1402 Specify whether to output untracked files in `git status` in columns.1403 See `column.ui` for details.14041405column.tag::1406 Specify whether to output tag listing in `git tag` in columns.1407 See `column.ui` for details.14081409commit.cleanup::1410 This setting overrides the default of the `--cleanup` option in1411 `git commit`. See linkgit:git-commit[1] for details. Changing the1412 default can be useful when you always want to keep lines that begin1413 with comment character `#` in your log message, in which case you1414 would do `git config commit.cleanup whitespace` (note that you will1415 have to remove the help lines that begin with `#` in the commit log1416 template yourself, if you do this).14171418commit.gpgSign::14191420 A boolean to specify whether all commits should be GPG signed.1421 Use of this option when doing operations such as rebase can1422 result in a large number of commits being signed. It may be1423 convenient to use an agent to avoid typing your GPG passphrase1424 several times.14251426commit.status::1427 A boolean to enable/disable inclusion of status information in the1428 commit message template when using an editor to prepare the commit1429 message. Defaults to true.14301431commit.template::1432 Specify the pathname of a file to use as the template for1433 new commit messages.14341435commit.verbose::1436 A boolean or int to specify the level of verbose with `git commit`.1437 See linkgit:git-commit[1].14381439credential.helper::1440 Specify an external helper to be called when a username or1441 password credential is needed; the helper may consult external1442 storage to avoid prompting the user for the credentials. Note1443 that multiple helpers may be defined. See linkgit:gitcredentials[7]1444 for details.14451446credential.useHttpPath::1447 When acquiring credentials, consider the "path" component of an http1448 or https URL to be important. Defaults to false. See1449 linkgit:gitcredentials[7] for more information.14501451credential.username::1452 If no username is set for a network authentication, use this username1453 by default. See credential.<context>.* below, and1454 linkgit:gitcredentials[7].14551456credential.<url>.*::1457 Any of the credential.* options above can be applied selectively to1458 some credentials. For example "credential.https://example.com.username"1459 would set the default username only for https connections to1460 example.com. See linkgit:gitcredentials[7] for details on how URLs are1461 matched.14621463credentialCache.ignoreSIGHUP::1464 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14651466completion.commands::1467 This is only used by git-completion.bash to add or remove1468 commands from the list of completed commands. Normally only1469 porcelain commands and a few select others are completed. You1470 can add more commands, separated by space, in this1471 variable. Prefixing the command with '-' will remove it from1472 the existing list.14731474include::diff-config.txt[]14751476difftool.<tool>.path::1477 Override the path for the given tool. This is useful in case1478 your tool is not in the PATH.14791480difftool.<tool>.cmd::1481 Specify the command to invoke the specified diff tool.1482 The specified command is evaluated in shell with the following1483 variables available: 'LOCAL' is set to the name of the temporary1484 file containing the contents of the diff pre-image and 'REMOTE'1485 is set to the name of the temporary file containing the contents1486 of the diff post-image.14871488difftool.prompt::1489 Prompt before each invocation of the diff tool.14901491fastimport.unpackLimit::1492 If the number of objects imported by linkgit:git-fast-import[1]1493 is below this limit, then the objects will be unpacked into1494 loose object files. However if the number of imported objects1495 equals or exceeds this limit then the pack will be stored as a1496 pack. Storing the pack from a fast-import can make the import1497 operation complete faster, especially on slow filesystems. If1498 not set, the value of `transfer.unpackLimit` is used instead.14991500fetch.recurseSubmodules::1501 This option can be either set to a boolean value or to 'on-demand'.1502 Setting it to a boolean changes the behavior of fetch and pull to1503 unconditionally recurse into submodules when set to true or to not1504 recurse at all when set to false. When set to 'on-demand' (the default1505 value), fetch and pull will only recurse into a populated submodule1506 when its superproject retrieves a commit that updates the submodule's1507 reference.15081509fetch.fsckObjects::1510 If it is set to true, git-fetch-pack will check all fetched1511 objects. It will abort in the case of a malformed object or a1512 broken link. The result of an abort are only dangling objects.1513 Defaults to false. If not set, the value of `transfer.fsckObjects`1514 is used instead.15151516fetch.unpackLimit::1517 If the number of objects fetched over the Git native1518 transfer is below this1519 limit, then the objects will be unpacked into loose object1520 files. However if the number of received objects equals or1521 exceeds this limit then the received pack will be stored as1522 a pack, after adding any missing delta bases. Storing the1523 pack from a push can make the push operation complete faster,1524 especially on slow filesystems. If not set, the value of1525 `transfer.unpackLimit` is used instead.15261527fetch.prune::1528 If true, fetch will automatically behave as if the `--prune`1529 option was given on the command line. See also `remote.<name>.prune`1530 and the PRUNING section of linkgit:git-fetch[1].15311532fetch.pruneTags::1533 If true, fetch will automatically behave as if the1534 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1535 if not set already. This allows for setting both this option1536 and `fetch.prune` to maintain a 1=1 mapping to upstream1537 refs. See also `remote.<name>.pruneTags` and the PRUNING1538 section of linkgit:git-fetch[1].15391540fetch.output::1541 Control how ref update status is printed. Valid values are1542 `full` and `compact`. Default value is `full`. See section1543 OUTPUT in linkgit:git-fetch[1] for detail.15441545fetch.negotiationAlgorithm::1546 Control how information about the commits in the local repository is1547 sent when negotiating the contents of the packfile to be sent by the1548 server. Set to "skipping" to use an algorithm that skips commits in an1549 effort to converge faster, but may result in a larger-than-necessary1550 packfile; any other value instructs Git to use the default algorithm1551 that never skips commits (unless the server has acknowledged it or one1552 of its descendants).15531554format.attach::1555 Enable multipart/mixed attachments as the default for1556 'format-patch'. The value can also be a double quoted string1557 which will enable attachments as the default and set the1558 value as the boundary. See the --attach option in1559 linkgit:git-format-patch[1].15601561format.from::1562 Provides the default value for the `--from` option to format-patch.1563 Accepts a boolean value, or a name and email address. If false,1564 format-patch defaults to `--no-from`, using commit authors directly in1565 the "From:" field of patch mails. If true, format-patch defaults to1566 `--from`, using your committer identity in the "From:" field of patch1567 mails and including a "From:" field in the body of the patch mail if1568 different. If set to a non-boolean value, format-patch uses that1569 value instead of your committer identity. Defaults to false.15701571format.numbered::1572 A boolean which can enable or disable sequence numbers in patch1573 subjects. It defaults to "auto" which enables it only if there1574 is more than one patch. It can be enabled or disabled for all1575 messages by setting it to "true" or "false". See --numbered1576 option in linkgit:git-format-patch[1].15771578format.headers::1579 Additional email headers to include in a patch to be submitted1580 by mail. See linkgit:git-format-patch[1].15811582format.to::1583format.cc::1584 Additional recipients to include in a patch to be submitted1585 by mail. See the --to and --cc options in1586 linkgit:git-format-patch[1].15871588format.subjectPrefix::1589 The default for format-patch is to output files with the '[PATCH]'1590 subject prefix. Use this variable to change that prefix.15911592format.signature::1593 The default for format-patch is to output a signature containing1594 the Git version number. Use this variable to change that default.1595 Set this variable to the empty string ("") to suppress1596 signature generation.15971598format.signatureFile::1599 Works just like format.signature except the contents of the1600 file specified by this variable will be used as the signature.16011602format.suffix::1603 The default for format-patch is to output files with the suffix1604 `.patch`. Use this variable to change that suffix (make sure to1605 include the dot if you want it).16061607format.pretty::1608 The default pretty format for log/show/whatchanged command,1609 See linkgit:git-log[1], linkgit:git-show[1],1610 linkgit:git-whatchanged[1].16111612format.thread::1613 The default threading style for 'git format-patch'. Can be1614 a boolean value, or `shallow` or `deep`. `shallow` threading1615 makes every mail a reply to the head of the series,1616 where the head is chosen from the cover letter, the1617 `--in-reply-to`, and the first patch mail, in this order.1618 `deep` threading makes every mail a reply to the previous one.1619 A true boolean value is the same as `shallow`, and a false1620 value disables threading.16211622format.signOff::1623 A boolean value which lets you enable the `-s/--signoff` option of1624 format-patch by default. *Note:* Adding the Signed-off-by: line to a1625 patch should be a conscious act and means that you certify you have1626 the rights to submit this work under the same open source license.1627 Please see the 'SubmittingPatches' document for further discussion.16281629format.coverLetter::1630 A boolean that controls whether to generate a cover-letter when1631 format-patch is invoked, but in addition can be set to "auto", to1632 generate a cover-letter only when there's more than one patch.16331634format.outputDirectory::1635 Set a custom directory to store the resulting files instead of the1636 current working directory.16371638format.useAutoBase::1639 A boolean value which lets you enable the `--base=auto` option of1640 format-patch by default.16411642filter.<driver>.clean::1643 The command which is used to convert the content of a worktree1644 file to a blob upon checkin. See linkgit:gitattributes[5] for1645 details.16461647filter.<driver>.smudge::1648 The command which is used to convert the content of a blob1649 object to a worktree file upon checkout. See1650 linkgit:gitattributes[5] for details.16511652fsck.<msg-id>::1653 Allows overriding the message type (error, warn or ignore) of a1654 specific message ID such as `missingEmail`.1655+1656For convenience, fsck prefixes the error/warning with the message ID,1657e.g. "missingEmail: invalid author/committer line - missing email" means1658that setting `fsck.missingEmail = ignore` will hide that issue.1659+1660This feature is intended to support working with legacy repositories1661which cannot be repaired without disruptive changes.16621663fsck.skipList::1664 The path to a sorted list of object names (i.e. one SHA-1 per1665 line) that are known to be broken in a non-fatal way and should1666 be ignored. This feature is useful when an established project1667 should be accepted despite early commits containing errors that1668 can be safely ignored such as invalid committer email addresses.1669 Note: corrupt objects cannot be skipped with this setting.16701671gc.aggressiveDepth::1672 The depth parameter used in the delta compression1673 algorithm used by 'git gc --aggressive'. This defaults1674 to 50.16751676gc.aggressiveWindow::1677 The window size parameter used in the delta compression1678 algorithm used by 'git gc --aggressive'. This defaults1679 to 250.16801681gc.auto::1682 When there are approximately more than this many loose1683 objects in the repository, `git gc --auto` will pack them.1684 Some Porcelain commands use this command to perform a1685 light-weight garbage collection from time to time. The1686 default value is 6700. Setting this to 0 disables it.16871688gc.autoPackLimit::1689 When there are more than this many packs that are not1690 marked with `*.keep` file in the repository, `git gc1691 --auto` consolidates them into one larger pack. The1692 default value is 50. Setting this to 0 disables it.16931694gc.autoDetach::1695 Make `git gc --auto` return immediately and run in background1696 if the system supports it. Default is true.16971698gc.bigPackThreshold::1699 If non-zero, all packs larger than this limit are kept when1700 `git gc` is run. This is very similar to `--keep-base-pack`1701 except that all packs that meet the threshold are kept, not1702 just the base pack. Defaults to zero. Common unit suffixes of1703 'k', 'm', or 'g' are supported.1704+1705Note that if the number of kept packs is more than gc.autoPackLimit,1706this configuration variable is ignored, all packs except the base pack1707will be repacked. After this the number of packs should go below1708gc.autoPackLimit and gc.bigPackThreshold should be respected again.17091710gc.logExpiry::1711 If the file gc.log exists, then `git gc --auto` won't run1712 unless that file is more than 'gc.logExpiry' old. Default is1713 "1.day". See `gc.pruneExpire` for more ways to specify its1714 value.17151716gc.packRefs::1717 Running `git pack-refs` in a repository renders it1718 unclonable by Git versions prior to 1.5.1.2 over dumb1719 transports such as HTTP. This variable determines whether1720 'git gc' runs `git pack-refs`. This can be set to `notbare`1721 to enable it within all non-bare repos or it can be set to a1722 boolean value. The default is `true`.17231724gc.pruneExpire::1725 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1726 Override the grace period with this config variable. The value1727 "now" may be used to disable this grace period and always prune1728 unreachable objects immediately, or "never" may be used to1729 suppress pruning. This feature helps prevent corruption when1730 'git gc' runs concurrently with another process writing to the1731 repository; see the "NOTES" section of linkgit:git-gc[1].17321733gc.worktreePruneExpire::1734 When 'git gc' is run, it calls1735 'git worktree prune --expire 3.months.ago'.1736 This config variable can be used to set a different grace1737 period. The value "now" may be used to disable the grace1738 period and prune `$GIT_DIR/worktrees` immediately, or "never"1739 may be used to suppress pruning.17401741gc.reflogExpire::1742gc.<pattern>.reflogExpire::1743 'git reflog expire' removes reflog entries older than1744 this time; defaults to 90 days. The value "now" expires all1745 entries immediately, and "never" suppresses expiration1746 altogether. With "<pattern>" (e.g.1747 "refs/stash") in the middle the setting applies only to1748 the refs that match the <pattern>.17491750gc.reflogExpireUnreachable::1751gc.<pattern>.reflogExpireUnreachable::1752 'git reflog expire' removes reflog entries older than1753 this time and are not reachable from the current tip;1754 defaults to 30 days. The value "now" expires all entries1755 immediately, and "never" suppresses expiration altogether.1756 With "<pattern>" (e.g. "refs/stash")1757 in the middle, the setting applies only to the refs that1758 match the <pattern>.17591760gc.rerereResolved::1761 Records of conflicted merge you resolved earlier are1762 kept for this many days when 'git rerere gc' is run.1763 You can also use more human-readable "1.month.ago", etc.1764 The default is 60 days. See linkgit:git-rerere[1].17651766gc.rerereUnresolved::1767 Records of conflicted merge you have not resolved are1768 kept for this many days when 'git rerere gc' is run.1769 You can also use more human-readable "1.month.ago", etc.1770 The default is 15 days. See linkgit:git-rerere[1].17711772gitcvs.commitMsgAnnotation::1773 Append this string to each commit message. Set to empty string1774 to disable this feature. Defaults to "via git-CVS emulator".17751776gitcvs.enabled::1777 Whether the CVS server interface is enabled for this repository.1778 See linkgit:git-cvsserver[1].17791780gitcvs.logFile::1781 Path to a log file where the CVS server interface well... logs1782 various stuff. See linkgit:git-cvsserver[1].17831784gitcvs.usecrlfattr::1785 If true, the server will look up the end-of-line conversion1786 attributes for files to determine the `-k` modes to use. If1787 the attributes force Git to treat a file as text,1788 the `-k` mode will be left blank so CVS clients will1789 treat it as text. If they suppress text conversion, the file1790 will be set with '-kb' mode, which suppresses any newline munging1791 the client might otherwise do. If the attributes do not allow1792 the file type to be determined, then `gitcvs.allBinary` is1793 used. See linkgit:gitattributes[5].17941795gitcvs.allBinary::1796 This is used if `gitcvs.usecrlfattr` does not resolve1797 the correct '-kb' mode to use. If true, all1798 unresolved files are sent to the client in1799 mode '-kb'. This causes the client to treat them1800 as binary files, which suppresses any newline munging it1801 otherwise might do. Alternatively, if it is set to "guess",1802 then the contents of the file are examined to decide if1803 it is binary, similar to `core.autocrlf`.18041805gitcvs.dbName::1806 Database used by git-cvsserver to cache revision information1807 derived from the Git repository. The exact meaning depends on the1808 used database driver, for SQLite (which is the default driver) this1809 is a filename. Supports variable substitution (see1810 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1811 Default: '%Ggitcvs.%m.sqlite'18121813gitcvs.dbDriver::1814 Used Perl DBI driver. You can specify any available driver1815 for this here, but it might not work. git-cvsserver is tested1816 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1817 reported *not* to work with 'DBD::mysql'. Experimental feature.1818 May not contain double colons (`:`). Default: 'SQLite'.1819 See linkgit:git-cvsserver[1].18201821gitcvs.dbUser, gitcvs.dbPass::1822 Database user and password. Only useful if setting `gitcvs.dbDriver`,1823 since SQLite has no concept of database users and/or passwords.1824 'gitcvs.dbUser' supports variable substitution (see1825 linkgit:git-cvsserver[1] for details).18261827gitcvs.dbTableNamePrefix::1828 Database table name prefix. Prepended to the names of any1829 database tables used, allowing a single database to be used1830 for several repositories. Supports variable substitution (see1831 linkgit:git-cvsserver[1] for details). Any non-alphabetic1832 characters will be replaced with underscores.18331834All gitcvs variables except for `gitcvs.usecrlfattr` and1835`gitcvs.allBinary` can also be specified as1836'gitcvs.<access_method>.<varname>' (where 'access_method'1837is one of "ext" and "pserver") to make them apply only for the given1838access method.18391840gitweb.category::1841gitweb.description::1842gitweb.owner::1843gitweb.url::1844 See linkgit:gitweb[1] for description.18451846gitweb.avatar::1847gitweb.blame::1848gitweb.grep::1849gitweb.highlight::1850gitweb.patches::1851gitweb.pickaxe::1852gitweb.remote_heads::1853gitweb.showSizes::1854gitweb.snapshot::1855 See linkgit:gitweb.conf[5] for description.18561857grep.lineNumber::1858 If set to true, enable `-n` option by default.18591860grep.column::1861 If set to true, enable the `--column` option by default.18621863grep.patternType::1864 Set the default matching behavior. Using a value of 'basic', 'extended',1865 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1866 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1867 value 'default' will return to the default matching behavior.18681869grep.extendedRegexp::1870 If set to true, enable `--extended-regexp` option by default. This1871 option is ignored when the `grep.patternType` option is set to a value1872 other than 'default'.18731874grep.threads::1875 Number of grep worker threads to use.1876 See `grep.threads` in linkgit:git-grep[1] for more information.18771878grep.fallbackToNoIndex::1879 If set to true, fall back to git grep --no-index if git grep1880 is executed outside of a git repository. Defaults to false.18811882gpg.program::1883 Use this custom program instead of "`gpg`" found on `$PATH` when1884 making or verifying a PGP signature. The program must support the1885 same command-line interface as GPG, namely, to verify a detached1886 signature, "`gpg --verify $file - <$signature`" is run, and the1887 program is expected to signal a good signature by exiting with1888 code 0, and to generate an ASCII-armored detached signature, the1889 standard input of "`gpg -bsau $key`" is fed with the contents to be1890 signed, and the program is expected to send the result to its1891 standard output.18921893gpg.format::1894 Specifies which key format to use when signing with `--gpg-sign`.1895 Default is "openpgp" and another possible value is "x509".18961897gpg.<format>.program::1898 Use this to customize the program used for the signing format you1899 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still1900 be used as a legacy synonym for `gpg.openpgp.program`. The default1901 value for `gpg.x509.program` is "gpgsm".19021903gui.commitMsgWidth::1904 Defines how wide the commit message window is in the1905 linkgit:git-gui[1]. "75" is the default.19061907gui.diffContext::1908 Specifies how many context lines should be used in calls to diff1909 made by the linkgit:git-gui[1]. The default is "5".19101911gui.displayUntracked::1912 Determines if linkgit:git-gui[1] shows untracked files1913 in the file list. The default is "true".19141915gui.encoding::1916 Specifies the default encoding to use for displaying of1917 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1918 It can be overridden by setting the 'encoding' attribute1919 for relevant files (see linkgit:gitattributes[5]).1920 If this option is not set, the tools default to the1921 locale encoding.19221923gui.matchTrackingBranch::1924 Determines if new branches created with linkgit:git-gui[1] should1925 default to tracking remote branches with matching names or1926 not. Default: "false".19271928gui.newBranchTemplate::1929 Is used as suggested name when creating new branches using the1930 linkgit:git-gui[1].19311932gui.pruneDuringFetch::1933 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1934 performing a fetch. The default value is "false".19351936gui.trustmtime::1937 Determines if linkgit:git-gui[1] should trust the file modification1938 timestamp or not. By default the timestamps are not trusted.19391940gui.spellingDictionary::1941 Specifies the dictionary used for spell checking commit messages in1942 the linkgit:git-gui[1]. When set to "none" spell checking is turned1943 off.19441945gui.fastCopyBlame::1946 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1947 location detection. It makes blame significantly faster on huge1948 repositories at the expense of less thorough copy detection.19491950gui.copyBlameThreshold::1951 Specifies the threshold to use in 'git gui blame' original location1952 detection, measured in alphanumeric characters. See the1953 linkgit:git-blame[1] manual for more information on copy detection.19541955gui.blamehistoryctx::1956 Specifies the radius of history context in days to show in1957 linkgit:gitk[1] for the selected commit, when the `Show History1958 Context` menu item is invoked from 'git gui blame'. If this1959 variable is set to zero, the whole history is shown.19601961guitool.<name>.cmd::1962 Specifies the shell command line to execute when the corresponding item1963 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1964 mandatory for every tool. The command is executed from the root of1965 the working directory, and in the environment it receives the name of1966 the tool as `GIT_GUITOOL`, the name of the currently selected file as1967 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1968 the head is detached, 'CUR_BRANCH' is empty).19691970guitool.<name>.needsFile::1971 Run the tool only if a diff is selected in the GUI. It guarantees1972 that 'FILENAME' is not empty.19731974guitool.<name>.noConsole::1975 Run the command silently, without creating a window to display its1976 output.19771978guitool.<name>.noRescan::1979 Don't rescan the working directory for changes after the tool1980 finishes execution.19811982guitool.<name>.confirm::1983 Show a confirmation dialog before actually running the tool.19841985guitool.<name>.argPrompt::1986 Request a string argument from the user, and pass it to the tool1987 through the `ARGS` environment variable. Since requesting an1988 argument implies confirmation, the 'confirm' option has no effect1989 if this is enabled. If the option is set to 'true', 'yes', or '1',1990 the dialog uses a built-in generic prompt; otherwise the exact1991 value of the variable is used.19921993guitool.<name>.revPrompt::1994 Request a single valid revision from the user, and set the1995 `REVISION` environment variable. In other aspects this option1996 is similar to 'argPrompt', and can be used together with it.19971998guitool.<name>.revUnmerged::1999 Show only unmerged branches in the 'revPrompt' subdialog.2000 This is useful for tools similar to merge or rebase, but not2001 for things like checkout or reset.20022003guitool.<name>.title::2004 Specifies the title to use for the prompt dialog. The default2005 is the tool name.20062007guitool.<name>.prompt::2008 Specifies the general prompt string to display at the top of2009 the dialog, before subsections for 'argPrompt' and 'revPrompt'.2010 The default value includes the actual command.20112012help.browser::2013 Specify the browser that will be used to display help in the2014 'web' format. See linkgit:git-help[1].20152016help.format::2017 Override the default help format used by linkgit:git-help[1].2018 Values 'man', 'info', 'web' and 'html' are supported. 'man' is2019 the default. 'web' and 'html' are the same.20202021help.autoCorrect::2022 Automatically correct and execute mistyped commands after2023 waiting for the given number of deciseconds (0.1 sec). If more2024 than one command can be deduced from the entered text, nothing2025 will be executed. If the value of this option is negative,2026 the corrected command will be executed immediately. If the2027 value is 0 - the command will be just shown but not executed.2028 This is the default.20292030help.htmlPath::2031 Specify the path where the HTML documentation resides. File system paths2032 and URLs are supported. HTML pages will be prefixed with this path when2033 help is displayed in the 'web' format. This defaults to the documentation2034 path of your Git installation.20352036http.proxy::2037 Override the HTTP proxy, normally configured using the 'http_proxy',2038 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In2039 addition to the syntax understood by curl, it is possible to specify a2040 proxy string with a user name but no password, in which case git will2041 attempt to acquire one in the same way it does for other credentials. See2042 linkgit:gitcredentials[7] for more information. The syntax thus is2043 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden2044 on a per-remote basis; see remote.<name>.proxy20452046http.proxyAuthMethod::2047 Set the method with which to authenticate against the HTTP proxy. This2048 only takes effect if the configured proxy string contains a user name part2049 (i.e. is of the form 'user@host' or 'user@host:port'). This can be2050 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.2051 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment2052 variable. Possible values are:2053+2054--2055* `anyauth` - Automatically pick a suitable authentication method. It is2056 assumed that the proxy answers an unauthenticated request with a 4072057 status code and one or more Proxy-authenticate headers with supported2058 authentication methods. This is the default.2059* `basic` - HTTP Basic authentication2060* `digest` - HTTP Digest authentication; this prevents the password from being2061 transmitted to the proxy in clear text2062* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option2063 of `curl(1)`)2064* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)2065--20662067http.emptyAuth::2068 Attempt authentication without seeking a username or password. This2069 can be used to attempt GSS-Negotiate authentication without specifying2070 a username in the URL, as libcurl normally requires a username for2071 authentication.20722073http.delegation::2074 Control GSSAPI credential delegation. The delegation is disabled2075 by default in libcurl since version 7.21.7. Set parameter to tell2076 the server what it is allowed to delegate when it comes to user2077 credentials. Used with GSS/kerberos. Possible values are:2078+2079--2080* `none` - Don't allow any delegation.2081* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2082 Kerberos service ticket, which is a matter of realm policy.2083* `always` - Unconditionally allow the server to delegate.2084--208520862087http.extraHeader::2088 Pass an additional HTTP header when communicating with a server. If2089 more than one such entry exists, all of them are added as extra2090 headers. To allow overriding the settings inherited from the system2091 config, an empty value will reset the extra headers to the empty list.20922093http.cookieFile::2094 The pathname of a file containing previously stored cookie lines,2095 which should be used2096 in the Git http session, if they match the server. The file format2097 of the file to read cookies from should be plain HTTP headers or2098 the Netscape/Mozilla cookie file format (see `curl(1)`).2099 NOTE that the file specified with http.cookieFile is used only as2100 input unless http.saveCookies is set.21012102http.saveCookies::2103 If set, store cookies received during requests to the file specified by2104 http.cookieFile. Has no effect if http.cookieFile is unset.21052106http.sslVersion::2107 The SSL version to use when negotiating an SSL connection, if you2108 want to force the default. The available and default version2109 depend on whether libcurl was built against NSS or OpenSSL and the2110 particular configuration of the crypto library in use. Internally2111 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2112 documentation for more details on the format of this option and2113 for the ssl version supported. Actually the possible values of2114 this option are:21152116 - sslv22117 - sslv32118 - tlsv12119 - tlsv1.02120 - tlsv1.12121 - tlsv1.22122 - tlsv1.321232124+2125Can be overridden by the `GIT_SSL_VERSION` environment variable.2126To force git to use libcurl's default ssl version and ignore any2127explicit http.sslversion option, set `GIT_SSL_VERSION` to the2128empty string.21292130http.sslCipherList::2131 A list of SSL ciphers to use when negotiating an SSL connection.2132 The available ciphers depend on whether libcurl was built against2133 NSS or OpenSSL and the particular configuration of the crypto2134 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2135 option; see the libcurl documentation for more details on the format2136 of this list.2137+2138Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2139To force git to use libcurl's default cipher list and ignore any2140explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2141empty string.21422143http.sslVerify::2144 Whether to verify the SSL certificate when fetching or pushing2145 over HTTPS. Defaults to true. Can be overridden by the2146 `GIT_SSL_NO_VERIFY` environment variable.21472148http.sslCert::2149 File containing the SSL certificate when fetching or pushing2150 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2151 variable.21522153http.sslKey::2154 File containing the SSL private key when fetching or pushing2155 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2156 variable.21572158http.sslCertPasswordProtected::2159 Enable Git's password prompt for the SSL certificate. Otherwise2160 OpenSSL will prompt the user, possibly many times, if the2161 certificate or private key is encrypted. Can be overridden by the2162 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.21632164http.sslCAInfo::2165 File containing the certificates to verify the peer with when2166 fetching or pushing over HTTPS. Can be overridden by the2167 `GIT_SSL_CAINFO` environment variable.21682169http.sslCAPath::2170 Path containing files with the CA certificates to verify the peer2171 with when fetching or pushing over HTTPS. Can be overridden2172 by the `GIT_SSL_CAPATH` environment variable.21732174http.pinnedpubkey::2175 Public key of the https service. It may either be the filename of2176 a PEM or DER encoded public key file or a string starting with2177 'sha256//' followed by the base64 encoded sha256 hash of the2178 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2179 exit with an error if this option is set but not supported by2180 cURL.21812182http.sslTry::2183 Attempt to use AUTH SSL/TLS and encrypted data transfers2184 when connecting via regular FTP protocol. This might be needed2185 if the FTP server requires it for security reasons or you wish2186 to connect securely whenever remote FTP server supports it.2187 Default is false since it might trigger certificate verification2188 errors on misconfigured servers.21892190http.maxRequests::2191 How many HTTP requests to launch in parallel. Can be overridden2192 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21932194http.minSessions::2195 The number of curl sessions (counted across slots) to be kept across2196 requests. They will not be ended with curl_easy_cleanup() until2197 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2198 value will be capped at 1. Defaults to 1.21992200http.postBuffer::2201 Maximum size in bytes of the buffer used by smart HTTP2202 transports when POSTing data to the remote system.2203 For requests larger than this buffer size, HTTP/1.1 and2204 Transfer-Encoding: chunked is used to avoid creating a2205 massive pack file locally. Default is 1 MiB, which is2206 sufficient for most requests.22072208http.lowSpeedLimit, http.lowSpeedTime::2209 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2210 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2211 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2212 `GIT_HTTP_LOW_SPEED_TIME` environment variables.22132214http.noEPSV::2215 A boolean which disables using of EPSV ftp command by curl.2216 This can helpful with some "poor" ftp servers which don't2217 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2218 environment variable. Default is false (curl will use EPSV).22192220http.userAgent::2221 The HTTP USER_AGENT string presented to an HTTP server. The default2222 value represents the version of the client Git such as git/1.7.1.2223 This option allows you to override this value to a more common value2224 such as Mozilla/4.0. This may be necessary, for instance, if2225 connecting through a firewall that restricts HTTP connections to a set2226 of common USER_AGENT strings (but not including those like git/1.7.1).2227 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.22282229http.followRedirects::2230 Whether git should follow HTTP redirects. If set to `true`, git2231 will transparently follow any redirect issued by a server it2232 encounters. If set to `false`, git will treat all redirects as2233 errors. If set to `initial`, git will follow redirects only for2234 the initial request to a remote, but not for subsequent2235 follow-up HTTP requests. Since git uses the redirected URL as2236 the base for the follow-up requests, this is generally2237 sufficient. The default is `initial`.22382239http.<url>.*::2240 Any of the http.* options above can be applied selectively to some URLs.2241 For a config key to match a URL, each element of the config key is2242 compared to that of the URL, in the following order:2243+2244--2245. Scheme (e.g., `https` in `https://example.com/`). This field2246 must match exactly between the config key and the URL.22472248. Host/domain name (e.g., `example.com` in `https://example.com/`).2249 This field must match between the config key and the URL. It is2250 possible to specify a `*` as part of the host name to match all subdomains2251 at this level. `https://*.example.com/` for example would match2252 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.22532254. Port number (e.g., `8080` in `http://example.com:8080/`).2255 This field must match exactly between the config key and the URL.2256 Omitted port numbers are automatically converted to the correct2257 default for the scheme before matching.22582259. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2260 path field of the config key must match the path field of the URL2261 either exactly or as a prefix of slash-delimited path elements. This means2262 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2263 match on a slash (`/`) boundary. Longer matches take precedence (so a config2264 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2265 key with just path `foo/`).22662267. User name (e.g., `user` in `https://user@example.com/repo.git`). If2268 the config key has a user name it must match the user name in the2269 URL exactly. If the config key does not have a user name, that2270 config key will match a URL with any user name (including none),2271 but at a lower precedence than a config key with a user name.2272--2273+2274The list above is ordered by decreasing precedence; a URL that matches2275a config key's path is preferred to one that matches its user name. For example,2276if the URL is `https://user@example.com/foo/bar` a config key match of2277`https://example.com/foo` will be preferred over a config key match of2278`https://user@example.com`.2279+2280All URLs are normalized before attempting any matching (the password part,2281if embedded in the URL, is always ignored for matching purposes) so that2282equivalent URLs that are simply spelled differently will match properly.2283Environment variable settings always override any matches. The URLs that are2284matched against are those given directly to Git commands. This means any URLs2285visited as a result of a redirection do not participate in matching.22862287ssh.variant::2288 By default, Git determines the command line arguments to use2289 based on the basename of the configured SSH command (configured2290 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2291 the config setting `core.sshCommand`). If the basename is2292 unrecognized, Git will attempt to detect support of OpenSSH2293 options by first invoking the configured SSH command with the2294 `-G` (print configuration) option and will subsequently use2295 OpenSSH options (if that is successful) or no options besides2296 the host and remote command (if it fails).2297+2298The config variable `ssh.variant` can be set to override this detection.2299Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2300`tortoiseplink`, `simple` (no options except the host and remote command).2301The default auto-detection can be explicitly requested using the value2302`auto`. Any other value is treated as `ssh`. This setting can also be2303overridden via the environment variable `GIT_SSH_VARIANT`.2304+2305The current command-line parameters used for each variant are as2306follows:2307+2308--23092310* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command23112312* `simple` - [username@]host command23132314* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command23152316* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command23172318--2319+2320Except for the `simple` variant, command-line parameters are likely to2321change as git gains new features.23222323i18n.commitEncoding::2324 Character encoding the commit messages are stored in; Git itself2325 does not care per se, but this information is necessary e.g. when2326 importing commits from emails or in the gitk graphical history2327 browser (and possibly at other places in the future or in other2328 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.23292330i18n.logOutputEncoding::2331 Character encoding the commit messages are converted to when2332 running 'git log' and friends.23332334imap::2335 The configuration variables in the 'imap' section are described2336 in linkgit:git-imap-send[1].23372338index.version::2339 Specify the version with which new index files should be2340 initialized. This does not affect existing repositories.23412342init.templateDir::2343 Specify the directory from which templates will be copied.2344 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)23452346instaweb.browser::2347 Specify the program that will be used to browse your working2348 repository in gitweb. See linkgit:git-instaweb[1].23492350instaweb.httpd::2351 The HTTP daemon command-line to start gitweb on your working2352 repository. See linkgit:git-instaweb[1].23532354instaweb.local::2355 If true the web server started by linkgit:git-instaweb[1] will2356 be bound to the local IP (127.0.0.1).23572358instaweb.modulePath::2359 The default module path for linkgit:git-instaweb[1] to use2360 instead of /usr/lib/apache2/modules. Only used if httpd2361 is Apache.23622363instaweb.port::2364 The port number to bind the gitweb httpd to. See2365 linkgit:git-instaweb[1].23662367interactive.singleKey::2368 In interactive commands, allow the user to provide one-letter2369 input with a single key (i.e., without hitting enter).2370 Currently this is used by the `--patch` mode of2371 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2372 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2373 setting is silently ignored if portable keystroke input2374 is not available; requires the Perl module Term::ReadKey.23752376interactive.diffFilter::2377 When an interactive command (such as `git add --patch`) shows2378 a colorized diff, git will pipe the diff through the shell2379 command defined by this configuration variable. The command may2380 mark up the diff further for human consumption, provided that it2381 retains a one-to-one correspondence with the lines in the2382 original diff. Defaults to disabled (no filtering).23832384log.abbrevCommit::2385 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2386 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2387 override this option with `--no-abbrev-commit`.23882389log.date::2390 Set the default date-time mode for the 'log' command.2391 Setting a value for log.date is similar to using 'git log''s2392 `--date` option. See linkgit:git-log[1] for details.23932394log.decorate::2395 Print out the ref names of any commits that are shown by the log2396 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2397 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2398 specified, the full ref name (including prefix) will be printed.2399 If 'auto' is specified, then if the output is going to a terminal,2400 the ref names are shown as if 'short' were given, otherwise no ref2401 names are shown. This is the same as the `--decorate` option2402 of the `git log`.24032404log.follow::2405 If `true`, `git log` will act as if the `--follow` option was used when2406 a single <path> is given. This has the same limitations as `--follow`,2407 i.e. it cannot be used to follow multiple files and does not work well2408 on non-linear history.24092410log.graphColors::2411 A list of colors, separated by commas, that can be used to draw2412 history lines in `git log --graph`.24132414log.showRoot::2415 If true, the initial commit will be shown as a big creation event.2416 This is equivalent to a diff against an empty tree.2417 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2418 normally hide the root commit will now show it. True by default.24192420log.showSignature::2421 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2422 linkgit:git-whatchanged[1] assume `--show-signature`.24232424log.mailmap::2425 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2426 linkgit:git-whatchanged[1] assume `--use-mailmap`.24272428mailinfo.scissors::2429 If true, makes linkgit:git-mailinfo[1] (and therefore2430 linkgit:git-am[1]) act by default as if the --scissors option2431 was provided on the command-line. When active, this features2432 removes everything from the message body before a scissors2433 line (i.e. consisting mainly of ">8", "8<" and "-").24342435mailmap.file::2436 The location of an augmenting mailmap file. The default2437 mailmap, located in the root of the repository, is loaded2438 first, then the mailmap file pointed to by this variable.2439 The location of the mailmap file may be in a repository2440 subdirectory, or somewhere outside of the repository itself.2441 See linkgit:git-shortlog[1] and linkgit:git-blame[1].24422443mailmap.blob::2444 Like `mailmap.file`, but consider the value as a reference to a2445 blob in the repository. If both `mailmap.file` and2446 `mailmap.blob` are given, both are parsed, with entries from2447 `mailmap.file` taking precedence. In a bare repository, this2448 defaults to `HEAD:.mailmap`. In a non-bare repository, it2449 defaults to empty.24502451man.viewer::2452 Specify the programs that may be used to display help in the2453 'man' format. See linkgit:git-help[1].24542455man.<tool>.cmd::2456 Specify the command to invoke the specified man viewer. The2457 specified command is evaluated in shell with the man page2458 passed as argument. (See linkgit:git-help[1].)24592460man.<tool>.path::2461 Override the path for the given tool that may be used to2462 display help in the 'man' format. See linkgit:git-help[1].24632464include::merge-config.txt[]24652466mergetool.<tool>.path::2467 Override the path for the given tool. This is useful in case2468 your tool is not in the PATH.24692470mergetool.<tool>.cmd::2471 Specify the command to invoke the specified merge tool. The2472 specified command is evaluated in shell with the following2473 variables available: 'BASE' is the name of a temporary file2474 containing the common base of the files to be merged, if available;2475 'LOCAL' is the name of a temporary file containing the contents of2476 the file on the current branch; 'REMOTE' is the name of a temporary2477 file containing the contents of the file from the branch being2478 merged; 'MERGED' contains the name of the file to which the merge2479 tool should write the results of a successful merge.24802481mergetool.<tool>.trustExitCode::2482 For a custom merge command, specify whether the exit code of2483 the merge command can be used to determine whether the merge was2484 successful. If this is not set to true then the merge target file2485 timestamp is checked and the merge assumed to have been successful2486 if the file has been updated, otherwise the user is prompted to2487 indicate the success of the merge.24882489mergetool.meld.hasOutput::2490 Older versions of `meld` do not support the `--output` option.2491 Git will attempt to detect whether `meld` supports `--output`2492 by inspecting the output of `meld --help`. Configuring2493 `mergetool.meld.hasOutput` will make Git skip these checks and2494 use the configured value instead. Setting `mergetool.meld.hasOutput`2495 to `true` tells Git to unconditionally use the `--output` option,2496 and `false` avoids using `--output`.24972498mergetool.keepBackup::2499 After performing a merge, the original file with conflict markers2500 can be saved as a file with a `.orig` extension. If this variable2501 is set to `false` then this file is not preserved. Defaults to2502 `true` (i.e. keep the backup files).25032504mergetool.keepTemporaries::2505 When invoking a custom merge tool, Git uses a set of temporary2506 files to pass to the tool. If the tool returns an error and this2507 variable is set to `true`, then these temporary files will be2508 preserved, otherwise they will be removed after the tool has2509 exited. Defaults to `false`.25102511mergetool.writeToTemp::2512 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2513 conflicting files in the worktree by default. Git will attempt2514 to use a temporary directory for these files when set `true`.2515 Defaults to `false`.25162517mergetool.prompt::2518 Prompt before each invocation of the merge resolution program.25192520notes.mergeStrategy::2521 Which merge strategy to choose by default when resolving notes2522 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2523 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2524 section of linkgit:git-notes[1] for more information on each strategy.25252526notes.<name>.mergeStrategy::2527 Which merge strategy to choose when doing a notes merge into2528 refs/notes/<name>. This overrides the more general2529 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2530 linkgit:git-notes[1] for more information on the available strategies.25312532notes.displayRef::2533 The (fully qualified) refname from which to show notes when2534 showing commit messages. The value of this variable can be set2535 to a glob, in which case notes from all matching refs will be2536 shown. You may also specify this configuration variable2537 several times. A warning will be issued for refs that do not2538 exist, but a glob that does not match any refs is silently2539 ignored.2540+2541This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2542environment variable, which must be a colon separated list of refs or2543globs.2544+2545The effective value of "core.notesRef" (possibly overridden by2546GIT_NOTES_REF) is also implicitly added to the list of refs to be2547displayed.25482549notes.rewrite.<command>::2550 When rewriting commits with <command> (currently `amend` or2551 `rebase`) and this variable is set to `true`, Git2552 automatically copies your notes from the original to the2553 rewritten commit. Defaults to `true`, but see2554 "notes.rewriteRef" below.25552556notes.rewriteMode::2557 When copying notes during a rewrite (see the2558 "notes.rewrite.<command>" option), determines what to do if2559 the target commit already has a note. Must be one of2560 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2561 Defaults to `concatenate`.2562+2563This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2564environment variable.25652566notes.rewriteRef::2567 When copying notes during a rewrite, specifies the (fully2568 qualified) ref whose notes should be copied. The ref may be a2569 glob, in which case notes in all matching refs will be copied.2570 You may also specify this configuration several times.2571+2572Does not have a default value; you must configure this variable to2573enable note rewriting. Set it to `refs/notes/commits` to enable2574rewriting for the default commit notes.2575+2576This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2577environment variable, which must be a colon separated list of refs or2578globs.25792580pack.window::2581 The size of the window used by linkgit:git-pack-objects[1] when no2582 window size is given on the command line. Defaults to 10.25832584pack.depth::2585 The maximum delta depth used by linkgit:git-pack-objects[1] when no2586 maximum depth is given on the command line. Defaults to 50.2587 Maximum value is 4095.25882589pack.windowMemory::2590 The maximum size of memory that is consumed by each thread2591 in linkgit:git-pack-objects[1] for pack window memory when2592 no limit is given on the command line. The value can be2593 suffixed with "k", "m", or "g". When left unconfigured (or2594 set explicitly to 0), there will be no limit.25952596pack.compression::2597 An integer -1..9, indicating the compression level for objects2598 in a pack file. -1 is the zlib default. 0 means no2599 compression, and 1..9 are various speed/size tradeoffs, 9 being2600 slowest. If not set, defaults to core.compression. If that is2601 not set, defaults to -1, the zlib default, which is "a default2602 compromise between speed and compression (currently equivalent2603 to level 6)."2604+2605Note that changing the compression level will not automatically recompress2606all existing objects. You can force recompression by passing the -F option2607to linkgit:git-repack[1].26082609pack.deltaCacheSize::2610 The maximum memory in bytes used for caching deltas in2611 linkgit:git-pack-objects[1] before writing them out to a pack.2612 This cache is used to speed up the writing object phase by not2613 having to recompute the final delta result once the best match2614 for all objects is found. Repacking large repositories on machines2615 which are tight with memory might be badly impacted by this though,2616 especially if this cache pushes the system into swapping.2617 A value of 0 means no limit. The smallest size of 1 byte may be2618 used to virtually disable this cache. Defaults to 256 MiB.26192620pack.deltaCacheLimit::2621 The maximum size of a delta, that is cached in2622 linkgit:git-pack-objects[1]. This cache is used to speed up the2623 writing object phase by not having to recompute the final delta2624 result once the best match for all objects is found.2625 Defaults to 1000. Maximum value is 65535.26262627pack.threads::2628 Specifies the number of threads to spawn when searching for best2629 delta matches. This requires that linkgit:git-pack-objects[1]2630 be compiled with pthreads otherwise this option is ignored with a2631 warning. This is meant to reduce packing time on multiprocessor2632 machines. The required amount of memory for the delta search window2633 is however multiplied by the number of threads.2634 Specifying 0 will cause Git to auto-detect the number of CPU's2635 and set the number of threads accordingly.26362637pack.indexVersion::2638 Specify the default pack index version. Valid values are 1 for2639 legacy pack index used by Git versions prior to 1.5.2, and 2 for2640 the new pack index with capabilities for packs larger than 4 GB2641 as well as proper protection against the repacking of corrupted2642 packs. Version 2 is the default. Note that version 2 is enforced2643 and this config option ignored whenever the corresponding pack is2644 larger than 2 GB.2645+2646If you have an old Git that does not understand the version 2 `*.idx` file,2647cloning or fetching over a non native protocol (e.g. "http")2648that will copy both `*.pack` file and corresponding `*.idx` file from the2649other side may give you a repository that cannot be accessed with your2650older version of Git. If the `*.pack` file is smaller than 2 GB, however,2651you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2652the `*.idx` file.26532654pack.packSizeLimit::2655 The maximum size of a pack. This setting only affects2656 packing to a file when repacking, i.e. the git:// protocol2657 is unaffected. It can be overridden by the `--max-pack-size`2658 option of linkgit:git-repack[1]. Reaching this limit results2659 in the creation of multiple packfiles; which in turn prevents2660 bitmaps from being created.2661 The minimum size allowed is limited to 1 MiB.2662 The default is unlimited.2663 Common unit suffixes of 'k', 'm', or 'g' are2664 supported.26652666pack.useBitmaps::2667 When true, git will use pack bitmaps (if available) when packing2668 to stdout (e.g., during the server side of a fetch). Defaults to2669 true. You should not generally need to turn this off unless2670 you are debugging pack bitmaps.26712672pack.writeBitmaps (deprecated)::2673 This is a deprecated synonym for `repack.writeBitmaps`.26742675pack.writeBitmapHashCache::2676 When true, git will include a "hash cache" section in the bitmap2677 index (if one is written). This cache can be used to feed git's2678 delta heuristics, potentially leading to better deltas between2679 bitmapped and non-bitmapped objects (e.g., when serving a fetch2680 between an older, bitmapped pack and objects that have been2681 pushed since the last gc). The downside is that it consumes 42682 bytes per object of disk space, and that JGit's bitmap2683 implementation does not understand it, causing it to complain if2684 Git and JGit are used on the same repository. Defaults to false.26852686pager.<cmd>::2687 If the value is boolean, turns on or off pagination of the2688 output of a particular Git subcommand when writing to a tty.2689 Otherwise, turns on pagination for the subcommand using the2690 pager specified by the value of `pager.<cmd>`. If `--paginate`2691 or `--no-pager` is specified on the command line, it takes2692 precedence over this option. To disable pagination for all2693 commands, set `core.pager` or `GIT_PAGER` to `cat`.26942695pretty.<name>::2696 Alias for a --pretty= format string, as specified in2697 linkgit:git-log[1]. Any aliases defined here can be used just2698 as the built-in pretty formats could. For example,2699 running `git config pretty.changelog "format:* %H %s"`2700 would cause the invocation `git log --pretty=changelog`2701 to be equivalent to running `git log "--pretty=format:* %H %s"`.2702 Note that an alias with the same name as a built-in format2703 will be silently ignored.27042705protocol.allow::2706 If set, provide a user defined default policy for all protocols which2707 don't explicitly have a policy (`protocol.<name>.allow`). By default,2708 if unset, known-safe protocols (http, https, git, ssh, file) have a2709 default policy of `always`, known-dangerous protocols (ext) have a2710 default policy of `never`, and all other protocols have a default2711 policy of `user`. Supported policies:2712+2713--27142715* `always` - protocol is always able to be used.27162717* `never` - protocol is never able to be used.27182719* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2720 either unset or has a value of 1. This policy should be used when you want a2721 protocol to be directly usable by the user but don't want it used by commands which2722 execute clone/fetch/push commands without user input, e.g. recursive2723 submodule initialization.27242725--27262727protocol.<name>.allow::2728 Set a policy to be used by protocol `<name>` with clone/fetch/push2729 commands. See `protocol.allow` above for the available policies.2730+2731The protocol names currently used by git are:2732+2733--2734 - `file`: any local file-based path (including `file://` URLs,2735 or local paths)27362737 - `git`: the anonymous git protocol over a direct TCP2738 connection (or proxy, if configured)27392740 - `ssh`: git over ssh (including `host:path` syntax,2741 `ssh://`, etc).27422743 - `http`: git over http, both "smart http" and "dumb http".2744 Note that this does _not_ include `https`; if you want to configure2745 both, you must do so individually.27462747 - any external helpers are named by their protocol (e.g., use2748 `hg` to allow the `git-remote-hg` helper)2749--27502751protocol.version::2752 Experimental. If set, clients will attempt to communicate with a2753 server using the specified protocol version. If unset, no2754 attempt will be made by the client to communicate using a2755 particular protocol version, this results in protocol version 02756 being used.2757 Supported versions:2758+2759--27602761* `0` - the original wire protocol.27622763* `1` - the original wire protocol with the addition of a version string2764 in the initial response from the server.27652766--27672768pull.ff::2769 By default, Git does not create an extra merge commit when merging2770 a commit that is a descendant of the current commit. Instead, the2771 tip of the current branch is fast-forwarded. When set to `false`,2772 this variable tells Git to create an extra merge commit in such2773 a case (equivalent to giving the `--no-ff` option from the command2774 line). When set to `only`, only such fast-forward merges are2775 allowed (equivalent to giving the `--ff-only` option from the2776 command line). This setting overrides `merge.ff` when pulling.27772778pull.rebase::2779 When true, rebase branches on top of the fetched branch, instead2780 of merging the default branch from the default remote when "git2781 pull" is run. See "branch.<name>.rebase" for setting this on a2782 per-branch basis.2783+2784When `merges`, pass the `--rebase-merges` option to 'git rebase'2785so that the local merge commits are included in the rebase (see2786linkgit:git-rebase[1] for details).2787+2788When preserve, also pass `--preserve-merges` along to 'git rebase'2789so that locally committed merge commits will not be flattened2790by running 'git pull'.2791+2792When the value is `interactive`, the rebase is run in interactive mode.2793+2794*NOTE*: this is a possibly dangerous operation; do *not* use2795it unless you understand the implications (see linkgit:git-rebase[1]2796for details).27972798pull.octopus::2799 The default merge strategy to use when pulling multiple branches2800 at once.28012802pull.twohead::2803 The default merge strategy to use when pulling a single branch.28042805push.default::2806 Defines the action `git push` should take if no refspec is2807 explicitly given. Different values are well-suited for2808 specific workflows; for instance, in a purely central workflow2809 (i.e. the fetch source is equal to the push destination),2810 `upstream` is probably what you want. Possible values are:2811+2812--28132814* `nothing` - do not push anything (error out) unless a refspec is2815 explicitly given. This is primarily meant for people who want to2816 avoid mistakes by always being explicit.28172818* `current` - push the current branch to update a branch with the same2819 name on the receiving end. Works in both central and non-central2820 workflows.28212822* `upstream` - push the current branch back to the branch whose2823 changes are usually integrated into the current branch (which is2824 called `@{upstream}`). This mode only makes sense if you are2825 pushing to the same repository you would normally pull from2826 (i.e. central workflow).28272828* `tracking` - This is a deprecated synonym for `upstream`.28292830* `simple` - in centralized workflow, work like `upstream` with an2831 added safety to refuse to push if the upstream branch's name is2832 different from the local one.2833+2834When pushing to a remote that is different from the remote you normally2835pull from, work as `current`. This is the safest option and is suited2836for beginners.2837+2838This mode has become the default in Git 2.0.28392840* `matching` - push all branches having the same name on both ends.2841 This makes the repository you are pushing to remember the set of2842 branches that will be pushed out (e.g. if you always push 'maint'2843 and 'master' there and no other branches, the repository you push2844 to will have these two branches, and your local 'maint' and2845 'master' will be pushed there).2846+2847To use this mode effectively, you have to make sure _all_ the2848branches you would push out are ready to be pushed out before2849running 'git push', as the whole point of this mode is to allow you2850to push all of the branches in one go. If you usually finish work2851on only one branch and push out the result, while other branches are2852unfinished, this mode is not for you. Also this mode is not2853suitable for pushing into a shared central repository, as other2854people may add new branches there, or update the tip of existing2855branches outside your control.2856+2857This used to be the default, but not since Git 2.0 (`simple` is the2858new default).28592860--28612862push.followTags::2863 If set to true enable `--follow-tags` option by default. You2864 may override this configuration at time of push by specifying2865 `--no-follow-tags`.28662867push.gpgSign::2868 May be set to a boolean value, or the string 'if-asked'. A true2869 value causes all pushes to be GPG signed, as if `--signed` is2870 passed to linkgit:git-push[1]. The string 'if-asked' causes2871 pushes to be signed if the server supports it, as if2872 `--signed=if-asked` is passed to 'git push'. A false value may2873 override a value from a lower-priority config file. An explicit2874 command-line flag always overrides this config option.28752876push.pushOption::2877 When no `--push-option=<option>` argument is given from the2878 command line, `git push` behaves as if each <value> of2879 this variable is given as `--push-option=<value>`.2880+2881This is a multi-valued variable, and an empty value can be used in a2882higher priority configuration file (e.g. `.git/config` in a2883repository) to clear the values inherited from a lower priority2884configuration files (e.g. `$HOME/.gitconfig`).2885+2886--28872888Example:28892890/etc/gitconfig2891 push.pushoption = a2892 push.pushoption = b28932894~/.gitconfig2895 push.pushoption = c28962897repo/.git/config2898 push.pushoption =2899 push.pushoption = b29002901This will result in only b (a and c are cleared).29022903--29042905push.recurseSubmodules::2906 Make sure all submodule commits used by the revisions to be pushed2907 are available on a remote-tracking branch. If the value is 'check'2908 then Git will verify that all submodule commits that changed in the2909 revisions to be pushed are available on at least one remote of the2910 submodule. If any commits are missing, the push will be aborted and2911 exit with non-zero status. If the value is 'on-demand' then all2912 submodules that changed in the revisions to be pushed will be2913 pushed. If on-demand was not able to push all necessary revisions2914 it will also be aborted and exit with non-zero status. If the value2915 is 'no' then default behavior of ignoring submodules when pushing2916 is retained. You may override this configuration at time of push by2917 specifying '--recurse-submodules=check|on-demand|no'.29182919include::rebase-config.txt[]29202921receive.advertiseAtomic::2922 By default, git-receive-pack will advertise the atomic push2923 capability to its clients. If you don't want to advertise this2924 capability, set this variable to false.29252926receive.advertisePushOptions::2927 When set to true, git-receive-pack will advertise the push options2928 capability to its clients. False by default.29292930receive.autogc::2931 By default, git-receive-pack will run "git-gc --auto" after2932 receiving data from git-push and updating refs. You can stop2933 it by setting this variable to false.29342935receive.certNonceSeed::2936 By setting this variable to a string, `git receive-pack`2937 will accept a `git push --signed` and verifies it by using2938 a "nonce" protected by HMAC using this string as a secret2939 key.29402941receive.certNonceSlop::2942 When a `git push --signed` sent a push certificate with a2943 "nonce" that was issued by a receive-pack serving the same2944 repository within this many seconds, export the "nonce"2945 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2946 hooks (instead of what the receive-pack asked the sending2947 side to include). This may allow writing checks in2948 `pre-receive` and `post-receive` a bit easier. Instead of2949 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2950 that records by how many seconds the nonce is stale to2951 decide if they want to accept the certificate, they only2952 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.29532954receive.fsckObjects::2955 If it is set to true, git-receive-pack will check all received2956 objects. It will abort in the case of a malformed object or a2957 broken link. The result of an abort are only dangling objects.2958 Defaults to false. If not set, the value of `transfer.fsckObjects`2959 is used instead.29602961receive.fsck.<msg-id>::2962 When `receive.fsckObjects` is set to true, errors can be switched2963 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2964 setting where the `<msg-id>` is the fsck message ID and the value2965 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2966 the error/warning with the message ID, e.g. "missingEmail: invalid2967 author/committer line - missing email" means that setting2968 `receive.fsck.missingEmail = ignore` will hide that issue.2969+2970This feature is intended to support working with legacy repositories2971which would not pass pushing when `receive.fsckObjects = true`, allowing2972the host to accept repositories with certain known issues but still catch2973other issues.29742975receive.fsck.skipList::2976 The path to a sorted list of object names (i.e. one SHA-1 per2977 line) that are known to be broken in a non-fatal way and should2978 be ignored. This feature is useful when an established project2979 should be accepted despite early commits containing errors that2980 can be safely ignored such as invalid committer email addresses.2981 Note: corrupt objects cannot be skipped with this setting.29822983receive.keepAlive::2984 After receiving the pack from the client, `receive-pack` may2985 produce no output (if `--quiet` was specified) while processing2986 the pack, causing some networks to drop the TCP connection.2987 With this option set, if `receive-pack` does not transmit2988 any data in this phase for `receive.keepAlive` seconds, it will2989 send a short keepalive packet. The default is 5 seconds; set2990 to 0 to disable keepalives entirely.29912992receive.unpackLimit::2993 If the number of objects received in a push is below this2994 limit then the objects will be unpacked into loose object2995 files. However if the number of received objects equals or2996 exceeds this limit then the received pack will be stored as2997 a pack, after adding any missing delta bases. Storing the2998 pack from a push can make the push operation complete faster,2999 especially on slow filesystems. If not set, the value of3000 `transfer.unpackLimit` is used instead.30013002receive.maxInputSize::3003 If the size of the incoming pack stream is larger than this3004 limit, then git-receive-pack will error out, instead of3005 accepting the pack file. If not set or set to 0, then the size3006 is unlimited.30073008receive.denyDeletes::3009 If set to true, git-receive-pack will deny a ref update that deletes3010 the ref. Use this to prevent such a ref deletion via a push.30113012receive.denyDeleteCurrent::3013 If set to true, git-receive-pack will deny a ref update that3014 deletes the currently checked out branch of a non-bare repository.30153016receive.denyCurrentBranch::3017 If set to true or "refuse", git-receive-pack will deny a ref update3018 to the currently checked out branch of a non-bare repository.3019 Such a push is potentially dangerous because it brings the HEAD3020 out of sync with the index and working tree. If set to "warn",3021 print a warning of such a push to stderr, but allow the push to3022 proceed. If set to false or "ignore", allow such pushes with no3023 message. Defaults to "refuse".3024+3025Another option is "updateInstead" which will update the working3026tree if pushing into the current branch. This option is3027intended for synchronizing working directories when one side is not easily3028accessible via interactive ssh (e.g. a live web site, hence the requirement3029that the working directory be clean). This mode also comes in handy when3030developing inside a VM to test and fix code on different Operating Systems.3031+3032By default, "updateInstead" will refuse the push if the working tree or3033the index have any difference from the HEAD, but the `push-to-checkout`3034hook can be used to customize this. See linkgit:githooks[5].30353036receive.denyNonFastForwards::3037 If set to true, git-receive-pack will deny a ref update which is3038 not a fast-forward. Use this to prevent such an update via a push,3039 even if that push is forced. This configuration variable is3040 set when initializing a shared repository.30413042receive.hideRefs::3043 This variable is the same as `transfer.hideRefs`, but applies3044 only to `receive-pack` (and so affects pushes, but not fetches).3045 An attempt to update or delete a hidden ref by `git push` is3046 rejected.30473048receive.updateServerInfo::3049 If set to true, git-receive-pack will run git-update-server-info3050 after receiving data from git-push and updating refs.30513052receive.shallowUpdate::3053 If set to true, .git/shallow can be updated when new refs3054 require new shallow roots. Otherwise those refs are rejected.30553056remote.pushDefault::3057 The remote to push to by default. Overrides3058 `branch.<name>.remote` for all branches, and is overridden by3059 `branch.<name>.pushRemote` for specific branches.30603061remote.<name>.url::3062 The URL of a remote repository. See linkgit:git-fetch[1] or3063 linkgit:git-push[1].30643065remote.<name>.pushurl::3066 The push URL of a remote repository. See linkgit:git-push[1].30673068remote.<name>.proxy::3069 For remotes that require curl (http, https and ftp), the URL to3070 the proxy to use for that remote. Set to the empty string to3071 disable proxying for that remote.30723073remote.<name>.proxyAuthMethod::3074 For remotes that require curl (http, https and ftp), the method to use for3075 authenticating against the proxy in use (probably set in3076 `remote.<name>.proxy`). See `http.proxyAuthMethod`.30773078remote.<name>.fetch::3079 The default set of "refspec" for linkgit:git-fetch[1]. See3080 linkgit:git-fetch[1].30813082remote.<name>.push::3083 The default set of "refspec" for linkgit:git-push[1]. See3084 linkgit:git-push[1].30853086remote.<name>.mirror::3087 If true, pushing to this remote will automatically behave3088 as if the `--mirror` option was given on the command line.30893090remote.<name>.skipDefaultUpdate::3091 If true, this remote will be skipped by default when updating3092 using linkgit:git-fetch[1] or the `update` subcommand of3093 linkgit:git-remote[1].30943095remote.<name>.skipFetchAll::3096 If true, this remote will be skipped by default when updating3097 using linkgit:git-fetch[1] or the `update` subcommand of3098 linkgit:git-remote[1].30993100remote.<name>.receivepack::3101 The default program to execute on the remote side when pushing. See3102 option --receive-pack of linkgit:git-push[1].31033104remote.<name>.uploadpack::3105 The default program to execute on the remote side when fetching. See3106 option --upload-pack of linkgit:git-fetch-pack[1].31073108remote.<name>.tagOpt::3109 Setting this value to --no-tags disables automatic tag following when3110 fetching from remote <name>. Setting it to --tags will fetch every3111 tag from remote <name>, even if they are not reachable from remote3112 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3113 override this setting. See options --tags and --no-tags of3114 linkgit:git-fetch[1].31153116remote.<name>.vcs::3117 Setting this to a value <vcs> will cause Git to interact with3118 the remote with the git-remote-<vcs> helper.31193120remote.<name>.prune::3121 When set to true, fetching from this remote by default will also3122 remove any remote-tracking references that no longer exist on the3123 remote (as if the `--prune` option was given on the command line).3124 Overrides `fetch.prune` settings, if any.31253126remote.<name>.pruneTags::3127 When set to true, fetching from this remote by default will also3128 remove any local tags that no longer exist on the remote if pruning3129 is activated in general via `remote.<name>.prune`, `fetch.prune` or3130 `--prune`. Overrides `fetch.pruneTags` settings, if any.3131+3132See also `remote.<name>.prune` and the PRUNING section of3133linkgit:git-fetch[1].31343135remotes.<group>::3136 The list of remotes which are fetched by "git remote update3137 <group>". See linkgit:git-remote[1].31383139repack.useDeltaBaseOffset::3140 By default, linkgit:git-repack[1] creates packs that use3141 delta-base offset. If you need to share your repository with3142 Git older than version 1.4.4, either directly or via a dumb3143 protocol such as http, then you need to set this option to3144 "false" and repack. Access from old Git versions over the3145 native protocol are unaffected by this option.31463147repack.packKeptObjects::3148 If set to true, makes `git repack` act as if3149 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3150 details. Defaults to `false` normally, but `true` if a bitmap3151 index is being written (either via `--write-bitmap-index` or3152 `repack.writeBitmaps`).31533154repack.writeBitmaps::3155 When true, git will write a bitmap index when packing all3156 objects to disk (e.g., when `git repack -a` is run). This3157 index can speed up the "counting objects" phase of subsequent3158 packs created for clones and fetches, at the cost of some disk3159 space and extra time spent on the initial repack. This has3160 no effect if multiple packfiles are created.3161 Defaults to false.31623163rerere.autoUpdate::3164 When set to true, `git-rerere` updates the index with the3165 resulting contents after it cleanly resolves conflicts using3166 previously recorded resolution. Defaults to false.31673168rerere.enabled::3169 Activate recording of resolved conflicts, so that identical3170 conflict hunks can be resolved automatically, should they be3171 encountered again. By default, linkgit:git-rerere[1] is3172 enabled if there is an `rr-cache` directory under the3173 `$GIT_DIR`, e.g. if "rerere" was previously used in the3174 repository.31753176sendemail.identity::3177 A configuration identity. When given, causes values in the3178 'sendemail.<identity>' subsection to take precedence over3179 values in the 'sendemail' section. The default identity is3180 the value of `sendemail.identity`.31813182sendemail.smtpEncryption::3183 See linkgit:git-send-email[1] for description. Note that this3184 setting is not subject to the 'identity' mechanism.31853186sendemail.smtpssl (deprecated)::3187 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31883189sendemail.smtpsslcertpath::3190 Path to ca-certificates (either a directory or a single file).3191 Set it to an empty string to disable certificate verification.31923193sendemail.<identity>.*::3194 Identity-specific versions of the 'sendemail.*' parameters3195 found below, taking precedence over those when this3196 identity is selected, through either the command-line or3197 `sendemail.identity`.31983199sendemail.aliasesFile::3200sendemail.aliasFileType::3201sendemail.annotate::3202sendemail.bcc::3203sendemail.cc::3204sendemail.ccCmd::3205sendemail.chainReplyTo::3206sendemail.confirm::3207sendemail.envelopeSender::3208sendemail.from::3209sendemail.multiEdit::3210sendemail.signedoffbycc::3211sendemail.smtpPass::3212sendemail.suppresscc::3213sendemail.suppressFrom::3214sendemail.to::3215sendemail.tocmd::3216sendemail.smtpDomain::3217sendemail.smtpServer::3218sendemail.smtpServerPort::3219sendemail.smtpServerOption::3220sendemail.smtpUser::3221sendemail.thread::3222sendemail.transferEncoding::3223sendemail.validate::3224sendemail.xmailer::3225 See linkgit:git-send-email[1] for description.32263227sendemail.signedoffcc (deprecated)::3228 Deprecated alias for `sendemail.signedoffbycc`.32293230sendemail.smtpBatchSize::3231 Number of messages to be sent per connection, after that a relogin3232 will happen. If the value is 0 or undefined, send all messages in3233 one connection.3234 See also the `--batch-size` option of linkgit:git-send-email[1].32353236sendemail.smtpReloginDelay::3237 Seconds wait before reconnecting to smtp server.3238 See also the `--relogin-delay` option of linkgit:git-send-email[1].32393240showbranch.default::3241 The default set of branches for linkgit:git-show-branch[1].3242 See linkgit:git-show-branch[1].32433244splitIndex.maxPercentChange::3245 When the split index feature is used, this specifies the3246 percent of entries the split index can contain compared to the3247 total number of entries in both the split index and the shared3248 index before a new shared index is written.3249 The value should be between 0 and 100. If the value is 0 then3250 a new shared index is always written, if it is 100 a new3251 shared index is never written.3252 By default the value is 20, so a new shared index is written3253 if the number of entries in the split index would be greater3254 than 20 percent of the total number of entries.3255 See linkgit:git-update-index[1].32563257splitIndex.sharedIndexExpire::3258 When the split index feature is used, shared index files that3259 were not modified since the time this variable specifies will3260 be removed when a new shared index file is created. The value3261 "now" expires all entries immediately, and "never" suppresses3262 expiration altogether.3263 The default value is "2.weeks.ago".3264 Note that a shared index file is considered modified (for the3265 purpose of expiration) each time a new split-index file is3266 either created based on it or read from it.3267 See linkgit:git-update-index[1].32683269status.relativePaths::3270 By default, linkgit:git-status[1] shows paths relative to the3271 current directory. Setting this variable to `false` shows paths3272 relative to the repository root (this was the default for Git3273 prior to v1.5.4).32743275status.short::3276 Set to true to enable --short by default in linkgit:git-status[1].3277 The option --no-short takes precedence over this variable.32783279status.branch::3280 Set to true to enable --branch by default in linkgit:git-status[1].3281 The option --no-branch takes precedence over this variable.32823283status.displayCommentPrefix::3284 If set to true, linkgit:git-status[1] will insert a comment3285 prefix before each output line (starting with3286 `core.commentChar`, i.e. `#` by default). This was the3287 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3288 Defaults to false.32893290status.renameLimit::3291 The number of files to consider when performing rename detection3292 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3293 the value of diff.renameLimit.32943295status.renames::3296 Whether and how Git detects renames in linkgit:git-status[1] and3297 linkgit:git-commit[1] . If set to "false", rename detection is3298 disabled. If set to "true", basic rename detection is enabled.3299 If set to "copies" or "copy", Git will detect copies, as well.3300 Defaults to the value of diff.renames.33013302status.showStash::3303 If set to true, linkgit:git-status[1] will display the number of3304 entries currently stashed away.3305 Defaults to false.33063307status.showUntrackedFiles::3308 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3309 files which are not currently tracked by Git. Directories which3310 contain only untracked files, are shown with the directory name3311 only. Showing untracked files means that Git needs to lstat() all3312 the files in the whole repository, which might be slow on some3313 systems. So, this variable controls how the commands displays3314 the untracked files. Possible values are:3315+3316--3317* `no` - Show no untracked files.3318* `normal` - Show untracked files and directories.3319* `all` - Show also individual files in untracked directories.3320--3321+3322If this variable is not specified, it defaults to 'normal'.3323This variable can be overridden with the -u|--untracked-files option3324of linkgit:git-status[1] and linkgit:git-commit[1].33253326status.submoduleSummary::3327 Defaults to false.3328 If this is set to a non zero number or true (identical to -1 or an3329 unlimited number), the submodule summary will be enabled and a3330 summary of commits for modified submodules will be shown (see3331 --summary-limit option of linkgit:git-submodule[1]). Please note3332 that the summary output command will be suppressed for all3333 submodules when `diff.ignoreSubmodules` is set to 'all' or only3334 for those submodules where `submodule.<name>.ignore=all`. The only3335 exception to that rule is that status and commit will show staged3336 submodule changes. To3337 also view the summary for ignored submodules you can either use3338 the --ignore-submodules=dirty command-line option or the 'git3339 submodule summary' command, which shows a similar output but does3340 not honor these settings.33413342stash.showPatch::3343 If this is set to true, the `git stash show` command without an3344 option will show the stash entry in patch form. Defaults to false.3345 See description of 'show' command in linkgit:git-stash[1].33463347stash.showStat::3348 If this is set to true, the `git stash show` command without an3349 option will show diffstat of the stash entry. Defaults to true.3350 See description of 'show' command in linkgit:git-stash[1].33513352submodule.<name>.url::3353 The URL for a submodule. This variable is copied from the .gitmodules3354 file to the git config via 'git submodule init'. The user can change3355 the configured URL before obtaining the submodule via 'git submodule3356 update'. If neither submodule.<name>.active or submodule.active are3357 set, the presence of this variable is used as a fallback to indicate3358 whether the submodule is of interest to git commands.3359 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.33603361submodule.<name>.update::3362 The method by which a submodule is updated by 'git submodule update',3363 which is the only affected command, others such as3364 'git checkout --recurse-submodules' are unaffected. It exists for3365 historical reasons, when 'git submodule' was the only command to3366 interact with submodules; settings like `submodule.active`3367 and `pull.rebase` are more specific. It is populated by3368 `git submodule init` from the linkgit:gitmodules[5] file.3369 See description of 'update' command in linkgit:git-submodule[1].33703371submodule.<name>.branch::3372 The remote branch name for a submodule, used by `git submodule3373 update --remote`. Set this option to override the value found in3374 the `.gitmodules` file. See linkgit:git-submodule[1] and3375 linkgit:gitmodules[5] for details.33763377submodule.<name>.fetchRecurseSubmodules::3378 This option can be used to control recursive fetching of this3379 submodule. It can be overridden by using the --[no-]recurse-submodules3380 command-line option to "git fetch" and "git pull".3381 This setting will override that from in the linkgit:gitmodules[5]3382 file.33833384submodule.<name>.ignore::3385 Defines under what circumstances "git status" and the diff family show3386 a submodule as modified. When set to "all", it will never be considered3387 modified (but it will nonetheless show up in the output of status and3388 commit when it has been staged), "dirty" will ignore all changes3389 to the submodules work tree and3390 takes only differences between the HEAD of the submodule and the commit3391 recorded in the superproject into account. "untracked" will additionally3392 let submodules with modified tracked files in their work tree show up.3393 Using "none" (the default when this option is not set) also shows3394 submodules that have untracked files in their work tree as changed.3395 This setting overrides any setting made in .gitmodules for this submodule,3396 both settings can be overridden on the command line by using the3397 "--ignore-submodules" option. The 'git submodule' commands are not3398 affected by this setting.33993400submodule.<name>.active::3401 Boolean value indicating if the submodule is of interest to git3402 commands. This config option takes precedence over the3403 submodule.active config option. See linkgit:gitsubmodules[7] for3404 details.34053406submodule.active::3407 A repeated field which contains a pathspec used to match against a3408 submodule's path to determine if the submodule is of interest to git3409 commands. See linkgit:gitsubmodules[7] for details.34103411submodule.recurse::3412 Specifies if commands recurse into submodules by default. This3413 applies to all commands that have a `--recurse-submodules` option,3414 except `clone`.3415 Defaults to false.34163417submodule.fetchJobs::3418 Specifies how many submodules are fetched/cloned at the same time.3419 A positive integer allows up to that number of submodules fetched3420 in parallel. A value of 0 will give some reasonable default.3421 If unset, it defaults to 1.34223423submodule.alternateLocation::3424 Specifies how the submodules obtain alternates when submodules are3425 cloned. Possible values are `no`, `superproject`.3426 By default `no` is assumed, which doesn't add references. When the3427 value is set to `superproject` the submodule to be cloned computes3428 its alternates location relative to the superprojects alternate.34293430submodule.alternateErrorStrategy::3431 Specifies how to treat errors with the alternates for a submodule3432 as computed via `submodule.alternateLocation`. Possible values are3433 `ignore`, `info`, `die`. Default is `die`.34343435tag.forceSignAnnotated::3436 A boolean to specify whether annotated tags created should be GPG signed.3437 If `--annotate` is specified on the command line, it takes3438 precedence over this option.34393440tag.sort::3441 This variable controls the sort ordering of tags when displayed by3442 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3443 value of this variable will be used as the default.34443445tar.umask::3446 This variable can be used to restrict the permission bits of3447 tar archive entries. The default is 0002, which turns off the3448 world write bit. The special value "user" indicates that the3449 archiving user's umask will be used instead. See umask(2) and3450 linkgit:git-archive[1].34513452transfer.fsckObjects::3453 When `fetch.fsckObjects` or `receive.fsckObjects` are3454 not set, the value of this variable is used instead.3455 Defaults to false.34563457transfer.hideRefs::3458 String(s) `receive-pack` and `upload-pack` use to decide which3459 refs to omit from their initial advertisements. Use more than3460 one definition to specify multiple prefix strings. A ref that is3461 under the hierarchies listed in the value of this variable is3462 excluded, and is hidden when responding to `git push` or `git3463 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3464 program-specific versions of this config.3465+3466You may also include a `!` in front of the ref name to negate the entry,3467explicitly exposing it, even if an earlier entry marked it as hidden.3468If you have multiple hideRefs values, later entries override earlier ones3469(and entries in more-specific config files override less-specific ones).3470+3471If a namespace is in use, the namespace prefix is stripped from each3472reference before it is matched against `transfer.hiderefs` patterns.3473For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3474the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3475is omitted from the advertisements but `refs/heads/master` and3476`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3477"have" lines. In order to match refs before stripping, add a `^` in front of3478the ref name. If you combine `!` and `^`, `!` must be specified first.3479+3480Even if you hide refs, a client may still be able to steal the target3481objects via the techniques described in the "SECURITY" section of the3482linkgit:gitnamespaces[7] man page; it's best to keep private data in a3483separate repository.34843485transfer.unpackLimit::3486 When `fetch.unpackLimit` or `receive.unpackLimit` are3487 not set, the value of this variable is used instead.3488 The default value is 100.34893490uploadarchive.allowUnreachable::3491 If true, allow clients to use `git archive --remote` to request3492 any tree, whether reachable from the ref tips or not. See the3493 discussion in the "SECURITY" section of3494 linkgit:git-upload-archive[1] for more details. Defaults to3495 `false`.34963497uploadpack.hideRefs::3498 This variable is the same as `transfer.hideRefs`, but applies3499 only to `upload-pack` (and so affects only fetches, not pushes).3500 An attempt to fetch a hidden ref by `git fetch` will fail. See3501 also `uploadpack.allowTipSHA1InWant`.35023503uploadpack.allowTipSHA1InWant::3504 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3505 to accept a fetch request that asks for an object at the tip3506 of a hidden ref (by default, such a request is rejected).3507 See also `uploadpack.hideRefs`. Even if this is false, a client3508 may be able to steal objects via the techniques described in the3509 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3510 best to keep private data in a separate repository.35113512uploadpack.allowReachableSHA1InWant::3513 Allow `upload-pack` to accept a fetch request that asks for an3514 object that is reachable from any ref tip. However, note that3515 calculating object reachability is computationally expensive.3516 Defaults to `false`. Even if this is false, a client may be able3517 to steal objects via the techniques described in the "SECURITY"3518 section of the linkgit:gitnamespaces[7] man page; it's best to3519 keep private data in a separate repository.35203521uploadpack.allowAnySHA1InWant::3522 Allow `upload-pack` to accept a fetch request that asks for any3523 object at all.3524 Defaults to `false`.35253526uploadpack.keepAlive::3527 When `upload-pack` has started `pack-objects`, there may be a3528 quiet period while `pack-objects` prepares the pack. Normally3529 it would output progress information, but if `--quiet` was used3530 for the fetch, `pack-objects` will output nothing at all until3531 the pack data begins. Some clients and networks may consider3532 the server to be hung and give up. Setting this option instructs3533 `upload-pack` to send an empty keepalive packet every3534 `uploadpack.keepAlive` seconds. Setting this option to 03535 disables keepalive packets entirely. The default is 5 seconds.35363537uploadpack.packObjectsHook::3538 If this option is set, when `upload-pack` would run3539 `git pack-objects` to create a packfile for a client, it will3540 run this shell command instead. The `pack-objects` command and3541 arguments it _would_ have run (including the `git pack-objects`3542 at the beginning) are appended to the shell command. The stdin3543 and stdout of the hook are treated as if `pack-objects` itself3544 was run. I.e., `upload-pack` will feed input intended for3545 `pack-objects` to the hook, and expects a completed packfile on3546 stdout.35473548uploadpack.allowFilter::3549 If this option is set, `upload-pack` will support partial3550 clone and partial fetch object filtering.3551+3552Note that this configuration variable is ignored if it is seen in the3553repository-level config (this is a safety measure against fetching from3554untrusted repositories).35553556uploadpack.allowRefInWant::3557 If this option is set, `upload-pack` will support the `ref-in-want`3558 feature of the protocol version 2 `fetch` command. This feature3559 is intended for the benefit of load-balanced servers which may3560 not have the same view of what OIDs their refs point to due to3561 replication delay.35623563url.<base>.insteadOf::3564 Any URL that starts with this value will be rewritten to3565 start, instead, with <base>. In cases where some site serves a3566 large number of repositories, and serves them with multiple3567 access methods, and some users need to use different access3568 methods, this feature allows people to specify any of the3569 equivalent URLs and have Git automatically rewrite the URL to3570 the best alternative for the particular user, even for a3571 never-before-seen repository on the site. When more than one3572 insteadOf strings match a given URL, the longest match is used.3573+3574Note that any protocol restrictions will be applied to the rewritten3575URL. If the rewrite changes the URL to use a custom protocol or remote3576helper, you may need to adjust the `protocol.*.allow` config to permit3577the request. In particular, protocols you expect to use for submodules3578must be set to `always` rather than the default of `user`. See the3579description of `protocol.allow` above.35803581url.<base>.pushInsteadOf::3582 Any URL that starts with this value will not be pushed to;3583 instead, it will be rewritten to start with <base>, and the3584 resulting URL will be pushed to. In cases where some site serves3585 a large number of repositories, and serves them with multiple3586 access methods, some of which do not allow push, this feature3587 allows people to specify a pull-only URL and have Git3588 automatically use an appropriate URL to push, even for a3589 never-before-seen repository on the site. When more than one3590 pushInsteadOf strings match a given URL, the longest match is3591 used. If a remote has an explicit pushurl, Git will ignore this3592 setting for that remote.35933594user.email::3595 Your email address to be recorded in any newly created commits.3596 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3597 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35983599user.name::3600 Your full name to be recorded in any newly created commits.3601 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3602 environment variables. See linkgit:git-commit-tree[1].36033604user.useConfigOnly::3605 Instruct Git to avoid trying to guess defaults for `user.email`3606 and `user.name`, and instead retrieve the values only from the3607 configuration. For example, if you have multiple email addresses3608 and would like to use a different one for each repository, then3609 with this configuration option set to `true` in the global config3610 along with a name, Git will prompt you to set up an email before3611 making new commits in a newly cloned repository.3612 Defaults to `false`.36133614user.signingKey::3615 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3616 key you want it to automatically when creating a signed tag or3617 commit, you can override the default selection with this variable.3618 This option is passed unchanged to gpg's --local-user parameter,3619 so you may specify a key using any method that gpg supports.36203621versionsort.prereleaseSuffix (deprecated)::3622 Deprecated alias for `versionsort.suffix`. Ignored if3623 `versionsort.suffix` is set.36243625versionsort.suffix::3626 Even when version sort is used in linkgit:git-tag[1], tagnames3627 with the same base version but different suffixes are still sorted3628 lexicographically, resulting e.g. in prerelease tags appearing3629 after the main release (e.g. "1.0-rc1" after "1.0"). This3630 variable can be specified to determine the sorting order of tags3631 with different suffixes.3632+3633By specifying a single suffix in this variable, any tagname containing3634that suffix will appear before the corresponding main release. E.g. if3635the variable is set to "-rc", then all "1.0-rcX" tags will appear before3636"1.0". If specified multiple times, once per suffix, then the order of3637suffixes in the configuration will determine the sorting order of tagnames3638with those suffixes. E.g. if "-pre" appears before "-rc" in the3639configuration, then all "1.0-preX" tags will be listed before any3640"1.0-rcX" tags. The placement of the main release tag relative to tags3641with various suffixes can be determined by specifying the empty suffix3642among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3643"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3644are listed first, followed by "v4.8", then "v4.8-ckX" and finally3645"v4.8-bfsX".3646+3647If more than one suffixes match the same tagname, then that tagname will3648be sorted according to the suffix which starts at the earliest position in3649the tagname. If more than one different matching suffixes start at3650that earliest position, then that tagname will be sorted according to the3651longest of those suffixes.3652The sorting order between different suffixes is undefined if they are3653in multiple config files.36543655web.browser::3656 Specify a web browser that may be used by some commands.3657 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3658 may use it.36593660worktree.guessRemote::3661 With `add`, if no branch argument, and neither of `-b` nor3662 `-B` nor `--detach` are given, the command defaults to3663 creating a new branch from HEAD. If `worktree.guessRemote` is3664 set to true, `worktree add` tries to find a remote-tracking3665 branch whose name uniquely matches the new branch name. If3666 such a branch exists, it is checked out and set as "upstream"3667 for the new branch. If no such match can be found, it falls3668 back to creating a new branch from the current HEAD.