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 an 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 If true, this option enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like FAT. For example, if a directory listing finds 396 "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 404core.precomposeUnicode:: 405 This option is only used by Mac OS implementation of Git. 406 When core.precomposeUnicode=true, Git reverts the unicode decomposition 407 of filenames done by Mac OS. This is useful when sharing a repository 408 between Mac OS and Linux or Windows. 409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 410 When false, file names are handled fully transparent by Git, 411 which is backward compatible with older versions of Git. 412 413core.protectHFS:: 414 If set to true, do not allow checkout of paths that would 415 be considered equivalent to `.git` on an HFS+ filesystem. 416 Defaults to `true` on Mac OS, and `false` elsewhere. 417 418core.protectNTFS:: 419 If set to true, do not allow checkout of paths that would 420 cause problems with the NTFS filesystem, e.g. conflict with 421 8.3 "short" names. 422 Defaults to `true` on Windows, and `false` elsewhere. 423 424core.fsmonitor:: 425 If set, the value of this variable is used as a command which 426 will identify all files that may have changed since the 427 requested date/time. This information is used to speed up git by 428 avoiding unnecessary processing of files that have not changed. 429 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 430 431core.trustctime:: 432 If false, the ctime differences between the index and the 433 working tree are ignored; useful when the inode change time 434 is regularly modified by something outside Git (file system 435 crawlers and some backup systems). 436 See linkgit:git-update-index[1]. True by default. 437 438core.splitIndex:: 439 If true, the split-index feature of the index will be used. 440 See linkgit:git-update-index[1]. False by default. 441 442core.untrackedCache:: 443 Determines what to do about the untracked cache feature of the 444 index. It will be kept, if this variable is unset or set to 445 `keep`. It will automatically be added if set to `true`. And 446 it will automatically be removed, if set to `false`. Before 447 setting it to `true`, you should check that mtime is working 448 properly on your system. 449 See linkgit:git-update-index[1]. `keep` by default. 450 451core.checkStat:: 452 Determines which stat fields to match between the index 453 and work tree. The user can set this to 'default' or 454 'minimal'. Default (or explicitly 'default'), is to check 455 all fields, including the sub-second part of mtime and ctime. 456 457core.quotePath:: 458 Commands that output paths (e.g. 'ls-files', 'diff'), will 459 quote "unusual" characters in the pathname by enclosing the 460 pathname in double-quotes and escaping those characters with 461 backslashes in the same way C escapes control characters (e.g. 462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 464 UTF-8). If this variable is set to false, bytes higher than 465 0x80 are not considered "unusual" any more. Double-quotes, 466 backslash and control characters are always escaped regardless 467 of the setting of this variable. A simple space character is 468 not considered "unusual". Many commands can output pathnames 469 completely verbatim using the `-z` option. The default value 470 is true. 471 472core.eol:: 473 Sets the line ending type to use in the working directory for 474 files that have the `text` property set when core.autocrlf is false. 475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 476 native line ending. The default value is `native`. See 477 linkgit:gitattributes[5] for more information on end-of-line 478 conversion. 479 480core.safecrlf:: 481 If true, makes Git check if converting `CRLF` is reversible when 482 end-of-line conversion is active. Git will verify if a command 483 modifies a file in the work tree either directly or indirectly. 484 For example, committing a file followed by checking out the 485 same file should yield the original file in the work tree. If 486 this is not the case for the current setting of 487 `core.autocrlf`, Git will reject the file. The variable can 488 be set to "warn", in which case Git will only warn about an 489 irreversible conversion but continue the operation. 490+ 491CRLF conversion bears a slight chance of corrupting data. 492When it is enabled, Git will convert CRLF to LF during commit and LF to 493CRLF during checkout. A file that contains a mixture of LF and 494CRLF before the commit cannot be recreated by Git. For text 495files this is the right thing to do: it corrects line endings 496such that we have only LF line endings in the repository. 497But for binary files that are accidentally classified as text the 498conversion can corrupt data. 499+ 500If you recognize such corruption early you can easily fix it by 501setting the conversion type explicitly in .gitattributes. Right 502after committing you still have the original file in your work 503tree and this file is not yet corrupted. You can explicitly tell 504Git that this file is binary and Git will handle the file 505appropriately. 506+ 507Unfortunately, the desired effect of cleaning up text files with 508mixed line endings and the undesired effect of corrupting binary 509files cannot be distinguished. In both cases CRLFs are removed 510in an irreversible way. For text files this is the right thing 511to do because CRLFs are line endings, while for binary files 512converting CRLFs corrupts data. 513+ 514Note, this safety check does not mean that a checkout will generate a 515file identical to the original file for a different setting of 516`core.eol` and `core.autocrlf`, but only for the current one. For 517example, a text file with `LF` would be accepted with `core.eol=lf` 518and could later be checked out with `core.eol=crlf`, in which case the 519resulting file would contain `CRLF`, although the original file 520contained `LF`. However, in both work trees the line endings would be 521consistent, that is either all `LF` or all `CRLF`, but never mixed. A 522file with mixed line endings would be reported by the `core.safecrlf` 523mechanism. 524 525core.autocrlf:: 526 Setting this variable to "true" is the same as setting 527 the `text` attribute to "auto" on all files and core.eol to "crlf". 528 Set to true if you want to have `CRLF` line endings in your 529 working directory and the repository has LF line endings. 530 This variable can be set to 'input', 531 in which case no output conversion is performed. 532 533core.symlinks:: 534 If false, symbolic links are checked out as small plain files that 535 contain the link text. linkgit:git-update-index[1] and 536 linkgit:git-add[1] will not change the recorded type to regular 537 file. Useful on filesystems like FAT that do not support 538 symbolic links. 539+ 540The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 541will probe and set core.symlinks false if appropriate when the repository 542is created. 543 544core.gitProxy:: 545 A "proxy command" to execute (as 'command host port') instead 546 of establishing direct connection to the remote server when 547 using the Git protocol for fetching. If the variable value is 548 in the "COMMAND for DOMAIN" format, the command is applied only 549 on hostnames ending with the specified domain string. This variable 550 may be set multiple times and is matched in the given order; 551 the first match wins. 552+ 553Can be overridden by the `GIT_PROXY_COMMAND` environment variable 554(which always applies universally, without the special "for" 555handling). 556+ 557The special string `none` can be used as the proxy command to 558specify that no proxy be used for a given domain pattern. 559This is useful for excluding servers inside a firewall from 560proxy use, while defaulting to a common proxy for external domains. 561 562core.sshCommand:: 563 If this variable is set, `git fetch` and `git push` will 564 use the specified command instead of `ssh` when they need to 565 connect to a remote system. The command is in the same form as 566 the `GIT_SSH_COMMAND` environment variable and is overridden 567 when the environment variable is set. 568 569core.ignoreStat:: 570 If true, Git will avoid using lstat() calls to detect if files have 571 changed by setting the "assume-unchanged" bit for those tracked files 572 which it has updated identically in both the index and working tree. 573+ 574When files are modified outside of Git, the user will need to stage 575the modified files explicitly (e.g. see 'Examples' section in 576linkgit:git-update-index[1]). 577Git will not normally detect changes to those files. 578+ 579This is useful on systems where lstat() calls are very slow, such as 580CIFS/Microsoft Windows. 581+ 582False by default. 583 584core.preferSymlinkRefs:: 585 Instead of the default "symref" format for HEAD 586 and other symbolic reference files, use symbolic links. 587 This is sometimes needed to work with old scripts that 588 expect HEAD to be a symbolic link. 589 590core.bare:: 591 If true this repository is assumed to be 'bare' and has no 592 working directory associated with it. If this is the case a 593 number of commands that require a working directory will be 594 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 595+ 596This setting is automatically guessed by linkgit:git-clone[1] or 597linkgit:git-init[1] when the repository was created. By default a 598repository that ends in "/.git" is assumed to be not bare (bare = 599false), while all other repositories are assumed to be bare (bare 600= true). 601 602core.worktree:: 603 Set the path to the root of the working tree. 604 If `GIT_COMMON_DIR` environment variable is set, core.worktree 605 is ignored and not used for determining the root of working tree. 606 This can be overridden by the `GIT_WORK_TREE` environment 607 variable and the `--work-tree` command-line option. 608 The value can be an absolute path or relative to the path to 609 the .git directory, which is either specified by --git-dir 610 or GIT_DIR, or automatically discovered. 611 If --git-dir or GIT_DIR is specified but none of 612 --work-tree, GIT_WORK_TREE and core.worktree is specified, 613 the current working directory is regarded as the top level 614 of your working tree. 615+ 616Note that this variable is honored even when set in a configuration 617file in a ".git" subdirectory of a directory and its value differs 618from the latter directory (e.g. "/path/to/.git/config" has 619core.worktree set to "/different/path"), which is most likely a 620misconfiguration. Running Git commands in the "/path/to" directory will 621still use "/different/path" as the root of the work tree and can cause 622confusion unless you know what you are doing (e.g. you are creating a 623read-only snapshot of the same index to a location different from the 624repository's usual working tree). 625 626core.logAllRefUpdates:: 627 Enable the reflog. Updates to a ref <ref> is logged to the file 628 "`$GIT_DIR/logs/<ref>`", by appending the new and old 629 SHA-1, the date/time and the reason of the update, but 630 only when the file exists. If this configuration 631 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 632 file is automatically created for branch heads (i.e. under 633 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 634 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 635 If it is set to `always`, then a missing reflog is automatically 636 created for any ref under `refs/`. 637+ 638This information can be used to determine what commit 639was the tip of a branch "2 days ago". 640+ 641This value is true by default in a repository that has 642a working directory associated with it, and false by 643default in a bare repository. 644 645core.repositoryFormatVersion:: 646 Internal variable identifying the repository format and layout 647 version. 648 649core.sharedRepository:: 650 When 'group' (or 'true'), the repository is made shareable between 651 several users in a group (making sure all the files and objects are 652 group-writable). When 'all' (or 'world' or 'everybody'), the 653 repository will be readable by all users, additionally to being 654 group-shareable. When 'umask' (or 'false'), Git will use permissions 655 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 656 files in the repository will have this mode value. '0xxx' will override 657 user's umask value (whereas the other options will only override 658 requested parts of the user's umask value). Examples: '0660' will make 659 the repo read/write-able for the owner and group, but inaccessible to 660 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 661 repository that is group-readable but not group-writable. 662 See linkgit:git-init[1]. False by default. 663 664core.warnAmbiguousRefs:: 665 If true, Git will warn you if the ref name you passed it is ambiguous 666 and might match multiple refs in the repository. True by default. 667 668core.compression:: 669 An integer -1..9, indicating a default compression level. 670 -1 is the zlib default. 0 means no compression, 671 and 1..9 are various speed/size tradeoffs, 9 being slowest. 672 If set, this provides a default to other compression variables, 673 such as `core.looseCompression` and `pack.compression`. 674 675core.looseCompression:: 676 An integer -1..9, indicating the compression level for objects that 677 are not in a pack file. -1 is the zlib default. 0 means no 678 compression, and 1..9 are various speed/size tradeoffs, 9 being 679 slowest. If not set, defaults to core.compression. If that is 680 not set, defaults to 1 (best speed). 681 682core.packedGitWindowSize:: 683 Number of bytes of a pack file to map into memory in a 684 single mapping operation. Larger window sizes may allow 685 your system to process a smaller number of large pack files 686 more quickly. Smaller window sizes will negatively affect 687 performance due to increased calls to the operating system's 688 memory manager, but may improve performance when accessing 689 a large number of large pack files. 690+ 691Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 692MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 693be reasonable for all users/operating systems. You probably do 694not need to adjust this value. 695+ 696Common unit suffixes of 'k', 'm', or 'g' are supported. 697 698core.packedGitLimit:: 699 Maximum number of bytes to map simultaneously into memory 700 from pack files. If Git needs to access more than this many 701 bytes at once to complete an operation it will unmap existing 702 regions to reclaim virtual address space within the process. 703+ 704Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 705unlimited) on 64 bit platforms. 706This should be reasonable for all users/operating systems, except on 707the largest projects. You probably do not need to adjust this value. 708+ 709Common unit suffixes of 'k', 'm', or 'g' are supported. 710 711core.deltaBaseCacheLimit:: 712 Maximum number of bytes to reserve for caching base objects 713 that may be referenced by multiple deltified objects. By storing the 714 entire decompressed base objects in a cache Git is able 715 to avoid unpacking and decompressing frequently used base 716 objects multiple times. 717+ 718Default is 96 MiB on all platforms. This should be reasonable 719for all users/operating systems, except on the largest projects. 720You probably do not need to adjust this value. 721+ 722Common unit suffixes of 'k', 'm', or 'g' are supported. 723 724core.bigFileThreshold:: 725 Files larger than this size are stored deflated, without 726 attempting delta compression. Storing large files without 727 delta compression avoids excessive memory usage, at the 728 slight expense of increased disk usage. Additionally files 729 larger than this size are always treated as binary. 730+ 731Default is 512 MiB on all platforms. This should be reasonable 732for most projects as source code and other text files can still 733be delta compressed, but larger binary media files won't be. 734+ 735Common unit suffixes of 'k', 'm', or 'g' are supported. 736 737core.excludesFile:: 738 Specifies the pathname to the file that contains patterns to 739 describe paths that are not meant to be tracked, in addition 740 to '.gitignore' (per-directory) and '.git/info/exclude'. 741 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 742 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 743 is used instead. See linkgit:gitignore[5]. 744 745core.askPass:: 746 Some commands (e.g. svn and http interfaces) that interactively 747 ask for a password can be told to use an external program given 748 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 749 environment variable. If not set, fall back to the value of the 750 `SSH_ASKPASS` environment variable or, failing that, a simple password 751 prompt. The external program shall be given a suitable prompt as 752 command-line argument and write the password on its STDOUT. 753 754core.attributesFile:: 755 In addition to '.gitattributes' (per-directory) and 756 '.git/info/attributes', Git looks into this file for attributes 757 (see linkgit:gitattributes[5]). Path expansions are made the same 758 way as for `core.excludesFile`. Its default value is 759 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 760 set or empty, `$HOME/.config/git/attributes` is used instead. 761 762core.hooksPath:: 763 By default Git will look for your hooks in the 764 '$GIT_DIR/hooks' directory. Set this to different path, 765 e.g. '/etc/git/hooks', and Git will try to find your hooks in 766 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 767 in '$GIT_DIR/hooks/pre-receive'. 768+ 769The path can be either absolute or relative. A relative path is 770taken as relative to the directory where the hooks are run (see 771the "DESCRIPTION" section of linkgit:githooks[5]). 772+ 773This configuration variable is useful in cases where you'd like to 774centrally configure your Git hooks instead of configuring them on a 775per-repository basis, or as a more flexible and centralized 776alternative to having an `init.templateDir` where you've changed 777default hooks. 778 779core.editor:: 780 Commands such as `commit` and `tag` that let you edit 781 messages by launching an editor use the value of this 782 variable when it is set, and the environment variable 783 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 784 785core.commentChar:: 786 Commands such as `commit` and `tag` that let you edit 787 messages consider a line that begins with this character 788 commented, and removes them after the editor returns 789 (default '#'). 790+ 791If set to "auto", `git-commit` would select a character that is not 792the beginning character of any line in existing commit messages. 793 794core.filesRefLockTimeout:: 795 The length of time, in milliseconds, to retry when trying to 796 lock an individual reference. Value 0 means not to retry at 797 all; -1 means to try indefinitely. Default is 100 (i.e., 798 retry for 100ms). 799 800core.packedRefsTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock the `packed-refs` file. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 1000 (i.e., 804 retry for 1 second). 805 806sequence.editor:: 807 Text editor used by `git rebase -i` for editing the rebase instruction file. 808 The value is meant to be interpreted by the shell when it is used. 809 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 810 When not configured the default commit message editor is used instead. 811 812core.pager:: 813 Text viewer for use by Git commands (e.g., 'less'). The value 814 is meant to be interpreted by the shell. The order of preference 815 is the `$GIT_PAGER` environment variable, then `core.pager` 816 configuration, then `$PAGER`, and then the default chosen at 817 compile time (usually 'less'). 818+ 819When the `LESS` environment variable is unset, Git sets it to `FRX` 820(if `LESS` environment variable is set, Git does not change it at 821all). If you want to selectively override Git's default setting 822for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 823be passed to the shell by Git, which will translate the final 824command to `LESS=FRX less -S`. The environment does not set the 825`S` option but the command line does, instructing less to truncate 826long lines. Similarly, setting `core.pager` to `less -+F` will 827deactivate the `F` option specified by the environment from the 828command-line, deactivating the "quit if one screen" behavior of 829`less`. One can specifically activate some flags for particular 830commands: for example, setting `pager.blame` to `less -S` enables 831line truncation only for `git blame`. 832+ 833Likewise, when the `LV` environment variable is unset, Git sets it 834to `-c`. You can override this setting by exporting `LV` with 835another value or setting `core.pager` to `lv +c`. 836 837core.whitespace:: 838 A comma separated list of common whitespace problems to 839 notice. 'git diff' will use `color.diff.whitespace` to 840 highlight them, and 'git apply --whitespace=error' will 841 consider them as errors. You can prefix `-` to disable 842 any of them (e.g. `-trailing-space`): 843+ 844* `blank-at-eol` treats trailing whitespaces at the end of the line 845 as an error (enabled by default). 846* `space-before-tab` treats a space character that appears immediately 847 before a tab character in the initial indent part of the line as an 848 error (enabled by default). 849* `indent-with-non-tab` treats a line that is indented with space 850 characters instead of the equivalent tabs as an error (not enabled by 851 default). 852* `tab-in-indent` treats a tab character in the initial indent part of 853 the line as an error (not enabled by default). 854* `blank-at-eof` treats blank lines added at the end of file as an error 855 (enabled by default). 856* `trailing-space` is a short-hand to cover both `blank-at-eol` and 857 `blank-at-eof`. 858* `cr-at-eol` treats a carriage-return at the end of line as 859 part of the line terminator, i.e. with it, `trailing-space` 860 does not trigger if the character before such a carriage-return 861 is not a whitespace (not enabled by default). 862* `tabwidth=<n>` tells how many character positions a tab occupies; this 863 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 864 errors. The default tab width is 8. Allowed values are 1 to 63. 865 866core.fsyncObjectFiles:: 867 This boolean will enable 'fsync()' when writing object files. 868+ 869This is a total waste of time and effort on a filesystem that orders 870data writes properly, but can be useful for filesystems that do not use 871journalling (traditional UNIX filesystems) or that only journal metadata 872and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 873 874core.preloadIndex:: 875 Enable parallel index preload for operations like 'git diff' 876+ 877This can speed up operations like 'git diff' and 'git status' especially 878on filesystems like NFS that have weak caching semantics and thus 879relatively high IO latencies. When enabled, Git will do the 880index comparison to the filesystem data in parallel, allowing 881overlapping IO's. Defaults to true. 882 883core.createObject:: 884 You can set this to 'link', in which case a hardlink followed by 885 a delete of the source are used to make sure that object creation 886 will not overwrite existing objects. 887+ 888On some file system/operating system combinations, this is unreliable. 889Set this config setting to 'rename' there; However, This will remove the 890check that makes sure that existing object files will not get overwritten. 891 892core.notesRef:: 893 When showing commit messages, also show notes which are stored in 894 the given ref. The ref must be fully qualified. If the given 895 ref does not exist, it is not an error but means that no 896 notes should be printed. 897+ 898This setting defaults to "refs/notes/commits", and it can be overridden by 899the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 900 901core.sparseCheckout:: 902 Enable "sparse checkout" feature. See section "Sparse checkout" in 903 linkgit:git-read-tree[1] for more information. 904 905core.abbrev:: 906 Set the length object names are abbreviated to. If 907 unspecified or set to "auto", an appropriate value is 908 computed based on the approximate number of packed objects 909 in your repository, which hopefully is enough for 910 abbreviated object names to stay unique for some time. 911 The minimum length is 4. 912 913add.ignoreErrors:: 914add.ignore-errors (deprecated):: 915 Tells 'git add' to continue adding files when some files cannot be 916 added due to indexing errors. Equivalent to the `--ignore-errors` 917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 918 as it does not follow the usual naming convention for configuration 919 variables. 920 921alias.*:: 922 Command aliases for the linkgit:git[1] command wrapper - e.g. 923 after defining "alias.last = cat-file commit HEAD", the invocation 924 "git last" is equivalent to "git cat-file commit HEAD". To avoid 925 confusion and troubles with script usage, aliases that 926 hide existing Git commands are ignored. Arguments are split by 927 spaces, the usual shell quoting and escaping is supported. 928 A quote pair or a backslash can be used to quote them. 929+ 930If the alias expansion is prefixed with an exclamation point, 931it will be treated as a shell command. For example, defining 932"alias.new = !gitk --all --not ORIG_HEAD", the invocation 933"git new" is equivalent to running the shell command 934"gitk --all --not ORIG_HEAD". Note that shell commands will be 935executed from the top-level directory of a repository, which may 936not necessarily be the current directory. 937`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 938from the original current directory. See linkgit:git-rev-parse[1]. 939 940am.keepcr:: 941 If true, git-am will call git-mailsplit for patches in mbox format 942 with parameter `--keep-cr`. In this case git-mailsplit will 943 not remove `\r` from lines ending with `\r\n`. Can be overridden 944 by giving `--no-keep-cr` from the command line. 945 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 946 947am.threeWay:: 948 By default, `git am` will fail if the patch does not apply cleanly. When 949 set to true, this setting tells `git am` to fall back on 3-way merge if 950 the patch records the identity of blobs it is supposed to apply to and 951 we have those blobs available locally (equivalent to giving the `--3way` 952 option from the command line). Defaults to `false`. 953 See linkgit:git-am[1]. 954 955apply.ignoreWhitespace:: 956 When set to 'change', tells 'git apply' to ignore changes in 957 whitespace, in the same way as the `--ignore-space-change` 958 option. 959 When set to one of: no, none, never, false tells 'git apply' to 960 respect all whitespace differences. 961 See linkgit:git-apply[1]. 962 963apply.whitespace:: 964 Tells 'git apply' how to handle whitespaces, in the same way 965 as the `--whitespace` option. See linkgit:git-apply[1]. 966 967blame.showRoot:: 968 Do not treat root commits as boundaries in linkgit:git-blame[1]. 969 This option defaults to false. 970 971blame.blankBoundary:: 972 Show blank commit object name for boundary commits in 973 linkgit:git-blame[1]. This option defaults to false. 974 975blame.showEmail:: 976 Show the author email instead of author name in linkgit:git-blame[1]. 977 This option defaults to false. 978 979blame.date:: 980 Specifies the format used to output dates in linkgit:git-blame[1]. 981 If unset the iso format is used. For supported values, 982 see the discussion of the `--date` option at linkgit:git-log[1]. 983 984branch.autoSetupMerge:: 985 Tells 'git branch' and 'git checkout' to set up new branches 986 so that linkgit:git-pull[1] will appropriately merge from the 987 starting point branch. Note that even if this option is not set, 988 this behavior can be chosen per-branch using the `--track` 989 and `--no-track` options. The valid settings are: `false` -- no 990 automatic setup is done; `true` -- automatic setup is done when the 991 starting point is a remote-tracking branch; `always` -- 992 automatic setup is done when the starting point is either a 993 local branch or remote-tracking 994 branch. This option defaults to true. 995 996branch.autoSetupRebase:: 997 When a new branch is created with 'git branch' or 'git checkout' 998 that tracks another branch, this variable tells Git to set 999 up pull to rebase instead of merge (see "branch.<name>.rebase").1000 When `never`, rebase is never automatically set to true.1001 When `local`, rebase is set to true for tracked branches of1002 other local branches.1003 When `remote`, rebase is set to true for tracked branches of1004 remote-tracking branches.1005 When `always`, rebase will be set to true for all tracking1006 branches.1007 See "branch.autoSetupMerge" for details on how to set up a1008 branch to track another branch.1009 This option defaults to never.10101011branch.<name>.remote::1012 When on branch <name>, it tells 'git fetch' and 'git push'1013 which remote to fetch from/push to. The remote to push to1014 may be overridden with `remote.pushDefault` (for all branches).1015 The remote to push to, for the current branch, may be further1016 overridden by `branch.<name>.pushRemote`. If no remote is1017 configured, or if you are not on any branch, it defaults to1018 `origin` for fetching and `remote.pushDefault` for pushing.1019 Additionally, `.` (a period) is the current local repository1020 (a dot-repository), see `branch.<name>.merge`'s final note below.10211022branch.<name>.pushRemote::1023 When on branch <name>, it overrides `branch.<name>.remote` for1024 pushing. It also overrides `remote.pushDefault` for pushing1025 from branch <name>. When you pull from one place (e.g. your1026 upstream) and push to another place (e.g. your own publishing1027 repository), you would want to set `remote.pushDefault` to1028 specify the remote to push to for all branches, and use this1029 option to override it for a specific branch.10301031branch.<name>.merge::1032 Defines, together with branch.<name>.remote, the upstream branch1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1034 branch to merge and can also affect 'git push' (see push.default).1035 When in branch <name>, it tells 'git fetch' the default1036 refspec to be marked for merging in FETCH_HEAD. The value is1037 handled like the remote part of a refspec, and must match a1038 ref which is fetched from the remote given by1039 "branch.<name>.remote".1040 The merge information is used by 'git pull' (which at first calls1041 'git fetch') to lookup the default branch for merging. Without1042 this option, 'git pull' defaults to merge the first refspec fetched.1043 Specify multiple values to get an octopus merge.1044 If you wish to setup 'git pull' so that it merges into <name> from1045 another branch in the local repository, you can point1046 branch.<name>.merge to the desired branch, and use the relative path1047 setting `.` (a period) for branch.<name>.remote.10481049branch.<name>.mergeOptions::1050 Sets default options for merging into branch <name>. The syntax and1051 supported options are the same as those of linkgit:git-merge[1], but1052 option values containing whitespace characters are currently not1053 supported.10541055branch.<name>.rebase::1056 When true, rebase the branch <name> on top of the fetched branch,1057 instead of merging the default branch from the default remote when1058 "git pull" is run. See "pull.rebase" for doing this in a non1059 branch-specific manner.1060+1061When preserve, also pass `--preserve-merges` along to 'git rebase'1062so that locally committed merge commits will not be flattened1063by running 'git pull'.1064+1065When the value is `interactive`, the rebase is run in interactive mode.1066+1067*NOTE*: this is a possibly dangerous operation; do *not* use1068it unless you understand the implications (see linkgit:git-rebase[1]1069for details).10701071branch.<name>.description::1072 Branch description, can be edited with1073 `git branch --edit-description`. Branch description is1074 automatically added in the format-patch cover letter or1075 request-pull summary.10761077browser.<tool>.cmd::1078 Specify the command to invoke the specified browser. The1079 specified command is evaluated in shell with the URLs passed1080 as arguments. (See linkgit:git-web{litdd}browse[1].)10811082browser.<tool>.path::1083 Override the path for the given tool that may be used to1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1085 working repository in gitweb (see linkgit:git-instaweb[1]).10861087clean.requireForce::1088 A boolean to make git-clean do nothing unless given -f,1089 -i or -n. Defaults to true.10901091color.branch::1092 A boolean to enable/disable color in the output of1093 linkgit:git-branch[1]. May be set to `always`,1094 `false` (or `never`) or `auto` (or `true`), in which case colors are used1095 only when the output is to a terminal. If unset, then the1096 value of `color.ui` is used (`auto` by default).10971098color.branch.<slot>::1099 Use customized color for branch coloration. `<slot>` is one of1100 `current` (the current branch), `local` (a local branch),1101 `remote` (a remote-tracking branch in refs/remotes/),1102 `upstream` (upstream tracking branch), `plain` (other1103 refs).11041105color.diff::1106 Whether to use ANSI escape sequences to add color to patches.1107 If this is set to `always`, linkgit:git-diff[1],1108 linkgit:git-log[1], and linkgit:git-show[1] will use color1109 for all patches. If it is set to `true` or `auto`, those1110 commands will only use color when output is to the terminal.1111 If unset, then the value of `color.ui` is used (`auto` by1112 default).1113+1114This does not affect linkgit:git-format-patch[1] or the1115'git-diff-{asterisk}' plumbing commands. Can be overridden on the1116command line with the `--color[=<when>]` option.11171118diff.colorMoved::1119 If set to either a valid `<mode>` or a true value, moved lines1120 in a diff are colored differently, for details of valid modes1121 see '--color-moved' in linkgit:git-diff[1]. If simply set to1122 true the default color mode will be used. When set to false,1123 moved lines are not colored.11241125color.diff.<slot>::1126 Use customized color for diff colorization. `<slot>` specifies1127 which part of the patch to use the specified color, and is one1128 of `context` (context text - `plain` is a historical synonym),1129 `meta` (metainformation), `frag`1130 (hunk header), 'func' (function in hunk header), `old` (removed lines),1131 `new` (added lines), `commit` (commit headers), `whitespace`1132 (highlighting whitespace errors), `oldMoved` (deleted lines),1133 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1134 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1135 and `newMovedAlternativeDimmed` (See the '<mode>'1136 setting of '--color-moved' in linkgit:git-diff[1] for details).11371138color.decorate.<slot>::1139 Use customized color for 'git log --decorate' output. `<slot>` is one1140 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1141 branches, remote-tracking branches, tags, stash and HEAD, respectively.11421143color.grep::1144 When set to `always`, always highlight matches. When `false` (or1145 `never`), never. When set to `true` or `auto`, use color only1146 when the output is written to the terminal. If unset, then the1147 value of `color.ui` is used (`auto` by default).11481149color.grep.<slot>::1150 Use customized color for grep colorization. `<slot>` specifies which1151 part of the line to use the specified color, and is one of1152+1153--1154`context`;;1155 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1156`filename`;;1157 filename prefix (when not using `-h`)1158`function`;;1159 function name lines (when using `-p`)1160`linenumber`;;1161 line number prefix (when using `-n`)1162`match`;;1163 matching text (same as setting `matchContext` and `matchSelected`)1164`matchContext`;;1165 matching text in context lines1166`matchSelected`;;1167 matching text in selected lines1168`selected`;;1169 non-matching text in selected lines1170`separator`;;1171 separators between fields on a line (`:`, `-`, and `=`)1172 and between hunks (`--`)1173--11741175color.interactive::1176 When set to `always`, always use colors for interactive prompts1177 and displays (such as those used by "git-add --interactive" and1178 "git-clean --interactive"). When false (or `never`), never.1179 When set to `true` or `auto`, use colors only when the output is1180 to the terminal. If unset, then the value of `color.ui` is1181 used (`auto` by default).11821183color.interactive.<slot>::1184 Use customized color for 'git add --interactive' and 'git clean1185 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1186 or `error`, for four distinct types of normal output from1187 interactive commands.11881189color.pager::1190 A boolean to enable/disable colored output when the pager is in1191 use (default is true).11921193color.showBranch::1194 A boolean to enable/disable color in the output of1195 linkgit:git-show-branch[1]. May be set to `always`,1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used1197 only when the output is to a terminal. If unset, then the1198 value of `color.ui` is used (`auto` by default).11991200color.status::1201 A boolean to enable/disable color in the output of1202 linkgit:git-status[1]. May be set to `always`,1203 `false` (or `never`) or `auto` (or `true`), in which case colors are used1204 only when the output is to a terminal. If unset, then the1205 value of `color.ui` is used (`auto` by default).12061207color.status.<slot>::1208 Use customized color for status colorization. `<slot>` is1209 one of `header` (the header text of the status message),1210 `added` or `updated` (files which are added but not committed),1211 `changed` (files which are changed but not added in the index),1212 `untracked` (files which are not tracked by Git),1213 `branch` (the current branch),1214 `nobranch` (the color the 'no branch' warning is shown in, defaulting1215 to red),1216 `localBranch` or `remoteBranch` (the local and remote branch names,1217 respectively, when branch and tracking information is displayed in the1218 status short-format), or1219 `unmerged` (files which have unmerged changes).12201221color.ui::1222 This variable determines the default value for variables such1223 as `color.diff` and `color.grep` that control the use of color1224 per command family. Its scope will expand as more commands learn1225 configuration to set a default for the `--color` option. Set it1226 to `false` or `never` if you prefer Git commands not to use1227 color unless enabled explicitly with some other configuration1228 or the `--color` option. Set it to `always` if you want all1229 output not intended for machine consumption to use color, to1230 `true` or `auto` (this is the default since Git 1.8.4) if you1231 want such output to use color when written to the terminal.12321233column.ui::1234 Specify whether supported commands should output in columns.1235 This variable consists of a list of tokens separated by spaces1236 or commas:1237+1238These options control when the feature should be enabled1239(defaults to 'never'):1240+1241--1242`always`;;1243 always show in columns1244`never`;;1245 never show in columns1246`auto`;;1247 show in columns if the output is to the terminal1248--1249+1250These options control layout (defaults to 'column'). Setting any1251of these implies 'always' if none of 'always', 'never', or 'auto' are1252specified.1253+1254--1255`column`;;1256 fill columns before rows1257`row`;;1258 fill rows before columns1259`plain`;;1260 show in one column1261--1262+1263Finally, these options can be combined with a layout option (defaults1264to 'nodense'):1265+1266--1267`dense`;;1268 make unequal size columns to utilize more space1269`nodense`;;1270 make equal size columns1271--12721273column.branch::1274 Specify whether to output branch listing in `git branch` in columns.1275 See `column.ui` for details.12761277column.clean::1278 Specify the layout when list items in `git clean -i`, which always1279 shows files and directories in columns. See `column.ui` for details.12801281column.status::1282 Specify whether to output untracked files in `git status` in columns.1283 See `column.ui` for details.12841285column.tag::1286 Specify whether to output tag listing in `git tag` in columns.1287 See `column.ui` for details.12881289commit.cleanup::1290 This setting overrides the default of the `--cleanup` option in1291 `git commit`. See linkgit:git-commit[1] for details. Changing the1292 default can be useful when you always want to keep lines that begin1293 with comment character `#` in your log message, in which case you1294 would do `git config commit.cleanup whitespace` (note that you will1295 have to remove the help lines that begin with `#` in the commit log1296 template yourself, if you do this).12971298commit.gpgSign::12991300 A boolean to specify whether all commits should be GPG signed.1301 Use of this option when doing operations such as rebase can1302 result in a large number of commits being signed. It may be1303 convenient to use an agent to avoid typing your GPG passphrase1304 several times.13051306commit.status::1307 A boolean to enable/disable inclusion of status information in the1308 commit message template when using an editor to prepare the commit1309 message. Defaults to true.13101311commit.template::1312 Specify the pathname of a file to use as the template for1313 new commit messages.13141315commit.verbose::1316 A boolean or int to specify the level of verbose with `git commit`.1317 See linkgit:git-commit[1].13181319credential.helper::1320 Specify an external helper to be called when a username or1321 password credential is needed; the helper may consult external1322 storage to avoid prompting the user for the credentials. Note1323 that multiple helpers may be defined. See linkgit:gitcredentials[7]1324 for details.13251326credential.useHttpPath::1327 When acquiring credentials, consider the "path" component of an http1328 or https URL to be important. Defaults to false. See1329 linkgit:gitcredentials[7] for more information.13301331credential.username::1332 If no username is set for a network authentication, use this username1333 by default. See credential.<context>.* below, and1334 linkgit:gitcredentials[7].13351336credential.<url>.*::1337 Any of the credential.* options above can be applied selectively to1338 some credentials. For example "credential.https://example.com.username"1339 would set the default username only for https connections to1340 example.com. See linkgit:gitcredentials[7] for details on how URLs are1341 matched.13421343credentialCache.ignoreSIGHUP::1344 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13451346completion.commands::1347 This is only used by git-completion.bash to add or remove1348 commands from the list of completed commands. Normally only1349 porcelain commands and a few select others are completed. You1350 can add more commands, separated by space, in this1351 variable. Prefixing the command with '-' will remove it from1352 the existing list.13531354include::diff-config.txt[]13551356difftool.<tool>.path::1357 Override the path for the given tool. This is useful in case1358 your tool is not in the PATH.13591360difftool.<tool>.cmd::1361 Specify the command to invoke the specified diff tool.1362 The specified command is evaluated in shell with the following1363 variables available: 'LOCAL' is set to the name of the temporary1364 file containing the contents of the diff pre-image and 'REMOTE'1365 is set to the name of the temporary file containing the contents1366 of the diff post-image.13671368difftool.prompt::1369 Prompt before each invocation of the diff tool.13701371fastimport.unpackLimit::1372 If the number of objects imported by linkgit:git-fast-import[1]1373 is below this limit, then the objects will be unpacked into1374 loose object files. However if the number of imported objects1375 equals or exceeds this limit then the pack will be stored as a1376 pack. Storing the pack from a fast-import can make the import1377 operation complete faster, especially on slow filesystems. If1378 not set, the value of `transfer.unpackLimit` is used instead.13791380fetch.recurseSubmodules::1381 This option can be either set to a boolean value or to 'on-demand'.1382 Setting it to a boolean changes the behavior of fetch and pull to1383 unconditionally recurse into submodules when set to true or to not1384 recurse at all when set to false. When set to 'on-demand' (the default1385 value), fetch and pull will only recurse into a populated submodule1386 when its superproject retrieves a commit that updates the submodule's1387 reference.13881389fetch.fsckObjects::1390 If it is set to true, git-fetch-pack will check all fetched1391 objects. It will abort in the case of a malformed object or a1392 broken link. The result of an abort are only dangling objects.1393 Defaults to false. If not set, the value of `transfer.fsckObjects`1394 is used instead.13951396fetch.unpackLimit::1397 If the number of objects fetched over the Git native1398 transfer is below this1399 limit, then the objects will be unpacked into loose object1400 files. However if the number of received objects equals or1401 exceeds this limit then the received pack will be stored as1402 a pack, after adding any missing delta bases. Storing the1403 pack from a push can make the push operation complete faster,1404 especially on slow filesystems. If not set, the value of1405 `transfer.unpackLimit` is used instead.14061407fetch.prune::1408 If true, fetch will automatically behave as if the `--prune`1409 option was given on the command line. See also `remote.<name>.prune`1410 and the PRUNING section of linkgit:git-fetch[1].14111412fetch.pruneTags::1413 If true, fetch will automatically behave as if the1414 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1415 if not set already. This allows for setting both this option1416 and `fetch.prune` to maintain a 1=1 mapping to upstream1417 refs. See also `remote.<name>.pruneTags` and the PRUNING1418 section of linkgit:git-fetch[1].14191420fetch.output::1421 Control how ref update status is printed. Valid values are1422 `full` and `compact`. Default value is `full`. See section1423 OUTPUT in linkgit:git-fetch[1] for detail.14241425format.attach::1426 Enable multipart/mixed attachments as the default for1427 'format-patch'. The value can also be a double quoted string1428 which will enable attachments as the default and set the1429 value as the boundary. See the --attach option in1430 linkgit:git-format-patch[1].14311432format.from::1433 Provides the default value for the `--from` option to format-patch.1434 Accepts a boolean value, or a name and email address. If false,1435 format-patch defaults to `--no-from`, using commit authors directly in1436 the "From:" field of patch mails. If true, format-patch defaults to1437 `--from`, using your committer identity in the "From:" field of patch1438 mails and including a "From:" field in the body of the patch mail if1439 different. If set to a non-boolean value, format-patch uses that1440 value instead of your committer identity. Defaults to false.14411442format.numbered::1443 A boolean which can enable or disable sequence numbers in patch1444 subjects. It defaults to "auto" which enables it only if there1445 is more than one patch. It can be enabled or disabled for all1446 messages by setting it to "true" or "false". See --numbered1447 option in linkgit:git-format-patch[1].14481449format.headers::1450 Additional email headers to include in a patch to be submitted1451 by mail. See linkgit:git-format-patch[1].14521453format.to::1454format.cc::1455 Additional recipients to include in a patch to be submitted1456 by mail. See the --to and --cc options in1457 linkgit:git-format-patch[1].14581459format.subjectPrefix::1460 The default for format-patch is to output files with the '[PATCH]'1461 subject prefix. Use this variable to change that prefix.14621463format.signature::1464 The default for format-patch is to output a signature containing1465 the Git version number. Use this variable to change that default.1466 Set this variable to the empty string ("") to suppress1467 signature generation.14681469format.signatureFile::1470 Works just like format.signature except the contents of the1471 file specified by this variable will be used as the signature.14721473format.suffix::1474 The default for format-patch is to output files with the suffix1475 `.patch`. Use this variable to change that suffix (make sure to1476 include the dot if you want it).14771478format.pretty::1479 The default pretty format for log/show/whatchanged command,1480 See linkgit:git-log[1], linkgit:git-show[1],1481 linkgit:git-whatchanged[1].14821483format.thread::1484 The default threading style for 'git format-patch'. Can be1485 a boolean value, or `shallow` or `deep`. `shallow` threading1486 makes every mail a reply to the head of the series,1487 where the head is chosen from the cover letter, the1488 `--in-reply-to`, and the first patch mail, in this order.1489 `deep` threading makes every mail a reply to the previous one.1490 A true boolean value is the same as `shallow`, and a false1491 value disables threading.14921493format.signOff::1494 A boolean value which lets you enable the `-s/--signoff` option of1495 format-patch by default. *Note:* Adding the Signed-off-by: line to a1496 patch should be a conscious act and means that you certify you have1497 the rights to submit this work under the same open source license.1498 Please see the 'SubmittingPatches' document for further discussion.14991500format.coverLetter::1501 A boolean that controls whether to generate a cover-letter when1502 format-patch is invoked, but in addition can be set to "auto", to1503 generate a cover-letter only when there's more than one patch.15041505format.outputDirectory::1506 Set a custom directory to store the resulting files instead of the1507 current working directory.15081509format.useAutoBase::1510 A boolean value which lets you enable the `--base=auto` option of1511 format-patch by default.15121513filter.<driver>.clean::1514 The command which is used to convert the content of a worktree1515 file to a blob upon checkin. See linkgit:gitattributes[5] for1516 details.15171518filter.<driver>.smudge::1519 The command which is used to convert the content of a blob1520 object to a worktree file upon checkout. See1521 linkgit:gitattributes[5] for details.15221523fsck.<msg-id>::1524 Allows overriding the message type (error, warn or ignore) of a1525 specific message ID such as `missingEmail`.1526+1527For convenience, fsck prefixes the error/warning with the message ID,1528e.g. "missingEmail: invalid author/committer line - missing email" means1529that setting `fsck.missingEmail = ignore` will hide that issue.1530+1531This feature is intended to support working with legacy repositories1532which cannot be repaired without disruptive changes.15331534fsck.skipList::1535 The path to a sorted list of object names (i.e. one SHA-1 per1536 line) that are known to be broken in a non-fatal way and should1537 be ignored. This feature is useful when an established project1538 should be accepted despite early commits containing errors that1539 can be safely ignored such as invalid committer email addresses.1540 Note: corrupt objects cannot be skipped with this setting.15411542gc.aggressiveDepth::1543 The depth parameter used in the delta compression1544 algorithm used by 'git gc --aggressive'. This defaults1545 to 50.15461547gc.aggressiveWindow::1548 The window size parameter used in the delta compression1549 algorithm used by 'git gc --aggressive'. This defaults1550 to 250.15511552gc.auto::1553 When there are approximately more than this many loose1554 objects in the repository, `git gc --auto` will pack them.1555 Some Porcelain commands use this command to perform a1556 light-weight garbage collection from time to time. The1557 default value is 6700. Setting this to 0 disables it.15581559gc.autoPackLimit::1560 When there are more than this many packs that are not1561 marked with `*.keep` file in the repository, `git gc1562 --auto` consolidates them into one larger pack. The1563 default value is 50. Setting this to 0 disables it.15641565gc.autoDetach::1566 Make `git gc --auto` return immediately and run in background1567 if the system supports it. Default is true.15681569gc.logExpiry::1570 If the file gc.log exists, then `git gc --auto` won't run1571 unless that file is more than 'gc.logExpiry' old. Default is1572 "1.day". See `gc.pruneExpire` for more ways to specify its1573 value.15741575gc.packRefs::1576 Running `git pack-refs` in a repository renders it1577 unclonable by Git versions prior to 1.5.1.2 over dumb1578 transports such as HTTP. This variable determines whether1579 'git gc' runs `git pack-refs`. This can be set to `notbare`1580 to enable it within all non-bare repos or it can be set to a1581 boolean value. The default is `true`.15821583gc.pruneExpire::1584 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1585 Override the grace period with this config variable. The value1586 "now" may be used to disable this grace period and always prune1587 unreachable objects immediately, or "never" may be used to1588 suppress pruning. This feature helps prevent corruption when1589 'git gc' runs concurrently with another process writing to the1590 repository; see the "NOTES" section of linkgit:git-gc[1].15911592gc.worktreePruneExpire::1593 When 'git gc' is run, it calls1594 'git worktree prune --expire 3.months.ago'.1595 This config variable can be used to set a different grace1596 period. The value "now" may be used to disable the grace1597 period and prune `$GIT_DIR/worktrees` immediately, or "never"1598 may be used to suppress pruning.15991600gc.reflogExpire::1601gc.<pattern>.reflogExpire::1602 'git reflog expire' removes reflog entries older than1603 this time; defaults to 90 days. The value "now" expires all1604 entries immediately, and "never" suppresses expiration1605 altogether. With "<pattern>" (e.g.1606 "refs/stash") in the middle the setting applies only to1607 the refs that match the <pattern>.16081609gc.reflogExpireUnreachable::1610gc.<pattern>.reflogExpireUnreachable::1611 'git reflog expire' removes reflog entries older than1612 this time and are not reachable from the current tip;1613 defaults to 30 days. The value "now" expires all entries1614 immediately, and "never" suppresses expiration altogether.1615 With "<pattern>" (e.g. "refs/stash")1616 in the middle, the setting applies only to the refs that1617 match the <pattern>.16181619gc.rerereResolved::1620 Records of conflicted merge you resolved earlier are1621 kept for this many days when 'git rerere gc' is run.1622 You can also use more human-readable "1.month.ago", etc.1623 The default is 60 days. See linkgit:git-rerere[1].16241625gc.rerereUnresolved::1626 Records of conflicted merge you have not resolved are1627 kept for this many days when 'git rerere gc' is run.1628 You can also use more human-readable "1.month.ago", etc.1629 The default is 15 days. See linkgit:git-rerere[1].16301631gitcvs.commitMsgAnnotation::1632 Append this string to each commit message. Set to empty string1633 to disable this feature. Defaults to "via git-CVS emulator".16341635gitcvs.enabled::1636 Whether the CVS server interface is enabled for this repository.1637 See linkgit:git-cvsserver[1].16381639gitcvs.logFile::1640 Path to a log file where the CVS server interface well... logs1641 various stuff. See linkgit:git-cvsserver[1].16421643gitcvs.usecrlfattr::1644 If true, the server will look up the end-of-line conversion1645 attributes for files to determine the `-k` modes to use. If1646 the attributes force Git to treat a file as text,1647 the `-k` mode will be left blank so CVS clients will1648 treat it as text. If they suppress text conversion, the file1649 will be set with '-kb' mode, which suppresses any newline munging1650 the client might otherwise do. If the attributes do not allow1651 the file type to be determined, then `gitcvs.allBinary` is1652 used. See linkgit:gitattributes[5].16531654gitcvs.allBinary::1655 This is used if `gitcvs.usecrlfattr` does not resolve1656 the correct '-kb' mode to use. If true, all1657 unresolved files are sent to the client in1658 mode '-kb'. This causes the client to treat them1659 as binary files, which suppresses any newline munging it1660 otherwise might do. Alternatively, if it is set to "guess",1661 then the contents of the file are examined to decide if1662 it is binary, similar to `core.autocrlf`.16631664gitcvs.dbName::1665 Database used by git-cvsserver to cache revision information1666 derived from the Git repository. The exact meaning depends on the1667 used database driver, for SQLite (which is the default driver) this1668 is a filename. Supports variable substitution (see1669 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1670 Default: '%Ggitcvs.%m.sqlite'16711672gitcvs.dbDriver::1673 Used Perl DBI driver. You can specify any available driver1674 for this here, but it might not work. git-cvsserver is tested1675 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1676 reported *not* to work with 'DBD::mysql'. Experimental feature.1677 May not contain double colons (`:`). Default: 'SQLite'.1678 See linkgit:git-cvsserver[1].16791680gitcvs.dbUser, gitcvs.dbPass::1681 Database user and password. Only useful if setting `gitcvs.dbDriver`,1682 since SQLite has no concept of database users and/or passwords.1683 'gitcvs.dbUser' supports variable substitution (see1684 linkgit:git-cvsserver[1] for details).16851686gitcvs.dbTableNamePrefix::1687 Database table name prefix. Prepended to the names of any1688 database tables used, allowing a single database to be used1689 for several repositories. Supports variable substitution (see1690 linkgit:git-cvsserver[1] for details). Any non-alphabetic1691 characters will be replaced with underscores.16921693All gitcvs variables except for `gitcvs.usecrlfattr` and1694`gitcvs.allBinary` can also be specified as1695'gitcvs.<access_method>.<varname>' (where 'access_method'1696is one of "ext" and "pserver") to make them apply only for the given1697access method.16981699gitweb.category::1700gitweb.description::1701gitweb.owner::1702gitweb.url::1703 See linkgit:gitweb[1] for description.17041705gitweb.avatar::1706gitweb.blame::1707gitweb.grep::1708gitweb.highlight::1709gitweb.patches::1710gitweb.pickaxe::1711gitweb.remote_heads::1712gitweb.showSizes::1713gitweb.snapshot::1714 See linkgit:gitweb.conf[5] for description.17151716grep.lineNumber::1717 If set to true, enable `-n` option by default.17181719grep.patternType::1720 Set the default matching behavior. Using a value of 'basic', 'extended',1721 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1722 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1723 value 'default' will return to the default matching behavior.17241725grep.extendedRegexp::1726 If set to true, enable `--extended-regexp` option by default. This1727 option is ignored when the `grep.patternType` option is set to a value1728 other than 'default'.17291730grep.threads::1731 Number of grep worker threads to use.1732 See `grep.threads` in linkgit:git-grep[1] for more information.17331734grep.fallbackToNoIndex::1735 If set to true, fall back to git grep --no-index if git grep1736 is executed outside of a git repository. Defaults to false.17371738gpg.program::1739 Use this custom program instead of "`gpg`" found on `$PATH` when1740 making or verifying a PGP signature. The program must support the1741 same command-line interface as GPG, namely, to verify a detached1742 signature, "`gpg --verify $file - <$signature`" is run, and the1743 program is expected to signal a good signature by exiting with1744 code 0, and to generate an ASCII-armored detached signature, the1745 standard input of "`gpg -bsau $key`" is fed with the contents to be1746 signed, and the program is expected to send the result to its1747 standard output.17481749gui.commitMsgWidth::1750 Defines how wide the commit message window is in the1751 linkgit:git-gui[1]. "75" is the default.17521753gui.diffContext::1754 Specifies how many context lines should be used in calls to diff1755 made by the linkgit:git-gui[1]. The default is "5".17561757gui.displayUntracked::1758 Determines if linkgit:git-gui[1] shows untracked files1759 in the file list. The default is "true".17601761gui.encoding::1762 Specifies the default encoding to use for displaying of1763 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1764 It can be overridden by setting the 'encoding' attribute1765 for relevant files (see linkgit:gitattributes[5]).1766 If this option is not set, the tools default to the1767 locale encoding.17681769gui.matchTrackingBranch::1770 Determines if new branches created with linkgit:git-gui[1] should1771 default to tracking remote branches with matching names or1772 not. Default: "false".17731774gui.newBranchTemplate::1775 Is used as suggested name when creating new branches using the1776 linkgit:git-gui[1].17771778gui.pruneDuringFetch::1779 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1780 performing a fetch. The default value is "false".17811782gui.trustmtime::1783 Determines if linkgit:git-gui[1] should trust the file modification1784 timestamp or not. By default the timestamps are not trusted.17851786gui.spellingDictionary::1787 Specifies the dictionary used for spell checking commit messages in1788 the linkgit:git-gui[1]. When set to "none" spell checking is turned1789 off.17901791gui.fastCopyBlame::1792 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1793 location detection. It makes blame significantly faster on huge1794 repositories at the expense of less thorough copy detection.17951796gui.copyBlameThreshold::1797 Specifies the threshold to use in 'git gui blame' original location1798 detection, measured in alphanumeric characters. See the1799 linkgit:git-blame[1] manual for more information on copy detection.18001801gui.blamehistoryctx::1802 Specifies the radius of history context in days to show in1803 linkgit:gitk[1] for the selected commit, when the `Show History1804 Context` menu item is invoked from 'git gui blame'. If this1805 variable is set to zero, the whole history is shown.18061807guitool.<name>.cmd::1808 Specifies the shell command line to execute when the corresponding item1809 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1810 mandatory for every tool. The command is executed from the root of1811 the working directory, and in the environment it receives the name of1812 the tool as `GIT_GUITOOL`, the name of the currently selected file as1813 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1814 the head is detached, 'CUR_BRANCH' is empty).18151816guitool.<name>.needsFile::1817 Run the tool only if a diff is selected in the GUI. It guarantees1818 that 'FILENAME' is not empty.18191820guitool.<name>.noConsole::1821 Run the command silently, without creating a window to display its1822 output.18231824guitool.<name>.noRescan::1825 Don't rescan the working directory for changes after the tool1826 finishes execution.18271828guitool.<name>.confirm::1829 Show a confirmation dialog before actually running the tool.18301831guitool.<name>.argPrompt::1832 Request a string argument from the user, and pass it to the tool1833 through the `ARGS` environment variable. Since requesting an1834 argument implies confirmation, the 'confirm' option has no effect1835 if this is enabled. If the option is set to 'true', 'yes', or '1',1836 the dialog uses a built-in generic prompt; otherwise the exact1837 value of the variable is used.18381839guitool.<name>.revPrompt::1840 Request a single valid revision from the user, and set the1841 `REVISION` environment variable. In other aspects this option1842 is similar to 'argPrompt', and can be used together with it.18431844guitool.<name>.revUnmerged::1845 Show only unmerged branches in the 'revPrompt' subdialog.1846 This is useful for tools similar to merge or rebase, but not1847 for things like checkout or reset.18481849guitool.<name>.title::1850 Specifies the title to use for the prompt dialog. The default1851 is the tool name.18521853guitool.<name>.prompt::1854 Specifies the general prompt string to display at the top of1855 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1856 The default value includes the actual command.18571858help.browser::1859 Specify the browser that will be used to display help in the1860 'web' format. See linkgit:git-help[1].18611862help.format::1863 Override the default help format used by linkgit:git-help[1].1864 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1865 the default. 'web' and 'html' are the same.18661867help.autoCorrect::1868 Automatically correct and execute mistyped commands after1869 waiting for the given number of deciseconds (0.1 sec). If more1870 than one command can be deduced from the entered text, nothing1871 will be executed. If the value of this option is negative,1872 the corrected command will be executed immediately. If the1873 value is 0 - the command will be just shown but not executed.1874 This is the default.18751876help.htmlPath::1877 Specify the path where the HTML documentation resides. File system paths1878 and URLs are supported. HTML pages will be prefixed with this path when1879 help is displayed in the 'web' format. This defaults to the documentation1880 path of your Git installation.18811882http.proxy::1883 Override the HTTP proxy, normally configured using the 'http_proxy',1884 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1885 addition to the syntax understood by curl, it is possible to specify a1886 proxy string with a user name but no password, in which case git will1887 attempt to acquire one in the same way it does for other credentials. See1888 linkgit:gitcredentials[7] for more information. The syntax thus is1889 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1890 on a per-remote basis; see remote.<name>.proxy18911892http.proxyAuthMethod::1893 Set the method with which to authenticate against the HTTP proxy. This1894 only takes effect if the configured proxy string contains a user name part1895 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1896 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1897 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1898 variable. Possible values are:1899+1900--1901* `anyauth` - Automatically pick a suitable authentication method. It is1902 assumed that the proxy answers an unauthenticated request with a 4071903 status code and one or more Proxy-authenticate headers with supported1904 authentication methods. This is the default.1905* `basic` - HTTP Basic authentication1906* `digest` - HTTP Digest authentication; this prevents the password from being1907 transmitted to the proxy in clear text1908* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1909 of `curl(1)`)1910* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1911--19121913http.emptyAuth::1914 Attempt authentication without seeking a username or password. This1915 can be used to attempt GSS-Negotiate authentication without specifying1916 a username in the URL, as libcurl normally requires a username for1917 authentication.19181919http.delegation::1920 Control GSSAPI credential delegation. The delegation is disabled1921 by default in libcurl since version 7.21.7. Set parameter to tell1922 the server what it is allowed to delegate when it comes to user1923 credentials. Used with GSS/kerberos. Possible values are:1924+1925--1926* `none` - Don't allow any delegation.1927* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1928 Kerberos service ticket, which is a matter of realm policy.1929* `always` - Unconditionally allow the server to delegate.1930--193119321933http.extraHeader::1934 Pass an additional HTTP header when communicating with a server. If1935 more than one such entry exists, all of them are added as extra1936 headers. To allow overriding the settings inherited from the system1937 config, an empty value will reset the extra headers to the empty list.19381939http.cookieFile::1940 The pathname of a file containing previously stored cookie lines,1941 which should be used1942 in the Git http session, if they match the server. The file format1943 of the file to read cookies from should be plain HTTP headers or1944 the Netscape/Mozilla cookie file format (see `curl(1)`).1945 NOTE that the file specified with http.cookieFile is used only as1946 input unless http.saveCookies is set.19471948http.saveCookies::1949 If set, store cookies received during requests to the file specified by1950 http.cookieFile. Has no effect if http.cookieFile is unset.19511952http.sslVersion::1953 The SSL version to use when negotiating an SSL connection, if you1954 want to force the default. The available and default version1955 depend on whether libcurl was built against NSS or OpenSSL and the1956 particular configuration of the crypto library in use. Internally1957 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1958 documentation for more details on the format of this option and1959 for the ssl version supported. Actually the possible values of1960 this option are:19611962 - sslv21963 - sslv31964 - tlsv11965 - tlsv1.01966 - tlsv1.11967 - tlsv1.21968 - tlsv1.319691970+1971Can be overridden by the `GIT_SSL_VERSION` environment variable.1972To force git to use libcurl's default ssl version and ignore any1973explicit http.sslversion option, set `GIT_SSL_VERSION` to the1974empty string.19751976http.sslCipherList::1977 A list of SSL ciphers to use when negotiating an SSL connection.1978 The available ciphers depend on whether libcurl was built against1979 NSS or OpenSSL and the particular configuration of the crypto1980 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1981 option; see the libcurl documentation for more details on the format1982 of this list.1983+1984Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1985To force git to use libcurl's default cipher list and ignore any1986explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1987empty string.19881989http.sslVerify::1990 Whether to verify the SSL certificate when fetching or pushing1991 over HTTPS. Defaults to true. Can be overridden by the1992 `GIT_SSL_NO_VERIFY` environment variable.19931994http.sslCert::1995 File containing the SSL certificate when fetching or pushing1996 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1997 variable.19981999http.sslKey::2000 File containing the SSL private key when fetching or pushing2001 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2002 variable.20032004http.sslCertPasswordProtected::2005 Enable Git's password prompt for the SSL certificate. Otherwise2006 OpenSSL will prompt the user, possibly many times, if the2007 certificate or private key is encrypted. Can be overridden by the2008 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20092010http.sslCAInfo::2011 File containing the certificates to verify the peer with when2012 fetching or pushing over HTTPS. Can be overridden by the2013 `GIT_SSL_CAINFO` environment variable.20142015http.sslCAPath::2016 Path containing files with the CA certificates to verify the peer2017 with when fetching or pushing over HTTPS. Can be overridden2018 by the `GIT_SSL_CAPATH` environment variable.20192020http.pinnedpubkey::2021 Public key of the https service. It may either be the filename of2022 a PEM or DER encoded public key file or a string starting with2023 'sha256//' followed by the base64 encoded sha256 hash of the2024 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2025 exit with an error if this option is set but not supported by2026 cURL.20272028http.sslTry::2029 Attempt to use AUTH SSL/TLS and encrypted data transfers2030 when connecting via regular FTP protocol. This might be needed2031 if the FTP server requires it for security reasons or you wish2032 to connect securely whenever remote FTP server supports it.2033 Default is false since it might trigger certificate verification2034 errors on misconfigured servers.20352036http.maxRequests::2037 How many HTTP requests to launch in parallel. Can be overridden2038 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20392040http.minSessions::2041 The number of curl sessions (counted across slots) to be kept across2042 requests. They will not be ended with curl_easy_cleanup() until2043 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2044 value will be capped at 1. Defaults to 1.20452046http.postBuffer::2047 Maximum size in bytes of the buffer used by smart HTTP2048 transports when POSTing data to the remote system.2049 For requests larger than this buffer size, HTTP/1.1 and2050 Transfer-Encoding: chunked is used to avoid creating a2051 massive pack file locally. Default is 1 MiB, which is2052 sufficient for most requests.20532054http.lowSpeedLimit, http.lowSpeedTime::2055 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2056 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2057 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2058 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20592060http.noEPSV::2061 A boolean which disables using of EPSV ftp command by curl.2062 This can helpful with some "poor" ftp servers which don't2063 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2064 environment variable. Default is false (curl will use EPSV).20652066http.userAgent::2067 The HTTP USER_AGENT string presented to an HTTP server. The default2068 value represents the version of the client Git such as git/1.7.1.2069 This option allows you to override this value to a more common value2070 such as Mozilla/4.0. This may be necessary, for instance, if2071 connecting through a firewall that restricts HTTP connections to a set2072 of common USER_AGENT strings (but not including those like git/1.7.1).2073 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20742075http.followRedirects::2076 Whether git should follow HTTP redirects. If set to `true`, git2077 will transparently follow any redirect issued by a server it2078 encounters. If set to `false`, git will treat all redirects as2079 errors. If set to `initial`, git will follow redirects only for2080 the initial request to a remote, but not for subsequent2081 follow-up HTTP requests. Since git uses the redirected URL as2082 the base for the follow-up requests, this is generally2083 sufficient. The default is `initial`.20842085http.<url>.*::2086 Any of the http.* options above can be applied selectively to some URLs.2087 For a config key to match a URL, each element of the config key is2088 compared to that of the URL, in the following order:2089+2090--2091. Scheme (e.g., `https` in `https://example.com/`). This field2092 must match exactly between the config key and the URL.20932094. Host/domain name (e.g., `example.com` in `https://example.com/`).2095 This field must match between the config key and the URL. It is2096 possible to specify a `*` as part of the host name to match all subdomains2097 at this level. `https://*.example.com/` for example would match2098 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20992100. Port number (e.g., `8080` in `http://example.com:8080/`).2101 This field must match exactly between the config key and the URL.2102 Omitted port numbers are automatically converted to the correct2103 default for the scheme before matching.21042105. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2106 path field of the config key must match the path field of the URL2107 either exactly or as a prefix of slash-delimited path elements. This means2108 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2109 match on a slash (`/`) boundary. Longer matches take precedence (so a config2110 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2111 key with just path `foo/`).21122113. User name (e.g., `user` in `https://user@example.com/repo.git`). If2114 the config key has a user name it must match the user name in the2115 URL exactly. If the config key does not have a user name, that2116 config key will match a URL with any user name (including none),2117 but at a lower precedence than a config key with a user name.2118--2119+2120The list above is ordered by decreasing precedence; a URL that matches2121a config key's path is preferred to one that matches its user name. For example,2122if the URL is `https://user@example.com/foo/bar` a config key match of2123`https://example.com/foo` will be preferred over a config key match of2124`https://user@example.com`.2125+2126All URLs are normalized before attempting any matching (the password part,2127if embedded in the URL, is always ignored for matching purposes) so that2128equivalent URLs that are simply spelled differently will match properly.2129Environment variable settings always override any matches. The URLs that are2130matched against are those given directly to Git commands. This means any URLs2131visited as a result of a redirection do not participate in matching.21322133ssh.variant::2134 By default, Git determines the command line arguments to use2135 based on the basename of the configured SSH command (configured2136 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2137 the config setting `core.sshCommand`). If the basename is2138 unrecognized, Git will attempt to detect support of OpenSSH2139 options by first invoking the configured SSH command with the2140 `-G` (print configuration) option and will subsequently use2141 OpenSSH options (if that is successful) or no options besides2142 the host and remote command (if it fails).2143+2144The config variable `ssh.variant` can be set to override this detection.2145Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2146`tortoiseplink`, `simple` (no options except the host and remote command).2147The default auto-detection can be explicitly requested using the value2148`auto`. Any other value is treated as `ssh`. This setting can also be2149overridden via the environment variable `GIT_SSH_VARIANT`.2150+2151The current command-line parameters used for each variant are as2152follows:2153+2154--21552156* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21572158* `simple` - [username@]host command21592160* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21612162* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21632164--2165+2166Except for the `simple` variant, command-line parameters are likely to2167change as git gains new features.21682169i18n.commitEncoding::2170 Character encoding the commit messages are stored in; Git itself2171 does not care per se, but this information is necessary e.g. when2172 importing commits from emails or in the gitk graphical history2173 browser (and possibly at other places in the future or in other2174 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21752176i18n.logOutputEncoding::2177 Character encoding the commit messages are converted to when2178 running 'git log' and friends.21792180imap::2181 The configuration variables in the 'imap' section are described2182 in linkgit:git-imap-send[1].21832184index.version::2185 Specify the version with which new index files should be2186 initialized. This does not affect existing repositories.21872188init.templateDir::2189 Specify the directory from which templates will be copied.2190 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21912192instaweb.browser::2193 Specify the program that will be used to browse your working2194 repository in gitweb. See linkgit:git-instaweb[1].21952196instaweb.httpd::2197 The HTTP daemon command-line to start gitweb on your working2198 repository. See linkgit:git-instaweb[1].21992200instaweb.local::2201 If true the web server started by linkgit:git-instaweb[1] will2202 be bound to the local IP (127.0.0.1).22032204instaweb.modulePath::2205 The default module path for linkgit:git-instaweb[1] to use2206 instead of /usr/lib/apache2/modules. Only used if httpd2207 is Apache.22082209instaweb.port::2210 The port number to bind the gitweb httpd to. See2211 linkgit:git-instaweb[1].22122213interactive.singleKey::2214 In interactive commands, allow the user to provide one-letter2215 input with a single key (i.e., without hitting enter).2216 Currently this is used by the `--patch` mode of2217 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2218 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2219 setting is silently ignored if portable keystroke input2220 is not available; requires the Perl module Term::ReadKey.22212222interactive.diffFilter::2223 When an interactive command (such as `git add --patch`) shows2224 a colorized diff, git will pipe the diff through the shell2225 command defined by this configuration variable. The command may2226 mark up the diff further for human consumption, provided that it2227 retains a one-to-one correspondence with the lines in the2228 original diff. Defaults to disabled (no filtering).22292230log.abbrevCommit::2231 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2232 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2233 override this option with `--no-abbrev-commit`.22342235log.date::2236 Set the default date-time mode for the 'log' command.2237 Setting a value for log.date is similar to using 'git log''s2238 `--date` option. See linkgit:git-log[1] for details.22392240log.decorate::2241 Print out the ref names of any commits that are shown by the log2242 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2243 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2244 specified, the full ref name (including prefix) will be printed.2245 If 'auto' is specified, then if the output is going to a terminal,2246 the ref names are shown as if 'short' were given, otherwise no ref2247 names are shown. This is the same as the `--decorate` option2248 of the `git log`.22492250log.follow::2251 If `true`, `git log` will act as if the `--follow` option was used when2252 a single <path> is given. This has the same limitations as `--follow`,2253 i.e. it cannot be used to follow multiple files and does not work well2254 on non-linear history.22552256log.graphColors::2257 A list of colors, separated by commas, that can be used to draw2258 history lines in `git log --graph`.22592260log.showRoot::2261 If true, the initial commit will be shown as a big creation event.2262 This is equivalent to a diff against an empty tree.2263 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2264 normally hide the root commit will now show it. True by default.22652266log.showSignature::2267 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2268 linkgit:git-whatchanged[1] assume `--show-signature`.22692270log.mailmap::2271 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2272 linkgit:git-whatchanged[1] assume `--use-mailmap`.22732274mailinfo.scissors::2275 If true, makes linkgit:git-mailinfo[1] (and therefore2276 linkgit:git-am[1]) act by default as if the --scissors option2277 was provided on the command-line. When active, this features2278 removes everything from the message body before a scissors2279 line (i.e. consisting mainly of ">8", "8<" and "-").22802281mailmap.file::2282 The location of an augmenting mailmap file. The default2283 mailmap, located in the root of the repository, is loaded2284 first, then the mailmap file pointed to by this variable.2285 The location of the mailmap file may be in a repository2286 subdirectory, or somewhere outside of the repository itself.2287 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22882289mailmap.blob::2290 Like `mailmap.file`, but consider the value as a reference to a2291 blob in the repository. If both `mailmap.file` and2292 `mailmap.blob` are given, both are parsed, with entries from2293 `mailmap.file` taking precedence. In a bare repository, this2294 defaults to `HEAD:.mailmap`. In a non-bare repository, it2295 defaults to empty.22962297man.viewer::2298 Specify the programs that may be used to display help in the2299 'man' format. See linkgit:git-help[1].23002301man.<tool>.cmd::2302 Specify the command to invoke the specified man viewer. The2303 specified command is evaluated in shell with the man page2304 passed as argument. (See linkgit:git-help[1].)23052306man.<tool>.path::2307 Override the path for the given tool that may be used to2308 display help in the 'man' format. See linkgit:git-help[1].23092310include::merge-config.txt[]23112312mergetool.<tool>.path::2313 Override the path for the given tool. This is useful in case2314 your tool is not in the PATH.23152316mergetool.<tool>.cmd::2317 Specify the command to invoke the specified merge tool. The2318 specified command is evaluated in shell with the following2319 variables available: 'BASE' is the name of a temporary file2320 containing the common base of the files to be merged, if available;2321 'LOCAL' is the name of a temporary file containing the contents of2322 the file on the current branch; 'REMOTE' is the name of a temporary2323 file containing the contents of the file from the branch being2324 merged; 'MERGED' contains the name of the file to which the merge2325 tool should write the results of a successful merge.23262327mergetool.<tool>.trustExitCode::2328 For a custom merge command, specify whether the exit code of2329 the merge command can be used to determine whether the merge was2330 successful. If this is not set to true then the merge target file2331 timestamp is checked and the merge assumed to have been successful2332 if the file has been updated, otherwise the user is prompted to2333 indicate the success of the merge.23342335mergetool.meld.hasOutput::2336 Older versions of `meld` do not support the `--output` option.2337 Git will attempt to detect whether `meld` supports `--output`2338 by inspecting the output of `meld --help`. Configuring2339 `mergetool.meld.hasOutput` will make Git skip these checks and2340 use the configured value instead. Setting `mergetool.meld.hasOutput`2341 to `true` tells Git to unconditionally use the `--output` option,2342 and `false` avoids using `--output`.23432344mergetool.keepBackup::2345 After performing a merge, the original file with conflict markers2346 can be saved as a file with a `.orig` extension. If this variable2347 is set to `false` then this file is not preserved. Defaults to2348 `true` (i.e. keep the backup files).23492350mergetool.keepTemporaries::2351 When invoking a custom merge tool, Git uses a set of temporary2352 files to pass to the tool. If the tool returns an error and this2353 variable is set to `true`, then these temporary files will be2354 preserved, otherwise they will be removed after the tool has2355 exited. Defaults to `false`.23562357mergetool.writeToTemp::2358 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2359 conflicting files in the worktree by default. Git will attempt2360 to use a temporary directory for these files when set `true`.2361 Defaults to `false`.23622363mergetool.prompt::2364 Prompt before each invocation of the merge resolution program.23652366notes.mergeStrategy::2367 Which merge strategy to choose by default when resolving notes2368 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2369 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2370 section of linkgit:git-notes[1] for more information on each strategy.23712372notes.<name>.mergeStrategy::2373 Which merge strategy to choose when doing a notes merge into2374 refs/notes/<name>. This overrides the more general2375 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2376 linkgit:git-notes[1] for more information on the available strategies.23772378notes.displayRef::2379 The (fully qualified) refname from which to show notes when2380 showing commit messages. The value of this variable can be set2381 to a glob, in which case notes from all matching refs will be2382 shown. You may also specify this configuration variable2383 several times. A warning will be issued for refs that do not2384 exist, but a glob that does not match any refs is silently2385 ignored.2386+2387This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2388environment variable, which must be a colon separated list of refs or2389globs.2390+2391The effective value of "core.notesRef" (possibly overridden by2392GIT_NOTES_REF) is also implicitly added to the list of refs to be2393displayed.23942395notes.rewrite.<command>::2396 When rewriting commits with <command> (currently `amend` or2397 `rebase`) and this variable is set to `true`, Git2398 automatically copies your notes from the original to the2399 rewritten commit. Defaults to `true`, but see2400 "notes.rewriteRef" below.24012402notes.rewriteMode::2403 When copying notes during a rewrite (see the2404 "notes.rewrite.<command>" option), determines what to do if2405 the target commit already has a note. Must be one of2406 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2407 Defaults to `concatenate`.2408+2409This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2410environment variable.24112412notes.rewriteRef::2413 When copying notes during a rewrite, specifies the (fully2414 qualified) ref whose notes should be copied. The ref may be a2415 glob, in which case notes in all matching refs will be copied.2416 You may also specify this configuration several times.2417+2418Does not have a default value; you must configure this variable to2419enable note rewriting. Set it to `refs/notes/commits` to enable2420rewriting for the default commit notes.2421+2422This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2423environment variable, which must be a colon separated list of refs or2424globs.24252426pack.window::2427 The size of the window used by linkgit:git-pack-objects[1] when no2428 window size is given on the command line. Defaults to 10.24292430pack.depth::2431 The maximum delta depth used by linkgit:git-pack-objects[1] when no2432 maximum depth is given on the command line. Defaults to 50.24332434pack.windowMemory::2435 The maximum size of memory that is consumed by each thread2436 in linkgit:git-pack-objects[1] for pack window memory when2437 no limit is given on the command line. The value can be2438 suffixed with "k", "m", or "g". When left unconfigured (or2439 set explicitly to 0), there will be no limit.24402441pack.compression::2442 An integer -1..9, indicating the compression level for objects2443 in a pack file. -1 is the zlib default. 0 means no2444 compression, and 1..9 are various speed/size tradeoffs, 9 being2445 slowest. If not set, defaults to core.compression. If that is2446 not set, defaults to -1, the zlib default, which is "a default2447 compromise between speed and compression (currently equivalent2448 to level 6)."2449+2450Note that changing the compression level will not automatically recompress2451all existing objects. You can force recompression by passing the -F option2452to linkgit:git-repack[1].24532454pack.deltaCacheSize::2455 The maximum memory in bytes used for caching deltas in2456 linkgit:git-pack-objects[1] before writing them out to a pack.2457 This cache is used to speed up the writing object phase by not2458 having to recompute the final delta result once the best match2459 for all objects is found. Repacking large repositories on machines2460 which are tight with memory might be badly impacted by this though,2461 especially if this cache pushes the system into swapping.2462 A value of 0 means no limit. The smallest size of 1 byte may be2463 used to virtually disable this cache. Defaults to 256 MiB.24642465pack.deltaCacheLimit::2466 The maximum size of a delta, that is cached in2467 linkgit:git-pack-objects[1]. This cache is used to speed up the2468 writing object phase by not having to recompute the final delta2469 result once the best match for all objects is found. Defaults to 1000.24702471pack.threads::2472 Specifies the number of threads to spawn when searching for best2473 delta matches. This requires that linkgit:git-pack-objects[1]2474 be compiled with pthreads otherwise this option is ignored with a2475 warning. This is meant to reduce packing time on multiprocessor2476 machines. The required amount of memory for the delta search window2477 is however multiplied by the number of threads.2478 Specifying 0 will cause Git to auto-detect the number of CPU's2479 and set the number of threads accordingly.24802481pack.indexVersion::2482 Specify the default pack index version. Valid values are 1 for2483 legacy pack index used by Git versions prior to 1.5.2, and 2 for2484 the new pack index with capabilities for packs larger than 4 GB2485 as well as proper protection against the repacking of corrupted2486 packs. Version 2 is the default. Note that version 2 is enforced2487 and this config option ignored whenever the corresponding pack is2488 larger than 2 GB.2489+2490If you have an old Git that does not understand the version 2 `*.idx` file,2491cloning or fetching over a non native protocol (e.g. "http")2492that will copy both `*.pack` file and corresponding `*.idx` file from the2493other side may give you a repository that cannot be accessed with your2494older version of Git. If the `*.pack` file is smaller than 2 GB, however,2495you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2496the `*.idx` file.24972498pack.packSizeLimit::2499 The maximum size of a pack. This setting only affects2500 packing to a file when repacking, i.e. the git:// protocol2501 is unaffected. It can be overridden by the `--max-pack-size`2502 option of linkgit:git-repack[1]. Reaching this limit results2503 in the creation of multiple packfiles; which in turn prevents2504 bitmaps from being created.2505 The minimum size allowed is limited to 1 MiB.2506 The default is unlimited.2507 Common unit suffixes of 'k', 'm', or 'g' are2508 supported.25092510pack.useBitmaps::2511 When true, git will use pack bitmaps (if available) when packing2512 to stdout (e.g., during the server side of a fetch). Defaults to2513 true. You should not generally need to turn this off unless2514 you are debugging pack bitmaps.25152516pack.writeBitmaps (deprecated)::2517 This is a deprecated synonym for `repack.writeBitmaps`.25182519pack.writeBitmapHashCache::2520 When true, git will include a "hash cache" section in the bitmap2521 index (if one is written). This cache can be used to feed git's2522 delta heuristics, potentially leading to better deltas between2523 bitmapped and non-bitmapped objects (e.g., when serving a fetch2524 between an older, bitmapped pack and objects that have been2525 pushed since the last gc). The downside is that it consumes 42526 bytes per object of disk space, and that JGit's bitmap2527 implementation does not understand it, causing it to complain if2528 Git and JGit are used on the same repository. Defaults to false.25292530pager.<cmd>::2531 If the value is boolean, turns on or off pagination of the2532 output of a particular Git subcommand when writing to a tty.2533 Otherwise, turns on pagination for the subcommand using the2534 pager specified by the value of `pager.<cmd>`. If `--paginate`2535 or `--no-pager` is specified on the command line, it takes2536 precedence over this option. To disable pagination for all2537 commands, set `core.pager` or `GIT_PAGER` to `cat`.25382539pretty.<name>::2540 Alias for a --pretty= format string, as specified in2541 linkgit:git-log[1]. Any aliases defined here can be used just2542 as the built-in pretty formats could. For example,2543 running `git config pretty.changelog "format:* %H %s"`2544 would cause the invocation `git log --pretty=changelog`2545 to be equivalent to running `git log "--pretty=format:* %H %s"`.2546 Note that an alias with the same name as a built-in format2547 will be silently ignored.25482549protocol.allow::2550 If set, provide a user defined default policy for all protocols which2551 don't explicitly have a policy (`protocol.<name>.allow`). By default,2552 if unset, known-safe protocols (http, https, git, ssh, file) have a2553 default policy of `always`, known-dangerous protocols (ext) have a2554 default policy of `never`, and all other protocols have a default2555 policy of `user`. Supported policies:2556+2557--25582559* `always` - protocol is always able to be used.25602561* `never` - protocol is never able to be used.25622563* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2564 either unset or has a value of 1. This policy should be used when you want a2565 protocol to be directly usable by the user but don't want it used by commands which2566 execute clone/fetch/push commands without user input, e.g. recursive2567 submodule initialization.25682569--25702571protocol.<name>.allow::2572 Set a policy to be used by protocol `<name>` with clone/fetch/push2573 commands. See `protocol.allow` above for the available policies.2574+2575The protocol names currently used by git are:2576+2577--2578 - `file`: any local file-based path (including `file://` URLs,2579 or local paths)25802581 - `git`: the anonymous git protocol over a direct TCP2582 connection (or proxy, if configured)25832584 - `ssh`: git over ssh (including `host:path` syntax,2585 `ssh://`, etc).25862587 - `http`: git over http, both "smart http" and "dumb http".2588 Note that this does _not_ include `https`; if you want to configure2589 both, you must do so individually.25902591 - any external helpers are named by their protocol (e.g., use2592 `hg` to allow the `git-remote-hg` helper)2593--25942595protocol.version::2596 Experimental. If set, clients will attempt to communicate with a2597 server using the specified protocol version. If unset, no2598 attempt will be made by the client to communicate using a2599 particular protocol version, this results in protocol version 02600 being used.2601 Supported versions:2602+2603--26042605* `0` - the original wire protocol.26062607* `1` - the original wire protocol with the addition of a version string2608 in the initial response from the server.26092610--26112612pull.ff::2613 By default, Git does not create an extra merge commit when merging2614 a commit that is a descendant of the current commit. Instead, the2615 tip of the current branch is fast-forwarded. When set to `false`,2616 this variable tells Git to create an extra merge commit in such2617 a case (equivalent to giving the `--no-ff` option from the command2618 line). When set to `only`, only such fast-forward merges are2619 allowed (equivalent to giving the `--ff-only` option from the2620 command line). This setting overrides `merge.ff` when pulling.26212622pull.rebase::2623 When true, rebase branches on top of the fetched branch, instead2624 of merging the default branch from the default remote when "git2625 pull" is run. See "branch.<name>.rebase" for setting this on a2626 per-branch basis.2627+2628When preserve, also pass `--preserve-merges` along to 'git rebase'2629so that locally committed merge commits will not be flattened2630by running 'git pull'.2631+2632When the value is `interactive`, the rebase is run in interactive mode.2633+2634*NOTE*: this is a possibly dangerous operation; do *not* use2635it unless you understand the implications (see linkgit:git-rebase[1]2636for details).26372638pull.octopus::2639 The default merge strategy to use when pulling multiple branches2640 at once.26412642pull.twohead::2643 The default merge strategy to use when pulling a single branch.26442645push.default::2646 Defines the action `git push` should take if no refspec is2647 explicitly given. Different values are well-suited for2648 specific workflows; for instance, in a purely central workflow2649 (i.e. the fetch source is equal to the push destination),2650 `upstream` is probably what you want. Possible values are:2651+2652--26532654* `nothing` - do not push anything (error out) unless a refspec is2655 explicitly given. This is primarily meant for people who want to2656 avoid mistakes by always being explicit.26572658* `current` - push the current branch to update a branch with the same2659 name on the receiving end. Works in both central and non-central2660 workflows.26612662* `upstream` - push the current branch back to the branch whose2663 changes are usually integrated into the current branch (which is2664 called `@{upstream}`). This mode only makes sense if you are2665 pushing to the same repository you would normally pull from2666 (i.e. central workflow).26672668* `tracking` - This is a deprecated synonym for `upstream`.26692670* `simple` - in centralized workflow, work like `upstream` with an2671 added safety to refuse to push if the upstream branch's name is2672 different from the local one.2673+2674When pushing to a remote that is different from the remote you normally2675pull from, work as `current`. This is the safest option and is suited2676for beginners.2677+2678This mode has become the default in Git 2.0.26792680* `matching` - push all branches having the same name on both ends.2681 This makes the repository you are pushing to remember the set of2682 branches that will be pushed out (e.g. if you always push 'maint'2683 and 'master' there and no other branches, the repository you push2684 to will have these two branches, and your local 'maint' and2685 'master' will be pushed there).2686+2687To use this mode effectively, you have to make sure _all_ the2688branches you would push out are ready to be pushed out before2689running 'git push', as the whole point of this mode is to allow you2690to push all of the branches in one go. If you usually finish work2691on only one branch and push out the result, while other branches are2692unfinished, this mode is not for you. Also this mode is not2693suitable for pushing into a shared central repository, as other2694people may add new branches there, or update the tip of existing2695branches outside your control.2696+2697This used to be the default, but not since Git 2.0 (`simple` is the2698new default).26992700--27012702push.followTags::2703 If set to true enable `--follow-tags` option by default. You2704 may override this configuration at time of push by specifying2705 `--no-follow-tags`.27062707push.gpgSign::2708 May be set to a boolean value, or the string 'if-asked'. A true2709 value causes all pushes to be GPG signed, as if `--signed` is2710 passed to linkgit:git-push[1]. The string 'if-asked' causes2711 pushes to be signed if the server supports it, as if2712 `--signed=if-asked` is passed to 'git push'. A false value may2713 override a value from a lower-priority config file. An explicit2714 command-line flag always overrides this config option.27152716push.pushOption::2717 When no `--push-option=<option>` argument is given from the2718 command line, `git push` behaves as if each <value> of2719 this variable is given as `--push-option=<value>`.2720+2721This is a multi-valued variable, and an empty value can be used in a2722higher priority configuration file (e.g. `.git/config` in a2723repository) to clear the values inherited from a lower priority2724configuration files (e.g. `$HOME/.gitconfig`).2725+2726--27272728Example:27292730/etc/gitconfig2731 push.pushoption = a2732 push.pushoption = b27332734~/.gitconfig2735 push.pushoption = c27362737repo/.git/config2738 push.pushoption =2739 push.pushoption = b27402741This will result in only b (a and c are cleared).27422743--27442745push.recurseSubmodules::2746 Make sure all submodule commits used by the revisions to be pushed2747 are available on a remote-tracking branch. If the value is 'check'2748 then Git will verify that all submodule commits that changed in the2749 revisions to be pushed are available on at least one remote of the2750 submodule. If any commits are missing, the push will be aborted and2751 exit with non-zero status. If the value is 'on-demand' then all2752 submodules that changed in the revisions to be pushed will be2753 pushed. If on-demand was not able to push all necessary revisions2754 it will also be aborted and exit with non-zero status. If the value2755 is 'no' then default behavior of ignoring submodules when pushing2756 is retained. You may override this configuration at time of push by2757 specifying '--recurse-submodules=check|on-demand|no'.27582759include::rebase-config.txt[]27602761receive.advertiseAtomic::2762 By default, git-receive-pack will advertise the atomic push2763 capability to its clients. If you don't want to advertise this2764 capability, set this variable to false.27652766receive.advertisePushOptions::2767 When set to true, git-receive-pack will advertise the push options2768 capability to its clients. False by default.27692770receive.autogc::2771 By default, git-receive-pack will run "git-gc --auto" after2772 receiving data from git-push and updating refs. You can stop2773 it by setting this variable to false.27742775receive.certNonceSeed::2776 By setting this variable to a string, `git receive-pack`2777 will accept a `git push --signed` and verifies it by using2778 a "nonce" protected by HMAC using this string as a secret2779 key.27802781receive.certNonceSlop::2782 When a `git push --signed` sent a push certificate with a2783 "nonce" that was issued by a receive-pack serving the same2784 repository within this many seconds, export the "nonce"2785 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2786 hooks (instead of what the receive-pack asked the sending2787 side to include). This may allow writing checks in2788 `pre-receive` and `post-receive` a bit easier. Instead of2789 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2790 that records by how many seconds the nonce is stale to2791 decide if they want to accept the certificate, they only2792 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27932794receive.fsckObjects::2795 If it is set to true, git-receive-pack will check all received2796 objects. It will abort in the case of a malformed object or a2797 broken link. The result of an abort are only dangling objects.2798 Defaults to false. If not set, the value of `transfer.fsckObjects`2799 is used instead.28002801receive.fsck.<msg-id>::2802 When `receive.fsckObjects` is set to true, errors can be switched2803 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2804 setting where the `<msg-id>` is the fsck message ID and the value2805 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2806 the error/warning with the message ID, e.g. "missingEmail: invalid2807 author/committer line - missing email" means that setting2808 `receive.fsck.missingEmail = ignore` will hide that issue.2809+2810This feature is intended to support working with legacy repositories2811which would not pass pushing when `receive.fsckObjects = true`, allowing2812the host to accept repositories with certain known issues but still catch2813other issues.28142815receive.fsck.skipList::2816 The path to a sorted list of object names (i.e. one SHA-1 per2817 line) that are known to be broken in a non-fatal way and should2818 be ignored. This feature is useful when an established project2819 should be accepted despite early commits containing errors that2820 can be safely ignored such as invalid committer email addresses.2821 Note: corrupt objects cannot be skipped with this setting.28222823receive.keepAlive::2824 After receiving the pack from the client, `receive-pack` may2825 produce no output (if `--quiet` was specified) while processing2826 the pack, causing some networks to drop the TCP connection.2827 With this option set, if `receive-pack` does not transmit2828 any data in this phase for `receive.keepAlive` seconds, it will2829 send a short keepalive packet. The default is 5 seconds; set2830 to 0 to disable keepalives entirely.28312832receive.unpackLimit::2833 If the number of objects received in a push is below this2834 limit then the objects will be unpacked into loose object2835 files. However if the number of received objects equals or2836 exceeds this limit then the received pack will be stored as2837 a pack, after adding any missing delta bases. Storing the2838 pack from a push can make the push operation complete faster,2839 especially on slow filesystems. If not set, the value of2840 `transfer.unpackLimit` is used instead.28412842receive.maxInputSize::2843 If the size of the incoming pack stream is larger than this2844 limit, then git-receive-pack will error out, instead of2845 accepting the pack file. If not set or set to 0, then the size2846 is unlimited.28472848receive.denyDeletes::2849 If set to true, git-receive-pack will deny a ref update that deletes2850 the ref. Use this to prevent such a ref deletion via a push.28512852receive.denyDeleteCurrent::2853 If set to true, git-receive-pack will deny a ref update that2854 deletes the currently checked out branch of a non-bare repository.28552856receive.denyCurrentBranch::2857 If set to true or "refuse", git-receive-pack will deny a ref update2858 to the currently checked out branch of a non-bare repository.2859 Such a push is potentially dangerous because it brings the HEAD2860 out of sync with the index and working tree. If set to "warn",2861 print a warning of such a push to stderr, but allow the push to2862 proceed. If set to false or "ignore", allow such pushes with no2863 message. Defaults to "refuse".2864+2865Another option is "updateInstead" which will update the working2866tree if pushing into the current branch. This option is2867intended for synchronizing working directories when one side is not easily2868accessible via interactive ssh (e.g. a live web site, hence the requirement2869that the working directory be clean). This mode also comes in handy when2870developing inside a VM to test and fix code on different Operating Systems.2871+2872By default, "updateInstead" will refuse the push if the working tree or2873the index have any difference from the HEAD, but the `push-to-checkout`2874hook can be used to customize this. See linkgit:githooks[5].28752876receive.denyNonFastForwards::2877 If set to true, git-receive-pack will deny a ref update which is2878 not a fast-forward. Use this to prevent such an update via a push,2879 even if that push is forced. This configuration variable is2880 set when initializing a shared repository.28812882receive.hideRefs::2883 This variable is the same as `transfer.hideRefs`, but applies2884 only to `receive-pack` (and so affects pushes, but not fetches).2885 An attempt to update or delete a hidden ref by `git push` is2886 rejected.28872888receive.updateServerInfo::2889 If set to true, git-receive-pack will run git-update-server-info2890 after receiving data from git-push and updating refs.28912892receive.shallowUpdate::2893 If set to true, .git/shallow can be updated when new refs2894 require new shallow roots. Otherwise those refs are rejected.28952896remote.pushDefault::2897 The remote to push to by default. Overrides2898 `branch.<name>.remote` for all branches, and is overridden by2899 `branch.<name>.pushRemote` for specific branches.29002901remote.<name>.url::2902 The URL of a remote repository. See linkgit:git-fetch[1] or2903 linkgit:git-push[1].29042905remote.<name>.pushurl::2906 The push URL of a remote repository. See linkgit:git-push[1].29072908remote.<name>.proxy::2909 For remotes that require curl (http, https and ftp), the URL to2910 the proxy to use for that remote. Set to the empty string to2911 disable proxying for that remote.29122913remote.<name>.proxyAuthMethod::2914 For remotes that require curl (http, https and ftp), the method to use for2915 authenticating against the proxy in use (probably set in2916 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29172918remote.<name>.fetch::2919 The default set of "refspec" for linkgit:git-fetch[1]. See2920 linkgit:git-fetch[1].29212922remote.<name>.push::2923 The default set of "refspec" for linkgit:git-push[1]. See2924 linkgit:git-push[1].29252926remote.<name>.mirror::2927 If true, pushing to this remote will automatically behave2928 as if the `--mirror` option was given on the command line.29292930remote.<name>.skipDefaultUpdate::2931 If true, this remote will be skipped by default when updating2932 using linkgit:git-fetch[1] or the `update` subcommand of2933 linkgit:git-remote[1].29342935remote.<name>.skipFetchAll::2936 If true, this remote will be skipped by default when updating2937 using linkgit:git-fetch[1] or the `update` subcommand of2938 linkgit:git-remote[1].29392940remote.<name>.receivepack::2941 The default program to execute on the remote side when pushing. See2942 option --receive-pack of linkgit:git-push[1].29432944remote.<name>.uploadpack::2945 The default program to execute on the remote side when fetching. See2946 option --upload-pack of linkgit:git-fetch-pack[1].29472948remote.<name>.tagOpt::2949 Setting this value to --no-tags disables automatic tag following when2950 fetching from remote <name>. Setting it to --tags will fetch every2951 tag from remote <name>, even if they are not reachable from remote2952 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2953 override this setting. See options --tags and --no-tags of2954 linkgit:git-fetch[1].29552956remote.<name>.vcs::2957 Setting this to a value <vcs> will cause Git to interact with2958 the remote with the git-remote-<vcs> helper.29592960remote.<name>.prune::2961 When set to true, fetching from this remote by default will also2962 remove any remote-tracking references that no longer exist on the2963 remote (as if the `--prune` option was given on the command line).2964 Overrides `fetch.prune` settings, if any.29652966remote.<name>.pruneTags::2967 When set to true, fetching from this remote by default will also2968 remove any local tags that no longer exist on the remote if pruning2969 is activated in general via `remote.<name>.prune`, `fetch.prune` or2970 `--prune`. Overrides `fetch.pruneTags` settings, if any.2971+2972See also `remote.<name>.prune` and the PRUNING section of2973linkgit:git-fetch[1].29742975remotes.<group>::2976 The list of remotes which are fetched by "git remote update2977 <group>". See linkgit:git-remote[1].29782979repack.useDeltaBaseOffset::2980 By default, linkgit:git-repack[1] creates packs that use2981 delta-base offset. If you need to share your repository with2982 Git older than version 1.4.4, either directly or via a dumb2983 protocol such as http, then you need to set this option to2984 "false" and repack. Access from old Git versions over the2985 native protocol are unaffected by this option.29862987repack.packKeptObjects::2988 If set to true, makes `git repack` act as if2989 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2990 details. Defaults to `false` normally, but `true` if a bitmap2991 index is being written (either via `--write-bitmap-index` or2992 `repack.writeBitmaps`).29932994repack.writeBitmaps::2995 When true, git will write a bitmap index when packing all2996 objects to disk (e.g., when `git repack -a` is run). This2997 index can speed up the "counting objects" phase of subsequent2998 packs created for clones and fetches, at the cost of some disk2999 space and extra time spent on the initial repack. This has3000 no effect if multiple packfiles are created.3001 Defaults to false.30023003rerere.autoUpdate::3004 When set to true, `git-rerere` updates the index with the3005 resulting contents after it cleanly resolves conflicts using3006 previously recorded resolution. Defaults to false.30073008rerere.enabled::3009 Activate recording of resolved conflicts, so that identical3010 conflict hunks can be resolved automatically, should they be3011 encountered again. By default, linkgit:git-rerere[1] is3012 enabled if there is an `rr-cache` directory under the3013 `$GIT_DIR`, e.g. if "rerere" was previously used in the3014 repository.30153016sendemail.identity::3017 A configuration identity. When given, causes values in the3018 'sendemail.<identity>' subsection to take precedence over3019 values in the 'sendemail' section. The default identity is3020 the value of `sendemail.identity`.30213022sendemail.smtpEncryption::3023 See linkgit:git-send-email[1] for description. Note that this3024 setting is not subject to the 'identity' mechanism.30253026sendemail.smtpssl (deprecated)::3027 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30283029sendemail.smtpsslcertpath::3030 Path to ca-certificates (either a directory or a single file).3031 Set it to an empty string to disable certificate verification.30323033sendemail.<identity>.*::3034 Identity-specific versions of the 'sendemail.*' parameters3035 found below, taking precedence over those when this3036 identity is selected, through either the command-line or3037 `sendemail.identity`.30383039sendemail.aliasesFile::3040sendemail.aliasFileType::3041sendemail.annotate::3042sendemail.bcc::3043sendemail.cc::3044sendemail.ccCmd::3045sendemail.chainReplyTo::3046sendemail.confirm::3047sendemail.envelopeSender::3048sendemail.from::3049sendemail.multiEdit::3050sendemail.signedoffbycc::3051sendemail.smtpPass::3052sendemail.suppresscc::3053sendemail.suppressFrom::3054sendemail.to::3055sendemail.tocmd::3056sendemail.smtpDomain::3057sendemail.smtpServer::3058sendemail.smtpServerPort::3059sendemail.smtpServerOption::3060sendemail.smtpUser::3061sendemail.thread::3062sendemail.transferEncoding::3063sendemail.validate::3064sendemail.xmailer::3065 See linkgit:git-send-email[1] for description.30663067sendemail.signedoffcc (deprecated)::3068 Deprecated alias for `sendemail.signedoffbycc`.30693070sendemail.smtpBatchSize::3071 Number of messages to be sent per connection, after that a relogin3072 will happen. If the value is 0 or undefined, send all messages in3073 one connection.3074 See also the `--batch-size` option of linkgit:git-send-email[1].30753076sendemail.smtpReloginDelay::3077 Seconds wait before reconnecting to smtp server.3078 See also the `--relogin-delay` option of linkgit:git-send-email[1].30793080showbranch.default::3081 The default set of branches for linkgit:git-show-branch[1].3082 See linkgit:git-show-branch[1].30833084splitIndex.maxPercentChange::3085 When the split index feature is used, this specifies the3086 percent of entries the split index can contain compared to the3087 total number of entries in both the split index and the shared3088 index before a new shared index is written.3089 The value should be between 0 and 100. If the value is 0 then3090 a new shared index is always written, if it is 100 a new3091 shared index is never written.3092 By default the value is 20, so a new shared index is written3093 if the number of entries in the split index would be greater3094 than 20 percent of the total number of entries.3095 See linkgit:git-update-index[1].30963097splitIndex.sharedIndexExpire::3098 When the split index feature is used, shared index files that3099 were not modified since the time this variable specifies will3100 be removed when a new shared index file is created. The value3101 "now" expires all entries immediately, and "never" suppresses3102 expiration altogether.3103 The default value is "2.weeks.ago".3104 Note that a shared index file is considered modified (for the3105 purpose of expiration) each time a new split-index file is3106 either created based on it or read from it.3107 See linkgit:git-update-index[1].31083109status.relativePaths::3110 By default, linkgit:git-status[1] shows paths relative to the3111 current directory. Setting this variable to `false` shows paths3112 relative to the repository root (this was the default for Git3113 prior to v1.5.4).31143115status.short::3116 Set to true to enable --short by default in linkgit:git-status[1].3117 The option --no-short takes precedence over this variable.31183119status.branch::3120 Set to true to enable --branch by default in linkgit:git-status[1].3121 The option --no-branch takes precedence over this variable.31223123status.displayCommentPrefix::3124 If set to true, linkgit:git-status[1] will insert a comment3125 prefix before each output line (starting with3126 `core.commentChar`, i.e. `#` by default). This was the3127 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3128 Defaults to false.31293130status.showStash::3131 If set to true, linkgit:git-status[1] will display the number of3132 entries currently stashed away.3133 Defaults to false.31343135status.showUntrackedFiles::3136 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3137 files which are not currently tracked by Git. Directories which3138 contain only untracked files, are shown with the directory name3139 only. Showing untracked files means that Git needs to lstat() all3140 the files in the whole repository, which might be slow on some3141 systems. So, this variable controls how the commands displays3142 the untracked files. Possible values are:3143+3144--3145* `no` - Show no untracked files.3146* `normal` - Show untracked files and directories.3147* `all` - Show also individual files in untracked directories.3148--3149+3150If this variable is not specified, it defaults to 'normal'.3151This variable can be overridden with the -u|--untracked-files option3152of linkgit:git-status[1] and linkgit:git-commit[1].31533154status.submoduleSummary::3155 Defaults to false.3156 If this is set to a non zero number or true (identical to -1 or an3157 unlimited number), the submodule summary will be enabled and a3158 summary of commits for modified submodules will be shown (see3159 --summary-limit option of linkgit:git-submodule[1]). Please note3160 that the summary output command will be suppressed for all3161 submodules when `diff.ignoreSubmodules` is set to 'all' or only3162 for those submodules where `submodule.<name>.ignore=all`. The only3163 exception to that rule is that status and commit will show staged3164 submodule changes. To3165 also view the summary for ignored submodules you can either use3166 the --ignore-submodules=dirty command-line option or the 'git3167 submodule summary' command, which shows a similar output but does3168 not honor these settings.31693170stash.showPatch::3171 If this is set to true, the `git stash show` command without an3172 option will show the stash entry in patch form. Defaults to false.3173 See description of 'show' command in linkgit:git-stash[1].31743175stash.showStat::3176 If this is set to true, the `git stash show` command without an3177 option will show diffstat of the stash entry. Defaults to true.3178 See description of 'show' command in linkgit:git-stash[1].31793180submodule.<name>.url::3181 The URL for a submodule. This variable is copied from the .gitmodules3182 file to the git config via 'git submodule init'. The user can change3183 the configured URL before obtaining the submodule via 'git submodule3184 update'. If neither submodule.<name>.active or submodule.active are3185 set, the presence of this variable is used as a fallback to indicate3186 whether the submodule is of interest to git commands.3187 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31883189submodule.<name>.update::3190 The method by which a submodule is updated by 'git submodule update',3191 which is the only affected command, others such as3192 'git checkout --recurse-submodules' are unaffected. It exists for3193 historical reasons, when 'git submodule' was the only command to3194 interact with submodules; settings like `submodule.active`3195 and `pull.rebase` are more specific. It is populated by3196 `git submodule init` from the linkgit:gitmodules[5] file.3197 See description of 'update' command in linkgit:git-submodule[1].31983199submodule.<name>.branch::3200 The remote branch name for a submodule, used by `git submodule3201 update --remote`. Set this option to override the value found in3202 the `.gitmodules` file. See linkgit:git-submodule[1] and3203 linkgit:gitmodules[5] for details.32043205submodule.<name>.fetchRecurseSubmodules::3206 This option can be used to control recursive fetching of this3207 submodule. It can be overridden by using the --[no-]recurse-submodules3208 command-line option to "git fetch" and "git pull".3209 This setting will override that from in the linkgit:gitmodules[5]3210 file.32113212submodule.<name>.ignore::3213 Defines under what circumstances "git status" and the diff family show3214 a submodule as modified. When set to "all", it will never be considered3215 modified (but it will nonetheless show up in the output of status and3216 commit when it has been staged), "dirty" will ignore all changes3217 to the submodules work tree and3218 takes only differences between the HEAD of the submodule and the commit3219 recorded in the superproject into account. "untracked" will additionally3220 let submodules with modified tracked files in their work tree show up.3221 Using "none" (the default when this option is not set) also shows3222 submodules that have untracked files in their work tree as changed.3223 This setting overrides any setting made in .gitmodules for this submodule,3224 both settings can be overridden on the command line by using the3225 "--ignore-submodules" option. The 'git submodule' commands are not3226 affected by this setting.32273228submodule.<name>.active::3229 Boolean value indicating if the submodule is of interest to git3230 commands. This config option takes precedence over the3231 submodule.active config option.32323233submodule.active::3234 A repeated field which contains a pathspec used to match against a3235 submodule's path to determine if the submodule is of interest to git3236 commands.32373238submodule.recurse::3239 Specifies if commands recurse into submodules by default. This3240 applies to all commands that have a `--recurse-submodules` option,3241 except `clone`.3242 Defaults to false.32433244submodule.fetchJobs::3245 Specifies how many submodules are fetched/cloned at the same time.3246 A positive integer allows up to that number of submodules fetched3247 in parallel. A value of 0 will give some reasonable default.3248 If unset, it defaults to 1.32493250submodule.alternateLocation::3251 Specifies how the submodules obtain alternates when submodules are3252 cloned. Possible values are `no`, `superproject`.3253 By default `no` is assumed, which doesn't add references. When the3254 value is set to `superproject` the submodule to be cloned computes3255 its alternates location relative to the superprojects alternate.32563257submodule.alternateErrorStrategy::3258 Specifies how to treat errors with the alternates for a submodule3259 as computed via `submodule.alternateLocation`. Possible values are3260 `ignore`, `info`, `die`. Default is `die`.32613262tag.forceSignAnnotated::3263 A boolean to specify whether annotated tags created should be GPG signed.3264 If `--annotate` is specified on the command line, it takes3265 precedence over this option.32663267tag.sort::3268 This variable controls the sort ordering of tags when displayed by3269 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3270 value of this variable will be used as the default.32713272tar.umask::3273 This variable can be used to restrict the permission bits of3274 tar archive entries. The default is 0002, which turns off the3275 world write bit. The special value "user" indicates that the3276 archiving user's umask will be used instead. See umask(2) and3277 linkgit:git-archive[1].32783279transfer.fsckObjects::3280 When `fetch.fsckObjects` or `receive.fsckObjects` are3281 not set, the value of this variable is used instead.3282 Defaults to false.32833284transfer.hideRefs::3285 String(s) `receive-pack` and `upload-pack` use to decide which3286 refs to omit from their initial advertisements. Use more than3287 one definition to specify multiple prefix strings. A ref that is3288 under the hierarchies listed in the value of this variable is3289 excluded, and is hidden when responding to `git push` or `git3290 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3291 program-specific versions of this config.3292+3293You may also include a `!` in front of the ref name to negate the entry,3294explicitly exposing it, even if an earlier entry marked it as hidden.3295If you have multiple hideRefs values, later entries override earlier ones3296(and entries in more-specific config files override less-specific ones).3297+3298If a namespace is in use, the namespace prefix is stripped from each3299reference before it is matched against `transfer.hiderefs` patterns.3300For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3301the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3302is omitted from the advertisements but `refs/heads/master` and3303`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3304"have" lines. In order to match refs before stripping, add a `^` in front of3305the ref name. If you combine `!` and `^`, `!` must be specified first.3306+3307Even if you hide refs, a client may still be able to steal the target3308objects via the techniques described in the "SECURITY" section of the3309linkgit:gitnamespaces[7] man page; it's best to keep private data in a3310separate repository.33113312transfer.unpackLimit::3313 When `fetch.unpackLimit` or `receive.unpackLimit` are3314 not set, the value of this variable is used instead.3315 The default value is 100.33163317uploadarchive.allowUnreachable::3318 If true, allow clients to use `git archive --remote` to request3319 any tree, whether reachable from the ref tips or not. See the3320 discussion in the "SECURITY" section of3321 linkgit:git-upload-archive[1] for more details. Defaults to3322 `false`.33233324uploadpack.hideRefs::3325 This variable is the same as `transfer.hideRefs`, but applies3326 only to `upload-pack` (and so affects only fetches, not pushes).3327 An attempt to fetch a hidden ref by `git fetch` will fail. See3328 also `uploadpack.allowTipSHA1InWant`.33293330uploadpack.allowTipSHA1InWant::3331 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3332 to accept a fetch request that asks for an object at the tip3333 of a hidden ref (by default, such a request is rejected).3334 See also `uploadpack.hideRefs`. Even if this is false, a client3335 may be able to steal objects via the techniques described in the3336 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3337 best to keep private data in a separate repository.33383339uploadpack.allowReachableSHA1InWant::3340 Allow `upload-pack` to accept a fetch request that asks for an3341 object that is reachable from any ref tip. However, note that3342 calculating object reachability is computationally expensive.3343 Defaults to `false`. Even if this is false, a client may be able3344 to steal objects via the techniques described in the "SECURITY"3345 section of the linkgit:gitnamespaces[7] man page; it's best to3346 keep private data in a separate repository.33473348uploadpack.allowAnySHA1InWant::3349 Allow `upload-pack` to accept a fetch request that asks for any3350 object at all.3351 Defaults to `false`.33523353uploadpack.keepAlive::3354 When `upload-pack` has started `pack-objects`, there may be a3355 quiet period while `pack-objects` prepares the pack. Normally3356 it would output progress information, but if `--quiet` was used3357 for the fetch, `pack-objects` will output nothing at all until3358 the pack data begins. Some clients and networks may consider3359 the server to be hung and give up. Setting this option instructs3360 `upload-pack` to send an empty keepalive packet every3361 `uploadpack.keepAlive` seconds. Setting this option to 03362 disables keepalive packets entirely. The default is 5 seconds.33633364uploadpack.packObjectsHook::3365 If this option is set, when `upload-pack` would run3366 `git pack-objects` to create a packfile for a client, it will3367 run this shell command instead. The `pack-objects` command and3368 arguments it _would_ have run (including the `git pack-objects`3369 at the beginning) are appended to the shell command. The stdin3370 and stdout of the hook are treated as if `pack-objects` itself3371 was run. I.e., `upload-pack` will feed input intended for3372 `pack-objects` to the hook, and expects a completed packfile on3373 stdout.33743375uploadpack.allowFilter::3376 If this option is set, `upload-pack` will support partial3377 clone and partial fetch object filtering.3378+3379Note that this configuration variable is ignored if it is seen in the3380repository-level config (this is a safety measure against fetching from3381untrusted repositories).33823383url.<base>.insteadOf::3384 Any URL that starts with this value will be rewritten to3385 start, instead, with <base>. In cases where some site serves a3386 large number of repositories, and serves them with multiple3387 access methods, and some users need to use different access3388 methods, this feature allows people to specify any of the3389 equivalent URLs and have Git automatically rewrite the URL to3390 the best alternative for the particular user, even for a3391 never-before-seen repository on the site. When more than one3392 insteadOf strings match a given URL, the longest match is used.3393+3394Note that any protocol restrictions will be applied to the rewritten3395URL. If the rewrite changes the URL to use a custom protocol or remote3396helper, you may need to adjust the `protocol.*.allow` config to permit3397the request. In particular, protocols you expect to use for submodules3398must be set to `always` rather than the default of `user`. See the3399description of `protocol.allow` above.34003401url.<base>.pushInsteadOf::3402 Any URL that starts with this value will not be pushed to;3403 instead, it will be rewritten to start with <base>, and the3404 resulting URL will be pushed to. In cases where some site serves3405 a large number of repositories, and serves them with multiple3406 access methods, some of which do not allow push, this feature3407 allows people to specify a pull-only URL and have Git3408 automatically use an appropriate URL to push, even for a3409 never-before-seen repository on the site. When more than one3410 pushInsteadOf strings match a given URL, the longest match is3411 used. If a remote has an explicit pushurl, Git will ignore this3412 setting for that remote.34133414user.email::3415 Your email address to be recorded in any newly created commits.3416 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3417 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34183419user.name::3420 Your full name to be recorded in any newly created commits.3421 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3422 environment variables. See linkgit:git-commit-tree[1].34233424user.useConfigOnly::3425 Instruct Git to avoid trying to guess defaults for `user.email`3426 and `user.name`, and instead retrieve the values only from the3427 configuration. For example, if you have multiple email addresses3428 and would like to use a different one for each repository, then3429 with this configuration option set to `true` in the global config3430 along with a name, Git will prompt you to set up an email before3431 making new commits in a newly cloned repository.3432 Defaults to `false`.34333434user.signingKey::3435 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3436 key you want it to automatically when creating a signed tag or3437 commit, you can override the default selection with this variable.3438 This option is passed unchanged to gpg's --local-user parameter,3439 so you may specify a key using any method that gpg supports.34403441versionsort.prereleaseSuffix (deprecated)::3442 Deprecated alias for `versionsort.suffix`. Ignored if3443 `versionsort.suffix` is set.34443445versionsort.suffix::3446 Even when version sort is used in linkgit:git-tag[1], tagnames3447 with the same base version but different suffixes are still sorted3448 lexicographically, resulting e.g. in prerelease tags appearing3449 after the main release (e.g. "1.0-rc1" after "1.0"). This3450 variable can be specified to determine the sorting order of tags3451 with different suffixes.3452+3453By specifying a single suffix in this variable, any tagname containing3454that suffix will appear before the corresponding main release. E.g. if3455the variable is set to "-rc", then all "1.0-rcX" tags will appear before3456"1.0". If specified multiple times, once per suffix, then the order of3457suffixes in the configuration will determine the sorting order of tagnames3458with those suffixes. E.g. if "-pre" appears before "-rc" in the3459configuration, then all "1.0-preX" tags will be listed before any3460"1.0-rcX" tags. The placement of the main release tag relative to tags3461with various suffixes can be determined by specifying the empty suffix3462among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3463"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3464are listed first, followed by "v4.8", then "v4.8-ckX" and finally3465"v4.8-bfsX".3466+3467If more than one suffixes match the same tagname, then that tagname will3468be sorted according to the suffix which starts at the earliest position in3469the tagname. If more than one different matching suffixes start at3470that earliest position, then that tagname will be sorted according to the3471longest of those suffixes.3472The sorting order between different suffixes is undefined if they are3473in multiple config files.34743475web.browser::3476 Specify a web browser that may be used by some commands.3477 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3478 may use it.34793480worktree.guessRemote::3481 With `add`, if no branch argument, and neither of `-b` nor3482 `-B` nor `--detach` are given, the command defaults to3483 creating a new branch from HEAD. If `worktree.guessRemote` is3484 set to true, `worktree add` tries to find a remote-tracking3485 branch whose name uniquely matches the new branch name. If3486 such a branch exists, it is checked out and set as "upstream"3487 for the new branch. If no such match can be found, it falls3488 back to creating a new branch from the current HEAD.