1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 amWorkDir:: 348 Advice that shows the location of the patch file when 349 linkgit:git-am[1] fails to apply it. 350 rmHints:: 351 In case of failure in the output of linkgit:git-rm[1], 352 show directions on how to proceed from the current state. 353 addEmbeddedRepo:: 354 Advice on what to do when you've accidentally added one 355 git repo inside of another. 356 ignoredHook:: 357 Advice shown if a hook is ignored because the hook is not 358 set as executable. 359 waitingForEditor:: 360 Print a message to the terminal whenever Git is waiting for 361 editor input from the user. 362-- 363 364core.fileMode:: 365 Tells Git if the executable bit of files in the working tree 366 is to be honored. 367+ 368Some filesystems lose the executable bit when a file that is 369marked as executable is checked out, or checks out a 370non-executable file with executable bit on. 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 372to see if it handles the executable bit correctly 373and this variable is automatically set as necessary. 374+ 375A repository, however, may be on a filesystem that handles 376the filemode correctly, and this variable is set to 'true' 377when created, but later may be made accessible from another 378environment that loses the filemode (e.g. exporting ext4 via 379CIFS mount, visiting a Cygwin created repository with 380Git for Windows or Eclipse). 381In such a case it may be necessary to set this variable to 'false'. 382See linkgit:git-update-index[1]. 383+ 384The default is true (when core.filemode is not specified in the config file). 385 386core.hideDotFiles:: 387 (Windows-only) If true, mark newly-created directories and files whose 388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 389 directory is hidden, but no other files starting with a dot. The 390 default mode is 'dotGitOnly'. 391 392core.ignoreCase:: 393 Internal variable which enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 396 finds "makefile" when Git expects "Makefile", Git will assume 397 it is really the same file, and continue to remember it as 398 "Makefile". 399+ 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 401will probe and set core.ignoreCase true if appropriate when the repository 402is created. 403+ 404Git relies on the proper configuration of this variable for your operating 405and file system. Modifying this value may result in unexpected behavior. 406 407core.precomposeUnicode:: 408 This option is only used by Mac OS implementation of Git. 409 When core.precomposeUnicode=true, Git reverts the unicode decomposition 410 of filenames done by Mac OS. This is useful when sharing a repository 411 between Mac OS and Linux or Windows. 412 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 413 When false, file names are handled fully transparent by Git, 414 which is backward compatible with older versions of Git. 415 416core.protectHFS:: 417 If set to true, do not allow checkout of paths that would 418 be considered equivalent to `.git` on an HFS+ filesystem. 419 Defaults to `true` on Mac OS, and `false` elsewhere. 420 421core.protectNTFS:: 422 If set to true, do not allow checkout of paths that would 423 cause problems with the NTFS filesystem, e.g. conflict with 424 8.3 "short" names. 425 Defaults to `true` on Windows, and `false` elsewhere. 426 427core.fsmonitor:: 428 If set, the value of this variable is used as a command which 429 will identify all files that may have changed since the 430 requested date/time. This information is used to speed up git by 431 avoiding unnecessary processing of files that have not changed. 432 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 433 434core.trustctime:: 435 If false, the ctime differences between the index and the 436 working tree are ignored; useful when the inode change time 437 is regularly modified by something outside Git (file system 438 crawlers and some backup systems). 439 See linkgit:git-update-index[1]. True by default. 440 441core.splitIndex:: 442 If true, the split-index feature of the index will be used. 443 See linkgit:git-update-index[1]. False by default. 444 445core.untrackedCache:: 446 Determines what to do about the untracked cache feature of the 447 index. It will be kept, if this variable is unset or set to 448 `keep`. It will automatically be added if set to `true`. And 449 it will automatically be removed, if set to `false`. Before 450 setting it to `true`, you should check that mtime is working 451 properly on your system. 452 See linkgit:git-update-index[1]. `keep` by default. 453 454core.checkStat:: 455 Determines which stat fields to match between the index 456 and work tree. The user can set this to 'default' or 457 'minimal'. Default (or explicitly 'default'), is to check 458 all fields, including the sub-second part of mtime and ctime. 459 460core.quotePath:: 461 Commands that output paths (e.g. 'ls-files', 'diff'), will 462 quote "unusual" characters in the pathname by enclosing the 463 pathname in double-quotes and escaping those characters with 464 backslashes in the same way C escapes control characters (e.g. 465 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 466 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 467 UTF-8). If this variable is set to false, bytes higher than 468 0x80 are not considered "unusual" any more. Double-quotes, 469 backslash and control characters are always escaped regardless 470 of the setting of this variable. A simple space character is 471 not considered "unusual". Many commands can output pathnames 472 completely verbatim using the `-z` option. The default value 473 is true. 474 475core.eol:: 476 Sets the line ending type to use in the working directory for 477 files that have the `text` property set when core.autocrlf is false. 478 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 479 native line ending. The default value is `native`. See 480 linkgit:gitattributes[5] for more information on end-of-line 481 conversion. 482 483core.safecrlf:: 484 If true, makes Git check if converting `CRLF` is reversible when 485 end-of-line conversion is active. Git will verify if a command 486 modifies a file in the work tree either directly or indirectly. 487 For example, committing a file followed by checking out the 488 same file should yield the original file in the work tree. If 489 this is not the case for the current setting of 490 `core.autocrlf`, Git will reject the file. The variable can 491 be set to "warn", in which case Git will only warn about an 492 irreversible conversion but continue the operation. 493+ 494CRLF conversion bears a slight chance of corrupting data. 495When it is enabled, Git will convert CRLF to LF during commit and LF to 496CRLF during checkout. A file that contains a mixture of LF and 497CRLF before the commit cannot be recreated by Git. For text 498files this is the right thing to do: it corrects line endings 499such that we have only LF line endings in the repository. 500But for binary files that are accidentally classified as text the 501conversion can corrupt data. 502+ 503If you recognize such corruption early you can easily fix it by 504setting the conversion type explicitly in .gitattributes. Right 505after committing you still have the original file in your work 506tree and this file is not yet corrupted. You can explicitly tell 507Git that this file is binary and Git will handle the file 508appropriately. 509+ 510Unfortunately, the desired effect of cleaning up text files with 511mixed line endings and the undesired effect of corrupting binary 512files cannot be distinguished. In both cases CRLFs are removed 513in an irreversible way. For text files this is the right thing 514to do because CRLFs are line endings, while for binary files 515converting CRLFs corrupts data. 516+ 517Note, this safety check does not mean that a checkout will generate a 518file identical to the original file for a different setting of 519`core.eol` and `core.autocrlf`, but only for the current one. For 520example, a text file with `LF` would be accepted with `core.eol=lf` 521and could later be checked out with `core.eol=crlf`, in which case the 522resulting file would contain `CRLF`, although the original file 523contained `LF`. However, in both work trees the line endings would be 524consistent, that is either all `LF` or all `CRLF`, but never mixed. A 525file with mixed line endings would be reported by the `core.safecrlf` 526mechanism. 527 528core.autocrlf:: 529 Setting this variable to "true" is the same as setting 530 the `text` attribute to "auto" on all files and core.eol to "crlf". 531 Set to true if you want to have `CRLF` line endings in your 532 working directory and the repository has LF line endings. 533 This variable can be set to 'input', 534 in which case no output conversion is performed. 535 536core.checkRoundtripEncoding:: 537 A comma and/or whitespace separated list of encodings that Git 538 performs UTF-8 round trip checks on if they are used in an 539 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 540 The default value is `SHIFT-JIS`. 541 542core.symlinks:: 543 If false, symbolic links are checked out as small plain files that 544 contain the link text. linkgit:git-update-index[1] and 545 linkgit:git-add[1] will not change the recorded type to regular 546 file. Useful on filesystems like FAT that do not support 547 symbolic links. 548+ 549The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 550will probe and set core.symlinks false if appropriate when the repository 551is created. 552 553core.gitProxy:: 554 A "proxy command" to execute (as 'command host port') instead 555 of establishing direct connection to the remote server when 556 using the Git protocol for fetching. If the variable value is 557 in the "COMMAND for DOMAIN" format, the command is applied only 558 on hostnames ending with the specified domain string. This variable 559 may be set multiple times and is matched in the given order; 560 the first match wins. 561+ 562Can be overridden by the `GIT_PROXY_COMMAND` environment variable 563(which always applies universally, without the special "for" 564handling). 565+ 566The special string `none` can be used as the proxy command to 567specify that no proxy be used for a given domain pattern. 568This is useful for excluding servers inside a firewall from 569proxy use, while defaulting to a common proxy for external domains. 570 571core.sshCommand:: 572 If this variable is set, `git fetch` and `git push` will 573 use the specified command instead of `ssh` when they need to 574 connect to a remote system. The command is in the same form as 575 the `GIT_SSH_COMMAND` environment variable and is overridden 576 when the environment variable is set. 577 578core.ignoreStat:: 579 If true, Git will avoid using lstat() calls to detect if files have 580 changed by setting the "assume-unchanged" bit for those tracked files 581 which it has updated identically in both the index and working tree. 582+ 583When files are modified outside of Git, the user will need to stage 584the modified files explicitly (e.g. see 'Examples' section in 585linkgit:git-update-index[1]). 586Git will not normally detect changes to those files. 587+ 588This is useful on systems where lstat() calls are very slow, such as 589CIFS/Microsoft Windows. 590+ 591False by default. 592 593core.preferSymlinkRefs:: 594 Instead of the default "symref" format for HEAD 595 and other symbolic reference files, use symbolic links. 596 This is sometimes needed to work with old scripts that 597 expect HEAD to be a symbolic link. 598 599core.bare:: 600 If true this repository is assumed to be 'bare' and has no 601 working directory associated with it. If this is the case a 602 number of commands that require a working directory will be 603 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 604+ 605This setting is automatically guessed by linkgit:git-clone[1] or 606linkgit:git-init[1] when the repository was created. By default a 607repository that ends in "/.git" is assumed to be not bare (bare = 608false), while all other repositories are assumed to be bare (bare 609= true). 610 611core.worktree:: 612 Set the path to the root of the working tree. 613 If `GIT_COMMON_DIR` environment variable is set, core.worktree 614 is ignored and not used for determining the root of working tree. 615 This can be overridden by the `GIT_WORK_TREE` environment 616 variable and the `--work-tree` command-line option. 617 The value can be an absolute path or relative to the path to 618 the .git directory, which is either specified by --git-dir 619 or GIT_DIR, or automatically discovered. 620 If --git-dir or GIT_DIR is specified but none of 621 --work-tree, GIT_WORK_TREE and core.worktree is specified, 622 the current working directory is regarded as the top level 623 of your working tree. 624+ 625Note that this variable is honored even when set in a configuration 626file in a ".git" subdirectory of a directory and its value differs 627from the latter directory (e.g. "/path/to/.git/config" has 628core.worktree set to "/different/path"), which is most likely a 629misconfiguration. Running Git commands in the "/path/to" directory will 630still use "/different/path" as the root of the work tree and can cause 631confusion unless you know what you are doing (e.g. you are creating a 632read-only snapshot of the same index to a location different from the 633repository's usual working tree). 634 635core.logAllRefUpdates:: 636 Enable the reflog. Updates to a ref <ref> is logged to the file 637 "`$GIT_DIR/logs/<ref>`", by appending the new and old 638 SHA-1, the date/time and the reason of the update, but 639 only when the file exists. If this configuration 640 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 641 file is automatically created for branch heads (i.e. under 642 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 643 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 644 If it is set to `always`, then a missing reflog is automatically 645 created for any ref under `refs/`. 646+ 647This information can be used to determine what commit 648was the tip of a branch "2 days ago". 649+ 650This value is true by default in a repository that has 651a working directory associated with it, and false by 652default in a bare repository. 653 654core.repositoryFormatVersion:: 655 Internal variable identifying the repository format and layout 656 version. 657 658core.sharedRepository:: 659 When 'group' (or 'true'), the repository is made shareable between 660 several users in a group (making sure all the files and objects are 661 group-writable). When 'all' (or 'world' or 'everybody'), the 662 repository will be readable by all users, additionally to being 663 group-shareable. When 'umask' (or 'false'), Git will use permissions 664 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 665 files in the repository will have this mode value. '0xxx' will override 666 user's umask value (whereas the other options will only override 667 requested parts of the user's umask value). Examples: '0660' will make 668 the repo read/write-able for the owner and group, but inaccessible to 669 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 670 repository that is group-readable but not group-writable. 671 See linkgit:git-init[1]. False by default. 672 673core.warnAmbiguousRefs:: 674 If true, Git will warn you if the ref name you passed it is ambiguous 675 and might match multiple refs in the repository. True by default. 676 677core.compression:: 678 An integer -1..9, indicating a default compression level. 679 -1 is the zlib default. 0 means no compression, 680 and 1..9 are various speed/size tradeoffs, 9 being slowest. 681 If set, this provides a default to other compression variables, 682 such as `core.looseCompression` and `pack.compression`. 683 684core.looseCompression:: 685 An integer -1..9, indicating the compression level for objects that 686 are not in a pack file. -1 is the zlib default. 0 means no 687 compression, and 1..9 are various speed/size tradeoffs, 9 being 688 slowest. If not set, defaults to core.compression. If that is 689 not set, defaults to 1 (best speed). 690 691core.packedGitWindowSize:: 692 Number of bytes of a pack file to map into memory in a 693 single mapping operation. Larger window sizes may allow 694 your system to process a smaller number of large pack files 695 more quickly. Smaller window sizes will negatively affect 696 performance due to increased calls to the operating system's 697 memory manager, but may improve performance when accessing 698 a large number of large pack files. 699+ 700Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 701MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 702be reasonable for all users/operating systems. You probably do 703not need to adjust this value. 704+ 705Common unit suffixes of 'k', 'm', or 'g' are supported. 706 707core.packedGitLimit:: 708 Maximum number of bytes to map simultaneously into memory 709 from pack files. If Git needs to access more than this many 710 bytes at once to complete an operation it will unmap existing 711 regions to reclaim virtual address space within the process. 712+ 713Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 714unlimited) on 64 bit platforms. 715This should be reasonable for all users/operating systems, except on 716the largest projects. You probably do not need to adjust this value. 717+ 718Common unit suffixes of 'k', 'm', or 'g' are supported. 719 720core.deltaBaseCacheLimit:: 721 Maximum number of bytes to reserve for caching base objects 722 that may be referenced by multiple deltified objects. By storing the 723 entire decompressed base objects in a cache Git is able 724 to avoid unpacking and decompressing frequently used base 725 objects multiple times. 726+ 727Default is 96 MiB on all platforms. This should be reasonable 728for all users/operating systems, except on the largest projects. 729You probably do not need to adjust this value. 730+ 731Common unit suffixes of 'k', 'm', or 'g' are supported. 732 733core.bigFileThreshold:: 734 Files larger than this size are stored deflated, without 735 attempting delta compression. Storing large files without 736 delta compression avoids excessive memory usage, at the 737 slight expense of increased disk usage. Additionally files 738 larger than this size are always treated as binary. 739+ 740Default is 512 MiB on all platforms. This should be reasonable 741for most projects as source code and other text files can still 742be delta compressed, but larger binary media files won't be. 743+ 744Common unit suffixes of 'k', 'm', or 'g' are supported. 745 746core.excludesFile:: 747 Specifies the pathname to the file that contains patterns to 748 describe paths that are not meant to be tracked, in addition 749 to '.gitignore' (per-directory) and '.git/info/exclude'. 750 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 751 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 752 is used instead. See linkgit:gitignore[5]. 753 754core.askPass:: 755 Some commands (e.g. svn and http interfaces) that interactively 756 ask for a password can be told to use an external program given 757 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 758 environment variable. If not set, fall back to the value of the 759 `SSH_ASKPASS` environment variable or, failing that, a simple password 760 prompt. The external program shall be given a suitable prompt as 761 command-line argument and write the password on its STDOUT. 762 763core.attributesFile:: 764 In addition to '.gitattributes' (per-directory) and 765 '.git/info/attributes', Git looks into this file for attributes 766 (see linkgit:gitattributes[5]). Path expansions are made the same 767 way as for `core.excludesFile`. Its default value is 768 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 769 set or empty, `$HOME/.config/git/attributes` is used instead. 770 771core.hooksPath:: 772 By default Git will look for your hooks in the 773 '$GIT_DIR/hooks' directory. Set this to different path, 774 e.g. '/etc/git/hooks', and Git will try to find your hooks in 775 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 776 in '$GIT_DIR/hooks/pre-receive'. 777+ 778The path can be either absolute or relative. A relative path is 779taken as relative to the directory where the hooks are run (see 780the "DESCRIPTION" section of linkgit:githooks[5]). 781+ 782This configuration variable is useful in cases where you'd like to 783centrally configure your Git hooks instead of configuring them on a 784per-repository basis, or as a more flexible and centralized 785alternative to having an `init.templateDir` where you've changed 786default hooks. 787 788core.editor:: 789 Commands such as `commit` and `tag` that let you edit 790 messages by launching an editor use the value of this 791 variable when it is set, and the environment variable 792 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 793 794core.commentChar:: 795 Commands such as `commit` and `tag` that let you edit 796 messages consider a line that begins with this character 797 commented, and removes them after the editor returns 798 (default '#'). 799+ 800If set to "auto", `git-commit` would select a character that is not 801the beginning character of any line in existing commit messages. 802 803core.filesRefLockTimeout:: 804 The length of time, in milliseconds, to retry when trying to 805 lock an individual reference. Value 0 means not to retry at 806 all; -1 means to try indefinitely. Default is 100 (i.e., 807 retry for 100ms). 808 809core.packedRefsTimeout:: 810 The length of time, in milliseconds, to retry when trying to 811 lock the `packed-refs` file. Value 0 means not to retry at 812 all; -1 means to try indefinitely. Default is 1000 (i.e., 813 retry for 1 second). 814 815sequence.editor:: 816 Text editor used by `git rebase -i` for editing the rebase instruction file. 817 The value is meant to be interpreted by the shell when it is used. 818 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 819 When not configured the default commit message editor is used instead. 820 821core.pager:: 822 Text viewer for use by Git commands (e.g., 'less'). The value 823 is meant to be interpreted by the shell. The order of preference 824 is the `$GIT_PAGER` environment variable, then `core.pager` 825 configuration, then `$PAGER`, and then the default chosen at 826 compile time (usually 'less'). 827+ 828When the `LESS` environment variable is unset, Git sets it to `FRX` 829(if `LESS` environment variable is set, Git does not change it at 830all). If you want to selectively override Git's default setting 831for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 832be passed to the shell by Git, which will translate the final 833command to `LESS=FRX less -S`. The environment does not set the 834`S` option but the command line does, instructing less to truncate 835long lines. Similarly, setting `core.pager` to `less -+F` will 836deactivate the `F` option specified by the environment from the 837command-line, deactivating the "quit if one screen" behavior of 838`less`. One can specifically activate some flags for particular 839commands: for example, setting `pager.blame` to `less -S` enables 840line truncation only for `git blame`. 841+ 842Likewise, when the `LV` environment variable is unset, Git sets it 843to `-c`. You can override this setting by exporting `LV` with 844another value or setting `core.pager` to `lv +c`. 845 846core.whitespace:: 847 A comma separated list of common whitespace problems to 848 notice. 'git diff' will use `color.diff.whitespace` to 849 highlight them, and 'git apply --whitespace=error' will 850 consider them as errors. You can prefix `-` to disable 851 any of them (e.g. `-trailing-space`): 852+ 853* `blank-at-eol` treats trailing whitespaces at the end of the line 854 as an error (enabled by default). 855* `space-before-tab` treats a space character that appears immediately 856 before a tab character in the initial indent part of the line as an 857 error (enabled by default). 858* `indent-with-non-tab` treats a line that is indented with space 859 characters instead of the equivalent tabs as an error (not enabled by 860 default). 861* `tab-in-indent` treats a tab character in the initial indent part of 862 the line as an error (not enabled by default). 863* `blank-at-eof` treats blank lines added at the end of file as an error 864 (enabled by default). 865* `trailing-space` is a short-hand to cover both `blank-at-eol` and 866 `blank-at-eof`. 867* `cr-at-eol` treats a carriage-return at the end of line as 868 part of the line terminator, i.e. with it, `trailing-space` 869 does not trigger if the character before such a carriage-return 870 is not a whitespace (not enabled by default). 871* `tabwidth=<n>` tells how many character positions a tab occupies; this 872 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 873 errors. The default tab width is 8. Allowed values are 1 to 63. 874 875core.fsyncObjectFiles:: 876 This boolean will enable 'fsync()' when writing object files. 877+ 878This is a total waste of time and effort on a filesystem that orders 879data writes properly, but can be useful for filesystems that do not use 880journalling (traditional UNIX filesystems) or that only journal metadata 881and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 882 883core.preloadIndex:: 884 Enable parallel index preload for operations like 'git diff' 885+ 886This can speed up operations like 'git diff' and 'git status' especially 887on filesystems like NFS that have weak caching semantics and thus 888relatively high IO latencies. When enabled, Git will do the 889index comparison to the filesystem data in parallel, allowing 890overlapping IO's. Defaults to true. 891 892core.createObject:: 893 You can set this to 'link', in which case a hardlink followed by 894 a delete of the source are used to make sure that object creation 895 will not overwrite existing objects. 896+ 897On some file system/operating system combinations, this is unreliable. 898Set this config setting to 'rename' there; However, This will remove the 899check that makes sure that existing object files will not get overwritten. 900 901core.notesRef:: 902 When showing commit messages, also show notes which are stored in 903 the given ref. The ref must be fully qualified. If the given 904 ref does not exist, it is not an error but means that no 905 notes should be printed. 906+ 907This setting defaults to "refs/notes/commits", and it can be overridden by 908the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 909 910core.commitGraph:: 911 Enable git commit graph feature. Allows reading from the 912 commit-graph file. 913 914core.useReplaceRefs:: 915 If set to `false`, behave as if the `--no-replace-objects` 916 option was given on the command line. See linkgit:git[1] and 917 linkgit:git-replace[1] for more information. 918 919core.sparseCheckout:: 920 Enable "sparse checkout" feature. See section "Sparse checkout" in 921 linkgit:git-read-tree[1] for more information. 922 923core.abbrev:: 924 Set the length object names are abbreviated to. If 925 unspecified or set to "auto", an appropriate value is 926 computed based on the approximate number of packed objects 927 in your repository, which hopefully is enough for 928 abbreviated object names to stay unique for some time. 929 The minimum length is 4. 930 931add.ignoreErrors:: 932add.ignore-errors (deprecated):: 933 Tells 'git add' to continue adding files when some files cannot be 934 added due to indexing errors. Equivalent to the `--ignore-errors` 935 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 936 as it does not follow the usual naming convention for configuration 937 variables. 938 939alias.*:: 940 Command aliases for the linkgit:git[1] command wrapper - e.g. 941 after defining "alias.last = cat-file commit HEAD", the invocation 942 "git last" is equivalent to "git cat-file commit HEAD". To avoid 943 confusion and troubles with script usage, aliases that 944 hide existing Git commands are ignored. Arguments are split by 945 spaces, the usual shell quoting and escaping is supported. 946 A quote pair or a backslash can be used to quote them. 947+ 948If the alias expansion is prefixed with an exclamation point, 949it will be treated as a shell command. For example, defining 950"alias.new = !gitk --all --not ORIG_HEAD", the invocation 951"git new" is equivalent to running the shell command 952"gitk --all --not ORIG_HEAD". Note that shell commands will be 953executed from the top-level directory of a repository, which may 954not necessarily be the current directory. 955`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 956from the original current directory. See linkgit:git-rev-parse[1]. 957 958am.keepcr:: 959 If true, git-am will call git-mailsplit for patches in mbox format 960 with parameter `--keep-cr`. In this case git-mailsplit will 961 not remove `\r` from lines ending with `\r\n`. Can be overridden 962 by giving `--no-keep-cr` from the command line. 963 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 964 965am.threeWay:: 966 By default, `git am` will fail if the patch does not apply cleanly. When 967 set to true, this setting tells `git am` to fall back on 3-way merge if 968 the patch records the identity of blobs it is supposed to apply to and 969 we have those blobs available locally (equivalent to giving the `--3way` 970 option from the command line). Defaults to `false`. 971 See linkgit:git-am[1]. 972 973apply.ignoreWhitespace:: 974 When set to 'change', tells 'git apply' to ignore changes in 975 whitespace, in the same way as the `--ignore-space-change` 976 option. 977 When set to one of: no, none, never, false tells 'git apply' to 978 respect all whitespace differences. 979 See linkgit:git-apply[1]. 980 981apply.whitespace:: 982 Tells 'git apply' how to handle whitespaces, in the same way 983 as the `--whitespace` option. See linkgit:git-apply[1]. 984 985blame.showRoot:: 986 Do not treat root commits as boundaries in linkgit:git-blame[1]. 987 This option defaults to false. 988 989blame.blankBoundary:: 990 Show blank commit object name for boundary commits in 991 linkgit:git-blame[1]. This option defaults to false. 992 993blame.showEmail:: 994 Show the author email instead of author name in linkgit:git-blame[1]. 995 This option defaults to false. 996 997blame.date:: 998 Specifies the format used to output dates in linkgit:git-blame[1]. 999 If unset the iso format is used. For supported values,1000 see the discussion of the `--date` option at linkgit:git-log[1].10011002branch.autoSetupMerge::1003 Tells 'git branch' and 'git checkout' to set up new branches1004 so that linkgit:git-pull[1] will appropriately merge from the1005 starting point branch. Note that even if this option is not set,1006 this behavior can be chosen per-branch using the `--track`1007 and `--no-track` options. The valid settings are: `false` -- no1008 automatic setup is done; `true` -- automatic setup is done when the1009 starting point is a remote-tracking branch; `always` --1010 automatic setup is done when the starting point is either a1011 local branch or remote-tracking1012 branch. This option defaults to true.10131014branch.autoSetupRebase::1015 When a new branch is created with 'git branch' or 'git checkout'1016 that tracks another branch, this variable tells Git to set1017 up pull to rebase instead of merge (see "branch.<name>.rebase").1018 When `never`, rebase is never automatically set to true.1019 When `local`, rebase is set to true for tracked branches of1020 other local branches.1021 When `remote`, rebase is set to true for tracked branches of1022 remote-tracking branches.1023 When `always`, rebase will be set to true for all tracking1024 branches.1025 See "branch.autoSetupMerge" for details on how to set up a1026 branch to track another branch.1027 This option defaults to never.10281029branch.<name>.remote::1030 When on branch <name>, it tells 'git fetch' and 'git push'1031 which remote to fetch from/push to. The remote to push to1032 may be overridden with `remote.pushDefault` (for all branches).1033 The remote to push to, for the current branch, may be further1034 overridden by `branch.<name>.pushRemote`. If no remote is1035 configured, or if you are not on any branch, it defaults to1036 `origin` for fetching and `remote.pushDefault` for pushing.1037 Additionally, `.` (a period) is the current local repository1038 (a dot-repository), see `branch.<name>.merge`'s final note below.10391040branch.<name>.pushRemote::1041 When on branch <name>, it overrides `branch.<name>.remote` for1042 pushing. It also overrides `remote.pushDefault` for pushing1043 from branch <name>. When you pull from one place (e.g. your1044 upstream) and push to another place (e.g. your own publishing1045 repository), you would want to set `remote.pushDefault` to1046 specify the remote to push to for all branches, and use this1047 option to override it for a specific branch.10481049branch.<name>.merge::1050 Defines, together with branch.<name>.remote, the upstream branch1051 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1052 branch to merge and can also affect 'git push' (see push.default).1053 When in branch <name>, it tells 'git fetch' the default1054 refspec to be marked for merging in FETCH_HEAD. The value is1055 handled like the remote part of a refspec, and must match a1056 ref which is fetched from the remote given by1057 "branch.<name>.remote".1058 The merge information is used by 'git pull' (which at first calls1059 'git fetch') to lookup the default branch for merging. Without1060 this option, 'git pull' defaults to merge the first refspec fetched.1061 Specify multiple values to get an octopus merge.1062 If you wish to setup 'git pull' so that it merges into <name> from1063 another branch in the local repository, you can point1064 branch.<name>.merge to the desired branch, and use the relative path1065 setting `.` (a period) for branch.<name>.remote.10661067branch.<name>.mergeOptions::1068 Sets default options for merging into branch <name>. The syntax and1069 supported options are the same as those of linkgit:git-merge[1], but1070 option values containing whitespace characters are currently not1071 supported.10721073branch.<name>.rebase::1074 When true, rebase the branch <name> on top of the fetched branch,1075 instead of merging the default branch from the default remote when1076 "git pull" is run. See "pull.rebase" for doing this in a non1077 branch-specific manner.1078+1079When `merges`, pass the `--rebase-merges` option to 'git rebase'1080so that the local merge commits are included in the rebase (see1081linkgit:git-rebase[1] for details).1082+1083When preserve, also pass `--preserve-merges` along to 'git rebase'1084so that locally committed merge commits will not be flattened1085by running 'git pull'.1086+1087When the value is `interactive`, the rebase is run in interactive mode.1088+1089*NOTE*: this is a possibly dangerous operation; do *not* use1090it unless you understand the implications (see linkgit:git-rebase[1]1091for details).10921093branch.<name>.description::1094 Branch description, can be edited with1095 `git branch --edit-description`. Branch description is1096 automatically added in the format-patch cover letter or1097 request-pull summary.10981099browser.<tool>.cmd::1100 Specify the command to invoke the specified browser. The1101 specified command is evaluated in shell with the URLs passed1102 as arguments. (See linkgit:git-web{litdd}browse[1].)11031104browser.<tool>.path::1105 Override the path for the given tool that may be used to1106 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1107 working repository in gitweb (see linkgit:git-instaweb[1]).11081109clean.requireForce::1110 A boolean to make git-clean do nothing unless given -f,1111 -i or -n. Defaults to true.11121113color.advice::1114 A boolean to enable/disable color in hints (e.g. when a push1115 failed, see `advice.*` for a list). May be set to `always`,1116 `false` (or `never`) or `auto` (or `true`), in which case colors1117 are used only when the error output goes to a terminal. If1118 unset, then the value of `color.ui` is used (`auto` by default).11191120color.advice.hint::1121 Use customized color for hints.11221123color.branch::1124 A boolean to enable/disable color in the output of1125 linkgit:git-branch[1]. May be set to `always`,1126 `false` (or `never`) or `auto` (or `true`), in which case colors are used1127 only when the output is to a terminal. If unset, then the1128 value of `color.ui` is used (`auto` by default).11291130color.branch.<slot>::1131 Use customized color for branch coloration. `<slot>` is one of1132 `current` (the current branch), `local` (a local branch),1133 `remote` (a remote-tracking branch in refs/remotes/),1134 `upstream` (upstream tracking branch), `plain` (other1135 refs).11361137color.diff::1138 Whether to use ANSI escape sequences to add color to patches.1139 If this is set to `always`, linkgit:git-diff[1],1140 linkgit:git-log[1], and linkgit:git-show[1] will use color1141 for all patches. If it is set to `true` or `auto`, those1142 commands will only use color when output is to the terminal.1143 If unset, then the value of `color.ui` is used (`auto` by1144 default).1145+1146This does not affect linkgit:git-format-patch[1] or the1147'git-diff-{asterisk}' plumbing commands. Can be overridden on the1148command line with the `--color[=<when>]` option.11491150diff.colorMoved::1151 If set to either a valid `<mode>` or a true value, moved lines1152 in a diff are colored differently, for details of valid modes1153 see '--color-moved' in linkgit:git-diff[1]. If simply set to1154 true the default color mode will be used. When set to false,1155 moved lines are not colored.11561157color.diff.<slot>::1158 Use customized color for diff colorization. `<slot>` specifies1159 which part of the patch to use the specified color, and is one1160 of `context` (context text - `plain` is a historical synonym),1161 `meta` (metainformation), `frag`1162 (hunk header), 'func' (function in hunk header), `old` (removed lines),1163 `new` (added lines), `commit` (commit headers), `whitespace`1164 (highlighting whitespace errors), `oldMoved` (deleted lines),1165 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1166 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1167 and `newMovedAlternativeDimmed` (See the '<mode>'1168 setting of '--color-moved' in linkgit:git-diff[1] for details).11691170color.decorate.<slot>::1171 Use customized color for 'git log --decorate' output. `<slot>` is one1172 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1173 branches, remote-tracking branches, tags, stash and HEAD, respectively1174 and `grafted` for grafted commits.11751176color.grep::1177 When set to `always`, always highlight matches. When `false` (or1178 `never`), never. When set to `true` or `auto`, use color only1179 when the output is written to the terminal. If unset, then the1180 value of `color.ui` is used (`auto` by default).11811182color.grep.<slot>::1183 Use customized color for grep colorization. `<slot>` specifies which1184 part of the line to use the specified color, and is one of1185+1186--1187`context`;;1188 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1189`filename`;;1190 filename prefix (when not using `-h`)1191`function`;;1192 function name lines (when using `-p`)1193`lineNumber`;;1194 line number prefix (when using `-n`)1195`column`;;1196 column number prefix (when using `--column`)1197`match`;;1198 matching text (same as setting `matchContext` and `matchSelected`)1199`matchContext`;;1200 matching text in context lines1201`matchSelected`;;1202 matching text in selected lines1203`selected`;;1204 non-matching text in selected lines1205`separator`;;1206 separators between fields on a line (`:`, `-`, and `=`)1207 and between hunks (`--`)1208--12091210color.interactive::1211 When set to `always`, always use colors for interactive prompts1212 and displays (such as those used by "git-add --interactive" and1213 "git-clean --interactive"). When false (or `never`), never.1214 When set to `true` or `auto`, use colors only when the output is1215 to the terminal. If unset, then the value of `color.ui` is1216 used (`auto` by default).12171218color.interactive.<slot>::1219 Use customized color for 'git add --interactive' and 'git clean1220 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1221 or `error`, for four distinct types of normal output from1222 interactive commands.12231224color.pager::1225 A boolean to enable/disable colored output when the pager is in1226 use (default is true).12271228color.push::1229 A boolean to enable/disable color in push errors. May be set to1230 `always`, `false` (or `never`) or `auto` (or `true`), in which1231 case colors are used only when the error output goes to a terminal.1232 If unset, then the value of `color.ui` is used (`auto` by default).12331234color.push.error::1235 Use customized color for push errors.12361237color.showBranch::1238 A boolean to enable/disable color in the output of1239 linkgit:git-show-branch[1]. May be set to `always`,1240 `false` (or `never`) or `auto` (or `true`), in which case colors are used1241 only when the output is to a terminal. If unset, then the1242 value of `color.ui` is used (`auto` by default).12431244color.status::1245 A boolean to enable/disable color in the output of1246 linkgit:git-status[1]. May be set to `always`,1247 `false` (or `never`) or `auto` (or `true`), in which case colors are used1248 only when the output is to a terminal. If unset, then the1249 value of `color.ui` is used (`auto` by default).12501251color.status.<slot>::1252 Use customized color for status colorization. `<slot>` is1253 one of `header` (the header text of the status message),1254 `added` or `updated` (files which are added but not committed),1255 `changed` (files which are changed but not added in the index),1256 `untracked` (files which are not tracked by Git),1257 `branch` (the current branch),1258 `nobranch` (the color the 'no branch' warning is shown in, defaulting1259 to red),1260 `localBranch` or `remoteBranch` (the local and remote branch names,1261 respectively, when branch and tracking information is displayed in the1262 status short-format), or1263 `unmerged` (files which have unmerged changes).12641265color.blame.repeatedLines::1266 Use the customized color for the part of git-blame output that1267 is repeated meta information per line (such as commit id,1268 author name, date and timezone). Defaults to cyan.12691270color.blame.highlightRecent::1271 This can be used to color the metadata of a blame line depending1272 on age of the line.1273+1274This setting should be set to a comma-separated list of color and date settings,1275starting and ending with a color, the dates should be set from oldest to newest.1276The metadata will be colored given the colors if the the line was introduced1277before the given timestamp, overwriting older timestamped colors.1278+1279Instead of an absolute timestamp relative timestamps work as well, e.g.12802.weeks.ago is valid to address anything older than 2 weeks.1281+1282It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1283everything older than one year blue, recent changes between one month and1284one year old are kept white, and lines introduced within the last month are1285colored red.12861287blame.coloring::1288 This determines the coloring scheme to be applied to blame1289 output. It can be 'repeatedLines', 'highlightRecent',1290 or 'none' which is the default.12911292color.transport::1293 A boolean to enable/disable color when pushes are rejected. May be1294 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1295 case colors are used only when the error output goes to a terminal.1296 If unset, then the value of `color.ui` is used (`auto` by default).12971298color.transport.rejected::1299 Use customized color when a push was rejected.13001301color.ui::1302 This variable determines the default value for variables such1303 as `color.diff` and `color.grep` that control the use of color1304 per command family. Its scope will expand as more commands learn1305 configuration to set a default for the `--color` option. Set it1306 to `false` or `never` if you prefer Git commands not to use1307 color unless enabled explicitly with some other configuration1308 or the `--color` option. Set it to `always` if you want all1309 output not intended for machine consumption to use color, to1310 `true` or `auto` (this is the default since Git 1.8.4) if you1311 want such output to use color when written to the terminal.13121313column.ui::1314 Specify whether supported commands should output in columns.1315 This variable consists of a list of tokens separated by spaces1316 or commas:1317+1318These options control when the feature should be enabled1319(defaults to 'never'):1320+1321--1322`always`;;1323 always show in columns1324`never`;;1325 never show in columns1326`auto`;;1327 show in columns if the output is to the terminal1328--1329+1330These options control layout (defaults to 'column'). Setting any1331of these implies 'always' if none of 'always', 'never', or 'auto' are1332specified.1333+1334--1335`column`;;1336 fill columns before rows1337`row`;;1338 fill rows before columns1339`plain`;;1340 show in one column1341--1342+1343Finally, these options can be combined with a layout option (defaults1344to 'nodense'):1345+1346--1347`dense`;;1348 make unequal size columns to utilize more space1349`nodense`;;1350 make equal size columns1351--13521353column.branch::1354 Specify whether to output branch listing in `git branch` in columns.1355 See `column.ui` for details.13561357column.clean::1358 Specify the layout when list items in `git clean -i`, which always1359 shows files and directories in columns. See `column.ui` for details.13601361column.status::1362 Specify whether to output untracked files in `git status` in columns.1363 See `column.ui` for details.13641365column.tag::1366 Specify whether to output tag listing in `git tag` in columns.1367 See `column.ui` for details.13681369commit.cleanup::1370 This setting overrides the default of the `--cleanup` option in1371 `git commit`. See linkgit:git-commit[1] for details. Changing the1372 default can be useful when you always want to keep lines that begin1373 with comment character `#` in your log message, in which case you1374 would do `git config commit.cleanup whitespace` (note that you will1375 have to remove the help lines that begin with `#` in the commit log1376 template yourself, if you do this).13771378commit.gpgSign::13791380 A boolean to specify whether all commits should be GPG signed.1381 Use of this option when doing operations such as rebase can1382 result in a large number of commits being signed. It may be1383 convenient to use an agent to avoid typing your GPG passphrase1384 several times.13851386commit.status::1387 A boolean to enable/disable inclusion of status information in the1388 commit message template when using an editor to prepare the commit1389 message. Defaults to true.13901391commit.template::1392 Specify the pathname of a file to use as the template for1393 new commit messages.13941395commit.verbose::1396 A boolean or int to specify the level of verbose with `git commit`.1397 See linkgit:git-commit[1].13981399credential.helper::1400 Specify an external helper to be called when a username or1401 password credential is needed; the helper may consult external1402 storage to avoid prompting the user for the credentials. Note1403 that multiple helpers may be defined. See linkgit:gitcredentials[7]1404 for details.14051406credential.useHttpPath::1407 When acquiring credentials, consider the "path" component of an http1408 or https URL to be important. Defaults to false. See1409 linkgit:gitcredentials[7] for more information.14101411credential.username::1412 If no username is set for a network authentication, use this username1413 by default. See credential.<context>.* below, and1414 linkgit:gitcredentials[7].14151416credential.<url>.*::1417 Any of the credential.* options above can be applied selectively to1418 some credentials. For example "credential.https://example.com.username"1419 would set the default username only for https connections to1420 example.com. See linkgit:gitcredentials[7] for details on how URLs are1421 matched.14221423credentialCache.ignoreSIGHUP::1424 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14251426completion.commands::1427 This is only used by git-completion.bash to add or remove1428 commands from the list of completed commands. Normally only1429 porcelain commands and a few select others are completed. You1430 can add more commands, separated by space, in this1431 variable. Prefixing the command with '-' will remove it from1432 the existing list.14331434include::diff-config.txt[]14351436difftool.<tool>.path::1437 Override the path for the given tool. This is useful in case1438 your tool is not in the PATH.14391440difftool.<tool>.cmd::1441 Specify the command to invoke the specified diff tool.1442 The specified command is evaluated in shell with the following1443 variables available: 'LOCAL' is set to the name of the temporary1444 file containing the contents of the diff pre-image and 'REMOTE'1445 is set to the name of the temporary file containing the contents1446 of the diff post-image.14471448difftool.prompt::1449 Prompt before each invocation of the diff tool.14501451fastimport.unpackLimit::1452 If the number of objects imported by linkgit:git-fast-import[1]1453 is below this limit, then the objects will be unpacked into1454 loose object files. However if the number of imported objects1455 equals or exceeds this limit then the pack will be stored as a1456 pack. Storing the pack from a fast-import can make the import1457 operation complete faster, especially on slow filesystems. If1458 not set, the value of `transfer.unpackLimit` is used instead.14591460fetch.recurseSubmodules::1461 This option can be either set to a boolean value or to 'on-demand'.1462 Setting it to a boolean changes the behavior of fetch and pull to1463 unconditionally recurse into submodules when set to true or to not1464 recurse at all when set to false. When set to 'on-demand' (the default1465 value), fetch and pull will only recurse into a populated submodule1466 when its superproject retrieves a commit that updates the submodule's1467 reference.14681469fetch.fsckObjects::1470 If it is set to true, git-fetch-pack will check all fetched1471 objects. It will abort in the case of a malformed object or a1472 broken link. The result of an abort are only dangling objects.1473 Defaults to false. If not set, the value of `transfer.fsckObjects`1474 is used instead.14751476fetch.unpackLimit::1477 If the number of objects fetched over the Git native1478 transfer is below this1479 limit, then the objects will be unpacked into loose object1480 files. However if the number of received objects equals or1481 exceeds this limit then the received pack will be stored as1482 a pack, after adding any missing delta bases. Storing the1483 pack from a push can make the push operation complete faster,1484 especially on slow filesystems. If not set, the value of1485 `transfer.unpackLimit` is used instead.14861487fetch.prune::1488 If true, fetch will automatically behave as if the `--prune`1489 option was given on the command line. See also `remote.<name>.prune`1490 and the PRUNING section of linkgit:git-fetch[1].14911492fetch.pruneTags::1493 If true, fetch will automatically behave as if the1494 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1495 if not set already. This allows for setting both this option1496 and `fetch.prune` to maintain a 1=1 mapping to upstream1497 refs. See also `remote.<name>.pruneTags` and the PRUNING1498 section of linkgit:git-fetch[1].14991500fetch.output::1501 Control how ref update status is printed. Valid values are1502 `full` and `compact`. Default value is `full`. See section1503 OUTPUT in linkgit:git-fetch[1] for detail.15041505format.attach::1506 Enable multipart/mixed attachments as the default for1507 'format-patch'. The value can also be a double quoted string1508 which will enable attachments as the default and set the1509 value as the boundary. See the --attach option in1510 linkgit:git-format-patch[1].15111512format.from::1513 Provides the default value for the `--from` option to format-patch.1514 Accepts a boolean value, or a name and email address. If false,1515 format-patch defaults to `--no-from`, using commit authors directly in1516 the "From:" field of patch mails. If true, format-patch defaults to1517 `--from`, using your committer identity in the "From:" field of patch1518 mails and including a "From:" field in the body of the patch mail if1519 different. If set to a non-boolean value, format-patch uses that1520 value instead of your committer identity. Defaults to false.15211522format.numbered::1523 A boolean which can enable or disable sequence numbers in patch1524 subjects. It defaults to "auto" which enables it only if there1525 is more than one patch. It can be enabled or disabled for all1526 messages by setting it to "true" or "false". See --numbered1527 option in linkgit:git-format-patch[1].15281529format.headers::1530 Additional email headers to include in a patch to be submitted1531 by mail. See linkgit:git-format-patch[1].15321533format.to::1534format.cc::1535 Additional recipients to include in a patch to be submitted1536 by mail. See the --to and --cc options in1537 linkgit:git-format-patch[1].15381539format.subjectPrefix::1540 The default for format-patch is to output files with the '[PATCH]'1541 subject prefix. Use this variable to change that prefix.15421543format.signature::1544 The default for format-patch is to output a signature containing1545 the Git version number. Use this variable to change that default.1546 Set this variable to the empty string ("") to suppress1547 signature generation.15481549format.signatureFile::1550 Works just like format.signature except the contents of the1551 file specified by this variable will be used as the signature.15521553format.suffix::1554 The default for format-patch is to output files with the suffix1555 `.patch`. Use this variable to change that suffix (make sure to1556 include the dot if you want it).15571558format.pretty::1559 The default pretty format for log/show/whatchanged command,1560 See linkgit:git-log[1], linkgit:git-show[1],1561 linkgit:git-whatchanged[1].15621563format.thread::1564 The default threading style for 'git format-patch'. Can be1565 a boolean value, or `shallow` or `deep`. `shallow` threading1566 makes every mail a reply to the head of the series,1567 where the head is chosen from the cover letter, the1568 `--in-reply-to`, and the first patch mail, in this order.1569 `deep` threading makes every mail a reply to the previous one.1570 A true boolean value is the same as `shallow`, and a false1571 value disables threading.15721573format.signOff::1574 A boolean value which lets you enable the `-s/--signoff` option of1575 format-patch by default. *Note:* Adding the Signed-off-by: line to a1576 patch should be a conscious act and means that you certify you have1577 the rights to submit this work under the same open source license.1578 Please see the 'SubmittingPatches' document for further discussion.15791580format.coverLetter::1581 A boolean that controls whether to generate a cover-letter when1582 format-patch is invoked, but in addition can be set to "auto", to1583 generate a cover-letter only when there's more than one patch.15841585format.outputDirectory::1586 Set a custom directory to store the resulting files instead of the1587 current working directory.15881589format.useAutoBase::1590 A boolean value which lets you enable the `--base=auto` option of1591 format-patch by default.15921593filter.<driver>.clean::1594 The command which is used to convert the content of a worktree1595 file to a blob upon checkin. See linkgit:gitattributes[5] for1596 details.15971598filter.<driver>.smudge::1599 The command which is used to convert the content of a blob1600 object to a worktree file upon checkout. See1601 linkgit:gitattributes[5] for details.16021603fsck.<msg-id>::1604 Allows overriding the message type (error, warn or ignore) of a1605 specific message ID such as `missingEmail`.1606+1607For convenience, fsck prefixes the error/warning with the message ID,1608e.g. "missingEmail: invalid author/committer line - missing email" means1609that setting `fsck.missingEmail = ignore` will hide that issue.1610+1611This feature is intended to support working with legacy repositories1612which cannot be repaired without disruptive changes.16131614fsck.skipList::1615 The path to a sorted list of object names (i.e. one SHA-1 per1616 line) that are known to be broken in a non-fatal way and should1617 be ignored. This feature is useful when an established project1618 should be accepted despite early commits containing errors that1619 can be safely ignored such as invalid committer email addresses.1620 Note: corrupt objects cannot be skipped with this setting.16211622gc.aggressiveDepth::1623 The depth parameter used in the delta compression1624 algorithm used by 'git gc --aggressive'. This defaults1625 to 50.16261627gc.aggressiveWindow::1628 The window size parameter used in the delta compression1629 algorithm used by 'git gc --aggressive'. This defaults1630 to 250.16311632gc.auto::1633 When there are approximately more than this many loose1634 objects in the repository, `git gc --auto` will pack them.1635 Some Porcelain commands use this command to perform a1636 light-weight garbage collection from time to time. The1637 default value is 6700. Setting this to 0 disables it.16381639gc.autoPackLimit::1640 When there are more than this many packs that are not1641 marked with `*.keep` file in the repository, `git gc1642 --auto` consolidates them into one larger pack. The1643 default value is 50. Setting this to 0 disables it.16441645gc.autoDetach::1646 Make `git gc --auto` return immediately and run in background1647 if the system supports it. Default is true.16481649gc.bigPackThreshold::1650 If non-zero, all packs larger than this limit are kept when1651 `git gc` is run. This is very similar to `--keep-base-pack`1652 except that all packs that meet the threshold are kept, not1653 just the base pack. Defaults to zero. Common unit suffixes of1654 'k', 'm', or 'g' are supported.1655+1656Note that if the number of kept packs is more than gc.autoPackLimit,1657this configuration variable is ignored, all packs except the base pack1658will be repacked. After this the number of packs should go below1659gc.autoPackLimit and gc.bigPackThreshold should be respected again.16601661gc.logExpiry::1662 If the file gc.log exists, then `git gc --auto` won't run1663 unless that file is more than 'gc.logExpiry' old. Default is1664 "1.day". See `gc.pruneExpire` for more ways to specify its1665 value.16661667gc.packRefs::1668 Running `git pack-refs` in a repository renders it1669 unclonable by Git versions prior to 1.5.1.2 over dumb1670 transports such as HTTP. This variable determines whether1671 'git gc' runs `git pack-refs`. This can be set to `notbare`1672 to enable it within all non-bare repos or it can be set to a1673 boolean value. The default is `true`.16741675gc.pruneExpire::1676 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1677 Override the grace period with this config variable. The value1678 "now" may be used to disable this grace period and always prune1679 unreachable objects immediately, or "never" may be used to1680 suppress pruning. This feature helps prevent corruption when1681 'git gc' runs concurrently with another process writing to the1682 repository; see the "NOTES" section of linkgit:git-gc[1].16831684gc.worktreePruneExpire::1685 When 'git gc' is run, it calls1686 'git worktree prune --expire 3.months.ago'.1687 This config variable can be used to set a different grace1688 period. The value "now" may be used to disable the grace1689 period and prune `$GIT_DIR/worktrees` immediately, or "never"1690 may be used to suppress pruning.16911692gc.reflogExpire::1693gc.<pattern>.reflogExpire::1694 'git reflog expire' removes reflog entries older than1695 this time; defaults to 90 days. The value "now" expires all1696 entries immediately, and "never" suppresses expiration1697 altogether. With "<pattern>" (e.g.1698 "refs/stash") in the middle the setting applies only to1699 the refs that match the <pattern>.17001701gc.reflogExpireUnreachable::1702gc.<pattern>.reflogExpireUnreachable::1703 'git reflog expire' removes reflog entries older than1704 this time and are not reachable from the current tip;1705 defaults to 30 days. The value "now" expires all entries1706 immediately, and "never" suppresses expiration altogether.1707 With "<pattern>" (e.g. "refs/stash")1708 in the middle, the setting applies only to the refs that1709 match the <pattern>.17101711gc.rerereResolved::1712 Records of conflicted merge you resolved earlier are1713 kept for this many days when 'git rerere gc' is run.1714 You can also use more human-readable "1.month.ago", etc.1715 The default is 60 days. See linkgit:git-rerere[1].17161717gc.rerereUnresolved::1718 Records of conflicted merge you have not resolved are1719 kept for this many days when 'git rerere gc' is run.1720 You can also use more human-readable "1.month.ago", etc.1721 The default is 15 days. See linkgit:git-rerere[1].17221723gitcvs.commitMsgAnnotation::1724 Append this string to each commit message. Set to empty string1725 to disable this feature. Defaults to "via git-CVS emulator".17261727gitcvs.enabled::1728 Whether the CVS server interface is enabled for this repository.1729 See linkgit:git-cvsserver[1].17301731gitcvs.logFile::1732 Path to a log file where the CVS server interface well... logs1733 various stuff. See linkgit:git-cvsserver[1].17341735gitcvs.usecrlfattr::1736 If true, the server will look up the end-of-line conversion1737 attributes for files to determine the `-k` modes to use. If1738 the attributes force Git to treat a file as text,1739 the `-k` mode will be left blank so CVS clients will1740 treat it as text. If they suppress text conversion, the file1741 will be set with '-kb' mode, which suppresses any newline munging1742 the client might otherwise do. If the attributes do not allow1743 the file type to be determined, then `gitcvs.allBinary` is1744 used. See linkgit:gitattributes[5].17451746gitcvs.allBinary::1747 This is used if `gitcvs.usecrlfattr` does not resolve1748 the correct '-kb' mode to use. If true, all1749 unresolved files are sent to the client in1750 mode '-kb'. This causes the client to treat them1751 as binary files, which suppresses any newline munging it1752 otherwise might do. Alternatively, if it is set to "guess",1753 then the contents of the file are examined to decide if1754 it is binary, similar to `core.autocrlf`.17551756gitcvs.dbName::1757 Database used by git-cvsserver to cache revision information1758 derived from the Git repository. The exact meaning depends on the1759 used database driver, for SQLite (which is the default driver) this1760 is a filename. Supports variable substitution (see1761 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1762 Default: '%Ggitcvs.%m.sqlite'17631764gitcvs.dbDriver::1765 Used Perl DBI driver. You can specify any available driver1766 for this here, but it might not work. git-cvsserver is tested1767 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1768 reported *not* to work with 'DBD::mysql'. Experimental feature.1769 May not contain double colons (`:`). Default: 'SQLite'.1770 See linkgit:git-cvsserver[1].17711772gitcvs.dbUser, gitcvs.dbPass::1773 Database user and password. Only useful if setting `gitcvs.dbDriver`,1774 since SQLite has no concept of database users and/or passwords.1775 'gitcvs.dbUser' supports variable substitution (see1776 linkgit:git-cvsserver[1] for details).17771778gitcvs.dbTableNamePrefix::1779 Database table name prefix. Prepended to the names of any1780 database tables used, allowing a single database to be used1781 for several repositories. Supports variable substitution (see1782 linkgit:git-cvsserver[1] for details). Any non-alphabetic1783 characters will be replaced with underscores.17841785All gitcvs variables except for `gitcvs.usecrlfattr` and1786`gitcvs.allBinary` can also be specified as1787'gitcvs.<access_method>.<varname>' (where 'access_method'1788is one of "ext" and "pserver") to make them apply only for the given1789access method.17901791gitweb.category::1792gitweb.description::1793gitweb.owner::1794gitweb.url::1795 See linkgit:gitweb[1] for description.17961797gitweb.avatar::1798gitweb.blame::1799gitweb.grep::1800gitweb.highlight::1801gitweb.patches::1802gitweb.pickaxe::1803gitweb.remote_heads::1804gitweb.showSizes::1805gitweb.snapshot::1806 See linkgit:gitweb.conf[5] for description.18071808grep.lineNumber::1809 If set to true, enable `-n` option by default.18101811grep.column::1812 If set to true, enable the `--column` option by default.18131814grep.patternType::1815 Set the default matching behavior. Using a value of 'basic', 'extended',1816 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1817 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1818 value 'default' will return to the default matching behavior.18191820grep.extendedRegexp::1821 If set to true, enable `--extended-regexp` option by default. This1822 option is ignored when the `grep.patternType` option is set to a value1823 other than 'default'.18241825grep.threads::1826 Number of grep worker threads to use.1827 See `grep.threads` in linkgit:git-grep[1] for more information.18281829grep.fallbackToNoIndex::1830 If set to true, fall back to git grep --no-index if git grep1831 is executed outside of a git repository. Defaults to false.18321833gpg.program::1834 Use this custom program instead of "`gpg`" found on `$PATH` when1835 making or verifying a PGP signature. The program must support the1836 same command-line interface as GPG, namely, to verify a detached1837 signature, "`gpg --verify $file - <$signature`" is run, and the1838 program is expected to signal a good signature by exiting with1839 code 0, and to generate an ASCII-armored detached signature, the1840 standard input of "`gpg -bsau $key`" is fed with the contents to be1841 signed, and the program is expected to send the result to its1842 standard output.18431844gui.commitMsgWidth::1845 Defines how wide the commit message window is in the1846 linkgit:git-gui[1]. "75" is the default.18471848gui.diffContext::1849 Specifies how many context lines should be used in calls to diff1850 made by the linkgit:git-gui[1]. The default is "5".18511852gui.displayUntracked::1853 Determines if linkgit:git-gui[1] shows untracked files1854 in the file list. The default is "true".18551856gui.encoding::1857 Specifies the default encoding to use for displaying of1858 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1859 It can be overridden by setting the 'encoding' attribute1860 for relevant files (see linkgit:gitattributes[5]).1861 If this option is not set, the tools default to the1862 locale encoding.18631864gui.matchTrackingBranch::1865 Determines if new branches created with linkgit:git-gui[1] should1866 default to tracking remote branches with matching names or1867 not. Default: "false".18681869gui.newBranchTemplate::1870 Is used as suggested name when creating new branches using the1871 linkgit:git-gui[1].18721873gui.pruneDuringFetch::1874 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1875 performing a fetch. The default value is "false".18761877gui.trustmtime::1878 Determines if linkgit:git-gui[1] should trust the file modification1879 timestamp or not. By default the timestamps are not trusted.18801881gui.spellingDictionary::1882 Specifies the dictionary used for spell checking commit messages in1883 the linkgit:git-gui[1]. When set to "none" spell checking is turned1884 off.18851886gui.fastCopyBlame::1887 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1888 location detection. It makes blame significantly faster on huge1889 repositories at the expense of less thorough copy detection.18901891gui.copyBlameThreshold::1892 Specifies the threshold to use in 'git gui blame' original location1893 detection, measured in alphanumeric characters. See the1894 linkgit:git-blame[1] manual for more information on copy detection.18951896gui.blamehistoryctx::1897 Specifies the radius of history context in days to show in1898 linkgit:gitk[1] for the selected commit, when the `Show History1899 Context` menu item is invoked from 'git gui blame'. If this1900 variable is set to zero, the whole history is shown.19011902guitool.<name>.cmd::1903 Specifies the shell command line to execute when the corresponding item1904 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1905 mandatory for every tool. The command is executed from the root of1906 the working directory, and in the environment it receives the name of1907 the tool as `GIT_GUITOOL`, the name of the currently selected file as1908 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1909 the head is detached, 'CUR_BRANCH' is empty).19101911guitool.<name>.needsFile::1912 Run the tool only if a diff is selected in the GUI. It guarantees1913 that 'FILENAME' is not empty.19141915guitool.<name>.noConsole::1916 Run the command silently, without creating a window to display its1917 output.19181919guitool.<name>.noRescan::1920 Don't rescan the working directory for changes after the tool1921 finishes execution.19221923guitool.<name>.confirm::1924 Show a confirmation dialog before actually running the tool.19251926guitool.<name>.argPrompt::1927 Request a string argument from the user, and pass it to the tool1928 through the `ARGS` environment variable. Since requesting an1929 argument implies confirmation, the 'confirm' option has no effect1930 if this is enabled. If the option is set to 'true', 'yes', or '1',1931 the dialog uses a built-in generic prompt; otherwise the exact1932 value of the variable is used.19331934guitool.<name>.revPrompt::1935 Request a single valid revision from the user, and set the1936 `REVISION` environment variable. In other aspects this option1937 is similar to 'argPrompt', and can be used together with it.19381939guitool.<name>.revUnmerged::1940 Show only unmerged branches in the 'revPrompt' subdialog.1941 This is useful for tools similar to merge or rebase, but not1942 for things like checkout or reset.19431944guitool.<name>.title::1945 Specifies the title to use for the prompt dialog. The default1946 is the tool name.19471948guitool.<name>.prompt::1949 Specifies the general prompt string to display at the top of1950 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1951 The default value includes the actual command.19521953help.browser::1954 Specify the browser that will be used to display help in the1955 'web' format. See linkgit:git-help[1].19561957help.format::1958 Override the default help format used by linkgit:git-help[1].1959 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1960 the default. 'web' and 'html' are the same.19611962help.autoCorrect::1963 Automatically correct and execute mistyped commands after1964 waiting for the given number of deciseconds (0.1 sec). If more1965 than one command can be deduced from the entered text, nothing1966 will be executed. If the value of this option is negative,1967 the corrected command will be executed immediately. If the1968 value is 0 - the command will be just shown but not executed.1969 This is the default.19701971help.htmlPath::1972 Specify the path where the HTML documentation resides. File system paths1973 and URLs are supported. HTML pages will be prefixed with this path when1974 help is displayed in the 'web' format. This defaults to the documentation1975 path of your Git installation.19761977http.proxy::1978 Override the HTTP proxy, normally configured using the 'http_proxy',1979 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1980 addition to the syntax understood by curl, it is possible to specify a1981 proxy string with a user name but no password, in which case git will1982 attempt to acquire one in the same way it does for other credentials. See1983 linkgit:gitcredentials[7] for more information. The syntax thus is1984 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1985 on a per-remote basis; see remote.<name>.proxy19861987http.proxyAuthMethod::1988 Set the method with which to authenticate against the HTTP proxy. This1989 only takes effect if the configured proxy string contains a user name part1990 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1991 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1992 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1993 variable. Possible values are:1994+1995--1996* `anyauth` - Automatically pick a suitable authentication method. It is1997 assumed that the proxy answers an unauthenticated request with a 4071998 status code and one or more Proxy-authenticate headers with supported1999 authentication methods. This is the default.2000* `basic` - HTTP Basic authentication2001* `digest` - HTTP Digest authentication; this prevents the password from being2002 transmitted to the proxy in clear text2003* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option2004 of `curl(1)`)2005* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)2006--20072008http.emptyAuth::2009 Attempt authentication without seeking a username or password. This2010 can be used to attempt GSS-Negotiate authentication without specifying2011 a username in the URL, as libcurl normally requires a username for2012 authentication.20132014http.delegation::2015 Control GSSAPI credential delegation. The delegation is disabled2016 by default in libcurl since version 7.21.7. Set parameter to tell2017 the server what it is allowed to delegate when it comes to user2018 credentials. Used with GSS/kerberos. Possible values are:2019+2020--2021* `none` - Don't allow any delegation.2022* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2023 Kerberos service ticket, which is a matter of realm policy.2024* `always` - Unconditionally allow the server to delegate.2025--202620272028http.extraHeader::2029 Pass an additional HTTP header when communicating with a server. If2030 more than one such entry exists, all of them are added as extra2031 headers. To allow overriding the settings inherited from the system2032 config, an empty value will reset the extra headers to the empty list.20332034http.cookieFile::2035 The pathname of a file containing previously stored cookie lines,2036 which should be used2037 in the Git http session, if they match the server. The file format2038 of the file to read cookies from should be plain HTTP headers or2039 the Netscape/Mozilla cookie file format (see `curl(1)`).2040 NOTE that the file specified with http.cookieFile is used only as2041 input unless http.saveCookies is set.20422043http.saveCookies::2044 If set, store cookies received during requests to the file specified by2045 http.cookieFile. Has no effect if http.cookieFile is unset.20462047http.sslVersion::2048 The SSL version to use when negotiating an SSL connection, if you2049 want to force the default. The available and default version2050 depend on whether libcurl was built against NSS or OpenSSL and the2051 particular configuration of the crypto library in use. Internally2052 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2053 documentation for more details on the format of this option and2054 for the ssl version supported. Actually the possible values of2055 this option are:20562057 - sslv22058 - sslv32059 - tlsv12060 - tlsv1.02061 - tlsv1.12062 - tlsv1.22063 - tlsv1.320642065+2066Can be overridden by the `GIT_SSL_VERSION` environment variable.2067To force git to use libcurl's default ssl version and ignore any2068explicit http.sslversion option, set `GIT_SSL_VERSION` to the2069empty string.20702071http.sslCipherList::2072 A list of SSL ciphers to use when negotiating an SSL connection.2073 The available ciphers depend on whether libcurl was built against2074 NSS or OpenSSL and the particular configuration of the crypto2075 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2076 option; see the libcurl documentation for more details on the format2077 of this list.2078+2079Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2080To force git to use libcurl's default cipher list and ignore any2081explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2082empty string.20832084http.sslVerify::2085 Whether to verify the SSL certificate when fetching or pushing2086 over HTTPS. Defaults to true. Can be overridden by the2087 `GIT_SSL_NO_VERIFY` environment variable.20882089http.sslCert::2090 File containing the SSL certificate when fetching or pushing2091 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2092 variable.20932094http.sslKey::2095 File containing the SSL private key when fetching or pushing2096 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2097 variable.20982099http.sslCertPasswordProtected::2100 Enable Git's password prompt for the SSL certificate. Otherwise2101 OpenSSL will prompt the user, possibly many times, if the2102 certificate or private key is encrypted. Can be overridden by the2103 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.21042105http.sslCAInfo::2106 File containing the certificates to verify the peer with when2107 fetching or pushing over HTTPS. Can be overridden by the2108 `GIT_SSL_CAINFO` environment variable.21092110http.sslCAPath::2111 Path containing files with the CA certificates to verify the peer2112 with when fetching or pushing over HTTPS. Can be overridden2113 by the `GIT_SSL_CAPATH` environment variable.21142115http.pinnedpubkey::2116 Public key of the https service. It may either be the filename of2117 a PEM or DER encoded public key file or a string starting with2118 'sha256//' followed by the base64 encoded sha256 hash of the2119 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2120 exit with an error if this option is set but not supported by2121 cURL.21222123http.sslTry::2124 Attempt to use AUTH SSL/TLS and encrypted data transfers2125 when connecting via regular FTP protocol. This might be needed2126 if the FTP server requires it for security reasons or you wish2127 to connect securely whenever remote FTP server supports it.2128 Default is false since it might trigger certificate verification2129 errors on misconfigured servers.21302131http.maxRequests::2132 How many HTTP requests to launch in parallel. Can be overridden2133 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21342135http.minSessions::2136 The number of curl sessions (counted across slots) to be kept across2137 requests. They will not be ended with curl_easy_cleanup() until2138 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2139 value will be capped at 1. Defaults to 1.21402141http.postBuffer::2142 Maximum size in bytes of the buffer used by smart HTTP2143 transports when POSTing data to the remote system.2144 For requests larger than this buffer size, HTTP/1.1 and2145 Transfer-Encoding: chunked is used to avoid creating a2146 massive pack file locally. Default is 1 MiB, which is2147 sufficient for most requests.21482149http.lowSpeedLimit, http.lowSpeedTime::2150 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2151 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2152 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2153 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21542155http.noEPSV::2156 A boolean which disables using of EPSV ftp command by curl.2157 This can helpful with some "poor" ftp servers which don't2158 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2159 environment variable. Default is false (curl will use EPSV).21602161http.userAgent::2162 The HTTP USER_AGENT string presented to an HTTP server. The default2163 value represents the version of the client Git such as git/1.7.1.2164 This option allows you to override this value to a more common value2165 such as Mozilla/4.0. This may be necessary, for instance, if2166 connecting through a firewall that restricts HTTP connections to a set2167 of common USER_AGENT strings (but not including those like git/1.7.1).2168 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21692170http.followRedirects::2171 Whether git should follow HTTP redirects. If set to `true`, git2172 will transparently follow any redirect issued by a server it2173 encounters. If set to `false`, git will treat all redirects as2174 errors. If set to `initial`, git will follow redirects only for2175 the initial request to a remote, but not for subsequent2176 follow-up HTTP requests. Since git uses the redirected URL as2177 the base for the follow-up requests, this is generally2178 sufficient. The default is `initial`.21792180http.<url>.*::2181 Any of the http.* options above can be applied selectively to some URLs.2182 For a config key to match a URL, each element of the config key is2183 compared to that of the URL, in the following order:2184+2185--2186. Scheme (e.g., `https` in `https://example.com/`). This field2187 must match exactly between the config key and the URL.21882189. Host/domain name (e.g., `example.com` in `https://example.com/`).2190 This field must match between the config key and the URL. It is2191 possible to specify a `*` as part of the host name to match all subdomains2192 at this level. `https://*.example.com/` for example would match2193 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21942195. Port number (e.g., `8080` in `http://example.com:8080/`).2196 This field must match exactly between the config key and the URL.2197 Omitted port numbers are automatically converted to the correct2198 default for the scheme before matching.21992200. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2201 path field of the config key must match the path field of the URL2202 either exactly or as a prefix of slash-delimited path elements. This means2203 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2204 match on a slash (`/`) boundary. Longer matches take precedence (so a config2205 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2206 key with just path `foo/`).22072208. User name (e.g., `user` in `https://user@example.com/repo.git`). If2209 the config key has a user name it must match the user name in the2210 URL exactly. If the config key does not have a user name, that2211 config key will match a URL with any user name (including none),2212 but at a lower precedence than a config key with a user name.2213--2214+2215The list above is ordered by decreasing precedence; a URL that matches2216a config key's path is preferred to one that matches its user name. For example,2217if the URL is `https://user@example.com/foo/bar` a config key match of2218`https://example.com/foo` will be preferred over a config key match of2219`https://user@example.com`.2220+2221All URLs are normalized before attempting any matching (the password part,2222if embedded in the URL, is always ignored for matching purposes) so that2223equivalent URLs that are simply spelled differently will match properly.2224Environment variable settings always override any matches. The URLs that are2225matched against are those given directly to Git commands. This means any URLs2226visited as a result of a redirection do not participate in matching.22272228ssh.variant::2229 By default, Git determines the command line arguments to use2230 based on the basename of the configured SSH command (configured2231 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2232 the config setting `core.sshCommand`). If the basename is2233 unrecognized, Git will attempt to detect support of OpenSSH2234 options by first invoking the configured SSH command with the2235 `-G` (print configuration) option and will subsequently use2236 OpenSSH options (if that is successful) or no options besides2237 the host and remote command (if it fails).2238+2239The config variable `ssh.variant` can be set to override this detection.2240Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2241`tortoiseplink`, `simple` (no options except the host and remote command).2242The default auto-detection can be explicitly requested using the value2243`auto`. Any other value is treated as `ssh`. This setting can also be2244overridden via the environment variable `GIT_SSH_VARIANT`.2245+2246The current command-line parameters used for each variant are as2247follows:2248+2249--22502251* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22522253* `simple` - [username@]host command22542255* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22562257* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22582259--2260+2261Except for the `simple` variant, command-line parameters are likely to2262change as git gains new features.22632264i18n.commitEncoding::2265 Character encoding the commit messages are stored in; Git itself2266 does not care per se, but this information is necessary e.g. when2267 importing commits from emails or in the gitk graphical history2268 browser (and possibly at other places in the future or in other2269 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22702271i18n.logOutputEncoding::2272 Character encoding the commit messages are converted to when2273 running 'git log' and friends.22742275imap::2276 The configuration variables in the 'imap' section are described2277 in linkgit:git-imap-send[1].22782279index.version::2280 Specify the version with which new index files should be2281 initialized. This does not affect existing repositories.22822283init.templateDir::2284 Specify the directory from which templates will be copied.2285 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22862287instaweb.browser::2288 Specify the program that will be used to browse your working2289 repository in gitweb. See linkgit:git-instaweb[1].22902291instaweb.httpd::2292 The HTTP daemon command-line to start gitweb on your working2293 repository. See linkgit:git-instaweb[1].22942295instaweb.local::2296 If true the web server started by linkgit:git-instaweb[1] will2297 be bound to the local IP (127.0.0.1).22982299instaweb.modulePath::2300 The default module path for linkgit:git-instaweb[1] to use2301 instead of /usr/lib/apache2/modules. Only used if httpd2302 is Apache.23032304instaweb.port::2305 The port number to bind the gitweb httpd to. See2306 linkgit:git-instaweb[1].23072308interactive.singleKey::2309 In interactive commands, allow the user to provide one-letter2310 input with a single key (i.e., without hitting enter).2311 Currently this is used by the `--patch` mode of2312 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2313 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2314 setting is silently ignored if portable keystroke input2315 is not available; requires the Perl module Term::ReadKey.23162317interactive.diffFilter::2318 When an interactive command (such as `git add --patch`) shows2319 a colorized diff, git will pipe the diff through the shell2320 command defined by this configuration variable. The command may2321 mark up the diff further for human consumption, provided that it2322 retains a one-to-one correspondence with the lines in the2323 original diff. Defaults to disabled (no filtering).23242325log.abbrevCommit::2326 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2327 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2328 override this option with `--no-abbrev-commit`.23292330log.date::2331 Set the default date-time mode for the 'log' command.2332 Setting a value for log.date is similar to using 'git log''s2333 `--date` option. See linkgit:git-log[1] for details.23342335log.decorate::2336 Print out the ref names of any commits that are shown by the log2337 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2338 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2339 specified, the full ref name (including prefix) will be printed.2340 If 'auto' is specified, then if the output is going to a terminal,2341 the ref names are shown as if 'short' were given, otherwise no ref2342 names are shown. This is the same as the `--decorate` option2343 of the `git log`.23442345log.follow::2346 If `true`, `git log` will act as if the `--follow` option was used when2347 a single <path> is given. This has the same limitations as `--follow`,2348 i.e. it cannot be used to follow multiple files and does not work well2349 on non-linear history.23502351log.graphColors::2352 A list of colors, separated by commas, that can be used to draw2353 history lines in `git log --graph`.23542355log.showRoot::2356 If true, the initial commit will be shown as a big creation event.2357 This is equivalent to a diff against an empty tree.2358 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2359 normally hide the root commit will now show it. True by default.23602361log.showSignature::2362 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2363 linkgit:git-whatchanged[1] assume `--show-signature`.23642365log.mailmap::2366 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2367 linkgit:git-whatchanged[1] assume `--use-mailmap`.23682369mailinfo.scissors::2370 If true, makes linkgit:git-mailinfo[1] (and therefore2371 linkgit:git-am[1]) act by default as if the --scissors option2372 was provided on the command-line. When active, this features2373 removes everything from the message body before a scissors2374 line (i.e. consisting mainly of ">8", "8<" and "-").23752376mailmap.file::2377 The location of an augmenting mailmap file. The default2378 mailmap, located in the root of the repository, is loaded2379 first, then the mailmap file pointed to by this variable.2380 The location of the mailmap file may be in a repository2381 subdirectory, or somewhere outside of the repository itself.2382 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23832384mailmap.blob::2385 Like `mailmap.file`, but consider the value as a reference to a2386 blob in the repository. If both `mailmap.file` and2387 `mailmap.blob` are given, both are parsed, with entries from2388 `mailmap.file` taking precedence. In a bare repository, this2389 defaults to `HEAD:.mailmap`. In a non-bare repository, it2390 defaults to empty.23912392man.viewer::2393 Specify the programs that may be used to display help in the2394 'man' format. See linkgit:git-help[1].23952396man.<tool>.cmd::2397 Specify the command to invoke the specified man viewer. The2398 specified command is evaluated in shell with the man page2399 passed as argument. (See linkgit:git-help[1].)24002401man.<tool>.path::2402 Override the path for the given tool that may be used to2403 display help in the 'man' format. See linkgit:git-help[1].24042405include::merge-config.txt[]24062407mergetool.<tool>.path::2408 Override the path for the given tool. This is useful in case2409 your tool is not in the PATH.24102411mergetool.<tool>.cmd::2412 Specify the command to invoke the specified merge tool. The2413 specified command is evaluated in shell with the following2414 variables available: 'BASE' is the name of a temporary file2415 containing the common base of the files to be merged, if available;2416 'LOCAL' is the name of a temporary file containing the contents of2417 the file on the current branch; 'REMOTE' is the name of a temporary2418 file containing the contents of the file from the branch being2419 merged; 'MERGED' contains the name of the file to which the merge2420 tool should write the results of a successful merge.24212422mergetool.<tool>.trustExitCode::2423 For a custom merge command, specify whether the exit code of2424 the merge command can be used to determine whether the merge was2425 successful. If this is not set to true then the merge target file2426 timestamp is checked and the merge assumed to have been successful2427 if the file has been updated, otherwise the user is prompted to2428 indicate the success of the merge.24292430mergetool.meld.hasOutput::2431 Older versions of `meld` do not support the `--output` option.2432 Git will attempt to detect whether `meld` supports `--output`2433 by inspecting the output of `meld --help`. Configuring2434 `mergetool.meld.hasOutput` will make Git skip these checks and2435 use the configured value instead. Setting `mergetool.meld.hasOutput`2436 to `true` tells Git to unconditionally use the `--output` option,2437 and `false` avoids using `--output`.24382439mergetool.keepBackup::2440 After performing a merge, the original file with conflict markers2441 can be saved as a file with a `.orig` extension. If this variable2442 is set to `false` then this file is not preserved. Defaults to2443 `true` (i.e. keep the backup files).24442445mergetool.keepTemporaries::2446 When invoking a custom merge tool, Git uses a set of temporary2447 files to pass to the tool. If the tool returns an error and this2448 variable is set to `true`, then these temporary files will be2449 preserved, otherwise they will be removed after the tool has2450 exited. Defaults to `false`.24512452mergetool.writeToTemp::2453 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2454 conflicting files in the worktree by default. Git will attempt2455 to use a temporary directory for these files when set `true`.2456 Defaults to `false`.24572458mergetool.prompt::2459 Prompt before each invocation of the merge resolution program.24602461notes.mergeStrategy::2462 Which merge strategy to choose by default when resolving notes2463 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2464 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2465 section of linkgit:git-notes[1] for more information on each strategy.24662467notes.<name>.mergeStrategy::2468 Which merge strategy to choose when doing a notes merge into2469 refs/notes/<name>. This overrides the more general2470 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2471 linkgit:git-notes[1] for more information on the available strategies.24722473notes.displayRef::2474 The (fully qualified) refname from which to show notes when2475 showing commit messages. The value of this variable can be set2476 to a glob, in which case notes from all matching refs will be2477 shown. You may also specify this configuration variable2478 several times. A warning will be issued for refs that do not2479 exist, but a glob that does not match any refs is silently2480 ignored.2481+2482This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2483environment variable, which must be a colon separated list of refs or2484globs.2485+2486The effective value of "core.notesRef" (possibly overridden by2487GIT_NOTES_REF) is also implicitly added to the list of refs to be2488displayed.24892490notes.rewrite.<command>::2491 When rewriting commits with <command> (currently `amend` or2492 `rebase`) and this variable is set to `true`, Git2493 automatically copies your notes from the original to the2494 rewritten commit. Defaults to `true`, but see2495 "notes.rewriteRef" below.24962497notes.rewriteMode::2498 When copying notes during a rewrite (see the2499 "notes.rewrite.<command>" option), determines what to do if2500 the target commit already has a note. Must be one of2501 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2502 Defaults to `concatenate`.2503+2504This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2505environment variable.25062507notes.rewriteRef::2508 When copying notes during a rewrite, specifies the (fully2509 qualified) ref whose notes should be copied. The ref may be a2510 glob, in which case notes in all matching refs will be copied.2511 You may also specify this configuration several times.2512+2513Does not have a default value; you must configure this variable to2514enable note rewriting. Set it to `refs/notes/commits` to enable2515rewriting for the default commit notes.2516+2517This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2518environment variable, which must be a colon separated list of refs or2519globs.25202521pack.window::2522 The size of the window used by linkgit:git-pack-objects[1] when no2523 window size is given on the command line. Defaults to 10.25242525pack.depth::2526 The maximum delta depth used by linkgit:git-pack-objects[1] when no2527 maximum depth is given on the command line. Defaults to 50.2528 Maximum value is 4095.25292530pack.windowMemory::2531 The maximum size of memory that is consumed by each thread2532 in linkgit:git-pack-objects[1] for pack window memory when2533 no limit is given on the command line. The value can be2534 suffixed with "k", "m", or "g". When left unconfigured (or2535 set explicitly to 0), there will be no limit.25362537pack.compression::2538 An integer -1..9, indicating the compression level for objects2539 in a pack file. -1 is the zlib default. 0 means no2540 compression, and 1..9 are various speed/size tradeoffs, 9 being2541 slowest. If not set, defaults to core.compression. If that is2542 not set, defaults to -1, the zlib default, which is "a default2543 compromise between speed and compression (currently equivalent2544 to level 6)."2545+2546Note that changing the compression level will not automatically recompress2547all existing objects. You can force recompression by passing the -F option2548to linkgit:git-repack[1].25492550pack.deltaCacheSize::2551 The maximum memory in bytes used for caching deltas in2552 linkgit:git-pack-objects[1] before writing them out to a pack.2553 This cache is used to speed up the writing object phase by not2554 having to recompute the final delta result once the best match2555 for all objects is found. Repacking large repositories on machines2556 which are tight with memory might be badly impacted by this though,2557 especially if this cache pushes the system into swapping.2558 A value of 0 means no limit. The smallest size of 1 byte may be2559 used to virtually disable this cache. Defaults to 256 MiB.25602561pack.deltaCacheLimit::2562 The maximum size of a delta, that is cached in2563 linkgit:git-pack-objects[1]. This cache is used to speed up the2564 writing object phase by not having to recompute the final delta2565 result once the best match for all objects is found.2566 Defaults to 1000. Maximum value is 65535.25672568pack.threads::2569 Specifies the number of threads to spawn when searching for best2570 delta matches. This requires that linkgit:git-pack-objects[1]2571 be compiled with pthreads otherwise this option is ignored with a2572 warning. This is meant to reduce packing time on multiprocessor2573 machines. The required amount of memory for the delta search window2574 is however multiplied by the number of threads.2575 Specifying 0 will cause Git to auto-detect the number of CPU's2576 and set the number of threads accordingly.25772578pack.indexVersion::2579 Specify the default pack index version. Valid values are 1 for2580 legacy pack index used by Git versions prior to 1.5.2, and 2 for2581 the new pack index with capabilities for packs larger than 4 GB2582 as well as proper protection against the repacking of corrupted2583 packs. Version 2 is the default. Note that version 2 is enforced2584 and this config option ignored whenever the corresponding pack is2585 larger than 2 GB.2586+2587If you have an old Git that does not understand the version 2 `*.idx` file,2588cloning or fetching over a non native protocol (e.g. "http")2589that will copy both `*.pack` file and corresponding `*.idx` file from the2590other side may give you a repository that cannot be accessed with your2591older version of Git. If the `*.pack` file is smaller than 2 GB, however,2592you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2593the `*.idx` file.25942595pack.packSizeLimit::2596 The maximum size of a pack. This setting only affects2597 packing to a file when repacking, i.e. the git:// protocol2598 is unaffected. It can be overridden by the `--max-pack-size`2599 option of linkgit:git-repack[1]. Reaching this limit results2600 in the creation of multiple packfiles; which in turn prevents2601 bitmaps from being created.2602 The minimum size allowed is limited to 1 MiB.2603 The default is unlimited.2604 Common unit suffixes of 'k', 'm', or 'g' are2605 supported.26062607pack.useBitmaps::2608 When true, git will use pack bitmaps (if available) when packing2609 to stdout (e.g., during the server side of a fetch). Defaults to2610 true. You should not generally need to turn this off unless2611 you are debugging pack bitmaps.26122613pack.writeBitmaps (deprecated)::2614 This is a deprecated synonym for `repack.writeBitmaps`.26152616pack.writeBitmapHashCache::2617 When true, git will include a "hash cache" section in the bitmap2618 index (if one is written). This cache can be used to feed git's2619 delta heuristics, potentially leading to better deltas between2620 bitmapped and non-bitmapped objects (e.g., when serving a fetch2621 between an older, bitmapped pack and objects that have been2622 pushed since the last gc). The downside is that it consumes 42623 bytes per object of disk space, and that JGit's bitmap2624 implementation does not understand it, causing it to complain if2625 Git and JGit are used on the same repository. Defaults to false.26262627pager.<cmd>::2628 If the value is boolean, turns on or off pagination of the2629 output of a particular Git subcommand when writing to a tty.2630 Otherwise, turns on pagination for the subcommand using the2631 pager specified by the value of `pager.<cmd>`. If `--paginate`2632 or `--no-pager` is specified on the command line, it takes2633 precedence over this option. To disable pagination for all2634 commands, set `core.pager` or `GIT_PAGER` to `cat`.26352636pretty.<name>::2637 Alias for a --pretty= format string, as specified in2638 linkgit:git-log[1]. Any aliases defined here can be used just2639 as the built-in pretty formats could. For example,2640 running `git config pretty.changelog "format:* %H %s"`2641 would cause the invocation `git log --pretty=changelog`2642 to be equivalent to running `git log "--pretty=format:* %H %s"`.2643 Note that an alias with the same name as a built-in format2644 will be silently ignored.26452646protocol.allow::2647 If set, provide a user defined default policy for all protocols which2648 don't explicitly have a policy (`protocol.<name>.allow`). By default,2649 if unset, known-safe protocols (http, https, git, ssh, file) have a2650 default policy of `always`, known-dangerous protocols (ext) have a2651 default policy of `never`, and all other protocols have a default2652 policy of `user`. Supported policies:2653+2654--26552656* `always` - protocol is always able to be used.26572658* `never` - protocol is never able to be used.26592660* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2661 either unset or has a value of 1. This policy should be used when you want a2662 protocol to be directly usable by the user but don't want it used by commands which2663 execute clone/fetch/push commands without user input, e.g. recursive2664 submodule initialization.26652666--26672668protocol.<name>.allow::2669 Set a policy to be used by protocol `<name>` with clone/fetch/push2670 commands. See `protocol.allow` above for the available policies.2671+2672The protocol names currently used by git are:2673+2674--2675 - `file`: any local file-based path (including `file://` URLs,2676 or local paths)26772678 - `git`: the anonymous git protocol over a direct TCP2679 connection (or proxy, if configured)26802681 - `ssh`: git over ssh (including `host:path` syntax,2682 `ssh://`, etc).26832684 - `http`: git over http, both "smart http" and "dumb http".2685 Note that this does _not_ include `https`; if you want to configure2686 both, you must do so individually.26872688 - any external helpers are named by their protocol (e.g., use2689 `hg` to allow the `git-remote-hg` helper)2690--26912692protocol.version::2693 Experimental. If set, clients will attempt to communicate with a2694 server using the specified protocol version. If unset, no2695 attempt will be made by the client to communicate using a2696 particular protocol version, this results in protocol version 02697 being used.2698 Supported versions:2699+2700--27012702* `0` - the original wire protocol.27032704* `1` - the original wire protocol with the addition of a version string2705 in the initial response from the server.27062707--27082709pull.ff::2710 By default, Git does not create an extra merge commit when merging2711 a commit that is a descendant of the current commit. Instead, the2712 tip of the current branch is fast-forwarded. When set to `false`,2713 this variable tells Git to create an extra merge commit in such2714 a case (equivalent to giving the `--no-ff` option from the command2715 line). When set to `only`, only such fast-forward merges are2716 allowed (equivalent to giving the `--ff-only` option from the2717 command line). This setting overrides `merge.ff` when pulling.27182719pull.rebase::2720 When true, rebase branches on top of the fetched branch, instead2721 of merging the default branch from the default remote when "git2722 pull" is run. See "branch.<name>.rebase" for setting this on a2723 per-branch basis.2724+2725When `merges`, pass the `--rebase-merges` option to 'git rebase'2726so that the local merge commits are included in the rebase (see2727linkgit:git-rebase[1] for details).2728+2729When preserve, also pass `--preserve-merges` along to 'git rebase'2730so that locally committed merge commits will not be flattened2731by running 'git pull'.2732+2733When the value is `interactive`, the rebase is run in interactive mode.2734+2735*NOTE*: this is a possibly dangerous operation; do *not* use2736it unless you understand the implications (see linkgit:git-rebase[1]2737for details).27382739pull.octopus::2740 The default merge strategy to use when pulling multiple branches2741 at once.27422743pull.twohead::2744 The default merge strategy to use when pulling a single branch.27452746push.default::2747 Defines the action `git push` should take if no refspec is2748 explicitly given. Different values are well-suited for2749 specific workflows; for instance, in a purely central workflow2750 (i.e. the fetch source is equal to the push destination),2751 `upstream` is probably what you want. Possible values are:2752+2753--27542755* `nothing` - do not push anything (error out) unless a refspec is2756 explicitly given. This is primarily meant for people who want to2757 avoid mistakes by always being explicit.27582759* `current` - push the current branch to update a branch with the same2760 name on the receiving end. Works in both central and non-central2761 workflows.27622763* `upstream` - push the current branch back to the branch whose2764 changes are usually integrated into the current branch (which is2765 called `@{upstream}`). This mode only makes sense if you are2766 pushing to the same repository you would normally pull from2767 (i.e. central workflow).27682769* `tracking` - This is a deprecated synonym for `upstream`.27702771* `simple` - in centralized workflow, work like `upstream` with an2772 added safety to refuse to push if the upstream branch's name is2773 different from the local one.2774+2775When pushing to a remote that is different from the remote you normally2776pull from, work as `current`. This is the safest option and is suited2777for beginners.2778+2779This mode has become the default in Git 2.0.27802781* `matching` - push all branches having the same name on both ends.2782 This makes the repository you are pushing to remember the set of2783 branches that will be pushed out (e.g. if you always push 'maint'2784 and 'master' there and no other branches, the repository you push2785 to will have these two branches, and your local 'maint' and2786 'master' will be pushed there).2787+2788To use this mode effectively, you have to make sure _all_ the2789branches you would push out are ready to be pushed out before2790running 'git push', as the whole point of this mode is to allow you2791to push all of the branches in one go. If you usually finish work2792on only one branch and push out the result, while other branches are2793unfinished, this mode is not for you. Also this mode is not2794suitable for pushing into a shared central repository, as other2795people may add new branches there, or update the tip of existing2796branches outside your control.2797+2798This used to be the default, but not since Git 2.0 (`simple` is the2799new default).28002801--28022803push.followTags::2804 If set to true enable `--follow-tags` option by default. You2805 may override this configuration at time of push by specifying2806 `--no-follow-tags`.28072808push.gpgSign::2809 May be set to a boolean value, or the string 'if-asked'. A true2810 value causes all pushes to be GPG signed, as if `--signed` is2811 passed to linkgit:git-push[1]. The string 'if-asked' causes2812 pushes to be signed if the server supports it, as if2813 `--signed=if-asked` is passed to 'git push'. A false value may2814 override a value from a lower-priority config file. An explicit2815 command-line flag always overrides this config option.28162817push.pushOption::2818 When no `--push-option=<option>` argument is given from the2819 command line, `git push` behaves as if each <value> of2820 this variable is given as `--push-option=<value>`.2821+2822This is a multi-valued variable, and an empty value can be used in a2823higher priority configuration file (e.g. `.git/config` in a2824repository) to clear the values inherited from a lower priority2825configuration files (e.g. `$HOME/.gitconfig`).2826+2827--28282829Example:28302831/etc/gitconfig2832 push.pushoption = a2833 push.pushoption = b28342835~/.gitconfig2836 push.pushoption = c28372838repo/.git/config2839 push.pushoption =2840 push.pushoption = b28412842This will result in only b (a and c are cleared).28432844--28452846push.recurseSubmodules::2847 Make sure all submodule commits used by the revisions to be pushed2848 are available on a remote-tracking branch. If the value is 'check'2849 then Git will verify that all submodule commits that changed in the2850 revisions to be pushed are available on at least one remote of the2851 submodule. If any commits are missing, the push will be aborted and2852 exit with non-zero status. If the value is 'on-demand' then all2853 submodules that changed in the revisions to be pushed will be2854 pushed. If on-demand was not able to push all necessary revisions2855 it will also be aborted and exit with non-zero status. If the value2856 is 'no' then default behavior of ignoring submodules when pushing2857 is retained. You may override this configuration at time of push by2858 specifying '--recurse-submodules=check|on-demand|no'.28592860include::rebase-config.txt[]28612862receive.advertiseAtomic::2863 By default, git-receive-pack will advertise the atomic push2864 capability to its clients. If you don't want to advertise this2865 capability, set this variable to false.28662867receive.advertisePushOptions::2868 When set to true, git-receive-pack will advertise the push options2869 capability to its clients. False by default.28702871receive.autogc::2872 By default, git-receive-pack will run "git-gc --auto" after2873 receiving data from git-push and updating refs. You can stop2874 it by setting this variable to false.28752876receive.certNonceSeed::2877 By setting this variable to a string, `git receive-pack`2878 will accept a `git push --signed` and verifies it by using2879 a "nonce" protected by HMAC using this string as a secret2880 key.28812882receive.certNonceSlop::2883 When a `git push --signed` sent a push certificate with a2884 "nonce" that was issued by a receive-pack serving the same2885 repository within this many seconds, export the "nonce"2886 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2887 hooks (instead of what the receive-pack asked the sending2888 side to include). This may allow writing checks in2889 `pre-receive` and `post-receive` a bit easier. Instead of2890 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2891 that records by how many seconds the nonce is stale to2892 decide if they want to accept the certificate, they only2893 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28942895receive.fsckObjects::2896 If it is set to true, git-receive-pack will check all received2897 objects. It will abort in the case of a malformed object or a2898 broken link. The result of an abort are only dangling objects.2899 Defaults to false. If not set, the value of `transfer.fsckObjects`2900 is used instead.29012902receive.fsck.<msg-id>::2903 When `receive.fsckObjects` is set to true, errors can be switched2904 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2905 setting where the `<msg-id>` is the fsck message ID and the value2906 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2907 the error/warning with the message ID, e.g. "missingEmail: invalid2908 author/committer line - missing email" means that setting2909 `receive.fsck.missingEmail = ignore` will hide that issue.2910+2911This feature is intended to support working with legacy repositories2912which would not pass pushing when `receive.fsckObjects = true`, allowing2913the host to accept repositories with certain known issues but still catch2914other issues.29152916receive.fsck.skipList::2917 The path to a sorted list of object names (i.e. one SHA-1 per2918 line) that are known to be broken in a non-fatal way and should2919 be ignored. This feature is useful when an established project2920 should be accepted despite early commits containing errors that2921 can be safely ignored such as invalid committer email addresses.2922 Note: corrupt objects cannot be skipped with this setting.29232924receive.keepAlive::2925 After receiving the pack from the client, `receive-pack` may2926 produce no output (if `--quiet` was specified) while processing2927 the pack, causing some networks to drop the TCP connection.2928 With this option set, if `receive-pack` does not transmit2929 any data in this phase for `receive.keepAlive` seconds, it will2930 send a short keepalive packet. The default is 5 seconds; set2931 to 0 to disable keepalives entirely.29322933receive.unpackLimit::2934 If the number of objects received in a push is below this2935 limit then the objects will be unpacked into loose object2936 files. However if the number of received objects equals or2937 exceeds this limit then the received pack will be stored as2938 a pack, after adding any missing delta bases. Storing the2939 pack from a push can make the push operation complete faster,2940 especially on slow filesystems. If not set, the value of2941 `transfer.unpackLimit` is used instead.29422943receive.maxInputSize::2944 If the size of the incoming pack stream is larger than this2945 limit, then git-receive-pack will error out, instead of2946 accepting the pack file. If not set or set to 0, then the size2947 is unlimited.29482949receive.denyDeletes::2950 If set to true, git-receive-pack will deny a ref update that deletes2951 the ref. Use this to prevent such a ref deletion via a push.29522953receive.denyDeleteCurrent::2954 If set to true, git-receive-pack will deny a ref update that2955 deletes the currently checked out branch of a non-bare repository.29562957receive.denyCurrentBranch::2958 If set to true or "refuse", git-receive-pack will deny a ref update2959 to the currently checked out branch of a non-bare repository.2960 Such a push is potentially dangerous because it brings the HEAD2961 out of sync with the index and working tree. If set to "warn",2962 print a warning of such a push to stderr, but allow the push to2963 proceed. If set to false or "ignore", allow such pushes with no2964 message. Defaults to "refuse".2965+2966Another option is "updateInstead" which will update the working2967tree if pushing into the current branch. This option is2968intended for synchronizing working directories when one side is not easily2969accessible via interactive ssh (e.g. a live web site, hence the requirement2970that the working directory be clean). This mode also comes in handy when2971developing inside a VM to test and fix code on different Operating Systems.2972+2973By default, "updateInstead" will refuse the push if the working tree or2974the index have any difference from the HEAD, but the `push-to-checkout`2975hook can be used to customize this. See linkgit:githooks[5].29762977receive.denyNonFastForwards::2978 If set to true, git-receive-pack will deny a ref update which is2979 not a fast-forward. Use this to prevent such an update via a push,2980 even if that push is forced. This configuration variable is2981 set when initializing a shared repository.29822983receive.hideRefs::2984 This variable is the same as `transfer.hideRefs`, but applies2985 only to `receive-pack` (and so affects pushes, but not fetches).2986 An attempt to update or delete a hidden ref by `git push` is2987 rejected.29882989receive.updateServerInfo::2990 If set to true, git-receive-pack will run git-update-server-info2991 after receiving data from git-push and updating refs.29922993receive.shallowUpdate::2994 If set to true, .git/shallow can be updated when new refs2995 require new shallow roots. Otherwise those refs are rejected.29962997remote.pushDefault::2998 The remote to push to by default. Overrides2999 `branch.<name>.remote` for all branches, and is overridden by3000 `branch.<name>.pushRemote` for specific branches.30013002remote.<name>.url::3003 The URL of a remote repository. See linkgit:git-fetch[1] or3004 linkgit:git-push[1].30053006remote.<name>.pushurl::3007 The push URL of a remote repository. See linkgit:git-push[1].30083009remote.<name>.proxy::3010 For remotes that require curl (http, https and ftp), the URL to3011 the proxy to use for that remote. Set to the empty string to3012 disable proxying for that remote.30133014remote.<name>.proxyAuthMethod::3015 For remotes that require curl (http, https and ftp), the method to use for3016 authenticating against the proxy in use (probably set in3017 `remote.<name>.proxy`). See `http.proxyAuthMethod`.30183019remote.<name>.fetch::3020 The default set of "refspec" for linkgit:git-fetch[1]. See3021 linkgit:git-fetch[1].30223023remote.<name>.push::3024 The default set of "refspec" for linkgit:git-push[1]. See3025 linkgit:git-push[1].30263027remote.<name>.mirror::3028 If true, pushing to this remote will automatically behave3029 as if the `--mirror` option was given on the command line.30303031remote.<name>.skipDefaultUpdate::3032 If true, this remote will be skipped by default when updating3033 using linkgit:git-fetch[1] or the `update` subcommand of3034 linkgit:git-remote[1].30353036remote.<name>.skipFetchAll::3037 If true, this remote will be skipped by default when updating3038 using linkgit:git-fetch[1] or the `update` subcommand of3039 linkgit:git-remote[1].30403041remote.<name>.receivepack::3042 The default program to execute on the remote side when pushing. See3043 option --receive-pack of linkgit:git-push[1].30443045remote.<name>.uploadpack::3046 The default program to execute on the remote side when fetching. See3047 option --upload-pack of linkgit:git-fetch-pack[1].30483049remote.<name>.tagOpt::3050 Setting this value to --no-tags disables automatic tag following when3051 fetching from remote <name>. Setting it to --tags will fetch every3052 tag from remote <name>, even if they are not reachable from remote3053 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3054 override this setting. See options --tags and --no-tags of3055 linkgit:git-fetch[1].30563057remote.<name>.vcs::3058 Setting this to a value <vcs> will cause Git to interact with3059 the remote with the git-remote-<vcs> helper.30603061remote.<name>.prune::3062 When set to true, fetching from this remote by default will also3063 remove any remote-tracking references that no longer exist on the3064 remote (as if the `--prune` option was given on the command line).3065 Overrides `fetch.prune` settings, if any.30663067remote.<name>.pruneTags::3068 When set to true, fetching from this remote by default will also3069 remove any local tags that no longer exist on the remote if pruning3070 is activated in general via `remote.<name>.prune`, `fetch.prune` or3071 `--prune`. Overrides `fetch.pruneTags` settings, if any.3072+3073See also `remote.<name>.prune` and the PRUNING section of3074linkgit:git-fetch[1].30753076remotes.<group>::3077 The list of remotes which are fetched by "git remote update3078 <group>". See linkgit:git-remote[1].30793080repack.useDeltaBaseOffset::3081 By default, linkgit:git-repack[1] creates packs that use3082 delta-base offset. If you need to share your repository with3083 Git older than version 1.4.4, either directly or via a dumb3084 protocol such as http, then you need to set this option to3085 "false" and repack. Access from old Git versions over the3086 native protocol are unaffected by this option.30873088repack.packKeptObjects::3089 If set to true, makes `git repack` act as if3090 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3091 details. Defaults to `false` normally, but `true` if a bitmap3092 index is being written (either via `--write-bitmap-index` or3093 `repack.writeBitmaps`).30943095repack.writeBitmaps::3096 When true, git will write a bitmap index when packing all3097 objects to disk (e.g., when `git repack -a` is run). This3098 index can speed up the "counting objects" phase of subsequent3099 packs created for clones and fetches, at the cost of some disk3100 space and extra time spent on the initial repack. This has3101 no effect if multiple packfiles are created.3102 Defaults to false.31033104rerere.autoUpdate::3105 When set to true, `git-rerere` updates the index with the3106 resulting contents after it cleanly resolves conflicts using3107 previously recorded resolution. Defaults to false.31083109rerere.enabled::3110 Activate recording of resolved conflicts, so that identical3111 conflict hunks can be resolved automatically, should they be3112 encountered again. By default, linkgit:git-rerere[1] is3113 enabled if there is an `rr-cache` directory under the3114 `$GIT_DIR`, e.g. if "rerere" was previously used in the3115 repository.31163117sendemail.identity::3118 A configuration identity. When given, causes values in the3119 'sendemail.<identity>' subsection to take precedence over3120 values in the 'sendemail' section. The default identity is3121 the value of `sendemail.identity`.31223123sendemail.smtpEncryption::3124 See linkgit:git-send-email[1] for description. Note that this3125 setting is not subject to the 'identity' mechanism.31263127sendemail.smtpssl (deprecated)::3128 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31293130sendemail.smtpsslcertpath::3131 Path to ca-certificates (either a directory or a single file).3132 Set it to an empty string to disable certificate verification.31333134sendemail.<identity>.*::3135 Identity-specific versions of the 'sendemail.*' parameters3136 found below, taking precedence over those when this3137 identity is selected, through either the command-line or3138 `sendemail.identity`.31393140sendemail.aliasesFile::3141sendemail.aliasFileType::3142sendemail.annotate::3143sendemail.bcc::3144sendemail.cc::3145sendemail.ccCmd::3146sendemail.chainReplyTo::3147sendemail.confirm::3148sendemail.envelopeSender::3149sendemail.from::3150sendemail.multiEdit::3151sendemail.signedoffbycc::3152sendemail.smtpPass::3153sendemail.suppresscc::3154sendemail.suppressFrom::3155sendemail.to::3156sendemail.tocmd::3157sendemail.smtpDomain::3158sendemail.smtpServer::3159sendemail.smtpServerPort::3160sendemail.smtpServerOption::3161sendemail.smtpUser::3162sendemail.thread::3163sendemail.transferEncoding::3164sendemail.validate::3165sendemail.xmailer::3166 See linkgit:git-send-email[1] for description.31673168sendemail.signedoffcc (deprecated)::3169 Deprecated alias for `sendemail.signedoffbycc`.31703171sendemail.smtpBatchSize::3172 Number of messages to be sent per connection, after that a relogin3173 will happen. If the value is 0 or undefined, send all messages in3174 one connection.3175 See also the `--batch-size` option of linkgit:git-send-email[1].31763177sendemail.smtpReloginDelay::3178 Seconds wait before reconnecting to smtp server.3179 See also the `--relogin-delay` option of linkgit:git-send-email[1].31803181showbranch.default::3182 The default set of branches for linkgit:git-show-branch[1].3183 See linkgit:git-show-branch[1].31843185splitIndex.maxPercentChange::3186 When the split index feature is used, this specifies the3187 percent of entries the split index can contain compared to the3188 total number of entries in both the split index and the shared3189 index before a new shared index is written.3190 The value should be between 0 and 100. If the value is 0 then3191 a new shared index is always written, if it is 100 a new3192 shared index is never written.3193 By default the value is 20, so a new shared index is written3194 if the number of entries in the split index would be greater3195 than 20 percent of the total number of entries.3196 See linkgit:git-update-index[1].31973198splitIndex.sharedIndexExpire::3199 When the split index feature is used, shared index files that3200 were not modified since the time this variable specifies will3201 be removed when a new shared index file is created. The value3202 "now" expires all entries immediately, and "never" suppresses3203 expiration altogether.3204 The default value is "2.weeks.ago".3205 Note that a shared index file is considered modified (for the3206 purpose of expiration) each time a new split-index file is3207 either created based on it or read from it.3208 See linkgit:git-update-index[1].32093210status.relativePaths::3211 By default, linkgit:git-status[1] shows paths relative to the3212 current directory. Setting this variable to `false` shows paths3213 relative to the repository root (this was the default for Git3214 prior to v1.5.4).32153216status.short::3217 Set to true to enable --short by default in linkgit:git-status[1].3218 The option --no-short takes precedence over this variable.32193220status.branch::3221 Set to true to enable --branch by default in linkgit:git-status[1].3222 The option --no-branch takes precedence over this variable.32233224status.displayCommentPrefix::3225 If set to true, linkgit:git-status[1] will insert a comment3226 prefix before each output line (starting with3227 `core.commentChar`, i.e. `#` by default). This was the3228 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3229 Defaults to false.32303231status.renameLimit::3232 The number of files to consider when performing rename detection3233 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3234 the value of diff.renameLimit.32353236status.renames::3237 Whether and how Git detects renames in linkgit:git-status[1] and3238 linkgit:git-commit[1] . If set to "false", rename detection is3239 disabled. If set to "true", basic rename detection is enabled.3240 If set to "copies" or "copy", Git will detect copies, as well.3241 Defaults to the value of diff.renames.32423243status.showStash::3244 If set to true, linkgit:git-status[1] will display the number of3245 entries currently stashed away.3246 Defaults to false.32473248status.showUntrackedFiles::3249 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3250 files which are not currently tracked by Git. Directories which3251 contain only untracked files, are shown with the directory name3252 only. Showing untracked files means that Git needs to lstat() all3253 the files in the whole repository, which might be slow on some3254 systems. So, this variable controls how the commands displays3255 the untracked files. Possible values are:3256+3257--3258* `no` - Show no untracked files.3259* `normal` - Show untracked files and directories.3260* `all` - Show also individual files in untracked directories.3261--3262+3263If this variable is not specified, it defaults to 'normal'.3264This variable can be overridden with the -u|--untracked-files option3265of linkgit:git-status[1] and linkgit:git-commit[1].32663267status.submoduleSummary::3268 Defaults to false.3269 If this is set to a non zero number or true (identical to -1 or an3270 unlimited number), the submodule summary will be enabled and a3271 summary of commits for modified submodules will be shown (see3272 --summary-limit option of linkgit:git-submodule[1]). Please note3273 that the summary output command will be suppressed for all3274 submodules when `diff.ignoreSubmodules` is set to 'all' or only3275 for those submodules where `submodule.<name>.ignore=all`. The only3276 exception to that rule is that status and commit will show staged3277 submodule changes. To3278 also view the summary for ignored submodules you can either use3279 the --ignore-submodules=dirty command-line option or the 'git3280 submodule summary' command, which shows a similar output but does3281 not honor these settings.32823283stash.showPatch::3284 If this is set to true, the `git stash show` command without an3285 option will show the stash entry in patch form. Defaults to false.3286 See description of 'show' command in linkgit:git-stash[1].32873288stash.showStat::3289 If this is set to true, the `git stash show` command without an3290 option will show diffstat of the stash entry. Defaults to true.3291 See description of 'show' command in linkgit:git-stash[1].32923293submodule.<name>.url::3294 The URL for a submodule. This variable is copied from the .gitmodules3295 file to the git config via 'git submodule init'. The user can change3296 the configured URL before obtaining the submodule via 'git submodule3297 update'. If neither submodule.<name>.active or submodule.active are3298 set, the presence of this variable is used as a fallback to indicate3299 whether the submodule is of interest to git commands.3300 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.33013302submodule.<name>.update::3303 The method by which a submodule is updated by 'git submodule update',3304 which is the only affected command, others such as3305 'git checkout --recurse-submodules' are unaffected. It exists for3306 historical reasons, when 'git submodule' was the only command to3307 interact with submodules; settings like `submodule.active`3308 and `pull.rebase` are more specific. It is populated by3309 `git submodule init` from the linkgit:gitmodules[5] file.3310 See description of 'update' command in linkgit:git-submodule[1].33113312submodule.<name>.branch::3313 The remote branch name for a submodule, used by `git submodule3314 update --remote`. Set this option to override the value found in3315 the `.gitmodules` file. See linkgit:git-submodule[1] and3316 linkgit:gitmodules[5] for details.33173318submodule.<name>.fetchRecurseSubmodules::3319 This option can be used to control recursive fetching of this3320 submodule. It can be overridden by using the --[no-]recurse-submodules3321 command-line option to "git fetch" and "git pull".3322 This setting will override that from in the linkgit:gitmodules[5]3323 file.33243325submodule.<name>.ignore::3326 Defines under what circumstances "git status" and the diff family show3327 a submodule as modified. When set to "all", it will never be considered3328 modified (but it will nonetheless show up in the output of status and3329 commit when it has been staged), "dirty" will ignore all changes3330 to the submodules work tree and3331 takes only differences between the HEAD of the submodule and the commit3332 recorded in the superproject into account. "untracked" will additionally3333 let submodules with modified tracked files in their work tree show up.3334 Using "none" (the default when this option is not set) also shows3335 submodules that have untracked files in their work tree as changed.3336 This setting overrides any setting made in .gitmodules for this submodule,3337 both settings can be overridden on the command line by using the3338 "--ignore-submodules" option. The 'git submodule' commands are not3339 affected by this setting.33403341submodule.<name>.active::3342 Boolean value indicating if the submodule is of interest to git3343 commands. This config option takes precedence over the3344 submodule.active config option. See linkgit:gitsubmodules[7] for3345 details.33463347submodule.active::3348 A repeated field which contains a pathspec used to match against a3349 submodule's path to determine if the submodule is of interest to git3350 commands. See linkgit:gitsubmodules[7] for details.33513352submodule.recurse::3353 Specifies if commands recurse into submodules by default. This3354 applies to all commands that have a `--recurse-submodules` option,3355 except `clone`.3356 Defaults to false.33573358submodule.fetchJobs::3359 Specifies how many submodules are fetched/cloned at the same time.3360 A positive integer allows up to that number of submodules fetched3361 in parallel. A value of 0 will give some reasonable default.3362 If unset, it defaults to 1.33633364submodule.alternateLocation::3365 Specifies how the submodules obtain alternates when submodules are3366 cloned. Possible values are `no`, `superproject`.3367 By default `no` is assumed, which doesn't add references. When the3368 value is set to `superproject` the submodule to be cloned computes3369 its alternates location relative to the superprojects alternate.33703371submodule.alternateErrorStrategy::3372 Specifies how to treat errors with the alternates for a submodule3373 as computed via `submodule.alternateLocation`. Possible values are3374 `ignore`, `info`, `die`. Default is `die`.33753376tag.forceSignAnnotated::3377 A boolean to specify whether annotated tags created should be GPG signed.3378 If `--annotate` is specified on the command line, it takes3379 precedence over this option.33803381tag.sort::3382 This variable controls the sort ordering of tags when displayed by3383 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3384 value of this variable will be used as the default.33853386tar.umask::3387 This variable can be used to restrict the permission bits of3388 tar archive entries. The default is 0002, which turns off the3389 world write bit. The special value "user" indicates that the3390 archiving user's umask will be used instead. See umask(2) and3391 linkgit:git-archive[1].33923393transfer.fsckObjects::3394 When `fetch.fsckObjects` or `receive.fsckObjects` are3395 not set, the value of this variable is used instead.3396 Defaults to false.33973398transfer.hideRefs::3399 String(s) `receive-pack` and `upload-pack` use to decide which3400 refs to omit from their initial advertisements. Use more than3401 one definition to specify multiple prefix strings. A ref that is3402 under the hierarchies listed in the value of this variable is3403 excluded, and is hidden when responding to `git push` or `git3404 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3405 program-specific versions of this config.3406+3407You may also include a `!` in front of the ref name to negate the entry,3408explicitly exposing it, even if an earlier entry marked it as hidden.3409If you have multiple hideRefs values, later entries override earlier ones3410(and entries in more-specific config files override less-specific ones).3411+3412If a namespace is in use, the namespace prefix is stripped from each3413reference before it is matched against `transfer.hiderefs` patterns.3414For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3415the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3416is omitted from the advertisements but `refs/heads/master` and3417`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3418"have" lines. In order to match refs before stripping, add a `^` in front of3419the ref name. If you combine `!` and `^`, `!` must be specified first.3420+3421Even if you hide refs, a client may still be able to steal the target3422objects via the techniques described in the "SECURITY" section of the3423linkgit:gitnamespaces[7] man page; it's best to keep private data in a3424separate repository.34253426transfer.unpackLimit::3427 When `fetch.unpackLimit` or `receive.unpackLimit` are3428 not set, the value of this variable is used instead.3429 The default value is 100.34303431uploadarchive.allowUnreachable::3432 If true, allow clients to use `git archive --remote` to request3433 any tree, whether reachable from the ref tips or not. See the3434 discussion in the "SECURITY" section of3435 linkgit:git-upload-archive[1] for more details. Defaults to3436 `false`.34373438uploadpack.hideRefs::3439 This variable is the same as `transfer.hideRefs`, but applies3440 only to `upload-pack` (and so affects only fetches, not pushes).3441 An attempt to fetch a hidden ref by `git fetch` will fail. See3442 also `uploadpack.allowTipSHA1InWant`.34433444uploadpack.allowTipSHA1InWant::3445 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3446 to accept a fetch request that asks for an object at the tip3447 of a hidden ref (by default, such a request is rejected).3448 See also `uploadpack.hideRefs`. Even if this is false, a client3449 may be able to steal objects via the techniques described in the3450 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3451 best to keep private data in a separate repository.34523453uploadpack.allowReachableSHA1InWant::3454 Allow `upload-pack` to accept a fetch request that asks for an3455 object that is reachable from any ref tip. However, note that3456 calculating object reachability is computationally expensive.3457 Defaults to `false`. Even if this is false, a client may be able3458 to steal objects via the techniques described in the "SECURITY"3459 section of the linkgit:gitnamespaces[7] man page; it's best to3460 keep private data in a separate repository.34613462uploadpack.allowAnySHA1InWant::3463 Allow `upload-pack` to accept a fetch request that asks for any3464 object at all.3465 Defaults to `false`.34663467uploadpack.keepAlive::3468 When `upload-pack` has started `pack-objects`, there may be a3469 quiet period while `pack-objects` prepares the pack. Normally3470 it would output progress information, but if `--quiet` was used3471 for the fetch, `pack-objects` will output nothing at all until3472 the pack data begins. Some clients and networks may consider3473 the server to be hung and give up. Setting this option instructs3474 `upload-pack` to send an empty keepalive packet every3475 `uploadpack.keepAlive` seconds. Setting this option to 03476 disables keepalive packets entirely. The default is 5 seconds.34773478uploadpack.packObjectsHook::3479 If this option is set, when `upload-pack` would run3480 `git pack-objects` to create a packfile for a client, it will3481 run this shell command instead. The `pack-objects` command and3482 arguments it _would_ have run (including the `git pack-objects`3483 at the beginning) are appended to the shell command. The stdin3484 and stdout of the hook are treated as if `pack-objects` itself3485 was run. I.e., `upload-pack` will feed input intended for3486 `pack-objects` to the hook, and expects a completed packfile on3487 stdout.34883489uploadpack.allowFilter::3490 If this option is set, `upload-pack` will support partial3491 clone and partial fetch object filtering.3492+3493Note that this configuration variable is ignored if it is seen in the3494repository-level config (this is a safety measure against fetching from3495untrusted repositories).34963497url.<base>.insteadOf::3498 Any URL that starts with this value will be rewritten to3499 start, instead, with <base>. In cases where some site serves a3500 large number of repositories, and serves them with multiple3501 access methods, and some users need to use different access3502 methods, this feature allows people to specify any of the3503 equivalent URLs and have Git automatically rewrite the URL to3504 the best alternative for the particular user, even for a3505 never-before-seen repository on the site. When more than one3506 insteadOf strings match a given URL, the longest match is used.3507+3508Note that any protocol restrictions will be applied to the rewritten3509URL. If the rewrite changes the URL to use a custom protocol or remote3510helper, you may need to adjust the `protocol.*.allow` config to permit3511the request. In particular, protocols you expect to use for submodules3512must be set to `always` rather than the default of `user`. See the3513description of `protocol.allow` above.35143515url.<base>.pushInsteadOf::3516 Any URL that starts with this value will not be pushed to;3517 instead, it will be rewritten to start with <base>, and the3518 resulting URL will be pushed to. In cases where some site serves3519 a large number of repositories, and serves them with multiple3520 access methods, some of which do not allow push, this feature3521 allows people to specify a pull-only URL and have Git3522 automatically use an appropriate URL to push, even for a3523 never-before-seen repository on the site. When more than one3524 pushInsteadOf strings match a given URL, the longest match is3525 used. If a remote has an explicit pushurl, Git will ignore this3526 setting for that remote.35273528user.email::3529 Your email address to be recorded in any newly created commits.3530 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3531 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35323533user.name::3534 Your full name to be recorded in any newly created commits.3535 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3536 environment variables. See linkgit:git-commit-tree[1].35373538user.useConfigOnly::3539 Instruct Git to avoid trying to guess defaults for `user.email`3540 and `user.name`, and instead retrieve the values only from the3541 configuration. For example, if you have multiple email addresses3542 and would like to use a different one for each repository, then3543 with this configuration option set to `true` in the global config3544 along with a name, Git will prompt you to set up an email before3545 making new commits in a newly cloned repository.3546 Defaults to `false`.35473548user.signingKey::3549 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3550 key you want it to automatically when creating a signed tag or3551 commit, you can override the default selection with this variable.3552 This option is passed unchanged to gpg's --local-user parameter,3553 so you may specify a key using any method that gpg supports.35543555versionsort.prereleaseSuffix (deprecated)::3556 Deprecated alias for `versionsort.suffix`. Ignored if3557 `versionsort.suffix` is set.35583559versionsort.suffix::3560 Even when version sort is used in linkgit:git-tag[1], tagnames3561 with the same base version but different suffixes are still sorted3562 lexicographically, resulting e.g. in prerelease tags appearing3563 after the main release (e.g. "1.0-rc1" after "1.0"). This3564 variable can be specified to determine the sorting order of tags3565 with different suffixes.3566+3567By specifying a single suffix in this variable, any tagname containing3568that suffix will appear before the corresponding main release. E.g. if3569the variable is set to "-rc", then all "1.0-rcX" tags will appear before3570"1.0". If specified multiple times, once per suffix, then the order of3571suffixes in the configuration will determine the sorting order of tagnames3572with those suffixes. E.g. if "-pre" appears before "-rc" in the3573configuration, then all "1.0-preX" tags will be listed before any3574"1.0-rcX" tags. The placement of the main release tag relative to tags3575with various suffixes can be determined by specifying the empty suffix3576among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3577"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3578are listed first, followed by "v4.8", then "v4.8-ckX" and finally3579"v4.8-bfsX".3580+3581If more than one suffixes match the same tagname, then that tagname will3582be sorted according to the suffix which starts at the earliest position in3583the tagname. If more than one different matching suffixes start at3584that earliest position, then that tagname will be sorted according to the3585longest of those suffixes.3586The sorting order between different suffixes is undefined if they are3587in multiple config files.35883589web.browser::3590 Specify a web browser that may be used by some commands.3591 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3592 may use it.35933594worktree.guessRemote::3595 With `add`, if no branch argument, and neither of `-b` nor3596 `-B` nor `--detach` are given, the command defaults to3597 creating a new branch from HEAD. If `worktree.guessRemote` is3598 set to true, `worktree add` tries to find a remote-tracking3599 branch whose name uniquely matches the new branch name. If3600 such a branch exists, it is checked out and set as "upstream"3601 for the new branch. If no such match can be found, it falls3602 back to creating a new branch from the current HEAD.