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. If unset, then the 957 value of `color.ui` is used (`auto` by default). 958 959color.branch.<slot>:: 960 Use customized color for branch coloration. `<slot>` is one of 961 `current` (the current branch), `local` (a local branch), 962 `remote` (a remote-tracking branch in refs/remotes/), 963 `upstream` (upstream tracking branch), `plain` (other 964 refs). 965 966color.diff:: 967 Whether to use ANSI escape sequences to add color to patches. 968 If this is set to `always`, linkgit:git-diff[1], 969 linkgit:git-log[1], and linkgit:git-show[1] will use color 970 for all patches. If it is set to `true` or `auto`, those 971 commands will only use color when output is to the terminal. 972 If unset, then the value of `color.ui` is used (`auto` by 973 default). 974+ 975This does not affect linkgit:git-format-patch[1] or the 976'git-diff-{asterisk}' plumbing commands. Can be overridden on the 977command line with the `--color[=<when>]` option. 978 979color.diff.<slot>:: 980 Use customized color for diff colorization. `<slot>` specifies 981 which part of the patch to use the specified color, and is one 982 of `context` (context text - `plain` is a historical synonym), 983 `meta` (metainformation), `frag` 984 (hunk header), 'func' (function in hunk header), `old` (removed lines), 985 `new` (added lines), `commit` (commit headers), or `whitespace` 986 (highlighting whitespace errors). 987 988color.decorate.<slot>:: 989 Use customized color for 'git log --decorate' output. `<slot>` is one 990 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 991 branches, remote-tracking branches, tags, stash and HEAD, respectively. 992 993color.grep:: 994 When set to `always`, always highlight matches. When `false` (or 995 `never`), never. When set to `true` or `auto`, use color only 996 when the output is written to the terminal. If unset, then the 997 value of `color.ui` is used (`auto` by default). 998 999color.grep.<slot>::1000 Use customized color for grep colorization. `<slot>` specifies which1001 part of the line to use the specified color, and is one of1002+1003--1004`context`;;1005 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1006`filename`;;1007 filename prefix (when not using `-h`)1008`function`;;1009 function name lines (when using `-p`)1010`linenumber`;;1011 line number prefix (when using `-n`)1012`match`;;1013 matching text (same as setting `matchContext` and `matchSelected`)1014`matchContext`;;1015 matching text in context lines1016`matchSelected`;;1017 matching text in selected lines1018`selected`;;1019 non-matching text in selected lines1020`separator`;;1021 separators between fields on a line (`:`, `-`, and `=`)1022 and between hunks (`--`)1023--10241025color.interactive::1026 When set to `always`, always use colors for interactive prompts1027 and displays (such as those used by "git-add --interactive" and1028 "git-clean --interactive"). When false (or `never`), never.1029 When set to `true` or `auto`, use colors only when the output is1030 to the terminal. If unset, then the value of `color.ui` is1031 used (`auto` by default).10321033color.interactive.<slot>::1034 Use customized color for 'git add --interactive' and 'git clean1035 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1036 or `error`, for four distinct types of normal output from1037 interactive commands.10381039color.pager::1040 A boolean to enable/disable colored output when the pager is in1041 use (default is true).10421043color.showBranch::1044 A boolean to enable/disable color in the output of1045 linkgit:git-show-branch[1]. May be set to `always`,1046 `false` (or `never`) or `auto` (or `true`), in which case colors are used1047 only when the output is to a terminal. If unset, then the1048 value of `color.ui` is used (`auto` by default).10491050color.status::1051 A boolean to enable/disable color in the output of1052 linkgit:git-status[1]. May be set to `always`,1053 `false` (or `never`) or `auto` (or `true`), in which case colors are used1054 only when the output is to a terminal. If unset, then the1055 value of `color.ui` is used (`auto` by default).10561057color.status.<slot>::1058 Use customized color for status colorization. `<slot>` is1059 one of `header` (the header text of the status message),1060 `added` or `updated` (files which are added but not committed),1061 `changed` (files which are changed but not added in the index),1062 `untracked` (files which are not tracked by Git),1063 `branch` (the current branch),1064 `nobranch` (the color the 'no branch' warning is shown in, defaulting1065 to red), or1066 `unmerged` (files which have unmerged changes).10671068color.ui::1069 This variable determines the default value for variables such1070 as `color.diff` and `color.grep` that control the use of color1071 per command family. Its scope will expand as more commands learn1072 configuration to set a default for the `--color` option. Set it1073 to `false` or `never` if you prefer Git commands not to use1074 color unless enabled explicitly with some other configuration1075 or the `--color` option. Set it to `always` if you want all1076 output not intended for machine consumption to use color, to1077 `true` or `auto` (this is the default since Git 1.8.4) if you1078 want such output to use color when written to the terminal.10791080column.ui::1081 Specify whether supported commands should output in columns.1082 This variable consists of a list of tokens separated by spaces1083 or commas:1084+1085These options control when the feature should be enabled1086(defaults to 'never'):1087+1088--1089`always`;;1090 always show in columns1091`never`;;1092 never show in columns1093`auto`;;1094 show in columns if the output is to the terminal1095--1096+1097These options control layout (defaults to 'column'). Setting any1098of these implies 'always' if none of 'always', 'never', or 'auto' are1099specified.1100+1101--1102`column`;;1103 fill columns before rows1104`row`;;1105 fill rows before columns1106`plain`;;1107 show in one column1108--1109+1110Finally, these options can be combined with a layout option (defaults1111to 'nodense'):1112+1113--1114`dense`;;1115 make unequal size columns to utilize more space1116`nodense`;;1117 make equal size columns1118--11191120column.branch::1121 Specify whether to output branch listing in `git branch` in columns.1122 See `column.ui` for details.11231124column.clean::1125 Specify the layout when list items in `git clean -i`, which always1126 shows files and directories in columns. See `column.ui` for details.11271128column.status::1129 Specify whether to output untracked files in `git status` in columns.1130 See `column.ui` for details.11311132column.tag::1133 Specify whether to output tag listing in `git tag` in columns.1134 See `column.ui` for details.11351136commit.cleanup::1137 This setting overrides the default of the `--cleanup` option in1138 `git commit`. See linkgit:git-commit[1] for details. Changing the1139 default can be useful when you always want to keep lines that begin1140 with comment character `#` in your log message, in which case you1141 would do `git config commit.cleanup whitespace` (note that you will1142 have to remove the help lines that begin with `#` in the commit log1143 template yourself, if you do this).11441145commit.gpgSign::11461147 A boolean to specify whether all commits should be GPG signed.1148 Use of this option when doing operations such as rebase can1149 result in a large number of commits being signed. It may be1150 convenient to use an agent to avoid typing your GPG passphrase1151 several times.11521153commit.status::1154 A boolean to enable/disable inclusion of status information in the1155 commit message template when using an editor to prepare the commit1156 message. Defaults to true.11571158commit.template::1159 Specify the pathname of a file to use as the template for1160 new commit messages.11611162commit.verbose::1163 A boolean or int to specify the level of verbose with `git commit`.1164 See linkgit:git-commit[1].11651166credential.helper::1167 Specify an external helper to be called when a username or1168 password credential is needed; the helper may consult external1169 storage to avoid prompting the user for the credentials. Note1170 that multiple helpers may be defined. See linkgit:gitcredentials[7]1171 for details.11721173credential.useHttpPath::1174 When acquiring credentials, consider the "path" component of an http1175 or https URL to be important. Defaults to false. See1176 linkgit:gitcredentials[7] for more information.11771178credential.username::1179 If no username is set for a network authentication, use this username1180 by default. See credential.<context>.* below, and1181 linkgit:gitcredentials[7].11821183credential.<url>.*::1184 Any of the credential.* options above can be applied selectively to1185 some credentials. For example "credential.https://example.com.username"1186 would set the default username only for https connections to1187 example.com. See linkgit:gitcredentials[7] for details on how URLs are1188 matched.11891190credentialCache.ignoreSIGHUP::1191 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11921193include::diff-config.txt[]11941195difftool.<tool>.path::1196 Override the path for the given tool. This is useful in case1197 your tool is not in the PATH.11981199difftool.<tool>.cmd::1200 Specify the command to invoke the specified diff tool.1201 The specified command is evaluated in shell with the following1202 variables available: 'LOCAL' is set to the name of the temporary1203 file containing the contents of the diff pre-image and 'REMOTE'1204 is set to the name of the temporary file containing the contents1205 of the diff post-image.12061207difftool.prompt::1208 Prompt before each invocation of the diff tool.12091210fastimport.unpackLimit::1211 If the number of objects imported by linkgit:git-fast-import[1]1212 is below this limit, then the objects will be unpacked into1213 loose object files. However if the number of imported objects1214 equals or exceeds this limit then the pack will be stored as a1215 pack. Storing the pack from a fast-import can make the import1216 operation complete faster, especially on slow filesystems. If1217 not set, the value of `transfer.unpackLimit` is used instead.12181219fetch.recurseSubmodules::1220 This option can be either set to a boolean value or to 'on-demand'.1221 Setting it to a boolean changes the behavior of fetch and pull to1222 unconditionally recurse into submodules when set to true or to not1223 recurse at all when set to false. When set to 'on-demand' (the default1224 value), fetch and pull will only recurse into a populated submodule1225 when its superproject retrieves a commit that updates the submodule's1226 reference.12271228fetch.fsckObjects::1229 If it is set to true, git-fetch-pack will check all fetched1230 objects. It will abort in the case of a malformed object or a1231 broken link. The result of an abort are only dangling objects.1232 Defaults to false. If not set, the value of `transfer.fsckObjects`1233 is used instead.12341235fetch.unpackLimit::1236 If the number of objects fetched over the Git native1237 transfer is below this1238 limit, then the objects will be unpacked into loose object1239 files. However if the number of received objects equals or1240 exceeds this limit then the received pack will be stored as1241 a pack, after adding any missing delta bases. Storing the1242 pack from a push can make the push operation complete faster,1243 especially on slow filesystems. If not set, the value of1244 `transfer.unpackLimit` is used instead.12451246fetch.prune::1247 If true, fetch will automatically behave as if the `--prune`1248 option was given on the command line. See also `remote.<name>.prune`.12491250fetch.output::1251 Control how ref update status is printed. Valid values are1252 `full` and `compact`. Default value is `full`. See section1253 OUTPUT in linkgit:git-fetch[1] for detail.12541255format.attach::1256 Enable multipart/mixed attachments as the default for1257 'format-patch'. The value can also be a double quoted string1258 which will enable attachments as the default and set the1259 value as the boundary. See the --attach option in1260 linkgit:git-format-patch[1].12611262format.from::1263 Provides the default value for the `--from` option to format-patch.1264 Accepts a boolean value, or a name and email address. If false,1265 format-patch defaults to `--no-from`, using commit authors directly in1266 the "From:" field of patch mails. If true, format-patch defaults to1267 `--from`, using your committer identity in the "From:" field of patch1268 mails and including a "From:" field in the body of the patch mail if1269 different. If set to a non-boolean value, format-patch uses that1270 value instead of your committer identity. Defaults to false.12711272format.numbered::1273 A boolean which can enable or disable sequence numbers in patch1274 subjects. It defaults to "auto" which enables it only if there1275 is more than one patch. It can be enabled or disabled for all1276 messages by setting it to "true" or "false". See --numbered1277 option in linkgit:git-format-patch[1].12781279format.headers::1280 Additional email headers to include in a patch to be submitted1281 by mail. See linkgit:git-format-patch[1].12821283format.to::1284format.cc::1285 Additional recipients to include in a patch to be submitted1286 by mail. See the --to and --cc options in1287 linkgit:git-format-patch[1].12881289format.subjectPrefix::1290 The default for format-patch is to output files with the '[PATCH]'1291 subject prefix. Use this variable to change that prefix.12921293format.signature::1294 The default for format-patch is to output a signature containing1295 the Git version number. Use this variable to change that default.1296 Set this variable to the empty string ("") to suppress1297 signature generation.12981299format.signatureFile::1300 Works just like format.signature except the contents of the1301 file specified by this variable will be used as the signature.13021303format.suffix::1304 The default for format-patch is to output files with the suffix1305 `.patch`. Use this variable to change that suffix (make sure to1306 include the dot if you want it).13071308format.pretty::1309 The default pretty format for log/show/whatchanged command,1310 See linkgit:git-log[1], linkgit:git-show[1],1311 linkgit:git-whatchanged[1].13121313format.thread::1314 The default threading style for 'git format-patch'. Can be1315 a boolean value, or `shallow` or `deep`. `shallow` threading1316 makes every mail a reply to the head of the series,1317 where the head is chosen from the cover letter, the1318 `--in-reply-to`, and the first patch mail, in this order.1319 `deep` threading makes every mail a reply to the previous one.1320 A true boolean value is the same as `shallow`, and a false1321 value disables threading.13221323format.signOff::1324 A boolean value which lets you enable the `-s/--signoff` option of1325 format-patch by default. *Note:* Adding the Signed-off-by: line to a1326 patch should be a conscious act and means that you certify you have1327 the rights to submit this work under the same open source license.1328 Please see the 'SubmittingPatches' document for further discussion.13291330format.coverLetter::1331 A boolean that controls whether to generate a cover-letter when1332 format-patch is invoked, but in addition can be set to "auto", to1333 generate a cover-letter only when there's more than one patch.13341335format.outputDirectory::1336 Set a custom directory to store the resulting files instead of the1337 current working directory.13381339format.useAutoBase::1340 A boolean value which lets you enable the `--base=auto` option of1341 format-patch by default.13421343filter.<driver>.clean::1344 The command which is used to convert the content of a worktree1345 file to a blob upon checkin. See linkgit:gitattributes[5] for1346 details.13471348filter.<driver>.smudge::1349 The command which is used to convert the content of a blob1350 object to a worktree file upon checkout. See1351 linkgit:gitattributes[5] for details.13521353fsck.<msg-id>::1354 Allows overriding the message type (error, warn or ignore) of a1355 specific message ID such as `missingEmail`.1356+1357For convenience, fsck prefixes the error/warning with the message ID,1358e.g. "missingEmail: invalid author/committer line - missing email" means1359that setting `fsck.missingEmail = ignore` will hide that issue.1360+1361This feature is intended to support working with legacy repositories1362which cannot be repaired without disruptive changes.13631364fsck.skipList::1365 The path to a sorted list of object names (i.e. one SHA-1 per1366 line) that are known to be broken in a non-fatal way and should1367 be ignored. This feature is useful when an established project1368 should be accepted despite early commits containing errors that1369 can be safely ignored such as invalid committer email addresses.1370 Note: corrupt objects cannot be skipped with this setting.13711372gc.aggressiveDepth::1373 The depth parameter used in the delta compression1374 algorithm used by 'git gc --aggressive'. This defaults1375 to 50.13761377gc.aggressiveWindow::1378 The window size parameter used in the delta compression1379 algorithm used by 'git gc --aggressive'. This defaults1380 to 250.13811382gc.auto::1383 When there are approximately more than this many loose1384 objects in the repository, `git gc --auto` will pack them.1385 Some Porcelain commands use this command to perform a1386 light-weight garbage collection from time to time. The1387 default value is 6700. Setting this to 0 disables it.13881389gc.autoPackLimit::1390 When there are more than this many packs that are not1391 marked with `*.keep` file in the repository, `git gc1392 --auto` consolidates them into one larger pack. The1393 default value is 50. Setting this to 0 disables it.13941395gc.autoDetach::1396 Make `git gc --auto` return immediately and run in background1397 if the system supports it. Default is true.13981399gc.packRefs::1400 Running `git pack-refs` in a repository renders it1401 unclonable by Git versions prior to 1.5.1.2 over dumb1402 transports such as HTTP. This variable determines whether1403 'git gc' runs `git pack-refs`. This can be set to `notbare`1404 to enable it within all non-bare repos or it can be set to a1405 boolean value. The default is `true`.14061407gc.pruneExpire::1408 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1409 Override the grace period with this config variable. The value1410 "now" may be used to disable this grace period and always prune1411 unreachable objects immediately, or "never" may be used to1412 suppress pruning.14131414gc.worktreePruneExpire::1415 When 'git gc' is run, it calls1416 'git worktree prune --expire 3.months.ago'.1417 This config variable can be used to set a different grace1418 period. The value "now" may be used to disable the grace1419 period and prune `$GIT_DIR/worktrees` immediately, or "never"1420 may be used to suppress pruning.14211422gc.reflogExpire::1423gc.<pattern>.reflogExpire::1424 'git reflog expire' removes reflog entries older than1425 this time; defaults to 90 days. The value "now" expires all1426 entries immediately, and "never" suppresses expiration1427 altogether. With "<pattern>" (e.g.1428 "refs/stash") in the middle the setting applies only to1429 the refs that match the <pattern>.14301431gc.reflogExpireUnreachable::1432gc.<pattern>.reflogExpireUnreachable::1433 'git reflog expire' removes reflog entries older than1434 this time and are not reachable from the current tip;1435 defaults to 30 days. The value "now" expires all entries1436 immediately, and "never" suppresses expiration altogether.1437 With "<pattern>" (e.g. "refs/stash")1438 in the middle, the setting applies only to the refs that1439 match the <pattern>.14401441gc.rerereResolved::1442 Records of conflicted merge you resolved earlier are1443 kept for this many days when 'git rerere gc' is run.1444 The default is 60 days. See linkgit:git-rerere[1].14451446gc.rerereUnresolved::1447 Records of conflicted merge you have not resolved are1448 kept for this many days when 'git rerere gc' is run.1449 The default is 15 days. See linkgit:git-rerere[1].14501451gitcvs.commitMsgAnnotation::1452 Append this string to each commit message. Set to empty string1453 to disable this feature. Defaults to "via git-CVS emulator".14541455gitcvs.enabled::1456 Whether the CVS server interface is enabled for this repository.1457 See linkgit:git-cvsserver[1].14581459gitcvs.logFile::1460 Path to a log file where the CVS server interface well... logs1461 various stuff. See linkgit:git-cvsserver[1].14621463gitcvs.usecrlfattr::1464 If true, the server will look up the end-of-line conversion1465 attributes for files to determine the `-k` modes to use. If1466 the attributes force Git to treat a file as text,1467 the `-k` mode will be left blank so CVS clients will1468 treat it as text. If they suppress text conversion, the file1469 will be set with '-kb' mode, which suppresses any newline munging1470 the client might otherwise do. If the attributes do not allow1471 the file type to be determined, then `gitcvs.allBinary` is1472 used. See linkgit:gitattributes[5].14731474gitcvs.allBinary::1475 This is used if `gitcvs.usecrlfattr` does not resolve1476 the correct '-kb' mode to use. If true, all1477 unresolved files are sent to the client in1478 mode '-kb'. This causes the client to treat them1479 as binary files, which suppresses any newline munging it1480 otherwise might do. Alternatively, if it is set to "guess",1481 then the contents of the file are examined to decide if1482 it is binary, similar to `core.autocrlf`.14831484gitcvs.dbName::1485 Database used by git-cvsserver to cache revision information1486 derived from the Git repository. The exact meaning depends on the1487 used database driver, for SQLite (which is the default driver) this1488 is a filename. Supports variable substitution (see1489 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1490 Default: '%Ggitcvs.%m.sqlite'14911492gitcvs.dbDriver::1493 Used Perl DBI driver. You can specify any available driver1494 for this here, but it might not work. git-cvsserver is tested1495 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1496 reported *not* to work with 'DBD::mysql'. Experimental feature.1497 May not contain double colons (`:`). Default: 'SQLite'.1498 See linkgit:git-cvsserver[1].14991500gitcvs.dbUser, gitcvs.dbPass::1501 Database user and password. Only useful if setting `gitcvs.dbDriver`,1502 since SQLite has no concept of database users and/or passwords.1503 'gitcvs.dbUser' supports variable substitution (see1504 linkgit:git-cvsserver[1] for details).15051506gitcvs.dbTableNamePrefix::1507 Database table name prefix. Prepended to the names of any1508 database tables used, allowing a single database to be used1509 for several repositories. Supports variable substitution (see1510 linkgit:git-cvsserver[1] for details). Any non-alphabetic1511 characters will be replaced with underscores.15121513All gitcvs variables except for `gitcvs.usecrlfattr` and1514`gitcvs.allBinary` can also be specified as1515'gitcvs.<access_method>.<varname>' (where 'access_method'1516is one of "ext" and "pserver") to make them apply only for the given1517access method.15181519gitweb.category::1520gitweb.description::1521gitweb.owner::1522gitweb.url::1523 See linkgit:gitweb[1] for description.15241525gitweb.avatar::1526gitweb.blame::1527gitweb.grep::1528gitweb.highlight::1529gitweb.patches::1530gitweb.pickaxe::1531gitweb.remote_heads::1532gitweb.showSizes::1533gitweb.snapshot::1534 See linkgit:gitweb.conf[5] for description.15351536grep.lineNumber::1537 If set to true, enable `-n` option by default.15381539grep.patternType::1540 Set the default matching behavior. Using a value of 'basic', 'extended',1541 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1542 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1543 value 'default' will return to the default matching behavior.15441545grep.extendedRegexp::1546 If set to true, enable `--extended-regexp` option by default. This1547 option is ignored when the `grep.patternType` option is set to a value1548 other than 'default'.15491550grep.threads::1551 Number of grep worker threads to use.1552 See `grep.threads` in linkgit:git-grep[1] for more information.15531554grep.fallbackToNoIndex::1555 If set to true, fall back to git grep --no-index if git grep1556 is executed outside of a git repository. Defaults to false.15571558gpg.program::1559 Use this custom program instead of "`gpg`" found on `$PATH` when1560 making or verifying a PGP signature. The program must support the1561 same command-line interface as GPG, namely, to verify a detached1562 signature, "`gpg --verify $file - <$signature`" is run, and the1563 program is expected to signal a good signature by exiting with1564 code 0, and to generate an ASCII-armored detached signature, the1565 standard input of "`gpg -bsau $key`" is fed with the contents to be1566 signed, and the program is expected to send the result to its1567 standard output.15681569gui.commitMsgWidth::1570 Defines how wide the commit message window is in the1571 linkgit:git-gui[1]. "75" is the default.15721573gui.diffContext::1574 Specifies how many context lines should be used in calls to diff1575 made by the linkgit:git-gui[1]. The default is "5".15761577gui.displayUntracked::1578 Determines if linkgit:git-gui[1] shows untracked files1579 in the file list. The default is "true".15801581gui.encoding::1582 Specifies the default encoding to use for displaying of1583 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1584 It can be overridden by setting the 'encoding' attribute1585 for relevant files (see linkgit:gitattributes[5]).1586 If this option is not set, the tools default to the1587 locale encoding.15881589gui.matchTrackingBranch::1590 Determines if new branches created with linkgit:git-gui[1] should1591 default to tracking remote branches with matching names or1592 not. Default: "false".15931594gui.newBranchTemplate::1595 Is used as suggested name when creating new branches using the1596 linkgit:git-gui[1].15971598gui.pruneDuringFetch::1599 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1600 performing a fetch. The default value is "false".16011602gui.trustmtime::1603 Determines if linkgit:git-gui[1] should trust the file modification1604 timestamp or not. By default the timestamps are not trusted.16051606gui.spellingDictionary::1607 Specifies the dictionary used for spell checking commit messages in1608 the linkgit:git-gui[1]. When set to "none" spell checking is turned1609 off.16101611gui.fastCopyBlame::1612 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1613 location detection. It makes blame significantly faster on huge1614 repositories at the expense of less thorough copy detection.16151616gui.copyBlameThreshold::1617 Specifies the threshold to use in 'git gui blame' original location1618 detection, measured in alphanumeric characters. See the1619 linkgit:git-blame[1] manual for more information on copy detection.16201621gui.blamehistoryctx::1622 Specifies the radius of history context in days to show in1623 linkgit:gitk[1] for the selected commit, when the `Show History1624 Context` menu item is invoked from 'git gui blame'. If this1625 variable is set to zero, the whole history is shown.16261627guitool.<name>.cmd::1628 Specifies the shell command line to execute when the corresponding item1629 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1630 mandatory for every tool. The command is executed from the root of1631 the working directory, and in the environment it receives the name of1632 the tool as `GIT_GUITOOL`, the name of the currently selected file as1633 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1634 the head is detached, 'CUR_BRANCH' is empty).16351636guitool.<name>.needsFile::1637 Run the tool only if a diff is selected in the GUI. It guarantees1638 that 'FILENAME' is not empty.16391640guitool.<name>.noConsole::1641 Run the command silently, without creating a window to display its1642 output.16431644guitool.<name>.noRescan::1645 Don't rescan the working directory for changes after the tool1646 finishes execution.16471648guitool.<name>.confirm::1649 Show a confirmation dialog before actually running the tool.16501651guitool.<name>.argPrompt::1652 Request a string argument from the user, and pass it to the tool1653 through the `ARGS` environment variable. Since requesting an1654 argument implies confirmation, the 'confirm' option has no effect1655 if this is enabled. If the option is set to 'true', 'yes', or '1',1656 the dialog uses a built-in generic prompt; otherwise the exact1657 value of the variable is used.16581659guitool.<name>.revPrompt::1660 Request a single valid revision from the user, and set the1661 `REVISION` environment variable. In other aspects this option1662 is similar to 'argPrompt', and can be used together with it.16631664guitool.<name>.revUnmerged::1665 Show only unmerged branches in the 'revPrompt' subdialog.1666 This is useful for tools similar to merge or rebase, but not1667 for things like checkout or reset.16681669guitool.<name>.title::1670 Specifies the title to use for the prompt dialog. The default1671 is the tool name.16721673guitool.<name>.prompt::1674 Specifies the general prompt string to display at the top of1675 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1676 The default value includes the actual command.16771678help.browser::1679 Specify the browser that will be used to display help in the1680 'web' format. See linkgit:git-help[1].16811682help.format::1683 Override the default help format used by linkgit:git-help[1].1684 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1685 the default. 'web' and 'html' are the same.16861687help.autoCorrect::1688 Automatically correct and execute mistyped commands after1689 waiting for the given number of deciseconds (0.1 sec). If more1690 than one command can be deduced from the entered text, nothing1691 will be executed. If the value of this option is negative,1692 the corrected command will be executed immediately. If the1693 value is 0 - the command will be just shown but not executed.1694 This is the default.16951696help.htmlPath::1697 Specify the path where the HTML documentation resides. File system paths1698 and URLs are supported. HTML pages will be prefixed with this path when1699 help is displayed in the 'web' format. This defaults to the documentation1700 path of your Git installation.17011702http.proxy::1703 Override the HTTP proxy, normally configured using the 'http_proxy',1704 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1705 addition to the syntax understood by curl, it is possible to specify a1706 proxy string with a user name but no password, in which case git will1707 attempt to acquire one in the same way it does for other credentials. See1708 linkgit:gitcredentials[7] for more information. The syntax thus is1709 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1710 on a per-remote basis; see remote.<name>.proxy17111712http.proxyAuthMethod::1713 Set the method with which to authenticate against the HTTP proxy. This1714 only takes effect if the configured proxy string contains a user name part1715 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1716 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1717 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1718 variable. Possible values are:1719+1720--1721* `anyauth` - Automatically pick a suitable authentication method. It is1722 assumed that the proxy answers an unauthenticated request with a 4071723 status code and one or more Proxy-authenticate headers with supported1724 authentication methods. This is the default.1725* `basic` - HTTP Basic authentication1726* `digest` - HTTP Digest authentication; this prevents the password from being1727 transmitted to the proxy in clear text1728* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1729 of `curl(1)`)1730* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1731--17321733http.emptyAuth::1734 Attempt authentication without seeking a username or password. This1735 can be used to attempt GSS-Negotiate authentication without specifying1736 a username in the URL, as libcurl normally requires a username for1737 authentication.17381739http.delegation::1740 Control GSSAPI credential delegation. The delegation is disabled1741 by default in libcurl since version 7.21.7. Set parameter to tell1742 the server what it is allowed to delegate when it comes to user1743 credentials. Used with GSS/kerberos. Possible values are:1744+1745--1746* `none` - Don't allow any delegation.1747* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1748 Kerberos service ticket, which is a matter of realm policy.1749* `always` - Unconditionally allow the server to delegate.1750--175117521753http.extraHeader::1754 Pass an additional HTTP header when communicating with a server. If1755 more than one such entry exists, all of them are added as extra1756 headers. To allow overriding the settings inherited from the system1757 config, an empty value will reset the extra headers to the empty list.17581759http.cookieFile::1760 The pathname of a file containing previously stored cookie lines,1761 which should be used1762 in the Git http session, if they match the server. The file format1763 of the file to read cookies from should be plain HTTP headers or1764 the Netscape/Mozilla cookie file format (see `curl(1)`).1765 NOTE that the file specified with http.cookieFile is used only as1766 input unless http.saveCookies is set.17671768http.saveCookies::1769 If set, store cookies received during requests to the file specified by1770 http.cookieFile. Has no effect if http.cookieFile is unset.17711772http.sslVersion::1773 The SSL version to use when negotiating an SSL connection, if you1774 want to force the default. The available and default version1775 depend on whether libcurl was built against NSS or OpenSSL and the1776 particular configuration of the crypto library in use. Internally1777 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1778 documentation for more details on the format of this option and1779 for the ssl version supported. Actually the possible values of1780 this option are:17811782 - sslv21783 - sslv31784 - tlsv11785 - tlsv1.01786 - tlsv1.11787 - tlsv1.217881789+1790Can be overridden by the `GIT_SSL_VERSION` environment variable.1791To force git to use libcurl's default ssl version and ignore any1792explicit http.sslversion option, set `GIT_SSL_VERSION` to the1793empty string.17941795http.sslCipherList::1796 A list of SSL ciphers to use when negotiating an SSL connection.1797 The available ciphers depend on whether libcurl was built against1798 NSS or OpenSSL and the particular configuration of the crypto1799 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1800 option; see the libcurl documentation for more details on the format1801 of this list.1802+1803Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1804To force git to use libcurl's default cipher list and ignore any1805explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1806empty string.18071808http.sslVerify::1809 Whether to verify the SSL certificate when fetching or pushing1810 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1811 variable.18121813http.sslCert::1814 File containing the SSL certificate when fetching or pushing1815 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1816 variable.18171818http.sslKey::1819 File containing the SSL private key when fetching or pushing1820 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1821 variable.18221823http.sslCertPasswordProtected::1824 Enable Git's password prompt for the SSL certificate. Otherwise1825 OpenSSL will prompt the user, possibly many times, if the1826 certificate or private key is encrypted. Can be overridden by the1827 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.18281829http.sslCAInfo::1830 File containing the certificates to verify the peer with when1831 fetching or pushing over HTTPS. Can be overridden by the1832 `GIT_SSL_CAINFO` environment variable.18331834http.sslCAPath::1835 Path containing files with the CA certificates to verify the peer1836 with when fetching or pushing over HTTPS. Can be overridden1837 by the `GIT_SSL_CAPATH` environment variable.18381839http.pinnedpubkey::1840 Public key of the https service. It may either be the filename of1841 a PEM or DER encoded public key file or a string starting with1842 'sha256//' followed by the base64 encoded sha256 hash of the1843 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1844 exit with an error if this option is set but not supported by1845 cURL.18461847http.sslTry::1848 Attempt to use AUTH SSL/TLS and encrypted data transfers1849 when connecting via regular FTP protocol. This might be needed1850 if the FTP server requires it for security reasons or you wish1851 to connect securely whenever remote FTP server supports it.1852 Default is false since it might trigger certificate verification1853 errors on misconfigured servers.18541855http.maxRequests::1856 How many HTTP requests to launch in parallel. Can be overridden1857 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.18581859http.minSessions::1860 The number of curl sessions (counted across slots) to be kept across1861 requests. They will not be ended with curl_easy_cleanup() until1862 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1863 value will be capped at 1. Defaults to 1.18641865http.postBuffer::1866 Maximum size in bytes of the buffer used by smart HTTP1867 transports when POSTing data to the remote system.1868 For requests larger than this buffer size, HTTP/1.1 and1869 Transfer-Encoding: chunked is used to avoid creating a1870 massive pack file locally. Default is 1 MiB, which is1871 sufficient for most requests.18721873http.lowSpeedLimit, http.lowSpeedTime::1874 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1875 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1876 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and1877 `GIT_HTTP_LOW_SPEED_TIME` environment variables.18781879http.noEPSV::1880 A boolean which disables using of EPSV ftp command by curl.1881 This can helpful with some "poor" ftp servers which don't1882 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`1883 environment variable. Default is false (curl will use EPSV).18841885http.userAgent::1886 The HTTP USER_AGENT string presented to an HTTP server. The default1887 value represents the version of the client Git such as git/1.7.1.1888 This option allows you to override this value to a more common value1889 such as Mozilla/4.0. This may be necessary, for instance, if1890 connecting through a firewall that restricts HTTP connections to a set1891 of common USER_AGENT strings (but not including those like git/1.7.1).1892 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.18931894http.<url>.*::1895 Any of the http.* options above can be applied selectively to some URLs.1896 For a config key to match a URL, each element of the config key is1897 compared to that of the URL, in the following order:1898+1899--1900. Scheme (e.g., `https` in `https://example.com/`). This field1901 must match exactly between the config key and the URL.19021903. Host/domain name (e.g., `example.com` in `https://example.com/`).1904 This field must match exactly between the config key and the URL.19051906. Port number (e.g., `8080` in `http://example.com:8080/`).1907 This field must match exactly between the config key and the URL.1908 Omitted port numbers are automatically converted to the correct1909 default for the scheme before matching.19101911. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1912 path field of the config key must match the path field of the URL1913 either exactly or as a prefix of slash-delimited path elements. This means1914 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1915 match on a slash (`/`) boundary. Longer matches take precedence (so a config1916 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1917 key with just path `foo/`).19181919. User name (e.g., `user` in `https://user@example.com/repo.git`). If1920 the config key has a user name it must match the user name in the1921 URL exactly. If the config key does not have a user name, that1922 config key will match a URL with any user name (including none),1923 but at a lower precedence than a config key with a user name.1924--1925+1926The list above is ordered by decreasing precedence; a URL that matches1927a config key's path is preferred to one that matches its user name. For example,1928if the URL is `https://user@example.com/foo/bar` a config key match of1929`https://example.com/foo` will be preferred over a config key match of1930`https://user@example.com`.1931+1932All URLs are normalized before attempting any matching (the password part,1933if embedded in the URL, is always ignored for matching purposes) so that1934equivalent URLs that are simply spelled differently will match properly.1935Environment variable settings always override any matches. The URLs that are1936matched against are those given directly to Git commands. This means any URLs1937visited as a result of a redirection do not participate in matching.19381939i18n.commitEncoding::1940 Character encoding the commit messages are stored in; Git itself1941 does not care per se, but this information is necessary e.g. when1942 importing commits from emails or in the gitk graphical history1943 browser (and possibly at other places in the future or in other1944 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.19451946i18n.logOutputEncoding::1947 Character encoding the commit messages are converted to when1948 running 'git log' and friends.19491950imap::1951 The configuration variables in the 'imap' section are described1952 in linkgit:git-imap-send[1].19531954index.version::1955 Specify the version with which new index files should be1956 initialized. This does not affect existing repositories.19571958init.templateDir::1959 Specify the directory from which templates will be copied.1960 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)19611962instaweb.browser::1963 Specify the program that will be used to browse your working1964 repository in gitweb. See linkgit:git-instaweb[1].19651966instaweb.httpd::1967 The HTTP daemon command-line to start gitweb on your working1968 repository. See linkgit:git-instaweb[1].19691970instaweb.local::1971 If true the web server started by linkgit:git-instaweb[1] will1972 be bound to the local IP (127.0.0.1).19731974instaweb.modulePath::1975 The default module path for linkgit:git-instaweb[1] to use1976 instead of /usr/lib/apache2/modules. Only used if httpd1977 is Apache.19781979instaweb.port::1980 The port number to bind the gitweb httpd to. See1981 linkgit:git-instaweb[1].19821983interactive.singleKey::1984 In interactive commands, allow the user to provide one-letter1985 input with a single key (i.e., without hitting enter).1986 Currently this is used by the `--patch` mode of1987 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1988 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1989 setting is silently ignored if portable keystroke input1990 is not available; requires the Perl module Term::ReadKey.19911992interactive.diffFilter::1993 When an interactive command (such as `git add --patch`) shows1994 a colorized diff, git will pipe the diff through the shell1995 command defined by this configuration variable. The command may1996 mark up the diff further for human consumption, provided that it1997 retains a one-to-one correspondence with the lines in the1998 original diff. Defaults to disabled (no filtering).19992000log.abbrevCommit::2001 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2002 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2003 override this option with `--no-abbrev-commit`.20042005log.date::2006 Set the default date-time mode for the 'log' command.2007 Setting a value for log.date is similar to using 'git log''s2008 `--date` option. See linkgit:git-log[1] for details.20092010log.decorate::2011 Print out the ref names of any commits that are shown by the log2012 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2013 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2014 specified, the full ref name (including prefix) will be printed.2015 If 'auto' is specified, then if the output is going to a terminal,2016 the ref names are shown as if 'short' were given, otherwise no ref2017 names are shown. This is the same as the `--decorate` option2018 of the `git log`.20192020log.follow::2021 If `true`, `git log` will act as if the `--follow` option was used when2022 a single <path> is given. This has the same limitations as `--follow`,2023 i.e. it cannot be used to follow multiple files and does not work well2024 on non-linear history.20252026log.showRoot::2027 If true, the initial commit will be shown as a big creation event.2028 This is equivalent to a diff against an empty tree.2029 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2030 normally hide the root commit will now show it. True by default.20312032log.mailmap::2033 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2034 linkgit:git-whatchanged[1] assume `--use-mailmap`.20352036mailinfo.scissors::2037 If true, makes linkgit:git-mailinfo[1] (and therefore2038 linkgit:git-am[1]) act by default as if the --scissors option2039 was provided on the command-line. When active, this features2040 removes everything from the message body before a scissors2041 line (i.e. consisting mainly of ">8", "8<" and "-").20422043mailmap.file::2044 The location of an augmenting mailmap file. The default2045 mailmap, located in the root of the repository, is loaded2046 first, then the mailmap file pointed to by this variable.2047 The location of the mailmap file may be in a repository2048 subdirectory, or somewhere outside of the repository itself.2049 See linkgit:git-shortlog[1] and linkgit:git-blame[1].20502051mailmap.blob::2052 Like `mailmap.file`, but consider the value as a reference to a2053 blob in the repository. If both `mailmap.file` and2054 `mailmap.blob` are given, both are parsed, with entries from2055 `mailmap.file` taking precedence. In a bare repository, this2056 defaults to `HEAD:.mailmap`. In a non-bare repository, it2057 defaults to empty.20582059man.viewer::2060 Specify the programs that may be used to display help in the2061 'man' format. See linkgit:git-help[1].20622063man.<tool>.cmd::2064 Specify the command to invoke the specified man viewer. The2065 specified command is evaluated in shell with the man page2066 passed as argument. (See linkgit:git-help[1].)20672068man.<tool>.path::2069 Override the path for the given tool that may be used to2070 display help in the 'man' format. See linkgit:git-help[1].20712072include::merge-config.txt[]20732074mergetool.<tool>.path::2075 Override the path for the given tool. This is useful in case2076 your tool is not in the PATH.20772078mergetool.<tool>.cmd::2079 Specify the command to invoke the specified merge tool. The2080 specified command is evaluated in shell with the following2081 variables available: 'BASE' is the name of a temporary file2082 containing the common base of the files to be merged, if available;2083 'LOCAL' is the name of a temporary file containing the contents of2084 the file on the current branch; 'REMOTE' is the name of a temporary2085 file containing the contents of the file from the branch being2086 merged; 'MERGED' contains the name of the file to which the merge2087 tool should write the results of a successful merge.20882089mergetool.<tool>.trustExitCode::2090 For a custom merge command, specify whether the exit code of2091 the merge command can be used to determine whether the merge was2092 successful. If this is not set to true then the merge target file2093 timestamp is checked and the merge assumed to have been successful2094 if the file has been updated, otherwise the user is prompted to2095 indicate the success of the merge.20962097mergetool.meld.hasOutput::2098 Older versions of `meld` do not support the `--output` option.2099 Git will attempt to detect whether `meld` supports `--output`2100 by inspecting the output of `meld --help`. Configuring2101 `mergetool.meld.hasOutput` will make Git skip these checks and2102 use the configured value instead. Setting `mergetool.meld.hasOutput`2103 to `true` tells Git to unconditionally use the `--output` option,2104 and `false` avoids using `--output`.21052106mergetool.keepBackup::2107 After performing a merge, the original file with conflict markers2108 can be saved as a file with a `.orig` extension. If this variable2109 is set to `false` then this file is not preserved. Defaults to2110 `true` (i.e. keep the backup files).21112112mergetool.keepTemporaries::2113 When invoking a custom merge tool, Git uses a set of temporary2114 files to pass to the tool. If the tool returns an error and this2115 variable is set to `true`, then these temporary files will be2116 preserved, otherwise they will be removed after the tool has2117 exited. Defaults to `false`.21182119mergetool.writeToTemp::2120 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2121 conflicting files in the worktree by default. Git will attempt2122 to use a temporary directory for these files when set `true`.2123 Defaults to `false`.21242125mergetool.prompt::2126 Prompt before each invocation of the merge resolution program.21272128notes.mergeStrategy::2129 Which merge strategy to choose by default when resolving notes2130 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2131 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2132 section of linkgit:git-notes[1] for more information on each strategy.21332134notes.<name>.mergeStrategy::2135 Which merge strategy to choose when doing a notes merge into2136 refs/notes/<name>. This overrides the more general2137 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2138 linkgit:git-notes[1] for more information on the available strategies.21392140notes.displayRef::2141 The (fully qualified) refname from which to show notes when2142 showing commit messages. The value of this variable can be set2143 to a glob, in which case notes from all matching refs will be2144 shown. You may also specify this configuration variable2145 several times. A warning will be issued for refs that do not2146 exist, but a glob that does not match any refs is silently2147 ignored.2148+2149This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2150environment variable, which must be a colon separated list of refs or2151globs.2152+2153The effective value of "core.notesRef" (possibly overridden by2154GIT_NOTES_REF) is also implicitly added to the list of refs to be2155displayed.21562157notes.rewrite.<command>::2158 When rewriting commits with <command> (currently `amend` or2159 `rebase`) and this variable is set to `true`, Git2160 automatically copies your notes from the original to the2161 rewritten commit. Defaults to `true`, but see2162 "notes.rewriteRef" below.21632164notes.rewriteMode::2165 When copying notes during a rewrite (see the2166 "notes.rewrite.<command>" option), determines what to do if2167 the target commit already has a note. Must be one of2168 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2169 Defaults to `concatenate`.2170+2171This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2172environment variable.21732174notes.rewriteRef::2175 When copying notes during a rewrite, specifies the (fully2176 qualified) ref whose notes should be copied. The ref may be a2177 glob, in which case notes in all matching refs will be copied.2178 You may also specify this configuration several times.2179+2180Does not have a default value; you must configure this variable to2181enable note rewriting. Set it to `refs/notes/commits` to enable2182rewriting for the default commit notes.2183+2184This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2185environment variable, which must be a colon separated list of refs or2186globs.21872188pack.window::2189 The size of the window used by linkgit:git-pack-objects[1] when no2190 window size is given on the command line. Defaults to 10.21912192pack.depth::2193 The maximum delta depth used by linkgit:git-pack-objects[1] when no2194 maximum depth is given on the command line. Defaults to 50.21952196pack.windowMemory::2197 The maximum size of memory that is consumed by each thread2198 in linkgit:git-pack-objects[1] for pack window memory when2199 no limit is given on the command line. The value can be2200 suffixed with "k", "m", or "g". When left unconfigured (or2201 set explicitly to 0), there will be no limit.22022203pack.compression::2204 An integer -1..9, indicating the compression level for objects2205 in a pack file. -1 is the zlib default. 0 means no2206 compression, and 1..9 are various speed/size tradeoffs, 9 being2207 slowest. If not set, defaults to core.compression. If that is2208 not set, defaults to -1, the zlib default, which is "a default2209 compromise between speed and compression (currently equivalent2210 to level 6)."2211+2212Note that changing the compression level will not automatically recompress2213all existing objects. You can force recompression by passing the -F option2214to linkgit:git-repack[1].22152216pack.deltaCacheSize::2217 The maximum memory in bytes used for caching deltas in2218 linkgit:git-pack-objects[1] before writing them out to a pack.2219 This cache is used to speed up the writing object phase by not2220 having to recompute the final delta result once the best match2221 for all objects is found. Repacking large repositories on machines2222 which are tight with memory might be badly impacted by this though,2223 especially if this cache pushes the system into swapping.2224 A value of 0 means no limit. The smallest size of 1 byte may be2225 used to virtually disable this cache. Defaults to 256 MiB.22262227pack.deltaCacheLimit::2228 The maximum size of a delta, that is cached in2229 linkgit:git-pack-objects[1]. This cache is used to speed up the2230 writing object phase by not having to recompute the final delta2231 result once the best match for all objects is found. Defaults to 1000.22322233pack.threads::2234 Specifies the number of threads to spawn when searching for best2235 delta matches. This requires that linkgit:git-pack-objects[1]2236 be compiled with pthreads otherwise this option is ignored with a2237 warning. This is meant to reduce packing time on multiprocessor2238 machines. The required amount of memory for the delta search window2239 is however multiplied by the number of threads.2240 Specifying 0 will cause Git to auto-detect the number of CPU's2241 and set the number of threads accordingly.22422243pack.indexVersion::2244 Specify the default pack index version. Valid values are 1 for2245 legacy pack index used by Git versions prior to 1.5.2, and 2 for2246 the new pack index with capabilities for packs larger than 4 GB2247 as well as proper protection against the repacking of corrupted2248 packs. Version 2 is the default. Note that version 2 is enforced2249 and this config option ignored whenever the corresponding pack is2250 larger than 2 GB.2251+2252If you have an old Git that does not understand the version 2 `*.idx` file,2253cloning or fetching over a non native protocol (e.g. "http")2254that will copy both `*.pack` file and corresponding `*.idx` file from the2255other side may give you a repository that cannot be accessed with your2256older version of Git. If the `*.pack` file is smaller than 2 GB, however,2257you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2258the `*.idx` file.22592260pack.packSizeLimit::2261 The maximum size of a pack. This setting only affects2262 packing to a file when repacking, i.e. the git:// protocol2263 is unaffected. It can be overridden by the `--max-pack-size`2264 option of linkgit:git-repack[1]. Reaching this limit results2265 in the creation of multiple packfiles; which in turn prevents2266 bitmaps from being created.2267 The minimum size allowed is limited to 1 MiB.2268 The default is unlimited.2269 Common unit suffixes of 'k', 'm', or 'g' are2270 supported.22712272pack.useBitmaps::2273 When true, git will use pack bitmaps (if available) when packing2274 to stdout (e.g., during the server side of a fetch). Defaults to2275 true. You should not generally need to turn this off unless2276 you are debugging pack bitmaps.22772278pack.writeBitmaps (deprecated)::2279 This is a deprecated synonym for `repack.writeBitmaps`.22802281pack.writeBitmapHashCache::2282 When true, git will include a "hash cache" section in the bitmap2283 index (if one is written). This cache can be used to feed git's2284 delta heuristics, potentially leading to better deltas between2285 bitmapped and non-bitmapped objects (e.g., when serving a fetch2286 between an older, bitmapped pack and objects that have been2287 pushed since the last gc). The downside is that it consumes 42288 bytes per object of disk space, and that JGit's bitmap2289 implementation does not understand it, causing it to complain if2290 Git and JGit are used on the same repository. Defaults to false.22912292pager.<cmd>::2293 If the value is boolean, turns on or off pagination of the2294 output of a particular Git subcommand when writing to a tty.2295 Otherwise, turns on pagination for the subcommand using the2296 pager specified by the value of `pager.<cmd>`. If `--paginate`2297 or `--no-pager` is specified on the command line, it takes2298 precedence over this option. To disable pagination for all2299 commands, set `core.pager` or `GIT_PAGER` to `cat`.23002301pretty.<name>::2302 Alias for a --pretty= format string, as specified in2303 linkgit:git-log[1]. Any aliases defined here can be used just2304 as the built-in pretty formats could. For example,2305 running `git config pretty.changelog "format:* %H %s"`2306 would cause the invocation `git log --pretty=changelog`2307 to be equivalent to running `git log "--pretty=format:* %H %s"`.2308 Note that an alias with the same name as a built-in format2309 will be silently ignored.23102311pull.ff::2312 By default, Git does not create an extra merge commit when merging2313 a commit that is a descendant of the current commit. Instead, the2314 tip of the current branch is fast-forwarded. When set to `false`,2315 this variable tells Git to create an extra merge commit in such2316 a case (equivalent to giving the `--no-ff` option from the command2317 line). When set to `only`, only such fast-forward merges are2318 allowed (equivalent to giving the `--ff-only` option from the2319 command line). This setting overrides `merge.ff` when pulling.23202321pull.rebase::2322 When true, rebase branches on top of the fetched branch, instead2323 of merging the default branch from the default remote when "git2324 pull" is run. See "branch.<name>.rebase" for setting this on a2325 per-branch basis.2326+2327When preserve, also pass `--preserve-merges` along to 'git rebase'2328so that locally committed merge commits will not be flattened2329by running 'git pull'.2330+2331When the value is `interactive`, the rebase is run in interactive mode.2332+2333*NOTE*: this is a possibly dangerous operation; do *not* use2334it unless you understand the implications (see linkgit:git-rebase[1]2335for details).23362337pull.octopus::2338 The default merge strategy to use when pulling multiple branches2339 at once.23402341pull.twohead::2342 The default merge strategy to use when pulling a single branch.23432344push.default::2345 Defines the action `git push` should take if no refspec is2346 explicitly given. Different values are well-suited for2347 specific workflows; for instance, in a purely central workflow2348 (i.e. the fetch source is equal to the push destination),2349 `upstream` is probably what you want. Possible values are:2350+2351--23522353* `nothing` - do not push anything (error out) unless a refspec is2354 explicitly given. This is primarily meant for people who want to2355 avoid mistakes by always being explicit.23562357* `current` - push the current branch to update a branch with the same2358 name on the receiving end. Works in both central and non-central2359 workflows.23602361* `upstream` - push the current branch back to the branch whose2362 changes are usually integrated into the current branch (which is2363 called `@{upstream}`). This mode only makes sense if you are2364 pushing to the same repository you would normally pull from2365 (i.e. central workflow).23662367* `simple` - in centralized workflow, work like `upstream` with an2368 added safety to refuse to push if the upstream branch's name is2369 different from the local one.2370+2371When pushing to a remote that is different from the remote you normally2372pull from, work as `current`. This is the safest option and is suited2373for beginners.2374+2375This mode has become the default in Git 2.0.23762377* `matching` - push all branches having the same name on both ends.2378 This makes the repository you are pushing to remember the set of2379 branches that will be pushed out (e.g. if you always push 'maint'2380 and 'master' there and no other branches, the repository you push2381 to will have these two branches, and your local 'maint' and2382 'master' will be pushed there).2383+2384To use this mode effectively, you have to make sure _all_ the2385branches you would push out are ready to be pushed out before2386running 'git push', as the whole point of this mode is to allow you2387to push all of the branches in one go. If you usually finish work2388on only one branch and push out the result, while other branches are2389unfinished, this mode is not for you. Also this mode is not2390suitable for pushing into a shared central repository, as other2391people may add new branches there, or update the tip of existing2392branches outside your control.2393+2394This used to be the default, but not since Git 2.0 (`simple` is the2395new default).23962397--23982399push.followTags::2400 If set to true enable `--follow-tags` option by default. You2401 may override this configuration at time of push by specifying2402 `--no-follow-tags`.24032404push.gpgSign::2405 May be set to a boolean value, or the string 'if-asked'. A true2406 value causes all pushes to be GPG signed, as if `--signed` is2407 passed to linkgit:git-push[1]. The string 'if-asked' causes2408 pushes to be signed if the server supports it, as if2409 `--signed=if-asked` is passed to 'git push'. A false value may2410 override a value from a lower-priority config file. An explicit2411 command-line flag always overrides this config option.24122413push.recurseSubmodules::2414 Make sure all submodule commits used by the revisions to be pushed2415 are available on a remote-tracking branch. If the value is 'check'2416 then Git will verify that all submodule commits that changed in the2417 revisions to be pushed are available on at least one remote of the2418 submodule. If any commits are missing, the push will be aborted and2419 exit with non-zero status. If the value is 'on-demand' then all2420 submodules that changed in the revisions to be pushed will be2421 pushed. If on-demand was not able to push all necessary revisions2422 it will also be aborted and exit with non-zero status. If the value2423 is 'no' then default behavior of ignoring submodules when pushing2424 is retained. You may override this configuration at time of push by2425 specifying '--recurse-submodules=check|on-demand|no'.24262427rebase.stat::2428 Whether to show a diffstat of what changed upstream since the last2429 rebase. False by default.24302431rebase.autoSquash::2432 If set to true enable `--autosquash` option by default.24332434rebase.autoStash::2435 When set to true, automatically create a temporary stash2436 before the operation begins, and apply it after the operation2437 ends. This means that you can run rebase on a dirty worktree.2438 However, use with care: the final stash application after a2439 successful rebase might result in non-trivial conflicts.2440 Defaults to false.24412442rebase.missingCommitsCheck::2443 If set to "warn", git rebase -i will print a warning if some2444 commits are removed (e.g. a line was deleted), however the2445 rebase will still proceed. If set to "error", it will print2446 the previous warning and stop the rebase, 'git rebase2447 --edit-todo' can then be used to correct the error. If set to2448 "ignore", no checking is done.2449 To drop a commit without warning or error, use the `drop`2450 command in the todo-list.2451 Defaults to "ignore".24522453rebase.instructionFormat::2454 A format string, as specified in linkgit:git-log[1], to be used for2455 the instruction list during an interactive rebase. The format will automatically2456 have the long commit hash prepended to the format.24572458receive.advertiseAtomic::2459 By default, git-receive-pack will advertise the atomic push2460 capability to its clients. If you don't want to advertise this2461 capability, set this variable to false.24622463receive.advertisePushOptions::2464 By default, git-receive-pack will advertise the push options2465 capability to its clients. If you don't want to advertise this2466 capability, set this variable to false.24672468receive.autogc::2469 By default, git-receive-pack will run "git-gc --auto" after2470 receiving data from git-push and updating refs. You can stop2471 it by setting this variable to false.24722473receive.certNonceSeed::2474 By setting this variable to a string, `git receive-pack`2475 will accept a `git push --signed` and verifies it by using2476 a "nonce" protected by HMAC using this string as a secret2477 key.24782479receive.certNonceSlop::2480 When a `git push --signed` sent a push certificate with a2481 "nonce" that was issued by a receive-pack serving the same2482 repository within this many seconds, export the "nonce"2483 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2484 hooks (instead of what the receive-pack asked the sending2485 side to include). This may allow writing checks in2486 `pre-receive` and `post-receive` a bit easier. Instead of2487 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2488 that records by how many seconds the nonce is stale to2489 decide if they want to accept the certificate, they only2490 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.24912492receive.fsckObjects::2493 If it is set to true, git-receive-pack will check all received2494 objects. It will abort in the case of a malformed object or a2495 broken link. The result of an abort are only dangling objects.2496 Defaults to false. If not set, the value of `transfer.fsckObjects`2497 is used instead.24982499receive.fsck.<msg-id>::2500 When `receive.fsckObjects` is set to true, errors can be switched2501 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2502 setting where the `<msg-id>` is the fsck message ID and the value2503 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2504 the error/warning with the message ID, e.g. "missingEmail: invalid2505 author/committer line - missing email" means that setting2506 `receive.fsck.missingEmail = ignore` will hide that issue.2507+2508This feature is intended to support working with legacy repositories2509which would not pass pushing when `receive.fsckObjects = true`, allowing2510the host to accept repositories with certain known issues but still catch2511other issues.25122513receive.fsck.skipList::2514 The path to a sorted list of object names (i.e. one SHA-1 per2515 line) that are known to be broken in a non-fatal way and should2516 be ignored. This feature is useful when an established project2517 should be accepted despite early commits containing errors that2518 can be safely ignored such as invalid committer email addresses.2519 Note: corrupt objects cannot be skipped with this setting.25202521receive.keepAlive::2522 After receiving the pack from the client, `receive-pack` may2523 produce no output (if `--quiet` was specified) while processing2524 the pack, causing some networks to drop the TCP connection.2525 With this option set, if `receive-pack` does not transmit2526 any data in this phase for `receive.keepAlive` seconds, it will2527 send a short keepalive packet. The default is 5 seconds; set2528 to 0 to disable keepalives entirely.25292530receive.unpackLimit::2531 If the number of objects received in a push is below this2532 limit then the objects will be unpacked into loose object2533 files. However if the number of received objects equals or2534 exceeds this limit then the received pack will be stored as2535 a pack, after adding any missing delta bases. Storing the2536 pack from a push can make the push operation complete faster,2537 especially on slow filesystems. If not set, the value of2538 `transfer.unpackLimit` is used instead.25392540receive.maxInputSize::2541 If the size of the incoming pack stream is larger than this2542 limit, then git-receive-pack will error out, instead of2543 accepting the pack file. If not set or set to 0, then the size2544 is unlimited.25452546receive.denyDeletes::2547 If set to true, git-receive-pack will deny a ref update that deletes2548 the ref. Use this to prevent such a ref deletion via a push.25492550receive.denyDeleteCurrent::2551 If set to true, git-receive-pack will deny a ref update that2552 deletes the currently checked out branch of a non-bare repository.25532554receive.denyCurrentBranch::2555 If set to true or "refuse", git-receive-pack will deny a ref update2556 to the currently checked out branch of a non-bare repository.2557 Such a push is potentially dangerous because it brings the HEAD2558 out of sync with the index and working tree. If set to "warn",2559 print a warning of such a push to stderr, but allow the push to2560 proceed. If set to false or "ignore", allow such pushes with no2561 message. Defaults to "refuse".2562+2563Another option is "updateInstead" which will update the working2564tree if pushing into the current branch. This option is2565intended for synchronizing working directories when one side is not easily2566accessible via interactive ssh (e.g. a live web site, hence the requirement2567that the working directory be clean). This mode also comes in handy when2568developing inside a VM to test and fix code on different Operating Systems.2569+2570By default, "updateInstead" will refuse the push if the working tree or2571the index have any difference from the HEAD, but the `push-to-checkout`2572hook can be used to customize this. See linkgit:githooks[5].25732574receive.denyNonFastForwards::2575 If set to true, git-receive-pack will deny a ref update which is2576 not a fast-forward. Use this to prevent such an update via a push,2577 even if that push is forced. This configuration variable is2578 set when initializing a shared repository.25792580receive.hideRefs::2581 This variable is the same as `transfer.hideRefs`, but applies2582 only to `receive-pack` (and so affects pushes, but not fetches).2583 An attempt to update or delete a hidden ref by `git push` is2584 rejected.25852586receive.updateServerInfo::2587 If set to true, git-receive-pack will run git-update-server-info2588 after receiving data from git-push and updating refs.25892590receive.shallowUpdate::2591 If set to true, .git/shallow can be updated when new refs2592 require new shallow roots. Otherwise those refs are rejected.25932594remote.pushDefault::2595 The remote to push to by default. Overrides2596 `branch.<name>.remote` for all branches, and is overridden by2597 `branch.<name>.pushRemote` for specific branches.25982599remote.<name>.url::2600 The URL of a remote repository. See linkgit:git-fetch[1] or2601 linkgit:git-push[1].26022603remote.<name>.pushurl::2604 The push URL of a remote repository. See linkgit:git-push[1].26052606remote.<name>.proxy::2607 For remotes that require curl (http, https and ftp), the URL to2608 the proxy to use for that remote. Set to the empty string to2609 disable proxying for that remote.26102611remote.<name>.proxyAuthMethod::2612 For remotes that require curl (http, https and ftp), the method to use for2613 authenticating against the proxy in use (probably set in2614 `remote.<name>.proxy`). See `http.proxyAuthMethod`.26152616remote.<name>.fetch::2617 The default set of "refspec" for linkgit:git-fetch[1]. See2618 linkgit:git-fetch[1].26192620remote.<name>.push::2621 The default set of "refspec" for linkgit:git-push[1]. See2622 linkgit:git-push[1].26232624remote.<name>.mirror::2625 If true, pushing to this remote will automatically behave2626 as if the `--mirror` option was given on the command line.26272628remote.<name>.skipDefaultUpdate::2629 If true, this remote will be skipped by default when updating2630 using linkgit:git-fetch[1] or the `update` subcommand of2631 linkgit:git-remote[1].26322633remote.<name>.skipFetchAll::2634 If true, this remote will be skipped by default when updating2635 using linkgit:git-fetch[1] or the `update` subcommand of2636 linkgit:git-remote[1].26372638remote.<name>.receivepack::2639 The default program to execute on the remote side when pushing. See2640 option --receive-pack of linkgit:git-push[1].26412642remote.<name>.uploadpack::2643 The default program to execute on the remote side when fetching. See2644 option --upload-pack of linkgit:git-fetch-pack[1].26452646remote.<name>.tagOpt::2647 Setting this value to --no-tags disables automatic tag following when2648 fetching from remote <name>. Setting it to --tags will fetch every2649 tag from remote <name>, even if they are not reachable from remote2650 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2651 override this setting. See options --tags and --no-tags of2652 linkgit:git-fetch[1].26532654remote.<name>.vcs::2655 Setting this to a value <vcs> will cause Git to interact with2656 the remote with the git-remote-<vcs> helper.26572658remote.<name>.prune::2659 When set to true, fetching from this remote by default will also2660 remove any remote-tracking references that no longer exist on the2661 remote (as if the `--prune` option was given on the command line).2662 Overrides `fetch.prune` settings, if any.26632664remotes.<group>::2665 The list of remotes which are fetched by "git remote update2666 <group>". See linkgit:git-remote[1].26672668repack.useDeltaBaseOffset::2669 By default, linkgit:git-repack[1] creates packs that use2670 delta-base offset. If you need to share your repository with2671 Git older than version 1.4.4, either directly or via a dumb2672 protocol such as http, then you need to set this option to2673 "false" and repack. Access from old Git versions over the2674 native protocol are unaffected by this option.26752676repack.packKeptObjects::2677 If set to true, makes `git repack` act as if2678 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2679 details. Defaults to `false` normally, but `true` if a bitmap2680 index is being written (either via `--write-bitmap-index` or2681 `repack.writeBitmaps`).26822683repack.writeBitmaps::2684 When true, git will write a bitmap index when packing all2685 objects to disk (e.g., when `git repack -a` is run). This2686 index can speed up the "counting objects" phase of subsequent2687 packs created for clones and fetches, at the cost of some disk2688 space and extra time spent on the initial repack. This has2689 no effect if multiple packfiles are created.2690 Defaults to false.26912692rerere.autoUpdate::2693 When set to true, `git-rerere` updates the index with the2694 resulting contents after it cleanly resolves conflicts using2695 previously recorded resolution. Defaults to false.26962697rerere.enabled::2698 Activate recording of resolved conflicts, so that identical2699 conflict hunks can be resolved automatically, should they be2700 encountered again. By default, linkgit:git-rerere[1] is2701 enabled if there is an `rr-cache` directory under the2702 `$GIT_DIR`, e.g. if "rerere" was previously used in the2703 repository.27042705sendemail.identity::2706 A configuration identity. When given, causes values in the2707 'sendemail.<identity>' subsection to take precedence over2708 values in the 'sendemail' section. The default identity is2709 the value of `sendemail.identity`.27102711sendemail.smtpEncryption::2712 See linkgit:git-send-email[1] for description. Note that this2713 setting is not subject to the 'identity' mechanism.27142715sendemail.smtpssl (deprecated)::2716 Deprecated alias for 'sendemail.smtpEncryption = ssl'.27172718sendemail.smtpsslcertpath::2719 Path to ca-certificates (either a directory or a single file).2720 Set it to an empty string to disable certificate verification.27212722sendemail.<identity>.*::2723 Identity-specific versions of the 'sendemail.*' parameters2724 found below, taking precedence over those when the this2725 identity is selected, through command-line or2726 `sendemail.identity`.27272728sendemail.aliasesFile::2729sendemail.aliasFileType::2730sendemail.annotate::2731sendemail.bcc::2732sendemail.cc::2733sendemail.ccCmd::2734sendemail.chainReplyTo::2735sendemail.confirm::2736sendemail.envelopeSender::2737sendemail.from::2738sendemail.multiEdit::2739sendemail.signedoffbycc::2740sendemail.smtpPass::2741sendemail.suppresscc::2742sendemail.suppressFrom::2743sendemail.to::2744sendemail.smtpDomain::2745sendemail.smtpServer::2746sendemail.smtpServerPort::2747sendemail.smtpServerOption::2748sendemail.smtpUser::2749sendemail.thread::2750sendemail.transferEncoding::2751sendemail.validate::2752sendemail.xmailer::2753 See linkgit:git-send-email[1] for description.27542755sendemail.signedoffcc (deprecated)::2756 Deprecated alias for `sendemail.signedoffbycc`.27572758showbranch.default::2759 The default set of branches for linkgit:git-show-branch[1].2760 See linkgit:git-show-branch[1].27612762status.relativePaths::2763 By default, linkgit:git-status[1] shows paths relative to the2764 current directory. Setting this variable to `false` shows paths2765 relative to the repository root (this was the default for Git2766 prior to v1.5.4).27672768status.short::2769 Set to true to enable --short by default in linkgit:git-status[1].2770 The option --no-short takes precedence over this variable.27712772status.branch::2773 Set to true to enable --branch by default in linkgit:git-status[1].2774 The option --no-branch takes precedence over this variable.27752776status.displayCommentPrefix::2777 If set to true, linkgit:git-status[1] will insert a comment2778 prefix before each output line (starting with2779 `core.commentChar`, i.e. `#` by default). This was the2780 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2781 Defaults to false.27822783status.showUntrackedFiles::2784 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2785 files which are not currently tracked by Git. Directories which2786 contain only untracked files, are shown with the directory name2787 only. Showing untracked files means that Git needs to lstat() all2788 the files in the whole repository, which might be slow on some2789 systems. So, this variable controls how the commands displays2790 the untracked files. Possible values are:2791+2792--2793* `no` - Show no untracked files.2794* `normal` - Show untracked files and directories.2795* `all` - Show also individual files in untracked directories.2796--2797+2798If this variable is not specified, it defaults to 'normal'.2799This variable can be overridden with the -u|--untracked-files option2800of linkgit:git-status[1] and linkgit:git-commit[1].28012802status.submoduleSummary::2803 Defaults to false.2804 If this is set to a non zero number or true (identical to -1 or an2805 unlimited number), the submodule summary will be enabled and a2806 summary of commits for modified submodules will be shown (see2807 --summary-limit option of linkgit:git-submodule[1]). Please note2808 that the summary output command will be suppressed for all2809 submodules when `diff.ignoreSubmodules` is set to 'all' or only2810 for those submodules where `submodule.<name>.ignore=all`. The only2811 exception to that rule is that status and commit will show staged2812 submodule changes. To2813 also view the summary for ignored submodules you can either use2814 the --ignore-submodules=dirty command-line option or the 'git2815 submodule summary' command, which shows a similar output but does2816 not honor these settings.28172818stash.showPatch::2819 If this is set to true, the `git stash show` command without an2820 option will show the stash in patch form. Defaults to false.2821 See description of 'show' command in linkgit:git-stash[1].28222823stash.showStat::2824 If this is set to true, the `git stash show` command without an2825 option will show diffstat of the stash. Defaults to true.2826 See description of 'show' command in linkgit:git-stash[1].28272828submodule.<name>.url::2829 The URL for a submodule. This variable is copied from the .gitmodules2830 file to the git config via 'git submodule init'. The user can change2831 the configured URL before obtaining the submodule via 'git submodule2832 update'. After obtaining the submodule, the presence of this variable2833 is used as a sign whether the submodule is of interest to git commands.2834 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.28352836submodule.<name>.update::2837 The default update procedure for a submodule. This variable2838 is populated by `git submodule init` from the2839 linkgit:gitmodules[5] file. See description of 'update'2840 command in linkgit:git-submodule[1].28412842submodule.<name>.branch::2843 The remote branch name for a submodule, used by `git submodule2844 update --remote`. Set this option to override the value found in2845 the `.gitmodules` file. See linkgit:git-submodule[1] and2846 linkgit:gitmodules[5] for details.28472848submodule.<name>.fetchRecurseSubmodules::2849 This option can be used to control recursive fetching of this2850 submodule. It can be overridden by using the --[no-]recurse-submodules2851 command-line option to "git fetch" and "git pull".2852 This setting will override that from in the linkgit:gitmodules[5]2853 file.28542855submodule.<name>.ignore::2856 Defines under what circumstances "git status" and the diff family show2857 a submodule as modified. When set to "all", it will never be considered2858 modified (but it will nonetheless show up in the output of status and2859 commit when it has been staged), "dirty" will ignore all changes2860 to the submodules work tree and2861 takes only differences between the HEAD of the submodule and the commit2862 recorded in the superproject into account. "untracked" will additionally2863 let submodules with modified tracked files in their work tree show up.2864 Using "none" (the default when this option is not set) also shows2865 submodules that have untracked files in their work tree as changed.2866 This setting overrides any setting made in .gitmodules for this submodule,2867 both settings can be overridden on the command line by using the2868 "--ignore-submodules" option. The 'git submodule' commands are not2869 affected by this setting.28702871submodule.fetchJobs::2872 Specifies how many submodules are fetched/cloned at the same time.2873 A positive integer allows up to that number of submodules fetched2874 in parallel. A value of 0 will give some reasonable default.2875 If unset, it defaults to 1.28762877submodule.alternateLocation::2878 Specifies how the submodules obtain alternates when submodules are2879 cloned. Possible values are `no`, `superproject`.2880 By default `no` is assumed, which doesn't add references. When the2881 value is set to `superproject` the submodule to be cloned computes2882 its alternates location relative to the superprojects alternate.28832884submodule.alternateErrorStrategy2885 Specifies how to treat errors with the alternates for a submodule2886 as computed via `submodule.alternateLocation`. Possible values are2887 `ignore`, `info`, `die`. Default is `die`.28882889tag.forceSignAnnotated::2890 A boolean to specify whether annotated tags created should be GPG signed.2891 If `--annotate` is specified on the command line, it takes2892 precedence over this option.28932894tag.sort::2895 This variable controls the sort ordering of tags when displayed by2896 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2897 value of this variable will be used as the default.28982899tar.umask::2900 This variable can be used to restrict the permission bits of2901 tar archive entries. The default is 0002, which turns off the2902 world write bit. The special value "user" indicates that the2903 archiving user's umask will be used instead. See umask(2) and2904 linkgit:git-archive[1].29052906transfer.fsckObjects::2907 When `fetch.fsckObjects` or `receive.fsckObjects` are2908 not set, the value of this variable is used instead.2909 Defaults to false.29102911transfer.hideRefs::2912 String(s) `receive-pack` and `upload-pack` use to decide which2913 refs to omit from their initial advertisements. Use more than2914 one definition to specify multiple prefix strings. A ref that is2915 under the hierarchies listed in the value of this variable is2916 excluded, and is hidden when responding to `git push` or `git2917 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2918 program-specific versions of this config.2919+2920You may also include a `!` in front of the ref name to negate the entry,2921explicitly exposing it, even if an earlier entry marked it as hidden.2922If you have multiple hideRefs values, later entries override earlier ones2923(and entries in more-specific config files override less-specific ones).2924+2925If a namespace is in use, the namespace prefix is stripped from each2926reference before it is matched against `transfer.hiderefs` patterns.2927For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2928the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2929is omitted from the advertisements but `refs/heads/master` and2930`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2931"have" lines. In order to match refs before stripping, add a `^` in front of2932the ref name. If you combine `!` and `^`, `!` must be specified first.29332934transfer.unpackLimit::2935 When `fetch.unpackLimit` or `receive.unpackLimit` are2936 not set, the value of this variable is used instead.2937 The default value is 100.29382939uploadarchive.allowUnreachable::2940 If true, allow clients to use `git archive --remote` to request2941 any tree, whether reachable from the ref tips or not. See the2942 discussion in the `SECURITY` section of2943 linkgit:git-upload-archive[1] for more details. Defaults to2944 `false`.29452946uploadpack.hideRefs::2947 This variable is the same as `transfer.hideRefs`, but applies2948 only to `upload-pack` (and so affects only fetches, not pushes).2949 An attempt to fetch a hidden ref by `git fetch` will fail. See2950 also `uploadpack.allowTipSHA1InWant`.29512952uploadpack.allowTipSHA1InWant::2953 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2954 to accept a fetch request that asks for an object at the tip2955 of a hidden ref (by default, such a request is rejected).2956 see also `uploadpack.hideRefs`.29572958uploadpack.allowReachableSHA1InWant::2959 Allow `upload-pack` to accept a fetch request that asks for an2960 object that is reachable from any ref tip. However, note that2961 calculating object reachability is computationally expensive.2962 Defaults to `false`.29632964uploadpack.keepAlive::2965 When `upload-pack` has started `pack-objects`, there may be a2966 quiet period while `pack-objects` prepares the pack. Normally2967 it would output progress information, but if `--quiet` was used2968 for the fetch, `pack-objects` will output nothing at all until2969 the pack data begins. Some clients and networks may consider2970 the server to be hung and give up. Setting this option instructs2971 `upload-pack` to send an empty keepalive packet every2972 `uploadpack.keepAlive` seconds. Setting this option to 02973 disables keepalive packets entirely. The default is 5 seconds.29742975uploadpack.packObjectsHook::2976 If this option is set, when `upload-pack` would run2977 `git pack-objects` to create a packfile for a client, it will2978 run this shell command instead. The `pack-objects` command and2979 arguments it _would_ have run (including the `git pack-objects`2980 at the beginning) are appended to the shell command. The stdin2981 and stdout of the hook are treated as if `pack-objects` itself2982 was run. I.e., `upload-pack` will feed input intended for2983 `pack-objects` to the hook, and expects a completed packfile on2984 stdout.2985+2986Note that this configuration variable is ignored if it is seen in the2987repository-level config (this is a safety measure against fetching from2988untrusted repositories).29892990url.<base>.insteadOf::2991 Any URL that starts with this value will be rewritten to2992 start, instead, with <base>. In cases where some site serves a2993 large number of repositories, and serves them with multiple2994 access methods, and some users need to use different access2995 methods, this feature allows people to specify any of the2996 equivalent URLs and have Git automatically rewrite the URL to2997 the best alternative for the particular user, even for a2998 never-before-seen repository on the site. When more than one2999 insteadOf strings match a given URL, the longest match is used.30003001url.<base>.pushInsteadOf::3002 Any URL that starts with this value will not be pushed to;3003 instead, it will be rewritten to start with <base>, and the3004 resulting URL will be pushed to. In cases where some site serves3005 a large number of repositories, and serves them with multiple3006 access methods, some of which do not allow push, this feature3007 allows people to specify a pull-only URL and have Git3008 automatically use an appropriate URL to push, even for a3009 never-before-seen repository on the site. When more than one3010 pushInsteadOf strings match a given URL, the longest match is3011 used. If a remote has an explicit pushurl, Git will ignore this3012 setting for that remote.30133014user.email::3015 Your email address to be recorded in any newly created commits.3016 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3017 `EMAIL` environment variables. See linkgit:git-commit-tree[1].30183019user.name::3020 Your full name to be recorded in any newly created commits.3021 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3022 environment variables. See linkgit:git-commit-tree[1].30233024user.useConfigOnly::3025 Instruct Git to avoid trying to guess defaults for `user.email`3026 and `user.name`, and instead retrieve the values only from the3027 configuration. For example, if you have multiple email addresses3028 and would like to use a different one for each repository, then3029 with this configuration option set to `true` in the global config3030 along with a name, Git will prompt you to set up an email before3031 making new commits in a newly cloned repository.3032 Defaults to `false`.30333034user.signingKey::3035 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3036 key you want it to automatically when creating a signed tag or3037 commit, you can override the default selection with this variable.3038 This option is passed unchanged to gpg's --local-user parameter,3039 so you may specify a key using any method that gpg supports.30403041versionsort.prereleaseSuffix::3042 When version sort is used in linkgit:git-tag[1], prerelease3043 tags (e.g. "1.0-rc1") may appear after the main release3044 "1.0". By specifying the suffix "-rc" in this variable,3045 "1.0-rc1" will appear before "1.0".3046+3047This variable can be specified multiple times, once per suffix. The3048order of suffixes in the config file determines the sorting order3049(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX3050is sorted before 1.0-rcXX). The sorting order between different3051suffixes is undefined if they are in multiple config files.30523053web.browser::3054 Specify a web browser that may be used by some commands.3055 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3056 may use it.