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 a value to its canonical form using the `--type=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 resetQuiet:: 337 Advice to consider using the `--quiet` option to linkgit:git-reset[1] 338 when the command takes more than 2 seconds to enumerate unstaged 339 changes after reset. 340 resolveConflict:: 341 Advice shown by various commands when conflicts 342 prevent the operation from being performed. 343 implicitIdentity:: 344 Advice on how to set your identity configuration when 345 your information is guessed from the system username and 346 domain name. 347 detachedHead:: 348 Advice shown when you used linkgit:git-checkout[1] to 349 move to the detach HEAD state, to instruct how to create 350 a local branch after the fact. 351 checkoutAmbiguousRemoteBranchName:: 352 Advice shown when the argument to 353 linkgit:git-checkout[1] ambiguously resolves to a 354 remote tracking branch on more than one remote in 355 situations where an unambiguous argument would have 356 otherwise caused a remote-tracking branch to be 357 checked out. See the `checkout.defaultRemote` 358 configuration variable for how to set a given remote 359 to used by default in some situations where this 360 advice would be printed. 361 amWorkDir:: 362 Advice that shows the location of the patch file when 363 linkgit:git-am[1] fails to apply it. 364 rmHints:: 365 In case of failure in the output of linkgit:git-rm[1], 366 show directions on how to proceed from the current state. 367 addEmbeddedRepo:: 368 Advice on what to do when you've accidentally added one 369 git repo inside of another. 370 ignoredHook:: 371 Advice shown if a hook is ignored because the hook is not 372 set as executable. 373 waitingForEditor:: 374 Print a message to the terminal whenever Git is waiting for 375 editor input from the user. 376-- 377 378core.fileMode:: 379 Tells Git if the executable bit of files in the working tree 380 is to be honored. 381+ 382Some filesystems lose the executable bit when a file that is 383marked as executable is checked out, or checks out a 384non-executable file with executable bit on. 385linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 386to see if it handles the executable bit correctly 387and this variable is automatically set as necessary. 388+ 389A repository, however, may be on a filesystem that handles 390the filemode correctly, and this variable is set to 'true' 391when created, but later may be made accessible from another 392environment that loses the filemode (e.g. exporting ext4 via 393CIFS mount, visiting a Cygwin created repository with 394Git for Windows or Eclipse). 395In such a case it may be necessary to set this variable to 'false'. 396See linkgit:git-update-index[1]. 397+ 398The default is true (when core.filemode is not specified in the config file). 399 400core.hideDotFiles:: 401 (Windows-only) If true, mark newly-created directories and files whose 402 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 403 directory is hidden, but no other files starting with a dot. The 404 default mode is 'dotGitOnly'. 405 406core.ignoreCase:: 407 Internal variable which enables various workarounds to enable 408 Git to work better on filesystems that are not case sensitive, 409 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 410 finds "makefile" when Git expects "Makefile", Git will assume 411 it is really the same file, and continue to remember it as 412 "Makefile". 413+ 414The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 415will probe and set core.ignoreCase true if appropriate when the repository 416is created. 417+ 418Git relies on the proper configuration of this variable for your operating 419and file system. Modifying this value may result in unexpected behavior. 420 421core.precomposeUnicode:: 422 This option is only used by Mac OS implementation of Git. 423 When core.precomposeUnicode=true, Git reverts the unicode decomposition 424 of filenames done by Mac OS. This is useful when sharing a repository 425 between Mac OS and Linux or Windows. 426 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 427 When false, file names are handled fully transparent by Git, 428 which is backward compatible with older versions of Git. 429 430core.protectHFS:: 431 If set to true, do not allow checkout of paths that would 432 be considered equivalent to `.git` on an HFS+ filesystem. 433 Defaults to `true` on Mac OS, and `false` elsewhere. 434 435core.protectNTFS:: 436 If set to true, do not allow checkout of paths that would 437 cause problems with the NTFS filesystem, e.g. conflict with 438 8.3 "short" names. 439 Defaults to `true` on Windows, and `false` elsewhere. 440 441core.fsmonitor:: 442 If set, the value of this variable is used as a command which 443 will identify all files that may have changed since the 444 requested date/time. This information is used to speed up git by 445 avoiding unnecessary processing of files that have not changed. 446 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 447 448core.trustctime:: 449 If false, the ctime differences between the index and the 450 working tree are ignored; useful when the inode change time 451 is regularly modified by something outside Git (file system 452 crawlers and some backup systems). 453 See linkgit:git-update-index[1]. True by default. 454 455core.splitIndex:: 456 If true, the split-index feature of the index will be used. 457 See linkgit:git-update-index[1]. False by default. 458 459core.untrackedCache:: 460 Determines what to do about the untracked cache feature of the 461 index. It will be kept, if this variable is unset or set to 462 `keep`. It will automatically be added if set to `true`. And 463 it will automatically be removed, if set to `false`. Before 464 setting it to `true`, you should check that mtime is working 465 properly on your system. 466 See linkgit:git-update-index[1]. `keep` by default. 467 468core.checkStat:: 469 When missing or is set to `default`, many fields in the stat 470 structure are checked to detect if a file has been modified 471 since Git looked at it. When this configuration variable is 472 set to `minimal`, sub-second part of mtime and ctime, the 473 uid and gid of the owner of the file, the inode number (and 474 the device number, if Git was compiled to use it), are 475 excluded from the check among these fields, leaving only the 476 whole-second part of mtime (and ctime, if `core.trustCtime` 477 is set) and the filesize to be checked. 478+ 479There are implementations of Git that do not leave usable values in 480some fields (e.g. JGit); by excluding these fields from the 481comparison, the `minimal` mode may help interoperability when the 482same repository is used by these other systems at the same time. 483 484core.quotePath:: 485 Commands that output paths (e.g. 'ls-files', 'diff'), will 486 quote "unusual" characters in the pathname by enclosing the 487 pathname in double-quotes and escaping those characters with 488 backslashes in the same way C escapes control characters (e.g. 489 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 490 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 491 UTF-8). If this variable is set to false, bytes higher than 492 0x80 are not considered "unusual" any more. Double-quotes, 493 backslash and control characters are always escaped regardless 494 of the setting of this variable. A simple space character is 495 not considered "unusual". Many commands can output pathnames 496 completely verbatim using the `-z` option. The default value 497 is true. 498 499core.eol:: 500 Sets the line ending type to use in the working directory for 501 files that have the `text` property set when core.autocrlf is false. 502 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 503 native line ending. The default value is `native`. See 504 linkgit:gitattributes[5] for more information on end-of-line 505 conversion. 506 507core.safecrlf:: 508 If true, makes Git check if converting `CRLF` is reversible when 509 end-of-line conversion is active. Git will verify if a command 510 modifies a file in the work tree either directly or indirectly. 511 For example, committing a file followed by checking out the 512 same file should yield the original file in the work tree. If 513 this is not the case for the current setting of 514 `core.autocrlf`, Git will reject the file. The variable can 515 be set to "warn", in which case Git will only warn about an 516 irreversible conversion but continue the operation. 517+ 518CRLF conversion bears a slight chance of corrupting data. 519When it is enabled, Git will convert CRLF to LF during commit and LF to 520CRLF during checkout. A file that contains a mixture of LF and 521CRLF before the commit cannot be recreated by Git. For text 522files this is the right thing to do: it corrects line endings 523such that we have only LF line endings in the repository. 524But for binary files that are accidentally classified as text the 525conversion can corrupt data. 526+ 527If you recognize such corruption early you can easily fix it by 528setting the conversion type explicitly in .gitattributes. Right 529after committing you still have the original file in your work 530tree and this file is not yet corrupted. You can explicitly tell 531Git that this file is binary and Git will handle the file 532appropriately. 533+ 534Unfortunately, the desired effect of cleaning up text files with 535mixed line endings and the undesired effect of corrupting binary 536files cannot be distinguished. In both cases CRLFs are removed 537in an irreversible way. For text files this is the right thing 538to do because CRLFs are line endings, while for binary files 539converting CRLFs corrupts data. 540+ 541Note, this safety check does not mean that a checkout will generate a 542file identical to the original file for a different setting of 543`core.eol` and `core.autocrlf`, but only for the current one. For 544example, a text file with `LF` would be accepted with `core.eol=lf` 545and could later be checked out with `core.eol=crlf`, in which case the 546resulting file would contain `CRLF`, although the original file 547contained `LF`. However, in both work trees the line endings would be 548consistent, that is either all `LF` or all `CRLF`, but never mixed. A 549file with mixed line endings would be reported by the `core.safecrlf` 550mechanism. 551 552core.autocrlf:: 553 Setting this variable to "true" is the same as setting 554 the `text` attribute to "auto" on all files and core.eol to "crlf". 555 Set to true if you want to have `CRLF` line endings in your 556 working directory and the repository has LF line endings. 557 This variable can be set to 'input', 558 in which case no output conversion is performed. 559 560core.checkRoundtripEncoding:: 561 A comma and/or whitespace separated list of encodings that Git 562 performs UTF-8 round trip checks on if they are used in an 563 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 564 The default value is `SHIFT-JIS`. 565 566core.symlinks:: 567 If false, symbolic links are checked out as small plain files that 568 contain the link text. linkgit:git-update-index[1] and 569 linkgit:git-add[1] will not change the recorded type to regular 570 file. Useful on filesystems like FAT that do not support 571 symbolic links. 572+ 573The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 574will probe and set core.symlinks false if appropriate when the repository 575is created. 576 577core.gitProxy:: 578 A "proxy command" to execute (as 'command host port') instead 579 of establishing direct connection to the remote server when 580 using the Git protocol for fetching. If the variable value is 581 in the "COMMAND for DOMAIN" format, the command is applied only 582 on hostnames ending with the specified domain string. This variable 583 may be set multiple times and is matched in the given order; 584 the first match wins. 585+ 586Can be overridden by the `GIT_PROXY_COMMAND` environment variable 587(which always applies universally, without the special "for" 588handling). 589+ 590The special string `none` can be used as the proxy command to 591specify that no proxy be used for a given domain pattern. 592This is useful for excluding servers inside a firewall from 593proxy use, while defaulting to a common proxy for external domains. 594 595core.sshCommand:: 596 If this variable is set, `git fetch` and `git push` will 597 use the specified command instead of `ssh` when they need to 598 connect to a remote system. The command is in the same form as 599 the `GIT_SSH_COMMAND` environment variable and is overridden 600 when the environment variable is set. 601 602core.ignoreStat:: 603 If true, Git will avoid using lstat() calls to detect if files have 604 changed by setting the "assume-unchanged" bit for those tracked files 605 which it has updated identically in both the index and working tree. 606+ 607When files are modified outside of Git, the user will need to stage 608the modified files explicitly (e.g. see 'Examples' section in 609linkgit:git-update-index[1]). 610Git will not normally detect changes to those files. 611+ 612This is useful on systems where lstat() calls are very slow, such as 613CIFS/Microsoft Windows. 614+ 615False by default. 616 617core.preferSymlinkRefs:: 618 Instead of the default "symref" format for HEAD 619 and other symbolic reference files, use symbolic links. 620 This is sometimes needed to work with old scripts that 621 expect HEAD to be a symbolic link. 622 623core.alternateRefsCommand:: 624 When advertising tips of available history from an alternate, use the shell to 625 execute the specified command instead of linkgit:git-for-each-ref[1]. The 626 first argument is the absolute path of the alternate. Output must contain one 627 hex object id per line (i.e., the same as produce by `git for-each-ref 628 --format='%(objectname)'`). 629+ 630Note that you cannot generally put `git for-each-ref` directly into the config 631value, as it does not take a repository path as an argument (but you can wrap 632the command above in a shell script). 633 634core.alternateRefsPrefixes:: 635 When listing references from an alternate, list only references that begin 636 with the given prefix. Prefixes match as if they were given as arguments to 637 linkgit:git-for-each-ref[1]. To list multiple prefixes, separate them with 638 whitespace. If `core.alternateRefsCommand` is set, setting 639 `core.alternateRefsPrefixes` has no effect. 640 641core.bare:: 642 If true this repository is assumed to be 'bare' and has no 643 working directory associated with it. If this is the case a 644 number of commands that require a working directory will be 645 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 646+ 647This setting is automatically guessed by linkgit:git-clone[1] or 648linkgit:git-init[1] when the repository was created. By default a 649repository that ends in "/.git" is assumed to be not bare (bare = 650false), while all other repositories are assumed to be bare (bare 651= true). 652 653core.worktree:: 654 Set the path to the root of the working tree. 655 If `GIT_COMMON_DIR` environment variable is set, core.worktree 656 is ignored and not used for determining the root of working tree. 657 This can be overridden by the `GIT_WORK_TREE` environment 658 variable and the `--work-tree` command-line option. 659 The value can be an absolute path or relative to the path to 660 the .git directory, which is either specified by --git-dir 661 or GIT_DIR, or automatically discovered. 662 If --git-dir or GIT_DIR is specified but none of 663 --work-tree, GIT_WORK_TREE and core.worktree is specified, 664 the current working directory is regarded as the top level 665 of your working tree. 666+ 667Note that this variable is honored even when set in a configuration 668file in a ".git" subdirectory of a directory and its value differs 669from the latter directory (e.g. "/path/to/.git/config" has 670core.worktree set to "/different/path"), which is most likely a 671misconfiguration. Running Git commands in the "/path/to" directory will 672still use "/different/path" as the root of the work tree and can cause 673confusion unless you know what you are doing (e.g. you are creating a 674read-only snapshot of the same index to a location different from the 675repository's usual working tree). 676 677core.logAllRefUpdates:: 678 Enable the reflog. Updates to a ref <ref> is logged to the file 679 "`$GIT_DIR/logs/<ref>`", by appending the new and old 680 SHA-1, the date/time and the reason of the update, but 681 only when the file exists. If this configuration 682 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 683 file is automatically created for branch heads (i.e. under 684 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 685 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 686 If it is set to `always`, then a missing reflog is automatically 687 created for any ref under `refs/`. 688+ 689This information can be used to determine what commit 690was the tip of a branch "2 days ago". 691+ 692This value is true by default in a repository that has 693a working directory associated with it, and false by 694default in a bare repository. 695 696core.repositoryFormatVersion:: 697 Internal variable identifying the repository format and layout 698 version. 699 700core.sharedRepository:: 701 When 'group' (or 'true'), the repository is made shareable between 702 several users in a group (making sure all the files and objects are 703 group-writable). When 'all' (or 'world' or 'everybody'), the 704 repository will be readable by all users, additionally to being 705 group-shareable. When 'umask' (or 'false'), Git will use permissions 706 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 707 files in the repository will have this mode value. '0xxx' will override 708 user's umask value (whereas the other options will only override 709 requested parts of the user's umask value). Examples: '0660' will make 710 the repo read/write-able for the owner and group, but inaccessible to 711 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 712 repository that is group-readable but not group-writable. 713 See linkgit:git-init[1]. False by default. 714 715core.warnAmbiguousRefs:: 716 If true, Git will warn you if the ref name you passed it is ambiguous 717 and might match multiple refs in the repository. True by default. 718 719core.compression:: 720 An integer -1..9, indicating a default compression level. 721 -1 is the zlib default. 0 means no compression, 722 and 1..9 are various speed/size tradeoffs, 9 being slowest. 723 If set, this provides a default to other compression variables, 724 such as `core.looseCompression` and `pack.compression`. 725 726core.looseCompression:: 727 An integer -1..9, indicating the compression level for objects that 728 are not in a pack file. -1 is the zlib default. 0 means no 729 compression, and 1..9 are various speed/size tradeoffs, 9 being 730 slowest. If not set, defaults to core.compression. If that is 731 not set, defaults to 1 (best speed). 732 733core.packedGitWindowSize:: 734 Number of bytes of a pack file to map into memory in a 735 single mapping operation. Larger window sizes may allow 736 your system to process a smaller number of large pack files 737 more quickly. Smaller window sizes will negatively affect 738 performance due to increased calls to the operating system's 739 memory manager, but may improve performance when accessing 740 a large number of large pack files. 741+ 742Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 743MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 744be reasonable for all users/operating systems. You probably do 745not need to adjust this value. 746+ 747Common unit suffixes of 'k', 'm', or 'g' are supported. 748 749core.packedGitLimit:: 750 Maximum number of bytes to map simultaneously into memory 751 from pack files. If Git needs to access more than this many 752 bytes at once to complete an operation it will unmap existing 753 regions to reclaim virtual address space within the process. 754+ 755Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 756unlimited) on 64 bit platforms. 757This should be reasonable for all users/operating systems, except on 758the largest projects. You probably do not need to adjust this value. 759+ 760Common unit suffixes of 'k', 'm', or 'g' are supported. 761 762core.deltaBaseCacheLimit:: 763 Maximum number of bytes to reserve for caching base objects 764 that may be referenced by multiple deltified objects. By storing the 765 entire decompressed base objects in a cache Git is able 766 to avoid unpacking and decompressing frequently used base 767 objects multiple times. 768+ 769Default is 96 MiB on all platforms. This should be reasonable 770for all users/operating systems, except on the largest projects. 771You probably do not need to adjust this value. 772+ 773Common unit suffixes of 'k', 'm', or 'g' are supported. 774 775core.bigFileThreshold:: 776 Files larger than this size are stored deflated, without 777 attempting delta compression. Storing large files without 778 delta compression avoids excessive memory usage, at the 779 slight expense of increased disk usage. Additionally files 780 larger than this size are always treated as binary. 781+ 782Default is 512 MiB on all platforms. This should be reasonable 783for most projects as source code and other text files can still 784be delta compressed, but larger binary media files won't be. 785+ 786Common unit suffixes of 'k', 'm', or 'g' are supported. 787 788core.excludesFile:: 789 Specifies the pathname to the file that contains patterns to 790 describe paths that are not meant to be tracked, in addition 791 to '.gitignore' (per-directory) and '.git/info/exclude'. 792 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 793 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 794 is used instead. See linkgit:gitignore[5]. 795 796core.askPass:: 797 Some commands (e.g. svn and http interfaces) that interactively 798 ask for a password can be told to use an external program given 799 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 800 environment variable. If not set, fall back to the value of the 801 `SSH_ASKPASS` environment variable or, failing that, a simple password 802 prompt. The external program shall be given a suitable prompt as 803 command-line argument and write the password on its STDOUT. 804 805core.attributesFile:: 806 In addition to '.gitattributes' (per-directory) and 807 '.git/info/attributes', Git looks into this file for attributes 808 (see linkgit:gitattributes[5]). Path expansions are made the same 809 way as for `core.excludesFile`. Its default value is 810 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 811 set or empty, `$HOME/.config/git/attributes` is used instead. 812 813core.hooksPath:: 814 By default Git will look for your hooks in the 815 '$GIT_DIR/hooks' directory. Set this to different path, 816 e.g. '/etc/git/hooks', and Git will try to find your hooks in 817 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 818 in '$GIT_DIR/hooks/pre-receive'. 819+ 820The path can be either absolute or relative. A relative path is 821taken as relative to the directory where the hooks are run (see 822the "DESCRIPTION" section of linkgit:githooks[5]). 823+ 824This configuration variable is useful in cases where you'd like to 825centrally configure your Git hooks instead of configuring them on a 826per-repository basis, or as a more flexible and centralized 827alternative to having an `init.templateDir` where you've changed 828default hooks. 829 830core.editor:: 831 Commands such as `commit` and `tag` that let you edit 832 messages by launching an editor use the value of this 833 variable when it is set, and the environment variable 834 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 835 836core.commentChar:: 837 Commands such as `commit` and `tag` that let you edit 838 messages consider a line that begins with this character 839 commented, and removes them after the editor returns 840 (default '#'). 841+ 842If set to "auto", `git-commit` would select a character that is not 843the beginning character of any line in existing commit messages. 844 845core.filesRefLockTimeout:: 846 The length of time, in milliseconds, to retry when trying to 847 lock an individual reference. Value 0 means not to retry at 848 all; -1 means to try indefinitely. Default is 100 (i.e., 849 retry for 100ms). 850 851core.packedRefsTimeout:: 852 The length of time, in milliseconds, to retry when trying to 853 lock the `packed-refs` file. Value 0 means not to retry at 854 all; -1 means to try indefinitely. Default is 1000 (i.e., 855 retry for 1 second). 856 857core.pager:: 858 Text viewer for use by Git commands (e.g., 'less'). The value 859 is meant to be interpreted by the shell. The order of preference 860 is the `$GIT_PAGER` environment variable, then `core.pager` 861 configuration, then `$PAGER`, and then the default chosen at 862 compile time (usually 'less'). 863+ 864When the `LESS` environment variable is unset, Git sets it to `FRX` 865(if `LESS` environment variable is set, Git does not change it at 866all). If you want to selectively override Git's default setting 867for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 868be passed to the shell by Git, which will translate the final 869command to `LESS=FRX less -S`. The environment does not set the 870`S` option but the command line does, instructing less to truncate 871long lines. Similarly, setting `core.pager` to `less -+F` will 872deactivate the `F` option specified by the environment from the 873command-line, deactivating the "quit if one screen" behavior of 874`less`. One can specifically activate some flags for particular 875commands: for example, setting `pager.blame` to `less -S` enables 876line truncation only for `git blame`. 877+ 878Likewise, when the `LV` environment variable is unset, Git sets it 879to `-c`. You can override this setting by exporting `LV` with 880another value or setting `core.pager` to `lv +c`. 881 882core.whitespace:: 883 A comma separated list of common whitespace problems to 884 notice. 'git diff' will use `color.diff.whitespace` to 885 highlight them, and 'git apply --whitespace=error' will 886 consider them as errors. You can prefix `-` to disable 887 any of them (e.g. `-trailing-space`): 888+ 889* `blank-at-eol` treats trailing whitespaces at the end of the line 890 as an error (enabled by default). 891* `space-before-tab` treats a space character that appears immediately 892 before a tab character in the initial indent part of the line as an 893 error (enabled by default). 894* `indent-with-non-tab` treats a line that is indented with space 895 characters instead of the equivalent tabs as an error (not enabled by 896 default). 897* `tab-in-indent` treats a tab character in the initial indent part of 898 the line as an error (not enabled by default). 899* `blank-at-eof` treats blank lines added at the end of file as an error 900 (enabled by default). 901* `trailing-space` is a short-hand to cover both `blank-at-eol` and 902 `blank-at-eof`. 903* `cr-at-eol` treats a carriage-return at the end of line as 904 part of the line terminator, i.e. with it, `trailing-space` 905 does not trigger if the character before such a carriage-return 906 is not a whitespace (not enabled by default). 907* `tabwidth=<n>` tells how many character positions a tab occupies; this 908 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 909 errors. The default tab width is 8. Allowed values are 1 to 63. 910 911core.fsyncObjectFiles:: 912 This boolean will enable 'fsync()' when writing object files. 913+ 914This is a total waste of time and effort on a filesystem that orders 915data writes properly, but can be useful for filesystems that do not use 916journalling (traditional UNIX filesystems) or that only journal metadata 917and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 918 919core.preloadIndex:: 920 Enable parallel index preload for operations like 'git diff' 921+ 922This can speed up operations like 'git diff' and 'git status' especially 923on filesystems like NFS that have weak caching semantics and thus 924relatively high IO latencies. When enabled, Git will do the 925index comparison to the filesystem data in parallel, allowing 926overlapping IO's. Defaults to true. 927 928core.createObject:: 929 You can set this to 'link', in which case a hardlink followed by 930 a delete of the source are used to make sure that object creation 931 will not overwrite existing objects. 932+ 933On some file system/operating system combinations, this is unreliable. 934Set this config setting to 'rename' there; However, This will remove the 935check that makes sure that existing object files will not get overwritten. 936 937core.notesRef:: 938 When showing commit messages, also show notes which are stored in 939 the given ref. The ref must be fully qualified. If the given 940 ref does not exist, it is not an error but means that no 941 notes should be printed. 942+ 943This setting defaults to "refs/notes/commits", and it can be overridden by 944the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 945 946core.commitGraph:: 947 If true, then git will read the commit-graph file (if it exists) 948 to parse the graph structure of commits. Defaults to false. See 949 linkgit:git-commit-graph[1] for more information. 950 951core.useReplaceRefs:: 952 If set to `false`, behave as if the `--no-replace-objects` 953 option was given on the command line. See linkgit:git[1] and 954 linkgit:git-replace[1] for more information. 955 956core.multiPackIndex:: 957 Use the multi-pack-index file to track multiple packfiles using a 958 single index. See link:technical/multi-pack-index.html[the 959 multi-pack-index design document]. 960 961core.sparseCheckout:: 962 Enable "sparse checkout" feature. See section "Sparse checkout" in 963 linkgit:git-read-tree[1] for more information. 964 965core.abbrev:: 966 Set the length object names are abbreviated to. If 967 unspecified or set to "auto", an appropriate value is 968 computed based on the approximate number of packed objects 969 in your repository, which hopefully is enough for 970 abbreviated object names to stay unique for some time. 971 The minimum length is 4. 972 973add.ignoreErrors:: 974add.ignore-errors (deprecated):: 975 Tells 'git add' to continue adding files when some files cannot be 976 added due to indexing errors. Equivalent to the `--ignore-errors` 977 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 978 as it does not follow the usual naming convention for configuration 979 variables. 980 981alias.*:: 982 Command aliases for the linkgit:git[1] command wrapper - e.g. 983 after defining "alias.last = cat-file commit HEAD", the invocation 984 "git last" is equivalent to "git cat-file commit HEAD". To avoid 985 confusion and troubles with script usage, aliases that 986 hide existing Git commands are ignored. Arguments are split by 987 spaces, the usual shell quoting and escaping is supported. 988 A quote pair or a backslash can be used to quote them. 989+ 990If the alias expansion is prefixed with an exclamation point, 991it will be treated as a shell command. For example, defining 992"alias.new = !gitk --all --not ORIG_HEAD", the invocation 993"git new" is equivalent to running the shell command 994"gitk --all --not ORIG_HEAD". Note that shell commands will be 995executed from the top-level directory of a repository, which may 996not necessarily be the current directory. 997`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 998from the original current directory. See linkgit:git-rev-parse[1]. 9991000am.keepcr::1001 If true, git-am will call git-mailsplit for patches in mbox format1002 with parameter `--keep-cr`. In this case git-mailsplit will1003 not remove `\r` from lines ending with `\r\n`. Can be overridden1004 by giving `--no-keep-cr` from the command line.1005 See linkgit:git-am[1], linkgit:git-mailsplit[1].10061007am.threeWay::1008 By default, `git am` will fail if the patch does not apply cleanly. When1009 set to true, this setting tells `git am` to fall back on 3-way merge if1010 the patch records the identity of blobs it is supposed to apply to and1011 we have those blobs available locally (equivalent to giving the `--3way`1012 option from the command line). Defaults to `false`.1013 See linkgit:git-am[1].10141015apply.ignoreWhitespace::1016 When set to 'change', tells 'git apply' to ignore changes in1017 whitespace, in the same way as the `--ignore-space-change`1018 option.1019 When set to one of: no, none, never, false tells 'git apply' to1020 respect all whitespace differences.1021 See linkgit:git-apply[1].10221023apply.whitespace::1024 Tells 'git apply' how to handle whitespaces, in the same way1025 as the `--whitespace` option. See linkgit:git-apply[1].10261027blame.blankBoundary::1028 Show blank commit object name for boundary commits in1029 linkgit:git-blame[1]. This option defaults to false.10301031blame.coloring::1032 This determines the coloring scheme to be applied to blame1033 output. It can be 'repeatedLines', 'highlightRecent',1034 or 'none' which is the default.10351036blame.date::1037 Specifies the format used to output dates in linkgit:git-blame[1].1038 If unset the iso format is used. For supported values,1039 see the discussion of the `--date` option at linkgit:git-log[1].10401041blame.showEmail::1042 Show the author email instead of author name in linkgit:git-blame[1].1043 This option defaults to false.10441045blame.showRoot::1046 Do not treat root commits as boundaries in linkgit:git-blame[1].1047 This option defaults to false.10481049branch.autoSetupMerge::1050 Tells 'git branch' and 'git checkout' to set up new branches1051 so that linkgit:git-pull[1] will appropriately merge from the1052 starting point branch. Note that even if this option is not set,1053 this behavior can be chosen per-branch using the `--track`1054 and `--no-track` options. The valid settings are: `false` -- no1055 automatic setup is done; `true` -- automatic setup is done when the1056 starting point is a remote-tracking branch; `always` --1057 automatic setup is done when the starting point is either a1058 local branch or remote-tracking1059 branch. This option defaults to true.10601061branch.autoSetupRebase::1062 When a new branch is created with 'git branch' or 'git checkout'1063 that tracks another branch, this variable tells Git to set1064 up pull to rebase instead of merge (see "branch.<name>.rebase").1065 When `never`, rebase is never automatically set to true.1066 When `local`, rebase is set to true for tracked branches of1067 other local branches.1068 When `remote`, rebase is set to true for tracked branches of1069 remote-tracking branches.1070 When `always`, rebase will be set to true for all tracking1071 branches.1072 See "branch.autoSetupMerge" for details on how to set up a1073 branch to track another branch.1074 This option defaults to never.10751076branch.sort::1077 This variable controls the sort ordering of branches when displayed by1078 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the1079 value of this variable will be used as the default.1080 See linkgit:git-for-each-ref[1] field names for valid values.10811082branch.<name>.remote::1083 When on branch <name>, it tells 'git fetch' and 'git push'1084 which remote to fetch from/push to. The remote to push to1085 may be overridden with `remote.pushDefault` (for all branches).1086 The remote to push to, for the current branch, may be further1087 overridden by `branch.<name>.pushRemote`. If no remote is1088 configured, or if you are not on any branch, it defaults to1089 `origin` for fetching and `remote.pushDefault` for pushing.1090 Additionally, `.` (a period) is the current local repository1091 (a dot-repository), see `branch.<name>.merge`'s final note below.10921093branch.<name>.pushRemote::1094 When on branch <name>, it overrides `branch.<name>.remote` for1095 pushing. It also overrides `remote.pushDefault` for pushing1096 from branch <name>. When you pull from one place (e.g. your1097 upstream) and push to another place (e.g. your own publishing1098 repository), you would want to set `remote.pushDefault` to1099 specify the remote to push to for all branches, and use this1100 option to override it for a specific branch.11011102branch.<name>.merge::1103 Defines, together with branch.<name>.remote, the upstream branch1104 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1105 branch to merge and can also affect 'git push' (see push.default).1106 When in branch <name>, it tells 'git fetch' the default1107 refspec to be marked for merging in FETCH_HEAD. The value is1108 handled like the remote part of a refspec, and must match a1109 ref which is fetched from the remote given by1110 "branch.<name>.remote".1111 The merge information is used by 'git pull' (which at first calls1112 'git fetch') to lookup the default branch for merging. Without1113 this option, 'git pull' defaults to merge the first refspec fetched.1114 Specify multiple values to get an octopus merge.1115 If you wish to setup 'git pull' so that it merges into <name> from1116 another branch in the local repository, you can point1117 branch.<name>.merge to the desired branch, and use the relative path1118 setting `.` (a period) for branch.<name>.remote.11191120branch.<name>.mergeOptions::1121 Sets default options for merging into branch <name>. The syntax and1122 supported options are the same as those of linkgit:git-merge[1], but1123 option values containing whitespace characters are currently not1124 supported.11251126branch.<name>.rebase::1127 When true, rebase the branch <name> on top of the fetched branch,1128 instead of merging the default branch from the default remote when1129 "git pull" is run. See "pull.rebase" for doing this in a non1130 branch-specific manner.1131+1132When `merges`, pass the `--rebase-merges` option to 'git rebase'1133so that the local merge commits are included in the rebase (see1134linkgit:git-rebase[1] for details).1135+1136When preserve, also pass `--preserve-merges` along to 'git rebase'1137so that locally committed merge commits will not be flattened1138by running 'git pull'.1139+1140When the value is `interactive`, the rebase is run in interactive mode.1141+1142*NOTE*: this is a possibly dangerous operation; do *not* use1143it unless you understand the implications (see linkgit:git-rebase[1]1144for details).11451146branch.<name>.description::1147 Branch description, can be edited with1148 `git branch --edit-description`. Branch description is1149 automatically added in the format-patch cover letter or1150 request-pull summary.11511152browser.<tool>.cmd::1153 Specify the command to invoke the specified browser. The1154 specified command is evaluated in shell with the URLs passed1155 as arguments. (See linkgit:git-web{litdd}browse[1].)11561157browser.<tool>.path::1158 Override the path for the given tool that may be used to1159 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1160 working repository in gitweb (see linkgit:git-instaweb[1]).11611162checkout.defaultRemote::1163 When you run 'git checkout <something>' and only have one1164 remote, it may implicitly fall back on checking out and1165 tracking e.g. 'origin/<something>'. This stops working as soon1166 as you have more than one remote with a '<something>'1167 reference. This setting allows for setting the name of a1168 preferred remote that should always win when it comes to1169 disambiguation. The typical use-case is to set this to1170 `origin`.1171+1172Currently this is used by linkgit:git-checkout[1] when 'git checkout1173<something>' will checkout the '<something>' branch on another remote,1174and by linkgit:git-worktree[1] when 'git worktree add' refers to a1175remote branch. This setting might be used for other checkout-like1176commands or functionality in the future.11771178checkout.optimizeNewBranch::1179 Optimizes the performance of "git checkout -b <new_branch>" when1180 using sparse-checkout. When set to true, git will not update the1181 repo based on the current sparse-checkout settings. This means it1182 will not update the skip-worktree bit in the index nor add/remove1183 files in the working directory to reflect the current sparse checkout1184 settings nor will it show the local changes.11851186clean.requireForce::1187 A boolean to make git-clean do nothing unless given -f,1188 -i or -n. Defaults to true.11891190color.advice::1191 A boolean to enable/disable color in hints (e.g. when a push1192 failed, see `advice.*` for a list). May be set to `always`,1193 `false` (or `never`) or `auto` (or `true`), in which case colors1194 are used only when the error output goes to a terminal. If1195 unset, then the value of `color.ui` is used (`auto` by default).11961197color.advice.hint::1198 Use customized color for hints.11991200color.blame.highlightRecent::1201 This can be used to color the metadata of a blame line depending1202 on age of the line.1203+1204This setting should be set to a comma-separated list of color and date settings,1205starting and ending with a color, the dates should be set from oldest to newest.1206The metadata will be colored given the colors if the the line was introduced1207before the given timestamp, overwriting older timestamped colors.1208+1209Instead of an absolute timestamp relative timestamps work as well, e.g.12102.weeks.ago is valid to address anything older than 2 weeks.1211+1212It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1213everything older than one year blue, recent changes between one month and1214one year old are kept white, and lines introduced within the last month are1215colored red.12161217color.blame.repeatedLines::1218 Use the customized color for the part of git-blame output that1219 is repeated meta information per line (such as commit id,1220 author name, date and timezone). Defaults to cyan.12211222color.branch::1223 A boolean to enable/disable color in the output of1224 linkgit:git-branch[1]. May be set to `always`,1225 `false` (or `never`) or `auto` (or `true`), in which case colors are used1226 only when the output is to a terminal. If unset, then the1227 value of `color.ui` is used (`auto` by default).12281229color.branch.<slot>::1230 Use customized color for branch coloration. `<slot>` is one of1231 `current` (the current branch), `local` (a local branch),1232 `remote` (a remote-tracking branch in refs/remotes/),1233 `upstream` (upstream tracking branch), `plain` (other1234 refs).12351236color.diff::1237 Whether to use ANSI escape sequences to add color to patches.1238 If this is set to `always`, linkgit:git-diff[1],1239 linkgit:git-log[1], and linkgit:git-show[1] will use color1240 for all patches. If it is set to `true` or `auto`, those1241 commands will only use color when output is to the terminal.1242 If unset, then the value of `color.ui` is used (`auto` by1243 default).1244+1245This does not affect linkgit:git-format-patch[1] or the1246'git-diff-{asterisk}' plumbing commands. Can be overridden on the1247command line with the `--color[=<when>]` option.12481249color.diff.<slot>::1250 Use customized color for diff colorization. `<slot>` specifies1251 which part of the patch to use the specified color, and is one1252 of `context` (context text - `plain` is a historical synonym),1253 `meta` (metainformation), `frag`1254 (hunk header), 'func' (function in hunk header), `old` (removed lines),1255 `new` (added lines), `commit` (commit headers), `whitespace`1256 (highlighting whitespace errors), `oldMoved` (deleted lines),1257 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1258 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1259 `newMovedAlternativeDimmed` (See the '<mode>'1260 setting of '--color-moved' in linkgit:git-diff[1] for details),1261 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,1262 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).12631264color.decorate.<slot>::1265 Use customized color for 'git log --decorate' output. `<slot>` is one1266 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1267 branches, remote-tracking branches, tags, stash and HEAD, respectively1268 and `grafted` for grafted commits.12691270color.grep::1271 When set to `always`, always highlight matches. When `false` (or1272 `never`), never. When set to `true` or `auto`, use color only1273 when the output is written to the terminal. If unset, then the1274 value of `color.ui` is used (`auto` by default).12751276color.grep.<slot>::1277 Use customized color for grep colorization. `<slot>` specifies which1278 part of the line to use the specified color, and is one of1279+1280--1281`context`;;1282 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1283`filename`;;1284 filename prefix (when not using `-h`)1285`function`;;1286 function name lines (when using `-p`)1287`lineNumber`;;1288 line number prefix (when using `-n`)1289`column`;;1290 column number prefix (when using `--column`)1291`match`;;1292 matching text (same as setting `matchContext` and `matchSelected`)1293`matchContext`;;1294 matching text in context lines1295`matchSelected`;;1296 matching text in selected lines1297`selected`;;1298 non-matching text in selected lines1299`separator`;;1300 separators between fields on a line (`:`, `-`, and `=`)1301 and between hunks (`--`)1302--13031304color.interactive::1305 When set to `always`, always use colors for interactive prompts1306 and displays (such as those used by "git-add --interactive" and1307 "git-clean --interactive"). When false (or `never`), never.1308 When set to `true` or `auto`, use colors only when the output is1309 to the terminal. If unset, then the value of `color.ui` is1310 used (`auto` by default).13111312color.interactive.<slot>::1313 Use customized color for 'git add --interactive' and 'git clean1314 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1315 or `error`, for four distinct types of normal output from1316 interactive commands.13171318color.pager::1319 A boolean to enable/disable colored output when the pager is in1320 use (default is true).13211322color.push::1323 A boolean to enable/disable color in push errors. May be set to1324 `always`, `false` (or `never`) or `auto` (or `true`), in which1325 case colors are used only when the error output goes to a terminal.1326 If unset, then the value of `color.ui` is used (`auto` by default).13271328color.push.error::1329 Use customized color for push errors.13301331color.remote::1332 If set, keywords at the start of the line are highlighted. The1333 keywords are "error", "warning", "hint" and "success", and are1334 matched case-insensitively. May be set to `always`, `false` (or1335 `never`) or `auto` (or `true`). If unset, then the value of1336 `color.ui` is used (`auto` by default).13371338color.remote.<slot>::1339 Use customized color for each remote keyword. `<slot>` may be1340 `hint`, `warning`, `success` or `error` which match the1341 corresponding keyword.13421343color.showBranch::1344 A boolean to enable/disable color in the output of1345 linkgit:git-show-branch[1]. May be set to `always`,1346 `false` (or `never`) or `auto` (or `true`), in which case colors are used1347 only when the output is to a terminal. If unset, then the1348 value of `color.ui` is used (`auto` by default).13491350color.status::1351 A boolean to enable/disable color in the output of1352 linkgit:git-status[1]. May be set to `always`,1353 `false` (or `never`) or `auto` (or `true`), in which case colors are used1354 only when the output is to a terminal. If unset, then the1355 value of `color.ui` is used (`auto` by default).13561357color.status.<slot>::1358 Use customized color for status colorization. `<slot>` is1359 one of `header` (the header text of the status message),1360 `added` or `updated` (files which are added but not committed),1361 `changed` (files which are changed but not added in the index),1362 `untracked` (files which are not tracked by Git),1363 `branch` (the current branch),1364 `nobranch` (the color the 'no branch' warning is shown in, defaulting1365 to red),1366 `localBranch` or `remoteBranch` (the local and remote branch names,1367 respectively, when branch and tracking information is displayed in the1368 status short-format), or1369 `unmerged` (files which have unmerged changes).13701371color.transport::1372 A boolean to enable/disable color when pushes are rejected. May be1373 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1374 case colors are used only when the error output goes to a terminal.1375 If unset, then the value of `color.ui` is used (`auto` by default).13761377color.transport.rejected::1378 Use customized color when a push was rejected.13791380color.ui::1381 This variable determines the default value for variables such1382 as `color.diff` and `color.grep` that control the use of color1383 per command family. Its scope will expand as more commands learn1384 configuration to set a default for the `--color` option. Set it1385 to `false` or `never` if you prefer Git commands not to use1386 color unless enabled explicitly with some other configuration1387 or the `--color` option. Set it to `always` if you want all1388 output not intended for machine consumption to use color, to1389 `true` or `auto` (this is the default since Git 1.8.4) if you1390 want such output to use color when written to the terminal.13911392column.ui::1393 Specify whether supported commands should output in columns.1394 This variable consists of a list of tokens separated by spaces1395 or commas:1396+1397These options control when the feature should be enabled1398(defaults to 'never'):1399+1400--1401`always`;;1402 always show in columns1403`never`;;1404 never show in columns1405`auto`;;1406 show in columns if the output is to the terminal1407--1408+1409These options control layout (defaults to 'column'). Setting any1410of these implies 'always' if none of 'always', 'never', or 'auto' are1411specified.1412+1413--1414`column`;;1415 fill columns before rows1416`row`;;1417 fill rows before columns1418`plain`;;1419 show in one column1420--1421+1422Finally, these options can be combined with a layout option (defaults1423to 'nodense'):1424+1425--1426`dense`;;1427 make unequal size columns to utilize more space1428`nodense`;;1429 make equal size columns1430--14311432column.branch::1433 Specify whether to output branch listing in `git branch` in columns.1434 See `column.ui` for details.14351436column.clean::1437 Specify the layout when list items in `git clean -i`, which always1438 shows files and directories in columns. See `column.ui` for details.14391440column.status::1441 Specify whether to output untracked files in `git status` in columns.1442 See `column.ui` for details.14431444column.tag::1445 Specify whether to output tag listing in `git tag` in columns.1446 See `column.ui` for details.14471448commit.cleanup::1449 This setting overrides the default of the `--cleanup` option in1450 `git commit`. See linkgit:git-commit[1] for details. Changing the1451 default can be useful when you always want to keep lines that begin1452 with comment character `#` in your log message, in which case you1453 would do `git config commit.cleanup whitespace` (note that you will1454 have to remove the help lines that begin with `#` in the commit log1455 template yourself, if you do this).14561457commit.gpgSign::14581459 A boolean to specify whether all commits should be GPG signed.1460 Use of this option when doing operations such as rebase can1461 result in a large number of commits being signed. It may be1462 convenient to use an agent to avoid typing your GPG passphrase1463 several times.14641465commit.status::1466 A boolean to enable/disable inclusion of status information in the1467 commit message template when using an editor to prepare the commit1468 message. Defaults to true.14691470commit.template::1471 Specify the pathname of a file to use as the template for1472 new commit messages.14731474commit.verbose::1475 A boolean or int to specify the level of verbose with `git commit`.1476 See linkgit:git-commit[1].14771478credential.helper::1479 Specify an external helper to be called when a username or1480 password credential is needed; the helper may consult external1481 storage to avoid prompting the user for the credentials. Note1482 that multiple helpers may be defined. See linkgit:gitcredentials[7]1483 for details.14841485credential.useHttpPath::1486 When acquiring credentials, consider the "path" component of an http1487 or https URL to be important. Defaults to false. See1488 linkgit:gitcredentials[7] for more information.14891490credential.username::1491 If no username is set for a network authentication, use this username1492 by default. See credential.<context>.* below, and1493 linkgit:gitcredentials[7].14941495credential.<url>.*::1496 Any of the credential.* options above can be applied selectively to1497 some credentials. For example "credential.https://example.com.username"1498 would set the default username only for https connections to1499 example.com. See linkgit:gitcredentials[7] for details on how URLs are1500 matched.15011502credentialCache.ignoreSIGHUP::1503 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.15041505completion.commands::1506 This is only used by git-completion.bash to add or remove1507 commands from the list of completed commands. Normally only1508 porcelain commands and a few select others are completed. You1509 can add more commands, separated by space, in this1510 variable. Prefixing the command with '-' will remove it from1511 the existing list.15121513include::diff-config.txt[]15141515difftool.<tool>.path::1516 Override the path for the given tool. This is useful in case1517 your tool is not in the PATH.15181519difftool.<tool>.cmd::1520 Specify the command to invoke the specified diff tool.1521 The specified command is evaluated in shell with the following1522 variables available: 'LOCAL' is set to the name of the temporary1523 file containing the contents of the diff pre-image and 'REMOTE'1524 is set to the name of the temporary file containing the contents1525 of the diff post-image.15261527difftool.prompt::1528 Prompt before each invocation of the diff tool.15291530fastimport.unpackLimit::1531 If the number of objects imported by linkgit:git-fast-import[1]1532 is below this limit, then the objects will be unpacked into1533 loose object files. However if the number of imported objects1534 equals or exceeds this limit then the pack will be stored as a1535 pack. Storing the pack from a fast-import can make the import1536 operation complete faster, especially on slow filesystems. If1537 not set, the value of `transfer.unpackLimit` is used instead.15381539include::fetch-config.txt[]15401541include::format-config.txt[]15421543filter.<driver>.clean::1544 The command which is used to convert the content of a worktree1545 file to a blob upon checkin. See linkgit:gitattributes[5] for1546 details.15471548filter.<driver>.smudge::1549 The command which is used to convert the content of a blob1550 object to a worktree file upon checkout. See1551 linkgit:gitattributes[5] for details.15521553fsck.<msg-id>::1554 During fsck git may find issues with legacy data which1555 wouldn't be generated by current versions of git, and which1556 wouldn't be sent over the wire if `transfer.fsckObjects` was1557 set. This feature is intended to support working with legacy1558 repositories containing such data.1559+1560Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but1561to accept pushes of such data set `receive.fsck.<msg-id>` instead, or1562to clone or fetch it set `fetch.fsck.<msg-id>`.1563+1564The rest of the documentation discusses `fsck.*` for brevity, but the1565same applies for the corresponding `receive.fsck.*` and1566`fetch.<msg-id>.*`. variables.1567+1568Unlike variables like `color.ui` and `core.editor` the1569`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not1570fall back on the `fsck.<msg-id>` configuration if they aren't set. To1571uniformly configure the same fsck settings in different circumstances1572all three of them they must all set to the same values.1573+1574When `fsck.<msg-id>` is set, errors can be switched to warnings and1575vice versa by configuring the `fsck.<msg-id>` setting where the1576`<msg-id>` is the fsck message ID and the value is one of `error`,1577`warn` or `ignore`. For convenience, fsck prefixes the error/warning1578with the message ID, e.g. "missingEmail: invalid author/committer line1579- missing email" means that setting `fsck.missingEmail = ignore` will1580hide that issue.1581+1582In general, it is better to enumerate existing objects with problems1583with `fsck.skipList`, instead of listing the kind of breakages these1584problematic objects share to be ignored, as doing the latter will1585allow new instances of the same breakages go unnoticed.1586+1587Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but1588doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`1589will only cause git to warn.15901591fsck.skipList::1592 The path to a list of object names (i.e. one unabbreviated SHA-1 per1593 line) that are known to be broken in a non-fatal way and should1594 be ignored. On versions of Git 2.20 and later comments ('#'), empty1595 lines, and any leading and trailing whitespace is ignored. Everything1596 but a SHA-1 per line will error out on older versions.1597+1598This feature is useful when an established project should be accepted1599despite early commits containing errors that can be safely ignored1600such as invalid committer email addresses. Note: corrupt objects1601cannot be skipped with this setting.1602+1603Like `fsck.<msg-id>` this variable has corresponding1604`receive.fsck.skipList` and `fetch.fsck.skipList` variants.1605+1606Unlike variables like `color.ui` and `core.editor` the1607`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not1608fall back on the `fsck.skipList` configuration if they aren't set. To1609uniformly configure the same fsck settings in different circumstances1610all three of them they must all set to the same values.1611+1612Older versions of Git (before 2.20) documented that the object names1613list should be sorted. This was never a requirement, the object names1614could appear in any order, but when reading the list we tracked whether1615the list was sorted for the purposes of an internal binary search1616implementation, which could save itself some work with an already sorted1617list. Unless you had a humongous list there was no reason to go out of1618your way to pre-sort the list. After Git version 2.20 a hash implementation1619is used instead, so there's now no reason to pre-sort the list.16201621gc.aggressiveDepth::1622 The depth parameter used in the delta compression1623 algorithm used by 'git gc --aggressive'. This defaults1624 to 50.16251626gc.aggressiveWindow::1627 The window size parameter used in the delta compression1628 algorithm used by 'git gc --aggressive'. This defaults1629 to 250.16301631gc.auto::1632 When there are approximately more than this many loose1633 objects in the repository, `git gc --auto` will pack them.1634 Some Porcelain commands use this command to perform a1635 light-weight garbage collection from time to time. The1636 default value is 6700. Setting this to 0 disables it.16371638gc.autoPackLimit::1639 When there are more than this many packs that are not1640 marked with `*.keep` file in the repository, `git gc1641 --auto` consolidates them into one larger pack. The1642 default value is 50. Setting this to 0 disables it.16431644gc.autoDetach::1645 Make `git gc --auto` return immediately and run in background1646 if the system supports it. Default is true.16471648gc.bigPackThreshold::1649 If non-zero, all packs larger than this limit are kept when1650 `git gc` is run. This is very similar to `--keep-base-pack`1651 except that all packs that meet the threshold are kept, not1652 just the base pack. Defaults to zero. Common unit suffixes of1653 'k', 'm', or 'g' are supported.1654+1655Note that if the number of kept packs is more than gc.autoPackLimit,1656this configuration variable is ignored, all packs except the base pack1657will be repacked. After this the number of packs should go below1658gc.autoPackLimit and gc.bigPackThreshold should be respected again.16591660gc.writeCommitGraph::1661 If true, then gc will rewrite the commit-graph file when1662 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]1663 '--auto' the commit-graph will be updated if housekeeping is1664 required. Default is false. See linkgit:git-commit-graph[1]1665 for details.16661667gc.logExpiry::1668 If the file gc.log exists, then `git gc --auto` will print1669 its content and exit with status zero instead of running1670 unless that file is more than 'gc.logExpiry' old. Default is1671 "1.day". See `gc.pruneExpire` for more ways to specify its1672 value.16731674gc.packRefs::1675 Running `git pack-refs` in a repository renders it1676 unclonable by Git versions prior to 1.5.1.2 over dumb1677 transports such as HTTP. This variable determines whether1678 'git gc' runs `git pack-refs`. This can be set to `notbare`1679 to enable it within all non-bare repos or it can be set to a1680 boolean value. The default is `true`.16811682gc.pruneExpire::1683 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1684 Override the grace period with this config variable. The value1685 "now" may be used to disable this grace period and always prune1686 unreachable objects immediately, or "never" may be used to1687 suppress pruning. This feature helps prevent corruption when1688 'git gc' runs concurrently with another process writing to the1689 repository; see the "NOTES" section of linkgit:git-gc[1].16901691gc.worktreePruneExpire::1692 When 'git gc' is run, it calls1693 'git worktree prune --expire 3.months.ago'.1694 This config variable can be used to set a different grace1695 period. The value "now" may be used to disable the grace1696 period and prune `$GIT_DIR/worktrees` immediately, or "never"1697 may be used to suppress pruning.16981699gc.reflogExpire::1700gc.<pattern>.reflogExpire::1701 'git reflog expire' removes reflog entries older than1702 this time; defaults to 90 days. The value "now" expires all1703 entries immediately, and "never" suppresses expiration1704 altogether. With "<pattern>" (e.g.1705 "refs/stash") in the middle the setting applies only to1706 the refs that match the <pattern>.17071708gc.reflogExpireUnreachable::1709gc.<pattern>.reflogExpireUnreachable::1710 'git reflog expire' removes reflog entries older than1711 this time and are not reachable from the current tip;1712 defaults to 30 days. The value "now" expires all entries1713 immediately, and "never" suppresses expiration altogether.1714 With "<pattern>" (e.g. "refs/stash")1715 in the middle, the setting applies only to the refs that1716 match the <pattern>.17171718gc.rerereResolved::1719 Records of conflicted merge you resolved earlier are1720 kept for this many days when 'git rerere gc' is run.1721 You can also use more human-readable "1.month.ago", etc.1722 The default is 60 days. See linkgit:git-rerere[1].17231724gc.rerereUnresolved::1725 Records of conflicted merge you have not resolved are1726 kept for this many days when 'git rerere gc' is run.1727 You can also use more human-readable "1.month.ago", etc.1728 The default is 15 days. See linkgit:git-rerere[1].17291730include::gitcvs-config.txt[]17311732gitweb.category::1733gitweb.description::1734gitweb.owner::1735gitweb.url::1736 See linkgit:gitweb[1] for description.17371738gitweb.avatar::1739gitweb.blame::1740gitweb.grep::1741gitweb.highlight::1742gitweb.patches::1743gitweb.pickaxe::1744gitweb.remote_heads::1745gitweb.showSizes::1746gitweb.snapshot::1747 See linkgit:gitweb.conf[5] for description.17481749grep.lineNumber::1750 If set to true, enable `-n` option by default.17511752grep.column::1753 If set to true, enable the `--column` option by default.17541755grep.patternType::1756 Set the default matching behavior. Using a value of 'basic', 'extended',1757 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1758 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1759 value 'default' will return to the default matching behavior.17601761grep.extendedRegexp::1762 If set to true, enable `--extended-regexp` option by default. This1763 option is ignored when the `grep.patternType` option is set to a value1764 other than 'default'.17651766grep.threads::1767 Number of grep worker threads to use.1768 See `grep.threads` in linkgit:git-grep[1] for more information.17691770grep.fallbackToNoIndex::1771 If set to true, fall back to git grep --no-index if git grep1772 is executed outside of a git repository. Defaults to false.17731774gpg.program::1775 Use this custom program instead of "`gpg`" found on `$PATH` when1776 making or verifying a PGP signature. The program must support the1777 same command-line interface as GPG, namely, to verify a detached1778 signature, "`gpg --verify $file - <$signature`" is run, and the1779 program is expected to signal a good signature by exiting with1780 code 0, and to generate an ASCII-armored detached signature, the1781 standard input of "`gpg -bsau $key`" is fed with the contents to be1782 signed, and the program is expected to send the result to its1783 standard output.17841785gpg.format::1786 Specifies which key format to use when signing with `--gpg-sign`.1787 Default is "openpgp" and another possible value is "x509".17881789gpg.<format>.program::1790 Use this to customize the program used for the signing format you1791 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still1792 be used as a legacy synonym for `gpg.openpgp.program`. The default1793 value for `gpg.x509.program` is "gpgsm".17941795include::gui-config.txt[]17961797guitool.<name>.cmd::1798 Specifies the shell command line to execute when the corresponding item1799 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1800 mandatory for every tool. The command is executed from the root of1801 the working directory, and in the environment it receives the name of1802 the tool as `GIT_GUITOOL`, the name of the currently selected file as1803 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1804 the head is detached, 'CUR_BRANCH' is empty).18051806guitool.<name>.needsFile::1807 Run the tool only if a diff is selected in the GUI. It guarantees1808 that 'FILENAME' is not empty.18091810guitool.<name>.noConsole::1811 Run the command silently, without creating a window to display its1812 output.18131814guitool.<name>.noRescan::1815 Don't rescan the working directory for changes after the tool1816 finishes execution.18171818guitool.<name>.confirm::1819 Show a confirmation dialog before actually running the tool.18201821guitool.<name>.argPrompt::1822 Request a string argument from the user, and pass it to the tool1823 through the `ARGS` environment variable. Since requesting an1824 argument implies confirmation, the 'confirm' option has no effect1825 if this is enabled. If the option is set to 'true', 'yes', or '1',1826 the dialog uses a built-in generic prompt; otherwise the exact1827 value of the variable is used.18281829guitool.<name>.revPrompt::1830 Request a single valid revision from the user, and set the1831 `REVISION` environment variable. In other aspects this option1832 is similar to 'argPrompt', and can be used together with it.18331834guitool.<name>.revUnmerged::1835 Show only unmerged branches in the 'revPrompt' subdialog.1836 This is useful for tools similar to merge or rebase, but not1837 for things like checkout or reset.18381839guitool.<name>.title::1840 Specifies the title to use for the prompt dialog. The default1841 is the tool name.18421843guitool.<name>.prompt::1844 Specifies the general prompt string to display at the top of1845 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1846 The default value includes the actual command.18471848help.browser::1849 Specify the browser that will be used to display help in the1850 'web' format. See linkgit:git-help[1].18511852help.format::1853 Override the default help format used by linkgit:git-help[1].1854 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1855 the default. 'web' and 'html' are the same.18561857help.autoCorrect::1858 Automatically correct and execute mistyped commands after1859 waiting for the given number of deciseconds (0.1 sec). If more1860 than one command can be deduced from the entered text, nothing1861 will be executed. If the value of this option is negative,1862 the corrected command will be executed immediately. If the1863 value is 0 - the command will be just shown but not executed.1864 This is the default.18651866help.htmlPath::1867 Specify the path where the HTML documentation resides. File system paths1868 and URLs are supported. HTML pages will be prefixed with this path when1869 help is displayed in the 'web' format. This defaults to the documentation1870 path of your Git installation.18711872http.proxy::1873 Override the HTTP proxy, normally configured using the 'http_proxy',1874 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1875 addition to the syntax understood by curl, it is possible to specify a1876 proxy string with a user name but no password, in which case git will1877 attempt to acquire one in the same way it does for other credentials. See1878 linkgit:gitcredentials[7] for more information. The syntax thus is1879 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1880 on a per-remote basis; see remote.<name>.proxy18811882http.proxyAuthMethod::1883 Set the method with which to authenticate against the HTTP proxy. This1884 only takes effect if the configured proxy string contains a user name part1885 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1886 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1887 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1888 variable. Possible values are:1889+1890--1891* `anyauth` - Automatically pick a suitable authentication method. It is1892 assumed that the proxy answers an unauthenticated request with a 4071893 status code and one or more Proxy-authenticate headers with supported1894 authentication methods. This is the default.1895* `basic` - HTTP Basic authentication1896* `digest` - HTTP Digest authentication; this prevents the password from being1897 transmitted to the proxy in clear text1898* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1899 of `curl(1)`)1900* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1901--19021903http.emptyAuth::1904 Attempt authentication without seeking a username or password. This1905 can be used to attempt GSS-Negotiate authentication without specifying1906 a username in the URL, as libcurl normally requires a username for1907 authentication.19081909http.delegation::1910 Control GSSAPI credential delegation. The delegation is disabled1911 by default in libcurl since version 7.21.7. Set parameter to tell1912 the server what it is allowed to delegate when it comes to user1913 credentials. Used with GSS/kerberos. Possible values are:1914+1915--1916* `none` - Don't allow any delegation.1917* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1918 Kerberos service ticket, which is a matter of realm policy.1919* `always` - Unconditionally allow the server to delegate.1920--192119221923http.extraHeader::1924 Pass an additional HTTP header when communicating with a server. If1925 more than one such entry exists, all of them are added as extra1926 headers. To allow overriding the settings inherited from the system1927 config, an empty value will reset the extra headers to the empty list.19281929http.cookieFile::1930 The pathname of a file containing previously stored cookie lines,1931 which should be used1932 in the Git http session, if they match the server. The file format1933 of the file to read cookies from should be plain HTTP headers or1934 the Netscape/Mozilla cookie file format (see `curl(1)`).1935 NOTE that the file specified with http.cookieFile is used only as1936 input unless http.saveCookies is set.19371938http.saveCookies::1939 If set, store cookies received during requests to the file specified by1940 http.cookieFile. Has no effect if http.cookieFile is unset.19411942http.sslVersion::1943 The SSL version to use when negotiating an SSL connection, if you1944 want to force the default. The available and default version1945 depend on whether libcurl was built against NSS or OpenSSL and the1946 particular configuration of the crypto library in use. Internally1947 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1948 documentation for more details on the format of this option and1949 for the ssl version supported. Actually the possible values of1950 this option are:19511952 - sslv21953 - sslv31954 - tlsv11955 - tlsv1.01956 - tlsv1.11957 - tlsv1.21958 - tlsv1.319591960+1961Can be overridden by the `GIT_SSL_VERSION` environment variable.1962To force git to use libcurl's default ssl version and ignore any1963explicit http.sslversion option, set `GIT_SSL_VERSION` to the1964empty string.19651966http.sslCipherList::1967 A list of SSL ciphers to use when negotiating an SSL connection.1968 The available ciphers depend on whether libcurl was built against1969 NSS or OpenSSL and the particular configuration of the crypto1970 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1971 option; see the libcurl documentation for more details on the format1972 of this list.1973+1974Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1975To force git to use libcurl's default cipher list and ignore any1976explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1977empty string.19781979http.sslVerify::1980 Whether to verify the SSL certificate when fetching or pushing1981 over HTTPS. Defaults to true. Can be overridden by the1982 `GIT_SSL_NO_VERIFY` environment variable.19831984http.sslCert::1985 File containing the SSL certificate when fetching or pushing1986 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1987 variable.19881989http.sslKey::1990 File containing the SSL private key when fetching or pushing1991 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1992 variable.19931994http.sslCertPasswordProtected::1995 Enable Git's password prompt for the SSL certificate. Otherwise1996 OpenSSL will prompt the user, possibly many times, if the1997 certificate or private key is encrypted. Can be overridden by the1998 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19992000http.sslCAInfo::2001 File containing the certificates to verify the peer with when2002 fetching or pushing over HTTPS. Can be overridden by the2003 `GIT_SSL_CAINFO` environment variable.20042005http.sslCAPath::2006 Path containing files with the CA certificates to verify the peer2007 with when fetching or pushing over HTTPS. Can be overridden2008 by the `GIT_SSL_CAPATH` environment variable.20092010http.sslBackend::2011 Name of the SSL backend to use (e.g. "openssl" or "schannel").2012 This option is ignored if cURL lacks support for choosing the SSL2013 backend at runtime.20142015http.schannelCheckRevoke::2016 Used to enforce or disable certificate revocation checks in cURL2017 when http.sslBackend is set to "schannel". Defaults to `true` if2018 unset. Only necessary to disable this if Git consistently errors2019 and the message is about checking the revocation status of a2020 certificate. This option is ignored if cURL lacks support for2021 setting the relevant SSL option at runtime.20222023http.schannelUseSSLCAInfo::2024 As of cURL v7.60.0, the Secure Channel backend can use the2025 certificate bundle provided via `http.sslCAInfo`, but that would2026 override the Windows Certificate Store. Since this is not desirable2027 by default, Git will tell cURL not to use that bundle by default2028 when the `schannel` backend was configured via `http.sslBackend`,2029 unless `http.schannelUseSSLCAInfo` overrides this behavior.20302031http.pinnedpubkey::2032 Public key of the https service. It may either be the filename of2033 a PEM or DER encoded public key file or a string starting with2034 'sha256//' followed by the base64 encoded sha256 hash of the2035 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2036 exit with an error if this option is set but not supported by2037 cURL.20382039http.sslTry::2040 Attempt to use AUTH SSL/TLS and encrypted data transfers2041 when connecting via regular FTP protocol. This might be needed2042 if the FTP server requires it for security reasons or you wish2043 to connect securely whenever remote FTP server supports it.2044 Default is false since it might trigger certificate verification2045 errors on misconfigured servers.20462047http.maxRequests::2048 How many HTTP requests to launch in parallel. Can be overridden2049 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20502051http.minSessions::2052 The number of curl sessions (counted across slots) to be kept across2053 requests. They will not be ended with curl_easy_cleanup() until2054 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2055 value will be capped at 1. Defaults to 1.20562057http.postBuffer::2058 Maximum size in bytes of the buffer used by smart HTTP2059 transports when POSTing data to the remote system.2060 For requests larger than this buffer size, HTTP/1.1 and2061 Transfer-Encoding: chunked is used to avoid creating a2062 massive pack file locally. Default is 1 MiB, which is2063 sufficient for most requests.20642065http.lowSpeedLimit, http.lowSpeedTime::2066 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2067 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2068 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2069 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20702071http.noEPSV::2072 A boolean which disables using of EPSV ftp command by curl.2073 This can helpful with some "poor" ftp servers which don't2074 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2075 environment variable. Default is false (curl will use EPSV).20762077http.userAgent::2078 The HTTP USER_AGENT string presented to an HTTP server. The default2079 value represents the version of the client Git such as git/1.7.1.2080 This option allows you to override this value to a more common value2081 such as Mozilla/4.0. This may be necessary, for instance, if2082 connecting through a firewall that restricts HTTP connections to a set2083 of common USER_AGENT strings (but not including those like git/1.7.1).2084 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20852086http.followRedirects::2087 Whether git should follow HTTP redirects. If set to `true`, git2088 will transparently follow any redirect issued by a server it2089 encounters. If set to `false`, git will treat all redirects as2090 errors. If set to `initial`, git will follow redirects only for2091 the initial request to a remote, but not for subsequent2092 follow-up HTTP requests. Since git uses the redirected URL as2093 the base for the follow-up requests, this is generally2094 sufficient. The default is `initial`.20952096http.<url>.*::2097 Any of the http.* options above can be applied selectively to some URLs.2098 For a config key to match a URL, each element of the config key is2099 compared to that of the URL, in the following order:2100+2101--2102. Scheme (e.g., `https` in `https://example.com/`). This field2103 must match exactly between the config key and the URL.21042105. Host/domain name (e.g., `example.com` in `https://example.com/`).2106 This field must match between the config key and the URL. It is2107 possible to specify a `*` as part of the host name to match all subdomains2108 at this level. `https://*.example.com/` for example would match2109 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21102111. Port number (e.g., `8080` in `http://example.com:8080/`).2112 This field must match exactly between the config key and the URL.2113 Omitted port numbers are automatically converted to the correct2114 default for the scheme before matching.21152116. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2117 path field of the config key must match the path field of the URL2118 either exactly or as a prefix of slash-delimited path elements. This means2119 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2120 match on a slash (`/`) boundary. Longer matches take precedence (so a config2121 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2122 key with just path `foo/`).21232124. User name (e.g., `user` in `https://user@example.com/repo.git`). If2125 the config key has a user name it must match the user name in the2126 URL exactly. If the config key does not have a user name, that2127 config key will match a URL with any user name (including none),2128 but at a lower precedence than a config key with a user name.2129--2130+2131The list above is ordered by decreasing precedence; a URL that matches2132a config key's path is preferred to one that matches its user name. For example,2133if the URL is `https://user@example.com/foo/bar` a config key match of2134`https://example.com/foo` will be preferred over a config key match of2135`https://user@example.com`.2136+2137All URLs are normalized before attempting any matching (the password part,2138if embedded in the URL, is always ignored for matching purposes) so that2139equivalent URLs that are simply spelled differently will match properly.2140Environment variable settings always override any matches. The URLs that are2141matched against are those given directly to Git commands. This means any URLs2142visited as a result of a redirection do not participate in matching.21432144ssh.variant::2145 By default, Git determines the command line arguments to use2146 based on the basename of the configured SSH command (configured2147 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2148 the config setting `core.sshCommand`). If the basename is2149 unrecognized, Git will attempt to detect support of OpenSSH2150 options by first invoking the configured SSH command with the2151 `-G` (print configuration) option and will subsequently use2152 OpenSSH options (if that is successful) or no options besides2153 the host and remote command (if it fails).2154+2155The config variable `ssh.variant` can be set to override this detection.2156Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2157`tortoiseplink`, `simple` (no options except the host and remote command).2158The default auto-detection can be explicitly requested using the value2159`auto`. Any other value is treated as `ssh`. This setting can also be2160overridden via the environment variable `GIT_SSH_VARIANT`.2161+2162The current command-line parameters used for each variant are as2163follows:2164+2165--21662167* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21682169* `simple` - [username@]host command21702171* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21722173* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21742175--2176+2177Except for the `simple` variant, command-line parameters are likely to2178change as git gains new features.21792180i18n.commitEncoding::2181 Character encoding the commit messages are stored in; Git itself2182 does not care per se, but this information is necessary e.g. when2183 importing commits from emails or in the gitk graphical history2184 browser (and possibly at other places in the future or in other2185 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21862187i18n.logOutputEncoding::2188 Character encoding the commit messages are converted to when2189 running 'git log' and friends.21902191imap::2192 The configuration variables in the 'imap' section are described2193 in linkgit:git-imap-send[1].21942195index.threads::2196 Specifies the number of threads to spawn when loading the index.2197 This is meant to reduce index load time on multiprocessor machines.2198 Specifying 0 or 'true' will cause Git to auto-detect the number of2199 CPU's and set the number of threads accordingly. Specifying 1 or2200 'false' will disable multithreading. Defaults to 'true'.22012202index.version::2203 Specify the version with which new index files should be2204 initialized. This does not affect existing repositories.22052206init.templateDir::2207 Specify the directory from which templates will be copied.2208 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22092210instaweb.browser::2211 Specify the program that will be used to browse your working2212 repository in gitweb. See linkgit:git-instaweb[1].22132214instaweb.httpd::2215 The HTTP daemon command-line to start gitweb on your working2216 repository. See linkgit:git-instaweb[1].22172218instaweb.local::2219 If true the web server started by linkgit:git-instaweb[1] will2220 be bound to the local IP (127.0.0.1).22212222instaweb.modulePath::2223 The default module path for linkgit:git-instaweb[1] to use2224 instead of /usr/lib/apache2/modules. Only used if httpd2225 is Apache.22262227instaweb.port::2228 The port number to bind the gitweb httpd to. See2229 linkgit:git-instaweb[1].22302231interactive.singleKey::2232 In interactive commands, allow the user to provide one-letter2233 input with a single key (i.e., without hitting enter).2234 Currently this is used by the `--patch` mode of2235 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2236 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2237 setting is silently ignored if portable keystroke input2238 is not available; requires the Perl module Term::ReadKey.22392240interactive.diffFilter::2241 When an interactive command (such as `git add --patch`) shows2242 a colorized diff, git will pipe the diff through the shell2243 command defined by this configuration variable. The command may2244 mark up the diff further for human consumption, provided that it2245 retains a one-to-one correspondence with the lines in the2246 original diff. Defaults to disabled (no filtering).22472248log.abbrevCommit::2249 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2250 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2251 override this option with `--no-abbrev-commit`.22522253log.date::2254 Set the default date-time mode for the 'log' command.2255 Setting a value for log.date is similar to using 'git log''s2256 `--date` option. See linkgit:git-log[1] for details.22572258log.decorate::2259 Print out the ref names of any commits that are shown by the log2260 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2261 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2262 specified, the full ref name (including prefix) will be printed.2263 If 'auto' is specified, then if the output is going to a terminal,2264 the ref names are shown as if 'short' were given, otherwise no ref2265 names are shown. This is the same as the `--decorate` option2266 of the `git log`.22672268log.follow::2269 If `true`, `git log` will act as if the `--follow` option was used when2270 a single <path> is given. This has the same limitations as `--follow`,2271 i.e. it cannot be used to follow multiple files and does not work well2272 on non-linear history.22732274log.graphColors::2275 A list of colors, separated by commas, that can be used to draw2276 history lines in `git log --graph`.22772278log.showRoot::2279 If true, the initial commit will be shown as a big creation event.2280 This is equivalent to a diff against an empty tree.2281 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2282 normally hide the root commit will now show it. True by default.22832284log.showSignature::2285 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2286 linkgit:git-whatchanged[1] assume `--show-signature`.22872288log.mailmap::2289 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2290 linkgit:git-whatchanged[1] assume `--use-mailmap`.22912292mailinfo.scissors::2293 If true, makes linkgit:git-mailinfo[1] (and therefore2294 linkgit:git-am[1]) act by default as if the --scissors option2295 was provided on the command-line. When active, this features2296 removes everything from the message body before a scissors2297 line (i.e. consisting mainly of ">8", "8<" and "-").22982299mailmap.file::2300 The location of an augmenting mailmap file. The default2301 mailmap, located in the root of the repository, is loaded2302 first, then the mailmap file pointed to by this variable.2303 The location of the mailmap file may be in a repository2304 subdirectory, or somewhere outside of the repository itself.2305 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23062307mailmap.blob::2308 Like `mailmap.file`, but consider the value as a reference to a2309 blob in the repository. If both `mailmap.file` and2310 `mailmap.blob` are given, both are parsed, with entries from2311 `mailmap.file` taking precedence. In a bare repository, this2312 defaults to `HEAD:.mailmap`. In a non-bare repository, it2313 defaults to empty.23142315man.viewer::2316 Specify the programs that may be used to display help in the2317 'man' format. See linkgit:git-help[1].23182319man.<tool>.cmd::2320 Specify the command to invoke the specified man viewer. The2321 specified command is evaluated in shell with the man page2322 passed as argument. (See linkgit:git-help[1].)23232324man.<tool>.path::2325 Override the path for the given tool that may be used to2326 display help in the 'man' format. See linkgit:git-help[1].23272328include::merge-config.txt[]23292330mergetool.<tool>.path::2331 Override the path for the given tool. This is useful in case2332 your tool is not in the PATH.23332334mergetool.<tool>.cmd::2335 Specify the command to invoke the specified merge tool. The2336 specified command is evaluated in shell with the following2337 variables available: 'BASE' is the name of a temporary file2338 containing the common base of the files to be merged, if available;2339 'LOCAL' is the name of a temporary file containing the contents of2340 the file on the current branch; 'REMOTE' is the name of a temporary2341 file containing the contents of the file from the branch being2342 merged; 'MERGED' contains the name of the file to which the merge2343 tool should write the results of a successful merge.23442345mergetool.<tool>.trustExitCode::2346 For a custom merge command, specify whether the exit code of2347 the merge command can be used to determine whether the merge was2348 successful. If this is not set to true then the merge target file2349 timestamp is checked and the merge assumed to have been successful2350 if the file has been updated, otherwise the user is prompted to2351 indicate the success of the merge.23522353mergetool.meld.hasOutput::2354 Older versions of `meld` do not support the `--output` option.2355 Git will attempt to detect whether `meld` supports `--output`2356 by inspecting the output of `meld --help`. Configuring2357 `mergetool.meld.hasOutput` will make Git skip these checks and2358 use the configured value instead. Setting `mergetool.meld.hasOutput`2359 to `true` tells Git to unconditionally use the `--output` option,2360 and `false` avoids using `--output`.23612362mergetool.keepBackup::2363 After performing a merge, the original file with conflict markers2364 can be saved as a file with a `.orig` extension. If this variable2365 is set to `false` then this file is not preserved. Defaults to2366 `true` (i.e. keep the backup files).23672368mergetool.keepTemporaries::2369 When invoking a custom merge tool, Git uses a set of temporary2370 files to pass to the tool. If the tool returns an error and this2371 variable is set to `true`, then these temporary files will be2372 preserved, otherwise they will be removed after the tool has2373 exited. Defaults to `false`.23742375mergetool.writeToTemp::2376 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2377 conflicting files in the worktree by default. Git will attempt2378 to use a temporary directory for these files when set `true`.2379 Defaults to `false`.23802381mergetool.prompt::2382 Prompt before each invocation of the merge resolution program.23832384notes.mergeStrategy::2385 Which merge strategy to choose by default when resolving notes2386 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2387 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2388 section of linkgit:git-notes[1] for more information on each strategy.23892390notes.<name>.mergeStrategy::2391 Which merge strategy to choose when doing a notes merge into2392 refs/notes/<name>. This overrides the more general2393 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2394 linkgit:git-notes[1] for more information on the available strategies.23952396notes.displayRef::2397 The (fully qualified) refname from which to show notes when2398 showing commit messages. The value of this variable can be set2399 to a glob, in which case notes from all matching refs will be2400 shown. You may also specify this configuration variable2401 several times. A warning will be issued for refs that do not2402 exist, but a glob that does not match any refs is silently2403 ignored.2404+2405This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2406environment variable, which must be a colon separated list of refs or2407globs.2408+2409The effective value of "core.notesRef" (possibly overridden by2410GIT_NOTES_REF) is also implicitly added to the list of refs to be2411displayed.24122413notes.rewrite.<command>::2414 When rewriting commits with <command> (currently `amend` or2415 `rebase`) and this variable is set to `true`, Git2416 automatically copies your notes from the original to the2417 rewritten commit. Defaults to `true`, but see2418 "notes.rewriteRef" below.24192420notes.rewriteMode::2421 When copying notes during a rewrite (see the2422 "notes.rewrite.<command>" option), determines what to do if2423 the target commit already has a note. Must be one of2424 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2425 Defaults to `concatenate`.2426+2427This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2428environment variable.24292430notes.rewriteRef::2431 When copying notes during a rewrite, specifies the (fully2432 qualified) ref whose notes should be copied. The ref may be a2433 glob, in which case notes in all matching refs will be copied.2434 You may also specify this configuration several times.2435+2436Does not have a default value; you must configure this variable to2437enable note rewriting. Set it to `refs/notes/commits` to enable2438rewriting for the default commit notes.2439+2440This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2441environment variable, which must be a colon separated list of refs or2442globs.24432444pack.window::2445 The size of the window used by linkgit:git-pack-objects[1] when no2446 window size is given on the command line. Defaults to 10.24472448pack.depth::2449 The maximum delta depth used by linkgit:git-pack-objects[1] when no2450 maximum depth is given on the command line. Defaults to 50.2451 Maximum value is 4095.24522453pack.windowMemory::2454 The maximum size of memory that is consumed by each thread2455 in linkgit:git-pack-objects[1] for pack window memory when2456 no limit is given on the command line. The value can be2457 suffixed with "k", "m", or "g". When left unconfigured (or2458 set explicitly to 0), there will be no limit.24592460pack.compression::2461 An integer -1..9, indicating the compression level for objects2462 in a pack file. -1 is the zlib default. 0 means no2463 compression, and 1..9 are various speed/size tradeoffs, 9 being2464 slowest. If not set, defaults to core.compression. If that is2465 not set, defaults to -1, the zlib default, which is "a default2466 compromise between speed and compression (currently equivalent2467 to level 6)."2468+2469Note that changing the compression level will not automatically recompress2470all existing objects. You can force recompression by passing the -F option2471to linkgit:git-repack[1].24722473pack.island::2474 An extended regular expression configuring a set of delta2475 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]2476 for details.24772478pack.islandCore::2479 Specify an island name which gets to have its objects be2480 packed first. This creates a kind of pseudo-pack at the front2481 of one pack, so that the objects from the specified island are2482 hopefully faster to copy into any pack that should be served2483 to a user requesting these objects. In practice this means2484 that the island specified should likely correspond to what is2485 the most commonly cloned in the repo. See also "DELTA ISLANDS"2486 in linkgit:git-pack-objects[1].24872488pack.deltaCacheSize::2489 The maximum memory in bytes used for caching deltas in2490 linkgit:git-pack-objects[1] before writing them out to a pack.2491 This cache is used to speed up the writing object phase by not2492 having to recompute the final delta result once the best match2493 for all objects is found. Repacking large repositories on machines2494 which are tight with memory might be badly impacted by this though,2495 especially if this cache pushes the system into swapping.2496 A value of 0 means no limit. The smallest size of 1 byte may be2497 used to virtually disable this cache. Defaults to 256 MiB.24982499pack.deltaCacheLimit::2500 The maximum size of a delta, that is cached in2501 linkgit:git-pack-objects[1]. This cache is used to speed up the2502 writing object phase by not having to recompute the final delta2503 result once the best match for all objects is found.2504 Defaults to 1000. Maximum value is 65535.25052506pack.threads::2507 Specifies the number of threads to spawn when searching for best2508 delta matches. This requires that linkgit:git-pack-objects[1]2509 be compiled with pthreads otherwise this option is ignored with a2510 warning. This is meant to reduce packing time on multiprocessor2511 machines. The required amount of memory for the delta search window2512 is however multiplied by the number of threads.2513 Specifying 0 will cause Git to auto-detect the number of CPU's2514 and set the number of threads accordingly.25152516pack.indexVersion::2517 Specify the default pack index version. Valid values are 1 for2518 legacy pack index used by Git versions prior to 1.5.2, and 2 for2519 the new pack index with capabilities for packs larger than 4 GB2520 as well as proper protection against the repacking of corrupted2521 packs. Version 2 is the default. Note that version 2 is enforced2522 and this config option ignored whenever the corresponding pack is2523 larger than 2 GB.2524+2525If you have an old Git that does not understand the version 2 `*.idx` file,2526cloning or fetching over a non native protocol (e.g. "http")2527that will copy both `*.pack` file and corresponding `*.idx` file from the2528other side may give you a repository that cannot be accessed with your2529older version of Git. If the `*.pack` file is smaller than 2 GB, however,2530you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2531the `*.idx` file.25322533pack.packSizeLimit::2534 The maximum size of a pack. This setting only affects2535 packing to a file when repacking, i.e. the git:// protocol2536 is unaffected. It can be overridden by the `--max-pack-size`2537 option of linkgit:git-repack[1]. Reaching this limit results2538 in the creation of multiple packfiles; which in turn prevents2539 bitmaps from being created.2540 The minimum size allowed is limited to 1 MiB.2541 The default is unlimited.2542 Common unit suffixes of 'k', 'm', or 'g' are2543 supported.25442545pack.useBitmaps::2546 When true, git will use pack bitmaps (if available) when packing2547 to stdout (e.g., during the server side of a fetch). Defaults to2548 true. You should not generally need to turn this off unless2549 you are debugging pack bitmaps.25502551pack.writeBitmaps (deprecated)::2552 This is a deprecated synonym for `repack.writeBitmaps`.25532554pack.writeBitmapHashCache::2555 When true, git will include a "hash cache" section in the bitmap2556 index (if one is written). This cache can be used to feed git's2557 delta heuristics, potentially leading to better deltas between2558 bitmapped and non-bitmapped objects (e.g., when serving a fetch2559 between an older, bitmapped pack and objects that have been2560 pushed since the last gc). The downside is that it consumes 42561 bytes per object of disk space, and that JGit's bitmap2562 implementation does not understand it, causing it to complain if2563 Git and JGit are used on the same repository. Defaults to false.25642565pager.<cmd>::2566 If the value is boolean, turns on or off pagination of the2567 output of a particular Git subcommand when writing to a tty.2568 Otherwise, turns on pagination for the subcommand using the2569 pager specified by the value of `pager.<cmd>`. If `--paginate`2570 or `--no-pager` is specified on the command line, it takes2571 precedence over this option. To disable pagination for all2572 commands, set `core.pager` or `GIT_PAGER` to `cat`.25732574pretty.<name>::2575 Alias for a --pretty= format string, as specified in2576 linkgit:git-log[1]. Any aliases defined here can be used just2577 as the built-in pretty formats could. For example,2578 running `git config pretty.changelog "format:* %H %s"`2579 would cause the invocation `git log --pretty=changelog`2580 to be equivalent to running `git log "--pretty=format:* %H %s"`.2581 Note that an alias with the same name as a built-in format2582 will be silently ignored.25832584protocol.allow::2585 If set, provide a user defined default policy for all protocols which2586 don't explicitly have a policy (`protocol.<name>.allow`). By default,2587 if unset, known-safe protocols (http, https, git, ssh, file) have a2588 default policy of `always`, known-dangerous protocols (ext) have a2589 default policy of `never`, and all other protocols have a default2590 policy of `user`. Supported policies:2591+2592--25932594* `always` - protocol is always able to be used.25952596* `never` - protocol is never able to be used.25972598* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2599 either unset or has a value of 1. This policy should be used when you want a2600 protocol to be directly usable by the user but don't want it used by commands which2601 execute clone/fetch/push commands without user input, e.g. recursive2602 submodule initialization.26032604--26052606protocol.<name>.allow::2607 Set a policy to be used by protocol `<name>` with clone/fetch/push2608 commands. See `protocol.allow` above for the available policies.2609+2610The protocol names currently used by git are:2611+2612--2613 - `file`: any local file-based path (including `file://` URLs,2614 or local paths)26152616 - `git`: the anonymous git protocol over a direct TCP2617 connection (or proxy, if configured)26182619 - `ssh`: git over ssh (including `host:path` syntax,2620 `ssh://`, etc).26212622 - `http`: git over http, both "smart http" and "dumb http".2623 Note that this does _not_ include `https`; if you want to configure2624 both, you must do so individually.26252626 - any external helpers are named by their protocol (e.g., use2627 `hg` to allow the `git-remote-hg` helper)2628--26292630protocol.version::2631 Experimental. If set, clients will attempt to communicate with a2632 server using the specified protocol version. If unset, no2633 attempt will be made by the client to communicate using a2634 particular protocol version, this results in protocol version 02635 being used.2636 Supported versions:2637+2638--26392640* `0` - the original wire protocol.26412642* `1` - the original wire protocol with the addition of a version string2643 in the initial response from the server.26442645* `2` - link:technical/protocol-v2.html[wire protocol version 2].26462647--26482649include::pull-config.txt[]26502651include::push-config.txt[]26522653include::rebase-config.txt[]26542655include::receive-config.txt[]26562657remote.pushDefault::2658 The remote to push to by default. Overrides2659 `branch.<name>.remote` for all branches, and is overridden by2660 `branch.<name>.pushRemote` for specific branches.26612662remote.<name>.url::2663 The URL of a remote repository. See linkgit:git-fetch[1] or2664 linkgit:git-push[1].26652666remote.<name>.pushurl::2667 The push URL of a remote repository. See linkgit:git-push[1].26682669remote.<name>.proxy::2670 For remotes that require curl (http, https and ftp), the URL to2671 the proxy to use for that remote. Set to the empty string to2672 disable proxying for that remote.26732674remote.<name>.proxyAuthMethod::2675 For remotes that require curl (http, https and ftp), the method to use for2676 authenticating against the proxy in use (probably set in2677 `remote.<name>.proxy`). See `http.proxyAuthMethod`.26782679remote.<name>.fetch::2680 The default set of "refspec" for linkgit:git-fetch[1]. See2681 linkgit:git-fetch[1].26822683remote.<name>.push::2684 The default set of "refspec" for linkgit:git-push[1]. See2685 linkgit:git-push[1].26862687remote.<name>.mirror::2688 If true, pushing to this remote will automatically behave2689 as if the `--mirror` option was given on the command line.26902691remote.<name>.skipDefaultUpdate::2692 If true, this remote will be skipped by default when updating2693 using linkgit:git-fetch[1] or the `update` subcommand of2694 linkgit:git-remote[1].26952696remote.<name>.skipFetchAll::2697 If true, this remote will be skipped by default when updating2698 using linkgit:git-fetch[1] or the `update` subcommand of2699 linkgit:git-remote[1].27002701remote.<name>.receivepack::2702 The default program to execute on the remote side when pushing. See2703 option --receive-pack of linkgit:git-push[1].27042705remote.<name>.uploadpack::2706 The default program to execute on the remote side when fetching. See2707 option --upload-pack of linkgit:git-fetch-pack[1].27082709remote.<name>.tagOpt::2710 Setting this value to --no-tags disables automatic tag following when2711 fetching from remote <name>. Setting it to --tags will fetch every2712 tag from remote <name>, even if they are not reachable from remote2713 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2714 override this setting. See options --tags and --no-tags of2715 linkgit:git-fetch[1].27162717remote.<name>.vcs::2718 Setting this to a value <vcs> will cause Git to interact with2719 the remote with the git-remote-<vcs> helper.27202721remote.<name>.prune::2722 When set to true, fetching from this remote by default will also2723 remove any remote-tracking references that no longer exist on the2724 remote (as if the `--prune` option was given on the command line).2725 Overrides `fetch.prune` settings, if any.27262727remote.<name>.pruneTags::2728 When set to true, fetching from this remote by default will also2729 remove any local tags that no longer exist on the remote if pruning2730 is activated in general via `remote.<name>.prune`, `fetch.prune` or2731 `--prune`. Overrides `fetch.pruneTags` settings, if any.2732+2733See also `remote.<name>.prune` and the PRUNING section of2734linkgit:git-fetch[1].27352736remotes.<group>::2737 The list of remotes which are fetched by "git remote update2738 <group>". See linkgit:git-remote[1].27392740repack.useDeltaBaseOffset::2741 By default, linkgit:git-repack[1] creates packs that use2742 delta-base offset. If you need to share your repository with2743 Git older than version 1.4.4, either directly or via a dumb2744 protocol such as http, then you need to set this option to2745 "false" and repack. Access from old Git versions over the2746 native protocol are unaffected by this option.27472748repack.packKeptObjects::2749 If set to true, makes `git repack` act as if2750 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2751 details. Defaults to `false` normally, but `true` if a bitmap2752 index is being written (either via `--write-bitmap-index` or2753 `repack.writeBitmaps`).27542755repack.useDeltaIslands::2756 If set to true, makes `git repack` act as if `--delta-islands`2757 was passed. Defaults to `false`.27582759repack.writeBitmaps::2760 When true, git will write a bitmap index when packing all2761 objects to disk (e.g., when `git repack -a` is run). This2762 index can speed up the "counting objects" phase of subsequent2763 packs created for clones and fetches, at the cost of some disk2764 space and extra time spent on the initial repack. This has2765 no effect if multiple packfiles are created.2766 Defaults to false.27672768rerere.autoUpdate::2769 When set to true, `git-rerere` updates the index with the2770 resulting contents after it cleanly resolves conflicts using2771 previously recorded resolution. Defaults to false.27722773rerere.enabled::2774 Activate recording of resolved conflicts, so that identical2775 conflict hunks can be resolved automatically, should they be2776 encountered again. By default, linkgit:git-rerere[1] is2777 enabled if there is an `rr-cache` directory under the2778 `$GIT_DIR`, e.g. if "rerere" was previously used in the2779 repository.27802781reset.quiet::2782 When set to true, 'git reset' will default to the '--quiet' option.27832784include::sendemail-config.txt[]27852786sequence.editor::2787 Text editor used by `git rebase -i` for editing the rebase instruction file.2788 The value is meant to be interpreted by the shell when it is used.2789 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.2790 When not configured the default commit message editor is used instead.27912792showBranch.default::2793 The default set of branches for linkgit:git-show-branch[1].2794 See linkgit:git-show-branch[1].27952796splitIndex.maxPercentChange::2797 When the split index feature is used, this specifies the2798 percent of entries the split index can contain compared to the2799 total number of entries in both the split index and the shared2800 index before a new shared index is written.2801 The value should be between 0 and 100. If the value is 0 then2802 a new shared index is always written, if it is 100 a new2803 shared index is never written.2804 By default the value is 20, so a new shared index is written2805 if the number of entries in the split index would be greater2806 than 20 percent of the total number of entries.2807 See linkgit:git-update-index[1].28082809splitIndex.sharedIndexExpire::2810 When the split index feature is used, shared index files that2811 were not modified since the time this variable specifies will2812 be removed when a new shared index file is created. The value2813 "now" expires all entries immediately, and "never" suppresses2814 expiration altogether.2815 The default value is "2.weeks.ago".2816 Note that a shared index file is considered modified (for the2817 purpose of expiration) each time a new split-index file is2818 either created based on it or read from it.2819 See linkgit:git-update-index[1].28202821status.relativePaths::2822 By default, linkgit:git-status[1] shows paths relative to the2823 current directory. Setting this variable to `false` shows paths2824 relative to the repository root (this was the default for Git2825 prior to v1.5.4).28262827status.short::2828 Set to true to enable --short by default in linkgit:git-status[1].2829 The option --no-short takes precedence over this variable.28302831status.branch::2832 Set to true to enable --branch by default in linkgit:git-status[1].2833 The option --no-branch takes precedence over this variable.28342835status.displayCommentPrefix::2836 If set to true, linkgit:git-status[1] will insert a comment2837 prefix before each output line (starting with2838 `core.commentChar`, i.e. `#` by default). This was the2839 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2840 Defaults to false.28412842status.renameLimit::2843 The number of files to consider when performing rename detection2844 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to2845 the value of diff.renameLimit.28462847status.renames::2848 Whether and how Git detects renames in linkgit:git-status[1] and2849 linkgit:git-commit[1] . If set to "false", rename detection is2850 disabled. If set to "true", basic rename detection is enabled.2851 If set to "copies" or "copy", Git will detect copies, as well.2852 Defaults to the value of diff.renames.28532854status.showStash::2855 If set to true, linkgit:git-status[1] will display the number of2856 entries currently stashed away.2857 Defaults to false.28582859status.showUntrackedFiles::2860 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2861 files which are not currently tracked by Git. Directories which2862 contain only untracked files, are shown with the directory name2863 only. Showing untracked files means that Git needs to lstat() all2864 the files in the whole repository, which might be slow on some2865 systems. So, this variable controls how the commands displays2866 the untracked files. Possible values are:2867+2868--2869* `no` - Show no untracked files.2870* `normal` - Show untracked files and directories.2871* `all` - Show also individual files in untracked directories.2872--2873+2874If this variable is not specified, it defaults to 'normal'.2875This variable can be overridden with the -u|--untracked-files option2876of linkgit:git-status[1] and linkgit:git-commit[1].28772878status.submoduleSummary::2879 Defaults to false.2880 If this is set to a non zero number or true (identical to -1 or an2881 unlimited number), the submodule summary will be enabled and a2882 summary of commits for modified submodules will be shown (see2883 --summary-limit option of linkgit:git-submodule[1]). Please note2884 that the summary output command will be suppressed for all2885 submodules when `diff.ignoreSubmodules` is set to 'all' or only2886 for those submodules where `submodule.<name>.ignore=all`. The only2887 exception to that rule is that status and commit will show staged2888 submodule changes. To2889 also view the summary for ignored submodules you can either use2890 the --ignore-submodules=dirty command-line option or the 'git2891 submodule summary' command, which shows a similar output but does2892 not honor these settings.28932894stash.showPatch::2895 If this is set to true, the `git stash show` command without an2896 option will show the stash entry in patch form. Defaults to false.2897 See description of 'show' command in linkgit:git-stash[1].28982899stash.showStat::2900 If this is set to true, the `git stash show` command without an2901 option will show diffstat of the stash entry. Defaults to true.2902 See description of 'show' command in linkgit:git-stash[1].29032904include::submodule-config.txt[]29052906tag.forceSignAnnotated::2907 A boolean to specify whether annotated tags created should be GPG signed.2908 If `--annotate` is specified on the command line, it takes2909 precedence over this option.29102911tag.sort::2912 This variable controls the sort ordering of tags when displayed by2913 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2914 value of this variable will be used as the default.29152916tar.umask::2917 This variable can be used to restrict the permission bits of2918 tar archive entries. The default is 0002, which turns off the2919 world write bit. The special value "user" indicates that the2920 archiving user's umask will be used instead. See umask(2) and2921 linkgit:git-archive[1].29222923transfer.fsckObjects::2924 When `fetch.fsckObjects` or `receive.fsckObjects` are2925 not set, the value of this variable is used instead.2926 Defaults to false.2927+2928When set, the fetch or receive will abort in the case of a malformed2929object or a link to a nonexistent object. In addition, various other2930issues are checked for, including legacy issues (see `fsck.<msg-id>`),2931and potential security issues like the existence of a `.GIT` directory2932or a malicious `.gitmodules` file (see the release notes for v2.2.12933and v2.17.1 for details). Other sanity and security checks may be2934added in future releases.2935+2936On the receiving side, failing fsckObjects will make those objects2937unreachable, see "QUARANTINE ENVIRONMENT" in2938linkgit:git-receive-pack[1]. On the fetch side, malformed objects will2939instead be left unreferenced in the repository.2940+2941Due to the non-quarantine nature of the `fetch.fsckObjects`2942implementation it can not be relied upon to leave the object store2943clean like `receive.fsckObjects` can.2944+2945As objects are unpacked they're written to the object store, so there2946can be cases where malicious objects get introduced even though the2947"fetch" failed, only to have a subsequent "fetch" succeed because only2948new incoming objects are checked, not those that have already been2949written to the object store. That difference in behavior should not be2950relied upon. In the future, such objects may be quarantined for2951"fetch" as well.2952+2953For now, the paranoid need to find some way to emulate the quarantine2954environment if they'd like the same protection as "push". E.g. in the2955case of an internal mirror do the mirroring in two steps, one to fetch2956the untrusted objects, and then do a second "push" (which will use the2957quarantine) to another internal repo, and have internal clients2958consume this pushed-to repository, or embargo internal fetches and2959only allow them once a full "fsck" has run (and no new fetches have2960happened in the meantime).29612962transfer.hideRefs::2963 String(s) `receive-pack` and `upload-pack` use to decide which2964 refs to omit from their initial advertisements. Use more than2965 one definition to specify multiple prefix strings. A ref that is2966 under the hierarchies listed in the value of this variable is2967 excluded, and is hidden when responding to `git push` or `git2968 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2969 program-specific versions of this config.2970+2971You may also include a `!` in front of the ref name to negate the entry,2972explicitly exposing it, even if an earlier entry marked it as hidden.2973If you have multiple hideRefs values, later entries override earlier ones2974(and entries in more-specific config files override less-specific ones).2975+2976If a namespace is in use, the namespace prefix is stripped from each2977reference before it is matched against `transfer.hiderefs` patterns.2978For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2979the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2980is omitted from the advertisements but `refs/heads/master` and2981`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2982"have" lines. In order to match refs before stripping, add a `^` in front of2983the ref name. If you combine `!` and `^`, `!` must be specified first.2984+2985Even if you hide refs, a client may still be able to steal the target2986objects via the techniques described in the "SECURITY" section of the2987linkgit:gitnamespaces[7] man page; it's best to keep private data in a2988separate repository.29892990transfer.unpackLimit::2991 When `fetch.unpackLimit` or `receive.unpackLimit` are2992 not set, the value of this variable is used instead.2993 The default value is 100.29942995uploadarchive.allowUnreachable::2996 If true, allow clients to use `git archive --remote` to request2997 any tree, whether reachable from the ref tips or not. See the2998 discussion in the "SECURITY" section of2999 linkgit:git-upload-archive[1] for more details. Defaults to3000 `false`.30013002uploadpack.hideRefs::3003 This variable is the same as `transfer.hideRefs`, but applies3004 only to `upload-pack` (and so affects only fetches, not pushes).3005 An attempt to fetch a hidden ref by `git fetch` will fail. See3006 also `uploadpack.allowTipSHA1InWant`.30073008uploadpack.allowTipSHA1InWant::3009 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3010 to accept a fetch request that asks for an object at the tip3011 of a hidden ref (by default, such a request is rejected).3012 See also `uploadpack.hideRefs`. Even if this is false, a client3013 may be able to steal objects via the techniques described in the3014 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3015 best to keep private data in a separate repository.30163017uploadpack.allowReachableSHA1InWant::3018 Allow `upload-pack` to accept a fetch request that asks for an3019 object that is reachable from any ref tip. However, note that3020 calculating object reachability is computationally expensive.3021 Defaults to `false`. Even if this is false, a client may be able3022 to steal objects via the techniques described in the "SECURITY"3023 section of the linkgit:gitnamespaces[7] man page; it's best to3024 keep private data in a separate repository.30253026uploadpack.allowAnySHA1InWant::3027 Allow `upload-pack` to accept a fetch request that asks for any3028 object at all.3029 Defaults to `false`.30303031uploadpack.keepAlive::3032 When `upload-pack` has started `pack-objects`, there may be a3033 quiet period while `pack-objects` prepares the pack. Normally3034 it would output progress information, but if `--quiet` was used3035 for the fetch, `pack-objects` will output nothing at all until3036 the pack data begins. Some clients and networks may consider3037 the server to be hung and give up. Setting this option instructs3038 `upload-pack` to send an empty keepalive packet every3039 `uploadpack.keepAlive` seconds. Setting this option to 03040 disables keepalive packets entirely. The default is 5 seconds.30413042uploadpack.packObjectsHook::3043 If this option is set, when `upload-pack` would run3044 `git pack-objects` to create a packfile for a client, it will3045 run this shell command instead. The `pack-objects` command and3046 arguments it _would_ have run (including the `git pack-objects`3047 at the beginning) are appended to the shell command. The stdin3048 and stdout of the hook are treated as if `pack-objects` itself3049 was run. I.e., `upload-pack` will feed input intended for3050 `pack-objects` to the hook, and expects a completed packfile on3051 stdout.3052+3053Note that this configuration variable is ignored if it is seen in the3054repository-level config (this is a safety measure against fetching from3055untrusted repositories).30563057uploadpack.allowFilter::3058 If this option is set, `upload-pack` will support partial3059 clone and partial fetch object filtering.30603061uploadpack.allowRefInWant::3062 If this option is set, `upload-pack` will support the `ref-in-want`3063 feature of the protocol version 2 `fetch` command. This feature3064 is intended for the benefit of load-balanced servers which may3065 not have the same view of what OIDs their refs point to due to3066 replication delay.30673068url.<base>.insteadOf::3069 Any URL that starts with this value will be rewritten to3070 start, instead, with <base>. In cases where some site serves a3071 large number of repositories, and serves them with multiple3072 access methods, and some users need to use different access3073 methods, this feature allows people to specify any of the3074 equivalent URLs and have Git automatically rewrite the URL to3075 the best alternative for the particular user, even for a3076 never-before-seen repository on the site. When more than one3077 insteadOf strings match a given URL, the longest match is used.3078+3079Note that any protocol restrictions will be applied to the rewritten3080URL. If the rewrite changes the URL to use a custom protocol or remote3081helper, you may need to adjust the `protocol.*.allow` config to permit3082the request. In particular, protocols you expect to use for submodules3083must be set to `always` rather than the default of `user`. See the3084description of `protocol.allow` above.30853086url.<base>.pushInsteadOf::3087 Any URL that starts with this value will not be pushed to;3088 instead, it will be rewritten to start with <base>, and the3089 resulting URL will be pushed to. In cases where some site serves3090 a large number of repositories, and serves them with multiple3091 access methods, some of which do not allow push, this feature3092 allows people to specify a pull-only URL and have Git3093 automatically use an appropriate URL to push, even for a3094 never-before-seen repository on the site. When more than one3095 pushInsteadOf strings match a given URL, the longest match is3096 used. If a remote has an explicit pushurl, Git will ignore this3097 setting for that remote.30983099user.email::3100 Your email address to be recorded in any newly created commits.3101 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3102 `EMAIL` environment variables. See linkgit:git-commit-tree[1].31033104user.name::3105 Your full name to be recorded in any newly created commits.3106 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3107 environment variables. See linkgit:git-commit-tree[1].31083109user.useConfigOnly::3110 Instruct Git to avoid trying to guess defaults for `user.email`3111 and `user.name`, and instead retrieve the values only from the3112 configuration. For example, if you have multiple email addresses3113 and would like to use a different one for each repository, then3114 with this configuration option set to `true` in the global config3115 along with a name, Git will prompt you to set up an email before3116 making new commits in a newly cloned repository.3117 Defaults to `false`.31183119user.signingKey::3120 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3121 key you want it to automatically when creating a signed tag or3122 commit, you can override the default selection with this variable.3123 This option is passed unchanged to gpg's --local-user parameter,3124 so you may specify a key using any method that gpg supports.31253126versionsort.prereleaseSuffix (deprecated)::3127 Deprecated alias for `versionsort.suffix`. Ignored if3128 `versionsort.suffix` is set.31293130versionsort.suffix::3131 Even when version sort is used in linkgit:git-tag[1], tagnames3132 with the same base version but different suffixes are still sorted3133 lexicographically, resulting e.g. in prerelease tags appearing3134 after the main release (e.g. "1.0-rc1" after "1.0"). This3135 variable can be specified to determine the sorting order of tags3136 with different suffixes.3137+3138By specifying a single suffix in this variable, any tagname containing3139that suffix will appear before the corresponding main release. E.g. if3140the variable is set to "-rc", then all "1.0-rcX" tags will appear before3141"1.0". If specified multiple times, once per suffix, then the order of3142suffixes in the configuration will determine the sorting order of tagnames3143with those suffixes. E.g. if "-pre" appears before "-rc" in the3144configuration, then all "1.0-preX" tags will be listed before any3145"1.0-rcX" tags. The placement of the main release tag relative to tags3146with various suffixes can be determined by specifying the empty suffix3147among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3148"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3149are listed first, followed by "v4.8", then "v4.8-ckX" and finally3150"v4.8-bfsX".3151+3152If more than one suffixes match the same tagname, then that tagname will3153be sorted according to the suffix which starts at the earliest position in3154the tagname. If more than one different matching suffixes start at3155that earliest position, then that tagname will be sorted according to the3156longest of those suffixes.3157The sorting order between different suffixes is undefined if they are3158in multiple config files.31593160web.browser::3161 Specify a web browser that may be used by some commands.3162 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3163 may use it.31643165worktree.guessRemote::3166 With `add`, if no branch argument, and neither of `-b` nor3167 `-B` nor `--detach` are given, the command defaults to3168 creating a new branch from HEAD. If `worktree.guessRemote` is3169 set to true, `worktree add` tries to find a remote-tracking3170 branch whose name uniquely matches the new branch name. If3171 such a branch exists, it is checked out and set as "upstream"3172 for the new branch. If no such match can be found, it falls3173 back to creating a new branch from the current HEAD.