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 910gc.commitGraph:: 911 If true, then gc will rewrite the commit-graph file when 912 linkgit:git-gc[1] is run. When using linkgit:git-gc[1] 913 '--auto' the commit-graph will be updated if housekeeping is 914 required. Default is false. See linkgit:git-commit-graph[1] 915 for details. 916 917core.sparseCheckout:: 918 Enable "sparse checkout" feature. See section "Sparse checkout" in 919 linkgit:git-read-tree[1] for more information. 920 921core.abbrev:: 922 Set the length object names are abbreviated to. If 923 unspecified or set to "auto", an appropriate value is 924 computed based on the approximate number of packed objects 925 in your repository, which hopefully is enough for 926 abbreviated object names to stay unique for some time. 927 The minimum length is 4. 928 929add.ignoreErrors:: 930add.ignore-errors (deprecated):: 931 Tells 'git add' to continue adding files when some files cannot be 932 added due to indexing errors. Equivalent to the `--ignore-errors` 933 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 934 as it does not follow the usual naming convention for configuration 935 variables. 936 937alias.*:: 938 Command aliases for the linkgit:git[1] command wrapper - e.g. 939 after defining "alias.last = cat-file commit HEAD", the invocation 940 "git last" is equivalent to "git cat-file commit HEAD". To avoid 941 confusion and troubles with script usage, aliases that 942 hide existing Git commands are ignored. Arguments are split by 943 spaces, the usual shell quoting and escaping is supported. 944 A quote pair or a backslash can be used to quote them. 945+ 946If the alias expansion is prefixed with an exclamation point, 947it will be treated as a shell command. For example, defining 948"alias.new = !gitk --all --not ORIG_HEAD", the invocation 949"git new" is equivalent to running the shell command 950"gitk --all --not ORIG_HEAD". Note that shell commands will be 951executed from the top-level directory of a repository, which may 952not necessarily be the current directory. 953`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 954from the original current directory. See linkgit:git-rev-parse[1]. 955 956am.keepcr:: 957 If true, git-am will call git-mailsplit for patches in mbox format 958 with parameter `--keep-cr`. In this case git-mailsplit will 959 not remove `\r` from lines ending with `\r\n`. Can be overridden 960 by giving `--no-keep-cr` from the command line. 961 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 962 963am.threeWay:: 964 By default, `git am` will fail if the patch does not apply cleanly. When 965 set to true, this setting tells `git am` to fall back on 3-way merge if 966 the patch records the identity of blobs it is supposed to apply to and 967 we have those blobs available locally (equivalent to giving the `--3way` 968 option from the command line). Defaults to `false`. 969 See linkgit:git-am[1]. 970 971apply.ignoreWhitespace:: 972 When set to 'change', tells 'git apply' to ignore changes in 973 whitespace, in the same way as the `--ignore-space-change` 974 option. 975 When set to one of: no, none, never, false tells 'git apply' to 976 respect all whitespace differences. 977 See linkgit:git-apply[1]. 978 979apply.whitespace:: 980 Tells 'git apply' how to handle whitespaces, in the same way 981 as the `--whitespace` option. See linkgit:git-apply[1]. 982 983blame.showRoot:: 984 Do not treat root commits as boundaries in linkgit:git-blame[1]. 985 This option defaults to false. 986 987blame.blankBoundary:: 988 Show blank commit object name for boundary commits in 989 linkgit:git-blame[1]. This option defaults to false. 990 991blame.showEmail:: 992 Show the author email instead of author name in linkgit:git-blame[1]. 993 This option defaults to false. 994 995blame.date:: 996 Specifies the format used to output dates in linkgit:git-blame[1]. 997 If unset the iso format is used. For supported values, 998 see the discussion of the `--date` option at linkgit:git-log[1]. 9991000branch.autoSetupMerge::1001 Tells 'git branch' and 'git checkout' to set up new branches1002 so that linkgit:git-pull[1] will appropriately merge from the1003 starting point branch. Note that even if this option is not set,1004 this behavior can be chosen per-branch using the `--track`1005 and `--no-track` options. The valid settings are: `false` -- no1006 automatic setup is done; `true` -- automatic setup is done when the1007 starting point is a remote-tracking branch; `always` --1008 automatic setup is done when the starting point is either a1009 local branch or remote-tracking1010 branch. This option defaults to true.10111012branch.autoSetupRebase::1013 When a new branch is created with 'git branch' or 'git checkout'1014 that tracks another branch, this variable tells Git to set1015 up pull to rebase instead of merge (see "branch.<name>.rebase").1016 When `never`, rebase is never automatically set to true.1017 When `local`, rebase is set to true for tracked branches of1018 other local branches.1019 When `remote`, rebase is set to true for tracked branches of1020 remote-tracking branches.1021 When `always`, rebase will be set to true for all tracking1022 branches.1023 See "branch.autoSetupMerge" for details on how to set up a1024 branch to track another branch.1025 This option defaults to never.10261027branch.<name>.remote::1028 When on branch <name>, it tells 'git fetch' and 'git push'1029 which remote to fetch from/push to. The remote to push to1030 may be overridden with `remote.pushDefault` (for all branches).1031 The remote to push to, for the current branch, may be further1032 overridden by `branch.<name>.pushRemote`. If no remote is1033 configured, or if you are not on any branch, it defaults to1034 `origin` for fetching and `remote.pushDefault` for pushing.1035 Additionally, `.` (a period) is the current local repository1036 (a dot-repository), see `branch.<name>.merge`'s final note below.10371038branch.<name>.pushRemote::1039 When on branch <name>, it overrides `branch.<name>.remote` for1040 pushing. It also overrides `remote.pushDefault` for pushing1041 from branch <name>. When you pull from one place (e.g. your1042 upstream) and push to another place (e.g. your own publishing1043 repository), you would want to set `remote.pushDefault` to1044 specify the remote to push to for all branches, and use this1045 option to override it for a specific branch.10461047branch.<name>.merge::1048 Defines, together with branch.<name>.remote, the upstream branch1049 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1050 branch to merge and can also affect 'git push' (see push.default).1051 When in branch <name>, it tells 'git fetch' the default1052 refspec to be marked for merging in FETCH_HEAD. The value is1053 handled like the remote part of a refspec, and must match a1054 ref which is fetched from the remote given by1055 "branch.<name>.remote".1056 The merge information is used by 'git pull' (which at first calls1057 'git fetch') to lookup the default branch for merging. Without1058 this option, 'git pull' defaults to merge the first refspec fetched.1059 Specify multiple values to get an octopus merge.1060 If you wish to setup 'git pull' so that it merges into <name> from1061 another branch in the local repository, you can point1062 branch.<name>.merge to the desired branch, and use the relative path1063 setting `.` (a period) for branch.<name>.remote.10641065branch.<name>.mergeOptions::1066 Sets default options for merging into branch <name>. The syntax and1067 supported options are the same as those of linkgit:git-merge[1], but1068 option values containing whitespace characters are currently not1069 supported.10701071branch.<name>.rebase::1072 When true, rebase the branch <name> on top of the fetched branch,1073 instead of merging the default branch from the default remote when1074 "git pull" is run. See "pull.rebase" for doing this in a non1075 branch-specific manner.1076+1077When `merges`, pass the `--rebase-merges` option to 'git rebase'1078so that the local merge commits are included in the rebase (see1079linkgit:git-rebase[1] for details).1080+1081When preserve, also pass `--preserve-merges` along to 'git rebase'1082so that locally committed merge commits will not be flattened1083by running 'git pull'.1084+1085When the value is `interactive`, the rebase is run in interactive mode.1086+1087*NOTE*: this is a possibly dangerous operation; do *not* use1088it unless you understand the implications (see linkgit:git-rebase[1]1089for details).10901091branch.<name>.description::1092 Branch description, can be edited with1093 `git branch --edit-description`. Branch description is1094 automatically added in the format-patch cover letter or1095 request-pull summary.10961097browser.<tool>.cmd::1098 Specify the command to invoke the specified browser. The1099 specified command is evaluated in shell with the URLs passed1100 as arguments. (See linkgit:git-web{litdd}browse[1].)11011102browser.<tool>.path::1103 Override the path for the given tool that may be used to1104 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1105 working repository in gitweb (see linkgit:git-instaweb[1]).11061107clean.requireForce::1108 A boolean to make git-clean do nothing unless given -f,1109 -i or -n. Defaults to true.11101111color.advice::1112 A boolean to enable/disable color in hints (e.g. when a push1113 failed, see `advice.*` for a list). May be set to `always`,1114 `false` (or `never`) or `auto` (or `true`), in which case colors1115 are used only when the error output goes to a terminal. If1116 unset, then the value of `color.ui` is used (`auto` by default).11171118color.advice.hint::1119 Use customized color for hints.11201121color.branch::1122 A boolean to enable/disable color in the output of1123 linkgit:git-branch[1]. May be set to `always`,1124 `false` (or `never`) or `auto` (or `true`), in which case colors are used1125 only when the output is to a terminal. If unset, then the1126 value of `color.ui` is used (`auto` by default).11271128color.branch.<slot>::1129 Use customized color for branch coloration. `<slot>` is one of1130 `current` (the current branch), `local` (a local branch),1131 `remote` (a remote-tracking branch in refs/remotes/),1132 `upstream` (upstream tracking branch), `plain` (other1133 refs).11341135color.diff::1136 Whether to use ANSI escape sequences to add color to patches.1137 If this is set to `always`, linkgit:git-diff[1],1138 linkgit:git-log[1], and linkgit:git-show[1] will use color1139 for all patches. If it is set to `true` or `auto`, those1140 commands will only use color when output is to the terminal.1141 If unset, then the value of `color.ui` is used (`auto` by1142 default).1143+1144This does not affect linkgit:git-format-patch[1] or the1145'git-diff-{asterisk}' plumbing commands. Can be overridden on the1146command line with the `--color[=<when>]` option.11471148diff.colorMoved::1149 If set to either a valid `<mode>` or a true value, moved lines1150 in a diff are colored differently, for details of valid modes1151 see '--color-moved' in linkgit:git-diff[1]. If simply set to1152 true the default color mode will be used. When set to false,1153 moved lines are not colored.11541155diff.colorMovedWS::1156 When moved lines are colored using e.g. the `diff.colorMoved` setting,1157 this option controls the `<mode>` how spaces are treated1158 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].11591160color.diff.<slot>::1161 Use customized color for diff colorization. `<slot>` specifies1162 which part of the patch to use the specified color, and is one1163 of `context` (context text - `plain` is a historical synonym),1164 `meta` (metainformation), `frag`1165 (hunk header), 'func' (function in hunk header), `old` (removed lines),1166 `new` (added lines), `commit` (commit headers), `whitespace`1167 (highlighting whitespace errors), `oldMoved` (deleted lines),1168 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1169 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1170 and `newMovedAlternativeDimmed` (See the '<mode>'1171 setting of '--color-moved' in linkgit:git-diff[1] for details).11721173color.decorate.<slot>::1174 Use customized color for 'git log --decorate' output. `<slot>` is one1175 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1176 branches, remote-tracking branches, tags, stash and HEAD, respectively1177 and `grafted` for grafted commits.11781179color.grep::1180 When set to `always`, always highlight matches. When `false` (or1181 `never`), never. When set to `true` or `auto`, use color only1182 when the output is written to the terminal. If unset, then the1183 value of `color.ui` is used (`auto` by default).11841185color.grep.<slot>::1186 Use customized color for grep colorization. `<slot>` specifies which1187 part of the line to use the specified color, and is one of1188+1189--1190`context`;;1191 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1192`filename`;;1193 filename prefix (when not using `-h`)1194`function`;;1195 function name lines (when using `-p`)1196`lineNumber`;;1197 line number prefix (when using `-n`)1198`column`;;1199 column number prefix (when using `--column`)1200`match`;;1201 matching text (same as setting `matchContext` and `matchSelected`)1202`matchContext`;;1203 matching text in context lines1204`matchSelected`;;1205 matching text in selected lines1206`selected`;;1207 non-matching text in selected lines1208`separator`;;1209 separators between fields on a line (`:`, `-`, and `=`)1210 and between hunks (`--`)1211--12121213color.interactive::1214 When set to `always`, always use colors for interactive prompts1215 and displays (such as those used by "git-add --interactive" and1216 "git-clean --interactive"). When false (or `never`), never.1217 When set to `true` or `auto`, use colors only when the output is1218 to the terminal. If unset, then the value of `color.ui` is1219 used (`auto` by default).12201221color.interactive.<slot>::1222 Use customized color for 'git add --interactive' and 'git clean1223 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1224 or `error`, for four distinct types of normal output from1225 interactive commands.12261227color.pager::1228 A boolean to enable/disable colored output when the pager is in1229 use (default is true).12301231color.push::1232 A boolean to enable/disable color in push errors. May be set to1233 `always`, `false` (or `never`) or `auto` (or `true`), in which1234 case colors are used only when the error output goes to a terminal.1235 If unset, then the value of `color.ui` is used (`auto` by default).12361237color.push.error::1238 Use customized color for push errors.12391240color.showBranch::1241 A boolean to enable/disable color in the output of1242 linkgit:git-show-branch[1]. May be set to `always`,1243 `false` (or `never`) or `auto` (or `true`), in which case colors are used1244 only when the output is to a terminal. If unset, then the1245 value of `color.ui` is used (`auto` by default).12461247color.status::1248 A boolean to enable/disable color in the output of1249 linkgit:git-status[1]. May be set to `always`,1250 `false` (or `never`) or `auto` (or `true`), in which case colors are used1251 only when the output is to a terminal. If unset, then the1252 value of `color.ui` is used (`auto` by default).12531254color.status.<slot>::1255 Use customized color for status colorization. `<slot>` is1256 one of `header` (the header text of the status message),1257 `added` or `updated` (files which are added but not committed),1258 `changed` (files which are changed but not added in the index),1259 `untracked` (files which are not tracked by Git),1260 `branch` (the current branch),1261 `nobranch` (the color the 'no branch' warning is shown in, defaulting1262 to red),1263 `localBranch` or `remoteBranch` (the local and remote branch names,1264 respectively, when branch and tracking information is displayed in the1265 status short-format), or1266 `unmerged` (files which have unmerged changes).12671268color.blame.repeatedLines::1269 Use the customized color for the part of git-blame output that1270 is repeated meta information per line (such as commit id,1271 author name, date and timezone). Defaults to cyan.12721273color.blame.highlightRecent::1274 This can be used to color the metadata of a blame line depending1275 on age of the line.1276+1277This setting should be set to a comma-separated list of color and date settings,1278starting and ending with a color, the dates should be set from oldest to newest.1279The metadata will be colored given the colors if the the line was introduced1280before the given timestamp, overwriting older timestamped colors.1281+1282Instead of an absolute timestamp relative timestamps work as well, e.g.12832.weeks.ago is valid to address anything older than 2 weeks.1284+1285It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1286everything older than one year blue, recent changes between one month and1287one year old are kept white, and lines introduced within the last month are1288colored red.12891290blame.coloring::1291 This determines the coloring scheme to be applied to blame1292 output. It can be 'repeatedLines', 'highlightRecent',1293 or 'none' which is the default.12941295color.transport::1296 A boolean to enable/disable color when pushes are rejected. May be1297 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1298 case colors are used only when the error output goes to a terminal.1299 If unset, then the value of `color.ui` is used (`auto` by default).13001301color.transport.rejected::1302 Use customized color when a push was rejected.13031304color.ui::1305 This variable determines the default value for variables such1306 as `color.diff` and `color.grep` that control the use of color1307 per command family. Its scope will expand as more commands learn1308 configuration to set a default for the `--color` option. Set it1309 to `false` or `never` if you prefer Git commands not to use1310 color unless enabled explicitly with some other configuration1311 or the `--color` option. Set it to `always` if you want all1312 output not intended for machine consumption to use color, to1313 `true` or `auto` (this is the default since Git 1.8.4) if you1314 want such output to use color when written to the terminal.13151316column.ui::1317 Specify whether supported commands should output in columns.1318 This variable consists of a list of tokens separated by spaces1319 or commas:1320+1321These options control when the feature should be enabled1322(defaults to 'never'):1323+1324--1325`always`;;1326 always show in columns1327`never`;;1328 never show in columns1329`auto`;;1330 show in columns if the output is to the terminal1331--1332+1333These options control layout (defaults to 'column'). Setting any1334of these implies 'always' if none of 'always', 'never', or 'auto' are1335specified.1336+1337--1338`column`;;1339 fill columns before rows1340`row`;;1341 fill rows before columns1342`plain`;;1343 show in one column1344--1345+1346Finally, these options can be combined with a layout option (defaults1347to 'nodense'):1348+1349--1350`dense`;;1351 make unequal size columns to utilize more space1352`nodense`;;1353 make equal size columns1354--13551356column.branch::1357 Specify whether to output branch listing in `git branch` in columns.1358 See `column.ui` for details.13591360column.clean::1361 Specify the layout when list items in `git clean -i`, which always1362 shows files and directories in columns. See `column.ui` for details.13631364column.status::1365 Specify whether to output untracked files in `git status` in columns.1366 See `column.ui` for details.13671368column.tag::1369 Specify whether to output tag listing in `git tag` in columns.1370 See `column.ui` for details.13711372commit.cleanup::1373 This setting overrides the default of the `--cleanup` option in1374 `git commit`. See linkgit:git-commit[1] for details. Changing the1375 default can be useful when you always want to keep lines that begin1376 with comment character `#` in your log message, in which case you1377 would do `git config commit.cleanup whitespace` (note that you will1378 have to remove the help lines that begin with `#` in the commit log1379 template yourself, if you do this).13801381commit.gpgSign::13821383 A boolean to specify whether all commits should be GPG signed.1384 Use of this option when doing operations such as rebase can1385 result in a large number of commits being signed. It may be1386 convenient to use an agent to avoid typing your GPG passphrase1387 several times.13881389commit.status::1390 A boolean to enable/disable inclusion of status information in the1391 commit message template when using an editor to prepare the commit1392 message. Defaults to true.13931394commit.template::1395 Specify the pathname of a file to use as the template for1396 new commit messages.13971398commit.verbose::1399 A boolean or int to specify the level of verbose with `git commit`.1400 See linkgit:git-commit[1].14011402credential.helper::1403 Specify an external helper to be called when a username or1404 password credential is needed; the helper may consult external1405 storage to avoid prompting the user for the credentials. Note1406 that multiple helpers may be defined. See linkgit:gitcredentials[7]1407 for details.14081409credential.useHttpPath::1410 When acquiring credentials, consider the "path" component of an http1411 or https URL to be important. Defaults to false. See1412 linkgit:gitcredentials[7] for more information.14131414credential.username::1415 If no username is set for a network authentication, use this username1416 by default. See credential.<context>.* below, and1417 linkgit:gitcredentials[7].14181419credential.<url>.*::1420 Any of the credential.* options above can be applied selectively to1421 some credentials. For example "credential.https://example.com.username"1422 would set the default username only for https connections to1423 example.com. See linkgit:gitcredentials[7] for details on how URLs are1424 matched.14251426credentialCache.ignoreSIGHUP::1427 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14281429completion.commands::1430 This is only used by git-completion.bash to add or remove1431 commands from the list of completed commands. Normally only1432 porcelain commands and a few select others are completed. You1433 can add more commands, separated by space, in this1434 variable. Prefixing the command with '-' will remove it from1435 the existing list.14361437include::diff-config.txt[]14381439difftool.<tool>.path::1440 Override the path for the given tool. This is useful in case1441 your tool is not in the PATH.14421443difftool.<tool>.cmd::1444 Specify the command to invoke the specified diff tool.1445 The specified command is evaluated in shell with the following1446 variables available: 'LOCAL' is set to the name of the temporary1447 file containing the contents of the diff pre-image and 'REMOTE'1448 is set to the name of the temporary file containing the contents1449 of the diff post-image.14501451difftool.prompt::1452 Prompt before each invocation of the diff tool.14531454fastimport.unpackLimit::1455 If the number of objects imported by linkgit:git-fast-import[1]1456 is below this limit, then the objects will be unpacked into1457 loose object files. However if the number of imported objects1458 equals or exceeds this limit then the pack will be stored as a1459 pack. Storing the pack from a fast-import can make the import1460 operation complete faster, especially on slow filesystems. If1461 not set, the value of `transfer.unpackLimit` is used instead.14621463fetch.recurseSubmodules::1464 This option can be either set to a boolean value or to 'on-demand'.1465 Setting it to a boolean changes the behavior of fetch and pull to1466 unconditionally recurse into submodules when set to true or to not1467 recurse at all when set to false. When set to 'on-demand' (the default1468 value), fetch and pull will only recurse into a populated submodule1469 when its superproject retrieves a commit that updates the submodule's1470 reference.14711472fetch.fsckObjects::1473 If it is set to true, git-fetch-pack will check all fetched1474 objects. It will abort in the case of a malformed object or a1475 broken link. The result of an abort are only dangling objects.1476 Defaults to false. If not set, the value of `transfer.fsckObjects`1477 is used instead.14781479fetch.unpackLimit::1480 If the number of objects fetched over the Git native1481 transfer is below this1482 limit, then the objects will be unpacked into loose object1483 files. However if the number of received objects equals or1484 exceeds this limit then the received pack will be stored as1485 a pack, after adding any missing delta bases. Storing the1486 pack from a push can make the push operation complete faster,1487 especially on slow filesystems. If not set, the value of1488 `transfer.unpackLimit` is used instead.14891490fetch.prune::1491 If true, fetch will automatically behave as if the `--prune`1492 option was given on the command line. See also `remote.<name>.prune`1493 and the PRUNING section of linkgit:git-fetch[1].14941495fetch.pruneTags::1496 If true, fetch will automatically behave as if the1497 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1498 if not set already. This allows for setting both this option1499 and `fetch.prune` to maintain a 1=1 mapping to upstream1500 refs. See also `remote.<name>.pruneTags` and the PRUNING1501 section of linkgit:git-fetch[1].15021503fetch.output::1504 Control how ref update status is printed. Valid values are1505 `full` and `compact`. Default value is `full`. See section1506 OUTPUT in linkgit:git-fetch[1] for detail.15071508format.attach::1509 Enable multipart/mixed attachments as the default for1510 'format-patch'. The value can also be a double quoted string1511 which will enable attachments as the default and set the1512 value as the boundary. See the --attach option in1513 linkgit:git-format-patch[1].15141515format.from::1516 Provides the default value for the `--from` option to format-patch.1517 Accepts a boolean value, or a name and email address. If false,1518 format-patch defaults to `--no-from`, using commit authors directly in1519 the "From:" field of patch mails. If true, format-patch defaults to1520 `--from`, using your committer identity in the "From:" field of patch1521 mails and including a "From:" field in the body of the patch mail if1522 different. If set to a non-boolean value, format-patch uses that1523 value instead of your committer identity. Defaults to false.15241525format.numbered::1526 A boolean which can enable or disable sequence numbers in patch1527 subjects. It defaults to "auto" which enables it only if there1528 is more than one patch. It can be enabled or disabled for all1529 messages by setting it to "true" or "false". See --numbered1530 option in linkgit:git-format-patch[1].15311532format.headers::1533 Additional email headers to include in a patch to be submitted1534 by mail. See linkgit:git-format-patch[1].15351536format.to::1537format.cc::1538 Additional recipients to include in a patch to be submitted1539 by mail. See the --to and --cc options in1540 linkgit:git-format-patch[1].15411542format.subjectPrefix::1543 The default for format-patch is to output files with the '[PATCH]'1544 subject prefix. Use this variable to change that prefix.15451546format.signature::1547 The default for format-patch is to output a signature containing1548 the Git version number. Use this variable to change that default.1549 Set this variable to the empty string ("") to suppress1550 signature generation.15511552format.signatureFile::1553 Works just like format.signature except the contents of the1554 file specified by this variable will be used as the signature.15551556format.suffix::1557 The default for format-patch is to output files with the suffix1558 `.patch`. Use this variable to change that suffix (make sure to1559 include the dot if you want it).15601561format.pretty::1562 The default pretty format for log/show/whatchanged command,1563 See linkgit:git-log[1], linkgit:git-show[1],1564 linkgit:git-whatchanged[1].15651566format.thread::1567 The default threading style for 'git format-patch'. Can be1568 a boolean value, or `shallow` or `deep`. `shallow` threading1569 makes every mail a reply to the head of the series,1570 where the head is chosen from the cover letter, the1571 `--in-reply-to`, and the first patch mail, in this order.1572 `deep` threading makes every mail a reply to the previous one.1573 A true boolean value is the same as `shallow`, and a false1574 value disables threading.15751576format.signOff::1577 A boolean value which lets you enable the `-s/--signoff` option of1578 format-patch by default. *Note:* Adding the Signed-off-by: line to a1579 patch should be a conscious act and means that you certify you have1580 the rights to submit this work under the same open source license.1581 Please see the 'SubmittingPatches' document for further discussion.15821583format.coverLetter::1584 A boolean that controls whether to generate a cover-letter when1585 format-patch is invoked, but in addition can be set to "auto", to1586 generate a cover-letter only when there's more than one patch.15871588format.outputDirectory::1589 Set a custom directory to store the resulting files instead of the1590 current working directory.15911592format.useAutoBase::1593 A boolean value which lets you enable the `--base=auto` option of1594 format-patch by default.15951596filter.<driver>.clean::1597 The command which is used to convert the content of a worktree1598 file to a blob upon checkin. See linkgit:gitattributes[5] for1599 details.16001601filter.<driver>.smudge::1602 The command which is used to convert the content of a blob1603 object to a worktree file upon checkout. See1604 linkgit:gitattributes[5] for details.16051606fsck.<msg-id>::1607 Allows overriding the message type (error, warn or ignore) of a1608 specific message ID such as `missingEmail`.1609+1610For convenience, fsck prefixes the error/warning with the message ID,1611e.g. "missingEmail: invalid author/committer line - missing email" means1612that setting `fsck.missingEmail = ignore` will hide that issue.1613+1614This feature is intended to support working with legacy repositories1615which cannot be repaired without disruptive changes.16161617fsck.skipList::1618 The path to a sorted list of object names (i.e. one SHA-1 per1619 line) that are known to be broken in a non-fatal way and should1620 be ignored. This feature is useful when an established project1621 should be accepted despite early commits containing errors that1622 can be safely ignored such as invalid committer email addresses.1623 Note: corrupt objects cannot be skipped with this setting.16241625gc.aggressiveDepth::1626 The depth parameter used in the delta compression1627 algorithm used by 'git gc --aggressive'. This defaults1628 to 50.16291630gc.aggressiveWindow::1631 The window size parameter used in the delta compression1632 algorithm used by 'git gc --aggressive'. This defaults1633 to 250.16341635gc.auto::1636 When there are approximately more than this many loose1637 objects in the repository, `git gc --auto` will pack them.1638 Some Porcelain commands use this command to perform a1639 light-weight garbage collection from time to time. The1640 default value is 6700. Setting this to 0 disables it.16411642gc.autoPackLimit::1643 When there are more than this many packs that are not1644 marked with `*.keep` file in the repository, `git gc1645 --auto` consolidates them into one larger pack. The1646 default value is 50. Setting this to 0 disables it.16471648gc.autoDetach::1649 Make `git gc --auto` return immediately and run in background1650 if the system supports it. Default is true.16511652gc.bigPackThreshold::1653 If non-zero, all packs larger than this limit are kept when1654 `git gc` is run. This is very similar to `--keep-base-pack`1655 except that all packs that meet the threshold are kept, not1656 just the base pack. Defaults to zero. Common unit suffixes of1657 'k', 'm', or 'g' are supported.1658+1659Note that if the number of kept packs is more than gc.autoPackLimit,1660this configuration variable is ignored, all packs except the base pack1661will be repacked. After this the number of packs should go below1662gc.autoPackLimit and gc.bigPackThreshold should be respected again.16631664gc.logExpiry::1665 If the file gc.log exists, then `git gc --auto` won't run1666 unless that file is more than 'gc.logExpiry' old. Default is1667 "1.day". See `gc.pruneExpire` for more ways to specify its1668 value.16691670gc.packRefs::1671 Running `git pack-refs` in a repository renders it1672 unclonable by Git versions prior to 1.5.1.2 over dumb1673 transports such as HTTP. This variable determines whether1674 'git gc' runs `git pack-refs`. This can be set to `notbare`1675 to enable it within all non-bare repos or it can be set to a1676 boolean value. The default is `true`.16771678gc.pruneExpire::1679 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1680 Override the grace period with this config variable. The value1681 "now" may be used to disable this grace period and always prune1682 unreachable objects immediately, or "never" may be used to1683 suppress pruning. This feature helps prevent corruption when1684 'git gc' runs concurrently with another process writing to the1685 repository; see the "NOTES" section of linkgit:git-gc[1].16861687gc.worktreePruneExpire::1688 When 'git gc' is run, it calls1689 'git worktree prune --expire 3.months.ago'.1690 This config variable can be used to set a different grace1691 period. The value "now" may be used to disable the grace1692 period and prune `$GIT_DIR/worktrees` immediately, or "never"1693 may be used to suppress pruning.16941695gc.reflogExpire::1696gc.<pattern>.reflogExpire::1697 'git reflog expire' removes reflog entries older than1698 this time; defaults to 90 days. The value "now" expires all1699 entries immediately, and "never" suppresses expiration1700 altogether. With "<pattern>" (e.g.1701 "refs/stash") in the middle the setting applies only to1702 the refs that match the <pattern>.17031704gc.reflogExpireUnreachable::1705gc.<pattern>.reflogExpireUnreachable::1706 'git reflog expire' removes reflog entries older than1707 this time and are not reachable from the current tip;1708 defaults to 30 days. The value "now" expires all entries1709 immediately, and "never" suppresses expiration altogether.1710 With "<pattern>" (e.g. "refs/stash")1711 in the middle, the setting applies only to the refs that1712 match the <pattern>.17131714gc.rerereResolved::1715 Records of conflicted merge you resolved earlier are1716 kept for this many days when 'git rerere gc' is run.1717 You can also use more human-readable "1.month.ago", etc.1718 The default is 60 days. See linkgit:git-rerere[1].17191720gc.rerereUnresolved::1721 Records of conflicted merge you have not resolved are1722 kept for this many days when 'git rerere gc' is run.1723 You can also use more human-readable "1.month.ago", etc.1724 The default is 15 days. See linkgit:git-rerere[1].17251726gitcvs.commitMsgAnnotation::1727 Append this string to each commit message. Set to empty string1728 to disable this feature. Defaults to "via git-CVS emulator".17291730gitcvs.enabled::1731 Whether the CVS server interface is enabled for this repository.1732 See linkgit:git-cvsserver[1].17331734gitcvs.logFile::1735 Path to a log file where the CVS server interface well... logs1736 various stuff. See linkgit:git-cvsserver[1].17371738gitcvs.usecrlfattr::1739 If true, the server will look up the end-of-line conversion1740 attributes for files to determine the `-k` modes to use. If1741 the attributes force Git to treat a file as text,1742 the `-k` mode will be left blank so CVS clients will1743 treat it as text. If they suppress text conversion, the file1744 will be set with '-kb' mode, which suppresses any newline munging1745 the client might otherwise do. If the attributes do not allow1746 the file type to be determined, then `gitcvs.allBinary` is1747 used. See linkgit:gitattributes[5].17481749gitcvs.allBinary::1750 This is used if `gitcvs.usecrlfattr` does not resolve1751 the correct '-kb' mode to use. If true, all1752 unresolved files are sent to the client in1753 mode '-kb'. This causes the client to treat them1754 as binary files, which suppresses any newline munging it1755 otherwise might do. Alternatively, if it is set to "guess",1756 then the contents of the file are examined to decide if1757 it is binary, similar to `core.autocrlf`.17581759gitcvs.dbName::1760 Database used by git-cvsserver to cache revision information1761 derived from the Git repository. The exact meaning depends on the1762 used database driver, for SQLite (which is the default driver) this1763 is a filename. Supports variable substitution (see1764 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1765 Default: '%Ggitcvs.%m.sqlite'17661767gitcvs.dbDriver::1768 Used Perl DBI driver. You can specify any available driver1769 for this here, but it might not work. git-cvsserver is tested1770 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1771 reported *not* to work with 'DBD::mysql'. Experimental feature.1772 May not contain double colons (`:`). Default: 'SQLite'.1773 See linkgit:git-cvsserver[1].17741775gitcvs.dbUser, gitcvs.dbPass::1776 Database user and password. Only useful if setting `gitcvs.dbDriver`,1777 since SQLite has no concept of database users and/or passwords.1778 'gitcvs.dbUser' supports variable substitution (see1779 linkgit:git-cvsserver[1] for details).17801781gitcvs.dbTableNamePrefix::1782 Database table name prefix. Prepended to the names of any1783 database tables used, allowing a single database to be used1784 for several repositories. Supports variable substitution (see1785 linkgit:git-cvsserver[1] for details). Any non-alphabetic1786 characters will be replaced with underscores.17871788All gitcvs variables except for `gitcvs.usecrlfattr` and1789`gitcvs.allBinary` can also be specified as1790'gitcvs.<access_method>.<varname>' (where 'access_method'1791is one of "ext" and "pserver") to make them apply only for the given1792access method.17931794gitweb.category::1795gitweb.description::1796gitweb.owner::1797gitweb.url::1798 See linkgit:gitweb[1] for description.17991800gitweb.avatar::1801gitweb.blame::1802gitweb.grep::1803gitweb.highlight::1804gitweb.patches::1805gitweb.pickaxe::1806gitweb.remote_heads::1807gitweb.showSizes::1808gitweb.snapshot::1809 See linkgit:gitweb.conf[5] for description.18101811grep.lineNumber::1812 If set to true, enable `-n` option by default.18131814grep.column::1815 If set to true, enable the `--column` option by default.18161817grep.patternType::1818 Set the default matching behavior. Using a value of 'basic', 'extended',1819 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1820 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1821 value 'default' will return to the default matching behavior.18221823grep.extendedRegexp::1824 If set to true, enable `--extended-regexp` option by default. This1825 option is ignored when the `grep.patternType` option is set to a value1826 other than 'default'.18271828grep.threads::1829 Number of grep worker threads to use.1830 See `grep.threads` in linkgit:git-grep[1] for more information.18311832grep.fallbackToNoIndex::1833 If set to true, fall back to git grep --no-index if git grep1834 is executed outside of a git repository. Defaults to false.18351836gpg.program::1837 Use this custom program instead of "`gpg`" found on `$PATH` when1838 making or verifying a PGP signature. The program must support the1839 same command-line interface as GPG, namely, to verify a detached1840 signature, "`gpg --verify $file - <$signature`" is run, and the1841 program is expected to signal a good signature by exiting with1842 code 0, and to generate an ASCII-armored detached signature, the1843 standard input of "`gpg -bsau $key`" is fed with the contents to be1844 signed, and the program is expected to send the result to its1845 standard output.18461847gui.commitMsgWidth::1848 Defines how wide the commit message window is in the1849 linkgit:git-gui[1]. "75" is the default.18501851gui.diffContext::1852 Specifies how many context lines should be used in calls to diff1853 made by the linkgit:git-gui[1]. The default is "5".18541855gui.displayUntracked::1856 Determines if linkgit:git-gui[1] shows untracked files1857 in the file list. The default is "true".18581859gui.encoding::1860 Specifies the default encoding to use for displaying of1861 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1862 It can be overridden by setting the 'encoding' attribute1863 for relevant files (see linkgit:gitattributes[5]).1864 If this option is not set, the tools default to the1865 locale encoding.18661867gui.matchTrackingBranch::1868 Determines if new branches created with linkgit:git-gui[1] should1869 default to tracking remote branches with matching names or1870 not. Default: "false".18711872gui.newBranchTemplate::1873 Is used as suggested name when creating new branches using the1874 linkgit:git-gui[1].18751876gui.pruneDuringFetch::1877 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1878 performing a fetch. The default value is "false".18791880gui.trustmtime::1881 Determines if linkgit:git-gui[1] should trust the file modification1882 timestamp or not. By default the timestamps are not trusted.18831884gui.spellingDictionary::1885 Specifies the dictionary used for spell checking commit messages in1886 the linkgit:git-gui[1]. When set to "none" spell checking is turned1887 off.18881889gui.fastCopyBlame::1890 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1891 location detection. It makes blame significantly faster on huge1892 repositories at the expense of less thorough copy detection.18931894gui.copyBlameThreshold::1895 Specifies the threshold to use in 'git gui blame' original location1896 detection, measured in alphanumeric characters. See the1897 linkgit:git-blame[1] manual for more information on copy detection.18981899gui.blamehistoryctx::1900 Specifies the radius of history context in days to show in1901 linkgit:gitk[1] for the selected commit, when the `Show History1902 Context` menu item is invoked from 'git gui blame'. If this1903 variable is set to zero, the whole history is shown.19041905guitool.<name>.cmd::1906 Specifies the shell command line to execute when the corresponding item1907 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1908 mandatory for every tool. The command is executed from the root of1909 the working directory, and in the environment it receives the name of1910 the tool as `GIT_GUITOOL`, the name of the currently selected file as1911 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1912 the head is detached, 'CUR_BRANCH' is empty).19131914guitool.<name>.needsFile::1915 Run the tool only if a diff is selected in the GUI. It guarantees1916 that 'FILENAME' is not empty.19171918guitool.<name>.noConsole::1919 Run the command silently, without creating a window to display its1920 output.19211922guitool.<name>.noRescan::1923 Don't rescan the working directory for changes after the tool1924 finishes execution.19251926guitool.<name>.confirm::1927 Show a confirmation dialog before actually running the tool.19281929guitool.<name>.argPrompt::1930 Request a string argument from the user, and pass it to the tool1931 through the `ARGS` environment variable. Since requesting an1932 argument implies confirmation, the 'confirm' option has no effect1933 if this is enabled. If the option is set to 'true', 'yes', or '1',1934 the dialog uses a built-in generic prompt; otherwise the exact1935 value of the variable is used.19361937guitool.<name>.revPrompt::1938 Request a single valid revision from the user, and set the1939 `REVISION` environment variable. In other aspects this option1940 is similar to 'argPrompt', and can be used together with it.19411942guitool.<name>.revUnmerged::1943 Show only unmerged branches in the 'revPrompt' subdialog.1944 This is useful for tools similar to merge or rebase, but not1945 for things like checkout or reset.19461947guitool.<name>.title::1948 Specifies the title to use for the prompt dialog. The default1949 is the tool name.19501951guitool.<name>.prompt::1952 Specifies the general prompt string to display at the top of1953 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1954 The default value includes the actual command.19551956help.browser::1957 Specify the browser that will be used to display help in the1958 'web' format. See linkgit:git-help[1].19591960help.format::1961 Override the default help format used by linkgit:git-help[1].1962 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1963 the default. 'web' and 'html' are the same.19641965help.autoCorrect::1966 Automatically correct and execute mistyped commands after1967 waiting for the given number of deciseconds (0.1 sec). If more1968 than one command can be deduced from the entered text, nothing1969 will be executed. If the value of this option is negative,1970 the corrected command will be executed immediately. If the1971 value is 0 - the command will be just shown but not executed.1972 This is the default.19731974help.htmlPath::1975 Specify the path where the HTML documentation resides. File system paths1976 and URLs are supported. HTML pages will be prefixed with this path when1977 help is displayed in the 'web' format. This defaults to the documentation1978 path of your Git installation.19791980http.proxy::1981 Override the HTTP proxy, normally configured using the 'http_proxy',1982 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1983 addition to the syntax understood by curl, it is possible to specify a1984 proxy string with a user name but no password, in which case git will1985 attempt to acquire one in the same way it does for other credentials. See1986 linkgit:gitcredentials[7] for more information. The syntax thus is1987 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1988 on a per-remote basis; see remote.<name>.proxy19891990http.proxyAuthMethod::1991 Set the method with which to authenticate against the HTTP proxy. This1992 only takes effect if the configured proxy string contains a user name part1993 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1994 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1995 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1996 variable. Possible values are:1997+1998--1999* `anyauth` - Automatically pick a suitable authentication method. It is2000 assumed that the proxy answers an unauthenticated request with a 4072001 status code and one or more Proxy-authenticate headers with supported2002 authentication methods. This is the default.2003* `basic` - HTTP Basic authentication2004* `digest` - HTTP Digest authentication; this prevents the password from being2005 transmitted to the proxy in clear text2006* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option2007 of `curl(1)`)2008* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)2009--20102011http.emptyAuth::2012 Attempt authentication without seeking a username or password. This2013 can be used to attempt GSS-Negotiate authentication without specifying2014 a username in the URL, as libcurl normally requires a username for2015 authentication.20162017http.delegation::2018 Control GSSAPI credential delegation. The delegation is disabled2019 by default in libcurl since version 7.21.7. Set parameter to tell2020 the server what it is allowed to delegate when it comes to user2021 credentials. Used with GSS/kerberos. Possible values are:2022+2023--2024* `none` - Don't allow any delegation.2025* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2026 Kerberos service ticket, which is a matter of realm policy.2027* `always` - Unconditionally allow the server to delegate.2028--202920302031http.extraHeader::2032 Pass an additional HTTP header when communicating with a server. If2033 more than one such entry exists, all of them are added as extra2034 headers. To allow overriding the settings inherited from the system2035 config, an empty value will reset the extra headers to the empty list.20362037http.cookieFile::2038 The pathname of a file containing previously stored cookie lines,2039 which should be used2040 in the Git http session, if they match the server. The file format2041 of the file to read cookies from should be plain HTTP headers or2042 the Netscape/Mozilla cookie file format (see `curl(1)`).2043 NOTE that the file specified with http.cookieFile is used only as2044 input unless http.saveCookies is set.20452046http.saveCookies::2047 If set, store cookies received during requests to the file specified by2048 http.cookieFile. Has no effect if http.cookieFile is unset.20492050http.sslVersion::2051 The SSL version to use when negotiating an SSL connection, if you2052 want to force the default. The available and default version2053 depend on whether libcurl was built against NSS or OpenSSL and the2054 particular configuration of the crypto library in use. Internally2055 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2056 documentation for more details on the format of this option and2057 for the ssl version supported. Actually the possible values of2058 this option are:20592060 - sslv22061 - sslv32062 - tlsv12063 - tlsv1.02064 - tlsv1.12065 - tlsv1.22066 - tlsv1.320672068+2069Can be overridden by the `GIT_SSL_VERSION` environment variable.2070To force git to use libcurl's default ssl version and ignore any2071explicit http.sslversion option, set `GIT_SSL_VERSION` to the2072empty string.20732074http.sslCipherList::2075 A list of SSL ciphers to use when negotiating an SSL connection.2076 The available ciphers depend on whether libcurl was built against2077 NSS or OpenSSL and the particular configuration of the crypto2078 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2079 option; see the libcurl documentation for more details on the format2080 of this list.2081+2082Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2083To force git to use libcurl's default cipher list and ignore any2084explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2085empty string.20862087http.sslVerify::2088 Whether to verify the SSL certificate when fetching or pushing2089 over HTTPS. Defaults to true. Can be overridden by the2090 `GIT_SSL_NO_VERIFY` environment variable.20912092http.sslCert::2093 File containing the SSL certificate when fetching or pushing2094 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2095 variable.20962097http.sslKey::2098 File containing the SSL private key when fetching or pushing2099 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2100 variable.21012102http.sslCertPasswordProtected::2103 Enable Git's password prompt for the SSL certificate. Otherwise2104 OpenSSL will prompt the user, possibly many times, if the2105 certificate or private key is encrypted. Can be overridden by the2106 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.21072108http.sslCAInfo::2109 File containing the certificates to verify the peer with when2110 fetching or pushing over HTTPS. Can be overridden by the2111 `GIT_SSL_CAINFO` environment variable.21122113http.sslCAPath::2114 Path containing files with the CA certificates to verify the peer2115 with when fetching or pushing over HTTPS. Can be overridden2116 by the `GIT_SSL_CAPATH` environment variable.21172118http.pinnedpubkey::2119 Public key of the https service. It may either be the filename of2120 a PEM or DER encoded public key file or a string starting with2121 'sha256//' followed by the base64 encoded sha256 hash of the2122 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2123 exit with an error if this option is set but not supported by2124 cURL.21252126http.sslTry::2127 Attempt to use AUTH SSL/TLS and encrypted data transfers2128 when connecting via regular FTP protocol. This might be needed2129 if the FTP server requires it for security reasons or you wish2130 to connect securely whenever remote FTP server supports it.2131 Default is false since it might trigger certificate verification2132 errors on misconfigured servers.21332134http.maxRequests::2135 How many HTTP requests to launch in parallel. Can be overridden2136 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21372138http.minSessions::2139 The number of curl sessions (counted across slots) to be kept across2140 requests. They will not be ended with curl_easy_cleanup() until2141 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2142 value will be capped at 1. Defaults to 1.21432144http.postBuffer::2145 Maximum size in bytes of the buffer used by smart HTTP2146 transports when POSTing data to the remote system.2147 For requests larger than this buffer size, HTTP/1.1 and2148 Transfer-Encoding: chunked is used to avoid creating a2149 massive pack file locally. Default is 1 MiB, which is2150 sufficient for most requests.21512152http.lowSpeedLimit, http.lowSpeedTime::2153 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2154 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2155 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2156 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21572158http.noEPSV::2159 A boolean which disables using of EPSV ftp command by curl.2160 This can helpful with some "poor" ftp servers which don't2161 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2162 environment variable. Default is false (curl will use EPSV).21632164http.userAgent::2165 The HTTP USER_AGENT string presented to an HTTP server. The default2166 value represents the version of the client Git such as git/1.7.1.2167 This option allows you to override this value to a more common value2168 such as Mozilla/4.0. This may be necessary, for instance, if2169 connecting through a firewall that restricts HTTP connections to a set2170 of common USER_AGENT strings (but not including those like git/1.7.1).2171 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21722173http.followRedirects::2174 Whether git should follow HTTP redirects. If set to `true`, git2175 will transparently follow any redirect issued by a server it2176 encounters. If set to `false`, git will treat all redirects as2177 errors. If set to `initial`, git will follow redirects only for2178 the initial request to a remote, but not for subsequent2179 follow-up HTTP requests. Since git uses the redirected URL as2180 the base for the follow-up requests, this is generally2181 sufficient. The default is `initial`.21822183http.<url>.*::2184 Any of the http.* options above can be applied selectively to some URLs.2185 For a config key to match a URL, each element of the config key is2186 compared to that of the URL, in the following order:2187+2188--2189. Scheme (e.g., `https` in `https://example.com/`). This field2190 must match exactly between the config key and the URL.21912192. Host/domain name (e.g., `example.com` in `https://example.com/`).2193 This field must match between the config key and the URL. It is2194 possible to specify a `*` as part of the host name to match all subdomains2195 at this level. `https://*.example.com/` for example would match2196 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21972198. Port number (e.g., `8080` in `http://example.com:8080/`).2199 This field must match exactly between the config key and the URL.2200 Omitted port numbers are automatically converted to the correct2201 default for the scheme before matching.22022203. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2204 path field of the config key must match the path field of the URL2205 either exactly or as a prefix of slash-delimited path elements. This means2206 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2207 match on a slash (`/`) boundary. Longer matches take precedence (so a config2208 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2209 key with just path `foo/`).22102211. User name (e.g., `user` in `https://user@example.com/repo.git`). If2212 the config key has a user name it must match the user name in the2213 URL exactly. If the config key does not have a user name, that2214 config key will match a URL with any user name (including none),2215 but at a lower precedence than a config key with a user name.2216--2217+2218The list above is ordered by decreasing precedence; a URL that matches2219a config key's path is preferred to one that matches its user name. For example,2220if the URL is `https://user@example.com/foo/bar` a config key match of2221`https://example.com/foo` will be preferred over a config key match of2222`https://user@example.com`.2223+2224All URLs are normalized before attempting any matching (the password part,2225if embedded in the URL, is always ignored for matching purposes) so that2226equivalent URLs that are simply spelled differently will match properly.2227Environment variable settings always override any matches. The URLs that are2228matched against are those given directly to Git commands. This means any URLs2229visited as a result of a redirection do not participate in matching.22302231ssh.variant::2232 By default, Git determines the command line arguments to use2233 based on the basename of the configured SSH command (configured2234 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2235 the config setting `core.sshCommand`). If the basename is2236 unrecognized, Git will attempt to detect support of OpenSSH2237 options by first invoking the configured SSH command with the2238 `-G` (print configuration) option and will subsequently use2239 OpenSSH options (if that is successful) or no options besides2240 the host and remote command (if it fails).2241+2242The config variable `ssh.variant` can be set to override this detection.2243Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2244`tortoiseplink`, `simple` (no options except the host and remote command).2245The default auto-detection can be explicitly requested using the value2246`auto`. Any other value is treated as `ssh`. This setting can also be2247overridden via the environment variable `GIT_SSH_VARIANT`.2248+2249The current command-line parameters used for each variant are as2250follows:2251+2252--22532254* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22552256* `simple` - [username@]host command22572258* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22592260* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22612262--2263+2264Except for the `simple` variant, command-line parameters are likely to2265change as git gains new features.22662267i18n.commitEncoding::2268 Character encoding the commit messages are stored in; Git itself2269 does not care per se, but this information is necessary e.g. when2270 importing commits from emails or in the gitk graphical history2271 browser (and possibly at other places in the future or in other2272 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22732274i18n.logOutputEncoding::2275 Character encoding the commit messages are converted to when2276 running 'git log' and friends.22772278imap::2279 The configuration variables in the 'imap' section are described2280 in linkgit:git-imap-send[1].22812282index.version::2283 Specify the version with which new index files should be2284 initialized. This does not affect existing repositories.22852286init.templateDir::2287 Specify the directory from which templates will be copied.2288 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22892290instaweb.browser::2291 Specify the program that will be used to browse your working2292 repository in gitweb. See linkgit:git-instaweb[1].22932294instaweb.httpd::2295 The HTTP daemon command-line to start gitweb on your working2296 repository. See linkgit:git-instaweb[1].22972298instaweb.local::2299 If true the web server started by linkgit:git-instaweb[1] will2300 be bound to the local IP (127.0.0.1).23012302instaweb.modulePath::2303 The default module path for linkgit:git-instaweb[1] to use2304 instead of /usr/lib/apache2/modules. Only used if httpd2305 is Apache.23062307instaweb.port::2308 The port number to bind the gitweb httpd to. See2309 linkgit:git-instaweb[1].23102311interactive.singleKey::2312 In interactive commands, allow the user to provide one-letter2313 input with a single key (i.e., without hitting enter).2314 Currently this is used by the `--patch` mode of2315 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2316 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2317 setting is silently ignored if portable keystroke input2318 is not available; requires the Perl module Term::ReadKey.23192320interactive.diffFilter::2321 When an interactive command (such as `git add --patch`) shows2322 a colorized diff, git will pipe the diff through the shell2323 command defined by this configuration variable. The command may2324 mark up the diff further for human consumption, provided that it2325 retains a one-to-one correspondence with the lines in the2326 original diff. Defaults to disabled (no filtering).23272328log.abbrevCommit::2329 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2330 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2331 override this option with `--no-abbrev-commit`.23322333log.date::2334 Set the default date-time mode for the 'log' command.2335 Setting a value for log.date is similar to using 'git log''s2336 `--date` option. See linkgit:git-log[1] for details.23372338log.decorate::2339 Print out the ref names of any commits that are shown by the log2340 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2341 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2342 specified, the full ref name (including prefix) will be printed.2343 If 'auto' is specified, then if the output is going to a terminal,2344 the ref names are shown as if 'short' were given, otherwise no ref2345 names are shown. This is the same as the `--decorate` option2346 of the `git log`.23472348log.follow::2349 If `true`, `git log` will act as if the `--follow` option was used when2350 a single <path> is given. This has the same limitations as `--follow`,2351 i.e. it cannot be used to follow multiple files and does not work well2352 on non-linear history.23532354log.graphColors::2355 A list of colors, separated by commas, that can be used to draw2356 history lines in `git log --graph`.23572358log.showRoot::2359 If true, the initial commit will be shown as a big creation event.2360 This is equivalent to a diff against an empty tree.2361 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2362 normally hide the root commit will now show it. True by default.23632364log.showSignature::2365 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2366 linkgit:git-whatchanged[1] assume `--show-signature`.23672368log.mailmap::2369 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2370 linkgit:git-whatchanged[1] assume `--use-mailmap`.23712372mailinfo.scissors::2373 If true, makes linkgit:git-mailinfo[1] (and therefore2374 linkgit:git-am[1]) act by default as if the --scissors option2375 was provided on the command-line. When active, this features2376 removes everything from the message body before a scissors2377 line (i.e. consisting mainly of ">8", "8<" and "-").23782379mailmap.file::2380 The location of an augmenting mailmap file. The default2381 mailmap, located in the root of the repository, is loaded2382 first, then the mailmap file pointed to by this variable.2383 The location of the mailmap file may be in a repository2384 subdirectory, or somewhere outside of the repository itself.2385 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23862387mailmap.blob::2388 Like `mailmap.file`, but consider the value as a reference to a2389 blob in the repository. If both `mailmap.file` and2390 `mailmap.blob` are given, both are parsed, with entries from2391 `mailmap.file` taking precedence. In a bare repository, this2392 defaults to `HEAD:.mailmap`. In a non-bare repository, it2393 defaults to empty.23942395man.viewer::2396 Specify the programs that may be used to display help in the2397 'man' format. See linkgit:git-help[1].23982399man.<tool>.cmd::2400 Specify the command to invoke the specified man viewer. The2401 specified command is evaluated in shell with the man page2402 passed as argument. (See linkgit:git-help[1].)24032404man.<tool>.path::2405 Override the path for the given tool that may be used to2406 display help in the 'man' format. See linkgit:git-help[1].24072408include::merge-config.txt[]24092410mergetool.<tool>.path::2411 Override the path for the given tool. This is useful in case2412 your tool is not in the PATH.24132414mergetool.<tool>.cmd::2415 Specify the command to invoke the specified merge tool. The2416 specified command is evaluated in shell with the following2417 variables available: 'BASE' is the name of a temporary file2418 containing the common base of the files to be merged, if available;2419 'LOCAL' is the name of a temporary file containing the contents of2420 the file on the current branch; 'REMOTE' is the name of a temporary2421 file containing the contents of the file from the branch being2422 merged; 'MERGED' contains the name of the file to which the merge2423 tool should write the results of a successful merge.24242425mergetool.<tool>.trustExitCode::2426 For a custom merge command, specify whether the exit code of2427 the merge command can be used to determine whether the merge was2428 successful. If this is not set to true then the merge target file2429 timestamp is checked and the merge assumed to have been successful2430 if the file has been updated, otherwise the user is prompted to2431 indicate the success of the merge.24322433mergetool.meld.hasOutput::2434 Older versions of `meld` do not support the `--output` option.2435 Git will attempt to detect whether `meld` supports `--output`2436 by inspecting the output of `meld --help`. Configuring2437 `mergetool.meld.hasOutput` will make Git skip these checks and2438 use the configured value instead. Setting `mergetool.meld.hasOutput`2439 to `true` tells Git to unconditionally use the `--output` option,2440 and `false` avoids using `--output`.24412442mergetool.keepBackup::2443 After performing a merge, the original file with conflict markers2444 can be saved as a file with a `.orig` extension. If this variable2445 is set to `false` then this file is not preserved. Defaults to2446 `true` (i.e. keep the backup files).24472448mergetool.keepTemporaries::2449 When invoking a custom merge tool, Git uses a set of temporary2450 files to pass to the tool. If the tool returns an error and this2451 variable is set to `true`, then these temporary files will be2452 preserved, otherwise they will be removed after the tool has2453 exited. Defaults to `false`.24542455mergetool.writeToTemp::2456 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2457 conflicting files in the worktree by default. Git will attempt2458 to use a temporary directory for these files when set `true`.2459 Defaults to `false`.24602461mergetool.prompt::2462 Prompt before each invocation of the merge resolution program.24632464notes.mergeStrategy::2465 Which merge strategy to choose by default when resolving notes2466 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2467 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2468 section of linkgit:git-notes[1] for more information on each strategy.24692470notes.<name>.mergeStrategy::2471 Which merge strategy to choose when doing a notes merge into2472 refs/notes/<name>. This overrides the more general2473 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2474 linkgit:git-notes[1] for more information on the available strategies.24752476notes.displayRef::2477 The (fully qualified) refname from which to show notes when2478 showing commit messages. The value of this variable can be set2479 to a glob, in which case notes from all matching refs will be2480 shown. You may also specify this configuration variable2481 several times. A warning will be issued for refs that do not2482 exist, but a glob that does not match any refs is silently2483 ignored.2484+2485This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2486environment variable, which must be a colon separated list of refs or2487globs.2488+2489The effective value of "core.notesRef" (possibly overridden by2490GIT_NOTES_REF) is also implicitly added to the list of refs to be2491displayed.24922493notes.rewrite.<command>::2494 When rewriting commits with <command> (currently `amend` or2495 `rebase`) and this variable is set to `true`, Git2496 automatically copies your notes from the original to the2497 rewritten commit. Defaults to `true`, but see2498 "notes.rewriteRef" below.24992500notes.rewriteMode::2501 When copying notes during a rewrite (see the2502 "notes.rewrite.<command>" option), determines what to do if2503 the target commit already has a note. Must be one of2504 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2505 Defaults to `concatenate`.2506+2507This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2508environment variable.25092510notes.rewriteRef::2511 When copying notes during a rewrite, specifies the (fully2512 qualified) ref whose notes should be copied. The ref may be a2513 glob, in which case notes in all matching refs will be copied.2514 You may also specify this configuration several times.2515+2516Does not have a default value; you must configure this variable to2517enable note rewriting. Set it to `refs/notes/commits` to enable2518rewriting for the default commit notes.2519+2520This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2521environment variable, which must be a colon separated list of refs or2522globs.25232524pack.window::2525 The size of the window used by linkgit:git-pack-objects[1] when no2526 window size is given on the command line. Defaults to 10.25272528pack.depth::2529 The maximum delta depth used by linkgit:git-pack-objects[1] when no2530 maximum depth is given on the command line. Defaults to 50.2531 Maximum value is 4095.25322533pack.windowMemory::2534 The maximum size of memory that is consumed by each thread2535 in linkgit:git-pack-objects[1] for pack window memory when2536 no limit is given on the command line. The value can be2537 suffixed with "k", "m", or "g". When left unconfigured (or2538 set explicitly to 0), there will be no limit.25392540pack.compression::2541 An integer -1..9, indicating the compression level for objects2542 in a pack file. -1 is the zlib default. 0 means no2543 compression, and 1..9 are various speed/size tradeoffs, 9 being2544 slowest. If not set, defaults to core.compression. If that is2545 not set, defaults to -1, the zlib default, which is "a default2546 compromise between speed and compression (currently equivalent2547 to level 6)."2548+2549Note that changing the compression level will not automatically recompress2550all existing objects. You can force recompression by passing the -F option2551to linkgit:git-repack[1].25522553pack.deltaCacheSize::2554 The maximum memory in bytes used for caching deltas in2555 linkgit:git-pack-objects[1] before writing them out to a pack.2556 This cache is used to speed up the writing object phase by not2557 having to recompute the final delta result once the best match2558 for all objects is found. Repacking large repositories on machines2559 which are tight with memory might be badly impacted by this though,2560 especially if this cache pushes the system into swapping.2561 A value of 0 means no limit. The smallest size of 1 byte may be2562 used to virtually disable this cache. Defaults to 256 MiB.25632564pack.deltaCacheLimit::2565 The maximum size of a delta, that is cached in2566 linkgit:git-pack-objects[1]. This cache is used to speed up the2567 writing object phase by not having to recompute the final delta2568 result once the best match for all objects is found.2569 Defaults to 1000. Maximum value is 65535.25702571pack.threads::2572 Specifies the number of threads to spawn when searching for best2573 delta matches. This requires that linkgit:git-pack-objects[1]2574 be compiled with pthreads otherwise this option is ignored with a2575 warning. This is meant to reduce packing time on multiprocessor2576 machines. The required amount of memory for the delta search window2577 is however multiplied by the number of threads.2578 Specifying 0 will cause Git to auto-detect the number of CPU's2579 and set the number of threads accordingly.25802581pack.indexVersion::2582 Specify the default pack index version. Valid values are 1 for2583 legacy pack index used by Git versions prior to 1.5.2, and 2 for2584 the new pack index with capabilities for packs larger than 4 GB2585 as well as proper protection against the repacking of corrupted2586 packs. Version 2 is the default. Note that version 2 is enforced2587 and this config option ignored whenever the corresponding pack is2588 larger than 2 GB.2589+2590If you have an old Git that does not understand the version 2 `*.idx` file,2591cloning or fetching over a non native protocol (e.g. "http")2592that will copy both `*.pack` file and corresponding `*.idx` file from the2593other side may give you a repository that cannot be accessed with your2594older version of Git. If the `*.pack` file is smaller than 2 GB, however,2595you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2596the `*.idx` file.25972598pack.packSizeLimit::2599 The maximum size of a pack. This setting only affects2600 packing to a file when repacking, i.e. the git:// protocol2601 is unaffected. It can be overridden by the `--max-pack-size`2602 option of linkgit:git-repack[1]. Reaching this limit results2603 in the creation of multiple packfiles; which in turn prevents2604 bitmaps from being created.2605 The minimum size allowed is limited to 1 MiB.2606 The default is unlimited.2607 Common unit suffixes of 'k', 'm', or 'g' are2608 supported.26092610pack.useBitmaps::2611 When true, git will use pack bitmaps (if available) when packing2612 to stdout (e.g., during the server side of a fetch). Defaults to2613 true. You should not generally need to turn this off unless2614 you are debugging pack bitmaps.26152616pack.writeBitmaps (deprecated)::2617 This is a deprecated synonym for `repack.writeBitmaps`.26182619pack.writeBitmapHashCache::2620 When true, git will include a "hash cache" section in the bitmap2621 index (if one is written). This cache can be used to feed git's2622 delta heuristics, potentially leading to better deltas between2623 bitmapped and non-bitmapped objects (e.g., when serving a fetch2624 between an older, bitmapped pack and objects that have been2625 pushed since the last gc). The downside is that it consumes 42626 bytes per object of disk space, and that JGit's bitmap2627 implementation does not understand it, causing it to complain if2628 Git and JGit are used on the same repository. Defaults to false.26292630pager.<cmd>::2631 If the value is boolean, turns on or off pagination of the2632 output of a particular Git subcommand when writing to a tty.2633 Otherwise, turns on pagination for the subcommand using the2634 pager specified by the value of `pager.<cmd>`. If `--paginate`2635 or `--no-pager` is specified on the command line, it takes2636 precedence over this option. To disable pagination for all2637 commands, set `core.pager` or `GIT_PAGER` to `cat`.26382639pretty.<name>::2640 Alias for a --pretty= format string, as specified in2641 linkgit:git-log[1]. Any aliases defined here can be used just2642 as the built-in pretty formats could. For example,2643 running `git config pretty.changelog "format:* %H %s"`2644 would cause the invocation `git log --pretty=changelog`2645 to be equivalent to running `git log "--pretty=format:* %H %s"`.2646 Note that an alias with the same name as a built-in format2647 will be silently ignored.26482649protocol.allow::2650 If set, provide a user defined default policy for all protocols which2651 don't explicitly have a policy (`protocol.<name>.allow`). By default,2652 if unset, known-safe protocols (http, https, git, ssh, file) have a2653 default policy of `always`, known-dangerous protocols (ext) have a2654 default policy of `never`, and all other protocols have a default2655 policy of `user`. Supported policies:2656+2657--26582659* `always` - protocol is always able to be used.26602661* `never` - protocol is never able to be used.26622663* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2664 either unset or has a value of 1. This policy should be used when you want a2665 protocol to be directly usable by the user but don't want it used by commands which2666 execute clone/fetch/push commands without user input, e.g. recursive2667 submodule initialization.26682669--26702671protocol.<name>.allow::2672 Set a policy to be used by protocol `<name>` with clone/fetch/push2673 commands. See `protocol.allow` above for the available policies.2674+2675The protocol names currently used by git are:2676+2677--2678 - `file`: any local file-based path (including `file://` URLs,2679 or local paths)26802681 - `git`: the anonymous git protocol over a direct TCP2682 connection (or proxy, if configured)26832684 - `ssh`: git over ssh (including `host:path` syntax,2685 `ssh://`, etc).26862687 - `http`: git over http, both "smart http" and "dumb http".2688 Note that this does _not_ include `https`; if you want to configure2689 both, you must do so individually.26902691 - any external helpers are named by their protocol (e.g., use2692 `hg` to allow the `git-remote-hg` helper)2693--26942695protocol.version::2696 Experimental. If set, clients will attempt to communicate with a2697 server using the specified protocol version. If unset, no2698 attempt will be made by the client to communicate using a2699 particular protocol version, this results in protocol version 02700 being used.2701 Supported versions:2702+2703--27042705* `0` - the original wire protocol.27062707* `1` - the original wire protocol with the addition of a version string2708 in the initial response from the server.27092710--27112712pull.ff::2713 By default, Git does not create an extra merge commit when merging2714 a commit that is a descendant of the current commit. Instead, the2715 tip of the current branch is fast-forwarded. When set to `false`,2716 this variable tells Git to create an extra merge commit in such2717 a case (equivalent to giving the `--no-ff` option from the command2718 line). When set to `only`, only such fast-forward merges are2719 allowed (equivalent to giving the `--ff-only` option from the2720 command line). This setting overrides `merge.ff` when pulling.27212722pull.rebase::2723 When true, rebase branches on top of the fetched branch, instead2724 of merging the default branch from the default remote when "git2725 pull" is run. See "branch.<name>.rebase" for setting this on a2726 per-branch basis.2727+2728When `merges`, pass the `--rebase-merges` option to 'git rebase'2729so that the local merge commits are included in the rebase (see2730linkgit:git-rebase[1] for details).2731+2732When preserve, also pass `--preserve-merges` along to 'git rebase'2733so that locally committed merge commits will not be flattened2734by running 'git pull'.2735+2736When the value is `interactive`, the rebase is run in interactive mode.2737+2738*NOTE*: this is a possibly dangerous operation; do *not* use2739it unless you understand the implications (see linkgit:git-rebase[1]2740for details).27412742pull.octopus::2743 The default merge strategy to use when pulling multiple branches2744 at once.27452746pull.twohead::2747 The default merge strategy to use when pulling a single branch.27482749push.default::2750 Defines the action `git push` should take if no refspec is2751 explicitly given. Different values are well-suited for2752 specific workflows; for instance, in a purely central workflow2753 (i.e. the fetch source is equal to the push destination),2754 `upstream` is probably what you want. Possible values are:2755+2756--27572758* `nothing` - do not push anything (error out) unless a refspec is2759 explicitly given. This is primarily meant for people who want to2760 avoid mistakes by always being explicit.27612762* `current` - push the current branch to update a branch with the same2763 name on the receiving end. Works in both central and non-central2764 workflows.27652766* `upstream` - push the current branch back to the branch whose2767 changes are usually integrated into the current branch (which is2768 called `@{upstream}`). This mode only makes sense if you are2769 pushing to the same repository you would normally pull from2770 (i.e. central workflow).27712772* `tracking` - This is a deprecated synonym for `upstream`.27732774* `simple` - in centralized workflow, work like `upstream` with an2775 added safety to refuse to push if the upstream branch's name is2776 different from the local one.2777+2778When pushing to a remote that is different from the remote you normally2779pull from, work as `current`. This is the safest option and is suited2780for beginners.2781+2782This mode has become the default in Git 2.0.27832784* `matching` - push all branches having the same name on both ends.2785 This makes the repository you are pushing to remember the set of2786 branches that will be pushed out (e.g. if you always push 'maint'2787 and 'master' there and no other branches, the repository you push2788 to will have these two branches, and your local 'maint' and2789 'master' will be pushed there).2790+2791To use this mode effectively, you have to make sure _all_ the2792branches you would push out are ready to be pushed out before2793running 'git push', as the whole point of this mode is to allow you2794to push all of the branches in one go. If you usually finish work2795on only one branch and push out the result, while other branches are2796unfinished, this mode is not for you. Also this mode is not2797suitable for pushing into a shared central repository, as other2798people may add new branches there, or update the tip of existing2799branches outside your control.2800+2801This used to be the default, but not since Git 2.0 (`simple` is the2802new default).28032804--28052806push.followTags::2807 If set to true enable `--follow-tags` option by default. You2808 may override this configuration at time of push by specifying2809 `--no-follow-tags`.28102811push.gpgSign::2812 May be set to a boolean value, or the string 'if-asked'. A true2813 value causes all pushes to be GPG signed, as if `--signed` is2814 passed to linkgit:git-push[1]. The string 'if-asked' causes2815 pushes to be signed if the server supports it, as if2816 `--signed=if-asked` is passed to 'git push'. A false value may2817 override a value from a lower-priority config file. An explicit2818 command-line flag always overrides this config option.28192820push.pushOption::2821 When no `--push-option=<option>` argument is given from the2822 command line, `git push` behaves as if each <value> of2823 this variable is given as `--push-option=<value>`.2824+2825This is a multi-valued variable, and an empty value can be used in a2826higher priority configuration file (e.g. `.git/config` in a2827repository) to clear the values inherited from a lower priority2828configuration files (e.g. `$HOME/.gitconfig`).2829+2830--28312832Example:28332834/etc/gitconfig2835 push.pushoption = a2836 push.pushoption = b28372838~/.gitconfig2839 push.pushoption = c28402841repo/.git/config2842 push.pushoption =2843 push.pushoption = b28442845This will result in only b (a and c are cleared).28462847--28482849push.recurseSubmodules::2850 Make sure all submodule commits used by the revisions to be pushed2851 are available on a remote-tracking branch. If the value is 'check'2852 then Git will verify that all submodule commits that changed in the2853 revisions to be pushed are available on at least one remote of the2854 submodule. If any commits are missing, the push will be aborted and2855 exit with non-zero status. If the value is 'on-demand' then all2856 submodules that changed in the revisions to be pushed will be2857 pushed. If on-demand was not able to push all necessary revisions2858 it will also be aborted and exit with non-zero status. If the value2859 is 'no' then default behavior of ignoring submodules when pushing2860 is retained. You may override this configuration at time of push by2861 specifying '--recurse-submodules=check|on-demand|no'.28622863include::rebase-config.txt[]28642865receive.advertiseAtomic::2866 By default, git-receive-pack will advertise the atomic push2867 capability to its clients. If you don't want to advertise this2868 capability, set this variable to false.28692870receive.advertisePushOptions::2871 When set to true, git-receive-pack will advertise the push options2872 capability to its clients. False by default.28732874receive.autogc::2875 By default, git-receive-pack will run "git-gc --auto" after2876 receiving data from git-push and updating refs. You can stop2877 it by setting this variable to false.28782879receive.certNonceSeed::2880 By setting this variable to a string, `git receive-pack`2881 will accept a `git push --signed` and verifies it by using2882 a "nonce" protected by HMAC using this string as a secret2883 key.28842885receive.certNonceSlop::2886 When a `git push --signed` sent a push certificate with a2887 "nonce" that was issued by a receive-pack serving the same2888 repository within this many seconds, export the "nonce"2889 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2890 hooks (instead of what the receive-pack asked the sending2891 side to include). This may allow writing checks in2892 `pre-receive` and `post-receive` a bit easier. Instead of2893 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2894 that records by how many seconds the nonce is stale to2895 decide if they want to accept the certificate, they only2896 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28972898receive.fsckObjects::2899 If it is set to true, git-receive-pack will check all received2900 objects. It will abort in the case of a malformed object or a2901 broken link. The result of an abort are only dangling objects.2902 Defaults to false. If not set, the value of `transfer.fsckObjects`2903 is used instead.29042905receive.fsck.<msg-id>::2906 When `receive.fsckObjects` is set to true, errors can be switched2907 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2908 setting where the `<msg-id>` is the fsck message ID and the value2909 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2910 the error/warning with the message ID, e.g. "missingEmail: invalid2911 author/committer line - missing email" means that setting2912 `receive.fsck.missingEmail = ignore` will hide that issue.2913+2914This feature is intended to support working with legacy repositories2915which would not pass pushing when `receive.fsckObjects = true`, allowing2916the host to accept repositories with certain known issues but still catch2917other issues.29182919receive.fsck.skipList::2920 The path to a sorted list of object names (i.e. one SHA-1 per2921 line) that are known to be broken in a non-fatal way and should2922 be ignored. This feature is useful when an established project2923 should be accepted despite early commits containing errors that2924 can be safely ignored such as invalid committer email addresses.2925 Note: corrupt objects cannot be skipped with this setting.29262927receive.keepAlive::2928 After receiving the pack from the client, `receive-pack` may2929 produce no output (if `--quiet` was specified) while processing2930 the pack, causing some networks to drop the TCP connection.2931 With this option set, if `receive-pack` does not transmit2932 any data in this phase for `receive.keepAlive` seconds, it will2933 send a short keepalive packet. The default is 5 seconds; set2934 to 0 to disable keepalives entirely.29352936receive.unpackLimit::2937 If the number of objects received in a push is below this2938 limit then the objects will be unpacked into loose object2939 files. However if the number of received objects equals or2940 exceeds this limit then the received pack will be stored as2941 a pack, after adding any missing delta bases. Storing the2942 pack from a push can make the push operation complete faster,2943 especially on slow filesystems. If not set, the value of2944 `transfer.unpackLimit` is used instead.29452946receive.maxInputSize::2947 If the size of the incoming pack stream is larger than this2948 limit, then git-receive-pack will error out, instead of2949 accepting the pack file. If not set or set to 0, then the size2950 is unlimited.29512952receive.denyDeletes::2953 If set to true, git-receive-pack will deny a ref update that deletes2954 the ref. Use this to prevent such a ref deletion via a push.29552956receive.denyDeleteCurrent::2957 If set to true, git-receive-pack will deny a ref update that2958 deletes the currently checked out branch of a non-bare repository.29592960receive.denyCurrentBranch::2961 If set to true or "refuse", git-receive-pack will deny a ref update2962 to the currently checked out branch of a non-bare repository.2963 Such a push is potentially dangerous because it brings the HEAD2964 out of sync with the index and working tree. If set to "warn",2965 print a warning of such a push to stderr, but allow the push to2966 proceed. If set to false or "ignore", allow such pushes with no2967 message. Defaults to "refuse".2968+2969Another option is "updateInstead" which will update the working2970tree if pushing into the current branch. This option is2971intended for synchronizing working directories when one side is not easily2972accessible via interactive ssh (e.g. a live web site, hence the requirement2973that the working directory be clean). This mode also comes in handy when2974developing inside a VM to test and fix code on different Operating Systems.2975+2976By default, "updateInstead" will refuse the push if the working tree or2977the index have any difference from the HEAD, but the `push-to-checkout`2978hook can be used to customize this. See linkgit:githooks[5].29792980receive.denyNonFastForwards::2981 If set to true, git-receive-pack will deny a ref update which is2982 not a fast-forward. Use this to prevent such an update via a push,2983 even if that push is forced. This configuration variable is2984 set when initializing a shared repository.29852986receive.hideRefs::2987 This variable is the same as `transfer.hideRefs`, but applies2988 only to `receive-pack` (and so affects pushes, but not fetches).2989 An attempt to update or delete a hidden ref by `git push` is2990 rejected.29912992receive.updateServerInfo::2993 If set to true, git-receive-pack will run git-update-server-info2994 after receiving data from git-push and updating refs.29952996receive.shallowUpdate::2997 If set to true, .git/shallow can be updated when new refs2998 require new shallow roots. Otherwise those refs are rejected.29993000remote.pushDefault::3001 The remote to push to by default. Overrides3002 `branch.<name>.remote` for all branches, and is overridden by3003 `branch.<name>.pushRemote` for specific branches.30043005remote.<name>.url::3006 The URL of a remote repository. See linkgit:git-fetch[1] or3007 linkgit:git-push[1].30083009remote.<name>.pushurl::3010 The push URL of a remote repository. See linkgit:git-push[1].30113012remote.<name>.proxy::3013 For remotes that require curl (http, https and ftp), the URL to3014 the proxy to use for that remote. Set to the empty string to3015 disable proxying for that remote.30163017remote.<name>.proxyAuthMethod::3018 For remotes that require curl (http, https and ftp), the method to use for3019 authenticating against the proxy in use (probably set in3020 `remote.<name>.proxy`). See `http.proxyAuthMethod`.30213022remote.<name>.fetch::3023 The default set of "refspec" for linkgit:git-fetch[1]. See3024 linkgit:git-fetch[1].30253026remote.<name>.push::3027 The default set of "refspec" for linkgit:git-push[1]. See3028 linkgit:git-push[1].30293030remote.<name>.mirror::3031 If true, pushing to this remote will automatically behave3032 as if the `--mirror` option was given on the command line.30333034remote.<name>.skipDefaultUpdate::3035 If true, this remote will be skipped by default when updating3036 using linkgit:git-fetch[1] or the `update` subcommand of3037 linkgit:git-remote[1].30383039remote.<name>.skipFetchAll::3040 If true, this remote will be skipped by default when updating3041 using linkgit:git-fetch[1] or the `update` subcommand of3042 linkgit:git-remote[1].30433044remote.<name>.receivepack::3045 The default program to execute on the remote side when pushing. See3046 option --receive-pack of linkgit:git-push[1].30473048remote.<name>.uploadpack::3049 The default program to execute on the remote side when fetching. See3050 option --upload-pack of linkgit:git-fetch-pack[1].30513052remote.<name>.tagOpt::3053 Setting this value to --no-tags disables automatic tag following when3054 fetching from remote <name>. Setting it to --tags will fetch every3055 tag from remote <name>, even if they are not reachable from remote3056 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3057 override this setting. See options --tags and --no-tags of3058 linkgit:git-fetch[1].30593060remote.<name>.vcs::3061 Setting this to a value <vcs> will cause Git to interact with3062 the remote with the git-remote-<vcs> helper.30633064remote.<name>.prune::3065 When set to true, fetching from this remote by default will also3066 remove any remote-tracking references that no longer exist on the3067 remote (as if the `--prune` option was given on the command line).3068 Overrides `fetch.prune` settings, if any.30693070remote.<name>.pruneTags::3071 When set to true, fetching from this remote by default will also3072 remove any local tags that no longer exist on the remote if pruning3073 is activated in general via `remote.<name>.prune`, `fetch.prune` or3074 `--prune`. Overrides `fetch.pruneTags` settings, if any.3075+3076See also `remote.<name>.prune` and the PRUNING section of3077linkgit:git-fetch[1].30783079remotes.<group>::3080 The list of remotes which are fetched by "git remote update3081 <group>". See linkgit:git-remote[1].30823083repack.useDeltaBaseOffset::3084 By default, linkgit:git-repack[1] creates packs that use3085 delta-base offset. If you need to share your repository with3086 Git older than version 1.4.4, either directly or via a dumb3087 protocol such as http, then you need to set this option to3088 "false" and repack. Access from old Git versions over the3089 native protocol are unaffected by this option.30903091repack.packKeptObjects::3092 If set to true, makes `git repack` act as if3093 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3094 details. Defaults to `false` normally, but `true` if a bitmap3095 index is being written (either via `--write-bitmap-index` or3096 `repack.writeBitmaps`).30973098repack.writeBitmaps::3099 When true, git will write a bitmap index when packing all3100 objects to disk (e.g., when `git repack -a` is run). This3101 index can speed up the "counting objects" phase of subsequent3102 packs created for clones and fetches, at the cost of some disk3103 space and extra time spent on the initial repack. This has3104 no effect if multiple packfiles are created.3105 Defaults to false.31063107rerere.autoUpdate::3108 When set to true, `git-rerere` updates the index with the3109 resulting contents after it cleanly resolves conflicts using3110 previously recorded resolution. Defaults to false.31113112rerere.enabled::3113 Activate recording of resolved conflicts, so that identical3114 conflict hunks can be resolved automatically, should they be3115 encountered again. By default, linkgit:git-rerere[1] is3116 enabled if there is an `rr-cache` directory under the3117 `$GIT_DIR`, e.g. if "rerere" was previously used in the3118 repository.31193120sendemail.identity::3121 A configuration identity. When given, causes values in the3122 'sendemail.<identity>' subsection to take precedence over3123 values in the 'sendemail' section. The default identity is3124 the value of `sendemail.identity`.31253126sendemail.smtpEncryption::3127 See linkgit:git-send-email[1] for description. Note that this3128 setting is not subject to the 'identity' mechanism.31293130sendemail.smtpssl (deprecated)::3131 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31323133sendemail.smtpsslcertpath::3134 Path to ca-certificates (either a directory or a single file).3135 Set it to an empty string to disable certificate verification.31363137sendemail.<identity>.*::3138 Identity-specific versions of the 'sendemail.*' parameters3139 found below, taking precedence over those when this3140 identity is selected, through either the command-line or3141 `sendemail.identity`.31423143sendemail.aliasesFile::3144sendemail.aliasFileType::3145sendemail.annotate::3146sendemail.bcc::3147sendemail.cc::3148sendemail.ccCmd::3149sendemail.chainReplyTo::3150sendemail.confirm::3151sendemail.envelopeSender::3152sendemail.from::3153sendemail.multiEdit::3154sendemail.signedoffbycc::3155sendemail.smtpPass::3156sendemail.suppresscc::3157sendemail.suppressFrom::3158sendemail.to::3159sendemail.tocmd::3160sendemail.smtpDomain::3161sendemail.smtpServer::3162sendemail.smtpServerPort::3163sendemail.smtpServerOption::3164sendemail.smtpUser::3165sendemail.thread::3166sendemail.transferEncoding::3167sendemail.validate::3168sendemail.xmailer::3169 See linkgit:git-send-email[1] for description.31703171sendemail.signedoffcc (deprecated)::3172 Deprecated alias for `sendemail.signedoffbycc`.31733174sendemail.smtpBatchSize::3175 Number of messages to be sent per connection, after that a relogin3176 will happen. If the value is 0 or undefined, send all messages in3177 one connection.3178 See also the `--batch-size` option of linkgit:git-send-email[1].31793180sendemail.smtpReloginDelay::3181 Seconds wait before reconnecting to smtp server.3182 See also the `--relogin-delay` option of linkgit:git-send-email[1].31833184showbranch.default::3185 The default set of branches for linkgit:git-show-branch[1].3186 See linkgit:git-show-branch[1].31873188splitIndex.maxPercentChange::3189 When the split index feature is used, this specifies the3190 percent of entries the split index can contain compared to the3191 total number of entries in both the split index and the shared3192 index before a new shared index is written.3193 The value should be between 0 and 100. If the value is 0 then3194 a new shared index is always written, if it is 100 a new3195 shared index is never written.3196 By default the value is 20, so a new shared index is written3197 if the number of entries in the split index would be greater3198 than 20 percent of the total number of entries.3199 See linkgit:git-update-index[1].32003201splitIndex.sharedIndexExpire::3202 When the split index feature is used, shared index files that3203 were not modified since the time this variable specifies will3204 be removed when a new shared index file is created. The value3205 "now" expires all entries immediately, and "never" suppresses3206 expiration altogether.3207 The default value is "2.weeks.ago".3208 Note that a shared index file is considered modified (for the3209 purpose of expiration) each time a new split-index file is3210 either created based on it or read from it.3211 See linkgit:git-update-index[1].32123213status.relativePaths::3214 By default, linkgit:git-status[1] shows paths relative to the3215 current directory. Setting this variable to `false` shows paths3216 relative to the repository root (this was the default for Git3217 prior to v1.5.4).32183219status.short::3220 Set to true to enable --short by default in linkgit:git-status[1].3221 The option --no-short takes precedence over this variable.32223223status.branch::3224 Set to true to enable --branch by default in linkgit:git-status[1].3225 The option --no-branch takes precedence over this variable.32263227status.displayCommentPrefix::3228 If set to true, linkgit:git-status[1] will insert a comment3229 prefix before each output line (starting with3230 `core.commentChar`, i.e. `#` by default). This was the3231 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3232 Defaults to false.32333234status.renameLimit::3235 The number of files to consider when performing rename detection3236 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3237 the value of diff.renameLimit.32383239status.renames::3240 Whether and how Git detects renames in linkgit:git-status[1] and3241 linkgit:git-commit[1] . If set to "false", rename detection is3242 disabled. If set to "true", basic rename detection is enabled.3243 If set to "copies" or "copy", Git will detect copies, as well.3244 Defaults to the value of diff.renames.32453246status.showStash::3247 If set to true, linkgit:git-status[1] will display the number of3248 entries currently stashed away.3249 Defaults to false.32503251status.showUntrackedFiles::3252 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3253 files which are not currently tracked by Git. Directories which3254 contain only untracked files, are shown with the directory name3255 only. Showing untracked files means that Git needs to lstat() all3256 the files in the whole repository, which might be slow on some3257 systems. So, this variable controls how the commands displays3258 the untracked files. Possible values are:3259+3260--3261* `no` - Show no untracked files.3262* `normal` - Show untracked files and directories.3263* `all` - Show also individual files in untracked directories.3264--3265+3266If this variable is not specified, it defaults to 'normal'.3267This variable can be overridden with the -u|--untracked-files option3268of linkgit:git-status[1] and linkgit:git-commit[1].32693270status.submoduleSummary::3271 Defaults to false.3272 If this is set to a non zero number or true (identical to -1 or an3273 unlimited number), the submodule summary will be enabled and a3274 summary of commits for modified submodules will be shown (see3275 --summary-limit option of linkgit:git-submodule[1]). Please note3276 that the summary output command will be suppressed for all3277 submodules when `diff.ignoreSubmodules` is set to 'all' or only3278 for those submodules where `submodule.<name>.ignore=all`. The only3279 exception to that rule is that status and commit will show staged3280 submodule changes. To3281 also view the summary for ignored submodules you can either use3282 the --ignore-submodules=dirty command-line option or the 'git3283 submodule summary' command, which shows a similar output but does3284 not honor these settings.32853286stash.showPatch::3287 If this is set to true, the `git stash show` command without an3288 option will show the stash entry in patch form. Defaults to false.3289 See description of 'show' command in linkgit:git-stash[1].32903291stash.showStat::3292 If this is set to true, the `git stash show` command without an3293 option will show diffstat of the stash entry. Defaults to true.3294 See description of 'show' command in linkgit:git-stash[1].32953296submodule.<name>.url::3297 The URL for a submodule. This variable is copied from the .gitmodules3298 file to the git config via 'git submodule init'. The user can change3299 the configured URL before obtaining the submodule via 'git submodule3300 update'. If neither submodule.<name>.active or submodule.active are3301 set, the presence of this variable is used as a fallback to indicate3302 whether the submodule is of interest to git commands.3303 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.33043305submodule.<name>.update::3306 The method by which a submodule is updated by 'git submodule update',3307 which is the only affected command, others such as3308 'git checkout --recurse-submodules' are unaffected. It exists for3309 historical reasons, when 'git submodule' was the only command to3310 interact with submodules; settings like `submodule.active`3311 and `pull.rebase` are more specific. It is populated by3312 `git submodule init` from the linkgit:gitmodules[5] file.3313 See description of 'update' command in linkgit:git-submodule[1].33143315submodule.<name>.branch::3316 The remote branch name for a submodule, used by `git submodule3317 update --remote`. Set this option to override the value found in3318 the `.gitmodules` file. See linkgit:git-submodule[1] and3319 linkgit:gitmodules[5] for details.33203321submodule.<name>.fetchRecurseSubmodules::3322 This option can be used to control recursive fetching of this3323 submodule. It can be overridden by using the --[no-]recurse-submodules3324 command-line option to "git fetch" and "git pull".3325 This setting will override that from in the linkgit:gitmodules[5]3326 file.33273328submodule.<name>.ignore::3329 Defines under what circumstances "git status" and the diff family show3330 a submodule as modified. When set to "all", it will never be considered3331 modified (but it will nonetheless show up in the output of status and3332 commit when it has been staged), "dirty" will ignore all changes3333 to the submodules work tree and3334 takes only differences between the HEAD of the submodule and the commit3335 recorded in the superproject into account. "untracked" will additionally3336 let submodules with modified tracked files in their work tree show up.3337 Using "none" (the default when this option is not set) also shows3338 submodules that have untracked files in their work tree as changed.3339 This setting overrides any setting made in .gitmodules for this submodule,3340 both settings can be overridden on the command line by using the3341 "--ignore-submodules" option. The 'git submodule' commands are not3342 affected by this setting.33433344submodule.<name>.active::3345 Boolean value indicating if the submodule is of interest to git3346 commands. This config option takes precedence over the3347 submodule.active config option. See linkgit:gitsubmodules[7] for3348 details.33493350submodule.active::3351 A repeated field which contains a pathspec used to match against a3352 submodule's path to determine if the submodule is of interest to git3353 commands. See linkgit:gitsubmodules[7] for details.33543355submodule.recurse::3356 Specifies if commands recurse into submodules by default. This3357 applies to all commands that have a `--recurse-submodules` option,3358 except `clone`.3359 Defaults to false.33603361submodule.fetchJobs::3362 Specifies how many submodules are fetched/cloned at the same time.3363 A positive integer allows up to that number of submodules fetched3364 in parallel. A value of 0 will give some reasonable default.3365 If unset, it defaults to 1.33663367submodule.alternateLocation::3368 Specifies how the submodules obtain alternates when submodules are3369 cloned. Possible values are `no`, `superproject`.3370 By default `no` is assumed, which doesn't add references. When the3371 value is set to `superproject` the submodule to be cloned computes3372 its alternates location relative to the superprojects alternate.33733374submodule.alternateErrorStrategy::3375 Specifies how to treat errors with the alternates for a submodule3376 as computed via `submodule.alternateLocation`. Possible values are3377 `ignore`, `info`, `die`. Default is `die`.33783379tag.forceSignAnnotated::3380 A boolean to specify whether annotated tags created should be GPG signed.3381 If `--annotate` is specified on the command line, it takes3382 precedence over this option.33833384tag.sort::3385 This variable controls the sort ordering of tags when displayed by3386 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3387 value of this variable will be used as the default.33883389tar.umask::3390 This variable can be used to restrict the permission bits of3391 tar archive entries. The default is 0002, which turns off the3392 world write bit. The special value "user" indicates that the3393 archiving user's umask will be used instead. See umask(2) and3394 linkgit:git-archive[1].33953396transfer.fsckObjects::3397 When `fetch.fsckObjects` or `receive.fsckObjects` are3398 not set, the value of this variable is used instead.3399 Defaults to false.34003401transfer.hideRefs::3402 String(s) `receive-pack` and `upload-pack` use to decide which3403 refs to omit from their initial advertisements. Use more than3404 one definition to specify multiple prefix strings. A ref that is3405 under the hierarchies listed in the value of this variable is3406 excluded, and is hidden when responding to `git push` or `git3407 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3408 program-specific versions of this config.3409+3410You may also include a `!` in front of the ref name to negate the entry,3411explicitly exposing it, even if an earlier entry marked it as hidden.3412If you have multiple hideRefs values, later entries override earlier ones3413(and entries in more-specific config files override less-specific ones).3414+3415If a namespace is in use, the namespace prefix is stripped from each3416reference before it is matched against `transfer.hiderefs` patterns.3417For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3418the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3419is omitted from the advertisements but `refs/heads/master` and3420`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3421"have" lines. In order to match refs before stripping, add a `^` in front of3422the ref name. If you combine `!` and `^`, `!` must be specified first.3423+3424Even if you hide refs, a client may still be able to steal the target3425objects via the techniques described in the "SECURITY" section of the3426linkgit:gitnamespaces[7] man page; it's best to keep private data in a3427separate repository.34283429transfer.unpackLimit::3430 When `fetch.unpackLimit` or `receive.unpackLimit` are3431 not set, the value of this variable is used instead.3432 The default value is 100.34333434uploadarchive.allowUnreachable::3435 If true, allow clients to use `git archive --remote` to request3436 any tree, whether reachable from the ref tips or not. See the3437 discussion in the "SECURITY" section of3438 linkgit:git-upload-archive[1] for more details. Defaults to3439 `false`.34403441uploadpack.hideRefs::3442 This variable is the same as `transfer.hideRefs`, but applies3443 only to `upload-pack` (and so affects only fetches, not pushes).3444 An attempt to fetch a hidden ref by `git fetch` will fail. See3445 also `uploadpack.allowTipSHA1InWant`.34463447uploadpack.allowTipSHA1InWant::3448 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3449 to accept a fetch request that asks for an object at the tip3450 of a hidden ref (by default, such a request is rejected).3451 See also `uploadpack.hideRefs`. Even if this is false, a client3452 may be able to steal objects via the techniques described in the3453 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3454 best to keep private data in a separate repository.34553456uploadpack.allowReachableSHA1InWant::3457 Allow `upload-pack` to accept a fetch request that asks for an3458 object that is reachable from any ref tip. However, note that3459 calculating object reachability is computationally expensive.3460 Defaults to `false`. Even if this is false, a client may be able3461 to steal objects via the techniques described in the "SECURITY"3462 section of the linkgit:gitnamespaces[7] man page; it's best to3463 keep private data in a separate repository.34643465uploadpack.allowAnySHA1InWant::3466 Allow `upload-pack` to accept a fetch request that asks for any3467 object at all.3468 Defaults to `false`.34693470uploadpack.keepAlive::3471 When `upload-pack` has started `pack-objects`, there may be a3472 quiet period while `pack-objects` prepares the pack. Normally3473 it would output progress information, but if `--quiet` was used3474 for the fetch, `pack-objects` will output nothing at all until3475 the pack data begins. Some clients and networks may consider3476 the server to be hung and give up. Setting this option instructs3477 `upload-pack` to send an empty keepalive packet every3478 `uploadpack.keepAlive` seconds. Setting this option to 03479 disables keepalive packets entirely. The default is 5 seconds.34803481uploadpack.packObjectsHook::3482 If this option is set, when `upload-pack` would run3483 `git pack-objects` to create a packfile for a client, it will3484 run this shell command instead. The `pack-objects` command and3485 arguments it _would_ have run (including the `git pack-objects`3486 at the beginning) are appended to the shell command. The stdin3487 and stdout of the hook are treated as if `pack-objects` itself3488 was run. I.e., `upload-pack` will feed input intended for3489 `pack-objects` to the hook, and expects a completed packfile on3490 stdout.34913492uploadpack.allowFilter::3493 If this option is set, `upload-pack` will support partial3494 clone and partial fetch object filtering.3495+3496Note that this configuration variable is ignored if it is seen in the3497repository-level config (this is a safety measure against fetching from3498untrusted repositories).34993500uploadpack.allowRefInWant::3501 If this option is set, `upload-pack` will support the `ref-in-want`3502 feature of the protocol version 2 `fetch` command. This feature3503 is intended for the benefit of load-balanced servers which may3504 not have the same view of what OIDs their refs point to due to3505 replication delay.35063507url.<base>.insteadOf::3508 Any URL that starts with this value will be rewritten to3509 start, instead, with <base>. In cases where some site serves a3510 large number of repositories, and serves them with multiple3511 access methods, and some users need to use different access3512 methods, this feature allows people to specify any of the3513 equivalent URLs and have Git automatically rewrite the URL to3514 the best alternative for the particular user, even for a3515 never-before-seen repository on the site. When more than one3516 insteadOf strings match a given URL, the longest match is used.3517+3518Note that any protocol restrictions will be applied to the rewritten3519URL. If the rewrite changes the URL to use a custom protocol or remote3520helper, you may need to adjust the `protocol.*.allow` config to permit3521the request. In particular, protocols you expect to use for submodules3522must be set to `always` rather than the default of `user`. See the3523description of `protocol.allow` above.35243525url.<base>.pushInsteadOf::3526 Any URL that starts with this value will not be pushed to;3527 instead, it will be rewritten to start with <base>, and the3528 resulting URL will be pushed to. In cases where some site serves3529 a large number of repositories, and serves them with multiple3530 access methods, some of which do not allow push, this feature3531 allows people to specify a pull-only URL and have Git3532 automatically use an appropriate URL to push, even for a3533 never-before-seen repository on the site. When more than one3534 pushInsteadOf strings match a given URL, the longest match is3535 used. If a remote has an explicit pushurl, Git will ignore this3536 setting for that remote.35373538user.email::3539 Your email address to be recorded in any newly created commits.3540 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3541 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35423543user.name::3544 Your full name to be recorded in any newly created commits.3545 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3546 environment variables. See linkgit:git-commit-tree[1].35473548user.useConfigOnly::3549 Instruct Git to avoid trying to guess defaults for `user.email`3550 and `user.name`, and instead retrieve the values only from the3551 configuration. For example, if you have multiple email addresses3552 and would like to use a different one for each repository, then3553 with this configuration option set to `true` in the global config3554 along with a name, Git will prompt you to set up an email before3555 making new commits in a newly cloned repository.3556 Defaults to `false`.35573558user.signingKey::3559 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3560 key you want it to automatically when creating a signed tag or3561 commit, you can override the default selection with this variable.3562 This option is passed unchanged to gpg's --local-user parameter,3563 so you may specify a key using any method that gpg supports.35643565versionsort.prereleaseSuffix (deprecated)::3566 Deprecated alias for `versionsort.suffix`. Ignored if3567 `versionsort.suffix` is set.35683569versionsort.suffix::3570 Even when version sort is used in linkgit:git-tag[1], tagnames3571 with the same base version but different suffixes are still sorted3572 lexicographically, resulting e.g. in prerelease tags appearing3573 after the main release (e.g. "1.0-rc1" after "1.0"). This3574 variable can be specified to determine the sorting order of tags3575 with different suffixes.3576+3577By specifying a single suffix in this variable, any tagname containing3578that suffix will appear before the corresponding main release. E.g. if3579the variable is set to "-rc", then all "1.0-rcX" tags will appear before3580"1.0". If specified multiple times, once per suffix, then the order of3581suffixes in the configuration will determine the sorting order of tagnames3582with those suffixes. E.g. if "-pre" appears before "-rc" in the3583configuration, then all "1.0-preX" tags will be listed before any3584"1.0-rcX" tags. The placement of the main release tag relative to tags3585with various suffixes can be determined by specifying the empty suffix3586among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3587"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3588are listed first, followed by "v4.8", then "v4.8-ckX" and finally3589"v4.8-bfsX".3590+3591If more than one suffixes match the same tagname, then that tagname will3592be sorted according to the suffix which starts at the earliest position in3593the tagname. If more than one different matching suffixes start at3594that earliest position, then that tagname will be sorted according to the3595longest of those suffixes.3596The sorting order between different suffixes is undefined if they are3597in multiple config files.35983599web.browser::3600 Specify a web browser that may be used by some commands.3601 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3602 may use it.36033604worktree.guessRemote::3605 With `add`, if no branch argument, and neither of `-b` nor3606 `-B` nor `--detach` are given, the command defaults to3607 creating a new branch from HEAD. If `worktree.guessRemote` is3608 set to true, `worktree add` tries to find a remote-tracking3609 branch whose name uniquely matches the new branch name. If3610 such a branch exists, it is checked out and set as "upstream"3611 for the new branch. If no such match can be found, it falls3612 back to creating a new branch from the current HEAD.