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). No other char escape sequence, nor octal 82char sequences are valid. 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. You will find a description of non-core 135porcelain configuration variables in the respective porcelain documentation. 136 137advice.*:: 138 These variables control various optional help messages designed to 139 aid new users. All 'advice.*' variables default to 'true', and you 140 can tell Git that you do not need help by setting these to 'false': 141+ 142-- 143 pushUpdateRejected:: 144 Set this variable to 'false' if you want to disable 145 'pushNonFFCurrent', 'pushNonFFDefault', 146 'pushNonFFMatching', 'pushAlreadyExists', 147 'pushFetchFirst', and 'pushNeedsForce' 148 simultaneously. 149 pushNonFFCurrent:: 150 Advice shown when linkgit:git-push[1] fails due to a 151 non-fast-forward update to the current branch. 152 pushNonFFDefault:: 153 Advice to set 'push.default' to 'upstream' or 'current' 154 when you ran linkgit:git-push[1] and pushed 'matching 155 refs' by default (i.e. you did not provide an explicit 156 refspec, and no 'push.default' configuration was set) 157 and it resulted in a non-fast-forward error. 158 pushNonFFMatching:: 159 Advice shown when you ran linkgit:git-push[1] and pushed 160 'matching refs' explicitly (i.e. you used ':', or 161 specified a refspec that isn't your current branch) and 162 it resulted in a non-fast-forward error. 163 pushAlreadyExists:: 164 Shown when linkgit:git-push[1] rejects an update that 165 does not qualify for fast-forwarding (e.g., a tag.) 166 pushFetchFirst:: 167 Shown when linkgit:git-push[1] rejects an update that 168 tries to overwrite a remote ref that points at an 169 object we do not have. 170 pushNeedsForce:: 171 Shown when linkgit:git-push[1] rejects an update that 172 tries to overwrite a remote ref that points at an 173 object that is not a commit-ish, or make the remote 174 ref point at an object that is not a commit-ish. 175 statusHints:: 176 Show directions on how to proceed from the current 177 state in the output of linkgit:git-status[1], in 178 the template shown when writing commit messages in 179 linkgit:git-commit[1], and in the help message shown 180 by linkgit:git-checkout[1] when switching branch. 181 statusUoption:: 182 Advise to consider using the `-u` option to linkgit:git-status[1] 183 when the command takes more than 2 seconds to enumerate untracked 184 files. 185 commitBeforeMerge:: 186 Advice shown when linkgit:git-merge[1] refuses to 187 merge to avoid overwriting local changes. 188 resolveConflict:: 189 Advice shown by various commands when conflicts 190 prevent the operation from being performed. 191 implicitIdentity:: 192 Advice on how to set your identity configuration when 193 your information is guessed from the system username and 194 domain name. 195 detachedHead:: 196 Advice shown when you used linkgit:git-checkout[1] to 197 move to the detach HEAD state, to instruct how to create 198 a local branch after the fact. 199 amWorkDir:: 200 Advice that shows the location of the patch file when 201 linkgit:git-am[1] fails to apply it. 202 rmHints:: 203 In case of failure in the output of linkgit:git-rm[1], 204 show directions on how to proceed from the current state. 205-- 206 207core.fileMode:: 208 If false, the executable bit differences between the index and 209 the working tree are ignored; useful on broken filesystems like FAT. 210 See linkgit:git-update-index[1]. 211+ 212The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 213will probe and set core.fileMode false if appropriate when the 214repository is created. 215 216core.ignorecase:: 217 If true, this option enables various workarounds to enable 218 Git to work better on filesystems that are not case sensitive, 219 like FAT. For example, if a directory listing finds 220 "makefile" when Git expects "Makefile", Git will assume 221 it is really the same file, and continue to remember it as 222 "Makefile". 223+ 224The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 225will probe and set core.ignorecase true if appropriate when the repository 226is created. 227 228core.precomposeunicode:: 229 This option is only used by Mac OS implementation of Git. 230 When core.precomposeunicode=true, Git reverts the unicode decomposition 231 of filenames done by Mac OS. This is useful when sharing a repository 232 between Mac OS and Linux or Windows. 233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 234 When false, file names are handled fully transparent by Git, 235 which is backward compatible with older versions of Git. 236 237core.protectHFS:: 238 If set to true, do not allow checkout of paths that would 239 be considered equivalent to `.git` on an HFS+ filesystem. 240 Defaults to `true` on Mac OS, and `false` elsewhere. 241 242core.trustctime:: 243 If false, the ctime differences between the index and the 244 working tree are ignored; useful when the inode change time 245 is regularly modified by something outside Git (file system 246 crawlers and some backup systems). 247 See linkgit:git-update-index[1]. True by default. 248 249core.checkstat:: 250 Determines which stat fields to match between the index 251 and work tree. The user can set this to 'default' or 252 'minimal'. Default (or explicitly 'default'), is to check 253 all fields, including the sub-second part of mtime and ctime. 254 255core.quotepath:: 256 The commands that output paths (e.g. 'ls-files', 257 'diff'), when not given the `-z` option, will quote 258 "unusual" characters in the pathname by enclosing the 259 pathname in a double-quote pair and with backslashes the 260 same way strings in C source code are quoted. If this 261 variable is set to false, the bytes higher than 0x80 are 262 not quoted but output as verbatim. Note that double 263 quote, backslash and control characters are always 264 quoted without `-z` regardless of the setting of this 265 variable. 266 267core.eol:: 268 Sets the line ending type to use in the working directory for 269 files that have the `text` property set. Alternatives are 270 'lf', 'crlf' and 'native', which uses the platform's native 271 line ending. The default value is `native`. See 272 linkgit:gitattributes[5] for more information on end-of-line 273 conversion. 274 275core.safecrlf:: 276 If true, makes Git check if converting `CRLF` is reversible when 277 end-of-line conversion is active. Git will verify if a command 278 modifies a file in the work tree either directly or indirectly. 279 For example, committing a file followed by checking out the 280 same file should yield the original file in the work tree. If 281 this is not the case for the current setting of 282 `core.autocrlf`, Git will reject the file. The variable can 283 be set to "warn", in which case Git will only warn about an 284 irreversible conversion but continue the operation. 285+ 286CRLF conversion bears a slight chance of corrupting data. 287When it is enabled, Git will convert CRLF to LF during commit and LF to 288CRLF during checkout. A file that contains a mixture of LF and 289CRLF before the commit cannot be recreated by Git. For text 290files this is the right thing to do: it corrects line endings 291such that we have only LF line endings in the repository. 292But for binary files that are accidentally classified as text the 293conversion can corrupt data. 294+ 295If you recognize such corruption early you can easily fix it by 296setting the conversion type explicitly in .gitattributes. Right 297after committing you still have the original file in your work 298tree and this file is not yet corrupted. You can explicitly tell 299Git that this file is binary and Git will handle the file 300appropriately. 301+ 302Unfortunately, the desired effect of cleaning up text files with 303mixed line endings and the undesired effect of corrupting binary 304files cannot be distinguished. In both cases CRLFs are removed 305in an irreversible way. For text files this is the right thing 306to do because CRLFs are line endings, while for binary files 307converting CRLFs corrupts data. 308+ 309Note, this safety check does not mean that a checkout will generate a 310file identical to the original file for a different setting of 311`core.eol` and `core.autocrlf`, but only for the current one. For 312example, a text file with `LF` would be accepted with `core.eol=lf` 313and could later be checked out with `core.eol=crlf`, in which case the 314resulting file would contain `CRLF`, although the original file 315contained `LF`. However, in both work trees the line endings would be 316consistent, that is either all `LF` or all `CRLF`, but never mixed. A 317file with mixed line endings would be reported by the `core.safecrlf` 318mechanism. 319 320core.autocrlf:: 321 Setting this variable to "true" is almost the same as setting 322 the `text` attribute to "auto" on all files except that text 323 files are not guaranteed to be normalized: files that contain 324 `CRLF` in the repository will not be touched. Use this 325 setting if you want to have `CRLF` line endings in your 326 working directory even though the repository does not have 327 normalized line endings. This variable can be set to 'input', 328 in which case no output conversion is performed. 329 330core.symlinks:: 331 If false, symbolic links are checked out as small plain files that 332 contain the link text. linkgit:git-update-index[1] and 333 linkgit:git-add[1] will not change the recorded type to regular 334 file. Useful on filesystems like FAT that do not support 335 symbolic links. 336+ 337The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 338will probe and set core.symlinks false if appropriate when the repository 339is created. 340 341core.gitProxy:: 342 A "proxy command" to execute (as 'command host port') instead 343 of establishing direct connection to the remote server when 344 using the Git protocol for fetching. If the variable value is 345 in the "COMMAND for DOMAIN" format, the command is applied only 346 on hostnames ending with the specified domain string. This variable 347 may be set multiple times and is matched in the given order; 348 the first match wins. 349+ 350Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 351(which always applies universally, without the special "for" 352handling). 353+ 354The special string `none` can be used as the proxy command to 355specify that no proxy be used for a given domain pattern. 356This is useful for excluding servers inside a firewall from 357proxy use, while defaulting to a common proxy for external domains. 358 359core.ignoreStat:: 360 If true, commands which modify both the working tree and the index 361 will mark the updated paths with the "assume unchanged" bit in the 362 index. These marked files are then assumed to stay unchanged in the 363 working tree, until you mark them otherwise manually - Git will not 364 detect the file changes by lstat() calls. This is useful on systems 365 where those are very slow, such as Microsoft Windows. 366 See linkgit:git-update-index[1]. 367 False by default. 368 369core.preferSymlinkRefs:: 370 Instead of the default "symref" format for HEAD 371 and other symbolic reference files, use symbolic links. 372 This is sometimes needed to work with old scripts that 373 expect HEAD to be a symbolic link. 374 375core.bare:: 376 If true this repository is assumed to be 'bare' and has no 377 working directory associated with it. If this is the case a 378 number of commands that require a working directory will be 379 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 380+ 381This setting is automatically guessed by linkgit:git-clone[1] or 382linkgit:git-init[1] when the repository was created. By default a 383repository that ends in "/.git" is assumed to be not bare (bare = 384false), while all other repositories are assumed to be bare (bare 385= true). 386 387core.worktree:: 388 Set the path to the root of the working tree. 389 This can be overridden by the GIT_WORK_TREE environment 390 variable and the '--work-tree' command line option. 391 The value can be an absolute path or relative to the path to 392 the .git directory, which is either specified by --git-dir 393 or GIT_DIR, or automatically discovered. 394 If --git-dir or GIT_DIR is specified but none of 395 --work-tree, GIT_WORK_TREE and core.worktree is specified, 396 the current working directory is regarded as the top level 397 of your working tree. 398+ 399Note that this variable is honored even when set in a configuration 400file in a ".git" subdirectory of a directory and its value differs 401from the latter directory (e.g. "/path/to/.git/config" has 402core.worktree set to "/different/path"), which is most likely a 403misconfiguration. Running Git commands in the "/path/to" directory will 404still use "/different/path" as the root of the work tree and can cause 405confusion unless you know what you are doing (e.g. you are creating a 406read-only snapshot of the same index to a location different from the 407repository's usual working tree). 408 409core.logAllRefUpdates:: 410 Enable the reflog. Updates to a ref <ref> is logged to the file 411 "$GIT_DIR/logs/<ref>", by appending the new and old 412 SHA-1, the date/time and the reason of the update, but 413 only when the file exists. If this configuration 414 variable is set to true, missing "$GIT_DIR/logs/<ref>" 415 file is automatically created for branch heads (i.e. under 416 refs/heads/), remote refs (i.e. under refs/remotes/), 417 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 418+ 419This information can be used to determine what commit 420was the tip of a branch "2 days ago". 421+ 422This value is true by default in a repository that has 423a working directory associated with it, and false by 424default in a bare repository. 425 426core.repositoryFormatVersion:: 427 Internal variable identifying the repository format and layout 428 version. 429 430core.sharedRepository:: 431 When 'group' (or 'true'), the repository is made shareable between 432 several users in a group (making sure all the files and objects are 433 group-writable). When 'all' (or 'world' or 'everybody'), the 434 repository will be readable by all users, additionally to being 435 group-shareable. When 'umask' (or 'false'), Git will use permissions 436 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 437 files in the repository will have this mode value. '0xxx' will override 438 user's umask value (whereas the other options will only override 439 requested parts of the user's umask value). Examples: '0660' will make 440 the repo read/write-able for the owner and group, but inaccessible to 441 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 442 repository that is group-readable but not group-writable. 443 See linkgit:git-init[1]. False by default. 444 445core.warnAmbiguousRefs:: 446 If true, Git will warn you if the ref name you passed it is ambiguous 447 and might match multiple refs in the repository. True by default. 448 449core.compression:: 450 An integer -1..9, indicating a default compression level. 451 -1 is the zlib default. 0 means no compression, 452 and 1..9 are various speed/size tradeoffs, 9 being slowest. 453 If set, this provides a default to other compression variables, 454 such as 'core.loosecompression' and 'pack.compression'. 455 456core.loosecompression:: 457 An integer -1..9, indicating the compression level for objects that 458 are not in a pack file. -1 is the zlib default. 0 means no 459 compression, and 1..9 are various speed/size tradeoffs, 9 being 460 slowest. If not set, defaults to core.compression. If that is 461 not set, defaults to 1 (best speed). 462 463core.packedGitWindowSize:: 464 Number of bytes of a pack file to map into memory in a 465 single mapping operation. Larger window sizes may allow 466 your system to process a smaller number of large pack files 467 more quickly. Smaller window sizes will negatively affect 468 performance due to increased calls to the operating system's 469 memory manager, but may improve performance when accessing 470 a large number of large pack files. 471+ 472Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 473MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 474be reasonable for all users/operating systems. You probably do 475not need to adjust this value. 476+ 477Common unit suffixes of 'k', 'm', or 'g' are supported. 478 479core.packedGitLimit:: 480 Maximum number of bytes to map simultaneously into memory 481 from pack files. If Git needs to access more than this many 482 bytes at once to complete an operation it will unmap existing 483 regions to reclaim virtual address space within the process. 484+ 485Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 486This should be reasonable for all users/operating systems, except on 487the largest projects. You probably do not need to adjust this value. 488+ 489Common unit suffixes of 'k', 'm', or 'g' are supported. 490 491core.deltaBaseCacheLimit:: 492 Maximum number of bytes to reserve for caching base objects 493 that may be referenced by multiple deltified objects. By storing the 494 entire decompressed base objects in a cache Git is able 495 to avoid unpacking and decompressing frequently used base 496 objects multiple times. 497+ 498Default is 16 MiB on all platforms. This should be reasonable 499for all users/operating systems, except on the largest projects. 500You probably do not need to adjust this value. 501+ 502Common unit suffixes of 'k', 'm', or 'g' are supported. 503 504core.bigFileThreshold:: 505 Files larger than this size are stored deflated, without 506 attempting delta compression. Storing large files without 507 delta compression avoids excessive memory usage, at the 508 slight expense of increased disk usage. 509+ 510Default is 512 MiB on all platforms. This should be reasonable 511for most projects as source code and other text files can still 512be delta compressed, but larger binary media files won't be. 513+ 514Common unit suffixes of 'k', 'm', or 'g' are supported. 515 516core.excludesfile:: 517 In addition to '.gitignore' (per-directory) and 518 '.git/info/exclude', Git looks into this file for patterns 519 of files which are not meant to be tracked. "`~/`" is expanded 520 to the value of `$HOME` and "`~user/`" to the specified user's 521 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 522 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 523 is used instead. See linkgit:gitignore[5]. 524 525core.askpass:: 526 Some commands (e.g. svn and http interfaces) that interactively 527 ask for a password can be told to use an external program given 528 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 529 environment variable. If not set, fall back to the value of the 530 'SSH_ASKPASS' environment variable or, failing that, a simple password 531 prompt. The external program shall be given a suitable prompt as 532 command line argument and write the password on its STDOUT. 533 534core.attributesfile:: 535 In addition to '.gitattributes' (per-directory) and 536 '.git/info/attributes', Git looks into this file for attributes 537 (see linkgit:gitattributes[5]). Path expansions are made the same 538 way as for `core.excludesfile`. Its default value is 539 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 540 set or empty, $HOME/.config/git/attributes is used instead. 541 542core.editor:: 543 Commands such as `commit` and `tag` that lets you edit 544 messages by launching an editor uses the value of this 545 variable when it is set, and the environment variable 546 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 547 548core.commentchar:: 549 Commands such as `commit` and `tag` that lets you edit 550 messages consider a line that begins with this character 551 commented, and removes them after the editor returns 552 (default '#'). 553 554sequence.editor:: 555 Text editor used by `git rebase -i` for editing the rebase instruction file. 556 The value is meant to be interpreted by the shell when it is used. 557 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 558 When not configured the default commit message editor is used instead. 559 560core.pager:: 561 Text viewer for use by Git commands (e.g., 'less'). The value 562 is meant to be interpreted by the shell. The order of preference 563 is the `$GIT_PAGER` environment variable, then `core.pager` 564 configuration, then `$PAGER`, and then the default chosen at 565 compile time (usually 'less'). 566+ 567When the `LESS` environment variable is unset, Git sets it to `FRSX` 568(if `LESS` environment variable is set, Git does not change it at 569all). If you want to selectively override Git's default setting 570for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 571be passed to the shell by Git, which will translate the final 572command to `LESS=FRSX less -+S`. The environment tells the command 573to set the `S` option to chop long lines but the command line 574resets it to the default to fold long lines. 575 576core.whitespace:: 577 A comma separated list of common whitespace problems to 578 notice. 'git diff' will use `color.diff.whitespace` to 579 highlight them, and 'git apply --whitespace=error' will 580 consider them as errors. You can prefix `-` to disable 581 any of them (e.g. `-trailing-space`): 582+ 583* `blank-at-eol` treats trailing whitespaces at the end of the line 584 as an error (enabled by default). 585* `space-before-tab` treats a space character that appears immediately 586 before a tab character in the initial indent part of the line as an 587 error (enabled by default). 588* `indent-with-non-tab` treats a line that is indented with space 589 characters instead of the equivalent tabs as an error (not enabled by 590 default). 591* `tab-in-indent` treats a tab character in the initial indent part of 592 the line as an error (not enabled by default). 593* `blank-at-eof` treats blank lines added at the end of file as an error 594 (enabled by default). 595* `trailing-space` is a short-hand to cover both `blank-at-eol` and 596 `blank-at-eof`. 597* `cr-at-eol` treats a carriage-return at the end of line as 598 part of the line terminator, i.e. with it, `trailing-space` 599 does not trigger if the character before such a carriage-return 600 is not a whitespace (not enabled by default). 601* `tabwidth=<n>` tells how many character positions a tab occupies; this 602 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 603 errors. The default tab width is 8. Allowed values are 1 to 63. 604 605core.fsyncobjectfiles:: 606 This boolean will enable 'fsync()' when writing object files. 607+ 608This is a total waste of time and effort on a filesystem that orders 609data writes properly, but can be useful for filesystems that do not use 610journalling (traditional UNIX filesystems) or that only journal metadata 611and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 612 613core.preloadindex:: 614 Enable parallel index preload for operations like 'git diff' 615+ 616This can speed up operations like 'git diff' and 'git status' especially 617on filesystems like NFS that have weak caching semantics and thus 618relatively high IO latencies. With this set to 'true', Git will do the 619index comparison to the filesystem data in parallel, allowing 620overlapping IO's. 621 622core.createObject:: 623 You can set this to 'link', in which case a hardlink followed by 624 a delete of the source are used to make sure that object creation 625 will not overwrite existing objects. 626+ 627On some file system/operating system combinations, this is unreliable. 628Set this config setting to 'rename' there; However, This will remove the 629check that makes sure that existing object files will not get overwritten. 630 631core.notesRef:: 632 When showing commit messages, also show notes which are stored in 633 the given ref. The ref must be fully qualified. If the given 634 ref does not exist, it is not an error but means that no 635 notes should be printed. 636+ 637This setting defaults to "refs/notes/commits", and it can be overridden by 638the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 639 640core.sparseCheckout:: 641 Enable "sparse checkout" feature. See section "Sparse checkout" in 642 linkgit:git-read-tree[1] for more information. 643 644core.abbrev:: 645 Set the length object names are abbreviated to. If unspecified, 646 many commands abbreviate to 7 hexdigits, which may not be enough 647 for abbreviated object names to stay unique for sufficiently long 648 time. 649 650add.ignore-errors:: 651add.ignoreErrors:: 652 Tells 'git add' to continue adding files when some files cannot be 653 added due to indexing errors. Equivalent to the '--ignore-errors' 654 option of linkgit:git-add[1]. Older versions of Git accept only 655 `add.ignore-errors`, which does not follow the usual naming 656 convention for configuration variables. Newer versions of Git 657 honor `add.ignoreErrors` as well. 658 659alias.*:: 660 Command aliases for the linkgit:git[1] command wrapper - e.g. 661 after defining "alias.last = cat-file commit HEAD", the invocation 662 "git last" is equivalent to "git cat-file commit HEAD". To avoid 663 confusion and troubles with script usage, aliases that 664 hide existing Git commands are ignored. Arguments are split by 665 spaces, the usual shell quoting and escaping is supported. 666 quote pair and a backslash can be used to quote them. 667+ 668If the alias expansion is prefixed with an exclamation point, 669it will be treated as a shell command. For example, defining 670"alias.new = !gitk --all --not ORIG_HEAD", the invocation 671"git new" is equivalent to running the shell command 672"gitk --all --not ORIG_HEAD". Note that shell commands will be 673executed from the top-level directory of a repository, which may 674not necessarily be the current directory. 675'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 676from the original current directory. See linkgit:git-rev-parse[1]. 677 678am.keepcr:: 679 If true, git-am will call git-mailsplit for patches in mbox format 680 with parameter '--keep-cr'. In this case git-mailsplit will 681 not remove `\r` from lines ending with `\r\n`. Can be overridden 682 by giving '--no-keep-cr' from the command line. 683 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 684 685apply.ignorewhitespace:: 686 When set to 'change', tells 'git apply' to ignore changes in 687 whitespace, in the same way as the '--ignore-space-change' 688 option. 689 When set to one of: no, none, never, false tells 'git apply' to 690 respect all whitespace differences. 691 See linkgit:git-apply[1]. 692 693apply.whitespace:: 694 Tells 'git apply' how to handle whitespaces, in the same way 695 as the '--whitespace' option. See linkgit:git-apply[1]. 696 697branch.autosetupmerge:: 698 Tells 'git branch' and 'git checkout' to set up new branches 699 so that linkgit:git-pull[1] will appropriately merge from the 700 starting point branch. Note that even if this option is not set, 701 this behavior can be chosen per-branch using the `--track` 702 and `--no-track` options. The valid settings are: `false` -- no 703 automatic setup is done; `true` -- automatic setup is done when the 704 starting point is a remote-tracking branch; `always` -- 705 automatic setup is done when the starting point is either a 706 local branch or remote-tracking 707 branch. This option defaults to true. 708 709branch.autosetuprebase:: 710 When a new branch is created with 'git branch' or 'git checkout' 711 that tracks another branch, this variable tells Git to set 712 up pull to rebase instead of merge (see "branch.<name>.rebase"). 713 When `never`, rebase is never automatically set to true. 714 When `local`, rebase is set to true for tracked branches of 715 other local branches. 716 When `remote`, rebase is set to true for tracked branches of 717 remote-tracking branches. 718 When `always`, rebase will be set to true for all tracking 719 branches. 720 See "branch.autosetupmerge" for details on how to set up a 721 branch to track another branch. 722 This option defaults to never. 723 724branch.<name>.remote:: 725 When on branch <name>, it tells 'git fetch' and 'git push' 726 which remote to fetch from/push to. The remote to push to 727 may be overridden with `remote.pushdefault` (for all branches). 728 The remote to push to, for the current branch, may be further 729 overridden by `branch.<name>.pushremote`. If no remote is 730 configured, or if you are not on any branch, it defaults to 731 `origin` for fetching and `remote.pushdefault` for pushing. 732 Additionally, `.` (a period) is the current local repository 733 (a dot-repository), see `branch.<name>.merge`'s final note below. 734 735branch.<name>.pushremote:: 736 When on branch <name>, it overrides `branch.<name>.remote` for 737 pushing. It also overrides `remote.pushdefault` for pushing 738 from branch <name>. When you pull from one place (e.g. your 739 upstream) and push to another place (e.g. your own publishing 740 repository), you would want to set `remote.pushdefault` to 741 specify the remote to push to for all branches, and use this 742 option to override it for a specific branch. 743 744branch.<name>.merge:: 745 Defines, together with branch.<name>.remote, the upstream branch 746 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 747 branch to merge and can also affect 'git push' (see push.default). 748 When in branch <name>, it tells 'git fetch' the default 749 refspec to be marked for merging in FETCH_HEAD. The value is 750 handled like the remote part of a refspec, and must match a 751 ref which is fetched from the remote given by 752 "branch.<name>.remote". 753 The merge information is used by 'git pull' (which at first calls 754 'git fetch') to lookup the default branch for merging. Without 755 this option, 'git pull' defaults to merge the first refspec fetched. 756 Specify multiple values to get an octopus merge. 757 If you wish to setup 'git pull' so that it merges into <name> from 758 another branch in the local repository, you can point 759 branch.<name>.merge to the desired branch, and use the relative path 760 setting `.` (a period) for branch.<name>.remote. 761 762branch.<name>.mergeoptions:: 763 Sets default options for merging into branch <name>. The syntax and 764 supported options are the same as those of linkgit:git-merge[1], but 765 option values containing whitespace characters are currently not 766 supported. 767 768branch.<name>.rebase:: 769 When true, rebase the branch <name> on top of the fetched branch, 770 instead of merging the default branch from the default remote when 771 "git pull" is run. See "pull.rebase" for doing this in a non 772 branch-specific manner. 773+ 774 When preserve, also pass `--preserve-merges` along to 'git rebase' 775 so that locally committed merge commits will not be flattened 776 by running 'git pull'. 777+ 778*NOTE*: this is a possibly dangerous operation; do *not* use 779it unless you understand the implications (see linkgit:git-rebase[1] 780for details). 781 782branch.<name>.description:: 783 Branch description, can be edited with 784 `git branch --edit-description`. Branch description is 785 automatically added in the format-patch cover letter or 786 request-pull summary. 787 788browser.<tool>.cmd:: 789 Specify the command to invoke the specified browser. The 790 specified command is evaluated in shell with the URLs passed 791 as arguments. (See linkgit:git-web{litdd}browse[1].) 792 793browser.<tool>.path:: 794 Override the path for the given tool that may be used to 795 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 796 working repository in gitweb (see linkgit:git-instaweb[1]). 797 798clean.requireForce:: 799 A boolean to make git-clean do nothing unless given -f, 800 -i or -n. Defaults to true. 801 802color.branch:: 803 A boolean to enable/disable color in the output of 804 linkgit:git-branch[1]. May be set to `always`, 805 `false` (or `never`) or `auto` (or `true`), in which case colors are used 806 only when the output is to a terminal. Defaults to false. 807 808color.branch.<slot>:: 809 Use customized color for branch coloration. `<slot>` is one of 810 `current` (the current branch), `local` (a local branch), 811 `remote` (a remote-tracking branch in refs/remotes/), 812 `upstream` (upstream tracking branch), `plain` (other 813 refs). 814+ 815The value for these configuration variables is a list of colors (at most 816two) and attributes (at most one), separated by spaces. The colors 817accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 818`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 819`blink` and `reverse`. The first color given is the foreground; the 820second is the background. The position of the attribute, if any, 821doesn't matter. 822 823color.diff:: 824 Whether to use ANSI escape sequences to add color to patches. 825 If this is set to `always`, linkgit:git-diff[1], 826 linkgit:git-log[1], and linkgit:git-show[1] will use color 827 for all patches. If it is set to `true` or `auto`, those 828 commands will only use color when output is to the terminal. 829 Defaults to false. 830+ 831This does not affect linkgit:git-format-patch[1] nor the 832'git-diff-{asterisk}' plumbing commands. Can be overridden on the 833command line with the `--color[=<when>]` option. 834 835color.diff.<slot>:: 836 Use customized color for diff colorization. `<slot>` specifies 837 which part of the patch to use the specified color, and is one 838 of `plain` (context text), `meta` (metainformation), `frag` 839 (hunk header), 'func' (function in hunk header), `old` (removed lines), 840 `new` (added lines), `commit` (commit headers), or `whitespace` 841 (highlighting whitespace errors). The values of these variables may be 842 specified as in color.branch.<slot>. 843 844color.decorate.<slot>:: 845 Use customized color for 'git log --decorate' output. `<slot>` is one 846 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 847 branches, remote-tracking branches, tags, stash and HEAD, respectively. 848 849color.grep:: 850 When set to `always`, always highlight matches. When `false` (or 851 `never`), never. When set to `true` or `auto`, use color only 852 when the output is written to the terminal. Defaults to `false`. 853 854color.grep.<slot>:: 855 Use customized color for grep colorization. `<slot>` specifies which 856 part of the line to use the specified color, and is one of 857+ 858-- 859`context`;; 860 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 861`filename`;; 862 filename prefix (when not using `-h`) 863`function`;; 864 function name lines (when using `-p`) 865`linenumber`;; 866 line number prefix (when using `-n`) 867`match`;; 868 matching text 869`selected`;; 870 non-matching text in selected lines 871`separator`;; 872 separators between fields on a line (`:`, `-`, and `=`) 873 and between hunks (`--`) 874-- 875+ 876The values of these variables may be specified as in color.branch.<slot>. 877 878color.interactive:: 879 When set to `always`, always use colors for interactive prompts 880 and displays (such as those used by "git-add --interactive" and 881 "git-clean --interactive"). When false (or `never`), never. 882 When set to `true` or `auto`, use colors only when the output is 883 to the terminal. Defaults to false. 884 885color.interactive.<slot>:: 886 Use customized color for 'git add --interactive' and 'git clean 887 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 888 or `error`, for four distinct types of normal output from 889 interactive commands. The values of these variables may be 890 specified as in color.branch.<slot>. 891 892color.pager:: 893 A boolean to enable/disable colored output when the pager is in 894 use (default is true). 895 896color.showbranch:: 897 A boolean to enable/disable color in the output of 898 linkgit:git-show-branch[1]. May be set to `always`, 899 `false` (or `never`) or `auto` (or `true`), in which case colors are used 900 only when the output is to a terminal. Defaults to false. 901 902color.status:: 903 A boolean to enable/disable color in the output of 904 linkgit:git-status[1]. May be set to `always`, 905 `false` (or `never`) or `auto` (or `true`), in which case colors are used 906 only when the output is to a terminal. Defaults to false. 907 908color.status.<slot>:: 909 Use customized color for status colorization. `<slot>` is 910 one of `header` (the header text of the status message), 911 `added` or `updated` (files which are added but not committed), 912 `changed` (files which are changed but not added in the index), 913 `untracked` (files which are not tracked by Git), 914 `branch` (the current branch), or 915 `nobranch` (the color the 'no branch' warning is shown in, defaulting 916 to red). The values of these variables may be specified as in 917 color.branch.<slot>. 918 919color.ui:: 920 This variable determines the default value for variables such 921 as `color.diff` and `color.grep` that control the use of color 922 per command family. Its scope will expand as more commands learn 923 configuration to set a default for the `--color` option. Set it 924 to `false` or `never` if you prefer Git commands not to use 925 color unless enabled explicitly with some other configuration 926 or the `--color` option. Set it to `always` if you want all 927 output not intended for machine consumption to use color, to 928 `true` or `auto` (this is the default since Git 1.8.4) if you 929 want such output to use color when written to the terminal. 930 931column.ui:: 932 Specify whether supported commands should output in columns. 933 This variable consists of a list of tokens separated by spaces 934 or commas: 935+ 936These options control when the feature should be enabled 937(defaults to 'never'): 938+ 939-- 940`always`;; 941 always show in columns 942`never`;; 943 never show in columns 944`auto`;; 945 show in columns if the output is to the terminal 946-- 947+ 948These options control layout (defaults to 'column'). Setting any 949of these implies 'always' if none of 'always', 'never', or 'auto' are 950specified. 951+ 952-- 953`column`;; 954 fill columns before rows 955`row`;; 956 fill rows before columns 957`plain`;; 958 show in one column 959-- 960+ 961Finally, these options can be combined with a layout option (defaults 962to 'nodense'): 963+ 964-- 965`dense`;; 966 make unequal size columns to utilize more space 967`nodense`;; 968 make equal size columns 969-- 970 971column.branch:: 972 Specify whether to output branch listing in `git branch` in columns. 973 See `column.ui` for details. 974 975column.clean:: 976 Specify the layout when list items in `git clean -i`, which always 977 shows files and directories in columns. See `column.ui` for details. 978 979column.status:: 980 Specify whether to output untracked files in `git status` in columns. 981 See `column.ui` for details. 982 983column.tag:: 984 Specify whether to output tag listing in `git tag` in columns. 985 See `column.ui` for details. 986 987commit.cleanup:: 988 This setting overrides the default of the `--cleanup` option in 989 `git commit`. See linkgit:git-commit[1] for details. Changing the 990 default can be useful when you always want to keep lines that begin 991 with comment character `#` in your log message, in which case you 992 would do `git config commit.cleanup whitespace` (note that you will 993 have to remove the help lines that begin with `#` in the commit log 994 template yourself, if you do this). 995 996commit.status:: 997 A boolean to enable/disable inclusion of status information in the 998 commit message template when using an editor to prepare the commit 999 message. Defaults to true.10001001commit.template::1002 Specify a file to use as the template for new commit messages.1003 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1004 specified user's home directory.10051006credential.helper::1007 Specify an external helper to be called when a username or1008 password credential is needed; the helper may consult external1009 storage to avoid prompting the user for the credentials. See1010 linkgit:gitcredentials[7] for details.10111012credential.useHttpPath::1013 When acquiring credentials, consider the "path" component of an http1014 or https URL to be important. Defaults to false. See1015 linkgit:gitcredentials[7] for more information.10161017credential.username::1018 If no username is set for a network authentication, use this username1019 by default. See credential.<context>.* below, and1020 linkgit:gitcredentials[7].10211022credential.<url>.*::1023 Any of the credential.* options above can be applied selectively to1024 some credentials. For example "credential.https://example.com.username"1025 would set the default username only for https connections to1026 example.com. See linkgit:gitcredentials[7] for details on how URLs are1027 matched.10281029include::diff-config.txt[]10301031difftool.<tool>.path::1032 Override the path for the given tool. This is useful in case1033 your tool is not in the PATH.10341035difftool.<tool>.cmd::1036 Specify the command to invoke the specified diff tool.1037 The specified command is evaluated in shell with the following1038 variables available: 'LOCAL' is set to the name of the temporary1039 file containing the contents of the diff pre-image and 'REMOTE'1040 is set to the name of the temporary file containing the contents1041 of the diff post-image.10421043difftool.prompt::1044 Prompt before each invocation of the diff tool.10451046fetch.recurseSubmodules::1047 This option can be either set to a boolean value or to 'on-demand'.1048 Setting it to a boolean changes the behavior of fetch and pull to1049 unconditionally recurse into submodules when set to true or to not1050 recurse at all when set to false. When set to 'on-demand' (the default1051 value), fetch and pull will only recurse into a populated submodule1052 when its superproject retrieves a commit that updates the submodule's1053 reference.10541055fetch.fsckObjects::1056 If it is set to true, git-fetch-pack will check all fetched1057 objects. It will abort in the case of a malformed object or a1058 broken link. The result of an abort are only dangling objects.1059 Defaults to false. If not set, the value of `transfer.fsckObjects`1060 is used instead.10611062fetch.unpackLimit::1063 If the number of objects fetched over the Git native1064 transfer is below this1065 limit, then the objects will be unpacked into loose object1066 files. However if the number of received objects equals or1067 exceeds this limit then the received pack will be stored as1068 a pack, after adding any missing delta bases. Storing the1069 pack from a push can make the push operation complete faster,1070 especially on slow filesystems. If not set, the value of1071 `transfer.unpackLimit` is used instead.10721073fetch.prune::1074 If true, fetch will automatically behave as if the `--prune`1075 option was given on the command line. See also `remote.<name>.prune`.10761077format.attach::1078 Enable multipart/mixed attachments as the default for1079 'format-patch'. The value can also be a double quoted string1080 which will enable attachments as the default and set the1081 value as the boundary. See the --attach option in1082 linkgit:git-format-patch[1].10831084format.numbered::1085 A boolean which can enable or disable sequence numbers in patch1086 subjects. It defaults to "auto" which enables it only if there1087 is more than one patch. It can be enabled or disabled for all1088 messages by setting it to "true" or "false". See --numbered1089 option in linkgit:git-format-patch[1].10901091format.headers::1092 Additional email headers to include in a patch to be submitted1093 by mail. See linkgit:git-format-patch[1].10941095format.to::1096format.cc::1097 Additional recipients to include in a patch to be submitted1098 by mail. See the --to and --cc options in1099 linkgit:git-format-patch[1].11001101format.subjectprefix::1102 The default for format-patch is to output files with the '[PATCH]'1103 subject prefix. Use this variable to change that prefix.11041105format.signature::1106 The default for format-patch is to output a signature containing1107 the Git version number. Use this variable to change that default.1108 Set this variable to the empty string ("") to suppress1109 signature generation.11101111format.suffix::1112 The default for format-patch is to output files with the suffix1113 `.patch`. Use this variable to change that suffix (make sure to1114 include the dot if you want it).11151116format.pretty::1117 The default pretty format for log/show/whatchanged command,1118 See linkgit:git-log[1], linkgit:git-show[1],1119 linkgit:git-whatchanged[1].11201121format.thread::1122 The default threading style for 'git format-patch'. Can be1123 a boolean value, or `shallow` or `deep`. `shallow` threading1124 makes every mail a reply to the head of the series,1125 where the head is chosen from the cover letter, the1126 `--in-reply-to`, and the first patch mail, in this order.1127 `deep` threading makes every mail a reply to the previous one.1128 A true boolean value is the same as `shallow`, and a false1129 value disables threading.11301131format.signoff::1132 A boolean value which lets you enable the `-s/--signoff` option of1133 format-patch by default. *Note:* Adding the Signed-off-by: line to a1134 patch should be a conscious act and means that you certify you have1135 the rights to submit this work under the same open source license.1136 Please see the 'SubmittingPatches' document for further discussion.11371138format.coverLetter::1139 A boolean that controls whether to generate a cover-letter when1140 format-patch is invoked, but in addition can be set to "auto", to1141 generate a cover-letter only when there's more than one patch.11421143filter.<driver>.clean::1144 The command which is used to convert the content of a worktree1145 file to a blob upon checkin. See linkgit:gitattributes[5] for1146 details.11471148filter.<driver>.smudge::1149 The command which is used to convert the content of a blob1150 object to a worktree file upon checkout. See1151 linkgit:gitattributes[5] for details.11521153gc.aggressiveWindow::1154 The window size parameter used in the delta compression1155 algorithm used by 'git gc --aggressive'. This defaults1156 to 250.11571158gc.auto::1159 When there are approximately more than this many loose1160 objects in the repository, `git gc --auto` will pack them.1161 Some Porcelain commands use this command to perform a1162 light-weight garbage collection from time to time. The1163 default value is 6700. Setting this to 0 disables it.11641165gc.autopacklimit::1166 When there are more than this many packs that are not1167 marked with `*.keep` file in the repository, `git gc1168 --auto` consolidates them into one larger pack. The1169 default value is 50. Setting this to 0 disables it.11701171gc.packrefs::1172 Running `git pack-refs` in a repository renders it1173 unclonable by Git versions prior to 1.5.1.2 over dumb1174 transports such as HTTP. This variable determines whether1175 'git gc' runs `git pack-refs`. This can be set to `notbare`1176 to enable it within all non-bare repos or it can be set to a1177 boolean value. The default is `true`.11781179gc.pruneexpire::1180 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1181 Override the grace period with this config variable. The value1182 "now" may be used to disable this grace period and always prune1183 unreachable objects immediately.11841185gc.reflogexpire::1186gc.<pattern>.reflogexpire::1187 'git reflog expire' removes reflog entries older than1188 this time; defaults to 90 days. With "<pattern>" (e.g.1189 "refs/stash") in the middle the setting applies only to1190 the refs that match the <pattern>.11911192gc.reflogexpireunreachable::1193gc.<ref>.reflogexpireunreachable::1194 'git reflog expire' removes reflog entries older than1195 this time and are not reachable from the current tip;1196 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1197 in the middle, the setting applies only to the refs that1198 match the <pattern>.11991200gc.rerereresolved::1201 Records of conflicted merge you resolved earlier are1202 kept for this many days when 'git rerere gc' is run.1203 The default is 60 days. See linkgit:git-rerere[1].12041205gc.rerereunresolved::1206 Records of conflicted merge you have not resolved are1207 kept for this many days when 'git rerere gc' is run.1208 The default is 15 days. See linkgit:git-rerere[1].12091210gitcvs.commitmsgannotation::1211 Append this string to each commit message. Set to empty string1212 to disable this feature. Defaults to "via git-CVS emulator".12131214gitcvs.enabled::1215 Whether the CVS server interface is enabled for this repository.1216 See linkgit:git-cvsserver[1].12171218gitcvs.logfile::1219 Path to a log file where the CVS server interface well... logs1220 various stuff. See linkgit:git-cvsserver[1].12211222gitcvs.usecrlfattr::1223 If true, the server will look up the end-of-line conversion1224 attributes for files to determine the '-k' modes to use. If1225 the attributes force Git to treat a file as text,1226 the '-k' mode will be left blank so CVS clients will1227 treat it as text. If they suppress text conversion, the file1228 will be set with '-kb' mode, which suppresses any newline munging1229 the client might otherwise do. If the attributes do not allow1230 the file type to be determined, then 'gitcvs.allbinary' is1231 used. See linkgit:gitattributes[5].12321233gitcvs.allbinary::1234 This is used if 'gitcvs.usecrlfattr' does not resolve1235 the correct '-kb' mode to use. If true, all1236 unresolved files are sent to the client in1237 mode '-kb'. This causes the client to treat them1238 as binary files, which suppresses any newline munging it1239 otherwise might do. Alternatively, if it is set to "guess",1240 then the contents of the file are examined to decide if1241 it is binary, similar to 'core.autocrlf'.12421243gitcvs.dbname::1244 Database used by git-cvsserver to cache revision information1245 derived from the Git repository. The exact meaning depends on the1246 used database driver, for SQLite (which is the default driver) this1247 is a filename. Supports variable substitution (see1248 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1249 Default: '%Ggitcvs.%m.sqlite'12501251gitcvs.dbdriver::1252 Used Perl DBI driver. You can specify any available driver1253 for this here, but it might not work. git-cvsserver is tested1254 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1255 reported *not* to work with 'DBD::mysql'. Experimental feature.1256 May not contain double colons (`:`). Default: 'SQLite'.1257 See linkgit:git-cvsserver[1].12581259gitcvs.dbuser, gitcvs.dbpass::1260 Database user and password. Only useful if setting 'gitcvs.dbdriver',1261 since SQLite has no concept of database users and/or passwords.1262 'gitcvs.dbuser' supports variable substitution (see1263 linkgit:git-cvsserver[1] for details).12641265gitcvs.dbTableNamePrefix::1266 Database table name prefix. Prepended to the names of any1267 database tables used, allowing a single database to be used1268 for several repositories. Supports variable substitution (see1269 linkgit:git-cvsserver[1] for details). Any non-alphabetic1270 characters will be replaced with underscores.12711272All gitcvs variables except for 'gitcvs.usecrlfattr' and1273'gitcvs.allbinary' can also be specified as1274'gitcvs.<access_method>.<varname>' (where 'access_method'1275is one of "ext" and "pserver") to make them apply only for the given1276access method.12771278gitweb.category::1279gitweb.description::1280gitweb.owner::1281gitweb.url::1282 See linkgit:gitweb[1] for description.12831284gitweb.avatar::1285gitweb.blame::1286gitweb.grep::1287gitweb.highlight::1288gitweb.patches::1289gitweb.pickaxe::1290gitweb.remote_heads::1291gitweb.showsizes::1292gitweb.snapshot::1293 See linkgit:gitweb.conf[5] for description.12941295grep.lineNumber::1296 If set to true, enable '-n' option by default.12971298grep.patternType::1299 Set the default matching behavior. Using a value of 'basic', 'extended',1300 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1301 '--fixed-strings', or '--perl-regexp' option accordingly, while the1302 value 'default' will return to the default matching behavior.13031304grep.extendedRegexp::1305 If set to true, enable '--extended-regexp' option by default. This1306 option is ignored when the 'grep.patternType' option is set to a value1307 other than 'default'.13081309gpg.program::1310 Use this custom program instead of "gpg" found on $PATH when1311 making or verifying a PGP signature. The program must support the1312 same command line interface as GPG, namely, to verify a detached1313 signature, "gpg --verify $file - <$signature" is run, and the1314 program is expected to signal a good signature by exiting with1315 code 0, and to generate an ascii-armored detached signature, the1316 standard input of "gpg -bsau $key" is fed with the contents to be1317 signed, and the program is expected to send the result to its1318 standard output.13191320gui.commitmsgwidth::1321 Defines how wide the commit message window is in the1322 linkgit:git-gui[1]. "75" is the default.13231324gui.diffcontext::1325 Specifies how many context lines should be used in calls to diff1326 made by the linkgit:git-gui[1]. The default is "5".13271328gui.encoding::1329 Specifies the default encoding to use for displaying of1330 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1331 It can be overridden by setting the 'encoding' attribute1332 for relevant files (see linkgit:gitattributes[5]).1333 If this option is not set, the tools default to the1334 locale encoding.13351336gui.matchtrackingbranch::1337 Determines if new branches created with linkgit:git-gui[1] should1338 default to tracking remote branches with matching names or1339 not. Default: "false".13401341gui.newbranchtemplate::1342 Is used as suggested name when creating new branches using the1343 linkgit:git-gui[1].13441345gui.pruneduringfetch::1346 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1347 performing a fetch. The default value is "false".13481349gui.trustmtime::1350 Determines if linkgit:git-gui[1] should trust the file modification1351 timestamp or not. By default the timestamps are not trusted.13521353gui.spellingdictionary::1354 Specifies the dictionary used for spell checking commit messages in1355 the linkgit:git-gui[1]. When set to "none" spell checking is turned1356 off.13571358gui.fastcopyblame::1359 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1360 location detection. It makes blame significantly faster on huge1361 repositories at the expense of less thorough copy detection.13621363gui.copyblamethreshold::1364 Specifies the threshold to use in 'git gui blame' original location1365 detection, measured in alphanumeric characters. See the1366 linkgit:git-blame[1] manual for more information on copy detection.13671368gui.blamehistoryctx::1369 Specifies the radius of history context in days to show in1370 linkgit:gitk[1] for the selected commit, when the `Show History1371 Context` menu item is invoked from 'git gui blame'. If this1372 variable is set to zero, the whole history is shown.13731374guitool.<name>.cmd::1375 Specifies the shell command line to execute when the corresponding item1376 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1377 mandatory for every tool. The command is executed from the root of1378 the working directory, and in the environment it receives the name of1379 the tool as 'GIT_GUITOOL', the name of the currently selected file as1380 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1381 the head is detached, 'CUR_BRANCH' is empty).13821383guitool.<name>.needsfile::1384 Run the tool only if a diff is selected in the GUI. It guarantees1385 that 'FILENAME' is not empty.13861387guitool.<name>.noconsole::1388 Run the command silently, without creating a window to display its1389 output.13901391guitool.<name>.norescan::1392 Don't rescan the working directory for changes after the tool1393 finishes execution.13941395guitool.<name>.confirm::1396 Show a confirmation dialog before actually running the tool.13971398guitool.<name>.argprompt::1399 Request a string argument from the user, and pass it to the tool1400 through the 'ARGS' environment variable. Since requesting an1401 argument implies confirmation, the 'confirm' option has no effect1402 if this is enabled. If the option is set to 'true', 'yes', or '1',1403 the dialog uses a built-in generic prompt; otherwise the exact1404 value of the variable is used.14051406guitool.<name>.revprompt::1407 Request a single valid revision from the user, and set the1408 'REVISION' environment variable. In other aspects this option1409 is similar to 'argprompt', and can be used together with it.14101411guitool.<name>.revunmerged::1412 Show only unmerged branches in the 'revprompt' subdialog.1413 This is useful for tools similar to merge or rebase, but not1414 for things like checkout or reset.14151416guitool.<name>.title::1417 Specifies the title to use for the prompt dialog. The default1418 is the tool name.14191420guitool.<name>.prompt::1421 Specifies the general prompt string to display at the top of1422 the dialog, before subsections for 'argprompt' and 'revprompt'.1423 The default value includes the actual command.14241425help.browser::1426 Specify the browser that will be used to display help in the1427 'web' format. See linkgit:git-help[1].14281429help.format::1430 Override the default help format used by linkgit:git-help[1].1431 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1432 the default. 'web' and 'html' are the same.14331434help.autocorrect::1435 Automatically correct and execute mistyped commands after1436 waiting for the given number of deciseconds (0.1 sec). If more1437 than one command can be deduced from the entered text, nothing1438 will be executed. If the value of this option is negative,1439 the corrected command will be executed immediately. If the1440 value is 0 - the command will be just shown but not executed.1441 This is the default.14421443help.htmlpath::1444 Specify the path where the HTML documentation resides. File system paths1445 and URLs are supported. HTML pages will be prefixed with this path when1446 help is displayed in the 'web' format. This defaults to the documentation1447 path of your Git installation.14481449http.proxy::1450 Override the HTTP proxy, normally configured using the 'http_proxy',1451 'https_proxy', and 'all_proxy' environment variables (see1452 `curl(1)`). This can be overridden on a per-remote basis; see1453 remote.<name>.proxy14541455http.cookiefile::1456 File containing previously stored cookie lines which should be used1457 in the Git http session, if they match the server. The file format1458 of the file to read cookies from should be plain HTTP headers or1459 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1460 NOTE that the file specified with http.cookiefile is only used as1461 input unless http.saveCookies is set.14621463http.savecookies::1464 If set, store cookies received during requests to the file specified by1465 http.cookiefile. Has no effect if http.cookiefile is unset.14661467http.sslVerify::1468 Whether to verify the SSL certificate when fetching or pushing1469 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1470 variable.14711472http.sslCert::1473 File containing the SSL certificate when fetching or pushing1474 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1475 variable.14761477http.sslKey::1478 File containing the SSL private key when fetching or pushing1479 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1480 variable.14811482http.sslCertPasswordProtected::1483 Enable Git's password prompt for the SSL certificate. Otherwise1484 OpenSSL will prompt the user, possibly many times, if the1485 certificate or private key is encrypted. Can be overridden by the1486 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.14871488http.sslCAInfo::1489 File containing the certificates to verify the peer with when1490 fetching or pushing over HTTPS. Can be overridden by the1491 'GIT_SSL_CAINFO' environment variable.14921493http.sslCAPath::1494 Path containing files with the CA certificates to verify the peer1495 with when fetching or pushing over HTTPS. Can be overridden1496 by the 'GIT_SSL_CAPATH' environment variable.14971498http.sslTry::1499 Attempt to use AUTH SSL/TLS and encrypted data transfers1500 when connecting via regular FTP protocol. This might be needed1501 if the FTP server requires it for security reasons or you wish1502 to connect securely whenever remote FTP server supports it.1503 Default is false since it might trigger certificate verification1504 errors on misconfigured servers.15051506http.maxRequests::1507 How many HTTP requests to launch in parallel. Can be overridden1508 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15091510http.minSessions::1511 The number of curl sessions (counted across slots) to be kept across1512 requests. They will not be ended with curl_easy_cleanup() until1513 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1514 value will be capped at 1. Defaults to 1.15151516http.postBuffer::1517 Maximum size in bytes of the buffer used by smart HTTP1518 transports when POSTing data to the remote system.1519 For requests larger than this buffer size, HTTP/1.1 and1520 Transfer-Encoding: chunked is used to avoid creating a1521 massive pack file locally. Default is 1 MiB, which is1522 sufficient for most requests.15231524http.lowSpeedLimit, http.lowSpeedTime::1525 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1526 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1527 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1528 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15291530http.noEPSV::1531 A boolean which disables using of EPSV ftp command by curl.1532 This can helpful with some "poor" ftp servers which don't1533 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1534 environment variable. Default is false (curl will use EPSV).15351536http.useragent::1537 The HTTP USER_AGENT string presented to an HTTP server. The default1538 value represents the version of the client Git such as git/1.7.1.1539 This option allows you to override this value to a more common value1540 such as Mozilla/4.0. This may be necessary, for instance, if1541 connecting through a firewall that restricts HTTP connections to a set1542 of common USER_AGENT strings (but not including those like git/1.7.1).1543 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15441545http.<url>.*::1546 Any of the http.* options above can be applied selectively to some urls.1547 For a config key to match a URL, each element of the config key is1548 compared to that of the URL, in the following order:1549+1550--1551. Scheme (e.g., `https` in `https://example.com/`). This field1552 must match exactly between the config key and the URL.15531554. Host/domain name (e.g., `example.com` in `https://example.com/`).1555 This field must match exactly between the config key and the URL.15561557. Port number (e.g., `8080` in `http://example.com:8080/`).1558 This field must match exactly between the config key and the URL.1559 Omitted port numbers are automatically converted to the correct1560 default for the scheme before matching.15611562. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1563 path field of the config key must match the path field of the URL1564 either exactly or as a prefix of slash-delimited path elements. This means1565 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1566 match on a slash (`/`) boundary. Longer matches take precedence (so a config1567 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1568 key with just path `foo/`).15691570. User name (e.g., `user` in `https://user@example.com/repo.git`). If1571 the config key has a user name it must match the user name in the1572 URL exactly. If the config key does not have a user name, that1573 config key will match a URL with any user name (including none),1574 but at a lower precedence than a config key with a user name.1575--1576+1577The list above is ordered by decreasing precedence; a URL that matches1578a config key's path is preferred to one that matches its user name. For example,1579if the URL is `https://user@example.com/foo/bar` a config key match of1580`https://example.com/foo` will be preferred over a config key match of1581`https://user@example.com`.1582+1583All URLs are normalized before attempting any matching (the password part,1584if embedded in the URL, is always ignored for matching purposes) so that1585equivalent urls that are simply spelled differently will match properly.1586Environment variable settings always override any matches. The urls that are1587matched against are those given directly to Git commands. This means any URLs1588visited as a result of a redirection do not participate in matching.15891590i18n.commitEncoding::1591 Character encoding the commit messages are stored in; Git itself1592 does not care per se, but this information is necessary e.g. when1593 importing commits from emails or in the gitk graphical history1594 browser (and possibly at other places in the future or in other1595 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.15961597i18n.logOutputEncoding::1598 Character encoding the commit messages are converted to when1599 running 'git log' and friends.16001601imap::1602 The configuration variables in the 'imap' section are described1603 in linkgit:git-imap-send[1].16041605init.templatedir::1606 Specify the directory from which templates will be copied.1607 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16081609instaweb.browser::1610 Specify the program that will be used to browse your working1611 repository in gitweb. See linkgit:git-instaweb[1].16121613instaweb.httpd::1614 The HTTP daemon command-line to start gitweb on your working1615 repository. See linkgit:git-instaweb[1].16161617instaweb.local::1618 If true the web server started by linkgit:git-instaweb[1] will1619 be bound to the local IP (127.0.0.1).16201621instaweb.modulepath::1622 The default module path for linkgit:git-instaweb[1] to use1623 instead of /usr/lib/apache2/modules. Only used if httpd1624 is Apache.16251626instaweb.port::1627 The port number to bind the gitweb httpd to. See1628 linkgit:git-instaweb[1].16291630interactive.singlekey::1631 In interactive commands, allow the user to provide one-letter1632 input with a single key (i.e., without hitting enter).1633 Currently this is used by the `--patch` mode of1634 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1635 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1636 setting is silently ignored if portable keystroke input1637 is not available.16381639log.abbrevCommit::1640 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1641 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1642 override this option with `--no-abbrev-commit`.16431644log.date::1645 Set the default date-time mode for the 'log' command.1646 Setting a value for log.date is similar to using 'git log''s1647 `--date` option. Possible values are `relative`, `local`,1648 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1649 for details.16501651log.decorate::1652 Print out the ref names of any commits that are shown by the log1653 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1654 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1655 specified, the full ref name (including prefix) will be printed.1656 This is the same as the log commands '--decorate' option.16571658log.showroot::1659 If true, the initial commit will be shown as a big creation event.1660 This is equivalent to a diff against an empty tree.1661 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1662 normally hide the root commit will now show it. True by default.16631664log.mailmap::1665 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1666 linkgit:git-whatchanged[1] assume `--use-mailmap`.16671668mailmap.file::1669 The location of an augmenting mailmap file. The default1670 mailmap, located in the root of the repository, is loaded1671 first, then the mailmap file pointed to by this variable.1672 The location of the mailmap file may be in a repository1673 subdirectory, or somewhere outside of the repository itself.1674 See linkgit:git-shortlog[1] and linkgit:git-blame[1].16751676mailmap.blob::1677 Like `mailmap.file`, but consider the value as a reference to a1678 blob in the repository. If both `mailmap.file` and1679 `mailmap.blob` are given, both are parsed, with entries from1680 `mailmap.file` taking precedence. In a bare repository, this1681 defaults to `HEAD:.mailmap`. In a non-bare repository, it1682 defaults to empty.16831684man.viewer::1685 Specify the programs that may be used to display help in the1686 'man' format. See linkgit:git-help[1].16871688man.<tool>.cmd::1689 Specify the command to invoke the specified man viewer. The1690 specified command is evaluated in shell with the man page1691 passed as argument. (See linkgit:git-help[1].)16921693man.<tool>.path::1694 Override the path for the given tool that may be used to1695 display help in the 'man' format. See linkgit:git-help[1].16961697include::merge-config.txt[]16981699mergetool.<tool>.path::1700 Override the path for the given tool. This is useful in case1701 your tool is not in the PATH.17021703mergetool.<tool>.cmd::1704 Specify the command to invoke the specified merge tool. The1705 specified command is evaluated in shell with the following1706 variables available: 'BASE' is the name of a temporary file1707 containing the common base of the files to be merged, if available;1708 'LOCAL' is the name of a temporary file containing the contents of1709 the file on the current branch; 'REMOTE' is the name of a temporary1710 file containing the contents of the file from the branch being1711 merged; 'MERGED' contains the name of the file to which the merge1712 tool should write the results of a successful merge.17131714mergetool.<tool>.trustExitCode::1715 For a custom merge command, specify whether the exit code of1716 the merge command can be used to determine whether the merge was1717 successful. If this is not set to true then the merge target file1718 timestamp is checked and the merge assumed to have been successful1719 if the file has been updated, otherwise the user is prompted to1720 indicate the success of the merge.17211722mergetool.keepBackup::1723 After performing a merge, the original file with conflict markers1724 can be saved as a file with a `.orig` extension. If this variable1725 is set to `false` then this file is not preserved. Defaults to1726 `true` (i.e. keep the backup files).17271728mergetool.keepTemporaries::1729 When invoking a custom merge tool, Git uses a set of temporary1730 files to pass to the tool. If the tool returns an error and this1731 variable is set to `true`, then these temporary files will be1732 preserved, otherwise they will be removed after the tool has1733 exited. Defaults to `false`.17341735mergetool.prompt::1736 Prompt before each invocation of the merge resolution program.17371738notes.displayRef::1739 The (fully qualified) refname from which to show notes when1740 showing commit messages. The value of this variable can be set1741 to a glob, in which case notes from all matching refs will be1742 shown. You may also specify this configuration variable1743 several times. A warning will be issued for refs that do not1744 exist, but a glob that does not match any refs is silently1745 ignored.1746+1747This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1748environment variable, which must be a colon separated list of refs or1749globs.1750+1751The effective value of "core.notesRef" (possibly overridden by1752GIT_NOTES_REF) is also implicitly added to the list of refs to be1753displayed.17541755notes.rewrite.<command>::1756 When rewriting commits with <command> (currently `amend` or1757 `rebase`) and this variable is set to `true`, Git1758 automatically copies your notes from the original to the1759 rewritten commit. Defaults to `true`, but see1760 "notes.rewriteRef" below.17611762notes.rewriteMode::1763 When copying notes during a rewrite (see the1764 "notes.rewrite.<command>" option), determines what to do if1765 the target commit already has a note. Must be one of1766 `overwrite`, `concatenate`, or `ignore`. Defaults to1767 `concatenate`.1768+1769This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1770environment variable.17711772notes.rewriteRef::1773 When copying notes during a rewrite, specifies the (fully1774 qualified) ref whose notes should be copied. The ref may be a1775 glob, in which case notes in all matching refs will be copied.1776 You may also specify this configuration several times.1777+1778Does not have a default value; you must configure this variable to1779enable note rewriting. Set it to `refs/notes/commits` to enable1780rewriting for the default commit notes.1781+1782This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1783environment variable, which must be a colon separated list of refs or1784globs.17851786pack.window::1787 The size of the window used by linkgit:git-pack-objects[1] when no1788 window size is given on the command line. Defaults to 10.17891790pack.depth::1791 The maximum delta depth used by linkgit:git-pack-objects[1] when no1792 maximum depth is given on the command line. Defaults to 50.17931794pack.windowMemory::1795 The window memory size limit used by linkgit:git-pack-objects[1]1796 when no limit is given on the command line. The value can be1797 suffixed with "k", "m", or "g". Defaults to 0, meaning no1798 limit.17991800pack.compression::1801 An integer -1..9, indicating the compression level for objects1802 in a pack file. -1 is the zlib default. 0 means no1803 compression, and 1..9 are various speed/size tradeoffs, 9 being1804 slowest. If not set, defaults to core.compression. If that is1805 not set, defaults to -1, the zlib default, which is "a default1806 compromise between speed and compression (currently equivalent1807 to level 6)."1808+1809Note that changing the compression level will not automatically recompress1810all existing objects. You can force recompression by passing the -F option1811to linkgit:git-repack[1].18121813pack.deltaCacheSize::1814 The maximum memory in bytes used for caching deltas in1815 linkgit:git-pack-objects[1] before writing them out to a pack.1816 This cache is used to speed up the writing object phase by not1817 having to recompute the final delta result once the best match1818 for all objects is found. Repacking large repositories on machines1819 which are tight with memory might be badly impacted by this though,1820 especially if this cache pushes the system into swapping.1821 A value of 0 means no limit. The smallest size of 1 byte may be1822 used to virtually disable this cache. Defaults to 256 MiB.18231824pack.deltaCacheLimit::1825 The maximum size of a delta, that is cached in1826 linkgit:git-pack-objects[1]. This cache is used to speed up the1827 writing object phase by not having to recompute the final delta1828 result once the best match for all objects is found. Defaults to 1000.18291830pack.threads::1831 Specifies the number of threads to spawn when searching for best1832 delta matches. This requires that linkgit:git-pack-objects[1]1833 be compiled with pthreads otherwise this option is ignored with a1834 warning. This is meant to reduce packing time on multiprocessor1835 machines. The required amount of memory for the delta search window1836 is however multiplied by the number of threads.1837 Specifying 0 will cause Git to auto-detect the number of CPU's1838 and set the number of threads accordingly.18391840pack.indexVersion::1841 Specify the default pack index version. Valid values are 1 for1842 legacy pack index used by Git versions prior to 1.5.2, and 2 for1843 the new pack index with capabilities for packs larger than 4 GB1844 as well as proper protection against the repacking of corrupted1845 packs. Version 2 is the default. Note that version 2 is enforced1846 and this config option ignored whenever the corresponding pack is1847 larger than 2 GB.1848+1849If you have an old Git that does not understand the version 2 `*.idx` file,1850cloning or fetching over a non native protocol (e.g. "http" and "rsync")1851that will copy both `*.pack` file and corresponding `*.idx` file from the1852other side may give you a repository that cannot be accessed with your1853older version of Git. If the `*.pack` file is smaller than 2 GB, however,1854you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1855the `*.idx` file.18561857pack.packSizeLimit::1858 The maximum size of a pack. This setting only affects1859 packing to a file when repacking, i.e. the git:// protocol1860 is unaffected. It can be overridden by the `--max-pack-size`1861 option of linkgit:git-repack[1]. The minimum size allowed is1862 limited to 1 MiB. The default is unlimited.1863 Common unit suffixes of 'k', 'm', or 'g' are1864 supported.18651866pager.<cmd>::1867 If the value is boolean, turns on or off pagination of the1868 output of a particular Git subcommand when writing to a tty.1869 Otherwise, turns on pagination for the subcommand using the1870 pager specified by the value of `pager.<cmd>`. If `--paginate`1871 or `--no-pager` is specified on the command line, it takes1872 precedence over this option. To disable pagination for all1873 commands, set `core.pager` or `GIT_PAGER` to `cat`.18741875pretty.<name>::1876 Alias for a --pretty= format string, as specified in1877 linkgit:git-log[1]. Any aliases defined here can be used just1878 as the built-in pretty formats could. For example,1879 running `git config pretty.changelog "format:* %H %s"`1880 would cause the invocation `git log --pretty=changelog`1881 to be equivalent to running `git log "--pretty=format:* %H %s"`.1882 Note that an alias with the same name as a built-in format1883 will be silently ignored.18841885pull.rebase::1886 When true, rebase branches on top of the fetched branch, instead1887 of merging the default branch from the default remote when "git1888 pull" is run. See "branch.<name>.rebase" for setting this on a1889 per-branch basis.1890+1891 When preserve, also pass `--preserve-merges` along to 'git rebase'1892 so that locally committed merge commits will not be flattened1893 by running 'git pull'.1894+1895*NOTE*: this is a possibly dangerous operation; do *not* use1896it unless you understand the implications (see linkgit:git-rebase[1]1897for details).18981899pull.octopus::1900 The default merge strategy to use when pulling multiple branches1901 at once.19021903pull.twohead::1904 The default merge strategy to use when pulling a single branch.19051906push.default::1907 Defines the action `git push` should take if no refspec is1908 explicitly given. Different values are well-suited for1909 specific workflows; for instance, in a purely central workflow1910 (i.e. the fetch source is equal to the push destination),1911 `upstream` is probably what you want. Possible values are:1912+1913--19141915* `nothing` - do not push anything (error out) unless a refspec is1916 explicitly given. This is primarily meant for people who want to1917 avoid mistakes by always being explicit.19181919* `current` - push the current branch to update a branch with the same1920 name on the receiving end. Works in both central and non-central1921 workflows.19221923* `upstream` - push the current branch back to the branch whose1924 changes are usually integrated into the current branch (which is1925 called `@{upstream}`). This mode only makes sense if you are1926 pushing to the same repository you would normally pull from1927 (i.e. central workflow).19281929* `simple` - in centralized workflow, work like `upstream` with an1930 added safety to refuse to push if the upstream branch's name is1931 different from the local one.1932+1933When pushing to a remote that is different from the remote you normally1934pull from, work as `current`. This is the safest option and is suited1935for beginners.1936+1937This mode will become the default in Git 2.0.19381939* `matching` - push all branches having the same name on both ends.1940 This makes the repository you are pushing to remember the set of1941 branches that will be pushed out (e.g. if you always push 'maint'1942 and 'master' there and no other branches, the repository you push1943 to will have these two branches, and your local 'maint' and1944 'master' will be pushed there).1945+1946To use this mode effectively, you have to make sure _all_ the1947branches you would push out are ready to be pushed out before1948running 'git push', as the whole point of this mode is to allow you1949to push all of the branches in one go. If you usually finish work1950on only one branch and push out the result, while other branches are1951unfinished, this mode is not for you. Also this mode is not1952suitable for pushing into a shared central repository, as other1953people may add new branches there, or update the tip of existing1954branches outside your control.1955+1956This is currently the default, but Git 2.0 will change the default1957to `simple`.19581959--19601961rebase.stat::1962 Whether to show a diffstat of what changed upstream since the last1963 rebase. False by default.19641965rebase.autosquash::1966 If set to true enable '--autosquash' option by default.19671968rebase.autostash::1969 When set to true, automatically create a temporary stash1970 before the operation begins, and apply it after the operation1971 ends. This means that you can run rebase on a dirty worktree.1972 However, use with care: the final stash application after a1973 successful rebase might result in non-trivial conflicts.1974 Defaults to false.19751976receive.autogc::1977 By default, git-receive-pack will run "git-gc --auto" after1978 receiving data from git-push and updating refs. You can stop1979 it by setting this variable to false.19801981receive.fsckObjects::1982 If it is set to true, git-receive-pack will check all received1983 objects. It will abort in the case of a malformed object or a1984 broken link. The result of an abort are only dangling objects.1985 Defaults to false. If not set, the value of `transfer.fsckObjects`1986 is used instead.19871988receive.unpackLimit::1989 If the number of objects received in a push is below this1990 limit then the objects will be unpacked into loose object1991 files. However if the number of received objects equals or1992 exceeds this limit then the received pack will be stored as1993 a pack, after adding any missing delta bases. Storing the1994 pack from a push can make the push operation complete faster,1995 especially on slow filesystems. If not set, the value of1996 `transfer.unpackLimit` is used instead.19971998receive.denyDeletes::1999 If set to true, git-receive-pack will deny a ref update that deletes2000 the ref. Use this to prevent such a ref deletion via a push.20012002receive.denyDeleteCurrent::2003 If set to true, git-receive-pack will deny a ref update that2004 deletes the currently checked out branch of a non-bare repository.20052006receive.denyCurrentBranch::2007 If set to true or "refuse", git-receive-pack will deny a ref update2008 to the currently checked out branch of a non-bare repository.2009 Such a push is potentially dangerous because it brings the HEAD2010 out of sync with the index and working tree. If set to "warn",2011 print a warning of such a push to stderr, but allow the push to2012 proceed. If set to false or "ignore", allow such pushes with no2013 message. Defaults to "refuse".20142015receive.denyNonFastForwards::2016 If set to true, git-receive-pack will deny a ref update which is2017 not a fast-forward. Use this to prevent such an update via a push,2018 even if that push is forced. This configuration variable is2019 set when initializing a shared repository.20202021receive.hiderefs::2022 String(s) `receive-pack` uses to decide which refs to omit2023 from its initial advertisement. Use more than one2024 definitions to specify multiple prefix strings. A ref that2025 are under the hierarchies listed on the value of this2026 variable is excluded, and is hidden when responding to `git2027 push`, and an attempt to update or delete a hidden ref by2028 `git push` is rejected.20292030receive.updateserverinfo::2031 If set to true, git-receive-pack will run git-update-server-info2032 after receiving data from git-push and updating refs.20332034remote.pushdefault::2035 The remote to push to by default. Overrides2036 `branch.<name>.remote` for all branches, and is overridden by2037 `branch.<name>.pushremote` for specific branches.20382039remote.<name>.url::2040 The URL of a remote repository. See linkgit:git-fetch[1] or2041 linkgit:git-push[1].20422043remote.<name>.pushurl::2044 The push URL of a remote repository. See linkgit:git-push[1].20452046remote.<name>.proxy::2047 For remotes that require curl (http, https and ftp), the URL to2048 the proxy to use for that remote. Set to the empty string to2049 disable proxying for that remote.20502051remote.<name>.fetch::2052 The default set of "refspec" for linkgit:git-fetch[1]. See2053 linkgit:git-fetch[1].20542055remote.<name>.push::2056 The default set of "refspec" for linkgit:git-push[1]. See2057 linkgit:git-push[1].20582059remote.<name>.mirror::2060 If true, pushing to this remote will automatically behave2061 as if the `--mirror` option was given on the command line.20622063remote.<name>.skipDefaultUpdate::2064 If true, this remote will be skipped by default when updating2065 using linkgit:git-fetch[1] or the `update` subcommand of2066 linkgit:git-remote[1].20672068remote.<name>.skipFetchAll::2069 If true, this remote will be skipped by default when updating2070 using linkgit:git-fetch[1] or the `update` subcommand of2071 linkgit:git-remote[1].20722073remote.<name>.receivepack::2074 The default program to execute on the remote side when pushing. See2075 option \--receive-pack of linkgit:git-push[1].20762077remote.<name>.uploadpack::2078 The default program to execute on the remote side when fetching. See2079 option \--upload-pack of linkgit:git-fetch-pack[1].20802081remote.<name>.tagopt::2082 Setting this value to \--no-tags disables automatic tag following when2083 fetching from remote <name>. Setting it to \--tags will fetch every2084 tag from remote <name>, even if they are not reachable from remote2085 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2086 override this setting. See options \--tags and \--no-tags of2087 linkgit:git-fetch[1].20882089remote.<name>.vcs::2090 Setting this to a value <vcs> will cause Git to interact with2091 the remote with the git-remote-<vcs> helper.20922093remote.<name>.prune::2094 When set to true, fetching from this remote by default will also2095 remove any remote-tracking branches which no longer exist on the2096 remote (as if the `--prune` option was give on the command line).2097 Overrides `fetch.prune` settings, if any.20982099remotes.<group>::2100 The list of remotes which are fetched by "git remote update2101 <group>". See linkgit:git-remote[1].21022103repack.usedeltabaseoffset::2104 By default, linkgit:git-repack[1] creates packs that use2105 delta-base offset. If you need to share your repository with2106 Git older than version 1.4.4, either directly or via a dumb2107 protocol such as http, then you need to set this option to2108 "false" and repack. Access from old Git versions over the2109 native protocol are unaffected by this option.21102111rerere.autoupdate::2112 When set to true, `git-rerere` updates the index with the2113 resulting contents after it cleanly resolves conflicts using2114 previously recorded resolution. Defaults to false.21152116rerere.enabled::2117 Activate recording of resolved conflicts, so that identical2118 conflict hunks can be resolved automatically, should they be2119 encountered again. By default, linkgit:git-rerere[1] is2120 enabled if there is an `rr-cache` directory under the2121 `$GIT_DIR`, e.g. if "rerere" was previously used in the2122 repository.21232124sendemail.identity::2125 A configuration identity. When given, causes values in the2126 'sendemail.<identity>' subsection to take precedence over2127 values in the 'sendemail' section. The default identity is2128 the value of 'sendemail.identity'.21292130sendemail.smtpencryption::2131 See linkgit:git-send-email[1] for description. Note that this2132 setting is not subject to the 'identity' mechanism.21332134sendemail.smtpssl::2135 Deprecated alias for 'sendemail.smtpencryption = ssl'.21362137sendemail.smtpsslcertpath::2138 Path to ca-certificates (either a directory or a single file).2139 Set it to an empty string to disable certificate verification.21402141sendemail.<identity>.*::2142 Identity-specific versions of the 'sendemail.*' parameters2143 found below, taking precedence over those when the this2144 identity is selected, through command-line or2145 'sendemail.identity'.21462147sendemail.aliasesfile::2148sendemail.aliasfiletype::2149sendemail.annotate::2150sendemail.bcc::2151sendemail.cc::2152sendemail.cccmd::2153sendemail.chainreplyto::2154sendemail.confirm::2155sendemail.envelopesender::2156sendemail.from::2157sendemail.multiedit::2158sendemail.signedoffbycc::2159sendemail.smtppass::2160sendemail.suppresscc::2161sendemail.suppressfrom::2162sendemail.to::2163sendemail.smtpdomain::2164sendemail.smtpserver::2165sendemail.smtpserverport::2166sendemail.smtpserveroption::2167sendemail.smtpuser::2168sendemail.thread::2169sendemail.validate::2170 See linkgit:git-send-email[1] for description.21712172sendemail.signedoffcc::2173 Deprecated alias for 'sendemail.signedoffbycc'.21742175showbranch.default::2176 The default set of branches for linkgit:git-show-branch[1].2177 See linkgit:git-show-branch[1].21782179status.relativePaths::2180 By default, linkgit:git-status[1] shows paths relative to the2181 current directory. Setting this variable to `false` shows paths2182 relative to the repository root (this was the default for Git2183 prior to v1.5.4).21842185status.short::2186 Set to true to enable --short by default in linkgit:git-status[1].2187 The option --no-short takes precedence over this variable.21882189status.branch::2190 Set to true to enable --branch by default in linkgit:git-status[1].2191 The option --no-branch takes precedence over this variable.21922193status.displayCommentPrefix::2194 If set to true, linkgit:git-status[1] will insert a comment2195 prefix before each output line (starting with2196 `core.commentChar`, i.e. `#` by default). This was the2197 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2198 Defaults to false.21992200status.showUntrackedFiles::2201 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2202 files which are not currently tracked by Git. Directories which2203 contain only untracked files, are shown with the directory name2204 only. Showing untracked files means that Git needs to lstat() all2205 all the files in the whole repository, which might be slow on some2206 systems. So, this variable controls how the commands displays2207 the untracked files. Possible values are:2208+2209--2210* `no` - Show no untracked files.2211* `normal` - Show untracked files and directories.2212* `all` - Show also individual files in untracked directories.2213--2214+2215If this variable is not specified, it defaults to 'normal'.2216This variable can be overridden with the -u|--untracked-files option2217of linkgit:git-status[1] and linkgit:git-commit[1].22182219status.submodulesummary::2220 Defaults to false.2221 If this is set to a non zero number or true (identical to -1 or an2222 unlimited number), the submodule summary will be enabled and a2223 summary of commits for modified submodules will be shown (see2224 --summary-limit option of linkgit:git-submodule[1]). Please note2225 that the summary output command will be suppressed for all2226 submodules when `diff.ignoreSubmodules` is set to 'all' or only2227 for those submodules where `submodule.<name>.ignore=all`. To2228 also view the summary for ignored submodules you can either use2229 the --ignore-submodules=dirty command line option or the 'git2230 submodule summary' command, which shows a similar output but does2231 not honor these settings.22322233submodule.<name>.path::2234submodule.<name>.url::2235submodule.<name>.update::2236 The path within this project, URL, and the updating strategy2237 for a submodule. These variables are initially populated2238 by 'git submodule init'; edit them to override the2239 URL and other values found in the `.gitmodules` file. See2240 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.22412242submodule.<name>.branch::2243 The remote branch name for a submodule, used by `git submodule2244 update --remote`. Set this option to override the value found in2245 the `.gitmodules` file. See linkgit:git-submodule[1] and2246 linkgit:gitmodules[5] for details.22472248submodule.<name>.fetchRecurseSubmodules::2249 This option can be used to control recursive fetching of this2250 submodule. It can be overridden by using the --[no-]recurse-submodules2251 command line option to "git fetch" and "git pull".2252 This setting will override that from in the linkgit:gitmodules[5]2253 file.22542255submodule.<name>.ignore::2256 Defines under what circumstances "git status" and the diff family show2257 a submodule as modified. When set to "all", it will never be considered2258 modified, "dirty" will ignore all changes to the submodules work tree and2259 takes only differences between the HEAD of the submodule and the commit2260 recorded in the superproject into account. "untracked" will additionally2261 let submodules with modified tracked files in their work tree show up.2262 Using "none" (the default when this option is not set) also shows2263 submodules that have untracked files in their work tree as changed.2264 This setting overrides any setting made in .gitmodules for this submodule,2265 both settings can be overridden on the command line by using the2266 "--ignore-submodules" option. The 'git submodule' commands are not2267 affected by this setting.22682269tar.umask::2270 This variable can be used to restrict the permission bits of2271 tar archive entries. The default is 0002, which turns off the2272 world write bit. The special value "user" indicates that the2273 archiving user's umask will be used instead. See umask(2) and2274 linkgit:git-archive[1].22752276transfer.fsckObjects::2277 When `fetch.fsckObjects` or `receive.fsckObjects` are2278 not set, the value of this variable is used instead.2279 Defaults to false.22802281transfer.hiderefs::2282 This variable can be used to set both `receive.hiderefs`2283 and `uploadpack.hiderefs` at the same time to the same2284 values. See entries for these other variables.22852286transfer.unpackLimit::2287 When `fetch.unpackLimit` or `receive.unpackLimit` are2288 not set, the value of this variable is used instead.2289 The default value is 100.22902291uploadpack.hiderefs::2292 String(s) `upload-pack` uses to decide which refs to omit2293 from its initial advertisement. Use more than one2294 definitions to specify multiple prefix strings. A ref that2295 are under the hierarchies listed on the value of this2296 variable is excluded, and is hidden from `git ls-remote`,2297 `git fetch`, etc. An attempt to fetch a hidden ref by `git2298 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.22992300uploadpack.allowtipsha1inwant::2301 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2302 to accept a fetch request that asks for an object at the tip2303 of a hidden ref (by default, such a request is rejected).2304 see also `uploadpack.hiderefs`.23052306uploadpack.keepalive::2307 When `upload-pack` has started `pack-objects`, there may be a2308 quiet period while `pack-objects` prepares the pack. Normally2309 it would output progress information, but if `--quiet` was used2310 for the fetch, `pack-objects` will output nothing at all until2311 the pack data begins. Some clients and networks may consider2312 the server to be hung and give up. Setting this option instructs2313 `upload-pack` to send an empty keepalive packet every2314 `uploadpack.keepalive` seconds. Setting this option to 02315 disables keepalive packets entirely. The default is 5 seconds.23162317url.<base>.insteadOf::2318 Any URL that starts with this value will be rewritten to2319 start, instead, with <base>. In cases where some site serves a2320 large number of repositories, and serves them with multiple2321 access methods, and some users need to use different access2322 methods, this feature allows people to specify any of the2323 equivalent URLs and have Git automatically rewrite the URL to2324 the best alternative for the particular user, even for a2325 never-before-seen repository on the site. When more than one2326 insteadOf strings match a given URL, the longest match is used.23272328url.<base>.pushInsteadOf::2329 Any URL that starts with this value will not be pushed to;2330 instead, it will be rewritten to start with <base>, and the2331 resulting URL will be pushed to. In cases where some site serves2332 a large number of repositories, and serves them with multiple2333 access methods, some of which do not allow push, this feature2334 allows people to specify a pull-only URL and have Git2335 automatically use an appropriate URL to push, even for a2336 never-before-seen repository on the site. When more than one2337 pushInsteadOf strings match a given URL, the longest match is2338 used. If a remote has an explicit pushurl, Git will ignore this2339 setting for that remote.23402341user.email::2342 Your email address to be recorded in any newly created commits.2343 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2344 'EMAIL' environment variables. See linkgit:git-commit-tree[1].23452346user.name::2347 Your full name to be recorded in any newly created commits.2348 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2349 environment variables. See linkgit:git-commit-tree[1].23502351user.signingkey::2352 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2353 key you want it to automatically when creating a signed tag or2354 commit, you can override the default selection with this variable.2355 This option is passed unchanged to gpg's --local-user parameter,2356 so you may specify a key using any method that gpg supports.23572358web.browser::2359 Specify a web browser that may be used by some commands.2360 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2361 may use it.