1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 checkoutAmbiguousRemoteBranchName:: 348 Advice shown when the argument to 349 linkgit:git-checkout[1] ambiguously resolves to a 350 remote tracking branch on more than one remote in 351 situations where an unambiguous argument would have 352 otherwise caused a remote-tracking branch to be 353 checked out. 354 amWorkDir:: 355 Advice that shows the location of the patch file when 356 linkgit:git-am[1] fails to apply it. 357 rmHints:: 358 In case of failure in the output of linkgit:git-rm[1], 359 show directions on how to proceed from the current state. 360 addEmbeddedRepo:: 361 Advice on what to do when you've accidentally added one 362 git repo inside of another. 363 ignoredHook:: 364 Advice shown if an hook is ignored because the hook is not 365 set as executable. 366 waitingForEditor:: 367 Print a message to the terminal whenever Git is waiting for 368 editor input from the user. 369-- 370 371core.fileMode:: 372 Tells Git if the executable bit of files in the working tree 373 is to be honored. 374+ 375Some filesystems lose the executable bit when a file that is 376marked as executable is checked out, or checks out a 377non-executable file with executable bit on. 378linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 379to see if it handles the executable bit correctly 380and this variable is automatically set as necessary. 381+ 382A repository, however, may be on a filesystem that handles 383the filemode correctly, and this variable is set to 'true' 384when created, but later may be made accessible from another 385environment that loses the filemode (e.g. exporting ext4 via 386CIFS mount, visiting a Cygwin created repository with 387Git for Windows or Eclipse). 388In such a case it may be necessary to set this variable to 'false'. 389See linkgit:git-update-index[1]. 390+ 391The default is true (when core.filemode is not specified in the config file). 392 393core.hideDotFiles:: 394 (Windows-only) If true, mark newly-created directories and files whose 395 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 396 directory is hidden, but no other files starting with a dot. The 397 default mode is 'dotGitOnly'. 398 399core.ignoreCase:: 400 If true, this option enables various workarounds to enable 401 Git to work better on filesystems that are not case sensitive, 402 like FAT. For example, if a directory listing finds 403 "makefile" when Git expects "Makefile", Git will assume 404 it is really the same file, and continue to remember it as 405 "Makefile". 406+ 407The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 408will probe and set core.ignoreCase true if appropriate when the repository 409is created. 410 411core.precomposeUnicode:: 412 This option is only used by Mac OS implementation of Git. 413 When core.precomposeUnicode=true, Git reverts the unicode decomposition 414 of filenames done by Mac OS. This is useful when sharing a repository 415 between Mac OS and Linux or Windows. 416 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 417 When false, file names are handled fully transparent by Git, 418 which is backward compatible with older versions of Git. 419 420core.protectHFS:: 421 If set to true, do not allow checkout of paths that would 422 be considered equivalent to `.git` on an HFS+ filesystem. 423 Defaults to `true` on Mac OS, and `false` elsewhere. 424 425core.protectNTFS:: 426 If set to true, do not allow checkout of paths that would 427 cause problems with the NTFS filesystem, e.g. conflict with 428 8.3 "short" names. 429 Defaults to `true` on Windows, and `false` elsewhere. 430 431core.fsmonitor:: 432 If set, the value of this variable is used as a command which 433 will identify all files that may have changed since the 434 requested date/time. This information is used to speed up git by 435 avoiding unnecessary processing of files that have not changed. 436 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 437 438core.trustctime:: 439 If false, the ctime differences between the index and the 440 working tree are ignored; useful when the inode change time 441 is regularly modified by something outside Git (file system 442 crawlers and some backup systems). 443 See linkgit:git-update-index[1]. True by default. 444 445core.splitIndex:: 446 If true, the split-index feature of the index will be used. 447 See linkgit:git-update-index[1]. False by default. 448 449core.untrackedCache:: 450 Determines what to do about the untracked cache feature of the 451 index. It will be kept, if this variable is unset or set to 452 `keep`. It will automatically be added if set to `true`. And 453 it will automatically be removed, if set to `false`. Before 454 setting it to `true`, you should check that mtime is working 455 properly on your system. 456 See linkgit:git-update-index[1]. `keep` by default. 457 458core.checkStat:: 459 Determines which stat fields to match between the index 460 and work tree. The user can set this to 'default' or 461 'minimal'. Default (or explicitly 'default'), is to check 462 all fields, including the sub-second part of mtime and ctime. 463 464core.quotePath:: 465 Commands that output paths (e.g. 'ls-files', 'diff'), will 466 quote "unusual" characters in the pathname by enclosing the 467 pathname in double-quotes and escaping those characters with 468 backslashes in the same way C escapes control characters (e.g. 469 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 470 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 471 UTF-8). If this variable is set to false, bytes higher than 472 0x80 are not considered "unusual" any more. Double-quotes, 473 backslash and control characters are always escaped regardless 474 of the setting of this variable. A simple space character is 475 not considered "unusual". Many commands can output pathnames 476 completely verbatim using the `-z` option. The default value 477 is true. 478 479core.eol:: 480 Sets the line ending type to use in the working directory for 481 files that have the `text` property set when core.autocrlf is false. 482 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 483 native line ending. The default value is `native`. See 484 linkgit:gitattributes[5] for more information on end-of-line 485 conversion. 486 487core.safecrlf:: 488 If true, makes Git check if converting `CRLF` is reversible when 489 end-of-line conversion is active. Git will verify if a command 490 modifies a file in the work tree either directly or indirectly. 491 For example, committing a file followed by checking out the 492 same file should yield the original file in the work tree. If 493 this is not the case for the current setting of 494 `core.autocrlf`, Git will reject the file. The variable can 495 be set to "warn", in which case Git will only warn about an 496 irreversible conversion but continue the operation. 497+ 498CRLF conversion bears a slight chance of corrupting data. 499When it is enabled, Git will convert CRLF to LF during commit and LF to 500CRLF during checkout. A file that contains a mixture of LF and 501CRLF before the commit cannot be recreated by Git. For text 502files this is the right thing to do: it corrects line endings 503such that we have only LF line endings in the repository. 504But for binary files that are accidentally classified as text the 505conversion can corrupt data. 506+ 507If you recognize such corruption early you can easily fix it by 508setting the conversion type explicitly in .gitattributes. Right 509after committing you still have the original file in your work 510tree and this file is not yet corrupted. You can explicitly tell 511Git that this file is binary and Git will handle the file 512appropriately. 513+ 514Unfortunately, the desired effect of cleaning up text files with 515mixed line endings and the undesired effect of corrupting binary 516files cannot be distinguished. In both cases CRLFs are removed 517in an irreversible way. For text files this is the right thing 518to do because CRLFs are line endings, while for binary files 519converting CRLFs corrupts data. 520+ 521Note, this safety check does not mean that a checkout will generate a 522file identical to the original file for a different setting of 523`core.eol` and `core.autocrlf`, but only for the current one. For 524example, a text file with `LF` would be accepted with `core.eol=lf` 525and could later be checked out with `core.eol=crlf`, in which case the 526resulting file would contain `CRLF`, although the original file 527contained `LF`. However, in both work trees the line endings would be 528consistent, that is either all `LF` or all `CRLF`, but never mixed. A 529file with mixed line endings would be reported by the `core.safecrlf` 530mechanism. 531 532core.autocrlf:: 533 Setting this variable to "true" is the same as setting 534 the `text` attribute to "auto" on all files and core.eol to "crlf". 535 Set to true if you want to have `CRLF` line endings in your 536 working directory and the repository has LF line endings. 537 This variable can be set to 'input', 538 in which case no output conversion is performed. 539 540core.checkRoundtripEncoding:: 541 A comma and/or whitespace separated list of encodings that Git 542 performs UTF-8 round trip checks on if they are used in an 543 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 544 The default value is `SHIFT-JIS`. 545 546core.symlinks:: 547 If false, symbolic links are checked out as small plain files that 548 contain the link text. linkgit:git-update-index[1] and 549 linkgit:git-add[1] will not change the recorded type to regular 550 file. Useful on filesystems like FAT that do not support 551 symbolic links. 552+ 553The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 554will probe and set core.symlinks false if appropriate when the repository 555is created. 556 557core.gitProxy:: 558 A "proxy command" to execute (as 'command host port') instead 559 of establishing direct connection to the remote server when 560 using the Git protocol for fetching. If the variable value is 561 in the "COMMAND for DOMAIN" format, the command is applied only 562 on hostnames ending with the specified domain string. This variable 563 may be set multiple times and is matched in the given order; 564 the first match wins. 565+ 566Can be overridden by the `GIT_PROXY_COMMAND` environment variable 567(which always applies universally, without the special "for" 568handling). 569+ 570The special string `none` can be used as the proxy command to 571specify that no proxy be used for a given domain pattern. 572This is useful for excluding servers inside a firewall from 573proxy use, while defaulting to a common proxy for external domains. 574 575core.sshCommand:: 576 If this variable is set, `git fetch` and `git push` will 577 use the specified command instead of `ssh` when they need to 578 connect to a remote system. The command is in the same form as 579 the `GIT_SSH_COMMAND` environment variable and is overridden 580 when the environment variable is set. 581 582core.ignoreStat:: 583 If true, Git will avoid using lstat() calls to detect if files have 584 changed by setting the "assume-unchanged" bit for those tracked files 585 which it has updated identically in both the index and working tree. 586+ 587When files are modified outside of Git, the user will need to stage 588the modified files explicitly (e.g. see 'Examples' section in 589linkgit:git-update-index[1]). 590Git will not normally detect changes to those files. 591+ 592This is useful on systems where lstat() calls are very slow, such as 593CIFS/Microsoft Windows. 594+ 595False by default. 596 597core.preferSymlinkRefs:: 598 Instead of the default "symref" format for HEAD 599 and other symbolic reference files, use symbolic links. 600 This is sometimes needed to work with old scripts that 601 expect HEAD to be a symbolic link. 602 603core.bare:: 604 If true this repository is assumed to be 'bare' and has no 605 working directory associated with it. If this is the case a 606 number of commands that require a working directory will be 607 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 608+ 609This setting is automatically guessed by linkgit:git-clone[1] or 610linkgit:git-init[1] when the repository was created. By default a 611repository that ends in "/.git" is assumed to be not bare (bare = 612false), while all other repositories are assumed to be bare (bare 613= true). 614 615core.worktree:: 616 Set the path to the root of the working tree. 617 If `GIT_COMMON_DIR` environment variable is set, core.worktree 618 is ignored and not used for determining the root of working tree. 619 This can be overridden by the `GIT_WORK_TREE` environment 620 variable and the `--work-tree` command-line option. 621 The value can be an absolute path or relative to the path to 622 the .git directory, which is either specified by --git-dir 623 or GIT_DIR, or automatically discovered. 624 If --git-dir or GIT_DIR is specified but none of 625 --work-tree, GIT_WORK_TREE and core.worktree is specified, 626 the current working directory is regarded as the top level 627 of your working tree. 628+ 629Note that this variable is honored even when set in a configuration 630file in a ".git" subdirectory of a directory and its value differs 631from the latter directory (e.g. "/path/to/.git/config" has 632core.worktree set to "/different/path"), which is most likely a 633misconfiguration. Running Git commands in the "/path/to" directory will 634still use "/different/path" as the root of the work tree and can cause 635confusion unless you know what you are doing (e.g. you are creating a 636read-only snapshot of the same index to a location different from the 637repository's usual working tree). 638 639core.logAllRefUpdates:: 640 Enable the reflog. Updates to a ref <ref> is logged to the file 641 "`$GIT_DIR/logs/<ref>`", by appending the new and old 642 SHA-1, the date/time and the reason of the update, but 643 only when the file exists. If this configuration 644 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 645 file is automatically created for branch heads (i.e. under 646 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 647 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 648 If it is set to `always`, then a missing reflog is automatically 649 created for any ref under `refs/`. 650+ 651This information can be used to determine what commit 652was the tip of a branch "2 days ago". 653+ 654This value is true by default in a repository that has 655a working directory associated with it, and false by 656default in a bare repository. 657 658core.repositoryFormatVersion:: 659 Internal variable identifying the repository format and layout 660 version. 661 662core.sharedRepository:: 663 When 'group' (or 'true'), the repository is made shareable between 664 several users in a group (making sure all the files and objects are 665 group-writable). When 'all' (or 'world' or 'everybody'), the 666 repository will be readable by all users, additionally to being 667 group-shareable. When 'umask' (or 'false'), Git will use permissions 668 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 669 files in the repository will have this mode value. '0xxx' will override 670 user's umask value (whereas the other options will only override 671 requested parts of the user's umask value). Examples: '0660' will make 672 the repo read/write-able for the owner and group, but inaccessible to 673 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 674 repository that is group-readable but not group-writable. 675 See linkgit:git-init[1]. False by default. 676 677core.warnAmbiguousRefs:: 678 If true, Git will warn you if the ref name you passed it is ambiguous 679 and might match multiple refs in the repository. True by default. 680 681core.compression:: 682 An integer -1..9, indicating a default compression level. 683 -1 is the zlib default. 0 means no compression, 684 and 1..9 are various speed/size tradeoffs, 9 being slowest. 685 If set, this provides a default to other compression variables, 686 such as `core.looseCompression` and `pack.compression`. 687 688core.looseCompression:: 689 An integer -1..9, indicating the compression level for objects that 690 are not in a pack file. -1 is the zlib default. 0 means no 691 compression, and 1..9 are various speed/size tradeoffs, 9 being 692 slowest. If not set, defaults to core.compression. If that is 693 not set, defaults to 1 (best speed). 694 695core.packedGitWindowSize:: 696 Number of bytes of a pack file to map into memory in a 697 single mapping operation. Larger window sizes may allow 698 your system to process a smaller number of large pack files 699 more quickly. Smaller window sizes will negatively affect 700 performance due to increased calls to the operating system's 701 memory manager, but may improve performance when accessing 702 a large number of large pack files. 703+ 704Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 705MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 706be reasonable for all users/operating systems. You probably do 707not need to adjust this value. 708+ 709Common unit suffixes of 'k', 'm', or 'g' are supported. 710 711core.packedGitLimit:: 712 Maximum number of bytes to map simultaneously into memory 713 from pack files. If Git needs to access more than this many 714 bytes at once to complete an operation it will unmap existing 715 regions to reclaim virtual address space within the process. 716+ 717Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 718unlimited) on 64 bit platforms. 719This should be reasonable for all users/operating systems, except on 720the largest projects. You probably do not need to adjust this value. 721+ 722Common unit suffixes of 'k', 'm', or 'g' are supported. 723 724core.deltaBaseCacheLimit:: 725 Maximum number of bytes to reserve for caching base objects 726 that may be referenced by multiple deltified objects. By storing the 727 entire decompressed base objects in a cache Git is able 728 to avoid unpacking and decompressing frequently used base 729 objects multiple times. 730+ 731Default is 96 MiB on all platforms. This should be reasonable 732for all users/operating systems, except on the largest projects. 733You probably do not need to adjust this value. 734+ 735Common unit suffixes of 'k', 'm', or 'g' are supported. 736 737core.bigFileThreshold:: 738 Files larger than this size are stored deflated, without 739 attempting delta compression. Storing large files without 740 delta compression avoids excessive memory usage, at the 741 slight expense of increased disk usage. Additionally files 742 larger than this size are always treated as binary. 743+ 744Default is 512 MiB on all platforms. This should be reasonable 745for most projects as source code and other text files can still 746be delta compressed, but larger binary media files won't be. 747+ 748Common unit suffixes of 'k', 'm', or 'g' are supported. 749 750core.excludesFile:: 751 Specifies the pathname to the file that contains patterns to 752 describe paths that are not meant to be tracked, in addition 753 to '.gitignore' (per-directory) and '.git/info/exclude'. 754 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 755 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 756 is used instead. See linkgit:gitignore[5]. 757 758core.askPass:: 759 Some commands (e.g. svn and http interfaces) that interactively 760 ask for a password can be told to use an external program given 761 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 762 environment variable. If not set, fall back to the value of the 763 `SSH_ASKPASS` environment variable or, failing that, a simple password 764 prompt. The external program shall be given a suitable prompt as 765 command-line argument and write the password on its STDOUT. 766 767core.attributesFile:: 768 In addition to '.gitattributes' (per-directory) and 769 '.git/info/attributes', Git looks into this file for attributes 770 (see linkgit:gitattributes[5]). Path expansions are made the same 771 way as for `core.excludesFile`. Its default value is 772 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 773 set or empty, `$HOME/.config/git/attributes` is used instead. 774 775core.hooksPath:: 776 By default Git will look for your hooks in the 777 '$GIT_DIR/hooks' directory. Set this to different path, 778 e.g. '/etc/git/hooks', and Git will try to find your hooks in 779 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 780 in '$GIT_DIR/hooks/pre-receive'. 781+ 782The path can be either absolute or relative. A relative path is 783taken as relative to the directory where the hooks are run (see 784the "DESCRIPTION" section of linkgit:githooks[5]). 785+ 786This configuration variable is useful in cases where you'd like to 787centrally configure your Git hooks instead of configuring them on a 788per-repository basis, or as a more flexible and centralized 789alternative to having an `init.templateDir` where you've changed 790default hooks. 791 792core.editor:: 793 Commands such as `commit` and `tag` that let you edit 794 messages by launching an editor use the value of this 795 variable when it is set, and the environment variable 796 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 797 798core.commentChar:: 799 Commands such as `commit` and `tag` that let you edit 800 messages consider a line that begins with this character 801 commented, and removes them after the editor returns 802 (default '#'). 803+ 804If set to "auto", `git-commit` would select a character that is not 805the beginning character of any line in existing commit messages. 806 807core.filesRefLockTimeout:: 808 The length of time, in milliseconds, to retry when trying to 809 lock an individual reference. Value 0 means not to retry at 810 all; -1 means to try indefinitely. Default is 100 (i.e., 811 retry for 100ms). 812 813core.packedRefsTimeout:: 814 The length of time, in milliseconds, to retry when trying to 815 lock the `packed-refs` file. Value 0 means not to retry at 816 all; -1 means to try indefinitely. Default is 1000 (i.e., 817 retry for 1 second). 818 819sequence.editor:: 820 Text editor used by `git rebase -i` for editing the rebase instruction file. 821 The value is meant to be interpreted by the shell when it is used. 822 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 823 When not configured the default commit message editor is used instead. 824 825core.pager:: 826 Text viewer for use by Git commands (e.g., 'less'). The value 827 is meant to be interpreted by the shell. The order of preference 828 is the `$GIT_PAGER` environment variable, then `core.pager` 829 configuration, then `$PAGER`, and then the default chosen at 830 compile time (usually 'less'). 831+ 832When the `LESS` environment variable is unset, Git sets it to `FRX` 833(if `LESS` environment variable is set, Git does not change it at 834all). If you want to selectively override Git's default setting 835for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 836be passed to the shell by Git, which will translate the final 837command to `LESS=FRX less -S`. The environment does not set the 838`S` option but the command line does, instructing less to truncate 839long lines. Similarly, setting `core.pager` to `less -+F` will 840deactivate the `F` option specified by the environment from the 841command-line, deactivating the "quit if one screen" behavior of 842`less`. One can specifically activate some flags for particular 843commands: for example, setting `pager.blame` to `less -S` enables 844line truncation only for `git blame`. 845+ 846Likewise, when the `LV` environment variable is unset, Git sets it 847to `-c`. You can override this setting by exporting `LV` with 848another value or setting `core.pager` to `lv +c`. 849 850core.whitespace:: 851 A comma separated list of common whitespace problems to 852 notice. 'git diff' will use `color.diff.whitespace` to 853 highlight them, and 'git apply --whitespace=error' will 854 consider them as errors. You can prefix `-` to disable 855 any of them (e.g. `-trailing-space`): 856+ 857* `blank-at-eol` treats trailing whitespaces at the end of the line 858 as an error (enabled by default). 859* `space-before-tab` treats a space character that appears immediately 860 before a tab character in the initial indent part of the line as an 861 error (enabled by default). 862* `indent-with-non-tab` treats a line that is indented with space 863 characters instead of the equivalent tabs as an error (not enabled by 864 default). 865* `tab-in-indent` treats a tab character in the initial indent part of 866 the line as an error (not enabled by default). 867* `blank-at-eof` treats blank lines added at the end of file as an error 868 (enabled by default). 869* `trailing-space` is a short-hand to cover both `blank-at-eol` and 870 `blank-at-eof`. 871* `cr-at-eol` treats a carriage-return at the end of line as 872 part of the line terminator, i.e. with it, `trailing-space` 873 does not trigger if the character before such a carriage-return 874 is not a whitespace (not enabled by default). 875* `tabwidth=<n>` tells how many character positions a tab occupies; this 876 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 877 errors. The default tab width is 8. Allowed values are 1 to 63. 878 879core.fsyncObjectFiles:: 880 This boolean will enable 'fsync()' when writing object files. 881+ 882This is a total waste of time and effort on a filesystem that orders 883data writes properly, but can be useful for filesystems that do not use 884journalling (traditional UNIX filesystems) or that only journal metadata 885and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 886 887core.preloadIndex:: 888 Enable parallel index preload for operations like 'git diff' 889+ 890This can speed up operations like 'git diff' and 'git status' especially 891on filesystems like NFS that have weak caching semantics and thus 892relatively high IO latencies. When enabled, Git will do the 893index comparison to the filesystem data in parallel, allowing 894overlapping IO's. Defaults to true. 895 896core.createObject:: 897 You can set this to 'link', in which case a hardlink followed by 898 a delete of the source are used to make sure that object creation 899 will not overwrite existing objects. 900+ 901On some file system/operating system combinations, this is unreliable. 902Set this config setting to 'rename' there; However, This will remove the 903check that makes sure that existing object files will not get overwritten. 904 905core.notesRef:: 906 When showing commit messages, also show notes which are stored in 907 the given ref. The ref must be fully qualified. If the given 908 ref does not exist, it is not an error but means that no 909 notes should be printed. 910+ 911This setting defaults to "refs/notes/commits", and it can be overridden by 912the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 913 914core.commitGraph:: 915 Enable git commit graph feature. Allows reading from the 916 commit-graph file. 917 918core.sparseCheckout:: 919 Enable "sparse checkout" feature. See section "Sparse checkout" in 920 linkgit:git-read-tree[1] for more information. 921 922core.abbrev:: 923 Set the length object names are abbreviated to. If 924 unspecified or set to "auto", an appropriate value is 925 computed based on the approximate number of packed objects 926 in your repository, which hopefully is enough for 927 abbreviated object names to stay unique for some time. 928 The minimum length is 4. 929 930add.ignoreErrors:: 931add.ignore-errors (deprecated):: 932 Tells 'git add' to continue adding files when some files cannot be 933 added due to indexing errors. Equivalent to the `--ignore-errors` 934 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 935 as it does not follow the usual naming convention for configuration 936 variables. 937 938alias.*:: 939 Command aliases for the linkgit:git[1] command wrapper - e.g. 940 after defining "alias.last = cat-file commit HEAD", the invocation 941 "git last" is equivalent to "git cat-file commit HEAD". To avoid 942 confusion and troubles with script usage, aliases that 943 hide existing Git commands are ignored. Arguments are split by 944 spaces, the usual shell quoting and escaping is supported. 945 A quote pair or a backslash can be used to quote them. 946+ 947If the alias expansion is prefixed with an exclamation point, 948it will be treated as a shell command. For example, defining 949"alias.new = !gitk --all --not ORIG_HEAD", the invocation 950"git new" is equivalent to running the shell command 951"gitk --all --not ORIG_HEAD". Note that shell commands will be 952executed from the top-level directory of a repository, which may 953not necessarily be the current directory. 954`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 955from the original current directory. See linkgit:git-rev-parse[1]. 956 957am.keepcr:: 958 If true, git-am will call git-mailsplit for patches in mbox format 959 with parameter `--keep-cr`. In this case git-mailsplit will 960 not remove `\r` from lines ending with `\r\n`. Can be overridden 961 by giving `--no-keep-cr` from the command line. 962 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 963 964am.threeWay:: 965 By default, `git am` will fail if the patch does not apply cleanly. When 966 set to true, this setting tells `git am` to fall back on 3-way merge if 967 the patch records the identity of blobs it is supposed to apply to and 968 we have those blobs available locally (equivalent to giving the `--3way` 969 option from the command line). Defaults to `false`. 970 See linkgit:git-am[1]. 971 972apply.ignoreWhitespace:: 973 When set to 'change', tells 'git apply' to ignore changes in 974 whitespace, in the same way as the `--ignore-space-change` 975 option. 976 When set to one of: no, none, never, false tells 'git apply' to 977 respect all whitespace differences. 978 See linkgit:git-apply[1]. 979 980apply.whitespace:: 981 Tells 'git apply' how to handle whitespaces, in the same way 982 as the `--whitespace` option. See linkgit:git-apply[1]. 983 984blame.showRoot:: 985 Do not treat root commits as boundaries in linkgit:git-blame[1]. 986 This option defaults to false. 987 988blame.blankBoundary:: 989 Show blank commit object name for boundary commits in 990 linkgit:git-blame[1]. This option defaults to false. 991 992blame.showEmail:: 993 Show the author email instead of author name in linkgit:git-blame[1]. 994 This option defaults to false. 995 996blame.date:: 997 Specifies the format used to output dates in linkgit:git-blame[1]. 998 If unset the iso format is used. For supported values, 999 see the discussion of the `--date` option at linkgit:git-log[1].10001001branch.autoSetupMerge::1002 Tells 'git branch' and 'git checkout' to set up new branches1003 so that linkgit:git-pull[1] will appropriately merge from the1004 starting point branch. Note that even if this option is not set,1005 this behavior can be chosen per-branch using the `--track`1006 and `--no-track` options. The valid settings are: `false` -- no1007 automatic setup is done; `true` -- automatic setup is done when the1008 starting point is a remote-tracking branch; `always` --1009 automatic setup is done when the starting point is either a1010 local branch or remote-tracking1011 branch. This option defaults to true.10121013branch.autoSetupRebase::1014 When a new branch is created with 'git branch' or 'git checkout'1015 that tracks another branch, this variable tells Git to set1016 up pull to rebase instead of merge (see "branch.<name>.rebase").1017 When `never`, rebase is never automatically set to true.1018 When `local`, rebase is set to true for tracked branches of1019 other local branches.1020 When `remote`, rebase is set to true for tracked branches of1021 remote-tracking branches.1022 When `always`, rebase will be set to true for all tracking1023 branches.1024 See "branch.autoSetupMerge" for details on how to set up a1025 branch to track another branch.1026 This option defaults to never.10271028branch.<name>.remote::1029 When on branch <name>, it tells 'git fetch' and 'git push'1030 which remote to fetch from/push to. The remote to push to1031 may be overridden with `remote.pushDefault` (for all branches).1032 The remote to push to, for the current branch, may be further1033 overridden by `branch.<name>.pushRemote`. If no remote is1034 configured, or if you are not on any branch, it defaults to1035 `origin` for fetching and `remote.pushDefault` for pushing.1036 Additionally, `.` (a period) is the current local repository1037 (a dot-repository), see `branch.<name>.merge`'s final note below.10381039branch.<name>.pushRemote::1040 When on branch <name>, it overrides `branch.<name>.remote` for1041 pushing. It also overrides `remote.pushDefault` for pushing1042 from branch <name>. When you pull from one place (e.g. your1043 upstream) and push to another place (e.g. your own publishing1044 repository), you would want to set `remote.pushDefault` to1045 specify the remote to push to for all branches, and use this1046 option to override it for a specific branch.10471048branch.<name>.merge::1049 Defines, together with branch.<name>.remote, the upstream branch1050 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1051 branch to merge and can also affect 'git push' (see push.default).1052 When in branch <name>, it tells 'git fetch' the default1053 refspec to be marked for merging in FETCH_HEAD. The value is1054 handled like the remote part of a refspec, and must match a1055 ref which is fetched from the remote given by1056 "branch.<name>.remote".1057 The merge information is used by 'git pull' (which at first calls1058 'git fetch') to lookup the default branch for merging. Without1059 this option, 'git pull' defaults to merge the first refspec fetched.1060 Specify multiple values to get an octopus merge.1061 If you wish to setup 'git pull' so that it merges into <name> from1062 another branch in the local repository, you can point1063 branch.<name>.merge to the desired branch, and use the relative path1064 setting `.` (a period) for branch.<name>.remote.10651066branch.<name>.mergeOptions::1067 Sets default options for merging into branch <name>. The syntax and1068 supported options are the same as those of linkgit:git-merge[1], but1069 option values containing whitespace characters are currently not1070 supported.10711072branch.<name>.rebase::1073 When true, rebase the branch <name> on top of the fetched branch,1074 instead of merging the default branch from the default remote when1075 "git pull" is run. See "pull.rebase" for doing this in a non1076 branch-specific manner.1077+1078When `merges`, pass the `--rebase-merges` option to 'git rebase'1079so that the local merge commits are included in the rebase (see1080linkgit:git-rebase[1] for details).1081+1082When preserve, also pass `--preserve-merges` along to 'git rebase'1083so that locally committed merge commits will not be flattened1084by running 'git pull'.1085+1086When the value is `interactive`, the rebase is run in interactive mode.1087+1088*NOTE*: this is a possibly dangerous operation; do *not* use1089it unless you understand the implications (see linkgit:git-rebase[1]1090for details).10911092branch.<name>.description::1093 Branch description, can be edited with1094 `git branch --edit-description`. Branch description is1095 automatically added in the format-patch cover letter or1096 request-pull summary.10971098browser.<tool>.cmd::1099 Specify the command to invoke the specified browser. The1100 specified command is evaluated in shell with the URLs passed1101 as arguments. (See linkgit:git-web{litdd}browse[1].)11021103browser.<tool>.path::1104 Override the path for the given tool that may be used to1105 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1106 working repository in gitweb (see linkgit:git-instaweb[1]).11071108clean.requireForce::1109 A boolean to make git-clean do nothing unless given -f,1110 -i or -n. Defaults to true.11111112color.advice::1113 A boolean to enable/disable color in hints (e.g. when a push1114 failed, see `advice.*` for a list). May be set to `always`,1115 `false` (or `never`) or `auto` (or `true`), in which case colors1116 are used only when the error output goes to a terminal. If1117 unset, then the value of `color.ui` is used (`auto` by default).11181119color.advice.hint::1120 Use customized color for hints.11211122color.branch::1123 A boolean to enable/disable color in the output of1124 linkgit:git-branch[1]. May be set to `always`,1125 `false` (or `never`) or `auto` (or `true`), in which case colors are used1126 only when the output is to a terminal. If unset, then the1127 value of `color.ui` is used (`auto` by default).11281129color.branch.<slot>::1130 Use customized color for branch coloration. `<slot>` is one of1131 `current` (the current branch), `local` (a local branch),1132 `remote` (a remote-tracking branch in refs/remotes/),1133 `upstream` (upstream tracking branch), `plain` (other1134 refs).11351136color.diff::1137 Whether to use ANSI escape sequences to add color to patches.1138 If this is set to `always`, linkgit:git-diff[1],1139 linkgit:git-log[1], and linkgit:git-show[1] will use color1140 for all patches. If it is set to `true` or `auto`, those1141 commands will only use color when output is to the terminal.1142 If unset, then the value of `color.ui` is used (`auto` by1143 default).1144+1145This does not affect linkgit:git-format-patch[1] or the1146'git-diff-{asterisk}' plumbing commands. Can be overridden on the1147command line with the `--color[=<when>]` option.11481149diff.colorMoved::1150 If set to either a valid `<mode>` or a true value, moved lines1151 in a diff are colored differently, for details of valid modes1152 see '--color-moved' in linkgit:git-diff[1]. If simply set to1153 true the default color mode will be used. When set to false,1154 moved lines are not colored.11551156color.diff.<slot>::1157 Use customized color for diff colorization. `<slot>` specifies1158 which part of the patch to use the specified color, and is one1159 of `context` (context text - `plain` is a historical synonym),1160 `meta` (metainformation), `frag`1161 (hunk header), 'func' (function in hunk header), `old` (removed lines),1162 `new` (added lines), `commit` (commit headers), `whitespace`1163 (highlighting whitespace errors), `oldMoved` (deleted lines),1164 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1165 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1166 and `newMovedAlternativeDimmed` (See the '<mode>'1167 setting of '--color-moved' in linkgit:git-diff[1] for details).11681169color.decorate.<slot>::1170 Use customized color for 'git log --decorate' output. `<slot>` is one1171 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1172 branches, remote-tracking branches, tags, stash and HEAD, respectively.11731174color.grep::1175 When set to `always`, always highlight matches. When `false` (or1176 `never`), never. When set to `true` or `auto`, use color only1177 when the output is written to the terminal. If unset, then the1178 value of `color.ui` is used (`auto` by default).11791180color.grep.<slot>::1181 Use customized color for grep colorization. `<slot>` specifies which1182 part of the line to use the specified color, and is one of1183+1184--1185`context`;;1186 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1187`filename`;;1188 filename prefix (when not using `-h`)1189`function`;;1190 function name lines (when using `-p`)1191`linenumber`;;1192 line number prefix (when using `-n`)1193`match`;;1194 matching text (same as setting `matchContext` and `matchSelected`)1195`matchContext`;;1196 matching text in context lines1197`matchSelected`;;1198 matching text in selected lines1199`selected`;;1200 non-matching text in selected lines1201`separator`;;1202 separators between fields on a line (`:`, `-`, and `=`)1203 and between hunks (`--`)1204--12051206color.interactive::1207 When set to `always`, always use colors for interactive prompts1208 and displays (such as those used by "git-add --interactive" and1209 "git-clean --interactive"). When false (or `never`), never.1210 When set to `true` or `auto`, use colors only when the output is1211 to the terminal. If unset, then the value of `color.ui` is1212 used (`auto` by default).12131214color.interactive.<slot>::1215 Use customized color for 'git add --interactive' and 'git clean1216 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1217 or `error`, for four distinct types of normal output from1218 interactive commands.12191220color.pager::1221 A boolean to enable/disable colored output when the pager is in1222 use (default is true).12231224color.push::1225 A boolean to enable/disable color in push errors. May be set to1226 `always`, `false` (or `never`) or `auto` (or `true`), in which1227 case colors are used only when the error output goes to a terminal.1228 If unset, then the value of `color.ui` is used (`auto` by default).12291230color.push.error::1231 Use customized color for push errors.12321233color.showBranch::1234 A boolean to enable/disable color in the output of1235 linkgit:git-show-branch[1]. May be set to `always`,1236 `false` (or `never`) or `auto` (or `true`), in which case colors are used1237 only when the output is to a terminal. If unset, then the1238 value of `color.ui` is used (`auto` by default).12391240color.status::1241 A boolean to enable/disable color in the output of1242 linkgit:git-status[1]. May be set to `always`,1243 `false` (or `never`) or `auto` (or `true`), in which case colors are used1244 only when the output is to a terminal. If unset, then the1245 value of `color.ui` is used (`auto` by default).12461247color.status.<slot>::1248 Use customized color for status colorization. `<slot>` is1249 one of `header` (the header text of the status message),1250 `added` or `updated` (files which are added but not committed),1251 `changed` (files which are changed but not added in the index),1252 `untracked` (files which are not tracked by Git),1253 `branch` (the current branch),1254 `nobranch` (the color the 'no branch' warning is shown in, defaulting1255 to red),1256 `localBranch` or `remoteBranch` (the local and remote branch names,1257 respectively, when branch and tracking information is displayed in the1258 status short-format), or1259 `unmerged` (files which have unmerged changes).12601261color.blame.repeatedLines::1262 Use the customized color for the part of git-blame output that1263 is repeated meta information per line (such as commit id,1264 author name, date and timezone). Defaults to cyan.12651266color.blame.highlightRecent::1267 This can be used to color the metadata of a blame line depending1268 on age of the line.1269+1270This setting should be set to a comma-separated list of color and date settings,1271starting and ending with a color, the dates should be set from oldest to newest.1272The metadata will be colored given the colors if the the line was introduced1273before the given timestamp, overwriting older timestamped colors.1274+1275Instead of an absolute timestamp relative timestamps work as well, e.g.12762.weeks.ago is valid to address anything older than 2 weeks.1277+1278It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1279everything older than one year blue, recent changes between one month and1280one year old are kept white, and lines introduced within the last month are1281colored red.12821283blame.coloring::1284 This determines the coloring scheme to be applied to blame1285 output. It can be 'repeatedLines', 'highlightRecent',1286 or 'none' which is the default.12871288color.transport::1289 A boolean to enable/disable color when pushes are rejected. May be1290 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1291 case colors are used only when the error output goes to a terminal.1292 If unset, then the value of `color.ui` is used (`auto` by default).12931294color.transport.rejected::1295 Use customized color when a push was rejected.12961297color.ui::1298 This variable determines the default value for variables such1299 as `color.diff` and `color.grep` that control the use of color1300 per command family. Its scope will expand as more commands learn1301 configuration to set a default for the `--color` option. Set it1302 to `false` or `never` if you prefer Git commands not to use1303 color unless enabled explicitly with some other configuration1304 or the `--color` option. Set it to `always` if you want all1305 output not intended for machine consumption to use color, to1306 `true` or `auto` (this is the default since Git 1.8.4) if you1307 want such output to use color when written to the terminal.13081309column.ui::1310 Specify whether supported commands should output in columns.1311 This variable consists of a list of tokens separated by spaces1312 or commas:1313+1314These options control when the feature should be enabled1315(defaults to 'never'):1316+1317--1318`always`;;1319 always show in columns1320`never`;;1321 never show in columns1322`auto`;;1323 show in columns if the output is to the terminal1324--1325+1326These options control layout (defaults to 'column'). Setting any1327of these implies 'always' if none of 'always', 'never', or 'auto' are1328specified.1329+1330--1331`column`;;1332 fill columns before rows1333`row`;;1334 fill rows before columns1335`plain`;;1336 show in one column1337--1338+1339Finally, these options can be combined with a layout option (defaults1340to 'nodense'):1341+1342--1343`dense`;;1344 make unequal size columns to utilize more space1345`nodense`;;1346 make equal size columns1347--13481349column.branch::1350 Specify whether to output branch listing in `git branch` in columns.1351 See `column.ui` for details.13521353column.clean::1354 Specify the layout when list items in `git clean -i`, which always1355 shows files and directories in columns. See `column.ui` for details.13561357column.status::1358 Specify whether to output untracked files in `git status` in columns.1359 See `column.ui` for details.13601361column.tag::1362 Specify whether to output tag listing in `git tag` in columns.1363 See `column.ui` for details.13641365commit.cleanup::1366 This setting overrides the default of the `--cleanup` option in1367 `git commit`. See linkgit:git-commit[1] for details. Changing the1368 default can be useful when you always want to keep lines that begin1369 with comment character `#` in your log message, in which case you1370 would do `git config commit.cleanup whitespace` (note that you will1371 have to remove the help lines that begin with `#` in the commit log1372 template yourself, if you do this).13731374commit.gpgSign::13751376 A boolean to specify whether all commits should be GPG signed.1377 Use of this option when doing operations such as rebase can1378 result in a large number of commits being signed. It may be1379 convenient to use an agent to avoid typing your GPG passphrase1380 several times.13811382commit.status::1383 A boolean to enable/disable inclusion of status information in the1384 commit message template when using an editor to prepare the commit1385 message. Defaults to true.13861387commit.template::1388 Specify the pathname of a file to use as the template for1389 new commit messages.13901391commit.verbose::1392 A boolean or int to specify the level of verbose with `git commit`.1393 See linkgit:git-commit[1].13941395credential.helper::1396 Specify an external helper to be called when a username or1397 password credential is needed; the helper may consult external1398 storage to avoid prompting the user for the credentials. Note1399 that multiple helpers may be defined. See linkgit:gitcredentials[7]1400 for details.14011402credential.useHttpPath::1403 When acquiring credentials, consider the "path" component of an http1404 or https URL to be important. Defaults to false. See1405 linkgit:gitcredentials[7] for more information.14061407credential.username::1408 If no username is set for a network authentication, use this username1409 by default. See credential.<context>.* below, and1410 linkgit:gitcredentials[7].14111412credential.<url>.*::1413 Any of the credential.* options above can be applied selectively to1414 some credentials. For example "credential.https://example.com.username"1415 would set the default username only for https connections to1416 example.com. See linkgit:gitcredentials[7] for details on how URLs are1417 matched.14181419credentialCache.ignoreSIGHUP::1420 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14211422completion.commands::1423 This is only used by git-completion.bash to add or remove1424 commands from the list of completed commands. Normally only1425 porcelain commands and a few select others are completed. You1426 can add more commands, separated by space, in this1427 variable. Prefixing the command with '-' will remove it from1428 the existing list.14291430include::diff-config.txt[]14311432difftool.<tool>.path::1433 Override the path for the given tool. This is useful in case1434 your tool is not in the PATH.14351436difftool.<tool>.cmd::1437 Specify the command to invoke the specified diff tool.1438 The specified command is evaluated in shell with the following1439 variables available: 'LOCAL' is set to the name of the temporary1440 file containing the contents of the diff pre-image and 'REMOTE'1441 is set to the name of the temporary file containing the contents1442 of the diff post-image.14431444difftool.prompt::1445 Prompt before each invocation of the diff tool.14461447fastimport.unpackLimit::1448 If the number of objects imported by linkgit:git-fast-import[1]1449 is below this limit, then the objects will be unpacked into1450 loose object files. However if the number of imported objects1451 equals or exceeds this limit then the pack will be stored as a1452 pack. Storing the pack from a fast-import can make the import1453 operation complete faster, especially on slow filesystems. If1454 not set, the value of `transfer.unpackLimit` is used instead.14551456fetch.recurseSubmodules::1457 This option can be either set to a boolean value or to 'on-demand'.1458 Setting it to a boolean changes the behavior of fetch and pull to1459 unconditionally recurse into submodules when set to true or to not1460 recurse at all when set to false. When set to 'on-demand' (the default1461 value), fetch and pull will only recurse into a populated submodule1462 when its superproject retrieves a commit that updates the submodule's1463 reference.14641465fetch.fsckObjects::1466 If it is set to true, git-fetch-pack will check all fetched1467 objects. It will abort in the case of a malformed object or a1468 broken link. The result of an abort are only dangling objects.1469 Defaults to false. If not set, the value of `transfer.fsckObjects`1470 is used instead.14711472fetch.unpackLimit::1473 If the number of objects fetched over the Git native1474 transfer is below this1475 limit, then the objects will be unpacked into loose object1476 files. However if the number of received objects equals or1477 exceeds this limit then the received pack will be stored as1478 a pack, after adding any missing delta bases. Storing the1479 pack from a push can make the push operation complete faster,1480 especially on slow filesystems. If not set, the value of1481 `transfer.unpackLimit` is used instead.14821483fetch.prune::1484 If true, fetch will automatically behave as if the `--prune`1485 option was given on the command line. See also `remote.<name>.prune`1486 and the PRUNING section of linkgit:git-fetch[1].14871488fetch.pruneTags::1489 If true, fetch will automatically behave as if the1490 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1491 if not set already. This allows for setting both this option1492 and `fetch.prune` to maintain a 1=1 mapping to upstream1493 refs. See also `remote.<name>.pruneTags` and the PRUNING1494 section of linkgit:git-fetch[1].14951496fetch.output::1497 Control how ref update status is printed. Valid values are1498 `full` and `compact`. Default value is `full`. See section1499 OUTPUT in linkgit:git-fetch[1] for detail.15001501format.attach::1502 Enable multipart/mixed attachments as the default for1503 'format-patch'. The value can also be a double quoted string1504 which will enable attachments as the default and set the1505 value as the boundary. See the --attach option in1506 linkgit:git-format-patch[1].15071508format.from::1509 Provides the default value for the `--from` option to format-patch.1510 Accepts a boolean value, or a name and email address. If false,1511 format-patch defaults to `--no-from`, using commit authors directly in1512 the "From:" field of patch mails. If true, format-patch defaults to1513 `--from`, using your committer identity in the "From:" field of patch1514 mails and including a "From:" field in the body of the patch mail if1515 different. If set to a non-boolean value, format-patch uses that1516 value instead of your committer identity. Defaults to false.15171518format.numbered::1519 A boolean which can enable or disable sequence numbers in patch1520 subjects. It defaults to "auto" which enables it only if there1521 is more than one patch. It can be enabled or disabled for all1522 messages by setting it to "true" or "false". See --numbered1523 option in linkgit:git-format-patch[1].15241525format.headers::1526 Additional email headers to include in a patch to be submitted1527 by mail. See linkgit:git-format-patch[1].15281529format.to::1530format.cc::1531 Additional recipients to include in a patch to be submitted1532 by mail. See the --to and --cc options in1533 linkgit:git-format-patch[1].15341535format.subjectPrefix::1536 The default for format-patch is to output files with the '[PATCH]'1537 subject prefix. Use this variable to change that prefix.15381539format.signature::1540 The default for format-patch is to output a signature containing1541 the Git version number. Use this variable to change that default.1542 Set this variable to the empty string ("") to suppress1543 signature generation.15441545format.signatureFile::1546 Works just like format.signature except the contents of the1547 file specified by this variable will be used as the signature.15481549format.suffix::1550 The default for format-patch is to output files with the suffix1551 `.patch`. Use this variable to change that suffix (make sure to1552 include the dot if you want it).15531554format.pretty::1555 The default pretty format for log/show/whatchanged command,1556 See linkgit:git-log[1], linkgit:git-show[1],1557 linkgit:git-whatchanged[1].15581559format.thread::1560 The default threading style for 'git format-patch'. Can be1561 a boolean value, or `shallow` or `deep`. `shallow` threading1562 makes every mail a reply to the head of the series,1563 where the head is chosen from the cover letter, the1564 `--in-reply-to`, and the first patch mail, in this order.1565 `deep` threading makes every mail a reply to the previous one.1566 A true boolean value is the same as `shallow`, and a false1567 value disables threading.15681569format.signOff::1570 A boolean value which lets you enable the `-s/--signoff` option of1571 format-patch by default. *Note:* Adding the Signed-off-by: line to a1572 patch should be a conscious act and means that you certify you have1573 the rights to submit this work under the same open source license.1574 Please see the 'SubmittingPatches' document for further discussion.15751576format.coverLetter::1577 A boolean that controls whether to generate a cover-letter when1578 format-patch is invoked, but in addition can be set to "auto", to1579 generate a cover-letter only when there's more than one patch.15801581format.outputDirectory::1582 Set a custom directory to store the resulting files instead of the1583 current working directory.15841585format.useAutoBase::1586 A boolean value which lets you enable the `--base=auto` option of1587 format-patch by default.15881589filter.<driver>.clean::1590 The command which is used to convert the content of a worktree1591 file to a blob upon checkin. See linkgit:gitattributes[5] for1592 details.15931594filter.<driver>.smudge::1595 The command which is used to convert the content of a blob1596 object to a worktree file upon checkout. See1597 linkgit:gitattributes[5] for details.15981599fsck.<msg-id>::1600 Allows overriding the message type (error, warn or ignore) of a1601 specific message ID such as `missingEmail`.1602+1603For convenience, fsck prefixes the error/warning with the message ID,1604e.g. "missingEmail: invalid author/committer line - missing email" means1605that setting `fsck.missingEmail = ignore` will hide that issue.1606+1607This feature is intended to support working with legacy repositories1608which cannot be repaired without disruptive changes.16091610fsck.skipList::1611 The path to a sorted list of object names (i.e. one SHA-1 per1612 line) that are known to be broken in a non-fatal way and should1613 be ignored. This feature is useful when an established project1614 should be accepted despite early commits containing errors that1615 can be safely ignored such as invalid committer email addresses.1616 Note: corrupt objects cannot be skipped with this setting.16171618gc.aggressiveDepth::1619 The depth parameter used in the delta compression1620 algorithm used by 'git gc --aggressive'. This defaults1621 to 50.16221623gc.aggressiveWindow::1624 The window size parameter used in the delta compression1625 algorithm used by 'git gc --aggressive'. This defaults1626 to 250.16271628gc.auto::1629 When there are approximately more than this many loose1630 objects in the repository, `git gc --auto` will pack them.1631 Some Porcelain commands use this command to perform a1632 light-weight garbage collection from time to time. The1633 default value is 6700. Setting this to 0 disables it.16341635gc.autoPackLimit::1636 When there are more than this many packs that are not1637 marked with `*.keep` file in the repository, `git gc1638 --auto` consolidates them into one larger pack. The1639 default value is 50. Setting this to 0 disables it.16401641gc.autoDetach::1642 Make `git gc --auto` return immediately and run in background1643 if the system supports it. Default is true.16441645gc.bigPackThreshold::1646 If non-zero, all packs larger than this limit are kept when1647 `git gc` is run. This is very similar to `--keep-base-pack`1648 except that all packs that meet the threshold are kept, not1649 just the base pack. Defaults to zero. Common unit suffixes of1650 'k', 'm', or 'g' are supported.1651+1652Note that if the number of kept packs is more than gc.autoPackLimit,1653this configuration variable is ignored, all packs except the base pack1654will be repacked. After this the number of packs should go below1655gc.autoPackLimit and gc.bigPackThreshold should be respected again.16561657gc.logExpiry::1658 If the file gc.log exists, then `git gc --auto` won't run1659 unless that file is more than 'gc.logExpiry' old. Default is1660 "1.day". See `gc.pruneExpire` for more ways to specify its1661 value.16621663gc.packRefs::1664 Running `git pack-refs` in a repository renders it1665 unclonable by Git versions prior to 1.5.1.2 over dumb1666 transports such as HTTP. This variable determines whether1667 'git gc' runs `git pack-refs`. This can be set to `notbare`1668 to enable it within all non-bare repos or it can be set to a1669 boolean value. The default is `true`.16701671gc.pruneExpire::1672 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1673 Override the grace period with this config variable. The value1674 "now" may be used to disable this grace period and always prune1675 unreachable objects immediately, or "never" may be used to1676 suppress pruning. This feature helps prevent corruption when1677 'git gc' runs concurrently with another process writing to the1678 repository; see the "NOTES" section of linkgit:git-gc[1].16791680gc.worktreePruneExpire::1681 When 'git gc' is run, it calls1682 'git worktree prune --expire 3.months.ago'.1683 This config variable can be used to set a different grace1684 period. The value "now" may be used to disable the grace1685 period and prune `$GIT_DIR/worktrees` immediately, or "never"1686 may be used to suppress pruning.16871688gc.reflogExpire::1689gc.<pattern>.reflogExpire::1690 'git reflog expire' removes reflog entries older than1691 this time; defaults to 90 days. The value "now" expires all1692 entries immediately, and "never" suppresses expiration1693 altogether. With "<pattern>" (e.g.1694 "refs/stash") in the middle the setting applies only to1695 the refs that match the <pattern>.16961697gc.reflogExpireUnreachable::1698gc.<pattern>.reflogExpireUnreachable::1699 'git reflog expire' removes reflog entries older than1700 this time and are not reachable from the current tip;1701 defaults to 30 days. The value "now" expires all entries1702 immediately, and "never" suppresses expiration altogether.1703 With "<pattern>" (e.g. "refs/stash")1704 in the middle, the setting applies only to the refs that1705 match the <pattern>.17061707gc.rerereResolved::1708 Records of conflicted merge you resolved earlier are1709 kept for this many days when 'git rerere gc' is run.1710 You can also use more human-readable "1.month.ago", etc.1711 The default is 60 days. See linkgit:git-rerere[1].17121713gc.rerereUnresolved::1714 Records of conflicted merge you have not resolved are1715 kept for this many days when 'git rerere gc' is run.1716 You can also use more human-readable "1.month.ago", etc.1717 The default is 15 days. See linkgit:git-rerere[1].17181719gitcvs.commitMsgAnnotation::1720 Append this string to each commit message. Set to empty string1721 to disable this feature. Defaults to "via git-CVS emulator".17221723gitcvs.enabled::1724 Whether the CVS server interface is enabled for this repository.1725 See linkgit:git-cvsserver[1].17261727gitcvs.logFile::1728 Path to a log file where the CVS server interface well... logs1729 various stuff. See linkgit:git-cvsserver[1].17301731gitcvs.usecrlfattr::1732 If true, the server will look up the end-of-line conversion1733 attributes for files to determine the `-k` modes to use. If1734 the attributes force Git to treat a file as text,1735 the `-k` mode will be left blank so CVS clients will1736 treat it as text. If they suppress text conversion, the file1737 will be set with '-kb' mode, which suppresses any newline munging1738 the client might otherwise do. If the attributes do not allow1739 the file type to be determined, then `gitcvs.allBinary` is1740 used. See linkgit:gitattributes[5].17411742gitcvs.allBinary::1743 This is used if `gitcvs.usecrlfattr` does not resolve1744 the correct '-kb' mode to use. If true, all1745 unresolved files are sent to the client in1746 mode '-kb'. This causes the client to treat them1747 as binary files, which suppresses any newline munging it1748 otherwise might do. Alternatively, if it is set to "guess",1749 then the contents of the file are examined to decide if1750 it is binary, similar to `core.autocrlf`.17511752gitcvs.dbName::1753 Database used by git-cvsserver to cache revision information1754 derived from the Git repository. The exact meaning depends on the1755 used database driver, for SQLite (which is the default driver) this1756 is a filename. Supports variable substitution (see1757 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1758 Default: '%Ggitcvs.%m.sqlite'17591760gitcvs.dbDriver::1761 Used Perl DBI driver. You can specify any available driver1762 for this here, but it might not work. git-cvsserver is tested1763 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1764 reported *not* to work with 'DBD::mysql'. Experimental feature.1765 May not contain double colons (`:`). Default: 'SQLite'.1766 See linkgit:git-cvsserver[1].17671768gitcvs.dbUser, gitcvs.dbPass::1769 Database user and password. Only useful if setting `gitcvs.dbDriver`,1770 since SQLite has no concept of database users and/or passwords.1771 'gitcvs.dbUser' supports variable substitution (see1772 linkgit:git-cvsserver[1] for details).17731774gitcvs.dbTableNamePrefix::1775 Database table name prefix. Prepended to the names of any1776 database tables used, allowing a single database to be used1777 for several repositories. Supports variable substitution (see1778 linkgit:git-cvsserver[1] for details). Any non-alphabetic1779 characters will be replaced with underscores.17801781All gitcvs variables except for `gitcvs.usecrlfattr` and1782`gitcvs.allBinary` can also be specified as1783'gitcvs.<access_method>.<varname>' (where 'access_method'1784is one of "ext" and "pserver") to make them apply only for the given1785access method.17861787gitweb.category::1788gitweb.description::1789gitweb.owner::1790gitweb.url::1791 See linkgit:gitweb[1] for description.17921793gitweb.avatar::1794gitweb.blame::1795gitweb.grep::1796gitweb.highlight::1797gitweb.patches::1798gitweb.pickaxe::1799gitweb.remote_heads::1800gitweb.showSizes::1801gitweb.snapshot::1802 See linkgit:gitweb.conf[5] for description.18031804grep.lineNumber::1805 If set to true, enable `-n` option by default.18061807grep.patternType::1808 Set the default matching behavior. Using a value of 'basic', 'extended',1809 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1810 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1811 value 'default' will return to the default matching behavior.18121813grep.extendedRegexp::1814 If set to true, enable `--extended-regexp` option by default. This1815 option is ignored when the `grep.patternType` option is set to a value1816 other than 'default'.18171818grep.threads::1819 Number of grep worker threads to use.1820 See `grep.threads` in linkgit:git-grep[1] for more information.18211822grep.fallbackToNoIndex::1823 If set to true, fall back to git grep --no-index if git grep1824 is executed outside of a git repository. Defaults to false.18251826gpg.program::1827 Use this custom program instead of "`gpg`" found on `$PATH` when1828 making or verifying a PGP signature. The program must support the1829 same command-line interface as GPG, namely, to verify a detached1830 signature, "`gpg --verify $file - <$signature`" is run, and the1831 program is expected to signal a good signature by exiting with1832 code 0, and to generate an ASCII-armored detached signature, the1833 standard input of "`gpg -bsau $key`" is fed with the contents to be1834 signed, and the program is expected to send the result to its1835 standard output.18361837gui.commitMsgWidth::1838 Defines how wide the commit message window is in the1839 linkgit:git-gui[1]. "75" is the default.18401841gui.diffContext::1842 Specifies how many context lines should be used in calls to diff1843 made by the linkgit:git-gui[1]. The default is "5".18441845gui.displayUntracked::1846 Determines if linkgit:git-gui[1] shows untracked files1847 in the file list. The default is "true".18481849gui.encoding::1850 Specifies the default encoding to use for displaying of1851 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1852 It can be overridden by setting the 'encoding' attribute1853 for relevant files (see linkgit:gitattributes[5]).1854 If this option is not set, the tools default to the1855 locale encoding.18561857gui.matchTrackingBranch::1858 Determines if new branches created with linkgit:git-gui[1] should1859 default to tracking remote branches with matching names or1860 not. Default: "false".18611862gui.newBranchTemplate::1863 Is used as suggested name when creating new branches using the1864 linkgit:git-gui[1].18651866gui.pruneDuringFetch::1867 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1868 performing a fetch. The default value is "false".18691870gui.trustmtime::1871 Determines if linkgit:git-gui[1] should trust the file modification1872 timestamp or not. By default the timestamps are not trusted.18731874gui.spellingDictionary::1875 Specifies the dictionary used for spell checking commit messages in1876 the linkgit:git-gui[1]. When set to "none" spell checking is turned1877 off.18781879gui.fastCopyBlame::1880 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1881 location detection. It makes blame significantly faster on huge1882 repositories at the expense of less thorough copy detection.18831884gui.copyBlameThreshold::1885 Specifies the threshold to use in 'git gui blame' original location1886 detection, measured in alphanumeric characters. See the1887 linkgit:git-blame[1] manual for more information on copy detection.18881889gui.blamehistoryctx::1890 Specifies the radius of history context in days to show in1891 linkgit:gitk[1] for the selected commit, when the `Show History1892 Context` menu item is invoked from 'git gui blame'. If this1893 variable is set to zero, the whole history is shown.18941895guitool.<name>.cmd::1896 Specifies the shell command line to execute when the corresponding item1897 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1898 mandatory for every tool. The command is executed from the root of1899 the working directory, and in the environment it receives the name of1900 the tool as `GIT_GUITOOL`, the name of the currently selected file as1901 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1902 the head is detached, 'CUR_BRANCH' is empty).19031904guitool.<name>.needsFile::1905 Run the tool only if a diff is selected in the GUI. It guarantees1906 that 'FILENAME' is not empty.19071908guitool.<name>.noConsole::1909 Run the command silently, without creating a window to display its1910 output.19111912guitool.<name>.noRescan::1913 Don't rescan the working directory for changes after the tool1914 finishes execution.19151916guitool.<name>.confirm::1917 Show a confirmation dialog before actually running the tool.19181919guitool.<name>.argPrompt::1920 Request a string argument from the user, and pass it to the tool1921 through the `ARGS` environment variable. Since requesting an1922 argument implies confirmation, the 'confirm' option has no effect1923 if this is enabled. If the option is set to 'true', 'yes', or '1',1924 the dialog uses a built-in generic prompt; otherwise the exact1925 value of the variable is used.19261927guitool.<name>.revPrompt::1928 Request a single valid revision from the user, and set the1929 `REVISION` environment variable. In other aspects this option1930 is similar to 'argPrompt', and can be used together with it.19311932guitool.<name>.revUnmerged::1933 Show only unmerged branches in the 'revPrompt' subdialog.1934 This is useful for tools similar to merge or rebase, but not1935 for things like checkout or reset.19361937guitool.<name>.title::1938 Specifies the title to use for the prompt dialog. The default1939 is the tool name.19401941guitool.<name>.prompt::1942 Specifies the general prompt string to display at the top of1943 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1944 The default value includes the actual command.19451946help.browser::1947 Specify the browser that will be used to display help in the1948 'web' format. See linkgit:git-help[1].19491950help.format::1951 Override the default help format used by linkgit:git-help[1].1952 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1953 the default. 'web' and 'html' are the same.19541955help.autoCorrect::1956 Automatically correct and execute mistyped commands after1957 waiting for the given number of deciseconds (0.1 sec). If more1958 than one command can be deduced from the entered text, nothing1959 will be executed. If the value of this option is negative,1960 the corrected command will be executed immediately. If the1961 value is 0 - the command will be just shown but not executed.1962 This is the default.19631964help.htmlPath::1965 Specify the path where the HTML documentation resides. File system paths1966 and URLs are supported. HTML pages will be prefixed with this path when1967 help is displayed in the 'web' format. This defaults to the documentation1968 path of your Git installation.19691970http.proxy::1971 Override the HTTP proxy, normally configured using the 'http_proxy',1972 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1973 addition to the syntax understood by curl, it is possible to specify a1974 proxy string with a user name but no password, in which case git will1975 attempt to acquire one in the same way it does for other credentials. See1976 linkgit:gitcredentials[7] for more information. The syntax thus is1977 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1978 on a per-remote basis; see remote.<name>.proxy19791980http.proxyAuthMethod::1981 Set the method with which to authenticate against the HTTP proxy. This1982 only takes effect if the configured proxy string contains a user name part1983 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1984 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1985 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1986 variable. Possible values are:1987+1988--1989* `anyauth` - Automatically pick a suitable authentication method. It is1990 assumed that the proxy answers an unauthenticated request with a 4071991 status code and one or more Proxy-authenticate headers with supported1992 authentication methods. This is the default.1993* `basic` - HTTP Basic authentication1994* `digest` - HTTP Digest authentication; this prevents the password from being1995 transmitted to the proxy in clear text1996* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1997 of `curl(1)`)1998* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1999--20002001http.emptyAuth::2002 Attempt authentication without seeking a username or password. This2003 can be used to attempt GSS-Negotiate authentication without specifying2004 a username in the URL, as libcurl normally requires a username for2005 authentication.20062007http.delegation::2008 Control GSSAPI credential delegation. The delegation is disabled2009 by default in libcurl since version 7.21.7. Set parameter to tell2010 the server what it is allowed to delegate when it comes to user2011 credentials. Used with GSS/kerberos. Possible values are:2012+2013--2014* `none` - Don't allow any delegation.2015* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2016 Kerberos service ticket, which is a matter of realm policy.2017* `always` - Unconditionally allow the server to delegate.2018--201920202021http.extraHeader::2022 Pass an additional HTTP header when communicating with a server. If2023 more than one such entry exists, all of them are added as extra2024 headers. To allow overriding the settings inherited from the system2025 config, an empty value will reset the extra headers to the empty list.20262027http.cookieFile::2028 The pathname of a file containing previously stored cookie lines,2029 which should be used2030 in the Git http session, if they match the server. The file format2031 of the file to read cookies from should be plain HTTP headers or2032 the Netscape/Mozilla cookie file format (see `curl(1)`).2033 NOTE that the file specified with http.cookieFile is used only as2034 input unless http.saveCookies is set.20352036http.saveCookies::2037 If set, store cookies received during requests to the file specified by2038 http.cookieFile. Has no effect if http.cookieFile is unset.20392040http.sslVersion::2041 The SSL version to use when negotiating an SSL connection, if you2042 want to force the default. The available and default version2043 depend on whether libcurl was built against NSS or OpenSSL and the2044 particular configuration of the crypto library in use. Internally2045 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2046 documentation for more details on the format of this option and2047 for the ssl version supported. Actually the possible values of2048 this option are:20492050 - sslv22051 - sslv32052 - tlsv12053 - tlsv1.02054 - tlsv1.12055 - tlsv1.22056 - tlsv1.320572058+2059Can be overridden by the `GIT_SSL_VERSION` environment variable.2060To force git to use libcurl's default ssl version and ignore any2061explicit http.sslversion option, set `GIT_SSL_VERSION` to the2062empty string.20632064http.sslCipherList::2065 A list of SSL ciphers to use when negotiating an SSL connection.2066 The available ciphers depend on whether libcurl was built against2067 NSS or OpenSSL and the particular configuration of the crypto2068 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2069 option; see the libcurl documentation for more details on the format2070 of this list.2071+2072Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2073To force git to use libcurl's default cipher list and ignore any2074explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2075empty string.20762077http.sslVerify::2078 Whether to verify the SSL certificate when fetching or pushing2079 over HTTPS. Defaults to true. Can be overridden by the2080 `GIT_SSL_NO_VERIFY` environment variable.20812082http.sslCert::2083 File containing the SSL certificate when fetching or pushing2084 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2085 variable.20862087http.sslKey::2088 File containing the SSL private key when fetching or pushing2089 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2090 variable.20912092http.sslCertPasswordProtected::2093 Enable Git's password prompt for the SSL certificate. Otherwise2094 OpenSSL will prompt the user, possibly many times, if the2095 certificate or private key is encrypted. Can be overridden by the2096 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20972098http.sslCAInfo::2099 File containing the certificates to verify the peer with when2100 fetching or pushing over HTTPS. Can be overridden by the2101 `GIT_SSL_CAINFO` environment variable.21022103http.sslCAPath::2104 Path containing files with the CA certificates to verify the peer2105 with when fetching or pushing over HTTPS. Can be overridden2106 by the `GIT_SSL_CAPATH` environment variable.21072108http.pinnedpubkey::2109 Public key of the https service. It may either be the filename of2110 a PEM or DER encoded public key file or a string starting with2111 'sha256//' followed by the base64 encoded sha256 hash of the2112 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2113 exit with an error if this option is set but not supported by2114 cURL.21152116http.sslTry::2117 Attempt to use AUTH SSL/TLS and encrypted data transfers2118 when connecting via regular FTP protocol. This might be needed2119 if the FTP server requires it for security reasons or you wish2120 to connect securely whenever remote FTP server supports it.2121 Default is false since it might trigger certificate verification2122 errors on misconfigured servers.21232124http.maxRequests::2125 How many HTTP requests to launch in parallel. Can be overridden2126 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21272128http.minSessions::2129 The number of curl sessions (counted across slots) to be kept across2130 requests. They will not be ended with curl_easy_cleanup() until2131 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2132 value will be capped at 1. Defaults to 1.21332134http.postBuffer::2135 Maximum size in bytes of the buffer used by smart HTTP2136 transports when POSTing data to the remote system.2137 For requests larger than this buffer size, HTTP/1.1 and2138 Transfer-Encoding: chunked is used to avoid creating a2139 massive pack file locally. Default is 1 MiB, which is2140 sufficient for most requests.21412142http.lowSpeedLimit, http.lowSpeedTime::2143 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2144 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2145 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2146 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21472148http.noEPSV::2149 A boolean which disables using of EPSV ftp command by curl.2150 This can helpful with some "poor" ftp servers which don't2151 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2152 environment variable. Default is false (curl will use EPSV).21532154http.userAgent::2155 The HTTP USER_AGENT string presented to an HTTP server. The default2156 value represents the version of the client Git such as git/1.7.1.2157 This option allows you to override this value to a more common value2158 such as Mozilla/4.0. This may be necessary, for instance, if2159 connecting through a firewall that restricts HTTP connections to a set2160 of common USER_AGENT strings (but not including those like git/1.7.1).2161 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21622163http.followRedirects::2164 Whether git should follow HTTP redirects. If set to `true`, git2165 will transparently follow any redirect issued by a server it2166 encounters. If set to `false`, git will treat all redirects as2167 errors. If set to `initial`, git will follow redirects only for2168 the initial request to a remote, but not for subsequent2169 follow-up HTTP requests. Since git uses the redirected URL as2170 the base for the follow-up requests, this is generally2171 sufficient. The default is `initial`.21722173http.<url>.*::2174 Any of the http.* options above can be applied selectively to some URLs.2175 For a config key to match a URL, each element of the config key is2176 compared to that of the URL, in the following order:2177+2178--2179. Scheme (e.g., `https` in `https://example.com/`). This field2180 must match exactly between the config key and the URL.21812182. Host/domain name (e.g., `example.com` in `https://example.com/`).2183 This field must match between the config key and the URL. It is2184 possible to specify a `*` as part of the host name to match all subdomains2185 at this level. `https://*.example.com/` for example would match2186 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21872188. Port number (e.g., `8080` in `http://example.com:8080/`).2189 This field must match exactly between the config key and the URL.2190 Omitted port numbers are automatically converted to the correct2191 default for the scheme before matching.21922193. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2194 path field of the config key must match the path field of the URL2195 either exactly or as a prefix of slash-delimited path elements. This means2196 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2197 match on a slash (`/`) boundary. Longer matches take precedence (so a config2198 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2199 key with just path `foo/`).22002201. User name (e.g., `user` in `https://user@example.com/repo.git`). If2202 the config key has a user name it must match the user name in the2203 URL exactly. If the config key does not have a user name, that2204 config key will match a URL with any user name (including none),2205 but at a lower precedence than a config key with a user name.2206--2207+2208The list above is ordered by decreasing precedence; a URL that matches2209a config key's path is preferred to one that matches its user name. For example,2210if the URL is `https://user@example.com/foo/bar` a config key match of2211`https://example.com/foo` will be preferred over a config key match of2212`https://user@example.com`.2213+2214All URLs are normalized before attempting any matching (the password part,2215if embedded in the URL, is always ignored for matching purposes) so that2216equivalent URLs that are simply spelled differently will match properly.2217Environment variable settings always override any matches. The URLs that are2218matched against are those given directly to Git commands. This means any URLs2219visited as a result of a redirection do not participate in matching.22202221ssh.variant::2222 By default, Git determines the command line arguments to use2223 based on the basename of the configured SSH command (configured2224 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2225 the config setting `core.sshCommand`). If the basename is2226 unrecognized, Git will attempt to detect support of OpenSSH2227 options by first invoking the configured SSH command with the2228 `-G` (print configuration) option and will subsequently use2229 OpenSSH options (if that is successful) or no options besides2230 the host and remote command (if it fails).2231+2232The config variable `ssh.variant` can be set to override this detection.2233Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2234`tortoiseplink`, `simple` (no options except the host and remote command).2235The default auto-detection can be explicitly requested using the value2236`auto`. Any other value is treated as `ssh`. This setting can also be2237overridden via the environment variable `GIT_SSH_VARIANT`.2238+2239The current command-line parameters used for each variant are as2240follows:2241+2242--22432244* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22452246* `simple` - [username@]host command22472248* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22492250* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22512252--2253+2254Except for the `simple` variant, command-line parameters are likely to2255change as git gains new features.22562257i18n.commitEncoding::2258 Character encoding the commit messages are stored in; Git itself2259 does not care per se, but this information is necessary e.g. when2260 importing commits from emails or in the gitk graphical history2261 browser (and possibly at other places in the future or in other2262 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22632264i18n.logOutputEncoding::2265 Character encoding the commit messages are converted to when2266 running 'git log' and friends.22672268imap::2269 The configuration variables in the 'imap' section are described2270 in linkgit:git-imap-send[1].22712272index.version::2273 Specify the version with which new index files should be2274 initialized. This does not affect existing repositories.22752276init.templateDir::2277 Specify the directory from which templates will be copied.2278 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22792280instaweb.browser::2281 Specify the program that will be used to browse your working2282 repository in gitweb. See linkgit:git-instaweb[1].22832284instaweb.httpd::2285 The HTTP daemon command-line to start gitweb on your working2286 repository. See linkgit:git-instaweb[1].22872288instaweb.local::2289 If true the web server started by linkgit:git-instaweb[1] will2290 be bound to the local IP (127.0.0.1).22912292instaweb.modulePath::2293 The default module path for linkgit:git-instaweb[1] to use2294 instead of /usr/lib/apache2/modules. Only used if httpd2295 is Apache.22962297instaweb.port::2298 The port number to bind the gitweb httpd to. See2299 linkgit:git-instaweb[1].23002301interactive.singleKey::2302 In interactive commands, allow the user to provide one-letter2303 input with a single key (i.e., without hitting enter).2304 Currently this is used by the `--patch` mode of2305 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2306 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2307 setting is silently ignored if portable keystroke input2308 is not available; requires the Perl module Term::ReadKey.23092310interactive.diffFilter::2311 When an interactive command (such as `git add --patch`) shows2312 a colorized diff, git will pipe the diff through the shell2313 command defined by this configuration variable. The command may2314 mark up the diff further for human consumption, provided that it2315 retains a one-to-one correspondence with the lines in the2316 original diff. Defaults to disabled (no filtering).23172318log.abbrevCommit::2319 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2320 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2321 override this option with `--no-abbrev-commit`.23222323log.date::2324 Set the default date-time mode for the 'log' command.2325 Setting a value for log.date is similar to using 'git log''s2326 `--date` option. See linkgit:git-log[1] for details.23272328log.decorate::2329 Print out the ref names of any commits that are shown by the log2330 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2331 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2332 specified, the full ref name (including prefix) will be printed.2333 If 'auto' is specified, then if the output is going to a terminal,2334 the ref names are shown as if 'short' were given, otherwise no ref2335 names are shown. This is the same as the `--decorate` option2336 of the `git log`.23372338log.follow::2339 If `true`, `git log` will act as if the `--follow` option was used when2340 a single <path> is given. This has the same limitations as `--follow`,2341 i.e. it cannot be used to follow multiple files and does not work well2342 on non-linear history.23432344log.graphColors::2345 A list of colors, separated by commas, that can be used to draw2346 history lines in `git log --graph`.23472348log.showRoot::2349 If true, the initial commit will be shown as a big creation event.2350 This is equivalent to a diff against an empty tree.2351 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2352 normally hide the root commit will now show it. True by default.23532354log.showSignature::2355 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2356 linkgit:git-whatchanged[1] assume `--show-signature`.23572358log.mailmap::2359 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2360 linkgit:git-whatchanged[1] assume `--use-mailmap`.23612362mailinfo.scissors::2363 If true, makes linkgit:git-mailinfo[1] (and therefore2364 linkgit:git-am[1]) act by default as if the --scissors option2365 was provided on the command-line. When active, this features2366 removes everything from the message body before a scissors2367 line (i.e. consisting mainly of ">8", "8<" and "-").23682369mailmap.file::2370 The location of an augmenting mailmap file. The default2371 mailmap, located in the root of the repository, is loaded2372 first, then the mailmap file pointed to by this variable.2373 The location of the mailmap file may be in a repository2374 subdirectory, or somewhere outside of the repository itself.2375 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23762377mailmap.blob::2378 Like `mailmap.file`, but consider the value as a reference to a2379 blob in the repository. If both `mailmap.file` and2380 `mailmap.blob` are given, both are parsed, with entries from2381 `mailmap.file` taking precedence. In a bare repository, this2382 defaults to `HEAD:.mailmap`. In a non-bare repository, it2383 defaults to empty.23842385man.viewer::2386 Specify the programs that may be used to display help in the2387 'man' format. See linkgit:git-help[1].23882389man.<tool>.cmd::2390 Specify the command to invoke the specified man viewer. The2391 specified command is evaluated in shell with the man page2392 passed as argument. (See linkgit:git-help[1].)23932394man.<tool>.path::2395 Override the path for the given tool that may be used to2396 display help in the 'man' format. See linkgit:git-help[1].23972398include::merge-config.txt[]23992400mergetool.<tool>.path::2401 Override the path for the given tool. This is useful in case2402 your tool is not in the PATH.24032404mergetool.<tool>.cmd::2405 Specify the command to invoke the specified merge tool. The2406 specified command is evaluated in shell with the following2407 variables available: 'BASE' is the name of a temporary file2408 containing the common base of the files to be merged, if available;2409 'LOCAL' is the name of a temporary file containing the contents of2410 the file on the current branch; 'REMOTE' is the name of a temporary2411 file containing the contents of the file from the branch being2412 merged; 'MERGED' contains the name of the file to which the merge2413 tool should write the results of a successful merge.24142415mergetool.<tool>.trustExitCode::2416 For a custom merge command, specify whether the exit code of2417 the merge command can be used to determine whether the merge was2418 successful. If this is not set to true then the merge target file2419 timestamp is checked and the merge assumed to have been successful2420 if the file has been updated, otherwise the user is prompted to2421 indicate the success of the merge.24222423mergetool.meld.hasOutput::2424 Older versions of `meld` do not support the `--output` option.2425 Git will attempt to detect whether `meld` supports `--output`2426 by inspecting the output of `meld --help`. Configuring2427 `mergetool.meld.hasOutput` will make Git skip these checks and2428 use the configured value instead. Setting `mergetool.meld.hasOutput`2429 to `true` tells Git to unconditionally use the `--output` option,2430 and `false` avoids using `--output`.24312432mergetool.keepBackup::2433 After performing a merge, the original file with conflict markers2434 can be saved as a file with a `.orig` extension. If this variable2435 is set to `false` then this file is not preserved. Defaults to2436 `true` (i.e. keep the backup files).24372438mergetool.keepTemporaries::2439 When invoking a custom merge tool, Git uses a set of temporary2440 files to pass to the tool. If the tool returns an error and this2441 variable is set to `true`, then these temporary files will be2442 preserved, otherwise they will be removed after the tool has2443 exited. Defaults to `false`.24442445mergetool.writeToTemp::2446 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2447 conflicting files in the worktree by default. Git will attempt2448 to use a temporary directory for these files when set `true`.2449 Defaults to `false`.24502451mergetool.prompt::2452 Prompt before each invocation of the merge resolution program.24532454notes.mergeStrategy::2455 Which merge strategy to choose by default when resolving notes2456 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2457 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2458 section of linkgit:git-notes[1] for more information on each strategy.24592460notes.<name>.mergeStrategy::2461 Which merge strategy to choose when doing a notes merge into2462 refs/notes/<name>. This overrides the more general2463 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2464 linkgit:git-notes[1] for more information on the available strategies.24652466notes.displayRef::2467 The (fully qualified) refname from which to show notes when2468 showing commit messages. The value of this variable can be set2469 to a glob, in which case notes from all matching refs will be2470 shown. You may also specify this configuration variable2471 several times. A warning will be issued for refs that do not2472 exist, but a glob that does not match any refs is silently2473 ignored.2474+2475This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2476environment variable, which must be a colon separated list of refs or2477globs.2478+2479The effective value of "core.notesRef" (possibly overridden by2480GIT_NOTES_REF) is also implicitly added to the list of refs to be2481displayed.24822483notes.rewrite.<command>::2484 When rewriting commits with <command> (currently `amend` or2485 `rebase`) and this variable is set to `true`, Git2486 automatically copies your notes from the original to the2487 rewritten commit. Defaults to `true`, but see2488 "notes.rewriteRef" below.24892490notes.rewriteMode::2491 When copying notes during a rewrite (see the2492 "notes.rewrite.<command>" option), determines what to do if2493 the target commit already has a note. Must be one of2494 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2495 Defaults to `concatenate`.2496+2497This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2498environment variable.24992500notes.rewriteRef::2501 When copying notes during a rewrite, specifies the (fully2502 qualified) ref whose notes should be copied. The ref may be a2503 glob, in which case notes in all matching refs will be copied.2504 You may also specify this configuration several times.2505+2506Does not have a default value; you must configure this variable to2507enable note rewriting. Set it to `refs/notes/commits` to enable2508rewriting for the default commit notes.2509+2510This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2511environment variable, which must be a colon separated list of refs or2512globs.25132514pack.window::2515 The size of the window used by linkgit:git-pack-objects[1] when no2516 window size is given on the command line. Defaults to 10.25172518pack.depth::2519 The maximum delta depth used by linkgit:git-pack-objects[1] when no2520 maximum depth is given on the command line. Defaults to 50.2521 Maximum value is 4095.25222523pack.windowMemory::2524 The maximum size of memory that is consumed by each thread2525 in linkgit:git-pack-objects[1] for pack window memory when2526 no limit is given on the command line. The value can be2527 suffixed with "k", "m", or "g". When left unconfigured (or2528 set explicitly to 0), there will be no limit.25292530pack.compression::2531 An integer -1..9, indicating the compression level for objects2532 in a pack file. -1 is the zlib default. 0 means no2533 compression, and 1..9 are various speed/size tradeoffs, 9 being2534 slowest. If not set, defaults to core.compression. If that is2535 not set, defaults to -1, the zlib default, which is "a default2536 compromise between speed and compression (currently equivalent2537 to level 6)."2538+2539Note that changing the compression level will not automatically recompress2540all existing objects. You can force recompression by passing the -F option2541to linkgit:git-repack[1].25422543pack.deltaCacheSize::2544 The maximum memory in bytes used for caching deltas in2545 linkgit:git-pack-objects[1] before writing them out to a pack.2546 This cache is used to speed up the writing object phase by not2547 having to recompute the final delta result once the best match2548 for all objects is found. Repacking large repositories on machines2549 which are tight with memory might be badly impacted by this though,2550 especially if this cache pushes the system into swapping.2551 A value of 0 means no limit. The smallest size of 1 byte may be2552 used to virtually disable this cache. Defaults to 256 MiB.25532554pack.deltaCacheLimit::2555 The maximum size of a delta, that is cached in2556 linkgit:git-pack-objects[1]. This cache is used to speed up the2557 writing object phase by not having to recompute the final delta2558 result once the best match for all objects is found.2559 Defaults to 1000. Maximum value is 65535.25602561pack.threads::2562 Specifies the number of threads to spawn when searching for best2563 delta matches. This requires that linkgit:git-pack-objects[1]2564 be compiled with pthreads otherwise this option is ignored with a2565 warning. This is meant to reduce packing time on multiprocessor2566 machines. The required amount of memory for the delta search window2567 is however multiplied by the number of threads.2568 Specifying 0 will cause Git to auto-detect the number of CPU's2569 and set the number of threads accordingly.25702571pack.indexVersion::2572 Specify the default pack index version. Valid values are 1 for2573 legacy pack index used by Git versions prior to 1.5.2, and 2 for2574 the new pack index with capabilities for packs larger than 4 GB2575 as well as proper protection against the repacking of corrupted2576 packs. Version 2 is the default. Note that version 2 is enforced2577 and this config option ignored whenever the corresponding pack is2578 larger than 2 GB.2579+2580If you have an old Git that does not understand the version 2 `*.idx` file,2581cloning or fetching over a non native protocol (e.g. "http")2582that will copy both `*.pack` file and corresponding `*.idx` file from the2583other side may give you a repository that cannot be accessed with your2584older version of Git. If the `*.pack` file is smaller than 2 GB, however,2585you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2586the `*.idx` file.25872588pack.packSizeLimit::2589 The maximum size of a pack. This setting only affects2590 packing to a file when repacking, i.e. the git:// protocol2591 is unaffected. It can be overridden by the `--max-pack-size`2592 option of linkgit:git-repack[1]. Reaching this limit results2593 in the creation of multiple packfiles; which in turn prevents2594 bitmaps from being created.2595 The minimum size allowed is limited to 1 MiB.2596 The default is unlimited.2597 Common unit suffixes of 'k', 'm', or 'g' are2598 supported.25992600pack.useBitmaps::2601 When true, git will use pack bitmaps (if available) when packing2602 to stdout (e.g., during the server side of a fetch). Defaults to2603 true. You should not generally need to turn this off unless2604 you are debugging pack bitmaps.26052606pack.writeBitmaps (deprecated)::2607 This is a deprecated synonym for `repack.writeBitmaps`.26082609pack.writeBitmapHashCache::2610 When true, git will include a "hash cache" section in the bitmap2611 index (if one is written). This cache can be used to feed git's2612 delta heuristics, potentially leading to better deltas between2613 bitmapped and non-bitmapped objects (e.g., when serving a fetch2614 between an older, bitmapped pack and objects that have been2615 pushed since the last gc). The downside is that it consumes 42616 bytes per object of disk space, and that JGit's bitmap2617 implementation does not understand it, causing it to complain if2618 Git and JGit are used on the same repository. Defaults to false.26192620pager.<cmd>::2621 If the value is boolean, turns on or off pagination of the2622 output of a particular Git subcommand when writing to a tty.2623 Otherwise, turns on pagination for the subcommand using the2624 pager specified by the value of `pager.<cmd>`. If `--paginate`2625 or `--no-pager` is specified on the command line, it takes2626 precedence over this option. To disable pagination for all2627 commands, set `core.pager` or `GIT_PAGER` to `cat`.26282629pretty.<name>::2630 Alias for a --pretty= format string, as specified in2631 linkgit:git-log[1]. Any aliases defined here can be used just2632 as the built-in pretty formats could. For example,2633 running `git config pretty.changelog "format:* %H %s"`2634 would cause the invocation `git log --pretty=changelog`2635 to be equivalent to running `git log "--pretty=format:* %H %s"`.2636 Note that an alias with the same name as a built-in format2637 will be silently ignored.26382639protocol.allow::2640 If set, provide a user defined default policy for all protocols which2641 don't explicitly have a policy (`protocol.<name>.allow`). By default,2642 if unset, known-safe protocols (http, https, git, ssh, file) have a2643 default policy of `always`, known-dangerous protocols (ext) have a2644 default policy of `never`, and all other protocols have a default2645 policy of `user`. Supported policies:2646+2647--26482649* `always` - protocol is always able to be used.26502651* `never` - protocol is never able to be used.26522653* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2654 either unset or has a value of 1. This policy should be used when you want a2655 protocol to be directly usable by the user but don't want it used by commands which2656 execute clone/fetch/push commands without user input, e.g. recursive2657 submodule initialization.26582659--26602661protocol.<name>.allow::2662 Set a policy to be used by protocol `<name>` with clone/fetch/push2663 commands. See `protocol.allow` above for the available policies.2664+2665The protocol names currently used by git are:2666+2667--2668 - `file`: any local file-based path (including `file://` URLs,2669 or local paths)26702671 - `git`: the anonymous git protocol over a direct TCP2672 connection (or proxy, if configured)26732674 - `ssh`: git over ssh (including `host:path` syntax,2675 `ssh://`, etc).26762677 - `http`: git over http, both "smart http" and "dumb http".2678 Note that this does _not_ include `https`; if you want to configure2679 both, you must do so individually.26802681 - any external helpers are named by their protocol (e.g., use2682 `hg` to allow the `git-remote-hg` helper)2683--26842685protocol.version::2686 Experimental. If set, clients will attempt to communicate with a2687 server using the specified protocol version. If unset, no2688 attempt will be made by the client to communicate using a2689 particular protocol version, this results in protocol version 02690 being used.2691 Supported versions:2692+2693--26942695* `0` - the original wire protocol.26962697* `1` - the original wire protocol with the addition of a version string2698 in the initial response from the server.26992700--27012702pull.ff::2703 By default, Git does not create an extra merge commit when merging2704 a commit that is a descendant of the current commit. Instead, the2705 tip of the current branch is fast-forwarded. When set to `false`,2706 this variable tells Git to create an extra merge commit in such2707 a case (equivalent to giving the `--no-ff` option from the command2708 line). When set to `only`, only such fast-forward merges are2709 allowed (equivalent to giving the `--ff-only` option from the2710 command line). This setting overrides `merge.ff` when pulling.27112712pull.rebase::2713 When true, rebase branches on top of the fetched branch, instead2714 of merging the default branch from the default remote when "git2715 pull" is run. See "branch.<name>.rebase" for setting this on a2716 per-branch basis.2717+2718When `merges`, pass the `--rebase-merges` option to 'git rebase'2719so that the local merge commits are included in the rebase (see2720linkgit:git-rebase[1] for details).2721+2722When preserve, also pass `--preserve-merges` along to 'git rebase'2723so that locally committed merge commits will not be flattened2724by running 'git pull'.2725+2726When the value is `interactive`, the rebase is run in interactive mode.2727+2728*NOTE*: this is a possibly dangerous operation; do *not* use2729it unless you understand the implications (see linkgit:git-rebase[1]2730for details).27312732pull.octopus::2733 The default merge strategy to use when pulling multiple branches2734 at once.27352736pull.twohead::2737 The default merge strategy to use when pulling a single branch.27382739push.default::2740 Defines the action `git push` should take if no refspec is2741 explicitly given. Different values are well-suited for2742 specific workflows; for instance, in a purely central workflow2743 (i.e. the fetch source is equal to the push destination),2744 `upstream` is probably what you want. Possible values are:2745+2746--27472748* `nothing` - do not push anything (error out) unless a refspec is2749 explicitly given. This is primarily meant for people who want to2750 avoid mistakes by always being explicit.27512752* `current` - push the current branch to update a branch with the same2753 name on the receiving end. Works in both central and non-central2754 workflows.27552756* `upstream` - push the current branch back to the branch whose2757 changes are usually integrated into the current branch (which is2758 called `@{upstream}`). This mode only makes sense if you are2759 pushing to the same repository you would normally pull from2760 (i.e. central workflow).27612762* `tracking` - This is a deprecated synonym for `upstream`.27632764* `simple` - in centralized workflow, work like `upstream` with an2765 added safety to refuse to push if the upstream branch's name is2766 different from the local one.2767+2768When pushing to a remote that is different from the remote you normally2769pull from, work as `current`. This is the safest option and is suited2770for beginners.2771+2772This mode has become the default in Git 2.0.27732774* `matching` - push all branches having the same name on both ends.2775 This makes the repository you are pushing to remember the set of2776 branches that will be pushed out (e.g. if you always push 'maint'2777 and 'master' there and no other branches, the repository you push2778 to will have these two branches, and your local 'maint' and2779 'master' will be pushed there).2780+2781To use this mode effectively, you have to make sure _all_ the2782branches you would push out are ready to be pushed out before2783running 'git push', as the whole point of this mode is to allow you2784to push all of the branches in one go. If you usually finish work2785on only one branch and push out the result, while other branches are2786unfinished, this mode is not for you. Also this mode is not2787suitable for pushing into a shared central repository, as other2788people may add new branches there, or update the tip of existing2789branches outside your control.2790+2791This used to be the default, but not since Git 2.0 (`simple` is the2792new default).27932794--27952796push.followTags::2797 If set to true enable `--follow-tags` option by default. You2798 may override this configuration at time of push by specifying2799 `--no-follow-tags`.28002801push.gpgSign::2802 May be set to a boolean value, or the string 'if-asked'. A true2803 value causes all pushes to be GPG signed, as if `--signed` is2804 passed to linkgit:git-push[1]. The string 'if-asked' causes2805 pushes to be signed if the server supports it, as if2806 `--signed=if-asked` is passed to 'git push'. A false value may2807 override a value from a lower-priority config file. An explicit2808 command-line flag always overrides this config option.28092810push.pushOption::2811 When no `--push-option=<option>` argument is given from the2812 command line, `git push` behaves as if each <value> of2813 this variable is given as `--push-option=<value>`.2814+2815This is a multi-valued variable, and an empty value can be used in a2816higher priority configuration file (e.g. `.git/config` in a2817repository) to clear the values inherited from a lower priority2818configuration files (e.g. `$HOME/.gitconfig`).2819+2820--28212822Example:28232824/etc/gitconfig2825 push.pushoption = a2826 push.pushoption = b28272828~/.gitconfig2829 push.pushoption = c28302831repo/.git/config2832 push.pushoption =2833 push.pushoption = b28342835This will result in only b (a and c are cleared).28362837--28382839push.recurseSubmodules::2840 Make sure all submodule commits used by the revisions to be pushed2841 are available on a remote-tracking branch. If the value is 'check'2842 then Git will verify that all submodule commits that changed in the2843 revisions to be pushed are available on at least one remote of the2844 submodule. If any commits are missing, the push will be aborted and2845 exit with non-zero status. If the value is 'on-demand' then all2846 submodules that changed in the revisions to be pushed will be2847 pushed. If on-demand was not able to push all necessary revisions2848 it will also be aborted and exit with non-zero status. If the value2849 is 'no' then default behavior of ignoring submodules when pushing2850 is retained. You may override this configuration at time of push by2851 specifying '--recurse-submodules=check|on-demand|no'.28522853include::rebase-config.txt[]28542855receive.advertiseAtomic::2856 By default, git-receive-pack will advertise the atomic push2857 capability to its clients. If you don't want to advertise this2858 capability, set this variable to false.28592860receive.advertisePushOptions::2861 When set to true, git-receive-pack will advertise the push options2862 capability to its clients. False by default.28632864receive.autogc::2865 By default, git-receive-pack will run "git-gc --auto" after2866 receiving data from git-push and updating refs. You can stop2867 it by setting this variable to false.28682869receive.certNonceSeed::2870 By setting this variable to a string, `git receive-pack`2871 will accept a `git push --signed` and verifies it by using2872 a "nonce" protected by HMAC using this string as a secret2873 key.28742875receive.certNonceSlop::2876 When a `git push --signed` sent a push certificate with a2877 "nonce" that was issued by a receive-pack serving the same2878 repository within this many seconds, export the "nonce"2879 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2880 hooks (instead of what the receive-pack asked the sending2881 side to include). This may allow writing checks in2882 `pre-receive` and `post-receive` a bit easier. Instead of2883 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2884 that records by how many seconds the nonce is stale to2885 decide if they want to accept the certificate, they only2886 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28872888receive.fsckObjects::2889 If it is set to true, git-receive-pack will check all received2890 objects. It will abort in the case of a malformed object or a2891 broken link. The result of an abort are only dangling objects.2892 Defaults to false. If not set, the value of `transfer.fsckObjects`2893 is used instead.28942895receive.fsck.<msg-id>::2896 When `receive.fsckObjects` is set to true, errors can be switched2897 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2898 setting where the `<msg-id>` is the fsck message ID and the value2899 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2900 the error/warning with the message ID, e.g. "missingEmail: invalid2901 author/committer line - missing email" means that setting2902 `receive.fsck.missingEmail = ignore` will hide that issue.2903+2904This feature is intended to support working with legacy repositories2905which would not pass pushing when `receive.fsckObjects = true`, allowing2906the host to accept repositories with certain known issues but still catch2907other issues.29082909receive.fsck.skipList::2910 The path to a sorted list of object names (i.e. one SHA-1 per2911 line) that are known to be broken in a non-fatal way and should2912 be ignored. This feature is useful when an established project2913 should be accepted despite early commits containing errors that2914 can be safely ignored such as invalid committer email addresses.2915 Note: corrupt objects cannot be skipped with this setting.29162917receive.keepAlive::2918 After receiving the pack from the client, `receive-pack` may2919 produce no output (if `--quiet` was specified) while processing2920 the pack, causing some networks to drop the TCP connection.2921 With this option set, if `receive-pack` does not transmit2922 any data in this phase for `receive.keepAlive` seconds, it will2923 send a short keepalive packet. The default is 5 seconds; set2924 to 0 to disable keepalives entirely.29252926receive.unpackLimit::2927 If the number of objects received in a push is below this2928 limit then the objects will be unpacked into loose object2929 files. However if the number of received objects equals or2930 exceeds this limit then the received pack will be stored as2931 a pack, after adding any missing delta bases. Storing the2932 pack from a push can make the push operation complete faster,2933 especially on slow filesystems. If not set, the value of2934 `transfer.unpackLimit` is used instead.29352936receive.maxInputSize::2937 If the size of the incoming pack stream is larger than this2938 limit, then git-receive-pack will error out, instead of2939 accepting the pack file. If not set or set to 0, then the size2940 is unlimited.29412942receive.denyDeletes::2943 If set to true, git-receive-pack will deny a ref update that deletes2944 the ref. Use this to prevent such a ref deletion via a push.29452946receive.denyDeleteCurrent::2947 If set to true, git-receive-pack will deny a ref update that2948 deletes the currently checked out branch of a non-bare repository.29492950receive.denyCurrentBranch::2951 If set to true or "refuse", git-receive-pack will deny a ref update2952 to the currently checked out branch of a non-bare repository.2953 Such a push is potentially dangerous because it brings the HEAD2954 out of sync with the index and working tree. If set to "warn",2955 print a warning of such a push to stderr, but allow the push to2956 proceed. If set to false or "ignore", allow such pushes with no2957 message. Defaults to "refuse".2958+2959Another option is "updateInstead" which will update the working2960tree if pushing into the current branch. This option is2961intended for synchronizing working directories when one side is not easily2962accessible via interactive ssh (e.g. a live web site, hence the requirement2963that the working directory be clean). This mode also comes in handy when2964developing inside a VM to test and fix code on different Operating Systems.2965+2966By default, "updateInstead" will refuse the push if the working tree or2967the index have any difference from the HEAD, but the `push-to-checkout`2968hook can be used to customize this. See linkgit:githooks[5].29692970receive.denyNonFastForwards::2971 If set to true, git-receive-pack will deny a ref update which is2972 not a fast-forward. Use this to prevent such an update via a push,2973 even if that push is forced. This configuration variable is2974 set when initializing a shared repository.29752976receive.hideRefs::2977 This variable is the same as `transfer.hideRefs`, but applies2978 only to `receive-pack` (and so affects pushes, but not fetches).2979 An attempt to update or delete a hidden ref by `git push` is2980 rejected.29812982receive.updateServerInfo::2983 If set to true, git-receive-pack will run git-update-server-info2984 after receiving data from git-push and updating refs.29852986receive.shallowUpdate::2987 If set to true, .git/shallow can be updated when new refs2988 require new shallow roots. Otherwise those refs are rejected.29892990remote.pushDefault::2991 The remote to push to by default. Overrides2992 `branch.<name>.remote` for all branches, and is overridden by2993 `branch.<name>.pushRemote` for specific branches.29942995remote.<name>.url::2996 The URL of a remote repository. See linkgit:git-fetch[1] or2997 linkgit:git-push[1].29982999remote.<name>.pushurl::3000 The push URL of a remote repository. See linkgit:git-push[1].30013002remote.<name>.proxy::3003 For remotes that require curl (http, https and ftp), the URL to3004 the proxy to use for that remote. Set to the empty string to3005 disable proxying for that remote.30063007remote.<name>.proxyAuthMethod::3008 For remotes that require curl (http, https and ftp), the method to use for3009 authenticating against the proxy in use (probably set in3010 `remote.<name>.proxy`). See `http.proxyAuthMethod`.30113012remote.<name>.fetch::3013 The default set of "refspec" for linkgit:git-fetch[1]. See3014 linkgit:git-fetch[1].30153016remote.<name>.push::3017 The default set of "refspec" for linkgit:git-push[1]. See3018 linkgit:git-push[1].30193020remote.<name>.mirror::3021 If true, pushing to this remote will automatically behave3022 as if the `--mirror` option was given on the command line.30233024remote.<name>.skipDefaultUpdate::3025 If true, this remote will be skipped by default when updating3026 using linkgit:git-fetch[1] or the `update` subcommand of3027 linkgit:git-remote[1].30283029remote.<name>.skipFetchAll::3030 If true, this remote will be skipped by default when updating3031 using linkgit:git-fetch[1] or the `update` subcommand of3032 linkgit:git-remote[1].30333034remote.<name>.receivepack::3035 The default program to execute on the remote side when pushing. See3036 option --receive-pack of linkgit:git-push[1].30373038remote.<name>.uploadpack::3039 The default program to execute on the remote side when fetching. See3040 option --upload-pack of linkgit:git-fetch-pack[1].30413042remote.<name>.tagOpt::3043 Setting this value to --no-tags disables automatic tag following when3044 fetching from remote <name>. Setting it to --tags will fetch every3045 tag from remote <name>, even if they are not reachable from remote3046 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3047 override this setting. See options --tags and --no-tags of3048 linkgit:git-fetch[1].30493050remote.<name>.vcs::3051 Setting this to a value <vcs> will cause Git to interact with3052 the remote with the git-remote-<vcs> helper.30533054remote.<name>.prune::3055 When set to true, fetching from this remote by default will also3056 remove any remote-tracking references that no longer exist on the3057 remote (as if the `--prune` option was given on the command line).3058 Overrides `fetch.prune` settings, if any.30593060remote.<name>.pruneTags::3061 When set to true, fetching from this remote by default will also3062 remove any local tags that no longer exist on the remote if pruning3063 is activated in general via `remote.<name>.prune`, `fetch.prune` or3064 `--prune`. Overrides `fetch.pruneTags` settings, if any.3065+3066See also `remote.<name>.prune` and the PRUNING section of3067linkgit:git-fetch[1].30683069remotes.<group>::3070 The list of remotes which are fetched by "git remote update3071 <group>". See linkgit:git-remote[1].30723073repack.useDeltaBaseOffset::3074 By default, linkgit:git-repack[1] creates packs that use3075 delta-base offset. If you need to share your repository with3076 Git older than version 1.4.4, either directly or via a dumb3077 protocol such as http, then you need to set this option to3078 "false" and repack. Access from old Git versions over the3079 native protocol are unaffected by this option.30803081repack.packKeptObjects::3082 If set to true, makes `git repack` act as if3083 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3084 details. Defaults to `false` normally, but `true` if a bitmap3085 index is being written (either via `--write-bitmap-index` or3086 `repack.writeBitmaps`).30873088repack.writeBitmaps::3089 When true, git will write a bitmap index when packing all3090 objects to disk (e.g., when `git repack -a` is run). This3091 index can speed up the "counting objects" phase of subsequent3092 packs created for clones and fetches, at the cost of some disk3093 space and extra time spent on the initial repack. This has3094 no effect if multiple packfiles are created.3095 Defaults to false.30963097rerere.autoUpdate::3098 When set to true, `git-rerere` updates the index with the3099 resulting contents after it cleanly resolves conflicts using3100 previously recorded resolution. Defaults to false.31013102rerere.enabled::3103 Activate recording of resolved conflicts, so that identical3104 conflict hunks can be resolved automatically, should they be3105 encountered again. By default, linkgit:git-rerere[1] is3106 enabled if there is an `rr-cache` directory under the3107 `$GIT_DIR`, e.g. if "rerere" was previously used in the3108 repository.31093110sendemail.identity::3111 A configuration identity. When given, causes values in the3112 'sendemail.<identity>' subsection to take precedence over3113 values in the 'sendemail' section. The default identity is3114 the value of `sendemail.identity`.31153116sendemail.smtpEncryption::3117 See linkgit:git-send-email[1] for description. Note that this3118 setting is not subject to the 'identity' mechanism.31193120sendemail.smtpssl (deprecated)::3121 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31223123sendemail.smtpsslcertpath::3124 Path to ca-certificates (either a directory or a single file).3125 Set it to an empty string to disable certificate verification.31263127sendemail.<identity>.*::3128 Identity-specific versions of the 'sendemail.*' parameters3129 found below, taking precedence over those when this3130 identity is selected, through either the command-line or3131 `sendemail.identity`.31323133sendemail.aliasesFile::3134sendemail.aliasFileType::3135sendemail.annotate::3136sendemail.bcc::3137sendemail.cc::3138sendemail.ccCmd::3139sendemail.chainReplyTo::3140sendemail.confirm::3141sendemail.envelopeSender::3142sendemail.from::3143sendemail.multiEdit::3144sendemail.signedoffbycc::3145sendemail.smtpPass::3146sendemail.suppresscc::3147sendemail.suppressFrom::3148sendemail.to::3149sendemail.tocmd::3150sendemail.smtpDomain::3151sendemail.smtpServer::3152sendemail.smtpServerPort::3153sendemail.smtpServerOption::3154sendemail.smtpUser::3155sendemail.thread::3156sendemail.transferEncoding::3157sendemail.validate::3158sendemail.xmailer::3159 See linkgit:git-send-email[1] for description.31603161sendemail.signedoffcc (deprecated)::3162 Deprecated alias for `sendemail.signedoffbycc`.31633164sendemail.smtpBatchSize::3165 Number of messages to be sent per connection, after that a relogin3166 will happen. If the value is 0 or undefined, send all messages in3167 one connection.3168 See also the `--batch-size` option of linkgit:git-send-email[1].31693170sendemail.smtpReloginDelay::3171 Seconds wait before reconnecting to smtp server.3172 See also the `--relogin-delay` option of linkgit:git-send-email[1].31733174showbranch.default::3175 The default set of branches for linkgit:git-show-branch[1].3176 See linkgit:git-show-branch[1].31773178splitIndex.maxPercentChange::3179 When the split index feature is used, this specifies the3180 percent of entries the split index can contain compared to the3181 total number of entries in both the split index and the shared3182 index before a new shared index is written.3183 The value should be between 0 and 100. If the value is 0 then3184 a new shared index is always written, if it is 100 a new3185 shared index is never written.3186 By default the value is 20, so a new shared index is written3187 if the number of entries in the split index would be greater3188 than 20 percent of the total number of entries.3189 See linkgit:git-update-index[1].31903191splitIndex.sharedIndexExpire::3192 When the split index feature is used, shared index files that3193 were not modified since the time this variable specifies will3194 be removed when a new shared index file is created. The value3195 "now" expires all entries immediately, and "never" suppresses3196 expiration altogether.3197 The default value is "2.weeks.ago".3198 Note that a shared index file is considered modified (for the3199 purpose of expiration) each time a new split-index file is3200 either created based on it or read from it.3201 See linkgit:git-update-index[1].32023203status.relativePaths::3204 By default, linkgit:git-status[1] shows paths relative to the3205 current directory. Setting this variable to `false` shows paths3206 relative to the repository root (this was the default for Git3207 prior to v1.5.4).32083209status.short::3210 Set to true to enable --short by default in linkgit:git-status[1].3211 The option --no-short takes precedence over this variable.32123213status.branch::3214 Set to true to enable --branch by default in linkgit:git-status[1].3215 The option --no-branch takes precedence over this variable.32163217status.displayCommentPrefix::3218 If set to true, linkgit:git-status[1] will insert a comment3219 prefix before each output line (starting with3220 `core.commentChar`, i.e. `#` by default). This was the3221 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3222 Defaults to false.32233224status.renameLimit::3225 The number of files to consider when performing rename detection3226 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3227 the value of diff.renameLimit.32283229status.renames::3230 Whether and how Git detects renames in linkgit:git-status[1] and3231 linkgit:git-commit[1] . If set to "false", rename detection is3232 disabled. If set to "true", basic rename detection is enabled.3233 If set to "copies" or "copy", Git will detect copies, as well.3234 Defaults to the value of diff.renames.32353236status.showStash::3237 If set to true, linkgit:git-status[1] will display the number of3238 entries currently stashed away.3239 Defaults to false.32403241status.showUntrackedFiles::3242 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3243 files which are not currently tracked by Git. Directories which3244 contain only untracked files, are shown with the directory name3245 only. Showing untracked files means that Git needs to lstat() all3246 the files in the whole repository, which might be slow on some3247 systems. So, this variable controls how the commands displays3248 the untracked files. Possible values are:3249+3250--3251* `no` - Show no untracked files.3252* `normal` - Show untracked files and directories.3253* `all` - Show also individual files in untracked directories.3254--3255+3256If this variable is not specified, it defaults to 'normal'.3257This variable can be overridden with the -u|--untracked-files option3258of linkgit:git-status[1] and linkgit:git-commit[1].32593260status.submoduleSummary::3261 Defaults to false.3262 If this is set to a non zero number or true (identical to -1 or an3263 unlimited number), the submodule summary will be enabled and a3264 summary of commits for modified submodules will be shown (see3265 --summary-limit option of linkgit:git-submodule[1]). Please note3266 that the summary output command will be suppressed for all3267 submodules when `diff.ignoreSubmodules` is set to 'all' or only3268 for those submodules where `submodule.<name>.ignore=all`. The only3269 exception to that rule is that status and commit will show staged3270 submodule changes. To3271 also view the summary for ignored submodules you can either use3272 the --ignore-submodules=dirty command-line option or the 'git3273 submodule summary' command, which shows a similar output but does3274 not honor these settings.32753276stash.showPatch::3277 If this is set to true, the `git stash show` command without an3278 option will show the stash entry in patch form. Defaults to false.3279 See description of 'show' command in linkgit:git-stash[1].32803281stash.showStat::3282 If this is set to true, the `git stash show` command without an3283 option will show diffstat of the stash entry. Defaults to true.3284 See description of 'show' command in linkgit:git-stash[1].32853286submodule.<name>.url::3287 The URL for a submodule. This variable is copied from the .gitmodules3288 file to the git config via 'git submodule init'. The user can change3289 the configured URL before obtaining the submodule via 'git submodule3290 update'. If neither submodule.<name>.active or submodule.active are3291 set, the presence of this variable is used as a fallback to indicate3292 whether the submodule is of interest to git commands.3293 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32943295submodule.<name>.update::3296 The method by which a submodule is updated by 'git submodule update',3297 which is the only affected command, others such as3298 'git checkout --recurse-submodules' are unaffected. It exists for3299 historical reasons, when 'git submodule' was the only command to3300 interact with submodules; settings like `submodule.active`3301 and `pull.rebase` are more specific. It is populated by3302 `git submodule init` from the linkgit:gitmodules[5] file.3303 See description of 'update' command in linkgit:git-submodule[1].33043305submodule.<name>.branch::3306 The remote branch name for a submodule, used by `git submodule3307 update --remote`. Set this option to override the value found in3308 the `.gitmodules` file. See linkgit:git-submodule[1] and3309 linkgit:gitmodules[5] for details.33103311submodule.<name>.fetchRecurseSubmodules::3312 This option can be used to control recursive fetching of this3313 submodule. It can be overridden by using the --[no-]recurse-submodules3314 command-line option to "git fetch" and "git pull".3315 This setting will override that from in the linkgit:gitmodules[5]3316 file.33173318submodule.<name>.ignore::3319 Defines under what circumstances "git status" and the diff family show3320 a submodule as modified. When set to "all", it will never be considered3321 modified (but it will nonetheless show up in the output of status and3322 commit when it has been staged), "dirty" will ignore all changes3323 to the submodules work tree and3324 takes only differences between the HEAD of the submodule and the commit3325 recorded in the superproject into account. "untracked" will additionally3326 let submodules with modified tracked files in their work tree show up.3327 Using "none" (the default when this option is not set) also shows3328 submodules that have untracked files in their work tree as changed.3329 This setting overrides any setting made in .gitmodules for this submodule,3330 both settings can be overridden on the command line by using the3331 "--ignore-submodules" option. The 'git submodule' commands are not3332 affected by this setting.33333334submodule.<name>.active::3335 Boolean value indicating if the submodule is of interest to git3336 commands. This config option takes precedence over the3337 submodule.active config option.33383339submodule.active::3340 A repeated field which contains a pathspec used to match against a3341 submodule's path to determine if the submodule is of interest to git3342 commands.33433344submodule.recurse::3345 Specifies if commands recurse into submodules by default. This3346 applies to all commands that have a `--recurse-submodules` option,3347 except `clone`.3348 Defaults to false.33493350submodule.fetchJobs::3351 Specifies how many submodules are fetched/cloned at the same time.3352 A positive integer allows up to that number of submodules fetched3353 in parallel. A value of 0 will give some reasonable default.3354 If unset, it defaults to 1.33553356submodule.alternateLocation::3357 Specifies how the submodules obtain alternates when submodules are3358 cloned. Possible values are `no`, `superproject`.3359 By default `no` is assumed, which doesn't add references. When the3360 value is set to `superproject` the submodule to be cloned computes3361 its alternates location relative to the superprojects alternate.33623363submodule.alternateErrorStrategy::3364 Specifies how to treat errors with the alternates for a submodule3365 as computed via `submodule.alternateLocation`. Possible values are3366 `ignore`, `info`, `die`. Default is `die`.33673368tag.forceSignAnnotated::3369 A boolean to specify whether annotated tags created should be GPG signed.3370 If `--annotate` is specified on the command line, it takes3371 precedence over this option.33723373tag.sort::3374 This variable controls the sort ordering of tags when displayed by3375 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3376 value of this variable will be used as the default.33773378tar.umask::3379 This variable can be used to restrict the permission bits of3380 tar archive entries. The default is 0002, which turns off the3381 world write bit. The special value "user" indicates that the3382 archiving user's umask will be used instead. See umask(2) and3383 linkgit:git-archive[1].33843385transfer.fsckObjects::3386 When `fetch.fsckObjects` or `receive.fsckObjects` are3387 not set, the value of this variable is used instead.3388 Defaults to false.33893390transfer.hideRefs::3391 String(s) `receive-pack` and `upload-pack` use to decide which3392 refs to omit from their initial advertisements. Use more than3393 one definition to specify multiple prefix strings. A ref that is3394 under the hierarchies listed in the value of this variable is3395 excluded, and is hidden when responding to `git push` or `git3396 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3397 program-specific versions of this config.3398+3399You may also include a `!` in front of the ref name to negate the entry,3400explicitly exposing it, even if an earlier entry marked it as hidden.3401If you have multiple hideRefs values, later entries override earlier ones3402(and entries in more-specific config files override less-specific ones).3403+3404If a namespace is in use, the namespace prefix is stripped from each3405reference before it is matched against `transfer.hiderefs` patterns.3406For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3407the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3408is omitted from the advertisements but `refs/heads/master` and3409`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3410"have" lines. In order to match refs before stripping, add a `^` in front of3411the ref name. If you combine `!` and `^`, `!` must be specified first.3412+3413Even if you hide refs, a client may still be able to steal the target3414objects via the techniques described in the "SECURITY" section of the3415linkgit:gitnamespaces[7] man page; it's best to keep private data in a3416separate repository.34173418transfer.unpackLimit::3419 When `fetch.unpackLimit` or `receive.unpackLimit` are3420 not set, the value of this variable is used instead.3421 The default value is 100.34223423uploadarchive.allowUnreachable::3424 If true, allow clients to use `git archive --remote` to request3425 any tree, whether reachable from the ref tips or not. See the3426 discussion in the "SECURITY" section of3427 linkgit:git-upload-archive[1] for more details. Defaults to3428 `false`.34293430uploadpack.hideRefs::3431 This variable is the same as `transfer.hideRefs`, but applies3432 only to `upload-pack` (and so affects only fetches, not pushes).3433 An attempt to fetch a hidden ref by `git fetch` will fail. See3434 also `uploadpack.allowTipSHA1InWant`.34353436uploadpack.allowTipSHA1InWant::3437 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3438 to accept a fetch request that asks for an object at the tip3439 of a hidden ref (by default, such a request is rejected).3440 See also `uploadpack.hideRefs`. Even if this is false, a client3441 may be able to steal objects via the techniques described in the3442 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3443 best to keep private data in a separate repository.34443445uploadpack.allowReachableSHA1InWant::3446 Allow `upload-pack` to accept a fetch request that asks for an3447 object that is reachable from any ref tip. However, note that3448 calculating object reachability is computationally expensive.3449 Defaults to `false`. Even if this is false, a client may be able3450 to steal objects via the techniques described in the "SECURITY"3451 section of the linkgit:gitnamespaces[7] man page; it's best to3452 keep private data in a separate repository.34533454uploadpack.allowAnySHA1InWant::3455 Allow `upload-pack` to accept a fetch request that asks for any3456 object at all.3457 Defaults to `false`.34583459uploadpack.keepAlive::3460 When `upload-pack` has started `pack-objects`, there may be a3461 quiet period while `pack-objects` prepares the pack. Normally3462 it would output progress information, but if `--quiet` was used3463 for the fetch, `pack-objects` will output nothing at all until3464 the pack data begins. Some clients and networks may consider3465 the server to be hung and give up. Setting this option instructs3466 `upload-pack` to send an empty keepalive packet every3467 `uploadpack.keepAlive` seconds. Setting this option to 03468 disables keepalive packets entirely. The default is 5 seconds.34693470uploadpack.packObjectsHook::3471 If this option is set, when `upload-pack` would run3472 `git pack-objects` to create a packfile for a client, it will3473 run this shell command instead. The `pack-objects` command and3474 arguments it _would_ have run (including the `git pack-objects`3475 at the beginning) are appended to the shell command. The stdin3476 and stdout of the hook are treated as if `pack-objects` itself3477 was run. I.e., `upload-pack` will feed input intended for3478 `pack-objects` to the hook, and expects a completed packfile on3479 stdout.34803481uploadpack.allowFilter::3482 If this option is set, `upload-pack` will support partial3483 clone and partial fetch object filtering.3484+3485Note that this configuration variable is ignored if it is seen in the3486repository-level config (this is a safety measure against fetching from3487untrusted repositories).34883489url.<base>.insteadOf::3490 Any URL that starts with this value will be rewritten to3491 start, instead, with <base>. In cases where some site serves a3492 large number of repositories, and serves them with multiple3493 access methods, and some users need to use different access3494 methods, this feature allows people to specify any of the3495 equivalent URLs and have Git automatically rewrite the URL to3496 the best alternative for the particular user, even for a3497 never-before-seen repository on the site. When more than one3498 insteadOf strings match a given URL, the longest match is used.3499+3500Note that any protocol restrictions will be applied to the rewritten3501URL. If the rewrite changes the URL to use a custom protocol or remote3502helper, you may need to adjust the `protocol.*.allow` config to permit3503the request. In particular, protocols you expect to use for submodules3504must be set to `always` rather than the default of `user`. See the3505description of `protocol.allow` above.35063507url.<base>.pushInsteadOf::3508 Any URL that starts with this value will not be pushed to;3509 instead, it will be rewritten to start with <base>, and the3510 resulting URL will be pushed to. In cases where some site serves3511 a large number of repositories, and serves them with multiple3512 access methods, some of which do not allow push, this feature3513 allows people to specify a pull-only URL and have Git3514 automatically use an appropriate URL to push, even for a3515 never-before-seen repository on the site. When more than one3516 pushInsteadOf strings match a given URL, the longest match is3517 used. If a remote has an explicit pushurl, Git will ignore this3518 setting for that remote.35193520user.email::3521 Your email address to be recorded in any newly created commits.3522 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3523 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35243525user.name::3526 Your full name to be recorded in any newly created commits.3527 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3528 environment variables. See linkgit:git-commit-tree[1].35293530user.useConfigOnly::3531 Instruct Git to avoid trying to guess defaults for `user.email`3532 and `user.name`, and instead retrieve the values only from the3533 configuration. For example, if you have multiple email addresses3534 and would like to use a different one for each repository, then3535 with this configuration option set to `true` in the global config3536 along with a name, Git will prompt you to set up an email before3537 making new commits in a newly cloned repository.3538 Defaults to `false`.35393540user.signingKey::3541 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3542 key you want it to automatically when creating a signed tag or3543 commit, you can override the default selection with this variable.3544 This option is passed unchanged to gpg's --local-user parameter,3545 so you may specify a key using any method that gpg supports.35463547versionsort.prereleaseSuffix (deprecated)::3548 Deprecated alias for `versionsort.suffix`. Ignored if3549 `versionsort.suffix` is set.35503551versionsort.suffix::3552 Even when version sort is used in linkgit:git-tag[1], tagnames3553 with the same base version but different suffixes are still sorted3554 lexicographically, resulting e.g. in prerelease tags appearing3555 after the main release (e.g. "1.0-rc1" after "1.0"). This3556 variable can be specified to determine the sorting order of tags3557 with different suffixes.3558+3559By specifying a single suffix in this variable, any tagname containing3560that suffix will appear before the corresponding main release. E.g. if3561the variable is set to "-rc", then all "1.0-rcX" tags will appear before3562"1.0". If specified multiple times, once per suffix, then the order of3563suffixes in the configuration will determine the sorting order of tagnames3564with those suffixes. E.g. if "-pre" appears before "-rc" in the3565configuration, then all "1.0-preX" tags will be listed before any3566"1.0-rcX" tags. The placement of the main release tag relative to tags3567with various suffixes can be determined by specifying the empty suffix3568among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3569"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3570are listed first, followed by "v4.8", then "v4.8-ckX" and finally3571"v4.8-bfsX".3572+3573If more than one suffixes match the same tagname, then that tagname will3574be sorted according to the suffix which starts at the earliest position in3575the tagname. If more than one different matching suffixes start at3576that earliest position, then that tagname will be sorted according to the3577longest of those suffixes.3578The sorting order between different suffixes is undefined if they are3579in multiple config files.35803581web.browser::3582 Specify a web browser that may be used by some commands.3583 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3584 may use it.35853586worktree.guessRemote::3587 With `add`, if no branch argument, and neither of `-b` nor3588 `-B` nor `--detach` are given, the command defaults to3589 creating a new branch from HEAD. If `worktree.guessRemote` is3590 set to true, `worktree add` tries to find a remote-tracking3591 branch whose name uniquely matches the new branch name. If3592 such a branch exists, it is checked out and set as "upstream"3593 for the new branch. If no such match can be found, it falls3594 back to creating a new branch from the current HEAD.