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.checkRoundtripEncoding:: 534 A comma and/or whitespace separated list of encodings that Git 535 performs UTF-8 round trip checks on if they are used in an 536 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 537 The default value is `SHIFT-JIS`. 538 539core.symlinks:: 540 If false, symbolic links are checked out as small plain files that 541 contain the link text. linkgit:git-update-index[1] and 542 linkgit:git-add[1] will not change the recorded type to regular 543 file. Useful on filesystems like FAT that do not support 544 symbolic links. 545+ 546The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 547will probe and set core.symlinks false if appropriate when the repository 548is created. 549 550core.gitProxy:: 551 A "proxy command" to execute (as 'command host port') instead 552 of establishing direct connection to the remote server when 553 using the Git protocol for fetching. If the variable value is 554 in the "COMMAND for DOMAIN" format, the command is applied only 555 on hostnames ending with the specified domain string. This variable 556 may be set multiple times and is matched in the given order; 557 the first match wins. 558+ 559Can be overridden by the `GIT_PROXY_COMMAND` environment variable 560(which always applies universally, without the special "for" 561handling). 562+ 563The special string `none` can be used as the proxy command to 564specify that no proxy be used for a given domain pattern. 565This is useful for excluding servers inside a firewall from 566proxy use, while defaulting to a common proxy for external domains. 567 568core.sshCommand:: 569 If this variable is set, `git fetch` and `git push` will 570 use the specified command instead of `ssh` when they need to 571 connect to a remote system. The command is in the same form as 572 the `GIT_SSH_COMMAND` environment variable and is overridden 573 when the environment variable is set. 574 575core.ignoreStat:: 576 If true, Git will avoid using lstat() calls to detect if files have 577 changed by setting the "assume-unchanged" bit for those tracked files 578 which it has updated identically in both the index and working tree. 579+ 580When files are modified outside of Git, the user will need to stage 581the modified files explicitly (e.g. see 'Examples' section in 582linkgit:git-update-index[1]). 583Git will not normally detect changes to those files. 584+ 585This is useful on systems where lstat() calls are very slow, such as 586CIFS/Microsoft Windows. 587+ 588False by default. 589 590core.preferSymlinkRefs:: 591 Instead of the default "symref" format for HEAD 592 and other symbolic reference files, use symbolic links. 593 This is sometimes needed to work with old scripts that 594 expect HEAD to be a symbolic link. 595 596core.bare:: 597 If true this repository is assumed to be 'bare' and has no 598 working directory associated with it. If this is the case a 599 number of commands that require a working directory will be 600 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 601+ 602This setting is automatically guessed by linkgit:git-clone[1] or 603linkgit:git-init[1] when the repository was created. By default a 604repository that ends in "/.git" is assumed to be not bare (bare = 605false), while all other repositories are assumed to be bare (bare 606= true). 607 608core.worktree:: 609 Set the path to the root of the working tree. 610 If `GIT_COMMON_DIR` environment variable is set, core.worktree 611 is ignored and not used for determining the root of working tree. 612 This can be overridden by the `GIT_WORK_TREE` environment 613 variable and the `--work-tree` command-line option. 614 The value can be an absolute path or relative to the path to 615 the .git directory, which is either specified by --git-dir 616 or GIT_DIR, or automatically discovered. 617 If --git-dir or GIT_DIR is specified but none of 618 --work-tree, GIT_WORK_TREE and core.worktree is specified, 619 the current working directory is regarded as the top level 620 of your working tree. 621+ 622Note that this variable is honored even when set in a configuration 623file in a ".git" subdirectory of a directory and its value differs 624from the latter directory (e.g. "/path/to/.git/config" has 625core.worktree set to "/different/path"), which is most likely a 626misconfiguration. Running Git commands in the "/path/to" directory will 627still use "/different/path" as the root of the work tree and can cause 628confusion unless you know what you are doing (e.g. you are creating a 629read-only snapshot of the same index to a location different from the 630repository's usual working tree). 631 632core.logAllRefUpdates:: 633 Enable the reflog. Updates to a ref <ref> is logged to the file 634 "`$GIT_DIR/logs/<ref>`", by appending the new and old 635 SHA-1, the date/time and the reason of the update, but 636 only when the file exists. If this configuration 637 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 638 file is automatically created for branch heads (i.e. under 639 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 640 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 641 If it is set to `always`, then a missing reflog is automatically 642 created for any ref under `refs/`. 643+ 644This information can be used to determine what commit 645was the tip of a branch "2 days ago". 646+ 647This value is true by default in a repository that has 648a working directory associated with it, and false by 649default in a bare repository. 650 651core.repositoryFormatVersion:: 652 Internal variable identifying the repository format and layout 653 version. 654 655core.sharedRepository:: 656 When 'group' (or 'true'), the repository is made shareable between 657 several users in a group (making sure all the files and objects are 658 group-writable). When 'all' (or 'world' or 'everybody'), the 659 repository will be readable by all users, additionally to being 660 group-shareable. When 'umask' (or 'false'), Git will use permissions 661 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 662 files in the repository will have this mode value. '0xxx' will override 663 user's umask value (whereas the other options will only override 664 requested parts of the user's umask value). Examples: '0660' will make 665 the repo read/write-able for the owner and group, but inaccessible to 666 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 667 repository that is group-readable but not group-writable. 668 See linkgit:git-init[1]. False by default. 669 670core.warnAmbiguousRefs:: 671 If true, Git will warn you if the ref name you passed it is ambiguous 672 and might match multiple refs in the repository. True by default. 673 674core.compression:: 675 An integer -1..9, indicating a default compression level. 676 -1 is the zlib default. 0 means no compression, 677 and 1..9 are various speed/size tradeoffs, 9 being slowest. 678 If set, this provides a default to other compression variables, 679 such as `core.looseCompression` and `pack.compression`. 680 681core.looseCompression:: 682 An integer -1..9, indicating the compression level for objects that 683 are not in a pack file. -1 is the zlib default. 0 means no 684 compression, and 1..9 are various speed/size tradeoffs, 9 being 685 slowest. If not set, defaults to core.compression. If that is 686 not set, defaults to 1 (best speed). 687 688core.packedGitWindowSize:: 689 Number of bytes of a pack file to map into memory in a 690 single mapping operation. Larger window sizes may allow 691 your system to process a smaller number of large pack files 692 more quickly. Smaller window sizes will negatively affect 693 performance due to increased calls to the operating system's 694 memory manager, but may improve performance when accessing 695 a large number of large pack files. 696+ 697Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 698MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 699be reasonable for all users/operating systems. You probably do 700not need to adjust this value. 701+ 702Common unit suffixes of 'k', 'm', or 'g' are supported. 703 704core.packedGitLimit:: 705 Maximum number of bytes to map simultaneously into memory 706 from pack files. If Git needs to access more than this many 707 bytes at once to complete an operation it will unmap existing 708 regions to reclaim virtual address space within the process. 709+ 710Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 711unlimited) on 64 bit platforms. 712This should be reasonable for all users/operating systems, except on 713the largest projects. You probably do not need to adjust this value. 714+ 715Common unit suffixes of 'k', 'm', or 'g' are supported. 716 717core.deltaBaseCacheLimit:: 718 Maximum number of bytes to reserve for caching base objects 719 that may be referenced by multiple deltified objects. By storing the 720 entire decompressed base objects in a cache Git is able 721 to avoid unpacking and decompressing frequently used base 722 objects multiple times. 723+ 724Default is 96 MiB on all platforms. This should be reasonable 725for all users/operating systems, except on the largest projects. 726You probably do not need to adjust this value. 727+ 728Common unit suffixes of 'k', 'm', or 'g' are supported. 729 730core.bigFileThreshold:: 731 Files larger than this size are stored deflated, without 732 attempting delta compression. Storing large files without 733 delta compression avoids excessive memory usage, at the 734 slight expense of increased disk usage. Additionally files 735 larger than this size are always treated as binary. 736+ 737Default is 512 MiB on all platforms. This should be reasonable 738for most projects as source code and other text files can still 739be delta compressed, but larger binary media files won't be. 740+ 741Common unit suffixes of 'k', 'm', or 'g' are supported. 742 743core.excludesFile:: 744 Specifies the pathname to the file that contains patterns to 745 describe paths that are not meant to be tracked, in addition 746 to '.gitignore' (per-directory) and '.git/info/exclude'. 747 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 748 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 749 is used instead. See linkgit:gitignore[5]. 750 751core.askPass:: 752 Some commands (e.g. svn and http interfaces) that interactively 753 ask for a password can be told to use an external program given 754 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 755 environment variable. If not set, fall back to the value of the 756 `SSH_ASKPASS` environment variable or, failing that, a simple password 757 prompt. The external program shall be given a suitable prompt as 758 command-line argument and write the password on its STDOUT. 759 760core.attributesFile:: 761 In addition to '.gitattributes' (per-directory) and 762 '.git/info/attributes', Git looks into this file for attributes 763 (see linkgit:gitattributes[5]). Path expansions are made the same 764 way as for `core.excludesFile`. Its default value is 765 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 766 set or empty, `$HOME/.config/git/attributes` is used instead. 767 768core.hooksPath:: 769 By default Git will look for your hooks in the 770 '$GIT_DIR/hooks' directory. Set this to different path, 771 e.g. '/etc/git/hooks', and Git will try to find your hooks in 772 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 773 in '$GIT_DIR/hooks/pre-receive'. 774+ 775The path can be either absolute or relative. A relative path is 776taken as relative to the directory where the hooks are run (see 777the "DESCRIPTION" section of linkgit:githooks[5]). 778+ 779This configuration variable is useful in cases where you'd like to 780centrally configure your Git hooks instead of configuring them on a 781per-repository basis, or as a more flexible and centralized 782alternative to having an `init.templateDir` where you've changed 783default hooks. 784 785core.editor:: 786 Commands such as `commit` and `tag` that let you edit 787 messages by launching an editor use the value of this 788 variable when it is set, and the environment variable 789 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 790 791core.commentChar:: 792 Commands such as `commit` and `tag` that let you edit 793 messages consider a line that begins with this character 794 commented, and removes them after the editor returns 795 (default '#'). 796+ 797If set to "auto", `git-commit` would select a character that is not 798the beginning character of any line in existing commit messages. 799 800core.filesRefLockTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock an individual reference. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 100 (i.e., 804 retry for 100ms). 805 806core.packedRefsTimeout:: 807 The length of time, in milliseconds, to retry when trying to 808 lock the `packed-refs` file. Value 0 means not to retry at 809 all; -1 means to try indefinitely. Default is 1000 (i.e., 810 retry for 1 second). 811 812sequence.editor:: 813 Text editor used by `git rebase -i` for editing the rebase instruction file. 814 The value is meant to be interpreted by the shell when it is used. 815 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 816 When not configured the default commit message editor is used instead. 817 818core.pager:: 819 Text viewer for use by Git commands (e.g., 'less'). The value 820 is meant to be interpreted by the shell. The order of preference 821 is the `$GIT_PAGER` environment variable, then `core.pager` 822 configuration, then `$PAGER`, and then the default chosen at 823 compile time (usually 'less'). 824+ 825When the `LESS` environment variable is unset, Git sets it to `FRX` 826(if `LESS` environment variable is set, Git does not change it at 827all). If you want to selectively override Git's default setting 828for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 829be passed to the shell by Git, which will translate the final 830command to `LESS=FRX less -S`. The environment does not set the 831`S` option but the command line does, instructing less to truncate 832long lines. Similarly, setting `core.pager` to `less -+F` will 833deactivate the `F` option specified by the environment from the 834command-line, deactivating the "quit if one screen" behavior of 835`less`. One can specifically activate some flags for particular 836commands: for example, setting `pager.blame` to `less -S` enables 837line truncation only for `git blame`. 838+ 839Likewise, when the `LV` environment variable is unset, Git sets it 840to `-c`. You can override this setting by exporting `LV` with 841another value or setting `core.pager` to `lv +c`. 842 843core.whitespace:: 844 A comma separated list of common whitespace problems to 845 notice. 'git diff' will use `color.diff.whitespace` to 846 highlight them, and 'git apply --whitespace=error' will 847 consider them as errors. You can prefix `-` to disable 848 any of them (e.g. `-trailing-space`): 849+ 850* `blank-at-eol` treats trailing whitespaces at the end of the line 851 as an error (enabled by default). 852* `space-before-tab` treats a space character that appears immediately 853 before a tab character in the initial indent part of the line as an 854 error (enabled by default). 855* `indent-with-non-tab` treats a line that is indented with space 856 characters instead of the equivalent tabs as an error (not enabled by 857 default). 858* `tab-in-indent` treats a tab character in the initial indent part of 859 the line as an error (not enabled by default). 860* `blank-at-eof` treats blank lines added at the end of file as an error 861 (enabled by default). 862* `trailing-space` is a short-hand to cover both `blank-at-eol` and 863 `blank-at-eof`. 864* `cr-at-eol` treats a carriage-return at the end of line as 865 part of the line terminator, i.e. with it, `trailing-space` 866 does not trigger if the character before such a carriage-return 867 is not a whitespace (not enabled by default). 868* `tabwidth=<n>` tells how many character positions a tab occupies; this 869 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 870 errors. The default tab width is 8. Allowed values are 1 to 63. 871 872core.fsyncObjectFiles:: 873 This boolean will enable 'fsync()' when writing object files. 874+ 875This is a total waste of time and effort on a filesystem that orders 876data writes properly, but can be useful for filesystems that do not use 877journalling (traditional UNIX filesystems) or that only journal metadata 878and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 879 880core.preloadIndex:: 881 Enable parallel index preload for operations like 'git diff' 882+ 883This can speed up operations like 'git diff' and 'git status' especially 884on filesystems like NFS that have weak caching semantics and thus 885relatively high IO latencies. When enabled, Git will do the 886index comparison to the filesystem data in parallel, allowing 887overlapping IO's. Defaults to true. 888 889core.createObject:: 890 You can set this to 'link', in which case a hardlink followed by 891 a delete of the source are used to make sure that object creation 892 will not overwrite existing objects. 893+ 894On some file system/operating system combinations, this is unreliable. 895Set this config setting to 'rename' there; However, This will remove the 896check that makes sure that existing object files will not get overwritten. 897 898core.notesRef:: 899 When showing commit messages, also show notes which are stored in 900 the given ref. The ref must be fully qualified. If the given 901 ref does not exist, it is not an error but means that no 902 notes should be printed. 903+ 904This setting defaults to "refs/notes/commits", and it can be overridden by 905the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 906 907core.commitGraph:: 908 Enable git commit graph feature. Allows reading from the 909 commit-graph file. 910 911core.sparseCheckout:: 912 Enable "sparse checkout" feature. See section "Sparse checkout" in 913 linkgit:git-read-tree[1] for more information. 914 915core.abbrev:: 916 Set the length object names are abbreviated to. If 917 unspecified or set to "auto", an appropriate value is 918 computed based on the approximate number of packed objects 919 in your repository, which hopefully is enough for 920 abbreviated object names to stay unique for some time. 921 The minimum length is 4. 922 923add.ignoreErrors:: 924add.ignore-errors (deprecated):: 925 Tells 'git add' to continue adding files when some files cannot be 926 added due to indexing errors. Equivalent to the `--ignore-errors` 927 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 928 as it does not follow the usual naming convention for configuration 929 variables. 930 931alias.*:: 932 Command aliases for the linkgit:git[1] command wrapper - e.g. 933 after defining "alias.last = cat-file commit HEAD", the invocation 934 "git last" is equivalent to "git cat-file commit HEAD". To avoid 935 confusion and troubles with script usage, aliases that 936 hide existing Git commands are ignored. Arguments are split by 937 spaces, the usual shell quoting and escaping is supported. 938 A quote pair or a backslash can be used to quote them. 939+ 940If the alias expansion is prefixed with an exclamation point, 941it will be treated as a shell command. For example, defining 942"alias.new = !gitk --all --not ORIG_HEAD", the invocation 943"git new" is equivalent to running the shell command 944"gitk --all --not ORIG_HEAD". Note that shell commands will be 945executed from the top-level directory of a repository, which may 946not necessarily be the current directory. 947`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 948from the original current directory. See linkgit:git-rev-parse[1]. 949 950am.keepcr:: 951 If true, git-am will call git-mailsplit for patches in mbox format 952 with parameter `--keep-cr`. In this case git-mailsplit will 953 not remove `\r` from lines ending with `\r\n`. Can be overridden 954 by giving `--no-keep-cr` from the command line. 955 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 956 957am.threeWay:: 958 By default, `git am` will fail if the patch does not apply cleanly. When 959 set to true, this setting tells `git am` to fall back on 3-way merge if 960 the patch records the identity of blobs it is supposed to apply to and 961 we have those blobs available locally (equivalent to giving the `--3way` 962 option from the command line). Defaults to `false`. 963 See linkgit:git-am[1]. 964 965apply.ignoreWhitespace:: 966 When set to 'change', tells 'git apply' to ignore changes in 967 whitespace, in the same way as the `--ignore-space-change` 968 option. 969 When set to one of: no, none, never, false tells 'git apply' to 970 respect all whitespace differences. 971 See linkgit:git-apply[1]. 972 973apply.whitespace:: 974 Tells 'git apply' how to handle whitespaces, in the same way 975 as the `--whitespace` option. See linkgit:git-apply[1]. 976 977blame.showRoot:: 978 Do not treat root commits as boundaries in linkgit:git-blame[1]. 979 This option defaults to false. 980 981blame.blankBoundary:: 982 Show blank commit object name for boundary commits in 983 linkgit:git-blame[1]. This option defaults to false. 984 985blame.showEmail:: 986 Show the author email instead of author name in linkgit:git-blame[1]. 987 This option defaults to false. 988 989blame.date:: 990 Specifies the format used to output dates in linkgit:git-blame[1]. 991 If unset the iso format is used. For supported values, 992 see the discussion of the `--date` option at linkgit:git-log[1]. 993 994branch.autoSetupMerge:: 995 Tells 'git branch' and 'git checkout' to set up new branches 996 so that linkgit:git-pull[1] will appropriately merge from the 997 starting point branch. Note that even if this option is not set, 998 this behavior can be chosen per-branch using the `--track` 999 and `--no-track` options. The valid settings are: `false` -- no1000 automatic setup is done; `true` -- automatic setup is done when the1001 starting point is a remote-tracking branch; `always` --1002 automatic setup is done when the starting point is either a1003 local branch or remote-tracking1004 branch. This option defaults to true.10051006branch.autoSetupRebase::1007 When a new branch is created with 'git branch' or 'git checkout'1008 that tracks another branch, this variable tells Git to set1009 up pull to rebase instead of merge (see "branch.<name>.rebase").1010 When `never`, rebase is never automatically set to true.1011 When `local`, rebase is set to true for tracked branches of1012 other local branches.1013 When `remote`, rebase is set to true for tracked branches of1014 remote-tracking branches.1015 When `always`, rebase will be set to true for all tracking1016 branches.1017 See "branch.autoSetupMerge" for details on how to set up a1018 branch to track another branch.1019 This option defaults to never.10201021branch.<name>.remote::1022 When on branch <name>, it tells 'git fetch' and 'git push'1023 which remote to fetch from/push to. The remote to push to1024 may be overridden with `remote.pushDefault` (for all branches).1025 The remote to push to, for the current branch, may be further1026 overridden by `branch.<name>.pushRemote`. If no remote is1027 configured, or if you are not on any branch, it defaults to1028 `origin` for fetching and `remote.pushDefault` for pushing.1029 Additionally, `.` (a period) is the current local repository1030 (a dot-repository), see `branch.<name>.merge`'s final note below.10311032branch.<name>.pushRemote::1033 When on branch <name>, it overrides `branch.<name>.remote` for1034 pushing. It also overrides `remote.pushDefault` for pushing1035 from branch <name>. When you pull from one place (e.g. your1036 upstream) and push to another place (e.g. your own publishing1037 repository), you would want to set `remote.pushDefault` to1038 specify the remote to push to for all branches, and use this1039 option to override it for a specific branch.10401041branch.<name>.merge::1042 Defines, together with branch.<name>.remote, the upstream branch1043 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1044 branch to merge and can also affect 'git push' (see push.default).1045 When in branch <name>, it tells 'git fetch' the default1046 refspec to be marked for merging in FETCH_HEAD. The value is1047 handled like the remote part of a refspec, and must match a1048 ref which is fetched from the remote given by1049 "branch.<name>.remote".1050 The merge information is used by 'git pull' (which at first calls1051 'git fetch') to lookup the default branch for merging. Without1052 this option, 'git pull' defaults to merge the first refspec fetched.1053 Specify multiple values to get an octopus merge.1054 If you wish to setup 'git pull' so that it merges into <name> from1055 another branch in the local repository, you can point1056 branch.<name>.merge to the desired branch, and use the relative path1057 setting `.` (a period) for branch.<name>.remote.10581059branch.<name>.mergeOptions::1060 Sets default options for merging into branch <name>. The syntax and1061 supported options are the same as those of linkgit:git-merge[1], but1062 option values containing whitespace characters are currently not1063 supported.10641065branch.<name>.rebase::1066 When true, rebase the branch <name> on top of the fetched branch,1067 instead of merging the default branch from the default remote when1068 "git pull" is run. See "pull.rebase" for doing this in a non1069 branch-specific manner.1070+1071When `merges`, pass the `--rebase-merges` option to 'git rebase'1072so that the local merge commits are included in the rebase (see1073linkgit:git-rebase[1] for details).1074+1075When preserve, also pass `--preserve-merges` along to 'git rebase'1076so that locally committed merge commits will not be flattened1077by running 'git pull'.1078+1079When the value is `interactive`, the rebase is run in interactive mode.1080+1081*NOTE*: this is a possibly dangerous operation; do *not* use1082it unless you understand the implications (see linkgit:git-rebase[1]1083for details).10841085branch.<name>.description::1086 Branch description, can be edited with1087 `git branch --edit-description`. Branch description is1088 automatically added in the format-patch cover letter or1089 request-pull summary.10901091browser.<tool>.cmd::1092 Specify the command to invoke the specified browser. The1093 specified command is evaluated in shell with the URLs passed1094 as arguments. (See linkgit:git-web{litdd}browse[1].)10951096browser.<tool>.path::1097 Override the path for the given tool that may be used to1098 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1099 working repository in gitweb (see linkgit:git-instaweb[1]).11001101clean.requireForce::1102 A boolean to make git-clean do nothing unless given -f,1103 -i or -n. Defaults to true.11041105color.advice::1106 A boolean to enable/disable color in hints (e.g. when a push1107 failed, see `advice.*` for a list). May be set to `always`,1108 `false` (or `never`) or `auto` (or `true`), in which case colors1109 are used only when the error output goes to a terminal. If1110 unset, then the value of `color.ui` is used (`auto` by default).11111112color.advice.hint::1113 Use customized color for hints.11141115color.branch::1116 A boolean to enable/disable color in the output of1117 linkgit:git-branch[1]. May be set to `always`,1118 `false` (or `never`) or `auto` (or `true`), in which case colors are used1119 only when the output is to a terminal. If unset, then the1120 value of `color.ui` is used (`auto` by default).11211122color.branch.<slot>::1123 Use customized color for branch coloration. `<slot>` is one of1124 `current` (the current branch), `local` (a local branch),1125 `remote` (a remote-tracking branch in refs/remotes/),1126 `upstream` (upstream tracking branch), `plain` (other1127 refs).11281129color.diff::1130 Whether to use ANSI escape sequences to add color to patches.1131 If this is set to `always`, linkgit:git-diff[1],1132 linkgit:git-log[1], and linkgit:git-show[1] will use color1133 for all patches. If it is set to `true` or `auto`, those1134 commands will only use color when output is to the terminal.1135 If unset, then the value of `color.ui` is used (`auto` by1136 default).1137+1138This does not affect linkgit:git-format-patch[1] or the1139'git-diff-{asterisk}' plumbing commands. Can be overridden on the1140command line with the `--color[=<when>]` option.11411142diff.colorMoved::1143 If set to either a valid `<mode>` or a true value, moved lines1144 in a diff are colored differently, for details of valid modes1145 see '--color-moved' in linkgit:git-diff[1]. If simply set to1146 true the default color mode will be used. When set to false,1147 moved lines are not colored.11481149color.diff.<slot>::1150 Use customized color for diff colorization. `<slot>` specifies1151 which part of the patch to use the specified color, and is one1152 of `context` (context text - `plain` is a historical synonym),1153 `meta` (metainformation), `frag`1154 (hunk header), 'func' (function in hunk header), `old` (removed lines),1155 `new` (added lines), `commit` (commit headers), `whitespace`1156 (highlighting whitespace errors), `oldMoved` (deleted lines),1157 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1158 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1159 and `newMovedAlternativeDimmed` (See the '<mode>'1160 setting of '--color-moved' in linkgit:git-diff[1] for details).11611162color.decorate.<slot>::1163 Use customized color for 'git log --decorate' output. `<slot>` is one1164 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1165 branches, remote-tracking branches, tags, stash and HEAD, respectively.11661167color.grep::1168 When set to `always`, always highlight matches. When `false` (or1169 `never`), never. When set to `true` or `auto`, use color only1170 when the output is written to the terminal. If unset, then the1171 value of `color.ui` is used (`auto` by default).11721173color.grep.<slot>::1174 Use customized color for grep colorization. `<slot>` specifies which1175 part of the line to use the specified color, and is one of1176+1177--1178`context`;;1179 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1180`filename`;;1181 filename prefix (when not using `-h`)1182`function`;;1183 function name lines (when using `-p`)1184`linenumber`;;1185 line number prefix (when using `-n`)1186`match`;;1187 matching text (same as setting `matchContext` and `matchSelected`)1188`matchContext`;;1189 matching text in context lines1190`matchSelected`;;1191 matching text in selected lines1192`selected`;;1193 non-matching text in selected lines1194`separator`;;1195 separators between fields on a line (`:`, `-`, and `=`)1196 and between hunks (`--`)1197--11981199color.interactive::1200 When set to `always`, always use colors for interactive prompts1201 and displays (such as those used by "git-add --interactive" and1202 "git-clean --interactive"). When false (or `never`), never.1203 When set to `true` or `auto`, use colors only when the output is1204 to the terminal. If unset, then the value of `color.ui` is1205 used (`auto` by default).12061207color.interactive.<slot>::1208 Use customized color for 'git add --interactive' and 'git clean1209 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1210 or `error`, for four distinct types of normal output from1211 interactive commands.12121213color.pager::1214 A boolean to enable/disable colored output when the pager is in1215 use (default is true).12161217color.push::1218 A boolean to enable/disable color in push errors. May be set to1219 `always`, `false` (or `never`) or `auto` (or `true`), in which1220 case colors are used only when the error output goes to a terminal.1221 If unset, then the value of `color.ui` is used (`auto` by default).12221223color.push.error::1224 Use customized color for push errors.12251226color.showBranch::1227 A boolean to enable/disable color in the output of1228 linkgit:git-show-branch[1]. May be set to `always`,1229 `false` (or `never`) or `auto` (or `true`), in which case colors are used1230 only when the output is to a terminal. If unset, then the1231 value of `color.ui` is used (`auto` by default).12321233color.status::1234 A boolean to enable/disable color in the output of1235 linkgit:git-status[1]. May be set to `always`,1236 `false` (or `never`) or `auto` (or `true`), in which case colors are used1237 only when the output is to a terminal. If unset, then the1238 value of `color.ui` is used (`auto` by default).12391240color.status.<slot>::1241 Use customized color for status colorization. `<slot>` is1242 one of `header` (the header text of the status message),1243 `added` or `updated` (files which are added but not committed),1244 `changed` (files which are changed but not added in the index),1245 `untracked` (files which are not tracked by Git),1246 `branch` (the current branch),1247 `nobranch` (the color the 'no branch' warning is shown in, defaulting1248 to red),1249 `localBranch` or `remoteBranch` (the local and remote branch names,1250 respectively, when branch and tracking information is displayed in the1251 status short-format), or1252 `unmerged` (files which have unmerged changes).12531254color.blame.repeatedLines::1255 Use the customized color for the part of git-blame output that1256 is repeated meta information per line (such as commit id,1257 author name, date and timezone). Defaults to cyan.12581259color.blame.highlightRecent::1260 This can be used to color the metadata of a blame line depending1261 on age of the line.1262+1263This setting should be set to a comma-separated list of color and date settings,1264starting and ending with a color, the dates should be set from oldest to newest.1265The metadata will be colored given the colors if the the line was introduced1266before the given timestamp, overwriting older timestamped colors.1267+1268Instead of an absolute timestamp relative timestamps work as well, e.g.12692.weeks.ago is valid to address anything older than 2 weeks.1270+1271It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1272everything older than one year blue, recent changes between one month and1273one year old are kept white, and lines introduced within the last month are1274colored red.12751276blame.coloring::1277 This determines the coloring scheme to be applied to blame1278 output. It can be 'repeatedLines', 'highlightRecent',1279 or 'none' which is the default.12801281color.transport::1282 A boolean to enable/disable color when pushes are rejected. May be1283 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1284 case colors are used only when the error output goes to a terminal.1285 If unset, then the value of `color.ui` is used (`auto` by default).12861287color.transport.rejected::1288 Use customized color when a push was rejected.12891290color.ui::1291 This variable determines the default value for variables such1292 as `color.diff` and `color.grep` that control the use of color1293 per command family. Its scope will expand as more commands learn1294 configuration to set a default for the `--color` option. Set it1295 to `false` or `never` if you prefer Git commands not to use1296 color unless enabled explicitly with some other configuration1297 or the `--color` option. Set it to `always` if you want all1298 output not intended for machine consumption to use color, to1299 `true` or `auto` (this is the default since Git 1.8.4) if you1300 want such output to use color when written to the terminal.13011302column.ui::1303 Specify whether supported commands should output in columns.1304 This variable consists of a list of tokens separated by spaces1305 or commas:1306+1307These options control when the feature should be enabled1308(defaults to 'never'):1309+1310--1311`always`;;1312 always show in columns1313`never`;;1314 never show in columns1315`auto`;;1316 show in columns if the output is to the terminal1317--1318+1319These options control layout (defaults to 'column'). Setting any1320of these implies 'always' if none of 'always', 'never', or 'auto' are1321specified.1322+1323--1324`column`;;1325 fill columns before rows1326`row`;;1327 fill rows before columns1328`plain`;;1329 show in one column1330--1331+1332Finally, these options can be combined with a layout option (defaults1333to 'nodense'):1334+1335--1336`dense`;;1337 make unequal size columns to utilize more space1338`nodense`;;1339 make equal size columns1340--13411342column.branch::1343 Specify whether to output branch listing in `git branch` in columns.1344 See `column.ui` for details.13451346column.clean::1347 Specify the layout when list items in `git clean -i`, which always1348 shows files and directories in columns. See `column.ui` for details.13491350column.status::1351 Specify whether to output untracked files in `git status` in columns.1352 See `column.ui` for details.13531354column.tag::1355 Specify whether to output tag listing in `git tag` in columns.1356 See `column.ui` for details.13571358commit.cleanup::1359 This setting overrides the default of the `--cleanup` option in1360 `git commit`. See linkgit:git-commit[1] for details. Changing the1361 default can be useful when you always want to keep lines that begin1362 with comment character `#` in your log message, in which case you1363 would do `git config commit.cleanup whitespace` (note that you will1364 have to remove the help lines that begin with `#` in the commit log1365 template yourself, if you do this).13661367commit.gpgSign::13681369 A boolean to specify whether all commits should be GPG signed.1370 Use of this option when doing operations such as rebase can1371 result in a large number of commits being signed. It may be1372 convenient to use an agent to avoid typing your GPG passphrase1373 several times.13741375commit.status::1376 A boolean to enable/disable inclusion of status information in the1377 commit message template when using an editor to prepare the commit1378 message. Defaults to true.13791380commit.template::1381 Specify the pathname of a file to use as the template for1382 new commit messages.13831384commit.verbose::1385 A boolean or int to specify the level of verbose with `git commit`.1386 See linkgit:git-commit[1].13871388credential.helper::1389 Specify an external helper to be called when a username or1390 password credential is needed; the helper may consult external1391 storage to avoid prompting the user for the credentials. Note1392 that multiple helpers may be defined. See linkgit:gitcredentials[7]1393 for details.13941395credential.useHttpPath::1396 When acquiring credentials, consider the "path" component of an http1397 or https URL to be important. Defaults to false. See1398 linkgit:gitcredentials[7] for more information.13991400credential.username::1401 If no username is set for a network authentication, use this username1402 by default. See credential.<context>.* below, and1403 linkgit:gitcredentials[7].14041405credential.<url>.*::1406 Any of the credential.* options above can be applied selectively to1407 some credentials. For example "credential.https://example.com.username"1408 would set the default username only for https connections to1409 example.com. See linkgit:gitcredentials[7] for details on how URLs are1410 matched.14111412credentialCache.ignoreSIGHUP::1413 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14141415include::diff-config.txt[]14161417difftool.<tool>.path::1418 Override the path for the given tool. This is useful in case1419 your tool is not in the PATH.14201421difftool.<tool>.cmd::1422 Specify the command to invoke the specified diff tool.1423 The specified command is evaluated in shell with the following1424 variables available: 'LOCAL' is set to the name of the temporary1425 file containing the contents of the diff pre-image and 'REMOTE'1426 is set to the name of the temporary file containing the contents1427 of the diff post-image.14281429difftool.prompt::1430 Prompt before each invocation of the diff tool.14311432fastimport.unpackLimit::1433 If the number of objects imported by linkgit:git-fast-import[1]1434 is below this limit, then the objects will be unpacked into1435 loose object files. However if the number of imported objects1436 equals or exceeds this limit then the pack will be stored as a1437 pack. Storing the pack from a fast-import can make the import1438 operation complete faster, especially on slow filesystems. If1439 not set, the value of `transfer.unpackLimit` is used instead.14401441fetch.recurseSubmodules::1442 This option can be either set to a boolean value or to 'on-demand'.1443 Setting it to a boolean changes the behavior of fetch and pull to1444 unconditionally recurse into submodules when set to true or to not1445 recurse at all when set to false. When set to 'on-demand' (the default1446 value), fetch and pull will only recurse into a populated submodule1447 when its superproject retrieves a commit that updates the submodule's1448 reference.14491450fetch.fsckObjects::1451 If it is set to true, git-fetch-pack will check all fetched1452 objects. It will abort in the case of a malformed object or a1453 broken link. The result of an abort are only dangling objects.1454 Defaults to false. If not set, the value of `transfer.fsckObjects`1455 is used instead.14561457fetch.unpackLimit::1458 If the number of objects fetched over the Git native1459 transfer is below this1460 limit, then the objects will be unpacked into loose object1461 files. However if the number of received objects equals or1462 exceeds this limit then the received pack will be stored as1463 a pack, after adding any missing delta bases. Storing the1464 pack from a push can make the push operation complete faster,1465 especially on slow filesystems. If not set, the value of1466 `transfer.unpackLimit` is used instead.14671468fetch.prune::1469 If true, fetch will automatically behave as if the `--prune`1470 option was given on the command line. See also `remote.<name>.prune`1471 and the PRUNING section of linkgit:git-fetch[1].14721473fetch.pruneTags::1474 If true, fetch will automatically behave as if the1475 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1476 if not set already. This allows for setting both this option1477 and `fetch.prune` to maintain a 1=1 mapping to upstream1478 refs. See also `remote.<name>.pruneTags` and the PRUNING1479 section of linkgit:git-fetch[1].14801481fetch.output::1482 Control how ref update status is printed. Valid values are1483 `full` and `compact`. Default value is `full`. See section1484 OUTPUT in linkgit:git-fetch[1] for detail.14851486format.attach::1487 Enable multipart/mixed attachments as the default for1488 'format-patch'. The value can also be a double quoted string1489 which will enable attachments as the default and set the1490 value as the boundary. See the --attach option in1491 linkgit:git-format-patch[1].14921493format.from::1494 Provides the default value for the `--from` option to format-patch.1495 Accepts a boolean value, or a name and email address. If false,1496 format-patch defaults to `--no-from`, using commit authors directly in1497 the "From:" field of patch mails. If true, format-patch defaults to1498 `--from`, using your committer identity in the "From:" field of patch1499 mails and including a "From:" field in the body of the patch mail if1500 different. If set to a non-boolean value, format-patch uses that1501 value instead of your committer identity. Defaults to false.15021503format.numbered::1504 A boolean which can enable or disable sequence numbers in patch1505 subjects. It defaults to "auto" which enables it only if there1506 is more than one patch. It can be enabled or disabled for all1507 messages by setting it to "true" or "false". See --numbered1508 option in linkgit:git-format-patch[1].15091510format.headers::1511 Additional email headers to include in a patch to be submitted1512 by mail. See linkgit:git-format-patch[1].15131514format.to::1515format.cc::1516 Additional recipients to include in a patch to be submitted1517 by mail. See the --to and --cc options in1518 linkgit:git-format-patch[1].15191520format.subjectPrefix::1521 The default for format-patch is to output files with the '[PATCH]'1522 subject prefix. Use this variable to change that prefix.15231524format.signature::1525 The default for format-patch is to output a signature containing1526 the Git version number. Use this variable to change that default.1527 Set this variable to the empty string ("") to suppress1528 signature generation.15291530format.signatureFile::1531 Works just like format.signature except the contents of the1532 file specified by this variable will be used as the signature.15331534format.suffix::1535 The default for format-patch is to output files with the suffix1536 `.patch`. Use this variable to change that suffix (make sure to1537 include the dot if you want it).15381539format.pretty::1540 The default pretty format for log/show/whatchanged command,1541 See linkgit:git-log[1], linkgit:git-show[1],1542 linkgit:git-whatchanged[1].15431544format.thread::1545 The default threading style for 'git format-patch'. Can be1546 a boolean value, or `shallow` or `deep`. `shallow` threading1547 makes every mail a reply to the head of the series,1548 where the head is chosen from the cover letter, the1549 `--in-reply-to`, and the first patch mail, in this order.1550 `deep` threading makes every mail a reply to the previous one.1551 A true boolean value is the same as `shallow`, and a false1552 value disables threading.15531554format.signOff::1555 A boolean value which lets you enable the `-s/--signoff` option of1556 format-patch by default. *Note:* Adding the Signed-off-by: line to a1557 patch should be a conscious act and means that you certify you have1558 the rights to submit this work under the same open source license.1559 Please see the 'SubmittingPatches' document for further discussion.15601561format.coverLetter::1562 A boolean that controls whether to generate a cover-letter when1563 format-patch is invoked, but in addition can be set to "auto", to1564 generate a cover-letter only when there's more than one patch.15651566format.outputDirectory::1567 Set a custom directory to store the resulting files instead of the1568 current working directory.15691570format.useAutoBase::1571 A boolean value which lets you enable the `--base=auto` option of1572 format-patch by default.15731574filter.<driver>.clean::1575 The command which is used to convert the content of a worktree1576 file to a blob upon checkin. See linkgit:gitattributes[5] for1577 details.15781579filter.<driver>.smudge::1580 The command which is used to convert the content of a blob1581 object to a worktree file upon checkout. See1582 linkgit:gitattributes[5] for details.15831584fsck.<msg-id>::1585 Allows overriding the message type (error, warn or ignore) of a1586 specific message ID such as `missingEmail`.1587+1588For convenience, fsck prefixes the error/warning with the message ID,1589e.g. "missingEmail: invalid author/committer line - missing email" means1590that setting `fsck.missingEmail = ignore` will hide that issue.1591+1592This feature is intended to support working with legacy repositories1593which cannot be repaired without disruptive changes.15941595fsck.skipList::1596 The path to a sorted list of object names (i.e. one SHA-1 per1597 line) that are known to be broken in a non-fatal way and should1598 be ignored. This feature is useful when an established project1599 should be accepted despite early commits containing errors that1600 can be safely ignored such as invalid committer email addresses.1601 Note: corrupt objects cannot be skipped with this setting.16021603gc.aggressiveDepth::1604 The depth parameter used in the delta compression1605 algorithm used by 'git gc --aggressive'. This defaults1606 to 50.16071608gc.aggressiveWindow::1609 The window size parameter used in the delta compression1610 algorithm used by 'git gc --aggressive'. This defaults1611 to 250.16121613gc.auto::1614 When there are approximately more than this many loose1615 objects in the repository, `git gc --auto` will pack them.1616 Some Porcelain commands use this command to perform a1617 light-weight garbage collection from time to time. The1618 default value is 6700. Setting this to 0 disables it.16191620gc.autoPackLimit::1621 When there are more than this many packs that are not1622 marked with `*.keep` file in the repository, `git gc1623 --auto` consolidates them into one larger pack. The1624 default value is 50. Setting this to 0 disables it.16251626gc.autoDetach::1627 Make `git gc --auto` return immediately and run in background1628 if the system supports it. Default is true.16291630gc.bigPackThreshold::1631 If non-zero, all packs larger than this limit are kept when1632 `git gc` is run. This is very similar to `--keep-base-pack`1633 except that all packs that meet the threshold are kept, not1634 just the base pack. Defaults to zero. Common unit suffixes of1635 'k', 'm', or 'g' are supported.1636+1637Note that if the number of kept packs is more than gc.autoPackLimit,1638this configuration variable is ignored, all packs except the base pack1639will be repacked. After this the number of packs should go below1640gc.autoPackLimit and gc.bigPackThreshold should be respected again.16411642gc.logExpiry::1643 If the file gc.log exists, then `git gc --auto` won't run1644 unless that file is more than 'gc.logExpiry' old. Default is1645 "1.day". See `gc.pruneExpire` for more ways to specify its1646 value.16471648gc.packRefs::1649 Running `git pack-refs` in a repository renders it1650 unclonable by Git versions prior to 1.5.1.2 over dumb1651 transports such as HTTP. This variable determines whether1652 'git gc' runs `git pack-refs`. This can be set to `notbare`1653 to enable it within all non-bare repos or it can be set to a1654 boolean value. The default is `true`.16551656gc.pruneExpire::1657 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1658 Override the grace period with this config variable. The value1659 "now" may be used to disable this grace period and always prune1660 unreachable objects immediately, or "never" may be used to1661 suppress pruning. This feature helps prevent corruption when1662 'git gc' runs concurrently with another process writing to the1663 repository; see the "NOTES" section of linkgit:git-gc[1].16641665gc.worktreePruneExpire::1666 When 'git gc' is run, it calls1667 'git worktree prune --expire 3.months.ago'.1668 This config variable can be used to set a different grace1669 period. The value "now" may be used to disable the grace1670 period and prune `$GIT_DIR/worktrees` immediately, or "never"1671 may be used to suppress pruning.16721673gc.reflogExpire::1674gc.<pattern>.reflogExpire::1675 'git reflog expire' removes reflog entries older than1676 this time; defaults to 90 days. The value "now" expires all1677 entries immediately, and "never" suppresses expiration1678 altogether. With "<pattern>" (e.g.1679 "refs/stash") in the middle the setting applies only to1680 the refs that match the <pattern>.16811682gc.reflogExpireUnreachable::1683gc.<pattern>.reflogExpireUnreachable::1684 'git reflog expire' removes reflog entries older than1685 this time and are not reachable from the current tip;1686 defaults to 30 days. The value "now" expires all entries1687 immediately, and "never" suppresses expiration altogether.1688 With "<pattern>" (e.g. "refs/stash")1689 in the middle, the setting applies only to the refs that1690 match the <pattern>.16911692gc.rerereResolved::1693 Records of conflicted merge you resolved earlier are1694 kept for this many days when 'git rerere gc' is run.1695 You can also use more human-readable "1.month.ago", etc.1696 The default is 60 days. See linkgit:git-rerere[1].16971698gc.rerereUnresolved::1699 Records of conflicted merge you have not resolved are1700 kept for this many days when 'git rerere gc' is run.1701 You can also use more human-readable "1.month.ago", etc.1702 The default is 15 days. See linkgit:git-rerere[1].17031704gitcvs.commitMsgAnnotation::1705 Append this string to each commit message. Set to empty string1706 to disable this feature. Defaults to "via git-CVS emulator".17071708gitcvs.enabled::1709 Whether the CVS server interface is enabled for this repository.1710 See linkgit:git-cvsserver[1].17111712gitcvs.logFile::1713 Path to a log file where the CVS server interface well... logs1714 various stuff. See linkgit:git-cvsserver[1].17151716gitcvs.usecrlfattr::1717 If true, the server will look up the end-of-line conversion1718 attributes for files to determine the `-k` modes to use. If1719 the attributes force Git to treat a file as text,1720 the `-k` mode will be left blank so CVS clients will1721 treat it as text. If they suppress text conversion, the file1722 will be set with '-kb' mode, which suppresses any newline munging1723 the client might otherwise do. If the attributes do not allow1724 the file type to be determined, then `gitcvs.allBinary` is1725 used. See linkgit:gitattributes[5].17261727gitcvs.allBinary::1728 This is used if `gitcvs.usecrlfattr` does not resolve1729 the correct '-kb' mode to use. If true, all1730 unresolved files are sent to the client in1731 mode '-kb'. This causes the client to treat them1732 as binary files, which suppresses any newline munging it1733 otherwise might do. Alternatively, if it is set to "guess",1734 then the contents of the file are examined to decide if1735 it is binary, similar to `core.autocrlf`.17361737gitcvs.dbName::1738 Database used by git-cvsserver to cache revision information1739 derived from the Git repository. The exact meaning depends on the1740 used database driver, for SQLite (which is the default driver) this1741 is a filename. Supports variable substitution (see1742 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1743 Default: '%Ggitcvs.%m.sqlite'17441745gitcvs.dbDriver::1746 Used Perl DBI driver. You can specify any available driver1747 for this here, but it might not work. git-cvsserver is tested1748 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1749 reported *not* to work with 'DBD::mysql'. Experimental feature.1750 May not contain double colons (`:`). Default: 'SQLite'.1751 See linkgit:git-cvsserver[1].17521753gitcvs.dbUser, gitcvs.dbPass::1754 Database user and password. Only useful if setting `gitcvs.dbDriver`,1755 since SQLite has no concept of database users and/or passwords.1756 'gitcvs.dbUser' supports variable substitution (see1757 linkgit:git-cvsserver[1] for details).17581759gitcvs.dbTableNamePrefix::1760 Database table name prefix. Prepended to the names of any1761 database tables used, allowing a single database to be used1762 for several repositories. Supports variable substitution (see1763 linkgit:git-cvsserver[1] for details). Any non-alphabetic1764 characters will be replaced with underscores.17651766All gitcvs variables except for `gitcvs.usecrlfattr` and1767`gitcvs.allBinary` can also be specified as1768'gitcvs.<access_method>.<varname>' (where 'access_method'1769is one of "ext" and "pserver") to make them apply only for the given1770access method.17711772gitweb.category::1773gitweb.description::1774gitweb.owner::1775gitweb.url::1776 See linkgit:gitweb[1] for description.17771778gitweb.avatar::1779gitweb.blame::1780gitweb.grep::1781gitweb.highlight::1782gitweb.patches::1783gitweb.pickaxe::1784gitweb.remote_heads::1785gitweb.showSizes::1786gitweb.snapshot::1787 See linkgit:gitweb.conf[5] for description.17881789grep.lineNumber::1790 If set to true, enable `-n` option by default.17911792grep.patternType::1793 Set the default matching behavior. Using a value of 'basic', 'extended',1794 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1795 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1796 value 'default' will return to the default matching behavior.17971798grep.extendedRegexp::1799 If set to true, enable `--extended-regexp` option by default. This1800 option is ignored when the `grep.patternType` option is set to a value1801 other than 'default'.18021803grep.threads::1804 Number of grep worker threads to use.1805 See `grep.threads` in linkgit:git-grep[1] for more information.18061807grep.fallbackToNoIndex::1808 If set to true, fall back to git grep --no-index if git grep1809 is executed outside of a git repository. Defaults to false.18101811gpg.program::1812 Use this custom program instead of "`gpg`" found on `$PATH` when1813 making or verifying a PGP signature. The program must support the1814 same command-line interface as GPG, namely, to verify a detached1815 signature, "`gpg --verify $file - <$signature`" is run, and the1816 program is expected to signal a good signature by exiting with1817 code 0, and to generate an ASCII-armored detached signature, the1818 standard input of "`gpg -bsau $key`" is fed with the contents to be1819 signed, and the program is expected to send the result to its1820 standard output.18211822gui.commitMsgWidth::1823 Defines how wide the commit message window is in the1824 linkgit:git-gui[1]. "75" is the default.18251826gui.diffContext::1827 Specifies how many context lines should be used in calls to diff1828 made by the linkgit:git-gui[1]. The default is "5".18291830gui.displayUntracked::1831 Determines if linkgit:git-gui[1] shows untracked files1832 in the file list. The default is "true".18331834gui.encoding::1835 Specifies the default encoding to use for displaying of1836 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1837 It can be overridden by setting the 'encoding' attribute1838 for relevant files (see linkgit:gitattributes[5]).1839 If this option is not set, the tools default to the1840 locale encoding.18411842gui.matchTrackingBranch::1843 Determines if new branches created with linkgit:git-gui[1] should1844 default to tracking remote branches with matching names or1845 not. Default: "false".18461847gui.newBranchTemplate::1848 Is used as suggested name when creating new branches using the1849 linkgit:git-gui[1].18501851gui.pruneDuringFetch::1852 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1853 performing a fetch. The default value is "false".18541855gui.trustmtime::1856 Determines if linkgit:git-gui[1] should trust the file modification1857 timestamp or not. By default the timestamps are not trusted.18581859gui.spellingDictionary::1860 Specifies the dictionary used for spell checking commit messages in1861 the linkgit:git-gui[1]. When set to "none" spell checking is turned1862 off.18631864gui.fastCopyBlame::1865 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1866 location detection. It makes blame significantly faster on huge1867 repositories at the expense of less thorough copy detection.18681869gui.copyBlameThreshold::1870 Specifies the threshold to use in 'git gui blame' original location1871 detection, measured in alphanumeric characters. See the1872 linkgit:git-blame[1] manual for more information on copy detection.18731874gui.blamehistoryctx::1875 Specifies the radius of history context in days to show in1876 linkgit:gitk[1] for the selected commit, when the `Show History1877 Context` menu item is invoked from 'git gui blame'. If this1878 variable is set to zero, the whole history is shown.18791880guitool.<name>.cmd::1881 Specifies the shell command line to execute when the corresponding item1882 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1883 mandatory for every tool. The command is executed from the root of1884 the working directory, and in the environment it receives the name of1885 the tool as `GIT_GUITOOL`, the name of the currently selected file as1886 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1887 the head is detached, 'CUR_BRANCH' is empty).18881889guitool.<name>.needsFile::1890 Run the tool only if a diff is selected in the GUI. It guarantees1891 that 'FILENAME' is not empty.18921893guitool.<name>.noConsole::1894 Run the command silently, without creating a window to display its1895 output.18961897guitool.<name>.noRescan::1898 Don't rescan the working directory for changes after the tool1899 finishes execution.19001901guitool.<name>.confirm::1902 Show a confirmation dialog before actually running the tool.19031904guitool.<name>.argPrompt::1905 Request a string argument from the user, and pass it to the tool1906 through the `ARGS` environment variable. Since requesting an1907 argument implies confirmation, the 'confirm' option has no effect1908 if this is enabled. If the option is set to 'true', 'yes', or '1',1909 the dialog uses a built-in generic prompt; otherwise the exact1910 value of the variable is used.19111912guitool.<name>.revPrompt::1913 Request a single valid revision from the user, and set the1914 `REVISION` environment variable. In other aspects this option1915 is similar to 'argPrompt', and can be used together with it.19161917guitool.<name>.revUnmerged::1918 Show only unmerged branches in the 'revPrompt' subdialog.1919 This is useful for tools similar to merge or rebase, but not1920 for things like checkout or reset.19211922guitool.<name>.title::1923 Specifies the title to use for the prompt dialog. The default1924 is the tool name.19251926guitool.<name>.prompt::1927 Specifies the general prompt string to display at the top of1928 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1929 The default value includes the actual command.19301931help.browser::1932 Specify the browser that will be used to display help in the1933 'web' format. See linkgit:git-help[1].19341935help.format::1936 Override the default help format used by linkgit:git-help[1].1937 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1938 the default. 'web' and 'html' are the same.19391940help.autoCorrect::1941 Automatically correct and execute mistyped commands after1942 waiting for the given number of deciseconds (0.1 sec). If more1943 than one command can be deduced from the entered text, nothing1944 will be executed. If the value of this option is negative,1945 the corrected command will be executed immediately. If the1946 value is 0 - the command will be just shown but not executed.1947 This is the default.19481949help.htmlPath::1950 Specify the path where the HTML documentation resides. File system paths1951 and URLs are supported. HTML pages will be prefixed with this path when1952 help is displayed in the 'web' format. This defaults to the documentation1953 path of your Git installation.19541955http.proxy::1956 Override the HTTP proxy, normally configured using the 'http_proxy',1957 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1958 addition to the syntax understood by curl, it is possible to specify a1959 proxy string with a user name but no password, in which case git will1960 attempt to acquire one in the same way it does for other credentials. See1961 linkgit:gitcredentials[7] for more information. The syntax thus is1962 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1963 on a per-remote basis; see remote.<name>.proxy19641965http.proxyAuthMethod::1966 Set the method with which to authenticate against the HTTP proxy. This1967 only takes effect if the configured proxy string contains a user name part1968 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1969 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1970 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1971 variable. Possible values are:1972+1973--1974* `anyauth` - Automatically pick a suitable authentication method. It is1975 assumed that the proxy answers an unauthenticated request with a 4071976 status code and one or more Proxy-authenticate headers with supported1977 authentication methods. This is the default.1978* `basic` - HTTP Basic authentication1979* `digest` - HTTP Digest authentication; this prevents the password from being1980 transmitted to the proxy in clear text1981* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1982 of `curl(1)`)1983* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1984--19851986http.emptyAuth::1987 Attempt authentication without seeking a username or password. This1988 can be used to attempt GSS-Negotiate authentication without specifying1989 a username in the URL, as libcurl normally requires a username for1990 authentication.19911992http.delegation::1993 Control GSSAPI credential delegation. The delegation is disabled1994 by default in libcurl since version 7.21.7. Set parameter to tell1995 the server what it is allowed to delegate when it comes to user1996 credentials. Used with GSS/kerberos. Possible values are:1997+1998--1999* `none` - Don't allow any delegation.2000* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2001 Kerberos service ticket, which is a matter of realm policy.2002* `always` - Unconditionally allow the server to delegate.2003--200420052006http.extraHeader::2007 Pass an additional HTTP header when communicating with a server. If2008 more than one such entry exists, all of them are added as extra2009 headers. To allow overriding the settings inherited from the system2010 config, an empty value will reset the extra headers to the empty list.20112012http.cookieFile::2013 The pathname of a file containing previously stored cookie lines,2014 which should be used2015 in the Git http session, if they match the server. The file format2016 of the file to read cookies from should be plain HTTP headers or2017 the Netscape/Mozilla cookie file format (see `curl(1)`).2018 NOTE that the file specified with http.cookieFile is used only as2019 input unless http.saveCookies is set.20202021http.saveCookies::2022 If set, store cookies received during requests to the file specified by2023 http.cookieFile. Has no effect if http.cookieFile is unset.20242025http.sslVersion::2026 The SSL version to use when negotiating an SSL connection, if you2027 want to force the default. The available and default version2028 depend on whether libcurl was built against NSS or OpenSSL and the2029 particular configuration of the crypto library in use. Internally2030 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2031 documentation for more details on the format of this option and2032 for the ssl version supported. Actually the possible values of2033 this option are:20342035 - sslv22036 - sslv32037 - tlsv12038 - tlsv1.02039 - tlsv1.12040 - tlsv1.22041 - tlsv1.320422043+2044Can be overridden by the `GIT_SSL_VERSION` environment variable.2045To force git to use libcurl's default ssl version and ignore any2046explicit http.sslversion option, set `GIT_SSL_VERSION` to the2047empty string.20482049http.sslCipherList::2050 A list of SSL ciphers to use when negotiating an SSL connection.2051 The available ciphers depend on whether libcurl was built against2052 NSS or OpenSSL and the particular configuration of the crypto2053 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2054 option; see the libcurl documentation for more details on the format2055 of this list.2056+2057Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2058To force git to use libcurl's default cipher list and ignore any2059explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2060empty string.20612062http.sslVerify::2063 Whether to verify the SSL certificate when fetching or pushing2064 over HTTPS. Defaults to true. Can be overridden by the2065 `GIT_SSL_NO_VERIFY` environment variable.20662067http.sslCert::2068 File containing the SSL certificate when fetching or pushing2069 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2070 variable.20712072http.sslKey::2073 File containing the SSL private key when fetching or pushing2074 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2075 variable.20762077http.sslCertPasswordProtected::2078 Enable Git's password prompt for the SSL certificate. Otherwise2079 OpenSSL will prompt the user, possibly many times, if the2080 certificate or private key is encrypted. Can be overridden by the2081 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20822083http.sslCAInfo::2084 File containing the certificates to verify the peer with when2085 fetching or pushing over HTTPS. Can be overridden by the2086 `GIT_SSL_CAINFO` environment variable.20872088http.sslCAPath::2089 Path containing files with the CA certificates to verify the peer2090 with when fetching or pushing over HTTPS. Can be overridden2091 by the `GIT_SSL_CAPATH` environment variable.20922093http.pinnedpubkey::2094 Public key of the https service. It may either be the filename of2095 a PEM or DER encoded public key file or a string starting with2096 'sha256//' followed by the base64 encoded sha256 hash of the2097 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2098 exit with an error if this option is set but not supported by2099 cURL.21002101http.sslTry::2102 Attempt to use AUTH SSL/TLS and encrypted data transfers2103 when connecting via regular FTP protocol. This might be needed2104 if the FTP server requires it for security reasons or you wish2105 to connect securely whenever remote FTP server supports it.2106 Default is false since it might trigger certificate verification2107 errors on misconfigured servers.21082109http.maxRequests::2110 How many HTTP requests to launch in parallel. Can be overridden2111 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.21122113http.minSessions::2114 The number of curl sessions (counted across slots) to be kept across2115 requests. They will not be ended with curl_easy_cleanup() until2116 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2117 value will be capped at 1. Defaults to 1.21182119http.postBuffer::2120 Maximum size in bytes of the buffer used by smart HTTP2121 transports when POSTing data to the remote system.2122 For requests larger than this buffer size, HTTP/1.1 and2123 Transfer-Encoding: chunked is used to avoid creating a2124 massive pack file locally. Default is 1 MiB, which is2125 sufficient for most requests.21262127http.lowSpeedLimit, http.lowSpeedTime::2128 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2129 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2130 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2131 `GIT_HTTP_LOW_SPEED_TIME` environment variables.21322133http.noEPSV::2134 A boolean which disables using of EPSV ftp command by curl.2135 This can helpful with some "poor" ftp servers which don't2136 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2137 environment variable. Default is false (curl will use EPSV).21382139http.userAgent::2140 The HTTP USER_AGENT string presented to an HTTP server. The default2141 value represents the version of the client Git such as git/1.7.1.2142 This option allows you to override this value to a more common value2143 such as Mozilla/4.0. This may be necessary, for instance, if2144 connecting through a firewall that restricts HTTP connections to a set2145 of common USER_AGENT strings (but not including those like git/1.7.1).2146 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.21472148http.followRedirects::2149 Whether git should follow HTTP redirects. If set to `true`, git2150 will transparently follow any redirect issued by a server it2151 encounters. If set to `false`, git will treat all redirects as2152 errors. If set to `initial`, git will follow redirects only for2153 the initial request to a remote, but not for subsequent2154 follow-up HTTP requests. Since git uses the redirected URL as2155 the base for the follow-up requests, this is generally2156 sufficient. The default is `initial`.21572158http.<url>.*::2159 Any of the http.* options above can be applied selectively to some URLs.2160 For a config key to match a URL, each element of the config key is2161 compared to that of the URL, in the following order:2162+2163--2164. Scheme (e.g., `https` in `https://example.com/`). This field2165 must match exactly between the config key and the URL.21662167. Host/domain name (e.g., `example.com` in `https://example.com/`).2168 This field must match between the config key and the URL. It is2169 possible to specify a `*` as part of the host name to match all subdomains2170 at this level. `https://*.example.com/` for example would match2171 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21722173. Port number (e.g., `8080` in `http://example.com:8080/`).2174 This field must match exactly between the config key and the URL.2175 Omitted port numbers are automatically converted to the correct2176 default for the scheme before matching.21772178. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2179 path field of the config key must match the path field of the URL2180 either exactly or as a prefix of slash-delimited path elements. This means2181 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2182 match on a slash (`/`) boundary. Longer matches take precedence (so a config2183 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2184 key with just path `foo/`).21852186. User name (e.g., `user` in `https://user@example.com/repo.git`). If2187 the config key has a user name it must match the user name in the2188 URL exactly. If the config key does not have a user name, that2189 config key will match a URL with any user name (including none),2190 but at a lower precedence than a config key with a user name.2191--2192+2193The list above is ordered by decreasing precedence; a URL that matches2194a config key's path is preferred to one that matches its user name. For example,2195if the URL is `https://user@example.com/foo/bar` a config key match of2196`https://example.com/foo` will be preferred over a config key match of2197`https://user@example.com`.2198+2199All URLs are normalized before attempting any matching (the password part,2200if embedded in the URL, is always ignored for matching purposes) so that2201equivalent URLs that are simply spelled differently will match properly.2202Environment variable settings always override any matches. The URLs that are2203matched against are those given directly to Git commands. This means any URLs2204visited as a result of a redirection do not participate in matching.22052206ssh.variant::2207 By default, Git determines the command line arguments to use2208 based on the basename of the configured SSH command (configured2209 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2210 the config setting `core.sshCommand`). If the basename is2211 unrecognized, Git will attempt to detect support of OpenSSH2212 options by first invoking the configured SSH command with the2213 `-G` (print configuration) option and will subsequently use2214 OpenSSH options (if that is successful) or no options besides2215 the host and remote command (if it fails).2216+2217The config variable `ssh.variant` can be set to override this detection.2218Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2219`tortoiseplink`, `simple` (no options except the host and remote command).2220The default auto-detection can be explicitly requested using the value2221`auto`. Any other value is treated as `ssh`. This setting can also be2222overridden via the environment variable `GIT_SSH_VARIANT`.2223+2224The current command-line parameters used for each variant are as2225follows:2226+2227--22282229* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command22302231* `simple` - [username@]host command22322233* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command22342235* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command22362237--2238+2239Except for the `simple` variant, command-line parameters are likely to2240change as git gains new features.22412242i18n.commitEncoding::2243 Character encoding the commit messages are stored in; Git itself2244 does not care per se, but this information is necessary e.g. when2245 importing commits from emails or in the gitk graphical history2246 browser (and possibly at other places in the future or in other2247 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.22482249i18n.logOutputEncoding::2250 Character encoding the commit messages are converted to when2251 running 'git log' and friends.22522253imap::2254 The configuration variables in the 'imap' section are described2255 in linkgit:git-imap-send[1].22562257index.version::2258 Specify the version with which new index files should be2259 initialized. This does not affect existing repositories.22602261init.templateDir::2262 Specify the directory from which templates will be copied.2263 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22642265instaweb.browser::2266 Specify the program that will be used to browse your working2267 repository in gitweb. See linkgit:git-instaweb[1].22682269instaweb.httpd::2270 The HTTP daemon command-line to start gitweb on your working2271 repository. See linkgit:git-instaweb[1].22722273instaweb.local::2274 If true the web server started by linkgit:git-instaweb[1] will2275 be bound to the local IP (127.0.0.1).22762277instaweb.modulePath::2278 The default module path for linkgit:git-instaweb[1] to use2279 instead of /usr/lib/apache2/modules. Only used if httpd2280 is Apache.22812282instaweb.port::2283 The port number to bind the gitweb httpd to. See2284 linkgit:git-instaweb[1].22852286interactive.singleKey::2287 In interactive commands, allow the user to provide one-letter2288 input with a single key (i.e., without hitting enter).2289 Currently this is used by the `--patch` mode of2290 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2291 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2292 setting is silently ignored if portable keystroke input2293 is not available; requires the Perl module Term::ReadKey.22942295interactive.diffFilter::2296 When an interactive command (such as `git add --patch`) shows2297 a colorized diff, git will pipe the diff through the shell2298 command defined by this configuration variable. The command may2299 mark up the diff further for human consumption, provided that it2300 retains a one-to-one correspondence with the lines in the2301 original diff. Defaults to disabled (no filtering).23022303log.abbrevCommit::2304 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2305 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2306 override this option with `--no-abbrev-commit`.23072308log.date::2309 Set the default date-time mode for the 'log' command.2310 Setting a value for log.date is similar to using 'git log''s2311 `--date` option. See linkgit:git-log[1] for details.23122313log.decorate::2314 Print out the ref names of any commits that are shown by the log2315 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2316 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2317 specified, the full ref name (including prefix) will be printed.2318 If 'auto' is specified, then if the output is going to a terminal,2319 the ref names are shown as if 'short' were given, otherwise no ref2320 names are shown. This is the same as the `--decorate` option2321 of the `git log`.23222323log.follow::2324 If `true`, `git log` will act as if the `--follow` option was used when2325 a single <path> is given. This has the same limitations as `--follow`,2326 i.e. it cannot be used to follow multiple files and does not work well2327 on non-linear history.23282329log.graphColors::2330 A list of colors, separated by commas, that can be used to draw2331 history lines in `git log --graph`.23322333log.showRoot::2334 If true, the initial commit will be shown as a big creation event.2335 This is equivalent to a diff against an empty tree.2336 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2337 normally hide the root commit will now show it. True by default.23382339log.showSignature::2340 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2341 linkgit:git-whatchanged[1] assume `--show-signature`.23422343log.mailmap::2344 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2345 linkgit:git-whatchanged[1] assume `--use-mailmap`.23462347mailinfo.scissors::2348 If true, makes linkgit:git-mailinfo[1] (and therefore2349 linkgit:git-am[1]) act by default as if the --scissors option2350 was provided on the command-line. When active, this features2351 removes everything from the message body before a scissors2352 line (i.e. consisting mainly of ">8", "8<" and "-").23532354mailmap.file::2355 The location of an augmenting mailmap file. The default2356 mailmap, located in the root of the repository, is loaded2357 first, then the mailmap file pointed to by this variable.2358 The location of the mailmap file may be in a repository2359 subdirectory, or somewhere outside of the repository itself.2360 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23612362mailmap.blob::2363 Like `mailmap.file`, but consider the value as a reference to a2364 blob in the repository. If both `mailmap.file` and2365 `mailmap.blob` are given, both are parsed, with entries from2366 `mailmap.file` taking precedence. In a bare repository, this2367 defaults to `HEAD:.mailmap`. In a non-bare repository, it2368 defaults to empty.23692370man.viewer::2371 Specify the programs that may be used to display help in the2372 'man' format. See linkgit:git-help[1].23732374man.<tool>.cmd::2375 Specify the command to invoke the specified man viewer. The2376 specified command is evaluated in shell with the man page2377 passed as argument. (See linkgit:git-help[1].)23782379man.<tool>.path::2380 Override the path for the given tool that may be used to2381 display help in the 'man' format. See linkgit:git-help[1].23822383include::merge-config.txt[]23842385mergetool.<tool>.path::2386 Override the path for the given tool. This is useful in case2387 your tool is not in the PATH.23882389mergetool.<tool>.cmd::2390 Specify the command to invoke the specified merge tool. The2391 specified command is evaluated in shell with the following2392 variables available: 'BASE' is the name of a temporary file2393 containing the common base of the files to be merged, if available;2394 'LOCAL' is the name of a temporary file containing the contents of2395 the file on the current branch; 'REMOTE' is the name of a temporary2396 file containing the contents of the file from the branch being2397 merged; 'MERGED' contains the name of the file to which the merge2398 tool should write the results of a successful merge.23992400mergetool.<tool>.trustExitCode::2401 For a custom merge command, specify whether the exit code of2402 the merge command can be used to determine whether the merge was2403 successful. If this is not set to true then the merge target file2404 timestamp is checked and the merge assumed to have been successful2405 if the file has been updated, otherwise the user is prompted to2406 indicate the success of the merge.24072408mergetool.meld.hasOutput::2409 Older versions of `meld` do not support the `--output` option.2410 Git will attempt to detect whether `meld` supports `--output`2411 by inspecting the output of `meld --help`. Configuring2412 `mergetool.meld.hasOutput` will make Git skip these checks and2413 use the configured value instead. Setting `mergetool.meld.hasOutput`2414 to `true` tells Git to unconditionally use the `--output` option,2415 and `false` avoids using `--output`.24162417mergetool.keepBackup::2418 After performing a merge, the original file with conflict markers2419 can be saved as a file with a `.orig` extension. If this variable2420 is set to `false` then this file is not preserved. Defaults to2421 `true` (i.e. keep the backup files).24222423mergetool.keepTemporaries::2424 When invoking a custom merge tool, Git uses a set of temporary2425 files to pass to the tool. If the tool returns an error and this2426 variable is set to `true`, then these temporary files will be2427 preserved, otherwise they will be removed after the tool has2428 exited. Defaults to `false`.24292430mergetool.writeToTemp::2431 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2432 conflicting files in the worktree by default. Git will attempt2433 to use a temporary directory for these files when set `true`.2434 Defaults to `false`.24352436mergetool.prompt::2437 Prompt before each invocation of the merge resolution program.24382439notes.mergeStrategy::2440 Which merge strategy to choose by default when resolving notes2441 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2442 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2443 section of linkgit:git-notes[1] for more information on each strategy.24442445notes.<name>.mergeStrategy::2446 Which merge strategy to choose when doing a notes merge into2447 refs/notes/<name>. This overrides the more general2448 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2449 linkgit:git-notes[1] for more information on the available strategies.24502451notes.displayRef::2452 The (fully qualified) refname from which to show notes when2453 showing commit messages. The value of this variable can be set2454 to a glob, in which case notes from all matching refs will be2455 shown. You may also specify this configuration variable2456 several times. A warning will be issued for refs that do not2457 exist, but a glob that does not match any refs is silently2458 ignored.2459+2460This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2461environment variable, which must be a colon separated list of refs or2462globs.2463+2464The effective value of "core.notesRef" (possibly overridden by2465GIT_NOTES_REF) is also implicitly added to the list of refs to be2466displayed.24672468notes.rewrite.<command>::2469 When rewriting commits with <command> (currently `amend` or2470 `rebase`) and this variable is set to `true`, Git2471 automatically copies your notes from the original to the2472 rewritten commit. Defaults to `true`, but see2473 "notes.rewriteRef" below.24742475notes.rewriteMode::2476 When copying notes during a rewrite (see the2477 "notes.rewrite.<command>" option), determines what to do if2478 the target commit already has a note. Must be one of2479 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2480 Defaults to `concatenate`.2481+2482This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2483environment variable.24842485notes.rewriteRef::2486 When copying notes during a rewrite, specifies the (fully2487 qualified) ref whose notes should be copied. The ref may be a2488 glob, in which case notes in all matching refs will be copied.2489 You may also specify this configuration several times.2490+2491Does not have a default value; you must configure this variable to2492enable note rewriting. Set it to `refs/notes/commits` to enable2493rewriting for the default commit notes.2494+2495This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2496environment variable, which must be a colon separated list of refs or2497globs.24982499pack.window::2500 The size of the window used by linkgit:git-pack-objects[1] when no2501 window size is given on the command line. Defaults to 10.25022503pack.depth::2504 The maximum delta depth used by linkgit:git-pack-objects[1] when no2505 maximum depth is given on the command line. Defaults to 50.2506 Maximum value is 4095.25072508pack.windowMemory::2509 The maximum size of memory that is consumed by each thread2510 in linkgit:git-pack-objects[1] for pack window memory when2511 no limit is given on the command line. The value can be2512 suffixed with "k", "m", or "g". When left unconfigured (or2513 set explicitly to 0), there will be no limit.25142515pack.compression::2516 An integer -1..9, indicating the compression level for objects2517 in a pack file. -1 is the zlib default. 0 means no2518 compression, and 1..9 are various speed/size tradeoffs, 9 being2519 slowest. If not set, defaults to core.compression. If that is2520 not set, defaults to -1, the zlib default, which is "a default2521 compromise between speed and compression (currently equivalent2522 to level 6)."2523+2524Note that changing the compression level will not automatically recompress2525all existing objects. You can force recompression by passing the -F option2526to linkgit:git-repack[1].25272528pack.deltaCacheSize::2529 The maximum memory in bytes used for caching deltas in2530 linkgit:git-pack-objects[1] before writing them out to a pack.2531 This cache is used to speed up the writing object phase by not2532 having to recompute the final delta result once the best match2533 for all objects is found. Repacking large repositories on machines2534 which are tight with memory might be badly impacted by this though,2535 especially if this cache pushes the system into swapping.2536 A value of 0 means no limit. The smallest size of 1 byte may be2537 used to virtually disable this cache. Defaults to 256 MiB.25382539pack.deltaCacheLimit::2540 The maximum size of a delta, that is cached in2541 linkgit:git-pack-objects[1]. This cache is used to speed up the2542 writing object phase by not having to recompute the final delta2543 result once the best match for all objects is found.2544 Defaults to 1000. Maximum value is 65535.25452546pack.threads::2547 Specifies the number of threads to spawn when searching for best2548 delta matches. This requires that linkgit:git-pack-objects[1]2549 be compiled with pthreads otherwise this option is ignored with a2550 warning. This is meant to reduce packing time on multiprocessor2551 machines. The required amount of memory for the delta search window2552 is however multiplied by the number of threads.2553 Specifying 0 will cause Git to auto-detect the number of CPU's2554 and set the number of threads accordingly.25552556pack.indexVersion::2557 Specify the default pack index version. Valid values are 1 for2558 legacy pack index used by Git versions prior to 1.5.2, and 2 for2559 the new pack index with capabilities for packs larger than 4 GB2560 as well as proper protection against the repacking of corrupted2561 packs. Version 2 is the default. Note that version 2 is enforced2562 and this config option ignored whenever the corresponding pack is2563 larger than 2 GB.2564+2565If you have an old Git that does not understand the version 2 `*.idx` file,2566cloning or fetching over a non native protocol (e.g. "http")2567that will copy both `*.pack` file and corresponding `*.idx` file from the2568other side may give you a repository that cannot be accessed with your2569older version of Git. If the `*.pack` file is smaller than 2 GB, however,2570you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2571the `*.idx` file.25722573pack.packSizeLimit::2574 The maximum size of a pack. This setting only affects2575 packing to a file when repacking, i.e. the git:// protocol2576 is unaffected. It can be overridden by the `--max-pack-size`2577 option of linkgit:git-repack[1]. Reaching this limit results2578 in the creation of multiple packfiles; which in turn prevents2579 bitmaps from being created.2580 The minimum size allowed is limited to 1 MiB.2581 The default is unlimited.2582 Common unit suffixes of 'k', 'm', or 'g' are2583 supported.25842585pack.useBitmaps::2586 When true, git will use pack bitmaps (if available) when packing2587 to stdout (e.g., during the server side of a fetch). Defaults to2588 true. You should not generally need to turn this off unless2589 you are debugging pack bitmaps.25902591pack.writeBitmaps (deprecated)::2592 This is a deprecated synonym for `repack.writeBitmaps`.25932594pack.writeBitmapHashCache::2595 When true, git will include a "hash cache" section in the bitmap2596 index (if one is written). This cache can be used to feed git's2597 delta heuristics, potentially leading to better deltas between2598 bitmapped and non-bitmapped objects (e.g., when serving a fetch2599 between an older, bitmapped pack and objects that have been2600 pushed since the last gc). The downside is that it consumes 42601 bytes per object of disk space, and that JGit's bitmap2602 implementation does not understand it, causing it to complain if2603 Git and JGit are used on the same repository. Defaults to false.26042605pager.<cmd>::2606 If the value is boolean, turns on or off pagination of the2607 output of a particular Git subcommand when writing to a tty.2608 Otherwise, turns on pagination for the subcommand using the2609 pager specified by the value of `pager.<cmd>`. If `--paginate`2610 or `--no-pager` is specified on the command line, it takes2611 precedence over this option. To disable pagination for all2612 commands, set `core.pager` or `GIT_PAGER` to `cat`.26132614pretty.<name>::2615 Alias for a --pretty= format string, as specified in2616 linkgit:git-log[1]. Any aliases defined here can be used just2617 as the built-in pretty formats could. For example,2618 running `git config pretty.changelog "format:* %H %s"`2619 would cause the invocation `git log --pretty=changelog`2620 to be equivalent to running `git log "--pretty=format:* %H %s"`.2621 Note that an alias with the same name as a built-in format2622 will be silently ignored.26232624protocol.allow::2625 If set, provide a user defined default policy for all protocols which2626 don't explicitly have a policy (`protocol.<name>.allow`). By default,2627 if unset, known-safe protocols (http, https, git, ssh, file) have a2628 default policy of `always`, known-dangerous protocols (ext) have a2629 default policy of `never`, and all other protocols have a default2630 policy of `user`. Supported policies:2631+2632--26332634* `always` - protocol is always able to be used.26352636* `never` - protocol is never able to be used.26372638* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2639 either unset or has a value of 1. This policy should be used when you want a2640 protocol to be directly usable by the user but don't want it used by commands which2641 execute clone/fetch/push commands without user input, e.g. recursive2642 submodule initialization.26432644--26452646protocol.<name>.allow::2647 Set a policy to be used by protocol `<name>` with clone/fetch/push2648 commands. See `protocol.allow` above for the available policies.2649+2650The protocol names currently used by git are:2651+2652--2653 - `file`: any local file-based path (including `file://` URLs,2654 or local paths)26552656 - `git`: the anonymous git protocol over a direct TCP2657 connection (or proxy, if configured)26582659 - `ssh`: git over ssh (including `host:path` syntax,2660 `ssh://`, etc).26612662 - `http`: git over http, both "smart http" and "dumb http".2663 Note that this does _not_ include `https`; if you want to configure2664 both, you must do so individually.26652666 - any external helpers are named by their protocol (e.g., use2667 `hg` to allow the `git-remote-hg` helper)2668--26692670protocol.version::2671 Experimental. If set, clients will attempt to communicate with a2672 server using the specified protocol version. If unset, no2673 attempt will be made by the client to communicate using a2674 particular protocol version, this results in protocol version 02675 being used.2676 Supported versions:2677+2678--26792680* `0` - the original wire protocol.26812682* `1` - the original wire protocol with the addition of a version string2683 in the initial response from the server.26842685--26862687pull.ff::2688 By default, Git does not create an extra merge commit when merging2689 a commit that is a descendant of the current commit. Instead, the2690 tip of the current branch is fast-forwarded. When set to `false`,2691 this variable tells Git to create an extra merge commit in such2692 a case (equivalent to giving the `--no-ff` option from the command2693 line). When set to `only`, only such fast-forward merges are2694 allowed (equivalent to giving the `--ff-only` option from the2695 command line). This setting overrides `merge.ff` when pulling.26962697pull.rebase::2698 When true, rebase branches on top of the fetched branch, instead2699 of merging the default branch from the default remote when "git2700 pull" is run. See "branch.<name>.rebase" for setting this on a2701 per-branch basis.2702+2703When `merges`, pass the `--rebase-merges` option to 'git rebase'2704so that the local merge commits are included in the rebase (see2705linkgit:git-rebase[1] for details).2706+2707When preserve, also pass `--preserve-merges` along to 'git rebase'2708so that locally committed merge commits will not be flattened2709by running 'git pull'.2710+2711When the value is `interactive`, the rebase is run in interactive mode.2712+2713*NOTE*: this is a possibly dangerous operation; do *not* use2714it unless you understand the implications (see linkgit:git-rebase[1]2715for details).27162717pull.octopus::2718 The default merge strategy to use when pulling multiple branches2719 at once.27202721pull.twohead::2722 The default merge strategy to use when pulling a single branch.27232724push.default::2725 Defines the action `git push` should take if no refspec is2726 explicitly given. Different values are well-suited for2727 specific workflows; for instance, in a purely central workflow2728 (i.e. the fetch source is equal to the push destination),2729 `upstream` is probably what you want. Possible values are:2730+2731--27322733* `nothing` - do not push anything (error out) unless a refspec is2734 explicitly given. This is primarily meant for people who want to2735 avoid mistakes by always being explicit.27362737* `current` - push the current branch to update a branch with the same2738 name on the receiving end. Works in both central and non-central2739 workflows.27402741* `upstream` - push the current branch back to the branch whose2742 changes are usually integrated into the current branch (which is2743 called `@{upstream}`). This mode only makes sense if you are2744 pushing to the same repository you would normally pull from2745 (i.e. central workflow).27462747* `tracking` - This is a deprecated synonym for `upstream`.27482749* `simple` - in centralized workflow, work like `upstream` with an2750 added safety to refuse to push if the upstream branch's name is2751 different from the local one.2752+2753When pushing to a remote that is different from the remote you normally2754pull from, work as `current`. This is the safest option and is suited2755for beginners.2756+2757This mode has become the default in Git 2.0.27582759* `matching` - push all branches having the same name on both ends.2760 This makes the repository you are pushing to remember the set of2761 branches that will be pushed out (e.g. if you always push 'maint'2762 and 'master' there and no other branches, the repository you push2763 to will have these two branches, and your local 'maint' and2764 'master' will be pushed there).2765+2766To use this mode effectively, you have to make sure _all_ the2767branches you would push out are ready to be pushed out before2768running 'git push', as the whole point of this mode is to allow you2769to push all of the branches in one go. If you usually finish work2770on only one branch and push out the result, while other branches are2771unfinished, this mode is not for you. Also this mode is not2772suitable for pushing into a shared central repository, as other2773people may add new branches there, or update the tip of existing2774branches outside your control.2775+2776This used to be the default, but not since Git 2.0 (`simple` is the2777new default).27782779--27802781push.followTags::2782 If set to true enable `--follow-tags` option by default. You2783 may override this configuration at time of push by specifying2784 `--no-follow-tags`.27852786push.gpgSign::2787 May be set to a boolean value, or the string 'if-asked'. A true2788 value causes all pushes to be GPG signed, as if `--signed` is2789 passed to linkgit:git-push[1]. The string 'if-asked' causes2790 pushes to be signed if the server supports it, as if2791 `--signed=if-asked` is passed to 'git push'. A false value may2792 override a value from a lower-priority config file. An explicit2793 command-line flag always overrides this config option.27942795push.pushOption::2796 When no `--push-option=<option>` argument is given from the2797 command line, `git push` behaves as if each <value> of2798 this variable is given as `--push-option=<value>`.2799+2800This is a multi-valued variable, and an empty value can be used in a2801higher priority configuration file (e.g. `.git/config` in a2802repository) to clear the values inherited from a lower priority2803configuration files (e.g. `$HOME/.gitconfig`).2804+2805--28062807Example:28082809/etc/gitconfig2810 push.pushoption = a2811 push.pushoption = b28122813~/.gitconfig2814 push.pushoption = c28152816repo/.git/config2817 push.pushoption =2818 push.pushoption = b28192820This will result in only b (a and c are cleared).28212822--28232824push.recurseSubmodules::2825 Make sure all submodule commits used by the revisions to be pushed2826 are available on a remote-tracking branch. If the value is 'check'2827 then Git will verify that all submodule commits that changed in the2828 revisions to be pushed are available on at least one remote of the2829 submodule. If any commits are missing, the push will be aborted and2830 exit with non-zero status. If the value is 'on-demand' then all2831 submodules that changed in the revisions to be pushed will be2832 pushed. If on-demand was not able to push all necessary revisions2833 it will also be aborted and exit with non-zero status. If the value2834 is 'no' then default behavior of ignoring submodules when pushing2835 is retained. You may override this configuration at time of push by2836 specifying '--recurse-submodules=check|on-demand|no'.28372838include::rebase-config.txt[]28392840receive.advertiseAtomic::2841 By default, git-receive-pack will advertise the atomic push2842 capability to its clients. If you don't want to advertise this2843 capability, set this variable to false.28442845receive.advertisePushOptions::2846 When set to true, git-receive-pack will advertise the push options2847 capability to its clients. False by default.28482849receive.autogc::2850 By default, git-receive-pack will run "git-gc --auto" after2851 receiving data from git-push and updating refs. You can stop2852 it by setting this variable to false.28532854receive.certNonceSeed::2855 By setting this variable to a string, `git receive-pack`2856 will accept a `git push --signed` and verifies it by using2857 a "nonce" protected by HMAC using this string as a secret2858 key.28592860receive.certNonceSlop::2861 When a `git push --signed` sent a push certificate with a2862 "nonce" that was issued by a receive-pack serving the same2863 repository within this many seconds, export the "nonce"2864 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2865 hooks (instead of what the receive-pack asked the sending2866 side to include). This may allow writing checks in2867 `pre-receive` and `post-receive` a bit easier. Instead of2868 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2869 that records by how many seconds the nonce is stale to2870 decide if they want to accept the certificate, they only2871 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28722873receive.fsckObjects::2874 If it is set to true, git-receive-pack will check all received2875 objects. It will abort in the case of a malformed object or a2876 broken link. The result of an abort are only dangling objects.2877 Defaults to false. If not set, the value of `transfer.fsckObjects`2878 is used instead.28792880receive.fsck.<msg-id>::2881 When `receive.fsckObjects` is set to true, errors can be switched2882 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2883 setting where the `<msg-id>` is the fsck message ID and the value2884 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2885 the error/warning with the message ID, e.g. "missingEmail: invalid2886 author/committer line - missing email" means that setting2887 `receive.fsck.missingEmail = ignore` will hide that issue.2888+2889This feature is intended to support working with legacy repositories2890which would not pass pushing when `receive.fsckObjects = true`, allowing2891the host to accept repositories with certain known issues but still catch2892other issues.28932894receive.fsck.skipList::2895 The path to a sorted list of object names (i.e. one SHA-1 per2896 line) that are known to be broken in a non-fatal way and should2897 be ignored. This feature is useful when an established project2898 should be accepted despite early commits containing errors that2899 can be safely ignored such as invalid committer email addresses.2900 Note: corrupt objects cannot be skipped with this setting.29012902receive.keepAlive::2903 After receiving the pack from the client, `receive-pack` may2904 produce no output (if `--quiet` was specified) while processing2905 the pack, causing some networks to drop the TCP connection.2906 With this option set, if `receive-pack` does not transmit2907 any data in this phase for `receive.keepAlive` seconds, it will2908 send a short keepalive packet. The default is 5 seconds; set2909 to 0 to disable keepalives entirely.29102911receive.unpackLimit::2912 If the number of objects received in a push is below this2913 limit then the objects will be unpacked into loose object2914 files. However if the number of received objects equals or2915 exceeds this limit then the received pack will be stored as2916 a pack, after adding any missing delta bases. Storing the2917 pack from a push can make the push operation complete faster,2918 especially on slow filesystems. If not set, the value of2919 `transfer.unpackLimit` is used instead.29202921receive.maxInputSize::2922 If the size of the incoming pack stream is larger than this2923 limit, then git-receive-pack will error out, instead of2924 accepting the pack file. If not set or set to 0, then the size2925 is unlimited.29262927receive.denyDeletes::2928 If set to true, git-receive-pack will deny a ref update that deletes2929 the ref. Use this to prevent such a ref deletion via a push.29302931receive.denyDeleteCurrent::2932 If set to true, git-receive-pack will deny a ref update that2933 deletes the currently checked out branch of a non-bare repository.29342935receive.denyCurrentBranch::2936 If set to true or "refuse", git-receive-pack will deny a ref update2937 to the currently checked out branch of a non-bare repository.2938 Such a push is potentially dangerous because it brings the HEAD2939 out of sync with the index and working tree. If set to "warn",2940 print a warning of such a push to stderr, but allow the push to2941 proceed. If set to false or "ignore", allow such pushes with no2942 message. Defaults to "refuse".2943+2944Another option is "updateInstead" which will update the working2945tree if pushing into the current branch. This option is2946intended for synchronizing working directories when one side is not easily2947accessible via interactive ssh (e.g. a live web site, hence the requirement2948that the working directory be clean). This mode also comes in handy when2949developing inside a VM to test and fix code on different Operating Systems.2950+2951By default, "updateInstead" will refuse the push if the working tree or2952the index have any difference from the HEAD, but the `push-to-checkout`2953hook can be used to customize this. See linkgit:githooks[5].29542955receive.denyNonFastForwards::2956 If set to true, git-receive-pack will deny a ref update which is2957 not a fast-forward. Use this to prevent such an update via a push,2958 even if that push is forced. This configuration variable is2959 set when initializing a shared repository.29602961receive.hideRefs::2962 This variable is the same as `transfer.hideRefs`, but applies2963 only to `receive-pack` (and so affects pushes, but not fetches).2964 An attempt to update or delete a hidden ref by `git push` is2965 rejected.29662967receive.updateServerInfo::2968 If set to true, git-receive-pack will run git-update-server-info2969 after receiving data from git-push and updating refs.29702971receive.shallowUpdate::2972 If set to true, .git/shallow can be updated when new refs2973 require new shallow roots. Otherwise those refs are rejected.29742975remote.pushDefault::2976 The remote to push to by default. Overrides2977 `branch.<name>.remote` for all branches, and is overridden by2978 `branch.<name>.pushRemote` for specific branches.29792980remote.<name>.url::2981 The URL of a remote repository. See linkgit:git-fetch[1] or2982 linkgit:git-push[1].29832984remote.<name>.pushurl::2985 The push URL of a remote repository. See linkgit:git-push[1].29862987remote.<name>.proxy::2988 For remotes that require curl (http, https and ftp), the URL to2989 the proxy to use for that remote. Set to the empty string to2990 disable proxying for that remote.29912992remote.<name>.proxyAuthMethod::2993 For remotes that require curl (http, https and ftp), the method to use for2994 authenticating against the proxy in use (probably set in2995 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29962997remote.<name>.fetch::2998 The default set of "refspec" for linkgit:git-fetch[1]. See2999 linkgit:git-fetch[1].30003001remote.<name>.push::3002 The default set of "refspec" for linkgit:git-push[1]. See3003 linkgit:git-push[1].30043005remote.<name>.mirror::3006 If true, pushing to this remote will automatically behave3007 as if the `--mirror` option was given on the command line.30083009remote.<name>.skipDefaultUpdate::3010 If true, this remote will be skipped by default when updating3011 using linkgit:git-fetch[1] or the `update` subcommand of3012 linkgit:git-remote[1].30133014remote.<name>.skipFetchAll::3015 If true, this remote will be skipped by default when updating3016 using linkgit:git-fetch[1] or the `update` subcommand of3017 linkgit:git-remote[1].30183019remote.<name>.receivepack::3020 The default program to execute on the remote side when pushing. See3021 option --receive-pack of linkgit:git-push[1].30223023remote.<name>.uploadpack::3024 The default program to execute on the remote side when fetching. See3025 option --upload-pack of linkgit:git-fetch-pack[1].30263027remote.<name>.tagOpt::3028 Setting this value to --no-tags disables automatic tag following when3029 fetching from remote <name>. Setting it to --tags will fetch every3030 tag from remote <name>, even if they are not reachable from remote3031 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3032 override this setting. See options --tags and --no-tags of3033 linkgit:git-fetch[1].30343035remote.<name>.vcs::3036 Setting this to a value <vcs> will cause Git to interact with3037 the remote with the git-remote-<vcs> helper.30383039remote.<name>.prune::3040 When set to true, fetching from this remote by default will also3041 remove any remote-tracking references that no longer exist on the3042 remote (as if the `--prune` option was given on the command line).3043 Overrides `fetch.prune` settings, if any.30443045remote.<name>.pruneTags::3046 When set to true, fetching from this remote by default will also3047 remove any local tags that no longer exist on the remote if pruning3048 is activated in general via `remote.<name>.prune`, `fetch.prune` or3049 `--prune`. Overrides `fetch.pruneTags` settings, if any.3050+3051See also `remote.<name>.prune` and the PRUNING section of3052linkgit:git-fetch[1].30533054remotes.<group>::3055 The list of remotes which are fetched by "git remote update3056 <group>". See linkgit:git-remote[1].30573058repack.useDeltaBaseOffset::3059 By default, linkgit:git-repack[1] creates packs that use3060 delta-base offset. If you need to share your repository with3061 Git older than version 1.4.4, either directly or via a dumb3062 protocol such as http, then you need to set this option to3063 "false" and repack. Access from old Git versions over the3064 native protocol are unaffected by this option.30653066repack.packKeptObjects::3067 If set to true, makes `git repack` act as if3068 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3069 details. Defaults to `false` normally, but `true` if a bitmap3070 index is being written (either via `--write-bitmap-index` or3071 `repack.writeBitmaps`).30723073repack.writeBitmaps::3074 When true, git will write a bitmap index when packing all3075 objects to disk (e.g., when `git repack -a` is run). This3076 index can speed up the "counting objects" phase of subsequent3077 packs created for clones and fetches, at the cost of some disk3078 space and extra time spent on the initial repack. This has3079 no effect if multiple packfiles are created.3080 Defaults to false.30813082rerere.autoUpdate::3083 When set to true, `git-rerere` updates the index with the3084 resulting contents after it cleanly resolves conflicts using3085 previously recorded resolution. Defaults to false.30863087rerere.enabled::3088 Activate recording of resolved conflicts, so that identical3089 conflict hunks can be resolved automatically, should they be3090 encountered again. By default, linkgit:git-rerere[1] is3091 enabled if there is an `rr-cache` directory under the3092 `$GIT_DIR`, e.g. if "rerere" was previously used in the3093 repository.30943095sendemail.identity::3096 A configuration identity. When given, causes values in the3097 'sendemail.<identity>' subsection to take precedence over3098 values in the 'sendemail' section. The default identity is3099 the value of `sendemail.identity`.31003101sendemail.smtpEncryption::3102 See linkgit:git-send-email[1] for description. Note that this3103 setting is not subject to the 'identity' mechanism.31043105sendemail.smtpssl (deprecated)::3106 Deprecated alias for 'sendemail.smtpEncryption = ssl'.31073108sendemail.smtpsslcertpath::3109 Path to ca-certificates (either a directory or a single file).3110 Set it to an empty string to disable certificate verification.31113112sendemail.<identity>.*::3113 Identity-specific versions of the 'sendemail.*' parameters3114 found below, taking precedence over those when this3115 identity is selected, through either the command-line or3116 `sendemail.identity`.31173118sendemail.aliasesFile::3119sendemail.aliasFileType::3120sendemail.annotate::3121sendemail.bcc::3122sendemail.cc::3123sendemail.ccCmd::3124sendemail.chainReplyTo::3125sendemail.confirm::3126sendemail.envelopeSender::3127sendemail.from::3128sendemail.multiEdit::3129sendemail.signedoffbycc::3130sendemail.smtpPass::3131sendemail.suppresscc::3132sendemail.suppressFrom::3133sendemail.to::3134sendemail.tocmd::3135sendemail.smtpDomain::3136sendemail.smtpServer::3137sendemail.smtpServerPort::3138sendemail.smtpServerOption::3139sendemail.smtpUser::3140sendemail.thread::3141sendemail.transferEncoding::3142sendemail.validate::3143sendemail.xmailer::3144 See linkgit:git-send-email[1] for description.31453146sendemail.signedoffcc (deprecated)::3147 Deprecated alias for `sendemail.signedoffbycc`.31483149sendemail.smtpBatchSize::3150 Number of messages to be sent per connection, after that a relogin3151 will happen. If the value is 0 or undefined, send all messages in3152 one connection.3153 See also the `--batch-size` option of linkgit:git-send-email[1].31543155sendemail.smtpReloginDelay::3156 Seconds wait before reconnecting to smtp server.3157 See also the `--relogin-delay` option of linkgit:git-send-email[1].31583159showbranch.default::3160 The default set of branches for linkgit:git-show-branch[1].3161 See linkgit:git-show-branch[1].31623163splitIndex.maxPercentChange::3164 When the split index feature is used, this specifies the3165 percent of entries the split index can contain compared to the3166 total number of entries in both the split index and the shared3167 index before a new shared index is written.3168 The value should be between 0 and 100. If the value is 0 then3169 a new shared index is always written, if it is 100 a new3170 shared index is never written.3171 By default the value is 20, so a new shared index is written3172 if the number of entries in the split index would be greater3173 than 20 percent of the total number of entries.3174 See linkgit:git-update-index[1].31753176splitIndex.sharedIndexExpire::3177 When the split index feature is used, shared index files that3178 were not modified since the time this variable specifies will3179 be removed when a new shared index file is created. The value3180 "now" expires all entries immediately, and "never" suppresses3181 expiration altogether.3182 The default value is "2.weeks.ago".3183 Note that a shared index file is considered modified (for the3184 purpose of expiration) each time a new split-index file is3185 either created based on it or read from it.3186 See linkgit:git-update-index[1].31873188status.relativePaths::3189 By default, linkgit:git-status[1] shows paths relative to the3190 current directory. Setting this variable to `false` shows paths3191 relative to the repository root (this was the default for Git3192 prior to v1.5.4).31933194status.short::3195 Set to true to enable --short by default in linkgit:git-status[1].3196 The option --no-short takes precedence over this variable.31973198status.branch::3199 Set to true to enable --branch by default in linkgit:git-status[1].3200 The option --no-branch takes precedence over this variable.32013202status.displayCommentPrefix::3203 If set to true, linkgit:git-status[1] will insert a comment3204 prefix before each output line (starting with3205 `core.commentChar`, i.e. `#` by default). This was the3206 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3207 Defaults to false.32083209status.renameLimit::3210 The number of files to consider when performing rename detection3211 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3212 the value of diff.renameLimit.32133214status.renames::3215 Whether and how Git detects renames in linkgit:git-status[1] and3216 linkgit:git-commit[1] . If set to "false", rename detection is3217 disabled. If set to "true", basic rename detection is enabled.3218 If set to "copies" or "copy", Git will detect copies, as well.3219 Defaults to the value of diff.renames.32203221status.showStash::3222 If set to true, linkgit:git-status[1] will display the number of3223 entries currently stashed away.3224 Defaults to false.32253226status.showUntrackedFiles::3227 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3228 files which are not currently tracked by Git. Directories which3229 contain only untracked files, are shown with the directory name3230 only. Showing untracked files means that Git needs to lstat() all3231 the files in the whole repository, which might be slow on some3232 systems. So, this variable controls how the commands displays3233 the untracked files. Possible values are:3234+3235--3236* `no` - Show no untracked files.3237* `normal` - Show untracked files and directories.3238* `all` - Show also individual files in untracked directories.3239--3240+3241If this variable is not specified, it defaults to 'normal'.3242This variable can be overridden with the -u|--untracked-files option3243of linkgit:git-status[1] and linkgit:git-commit[1].32443245status.submoduleSummary::3246 Defaults to false.3247 If this is set to a non zero number or true (identical to -1 or an3248 unlimited number), the submodule summary will be enabled and a3249 summary of commits for modified submodules will be shown (see3250 --summary-limit option of linkgit:git-submodule[1]). Please note3251 that the summary output command will be suppressed for all3252 submodules when `diff.ignoreSubmodules` is set to 'all' or only3253 for those submodules where `submodule.<name>.ignore=all`. The only3254 exception to that rule is that status and commit will show staged3255 submodule changes. To3256 also view the summary for ignored submodules you can either use3257 the --ignore-submodules=dirty command-line option or the 'git3258 submodule summary' command, which shows a similar output but does3259 not honor these settings.32603261stash.showPatch::3262 If this is set to true, the `git stash show` command without an3263 option will show the stash entry in patch form. Defaults to false.3264 See description of 'show' command in linkgit:git-stash[1].32653266stash.showStat::3267 If this is set to true, the `git stash show` command without an3268 option will show diffstat of the stash entry. Defaults to true.3269 See description of 'show' command in linkgit:git-stash[1].32703271submodule.<name>.url::3272 The URL for a submodule. This variable is copied from the .gitmodules3273 file to the git config via 'git submodule init'. The user can change3274 the configured URL before obtaining the submodule via 'git submodule3275 update'. If neither submodule.<name>.active or submodule.active are3276 set, the presence of this variable is used as a fallback to indicate3277 whether the submodule is of interest to git commands.3278 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32793280submodule.<name>.update::3281 The method by which a submodule is updated by 'git submodule update',3282 which is the only affected command, others such as3283 'git checkout --recurse-submodules' are unaffected. It exists for3284 historical reasons, when 'git submodule' was the only command to3285 interact with submodules; settings like `submodule.active`3286 and `pull.rebase` are more specific. It is populated by3287 `git submodule init` from the linkgit:gitmodules[5] file.3288 See description of 'update' command in linkgit:git-submodule[1].32893290submodule.<name>.branch::3291 The remote branch name for a submodule, used by `git submodule3292 update --remote`. Set this option to override the value found in3293 the `.gitmodules` file. See linkgit:git-submodule[1] and3294 linkgit:gitmodules[5] for details.32953296submodule.<name>.fetchRecurseSubmodules::3297 This option can be used to control recursive fetching of this3298 submodule. It can be overridden by using the --[no-]recurse-submodules3299 command-line option to "git fetch" and "git pull".3300 This setting will override that from in the linkgit:gitmodules[5]3301 file.33023303submodule.<name>.ignore::3304 Defines under what circumstances "git status" and the diff family show3305 a submodule as modified. When set to "all", it will never be considered3306 modified (but it will nonetheless show up in the output of status and3307 commit when it has been staged), "dirty" will ignore all changes3308 to the submodules work tree and3309 takes only differences between the HEAD of the submodule and the commit3310 recorded in the superproject into account. "untracked" will additionally3311 let submodules with modified tracked files in their work tree show up.3312 Using "none" (the default when this option is not set) also shows3313 submodules that have untracked files in their work tree as changed.3314 This setting overrides any setting made in .gitmodules for this submodule,3315 both settings can be overridden on the command line by using the3316 "--ignore-submodules" option. The 'git submodule' commands are not3317 affected by this setting.33183319submodule.<name>.active::3320 Boolean value indicating if the submodule is of interest to git3321 commands. This config option takes precedence over the3322 submodule.active config option.33233324submodule.active::3325 A repeated field which contains a pathspec used to match against a3326 submodule's path to determine if the submodule is of interest to git3327 commands.33283329submodule.recurse::3330 Specifies if commands recurse into submodules by default. This3331 applies to all commands that have a `--recurse-submodules` option,3332 except `clone`.3333 Defaults to false.33343335submodule.fetchJobs::3336 Specifies how many submodules are fetched/cloned at the same time.3337 A positive integer allows up to that number of submodules fetched3338 in parallel. A value of 0 will give some reasonable default.3339 If unset, it defaults to 1.33403341submodule.alternateLocation::3342 Specifies how the submodules obtain alternates when submodules are3343 cloned. Possible values are `no`, `superproject`.3344 By default `no` is assumed, which doesn't add references. When the3345 value is set to `superproject` the submodule to be cloned computes3346 its alternates location relative to the superprojects alternate.33473348submodule.alternateErrorStrategy::3349 Specifies how to treat errors with the alternates for a submodule3350 as computed via `submodule.alternateLocation`. Possible values are3351 `ignore`, `info`, `die`. Default is `die`.33523353tag.forceSignAnnotated::3354 A boolean to specify whether annotated tags created should be GPG signed.3355 If `--annotate` is specified on the command line, it takes3356 precedence over this option.33573358tag.sort::3359 This variable controls the sort ordering of tags when displayed by3360 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3361 value of this variable will be used as the default.33623363tar.umask::3364 This variable can be used to restrict the permission bits of3365 tar archive entries. The default is 0002, which turns off the3366 world write bit. The special value "user" indicates that the3367 archiving user's umask will be used instead. See umask(2) and3368 linkgit:git-archive[1].33693370transfer.fsckObjects::3371 When `fetch.fsckObjects` or `receive.fsckObjects` are3372 not set, the value of this variable is used instead.3373 Defaults to false.33743375transfer.hideRefs::3376 String(s) `receive-pack` and `upload-pack` use to decide which3377 refs to omit from their initial advertisements. Use more than3378 one definition to specify multiple prefix strings. A ref that is3379 under the hierarchies listed in the value of this variable is3380 excluded, and is hidden when responding to `git push` or `git3381 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3382 program-specific versions of this config.3383+3384You may also include a `!` in front of the ref name to negate the entry,3385explicitly exposing it, even if an earlier entry marked it as hidden.3386If you have multiple hideRefs values, later entries override earlier ones3387(and entries in more-specific config files override less-specific ones).3388+3389If a namespace is in use, the namespace prefix is stripped from each3390reference before it is matched against `transfer.hiderefs` patterns.3391For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3392the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3393is omitted from the advertisements but `refs/heads/master` and3394`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3395"have" lines. In order to match refs before stripping, add a `^` in front of3396the ref name. If you combine `!` and `^`, `!` must be specified first.3397+3398Even if you hide refs, a client may still be able to steal the target3399objects via the techniques described in the "SECURITY" section of the3400linkgit:gitnamespaces[7] man page; it's best to keep private data in a3401separate repository.34023403transfer.unpackLimit::3404 When `fetch.unpackLimit` or `receive.unpackLimit` are3405 not set, the value of this variable is used instead.3406 The default value is 100.34073408uploadarchive.allowUnreachable::3409 If true, allow clients to use `git archive --remote` to request3410 any tree, whether reachable from the ref tips or not. See the3411 discussion in the "SECURITY" section of3412 linkgit:git-upload-archive[1] for more details. Defaults to3413 `false`.34143415uploadpack.hideRefs::3416 This variable is the same as `transfer.hideRefs`, but applies3417 only to `upload-pack` (and so affects only fetches, not pushes).3418 An attempt to fetch a hidden ref by `git fetch` will fail. See3419 also `uploadpack.allowTipSHA1InWant`.34203421uploadpack.allowTipSHA1InWant::3422 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3423 to accept a fetch request that asks for an object at the tip3424 of a hidden ref (by default, such a request is rejected).3425 See also `uploadpack.hideRefs`. Even if this is false, a client3426 may be able to steal objects via the techniques described in the3427 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3428 best to keep private data in a separate repository.34293430uploadpack.allowReachableSHA1InWant::3431 Allow `upload-pack` to accept a fetch request that asks for an3432 object that is reachable from any ref tip. However, note that3433 calculating object reachability is computationally expensive.3434 Defaults to `false`. Even if this is false, a client may be able3435 to steal objects via the techniques described in the "SECURITY"3436 section of the linkgit:gitnamespaces[7] man page; it's best to3437 keep private data in a separate repository.34383439uploadpack.allowAnySHA1InWant::3440 Allow `upload-pack` to accept a fetch request that asks for any3441 object at all.3442 Defaults to `false`.34433444uploadpack.keepAlive::3445 When `upload-pack` has started `pack-objects`, there may be a3446 quiet period while `pack-objects` prepares the pack. Normally3447 it would output progress information, but if `--quiet` was used3448 for the fetch, `pack-objects` will output nothing at all until3449 the pack data begins. Some clients and networks may consider3450 the server to be hung and give up. Setting this option instructs3451 `upload-pack` to send an empty keepalive packet every3452 `uploadpack.keepAlive` seconds. Setting this option to 03453 disables keepalive packets entirely. The default is 5 seconds.34543455uploadpack.packObjectsHook::3456 If this option is set, when `upload-pack` would run3457 `git pack-objects` to create a packfile for a client, it will3458 run this shell command instead. The `pack-objects` command and3459 arguments it _would_ have run (including the `git pack-objects`3460 at the beginning) are appended to the shell command. The stdin3461 and stdout of the hook are treated as if `pack-objects` itself3462 was run. I.e., `upload-pack` will feed input intended for3463 `pack-objects` to the hook, and expects a completed packfile on3464 stdout.34653466uploadpack.allowFilter::3467 If this option is set, `upload-pack` will support partial3468 clone and partial fetch object filtering.3469+3470Note that this configuration variable is ignored if it is seen in the3471repository-level config (this is a safety measure against fetching from3472untrusted repositories).34733474url.<base>.insteadOf::3475 Any URL that starts with this value will be rewritten to3476 start, instead, with <base>. In cases where some site serves a3477 large number of repositories, and serves them with multiple3478 access methods, and some users need to use different access3479 methods, this feature allows people to specify any of the3480 equivalent URLs and have Git automatically rewrite the URL to3481 the best alternative for the particular user, even for a3482 never-before-seen repository on the site. When more than one3483 insteadOf strings match a given URL, the longest match is used.3484+3485Note that any protocol restrictions will be applied to the rewritten3486URL. If the rewrite changes the URL to use a custom protocol or remote3487helper, you may need to adjust the `protocol.*.allow` config to permit3488the request. In particular, protocols you expect to use for submodules3489must be set to `always` rather than the default of `user`. See the3490description of `protocol.allow` above.34913492url.<base>.pushInsteadOf::3493 Any URL that starts with this value will not be pushed to;3494 instead, it will be rewritten to start with <base>, and the3495 resulting URL will be pushed to. In cases where some site serves3496 a large number of repositories, and serves them with multiple3497 access methods, some of which do not allow push, this feature3498 allows people to specify a pull-only URL and have Git3499 automatically use an appropriate URL to push, even for a3500 never-before-seen repository on the site. When more than one3501 pushInsteadOf strings match a given URL, the longest match is3502 used. If a remote has an explicit pushurl, Git will ignore this3503 setting for that remote.35043505user.email::3506 Your email address to be recorded in any newly created commits.3507 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3508 `EMAIL` environment variables. See linkgit:git-commit-tree[1].35093510user.name::3511 Your full name to be recorded in any newly created commits.3512 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3513 environment variables. See linkgit:git-commit-tree[1].35143515user.useConfigOnly::3516 Instruct Git to avoid trying to guess defaults for `user.email`3517 and `user.name`, and instead retrieve the values only from the3518 configuration. For example, if you have multiple email addresses3519 and would like to use a different one for each repository, then3520 with this configuration option set to `true` in the global config3521 along with a name, Git will prompt you to set up an email before3522 making new commits in a newly cloned repository.3523 Defaults to `false`.35243525user.signingKey::3526 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3527 key you want it to automatically when creating a signed tag or3528 commit, you can override the default selection with this variable.3529 This option is passed unchanged to gpg's --local-user parameter,3530 so you may specify a key using any method that gpg supports.35313532versionsort.prereleaseSuffix (deprecated)::3533 Deprecated alias for `versionsort.suffix`. Ignored if3534 `versionsort.suffix` is set.35353536versionsort.suffix::3537 Even when version sort is used in linkgit:git-tag[1], tagnames3538 with the same base version but different suffixes are still sorted3539 lexicographically, resulting e.g. in prerelease tags appearing3540 after the main release (e.g. "1.0-rc1" after "1.0"). This3541 variable can be specified to determine the sorting order of tags3542 with different suffixes.3543+3544By specifying a single suffix in this variable, any tagname containing3545that suffix will appear before the corresponding main release. E.g. if3546the variable is set to "-rc", then all "1.0-rcX" tags will appear before3547"1.0". If specified multiple times, once per suffix, then the order of3548suffixes in the configuration will determine the sorting order of tagnames3549with those suffixes. E.g. if "-pre" appears before "-rc" in the3550configuration, then all "1.0-preX" tags will be listed before any3551"1.0-rcX" tags. The placement of the main release tag relative to tags3552with various suffixes can be determined by specifying the empty suffix3553among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3554"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3555are listed first, followed by "v4.8", then "v4.8-ckX" and finally3556"v4.8-bfsX".3557+3558If more than one suffixes match the same tagname, then that tagname will3559be sorted according to the suffix which starts at the earliest position in3560the tagname. If more than one different matching suffixes start at3561that earliest position, then that tagname will be sorted according to the3562longest of those suffixes.3563The sorting order between different suffixes is undefined if they are3564in multiple config files.35653566web.browser::3567 Specify a web browser that may be used by some commands.3568 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3569 may use it.35703571worktree.guessRemote::3572 With `add`, if no branch argument, and neither of `-b` nor3573 `-B` nor `--detach` are given, the command defaults to3574 creating a new branch from HEAD. If `worktree.guessRemote` is3575 set to true, `worktree add` tries to find a remote-tracking3576 branch whose name uniquely matches the new branch name. If3577 such a branch exists, it is checked out and set as "upstream"3578 for the new branch. If no such match can be found, it falls3579 back to creating a new branch from the current HEAD.