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'. If there is no equal sign on the line, the entire line 58is taken as 'name' and the variable is recognized as 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). No other char escape sequence, nor octal 76char sequences are valid. 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 84included file is expanded immediately, as if its contents had been 85found at the location of the include directive. If the value of the 86`include.path` variable is a relative path, the path is considered to be 87relative to the configuration file in which the include directive was 88found. The value of `include.path` is subject to tilde expansion: `~/` 89is expanded to the value of `$HOME`, and `~user/` to the specified 90user's home directory. See below for examples. 91 92Example 93~~~~~~~ 94 95 # Core variables 96 [core] 97 ; Don't trust file modes 98 filemode = false 99 100 # Our diff algorithm 101 [diff] 102 external = /usr/local/bin/diff-wrapper 103 renames = true 104 105 [branch "devel"] 106 remote = origin 107 merge = refs/heads/devel 108 109 # Proxy settings 110 [core] 111 gitProxy="ssh" for "kernel.org" 112 gitProxy=default-proxy ; for the rest 113 114 [include] 115 path = /path/to/foo.inc ; include by absolute path 116 path = foo ; expand "foo" relative to the current file 117 path = ~/foo ; expand "foo" in your $HOME directory 118 119 120Values 121~~~~~~ 122 123Values of many variables are treated as a simple string, but there 124are variables that take values of specific types and there are rules 125as to how to spell them. 126 127boolean:: 128 129 When a variable is said to take a boolean value, many 130 synonyms are accepted for 'true' and 'false'; these are all 131 case-insensitive. 132 133 true;; Boolean true can be spelled as `yes`, `on`, `true`, 134 or `1`. Also, a variable defined without `= <value>` 135 is taken as true. 136 137 false;; Boolean false can be spelled as `no`, `off`, 138 `false`, or `0`. 139+ 140When converting value to the canonical form using '--bool' type 141specifier; 'git config' will ensure that the output is "true" or 142"false" (spelled in lowercase). 143 144integer:: 145 The value for many variables that specify various sizes can 146 be suffixed with `k`, `M`,... to mean "scale the number by 147 1024", "by 1024x1024", etc. 148 149 150Variables 151~~~~~~~~~ 152 153Note that this list is non-comprehensive and not necessarily complete. 154For command-specific variables, you will find a more detailed description 155in the appropriate manual page. You will find a description of non-core 156porcelain configuration variables in the respective porcelain documentation. 157 158advice.*:: 159 These variables control various optional help messages designed to 160 aid new users. All 'advice.*' variables default to 'true', and you 161 can tell Git that you do not need help by setting these to 'false': 162+ 163-- 164 pushUpdateRejected:: 165 Set this variable to 'false' if you want to disable 166 'pushNonFFCurrent', 'pushNonFFDefault', 167 'pushNonFFMatching', 'pushAlreadyExists', 168 'pushFetchFirst', and 'pushNeedsForce' 169 simultaneously. 170 pushNonFFCurrent:: 171 Advice shown when linkgit:git-push[1] fails due to a 172 non-fast-forward update to the current branch. 173 pushNonFFDefault:: 174 Advice to set 'push.default' to 'upstream' or 'current' 175 when you ran linkgit:git-push[1] and pushed 'matching 176 refs' by default (i.e. you did not provide an explicit 177 refspec, and no 'push.default' configuration was set) 178 and it resulted in a non-fast-forward error. 179 pushNonFFMatching:: 180 Advice shown when you ran linkgit:git-push[1] and pushed 181 'matching refs' explicitly (i.e. you used ':', or 182 specified a refspec that isn't your current branch) and 183 it resulted in a non-fast-forward error. 184 pushAlreadyExists:: 185 Shown when linkgit:git-push[1] rejects an update that 186 does not qualify for fast-forwarding (e.g., a tag.) 187 pushFetchFirst:: 188 Shown when linkgit:git-push[1] rejects an update that 189 tries to overwrite a remote ref that points at an 190 object we do not have. 191 pushNeedsForce:: 192 Shown when linkgit:git-push[1] rejects an update that 193 tries to overwrite a remote ref that points at an 194 object that is not a commit-ish, or make the remote 195 ref point at an object that is not a commit-ish. 196 statusHints:: 197 Show directions on how to proceed from the current 198 state in the output of linkgit:git-status[1], in 199 the template shown when writing commit messages in 200 linkgit:git-commit[1], and in the help message shown 201 by linkgit:git-checkout[1] when switching branch. 202 statusUoption:: 203 Advise to consider using the `-u` option to linkgit:git-status[1] 204 when the command takes more than 2 seconds to enumerate untracked 205 files. 206 commitBeforeMerge:: 207 Advice shown when linkgit:git-merge[1] refuses to 208 merge to avoid overwriting local changes. 209 resolveConflict:: 210 Advice shown by various commands when conflicts 211 prevent the operation from being performed. 212 implicitIdentity:: 213 Advice on how to set your identity configuration when 214 your information is guessed from the system username and 215 domain name. 216 detachedHead:: 217 Advice shown when you used linkgit:git-checkout[1] to 218 move to the detach HEAD state, to instruct how to create 219 a local branch after the fact. 220 amWorkDir:: 221 Advice that shows the location of the patch file when 222 linkgit:git-am[1] fails to apply it. 223 rmHints:: 224 In case of failure in the output of linkgit:git-rm[1], 225 show directions on how to proceed from the current state. 226-- 227 228core.fileMode:: 229 If false, the executable bit differences between the index and 230 the working tree are ignored; useful on broken filesystems like FAT. 231 See linkgit:git-update-index[1]. 232+ 233The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 234will probe and set core.fileMode false if appropriate when the 235repository is created. 236 237core.ignorecase:: 238 If true, this option enables various workarounds to enable 239 Git to work better on filesystems that are not case sensitive, 240 like FAT. For example, if a directory listing finds 241 "makefile" when Git expects "Makefile", Git will assume 242 it is really the same file, and continue to remember it as 243 "Makefile". 244+ 245The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 246will probe and set core.ignorecase true if appropriate when the repository 247is created. 248 249core.precomposeunicode:: 250 This option is only used by Mac OS implementation of Git. 251 When core.precomposeunicode=true, Git reverts the unicode decomposition 252 of filenames done by Mac OS. This is useful when sharing a repository 253 between Mac OS and Linux or Windows. 254 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 255 When false, file names are handled fully transparent by Git, 256 which is backward compatible with older versions of Git. 257 258core.protectHFS:: 259 If set to true, do not allow checkout of paths that would 260 be considered equivalent to `.git` on an HFS+ filesystem. 261 Defaults to `true` on Mac OS, and `false` elsewhere. 262 263core.protectNTFS:: 264 If set to true, do not allow checkout of paths that would 265 cause problems with the NTFS filesystem, e.g. conflict with 266 8.3 "short" names. 267 Defaults to `true` on Windows, and `false` elsewhere. 268 269core.trustctime:: 270 If false, the ctime differences between the index and the 271 working tree are ignored; useful when the inode change time 272 is regularly modified by something outside Git (file system 273 crawlers and some backup systems). 274 See linkgit:git-update-index[1]. True by default. 275 276core.checkstat:: 277 Determines which stat fields to match between the index 278 and work tree. The user can set this to 'default' or 279 'minimal'. Default (or explicitly 'default'), is to check 280 all fields, including the sub-second part of mtime and ctime. 281 282core.quotepath:: 283 The commands that output paths (e.g. 'ls-files', 284 'diff'), when not given the `-z` option, will quote 285 "unusual" characters in the pathname by enclosing the 286 pathname in a double-quote pair and with backslashes the 287 same way strings in C source code are quoted. If this 288 variable is set to false, the bytes higher than 0x80 are 289 not quoted but output as verbatim. Note that double 290 quote, backslash and control characters are always 291 quoted without `-z` regardless of the setting of this 292 variable. 293 294core.eol:: 295 Sets the line ending type to use in the working directory for 296 files that have the `text` property set. Alternatives are 297 'lf', 'crlf' and 'native', which uses the platform's native 298 line ending. The default value is `native`. See 299 linkgit:gitattributes[5] for more information on end-of-line 300 conversion. 301 302core.safecrlf:: 303 If true, makes Git check if converting `CRLF` is reversible when 304 end-of-line conversion is active. Git will verify if a command 305 modifies a file in the work tree either directly or indirectly. 306 For example, committing a file followed by checking out the 307 same file should yield the original file in the work tree. If 308 this is not the case for the current setting of 309 `core.autocrlf`, Git will reject the file. The variable can 310 be set to "warn", in which case Git will only warn about an 311 irreversible conversion but continue the operation. 312+ 313CRLF conversion bears a slight chance of corrupting data. 314When it is enabled, Git will convert CRLF to LF during commit and LF to 315CRLF during checkout. A file that contains a mixture of LF and 316CRLF before the commit cannot be recreated by Git. For text 317files this is the right thing to do: it corrects line endings 318such that we have only LF line endings in the repository. 319But for binary files that are accidentally classified as text the 320conversion can corrupt data. 321+ 322If you recognize such corruption early you can easily fix it by 323setting the conversion type explicitly in .gitattributes. Right 324after committing you still have the original file in your work 325tree and this file is not yet corrupted. You can explicitly tell 326Git that this file is binary and Git will handle the file 327appropriately. 328+ 329Unfortunately, the desired effect of cleaning up text files with 330mixed line endings and the undesired effect of corrupting binary 331files cannot be distinguished. In both cases CRLFs are removed 332in an irreversible way. For text files this is the right thing 333to do because CRLFs are line endings, while for binary files 334converting CRLFs corrupts data. 335+ 336Note, this safety check does not mean that a checkout will generate a 337file identical to the original file for a different setting of 338`core.eol` and `core.autocrlf`, but only for the current one. For 339example, a text file with `LF` would be accepted with `core.eol=lf` 340and could later be checked out with `core.eol=crlf`, in which case the 341resulting file would contain `CRLF`, although the original file 342contained `LF`. However, in both work trees the line endings would be 343consistent, that is either all `LF` or all `CRLF`, but never mixed. A 344file with mixed line endings would be reported by the `core.safecrlf` 345mechanism. 346 347core.autocrlf:: 348 Setting this variable to "true" is almost the same as setting 349 the `text` attribute to "auto" on all files except that text 350 files are not guaranteed to be normalized: files that contain 351 `CRLF` in the repository will not be touched. Use this 352 setting if you want to have `CRLF` line endings in your 353 working directory even though the repository does not have 354 normalized line endings. This variable can be set to 'input', 355 in which case no output conversion is performed. 356 357core.symlinks:: 358 If false, symbolic links are checked out as small plain files that 359 contain the link text. linkgit:git-update-index[1] and 360 linkgit:git-add[1] will not change the recorded type to regular 361 file. Useful on filesystems like FAT that do not support 362 symbolic links. 363+ 364The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 365will probe and set core.symlinks false if appropriate when the repository 366is created. 367 368core.gitProxy:: 369 A "proxy command" to execute (as 'command host port') instead 370 of establishing direct connection to the remote server when 371 using the Git protocol for fetching. If the variable value is 372 in the "COMMAND for DOMAIN" format, the command is applied only 373 on hostnames ending with the specified domain string. This variable 374 may be set multiple times and is matched in the given order; 375 the first match wins. 376+ 377Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 378(which always applies universally, without the special "for" 379handling). 380+ 381The special string `none` can be used as the proxy command to 382specify that no proxy be used for a given domain pattern. 383This is useful for excluding servers inside a firewall from 384proxy use, while defaulting to a common proxy for external domains. 385 386core.ignoreStat:: 387 If true, commands which modify both the working tree and the index 388 will mark the updated paths with the "assume unchanged" bit in the 389 index. These marked files are then assumed to stay unchanged in the 390 working tree, until you mark them otherwise manually - Git will not 391 detect the file changes by lstat() calls. This is useful on systems 392 where those are very slow, such as Microsoft Windows. 393 See linkgit:git-update-index[1]. 394 False by default. 395 396core.preferSymlinkRefs:: 397 Instead of the default "symref" format for HEAD 398 and other symbolic reference files, use symbolic links. 399 This is sometimes needed to work with old scripts that 400 expect HEAD to be a symbolic link. 401 402core.bare:: 403 If true this repository is assumed to be 'bare' and has no 404 working directory associated with it. If this is the case a 405 number of commands that require a working directory will be 406 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 407+ 408This setting is automatically guessed by linkgit:git-clone[1] or 409linkgit:git-init[1] when the repository was created. By default a 410repository that ends in "/.git" is assumed to be not bare (bare = 411false), while all other repositories are assumed to be bare (bare 412= true). 413 414core.worktree:: 415 Set the path to the root of the working tree. 416 This can be overridden by the GIT_WORK_TREE environment 417 variable and the '--work-tree' command line option. 418 The value can be an absolute path or relative to the path to 419 the .git directory, which is either specified by --git-dir 420 or GIT_DIR, or automatically discovered. 421 If --git-dir or GIT_DIR is specified but none of 422 --work-tree, GIT_WORK_TREE and core.worktree is specified, 423 the current working directory is regarded as the top level 424 of your working tree. 425+ 426Note that this variable is honored even when set in a configuration 427file in a ".git" subdirectory of a directory and its value differs 428from the latter directory (e.g. "/path/to/.git/config" has 429core.worktree set to "/different/path"), which is most likely a 430misconfiguration. Running Git commands in the "/path/to" directory will 431still use "/different/path" as the root of the work tree and can cause 432confusion unless you know what you are doing (e.g. you are creating a 433read-only snapshot of the same index to a location different from the 434repository's usual working tree). 435 436core.logAllRefUpdates:: 437 Enable the reflog. Updates to a ref <ref> is logged to the file 438 "$GIT_DIR/logs/<ref>", by appending the new and old 439 SHA-1, the date/time and the reason of the update, but 440 only when the file exists. If this configuration 441 variable is set to true, missing "$GIT_DIR/logs/<ref>" 442 file is automatically created for branch heads (i.e. under 443 refs/heads/), remote refs (i.e. under refs/remotes/), 444 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 445+ 446This information can be used to determine what commit 447was the tip of a branch "2 days ago". 448+ 449This value is true by default in a repository that has 450a working directory associated with it, and false by 451default in a bare repository. 452 453core.repositoryFormatVersion:: 454 Internal variable identifying the repository format and layout 455 version. 456 457core.sharedRepository:: 458 When 'group' (or 'true'), the repository is made shareable between 459 several users in a group (making sure all the files and objects are 460 group-writable). When 'all' (or 'world' or 'everybody'), the 461 repository will be readable by all users, additionally to being 462 group-shareable. When 'umask' (or 'false'), Git will use permissions 463 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 464 files in the repository will have this mode value. '0xxx' will override 465 user's umask value (whereas the other options will only override 466 requested parts of the user's umask value). Examples: '0660' will make 467 the repo read/write-able for the owner and group, but inaccessible to 468 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 469 repository that is group-readable but not group-writable. 470 See linkgit:git-init[1]. False by default. 471 472core.warnAmbiguousRefs:: 473 If true, Git will warn you if the ref name you passed it is ambiguous 474 and might match multiple refs in the repository. True by default. 475 476core.compression:: 477 An integer -1..9, indicating a default compression level. 478 -1 is the zlib default. 0 means no compression, 479 and 1..9 are various speed/size tradeoffs, 9 being slowest. 480 If set, this provides a default to other compression variables, 481 such as 'core.loosecompression' and 'pack.compression'. 482 483core.loosecompression:: 484 An integer -1..9, indicating the compression level for objects that 485 are not in a pack file. -1 is the zlib default. 0 means no 486 compression, and 1..9 are various speed/size tradeoffs, 9 being 487 slowest. If not set, defaults to core.compression. If that is 488 not set, defaults to 1 (best speed). 489 490core.packedGitWindowSize:: 491 Number of bytes of a pack file to map into memory in a 492 single mapping operation. Larger window sizes may allow 493 your system to process a smaller number of large pack files 494 more quickly. Smaller window sizes will negatively affect 495 performance due to increased calls to the operating system's 496 memory manager, but may improve performance when accessing 497 a large number of large pack files. 498+ 499Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 500MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 501be reasonable for all users/operating systems. You probably do 502not need to adjust this value. 503+ 504Common unit suffixes of 'k', 'm', or 'g' are supported. 505 506core.packedGitLimit:: 507 Maximum number of bytes to map simultaneously into memory 508 from pack files. If Git needs to access more than this many 509 bytes at once to complete an operation it will unmap existing 510 regions to reclaim virtual address space within the process. 511+ 512Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 513This should be reasonable for all users/operating systems, except on 514the largest projects. You probably do not need to adjust this value. 515+ 516Common unit suffixes of 'k', 'm', or 'g' are supported. 517 518core.deltaBaseCacheLimit:: 519 Maximum number of bytes to reserve for caching base objects 520 that may be referenced by multiple deltified objects. By storing the 521 entire decompressed base objects in a cache Git is able 522 to avoid unpacking and decompressing frequently used base 523 objects multiple times. 524+ 525Default is 16 MiB on all platforms. This should be reasonable 526for all users/operating systems, except on the largest projects. 527You probably do not need to adjust this value. 528+ 529Common unit suffixes of 'k', 'm', or 'g' are supported. 530 531core.bigFileThreshold:: 532 Files larger than this size are stored deflated, without 533 attempting delta compression. Storing large files without 534 delta compression avoids excessive memory usage, at the 535 slight expense of increased disk usage. 536+ 537Default is 512 MiB on all platforms. This should be reasonable 538for most projects as source code and other text files can still 539be delta compressed, but larger binary media files won't be. 540+ 541Common unit suffixes of 'k', 'm', or 'g' are supported. 542 543core.excludesfile:: 544 In addition to '.gitignore' (per-directory) and 545 '.git/info/exclude', Git looks into this file for patterns 546 of files which are not meant to be tracked. "`~/`" is expanded 547 to the value of `$HOME` and "`~user/`" to the specified user's 548 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 549 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 550 is used instead. See linkgit:gitignore[5]. 551 552core.askpass:: 553 Some commands (e.g. svn and http interfaces) that interactively 554 ask for a password can be told to use an external program given 555 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 556 environment variable. If not set, fall back to the value of the 557 'SSH_ASKPASS' environment variable or, failing that, a simple password 558 prompt. The external program shall be given a suitable prompt as 559 command line argument and write the password on its STDOUT. 560 561core.attributesfile:: 562 In addition to '.gitattributes' (per-directory) and 563 '.git/info/attributes', Git looks into this file for attributes 564 (see linkgit:gitattributes[5]). Path expansions are made the same 565 way as for `core.excludesfile`. Its default value is 566 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 567 set or empty, $HOME/.config/git/attributes is used instead. 568 569core.editor:: 570 Commands such as `commit` and `tag` that lets you edit 571 messages by launching an editor uses the value of this 572 variable when it is set, and the environment variable 573 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 574 575core.commentchar:: 576 Commands such as `commit` and `tag` that lets you edit 577 messages consider a line that begins with this character 578 commented, and removes them after the editor returns 579 (default '#'). 580 581sequence.editor:: 582 Text editor used by `git rebase -i` for editing the rebase instruction file. 583 The value is meant to be interpreted by the shell when it is used. 584 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 585 When not configured the default commit message editor is used instead. 586 587core.pager:: 588 Text viewer for use by Git commands (e.g., 'less'). The value 589 is meant to be interpreted by the shell. The order of preference 590 is the `$GIT_PAGER` environment variable, then `core.pager` 591 configuration, then `$PAGER`, and then the default chosen at 592 compile time (usually 'less'). 593+ 594When the `LESS` environment variable is unset, Git sets it to `FRSX` 595(if `LESS` environment variable is set, Git does not change it at 596all). If you want to selectively override Git's default setting 597for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 598be passed to the shell by Git, which will translate the final 599command to `LESS=FRSX less -+S`. The environment tells the command 600to set the `S` option to chop long lines but the command line 601resets it to the default to fold long lines. 602 603core.whitespace:: 604 A comma separated list of common whitespace problems to 605 notice. 'git diff' will use `color.diff.whitespace` to 606 highlight them, and 'git apply --whitespace=error' will 607 consider them as errors. You can prefix `-` to disable 608 any of them (e.g. `-trailing-space`): 609+ 610* `blank-at-eol` treats trailing whitespaces at the end of the line 611 as an error (enabled by default). 612* `space-before-tab` treats a space character that appears immediately 613 before a tab character in the initial indent part of the line as an 614 error (enabled by default). 615* `indent-with-non-tab` treats a line that is indented with space 616 characters instead of the equivalent tabs as an error (not enabled by 617 default). 618* `tab-in-indent` treats a tab character in the initial indent part of 619 the line as an error (not enabled by default). 620* `blank-at-eof` treats blank lines added at the end of file as an error 621 (enabled by default). 622* `trailing-space` is a short-hand to cover both `blank-at-eol` and 623 `blank-at-eof`. 624* `cr-at-eol` treats a carriage-return at the end of line as 625 part of the line terminator, i.e. with it, `trailing-space` 626 does not trigger if the character before such a carriage-return 627 is not a whitespace (not enabled by default). 628* `tabwidth=<n>` tells how many character positions a tab occupies; this 629 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 630 errors. The default tab width is 8. Allowed values are 1 to 63. 631 632core.fsyncobjectfiles:: 633 This boolean will enable 'fsync()' when writing object files. 634+ 635This is a total waste of time and effort on a filesystem that orders 636data writes properly, but can be useful for filesystems that do not use 637journalling (traditional UNIX filesystems) or that only journal metadata 638and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 639 640core.preloadindex:: 641 Enable parallel index preload for operations like 'git diff' 642+ 643This can speed up operations like 'git diff' and 'git status' especially 644on filesystems like NFS that have weak caching semantics and thus 645relatively high IO latencies. With this set to 'true', Git will do the 646index comparison to the filesystem data in parallel, allowing 647overlapping IO's. 648 649core.createObject:: 650 You can set this to 'link', in which case a hardlink followed by 651 a delete of the source are used to make sure that object creation 652 will not overwrite existing objects. 653+ 654On some file system/operating system combinations, this is unreliable. 655Set this config setting to 'rename' there; However, This will remove the 656check that makes sure that existing object files will not get overwritten. 657 658core.notesRef:: 659 When showing commit messages, also show notes which are stored in 660 the given ref. The ref must be fully qualified. If the given 661 ref does not exist, it is not an error but means that no 662 notes should be printed. 663+ 664This setting defaults to "refs/notes/commits", and it can be overridden by 665the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 666 667core.sparseCheckout:: 668 Enable "sparse checkout" feature. See section "Sparse checkout" in 669 linkgit:git-read-tree[1] for more information. 670 671core.abbrev:: 672 Set the length object names are abbreviated to. If unspecified, 673 many commands abbreviate to 7 hexdigits, which may not be enough 674 for abbreviated object names to stay unique for sufficiently long 675 time. 676 677add.ignore-errors:: 678add.ignoreErrors:: 679 Tells 'git add' to continue adding files when some files cannot be 680 added due to indexing errors. Equivalent to the '--ignore-errors' 681 option of linkgit:git-add[1]. Older versions of Git accept only 682 `add.ignore-errors`, which does not follow the usual naming 683 convention for configuration variables. Newer versions of Git 684 honor `add.ignoreErrors` as well. 685 686alias.*:: 687 Command aliases for the linkgit:git[1] command wrapper - e.g. 688 after defining "alias.last = cat-file commit HEAD", the invocation 689 "git last" is equivalent to "git cat-file commit HEAD". To avoid 690 confusion and troubles with script usage, aliases that 691 hide existing Git commands are ignored. Arguments are split by 692 spaces, the usual shell quoting and escaping is supported. 693 quote pair and a backslash can be used to quote them. 694+ 695If the alias expansion is prefixed with an exclamation point, 696it will be treated as a shell command. For example, defining 697"alias.new = !gitk --all --not ORIG_HEAD", the invocation 698"git new" is equivalent to running the shell command 699"gitk --all --not ORIG_HEAD". Note that shell commands will be 700executed from the top-level directory of a repository, which may 701not necessarily be the current directory. 702'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 703from the original current directory. See linkgit:git-rev-parse[1]. 704 705am.keepcr:: 706 If true, git-am will call git-mailsplit for patches in mbox format 707 with parameter '--keep-cr'. In this case git-mailsplit will 708 not remove `\r` from lines ending with `\r\n`. Can be overridden 709 by giving '--no-keep-cr' from the command line. 710 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 711 712apply.ignorewhitespace:: 713 When set to 'change', tells 'git apply' to ignore changes in 714 whitespace, in the same way as the '--ignore-space-change' 715 option. 716 When set to one of: no, none, never, false tells 'git apply' to 717 respect all whitespace differences. 718 See linkgit:git-apply[1]. 719 720apply.whitespace:: 721 Tells 'git apply' how to handle whitespaces, in the same way 722 as the '--whitespace' option. See linkgit:git-apply[1]. 723 724branch.autosetupmerge:: 725 Tells 'git branch' and 'git checkout' to set up new branches 726 so that linkgit:git-pull[1] will appropriately merge from the 727 starting point branch. Note that even if this option is not set, 728 this behavior can be chosen per-branch using the `--track` 729 and `--no-track` options. The valid settings are: `false` -- no 730 automatic setup is done; `true` -- automatic setup is done when the 731 starting point is a remote-tracking branch; `always` -- 732 automatic setup is done when the starting point is either a 733 local branch or remote-tracking 734 branch. This option defaults to true. 735 736branch.autosetuprebase:: 737 When a new branch is created with 'git branch' or 'git checkout' 738 that tracks another branch, this variable tells Git to set 739 up pull to rebase instead of merge (see "branch.<name>.rebase"). 740 When `never`, rebase is never automatically set to true. 741 When `local`, rebase is set to true for tracked branches of 742 other local branches. 743 When `remote`, rebase is set to true for tracked branches of 744 remote-tracking branches. 745 When `always`, rebase will be set to true for all tracking 746 branches. 747 See "branch.autosetupmerge" for details on how to set up a 748 branch to track another branch. 749 This option defaults to never. 750 751branch.<name>.remote:: 752 When on branch <name>, it tells 'git fetch' and 'git push' 753 which remote to fetch from/push to. The remote to push to 754 may be overridden with `remote.pushdefault` (for all branches). 755 The remote to push to, for the current branch, may be further 756 overridden by `branch.<name>.pushremote`. If no remote is 757 configured, or if you are not on any branch, it defaults to 758 `origin` for fetching and `remote.pushdefault` for pushing. 759 Additionally, `.` (a period) is the current local repository 760 (a dot-repository), see `branch.<name>.merge`'s final note below. 761 762branch.<name>.pushremote:: 763 When on branch <name>, it overrides `branch.<name>.remote` for 764 pushing. It also overrides `remote.pushdefault` for pushing 765 from branch <name>. When you pull from one place (e.g. your 766 upstream) and push to another place (e.g. your own publishing 767 repository), you would want to set `remote.pushdefault` to 768 specify the remote to push to for all branches, and use this 769 option to override it for a specific branch. 770 771branch.<name>.merge:: 772 Defines, together with branch.<name>.remote, the upstream branch 773 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 774 branch to merge and can also affect 'git push' (see push.default). 775 When in branch <name>, it tells 'git fetch' the default 776 refspec to be marked for merging in FETCH_HEAD. The value is 777 handled like the remote part of a refspec, and must match a 778 ref which is fetched from the remote given by 779 "branch.<name>.remote". 780 The merge information is used by 'git pull' (which at first calls 781 'git fetch') to lookup the default branch for merging. Without 782 this option, 'git pull' defaults to merge the first refspec fetched. 783 Specify multiple values to get an octopus merge. 784 If you wish to setup 'git pull' so that it merges into <name> from 785 another branch in the local repository, you can point 786 branch.<name>.merge to the desired branch, and use the relative path 787 setting `.` (a period) for branch.<name>.remote. 788 789branch.<name>.mergeoptions:: 790 Sets default options for merging into branch <name>. The syntax and 791 supported options are the same as those of linkgit:git-merge[1], but 792 option values containing whitespace characters are currently not 793 supported. 794 795branch.<name>.rebase:: 796 When true, rebase the branch <name> on top of the fetched branch, 797 instead of merging the default branch from the default remote when 798 "git pull" is run. See "pull.rebase" for doing this in a non 799 branch-specific manner. 800+ 801 When preserve, also pass `--preserve-merges` along to 'git rebase' 802 so that locally committed merge commits will not be flattened 803 by running 'git pull'. 804+ 805*NOTE*: this is a possibly dangerous operation; do *not* use 806it unless you understand the implications (see linkgit:git-rebase[1] 807for details). 808 809branch.<name>.description:: 810 Branch description, can be edited with 811 `git branch --edit-description`. Branch description is 812 automatically added in the format-patch cover letter or 813 request-pull summary. 814 815browser.<tool>.cmd:: 816 Specify the command to invoke the specified browser. The 817 specified command is evaluated in shell with the URLs passed 818 as arguments. (See linkgit:git-web{litdd}browse[1].) 819 820browser.<tool>.path:: 821 Override the path for the given tool that may be used to 822 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 823 working repository in gitweb (see linkgit:git-instaweb[1]). 824 825clean.requireForce:: 826 A boolean to make git-clean do nothing unless given -f, 827 -i or -n. Defaults to true. 828 829color.branch:: 830 A boolean to enable/disable color in the output of 831 linkgit:git-branch[1]. May be set to `always`, 832 `false` (or `never`) or `auto` (or `true`), in which case colors are used 833 only when the output is to a terminal. Defaults to false. 834 835color.branch.<slot>:: 836 Use customized color for branch coloration. `<slot>` is one of 837 `current` (the current branch), `local` (a local branch), 838 `remote` (a remote-tracking branch in refs/remotes/), 839 `upstream` (upstream tracking branch), `plain` (other 840 refs). 841+ 842The value for these configuration variables is a list of colors (at most 843two) and attributes (at most one), separated by spaces. The colors 844accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 845`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 846`blink` and `reverse`. The first color given is the foreground; the 847second is the background. The position of the attribute, if any, 848doesn't matter. 849 850color.diff:: 851 Whether to use ANSI escape sequences to add color to patches. 852 If this is set to `always`, linkgit:git-diff[1], 853 linkgit:git-log[1], and linkgit:git-show[1] will use color 854 for all patches. If it is set to `true` or `auto`, those 855 commands will only use color when output is to the terminal. 856 Defaults to false. 857+ 858This does not affect linkgit:git-format-patch[1] nor the 859'git-diff-{asterisk}' plumbing commands. Can be overridden on the 860command line with the `--color[=<when>]` option. 861 862color.diff.<slot>:: 863 Use customized color for diff colorization. `<slot>` specifies 864 which part of the patch to use the specified color, and is one 865 of `plain` (context text), `meta` (metainformation), `frag` 866 (hunk header), 'func' (function in hunk header), `old` (removed lines), 867 `new` (added lines), `commit` (commit headers), or `whitespace` 868 (highlighting whitespace errors). The values of these variables may be 869 specified as in color.branch.<slot>. 870 871color.decorate.<slot>:: 872 Use customized color for 'git log --decorate' output. `<slot>` is one 873 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 874 branches, remote-tracking branches, tags, stash and HEAD, respectively. 875 876color.grep:: 877 When set to `always`, always highlight matches. When `false` (or 878 `never`), never. When set to `true` or `auto`, use color only 879 when the output is written to the terminal. Defaults to `false`. 880 881color.grep.<slot>:: 882 Use customized color for grep colorization. `<slot>` specifies which 883 part of the line to use the specified color, and is one of 884+ 885-- 886`context`;; 887 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 888`filename`;; 889 filename prefix (when not using `-h`) 890`function`;; 891 function name lines (when using `-p`) 892`linenumber`;; 893 line number prefix (when using `-n`) 894`match`;; 895 matching text 896`selected`;; 897 non-matching text in selected lines 898`separator`;; 899 separators between fields on a line (`:`, `-`, and `=`) 900 and between hunks (`--`) 901-- 902+ 903The values of these variables may be specified as in color.branch.<slot>. 904 905color.interactive:: 906 When set to `always`, always use colors for interactive prompts 907 and displays (such as those used by "git-add --interactive" and 908 "git-clean --interactive"). When false (or `never`), never. 909 When set to `true` or `auto`, use colors only when the output is 910 to the terminal. Defaults to false. 911 912color.interactive.<slot>:: 913 Use customized color for 'git add --interactive' and 'git clean 914 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 915 or `error`, for four distinct types of normal output from 916 interactive commands. The values of these variables may be 917 specified as in color.branch.<slot>. 918 919color.pager:: 920 A boolean to enable/disable colored output when the pager is in 921 use (default is true). 922 923color.showbranch:: 924 A boolean to enable/disable color in the output of 925 linkgit:git-show-branch[1]. May be set to `always`, 926 `false` (or `never`) or `auto` (or `true`), in which case colors are used 927 only when the output is to a terminal. Defaults to false. 928 929color.status:: 930 A boolean to enable/disable color in the output of 931 linkgit:git-status[1]. May be set to `always`, 932 `false` (or `never`) or `auto` (or `true`), in which case colors are used 933 only when the output is to a terminal. Defaults to false. 934 935color.status.<slot>:: 936 Use customized color for status colorization. `<slot>` is 937 one of `header` (the header text of the status message), 938 `added` or `updated` (files which are added but not committed), 939 `changed` (files which are changed but not added in the index), 940 `untracked` (files which are not tracked by Git), 941 `branch` (the current branch), or 942 `nobranch` (the color the 'no branch' warning is shown in, defaulting 943 to red). The values of these variables may be specified as in 944 color.branch.<slot>. 945 946color.ui:: 947 This variable determines the default value for variables such 948 as `color.diff` and `color.grep` that control the use of color 949 per command family. Its scope will expand as more commands learn 950 configuration to set a default for the `--color` option. Set it 951 to `false` or `never` if you prefer Git commands not to use 952 color unless enabled explicitly with some other configuration 953 or the `--color` option. Set it to `always` if you want all 954 output not intended for machine consumption to use color, to 955 `true` or `auto` (this is the default since Git 1.8.4) if you 956 want such output to use color when written to the terminal. 957 958column.ui:: 959 Specify whether supported commands should output in columns. 960 This variable consists of a list of tokens separated by spaces 961 or commas: 962+ 963These options control when the feature should be enabled 964(defaults to 'never'): 965+ 966-- 967`always`;; 968 always show in columns 969`never`;; 970 never show in columns 971`auto`;; 972 show in columns if the output is to the terminal 973-- 974+ 975These options control layout (defaults to 'column'). Setting any 976of these implies 'always' if none of 'always', 'never', or 'auto' are 977specified. 978+ 979-- 980`column`;; 981 fill columns before rows 982`row`;; 983 fill rows before columns 984`plain`;; 985 show in one column 986-- 987+ 988Finally, these options can be combined with a layout option (defaults 989to 'nodense'): 990+ 991-- 992`dense`;; 993 make unequal size columns to utilize more space 994`nodense`;; 995 make equal size columns 996-- 997 998column.branch:: 999 Specify whether to output branch listing in `git branch` in columns.1000 See `column.ui` for details.10011002column.clean::1003 Specify the layout when list items in `git clean -i`, which always1004 shows files and directories in columns. See `column.ui` for details.10051006column.status::1007 Specify whether to output untracked files in `git status` in columns.1008 See `column.ui` for details.10091010column.tag::1011 Specify whether to output tag listing in `git tag` in columns.1012 See `column.ui` for details.10131014commit.cleanup::1015 This setting overrides the default of the `--cleanup` option in1016 `git commit`. See linkgit:git-commit[1] for details. Changing the1017 default can be useful when you always want to keep lines that begin1018 with comment character `#` in your log message, in which case you1019 would do `git config commit.cleanup whitespace` (note that you will1020 have to remove the help lines that begin with `#` in the commit log1021 template yourself, if you do this).10221023commit.status::1024 A boolean to enable/disable inclusion of status information in the1025 commit message template when using an editor to prepare the commit1026 message. Defaults to true.10271028commit.template::1029 Specify a file to use as the template for new commit messages.1030 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1031 specified user's home directory.10321033credential.helper::1034 Specify an external helper to be called when a username or1035 password credential is needed; the helper may consult external1036 storage to avoid prompting the user for the credentials. See1037 linkgit:gitcredentials[7] for details.10381039credential.useHttpPath::1040 When acquiring credentials, consider the "path" component of an http1041 or https URL to be important. Defaults to false. See1042 linkgit:gitcredentials[7] for more information.10431044credential.username::1045 If no username is set for a network authentication, use this username1046 by default. See credential.<context>.* below, and1047 linkgit:gitcredentials[7].10481049credential.<url>.*::1050 Any of the credential.* options above can be applied selectively to1051 some credentials. For example "credential.https://example.com.username"1052 would set the default username only for https connections to1053 example.com. See linkgit:gitcredentials[7] for details on how URLs are1054 matched.10551056include::diff-config.txt[]10571058difftool.<tool>.path::1059 Override the path for the given tool. This is useful in case1060 your tool is not in the PATH.10611062difftool.<tool>.cmd::1063 Specify the command to invoke the specified diff tool.1064 The specified command is evaluated in shell with the following1065 variables available: 'LOCAL' is set to the name of the temporary1066 file containing the contents of the diff pre-image and 'REMOTE'1067 is set to the name of the temporary file containing the contents1068 of the diff post-image.10691070difftool.prompt::1071 Prompt before each invocation of the diff tool.10721073fetch.recurseSubmodules::1074 This option can be either set to a boolean value or to 'on-demand'.1075 Setting it to a boolean changes the behavior of fetch and pull to1076 unconditionally recurse into submodules when set to true or to not1077 recurse at all when set to false. When set to 'on-demand' (the default1078 value), fetch and pull will only recurse into a populated submodule1079 when its superproject retrieves a commit that updates the submodule's1080 reference.10811082fetch.fsckObjects::1083 If it is set to true, git-fetch-pack will check all fetched1084 objects. It will abort in the case of a malformed object or a1085 broken link. The result of an abort are only dangling objects.1086 Defaults to false. If not set, the value of `transfer.fsckObjects`1087 is used instead.10881089fetch.unpackLimit::1090 If the number of objects fetched over the Git native1091 transfer is below this1092 limit, then the objects will be unpacked into loose object1093 files. However if the number of received objects equals or1094 exceeds this limit then the received pack will be stored as1095 a pack, after adding any missing delta bases. Storing the1096 pack from a push can make the push operation complete faster,1097 especially on slow filesystems. If not set, the value of1098 `transfer.unpackLimit` is used instead.10991100fetch.prune::1101 If true, fetch will automatically behave as if the `--prune`1102 option was given on the command line. See also `remote.<name>.prune`.11031104format.attach::1105 Enable multipart/mixed attachments as the default for1106 'format-patch'. The value can also be a double quoted string1107 which will enable attachments as the default and set the1108 value as the boundary. See the --attach option in1109 linkgit:git-format-patch[1].11101111format.numbered::1112 A boolean which can enable or disable sequence numbers in patch1113 subjects. It defaults to "auto" which enables it only if there1114 is more than one patch. It can be enabled or disabled for all1115 messages by setting it to "true" or "false". See --numbered1116 option in linkgit:git-format-patch[1].11171118format.headers::1119 Additional email headers to include in a patch to be submitted1120 by mail. See linkgit:git-format-patch[1].11211122format.to::1123format.cc::1124 Additional recipients to include in a patch to be submitted1125 by mail. See the --to and --cc options in1126 linkgit:git-format-patch[1].11271128format.subjectprefix::1129 The default for format-patch is to output files with the '[PATCH]'1130 subject prefix. Use this variable to change that prefix.11311132format.signature::1133 The default for format-patch is to output a signature containing1134 the Git version number. Use this variable to change that default.1135 Set this variable to the empty string ("") to suppress1136 signature generation.11371138format.suffix::1139 The default for format-patch is to output files with the suffix1140 `.patch`. Use this variable to change that suffix (make sure to1141 include the dot if you want it).11421143format.pretty::1144 The default pretty format for log/show/whatchanged command,1145 See linkgit:git-log[1], linkgit:git-show[1],1146 linkgit:git-whatchanged[1].11471148format.thread::1149 The default threading style for 'git format-patch'. Can be1150 a boolean value, or `shallow` or `deep`. `shallow` threading1151 makes every mail a reply to the head of the series,1152 where the head is chosen from the cover letter, the1153 `--in-reply-to`, and the first patch mail, in this order.1154 `deep` threading makes every mail a reply to the previous one.1155 A true boolean value is the same as `shallow`, and a false1156 value disables threading.11571158format.signoff::1159 A boolean value which lets you enable the `-s/--signoff` option of1160 format-patch by default. *Note:* Adding the Signed-off-by: line to a1161 patch should be a conscious act and means that you certify you have1162 the rights to submit this work under the same open source license.1163 Please see the 'SubmittingPatches' document for further discussion.11641165format.coverLetter::1166 A boolean that controls whether to generate a cover-letter when1167 format-patch is invoked, but in addition can be set to "auto", to1168 generate a cover-letter only when there's more than one patch.11691170filter.<driver>.clean::1171 The command which is used to convert the content of a worktree1172 file to a blob upon checkin. See linkgit:gitattributes[5] for1173 details.11741175filter.<driver>.smudge::1176 The command which is used to convert the content of a blob1177 object to a worktree file upon checkout. See1178 linkgit:gitattributes[5] for details.11791180gc.aggressiveWindow::1181 The window size parameter used in the delta compression1182 algorithm used by 'git gc --aggressive'. This defaults1183 to 250.11841185gc.auto::1186 When there are approximately more than this many loose1187 objects in the repository, `git gc --auto` will pack them.1188 Some Porcelain commands use this command to perform a1189 light-weight garbage collection from time to time. The1190 default value is 6700. Setting this to 0 disables it.11911192gc.autopacklimit::1193 When there are more than this many packs that are not1194 marked with `*.keep` file in the repository, `git gc1195 --auto` consolidates them into one larger pack. The1196 default value is 50. Setting this to 0 disables it.11971198gc.packrefs::1199 Running `git pack-refs` in a repository renders it1200 unclonable by Git versions prior to 1.5.1.2 over dumb1201 transports such as HTTP. This variable determines whether1202 'git gc' runs `git pack-refs`. This can be set to `notbare`1203 to enable it within all non-bare repos or it can be set to a1204 boolean value. The default is `true`.12051206gc.pruneexpire::1207 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1208 Override the grace period with this config variable. The value1209 "now" may be used to disable this grace period and always prune1210 unreachable objects immediately.12111212gc.reflogexpire::1213gc.<pattern>.reflogexpire::1214 'git reflog expire' removes reflog entries older than1215 this time; defaults to 90 days. With "<pattern>" (e.g.1216 "refs/stash") in the middle the setting applies only to1217 the refs that match the <pattern>.12181219gc.reflogexpireunreachable::1220gc.<ref>.reflogexpireunreachable::1221 'git reflog expire' removes reflog entries older than1222 this time and are not reachable from the current tip;1223 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1224 in the middle, the setting applies only to the refs that1225 match the <pattern>.12261227gc.rerereresolved::1228 Records of conflicted merge you resolved earlier are1229 kept for this many days when 'git rerere gc' is run.1230 The default is 60 days. See linkgit:git-rerere[1].12311232gc.rerereunresolved::1233 Records of conflicted merge you have not resolved are1234 kept for this many days when 'git rerere gc' is run.1235 The default is 15 days. See linkgit:git-rerere[1].12361237gitcvs.commitmsgannotation::1238 Append this string to each commit message. Set to empty string1239 to disable this feature. Defaults to "via git-CVS emulator".12401241gitcvs.enabled::1242 Whether the CVS server interface is enabled for this repository.1243 See linkgit:git-cvsserver[1].12441245gitcvs.logfile::1246 Path to a log file where the CVS server interface well... logs1247 various stuff. See linkgit:git-cvsserver[1].12481249gitcvs.usecrlfattr::1250 If true, the server will look up the end-of-line conversion1251 attributes for files to determine the '-k' modes to use. If1252 the attributes force Git to treat a file as text,1253 the '-k' mode will be left blank so CVS clients will1254 treat it as text. If they suppress text conversion, the file1255 will be set with '-kb' mode, which suppresses any newline munging1256 the client might otherwise do. If the attributes do not allow1257 the file type to be determined, then 'gitcvs.allbinary' is1258 used. See linkgit:gitattributes[5].12591260gitcvs.allbinary::1261 This is used if 'gitcvs.usecrlfattr' does not resolve1262 the correct '-kb' mode to use. If true, all1263 unresolved files are sent to the client in1264 mode '-kb'. This causes the client to treat them1265 as binary files, which suppresses any newline munging it1266 otherwise might do. Alternatively, if it is set to "guess",1267 then the contents of the file are examined to decide if1268 it is binary, similar to 'core.autocrlf'.12691270gitcvs.dbname::1271 Database used by git-cvsserver to cache revision information1272 derived from the Git repository. The exact meaning depends on the1273 used database driver, for SQLite (which is the default driver) this1274 is a filename. Supports variable substitution (see1275 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1276 Default: '%Ggitcvs.%m.sqlite'12771278gitcvs.dbdriver::1279 Used Perl DBI driver. You can specify any available driver1280 for this here, but it might not work. git-cvsserver is tested1281 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1282 reported *not* to work with 'DBD::mysql'. Experimental feature.1283 May not contain double colons (`:`). Default: 'SQLite'.1284 See linkgit:git-cvsserver[1].12851286gitcvs.dbuser, gitcvs.dbpass::1287 Database user and password. Only useful if setting 'gitcvs.dbdriver',1288 since SQLite has no concept of database users and/or passwords.1289 'gitcvs.dbuser' supports variable substitution (see1290 linkgit:git-cvsserver[1] for details).12911292gitcvs.dbTableNamePrefix::1293 Database table name prefix. Prepended to the names of any1294 database tables used, allowing a single database to be used1295 for several repositories. Supports variable substitution (see1296 linkgit:git-cvsserver[1] for details). Any non-alphabetic1297 characters will be replaced with underscores.12981299All gitcvs variables except for 'gitcvs.usecrlfattr' and1300'gitcvs.allbinary' can also be specified as1301'gitcvs.<access_method>.<varname>' (where 'access_method'1302is one of "ext" and "pserver") to make them apply only for the given1303access method.13041305gitweb.category::1306gitweb.description::1307gitweb.owner::1308gitweb.url::1309 See linkgit:gitweb[1] for description.13101311gitweb.avatar::1312gitweb.blame::1313gitweb.grep::1314gitweb.highlight::1315gitweb.patches::1316gitweb.pickaxe::1317gitweb.remote_heads::1318gitweb.showsizes::1319gitweb.snapshot::1320 See linkgit:gitweb.conf[5] for description.13211322grep.lineNumber::1323 If set to true, enable '-n' option by default.13241325grep.patternType::1326 Set the default matching behavior. Using a value of 'basic', 'extended',1327 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1328 '--fixed-strings', or '--perl-regexp' option accordingly, while the1329 value 'default' will return to the default matching behavior.13301331grep.extendedRegexp::1332 If set to true, enable '--extended-regexp' option by default. This1333 option is ignored when the 'grep.patternType' option is set to a value1334 other than 'default'.13351336gpg.program::1337 Use this custom program instead of "gpg" found on $PATH when1338 making or verifying a PGP signature. The program must support the1339 same command line interface as GPG, namely, to verify a detached1340 signature, "gpg --verify $file - <$signature" is run, and the1341 program is expected to signal a good signature by exiting with1342 code 0, and to generate an ascii-armored detached signature, the1343 standard input of "gpg -bsau $key" is fed with the contents to be1344 signed, and the program is expected to send the result to its1345 standard output.13461347gui.commitmsgwidth::1348 Defines how wide the commit message window is in the1349 linkgit:git-gui[1]. "75" is the default.13501351gui.diffcontext::1352 Specifies how many context lines should be used in calls to diff1353 made by the linkgit:git-gui[1]. The default is "5".13541355gui.encoding::1356 Specifies the default encoding to use for displaying of1357 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1358 It can be overridden by setting the 'encoding' attribute1359 for relevant files (see linkgit:gitattributes[5]).1360 If this option is not set, the tools default to the1361 locale encoding.13621363gui.matchtrackingbranch::1364 Determines if new branches created with linkgit:git-gui[1] should1365 default to tracking remote branches with matching names or1366 not. Default: "false".13671368gui.newbranchtemplate::1369 Is used as suggested name when creating new branches using the1370 linkgit:git-gui[1].13711372gui.pruneduringfetch::1373 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1374 performing a fetch. The default value is "false".13751376gui.trustmtime::1377 Determines if linkgit:git-gui[1] should trust the file modification1378 timestamp or not. By default the timestamps are not trusted.13791380gui.spellingdictionary::1381 Specifies the dictionary used for spell checking commit messages in1382 the linkgit:git-gui[1]. When set to "none" spell checking is turned1383 off.13841385gui.fastcopyblame::1386 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1387 location detection. It makes blame significantly faster on huge1388 repositories at the expense of less thorough copy detection.13891390gui.copyblamethreshold::1391 Specifies the threshold to use in 'git gui blame' original location1392 detection, measured in alphanumeric characters. See the1393 linkgit:git-blame[1] manual for more information on copy detection.13941395gui.blamehistoryctx::1396 Specifies the radius of history context in days to show in1397 linkgit:gitk[1] for the selected commit, when the `Show History1398 Context` menu item is invoked from 'git gui blame'. If this1399 variable is set to zero, the whole history is shown.14001401guitool.<name>.cmd::1402 Specifies the shell command line to execute when the corresponding item1403 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1404 mandatory for every tool. The command is executed from the root of1405 the working directory, and in the environment it receives the name of1406 the tool as 'GIT_GUITOOL', the name of the currently selected file as1407 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1408 the head is detached, 'CUR_BRANCH' is empty).14091410guitool.<name>.needsfile::1411 Run the tool only if a diff is selected in the GUI. It guarantees1412 that 'FILENAME' is not empty.14131414guitool.<name>.noconsole::1415 Run the command silently, without creating a window to display its1416 output.14171418guitool.<name>.norescan::1419 Don't rescan the working directory for changes after the tool1420 finishes execution.14211422guitool.<name>.confirm::1423 Show a confirmation dialog before actually running the tool.14241425guitool.<name>.argprompt::1426 Request a string argument from the user, and pass it to the tool1427 through the 'ARGS' environment variable. Since requesting an1428 argument implies confirmation, the 'confirm' option has no effect1429 if this is enabled. If the option is set to 'true', 'yes', or '1',1430 the dialog uses a built-in generic prompt; otherwise the exact1431 value of the variable is used.14321433guitool.<name>.revprompt::1434 Request a single valid revision from the user, and set the1435 'REVISION' environment variable. In other aspects this option1436 is similar to 'argprompt', and can be used together with it.14371438guitool.<name>.revunmerged::1439 Show only unmerged branches in the 'revprompt' subdialog.1440 This is useful for tools similar to merge or rebase, but not1441 for things like checkout or reset.14421443guitool.<name>.title::1444 Specifies the title to use for the prompt dialog. The default1445 is the tool name.14461447guitool.<name>.prompt::1448 Specifies the general prompt string to display at the top of1449 the dialog, before subsections for 'argprompt' and 'revprompt'.1450 The default value includes the actual command.14511452help.browser::1453 Specify the browser that will be used to display help in the1454 'web' format. See linkgit:git-help[1].14551456help.format::1457 Override the default help format used by linkgit:git-help[1].1458 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1459 the default. 'web' and 'html' are the same.14601461help.autocorrect::1462 Automatically correct and execute mistyped commands after1463 waiting for the given number of deciseconds (0.1 sec). If more1464 than one command can be deduced from the entered text, nothing1465 will be executed. If the value of this option is negative,1466 the corrected command will be executed immediately. If the1467 value is 0 - the command will be just shown but not executed.1468 This is the default.14691470help.htmlpath::1471 Specify the path where the HTML documentation resides. File system paths1472 and URLs are supported. HTML pages will be prefixed with this path when1473 help is displayed in the 'web' format. This defaults to the documentation1474 path of your Git installation.14751476http.proxy::1477 Override the HTTP proxy, normally configured using the 'http_proxy',1478 'https_proxy', and 'all_proxy' environment variables (see1479 `curl(1)`). This can be overridden on a per-remote basis; see1480 remote.<name>.proxy14811482http.cookiefile::1483 File containing previously stored cookie lines which should be used1484 in the Git http session, if they match the server. The file format1485 of the file to read cookies from should be plain HTTP headers or1486 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1487 NOTE that the file specified with http.cookiefile is only used as1488 input unless http.saveCookies is set.14891490http.savecookies::1491 If set, store cookies received during requests to the file specified by1492 http.cookiefile. Has no effect if http.cookiefile is unset.14931494http.sslVerify::1495 Whether to verify the SSL certificate when fetching or pushing1496 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1497 variable.14981499http.sslCert::1500 File containing the SSL certificate when fetching or pushing1501 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1502 variable.15031504http.sslKey::1505 File containing the SSL private key when fetching or pushing1506 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1507 variable.15081509http.sslCertPasswordProtected::1510 Enable Git's password prompt for the SSL certificate. Otherwise1511 OpenSSL will prompt the user, possibly many times, if the1512 certificate or private key is encrypted. Can be overridden by the1513 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15141515http.sslCAInfo::1516 File containing the certificates to verify the peer with when1517 fetching or pushing over HTTPS. Can be overridden by the1518 'GIT_SSL_CAINFO' environment variable.15191520http.sslCAPath::1521 Path containing files with the CA certificates to verify the peer1522 with when fetching or pushing over HTTPS. Can be overridden1523 by the 'GIT_SSL_CAPATH' environment variable.15241525http.sslTry::1526 Attempt to use AUTH SSL/TLS and encrypted data transfers1527 when connecting via regular FTP protocol. This might be needed1528 if the FTP server requires it for security reasons or you wish1529 to connect securely whenever remote FTP server supports it.1530 Default is false since it might trigger certificate verification1531 errors on misconfigured servers.15321533http.maxRequests::1534 How many HTTP requests to launch in parallel. Can be overridden1535 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15361537http.minSessions::1538 The number of curl sessions (counted across slots) to be kept across1539 requests. They will not be ended with curl_easy_cleanup() until1540 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1541 value will be capped at 1. Defaults to 1.15421543http.postBuffer::1544 Maximum size in bytes of the buffer used by smart HTTP1545 transports when POSTing data to the remote system.1546 For requests larger than this buffer size, HTTP/1.1 and1547 Transfer-Encoding: chunked is used to avoid creating a1548 massive pack file locally. Default is 1 MiB, which is1549 sufficient for most requests.15501551http.lowSpeedLimit, http.lowSpeedTime::1552 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1553 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1554 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1555 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15561557http.noEPSV::1558 A boolean which disables using of EPSV ftp command by curl.1559 This can helpful with some "poor" ftp servers which don't1560 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1561 environment variable. Default is false (curl will use EPSV).15621563http.useragent::1564 The HTTP USER_AGENT string presented to an HTTP server. The default1565 value represents the version of the client Git such as git/1.7.1.1566 This option allows you to override this value to a more common value1567 such as Mozilla/4.0. This may be necessary, for instance, if1568 connecting through a firewall that restricts HTTP connections to a set1569 of common USER_AGENT strings (but not including those like git/1.7.1).1570 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15711572http.<url>.*::1573 Any of the http.* options above can be applied selectively to some urls.1574 For a config key to match a URL, each element of the config key is1575 compared to that of the URL, in the following order:1576+1577--1578. Scheme (e.g., `https` in `https://example.com/`). This field1579 must match exactly between the config key and the URL.15801581. Host/domain name (e.g., `example.com` in `https://example.com/`).1582 This field must match exactly between the config key and the URL.15831584. Port number (e.g., `8080` in `http://example.com:8080/`).1585 This field must match exactly between the config key and the URL.1586 Omitted port numbers are automatically converted to the correct1587 default for the scheme before matching.15881589. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1590 path field of the config key must match the path field of the URL1591 either exactly or as a prefix of slash-delimited path elements. This means1592 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1593 match on a slash (`/`) boundary. Longer matches take precedence (so a config1594 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1595 key with just path `foo/`).15961597. User name (e.g., `user` in `https://user@example.com/repo.git`). If1598 the config key has a user name it must match the user name in the1599 URL exactly. If the config key does not have a user name, that1600 config key will match a URL with any user name (including none),1601 but at a lower precedence than a config key with a user name.1602--1603+1604The list above is ordered by decreasing precedence; a URL that matches1605a config key's path is preferred to one that matches its user name. For example,1606if the URL is `https://user@example.com/foo/bar` a config key match of1607`https://example.com/foo` will be preferred over a config key match of1608`https://user@example.com`.1609+1610All URLs are normalized before attempting any matching (the password part,1611if embedded in the URL, is always ignored for matching purposes) so that1612equivalent urls that are simply spelled differently will match properly.1613Environment variable settings always override any matches. The urls that are1614matched against are those given directly to Git commands. This means any URLs1615visited as a result of a redirection do not participate in matching.16161617i18n.commitEncoding::1618 Character encoding the commit messages are stored in; Git itself1619 does not care per se, but this information is necessary e.g. when1620 importing commits from emails or in the gitk graphical history1621 browser (and possibly at other places in the future or in other1622 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16231624i18n.logOutputEncoding::1625 Character encoding the commit messages are converted to when1626 running 'git log' and friends.16271628imap::1629 The configuration variables in the 'imap' section are described1630 in linkgit:git-imap-send[1].16311632init.templatedir::1633 Specify the directory from which templates will be copied.1634 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16351636instaweb.browser::1637 Specify the program that will be used to browse your working1638 repository in gitweb. See linkgit:git-instaweb[1].16391640instaweb.httpd::1641 The HTTP daemon command-line to start gitweb on your working1642 repository. See linkgit:git-instaweb[1].16431644instaweb.local::1645 If true the web server started by linkgit:git-instaweb[1] will1646 be bound to the local IP (127.0.0.1).16471648instaweb.modulepath::1649 The default module path for linkgit:git-instaweb[1] to use1650 instead of /usr/lib/apache2/modules. Only used if httpd1651 is Apache.16521653instaweb.port::1654 The port number to bind the gitweb httpd to. See1655 linkgit:git-instaweb[1].16561657interactive.singlekey::1658 In interactive commands, allow the user to provide one-letter1659 input with a single key (i.e., without hitting enter).1660 Currently this is used by the `--patch` mode of1661 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1662 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1663 setting is silently ignored if portable keystroke input1664 is not available.16651666log.abbrevCommit::1667 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1668 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1669 override this option with `--no-abbrev-commit`.16701671log.date::1672 Set the default date-time mode for the 'log' command.1673 Setting a value for log.date is similar to using 'git log''s1674 `--date` option. Possible values are `relative`, `local`,1675 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1676 for details.16771678log.decorate::1679 Print out the ref names of any commits that are shown by the log1680 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1681 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1682 specified, the full ref name (including prefix) will be printed.1683 This is the same as the log commands '--decorate' option.16841685log.showroot::1686 If true, the initial commit will be shown as a big creation event.1687 This is equivalent to a diff against an empty tree.1688 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1689 normally hide the root commit will now show it. True by default.16901691log.mailmap::1692 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1693 linkgit:git-whatchanged[1] assume `--use-mailmap`.16941695mailmap.file::1696 The location of an augmenting mailmap file. The default1697 mailmap, located in the root of the repository, is loaded1698 first, then the mailmap file pointed to by this variable.1699 The location of the mailmap file may be in a repository1700 subdirectory, or somewhere outside of the repository itself.1701 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17021703mailmap.blob::1704 Like `mailmap.file`, but consider the value as a reference to a1705 blob in the repository. If both `mailmap.file` and1706 `mailmap.blob` are given, both are parsed, with entries from1707 `mailmap.file` taking precedence. In a bare repository, this1708 defaults to `HEAD:.mailmap`. In a non-bare repository, it1709 defaults to empty.17101711man.viewer::1712 Specify the programs that may be used to display help in the1713 'man' format. See linkgit:git-help[1].17141715man.<tool>.cmd::1716 Specify the command to invoke the specified man viewer. The1717 specified command is evaluated in shell with the man page1718 passed as argument. (See linkgit:git-help[1].)17191720man.<tool>.path::1721 Override the path for the given tool that may be used to1722 display help in the 'man' format. See linkgit:git-help[1].17231724include::merge-config.txt[]17251726mergetool.<tool>.path::1727 Override the path for the given tool. This is useful in case1728 your tool is not in the PATH.17291730mergetool.<tool>.cmd::1731 Specify the command to invoke the specified merge tool. The1732 specified command is evaluated in shell with the following1733 variables available: 'BASE' is the name of a temporary file1734 containing the common base of the files to be merged, if available;1735 'LOCAL' is the name of a temporary file containing the contents of1736 the file on the current branch; 'REMOTE' is the name of a temporary1737 file containing the contents of the file from the branch being1738 merged; 'MERGED' contains the name of the file to which the merge1739 tool should write the results of a successful merge.17401741mergetool.<tool>.trustExitCode::1742 For a custom merge command, specify whether the exit code of1743 the merge command can be used to determine whether the merge was1744 successful. If this is not set to true then the merge target file1745 timestamp is checked and the merge assumed to have been successful1746 if the file has been updated, otherwise the user is prompted to1747 indicate the success of the merge.17481749mergetool.keepBackup::1750 After performing a merge, the original file with conflict markers1751 can be saved as a file with a `.orig` extension. If this variable1752 is set to `false` then this file is not preserved. Defaults to1753 `true` (i.e. keep the backup files).17541755mergetool.keepTemporaries::1756 When invoking a custom merge tool, Git uses a set of temporary1757 files to pass to the tool. If the tool returns an error and this1758 variable is set to `true`, then these temporary files will be1759 preserved, otherwise they will be removed after the tool has1760 exited. Defaults to `false`.17611762mergetool.prompt::1763 Prompt before each invocation of the merge resolution program.17641765notes.displayRef::1766 The (fully qualified) refname from which to show notes when1767 showing commit messages. The value of this variable can be set1768 to a glob, in which case notes from all matching refs will be1769 shown. You may also specify this configuration variable1770 several times. A warning will be issued for refs that do not1771 exist, but a glob that does not match any refs is silently1772 ignored.1773+1774This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1775environment variable, which must be a colon separated list of refs or1776globs.1777+1778The effective value of "core.notesRef" (possibly overridden by1779GIT_NOTES_REF) is also implicitly added to the list of refs to be1780displayed.17811782notes.rewrite.<command>::1783 When rewriting commits with <command> (currently `amend` or1784 `rebase`) and this variable is set to `true`, Git1785 automatically copies your notes from the original to the1786 rewritten commit. Defaults to `true`, but see1787 "notes.rewriteRef" below.17881789notes.rewriteMode::1790 When copying notes during a rewrite (see the1791 "notes.rewrite.<command>" option), determines what to do if1792 the target commit already has a note. Must be one of1793 `overwrite`, `concatenate`, or `ignore`. Defaults to1794 `concatenate`.1795+1796This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1797environment variable.17981799notes.rewriteRef::1800 When copying notes during a rewrite, specifies the (fully1801 qualified) ref whose notes should be copied. The ref may be a1802 glob, in which case notes in all matching refs will be copied.1803 You may also specify this configuration several times.1804+1805Does not have a default value; you must configure this variable to1806enable note rewriting. Set it to `refs/notes/commits` to enable1807rewriting for the default commit notes.1808+1809This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1810environment variable, which must be a colon separated list of refs or1811globs.18121813pack.window::1814 The size of the window used by linkgit:git-pack-objects[1] when no1815 window size is given on the command line. Defaults to 10.18161817pack.depth::1818 The maximum delta depth used by linkgit:git-pack-objects[1] when no1819 maximum depth is given on the command line. Defaults to 50.18201821pack.windowMemory::1822 The window memory size limit used by linkgit:git-pack-objects[1]1823 when no limit is given on the command line. The value can be1824 suffixed with "k", "m", or "g". Defaults to 0, meaning no1825 limit.18261827pack.compression::1828 An integer -1..9, indicating the compression level for objects1829 in a pack file. -1 is the zlib default. 0 means no1830 compression, and 1..9 are various speed/size tradeoffs, 9 being1831 slowest. If not set, defaults to core.compression. If that is1832 not set, defaults to -1, the zlib default, which is "a default1833 compromise between speed and compression (currently equivalent1834 to level 6)."1835+1836Note that changing the compression level will not automatically recompress1837all existing objects. You can force recompression by passing the -F option1838to linkgit:git-repack[1].18391840pack.deltaCacheSize::1841 The maximum memory in bytes used for caching deltas in1842 linkgit:git-pack-objects[1] before writing them out to a pack.1843 This cache is used to speed up the writing object phase by not1844 having to recompute the final delta result once the best match1845 for all objects is found. Repacking large repositories on machines1846 which are tight with memory might be badly impacted by this though,1847 especially if this cache pushes the system into swapping.1848 A value of 0 means no limit. The smallest size of 1 byte may be1849 used to virtually disable this cache. Defaults to 256 MiB.18501851pack.deltaCacheLimit::1852 The maximum size of a delta, that is cached in1853 linkgit:git-pack-objects[1]. This cache is used to speed up the1854 writing object phase by not having to recompute the final delta1855 result once the best match for all objects is found. Defaults to 1000.18561857pack.threads::1858 Specifies the number of threads to spawn when searching for best1859 delta matches. This requires that linkgit:git-pack-objects[1]1860 be compiled with pthreads otherwise this option is ignored with a1861 warning. This is meant to reduce packing time on multiprocessor1862 machines. The required amount of memory for the delta search window1863 is however multiplied by the number of threads.1864 Specifying 0 will cause Git to auto-detect the number of CPU's1865 and set the number of threads accordingly.18661867pack.indexVersion::1868 Specify the default pack index version. Valid values are 1 for1869 legacy pack index used by Git versions prior to 1.5.2, and 2 for1870 the new pack index with capabilities for packs larger than 4 GB1871 as well as proper protection against the repacking of corrupted1872 packs. Version 2 is the default. Note that version 2 is enforced1873 and this config option ignored whenever the corresponding pack is1874 larger than 2 GB.1875+1876If you have an old Git that does not understand the version 2 `*.idx` file,1877cloning or fetching over a non native protocol (e.g. "http" and "rsync")1878that will copy both `*.pack` file and corresponding `*.idx` file from the1879other side may give you a repository that cannot be accessed with your1880older version of Git. If the `*.pack` file is smaller than 2 GB, however,1881you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1882the `*.idx` file.18831884pack.packSizeLimit::1885 The maximum size of a pack. This setting only affects1886 packing to a file when repacking, i.e. the git:// protocol1887 is unaffected. It can be overridden by the `--max-pack-size`1888 option of linkgit:git-repack[1]. The minimum size allowed is1889 limited to 1 MiB. The default is unlimited.1890 Common unit suffixes of 'k', 'm', or 'g' are1891 supported.18921893pager.<cmd>::1894 If the value is boolean, turns on or off pagination of the1895 output of a particular Git subcommand when writing to a tty.1896 Otherwise, turns on pagination for the subcommand using the1897 pager specified by the value of `pager.<cmd>`. If `--paginate`1898 or `--no-pager` is specified on the command line, it takes1899 precedence over this option. To disable pagination for all1900 commands, set `core.pager` or `GIT_PAGER` to `cat`.19011902pretty.<name>::1903 Alias for a --pretty= format string, as specified in1904 linkgit:git-log[1]. Any aliases defined here can be used just1905 as the built-in pretty formats could. For example,1906 running `git config pretty.changelog "format:* %H %s"`1907 would cause the invocation `git log --pretty=changelog`1908 to be equivalent to running `git log "--pretty=format:* %H %s"`.1909 Note that an alias with the same name as a built-in format1910 will be silently ignored.19111912pull.rebase::1913 When true, rebase branches on top of the fetched branch, instead1914 of merging the default branch from the default remote when "git1915 pull" is run. See "branch.<name>.rebase" for setting this on a1916 per-branch basis.1917+1918 When preserve, also pass `--preserve-merges` along to 'git rebase'1919 so that locally committed merge commits will not be flattened1920 by running 'git pull'.1921+1922*NOTE*: this is a possibly dangerous operation; do *not* use1923it unless you understand the implications (see linkgit:git-rebase[1]1924for details).19251926pull.octopus::1927 The default merge strategy to use when pulling multiple branches1928 at once.19291930pull.twohead::1931 The default merge strategy to use when pulling a single branch.19321933push.default::1934 Defines the action `git push` should take if no refspec is1935 explicitly given. Different values are well-suited for1936 specific workflows; for instance, in a purely central workflow1937 (i.e. the fetch source is equal to the push destination),1938 `upstream` is probably what you want. Possible values are:1939+1940--19411942* `nothing` - do not push anything (error out) unless a refspec is1943 explicitly given. This is primarily meant for people who want to1944 avoid mistakes by always being explicit.19451946* `current` - push the current branch to update a branch with the same1947 name on the receiving end. Works in both central and non-central1948 workflows.19491950* `upstream` - push the current branch back to the branch whose1951 changes are usually integrated into the current branch (which is1952 called `@{upstream}`). This mode only makes sense if you are1953 pushing to the same repository you would normally pull from1954 (i.e. central workflow).19551956* `simple` - in centralized workflow, work like `upstream` with an1957 added safety to refuse to push if the upstream branch's name is1958 different from the local one.1959+1960When pushing to a remote that is different from the remote you normally1961pull from, work as `current`. This is the safest option and is suited1962for beginners.1963+1964This mode will become the default in Git 2.0.19651966* `matching` - push all branches having the same name on both ends.1967 This makes the repository you are pushing to remember the set of1968 branches that will be pushed out (e.g. if you always push 'maint'1969 and 'master' there and no other branches, the repository you push1970 to will have these two branches, and your local 'maint' and1971 'master' will be pushed there).1972+1973To use this mode effectively, you have to make sure _all_ the1974branches you would push out are ready to be pushed out before1975running 'git push', as the whole point of this mode is to allow you1976to push all of the branches in one go. If you usually finish work1977on only one branch and push out the result, while other branches are1978unfinished, this mode is not for you. Also this mode is not1979suitable for pushing into a shared central repository, as other1980people may add new branches there, or update the tip of existing1981branches outside your control.1982+1983This is currently the default, but Git 2.0 will change the default1984to `simple`.19851986--19871988rebase.stat::1989 Whether to show a diffstat of what changed upstream since the last1990 rebase. False by default.19911992rebase.autosquash::1993 If set to true enable '--autosquash' option by default.19941995rebase.autostash::1996 When set to true, automatically create a temporary stash1997 before the operation begins, and apply it after the operation1998 ends. This means that you can run rebase on a dirty worktree.1999 However, use with care: the final stash application after a2000 successful rebase might result in non-trivial conflicts.2001 Defaults to false.20022003receive.autogc::2004 By default, git-receive-pack will run "git-gc --auto" after2005 receiving data from git-push and updating refs. You can stop2006 it by setting this variable to false.20072008receive.fsckObjects::2009 If it is set to true, git-receive-pack will check all received2010 objects. It will abort in the case of a malformed object or a2011 broken link. The result of an abort are only dangling objects.2012 Defaults to false. If not set, the value of `transfer.fsckObjects`2013 is used instead.20142015receive.unpackLimit::2016 If the number of objects received in a push is below this2017 limit then the objects will be unpacked into loose object2018 files. However if the number of received objects equals or2019 exceeds this limit then the received pack will be stored as2020 a pack, after adding any missing delta bases. Storing the2021 pack from a push can make the push operation complete faster,2022 especially on slow filesystems. If not set, the value of2023 `transfer.unpackLimit` is used instead.20242025receive.denyDeletes::2026 If set to true, git-receive-pack will deny a ref update that deletes2027 the ref. Use this to prevent such a ref deletion via a push.20282029receive.denyDeleteCurrent::2030 If set to true, git-receive-pack will deny a ref update that2031 deletes the currently checked out branch of a non-bare repository.20322033receive.denyCurrentBranch::2034 If set to true or "refuse", git-receive-pack will deny a ref update2035 to the currently checked out branch of a non-bare repository.2036 Such a push is potentially dangerous because it brings the HEAD2037 out of sync with the index and working tree. If set to "warn",2038 print a warning of such a push to stderr, but allow the push to2039 proceed. If set to false or "ignore", allow such pushes with no2040 message. Defaults to "refuse".20412042receive.denyNonFastForwards::2043 If set to true, git-receive-pack will deny a ref update which is2044 not a fast-forward. Use this to prevent such an update via a push,2045 even if that push is forced. This configuration variable is2046 set when initializing a shared repository.20472048receive.hiderefs::2049 String(s) `receive-pack` uses to decide which refs to omit2050 from its initial advertisement. Use more than one2051 definitions to specify multiple prefix strings. A ref that2052 are under the hierarchies listed on the value of this2053 variable is excluded, and is hidden when responding to `git2054 push`, and an attempt to update or delete a hidden ref by2055 `git push` is rejected.20562057receive.updateserverinfo::2058 If set to true, git-receive-pack will run git-update-server-info2059 after receiving data from git-push and updating refs.20602061remote.pushdefault::2062 The remote to push to by default. Overrides2063 `branch.<name>.remote` for all branches, and is overridden by2064 `branch.<name>.pushremote` for specific branches.20652066remote.<name>.url::2067 The URL of a remote repository. See linkgit:git-fetch[1] or2068 linkgit:git-push[1].20692070remote.<name>.pushurl::2071 The push URL of a remote repository. See linkgit:git-push[1].20722073remote.<name>.proxy::2074 For remotes that require curl (http, https and ftp), the URL to2075 the proxy to use for that remote. Set to the empty string to2076 disable proxying for that remote.20772078remote.<name>.fetch::2079 The default set of "refspec" for linkgit:git-fetch[1]. See2080 linkgit:git-fetch[1].20812082remote.<name>.push::2083 The default set of "refspec" for linkgit:git-push[1]. See2084 linkgit:git-push[1].20852086remote.<name>.mirror::2087 If true, pushing to this remote will automatically behave2088 as if the `--mirror` option was given on the command line.20892090remote.<name>.skipDefaultUpdate::2091 If true, this remote will be skipped by default when updating2092 using linkgit:git-fetch[1] or the `update` subcommand of2093 linkgit:git-remote[1].20942095remote.<name>.skipFetchAll::2096 If true, this remote will be skipped by default when updating2097 using linkgit:git-fetch[1] or the `update` subcommand of2098 linkgit:git-remote[1].20992100remote.<name>.receivepack::2101 The default program to execute on the remote side when pushing. See2102 option \--receive-pack of linkgit:git-push[1].21032104remote.<name>.uploadpack::2105 The default program to execute on the remote side when fetching. See2106 option \--upload-pack of linkgit:git-fetch-pack[1].21072108remote.<name>.tagopt::2109 Setting this value to \--no-tags disables automatic tag following when2110 fetching from remote <name>. Setting it to \--tags will fetch every2111 tag from remote <name>, even if they are not reachable from remote2112 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2113 override this setting. See options \--tags and \--no-tags of2114 linkgit:git-fetch[1].21152116remote.<name>.vcs::2117 Setting this to a value <vcs> will cause Git to interact with2118 the remote with the git-remote-<vcs> helper.21192120remote.<name>.prune::2121 When set to true, fetching from this remote by default will also2122 remove any remote-tracking branches which no longer exist on the2123 remote (as if the `--prune` option was give on the command line).2124 Overrides `fetch.prune` settings, if any.21252126remotes.<group>::2127 The list of remotes which are fetched by "git remote update2128 <group>". See linkgit:git-remote[1].21292130repack.usedeltabaseoffset::2131 By default, linkgit:git-repack[1] creates packs that use2132 delta-base offset. If you need to share your repository with2133 Git older than version 1.4.4, either directly or via a dumb2134 protocol such as http, then you need to set this option to2135 "false" and repack. Access from old Git versions over the2136 native protocol are unaffected by this option.21372138rerere.autoupdate::2139 When set to true, `git-rerere` updates the index with the2140 resulting contents after it cleanly resolves conflicts using2141 previously recorded resolution. Defaults to false.21422143rerere.enabled::2144 Activate recording of resolved conflicts, so that identical2145 conflict hunks can be resolved automatically, should they be2146 encountered again. By default, linkgit:git-rerere[1] is2147 enabled if there is an `rr-cache` directory under the2148 `$GIT_DIR`, e.g. if "rerere" was previously used in the2149 repository.21502151sendemail.identity::2152 A configuration identity. When given, causes values in the2153 'sendemail.<identity>' subsection to take precedence over2154 values in the 'sendemail' section. The default identity is2155 the value of 'sendemail.identity'.21562157sendemail.smtpencryption::2158 See linkgit:git-send-email[1] for description. Note that this2159 setting is not subject to the 'identity' mechanism.21602161sendemail.smtpssl::2162 Deprecated alias for 'sendemail.smtpencryption = ssl'.21632164sendemail.smtpsslcertpath::2165 Path to ca-certificates (either a directory or a single file).2166 Set it to an empty string to disable certificate verification.21672168sendemail.<identity>.*::2169 Identity-specific versions of the 'sendemail.*' parameters2170 found below, taking precedence over those when the this2171 identity is selected, through command-line or2172 'sendemail.identity'.21732174sendemail.aliasesfile::2175sendemail.aliasfiletype::2176sendemail.annotate::2177sendemail.bcc::2178sendemail.cc::2179sendemail.cccmd::2180sendemail.chainreplyto::2181sendemail.confirm::2182sendemail.envelopesender::2183sendemail.from::2184sendemail.multiedit::2185sendemail.signedoffbycc::2186sendemail.smtppass::2187sendemail.suppresscc::2188sendemail.suppressfrom::2189sendemail.to::2190sendemail.smtpdomain::2191sendemail.smtpserver::2192sendemail.smtpserverport::2193sendemail.smtpserveroption::2194sendemail.smtpuser::2195sendemail.thread::2196sendemail.validate::2197 See linkgit:git-send-email[1] for description.21982199sendemail.signedoffcc::2200 Deprecated alias for 'sendemail.signedoffbycc'.22012202showbranch.default::2203 The default set of branches for linkgit:git-show-branch[1].2204 See linkgit:git-show-branch[1].22052206status.relativePaths::2207 By default, linkgit:git-status[1] shows paths relative to the2208 current directory. Setting this variable to `false` shows paths2209 relative to the repository root (this was the default for Git2210 prior to v1.5.4).22112212status.short::2213 Set to true to enable --short by default in linkgit:git-status[1].2214 The option --no-short takes precedence over this variable.22152216status.branch::2217 Set to true to enable --branch by default in linkgit:git-status[1].2218 The option --no-branch takes precedence over this variable.22192220status.displayCommentPrefix::2221 If set to true, linkgit:git-status[1] will insert a comment2222 prefix before each output line (starting with2223 `core.commentChar`, i.e. `#` by default). This was the2224 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2225 Defaults to false.22262227status.showUntrackedFiles::2228 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2229 files which are not currently tracked by Git. Directories which2230 contain only untracked files, are shown with the directory name2231 only. Showing untracked files means that Git needs to lstat() all2232 all the files in the whole repository, which might be slow on some2233 systems. So, this variable controls how the commands displays2234 the untracked files. Possible values are:2235+2236--2237* `no` - Show no untracked files.2238* `normal` - Show untracked files and directories.2239* `all` - Show also individual files in untracked directories.2240--2241+2242If this variable is not specified, it defaults to 'normal'.2243This variable can be overridden with the -u|--untracked-files option2244of linkgit:git-status[1] and linkgit:git-commit[1].22452246status.submodulesummary::2247 Defaults to false.2248 If this is set to a non zero number or true (identical to -1 or an2249 unlimited number), the submodule summary will be enabled and a2250 summary of commits for modified submodules will be shown (see2251 --summary-limit option of linkgit:git-submodule[1]). Please note2252 that the summary output command will be suppressed for all2253 submodules when `diff.ignoreSubmodules` is set to 'all' or only2254 for those submodules where `submodule.<name>.ignore=all`. To2255 also view the summary for ignored submodules you can either use2256 the --ignore-submodules=dirty command line option or the 'git2257 submodule summary' command, which shows a similar output but does2258 not honor these settings.22592260submodule.<name>.path::2261submodule.<name>.url::2262submodule.<name>.update::2263 The path within this project, URL, and the updating strategy2264 for a submodule. These variables are initially populated2265 by 'git submodule init'; edit them to override the2266 URL and other values found in the `.gitmodules` file. See2267 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.22682269submodule.<name>.branch::2270 The remote branch name for a submodule, used by `git submodule2271 update --remote`. Set this option to override the value found in2272 the `.gitmodules` file. See linkgit:git-submodule[1] and2273 linkgit:gitmodules[5] for details.22742275submodule.<name>.fetchRecurseSubmodules::2276 This option can be used to control recursive fetching of this2277 submodule. It can be overridden by using the --[no-]recurse-submodules2278 command line option to "git fetch" and "git pull".2279 This setting will override that from in the linkgit:gitmodules[5]2280 file.22812282submodule.<name>.ignore::2283 Defines under what circumstances "git status" and the diff family show2284 a submodule as modified. When set to "all", it will never be considered2285 modified, "dirty" will ignore all changes to the submodules work tree and2286 takes only differences between the HEAD of the submodule and the commit2287 recorded in the superproject into account. "untracked" will additionally2288 let submodules with modified tracked files in their work tree show up.2289 Using "none" (the default when this option is not set) also shows2290 submodules that have untracked files in their work tree as changed.2291 This setting overrides any setting made in .gitmodules for this submodule,2292 both settings can be overridden on the command line by using the2293 "--ignore-submodules" option. The 'git submodule' commands are not2294 affected by this setting.22952296tar.umask::2297 This variable can be used to restrict the permission bits of2298 tar archive entries. The default is 0002, which turns off the2299 world write bit. The special value "user" indicates that the2300 archiving user's umask will be used instead. See umask(2) and2301 linkgit:git-archive[1].23022303transfer.fsckObjects::2304 When `fetch.fsckObjects` or `receive.fsckObjects` are2305 not set, the value of this variable is used instead.2306 Defaults to false.23072308transfer.hiderefs::2309 This variable can be used to set both `receive.hiderefs`2310 and `uploadpack.hiderefs` at the same time to the same2311 values. See entries for these other variables.23122313transfer.unpackLimit::2314 When `fetch.unpackLimit` or `receive.unpackLimit` are2315 not set, the value of this variable is used instead.2316 The default value is 100.23172318uploadpack.hiderefs::2319 String(s) `upload-pack` uses to decide which refs to omit2320 from its initial advertisement. Use more than one2321 definitions to specify multiple prefix strings. A ref that2322 are under the hierarchies listed on the value of this2323 variable is excluded, and is hidden from `git ls-remote`,2324 `git fetch`, etc. An attempt to fetch a hidden ref by `git2325 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.23262327uploadpack.allowtipsha1inwant::2328 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2329 to accept a fetch request that asks for an object at the tip2330 of a hidden ref (by default, such a request is rejected).2331 see also `uploadpack.hiderefs`.23322333uploadpack.keepalive::2334 When `upload-pack` has started `pack-objects`, there may be a2335 quiet period while `pack-objects` prepares the pack. Normally2336 it would output progress information, but if `--quiet` was used2337 for the fetch, `pack-objects` will output nothing at all until2338 the pack data begins. Some clients and networks may consider2339 the server to be hung and give up. Setting this option instructs2340 `upload-pack` to send an empty keepalive packet every2341 `uploadpack.keepalive` seconds. Setting this option to 02342 disables keepalive packets entirely. The default is 5 seconds.23432344url.<base>.insteadOf::2345 Any URL that starts with this value will be rewritten to2346 start, instead, with <base>. In cases where some site serves a2347 large number of repositories, and serves them with multiple2348 access methods, and some users need to use different access2349 methods, this feature allows people to specify any of the2350 equivalent URLs and have Git automatically rewrite the URL to2351 the best alternative for the particular user, even for a2352 never-before-seen repository on the site. When more than one2353 insteadOf strings match a given URL, the longest match is used.23542355url.<base>.pushInsteadOf::2356 Any URL that starts with this value will not be pushed to;2357 instead, it will be rewritten to start with <base>, and the2358 resulting URL will be pushed to. In cases where some site serves2359 a large number of repositories, and serves them with multiple2360 access methods, some of which do not allow push, this feature2361 allows people to specify a pull-only URL and have Git2362 automatically use an appropriate URL to push, even for a2363 never-before-seen repository on the site. When more than one2364 pushInsteadOf strings match a given URL, the longest match is2365 used. If a remote has an explicit pushurl, Git will ignore this2366 setting for that remote.23672368user.email::2369 Your email address to be recorded in any newly created commits.2370 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2371 'EMAIL' environment variables. See linkgit:git-commit-tree[1].23722373user.name::2374 Your full name to be recorded in any newly created commits.2375 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2376 environment variables. See linkgit:git-commit-tree[1].23772378user.signingkey::2379 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2380 key you want it to automatically when creating a signed tag or2381 commit, you can override the default selection with this variable.2382 This option is passed unchanged to gpg's --local-user parameter,2383 so you may specify a key using any method that gpg supports.23842385web.browser::2386 Specify a web browser that may be used by some commands.2387 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2388 may use it.