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 (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82You can include one config file from another by setting the special 83`include.path` variable to the name of the file to be included. The 84variable takes a pathname as its value, and is subject to tilde 85expansion. 86 87The 88included file is expanded immediately, as if its contents had been 89found at the location of the include directive. If the value of the 90`include.path` variable is a relative path, the path is considered to be 91relative to the configuration file in which the include directive was 92found. See below for examples. 93 94 95Example 96~~~~~~~ 97 98 # Core variables 99 [core] 100 ; Don't trust file modes 101 filemode = false 102 103 # Our diff algorithm 104 [diff] 105 external = /usr/local/bin/diff-wrapper 106 renames = true 107 108 [branch "devel"] 109 remote = origin 110 merge = refs/heads/devel 111 112 # Proxy settings 113 [core] 114 gitProxy="ssh" for "kernel.org" 115 gitProxy=default-proxy ; for the rest 116 117 [include] 118 path = /path/to/foo.inc ; include by absolute path 119 path = foo ; expand "foo" relative to the current file 120 path = ~/foo ; expand "foo" in your `$HOME` directory 121 122 123Values 124~~~~~~ 125 126Values of many variables are treated as a simple string, but there 127are variables that take values of specific types and there are rules 128as to how to spell them. 129 130boolean:: 131 132 When a variable is said to take a boolean value, many 133 synonyms are accepted for 'true' and 'false'; these are all 134 case-insensitive. 135 136 true;; Boolean true can be spelled as `yes`, `on`, `true`, 137 or `1`. Also, a variable defined without `= <value>` 138 is taken as true. 139 140 false;; Boolean false can be spelled as `no`, `off`, 141 `false`, or `0`. 142+ 143When converting value to the canonical form using `--bool` type 144specifier; 'git config' will ensure that the output is "true" or 145"false" (spelled in lowercase). 146 147integer:: 148 The value for many variables that specify various sizes can 149 be suffixed with `k`, `M`,... to mean "scale the number by 150 1024", "by 1024x1024", etc. 151 152color:: 153 The value for a variable that takes a color is a list of 154 colors (at most two, one for foreground and one for background) 155 and attributes (as many as you want), separated by spaces. 156+ 157The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 158`blue`, `magenta`, `cyan` and `white`. The first color given is the 159foreground; the second is the background. 160+ 161Colors may also be given as numbers between 0 and 255; these use ANSI 162256-color mode (but note that not all terminals may support this). If 163your terminal supports it, you may also specify 24-bit RGB values as 164hex, like `#ff0ab3`. 165+ 166The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 167`italic`, and `strike` (for crossed-out or "strikethrough" letters). 168The position of any attributes with respect to the colors 169(before, after, or in between), doesn't matter. Specific attributes may 170be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 171`no-ul`, etc). 172+ 173For git's pre-defined color slots, the attributes are meant to be reset 174at the beginning of each item in the colored output. So setting 175`color.decorate.branch` to `black` will paint that branch name in a 176plain `black`, even if the previous thing on the same output line (e.g. 177opening parenthesis before the list of branch names in `log --decorate` 178output) is set to be painted with `bold` or some other attribute. 179However, custom log formats may do more complicated and layered 180coloring, and the negated forms may be useful there. 181 182pathname:: 183 A variable that takes a pathname value can be given a 184 string that begins with "`~/`" or "`~user/`", and the usual 185 tilde expansion happens to such a string: `~/` 186 is expanded to the value of `$HOME`, and `~user/` to the 187 specified user's home directory. 188 189 190Variables 191~~~~~~~~~ 192 193Note that this list is non-comprehensive and not necessarily complete. 194For command-specific variables, you will find a more detailed description 195in the appropriate manual page. 196 197Other git-related tools may and do use their own variables. When 198inventing new variables for use in your own tool, make sure their 199names do not conflict with those that are used by Git itself and 200other popular tools, and describe them in your documentation. 201 202 203advice.*:: 204 These variables control various optional help messages designed to 205 aid new users. All 'advice.*' variables default to 'true', and you 206 can tell Git that you do not need help by setting these to 'false': 207+ 208-- 209 pushUpdateRejected:: 210 Set this variable to 'false' if you want to disable 211 'pushNonFFCurrent', 212 'pushNonFFMatching', 'pushAlreadyExists', 213 'pushFetchFirst', and 'pushNeedsForce' 214 simultaneously. 215 pushNonFFCurrent:: 216 Advice shown when linkgit:git-push[1] fails due to a 217 non-fast-forward update to the current branch. 218 pushNonFFMatching:: 219 Advice shown when you ran linkgit:git-push[1] and pushed 220 'matching refs' explicitly (i.e. you used ':', or 221 specified a refspec that isn't your current branch) and 222 it resulted in a non-fast-forward error. 223 pushAlreadyExists:: 224 Shown when linkgit:git-push[1] rejects an update that 225 does not qualify for fast-forwarding (e.g., a tag.) 226 pushFetchFirst:: 227 Shown when linkgit:git-push[1] rejects an update that 228 tries to overwrite a remote ref that points at an 229 object we do not have. 230 pushNeedsForce:: 231 Shown when linkgit:git-push[1] rejects an update that 232 tries to overwrite a remote ref that points at an 233 object that is not a commit-ish, or make the remote 234 ref point at an object that is not a commit-ish. 235 statusHints:: 236 Show directions on how to proceed from the current 237 state in the output of linkgit:git-status[1], in 238 the template shown when writing commit messages in 239 linkgit:git-commit[1], and in the help message shown 240 by linkgit:git-checkout[1] when switching branch. 241 statusUoption:: 242 Advise to consider using the `-u` option to linkgit:git-status[1] 243 when the command takes more than 2 seconds to enumerate untracked 244 files. 245 commitBeforeMerge:: 246 Advice shown when linkgit:git-merge[1] refuses to 247 merge to avoid overwriting local changes. 248 resolveConflict:: 249 Advice shown by various commands when conflicts 250 prevent the operation from being performed. 251 implicitIdentity:: 252 Advice on how to set your identity configuration when 253 your information is guessed from the system username and 254 domain name. 255 detachedHead:: 256 Advice shown when you used linkgit:git-checkout[1] to 257 move to the detach HEAD state, to instruct how to create 258 a local branch after the fact. 259 amWorkDir:: 260 Advice that shows the location of the patch file when 261 linkgit:git-am[1] fails to apply it. 262 rmHints:: 263 In case of failure in the output of linkgit:git-rm[1], 264 show directions on how to proceed from the current state. 265-- 266 267core.fileMode:: 268 Tells Git if the executable bit of files in the working tree 269 is to be honored. 270+ 271Some filesystems lose the executable bit when a file that is 272marked as executable is checked out, or checks out an 273non-executable file with executable bit on. 274linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 275to see if it handles the executable bit correctly 276and this variable is automatically set as necessary. 277+ 278A repository, however, may be on a filesystem that handles 279the filemode correctly, and this variable is set to 'true' 280when created, but later may be made accessible from another 281environment that loses the filemode (e.g. exporting ext4 via 282CIFS mount, visiting a Cygwin created repository with 283Git for Windows or Eclipse). 284In such a case it may be necessary to set this variable to 'false'. 285See linkgit:git-update-index[1]. 286+ 287The default is true (when core.filemode is not specified in the config file). 288 289core.hideDotFiles:: 290 (Windows-only) If true, mark newly-created directories and files whose 291 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 292 directory is hidden, but no other files starting with a dot. The 293 default mode is 'dotGitOnly'. 294 295core.ignoreCase:: 296 If true, this option enables various workarounds to enable 297 Git to work better on filesystems that are not case sensitive, 298 like FAT. For example, if a directory listing finds 299 "makefile" when Git expects "Makefile", Git will assume 300 it is really the same file, and continue to remember it as 301 "Makefile". 302+ 303The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 304will probe and set core.ignoreCase true if appropriate when the repository 305is created. 306 307core.precomposeUnicode:: 308 This option is only used by Mac OS implementation of Git. 309 When core.precomposeUnicode=true, Git reverts the unicode decomposition 310 of filenames done by Mac OS. This is useful when sharing a repository 311 between Mac OS and Linux or Windows. 312 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 313 When false, file names are handled fully transparent by Git, 314 which is backward compatible with older versions of Git. 315 316core.protectHFS:: 317 If set to true, do not allow checkout of paths that would 318 be considered equivalent to `.git` on an HFS+ filesystem. 319 Defaults to `true` on Mac OS, and `false` elsewhere. 320 321core.protectNTFS:: 322 If set to true, do not allow checkout of paths that would 323 cause problems with the NTFS filesystem, e.g. conflict with 324 8.3 "short" names. 325 Defaults to `true` on Windows, and `false` elsewhere. 326 327core.trustctime:: 328 If false, the ctime differences between the index and the 329 working tree are ignored; useful when the inode change time 330 is regularly modified by something outside Git (file system 331 crawlers and some backup systems). 332 See linkgit:git-update-index[1]. True by default. 333 334core.untrackedCache:: 335 Determines what to do about the untracked cache feature of the 336 index. It will be kept, if this variable is unset or set to 337 `keep`. It will automatically be added if set to `true`. And 338 it will automatically be removed, if set to `false`. Before 339 setting it to `true`, you should check that mtime is working 340 properly on your system. 341 See linkgit:git-update-index[1]. `keep` by default. 342 343core.checkStat:: 344 Determines which stat fields to match between the index 345 and work tree. The user can set this to 'default' or 346 'minimal'. Default (or explicitly 'default'), is to check 347 all fields, including the sub-second part of mtime and ctime. 348 349core.quotePath:: 350 The commands that output paths (e.g. 'ls-files', 351 'diff'), when not given the `-z` option, will quote 352 "unusual" characters in the pathname by enclosing the 353 pathname in a double-quote pair and with backslashes the 354 same way strings in C source code are quoted. If this 355 variable is set to false, the bytes higher than 0x80 are 356 not quoted but output as verbatim. Note that double 357 quote, backslash and control characters are always 358 quoted without `-z` regardless of the setting of this 359 variable. 360 361core.eol:: 362 Sets the line ending type to use in the working directory for 363 files that have the `text` property set when core.autocrlf is false. 364 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 365 native line ending. The default value is `native`. See 366 linkgit:gitattributes[5] for more information on end-of-line 367 conversion. 368 369core.safecrlf:: 370 If true, makes Git check if converting `CRLF` is reversible when 371 end-of-line conversion is active. Git will verify if a command 372 modifies a file in the work tree either directly or indirectly. 373 For example, committing a file followed by checking out the 374 same file should yield the original file in the work tree. If 375 this is not the case for the current setting of 376 `core.autocrlf`, Git will reject the file. The variable can 377 be set to "warn", in which case Git will only warn about an 378 irreversible conversion but continue the operation. 379+ 380CRLF conversion bears a slight chance of corrupting data. 381When it is enabled, Git will convert CRLF to LF during commit and LF to 382CRLF during checkout. A file that contains a mixture of LF and 383CRLF before the commit cannot be recreated by Git. For text 384files this is the right thing to do: it corrects line endings 385such that we have only LF line endings in the repository. 386But for binary files that are accidentally classified as text the 387conversion can corrupt data. 388+ 389If you recognize such corruption early you can easily fix it by 390setting the conversion type explicitly in .gitattributes. Right 391after committing you still have the original file in your work 392tree and this file is not yet corrupted. You can explicitly tell 393Git that this file is binary and Git will handle the file 394appropriately. 395+ 396Unfortunately, the desired effect of cleaning up text files with 397mixed line endings and the undesired effect of corrupting binary 398files cannot be distinguished. In both cases CRLFs are removed 399in an irreversible way. For text files this is the right thing 400to do because CRLFs are line endings, while for binary files 401converting CRLFs corrupts data. 402+ 403Note, this safety check does not mean that a checkout will generate a 404file identical to the original file for a different setting of 405`core.eol` and `core.autocrlf`, but only for the current one. For 406example, a text file with `LF` would be accepted with `core.eol=lf` 407and could later be checked out with `core.eol=crlf`, in which case the 408resulting file would contain `CRLF`, although the original file 409contained `LF`. However, in both work trees the line endings would be 410consistent, that is either all `LF` or all `CRLF`, but never mixed. A 411file with mixed line endings would be reported by the `core.safecrlf` 412mechanism. 413 414core.autocrlf:: 415 Setting this variable to "true" is the same as setting 416 the `text` attribute to "auto" on all files and core.eol to "crlf". 417 Set to true if you want to have `CRLF` line endings in your 418 working directory and the repository has LF line endings. 419 This variable can be set to 'input', 420 in which case no output conversion is performed. 421 422core.symlinks:: 423 If false, symbolic links are checked out as small plain files that 424 contain the link text. linkgit:git-update-index[1] and 425 linkgit:git-add[1] will not change the recorded type to regular 426 file. Useful on filesystems like FAT that do not support 427 symbolic links. 428+ 429The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 430will probe and set core.symlinks false if appropriate when the repository 431is created. 432 433core.gitProxy:: 434 A "proxy command" to execute (as 'command host port') instead 435 of establishing direct connection to the remote server when 436 using the Git protocol for fetching. If the variable value is 437 in the "COMMAND for DOMAIN" format, the command is applied only 438 on hostnames ending with the specified domain string. This variable 439 may be set multiple times and is matched in the given order; 440 the first match wins. 441+ 442Can be overridden by the `GIT_PROXY_COMMAND` environment variable 443(which always applies universally, without the special "for" 444handling). 445+ 446The special string `none` can be used as the proxy command to 447specify that no proxy be used for a given domain pattern. 448This is useful for excluding servers inside a firewall from 449proxy use, while defaulting to a common proxy for external domains. 450 451core.sshCommand:: 452 If this variable is set, `git fetch` and `git push` will 453 use the specified command instead of `ssh` when they need to 454 connect to a remote system. The command is in the same form as 455 the `GIT_SSH_COMMAND` environment variable and is overridden 456 when the environment variable is set. 457 458core.ignoreStat:: 459 If true, Git will avoid using lstat() calls to detect if files have 460 changed by setting the "assume-unchanged" bit for those tracked files 461 which it has updated identically in both the index and working tree. 462+ 463When files are modified outside of Git, the user will need to stage 464the modified files explicitly (e.g. see 'Examples' section in 465linkgit:git-update-index[1]). 466Git will not normally detect changes to those files. 467+ 468This is useful on systems where lstat() calls are very slow, such as 469CIFS/Microsoft Windows. 470+ 471False by default. 472 473core.preferSymlinkRefs:: 474 Instead of the default "symref" format for HEAD 475 and other symbolic reference files, use symbolic links. 476 This is sometimes needed to work with old scripts that 477 expect HEAD to be a symbolic link. 478 479core.bare:: 480 If true this repository is assumed to be 'bare' and has no 481 working directory associated with it. If this is the case a 482 number of commands that require a working directory will be 483 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 484+ 485This setting is automatically guessed by linkgit:git-clone[1] or 486linkgit:git-init[1] when the repository was created. By default a 487repository that ends in "/.git" is assumed to be not bare (bare = 488false), while all other repositories are assumed to be bare (bare 489= true). 490 491core.worktree:: 492 Set the path to the root of the working tree. 493 If `GIT_COMMON_DIR` environment variable is set, core.worktree 494 is ignored and not used for determining the root of working tree. 495 This can be overridden by the `GIT_WORK_TREE` environment 496 variable and the `--work-tree` command-line option. 497 The value can be an absolute path or relative to the path to 498 the .git directory, which is either specified by --git-dir 499 or GIT_DIR, or automatically discovered. 500 If --git-dir or GIT_DIR is specified but none of 501 --work-tree, GIT_WORK_TREE and core.worktree is specified, 502 the current working directory is regarded as the top level 503 of your working tree. 504+ 505Note that this variable is honored even when set in a configuration 506file in a ".git" subdirectory of a directory and its value differs 507from the latter directory (e.g. "/path/to/.git/config" has 508core.worktree set to "/different/path"), which is most likely a 509misconfiguration. Running Git commands in the "/path/to" directory will 510still use "/different/path" as the root of the work tree and can cause 511confusion unless you know what you are doing (e.g. you are creating a 512read-only snapshot of the same index to a location different from the 513repository's usual working tree). 514 515core.logAllRefUpdates:: 516 Enable the reflog. Updates to a ref <ref> is logged to the file 517 "`$GIT_DIR/logs/<ref>`", by appending the new and old 518 SHA-1, the date/time and the reason of the update, but 519 only when the file exists. If this configuration 520 variable is set to true, missing "`$GIT_DIR/logs/<ref>`" 521 file is automatically created for branch heads (i.e. under 522 refs/heads/), remote refs (i.e. under refs/remotes/), 523 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 524+ 525This information can be used to determine what commit 526was the tip of a branch "2 days ago". 527+ 528This value is true by default in a repository that has 529a working directory associated with it, and false by 530default in a bare repository. 531 532core.repositoryFormatVersion:: 533 Internal variable identifying the repository format and layout 534 version. 535 536core.sharedRepository:: 537 When 'group' (or 'true'), the repository is made shareable between 538 several users in a group (making sure all the files and objects are 539 group-writable). When 'all' (or 'world' or 'everybody'), the 540 repository will be readable by all users, additionally to being 541 group-shareable. When 'umask' (or 'false'), Git will use permissions 542 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 543 files in the repository will have this mode value. '0xxx' will override 544 user's umask value (whereas the other options will only override 545 requested parts of the user's umask value). Examples: '0660' will make 546 the repo read/write-able for the owner and group, but inaccessible to 547 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 548 repository that is group-readable but not group-writable. 549 See linkgit:git-init[1]. False by default. 550 551core.warnAmbiguousRefs:: 552 If true, Git will warn you if the ref name you passed it is ambiguous 553 and might match multiple refs in the repository. True by default. 554 555core.compression:: 556 An integer -1..9, indicating a default compression level. 557 -1 is the zlib default. 0 means no compression, 558 and 1..9 are various speed/size tradeoffs, 9 being slowest. 559 If set, this provides a default to other compression variables, 560 such as `core.looseCompression` and `pack.compression`. 561 562core.looseCompression:: 563 An integer -1..9, indicating the compression level for objects that 564 are not in a pack file. -1 is the zlib default. 0 means no 565 compression, and 1..9 are various speed/size tradeoffs, 9 being 566 slowest. If not set, defaults to core.compression. If that is 567 not set, defaults to 1 (best speed). 568 569core.packedGitWindowSize:: 570 Number of bytes of a pack file to map into memory in a 571 single mapping operation. Larger window sizes may allow 572 your system to process a smaller number of large pack files 573 more quickly. Smaller window sizes will negatively affect 574 performance due to increased calls to the operating system's 575 memory manager, but may improve performance when accessing 576 a large number of large pack files. 577+ 578Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 579MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 580be reasonable for all users/operating systems. You probably do 581not need to adjust this value. 582+ 583Common unit suffixes of 'k', 'm', or 'g' are supported. 584 585core.packedGitLimit:: 586 Maximum number of bytes to map simultaneously into memory 587 from pack files. If Git needs to access more than this many 588 bytes at once to complete an operation it will unmap existing 589 regions to reclaim virtual address space within the process. 590+ 591Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 592This should be reasonable for all users/operating systems, except on 593the largest projects. You probably do not need to adjust this value. 594+ 595Common unit suffixes of 'k', 'm', or 'g' are supported. 596 597core.deltaBaseCacheLimit:: 598 Maximum number of bytes to reserve for caching base objects 599 that may be referenced by multiple deltified objects. By storing the 600 entire decompressed base objects in a cache Git is able 601 to avoid unpacking and decompressing frequently used base 602 objects multiple times. 603+ 604Default is 96 MiB on all platforms. This should be reasonable 605for all users/operating systems, except on the largest projects. 606You probably do not need to adjust this value. 607+ 608Common unit suffixes of 'k', 'm', or 'g' are supported. 609 610core.bigFileThreshold:: 611 Files larger than this size are stored deflated, without 612 attempting delta compression. Storing large files without 613 delta compression avoids excessive memory usage, at the 614 slight expense of increased disk usage. Additionally files 615 larger than this size are always treated as binary. 616+ 617Default is 512 MiB on all platforms. This should be reasonable 618for most projects as source code and other text files can still 619be delta compressed, but larger binary media files won't be. 620+ 621Common unit suffixes of 'k', 'm', or 'g' are supported. 622 623core.excludesFile:: 624 Specifies the pathname to the file that contains patterns to 625 describe paths that are not meant to be tracked, in addition 626 to '.gitignore' (per-directory) and '.git/info/exclude'. 627 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 628 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 629 is used instead. See linkgit:gitignore[5]. 630 631core.askPass:: 632 Some commands (e.g. svn and http interfaces) that interactively 633 ask for a password can be told to use an external program given 634 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 635 environment variable. If not set, fall back to the value of the 636 `SSH_ASKPASS` environment variable or, failing that, a simple password 637 prompt. The external program shall be given a suitable prompt as 638 command-line argument and write the password on its STDOUT. 639 640core.attributesFile:: 641 In addition to '.gitattributes' (per-directory) and 642 '.git/info/attributes', Git looks into this file for attributes 643 (see linkgit:gitattributes[5]). Path expansions are made the same 644 way as for `core.excludesFile`. Its default value is 645 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 646 set or empty, `$HOME/.config/git/attributes` is used instead. 647 648core.hooksPath:: 649 By default Git will look for your hooks in the 650 '$GIT_DIR/hooks' directory. Set this to different path, 651 e.g. '/etc/git/hooks', and Git will try to find your hooks in 652 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 653 in '$GIT_DIR/hooks/pre-receive'. 654+ 655The path can be either absolute or relative. A relative path is 656taken as relative to the directory where the hooks are run (see 657the "DESCRIPTION" section of linkgit:githooks[5]). 658+ 659This configuration variable is useful in cases where you'd like to 660centrally configure your Git hooks instead of configuring them on a 661per-repository basis, or as a more flexible and centralized 662alternative to having an `init.templateDir` where you've changed 663default hooks. 664 665core.editor:: 666 Commands such as `commit` and `tag` that lets you edit 667 messages by launching an editor uses the value of this 668 variable when it is set, and the environment variable 669 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 670 671core.commentChar:: 672 Commands such as `commit` and `tag` that lets you edit 673 messages consider a line that begins with this character 674 commented, and removes them after the editor returns 675 (default '#'). 676+ 677If set to "auto", `git-commit` would select a character that is not 678the beginning character of any line in existing commit messages. 679 680core.packedRefsTimeout:: 681 The length of time, in milliseconds, to retry when trying to 682 lock the `packed-refs` file. Value 0 means not to retry at 683 all; -1 means to try indefinitely. Default is 1000 (i.e., 684 retry for 1 second). 685 686sequence.editor:: 687 Text editor used by `git rebase -i` for editing the rebase instruction file. 688 The value is meant to be interpreted by the shell when it is used. 689 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 690 When not configured the default commit message editor is used instead. 691 692core.pager:: 693 Text viewer for use by Git commands (e.g., 'less'). The value 694 is meant to be interpreted by the shell. The order of preference 695 is the `$GIT_PAGER` environment variable, then `core.pager` 696 configuration, then `$PAGER`, and then the default chosen at 697 compile time (usually 'less'). 698+ 699When the `LESS` environment variable is unset, Git sets it to `FRX` 700(if `LESS` environment variable is set, Git does not change it at 701all). If you want to selectively override Git's default setting 702for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 703be passed to the shell by Git, which will translate the final 704command to `LESS=FRX less -S`. The environment does not set the 705`S` option but the command line does, instructing less to truncate 706long lines. Similarly, setting `core.pager` to `less -+F` will 707deactivate the `F` option specified by the environment from the 708command-line, deactivating the "quit if one screen" behavior of 709`less`. One can specifically activate some flags for particular 710commands: for example, setting `pager.blame` to `less -S` enables 711line truncation only for `git blame`. 712+ 713Likewise, when the `LV` environment variable is unset, Git sets it 714to `-c`. You can override this setting by exporting `LV` with 715another value or setting `core.pager` to `lv +c`. 716 717core.whitespace:: 718 A comma separated list of common whitespace problems to 719 notice. 'git diff' will use `color.diff.whitespace` to 720 highlight them, and 'git apply --whitespace=error' will 721 consider them as errors. You can prefix `-` to disable 722 any of them (e.g. `-trailing-space`): 723+ 724* `blank-at-eol` treats trailing whitespaces at the end of the line 725 as an error (enabled by default). 726* `space-before-tab` treats a space character that appears immediately 727 before a tab character in the initial indent part of the line as an 728 error (enabled by default). 729* `indent-with-non-tab` treats a line that is indented with space 730 characters instead of the equivalent tabs as an error (not enabled by 731 default). 732* `tab-in-indent` treats a tab character in the initial indent part of 733 the line as an error (not enabled by default). 734* `blank-at-eof` treats blank lines added at the end of file as an error 735 (enabled by default). 736* `trailing-space` is a short-hand to cover both `blank-at-eol` and 737 `blank-at-eof`. 738* `cr-at-eol` treats a carriage-return at the end of line as 739 part of the line terminator, i.e. with it, `trailing-space` 740 does not trigger if the character before such a carriage-return 741 is not a whitespace (not enabled by default). 742* `tabwidth=<n>` tells how many character positions a tab occupies; this 743 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 744 errors. The default tab width is 8. Allowed values are 1 to 63. 745 746core.fsyncObjectFiles:: 747 This boolean will enable 'fsync()' when writing object files. 748+ 749This is a total waste of time and effort on a filesystem that orders 750data writes properly, but can be useful for filesystems that do not use 751journalling (traditional UNIX filesystems) or that only journal metadata 752and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 753 754core.preloadIndex:: 755 Enable parallel index preload for operations like 'git diff' 756+ 757This can speed up operations like 'git diff' and 'git status' especially 758on filesystems like NFS that have weak caching semantics and thus 759relatively high IO latencies. When enabled, Git will do the 760index comparison to the filesystem data in parallel, allowing 761overlapping IO's. Defaults to true. 762 763core.createObject:: 764 You can set this to 'link', in which case a hardlink followed by 765 a delete of the source are used to make sure that object creation 766 will not overwrite existing objects. 767+ 768On some file system/operating system combinations, this is unreliable. 769Set this config setting to 'rename' there; However, This will remove the 770check that makes sure that existing object files will not get overwritten. 771 772core.notesRef:: 773 When showing commit messages, also show notes which are stored in 774 the given ref. The ref must be fully qualified. If the given 775 ref does not exist, it is not an error but means that no 776 notes should be printed. 777+ 778This setting defaults to "refs/notes/commits", and it can be overridden by 779the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 780 781core.sparseCheckout:: 782 Enable "sparse checkout" feature. See section "Sparse checkout" in 783 linkgit:git-read-tree[1] for more information. 784 785core.abbrev:: 786 Set the length object names are abbreviated to. If unspecified, 787 many commands abbreviate to 7 hexdigits, which may not be enough 788 for abbreviated object names to stay unique for sufficiently long 789 time. 790 791add.ignoreErrors:: 792add.ignore-errors (deprecated):: 793 Tells 'git add' to continue adding files when some files cannot be 794 added due to indexing errors. Equivalent to the `--ignore-errors` 795 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 796 as it does not follow the usual naming convention for configuration 797 variables. 798 799alias.*:: 800 Command aliases for the linkgit:git[1] command wrapper - e.g. 801 after defining "alias.last = cat-file commit HEAD", the invocation 802 "git last" is equivalent to "git cat-file commit HEAD". To avoid 803 confusion and troubles with script usage, aliases that 804 hide existing Git commands are ignored. Arguments are split by 805 spaces, the usual shell quoting and escaping is supported. 806 A quote pair or a backslash can be used to quote them. 807+ 808If the alias expansion is prefixed with an exclamation point, 809it will be treated as a shell command. For example, defining 810"alias.new = !gitk --all --not ORIG_HEAD", the invocation 811"git new" is equivalent to running the shell command 812"gitk --all --not ORIG_HEAD". Note that shell commands will be 813executed from the top-level directory of a repository, which may 814not necessarily be the current directory. 815`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 816from the original current directory. See linkgit:git-rev-parse[1]. 817 818am.keepcr:: 819 If true, git-am will call git-mailsplit for patches in mbox format 820 with parameter `--keep-cr`. In this case git-mailsplit will 821 not remove `\r` from lines ending with `\r\n`. Can be overridden 822 by giving `--no-keep-cr` from the command line. 823 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 824 825am.threeWay:: 826 By default, `git am` will fail if the patch does not apply cleanly. When 827 set to true, this setting tells `git am` to fall back on 3-way merge if 828 the patch records the identity of blobs it is supposed to apply to and 829 we have those blobs available locally (equivalent to giving the `--3way` 830 option from the command line). Defaults to `false`. 831 See linkgit:git-am[1]. 832 833apply.ignoreWhitespace:: 834 When set to 'change', tells 'git apply' to ignore changes in 835 whitespace, in the same way as the `--ignore-space-change` 836 option. 837 When set to one of: no, none, never, false tells 'git apply' to 838 respect all whitespace differences. 839 See linkgit:git-apply[1]. 840 841apply.whitespace:: 842 Tells 'git apply' how to handle whitespaces, in the same way 843 as the `--whitespace` option. See linkgit:git-apply[1]. 844 845branch.autoSetupMerge:: 846 Tells 'git branch' and 'git checkout' to set up new branches 847 so that linkgit:git-pull[1] will appropriately merge from the 848 starting point branch. Note that even if this option is not set, 849 this behavior can be chosen per-branch using the `--track` 850 and `--no-track` options. The valid settings are: `false` -- no 851 automatic setup is done; `true` -- automatic setup is done when the 852 starting point is a remote-tracking branch; `always` -- 853 automatic setup is done when the starting point is either a 854 local branch or remote-tracking 855 branch. This option defaults to true. 856 857branch.autoSetupRebase:: 858 When a new branch is created with 'git branch' or 'git checkout' 859 that tracks another branch, this variable tells Git to set 860 up pull to rebase instead of merge (see "branch.<name>.rebase"). 861 When `never`, rebase is never automatically set to true. 862 When `local`, rebase is set to true for tracked branches of 863 other local branches. 864 When `remote`, rebase is set to true for tracked branches of 865 remote-tracking branches. 866 When `always`, rebase will be set to true for all tracking 867 branches. 868 See "branch.autoSetupMerge" for details on how to set up a 869 branch to track another branch. 870 This option defaults to never. 871 872branch.<name>.remote:: 873 When on branch <name>, it tells 'git fetch' and 'git push' 874 which remote to fetch from/push to. The remote to push to 875 may be overridden with `remote.pushDefault` (for all branches). 876 The remote to push to, for the current branch, may be further 877 overridden by `branch.<name>.pushRemote`. If no remote is 878 configured, or if you are not on any branch, it defaults to 879 `origin` for fetching and `remote.pushDefault` for pushing. 880 Additionally, `.` (a period) is the current local repository 881 (a dot-repository), see `branch.<name>.merge`'s final note below. 882 883branch.<name>.pushRemote:: 884 When on branch <name>, it overrides `branch.<name>.remote` for 885 pushing. It also overrides `remote.pushDefault` for pushing 886 from branch <name>. When you pull from one place (e.g. your 887 upstream) and push to another place (e.g. your own publishing 888 repository), you would want to set `remote.pushDefault` to 889 specify the remote to push to for all branches, and use this 890 option to override it for a specific branch. 891 892branch.<name>.merge:: 893 Defines, together with branch.<name>.remote, the upstream branch 894 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 895 branch to merge and can also affect 'git push' (see push.default). 896 When in branch <name>, it tells 'git fetch' the default 897 refspec to be marked for merging in FETCH_HEAD. The value is 898 handled like the remote part of a refspec, and must match a 899 ref which is fetched from the remote given by 900 "branch.<name>.remote". 901 The merge information is used by 'git pull' (which at first calls 902 'git fetch') to lookup the default branch for merging. Without 903 this option, 'git pull' defaults to merge the first refspec fetched. 904 Specify multiple values to get an octopus merge. 905 If you wish to setup 'git pull' so that it merges into <name> from 906 another branch in the local repository, you can point 907 branch.<name>.merge to the desired branch, and use the relative path 908 setting `.` (a period) for branch.<name>.remote. 909 910branch.<name>.mergeOptions:: 911 Sets default options for merging into branch <name>. The syntax and 912 supported options are the same as those of linkgit:git-merge[1], but 913 option values containing whitespace characters are currently not 914 supported. 915 916branch.<name>.rebase:: 917 When true, rebase the branch <name> on top of the fetched branch, 918 instead of merging the default branch from the default remote when 919 "git pull" is run. See "pull.rebase" for doing this in a non 920 branch-specific manner. 921+ 922When preserve, also pass `--preserve-merges` along to 'git rebase' 923so that locally committed merge commits will not be flattened 924by running 'git pull'. 925+ 926When the value is `interactive`, the rebase is run in interactive mode. 927+ 928*NOTE*: this is a possibly dangerous operation; do *not* use 929it unless you understand the implications (see linkgit:git-rebase[1] 930for details). 931 932branch.<name>.description:: 933 Branch description, can be edited with 934 `git branch --edit-description`. Branch description is 935 automatically added in the format-patch cover letter or 936 request-pull summary. 937 938browser.<tool>.cmd:: 939 Specify the command to invoke the specified browser. The 940 specified command is evaluated in shell with the URLs passed 941 as arguments. (See linkgit:git-web{litdd}browse[1].) 942 943browser.<tool>.path:: 944 Override the path for the given tool that may be used to 945 browse HTML help (see `-w` option in linkgit:git-help[1]) or a 946 working repository in gitweb (see linkgit:git-instaweb[1]). 947 948clean.requireForce:: 949 A boolean to make git-clean do nothing unless given -f, 950 -i or -n. Defaults to true. 951 952color.branch:: 953 A boolean to enable/disable color in the output of 954 linkgit:git-branch[1]. May be set to `always`, 955 `false` (or `never`) or `auto` (or `true`), in which case colors are used 956 only when the output is to a terminal. Defaults to false. 957 958color.branch.<slot>:: 959 Use customized color for branch coloration. `<slot>` is one of 960 `current` (the current branch), `local` (a local branch), 961 `remote` (a remote-tracking branch in refs/remotes/), 962 `upstream` (upstream tracking branch), `plain` (other 963 refs). 964 965color.diff:: 966 Whether to use ANSI escape sequences to add color to patches. 967 If this is set to `always`, linkgit:git-diff[1], 968 linkgit:git-log[1], and linkgit:git-show[1] will use color 969 for all patches. If it is set to `true` or `auto`, those 970 commands will only use color when output is to the terminal. 971 Defaults to false. 972+ 973This does not affect linkgit:git-format-patch[1] or the 974'git-diff-{asterisk}' plumbing commands. Can be overridden on the 975command line with the `--color[=<when>]` option. 976 977color.diff.<slot>:: 978 Use customized color for diff colorization. `<slot>` specifies 979 which part of the patch to use the specified color, and is one 980 of `context` (context text - `plain` is a historical synonym), 981 `meta` (metainformation), `frag` 982 (hunk header), 'func' (function in hunk header), `old` (removed lines), 983 `new` (added lines), `commit` (commit headers), or `whitespace` 984 (highlighting whitespace errors). 985 986color.decorate.<slot>:: 987 Use customized color for 'git log --decorate' output. `<slot>` is one 988 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 989 branches, remote-tracking branches, tags, stash and HEAD, respectively. 990 991color.grep:: 992 When set to `always`, always highlight matches. When `false` (or 993 `never`), never. When set to `true` or `auto`, use color only 994 when the output is written to the terminal. Defaults to `false`. 995 996color.grep.<slot>:: 997 Use customized color for grep colorization. `<slot>` specifies which 998 part of the line to use the specified color, and is one of 999+1000--1001`context`;;1002 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1003`filename`;;1004 filename prefix (when not using `-h`)1005`function`;;1006 function name lines (when using `-p`)1007`linenumber`;;1008 line number prefix (when using `-n`)1009`match`;;1010 matching text (same as setting `matchContext` and `matchSelected`)1011`matchContext`;;1012 matching text in context lines1013`matchSelected`;;1014 matching text in selected lines1015`selected`;;1016 non-matching text in selected lines1017`separator`;;1018 separators between fields on a line (`:`, `-`, and `=`)1019 and between hunks (`--`)1020--10211022color.interactive::1023 When set to `always`, always use colors for interactive prompts1024 and displays (such as those used by "git-add --interactive" and1025 "git-clean --interactive"). When false (or `never`), never.1026 When set to `true` or `auto`, use colors only when the output is1027 to the terminal. Defaults to false.10281029color.interactive.<slot>::1030 Use customized color for 'git add --interactive' and 'git clean1031 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1032 or `error`, for four distinct types of normal output from1033 interactive commands.10341035color.pager::1036 A boolean to enable/disable colored output when the pager is in1037 use (default is true).10381039color.showBranch::1040 A boolean to enable/disable color in the output of1041 linkgit:git-show-branch[1]. May be set to `always`,1042 `false` (or `never`) or `auto` (or `true`), in which case colors are used1043 only when the output is to a terminal. Defaults to false.10441045color.status::1046 A boolean to enable/disable color in the output of1047 linkgit:git-status[1]. May be set to `always`,1048 `false` (or `never`) or `auto` (or `true`), in which case colors are used1049 only when the output is to a terminal. Defaults to false.10501051color.status.<slot>::1052 Use customized color for status colorization. `<slot>` is1053 one of `header` (the header text of the status message),1054 `added` or `updated` (files which are added but not committed),1055 `changed` (files which are changed but not added in the index),1056 `untracked` (files which are not tracked by Git),1057 `branch` (the current branch),1058 `nobranch` (the color the 'no branch' warning is shown in, defaulting1059 to red), or1060 `unmerged` (files which have unmerged changes).10611062color.ui::1063 This variable determines the default value for variables such1064 as `color.diff` and `color.grep` that control the use of color1065 per command family. Its scope will expand as more commands learn1066 configuration to set a default for the `--color` option. Set it1067 to `false` or `never` if you prefer Git commands not to use1068 color unless enabled explicitly with some other configuration1069 or the `--color` option. Set it to `always` if you want all1070 output not intended for machine consumption to use color, to1071 `true` or `auto` (this is the default since Git 1.8.4) if you1072 want such output to use color when written to the terminal.10731074column.ui::1075 Specify whether supported commands should output in columns.1076 This variable consists of a list of tokens separated by spaces1077 or commas:1078+1079These options control when the feature should be enabled1080(defaults to 'never'):1081+1082--1083`always`;;1084 always show in columns1085`never`;;1086 never show in columns1087`auto`;;1088 show in columns if the output is to the terminal1089--1090+1091These options control layout (defaults to 'column'). Setting any1092of these implies 'always' if none of 'always', 'never', or 'auto' are1093specified.1094+1095--1096`column`;;1097 fill columns before rows1098`row`;;1099 fill rows before columns1100`plain`;;1101 show in one column1102--1103+1104Finally, these options can be combined with a layout option (defaults1105to 'nodense'):1106+1107--1108`dense`;;1109 make unequal size columns to utilize more space1110`nodense`;;1111 make equal size columns1112--11131114column.branch::1115 Specify whether to output branch listing in `git branch` in columns.1116 See `column.ui` for details.11171118column.clean::1119 Specify the layout when list items in `git clean -i`, which always1120 shows files and directories in columns. See `column.ui` for details.11211122column.status::1123 Specify whether to output untracked files in `git status` in columns.1124 See `column.ui` for details.11251126column.tag::1127 Specify whether to output tag listing in `git tag` in columns.1128 See `column.ui` for details.11291130commit.cleanup::1131 This setting overrides the default of the `--cleanup` option in1132 `git commit`. See linkgit:git-commit[1] for details. Changing the1133 default can be useful when you always want to keep lines that begin1134 with comment character `#` in your log message, in which case you1135 would do `git config commit.cleanup whitespace` (note that you will1136 have to remove the help lines that begin with `#` in the commit log1137 template yourself, if you do this).11381139commit.gpgSign::11401141 A boolean to specify whether all commits should be GPG signed.1142 Use of this option when doing operations such as rebase can1143 result in a large number of commits being signed. It may be1144 convenient to use an agent to avoid typing your GPG passphrase1145 several times.11461147commit.status::1148 A boolean to enable/disable inclusion of status information in the1149 commit message template when using an editor to prepare the commit1150 message. Defaults to true.11511152commit.template::1153 Specify the pathname of a file to use as the template for1154 new commit messages.11551156commit.verbose::1157 A boolean or int to specify the level of verbose with `git commit`.1158 See linkgit:git-commit[1].11591160credential.helper::1161 Specify an external helper to be called when a username or1162 password credential is needed; the helper may consult external1163 storage to avoid prompting the user for the credentials. Note1164 that multiple helpers may be defined. See linkgit:gitcredentials[7]1165 for details.11661167credential.useHttpPath::1168 When acquiring credentials, consider the "path" component of an http1169 or https URL to be important. Defaults to false. See1170 linkgit:gitcredentials[7] for more information.11711172credential.username::1173 If no username is set for a network authentication, use this username1174 by default. See credential.<context>.* below, and1175 linkgit:gitcredentials[7].11761177credential.<url>.*::1178 Any of the credential.* options above can be applied selectively to1179 some credentials. For example "credential.https://example.com.username"1180 would set the default username only for https connections to1181 example.com. See linkgit:gitcredentials[7] for details on how URLs are1182 matched.11831184credentialCache.ignoreSIGHUP::1185 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11861187include::diff-config.txt[]11881189difftool.<tool>.path::1190 Override the path for the given tool. This is useful in case1191 your tool is not in the PATH.11921193difftool.<tool>.cmd::1194 Specify the command to invoke the specified diff tool.1195 The specified command is evaluated in shell with the following1196 variables available: 'LOCAL' is set to the name of the temporary1197 file containing the contents of the diff pre-image and 'REMOTE'1198 is set to the name of the temporary file containing the contents1199 of the diff post-image.12001201difftool.prompt::1202 Prompt before each invocation of the diff tool.12031204fastimport.unpackLimit::1205 If the number of objects imported by linkgit:git-fast-import[1]1206 is below this limit, then the objects will be unpacked into1207 loose object files. However if the number of imported objects1208 equals or exceeds this limit then the pack will be stored as a1209 pack. Storing the pack from a fast-import can make the import1210 operation complete faster, especially on slow filesystems. If1211 not set, the value of `transfer.unpackLimit` is used instead.12121213fetch.recurseSubmodules::1214 This option can be either set to a boolean value or to 'on-demand'.1215 Setting it to a boolean changes the behavior of fetch and pull to1216 unconditionally recurse into submodules when set to true or to not1217 recurse at all when set to false. When set to 'on-demand' (the default1218 value), fetch and pull will only recurse into a populated submodule1219 when its superproject retrieves a commit that updates the submodule's1220 reference.12211222fetch.fsckObjects::1223 If it is set to true, git-fetch-pack will check all fetched1224 objects. It will abort in the case of a malformed object or a1225 broken link. The result of an abort are only dangling objects.1226 Defaults to false. If not set, the value of `transfer.fsckObjects`1227 is used instead.12281229fetch.unpackLimit::1230 If the number of objects fetched over the Git native1231 transfer is below this1232 limit, then the objects will be unpacked into loose object1233 files. However if the number of received objects equals or1234 exceeds this limit then the received pack will be stored as1235 a pack, after adding any missing delta bases. Storing the1236 pack from a push can make the push operation complete faster,1237 especially on slow filesystems. If not set, the value of1238 `transfer.unpackLimit` is used instead.12391240fetch.prune::1241 If true, fetch will automatically behave as if the `--prune`1242 option was given on the command line. See also `remote.<name>.prune`.12431244fetch.output::1245 Control how ref update status is printed. Valid values are1246 `full` and `compact`. Default value is `full`. See section1247 OUTPUT in linkgit:git-fetch[1] for detail.12481249format.attach::1250 Enable multipart/mixed attachments as the default for1251 'format-patch'. The value can also be a double quoted string1252 which will enable attachments as the default and set the1253 value as the boundary. See the --attach option in1254 linkgit:git-format-patch[1].12551256format.numbered::1257 A boolean which can enable or disable sequence numbers in patch1258 subjects. It defaults to "auto" which enables it only if there1259 is more than one patch. It can be enabled or disabled for all1260 messages by setting it to "true" or "false". See --numbered1261 option in linkgit:git-format-patch[1].12621263format.headers::1264 Additional email headers to include in a patch to be submitted1265 by mail. See linkgit:git-format-patch[1].12661267format.to::1268format.cc::1269 Additional recipients to include in a patch to be submitted1270 by mail. See the --to and --cc options in1271 linkgit:git-format-patch[1].12721273format.subjectPrefix::1274 The default for format-patch is to output files with the '[PATCH]'1275 subject prefix. Use this variable to change that prefix.12761277format.signature::1278 The default for format-patch is to output a signature containing1279 the Git version number. Use this variable to change that default.1280 Set this variable to the empty string ("") to suppress1281 signature generation.12821283format.signatureFile::1284 Works just like format.signature except the contents of the1285 file specified by this variable will be used as the signature.12861287format.suffix::1288 The default for format-patch is to output files with the suffix1289 `.patch`. Use this variable to change that suffix (make sure to1290 include the dot if you want it).12911292format.pretty::1293 The default pretty format for log/show/whatchanged command,1294 See linkgit:git-log[1], linkgit:git-show[1],1295 linkgit:git-whatchanged[1].12961297format.thread::1298 The default threading style for 'git format-patch'. Can be1299 a boolean value, or `shallow` or `deep`. `shallow` threading1300 makes every mail a reply to the head of the series,1301 where the head is chosen from the cover letter, the1302 `--in-reply-to`, and the first patch mail, in this order.1303 `deep` threading makes every mail a reply to the previous one.1304 A true boolean value is the same as `shallow`, and a false1305 value disables threading.13061307format.signOff::1308 A boolean value which lets you enable the `-s/--signoff` option of1309 format-patch by default. *Note:* Adding the Signed-off-by: line to a1310 patch should be a conscious act and means that you certify you have1311 the rights to submit this work under the same open source license.1312 Please see the 'SubmittingPatches' document for further discussion.13131314format.coverLetter::1315 A boolean that controls whether to generate a cover-letter when1316 format-patch is invoked, but in addition can be set to "auto", to1317 generate a cover-letter only when there's more than one patch.13181319format.outputDirectory::1320 Set a custom directory to store the resulting files instead of the1321 current working directory.13221323format.useAutoBase::1324 A boolean value which lets you enable the `--base=auto` option of1325 format-patch by default.13261327filter.<driver>.clean::1328 The command which is used to convert the content of a worktree1329 file to a blob upon checkin. See linkgit:gitattributes[5] for1330 details.13311332filter.<driver>.smudge::1333 The command which is used to convert the content of a blob1334 object to a worktree file upon checkout. See1335 linkgit:gitattributes[5] for details.13361337fsck.<msg-id>::1338 Allows overriding the message type (error, warn or ignore) of a1339 specific message ID such as `missingEmail`.1340+1341For convenience, fsck prefixes the error/warning with the message ID,1342e.g. "missingEmail: invalid author/committer line - missing email" means1343that setting `fsck.missingEmail = ignore` will hide that issue.1344+1345This feature is intended to support working with legacy repositories1346which cannot be repaired without disruptive changes.13471348fsck.skipList::1349 The path to a sorted list of object names (i.e. one SHA-1 per1350 line) that are known to be broken in a non-fatal way and should1351 be ignored. This feature is useful when an established project1352 should be accepted despite early commits containing errors that1353 can be safely ignored such as invalid committer email addresses.1354 Note: corrupt objects cannot be skipped with this setting.13551356gc.aggressiveDepth::1357 The depth parameter used in the delta compression1358 algorithm used by 'git gc --aggressive'. This defaults1359 to 250.13601361gc.aggressiveWindow::1362 The window size parameter used in the delta compression1363 algorithm used by 'git gc --aggressive'. This defaults1364 to 250.13651366gc.auto::1367 When there are approximately more than this many loose1368 objects in the repository, `git gc --auto` will pack them.1369 Some Porcelain commands use this command to perform a1370 light-weight garbage collection from time to time. The1371 default value is 6700. Setting this to 0 disables it.13721373gc.autoPackLimit::1374 When there are more than this many packs that are not1375 marked with `*.keep` file in the repository, `git gc1376 --auto` consolidates them into one larger pack. The1377 default value is 50. Setting this to 0 disables it.13781379gc.autoDetach::1380 Make `git gc --auto` return immediately and run in background1381 if the system supports it. Default is true.13821383gc.packRefs::1384 Running `git pack-refs` in a repository renders it1385 unclonable by Git versions prior to 1.5.1.2 over dumb1386 transports such as HTTP. This variable determines whether1387 'git gc' runs `git pack-refs`. This can be set to `notbare`1388 to enable it within all non-bare repos or it can be set to a1389 boolean value. The default is `true`.13901391gc.pruneExpire::1392 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1393 Override the grace period with this config variable. The value1394 "now" may be used to disable this grace period and always prune1395 unreachable objects immediately, or "never" may be used to1396 suppress pruning.13971398gc.worktreePruneExpire::1399 When 'git gc' is run, it calls1400 'git worktree prune --expire 3.months.ago'.1401 This config variable can be used to set a different grace1402 period. The value "now" may be used to disable the grace1403 period and prune `$GIT_DIR/worktrees` immediately, or "never"1404 may be used to suppress pruning.14051406gc.reflogExpire::1407gc.<pattern>.reflogExpire::1408 'git reflog expire' removes reflog entries older than1409 this time; defaults to 90 days. The value "now" expires all1410 entries immediately, and "never" suppresses expiration1411 altogether. With "<pattern>" (e.g.1412 "refs/stash") in the middle the setting applies only to1413 the refs that match the <pattern>.14141415gc.reflogExpireUnreachable::1416gc.<pattern>.reflogExpireUnreachable::1417 'git reflog expire' removes reflog entries older than1418 this time and are not reachable from the current tip;1419 defaults to 30 days. The value "now" expires all entries1420 immediately, and "never" suppresses expiration altogether.1421 With "<pattern>" (e.g. "refs/stash")1422 in the middle, the setting applies only to the refs that1423 match the <pattern>.14241425gc.rerereResolved::1426 Records of conflicted merge you resolved earlier are1427 kept for this many days when 'git rerere gc' is run.1428 The default is 60 days. See linkgit:git-rerere[1].14291430gc.rerereUnresolved::1431 Records of conflicted merge you have not resolved are1432 kept for this many days when 'git rerere gc' is run.1433 The default is 15 days. See linkgit:git-rerere[1].14341435gitcvs.commitMsgAnnotation::1436 Append this string to each commit message. Set to empty string1437 to disable this feature. Defaults to "via git-CVS emulator".14381439gitcvs.enabled::1440 Whether the CVS server interface is enabled for this repository.1441 See linkgit:git-cvsserver[1].14421443gitcvs.logFile::1444 Path to a log file where the CVS server interface well... logs1445 various stuff. See linkgit:git-cvsserver[1].14461447gitcvs.usecrlfattr::1448 If true, the server will look up the end-of-line conversion1449 attributes for files to determine the `-k` modes to use. If1450 the attributes force Git to treat a file as text,1451 the `-k` mode will be left blank so CVS clients will1452 treat it as text. If they suppress text conversion, the file1453 will be set with '-kb' mode, which suppresses any newline munging1454 the client might otherwise do. If the attributes do not allow1455 the file type to be determined, then `gitcvs.allBinary` is1456 used. See linkgit:gitattributes[5].14571458gitcvs.allBinary::1459 This is used if `gitcvs.usecrlfattr` does not resolve1460 the correct '-kb' mode to use. If true, all1461 unresolved files are sent to the client in1462 mode '-kb'. This causes the client to treat them1463 as binary files, which suppresses any newline munging it1464 otherwise might do. Alternatively, if it is set to "guess",1465 then the contents of the file are examined to decide if1466 it is binary, similar to `core.autocrlf`.14671468gitcvs.dbName::1469 Database used by git-cvsserver to cache revision information1470 derived from the Git repository. The exact meaning depends on the1471 used database driver, for SQLite (which is the default driver) this1472 is a filename. Supports variable substitution (see1473 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1474 Default: '%Ggitcvs.%m.sqlite'14751476gitcvs.dbDriver::1477 Used Perl DBI driver. You can specify any available driver1478 for this here, but it might not work. git-cvsserver is tested1479 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1480 reported *not* to work with 'DBD::mysql'. Experimental feature.1481 May not contain double colons (`:`). Default: 'SQLite'.1482 See linkgit:git-cvsserver[1].14831484gitcvs.dbUser, gitcvs.dbPass::1485 Database user and password. Only useful if setting `gitcvs.dbDriver`,1486 since SQLite has no concept of database users and/or passwords.1487 'gitcvs.dbUser' supports variable substitution (see1488 linkgit:git-cvsserver[1] for details).14891490gitcvs.dbTableNamePrefix::1491 Database table name prefix. Prepended to the names of any1492 database tables used, allowing a single database to be used1493 for several repositories. Supports variable substitution (see1494 linkgit:git-cvsserver[1] for details). Any non-alphabetic1495 characters will be replaced with underscores.14961497All gitcvs variables except for `gitcvs.usecrlfattr` and1498`gitcvs.allBinary` can also be specified as1499'gitcvs.<access_method>.<varname>' (where 'access_method'1500is one of "ext" and "pserver") to make them apply only for the given1501access method.15021503gitweb.category::1504gitweb.description::1505gitweb.owner::1506gitweb.url::1507 See linkgit:gitweb[1] for description.15081509gitweb.avatar::1510gitweb.blame::1511gitweb.grep::1512gitweb.highlight::1513gitweb.patches::1514gitweb.pickaxe::1515gitweb.remote_heads::1516gitweb.showSizes::1517gitweb.snapshot::1518 See linkgit:gitweb.conf[5] for description.15191520grep.lineNumber::1521 If set to true, enable `-n` option by default.15221523grep.patternType::1524 Set the default matching behavior. Using a value of 'basic', 'extended',1525 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1526 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1527 value 'default' will return to the default matching behavior.15281529grep.extendedRegexp::1530 If set to true, enable `--extended-regexp` option by default. This1531 option is ignored when the `grep.patternType` option is set to a value1532 other than 'default'.15331534grep.threads::1535 Number of grep worker threads to use.1536 See `grep.threads` in linkgit:git-grep[1] for more information.15371538grep.fallbackToNoIndex::1539 If set to true, fall back to git grep --no-index if git grep1540 is executed outside of a git repository. Defaults to false.15411542gpg.program::1543 Use this custom program instead of "`gpg`" found on `$PATH` when1544 making or verifying a PGP signature. The program must support the1545 same command-line interface as GPG, namely, to verify a detached1546 signature, "`gpg --verify $file - <$signature`" is run, and the1547 program is expected to signal a good signature by exiting with1548 code 0, and to generate an ASCII-armored detached signature, the1549 standard input of "`gpg -bsau $key`" is fed with the contents to be1550 signed, and the program is expected to send the result to its1551 standard output.15521553gui.commitMsgWidth::1554 Defines how wide the commit message window is in the1555 linkgit:git-gui[1]. "75" is the default.15561557gui.diffContext::1558 Specifies how many context lines should be used in calls to diff1559 made by the linkgit:git-gui[1]. The default is "5".15601561gui.displayUntracked::1562 Determines if linkgit:git-gui[1] shows untracked files1563 in the file list. The default is "true".15641565gui.encoding::1566 Specifies the default encoding to use for displaying of1567 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1568 It can be overridden by setting the 'encoding' attribute1569 for relevant files (see linkgit:gitattributes[5]).1570 If this option is not set, the tools default to the1571 locale encoding.15721573gui.matchTrackingBranch::1574 Determines if new branches created with linkgit:git-gui[1] should1575 default to tracking remote branches with matching names or1576 not. Default: "false".15771578gui.newBranchTemplate::1579 Is used as suggested name when creating new branches using the1580 linkgit:git-gui[1].15811582gui.pruneDuringFetch::1583 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1584 performing a fetch. The default value is "false".15851586gui.trustmtime::1587 Determines if linkgit:git-gui[1] should trust the file modification1588 timestamp or not. By default the timestamps are not trusted.15891590gui.spellingDictionary::1591 Specifies the dictionary used for spell checking commit messages in1592 the linkgit:git-gui[1]. When set to "none" spell checking is turned1593 off.15941595gui.fastCopyBlame::1596 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1597 location detection. It makes blame significantly faster on huge1598 repositories at the expense of less thorough copy detection.15991600gui.copyBlameThreshold::1601 Specifies the threshold to use in 'git gui blame' original location1602 detection, measured in alphanumeric characters. See the1603 linkgit:git-blame[1] manual for more information on copy detection.16041605gui.blamehistoryctx::1606 Specifies the radius of history context in days to show in1607 linkgit:gitk[1] for the selected commit, when the `Show History1608 Context` menu item is invoked from 'git gui blame'. If this1609 variable is set to zero, the whole history is shown.16101611guitool.<name>.cmd::1612 Specifies the shell command line to execute when the corresponding item1613 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1614 mandatory for every tool. The command is executed from the root of1615 the working directory, and in the environment it receives the name of1616 the tool as `GIT_GUITOOL`, the name of the currently selected file as1617 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1618 the head is detached, 'CUR_BRANCH' is empty).16191620guitool.<name>.needsFile::1621 Run the tool only if a diff is selected in the GUI. It guarantees1622 that 'FILENAME' is not empty.16231624guitool.<name>.noConsole::1625 Run the command silently, without creating a window to display its1626 output.16271628guitool.<name>.noRescan::1629 Don't rescan the working directory for changes after the tool1630 finishes execution.16311632guitool.<name>.confirm::1633 Show a confirmation dialog before actually running the tool.16341635guitool.<name>.argPrompt::1636 Request a string argument from the user, and pass it to the tool1637 through the `ARGS` environment variable. Since requesting an1638 argument implies confirmation, the 'confirm' option has no effect1639 if this is enabled. If the option is set to 'true', 'yes', or '1',1640 the dialog uses a built-in generic prompt; otherwise the exact1641 value of the variable is used.16421643guitool.<name>.revPrompt::1644 Request a single valid revision from the user, and set the1645 `REVISION` environment variable. In other aspects this option1646 is similar to 'argPrompt', and can be used together with it.16471648guitool.<name>.revUnmerged::1649 Show only unmerged branches in the 'revPrompt' subdialog.1650 This is useful for tools similar to merge or rebase, but not1651 for things like checkout or reset.16521653guitool.<name>.title::1654 Specifies the title to use for the prompt dialog. The default1655 is the tool name.16561657guitool.<name>.prompt::1658 Specifies the general prompt string to display at the top of1659 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1660 The default value includes the actual command.16611662help.browser::1663 Specify the browser that will be used to display help in the1664 'web' format. See linkgit:git-help[1].16651666help.format::1667 Override the default help format used by linkgit:git-help[1].1668 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1669 the default. 'web' and 'html' are the same.16701671help.autoCorrect::1672 Automatically correct and execute mistyped commands after1673 waiting for the given number of deciseconds (0.1 sec). If more1674 than one command can be deduced from the entered text, nothing1675 will be executed. If the value of this option is negative,1676 the corrected command will be executed immediately. If the1677 value is 0 - the command will be just shown but not executed.1678 This is the default.16791680help.htmlPath::1681 Specify the path where the HTML documentation resides. File system paths1682 and URLs are supported. HTML pages will be prefixed with this path when1683 help is displayed in the 'web' format. This defaults to the documentation1684 path of your Git installation.16851686http.proxy::1687 Override the HTTP proxy, normally configured using the 'http_proxy',1688 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1689 addition to the syntax understood by curl, it is possible to specify a1690 proxy string with a user name but no password, in which case git will1691 attempt to acquire one in the same way it does for other credentials. See1692 linkgit:gitcredentials[7] for more information. The syntax thus is1693 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1694 on a per-remote basis; see remote.<name>.proxy16951696http.proxyAuthMethod::1697 Set the method with which to authenticate against the HTTP proxy. This1698 only takes effect if the configured proxy string contains a user name part1699 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1700 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1701 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1702 variable. Possible values are:1703+1704--1705* `anyauth` - Automatically pick a suitable authentication method. It is1706 assumed that the proxy answers an unauthenticated request with a 4071707 status code and one or more Proxy-authenticate headers with supported1708 authentication methods. This is the default.1709* `basic` - HTTP Basic authentication1710* `digest` - HTTP Digest authentication; this prevents the password from being1711 transmitted to the proxy in clear text1712* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1713 of `curl(1)`)1714* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1715--17161717http.emptyAuth::1718 Attempt authentication without seeking a username or password. This1719 can be used to attempt GSS-Negotiate authentication without specifying1720 a username in the URL, as libcurl normally requires a username for1721 authentication.17221723http.extraHeader::1724 Pass an additional HTTP header when communicating with a server. If1725 more than one such entry exists, all of them are added as extra1726 headers. To allow overriding the settings inherited from the system1727 config, an empty value will reset the extra headers to the empty list.17281729http.cookieFile::1730 The pathname of a file containing previously stored cookie lines,1731 which should be used1732 in the Git http session, if they match the server. The file format1733 of the file to read cookies from should be plain HTTP headers or1734 the Netscape/Mozilla cookie file format (see `curl(1)`).1735 NOTE that the file specified with http.cookieFile is used only as1736 input unless http.saveCookies is set.17371738http.saveCookies::1739 If set, store cookies received during requests to the file specified by1740 http.cookieFile. Has no effect if http.cookieFile is unset.17411742http.sslVersion::1743 The SSL version to use when negotiating an SSL connection, if you1744 want to force the default. The available and default version1745 depend on whether libcurl was built against NSS or OpenSSL and the1746 particular configuration of the crypto library in use. Internally1747 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1748 documentation for more details on the format of this option and1749 for the ssl version supported. Actually the possible values of1750 this option are:17511752 - sslv21753 - sslv31754 - tlsv11755 - tlsv1.01756 - tlsv1.11757 - tlsv1.217581759+1760Can be overridden by the `GIT_SSL_VERSION` environment variable.1761To force git to use libcurl's default ssl version and ignore any1762explicit http.sslversion option, set `GIT_SSL_VERSION` to the1763empty string.17641765http.sslCipherList::1766 A list of SSL ciphers to use when negotiating an SSL connection.1767 The available ciphers depend on whether libcurl was built against1768 NSS or OpenSSL and the particular configuration of the crypto1769 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1770 option; see the libcurl documentation for more details on the format1771 of this list.1772+1773Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1774To force git to use libcurl's default cipher list and ignore any1775explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1776empty string.17771778http.sslVerify::1779 Whether to verify the SSL certificate when fetching or pushing1780 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1781 variable.17821783http.sslCert::1784 File containing the SSL certificate when fetching or pushing1785 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1786 variable.17871788http.sslKey::1789 File containing the SSL private key when fetching or pushing1790 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1791 variable.17921793http.sslCertPasswordProtected::1794 Enable Git's password prompt for the SSL certificate. Otherwise1795 OpenSSL will prompt the user, possibly many times, if the1796 certificate or private key is encrypted. Can be overridden by the1797 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.17981799http.sslCAInfo::1800 File containing the certificates to verify the peer with when1801 fetching or pushing over HTTPS. Can be overridden by the1802 `GIT_SSL_CAINFO` environment variable.18031804http.sslCAPath::1805 Path containing files with the CA certificates to verify the peer1806 with when fetching or pushing over HTTPS. Can be overridden1807 by the `GIT_SSL_CAPATH` environment variable.18081809http.pinnedpubkey::1810 Public key of the https service. It may either be the filename of1811 a PEM or DER encoded public key file or a string starting with1812 'sha256//' followed by the base64 encoded sha256 hash of the1813 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1814 exit with an error if this option is set but not supported by1815 cURL.18161817http.sslTry::1818 Attempt to use AUTH SSL/TLS and encrypted data transfers1819 when connecting via regular FTP protocol. This might be needed1820 if the FTP server requires it for security reasons or you wish1821 to connect securely whenever remote FTP server supports it.1822 Default is false since it might trigger certificate verification1823 errors on misconfigured servers.18241825http.maxRequests::1826 How many HTTP requests to launch in parallel. Can be overridden1827 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.18281829http.minSessions::1830 The number of curl sessions (counted across slots) to be kept across1831 requests. They will not be ended with curl_easy_cleanup() until1832 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1833 value will be capped at 1. Defaults to 1.18341835http.postBuffer::1836 Maximum size in bytes of the buffer used by smart HTTP1837 transports when POSTing data to the remote system.1838 For requests larger than this buffer size, HTTP/1.1 and1839 Transfer-Encoding: chunked is used to avoid creating a1840 massive pack file locally. Default is 1 MiB, which is1841 sufficient for most requests.18421843http.lowSpeedLimit, http.lowSpeedTime::1844 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1845 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1846 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and1847 `GIT_HTTP_LOW_SPEED_TIME` environment variables.18481849http.noEPSV::1850 A boolean which disables using of EPSV ftp command by curl.1851 This can helpful with some "poor" ftp servers which don't1852 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`1853 environment variable. Default is false (curl will use EPSV).18541855http.userAgent::1856 The HTTP USER_AGENT string presented to an HTTP server. The default1857 value represents the version of the client Git such as git/1.7.1.1858 This option allows you to override this value to a more common value1859 such as Mozilla/4.0. This may be necessary, for instance, if1860 connecting through a firewall that restricts HTTP connections to a set1861 of common USER_AGENT strings (but not including those like git/1.7.1).1862 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.18631864http.<url>.*::1865 Any of the http.* options above can be applied selectively to some URLs.1866 For a config key to match a URL, each element of the config key is1867 compared to that of the URL, in the following order:1868+1869--1870. Scheme (e.g., `https` in `https://example.com/`). This field1871 must match exactly between the config key and the URL.18721873. Host/domain name (e.g., `example.com` in `https://example.com/`).1874 This field must match exactly between the config key and the URL.18751876. Port number (e.g., `8080` in `http://example.com:8080/`).1877 This field must match exactly between the config key and the URL.1878 Omitted port numbers are automatically converted to the correct1879 default for the scheme before matching.18801881. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1882 path field of the config key must match the path field of the URL1883 either exactly or as a prefix of slash-delimited path elements. This means1884 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1885 match on a slash (`/`) boundary. Longer matches take precedence (so a config1886 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1887 key with just path `foo/`).18881889. User name (e.g., `user` in `https://user@example.com/repo.git`). If1890 the config key has a user name it must match the user name in the1891 URL exactly. If the config key does not have a user name, that1892 config key will match a URL with any user name (including none),1893 but at a lower precedence than a config key with a user name.1894--1895+1896The list above is ordered by decreasing precedence; a URL that matches1897a config key's path is preferred to one that matches its user name. For example,1898if the URL is `https://user@example.com/foo/bar` a config key match of1899`https://example.com/foo` will be preferred over a config key match of1900`https://user@example.com`.1901+1902All URLs are normalized before attempting any matching (the password part,1903if embedded in the URL, is always ignored for matching purposes) so that1904equivalent URLs that are simply spelled differently will match properly.1905Environment variable settings always override any matches. The URLs that are1906matched against are those given directly to Git commands. This means any URLs1907visited as a result of a redirection do not participate in matching.19081909i18n.commitEncoding::1910 Character encoding the commit messages are stored in; Git itself1911 does not care per se, but this information is necessary e.g. when1912 importing commits from emails or in the gitk graphical history1913 browser (and possibly at other places in the future or in other1914 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.19151916i18n.logOutputEncoding::1917 Character encoding the commit messages are converted to when1918 running 'git log' and friends.19191920imap::1921 The configuration variables in the 'imap' section are described1922 in linkgit:git-imap-send[1].19231924index.version::1925 Specify the version with which new index files should be1926 initialized. This does not affect existing repositories.19271928init.templateDir::1929 Specify the directory from which templates will be copied.1930 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)19311932instaweb.browser::1933 Specify the program that will be used to browse your working1934 repository in gitweb. See linkgit:git-instaweb[1].19351936instaweb.httpd::1937 The HTTP daemon command-line to start gitweb on your working1938 repository. See linkgit:git-instaweb[1].19391940instaweb.local::1941 If true the web server started by linkgit:git-instaweb[1] will1942 be bound to the local IP (127.0.0.1).19431944instaweb.modulePath::1945 The default module path for linkgit:git-instaweb[1] to use1946 instead of /usr/lib/apache2/modules. Only used if httpd1947 is Apache.19481949instaweb.port::1950 The port number to bind the gitweb httpd to. See1951 linkgit:git-instaweb[1].19521953interactive.singleKey::1954 In interactive commands, allow the user to provide one-letter1955 input with a single key (i.e., without hitting enter).1956 Currently this is used by the `--patch` mode of1957 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1958 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1959 setting is silently ignored if portable keystroke input1960 is not available; requires the Perl module Term::ReadKey.19611962interactive.diffFilter::1963 When an interactive command (such as `git add --patch`) shows1964 a colorized diff, git will pipe the diff through the shell1965 command defined by this configuration variable. The command may1966 mark up the diff further for human consumption, provided that it1967 retains a one-to-one correspondence with the lines in the1968 original diff. Defaults to disabled (no filtering).19691970log.abbrevCommit::1971 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1972 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1973 override this option with `--no-abbrev-commit`.19741975log.date::1976 Set the default date-time mode for the 'log' command.1977 Setting a value for log.date is similar to using 'git log''s1978 `--date` option. See linkgit:git-log[1] for details.19791980log.decorate::1981 Print out the ref names of any commits that are shown by the log1982 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1983 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1984 specified, the full ref name (including prefix) will be printed.1985 If 'auto' is specified, then if the output is going to a terminal,1986 the ref names are shown as if 'short' were given, otherwise no ref1987 names are shown. This is the same as the `--decorate` option1988 of the `git log`.19891990log.follow::1991 If `true`, `git log` will act as if the `--follow` option was used when1992 a single <path> is given. This has the same limitations as `--follow`,1993 i.e. it cannot be used to follow multiple files and does not work well1994 on non-linear history.19951996log.showRoot::1997 If true, the initial commit will be shown as a big creation event.1998 This is equivalent to a diff against an empty tree.1999 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2000 normally hide the root commit will now show it. True by default.20012002log.mailmap::2003 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2004 linkgit:git-whatchanged[1] assume `--use-mailmap`.20052006mailinfo.scissors::2007 If true, makes linkgit:git-mailinfo[1] (and therefore2008 linkgit:git-am[1]) act by default as if the --scissors option2009 was provided on the command-line. When active, this features2010 removes everything from the message body before a scissors2011 line (i.e. consisting mainly of ">8", "8<" and "-").20122013mailmap.file::2014 The location of an augmenting mailmap file. The default2015 mailmap, located in the root of the repository, is loaded2016 first, then the mailmap file pointed to by this variable.2017 The location of the mailmap file may be in a repository2018 subdirectory, or somewhere outside of the repository itself.2019 See linkgit:git-shortlog[1] and linkgit:git-blame[1].20202021mailmap.blob::2022 Like `mailmap.file`, but consider the value as a reference to a2023 blob in the repository. If both `mailmap.file` and2024 `mailmap.blob` are given, both are parsed, with entries from2025 `mailmap.file` taking precedence. In a bare repository, this2026 defaults to `HEAD:.mailmap`. In a non-bare repository, it2027 defaults to empty.20282029man.viewer::2030 Specify the programs that may be used to display help in the2031 'man' format. See linkgit:git-help[1].20322033man.<tool>.cmd::2034 Specify the command to invoke the specified man viewer. The2035 specified command is evaluated in shell with the man page2036 passed as argument. (See linkgit:git-help[1].)20372038man.<tool>.path::2039 Override the path for the given tool that may be used to2040 display help in the 'man' format. See linkgit:git-help[1].20412042include::merge-config.txt[]20432044mergetool.<tool>.path::2045 Override the path for the given tool. This is useful in case2046 your tool is not in the PATH.20472048mergetool.<tool>.cmd::2049 Specify the command to invoke the specified merge tool. The2050 specified command is evaluated in shell with the following2051 variables available: 'BASE' is the name of a temporary file2052 containing the common base of the files to be merged, if available;2053 'LOCAL' is the name of a temporary file containing the contents of2054 the file on the current branch; 'REMOTE' is the name of a temporary2055 file containing the contents of the file from the branch being2056 merged; 'MERGED' contains the name of the file to which the merge2057 tool should write the results of a successful merge.20582059mergetool.<tool>.trustExitCode::2060 For a custom merge command, specify whether the exit code of2061 the merge command can be used to determine whether the merge was2062 successful. If this is not set to true then the merge target file2063 timestamp is checked and the merge assumed to have been successful2064 if the file has been updated, otherwise the user is prompted to2065 indicate the success of the merge.20662067mergetool.meld.hasOutput::2068 Older versions of `meld` do not support the `--output` option.2069 Git will attempt to detect whether `meld` supports `--output`2070 by inspecting the output of `meld --help`. Configuring2071 `mergetool.meld.hasOutput` will make Git skip these checks and2072 use the configured value instead. Setting `mergetool.meld.hasOutput`2073 to `true` tells Git to unconditionally use the `--output` option,2074 and `false` avoids using `--output`.20752076mergetool.keepBackup::2077 After performing a merge, the original file with conflict markers2078 can be saved as a file with a `.orig` extension. If this variable2079 is set to `false` then this file is not preserved. Defaults to2080 `true` (i.e. keep the backup files).20812082mergetool.keepTemporaries::2083 When invoking a custom merge tool, Git uses a set of temporary2084 files to pass to the tool. If the tool returns an error and this2085 variable is set to `true`, then these temporary files will be2086 preserved, otherwise they will be removed after the tool has2087 exited. Defaults to `false`.20882089mergetool.writeToTemp::2090 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2091 conflicting files in the worktree by default. Git will attempt2092 to use a temporary directory for these files when set `true`.2093 Defaults to `false`.20942095mergetool.prompt::2096 Prompt before each invocation of the merge resolution program.20972098notes.mergeStrategy::2099 Which merge strategy to choose by default when resolving notes2100 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2101 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2102 section of linkgit:git-notes[1] for more information on each strategy.21032104notes.<name>.mergeStrategy::2105 Which merge strategy to choose when doing a notes merge into2106 refs/notes/<name>. This overrides the more general2107 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2108 linkgit:git-notes[1] for more information on the available strategies.21092110notes.displayRef::2111 The (fully qualified) refname from which to show notes when2112 showing commit messages. The value of this variable can be set2113 to a glob, in which case notes from all matching refs will be2114 shown. You may also specify this configuration variable2115 several times. A warning will be issued for refs that do not2116 exist, but a glob that does not match any refs is silently2117 ignored.2118+2119This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2120environment variable, which must be a colon separated list of refs or2121globs.2122+2123The effective value of "core.notesRef" (possibly overridden by2124GIT_NOTES_REF) is also implicitly added to the list of refs to be2125displayed.21262127notes.rewrite.<command>::2128 When rewriting commits with <command> (currently `amend` or2129 `rebase`) and this variable is set to `true`, Git2130 automatically copies your notes from the original to the2131 rewritten commit. Defaults to `true`, but see2132 "notes.rewriteRef" below.21332134notes.rewriteMode::2135 When copying notes during a rewrite (see the2136 "notes.rewrite.<command>" option), determines what to do if2137 the target commit already has a note. Must be one of2138 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2139 Defaults to `concatenate`.2140+2141This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2142environment variable.21432144notes.rewriteRef::2145 When copying notes during a rewrite, specifies the (fully2146 qualified) ref whose notes should be copied. The ref may be a2147 glob, in which case notes in all matching refs will be copied.2148 You may also specify this configuration several times.2149+2150Does not have a default value; you must configure this variable to2151enable note rewriting. Set it to `refs/notes/commits` to enable2152rewriting for the default commit notes.2153+2154This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2155environment variable, which must be a colon separated list of refs or2156globs.21572158pack.window::2159 The size of the window used by linkgit:git-pack-objects[1] when no2160 window size is given on the command line. Defaults to 10.21612162pack.depth::2163 The maximum delta depth used by linkgit:git-pack-objects[1] when no2164 maximum depth is given on the command line. Defaults to 50.21652166pack.windowMemory::2167 The maximum size of memory that is consumed by each thread2168 in linkgit:git-pack-objects[1] for pack window memory when2169 no limit is given on the command line. The value can be2170 suffixed with "k", "m", or "g". When left unconfigured (or2171 set explicitly to 0), there will be no limit.21722173pack.compression::2174 An integer -1..9, indicating the compression level for objects2175 in a pack file. -1 is the zlib default. 0 means no2176 compression, and 1..9 are various speed/size tradeoffs, 9 being2177 slowest. If not set, defaults to core.compression. If that is2178 not set, defaults to -1, the zlib default, which is "a default2179 compromise between speed and compression (currently equivalent2180 to level 6)."2181+2182Note that changing the compression level will not automatically recompress2183all existing objects. You can force recompression by passing the -F option2184to linkgit:git-repack[1].21852186pack.deltaCacheSize::2187 The maximum memory in bytes used for caching deltas in2188 linkgit:git-pack-objects[1] before writing them out to a pack.2189 This cache is used to speed up the writing object phase by not2190 having to recompute the final delta result once the best match2191 for all objects is found. Repacking large repositories on machines2192 which are tight with memory might be badly impacted by this though,2193 especially if this cache pushes the system into swapping.2194 A value of 0 means no limit. The smallest size of 1 byte may be2195 used to virtually disable this cache. Defaults to 256 MiB.21962197pack.deltaCacheLimit::2198 The maximum size of a delta, that is cached in2199 linkgit:git-pack-objects[1]. This cache is used to speed up the2200 writing object phase by not having to recompute the final delta2201 result once the best match for all objects is found. Defaults to 1000.22022203pack.threads::2204 Specifies the number of threads to spawn when searching for best2205 delta matches. This requires that linkgit:git-pack-objects[1]2206 be compiled with pthreads otherwise this option is ignored with a2207 warning. This is meant to reduce packing time on multiprocessor2208 machines. The required amount of memory for the delta search window2209 is however multiplied by the number of threads.2210 Specifying 0 will cause Git to auto-detect the number of CPU's2211 and set the number of threads accordingly.22122213pack.indexVersion::2214 Specify the default pack index version. Valid values are 1 for2215 legacy pack index used by Git versions prior to 1.5.2, and 2 for2216 the new pack index with capabilities for packs larger than 4 GB2217 as well as proper protection against the repacking of corrupted2218 packs. Version 2 is the default. Note that version 2 is enforced2219 and this config option ignored whenever the corresponding pack is2220 larger than 2 GB.2221+2222If you have an old Git that does not understand the version 2 `*.idx` file,2223cloning or fetching over a non native protocol (e.g. "http")2224that will copy both `*.pack` file and corresponding `*.idx` file from the2225other side may give you a repository that cannot be accessed with your2226older version of Git. If the `*.pack` file is smaller than 2 GB, however,2227you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2228the `*.idx` file.22292230pack.packSizeLimit::2231 The maximum size of a pack. This setting only affects2232 packing to a file when repacking, i.e. the git:// protocol2233 is unaffected. It can be overridden by the `--max-pack-size`2234 option of linkgit:git-repack[1]. Reaching this limit results2235 in the creation of multiple packfiles; which in turn prevents2236 bitmaps from being created.2237 The minimum size allowed is limited to 1 MiB.2238 The default is unlimited.2239 Common unit suffixes of 'k', 'm', or 'g' are2240 supported.22412242pack.useBitmaps::2243 When true, git will use pack bitmaps (if available) when packing2244 to stdout (e.g., during the server side of a fetch). Defaults to2245 true. You should not generally need to turn this off unless2246 you are debugging pack bitmaps.22472248pack.writeBitmaps (deprecated)::2249 This is a deprecated synonym for `repack.writeBitmaps`.22502251pack.writeBitmapHashCache::2252 When true, git will include a "hash cache" section in the bitmap2253 index (if one is written). This cache can be used to feed git's2254 delta heuristics, potentially leading to better deltas between2255 bitmapped and non-bitmapped objects (e.g., when serving a fetch2256 between an older, bitmapped pack and objects that have been2257 pushed since the last gc). The downside is that it consumes 42258 bytes per object of disk space, and that JGit's bitmap2259 implementation does not understand it, causing it to complain if2260 Git and JGit are used on the same repository. Defaults to false.22612262pager.<cmd>::2263 If the value is boolean, turns on or off pagination of the2264 output of a particular Git subcommand when writing to a tty.2265 Otherwise, turns on pagination for the subcommand using the2266 pager specified by the value of `pager.<cmd>`. If `--paginate`2267 or `--no-pager` is specified on the command line, it takes2268 precedence over this option. To disable pagination for all2269 commands, set `core.pager` or `GIT_PAGER` to `cat`.22702271pretty.<name>::2272 Alias for a --pretty= format string, as specified in2273 linkgit:git-log[1]. Any aliases defined here can be used just2274 as the built-in pretty formats could. For example,2275 running `git config pretty.changelog "format:* %H %s"`2276 would cause the invocation `git log --pretty=changelog`2277 to be equivalent to running `git log "--pretty=format:* %H %s"`.2278 Note that an alias with the same name as a built-in format2279 will be silently ignored.22802281pull.ff::2282 By default, Git does not create an extra merge commit when merging2283 a commit that is a descendant of the current commit. Instead, the2284 tip of the current branch is fast-forwarded. When set to `false`,2285 this variable tells Git to create an extra merge commit in such2286 a case (equivalent to giving the `--no-ff` option from the command2287 line). When set to `only`, only such fast-forward merges are2288 allowed (equivalent to giving the `--ff-only` option from the2289 command line). This setting overrides `merge.ff` when pulling.22902291pull.rebase::2292 When true, rebase branches on top of the fetched branch, instead2293 of merging the default branch from the default remote when "git2294 pull" is run. See "branch.<name>.rebase" for setting this on a2295 per-branch basis.2296+2297When preserve, also pass `--preserve-merges` along to 'git rebase'2298so that locally committed merge commits will not be flattened2299by running 'git pull'.2300+2301When the value is `interactive`, the rebase is run in interactive mode.2302+2303*NOTE*: this is a possibly dangerous operation; do *not* use2304it unless you understand the implications (see linkgit:git-rebase[1]2305for details).23062307pull.octopus::2308 The default merge strategy to use when pulling multiple branches2309 at once.23102311pull.twohead::2312 The default merge strategy to use when pulling a single branch.23132314push.default::2315 Defines the action `git push` should take if no refspec is2316 explicitly given. Different values are well-suited for2317 specific workflows; for instance, in a purely central workflow2318 (i.e. the fetch source is equal to the push destination),2319 `upstream` is probably what you want. Possible values are:2320+2321--23222323* `nothing` - do not push anything (error out) unless a refspec is2324 explicitly given. This is primarily meant for people who want to2325 avoid mistakes by always being explicit.23262327* `current` - push the current branch to update a branch with the same2328 name on the receiving end. Works in both central and non-central2329 workflows.23302331* `upstream` - push the current branch back to the branch whose2332 changes are usually integrated into the current branch (which is2333 called `@{upstream}`). This mode only makes sense if you are2334 pushing to the same repository you would normally pull from2335 (i.e. central workflow).23362337* `simple` - in centralized workflow, work like `upstream` with an2338 added safety to refuse to push if the upstream branch's name is2339 different from the local one.2340+2341When pushing to a remote that is different from the remote you normally2342pull from, work as `current`. This is the safest option and is suited2343for beginners.2344+2345This mode has become the default in Git 2.0.23462347* `matching` - push all branches having the same name on both ends.2348 This makes the repository you are pushing to remember the set of2349 branches that will be pushed out (e.g. if you always push 'maint'2350 and 'master' there and no other branches, the repository you push2351 to will have these two branches, and your local 'maint' and2352 'master' will be pushed there).2353+2354To use this mode effectively, you have to make sure _all_ the2355branches you would push out are ready to be pushed out before2356running 'git push', as the whole point of this mode is to allow you2357to push all of the branches in one go. If you usually finish work2358on only one branch and push out the result, while other branches are2359unfinished, this mode is not for you. Also this mode is not2360suitable for pushing into a shared central repository, as other2361people may add new branches there, or update the tip of existing2362branches outside your control.2363+2364This used to be the default, but not since Git 2.0 (`simple` is the2365new default).23662367--23682369push.followTags::2370 If set to true enable `--follow-tags` option by default. You2371 may override this configuration at time of push by specifying2372 `--no-follow-tags`.23732374push.gpgSign::2375 May be set to a boolean value, or the string 'if-asked'. A true2376 value causes all pushes to be GPG signed, as if `--signed` is2377 passed to linkgit:git-push[1]. The string 'if-asked' causes2378 pushes to be signed if the server supports it, as if2379 `--signed=if-asked` is passed to 'git push'. A false value may2380 override a value from a lower-priority config file. An explicit2381 command-line flag always overrides this config option.23822383push.recurseSubmodules::2384 Make sure all submodule commits used by the revisions to be pushed2385 are available on a remote-tracking branch. If the value is 'check'2386 then Git will verify that all submodule commits that changed in the2387 revisions to be pushed are available on at least one remote of the2388 submodule. If any commits are missing, the push will be aborted and2389 exit with non-zero status. If the value is 'on-demand' then all2390 submodules that changed in the revisions to be pushed will be2391 pushed. If on-demand was not able to push all necessary revisions2392 it will also be aborted and exit with non-zero status. If the value2393 is 'no' then default behavior of ignoring submodules when pushing2394 is retained. You may override this configuration at time of push by2395 specifying '--recurse-submodules=check|on-demand|no'.23962397rebase.stat::2398 Whether to show a diffstat of what changed upstream since the last2399 rebase. False by default.24002401rebase.autoSquash::2402 If set to true enable `--autosquash` option by default.24032404rebase.autoStash::2405 When set to true, automatically create a temporary stash2406 before the operation begins, and apply it after the operation2407 ends. This means that you can run rebase on a dirty worktree.2408 However, use with care: the final stash application after a2409 successful rebase might result in non-trivial conflicts.2410 Defaults to false.24112412rebase.missingCommitsCheck::2413 If set to "warn", git rebase -i will print a warning if some2414 commits are removed (e.g. a line was deleted), however the2415 rebase will still proceed. If set to "error", it will print2416 the previous warning and stop the rebase, 'git rebase2417 --edit-todo' can then be used to correct the error. If set to2418 "ignore", no checking is done.2419 To drop a commit without warning or error, use the `drop`2420 command in the todo-list.2421 Defaults to "ignore".24222423rebase.instructionFormat2424 A format string, as specified in linkgit:git-log[1], to be used for2425 the instruction list during an interactive rebase. The format will automatically2426 have the long commit hash prepended to the format.24272428receive.advertiseAtomic::2429 By default, git-receive-pack will advertise the atomic push2430 capability to its clients. If you don't want to advertise this2431 capability, set this variable to false.24322433receive.advertisePushOptions::2434 By default, git-receive-pack will advertise the push options2435 capability to its clients. If you don't want to advertise this2436 capability, set this variable to false.24372438receive.autogc::2439 By default, git-receive-pack will run "git-gc --auto" after2440 receiving data from git-push and updating refs. You can stop2441 it by setting this variable to false.24422443receive.certNonceSeed::2444 By setting this variable to a string, `git receive-pack`2445 will accept a `git push --signed` and verifies it by using2446 a "nonce" protected by HMAC using this string as a secret2447 key.24482449receive.certNonceSlop::2450 When a `git push --signed` sent a push certificate with a2451 "nonce" that was issued by a receive-pack serving the same2452 repository within this many seconds, export the "nonce"2453 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2454 hooks (instead of what the receive-pack asked the sending2455 side to include). This may allow writing checks in2456 `pre-receive` and `post-receive` a bit easier. Instead of2457 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2458 that records by how many seconds the nonce is stale to2459 decide if they want to accept the certificate, they only2460 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.24612462receive.fsckObjects::2463 If it is set to true, git-receive-pack will check all received2464 objects. It will abort in the case of a malformed object or a2465 broken link. The result of an abort are only dangling objects.2466 Defaults to false. If not set, the value of `transfer.fsckObjects`2467 is used instead.24682469receive.fsck.<msg-id>::2470 When `receive.fsckObjects` is set to true, errors can be switched2471 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2472 setting where the `<msg-id>` is the fsck message ID and the value2473 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2474 the error/warning with the message ID, e.g. "missingEmail: invalid2475 author/committer line - missing email" means that setting2476 `receive.fsck.missingEmail = ignore` will hide that issue.2477+2478This feature is intended to support working with legacy repositories2479which would not pass pushing when `receive.fsckObjects = true`, allowing2480the host to accept repositories with certain known issues but still catch2481other issues.24822483receive.fsck.skipList::2484 The path to a sorted list of object names (i.e. one SHA-1 per2485 line) that are known to be broken in a non-fatal way and should2486 be ignored. This feature is useful when an established project2487 should be accepted despite early commits containing errors that2488 can be safely ignored such as invalid committer email addresses.2489 Note: corrupt objects cannot be skipped with this setting.24902491receive.keepAlive::2492 After receiving the pack from the client, `receive-pack` may2493 produce no output (if `--quiet` was specified) while processing2494 the pack, causing some networks to drop the TCP connection.2495 With this option set, if `receive-pack` does not transmit2496 any data in this phase for `receive.keepAlive` seconds, it will2497 send a short keepalive packet. The default is 5 seconds; set2498 to 0 to disable keepalives entirely.24992500receive.unpackLimit::2501 If the number of objects received in a push is below this2502 limit then the objects will be unpacked into loose object2503 files. However if the number of received objects equals or2504 exceeds this limit then the received pack will be stored as2505 a pack, after adding any missing delta bases. Storing the2506 pack from a push can make the push operation complete faster,2507 especially on slow filesystems. If not set, the value of2508 `transfer.unpackLimit` is used instead.25092510receive.denyDeletes::2511 If set to true, git-receive-pack will deny a ref update that deletes2512 the ref. Use this to prevent such a ref deletion via a push.25132514receive.denyDeleteCurrent::2515 If set to true, git-receive-pack will deny a ref update that2516 deletes the currently checked out branch of a non-bare repository.25172518receive.denyCurrentBranch::2519 If set to true or "refuse", git-receive-pack will deny a ref update2520 to the currently checked out branch of a non-bare repository.2521 Such a push is potentially dangerous because it brings the HEAD2522 out of sync with the index and working tree. If set to "warn",2523 print a warning of such a push to stderr, but allow the push to2524 proceed. If set to false or "ignore", allow such pushes with no2525 message. Defaults to "refuse".2526+2527Another option is "updateInstead" which will update the working2528tree if pushing into the current branch. This option is2529intended for synchronizing working directories when one side is not easily2530accessible via interactive ssh (e.g. a live web site, hence the requirement2531that the working directory be clean). This mode also comes in handy when2532developing inside a VM to test and fix code on different Operating Systems.2533+2534By default, "updateInstead" will refuse the push if the working tree or2535the index have any difference from the HEAD, but the `push-to-checkout`2536hook can be used to customize this. See linkgit:githooks[5].25372538receive.denyNonFastForwards::2539 If set to true, git-receive-pack will deny a ref update which is2540 not a fast-forward. Use this to prevent such an update via a push,2541 even if that push is forced. This configuration variable is2542 set when initializing a shared repository.25432544receive.hideRefs::2545 This variable is the same as `transfer.hideRefs`, but applies2546 only to `receive-pack` (and so affects pushes, but not fetches).2547 An attempt to update or delete a hidden ref by `git push` is2548 rejected.25492550receive.updateServerInfo::2551 If set to true, git-receive-pack will run git-update-server-info2552 after receiving data from git-push and updating refs.25532554receive.shallowUpdate::2555 If set to true, .git/shallow can be updated when new refs2556 require new shallow roots. Otherwise those refs are rejected.25572558remote.pushDefault::2559 The remote to push to by default. Overrides2560 `branch.<name>.remote` for all branches, and is overridden by2561 `branch.<name>.pushRemote` for specific branches.25622563remote.<name>.url::2564 The URL of a remote repository. See linkgit:git-fetch[1] or2565 linkgit:git-push[1].25662567remote.<name>.pushurl::2568 The push URL of a remote repository. See linkgit:git-push[1].25692570remote.<name>.proxy::2571 For remotes that require curl (http, https and ftp), the URL to2572 the proxy to use for that remote. Set to the empty string to2573 disable proxying for that remote.25742575remote.<name>.proxyAuthMethod::2576 For remotes that require curl (http, https and ftp), the method to use for2577 authenticating against the proxy in use (probably set in2578 `remote.<name>.proxy`). See `http.proxyAuthMethod`.25792580remote.<name>.fetch::2581 The default set of "refspec" for linkgit:git-fetch[1]. See2582 linkgit:git-fetch[1].25832584remote.<name>.push::2585 The default set of "refspec" for linkgit:git-push[1]. See2586 linkgit:git-push[1].25872588remote.<name>.mirror::2589 If true, pushing to this remote will automatically behave2590 as if the `--mirror` option was given on the command line.25912592remote.<name>.skipDefaultUpdate::2593 If true, this remote will be skipped by default when updating2594 using linkgit:git-fetch[1] or the `update` subcommand of2595 linkgit:git-remote[1].25962597remote.<name>.skipFetchAll::2598 If true, this remote will be skipped by default when updating2599 using linkgit:git-fetch[1] or the `update` subcommand of2600 linkgit:git-remote[1].26012602remote.<name>.receivepack::2603 The default program to execute on the remote side when pushing. See2604 option --receive-pack of linkgit:git-push[1].26052606remote.<name>.uploadpack::2607 The default program to execute on the remote side when fetching. See2608 option --upload-pack of linkgit:git-fetch-pack[1].26092610remote.<name>.tagOpt::2611 Setting this value to --no-tags disables automatic tag following when2612 fetching from remote <name>. Setting it to --tags will fetch every2613 tag from remote <name>, even if they are not reachable from remote2614 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2615 override this setting. See options --tags and --no-tags of2616 linkgit:git-fetch[1].26172618remote.<name>.vcs::2619 Setting this to a value <vcs> will cause Git to interact with2620 the remote with the git-remote-<vcs> helper.26212622remote.<name>.prune::2623 When set to true, fetching from this remote by default will also2624 remove any remote-tracking references that no longer exist on the2625 remote (as if the `--prune` option was given on the command line).2626 Overrides `fetch.prune` settings, if any.26272628remotes.<group>::2629 The list of remotes which are fetched by "git remote update2630 <group>". See linkgit:git-remote[1].26312632repack.useDeltaBaseOffset::2633 By default, linkgit:git-repack[1] creates packs that use2634 delta-base offset. If you need to share your repository with2635 Git older than version 1.4.4, either directly or via a dumb2636 protocol such as http, then you need to set this option to2637 "false" and repack. Access from old Git versions over the2638 native protocol are unaffected by this option.26392640repack.packKeptObjects::2641 If set to true, makes `git repack` act as if2642 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2643 details. Defaults to `false` normally, but `true` if a bitmap2644 index is being written (either via `--write-bitmap-index` or2645 `repack.writeBitmaps`).26462647repack.writeBitmaps::2648 When true, git will write a bitmap index when packing all2649 objects to disk (e.g., when `git repack -a` is run). This2650 index can speed up the "counting objects" phase of subsequent2651 packs created for clones and fetches, at the cost of some disk2652 space and extra time spent on the initial repack. This has2653 no effect if multiple packfiles are created.2654 Defaults to false.26552656rerere.autoUpdate::2657 When set to true, `git-rerere` updates the index with the2658 resulting contents after it cleanly resolves conflicts using2659 previously recorded resolution. Defaults to false.26602661rerere.enabled::2662 Activate recording of resolved conflicts, so that identical2663 conflict hunks can be resolved automatically, should they be2664 encountered again. By default, linkgit:git-rerere[1] is2665 enabled if there is an `rr-cache` directory under the2666 `$GIT_DIR`, e.g. if "rerere" was previously used in the2667 repository.26682669sendemail.identity::2670 A configuration identity. When given, causes values in the2671 'sendemail.<identity>' subsection to take precedence over2672 values in the 'sendemail' section. The default identity is2673 the value of `sendemail.identity`.26742675sendemail.smtpEncryption::2676 See linkgit:git-send-email[1] for description. Note that this2677 setting is not subject to the 'identity' mechanism.26782679sendemail.smtpssl (deprecated)::2680 Deprecated alias for 'sendemail.smtpEncryption = ssl'.26812682sendemail.smtpsslcertpath::2683 Path to ca-certificates (either a directory or a single file).2684 Set it to an empty string to disable certificate verification.26852686sendemail.<identity>.*::2687 Identity-specific versions of the 'sendemail.*' parameters2688 found below, taking precedence over those when the this2689 identity is selected, through command-line or2690 `sendemail.identity`.26912692sendemail.aliasesFile::2693sendemail.aliasFileType::2694sendemail.annotate::2695sendemail.bcc::2696sendemail.cc::2697sendemail.ccCmd::2698sendemail.chainReplyTo::2699sendemail.confirm::2700sendemail.envelopeSender::2701sendemail.from::2702sendemail.multiEdit::2703sendemail.signedoffbycc::2704sendemail.smtpPass::2705sendemail.suppresscc::2706sendemail.suppressFrom::2707sendemail.to::2708sendemail.smtpDomain::2709sendemail.smtpServer::2710sendemail.smtpServerPort::2711sendemail.smtpServerOption::2712sendemail.smtpUser::2713sendemail.thread::2714sendemail.transferEncoding::2715sendemail.validate::2716sendemail.xmailer::2717 See linkgit:git-send-email[1] for description.27182719sendemail.signedoffcc (deprecated)::2720 Deprecated alias for `sendemail.signedoffbycc`.27212722showbranch.default::2723 The default set of branches for linkgit:git-show-branch[1].2724 See linkgit:git-show-branch[1].27252726status.relativePaths::2727 By default, linkgit:git-status[1] shows paths relative to the2728 current directory. Setting this variable to `false` shows paths2729 relative to the repository root (this was the default for Git2730 prior to v1.5.4).27312732status.short::2733 Set to true to enable --short by default in linkgit:git-status[1].2734 The option --no-short takes precedence over this variable.27352736status.branch::2737 Set to true to enable --branch by default in linkgit:git-status[1].2738 The option --no-branch takes precedence over this variable.27392740status.displayCommentPrefix::2741 If set to true, linkgit:git-status[1] will insert a comment2742 prefix before each output line (starting with2743 `core.commentChar`, i.e. `#` by default). This was the2744 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2745 Defaults to false.27462747status.showUntrackedFiles::2748 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2749 files which are not currently tracked by Git. Directories which2750 contain only untracked files, are shown with the directory name2751 only. Showing untracked files means that Git needs to lstat() all2752 the files in the whole repository, which might be slow on some2753 systems. So, this variable controls how the commands displays2754 the untracked files. Possible values are:2755+2756--2757* `no` - Show no untracked files.2758* `normal` - Show untracked files and directories.2759* `all` - Show also individual files in untracked directories.2760--2761+2762If this variable is not specified, it defaults to 'normal'.2763This variable can be overridden with the -u|--untracked-files option2764of linkgit:git-status[1] and linkgit:git-commit[1].27652766status.submoduleSummary::2767 Defaults to false.2768 If this is set to a non zero number or true (identical to -1 or an2769 unlimited number), the submodule summary will be enabled and a2770 summary of commits for modified submodules will be shown (see2771 --summary-limit option of linkgit:git-submodule[1]). Please note2772 that the summary output command will be suppressed for all2773 submodules when `diff.ignoreSubmodules` is set to 'all' or only2774 for those submodules where `submodule.<name>.ignore=all`. The only2775 exception to that rule is that status and commit will show staged2776 submodule changes. To2777 also view the summary for ignored submodules you can either use2778 the --ignore-submodules=dirty command-line option or the 'git2779 submodule summary' command, which shows a similar output but does2780 not honor these settings.27812782stash.showPatch::2783 If this is set to true, the `git stash show` command without an2784 option will show the stash in patch form. Defaults to false.2785 See description of 'show' command in linkgit:git-stash[1].27862787stash.showStat::2788 If this is set to true, the `git stash show` command without an2789 option will show diffstat of the stash. Defaults to true.2790 See description of 'show' command in linkgit:git-stash[1].27912792submodule.<name>.path::2793submodule.<name>.url::2794 The path within this project and URL for a submodule. These2795 variables are initially populated by 'git submodule init'. See2796 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2797 details.27982799submodule.<name>.update::2800 The default update procedure for a submodule. This variable2801 is populated by `git submodule init` from the2802 linkgit:gitmodules[5] file. See description of 'update'2803 command in linkgit:git-submodule[1].28042805submodule.<name>.branch::2806 The remote branch name for a submodule, used by `git submodule2807 update --remote`. Set this option to override the value found in2808 the `.gitmodules` file. See linkgit:git-submodule[1] and2809 linkgit:gitmodules[5] for details.28102811submodule.<name>.fetchRecurseSubmodules::2812 This option can be used to control recursive fetching of this2813 submodule. It can be overridden by using the --[no-]recurse-submodules2814 command-line option to "git fetch" and "git pull".2815 This setting will override that from in the linkgit:gitmodules[5]2816 file.28172818submodule.<name>.ignore::2819 Defines under what circumstances "git status" and the diff family show2820 a submodule as modified. When set to "all", it will never be considered2821 modified (but it will nonetheless show up in the output of status and2822 commit when it has been staged), "dirty" will ignore all changes2823 to the submodules work tree and2824 takes only differences between the HEAD of the submodule and the commit2825 recorded in the superproject into account. "untracked" will additionally2826 let submodules with modified tracked files in their work tree show up.2827 Using "none" (the default when this option is not set) also shows2828 submodules that have untracked files in their work tree as changed.2829 This setting overrides any setting made in .gitmodules for this submodule,2830 both settings can be overridden on the command line by using the2831 "--ignore-submodules" option. The 'git submodule' commands are not2832 affected by this setting.28332834submodule.fetchJobs::2835 Specifies how many submodules are fetched/cloned at the same time.2836 A positive integer allows up to that number of submodules fetched2837 in parallel. A value of 0 will give some reasonable default.2838 If unset, it defaults to 1.28392840tag.forceSignAnnotated::2841 A boolean to specify whether annotated tags created should be GPG signed.2842 If `--annotate` is specified on the command line, it takes2843 precedence over this option.28442845tag.sort::2846 This variable controls the sort ordering of tags when displayed by2847 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2848 value of this variable will be used as the default.28492850tar.umask::2851 This variable can be used to restrict the permission bits of2852 tar archive entries. The default is 0002, which turns off the2853 world write bit. The special value "user" indicates that the2854 archiving user's umask will be used instead. See umask(2) and2855 linkgit:git-archive[1].28562857transfer.fsckObjects::2858 When `fetch.fsckObjects` or `receive.fsckObjects` are2859 not set, the value of this variable is used instead.2860 Defaults to false.28612862transfer.hideRefs::2863 String(s) `receive-pack` and `upload-pack` use to decide which2864 refs to omit from their initial advertisements. Use more than2865 one definition to specify multiple prefix strings. A ref that is2866 under the hierarchies listed in the value of this variable is2867 excluded, and is hidden when responding to `git push` or `git2868 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2869 program-specific versions of this config.2870+2871You may also include a `!` in front of the ref name to negate the entry,2872explicitly exposing it, even if an earlier entry marked it as hidden.2873If you have multiple hideRefs values, later entries override earlier ones2874(and entries in more-specific config files override less-specific ones).2875+2876If a namespace is in use, the namespace prefix is stripped from each2877reference before it is matched against `transfer.hiderefs` patterns.2878For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2879the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2880is omitted from the advertisements but `refs/heads/master` and2881`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2882"have" lines. In order to match refs before stripping, add a `^` in front of2883the ref name. If you combine `!` and `^`, `!` must be specified first.28842885transfer.unpackLimit::2886 When `fetch.unpackLimit` or `receive.unpackLimit` are2887 not set, the value of this variable is used instead.2888 The default value is 100.28892890uploadarchive.allowUnreachable::2891 If true, allow clients to use `git archive --remote` to request2892 any tree, whether reachable from the ref tips or not. See the2893 discussion in the `SECURITY` section of2894 linkgit:git-upload-archive[1] for more details. Defaults to2895 `false`.28962897uploadpack.hideRefs::2898 This variable is the same as `transfer.hideRefs`, but applies2899 only to `upload-pack` (and so affects only fetches, not pushes).2900 An attempt to fetch a hidden ref by `git fetch` will fail. See2901 also `uploadpack.allowTipSHA1InWant`.29022903uploadpack.allowTipSHA1InWant::2904 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2905 to accept a fetch request that asks for an object at the tip2906 of a hidden ref (by default, such a request is rejected).2907 see also `uploadpack.hideRefs`.29082909uploadpack.allowReachableSHA1InWant::2910 Allow `upload-pack` to accept a fetch request that asks for an2911 object that is reachable from any ref tip. However, note that2912 calculating object reachability is computationally expensive.2913 Defaults to `false`.29142915uploadpack.keepAlive::2916 When `upload-pack` has started `pack-objects`, there may be a2917 quiet period while `pack-objects` prepares the pack. Normally2918 it would output progress information, but if `--quiet` was used2919 for the fetch, `pack-objects` will output nothing at all until2920 the pack data begins. Some clients and networks may consider2921 the server to be hung and give up. Setting this option instructs2922 `upload-pack` to send an empty keepalive packet every2923 `uploadpack.keepAlive` seconds. Setting this option to 02924 disables keepalive packets entirely. The default is 5 seconds.29252926uploadpack.packObjectsHook::2927 If this option is set, when `upload-pack` would run2928 `git pack-objects` to create a packfile for a client, it will2929 run this shell command instead. The `pack-objects` command and2930 arguments it _would_ have run (including the `git pack-objects`2931 at the beginning) are appended to the shell command. The stdin2932 and stdout of the hook are treated as if `pack-objects` itself2933 was run. I.e., `upload-pack` will feed input intended for2934 `pack-objects` to the hook, and expects a completed packfile on2935 stdout.2936+2937Note that this configuration variable is ignored if it is seen in the2938repository-level config (this is a safety measure against fetching from2939untrusted repositories).29402941url.<base>.insteadOf::2942 Any URL that starts with this value will be rewritten to2943 start, instead, with <base>. In cases where some site serves a2944 large number of repositories, and serves them with multiple2945 access methods, and some users need to use different access2946 methods, this feature allows people to specify any of the2947 equivalent URLs and have Git automatically rewrite the URL to2948 the best alternative for the particular user, even for a2949 never-before-seen repository on the site. When more than one2950 insteadOf strings match a given URL, the longest match is used.29512952url.<base>.pushInsteadOf::2953 Any URL that starts with this value will not be pushed to;2954 instead, it will be rewritten to start with <base>, and the2955 resulting URL will be pushed to. In cases where some site serves2956 a large number of repositories, and serves them with multiple2957 access methods, some of which do not allow push, this feature2958 allows people to specify a pull-only URL and have Git2959 automatically use an appropriate URL to push, even for a2960 never-before-seen repository on the site. When more than one2961 pushInsteadOf strings match a given URL, the longest match is2962 used. If a remote has an explicit pushurl, Git will ignore this2963 setting for that remote.29642965user.email::2966 Your email address to be recorded in any newly created commits.2967 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and2968 `EMAIL` environment variables. See linkgit:git-commit-tree[1].29692970user.name::2971 Your full name to be recorded in any newly created commits.2972 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`2973 environment variables. See linkgit:git-commit-tree[1].29742975user.useConfigOnly::2976 Instruct Git to avoid trying to guess defaults for `user.email`2977 and `user.name`, and instead retrieve the values only from the2978 configuration. For example, if you have multiple email addresses2979 and would like to use a different one for each repository, then2980 with this configuration option set to `true` in the global config2981 along with a name, Git will prompt you to set up an email before2982 making new commits in a newly cloned repository.2983 Defaults to `false`.29842985user.signingKey::2986 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2987 key you want it to automatically when creating a signed tag or2988 commit, you can override the default selection with this variable.2989 This option is passed unchanged to gpg's --local-user parameter,2990 so you may specify a key using any method that gpg supports.29912992versionsort.prereleaseSuffix::2993 When version sort is used in linkgit:git-tag[1], prerelease2994 tags (e.g. "1.0-rc1") may appear after the main release2995 "1.0". By specifying the suffix "-rc" in this variable,2996 "1.0-rc1" will appear before "1.0".2997+2998This variable can be specified multiple times, once per suffix. The2999order of suffixes in the config file determines the sorting order3000(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX3001is sorted before 1.0-rcXX). The sorting order between different3002suffixes is undefined if they are in multiple config files.30033004web.browser::3005 Specify a web browser that may be used by some commands.3006 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3007 may use it.