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. 18 19Syntax 20~~~~~~ 21 22The syntax is fairly flexible and permissive; whitespaces are mostly 23ignored. The '#' and ';' characters begin comments to the end of line, 24blank lines are ignored. 25 26The file consists of sections and variables. A section begins with 27the name of the section in square brackets and continues until the next 28section begins. Section names are not case sensitive. Only alphanumeric 29characters, `-` and `.` are allowed in section names. Each variable 30must belong to some section, which means that there must be a section 31header before the first setting of a variable. 32 33Sections can be further divided into subsections. To begin a subsection 34put its name in double quotes, separated by space from the section name, 35in the section header, like in the example below: 36 37-------- 38 [section "subsection"] 39 40-------- 41 42Subsection names are case sensitive and can contain any characters except 43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 44respectively). Section headers cannot span multiple 45lines. Variables may belong directly to a section or to a given subsection. 46You can have `[section]` if you have `[section "subsection"]`, but you 47don't need to. 48 49There is also a deprecated `[section.subsection]` syntax. With this 50syntax, the subsection name is converted to lower-case and is also 51compared case sensitively. These subsection names follow the same 52restrictions as section names. 53 54All the other lines (and the remainder of the line after the section 55header) are recognized as setting variables, in the form 56'name = value'. If there is no equal sign on the line, the entire line 57is taken as 'name' and the variable is recognized as boolean "true". 58The variable names are case-insensitive, allow only alphanumeric characters 59and `-`, and must start with an alphabetic character. There can be more 60than one value for a given variable; we say then that the variable is 61multivalued. 62 63Leading and trailing whitespace in a variable value is discarded. 64Internal whitespace within a variable value is retained verbatim. 65 66The values following the equals sign in variable assign are all either 67a string, an integer, or a boolean. Boolean values may be given as yes/no, 681/0, true/false or on/off. Case is not significant in boolean values, when 69converting value to the canonical form using '--bool' type specifier; 70'git config' will ensure that the output is "true" or "false". 71 72String values may be entirely or partially enclosed in double quotes. 73You need to enclose variable values in double quotes if you want to 74preserve leading or trailing whitespace, or if the variable value contains 75comment characters (i.e. it contains '#' or ';'). 76Double quote `"` and backslash `\` characters in variable values must 77be escaped: use `\"` for `"` and `\\` for `\`. 78 79The following escape sequences (beside `\"` and `\\`) are recognized: 80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 81and `\b` for backspace (BS). Other char escape sequences (including octal 82escape sequences) are invalid. 83 84Variable values ending in a `\` are continued on the next line in the 85customary UNIX fashion. 86 87Some variables may require a special value format. 88 89Includes 90~~~~~~~~ 91 92You can include one config file from another by setting the special 93`include.path` variable to the name of the file to be included. The 94included file is expanded immediately, as if its contents had been 95found at the location of the include directive. If the value of the 96`include.path` variable is a relative path, the path is considered to be 97relative to the configuration file in which the include directive was 98found. The value of `include.path` is subject to tilde expansion: `~/` 99is expanded to the value of `$HOME`, and `~user/` to the specified 100user's home directory. See below for examples. 101 102Example 103~~~~~~~ 104 105 # Core variables 106 [core] 107 ; Don't trust file modes 108 filemode = false 109 110 # Our diff algorithm 111 [diff] 112 external = /usr/local/bin/diff-wrapper 113 renames = true 114 115 [branch "devel"] 116 remote = origin 117 merge = refs/heads/devel 118 119 # Proxy settings 120 [core] 121 gitProxy="ssh" for "kernel.org" 122 gitProxy=default-proxy ; for the rest 123 124 [include] 125 path = /path/to/foo.inc ; include by absolute path 126 path = foo ; expand "foo" relative to the current file 127 path = ~/foo ; expand "foo" in your $HOME directory 128 129Variables 130~~~~~~~~~ 131 132Note that this list is non-comprehensive and not necessarily complete. 133For command-specific variables, you will find a more detailed description 134in the appropriate manual page. 135 136Other git-related tools may and do use their own variables. When 137inventing new variables for use in your own tool, make sure their 138names do not conflict with those that are used by Git itself and 139other popular tools, and describe them in your documentation. 140 141 142advice.*:: 143 These variables control various optional help messages designed to 144 aid new users. All 'advice.*' variables default to 'true', and you 145 can tell Git that you do not need help by setting these to 'false': 146+ 147-- 148 pushUpdateRejected:: 149 Set this variable to 'false' if you want to disable 150 'pushNonFFCurrent', 151 'pushNonFFMatching', 'pushAlreadyExists', 152 'pushFetchFirst', and 'pushNeedsForce' 153 simultaneously. 154 pushNonFFCurrent:: 155 Advice shown when linkgit:git-push[1] fails due to a 156 non-fast-forward update to the current branch. 157 pushNonFFMatching:: 158 Advice shown when you ran linkgit:git-push[1] and pushed 159 'matching refs' explicitly (i.e. you used ':', or 160 specified a refspec that isn't your current branch) and 161 it resulted in a non-fast-forward error. 162 pushAlreadyExists:: 163 Shown when linkgit:git-push[1] rejects an update that 164 does not qualify for fast-forwarding (e.g., a tag.) 165 pushFetchFirst:: 166 Shown when linkgit:git-push[1] rejects an update that 167 tries to overwrite a remote ref that points at an 168 object we do not have. 169 pushNeedsForce:: 170 Shown when linkgit:git-push[1] rejects an update that 171 tries to overwrite a remote ref that points at an 172 object that is not a commit-ish, or make the remote 173 ref point at an object that is not a commit-ish. 174 statusHints:: 175 Show directions on how to proceed from the current 176 state in the output of linkgit:git-status[1], in 177 the template shown when writing commit messages in 178 linkgit:git-commit[1], and in the help message shown 179 by linkgit:git-checkout[1] when switching branch. 180 statusUoption:: 181 Advise to consider using the `-u` option to linkgit:git-status[1] 182 when the command takes more than 2 seconds to enumerate untracked 183 files. 184 commitBeforeMerge:: 185 Advice shown when linkgit:git-merge[1] refuses to 186 merge to avoid overwriting local changes. 187 resolveConflict:: 188 Advice shown by various commands when conflicts 189 prevent the operation from being performed. 190 implicitIdentity:: 191 Advice on how to set your identity configuration when 192 your information is guessed from the system username and 193 domain name. 194 detachedHead:: 195 Advice shown when you used linkgit:git-checkout[1] to 196 move to the detach HEAD state, to instruct how to create 197 a local branch after the fact. 198 amWorkDir:: 199 Advice that shows the location of the patch file when 200 linkgit:git-am[1] fails to apply it. 201 rmHints:: 202 In case of failure in the output of linkgit:git-rm[1], 203 show directions on how to proceed from the current state. 204-- 205 206core.fileMode:: 207 If false, the executable bit differences between the index and 208 the working tree are ignored; useful on broken filesystems like FAT. 209 See linkgit:git-update-index[1]. 210+ 211The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 212will probe and set core.fileMode false if appropriate when the 213repository is created. 214 215core.ignorecase:: 216 If true, this option enables various workarounds to enable 217 Git to work better on filesystems that are not case sensitive, 218 like FAT. For example, if a directory listing finds 219 "makefile" when Git expects "Makefile", Git will assume 220 it is really the same file, and continue to remember it as 221 "Makefile". 222+ 223The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 224will probe and set core.ignorecase true if appropriate when the repository 225is created. 226 227core.precomposeunicode:: 228 This option is only used by Mac OS implementation of Git. 229 When core.precomposeunicode=true, Git reverts the unicode decomposition 230 of filenames done by Mac OS. This is useful when sharing a repository 231 between Mac OS and Linux or Windows. 232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 233 When false, file names are handled fully transparent by Git, 234 which is backward compatible with older versions of Git. 235 236core.trustctime:: 237 If false, the ctime differences between the index and the 238 working tree are ignored; useful when the inode change time 239 is regularly modified by something outside Git (file system 240 crawlers and some backup systems). 241 See linkgit:git-update-index[1]. True by default. 242 243core.checkstat:: 244 Determines which stat fields to match between the index 245 and work tree. The user can set this to 'default' or 246 'minimal'. Default (or explicitly 'default'), is to check 247 all fields, including the sub-second part of mtime and ctime. 248 249core.quotepath:: 250 The commands that output paths (e.g. 'ls-files', 251 'diff'), when not given the `-z` option, will quote 252 "unusual" characters in the pathname by enclosing the 253 pathname in a double-quote pair and with backslashes the 254 same way strings in C source code are quoted. If this 255 variable is set to false, the bytes higher than 0x80 are 256 not quoted but output as verbatim. Note that double 257 quote, backslash and control characters are always 258 quoted without `-z` regardless of the setting of this 259 variable. 260 261core.eol:: 262 Sets the line ending type to use in the working directory for 263 files that have the `text` property set. Alternatives are 264 'lf', 'crlf' and 'native', which uses the platform's native 265 line ending. The default value is `native`. See 266 linkgit:gitattributes[5] for more information on end-of-line 267 conversion. 268 269core.safecrlf:: 270 If true, makes Git check if converting `CRLF` is reversible when 271 end-of-line conversion is active. Git will verify if a command 272 modifies a file in the work tree either directly or indirectly. 273 For example, committing a file followed by checking out the 274 same file should yield the original file in the work tree. If 275 this is not the case for the current setting of 276 `core.autocrlf`, Git will reject the file. The variable can 277 be set to "warn", in which case Git will only warn about an 278 irreversible conversion but continue the operation. 279+ 280CRLF conversion bears a slight chance of corrupting data. 281When it is enabled, Git will convert CRLF to LF during commit and LF to 282CRLF during checkout. A file that contains a mixture of LF and 283CRLF before the commit cannot be recreated by Git. For text 284files this is the right thing to do: it corrects line endings 285such that we have only LF line endings in the repository. 286But for binary files that are accidentally classified as text the 287conversion can corrupt data. 288+ 289If you recognize such corruption early you can easily fix it by 290setting the conversion type explicitly in .gitattributes. Right 291after committing you still have the original file in your work 292tree and this file is not yet corrupted. You can explicitly tell 293Git that this file is binary and Git will handle the file 294appropriately. 295+ 296Unfortunately, the desired effect of cleaning up text files with 297mixed line endings and the undesired effect of corrupting binary 298files cannot be distinguished. In both cases CRLFs are removed 299in an irreversible way. For text files this is the right thing 300to do because CRLFs are line endings, while for binary files 301converting CRLFs corrupts data. 302+ 303Note, this safety check does not mean that a checkout will generate a 304file identical to the original file for a different setting of 305`core.eol` and `core.autocrlf`, but only for the current one. For 306example, a text file with `LF` would be accepted with `core.eol=lf` 307and could later be checked out with `core.eol=crlf`, in which case the 308resulting file would contain `CRLF`, although the original file 309contained `LF`. However, in both work trees the line endings would be 310consistent, that is either all `LF` or all `CRLF`, but never mixed. A 311file with mixed line endings would be reported by the `core.safecrlf` 312mechanism. 313 314core.autocrlf:: 315 Setting this variable to "true" is almost the same as setting 316 the `text` attribute to "auto" on all files except that text 317 files are not guaranteed to be normalized: files that contain 318 `CRLF` in the repository will not be touched. Use this 319 setting if you want to have `CRLF` line endings in your 320 working directory even though the repository does not have 321 normalized line endings. This variable can be set to 'input', 322 in which case no output conversion is performed. 323 324core.symlinks:: 325 If false, symbolic links are checked out as small plain files that 326 contain the link text. linkgit:git-update-index[1] and 327 linkgit:git-add[1] will not change the recorded type to regular 328 file. Useful on filesystems like FAT that do not support 329 symbolic links. 330+ 331The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 332will probe and set core.symlinks false if appropriate when the repository 333is created. 334 335core.gitProxy:: 336 A "proxy command" to execute (as 'command host port') instead 337 of establishing direct connection to the remote server when 338 using the Git protocol for fetching. If the variable value is 339 in the "COMMAND for DOMAIN" format, the command is applied only 340 on hostnames ending with the specified domain string. This variable 341 may be set multiple times and is matched in the given order; 342 the first match wins. 343+ 344Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 345(which always applies universally, without the special "for" 346handling). 347+ 348The special string `none` can be used as the proxy command to 349specify that no proxy be used for a given domain pattern. 350This is useful for excluding servers inside a firewall from 351proxy use, while defaulting to a common proxy for external domains. 352 353core.ignoreStat:: 354 If true, commands which modify both the working tree and the index 355 will mark the updated paths with the "assume unchanged" bit in the 356 index. These marked files are then assumed to stay unchanged in the 357 working tree, until you mark them otherwise manually - Git will not 358 detect the file changes by lstat() calls. This is useful on systems 359 where those are very slow, such as Microsoft Windows. 360 See linkgit:git-update-index[1]. 361 False by default. 362 363core.preferSymlinkRefs:: 364 Instead of the default "symref" format for HEAD 365 and other symbolic reference files, use symbolic links. 366 This is sometimes needed to work with old scripts that 367 expect HEAD to be a symbolic link. 368 369core.bare:: 370 If true this repository is assumed to be 'bare' and has no 371 working directory associated with it. If this is the case a 372 number of commands that require a working directory will be 373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 374+ 375This setting is automatically guessed by linkgit:git-clone[1] or 376linkgit:git-init[1] when the repository was created. By default a 377repository that ends in "/.git" is assumed to be not bare (bare = 378false), while all other repositories are assumed to be bare (bare 379= true). 380 381core.worktree:: 382 Set the path to the root of the working tree. 383 This can be overridden by the GIT_WORK_TREE environment 384 variable and the '--work-tree' command-line option. 385 The value can be an absolute path or relative to the path to 386 the .git directory, which is either specified by --git-dir 387 or GIT_DIR, or automatically discovered. 388 If --git-dir or GIT_DIR is specified but none of 389 --work-tree, GIT_WORK_TREE and core.worktree is specified, 390 the current working directory is regarded as the top level 391 of your working tree. 392+ 393Note that this variable is honored even when set in a configuration 394file in a ".git" subdirectory of a directory and its value differs 395from the latter directory (e.g. "/path/to/.git/config" has 396core.worktree set to "/different/path"), which is most likely a 397misconfiguration. Running Git commands in the "/path/to" directory will 398still use "/different/path" as the root of the work tree and can cause 399confusion unless you know what you are doing (e.g. you are creating a 400read-only snapshot of the same index to a location different from the 401repository's usual working tree). 402 403core.logAllRefUpdates:: 404 Enable the reflog. Updates to a ref <ref> is logged to the file 405 "$GIT_DIR/logs/<ref>", by appending the new and old 406 SHA-1, the date/time and the reason of the update, but 407 only when the file exists. If this configuration 408 variable is set to true, missing "$GIT_DIR/logs/<ref>" 409 file is automatically created for branch heads (i.e. under 410 refs/heads/), remote refs (i.e. under refs/remotes/), 411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 412+ 413This information can be used to determine what commit 414was the tip of a branch "2 days ago". 415+ 416This value is true by default in a repository that has 417a working directory associated with it, and false by 418default in a bare repository. 419 420core.repositoryFormatVersion:: 421 Internal variable identifying the repository format and layout 422 version. 423 424core.sharedRepository:: 425 When 'group' (or 'true'), the repository is made shareable between 426 several users in a group (making sure all the files and objects are 427 group-writable). When 'all' (or 'world' or 'everybody'), the 428 repository will be readable by all users, additionally to being 429 group-shareable. When 'umask' (or 'false'), Git will use permissions 430 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 431 files in the repository will have this mode value. '0xxx' will override 432 user's umask value (whereas the other options will only override 433 requested parts of the user's umask value). Examples: '0660' will make 434 the repo read/write-able for the owner and group, but inaccessible to 435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 436 repository that is group-readable but not group-writable. 437 See linkgit:git-init[1]. False by default. 438 439core.warnAmbiguousRefs:: 440 If true, Git will warn you if the ref name you passed it is ambiguous 441 and might match multiple refs in the repository. True by default. 442 443core.compression:: 444 An integer -1..9, indicating a default compression level. 445 -1 is the zlib default. 0 means no compression, 446 and 1..9 are various speed/size tradeoffs, 9 being slowest. 447 If set, this provides a default to other compression variables, 448 such as 'core.loosecompression' and 'pack.compression'. 449 450core.loosecompression:: 451 An integer -1..9, indicating the compression level for objects that 452 are not in a pack file. -1 is the zlib default. 0 means no 453 compression, and 1..9 are various speed/size tradeoffs, 9 being 454 slowest. If not set, defaults to core.compression. If that is 455 not set, defaults to 1 (best speed). 456 457core.packedGitWindowSize:: 458 Number of bytes of a pack file to map into memory in a 459 single mapping operation. Larger window sizes may allow 460 your system to process a smaller number of large pack files 461 more quickly. Smaller window sizes will negatively affect 462 performance due to increased calls to the operating system's 463 memory manager, but may improve performance when accessing 464 a large number of large pack files. 465+ 466Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 467MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 468be reasonable for all users/operating systems. You probably do 469not need to adjust this value. 470+ 471Common unit suffixes of 'k', 'm', or 'g' are supported. 472 473core.packedGitLimit:: 474 Maximum number of bytes to map simultaneously into memory 475 from pack files. If Git needs to access more than this many 476 bytes at once to complete an operation it will unmap existing 477 regions to reclaim virtual address space within the process. 478+ 479Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 480This should be reasonable for all users/operating systems, except on 481the largest projects. You probably do not need to adjust this value. 482+ 483Common unit suffixes of 'k', 'm', or 'g' are supported. 484 485core.deltaBaseCacheLimit:: 486 Maximum number of bytes to reserve for caching base objects 487 that may be referenced by multiple deltified objects. By storing the 488 entire decompressed base objects in a cache Git is able 489 to avoid unpacking and decompressing frequently used base 490 objects multiple times. 491+ 492Default is 96 MiB on all platforms. This should be reasonable 493for all users/operating systems, except on the largest projects. 494You probably do not need to adjust this value. 495+ 496Common unit suffixes of 'k', 'm', or 'g' are supported. 497 498core.bigFileThreshold:: 499 Files larger than this size are stored deflated, without 500 attempting delta compression. Storing large files without 501 delta compression avoids excessive memory usage, at the 502 slight expense of increased disk usage. Additionally files 503 larger than this size are always treated as binary. 504+ 505Default is 512 MiB on all platforms. This should be reasonable 506for most projects as source code and other text files can still 507be delta compressed, but larger binary media files won't be. 508+ 509Common unit suffixes of 'k', 'm', or 'g' are supported. 510 511core.excludesfile:: 512 In addition to '.gitignore' (per-directory) and 513 '.git/info/exclude', Git looks into this file for patterns 514 of files which are not meant to be tracked. "`~/`" is expanded 515 to the value of `$HOME` and "`~user/`" to the specified user's 516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 518 is used instead. See linkgit:gitignore[5]. 519 520core.askpass:: 521 Some commands (e.g. svn and http interfaces) that interactively 522 ask for a password can be told to use an external program given 523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 524 environment variable. If not set, fall back to the value of the 525 'SSH_ASKPASS' environment variable or, failing that, a simple password 526 prompt. The external program shall be given a suitable prompt as 527 command-line argument and write the password on its STDOUT. 528 529core.attributesfile:: 530 In addition to '.gitattributes' (per-directory) and 531 '.git/info/attributes', Git looks into this file for attributes 532 (see linkgit:gitattributes[5]). Path expansions are made the same 533 way as for `core.excludesfile`. Its default value is 534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 535 set or empty, $HOME/.config/git/attributes is used instead. 536 537core.editor:: 538 Commands such as `commit` and `tag` that lets you edit 539 messages by launching an editor uses the value of this 540 variable when it is set, and the environment variable 541 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 542 543core.commentchar:: 544 Commands such as `commit` and `tag` that lets you edit 545 messages consider a line that begins with this character 546 commented, and removes them after the editor returns 547 (default '#'). 548+ 549If set to "auto", `git-commit` would select a character that is not 550the beginning character of any line in existing commit messages. 551 552sequence.editor:: 553 Text editor used by `git rebase -i` for editing the rebase instruction file. 554 The value is meant to be interpreted by the shell when it is used. 555 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 556 When not configured the default commit message editor is used instead. 557 558core.pager:: 559 Text viewer for use by Git commands (e.g., 'less'). The value 560 is meant to be interpreted by the shell. The order of preference 561 is the `$GIT_PAGER` environment variable, then `core.pager` 562 configuration, then `$PAGER`, and then the default chosen at 563 compile time (usually 'less'). 564+ 565When the `LESS` environment variable is unset, Git sets it to `FRX` 566(if `LESS` environment variable is set, Git does not change it at 567all). If you want to selectively override Git's default setting 568for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 569be passed to the shell by Git, which will translate the final 570command to `LESS=FRX less -S`. The environment does not set the 571`S` option but the command line does, instructing less to truncate 572long lines. Similarly, setting `core.pager` to `less -+F` will 573deactivate the `F` option specified by the environment from the 574command-line, deactivating the "quit if one screen" behavior of 575`less`. One can specifically activate some flags for particular 576commands: for example, setting `pager.blame` to `less -S` enables 577line truncation only for `git blame`. 578+ 579Likewise, when the `LV` environment variable is unset, Git sets it 580to `-c`. You can override this setting by exporting `LV` with 581another value or setting `core.pager` to `lv +c`. 582 583core.whitespace:: 584 A comma separated list of common whitespace problems to 585 notice. 'git diff' will use `color.diff.whitespace` to 586 highlight them, and 'git apply --whitespace=error' will 587 consider them as errors. You can prefix `-` to disable 588 any of them (e.g. `-trailing-space`): 589+ 590* `blank-at-eol` treats trailing whitespaces at the end of the line 591 as an error (enabled by default). 592* `space-before-tab` treats a space character that appears immediately 593 before a tab character in the initial indent part of the line as an 594 error (enabled by default). 595* `indent-with-non-tab` treats a line that is indented with space 596 characters instead of the equivalent tabs as an error (not enabled by 597 default). 598* `tab-in-indent` treats a tab character in the initial indent part of 599 the line as an error (not enabled by default). 600* `blank-at-eof` treats blank lines added at the end of file as an error 601 (enabled by default). 602* `trailing-space` is a short-hand to cover both `blank-at-eol` and 603 `blank-at-eof`. 604* `cr-at-eol` treats a carriage-return at the end of line as 605 part of the line terminator, i.e. with it, `trailing-space` 606 does not trigger if the character before such a carriage-return 607 is not a whitespace (not enabled by default). 608* `tabwidth=<n>` tells how many character positions a tab occupies; this 609 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 610 errors. The default tab width is 8. Allowed values are 1 to 63. 611 612core.fsyncobjectfiles:: 613 This boolean will enable 'fsync()' when writing object files. 614+ 615This is a total waste of time and effort on a filesystem that orders 616data writes properly, but can be useful for filesystems that do not use 617journalling (traditional UNIX filesystems) or that only journal metadata 618and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 619 620core.preloadindex:: 621 Enable parallel index preload for operations like 'git diff' 622+ 623This can speed up operations like 'git diff' and 'git status' especially 624on filesystems like NFS that have weak caching semantics and thus 625relatively high IO latencies. When enabled, Git will do the 626index comparison to the filesystem data in parallel, allowing 627overlapping IO's. Defaults to true. 628 629core.createObject:: 630 You can set this to 'link', in which case a hardlink followed by 631 a delete of the source are used to make sure that object creation 632 will not overwrite existing objects. 633+ 634On some file system/operating system combinations, this is unreliable. 635Set this config setting to 'rename' there; However, This will remove the 636check that makes sure that existing object files will not get overwritten. 637 638core.notesRef:: 639 When showing commit messages, also show notes which are stored in 640 the given ref. The ref must be fully qualified. If the given 641 ref does not exist, it is not an error but means that no 642 notes should be printed. 643+ 644This setting defaults to "refs/notes/commits", and it can be overridden by 645the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 646 647core.sparseCheckout:: 648 Enable "sparse checkout" feature. See section "Sparse checkout" in 649 linkgit:git-read-tree[1] for more information. 650 651core.abbrev:: 652 Set the length object names are abbreviated to. If unspecified, 653 many commands abbreviate to 7 hexdigits, which may not be enough 654 for abbreviated object names to stay unique for sufficiently long 655 time. 656 657add.ignore-errors:: 658add.ignoreErrors:: 659 Tells 'git add' to continue adding files when some files cannot be 660 added due to indexing errors. Equivalent to the '--ignore-errors' 661 option of linkgit:git-add[1]. Older versions of Git accept only 662 `add.ignore-errors`, which does not follow the usual naming 663 convention for configuration variables. Newer versions of Git 664 honor `add.ignoreErrors` as well. 665 666alias.*:: 667 Command aliases for the linkgit:git[1] command wrapper - e.g. 668 after defining "alias.last = cat-file commit HEAD", the invocation 669 "git last" is equivalent to "git cat-file commit HEAD". To avoid 670 confusion and troubles with script usage, aliases that 671 hide existing Git commands are ignored. Arguments are split by 672 spaces, the usual shell quoting and escaping is supported. 673 quote pair and a backslash can be used to quote them. 674+ 675If the alias expansion is prefixed with an exclamation point, 676it will be treated as a shell command. For example, defining 677"alias.new = !gitk --all --not ORIG_HEAD", the invocation 678"git new" is equivalent to running the shell command 679"gitk --all --not ORIG_HEAD". Note that shell commands will be 680executed from the top-level directory of a repository, which may 681not necessarily be the current directory. 682'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 683from the original current directory. See linkgit:git-rev-parse[1]. 684 685am.keepcr:: 686 If true, git-am will call git-mailsplit for patches in mbox format 687 with parameter '--keep-cr'. In this case git-mailsplit will 688 not remove `\r` from lines ending with `\r\n`. Can be overridden 689 by giving '--no-keep-cr' from the command line. 690 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 691 692apply.ignorewhitespace:: 693 When set to 'change', tells 'git apply' to ignore changes in 694 whitespace, in the same way as the '--ignore-space-change' 695 option. 696 When set to one of: no, none, never, false tells 'git apply' to 697 respect all whitespace differences. 698 See linkgit:git-apply[1]. 699 700apply.whitespace:: 701 Tells 'git apply' how to handle whitespaces, in the same way 702 as the '--whitespace' option. See linkgit:git-apply[1]. 703 704branch.autosetupmerge:: 705 Tells 'git branch' and 'git checkout' to set up new branches 706 so that linkgit:git-pull[1] will appropriately merge from the 707 starting point branch. Note that even if this option is not set, 708 this behavior can be chosen per-branch using the `--track` 709 and `--no-track` options. The valid settings are: `false` -- no 710 automatic setup is done; `true` -- automatic setup is done when the 711 starting point is a remote-tracking branch; `always` -- 712 automatic setup is done when the starting point is either a 713 local branch or remote-tracking 714 branch. This option defaults to true. 715 716branch.autosetuprebase:: 717 When a new branch is created with 'git branch' or 'git checkout' 718 that tracks another branch, this variable tells Git to set 719 up pull to rebase instead of merge (see "branch.<name>.rebase"). 720 When `never`, rebase is never automatically set to true. 721 When `local`, rebase is set to true for tracked branches of 722 other local branches. 723 When `remote`, rebase is set to true for tracked branches of 724 remote-tracking branches. 725 When `always`, rebase will be set to true for all tracking 726 branches. 727 See "branch.autosetupmerge" for details on how to set up a 728 branch to track another branch. 729 This option defaults to never. 730 731branch.<name>.remote:: 732 When on branch <name>, it tells 'git fetch' and 'git push' 733 which remote to fetch from/push to. The remote to push to 734 may be overridden with `remote.pushdefault` (for all branches). 735 The remote to push to, for the current branch, may be further 736 overridden by `branch.<name>.pushremote`. If no remote is 737 configured, or if you are not on any branch, it defaults to 738 `origin` for fetching and `remote.pushdefault` for pushing. 739 Additionally, `.` (a period) is the current local repository 740 (a dot-repository), see `branch.<name>.merge`'s final note below. 741 742branch.<name>.pushremote:: 743 When on branch <name>, it overrides `branch.<name>.remote` for 744 pushing. It also overrides `remote.pushdefault` for pushing 745 from branch <name>. When you pull from one place (e.g. your 746 upstream) and push to another place (e.g. your own publishing 747 repository), you would want to set `remote.pushdefault` to 748 specify the remote to push to for all branches, and use this 749 option to override it for a specific branch. 750 751branch.<name>.merge:: 752 Defines, together with branch.<name>.remote, the upstream branch 753 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 754 branch to merge and can also affect 'git push' (see push.default). 755 When in branch <name>, it tells 'git fetch' the default 756 refspec to be marked for merging in FETCH_HEAD. The value is 757 handled like the remote part of a refspec, and must match a 758 ref which is fetched from the remote given by 759 "branch.<name>.remote". 760 The merge information is used by 'git pull' (which at first calls 761 'git fetch') to lookup the default branch for merging. Without 762 this option, 'git pull' defaults to merge the first refspec fetched. 763 Specify multiple values to get an octopus merge. 764 If you wish to setup 'git pull' so that it merges into <name> from 765 another branch in the local repository, you can point 766 branch.<name>.merge to the desired branch, and use the relative path 767 setting `.` (a period) for branch.<name>.remote. 768 769branch.<name>.mergeoptions:: 770 Sets default options for merging into branch <name>. The syntax and 771 supported options are the same as those of linkgit:git-merge[1], but 772 option values containing whitespace characters are currently not 773 supported. 774 775branch.<name>.rebase:: 776 When true, rebase the branch <name> on top of the fetched branch, 777 instead of merging the default branch from the default remote when 778 "git pull" is run. See "pull.rebase" for doing this in a non 779 branch-specific manner. 780+ 781 When preserve, also pass `--preserve-merges` along to 'git rebase' 782 so that locally committed merge commits will not be flattened 783 by running 'git pull'. 784+ 785*NOTE*: this is a possibly dangerous operation; do *not* use 786it unless you understand the implications (see linkgit:git-rebase[1] 787for details). 788 789branch.<name>.description:: 790 Branch description, can be edited with 791 `git branch --edit-description`. Branch description is 792 automatically added in the format-patch cover letter or 793 request-pull summary. 794 795browser.<tool>.cmd:: 796 Specify the command to invoke the specified browser. The 797 specified command is evaluated in shell with the URLs passed 798 as arguments. (See linkgit:git-web{litdd}browse[1].) 799 800browser.<tool>.path:: 801 Override the path for the given tool that may be used to 802 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 803 working repository in gitweb (see linkgit:git-instaweb[1]). 804 805clean.requireForce:: 806 A boolean to make git-clean do nothing unless given -f, 807 -i or -n. Defaults to true. 808 809color.branch:: 810 A boolean to enable/disable color in the output of 811 linkgit:git-branch[1]. May be set to `always`, 812 `false` (or `never`) or `auto` (or `true`), in which case colors are used 813 only when the output is to a terminal. Defaults to false. 814 815color.branch.<slot>:: 816 Use customized color for branch coloration. `<slot>` is one of 817 `current` (the current branch), `local` (a local branch), 818 `remote` (a remote-tracking branch in refs/remotes/), 819 `upstream` (upstream tracking branch), `plain` (other 820 refs). 821+ 822The value for these configuration variables is a list of colors (at most 823two) and attributes (at most one), separated by spaces. The colors 824accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 825`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 826`blink` and `reverse`. The first color given is the foreground; the 827second is the background. The position of the attribute, if any, 828doesn't matter. 829 830color.diff:: 831 Whether to use ANSI escape sequences to add color to patches. 832 If this is set to `always`, linkgit:git-diff[1], 833 linkgit:git-log[1], and linkgit:git-show[1] will use color 834 for all patches. If it is set to `true` or `auto`, those 835 commands will only use color when output is to the terminal. 836 Defaults to false. 837+ 838This does not affect linkgit:git-format-patch[1] or the 839'git-diff-{asterisk}' plumbing commands. Can be overridden on the 840command line with the `--color[=<when>]` option. 841 842color.diff.<slot>:: 843 Use customized color for diff colorization. `<slot>` specifies 844 which part of the patch to use the specified color, and is one 845 of `plain` (context text), `meta` (metainformation), `frag` 846 (hunk header), 'func' (function in hunk header), `old` (removed lines), 847 `new` (added lines), `commit` (commit headers), or `whitespace` 848 (highlighting whitespace errors). The values of these variables may be 849 specified as in color.branch.<slot>. 850 851color.decorate.<slot>:: 852 Use customized color for 'git log --decorate' output. `<slot>` is one 853 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 854 branches, remote-tracking branches, tags, stash and HEAD, respectively. 855 856color.grep:: 857 When set to `always`, always highlight matches. When `false` (or 858 `never`), never. When set to `true` or `auto`, use color only 859 when the output is written to the terminal. Defaults to `false`. 860 861color.grep.<slot>:: 862 Use customized color for grep colorization. `<slot>` specifies which 863 part of the line to use the specified color, and is one of 864+ 865-- 866`context`;; 867 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 868`filename`;; 869 filename prefix (when not using `-h`) 870`function`;; 871 function name lines (when using `-p`) 872`linenumber`;; 873 line number prefix (when using `-n`) 874`match`;; 875 matching text 876`selected`;; 877 non-matching text in selected lines 878`separator`;; 879 separators between fields on a line (`:`, `-`, and `=`) 880 and between hunks (`--`) 881-- 882+ 883The values of these variables may be specified as in color.branch.<slot>. 884 885color.interactive:: 886 When set to `always`, always use colors for interactive prompts 887 and displays (such as those used by "git-add --interactive" and 888 "git-clean --interactive"). When false (or `never`), never. 889 When set to `true` or `auto`, use colors only when the output is 890 to the terminal. Defaults to false. 891 892color.interactive.<slot>:: 893 Use customized color for 'git add --interactive' and 'git clean 894 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 895 or `error`, for four distinct types of normal output from 896 interactive commands. The values of these variables may be 897 specified as in color.branch.<slot>. 898 899color.pager:: 900 A boolean to enable/disable colored output when the pager is in 901 use (default is true). 902 903color.showbranch:: 904 A boolean to enable/disable color in the output of 905 linkgit:git-show-branch[1]. May be set to `always`, 906 `false` (or `never`) or `auto` (or `true`), in which case colors are used 907 only when the output is to a terminal. Defaults to false. 908 909color.status:: 910 A boolean to enable/disable color in the output of 911 linkgit:git-status[1]. May be set to `always`, 912 `false` (or `never`) or `auto` (or `true`), in which case colors are used 913 only when the output is to a terminal. Defaults to false. 914 915color.status.<slot>:: 916 Use customized color for status colorization. `<slot>` is 917 one of `header` (the header text of the status message), 918 `added` or `updated` (files which are added but not committed), 919 `changed` (files which are changed but not added in the index), 920 `untracked` (files which are not tracked by Git), 921 `branch` (the current branch), or 922 `nobranch` (the color the 'no branch' warning is shown in, defaulting 923 to red). The values of these variables may be specified as in 924 color.branch.<slot>. 925 926color.ui:: 927 This variable determines the default value for variables such 928 as `color.diff` and `color.grep` that control the use of color 929 per command family. Its scope will expand as more commands learn 930 configuration to set a default for the `--color` option. Set it 931 to `false` or `never` if you prefer Git commands not to use 932 color unless enabled explicitly with some other configuration 933 or the `--color` option. Set it to `always` if you want all 934 output not intended for machine consumption to use color, to 935 `true` or `auto` (this is the default since Git 1.8.4) if you 936 want such output to use color when written to the terminal. 937 938column.ui:: 939 Specify whether supported commands should output in columns. 940 This variable consists of a list of tokens separated by spaces 941 or commas: 942+ 943These options control when the feature should be enabled 944(defaults to 'never'): 945+ 946-- 947`always`;; 948 always show in columns 949`never`;; 950 never show in columns 951`auto`;; 952 show in columns if the output is to the terminal 953-- 954+ 955These options control layout (defaults to 'column'). Setting any 956of these implies 'always' if none of 'always', 'never', or 'auto' are 957specified. 958+ 959-- 960`column`;; 961 fill columns before rows 962`row`;; 963 fill rows before columns 964`plain`;; 965 show in one column 966-- 967+ 968Finally, these options can be combined with a layout option (defaults 969to 'nodense'): 970+ 971-- 972`dense`;; 973 make unequal size columns to utilize more space 974`nodense`;; 975 make equal size columns 976-- 977 978column.branch:: 979 Specify whether to output branch listing in `git branch` in columns. 980 See `column.ui` for details. 981 982column.clean:: 983 Specify the layout when list items in `git clean -i`, which always 984 shows files and directories in columns. See `column.ui` for details. 985 986column.status:: 987 Specify whether to output untracked files in `git status` in columns. 988 See `column.ui` for details. 989 990column.tag:: 991 Specify whether to output tag listing in `git tag` in columns. 992 See `column.ui` for details. 993 994commit.cleanup:: 995 This setting overrides the default of the `--cleanup` option in 996 `git commit`. See linkgit:git-commit[1] for details. Changing the 997 default can be useful when you always want to keep lines that begin 998 with comment character `#` in your log message, in which case you 999 would do `git config commit.cleanup whitespace` (note that you will1000 have to remove the help lines that begin with `#` in the commit log1001 template yourself, if you do this).10021003commit.gpgsign::10041005 A boolean to specify whether all commits should be GPG signed.1006 Use of this option when doing operations such as rebase can1007 result in a large number of commits being signed. It may be1008 convenient to use an agent to avoid typing your GPG passphrase1009 several times.10101011commit.status::1012 A boolean to enable/disable inclusion of status information in the1013 commit message template when using an editor to prepare the commit1014 message. Defaults to true.10151016commit.template::1017 Specify a file to use as the template for new commit messages.1018 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1019 specified user's home directory.10201021credential.helper::1022 Specify an external helper to be called when a username or1023 password credential is needed; the helper may consult external1024 storage to avoid prompting the user for the credentials. See1025 linkgit:gitcredentials[7] for details.10261027credential.useHttpPath::1028 When acquiring credentials, consider the "path" component of an http1029 or https URL to be important. Defaults to false. See1030 linkgit:gitcredentials[7] for more information.10311032credential.username::1033 If no username is set for a network authentication, use this username1034 by default. See credential.<context>.* below, and1035 linkgit:gitcredentials[7].10361037credential.<url>.*::1038 Any of the credential.* options above can be applied selectively to1039 some credentials. For example "credential.https://example.com.username"1040 would set the default username only for https connections to1041 example.com. See linkgit:gitcredentials[7] for details on how URLs are1042 matched.10431044include::diff-config.txt[]10451046difftool.<tool>.path::1047 Override the path for the given tool. This is useful in case1048 your tool is not in the PATH.10491050difftool.<tool>.cmd::1051 Specify the command to invoke the specified diff tool.1052 The specified command is evaluated in shell with the following1053 variables available: 'LOCAL' is set to the name of the temporary1054 file containing the contents of the diff pre-image and 'REMOTE'1055 is set to the name of the temporary file containing the contents1056 of the diff post-image.10571058difftool.prompt::1059 Prompt before each invocation of the diff tool.10601061fetch.recurseSubmodules::1062 This option can be either set to a boolean value or to 'on-demand'.1063 Setting it to a boolean changes the behavior of fetch and pull to1064 unconditionally recurse into submodules when set to true or to not1065 recurse at all when set to false. When set to 'on-demand' (the default1066 value), fetch and pull will only recurse into a populated submodule1067 when its superproject retrieves a commit that updates the submodule's1068 reference.10691070fetch.fsckObjects::1071 If it is set to true, git-fetch-pack will check all fetched1072 objects. It will abort in the case of a malformed object or a1073 broken link. The result of an abort are only dangling objects.1074 Defaults to false. If not set, the value of `transfer.fsckObjects`1075 is used instead.10761077fetch.unpackLimit::1078 If the number of objects fetched over the Git native1079 transfer is below this1080 limit, then the objects will be unpacked into loose object1081 files. However if the number of received objects equals or1082 exceeds this limit then the received pack will be stored as1083 a pack, after adding any missing delta bases. Storing the1084 pack from a push can make the push operation complete faster,1085 especially on slow filesystems. If not set, the value of1086 `transfer.unpackLimit` is used instead.10871088fetch.prune::1089 If true, fetch will automatically behave as if the `--prune`1090 option was given on the command line. See also `remote.<name>.prune`.10911092format.attach::1093 Enable multipart/mixed attachments as the default for1094 'format-patch'. The value can also be a double quoted string1095 which will enable attachments as the default and set the1096 value as the boundary. See the --attach option in1097 linkgit:git-format-patch[1].10981099format.numbered::1100 A boolean which can enable or disable sequence numbers in patch1101 subjects. It defaults to "auto" which enables it only if there1102 is more than one patch. It can be enabled or disabled for all1103 messages by setting it to "true" or "false". See --numbered1104 option in linkgit:git-format-patch[1].11051106format.headers::1107 Additional email headers to include in a patch to be submitted1108 by mail. See linkgit:git-format-patch[1].11091110format.to::1111format.cc::1112 Additional recipients to include in a patch to be submitted1113 by mail. See the --to and --cc options in1114 linkgit:git-format-patch[1].11151116format.subjectprefix::1117 The default for format-patch is to output files with the '[PATCH]'1118 subject prefix. Use this variable to change that prefix.11191120format.signature::1121 The default for format-patch is to output a signature containing1122 the Git version number. Use this variable to change that default.1123 Set this variable to the empty string ("") to suppress1124 signature generation.11251126format.signaturefile::1127 Works just like format.signature except the contents of the1128 file specified by this variable will be used as the signature.11291130format.suffix::1131 The default for format-patch is to output files with the suffix1132 `.patch`. Use this variable to change that suffix (make sure to1133 include the dot if you want it).11341135format.pretty::1136 The default pretty format for log/show/whatchanged command,1137 See linkgit:git-log[1], linkgit:git-show[1],1138 linkgit:git-whatchanged[1].11391140format.thread::1141 The default threading style for 'git format-patch'. Can be1142 a boolean value, or `shallow` or `deep`. `shallow` threading1143 makes every mail a reply to the head of the series,1144 where the head is chosen from the cover letter, the1145 `--in-reply-to`, and the first patch mail, in this order.1146 `deep` threading makes every mail a reply to the previous one.1147 A true boolean value is the same as `shallow`, and a false1148 value disables threading.11491150format.signoff::1151 A boolean value which lets you enable the `-s/--signoff` option of1152 format-patch by default. *Note:* Adding the Signed-off-by: line to a1153 patch should be a conscious act and means that you certify you have1154 the rights to submit this work under the same open source license.1155 Please see the 'SubmittingPatches' document for further discussion.11561157format.coverLetter::1158 A boolean that controls whether to generate a cover-letter when1159 format-patch is invoked, but in addition can be set to "auto", to1160 generate a cover-letter only when there's more than one patch.11611162filter.<driver>.clean::1163 The command which is used to convert the content of a worktree1164 file to a blob upon checkin. See linkgit:gitattributes[5] for1165 details.11661167filter.<driver>.smudge::1168 The command which is used to convert the content of a blob1169 object to a worktree file upon checkout. See1170 linkgit:gitattributes[5] for details.11711172gc.aggressiveDepth::1173 The depth parameter used in the delta compression1174 algorithm used by 'git gc --aggressive'. This defaults1175 to 250.11761177gc.aggressiveWindow::1178 The window size parameter used in the delta compression1179 algorithm used by 'git gc --aggressive'. This defaults1180 to 250.11811182gc.auto::1183 When there are approximately more than this many loose1184 objects in the repository, `git gc --auto` will pack them.1185 Some Porcelain commands use this command to perform a1186 light-weight garbage collection from time to time. The1187 default value is 6700. Setting this to 0 disables it.11881189gc.autopacklimit::1190 When there are more than this many packs that are not1191 marked with `*.keep` file in the repository, `git gc1192 --auto` consolidates them into one larger pack. The1193 default value is 50. Setting this to 0 disables it.11941195gc.autodetach::1196 Make `git gc --auto` return immediately andrun in background1197 if the system supports it. Default is true.11981199gc.packrefs::1200 Running `git pack-refs` in a repository renders it1201 unclonable by Git versions prior to 1.5.1.2 over dumb1202 transports such as HTTP. This variable determines whether1203 'git gc' runs `git pack-refs`. This can be set to `notbare`1204 to enable it within all non-bare repos or it can be set to a1205 boolean value. The default is `true`.12061207gc.pruneexpire::1208 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1209 Override the grace period with this config variable. The value1210 "now" may be used to disable this grace period and always prune1211 unreachable objects immediately.12121213gc.reflogexpire::1214gc.<pattern>.reflogexpire::1215 'git reflog expire' removes reflog entries older than1216 this time; defaults to 90 days. With "<pattern>" (e.g.1217 "refs/stash") in the middle the setting applies only to1218 the refs that match the <pattern>.12191220gc.reflogexpireunreachable::1221gc.<ref>.reflogexpireunreachable::1222 'git reflog expire' removes reflog entries older than1223 this time and are not reachable from the current tip;1224 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1225 in the middle, the setting applies only to the refs that1226 match the <pattern>.12271228gc.rerereresolved::1229 Records of conflicted merge you resolved earlier are1230 kept for this many days when 'git rerere gc' is run.1231 The default is 60 days. See linkgit:git-rerere[1].12321233gc.rerereunresolved::1234 Records of conflicted merge you have not resolved are1235 kept for this many days when 'git rerere gc' is run.1236 The default is 15 days. See linkgit:git-rerere[1].12371238gitcvs.commitmsgannotation::1239 Append this string to each commit message. Set to empty string1240 to disable this feature. Defaults to "via git-CVS emulator".12411242gitcvs.enabled::1243 Whether the CVS server interface is enabled for this repository.1244 See linkgit:git-cvsserver[1].12451246gitcvs.logfile::1247 Path to a log file where the CVS server interface well... logs1248 various stuff. See linkgit:git-cvsserver[1].12491250gitcvs.usecrlfattr::1251 If true, the server will look up the end-of-line conversion1252 attributes for files to determine the '-k' modes to use. If1253 the attributes force Git to treat a file as text,1254 the '-k' mode will be left blank so CVS clients will1255 treat it as text. If they suppress text conversion, the file1256 will be set with '-kb' mode, which suppresses any newline munging1257 the client might otherwise do. If the attributes do not allow1258 the file type to be determined, then 'gitcvs.allbinary' is1259 used. See linkgit:gitattributes[5].12601261gitcvs.allbinary::1262 This is used if 'gitcvs.usecrlfattr' does not resolve1263 the correct '-kb' mode to use. If true, all1264 unresolved files are sent to the client in1265 mode '-kb'. This causes the client to treat them1266 as binary files, which suppresses any newline munging it1267 otherwise might do. Alternatively, if it is set to "guess",1268 then the contents of the file are examined to decide if1269 it is binary, similar to 'core.autocrlf'.12701271gitcvs.dbname::1272 Database used by git-cvsserver to cache revision information1273 derived from the Git repository. The exact meaning depends on the1274 used database driver, for SQLite (which is the default driver) this1275 is a filename. Supports variable substitution (see1276 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1277 Default: '%Ggitcvs.%m.sqlite'12781279gitcvs.dbdriver::1280 Used Perl DBI driver. You can specify any available driver1281 for this here, but it might not work. git-cvsserver is tested1282 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1283 reported *not* to work with 'DBD::mysql'. Experimental feature.1284 May not contain double colons (`:`). Default: 'SQLite'.1285 See linkgit:git-cvsserver[1].12861287gitcvs.dbuser, gitcvs.dbpass::1288 Database user and password. Only useful if setting 'gitcvs.dbdriver',1289 since SQLite has no concept of database users and/or passwords.1290 'gitcvs.dbuser' supports variable substitution (see1291 linkgit:git-cvsserver[1] for details).12921293gitcvs.dbTableNamePrefix::1294 Database table name prefix. Prepended to the names of any1295 database tables used, allowing a single database to be used1296 for several repositories. Supports variable substitution (see1297 linkgit:git-cvsserver[1] for details). Any non-alphabetic1298 characters will be replaced with underscores.12991300All gitcvs variables except for 'gitcvs.usecrlfattr' and1301'gitcvs.allbinary' can also be specified as1302'gitcvs.<access_method>.<varname>' (where 'access_method'1303is one of "ext" and "pserver") to make them apply only for the given1304access method.13051306gitweb.category::1307gitweb.description::1308gitweb.owner::1309gitweb.url::1310 See linkgit:gitweb[1] for description.13111312gitweb.avatar::1313gitweb.blame::1314gitweb.grep::1315gitweb.highlight::1316gitweb.patches::1317gitweb.pickaxe::1318gitweb.remote_heads::1319gitweb.showsizes::1320gitweb.snapshot::1321 See linkgit:gitweb.conf[5] for description.13221323grep.lineNumber::1324 If set to true, enable '-n' option by default.13251326grep.patternType::1327 Set the default matching behavior. Using a value of 'basic', 'extended',1328 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1329 '--fixed-strings', or '--perl-regexp' option accordingly, while the1330 value 'default' will return to the default matching behavior.13311332grep.extendedRegexp::1333 If set to true, enable '--extended-regexp' option by default. This1334 option is ignored when the 'grep.patternType' option is set to a value1335 other than 'default'.13361337gpg.program::1338 Use this custom program instead of "gpg" found on $PATH when1339 making or verifying a PGP signature. The program must support the1340 same command-line interface as GPG, namely, to verify a detached1341 signature, "gpg --verify $file - <$signature" is run, and the1342 program is expected to signal a good signature by exiting with1343 code 0, and to generate an ascii-armored detached signature, the1344 standard input of "gpg -bsau $key" is fed with the contents to be1345 signed, and the program is expected to send the result to its1346 standard output.13471348gui.commitmsgwidth::1349 Defines how wide the commit message window is in the1350 linkgit:git-gui[1]. "75" is the default.13511352gui.diffcontext::1353 Specifies how many context lines should be used in calls to diff1354 made by the linkgit:git-gui[1]. The default is "5".13551356gui.displayuntracked::1357 Determines if linkgit::git-gui[1] shows untracked files1358 in the file list. The default is "true".13591360gui.encoding::1361 Specifies the default encoding to use for displaying of1362 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1363 It can be overridden by setting the 'encoding' attribute1364 for relevant files (see linkgit:gitattributes[5]).1365 If this option is not set, the tools default to the1366 locale encoding.13671368gui.matchtrackingbranch::1369 Determines if new branches created with linkgit:git-gui[1] should1370 default to tracking remote branches with matching names or1371 not. Default: "false".13721373gui.newbranchtemplate::1374 Is used as suggested name when creating new branches using the1375 linkgit:git-gui[1].13761377gui.pruneduringfetch::1378 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1379 performing a fetch. The default value is "false".13801381gui.trustmtime::1382 Determines if linkgit:git-gui[1] should trust the file modification1383 timestamp or not. By default the timestamps are not trusted.13841385gui.spellingdictionary::1386 Specifies the dictionary used for spell checking commit messages in1387 the linkgit:git-gui[1]. When set to "none" spell checking is turned1388 off.13891390gui.fastcopyblame::1391 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1392 location detection. It makes blame significantly faster on huge1393 repositories at the expense of less thorough copy detection.13941395gui.copyblamethreshold::1396 Specifies the threshold to use in 'git gui blame' original location1397 detection, measured in alphanumeric characters. See the1398 linkgit:git-blame[1] manual for more information on copy detection.13991400gui.blamehistoryctx::1401 Specifies the radius of history context in days to show in1402 linkgit:gitk[1] for the selected commit, when the `Show History1403 Context` menu item is invoked from 'git gui blame'. If this1404 variable is set to zero, the whole history is shown.14051406guitool.<name>.cmd::1407 Specifies the shell command line to execute when the corresponding item1408 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1409 mandatory for every tool. The command is executed from the root of1410 the working directory, and in the environment it receives the name of1411 the tool as 'GIT_GUITOOL', the name of the currently selected file as1412 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1413 the head is detached, 'CUR_BRANCH' is empty).14141415guitool.<name>.needsfile::1416 Run the tool only if a diff is selected in the GUI. It guarantees1417 that 'FILENAME' is not empty.14181419guitool.<name>.noconsole::1420 Run the command silently, without creating a window to display its1421 output.14221423guitool.<name>.norescan::1424 Don't rescan the working directory for changes after the tool1425 finishes execution.14261427guitool.<name>.confirm::1428 Show a confirmation dialog before actually running the tool.14291430guitool.<name>.argprompt::1431 Request a string argument from the user, and pass it to the tool1432 through the 'ARGS' environment variable. Since requesting an1433 argument implies confirmation, the 'confirm' option has no effect1434 if this is enabled. If the option is set to 'true', 'yes', or '1',1435 the dialog uses a built-in generic prompt; otherwise the exact1436 value of the variable is used.14371438guitool.<name>.revprompt::1439 Request a single valid revision from the user, and set the1440 'REVISION' environment variable. In other aspects this option1441 is similar to 'argprompt', and can be used together with it.14421443guitool.<name>.revunmerged::1444 Show only unmerged branches in the 'revprompt' subdialog.1445 This is useful for tools similar to merge or rebase, but not1446 for things like checkout or reset.14471448guitool.<name>.title::1449 Specifies the title to use for the prompt dialog. The default1450 is the tool name.14511452guitool.<name>.prompt::1453 Specifies the general prompt string to display at the top of1454 the dialog, before subsections for 'argprompt' and 'revprompt'.1455 The default value includes the actual command.14561457help.browser::1458 Specify the browser that will be used to display help in the1459 'web' format. See linkgit:git-help[1].14601461help.format::1462 Override the default help format used by linkgit:git-help[1].1463 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1464 the default. 'web' and 'html' are the same.14651466help.autocorrect::1467 Automatically correct and execute mistyped commands after1468 waiting for the given number of deciseconds (0.1 sec). If more1469 than one command can be deduced from the entered text, nothing1470 will be executed. If the value of this option is negative,1471 the corrected command will be executed immediately. If the1472 value is 0 - the command will be just shown but not executed.1473 This is the default.14741475help.htmlpath::1476 Specify the path where the HTML documentation resides. File system paths1477 and URLs are supported. HTML pages will be prefixed with this path when1478 help is displayed in the 'web' format. This defaults to the documentation1479 path of your Git installation.14801481http.proxy::1482 Override the HTTP proxy, normally configured using the 'http_proxy',1483 'https_proxy', and 'all_proxy' environment variables (see1484 `curl(1)`). This can be overridden on a per-remote basis; see1485 remote.<name>.proxy14861487http.cookiefile::1488 File containing previously stored cookie lines which should be used1489 in the Git http session, if they match the server. The file format1490 of the file to read cookies from should be plain HTTP headers or1491 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1492 NOTE that the file specified with http.cookiefile is only used as1493 input unless http.saveCookies is set.14941495http.savecookies::1496 If set, store cookies received during requests to the file specified by1497 http.cookiefile. Has no effect if http.cookiefile is unset.14981499http.sslVerify::1500 Whether to verify the SSL certificate when fetching or pushing1501 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1502 variable.15031504http.sslCert::1505 File containing the SSL certificate when fetching or pushing1506 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1507 variable.15081509http.sslKey::1510 File containing the SSL private key when fetching or pushing1511 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1512 variable.15131514http.sslCertPasswordProtected::1515 Enable Git's password prompt for the SSL certificate. Otherwise1516 OpenSSL will prompt the user, possibly many times, if the1517 certificate or private key is encrypted. Can be overridden by the1518 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15191520http.sslCAInfo::1521 File containing the certificates to verify the peer with when1522 fetching or pushing over HTTPS. Can be overridden by the1523 'GIT_SSL_CAINFO' environment variable.15241525http.sslCAPath::1526 Path containing files with the CA certificates to verify the peer1527 with when fetching or pushing over HTTPS. Can be overridden1528 by the 'GIT_SSL_CAPATH' environment variable.15291530http.sslTry::1531 Attempt to use AUTH SSL/TLS and encrypted data transfers1532 when connecting via regular FTP protocol. This might be needed1533 if the FTP server requires it for security reasons or you wish1534 to connect securely whenever remote FTP server supports it.1535 Default is false since it might trigger certificate verification1536 errors on misconfigured servers.15371538http.maxRequests::1539 How many HTTP requests to launch in parallel. Can be overridden1540 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15411542http.minSessions::1543 The number of curl sessions (counted across slots) to be kept across1544 requests. They will not be ended with curl_easy_cleanup() until1545 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1546 value will be capped at 1. Defaults to 1.15471548http.postBuffer::1549 Maximum size in bytes of the buffer used by smart HTTP1550 transports when POSTing data to the remote system.1551 For requests larger than this buffer size, HTTP/1.1 and1552 Transfer-Encoding: chunked is used to avoid creating a1553 massive pack file locally. Default is 1 MiB, which is1554 sufficient for most requests.15551556http.lowSpeedLimit, http.lowSpeedTime::1557 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1558 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1559 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1560 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15611562http.noEPSV::1563 A boolean which disables using of EPSV ftp command by curl.1564 This can helpful with some "poor" ftp servers which don't1565 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1566 environment variable. Default is false (curl will use EPSV).15671568http.useragent::1569 The HTTP USER_AGENT string presented to an HTTP server. The default1570 value represents the version of the client Git such as git/1.7.1.1571 This option allows you to override this value to a more common value1572 such as Mozilla/4.0. This may be necessary, for instance, if1573 connecting through a firewall that restricts HTTP connections to a set1574 of common USER_AGENT strings (but not including those like git/1.7.1).1575 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15761577http.<url>.*::1578 Any of the http.* options above can be applied selectively to some urls.1579 For a config key to match a URL, each element of the config key is1580 compared to that of the URL, in the following order:1581+1582--1583. Scheme (e.g., `https` in `https://example.com/`). This field1584 must match exactly between the config key and the URL.15851586. Host/domain name (e.g., `example.com` in `https://example.com/`).1587 This field must match exactly between the config key and the URL.15881589. Port number (e.g., `8080` in `http://example.com:8080/`).1590 This field must match exactly between the config key and the URL.1591 Omitted port numbers are automatically converted to the correct1592 default for the scheme before matching.15931594. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1595 path field of the config key must match the path field of the URL1596 either exactly or as a prefix of slash-delimited path elements. This means1597 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1598 match on a slash (`/`) boundary. Longer matches take precedence (so a config1599 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1600 key with just path `foo/`).16011602. User name (e.g., `user` in `https://user@example.com/repo.git`). If1603 the config key has a user name it must match the user name in the1604 URL exactly. If the config key does not have a user name, that1605 config key will match a URL with any user name (including none),1606 but at a lower precedence than a config key with a user name.1607--1608+1609The list above is ordered by decreasing precedence; a URL that matches1610a config key's path is preferred to one that matches its user name. For example,1611if the URL is `https://user@example.com/foo/bar` a config key match of1612`https://example.com/foo` will be preferred over a config key match of1613`https://user@example.com`.1614+1615All URLs are normalized before attempting any matching (the password part,1616if embedded in the URL, is always ignored for matching purposes) so that1617equivalent urls that are simply spelled differently will match properly.1618Environment variable settings always override any matches. The urls that are1619matched against are those given directly to Git commands. This means any URLs1620visited as a result of a redirection do not participate in matching.16211622i18n.commitEncoding::1623 Character encoding the commit messages are stored in; Git itself1624 does not care per se, but this information is necessary e.g. when1625 importing commits from emails or in the gitk graphical history1626 browser (and possibly at other places in the future or in other1627 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16281629i18n.logOutputEncoding::1630 Character encoding the commit messages are converted to when1631 running 'git log' and friends.16321633imap::1634 The configuration variables in the 'imap' section are described1635 in linkgit:git-imap-send[1].16361637index.version::1638 Specify the version with which new index files should be1639 initialized. This does not affect existing repositories.16401641init.templatedir::1642 Specify the directory from which templates will be copied.1643 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16441645instaweb.browser::1646 Specify the program that will be used to browse your working1647 repository in gitweb. See linkgit:git-instaweb[1].16481649instaweb.httpd::1650 The HTTP daemon command-line to start gitweb on your working1651 repository. See linkgit:git-instaweb[1].16521653instaweb.local::1654 If true the web server started by linkgit:git-instaweb[1] will1655 be bound to the local IP (127.0.0.1).16561657instaweb.modulepath::1658 The default module path for linkgit:git-instaweb[1] to use1659 instead of /usr/lib/apache2/modules. Only used if httpd1660 is Apache.16611662instaweb.port::1663 The port number to bind the gitweb httpd to. See1664 linkgit:git-instaweb[1].16651666interactive.singlekey::1667 In interactive commands, allow the user to provide one-letter1668 input with a single key (i.e., without hitting enter).1669 Currently this is used by the `--patch` mode of1670 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1671 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1672 setting is silently ignored if portable keystroke input1673 is not available; requires the Perl module Term::ReadKey.16741675log.abbrevCommit::1676 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1677 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1678 override this option with `--no-abbrev-commit`.16791680log.date::1681 Set the default date-time mode for the 'log' command.1682 Setting a value for log.date is similar to using 'git log''s1683 `--date` option. Possible values are `relative`, `local`,1684 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1685 for details.16861687log.decorate::1688 Print out the ref names of any commits that are shown by the log1689 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1690 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1691 specified, the full ref name (including prefix) will be printed.1692 This is the same as the log commands '--decorate' option.16931694log.showroot::1695 If true, the initial commit will be shown as a big creation event.1696 This is equivalent to a diff against an empty tree.1697 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1698 normally hide the root commit will now show it. True by default.16991700log.mailmap::1701 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1702 linkgit:git-whatchanged[1] assume `--use-mailmap`.17031704mailmap.file::1705 The location of an augmenting mailmap file. The default1706 mailmap, located in the root of the repository, is loaded1707 first, then the mailmap file pointed to by this variable.1708 The location of the mailmap file may be in a repository1709 subdirectory, or somewhere outside of the repository itself.1710 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17111712mailmap.blob::1713 Like `mailmap.file`, but consider the value as a reference to a1714 blob in the repository. If both `mailmap.file` and1715 `mailmap.blob` are given, both are parsed, with entries from1716 `mailmap.file` taking precedence. In a bare repository, this1717 defaults to `HEAD:.mailmap`. In a non-bare repository, it1718 defaults to empty.17191720man.viewer::1721 Specify the programs that may be used to display help in the1722 'man' format. See linkgit:git-help[1].17231724man.<tool>.cmd::1725 Specify the command to invoke the specified man viewer. The1726 specified command is evaluated in shell with the man page1727 passed as argument. (See linkgit:git-help[1].)17281729man.<tool>.path::1730 Override the path for the given tool that may be used to1731 display help in the 'man' format. See linkgit:git-help[1].17321733include::merge-config.txt[]17341735mergetool.<tool>.path::1736 Override the path for the given tool. This is useful in case1737 your tool is not in the PATH.17381739mergetool.<tool>.cmd::1740 Specify the command to invoke the specified merge tool. The1741 specified command is evaluated in shell with the following1742 variables available: 'BASE' is the name of a temporary file1743 containing the common base of the files to be merged, if available;1744 'LOCAL' is the name of a temporary file containing the contents of1745 the file on the current branch; 'REMOTE' is the name of a temporary1746 file containing the contents of the file from the branch being1747 merged; 'MERGED' contains the name of the file to which the merge1748 tool should write the results of a successful merge.17491750mergetool.<tool>.trustExitCode::1751 For a custom merge command, specify whether the exit code of1752 the merge command can be used to determine whether the merge was1753 successful. If this is not set to true then the merge target file1754 timestamp is checked and the merge assumed to have been successful1755 if the file has been updated, otherwise the user is prompted to1756 indicate the success of the merge.17571758mergetool.keepBackup::1759 After performing a merge, the original file with conflict markers1760 can be saved as a file with a `.orig` extension. If this variable1761 is set to `false` then this file is not preserved. Defaults to1762 `true` (i.e. keep the backup files).17631764mergetool.keepTemporaries::1765 When invoking a custom merge tool, Git uses a set of temporary1766 files to pass to the tool. If the tool returns an error and this1767 variable is set to `true`, then these temporary files will be1768 preserved, otherwise they will be removed after the tool has1769 exited. Defaults to `false`.17701771mergetool.prompt::1772 Prompt before each invocation of the merge resolution program.17731774notes.displayRef::1775 The (fully qualified) refname from which to show notes when1776 showing commit messages. The value of this variable can be set1777 to a glob, in which case notes from all matching refs will be1778 shown. You may also specify this configuration variable1779 several times. A warning will be issued for refs that do not1780 exist, but a glob that does not match any refs is silently1781 ignored.1782+1783This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1784environment variable, which must be a colon separated list of refs or1785globs.1786+1787The effective value of "core.notesRef" (possibly overridden by1788GIT_NOTES_REF) is also implicitly added to the list of refs to be1789displayed.17901791notes.rewrite.<command>::1792 When rewriting commits with <command> (currently `amend` or1793 `rebase`) and this variable is set to `true`, Git1794 automatically copies your notes from the original to the1795 rewritten commit. Defaults to `true`, but see1796 "notes.rewriteRef" below.17971798notes.rewriteMode::1799 When copying notes during a rewrite (see the1800 "notes.rewrite.<command>" option), determines what to do if1801 the target commit already has a note. Must be one of1802 `overwrite`, `concatenate`, or `ignore`. Defaults to1803 `concatenate`.1804+1805This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1806environment variable.18071808notes.rewriteRef::1809 When copying notes during a rewrite, specifies the (fully1810 qualified) ref whose notes should be copied. The ref may be a1811 glob, in which case notes in all matching refs will be copied.1812 You may also specify this configuration several times.1813+1814Does not have a default value; you must configure this variable to1815enable note rewriting. Set it to `refs/notes/commits` to enable1816rewriting for the default commit notes.1817+1818This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1819environment variable, which must be a colon separated list of refs or1820globs.18211822pack.window::1823 The size of the window used by linkgit:git-pack-objects[1] when no1824 window size is given on the command line. Defaults to 10.18251826pack.depth::1827 The maximum delta depth used by linkgit:git-pack-objects[1] when no1828 maximum depth is given on the command line. Defaults to 50.18291830pack.windowMemory::1831 The window memory size limit used by linkgit:git-pack-objects[1]1832 when no limit is given on the command line. The value can be1833 suffixed with "k", "m", or "g". Defaults to 0, meaning no1834 limit.18351836pack.compression::1837 An integer -1..9, indicating the compression level for objects1838 in a pack file. -1 is the zlib default. 0 means no1839 compression, and 1..9 are various speed/size tradeoffs, 9 being1840 slowest. If not set, defaults to core.compression. If that is1841 not set, defaults to -1, the zlib default, which is "a default1842 compromise between speed and compression (currently equivalent1843 to level 6)."1844+1845Note that changing the compression level will not automatically recompress1846all existing objects. You can force recompression by passing the -F option1847to linkgit:git-repack[1].18481849pack.deltaCacheSize::1850 The maximum memory in bytes used for caching deltas in1851 linkgit:git-pack-objects[1] before writing them out to a pack.1852 This cache is used to speed up the writing object phase by not1853 having to recompute the final delta result once the best match1854 for all objects is found. Repacking large repositories on machines1855 which are tight with memory might be badly impacted by this though,1856 especially if this cache pushes the system into swapping.1857 A value of 0 means no limit. The smallest size of 1 byte may be1858 used to virtually disable this cache. Defaults to 256 MiB.18591860pack.deltaCacheLimit::1861 The maximum size of a delta, that is cached in1862 linkgit:git-pack-objects[1]. This cache is used to speed up the1863 writing object phase by not having to recompute the final delta1864 result once the best match for all objects is found. Defaults to 1000.18651866pack.threads::1867 Specifies the number of threads to spawn when searching for best1868 delta matches. This requires that linkgit:git-pack-objects[1]1869 be compiled with pthreads otherwise this option is ignored with a1870 warning. This is meant to reduce packing time on multiprocessor1871 machines. The required amount of memory for the delta search window1872 is however multiplied by the number of threads.1873 Specifying 0 will cause Git to auto-detect the number of CPU's1874 and set the number of threads accordingly.18751876pack.indexVersion::1877 Specify the default pack index version. Valid values are 1 for1878 legacy pack index used by Git versions prior to 1.5.2, and 2 for1879 the new pack index with capabilities for packs larger than 4 GB1880 as well as proper protection against the repacking of corrupted1881 packs. Version 2 is the default. Note that version 2 is enforced1882 and this config option ignored whenever the corresponding pack is1883 larger than 2 GB.1884+1885If you have an old Git that does not understand the version 2 `*.idx` file,1886cloning or fetching over a non native protocol (e.g. "http" and "rsync")1887that will copy both `*.pack` file and corresponding `*.idx` file from the1888other side may give you a repository that cannot be accessed with your1889older version of Git. If the `*.pack` file is smaller than 2 GB, however,1890you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1891the `*.idx` file.18921893pack.packSizeLimit::1894 The maximum size of a pack. This setting only affects1895 packing to a file when repacking, i.e. the git:// protocol1896 is unaffected. It can be overridden by the `--max-pack-size`1897 option of linkgit:git-repack[1]. The minimum size allowed is1898 limited to 1 MiB. The default is unlimited.1899 Common unit suffixes of 'k', 'm', or 'g' are1900 supported.19011902pack.useBitmaps::1903 When true, git will use pack bitmaps (if available) when packing1904 to stdout (e.g., during the server side of a fetch). Defaults to1905 true. You should not generally need to turn this off unless1906 you are debugging pack bitmaps.19071908pack.writebitmaps::1909 This is a deprecated synonym for `repack.writeBitmaps`.19101911pack.writeBitmapHashCache::1912 When true, git will include a "hash cache" section in the bitmap1913 index (if one is written). This cache can be used to feed git's1914 delta heuristics, potentially leading to better deltas between1915 bitmapped and non-bitmapped objects (e.g., when serving a fetch1916 between an older, bitmapped pack and objects that have been1917 pushed since the last gc). The downside is that it consumes 41918 bytes per object of disk space, and that JGit's bitmap1919 implementation does not understand it, causing it to complain if1920 Git and JGit are used on the same repository. Defaults to false.19211922pager.<cmd>::1923 If the value is boolean, turns on or off pagination of the1924 output of a particular Git subcommand when writing to a tty.1925 Otherwise, turns on pagination for the subcommand using the1926 pager specified by the value of `pager.<cmd>`. If `--paginate`1927 or `--no-pager` is specified on the command line, it takes1928 precedence over this option. To disable pagination for all1929 commands, set `core.pager` or `GIT_PAGER` to `cat`.19301931pretty.<name>::1932 Alias for a --pretty= format string, as specified in1933 linkgit:git-log[1]. Any aliases defined here can be used just1934 as the built-in pretty formats could. For example,1935 running `git config pretty.changelog "format:* %H %s"`1936 would cause the invocation `git log --pretty=changelog`1937 to be equivalent to running `git log "--pretty=format:* %H %s"`.1938 Note that an alias with the same name as a built-in format1939 will be silently ignored.19401941pull.ff::1942 By default, Git does not create an extra merge commit when merging1943 a commit that is a descendant of the current commit. Instead, the1944 tip of the current branch is fast-forwarded. When set to `false`,1945 this variable tells Git to create an extra merge commit in such1946 a case (equivalent to giving the `--no-ff` option from the command1947 line). When set to `only`, only such fast-forward merges are1948 allowed (equivalent to giving the `--ff-only` option from the1949 command line).19501951pull.rebase::1952 When true, rebase branches on top of the fetched branch, instead1953 of merging the default branch from the default remote when "git1954 pull" is run. See "branch.<name>.rebase" for setting this on a1955 per-branch basis.1956+1957 When preserve, also pass `--preserve-merges` along to 'git rebase'1958 so that locally committed merge commits will not be flattened1959 by running 'git pull'.1960+1961*NOTE*: this is a possibly dangerous operation; do *not* use1962it unless you understand the implications (see linkgit:git-rebase[1]1963for details).19641965pull.octopus::1966 The default merge strategy to use when pulling multiple branches1967 at once.19681969pull.twohead::1970 The default merge strategy to use when pulling a single branch.19711972push.default::1973 Defines the action `git push` should take if no refspec is1974 explicitly given. Different values are well-suited for1975 specific workflows; for instance, in a purely central workflow1976 (i.e. the fetch source is equal to the push destination),1977 `upstream` is probably what you want. Possible values are:1978+1979--19801981* `nothing` - do not push anything (error out) unless a refspec is1982 explicitly given. This is primarily meant for people who want to1983 avoid mistakes by always being explicit.19841985* `current` - push the current branch to update a branch with the same1986 name on the receiving end. Works in both central and non-central1987 workflows.19881989* `upstream` - push the current branch back to the branch whose1990 changes are usually integrated into the current branch (which is1991 called `@{upstream}`). This mode only makes sense if you are1992 pushing to the same repository you would normally pull from1993 (i.e. central workflow).19941995* `simple` - in centralized workflow, work like `upstream` with an1996 added safety to refuse to push if the upstream branch's name is1997 different from the local one.1998+1999When pushing to a remote that is different from the remote you normally2000pull from, work as `current`. This is the safest option and is suited2001for beginners.2002+2003This mode has become the default in Git 2.0.20042005* `matching` - push all branches having the same name on both ends.2006 This makes the repository you are pushing to remember the set of2007 branches that will be pushed out (e.g. if you always push 'maint'2008 and 'master' there and no other branches, the repository you push2009 to will have these two branches, and your local 'maint' and2010 'master' will be pushed there).2011+2012To use this mode effectively, you have to make sure _all_ the2013branches you would push out are ready to be pushed out before2014running 'git push', as the whole point of this mode is to allow you2015to push all of the branches in one go. If you usually finish work2016on only one branch and push out the result, while other branches are2017unfinished, this mode is not for you. Also this mode is not2018suitable for pushing into a shared central repository, as other2019people may add new branches there, or update the tip of existing2020branches outside your control.2021+2022This used to be the default, but not since Git 2.0 (`simple` is the2023new default).20242025--20262027rebase.stat::2028 Whether to show a diffstat of what changed upstream since the last2029 rebase. False by default.20302031rebase.autosquash::2032 If set to true enable '--autosquash' option by default.20332034rebase.autostash::2035 When set to true, automatically create a temporary stash2036 before the operation begins, and apply it after the operation2037 ends. This means that you can run rebase on a dirty worktree.2038 However, use with care: the final stash application after a2039 successful rebase might result in non-trivial conflicts.2040 Defaults to false.20412042receive.autogc::2043 By default, git-receive-pack will run "git-gc --auto" after2044 receiving data from git-push and updating refs. You can stop2045 it by setting this variable to false.20462047receive.fsckObjects::2048 If it is set to true, git-receive-pack will check all received2049 objects. It will abort in the case of a malformed object or a2050 broken link. The result of an abort are only dangling objects.2051 Defaults to false. If not set, the value of `transfer.fsckObjects`2052 is used instead.20532054receive.unpackLimit::2055 If the number of objects received in a push is below this2056 limit then the objects will be unpacked into loose object2057 files. However if the number of received objects equals or2058 exceeds this limit then the received pack will be stored as2059 a pack, after adding any missing delta bases. Storing the2060 pack from a push can make the push operation complete faster,2061 especially on slow filesystems. If not set, the value of2062 `transfer.unpackLimit` is used instead.20632064receive.denyDeletes::2065 If set to true, git-receive-pack will deny a ref update that deletes2066 the ref. Use this to prevent such a ref deletion via a push.20672068receive.denyDeleteCurrent::2069 If set to true, git-receive-pack will deny a ref update that2070 deletes the currently checked out branch of a non-bare repository.20712072receive.denyCurrentBranch::2073 If set to true or "refuse", git-receive-pack will deny a ref update2074 to the currently checked out branch of a non-bare repository.2075 Such a push is potentially dangerous because it brings the HEAD2076 out of sync with the index and working tree. If set to "warn",2077 print a warning of such a push to stderr, but allow the push to2078 proceed. If set to false or "ignore", allow such pushes with no2079 message. Defaults to "refuse".20802081receive.denyNonFastForwards::2082 If set to true, git-receive-pack will deny a ref update which is2083 not a fast-forward. Use this to prevent such an update via a push,2084 even if that push is forced. This configuration variable is2085 set when initializing a shared repository.20862087receive.hiderefs::2088 String(s) `receive-pack` uses to decide which refs to omit2089 from its initial advertisement. Use more than one2090 definitions to specify multiple prefix strings. A ref that2091 are under the hierarchies listed on the value of this2092 variable is excluded, and is hidden when responding to `git2093 push`, and an attempt to update or delete a hidden ref by2094 `git push` is rejected.20952096receive.updateserverinfo::2097 If set to true, git-receive-pack will run git-update-server-info2098 after receiving data from git-push and updating refs.20992100receive.shallowupdate::2101 If set to true, .git/shallow can be updated when new refs2102 require new shallow roots. Otherwise those refs are rejected.21032104remote.pushdefault::2105 The remote to push to by default. Overrides2106 `branch.<name>.remote` for all branches, and is overridden by2107 `branch.<name>.pushremote` for specific branches.21082109remote.<name>.url::2110 The URL of a remote repository. See linkgit:git-fetch[1] or2111 linkgit:git-push[1].21122113remote.<name>.pushurl::2114 The push URL of a remote repository. See linkgit:git-push[1].21152116remote.<name>.proxy::2117 For remotes that require curl (http, https and ftp), the URL to2118 the proxy to use for that remote. Set to the empty string to2119 disable proxying for that remote.21202121remote.<name>.fetch::2122 The default set of "refspec" for linkgit:git-fetch[1]. See2123 linkgit:git-fetch[1].21242125remote.<name>.push::2126 The default set of "refspec" for linkgit:git-push[1]. See2127 linkgit:git-push[1].21282129remote.<name>.mirror::2130 If true, pushing to this remote will automatically behave2131 as if the `--mirror` option was given on the command line.21322133remote.<name>.skipDefaultUpdate::2134 If true, this remote will be skipped by default when updating2135 using linkgit:git-fetch[1] or the `update` subcommand of2136 linkgit:git-remote[1].21372138remote.<name>.skipFetchAll::2139 If true, this remote will be skipped by default when updating2140 using linkgit:git-fetch[1] or the `update` subcommand of2141 linkgit:git-remote[1].21422143remote.<name>.receivepack::2144 The default program to execute on the remote side when pushing. See2145 option \--receive-pack of linkgit:git-push[1].21462147remote.<name>.uploadpack::2148 The default program to execute on the remote side when fetching. See2149 option \--upload-pack of linkgit:git-fetch-pack[1].21502151remote.<name>.tagopt::2152 Setting this value to \--no-tags disables automatic tag following when2153 fetching from remote <name>. Setting it to \--tags will fetch every2154 tag from remote <name>, even if they are not reachable from remote2155 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2156 override this setting. See options \--tags and \--no-tags of2157 linkgit:git-fetch[1].21582159remote.<name>.vcs::2160 Setting this to a value <vcs> will cause Git to interact with2161 the remote with the git-remote-<vcs> helper.21622163remote.<name>.prune::2164 When set to true, fetching from this remote by default will also2165 remove any remote-tracking references that no longer exist on the2166 remote (as if the `--prune` option was given on the command line).2167 Overrides `fetch.prune` settings, if any.21682169remotes.<group>::2170 The list of remotes which are fetched by "git remote update2171 <group>". See linkgit:git-remote[1].21722173repack.usedeltabaseoffset::2174 By default, linkgit:git-repack[1] creates packs that use2175 delta-base offset. If you need to share your repository with2176 Git older than version 1.4.4, either directly or via a dumb2177 protocol such as http, then you need to set this option to2178 "false" and repack. Access from old Git versions over the2179 native protocol are unaffected by this option.21802181repack.packKeptObjects::2182 If set to true, makes `git repack` act as if2183 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2184 details. Defaults to `false` normally, but `true` if a bitmap2185 index is being written (either via `--write-bitmap-index` or2186 `repack.writeBitmaps`).21872188repack.writeBitmaps::2189 When true, git will write a bitmap index when packing all2190 objects to disk (e.g., when `git repack -a` is run). This2191 index can speed up the "counting objects" phase of subsequent2192 packs created for clones and fetches, at the cost of some disk2193 space and extra time spent on the initial repack. Defaults to2194 false.21952196rerere.autoupdate::2197 When set to true, `git-rerere` updates the index with the2198 resulting contents after it cleanly resolves conflicts using2199 previously recorded resolution. Defaults to false.22002201rerere.enabled::2202 Activate recording of resolved conflicts, so that identical2203 conflict hunks can be resolved automatically, should they be2204 encountered again. By default, linkgit:git-rerere[1] is2205 enabled if there is an `rr-cache` directory under the2206 `$GIT_DIR`, e.g. if "rerere" was previously used in the2207 repository.22082209sendemail.identity::2210 A configuration identity. When given, causes values in the2211 'sendemail.<identity>' subsection to take precedence over2212 values in the 'sendemail' section. The default identity is2213 the value of 'sendemail.identity'.22142215sendemail.smtpencryption::2216 See linkgit:git-send-email[1] for description. Note that this2217 setting is not subject to the 'identity' mechanism.22182219sendemail.smtpssl::2220 Deprecated alias for 'sendemail.smtpencryption = ssl'.22212222sendemail.smtpsslcertpath::2223 Path to ca-certificates (either a directory or a single file).2224 Set it to an empty string to disable certificate verification.22252226sendemail.<identity>.*::2227 Identity-specific versions of the 'sendemail.*' parameters2228 found below, taking precedence over those when the this2229 identity is selected, through command-line or2230 'sendemail.identity'.22312232sendemail.aliasesfile::2233sendemail.aliasfiletype::2234sendemail.annotate::2235sendemail.bcc::2236sendemail.cc::2237sendemail.cccmd::2238sendemail.chainreplyto::2239sendemail.confirm::2240sendemail.envelopesender::2241sendemail.from::2242sendemail.multiedit::2243sendemail.signedoffbycc::2244sendemail.smtppass::2245sendemail.suppresscc::2246sendemail.suppressfrom::2247sendemail.to::2248sendemail.smtpdomain::2249sendemail.smtpserver::2250sendemail.smtpserverport::2251sendemail.smtpserveroption::2252sendemail.smtpuser::2253sendemail.thread::2254sendemail.validate::2255 See linkgit:git-send-email[1] for description.22562257sendemail.signedoffcc::2258 Deprecated alias for 'sendemail.signedoffbycc'.22592260showbranch.default::2261 The default set of branches for linkgit:git-show-branch[1].2262 See linkgit:git-show-branch[1].22632264status.relativePaths::2265 By default, linkgit:git-status[1] shows paths relative to the2266 current directory. Setting this variable to `false` shows paths2267 relative to the repository root (this was the default for Git2268 prior to v1.5.4).22692270status.short::2271 Set to true to enable --short by default in linkgit:git-status[1].2272 The option --no-short takes precedence over this variable.22732274status.branch::2275 Set to true to enable --branch by default in linkgit:git-status[1].2276 The option --no-branch takes precedence over this variable.22772278status.displayCommentPrefix::2279 If set to true, linkgit:git-status[1] will insert a comment2280 prefix before each output line (starting with2281 `core.commentChar`, i.e. `#` by default). This was the2282 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2283 Defaults to false.22842285status.showUntrackedFiles::2286 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2287 files which are not currently tracked by Git. Directories which2288 contain only untracked files, are shown with the directory name2289 only. Showing untracked files means that Git needs to lstat() all2290 all the files in the whole repository, which might be slow on some2291 systems. So, this variable controls how the commands displays2292 the untracked files. Possible values are:2293+2294--2295* `no` - Show no untracked files.2296* `normal` - Show untracked files and directories.2297* `all` - Show also individual files in untracked directories.2298--2299+2300If this variable is not specified, it defaults to 'normal'.2301This variable can be overridden with the -u|--untracked-files option2302of linkgit:git-status[1] and linkgit:git-commit[1].23032304status.submodulesummary::2305 Defaults to false.2306 If this is set to a non zero number or true (identical to -1 or an2307 unlimited number), the submodule summary will be enabled and a2308 summary of commits for modified submodules will be shown (see2309 --summary-limit option of linkgit:git-submodule[1]). Please note2310 that the summary output command will be suppressed for all2311 submodules when `diff.ignoreSubmodules` is set to 'all' or only2312 for those submodules where `submodule.<name>.ignore=all`. The only2313 exception to that rule is that status and commit will show staged2314 submodule changes. To2315 also view the summary for ignored submodules you can either use2316 the --ignore-submodules=dirty command-line option or the 'git2317 submodule summary' command, which shows a similar output but does2318 not honor these settings.23192320submodule.<name>.path::2321submodule.<name>.url::2322submodule.<name>.update::2323 The path within this project, URL, and the updating strategy2324 for a submodule. These variables are initially populated2325 by 'git submodule init'; edit them to override the2326 URL and other values found in the `.gitmodules` file. See2327 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.23282329submodule.<name>.branch::2330 The remote branch name for a submodule, used by `git submodule2331 update --remote`. Set this option to override the value found in2332 the `.gitmodules` file. See linkgit:git-submodule[1] and2333 linkgit:gitmodules[5] for details.23342335submodule.<name>.fetchRecurseSubmodules::2336 This option can be used to control recursive fetching of this2337 submodule. It can be overridden by using the --[no-]recurse-submodules2338 command-line option to "git fetch" and "git pull".2339 This setting will override that from in the linkgit:gitmodules[5]2340 file.23412342submodule.<name>.ignore::2343 Defines under what circumstances "git status" and the diff family show2344 a submodule as modified. When set to "all", it will never be considered2345 modified (but it will nonetheless show up in the output of status and2346 commit when it has been staged), "dirty" will ignore all changes2347 to the submodules work tree and2348 takes only differences between the HEAD of the submodule and the commit2349 recorded in the superproject into account. "untracked" will additionally2350 let submodules with modified tracked files in their work tree show up.2351 Using "none" (the default when this option is not set) also shows2352 submodules that have untracked files in their work tree as changed.2353 This setting overrides any setting made in .gitmodules for this submodule,2354 both settings can be overridden on the command line by using the2355 "--ignore-submodules" option. The 'git submodule' commands are not2356 affected by this setting.23572358tag.sort::2359 This variable controls the sort ordering of tags when displayed by2360 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2361 value of this variable will be used as the default.23622363tar.umask::2364 This variable can be used to restrict the permission bits of2365 tar archive entries. The default is 0002, which turns off the2366 world write bit. The special value "user" indicates that the2367 archiving user's umask will be used instead. See umask(2) and2368 linkgit:git-archive[1].23692370transfer.fsckObjects::2371 When `fetch.fsckObjects` or `receive.fsckObjects` are2372 not set, the value of this variable is used instead.2373 Defaults to false.23742375transfer.hiderefs::2376 This variable can be used to set both `receive.hiderefs`2377 and `uploadpack.hiderefs` at the same time to the same2378 values. See entries for these other variables.23792380transfer.unpackLimit::2381 When `fetch.unpackLimit` or `receive.unpackLimit` are2382 not set, the value of this variable is used instead.2383 The default value is 100.23842385uploadarchive.allowUnreachable::2386 If true, allow clients to use `git archive --remote` to request2387 any tree, whether reachable from the ref tips or not. See the2388 discussion in the `SECURITY` section of2389 linkgit:git-upload-archive[1] for more details. Defaults to2390 `false`.23912392uploadpack.hiderefs::2393 String(s) `upload-pack` uses to decide which refs to omit2394 from its initial advertisement. Use more than one2395 definitions to specify multiple prefix strings. A ref that2396 are under the hierarchies listed on the value of this2397 variable is excluded, and is hidden from `git ls-remote`,2398 `git fetch`, etc. An attempt to fetch a hidden ref by `git2399 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.24002401uploadpack.allowtipsha1inwant::2402 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2403 to accept a fetch request that asks for an object at the tip2404 of a hidden ref (by default, such a request is rejected).2405 see also `uploadpack.hiderefs`.24062407uploadpack.keepalive::2408 When `upload-pack` has started `pack-objects`, there may be a2409 quiet period while `pack-objects` prepares the pack. Normally2410 it would output progress information, but if `--quiet` was used2411 for the fetch, `pack-objects` will output nothing at all until2412 the pack data begins. Some clients and networks may consider2413 the server to be hung and give up. Setting this option instructs2414 `upload-pack` to send an empty keepalive packet every2415 `uploadpack.keepalive` seconds. Setting this option to 02416 disables keepalive packets entirely. The default is 5 seconds.24172418url.<base>.insteadOf::2419 Any URL that starts with this value will be rewritten to2420 start, instead, with <base>. In cases where some site serves a2421 large number of repositories, and serves them with multiple2422 access methods, and some users need to use different access2423 methods, this feature allows people to specify any of the2424 equivalent URLs and have Git automatically rewrite the URL to2425 the best alternative for the particular user, even for a2426 never-before-seen repository on the site. When more than one2427 insteadOf strings match a given URL, the longest match is used.24282429url.<base>.pushInsteadOf::2430 Any URL that starts with this value will not be pushed to;2431 instead, it will be rewritten to start with <base>, and the2432 resulting URL will be pushed to. In cases where some site serves2433 a large number of repositories, and serves them with multiple2434 access methods, some of which do not allow push, this feature2435 allows people to specify a pull-only URL and have Git2436 automatically use an appropriate URL to push, even for a2437 never-before-seen repository on the site. When more than one2438 pushInsteadOf strings match a given URL, the longest match is2439 used. If a remote has an explicit pushurl, Git will ignore this2440 setting for that remote.24412442user.email::2443 Your email address to be recorded in any newly created commits.2444 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2445 'EMAIL' environment variables. See linkgit:git-commit-tree[1].24462447user.name::2448 Your full name to be recorded in any newly created commits.2449 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2450 environment variables. See linkgit:git-commit-tree[1].24512452user.signingkey::2453 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2454 key you want it to automatically when creating a signed tag or2455 commit, you can override the default selection with this variable.2456 This option is passed unchanged to gpg's --local-user parameter,2457 so you may specify a key using any method that gpg supports.24582459web.browser::2460 Specify a web browser that may be used by some commands.2461 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2462 may use it.