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 16 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. 503+ 504Default is 512 MiB on all platforms. This should be reasonable 505for most projects as source code and other text files can still 506be delta compressed, but larger binary media files won't be. 507+ 508Common unit suffixes of 'k', 'm', or 'g' are supported. 509 510core.excludesfile:: 511 In addition to '.gitignore' (per-directory) and 512 '.git/info/exclude', Git looks into this file for patterns 513 of files which are not meant to be tracked. "`~/`" is expanded 514 to the value of `$HOME` and "`~user/`" to the specified user's 515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 517 is used instead. See linkgit:gitignore[5]. 518 519core.askpass:: 520 Some commands (e.g. svn and http interfaces) that interactively 521 ask for a password can be told to use an external program given 522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 523 environment variable. If not set, fall back to the value of the 524 'SSH_ASKPASS' environment variable or, failing that, a simple password 525 prompt. The external program shall be given a suitable prompt as 526 command line argument and write the password on its STDOUT. 527 528core.attributesfile:: 529 In addition to '.gitattributes' (per-directory) and 530 '.git/info/attributes', Git looks into this file for attributes 531 (see linkgit:gitattributes[5]). Path expansions are made the same 532 way as for `core.excludesfile`. Its default value is 533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 534 set or empty, $HOME/.config/git/attributes is used instead. 535 536core.editor:: 537 Commands such as `commit` and `tag` that lets you edit 538 messages by launching an editor uses the value of this 539 variable when it is set, and the environment variable 540 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 541 542core.commentchar:: 543 Commands such as `commit` and `tag` that lets you edit 544 messages consider a line that begins with this character 545 commented, and removes them after the editor returns 546 (default '#'). 547+ 548If set to "auto", `git-commit` would select a character that is not 549the beginning character of any line in existing commit messages. 550 551sequence.editor:: 552 Text editor used by `git rebase -i` for editing the rebase instruction file. 553 The value is meant to be interpreted by the shell when it is used. 554 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 555 When not configured the default commit message editor is used instead. 556 557core.pager:: 558 Text viewer for use by Git commands (e.g., 'less'). The value 559 is meant to be interpreted by the shell. The order of preference 560 is the `$GIT_PAGER` environment variable, then `core.pager` 561 configuration, then `$PAGER`, and then the default chosen at 562 compile time (usually 'less'). 563+ 564When the `LESS` environment variable is unset, Git sets it to `FRSX` 565(if `LESS` environment variable is set, Git does not change it at 566all). If you want to selectively override Git's default setting 567for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 568be passed to the shell by Git, which will translate the final 569command to `LESS=FRSX less -+S`. The environment tells the command 570to set the `S` option to chop long lines but the command line 571resets it to the default to fold long lines. 572+ 573Likewise, when the `LV` environment variable is unset, Git sets it 574to `-c`. You can override this setting by exporting `LV` with 575another value or setting `core.pager` to `lv +c`. 576 577core.whitespace:: 578 A comma separated list of common whitespace problems to 579 notice. 'git diff' will use `color.diff.whitespace` to 580 highlight them, and 'git apply --whitespace=error' will 581 consider them as errors. You can prefix `-` to disable 582 any of them (e.g. `-trailing-space`): 583+ 584* `blank-at-eol` treats trailing whitespaces at the end of the line 585 as an error (enabled by default). 586* `space-before-tab` treats a space character that appears immediately 587 before a tab character in the initial indent part of the line as an 588 error (enabled by default). 589* `indent-with-non-tab` treats a line that is indented with space 590 characters instead of the equivalent tabs as an error (not enabled by 591 default). 592* `tab-in-indent` treats a tab character in the initial indent part of 593 the line as an error (not enabled by default). 594* `blank-at-eof` treats blank lines added at the end of file as an error 595 (enabled by default). 596* `trailing-space` is a short-hand to cover both `blank-at-eol` and 597 `blank-at-eof`. 598* `cr-at-eol` treats a carriage-return at the end of line as 599 part of the line terminator, i.e. with it, `trailing-space` 600 does not trigger if the character before such a carriage-return 601 is not a whitespace (not enabled by default). 602* `tabwidth=<n>` tells how many character positions a tab occupies; this 603 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 604 errors. The default tab width is 8. Allowed values are 1 to 63. 605 606core.fsyncobjectfiles:: 607 This boolean will enable 'fsync()' when writing object files. 608+ 609This is a total waste of time and effort on a filesystem that orders 610data writes properly, but can be useful for filesystems that do not use 611journalling (traditional UNIX filesystems) or that only journal metadata 612and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 613 614core.preloadindex:: 615 Enable parallel index preload for operations like 'git diff' 616+ 617This can speed up operations like 'git diff' and 'git status' especially 618on filesystems like NFS that have weak caching semantics and thus 619relatively high IO latencies. With this set to 'true', Git will do the 620index comparison to the filesystem data in parallel, allowing 621overlapping IO's. 622 623core.createObject:: 624 You can set this to 'link', in which case a hardlink followed by 625 a delete of the source are used to make sure that object creation 626 will not overwrite existing objects. 627+ 628On some file system/operating system combinations, this is unreliable. 629Set this config setting to 'rename' there; However, This will remove the 630check that makes sure that existing object files will not get overwritten. 631 632core.notesRef:: 633 When showing commit messages, also show notes which are stored in 634 the given ref. The ref must be fully qualified. If the given 635 ref does not exist, it is not an error but means that no 636 notes should be printed. 637+ 638This setting defaults to "refs/notes/commits", and it can be overridden by 639the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 640 641core.sparseCheckout:: 642 Enable "sparse checkout" feature. See section "Sparse checkout" in 643 linkgit:git-read-tree[1] for more information. 644 645core.abbrev:: 646 Set the length object names are abbreviated to. If unspecified, 647 many commands abbreviate to 7 hexdigits, which may not be enough 648 for abbreviated object names to stay unique for sufficiently long 649 time. 650 651add.ignore-errors:: 652add.ignoreErrors:: 653 Tells 'git add' to continue adding files when some files cannot be 654 added due to indexing errors. Equivalent to the '--ignore-errors' 655 option of linkgit:git-add[1]. Older versions of Git accept only 656 `add.ignore-errors`, which does not follow the usual naming 657 convention for configuration variables. Newer versions of Git 658 honor `add.ignoreErrors` as well. 659 660alias.*:: 661 Command aliases for the linkgit:git[1] command wrapper - e.g. 662 after defining "alias.last = cat-file commit HEAD", the invocation 663 "git last" is equivalent to "git cat-file commit HEAD". To avoid 664 confusion and troubles with script usage, aliases that 665 hide existing Git commands are ignored. Arguments are split by 666 spaces, the usual shell quoting and escaping is supported. 667 quote pair and a backslash can be used to quote them. 668+ 669If the alias expansion is prefixed with an exclamation point, 670it will be treated as a shell command. For example, defining 671"alias.new = !gitk --all --not ORIG_HEAD", the invocation 672"git new" is equivalent to running the shell command 673"gitk --all --not ORIG_HEAD". Note that shell commands will be 674executed from the top-level directory of a repository, which may 675not necessarily be the current directory. 676'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 677from the original current directory. See linkgit:git-rev-parse[1]. 678 679am.keepcr:: 680 If true, git-am will call git-mailsplit for patches in mbox format 681 with parameter '--keep-cr'. In this case git-mailsplit will 682 not remove `\r` from lines ending with `\r\n`. Can be overridden 683 by giving '--no-keep-cr' from the command line. 684 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 685 686apply.ignorewhitespace:: 687 When set to 'change', tells 'git apply' to ignore changes in 688 whitespace, in the same way as the '--ignore-space-change' 689 option. 690 When set to one of: no, none, never, false tells 'git apply' to 691 respect all whitespace differences. 692 See linkgit:git-apply[1]. 693 694apply.whitespace:: 695 Tells 'git apply' how to handle whitespaces, in the same way 696 as the '--whitespace' option. See linkgit:git-apply[1]. 697 698branch.autosetupmerge:: 699 Tells 'git branch' and 'git checkout' to set up new branches 700 so that linkgit:git-pull[1] will appropriately merge from the 701 starting point branch. Note that even if this option is not set, 702 this behavior can be chosen per-branch using the `--track` 703 and `--no-track` options. The valid settings are: `false` -- no 704 automatic setup is done; `true` -- automatic setup is done when the 705 starting point is a remote-tracking branch; `always` -- 706 automatic setup is done when the starting point is either a 707 local branch or remote-tracking 708 branch. This option defaults to true. 709 710branch.autosetuprebase:: 711 When a new branch is created with 'git branch' or 'git checkout' 712 that tracks another branch, this variable tells Git to set 713 up pull to rebase instead of merge (see "branch.<name>.rebase"). 714 When `never`, rebase is never automatically set to true. 715 When `local`, rebase is set to true for tracked branches of 716 other local branches. 717 When `remote`, rebase is set to true for tracked branches of 718 remote-tracking branches. 719 When `always`, rebase will be set to true for all tracking 720 branches. 721 See "branch.autosetupmerge" for details on how to set up a 722 branch to track another branch. 723 This option defaults to never. 724 725branch.<name>.remote:: 726 When on branch <name>, it tells 'git fetch' and 'git push' 727 which remote to fetch from/push to. The remote to push to 728 may be overridden with `remote.pushdefault` (for all branches). 729 The remote to push to, for the current branch, may be further 730 overridden by `branch.<name>.pushremote`. If no remote is 731 configured, or if you are not on any branch, it defaults to 732 `origin` for fetching and `remote.pushdefault` for pushing. 733 Additionally, `.` (a period) is the current local repository 734 (a dot-repository), see `branch.<name>.merge`'s final note below. 735 736branch.<name>.pushremote:: 737 When on branch <name>, it overrides `branch.<name>.remote` for 738 pushing. It also overrides `remote.pushdefault` for pushing 739 from branch <name>. When you pull from one place (e.g. your 740 upstream) and push to another place (e.g. your own publishing 741 repository), you would want to set `remote.pushdefault` to 742 specify the remote to push to for all branches, and use this 743 option to override it for a specific branch. 744 745branch.<name>.merge:: 746 Defines, together with branch.<name>.remote, the upstream branch 747 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 748 branch to merge and can also affect 'git push' (see push.default). 749 When in branch <name>, it tells 'git fetch' the default 750 refspec to be marked for merging in FETCH_HEAD. The value is 751 handled like the remote part of a refspec, and must match a 752 ref which is fetched from the remote given by 753 "branch.<name>.remote". 754 The merge information is used by 'git pull' (which at first calls 755 'git fetch') to lookup the default branch for merging. Without 756 this option, 'git pull' defaults to merge the first refspec fetched. 757 Specify multiple values to get an octopus merge. 758 If you wish to setup 'git pull' so that it merges into <name> from 759 another branch in the local repository, you can point 760 branch.<name>.merge to the desired branch, and use the relative path 761 setting `.` (a period) for branch.<name>.remote. 762 763branch.<name>.mergeoptions:: 764 Sets default options for merging into branch <name>. The syntax and 765 supported options are the same as those of linkgit:git-merge[1], but 766 option values containing whitespace characters are currently not 767 supported. 768 769branch.<name>.rebase:: 770 When true, rebase the branch <name> on top of the fetched branch, 771 instead of merging the default branch from the default remote when 772 "git pull" is run. See "pull.rebase" for doing this in a non 773 branch-specific manner. 774+ 775 When preserve, also pass `--preserve-merges` along to 'git rebase' 776 so that locally committed merge commits will not be flattened 777 by running 'git pull'. 778+ 779*NOTE*: this is a possibly dangerous operation; do *not* use 780it unless you understand the implications (see linkgit:git-rebase[1] 781for details). 782 783branch.<name>.description:: 784 Branch description, can be edited with 785 `git branch --edit-description`. Branch description is 786 automatically added in the format-patch cover letter or 787 request-pull summary. 788 789browser.<tool>.cmd:: 790 Specify the command to invoke the specified browser. The 791 specified command is evaluated in shell with the URLs passed 792 as arguments. (See linkgit:git-web{litdd}browse[1].) 793 794browser.<tool>.path:: 795 Override the path for the given tool that may be used to 796 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 797 working repository in gitweb (see linkgit:git-instaweb[1]). 798 799clean.requireForce:: 800 A boolean to make git-clean do nothing unless given -f, 801 -i or -n. Defaults to true. 802 803color.branch:: 804 A boolean to enable/disable color in the output of 805 linkgit:git-branch[1]. May be set to `always`, 806 `false` (or `never`) or `auto` (or `true`), in which case colors are used 807 only when the output is to a terminal. Defaults to false. 808 809color.branch.<slot>:: 810 Use customized color for branch coloration. `<slot>` is one of 811 `current` (the current branch), `local` (a local branch), 812 `remote` (a remote-tracking branch in refs/remotes/), 813 `upstream` (upstream tracking branch), `plain` (other 814 refs). 815+ 816The value for these configuration variables is a list of colors (at most 817two) and attributes (at most one), separated by spaces. The colors 818accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 819`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 820`blink` and `reverse`. The first color given is the foreground; the 821second is the background. The position of the attribute, if any, 822doesn't matter. 823 824color.diff:: 825 Whether to use ANSI escape sequences to add color to patches. 826 If this is set to `always`, linkgit:git-diff[1], 827 linkgit:git-log[1], and linkgit:git-show[1] will use color 828 for all patches. If it is set to `true` or `auto`, those 829 commands will only use color when output is to the terminal. 830 Defaults to false. 831+ 832This does not affect linkgit:git-format-patch[1] or the 833'git-diff-{asterisk}' plumbing commands. Can be overridden on the 834command line with the `--color[=<when>]` option. 835 836color.diff.<slot>:: 837 Use customized color for diff colorization. `<slot>` specifies 838 which part of the patch to use the specified color, and is one 839 of `plain` (context text), `meta` (metainformation), `frag` 840 (hunk header), 'func' (function in hunk header), `old` (removed lines), 841 `new` (added lines), `commit` (commit headers), or `whitespace` 842 (highlighting whitespace errors). The values of these variables may be 843 specified as in color.branch.<slot>. 844 845color.decorate.<slot>:: 846 Use customized color for 'git log --decorate' output. `<slot>` is one 847 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 848 branches, remote-tracking branches, tags, stash and HEAD, respectively. 849 850color.grep:: 851 When set to `always`, always highlight matches. When `false` (or 852 `never`), never. When set to `true` or `auto`, use color only 853 when the output is written to the terminal. Defaults to `false`. 854 855color.grep.<slot>:: 856 Use customized color for grep colorization. `<slot>` specifies which 857 part of the line to use the specified color, and is one of 858+ 859-- 860`context`;; 861 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 862`filename`;; 863 filename prefix (when not using `-h`) 864`function`;; 865 function name lines (when using `-p`) 866`linenumber`;; 867 line number prefix (when using `-n`) 868`match`;; 869 matching text 870`selected`;; 871 non-matching text in selected lines 872`separator`;; 873 separators between fields on a line (`:`, `-`, and `=`) 874 and between hunks (`--`) 875-- 876+ 877The values of these variables may be specified as in color.branch.<slot>. 878 879color.interactive:: 880 When set to `always`, always use colors for interactive prompts 881 and displays (such as those used by "git-add --interactive" and 882 "git-clean --interactive"). When false (or `never`), never. 883 When set to `true` or `auto`, use colors only when the output is 884 to the terminal. Defaults to false. 885 886color.interactive.<slot>:: 887 Use customized color for 'git add --interactive' and 'git clean 888 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 889 or `error`, for four distinct types of normal output from 890 interactive commands. The values of these variables may be 891 specified as in color.branch.<slot>. 892 893color.pager:: 894 A boolean to enable/disable colored output when the pager is in 895 use (default is true). 896 897color.showbranch:: 898 A boolean to enable/disable color in the output of 899 linkgit:git-show-branch[1]. May be set to `always`, 900 `false` (or `never`) or `auto` (or `true`), in which case colors are used 901 only when the output is to a terminal. Defaults to false. 902 903color.status:: 904 A boolean to enable/disable color in the output of 905 linkgit:git-status[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.<slot>:: 910 Use customized color for status colorization. `<slot>` is 911 one of `header` (the header text of the status message), 912 `added` or `updated` (files which are added but not committed), 913 `changed` (files which are changed but not added in the index), 914 `untracked` (files which are not tracked by Git), 915 `branch` (the current branch), or 916 `nobranch` (the color the 'no branch' warning is shown in, defaulting 917 to red). The values of these variables may be specified as in 918 color.branch.<slot>. 919 920color.ui:: 921 This variable determines the default value for variables such 922 as `color.diff` and `color.grep` that control the use of color 923 per command family. Its scope will expand as more commands learn 924 configuration to set a default for the `--color` option. Set it 925 to `false` or `never` if you prefer Git commands not to use 926 color unless enabled explicitly with some other configuration 927 or the `--color` option. Set it to `always` if you want all 928 output not intended for machine consumption to use color, to 929 `true` or `auto` (this is the default since Git 1.8.4) if you 930 want such output to use color when written to the terminal. 931 932column.ui:: 933 Specify whether supported commands should output in columns. 934 This variable consists of a list of tokens separated by spaces 935 or commas: 936+ 937These options control when the feature should be enabled 938(defaults to 'never'): 939+ 940-- 941`always`;; 942 always show in columns 943`never`;; 944 never show in columns 945`auto`;; 946 show in columns if the output is to the terminal 947-- 948+ 949These options control layout (defaults to 'column'). Setting any 950of these implies 'always' if none of 'always', 'never', or 'auto' are 951specified. 952+ 953-- 954`column`;; 955 fill columns before rows 956`row`;; 957 fill rows before columns 958`plain`;; 959 show in one column 960-- 961+ 962Finally, these options can be combined with a layout option (defaults 963to 'nodense'): 964+ 965-- 966`dense`;; 967 make unequal size columns to utilize more space 968`nodense`;; 969 make equal size columns 970-- 971 972column.branch:: 973 Specify whether to output branch listing in `git branch` in columns. 974 See `column.ui` for details. 975 976column.clean:: 977 Specify the layout when list items in `git clean -i`, which always 978 shows files and directories in columns. See `column.ui` for details. 979 980column.status:: 981 Specify whether to output untracked files in `git status` in columns. 982 See `column.ui` for details. 983 984column.tag:: 985 Specify whether to output tag listing in `git tag` in columns. 986 See `column.ui` for details. 987 988commit.cleanup:: 989 This setting overrides the default of the `--cleanup` option in 990 `git commit`. See linkgit:git-commit[1] for details. Changing the 991 default can be useful when you always want to keep lines that begin 992 with comment character `#` in your log message, in which case you 993 would do `git config commit.cleanup whitespace` (note that you will 994 have to remove the help lines that begin with `#` in the commit log 995 template yourself, if you do this). 996 997commit.gpgsign:: 998 999 A boolean to specify whether all commits should be GPG signed.1000 Use of this option when doing operations such as rebase can1001 result in a large number of commits being signed. It may be1002 convenient to use an agent to avoid typing your GPG passphrase1003 several times.10041005commit.status::1006 A boolean to enable/disable inclusion of status information in the1007 commit message template when using an editor to prepare the commit1008 message. Defaults to true.10091010commit.template::1011 Specify a file to use as the template for new commit messages.1012 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1013 specified user's home directory.10141015credential.helper::1016 Specify an external helper to be called when a username or1017 password credential is needed; the helper may consult external1018 storage to avoid prompting the user for the credentials. See1019 linkgit:gitcredentials[7] for details.10201021credential.useHttpPath::1022 When acquiring credentials, consider the "path" component of an http1023 or https URL to be important. Defaults to false. See1024 linkgit:gitcredentials[7] for more information.10251026credential.username::1027 If no username is set for a network authentication, use this username1028 by default. See credential.<context>.* below, and1029 linkgit:gitcredentials[7].10301031credential.<url>.*::1032 Any of the credential.* options above can be applied selectively to1033 some credentials. For example "credential.https://example.com.username"1034 would set the default username only for https connections to1035 example.com. See linkgit:gitcredentials[7] for details on how URLs are1036 matched.10371038include::diff-config.txt[]10391040difftool.<tool>.path::1041 Override the path for the given tool. This is useful in case1042 your tool is not in the PATH.10431044difftool.<tool>.cmd::1045 Specify the command to invoke the specified diff tool.1046 The specified command is evaluated in shell with the following1047 variables available: 'LOCAL' is set to the name of the temporary1048 file containing the contents of the diff pre-image and 'REMOTE'1049 is set to the name of the temporary file containing the contents1050 of the diff post-image.10511052difftool.prompt::1053 Prompt before each invocation of the diff tool.10541055fetch.recurseSubmodules::1056 This option can be either set to a boolean value or to 'on-demand'.1057 Setting it to a boolean changes the behavior of fetch and pull to1058 unconditionally recurse into submodules when set to true or to not1059 recurse at all when set to false. When set to 'on-demand' (the default1060 value), fetch and pull will only recurse into a populated submodule1061 when its superproject retrieves a commit that updates the submodule's1062 reference.10631064fetch.fsckObjects::1065 If it is set to true, git-fetch-pack will check all fetched1066 objects. It will abort in the case of a malformed object or a1067 broken link. The result of an abort are only dangling objects.1068 Defaults to false. If not set, the value of `transfer.fsckObjects`1069 is used instead.10701071fetch.unpackLimit::1072 If the number of objects fetched over the Git native1073 transfer is below this1074 limit, then the objects will be unpacked into loose object1075 files. However if the number of received objects equals or1076 exceeds this limit then the received pack will be stored as1077 a pack, after adding any missing delta bases. Storing the1078 pack from a push can make the push operation complete faster,1079 especially on slow filesystems. If not set, the value of1080 `transfer.unpackLimit` is used instead.10811082fetch.prune::1083 If true, fetch will automatically behave as if the `--prune`1084 option was given on the command line. See also `remote.<name>.prune`.10851086format.attach::1087 Enable multipart/mixed attachments as the default for1088 'format-patch'. The value can also be a double quoted string1089 which will enable attachments as the default and set the1090 value as the boundary. See the --attach option in1091 linkgit:git-format-patch[1].10921093format.numbered::1094 A boolean which can enable or disable sequence numbers in patch1095 subjects. It defaults to "auto" which enables it only if there1096 is more than one patch. It can be enabled or disabled for all1097 messages by setting it to "true" or "false". See --numbered1098 option in linkgit:git-format-patch[1].10991100format.headers::1101 Additional email headers to include in a patch to be submitted1102 by mail. See linkgit:git-format-patch[1].11031104format.to::1105format.cc::1106 Additional recipients to include in a patch to be submitted1107 by mail. See the --to and --cc options in1108 linkgit:git-format-patch[1].11091110format.subjectprefix::1111 The default for format-patch is to output files with the '[PATCH]'1112 subject prefix. Use this variable to change that prefix.11131114format.signature::1115 The default for format-patch is to output a signature containing1116 the Git version number. Use this variable to change that default.1117 Set this variable to the empty string ("") to suppress1118 signature generation.11191120format.suffix::1121 The default for format-patch is to output files with the suffix1122 `.patch`. Use this variable to change that suffix (make sure to1123 include the dot if you want it).11241125format.pretty::1126 The default pretty format for log/show/whatchanged command,1127 See linkgit:git-log[1], linkgit:git-show[1],1128 linkgit:git-whatchanged[1].11291130format.thread::1131 The default threading style for 'git format-patch'. Can be1132 a boolean value, or `shallow` or `deep`. `shallow` threading1133 makes every mail a reply to the head of the series,1134 where the head is chosen from the cover letter, the1135 `--in-reply-to`, and the first patch mail, in this order.1136 `deep` threading makes every mail a reply to the previous one.1137 A true boolean value is the same as `shallow`, and a false1138 value disables threading.11391140format.signoff::1141 A boolean value which lets you enable the `-s/--signoff` option of1142 format-patch by default. *Note:* Adding the Signed-off-by: line to a1143 patch should be a conscious act and means that you certify you have1144 the rights to submit this work under the same open source license.1145 Please see the 'SubmittingPatches' document for further discussion.11461147format.coverLetter::1148 A boolean that controls whether to generate a cover-letter when1149 format-patch is invoked, but in addition can be set to "auto", to1150 generate a cover-letter only when there's more than one patch.11511152filter.<driver>.clean::1153 The command which is used to convert the content of a worktree1154 file to a blob upon checkin. See linkgit:gitattributes[5] for1155 details.11561157filter.<driver>.smudge::1158 The command which is used to convert the content of a blob1159 object to a worktree file upon checkout. See1160 linkgit:gitattributes[5] for details.11611162gc.aggressiveDepth::1163 The depth parameter used in the delta compression1164 algorithm used by 'git gc --aggressive'. This defaults1165 to 250.11661167gc.aggressiveWindow::1168 The window size parameter used in the delta compression1169 algorithm used by 'git gc --aggressive'. This defaults1170 to 250.11711172gc.auto::1173 When there are approximately more than this many loose1174 objects in the repository, `git gc --auto` will pack them.1175 Some Porcelain commands use this command to perform a1176 light-weight garbage collection from time to time. The1177 default value is 6700. Setting this to 0 disables it.11781179gc.autopacklimit::1180 When there are more than this many packs that are not1181 marked with `*.keep` file in the repository, `git gc1182 --auto` consolidates them into one larger pack. The1183 default value is 50. Setting this to 0 disables it.11841185gc.autodetach::1186 Make `git gc --auto` return immediately andrun in background1187 if the system supports it. Default is true.11881189gc.packrefs::1190 Running `git pack-refs` in a repository renders it1191 unclonable by Git versions prior to 1.5.1.2 over dumb1192 transports such as HTTP. This variable determines whether1193 'git gc' runs `git pack-refs`. This can be set to `notbare`1194 to enable it within all non-bare repos or it can be set to a1195 boolean value. The default is `true`.11961197gc.pruneexpire::1198 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1199 Override the grace period with this config variable. The value1200 "now" may be used to disable this grace period and always prune1201 unreachable objects immediately.12021203gc.reflogexpire::1204gc.<pattern>.reflogexpire::1205 'git reflog expire' removes reflog entries older than1206 this time; defaults to 90 days. With "<pattern>" (e.g.1207 "refs/stash") in the middle the setting applies only to1208 the refs that match the <pattern>.12091210gc.reflogexpireunreachable::1211gc.<ref>.reflogexpireunreachable::1212 'git reflog expire' removes reflog entries older than1213 this time and are not reachable from the current tip;1214 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1215 in the middle, the setting applies only to the refs that1216 match the <pattern>.12171218gc.rerereresolved::1219 Records of conflicted merge you resolved earlier are1220 kept for this many days when 'git rerere gc' is run.1221 The default is 60 days. See linkgit:git-rerere[1].12221223gc.rerereunresolved::1224 Records of conflicted merge you have not resolved are1225 kept for this many days when 'git rerere gc' is run.1226 The default is 15 days. See linkgit:git-rerere[1].12271228gitcvs.commitmsgannotation::1229 Append this string to each commit message. Set to empty string1230 to disable this feature. Defaults to "via git-CVS emulator".12311232gitcvs.enabled::1233 Whether the CVS server interface is enabled for this repository.1234 See linkgit:git-cvsserver[1].12351236gitcvs.logfile::1237 Path to a log file where the CVS server interface well... logs1238 various stuff. See linkgit:git-cvsserver[1].12391240gitcvs.usecrlfattr::1241 If true, the server will look up the end-of-line conversion1242 attributes for files to determine the '-k' modes to use. If1243 the attributes force Git to treat a file as text,1244 the '-k' mode will be left blank so CVS clients will1245 treat it as text. If they suppress text conversion, the file1246 will be set with '-kb' mode, which suppresses any newline munging1247 the client might otherwise do. If the attributes do not allow1248 the file type to be determined, then 'gitcvs.allbinary' is1249 used. See linkgit:gitattributes[5].12501251gitcvs.allbinary::1252 This is used if 'gitcvs.usecrlfattr' does not resolve1253 the correct '-kb' mode to use. If true, all1254 unresolved files are sent to the client in1255 mode '-kb'. This causes the client to treat them1256 as binary files, which suppresses any newline munging it1257 otherwise might do. Alternatively, if it is set to "guess",1258 then the contents of the file are examined to decide if1259 it is binary, similar to 'core.autocrlf'.12601261gitcvs.dbname::1262 Database used by git-cvsserver to cache revision information1263 derived from the Git repository. The exact meaning depends on the1264 used database driver, for SQLite (which is the default driver) this1265 is a filename. Supports variable substitution (see1266 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1267 Default: '%Ggitcvs.%m.sqlite'12681269gitcvs.dbdriver::1270 Used Perl DBI driver. You can specify any available driver1271 for this here, but it might not work. git-cvsserver is tested1272 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1273 reported *not* to work with 'DBD::mysql'. Experimental feature.1274 May not contain double colons (`:`). Default: 'SQLite'.1275 See linkgit:git-cvsserver[1].12761277gitcvs.dbuser, gitcvs.dbpass::1278 Database user and password. Only useful if setting 'gitcvs.dbdriver',1279 since SQLite has no concept of database users and/or passwords.1280 'gitcvs.dbuser' supports variable substitution (see1281 linkgit:git-cvsserver[1] for details).12821283gitcvs.dbTableNamePrefix::1284 Database table name prefix. Prepended to the names of any1285 database tables used, allowing a single database to be used1286 for several repositories. Supports variable substitution (see1287 linkgit:git-cvsserver[1] for details). Any non-alphabetic1288 characters will be replaced with underscores.12891290All gitcvs variables except for 'gitcvs.usecrlfattr' and1291'gitcvs.allbinary' can also be specified as1292'gitcvs.<access_method>.<varname>' (where 'access_method'1293is one of "ext" and "pserver") to make them apply only for the given1294access method.12951296gitweb.category::1297gitweb.description::1298gitweb.owner::1299gitweb.url::1300 See linkgit:gitweb[1] for description.13011302gitweb.avatar::1303gitweb.blame::1304gitweb.grep::1305gitweb.highlight::1306gitweb.patches::1307gitweb.pickaxe::1308gitweb.remote_heads::1309gitweb.showsizes::1310gitweb.snapshot::1311 See linkgit:gitweb.conf[5] for description.13121313grep.lineNumber::1314 If set to true, enable '-n' option by default.13151316grep.patternType::1317 Set the default matching behavior. Using a value of 'basic', 'extended',1318 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1319 '--fixed-strings', or '--perl-regexp' option accordingly, while the1320 value 'default' will return to the default matching behavior.13211322grep.extendedRegexp::1323 If set to true, enable '--extended-regexp' option by default. This1324 option is ignored when the 'grep.patternType' option is set to a value1325 other than 'default'.13261327gpg.program::1328 Use this custom program instead of "gpg" found on $PATH when1329 making or verifying a PGP signature. The program must support the1330 same command line interface as GPG, namely, to verify a detached1331 signature, "gpg --verify $file - <$signature" is run, and the1332 program is expected to signal a good signature by exiting with1333 code 0, and to generate an ascii-armored detached signature, the1334 standard input of "gpg -bsau $key" is fed with the contents to be1335 signed, and the program is expected to send the result to its1336 standard output.13371338gui.commitmsgwidth::1339 Defines how wide the commit message window is in the1340 linkgit:git-gui[1]. "75" is the default.13411342gui.diffcontext::1343 Specifies how many context lines should be used in calls to diff1344 made by the linkgit:git-gui[1]. The default is "5".13451346gui.displayuntracked::1347 Determines if linkgit::git-gui[1] shows untracked files1348 in the file list. The default is "true".13491350gui.encoding::1351 Specifies the default encoding to use for displaying of1352 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1353 It can be overridden by setting the 'encoding' attribute1354 for relevant files (see linkgit:gitattributes[5]).1355 If this option is not set, the tools default to the1356 locale encoding.13571358gui.matchtrackingbranch::1359 Determines if new branches created with linkgit:git-gui[1] should1360 default to tracking remote branches with matching names or1361 not. Default: "false".13621363gui.newbranchtemplate::1364 Is used as suggested name when creating new branches using the1365 linkgit:git-gui[1].13661367gui.pruneduringfetch::1368 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1369 performing a fetch. The default value is "false".13701371gui.trustmtime::1372 Determines if linkgit:git-gui[1] should trust the file modification1373 timestamp or not. By default the timestamps are not trusted.13741375gui.spellingdictionary::1376 Specifies the dictionary used for spell checking commit messages in1377 the linkgit:git-gui[1]. When set to "none" spell checking is turned1378 off.13791380gui.fastcopyblame::1381 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1382 location detection. It makes blame significantly faster on huge1383 repositories at the expense of less thorough copy detection.13841385gui.copyblamethreshold::1386 Specifies the threshold to use in 'git gui blame' original location1387 detection, measured in alphanumeric characters. See the1388 linkgit:git-blame[1] manual for more information on copy detection.13891390gui.blamehistoryctx::1391 Specifies the radius of history context in days to show in1392 linkgit:gitk[1] for the selected commit, when the `Show History1393 Context` menu item is invoked from 'git gui blame'. If this1394 variable is set to zero, the whole history is shown.13951396guitool.<name>.cmd::1397 Specifies the shell command line to execute when the corresponding item1398 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1399 mandatory for every tool. The command is executed from the root of1400 the working directory, and in the environment it receives the name of1401 the tool as 'GIT_GUITOOL', the name of the currently selected file as1402 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1403 the head is detached, 'CUR_BRANCH' is empty).14041405guitool.<name>.needsfile::1406 Run the tool only if a diff is selected in the GUI. It guarantees1407 that 'FILENAME' is not empty.14081409guitool.<name>.noconsole::1410 Run the command silently, without creating a window to display its1411 output.14121413guitool.<name>.norescan::1414 Don't rescan the working directory for changes after the tool1415 finishes execution.14161417guitool.<name>.confirm::1418 Show a confirmation dialog before actually running the tool.14191420guitool.<name>.argprompt::1421 Request a string argument from the user, and pass it to the tool1422 through the 'ARGS' environment variable. Since requesting an1423 argument implies confirmation, the 'confirm' option has no effect1424 if this is enabled. If the option is set to 'true', 'yes', or '1',1425 the dialog uses a built-in generic prompt; otherwise the exact1426 value of the variable is used.14271428guitool.<name>.revprompt::1429 Request a single valid revision from the user, and set the1430 'REVISION' environment variable. In other aspects this option1431 is similar to 'argprompt', and can be used together with it.14321433guitool.<name>.revunmerged::1434 Show only unmerged branches in the 'revprompt' subdialog.1435 This is useful for tools similar to merge or rebase, but not1436 for things like checkout or reset.14371438guitool.<name>.title::1439 Specifies the title to use for the prompt dialog. The default1440 is the tool name.14411442guitool.<name>.prompt::1443 Specifies the general prompt string to display at the top of1444 the dialog, before subsections for 'argprompt' and 'revprompt'.1445 The default value includes the actual command.14461447help.browser::1448 Specify the browser that will be used to display help in the1449 'web' format. See linkgit:git-help[1].14501451help.format::1452 Override the default help format used by linkgit:git-help[1].1453 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1454 the default. 'web' and 'html' are the same.14551456help.autocorrect::1457 Automatically correct and execute mistyped commands after1458 waiting for the given number of deciseconds (0.1 sec). If more1459 than one command can be deduced from the entered text, nothing1460 will be executed. If the value of this option is negative,1461 the corrected command will be executed immediately. If the1462 value is 0 - the command will be just shown but not executed.1463 This is the default.14641465help.htmlpath::1466 Specify the path where the HTML documentation resides. File system paths1467 and URLs are supported. HTML pages will be prefixed with this path when1468 help is displayed in the 'web' format. This defaults to the documentation1469 path of your Git installation.14701471http.proxy::1472 Override the HTTP proxy, normally configured using the 'http_proxy',1473 'https_proxy', and 'all_proxy' environment variables (see1474 `curl(1)`). This can be overridden on a per-remote basis; see1475 remote.<name>.proxy14761477http.cookiefile::1478 File containing previously stored cookie lines which should be used1479 in the Git http session, if they match the server. The file format1480 of the file to read cookies from should be plain HTTP headers or1481 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1482 NOTE that the file specified with http.cookiefile is only used as1483 input unless http.saveCookies is set.14841485http.savecookies::1486 If set, store cookies received during requests to the file specified by1487 http.cookiefile. Has no effect if http.cookiefile is unset.14881489http.sslVerify::1490 Whether to verify the SSL certificate when fetching or pushing1491 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1492 variable.14931494http.sslCert::1495 File containing the SSL certificate when fetching or pushing1496 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1497 variable.14981499http.sslKey::1500 File containing the SSL private key when fetching or pushing1501 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1502 variable.15031504http.sslCertPasswordProtected::1505 Enable Git's password prompt for the SSL certificate. Otherwise1506 OpenSSL will prompt the user, possibly many times, if the1507 certificate or private key is encrypted. Can be overridden by the1508 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15091510http.sslCAInfo::1511 File containing the certificates to verify the peer with when1512 fetching or pushing over HTTPS. Can be overridden by the1513 'GIT_SSL_CAINFO' environment variable.15141515http.sslCAPath::1516 Path containing files with the CA certificates to verify the peer1517 with when fetching or pushing over HTTPS. Can be overridden1518 by the 'GIT_SSL_CAPATH' environment variable.15191520http.sslTry::1521 Attempt to use AUTH SSL/TLS and encrypted data transfers1522 when connecting via regular FTP protocol. This might be needed1523 if the FTP server requires it for security reasons or you wish1524 to connect securely whenever remote FTP server supports it.1525 Default is false since it might trigger certificate verification1526 errors on misconfigured servers.15271528http.maxRequests::1529 How many HTTP requests to launch in parallel. Can be overridden1530 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15311532http.minSessions::1533 The number of curl sessions (counted across slots) to be kept across1534 requests. They will not be ended with curl_easy_cleanup() until1535 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1536 value will be capped at 1. Defaults to 1.15371538http.postBuffer::1539 Maximum size in bytes of the buffer used by smart HTTP1540 transports when POSTing data to the remote system.1541 For requests larger than this buffer size, HTTP/1.1 and1542 Transfer-Encoding: chunked is used to avoid creating a1543 massive pack file locally. Default is 1 MiB, which is1544 sufficient for most requests.15451546http.lowSpeedLimit, http.lowSpeedTime::1547 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1548 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1549 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1550 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15511552http.noEPSV::1553 A boolean which disables using of EPSV ftp command by curl.1554 This can helpful with some "poor" ftp servers which don't1555 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1556 environment variable. Default is false (curl will use EPSV).15571558http.useragent::1559 The HTTP USER_AGENT string presented to an HTTP server. The default1560 value represents the version of the client Git such as git/1.7.1.1561 This option allows you to override this value to a more common value1562 such as Mozilla/4.0. This may be necessary, for instance, if1563 connecting through a firewall that restricts HTTP connections to a set1564 of common USER_AGENT strings (but not including those like git/1.7.1).1565 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15661567http.<url>.*::1568 Any of the http.* options above can be applied selectively to some urls.1569 For a config key to match a URL, each element of the config key is1570 compared to that of the URL, in the following order:1571+1572--1573. Scheme (e.g., `https` in `https://example.com/`). This field1574 must match exactly between the config key and the URL.15751576. Host/domain name (e.g., `example.com` in `https://example.com/`).1577 This field must match exactly between the config key and the URL.15781579. Port number (e.g., `8080` in `http://example.com:8080/`).1580 This field must match exactly between the config key and the URL.1581 Omitted port numbers are automatically converted to the correct1582 default for the scheme before matching.15831584. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1585 path field of the config key must match the path field of the URL1586 either exactly or as a prefix of slash-delimited path elements. This means1587 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1588 match on a slash (`/`) boundary. Longer matches take precedence (so a config1589 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1590 key with just path `foo/`).15911592. User name (e.g., `user` in `https://user@example.com/repo.git`). If1593 the config key has a user name it must match the user name in the1594 URL exactly. If the config key does not have a user name, that1595 config key will match a URL with any user name (including none),1596 but at a lower precedence than a config key with a user name.1597--1598+1599The list above is ordered by decreasing precedence; a URL that matches1600a config key's path is preferred to one that matches its user name. For example,1601if the URL is `https://user@example.com/foo/bar` a config key match of1602`https://example.com/foo` will be preferred over a config key match of1603`https://user@example.com`.1604+1605All URLs are normalized before attempting any matching (the password part,1606if embedded in the URL, is always ignored for matching purposes) so that1607equivalent urls that are simply spelled differently will match properly.1608Environment variable settings always override any matches. The urls that are1609matched against are those given directly to Git commands. This means any URLs1610visited as a result of a redirection do not participate in matching.16111612i18n.commitEncoding::1613 Character encoding the commit messages are stored in; Git itself1614 does not care per se, but this information is necessary e.g. when1615 importing commits from emails or in the gitk graphical history1616 browser (and possibly at other places in the future or in other1617 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16181619i18n.logOutputEncoding::1620 Character encoding the commit messages are converted to when1621 running 'git log' and friends.16221623imap::1624 The configuration variables in the 'imap' section are described1625 in linkgit:git-imap-send[1].16261627index.version::1628 Specify the version with which new index files should be1629 initialized. This does not affect existing repositories.16301631init.templatedir::1632 Specify the directory from which templates will be copied.1633 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16341635instaweb.browser::1636 Specify the program that will be used to browse your working1637 repository in gitweb. See linkgit:git-instaweb[1].16381639instaweb.httpd::1640 The HTTP daemon command-line to start gitweb on your working1641 repository. See linkgit:git-instaweb[1].16421643instaweb.local::1644 If true the web server started by linkgit:git-instaweb[1] will1645 be bound to the local IP (127.0.0.1).16461647instaweb.modulepath::1648 The default module path for linkgit:git-instaweb[1] to use1649 instead of /usr/lib/apache2/modules. Only used if httpd1650 is Apache.16511652instaweb.port::1653 The port number to bind the gitweb httpd to. See1654 linkgit:git-instaweb[1].16551656interactive.singlekey::1657 In interactive commands, allow the user to provide one-letter1658 input with a single key (i.e., without hitting enter).1659 Currently this is used by the `--patch` mode of1660 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1661 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1662 setting is silently ignored if portable keystroke input1663 is not available; requires the Perl module Term::ReadKey.16641665log.abbrevCommit::1666 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1667 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1668 override this option with `--no-abbrev-commit`.16691670log.date::1671 Set the default date-time mode for the 'log' command.1672 Setting a value for log.date is similar to using 'git log''s1673 `--date` option. Possible values are `relative`, `local`,1674 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1675 for details.16761677log.decorate::1678 Print out the ref names of any commits that are shown by the log1679 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1680 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1681 specified, the full ref name (including prefix) will be printed.1682 This is the same as the log commands '--decorate' option.16831684log.showroot::1685 If true, the initial commit will be shown as a big creation event.1686 This is equivalent to a diff against an empty tree.1687 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1688 normally hide the root commit will now show it. True by default.16891690log.mailmap::1691 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1692 linkgit:git-whatchanged[1] assume `--use-mailmap`.16931694mailmap.file::1695 The location of an augmenting mailmap file. The default1696 mailmap, located in the root of the repository, is loaded1697 first, then the mailmap file pointed to by this variable.1698 The location of the mailmap file may be in a repository1699 subdirectory, or somewhere outside of the repository itself.1700 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17011702mailmap.blob::1703 Like `mailmap.file`, but consider the value as a reference to a1704 blob in the repository. If both `mailmap.file` and1705 `mailmap.blob` are given, both are parsed, with entries from1706 `mailmap.file` taking precedence. In a bare repository, this1707 defaults to `HEAD:.mailmap`. In a non-bare repository, it1708 defaults to empty.17091710man.viewer::1711 Specify the programs that may be used to display help in the1712 'man' format. See linkgit:git-help[1].17131714man.<tool>.cmd::1715 Specify the command to invoke the specified man viewer. The1716 specified command is evaluated in shell with the man page1717 passed as argument. (See linkgit:git-help[1].)17181719man.<tool>.path::1720 Override the path for the given tool that may be used to1721 display help in the 'man' format. See linkgit:git-help[1].17221723include::merge-config.txt[]17241725mergetool.<tool>.path::1726 Override the path for the given tool. This is useful in case1727 your tool is not in the PATH.17281729mergetool.<tool>.cmd::1730 Specify the command to invoke the specified merge tool. The1731 specified command is evaluated in shell with the following1732 variables available: 'BASE' is the name of a temporary file1733 containing the common base of the files to be merged, if available;1734 'LOCAL' is the name of a temporary file containing the contents of1735 the file on the current branch; 'REMOTE' is the name of a temporary1736 file containing the contents of the file from the branch being1737 merged; 'MERGED' contains the name of the file to which the merge1738 tool should write the results of a successful merge.17391740mergetool.<tool>.trustExitCode::1741 For a custom merge command, specify whether the exit code of1742 the merge command can be used to determine whether the merge was1743 successful. If this is not set to true then the merge target file1744 timestamp is checked and the merge assumed to have been successful1745 if the file has been updated, otherwise the user is prompted to1746 indicate the success of the merge.17471748mergetool.keepBackup::1749 After performing a merge, the original file with conflict markers1750 can be saved as a file with a `.orig` extension. If this variable1751 is set to `false` then this file is not preserved. Defaults to1752 `true` (i.e. keep the backup files).17531754mergetool.keepTemporaries::1755 When invoking a custom merge tool, Git uses a set of temporary1756 files to pass to the tool. If the tool returns an error and this1757 variable is set to `true`, then these temporary files will be1758 preserved, otherwise they will be removed after the tool has1759 exited. Defaults to `false`.17601761mergetool.prompt::1762 Prompt before each invocation of the merge resolution program.17631764notes.displayRef::1765 The (fully qualified) refname from which to show notes when1766 showing commit messages. The value of this variable can be set1767 to a glob, in which case notes from all matching refs will be1768 shown. You may also specify this configuration variable1769 several times. A warning will be issued for refs that do not1770 exist, but a glob that does not match any refs is silently1771 ignored.1772+1773This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1774environment variable, which must be a colon separated list of refs or1775globs.1776+1777The effective value of "core.notesRef" (possibly overridden by1778GIT_NOTES_REF) is also implicitly added to the list of refs to be1779displayed.17801781notes.rewrite.<command>::1782 When rewriting commits with <command> (currently `amend` or1783 `rebase`) and this variable is set to `true`, Git1784 automatically copies your notes from the original to the1785 rewritten commit. Defaults to `true`, but see1786 "notes.rewriteRef" below.17871788notes.rewriteMode::1789 When copying notes during a rewrite (see the1790 "notes.rewrite.<command>" option), determines what to do if1791 the target commit already has a note. Must be one of1792 `overwrite`, `concatenate`, or `ignore`. Defaults to1793 `concatenate`.1794+1795This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1796environment variable.17971798notes.rewriteRef::1799 When copying notes during a rewrite, specifies the (fully1800 qualified) ref whose notes should be copied. The ref may be a1801 glob, in which case notes in all matching refs will be copied.1802 You may also specify this configuration several times.1803+1804Does not have a default value; you must configure this variable to1805enable note rewriting. Set it to `refs/notes/commits` to enable1806rewriting for the default commit notes.1807+1808This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1809environment variable, which must be a colon separated list of refs or1810globs.18111812pack.window::1813 The size of the window used by linkgit:git-pack-objects[1] when no1814 window size is given on the command line. Defaults to 10.18151816pack.depth::1817 The maximum delta depth used by linkgit:git-pack-objects[1] when no1818 maximum depth is given on the command line. Defaults to 50.18191820pack.windowMemory::1821 The window memory size limit used by linkgit:git-pack-objects[1]1822 when no limit is given on the command line. The value can be1823 suffixed with "k", "m", or "g". Defaults to 0, meaning no1824 limit.18251826pack.compression::1827 An integer -1..9, indicating the compression level for objects1828 in a pack file. -1 is the zlib default. 0 means no1829 compression, and 1..9 are various speed/size tradeoffs, 9 being1830 slowest. If not set, defaults to core.compression. If that is1831 not set, defaults to -1, the zlib default, which is "a default1832 compromise between speed and compression (currently equivalent1833 to level 6)."1834+1835Note that changing the compression level will not automatically recompress1836all existing objects. You can force recompression by passing the -F option1837to linkgit:git-repack[1].18381839pack.deltaCacheSize::1840 The maximum memory in bytes used for caching deltas in1841 linkgit:git-pack-objects[1] before writing them out to a pack.1842 This cache is used to speed up the writing object phase by not1843 having to recompute the final delta result once the best match1844 for all objects is found. Repacking large repositories on machines1845 which are tight with memory might be badly impacted by this though,1846 especially if this cache pushes the system into swapping.1847 A value of 0 means no limit. The smallest size of 1 byte may be1848 used to virtually disable this cache. Defaults to 256 MiB.18491850pack.deltaCacheLimit::1851 The maximum size of a delta, that is cached in1852 linkgit:git-pack-objects[1]. This cache is used to speed up the1853 writing object phase by not having to recompute the final delta1854 result once the best match for all objects is found. Defaults to 1000.18551856pack.threads::1857 Specifies the number of threads to spawn when searching for best1858 delta matches. This requires that linkgit:git-pack-objects[1]1859 be compiled with pthreads otherwise this option is ignored with a1860 warning. This is meant to reduce packing time on multiprocessor1861 machines. The required amount of memory for the delta search window1862 is however multiplied by the number of threads.1863 Specifying 0 will cause Git to auto-detect the number of CPU's1864 and set the number of threads accordingly.18651866pack.indexVersion::1867 Specify the default pack index version. Valid values are 1 for1868 legacy pack index used by Git versions prior to 1.5.2, and 2 for1869 the new pack index with capabilities for packs larger than 4 GB1870 as well as proper protection against the repacking of corrupted1871 packs. Version 2 is the default. Note that version 2 is enforced1872 and this config option ignored whenever the corresponding pack is1873 larger than 2 GB.1874+1875If you have an old Git that does not understand the version 2 `*.idx` file,1876cloning or fetching over a non native protocol (e.g. "http" and "rsync")1877that will copy both `*.pack` file and corresponding `*.idx` file from the1878other side may give you a repository that cannot be accessed with your1879older version of Git. If the `*.pack` file is smaller than 2 GB, however,1880you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1881the `*.idx` file.18821883pack.packSizeLimit::1884 The maximum size of a pack. This setting only affects1885 packing to a file when repacking, i.e. the git:// protocol1886 is unaffected. It can be overridden by the `--max-pack-size`1887 option of linkgit:git-repack[1]. The minimum size allowed is1888 limited to 1 MiB. The default is unlimited.1889 Common unit suffixes of 'k', 'm', or 'g' are1890 supported.18911892pack.useBitmaps::1893 When true, git will use pack bitmaps (if available) when packing1894 to stdout (e.g., during the server side of a fetch). Defaults to1895 true. You should not generally need to turn this off unless1896 you are debugging pack bitmaps.18971898pack.writebitmaps::1899 When true, git will write a bitmap index when packing all1900 objects to disk (e.g., when `git repack -a` is run). This1901 index can speed up the "counting objects" phase of subsequent1902 packs created for clones and fetches, at the cost of some disk1903 space and extra time spent on the initial repack. Defaults to1904 false.19051906pack.writeBitmapHashCache::1907 When true, git will include a "hash cache" section in the bitmap1908 index (if one is written). This cache can be used to feed git's1909 delta heuristics, potentially leading to better deltas between1910 bitmapped and non-bitmapped objects (e.g., when serving a fetch1911 between an older, bitmapped pack and objects that have been1912 pushed since the last gc). The downside is that it consumes 41913 bytes per object of disk space, and that JGit's bitmap1914 implementation does not understand it, causing it to complain if1915 Git and JGit are used on the same repository. Defaults to false.19161917pager.<cmd>::1918 If the value is boolean, turns on or off pagination of the1919 output of a particular Git subcommand when writing to a tty.1920 Otherwise, turns on pagination for the subcommand using the1921 pager specified by the value of `pager.<cmd>`. If `--paginate`1922 or `--no-pager` is specified on the command line, it takes1923 precedence over this option. To disable pagination for all1924 commands, set `core.pager` or `GIT_PAGER` to `cat`.19251926pretty.<name>::1927 Alias for a --pretty= format string, as specified in1928 linkgit:git-log[1]. Any aliases defined here can be used just1929 as the built-in pretty formats could. For example,1930 running `git config pretty.changelog "format:* %H %s"`1931 would cause the invocation `git log --pretty=changelog`1932 to be equivalent to running `git log "--pretty=format:* %H %s"`.1933 Note that an alias with the same name as a built-in format1934 will be silently ignored.19351936pull.ff::1937 By default, Git does not create an extra merge commit when merging1938 a commit that is a descendant of the current commit. Instead, the1939 tip of the current branch is fast-forwarded. When set to `false`,1940 this variable tells Git to create an extra merge commit in such1941 a case (equivalent to giving the `--no-ff` option from the command1942 line). When set to `only`, only such fast-forward merges are1943 allowed (equivalent to giving the `--ff-only` option from the1944 command line).19451946pull.rebase::1947 When true, rebase branches on top of the fetched branch, instead1948 of merging the default branch from the default remote when "git1949 pull" is run. See "branch.<name>.rebase" for setting this on a1950 per-branch basis.1951+1952 When preserve, also pass `--preserve-merges` along to 'git rebase'1953 so that locally committed merge commits will not be flattened1954 by running 'git pull'.1955+1956*NOTE*: this is a possibly dangerous operation; do *not* use1957it unless you understand the implications (see linkgit:git-rebase[1]1958for details).19591960pull.octopus::1961 The default merge strategy to use when pulling multiple branches1962 at once.19631964pull.twohead::1965 The default merge strategy to use when pulling a single branch.19661967push.default::1968 Defines the action `git push` should take if no refspec is1969 explicitly given. Different values are well-suited for1970 specific workflows; for instance, in a purely central workflow1971 (i.e. the fetch source is equal to the push destination),1972 `upstream` is probably what you want. Possible values are:1973+1974--19751976* `nothing` - do not push anything (error out) unless a refspec is1977 explicitly given. This is primarily meant for people who want to1978 avoid mistakes by always being explicit.19791980* `current` - push the current branch to update a branch with the same1981 name on the receiving end. Works in both central and non-central1982 workflows.19831984* `upstream` - push the current branch back to the branch whose1985 changes are usually integrated into the current branch (which is1986 called `@{upstream}`). This mode only makes sense if you are1987 pushing to the same repository you would normally pull from1988 (i.e. central workflow).19891990* `simple` - in centralized workflow, work like `upstream` with an1991 added safety to refuse to push if the upstream branch's name is1992 different from the local one.1993+1994When pushing to a remote that is different from the remote you normally1995pull from, work as `current`. This is the safest option and is suited1996for beginners.1997+1998This mode has become the default in Git 2.0.19992000* `matching` - push all branches having the same name on both ends.2001 This makes the repository you are pushing to remember the set of2002 branches that will be pushed out (e.g. if you always push 'maint'2003 and 'master' there and no other branches, the repository you push2004 to will have these two branches, and your local 'maint' and2005 'master' will be pushed there).2006+2007To use this mode effectively, you have to make sure _all_ the2008branches you would push out are ready to be pushed out before2009running 'git push', as the whole point of this mode is to allow you2010to push all of the branches in one go. If you usually finish work2011on only one branch and push out the result, while other branches are2012unfinished, this mode is not for you. Also this mode is not2013suitable for pushing into a shared central repository, as other2014people may add new branches there, or update the tip of existing2015branches outside your control.2016+2017This used to be the default, but not since Git 2.0 (`simple` is the2018new default).20192020--20212022rebase.stat::2023 Whether to show a diffstat of what changed upstream since the last2024 rebase. False by default.20252026rebase.autosquash::2027 If set to true enable '--autosquash' option by default.20282029rebase.autostash::2030 When set to true, automatically create a temporary stash2031 before the operation begins, and apply it after the operation2032 ends. This means that you can run rebase on a dirty worktree.2033 However, use with care: the final stash application after a2034 successful rebase might result in non-trivial conflicts.2035 Defaults to false.20362037receive.autogc::2038 By default, git-receive-pack will run "git-gc --auto" after2039 receiving data from git-push and updating refs. You can stop2040 it by setting this variable to false.20412042receive.fsckObjects::2043 If it is set to true, git-receive-pack will check all received2044 objects. It will abort in the case of a malformed object or a2045 broken link. The result of an abort are only dangling objects.2046 Defaults to false. If not set, the value of `transfer.fsckObjects`2047 is used instead.20482049receive.unpackLimit::2050 If the number of objects received in a push is below this2051 limit then the objects will be unpacked into loose object2052 files. However if the number of received objects equals or2053 exceeds this limit then the received pack will be stored as2054 a pack, after adding any missing delta bases. Storing the2055 pack from a push can make the push operation complete faster,2056 especially on slow filesystems. If not set, the value of2057 `transfer.unpackLimit` is used instead.20582059receive.denyDeletes::2060 If set to true, git-receive-pack will deny a ref update that deletes2061 the ref. Use this to prevent such a ref deletion via a push.20622063receive.denyDeleteCurrent::2064 If set to true, git-receive-pack will deny a ref update that2065 deletes the currently checked out branch of a non-bare repository.20662067receive.denyCurrentBranch::2068 If set to true or "refuse", git-receive-pack will deny a ref update2069 to the currently checked out branch of a non-bare repository.2070 Such a push is potentially dangerous because it brings the HEAD2071 out of sync with the index and working tree. If set to "warn",2072 print a warning of such a push to stderr, but allow the push to2073 proceed. If set to false or "ignore", allow such pushes with no2074 message. Defaults to "refuse".20752076receive.denyNonFastForwards::2077 If set to true, git-receive-pack will deny a ref update which is2078 not a fast-forward. Use this to prevent such an update via a push,2079 even if that push is forced. This configuration variable is2080 set when initializing a shared repository.20812082receive.hiderefs::2083 String(s) `receive-pack` uses to decide which refs to omit2084 from its initial advertisement. Use more than one2085 definitions to specify multiple prefix strings. A ref that2086 are under the hierarchies listed on the value of this2087 variable is excluded, and is hidden when responding to `git2088 push`, and an attempt to update or delete a hidden ref by2089 `git push` is rejected.20902091receive.updateserverinfo::2092 If set to true, git-receive-pack will run git-update-server-info2093 after receiving data from git-push and updating refs.20942095receive.shallowupdate::2096 If set to true, .git/shallow can be updated when new refs2097 require new shallow roots. Otherwise those refs are rejected.20982099remote.pushdefault::2100 The remote to push to by default. Overrides2101 `branch.<name>.remote` for all branches, and is overridden by2102 `branch.<name>.pushremote` for specific branches.21032104remote.<name>.url::2105 The URL of a remote repository. See linkgit:git-fetch[1] or2106 linkgit:git-push[1].21072108remote.<name>.pushurl::2109 The push URL of a remote repository. See linkgit:git-push[1].21102111remote.<name>.proxy::2112 For remotes that require curl (http, https and ftp), the URL to2113 the proxy to use for that remote. Set to the empty string to2114 disable proxying for that remote.21152116remote.<name>.fetch::2117 The default set of "refspec" for linkgit:git-fetch[1]. See2118 linkgit:git-fetch[1].21192120remote.<name>.push::2121 The default set of "refspec" for linkgit:git-push[1]. See2122 linkgit:git-push[1].21232124remote.<name>.mirror::2125 If true, pushing to this remote will automatically behave2126 as if the `--mirror` option was given on the command line.21272128remote.<name>.skipDefaultUpdate::2129 If true, this remote will be skipped by default when updating2130 using linkgit:git-fetch[1] or the `update` subcommand of2131 linkgit:git-remote[1].21322133remote.<name>.skipFetchAll::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>.receivepack::2139 The default program to execute on the remote side when pushing. See2140 option \--receive-pack of linkgit:git-push[1].21412142remote.<name>.uploadpack::2143 The default program to execute on the remote side when fetching. See2144 option \--upload-pack of linkgit:git-fetch-pack[1].21452146remote.<name>.tagopt::2147 Setting this value to \--no-tags disables automatic tag following when2148 fetching from remote <name>. Setting it to \--tags will fetch every2149 tag from remote <name>, even if they are not reachable from remote2150 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2151 override this setting. See options \--tags and \--no-tags of2152 linkgit:git-fetch[1].21532154remote.<name>.vcs::2155 Setting this to a value <vcs> will cause Git to interact with2156 the remote with the git-remote-<vcs> helper.21572158remote.<name>.prune::2159 When set to true, fetching from this remote by default will also2160 remove any remote-tracking references that no longer exist on the2161 remote (as if the `--prune` option was given on the command line).2162 Overrides `fetch.prune` settings, if any.21632164remotes.<group>::2165 The list of remotes which are fetched by "git remote update2166 <group>". See linkgit:git-remote[1].21672168repack.usedeltabaseoffset::2169 By default, linkgit:git-repack[1] creates packs that use2170 delta-base offset. If you need to share your repository with2171 Git older than version 1.4.4, either directly or via a dumb2172 protocol such as http, then you need to set this option to2173 "false" and repack. Access from old Git versions over the2174 native protocol are unaffected by this option.21752176repack.packKeptObjects::2177 If set to true, makes `git repack` act as if2178 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2179 details. Defaults to `false` normally, but `true` if a bitmap2180 index is being written (either via `--write-bitmap-index` or2181 `pack.writeBitmaps`).21822183rerere.autoupdate::2184 When set to true, `git-rerere` updates the index with the2185 resulting contents after it cleanly resolves conflicts using2186 previously recorded resolution. Defaults to false.21872188rerere.enabled::2189 Activate recording of resolved conflicts, so that identical2190 conflict hunks can be resolved automatically, should they be2191 encountered again. By default, linkgit:git-rerere[1] is2192 enabled if there is an `rr-cache` directory under the2193 `$GIT_DIR`, e.g. if "rerere" was previously used in the2194 repository.21952196sendemail.identity::2197 A configuration identity. When given, causes values in the2198 'sendemail.<identity>' subsection to take precedence over2199 values in the 'sendemail' section. The default identity is2200 the value of 'sendemail.identity'.22012202sendemail.smtpencryption::2203 See linkgit:git-send-email[1] for description. Note that this2204 setting is not subject to the 'identity' mechanism.22052206sendemail.smtpssl::2207 Deprecated alias for 'sendemail.smtpencryption = ssl'.22082209sendemail.smtpsslcertpath::2210 Path to ca-certificates (either a directory or a single file).2211 Set it to an empty string to disable certificate verification.22122213sendemail.<identity>.*::2214 Identity-specific versions of the 'sendemail.*' parameters2215 found below, taking precedence over those when the this2216 identity is selected, through command-line or2217 'sendemail.identity'.22182219sendemail.aliasesfile::2220sendemail.aliasfiletype::2221sendemail.annotate::2222sendemail.bcc::2223sendemail.cc::2224sendemail.cccmd::2225sendemail.chainreplyto::2226sendemail.confirm::2227sendemail.envelopesender::2228sendemail.from::2229sendemail.multiedit::2230sendemail.signedoffbycc::2231sendemail.smtppass::2232sendemail.suppresscc::2233sendemail.suppressfrom::2234sendemail.to::2235sendemail.smtpdomain::2236sendemail.smtpserver::2237sendemail.smtpserverport::2238sendemail.smtpserveroption::2239sendemail.smtpuser::2240sendemail.thread::2241sendemail.validate::2242 See linkgit:git-send-email[1] for description.22432244sendemail.signedoffcc::2245 Deprecated alias for 'sendemail.signedoffbycc'.22462247showbranch.default::2248 The default set of branches for linkgit:git-show-branch[1].2249 See linkgit:git-show-branch[1].22502251status.relativePaths::2252 By default, linkgit:git-status[1] shows paths relative to the2253 current directory. Setting this variable to `false` shows paths2254 relative to the repository root (this was the default for Git2255 prior to v1.5.4).22562257status.short::2258 Set to true to enable --short by default in linkgit:git-status[1].2259 The option --no-short takes precedence over this variable.22602261status.branch::2262 Set to true to enable --branch by default in linkgit:git-status[1].2263 The option --no-branch takes precedence over this variable.22642265status.displayCommentPrefix::2266 If set to true, linkgit:git-status[1] will insert a comment2267 prefix before each output line (starting with2268 `core.commentChar`, i.e. `#` by default). This was the2269 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2270 Defaults to false.22712272status.showUntrackedFiles::2273 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2274 files which are not currently tracked by Git. Directories which2275 contain only untracked files, are shown with the directory name2276 only. Showing untracked files means that Git needs to lstat() all2277 all the files in the whole repository, which might be slow on some2278 systems. So, this variable controls how the commands displays2279 the untracked files. Possible values are:2280+2281--2282* `no` - Show no untracked files.2283* `normal` - Show untracked files and directories.2284* `all` - Show also individual files in untracked directories.2285--2286+2287If this variable is not specified, it defaults to 'normal'.2288This variable can be overridden with the -u|--untracked-files option2289of linkgit:git-status[1] and linkgit:git-commit[1].22902291status.submodulesummary::2292 Defaults to false.2293 If this is set to a non zero number or true (identical to -1 or an2294 unlimited number), the submodule summary will be enabled and a2295 summary of commits for modified submodules will be shown (see2296 --summary-limit option of linkgit:git-submodule[1]). Please note2297 that the summary output command will be suppressed for all2298 submodules when `diff.ignoreSubmodules` is set to 'all' or only2299 for those submodules where `submodule.<name>.ignore=all`. To2300 also view the summary for ignored submodules you can either use2301 the --ignore-submodules=dirty command line option or the 'git2302 submodule summary' command, which shows a similar output but does2303 not honor these settings.23042305submodule.<name>.path::2306submodule.<name>.url::2307submodule.<name>.update::2308 The path within this project, URL, and the updating strategy2309 for a submodule. These variables are initially populated2310 by 'git submodule init'; edit them to override the2311 URL and other values found in the `.gitmodules` file. See2312 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.23132314submodule.<name>.branch::2315 The remote branch name for a submodule, used by `git submodule2316 update --remote`. Set this option to override the value found in2317 the `.gitmodules` file. See linkgit:git-submodule[1] and2318 linkgit:gitmodules[5] for details.23192320submodule.<name>.fetchRecurseSubmodules::2321 This option can be used to control recursive fetching of this2322 submodule. It can be overridden by using the --[no-]recurse-submodules2323 command line option to "git fetch" and "git pull".2324 This setting will override that from in the linkgit:gitmodules[5]2325 file.23262327submodule.<name>.ignore::2328 Defines under what circumstances "git status" and the diff family show2329 a submodule as modified. When set to "all", it will never be considered2330 modified, "dirty" will ignore all changes to the submodules work tree and2331 takes only differences between the HEAD of the submodule and the commit2332 recorded in the superproject into account. "untracked" will additionally2333 let submodules with modified tracked files in their work tree show up.2334 Using "none" (the default when this option is not set) also shows2335 submodules that have untracked files in their work tree as changed.2336 This setting overrides any setting made in .gitmodules for this submodule,2337 both settings can be overridden on the command line by using the2338 "--ignore-submodules" option. The 'git submodule' commands are not2339 affected by this setting.23402341tar.umask::2342 This variable can be used to restrict the permission bits of2343 tar archive entries. The default is 0002, which turns off the2344 world write bit. The special value "user" indicates that the2345 archiving user's umask will be used instead. See umask(2) and2346 linkgit:git-archive[1].23472348transfer.fsckObjects::2349 When `fetch.fsckObjects` or `receive.fsckObjects` are2350 not set, the value of this variable is used instead.2351 Defaults to false.23522353transfer.hiderefs::2354 This variable can be used to set both `receive.hiderefs`2355 and `uploadpack.hiderefs` at the same time to the same2356 values. See entries for these other variables.23572358transfer.unpackLimit::2359 When `fetch.unpackLimit` or `receive.unpackLimit` are2360 not set, the value of this variable is used instead.2361 The default value is 100.23622363uploadarchive.allowUnreachable::2364 If true, allow clients to use `git archive --remote` to request2365 any tree, whether reachable from the ref tips or not. See the2366 discussion in the `SECURITY` section of2367 linkgit:git-upload-archive[1] for more details. Defaults to2368 `false`.23692370uploadpack.hiderefs::2371 String(s) `upload-pack` uses to decide which refs to omit2372 from its initial advertisement. Use more than one2373 definitions to specify multiple prefix strings. A ref that2374 are under the hierarchies listed on the value of this2375 variable is excluded, and is hidden from `git ls-remote`,2376 `git fetch`, etc. An attempt to fetch a hidden ref by `git2377 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.23782379uploadpack.allowtipsha1inwant::2380 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2381 to accept a fetch request that asks for an object at the tip2382 of a hidden ref (by default, such a request is rejected).2383 see also `uploadpack.hiderefs`.23842385uploadpack.keepalive::2386 When `upload-pack` has started `pack-objects`, there may be a2387 quiet period while `pack-objects` prepares the pack. Normally2388 it would output progress information, but if `--quiet` was used2389 for the fetch, `pack-objects` will output nothing at all until2390 the pack data begins. Some clients and networks may consider2391 the server to be hung and give up. Setting this option instructs2392 `upload-pack` to send an empty keepalive packet every2393 `uploadpack.keepalive` seconds. Setting this option to 02394 disables keepalive packets entirely. The default is 5 seconds.23952396url.<base>.insteadOf::2397 Any URL that starts with this value will be rewritten to2398 start, instead, with <base>. In cases where some site serves a2399 large number of repositories, and serves them with multiple2400 access methods, and some users need to use different access2401 methods, this feature allows people to specify any of the2402 equivalent URLs and have Git automatically rewrite the URL to2403 the best alternative for the particular user, even for a2404 never-before-seen repository on the site. When more than one2405 insteadOf strings match a given URL, the longest match is used.24062407url.<base>.pushInsteadOf::2408 Any URL that starts with this value will not be pushed to;2409 instead, it will be rewritten to start with <base>, and the2410 resulting URL will be pushed to. In cases where some site serves2411 a large number of repositories, and serves them with multiple2412 access methods, some of which do not allow push, this feature2413 allows people to specify a pull-only URL and have Git2414 automatically use an appropriate URL to push, even for a2415 never-before-seen repository on the site. When more than one2416 pushInsteadOf strings match a given URL, the longest match is2417 used. If a remote has an explicit pushurl, Git will ignore this2418 setting for that remote.24192420user.email::2421 Your email address to be recorded in any newly created commits.2422 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2423 'EMAIL' environment variables. See linkgit:git-commit-tree[1].24242425user.name::2426 Your full name to be recorded in any newly created commits.2427 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2428 environment variables. See linkgit:git-commit-tree[1].24292430user.signingkey::2431 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2432 key you want it to automatically when creating a signed tag or2433 commit, you can override the default selection with this variable.2434 This option is passed unchanged to gpg's --local-user parameter,2435 so you may specify a key using any method that gpg supports.24362437web.browser::2438 Specify a web browser that may be used by some commands.2439 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2440 may use it.