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.protectNTFS:: 243 If set to true, do not allow checkout of paths that would 244 cause problems with the NTFS filesystem, e.g. conflict with 245 8.3 "short" names. 246 Defaults to `true` on Windows, and `false` elsewhere. 247 248core.trustctime:: 249 If false, the ctime differences between the index and the 250 working tree are ignored; useful when the inode change time 251 is regularly modified by something outside Git (file system 252 crawlers and some backup systems). 253 See linkgit:git-update-index[1]. True by default. 254 255core.checkstat:: 256 Determines which stat fields to match between the index 257 and work tree. The user can set this to 'default' or 258 'minimal'. Default (or explicitly 'default'), is to check 259 all fields, including the sub-second part of mtime and ctime. 260 261core.quotepath:: 262 The commands that output paths (e.g. 'ls-files', 263 'diff'), when not given the `-z` option, will quote 264 "unusual" characters in the pathname by enclosing the 265 pathname in a double-quote pair and with backslashes the 266 same way strings in C source code are quoted. If this 267 variable is set to false, the bytes higher than 0x80 are 268 not quoted but output as verbatim. Note that double 269 quote, backslash and control characters are always 270 quoted without `-z` regardless of the setting of this 271 variable. 272 273core.eol:: 274 Sets the line ending type to use in the working directory for 275 files that have the `text` property set. Alternatives are 276 'lf', 'crlf' and 'native', which uses the platform's native 277 line ending. The default value is `native`. See 278 linkgit:gitattributes[5] for more information on end-of-line 279 conversion. 280 281core.safecrlf:: 282 If true, makes Git check if converting `CRLF` is reversible when 283 end-of-line conversion is active. Git will verify if a command 284 modifies a file in the work tree either directly or indirectly. 285 For example, committing a file followed by checking out the 286 same file should yield the original file in the work tree. If 287 this is not the case for the current setting of 288 `core.autocrlf`, Git will reject the file. The variable can 289 be set to "warn", in which case Git will only warn about an 290 irreversible conversion but continue the operation. 291+ 292CRLF conversion bears a slight chance of corrupting data. 293When it is enabled, Git will convert CRLF to LF during commit and LF to 294CRLF during checkout. A file that contains a mixture of LF and 295CRLF before the commit cannot be recreated by Git. For text 296files this is the right thing to do: it corrects line endings 297such that we have only LF line endings in the repository. 298But for binary files that are accidentally classified as text the 299conversion can corrupt data. 300+ 301If you recognize such corruption early you can easily fix it by 302setting the conversion type explicitly in .gitattributes. Right 303after committing you still have the original file in your work 304tree and this file is not yet corrupted. You can explicitly tell 305Git that this file is binary and Git will handle the file 306appropriately. 307+ 308Unfortunately, the desired effect of cleaning up text files with 309mixed line endings and the undesired effect of corrupting binary 310files cannot be distinguished. In both cases CRLFs are removed 311in an irreversible way. For text files this is the right thing 312to do because CRLFs are line endings, while for binary files 313converting CRLFs corrupts data. 314+ 315Note, this safety check does not mean that a checkout will generate a 316file identical to the original file for a different setting of 317`core.eol` and `core.autocrlf`, but only for the current one. For 318example, a text file with `LF` would be accepted with `core.eol=lf` 319and could later be checked out with `core.eol=crlf`, in which case the 320resulting file would contain `CRLF`, although the original file 321contained `LF`. However, in both work trees the line endings would be 322consistent, that is either all `LF` or all `CRLF`, but never mixed. A 323file with mixed line endings would be reported by the `core.safecrlf` 324mechanism. 325 326core.autocrlf:: 327 Setting this variable to "true" is almost the same as setting 328 the `text` attribute to "auto" on all files except that text 329 files are not guaranteed to be normalized: files that contain 330 `CRLF` in the repository will not be touched. Use this 331 setting if you want to have `CRLF` line endings in your 332 working directory even though the repository does not have 333 normalized line endings. This variable can be set to 'input', 334 in which case no output conversion is performed. 335 336core.symlinks:: 337 If false, symbolic links are checked out as small plain files that 338 contain the link text. linkgit:git-update-index[1] and 339 linkgit:git-add[1] will not change the recorded type to regular 340 file. Useful on filesystems like FAT that do not support 341 symbolic links. 342+ 343The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 344will probe and set core.symlinks false if appropriate when the repository 345is created. 346 347core.gitProxy:: 348 A "proxy command" to execute (as 'command host port') instead 349 of establishing direct connection to the remote server when 350 using the Git protocol for fetching. If the variable value is 351 in the "COMMAND for DOMAIN" format, the command is applied only 352 on hostnames ending with the specified domain string. This variable 353 may be set multiple times and is matched in the given order; 354 the first match wins. 355+ 356Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 357(which always applies universally, without the special "for" 358handling). 359+ 360The special string `none` can be used as the proxy command to 361specify that no proxy be used for a given domain pattern. 362This is useful for excluding servers inside a firewall from 363proxy use, while defaulting to a common proxy for external domains. 364 365core.ignoreStat:: 366 If true, commands which modify both the working tree and the index 367 will mark the updated paths with the "assume unchanged" bit in the 368 index. These marked files are then assumed to stay unchanged in the 369 working tree, until you mark them otherwise manually - Git will not 370 detect the file changes by lstat() calls. This is useful on systems 371 where those are very slow, such as Microsoft Windows. 372 See linkgit:git-update-index[1]. 373 False by default. 374 375core.preferSymlinkRefs:: 376 Instead of the default "symref" format for HEAD 377 and other symbolic reference files, use symbolic links. 378 This is sometimes needed to work with old scripts that 379 expect HEAD to be a symbolic link. 380 381core.bare:: 382 If true this repository is assumed to be 'bare' and has no 383 working directory associated with it. If this is the case a 384 number of commands that require a working directory will be 385 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 386+ 387This setting is automatically guessed by linkgit:git-clone[1] or 388linkgit:git-init[1] when the repository was created. By default a 389repository that ends in "/.git" is assumed to be not bare (bare = 390false), while all other repositories are assumed to be bare (bare 391= true). 392 393core.worktree:: 394 Set the path to the root of the working tree. 395 This can be overridden by the GIT_WORK_TREE environment 396 variable and the '--work-tree' command line option. 397 The value can be an absolute path or relative to the path to 398 the .git directory, which is either specified by --git-dir 399 or GIT_DIR, or automatically discovered. 400 If --git-dir or GIT_DIR is specified but none of 401 --work-tree, GIT_WORK_TREE and core.worktree is specified, 402 the current working directory is regarded as the top level 403 of your working tree. 404+ 405Note that this variable is honored even when set in a configuration 406file in a ".git" subdirectory of a directory and its value differs 407from the latter directory (e.g. "/path/to/.git/config" has 408core.worktree set to "/different/path"), which is most likely a 409misconfiguration. Running Git commands in the "/path/to" directory will 410still use "/different/path" as the root of the work tree and can cause 411confusion unless you know what you are doing (e.g. you are creating a 412read-only snapshot of the same index to a location different from the 413repository's usual working tree). 414 415core.logAllRefUpdates:: 416 Enable the reflog. Updates to a ref <ref> is logged to the file 417 "$GIT_DIR/logs/<ref>", by appending the new and old 418 SHA-1, the date/time and the reason of the update, but 419 only when the file exists. If this configuration 420 variable is set to true, missing "$GIT_DIR/logs/<ref>" 421 file is automatically created for branch heads (i.e. under 422 refs/heads/), remote refs (i.e. under refs/remotes/), 423 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 424+ 425This information can be used to determine what commit 426was the tip of a branch "2 days ago". 427+ 428This value is true by default in a repository that has 429a working directory associated with it, and false by 430default in a bare repository. 431 432core.repositoryFormatVersion:: 433 Internal variable identifying the repository format and layout 434 version. 435 436core.sharedRepository:: 437 When 'group' (or 'true'), the repository is made shareable between 438 several users in a group (making sure all the files and objects are 439 group-writable). When 'all' (or 'world' or 'everybody'), the 440 repository will be readable by all users, additionally to being 441 group-shareable. When 'umask' (or 'false'), Git will use permissions 442 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 443 files in the repository will have this mode value. '0xxx' will override 444 user's umask value (whereas the other options will only override 445 requested parts of the user's umask value). Examples: '0660' will make 446 the repo read/write-able for the owner and group, but inaccessible to 447 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 448 repository that is group-readable but not group-writable. 449 See linkgit:git-init[1]. False by default. 450 451core.warnAmbiguousRefs:: 452 If true, Git will warn you if the ref name you passed it is ambiguous 453 and might match multiple refs in the repository. True by default. 454 455core.compression:: 456 An integer -1..9, indicating a default compression level. 457 -1 is the zlib default. 0 means no compression, 458 and 1..9 are various speed/size tradeoffs, 9 being slowest. 459 If set, this provides a default to other compression variables, 460 such as 'core.loosecompression' and 'pack.compression'. 461 462core.loosecompression:: 463 An integer -1..9, indicating the compression level for objects that 464 are not in a pack file. -1 is the zlib default. 0 means no 465 compression, and 1..9 are various speed/size tradeoffs, 9 being 466 slowest. If not set, defaults to core.compression. If that is 467 not set, defaults to 1 (best speed). 468 469core.packedGitWindowSize:: 470 Number of bytes of a pack file to map into memory in a 471 single mapping operation. Larger window sizes may allow 472 your system to process a smaller number of large pack files 473 more quickly. Smaller window sizes will negatively affect 474 performance due to increased calls to the operating system's 475 memory manager, but may improve performance when accessing 476 a large number of large pack files. 477+ 478Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 479MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 480be reasonable for all users/operating systems. You probably do 481not need to adjust this value. 482+ 483Common unit suffixes of 'k', 'm', or 'g' are supported. 484 485core.packedGitLimit:: 486 Maximum number of bytes to map simultaneously into memory 487 from pack files. If Git needs to access more than this many 488 bytes at once to complete an operation it will unmap existing 489 regions to reclaim virtual address space within the process. 490+ 491Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 492This should be reasonable for all users/operating systems, except on 493the largest projects. You probably do not need to adjust this value. 494+ 495Common unit suffixes of 'k', 'm', or 'g' are supported. 496 497core.deltaBaseCacheLimit:: 498 Maximum number of bytes to reserve for caching base objects 499 that may be referenced by multiple deltified objects. By storing the 500 entire decompressed base objects in a cache Git is able 501 to avoid unpacking and decompressing frequently used base 502 objects multiple times. 503+ 504Default is 16 MiB on all platforms. This should be reasonable 505for all users/operating systems, except on the largest projects. 506You probably do not need to adjust this value. 507+ 508Common unit suffixes of 'k', 'm', or 'g' are supported. 509 510core.bigFileThreshold:: 511 Files larger than this size are stored deflated, without 512 attempting delta compression. Storing large files without 513 delta compression avoids excessive memory usage, at the 514 slight expense of increased disk usage. 515+ 516Default is 512 MiB on all platforms. This should be reasonable 517for most projects as source code and other text files can still 518be delta compressed, but larger binary media files won't be. 519+ 520Common unit suffixes of 'k', 'm', or 'g' are supported. 521 522core.excludesfile:: 523 In addition to '.gitignore' (per-directory) and 524 '.git/info/exclude', Git looks into this file for patterns 525 of files which are not meant to be tracked. "`~/`" is expanded 526 to the value of `$HOME` and "`~user/`" to the specified user's 527 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 528 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 529 is used instead. See linkgit:gitignore[5]. 530 531core.askpass:: 532 Some commands (e.g. svn and http interfaces) that interactively 533 ask for a password can be told to use an external program given 534 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 535 environment variable. If not set, fall back to the value of the 536 'SSH_ASKPASS' environment variable or, failing that, a simple password 537 prompt. The external program shall be given a suitable prompt as 538 command line argument and write the password on its STDOUT. 539 540core.attributesfile:: 541 In addition to '.gitattributes' (per-directory) and 542 '.git/info/attributes', Git looks into this file for attributes 543 (see linkgit:gitattributes[5]). Path expansions are made the same 544 way as for `core.excludesfile`. Its default value is 545 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 546 set or empty, $HOME/.config/git/attributes is used instead. 547 548core.editor:: 549 Commands such as `commit` and `tag` that lets you edit 550 messages by launching an editor uses the value of this 551 variable when it is set, and the environment variable 552 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 553 554core.commentchar:: 555 Commands such as `commit` and `tag` that lets you edit 556 messages consider a line that begins with this character 557 commented, and removes them after the editor returns 558 (default '#'). 559 560sequence.editor:: 561 Text editor used by `git rebase -i` for editing the rebase instruction file. 562 The value is meant to be interpreted by the shell when it is used. 563 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 564 When not configured the default commit message editor is used instead. 565 566core.pager:: 567 Text viewer for use by Git commands (e.g., 'less'). The value 568 is meant to be interpreted by the shell. The order of preference 569 is the `$GIT_PAGER` environment variable, then `core.pager` 570 configuration, then `$PAGER`, and then the default chosen at 571 compile time (usually 'less'). 572+ 573When the `LESS` environment variable is unset, Git sets it to `FRSX` 574(if `LESS` environment variable is set, Git does not change it at 575all). If you want to selectively override Git's default setting 576for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 577be passed to the shell by Git, which will translate the final 578command to `LESS=FRSX less -+S`. The environment tells the command 579to set the `S` option to chop long lines but the command line 580resets it to the default to fold long lines. 581 582core.whitespace:: 583 A comma separated list of common whitespace problems to 584 notice. 'git diff' will use `color.diff.whitespace` to 585 highlight them, and 'git apply --whitespace=error' will 586 consider them as errors. You can prefix `-` to disable 587 any of them (e.g. `-trailing-space`): 588+ 589* `blank-at-eol` treats trailing whitespaces at the end of the line 590 as an error (enabled by default). 591* `space-before-tab` treats a space character that appears immediately 592 before a tab character in the initial indent part of the line as an 593 error (enabled by default). 594* `indent-with-non-tab` treats a line that is indented with space 595 characters instead of the equivalent tabs as an error (not enabled by 596 default). 597* `tab-in-indent` treats a tab character in the initial indent part of 598 the line as an error (not enabled by default). 599* `blank-at-eof` treats blank lines added at the end of file as an error 600 (enabled by default). 601* `trailing-space` is a short-hand to cover both `blank-at-eol` and 602 `blank-at-eof`. 603* `cr-at-eol` treats a carriage-return at the end of line as 604 part of the line terminator, i.e. with it, `trailing-space` 605 does not trigger if the character before such a carriage-return 606 is not a whitespace (not enabled by default). 607* `tabwidth=<n>` tells how many character positions a tab occupies; this 608 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 609 errors. The default tab width is 8. Allowed values are 1 to 63. 610 611core.fsyncobjectfiles:: 612 This boolean will enable 'fsync()' when writing object files. 613+ 614This is a total waste of time and effort on a filesystem that orders 615data writes properly, but can be useful for filesystems that do not use 616journalling (traditional UNIX filesystems) or that only journal metadata 617and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 618 619core.preloadindex:: 620 Enable parallel index preload for operations like 'git diff' 621+ 622This can speed up operations like 'git diff' and 'git status' especially 623on filesystems like NFS that have weak caching semantics and thus 624relatively high IO latencies. With this set to 'true', Git will do the 625index comparison to the filesystem data in parallel, allowing 626overlapping IO's. 627 628core.createObject:: 629 You can set this to 'link', in which case a hardlink followed by 630 a delete of the source are used to make sure that object creation 631 will not overwrite existing objects. 632+ 633On some file system/operating system combinations, this is unreliable. 634Set this config setting to 'rename' there; However, This will remove the 635check that makes sure that existing object files will not get overwritten. 636 637core.notesRef:: 638 When showing commit messages, also show notes which are stored in 639 the given ref. The ref must be fully qualified. If the given 640 ref does not exist, it is not an error but means that no 641 notes should be printed. 642+ 643This setting defaults to "refs/notes/commits", and it can be overridden by 644the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 645 646core.sparseCheckout:: 647 Enable "sparse checkout" feature. See section "Sparse checkout" in 648 linkgit:git-read-tree[1] for more information. 649 650core.abbrev:: 651 Set the length object names are abbreviated to. If unspecified, 652 many commands abbreviate to 7 hexdigits, which may not be enough 653 for abbreviated object names to stay unique for sufficiently long 654 time. 655 656add.ignore-errors:: 657add.ignoreErrors:: 658 Tells 'git add' to continue adding files when some files cannot be 659 added due to indexing errors. Equivalent to the '--ignore-errors' 660 option of linkgit:git-add[1]. Older versions of Git accept only 661 `add.ignore-errors`, which does not follow the usual naming 662 convention for configuration variables. Newer versions of Git 663 honor `add.ignoreErrors` as well. 664 665alias.*:: 666 Command aliases for the linkgit:git[1] command wrapper - e.g. 667 after defining "alias.last = cat-file commit HEAD", the invocation 668 "git last" is equivalent to "git cat-file commit HEAD". To avoid 669 confusion and troubles with script usage, aliases that 670 hide existing Git commands are ignored. Arguments are split by 671 spaces, the usual shell quoting and escaping is supported. 672 quote pair and a backslash can be used to quote them. 673+ 674If the alias expansion is prefixed with an exclamation point, 675it will be treated as a shell command. For example, defining 676"alias.new = !gitk --all --not ORIG_HEAD", the invocation 677"git new" is equivalent to running the shell command 678"gitk --all --not ORIG_HEAD". Note that shell commands will be 679executed from the top-level directory of a repository, which may 680not necessarily be the current directory. 681'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 682from the original current directory. See linkgit:git-rev-parse[1]. 683 684am.keepcr:: 685 If true, git-am will call git-mailsplit for patches in mbox format 686 with parameter '--keep-cr'. In this case git-mailsplit will 687 not remove `\r` from lines ending with `\r\n`. Can be overridden 688 by giving '--no-keep-cr' from the command line. 689 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 690 691apply.ignorewhitespace:: 692 When set to 'change', tells 'git apply' to ignore changes in 693 whitespace, in the same way as the '--ignore-space-change' 694 option. 695 When set to one of: no, none, never, false tells 'git apply' to 696 respect all whitespace differences. 697 See linkgit:git-apply[1]. 698 699apply.whitespace:: 700 Tells 'git apply' how to handle whitespaces, in the same way 701 as the '--whitespace' option. See linkgit:git-apply[1]. 702 703branch.autosetupmerge:: 704 Tells 'git branch' and 'git checkout' to set up new branches 705 so that linkgit:git-pull[1] will appropriately merge from the 706 starting point branch. Note that even if this option is not set, 707 this behavior can be chosen per-branch using the `--track` 708 and `--no-track` options. The valid settings are: `false` -- no 709 automatic setup is done; `true` -- automatic setup is done when the 710 starting point is a remote-tracking branch; `always` -- 711 automatic setup is done when the starting point is either a 712 local branch or remote-tracking 713 branch. This option defaults to true. 714 715branch.autosetuprebase:: 716 When a new branch is created with 'git branch' or 'git checkout' 717 that tracks another branch, this variable tells Git to set 718 up pull to rebase instead of merge (see "branch.<name>.rebase"). 719 When `never`, rebase is never automatically set to true. 720 When `local`, rebase is set to true for tracked branches of 721 other local branches. 722 When `remote`, rebase is set to true for tracked branches of 723 remote-tracking branches. 724 When `always`, rebase will be set to true for all tracking 725 branches. 726 See "branch.autosetupmerge" for details on how to set up a 727 branch to track another branch. 728 This option defaults to never. 729 730branch.<name>.remote:: 731 When on branch <name>, it tells 'git fetch' and 'git push' 732 which remote to fetch from/push to. The remote to push to 733 may be overridden with `remote.pushdefault` (for all branches). 734 The remote to push to, for the current branch, may be further 735 overridden by `branch.<name>.pushremote`. If no remote is 736 configured, or if you are not on any branch, it defaults to 737 `origin` for fetching and `remote.pushdefault` for pushing. 738 Additionally, `.` (a period) is the current local repository 739 (a dot-repository), see `branch.<name>.merge`'s final note below. 740 741branch.<name>.pushremote:: 742 When on branch <name>, it overrides `branch.<name>.remote` for 743 pushing. It also overrides `remote.pushdefault` for pushing 744 from branch <name>. When you pull from one place (e.g. your 745 upstream) and push to another place (e.g. your own publishing 746 repository), you would want to set `remote.pushdefault` to 747 specify the remote to push to for all branches, and use this 748 option to override it for a specific branch. 749 750branch.<name>.merge:: 751 Defines, together with branch.<name>.remote, the upstream branch 752 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 753 branch to merge and can also affect 'git push' (see push.default). 754 When in branch <name>, it tells 'git fetch' the default 755 refspec to be marked for merging in FETCH_HEAD. The value is 756 handled like the remote part of a refspec, and must match a 757 ref which is fetched from the remote given by 758 "branch.<name>.remote". 759 The merge information is used by 'git pull' (which at first calls 760 'git fetch') to lookup the default branch for merging. Without 761 this option, 'git pull' defaults to merge the first refspec fetched. 762 Specify multiple values to get an octopus merge. 763 If you wish to setup 'git pull' so that it merges into <name> from 764 another branch in the local repository, you can point 765 branch.<name>.merge to the desired branch, and use the relative path 766 setting `.` (a period) for branch.<name>.remote. 767 768branch.<name>.mergeoptions:: 769 Sets default options for merging into branch <name>. The syntax and 770 supported options are the same as those of linkgit:git-merge[1], but 771 option values containing whitespace characters are currently not 772 supported. 773 774branch.<name>.rebase:: 775 When true, rebase the branch <name> on top of the fetched branch, 776 instead of merging the default branch from the default remote when 777 "git pull" is run. See "pull.rebase" for doing this in a non 778 branch-specific manner. 779+ 780 When preserve, also pass `--preserve-merges` along to 'git rebase' 781 so that locally committed merge commits will not be flattened 782 by running 'git pull'. 783+ 784*NOTE*: this is a possibly dangerous operation; do *not* use 785it unless you understand the implications (see linkgit:git-rebase[1] 786for details). 787 788branch.<name>.description:: 789 Branch description, can be edited with 790 `git branch --edit-description`. Branch description is 791 automatically added in the format-patch cover letter or 792 request-pull summary. 793 794browser.<tool>.cmd:: 795 Specify the command to invoke the specified browser. The 796 specified command is evaluated in shell with the URLs passed 797 as arguments. (See linkgit:git-web{litdd}browse[1].) 798 799browser.<tool>.path:: 800 Override the path for the given tool that may be used to 801 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 802 working repository in gitweb (see linkgit:git-instaweb[1]). 803 804clean.requireForce:: 805 A boolean to make git-clean do nothing unless given -f, 806 -i or -n. Defaults to true. 807 808color.branch:: 809 A boolean to enable/disable color in the output of 810 linkgit:git-branch[1]. May be set to `always`, 811 `false` (or `never`) or `auto` (or `true`), in which case colors are used 812 only when the output is to a terminal. Defaults to false. 813 814color.branch.<slot>:: 815 Use customized color for branch coloration. `<slot>` is one of 816 `current` (the current branch), `local` (a local branch), 817 `remote` (a remote-tracking branch in refs/remotes/), 818 `upstream` (upstream tracking branch), `plain` (other 819 refs). 820+ 821The value for these configuration variables is a list of colors (at most 822two) and attributes (at most one), separated by spaces. The colors 823accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 824`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 825`blink` and `reverse`. The first color given is the foreground; the 826second is the background. The position of the attribute, if any, 827doesn't matter. 828 829color.diff:: 830 Whether to use ANSI escape sequences to add color to patches. 831 If this is set to `always`, linkgit:git-diff[1], 832 linkgit:git-log[1], and linkgit:git-show[1] will use color 833 for all patches. If it is set to `true` or `auto`, those 834 commands will only use color when output is to the terminal. 835 Defaults to false. 836+ 837This does not affect linkgit:git-format-patch[1] nor the 838'git-diff-{asterisk}' plumbing commands. Can be overridden on the 839command line with the `--color[=<when>]` option. 840 841color.diff.<slot>:: 842 Use customized color for diff colorization. `<slot>` specifies 843 which part of the patch to use the specified color, and is one 844 of `plain` (context text), `meta` (metainformation), `frag` 845 (hunk header), 'func' (function in hunk header), `old` (removed lines), 846 `new` (added lines), `commit` (commit headers), or `whitespace` 847 (highlighting whitespace errors). The values of these variables may be 848 specified as in color.branch.<slot>. 849 850color.decorate.<slot>:: 851 Use customized color for 'git log --decorate' output. `<slot>` is one 852 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 853 branches, remote-tracking branches, tags, stash and HEAD, respectively. 854 855color.grep:: 856 When set to `always`, always highlight matches. When `false` (or 857 `never`), never. When set to `true` or `auto`, use color only 858 when the output is written to the terminal. Defaults to `false`. 859 860color.grep.<slot>:: 861 Use customized color for grep colorization. `<slot>` specifies which 862 part of the line to use the specified color, and is one of 863+ 864-- 865`context`;; 866 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 867`filename`;; 868 filename prefix (when not using `-h`) 869`function`;; 870 function name lines (when using `-p`) 871`linenumber`;; 872 line number prefix (when using `-n`) 873`match`;; 874 matching text 875`selected`;; 876 non-matching text in selected lines 877`separator`;; 878 separators between fields on a line (`:`, `-`, and `=`) 879 and between hunks (`--`) 880-- 881+ 882The values of these variables may be specified as in color.branch.<slot>. 883 884color.interactive:: 885 When set to `always`, always use colors for interactive prompts 886 and displays (such as those used by "git-add --interactive" and 887 "git-clean --interactive"). When false (or `never`), never. 888 When set to `true` or `auto`, use colors only when the output is 889 to the terminal. Defaults to false. 890 891color.interactive.<slot>:: 892 Use customized color for 'git add --interactive' and 'git clean 893 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 894 or `error`, for four distinct types of normal output from 895 interactive commands. The values of these variables may be 896 specified as in color.branch.<slot>. 897 898color.pager:: 899 A boolean to enable/disable colored output when the pager is in 900 use (default is true). 901 902color.showbranch:: 903 A boolean to enable/disable color in the output of 904 linkgit:git-show-branch[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:: 909 A boolean to enable/disable color in the output of 910 linkgit:git-status[1]. May be set to `always`, 911 `false` (or `never`) or `auto` (or `true`), in which case colors are used 912 only when the output is to a terminal. Defaults to false. 913 914color.status.<slot>:: 915 Use customized color for status colorization. `<slot>` is 916 one of `header` (the header text of the status message), 917 `added` or `updated` (files which are added but not committed), 918 `changed` (files which are changed but not added in the index), 919 `untracked` (files which are not tracked by Git), 920 `branch` (the current branch), or 921 `nobranch` (the color the 'no branch' warning is shown in, defaulting 922 to red). The values of these variables may be specified as in 923 color.branch.<slot>. 924 925color.ui:: 926 This variable determines the default value for variables such 927 as `color.diff` and `color.grep` that control the use of color 928 per command family. Its scope will expand as more commands learn 929 configuration to set a default for the `--color` option. Set it 930 to `false` or `never` if you prefer Git commands not to use 931 color unless enabled explicitly with some other configuration 932 or the `--color` option. Set it to `always` if you want all 933 output not intended for machine consumption to use color, to 934 `true` or `auto` (this is the default since Git 1.8.4) if you 935 want such output to use color when written to the terminal. 936 937column.ui:: 938 Specify whether supported commands should output in columns. 939 This variable consists of a list of tokens separated by spaces 940 or commas: 941+ 942These options control when the feature should be enabled 943(defaults to 'never'): 944+ 945-- 946`always`;; 947 always show in columns 948`never`;; 949 never show in columns 950`auto`;; 951 show in columns if the output is to the terminal 952-- 953+ 954These options control layout (defaults to 'column'). Setting any 955of these implies 'always' if none of 'always', 'never', or 'auto' are 956specified. 957+ 958-- 959`column`;; 960 fill columns before rows 961`row`;; 962 fill rows before columns 963`plain`;; 964 show in one column 965-- 966+ 967Finally, these options can be combined with a layout option (defaults 968to 'nodense'): 969+ 970-- 971`dense`;; 972 make unequal size columns to utilize more space 973`nodense`;; 974 make equal size columns 975-- 976 977column.branch:: 978 Specify whether to output branch listing in `git branch` in columns. 979 See `column.ui` for details. 980 981column.clean:: 982 Specify the layout when list items in `git clean -i`, which always 983 shows files and directories in columns. See `column.ui` for details. 984 985column.status:: 986 Specify whether to output untracked files in `git status` in columns. 987 See `column.ui` for details. 988 989column.tag:: 990 Specify whether to output tag listing in `git tag` in columns. 991 See `column.ui` for details. 992 993commit.cleanup:: 994 This setting overrides the default of the `--cleanup` option in 995 `git commit`. See linkgit:git-commit[1] for details. Changing the 996 default can be useful when you always want to keep lines that begin 997 with comment character `#` in your log message, in which case you 998 would do `git config commit.cleanup whitespace` (note that you will 999 have to remove the help lines that begin with `#` in the commit log1000 template yourself, if you do this).10011002commit.status::1003 A boolean to enable/disable inclusion of status information in the1004 commit message template when using an editor to prepare the commit1005 message. Defaults to true.10061007commit.template::1008 Specify a file to use as the template for new commit messages.1009 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1010 specified user's home directory.10111012credential.helper::1013 Specify an external helper to be called when a username or1014 password credential is needed; the helper may consult external1015 storage to avoid prompting the user for the credentials. See1016 linkgit:gitcredentials[7] for details.10171018credential.useHttpPath::1019 When acquiring credentials, consider the "path" component of an http1020 or https URL to be important. Defaults to false. See1021 linkgit:gitcredentials[7] for more information.10221023credential.username::1024 If no username is set for a network authentication, use this username1025 by default. See credential.<context>.* below, and1026 linkgit:gitcredentials[7].10271028credential.<url>.*::1029 Any of the credential.* options above can be applied selectively to1030 some credentials. For example "credential.https://example.com.username"1031 would set the default username only for https connections to1032 example.com. See linkgit:gitcredentials[7] for details on how URLs are1033 matched.10341035include::diff-config.txt[]10361037difftool.<tool>.path::1038 Override the path for the given tool. This is useful in case1039 your tool is not in the PATH.10401041difftool.<tool>.cmd::1042 Specify the command to invoke the specified diff tool.1043 The specified command is evaluated in shell with the following1044 variables available: 'LOCAL' is set to the name of the temporary1045 file containing the contents of the diff pre-image and 'REMOTE'1046 is set to the name of the temporary file containing the contents1047 of the diff post-image.10481049difftool.prompt::1050 Prompt before each invocation of the diff tool.10511052fetch.recurseSubmodules::1053 This option can be either set to a boolean value or to 'on-demand'.1054 Setting it to a boolean changes the behavior of fetch and pull to1055 unconditionally recurse into submodules when set to true or to not1056 recurse at all when set to false. When set to 'on-demand' (the default1057 value), fetch and pull will only recurse into a populated submodule1058 when its superproject retrieves a commit that updates the submodule's1059 reference.10601061fetch.fsckObjects::1062 If it is set to true, git-fetch-pack will check all fetched1063 objects. It will abort in the case of a malformed object or a1064 broken link. The result of an abort are only dangling objects.1065 Defaults to false. If not set, the value of `transfer.fsckObjects`1066 is used instead.10671068fetch.unpackLimit::1069 If the number of objects fetched over the Git native1070 transfer is below this1071 limit, then the objects will be unpacked into loose object1072 files. However if the number of received objects equals or1073 exceeds this limit then the received pack will be stored as1074 a pack, after adding any missing delta bases. Storing the1075 pack from a push can make the push operation complete faster,1076 especially on slow filesystems. If not set, the value of1077 `transfer.unpackLimit` is used instead.10781079fetch.prune::1080 If true, fetch will automatically behave as if the `--prune`1081 option was given on the command line. See also `remote.<name>.prune`.10821083format.attach::1084 Enable multipart/mixed attachments as the default for1085 'format-patch'. The value can also be a double quoted string1086 which will enable attachments as the default and set the1087 value as the boundary. See the --attach option in1088 linkgit:git-format-patch[1].10891090format.numbered::1091 A boolean which can enable or disable sequence numbers in patch1092 subjects. It defaults to "auto" which enables it only if there1093 is more than one patch. It can be enabled or disabled for all1094 messages by setting it to "true" or "false". See --numbered1095 option in linkgit:git-format-patch[1].10961097format.headers::1098 Additional email headers to include in a patch to be submitted1099 by mail. See linkgit:git-format-patch[1].11001101format.to::1102format.cc::1103 Additional recipients to include in a patch to be submitted1104 by mail. See the --to and --cc options in1105 linkgit:git-format-patch[1].11061107format.subjectprefix::1108 The default for format-patch is to output files with the '[PATCH]'1109 subject prefix. Use this variable to change that prefix.11101111format.signature::1112 The default for format-patch is to output a signature containing1113 the Git version number. Use this variable to change that default.1114 Set this variable to the empty string ("") to suppress1115 signature generation.11161117format.suffix::1118 The default for format-patch is to output files with the suffix1119 `.patch`. Use this variable to change that suffix (make sure to1120 include the dot if you want it).11211122format.pretty::1123 The default pretty format for log/show/whatchanged command,1124 See linkgit:git-log[1], linkgit:git-show[1],1125 linkgit:git-whatchanged[1].11261127format.thread::1128 The default threading style for 'git format-patch'. Can be1129 a boolean value, or `shallow` or `deep`. `shallow` threading1130 makes every mail a reply to the head of the series,1131 where the head is chosen from the cover letter, the1132 `--in-reply-to`, and the first patch mail, in this order.1133 `deep` threading makes every mail a reply to the previous one.1134 A true boolean value is the same as `shallow`, and a false1135 value disables threading.11361137format.signoff::1138 A boolean value which lets you enable the `-s/--signoff` option of1139 format-patch by default. *Note:* Adding the Signed-off-by: line to a1140 patch should be a conscious act and means that you certify you have1141 the rights to submit this work under the same open source license.1142 Please see the 'SubmittingPatches' document for further discussion.11431144format.coverLetter::1145 A boolean that controls whether to generate a cover-letter when1146 format-patch is invoked, but in addition can be set to "auto", to1147 generate a cover-letter only when there's more than one patch.11481149filter.<driver>.clean::1150 The command which is used to convert the content of a worktree1151 file to a blob upon checkin. See linkgit:gitattributes[5] for1152 details.11531154filter.<driver>.smudge::1155 The command which is used to convert the content of a blob1156 object to a worktree file upon checkout. See1157 linkgit:gitattributes[5] for details.11581159gc.aggressiveWindow::1160 The window size parameter used in the delta compression1161 algorithm used by 'git gc --aggressive'. This defaults1162 to 250.11631164gc.auto::1165 When there are approximately more than this many loose1166 objects in the repository, `git gc --auto` will pack them.1167 Some Porcelain commands use this command to perform a1168 light-weight garbage collection from time to time. The1169 default value is 6700. Setting this to 0 disables it.11701171gc.autopacklimit::1172 When there are more than this many packs that are not1173 marked with `*.keep` file in the repository, `git gc1174 --auto` consolidates them into one larger pack. The1175 default value is 50. Setting this to 0 disables it.11761177gc.packrefs::1178 Running `git pack-refs` in a repository renders it1179 unclonable by Git versions prior to 1.5.1.2 over dumb1180 transports such as HTTP. This variable determines whether1181 'git gc' runs `git pack-refs`. This can be set to `notbare`1182 to enable it within all non-bare repos or it can be set to a1183 boolean value. The default is `true`.11841185gc.pruneexpire::1186 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1187 Override the grace period with this config variable. The value1188 "now" may be used to disable this grace period and always prune1189 unreachable objects immediately.11901191gc.reflogexpire::1192gc.<pattern>.reflogexpire::1193 'git reflog expire' removes reflog entries older than1194 this time; defaults to 90 days. With "<pattern>" (e.g.1195 "refs/stash") in the middle the setting applies only to1196 the refs that match the <pattern>.11971198gc.reflogexpireunreachable::1199gc.<ref>.reflogexpireunreachable::1200 'git reflog expire' removes reflog entries older than1201 this time and are not reachable from the current tip;1202 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1203 in the middle, the setting applies only to the refs that1204 match the <pattern>.12051206gc.rerereresolved::1207 Records of conflicted merge you resolved earlier are1208 kept for this many days when 'git rerere gc' is run.1209 The default is 60 days. See linkgit:git-rerere[1].12101211gc.rerereunresolved::1212 Records of conflicted merge you have not resolved are1213 kept for this many days when 'git rerere gc' is run.1214 The default is 15 days. See linkgit:git-rerere[1].12151216gitcvs.commitmsgannotation::1217 Append this string to each commit message. Set to empty string1218 to disable this feature. Defaults to "via git-CVS emulator".12191220gitcvs.enabled::1221 Whether the CVS server interface is enabled for this repository.1222 See linkgit:git-cvsserver[1].12231224gitcvs.logfile::1225 Path to a log file where the CVS server interface well... logs1226 various stuff. See linkgit:git-cvsserver[1].12271228gitcvs.usecrlfattr::1229 If true, the server will look up the end-of-line conversion1230 attributes for files to determine the '-k' modes to use. If1231 the attributes force Git to treat a file as text,1232 the '-k' mode will be left blank so CVS clients will1233 treat it as text. If they suppress text conversion, the file1234 will be set with '-kb' mode, which suppresses any newline munging1235 the client might otherwise do. If the attributes do not allow1236 the file type to be determined, then 'gitcvs.allbinary' is1237 used. See linkgit:gitattributes[5].12381239gitcvs.allbinary::1240 This is used if 'gitcvs.usecrlfattr' does not resolve1241 the correct '-kb' mode to use. If true, all1242 unresolved files are sent to the client in1243 mode '-kb'. This causes the client to treat them1244 as binary files, which suppresses any newline munging it1245 otherwise might do. Alternatively, if it is set to "guess",1246 then the contents of the file are examined to decide if1247 it is binary, similar to 'core.autocrlf'.12481249gitcvs.dbname::1250 Database used by git-cvsserver to cache revision information1251 derived from the Git repository. The exact meaning depends on the1252 used database driver, for SQLite (which is the default driver) this1253 is a filename. Supports variable substitution (see1254 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1255 Default: '%Ggitcvs.%m.sqlite'12561257gitcvs.dbdriver::1258 Used Perl DBI driver. You can specify any available driver1259 for this here, but it might not work. git-cvsserver is tested1260 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1261 reported *not* to work with 'DBD::mysql'. Experimental feature.1262 May not contain double colons (`:`). Default: 'SQLite'.1263 See linkgit:git-cvsserver[1].12641265gitcvs.dbuser, gitcvs.dbpass::1266 Database user and password. Only useful if setting 'gitcvs.dbdriver',1267 since SQLite has no concept of database users and/or passwords.1268 'gitcvs.dbuser' supports variable substitution (see1269 linkgit:git-cvsserver[1] for details).12701271gitcvs.dbTableNamePrefix::1272 Database table name prefix. Prepended to the names of any1273 database tables used, allowing a single database to be used1274 for several repositories. Supports variable substitution (see1275 linkgit:git-cvsserver[1] for details). Any non-alphabetic1276 characters will be replaced with underscores.12771278All gitcvs variables except for 'gitcvs.usecrlfattr' and1279'gitcvs.allbinary' can also be specified as1280'gitcvs.<access_method>.<varname>' (where 'access_method'1281is one of "ext" and "pserver") to make them apply only for the given1282access method.12831284gitweb.category::1285gitweb.description::1286gitweb.owner::1287gitweb.url::1288 See linkgit:gitweb[1] for description.12891290gitweb.avatar::1291gitweb.blame::1292gitweb.grep::1293gitweb.highlight::1294gitweb.patches::1295gitweb.pickaxe::1296gitweb.remote_heads::1297gitweb.showsizes::1298gitweb.snapshot::1299 See linkgit:gitweb.conf[5] for description.13001301grep.lineNumber::1302 If set to true, enable '-n' option by default.13031304grep.patternType::1305 Set the default matching behavior. Using a value of 'basic', 'extended',1306 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1307 '--fixed-strings', or '--perl-regexp' option accordingly, while the1308 value 'default' will return to the default matching behavior.13091310grep.extendedRegexp::1311 If set to true, enable '--extended-regexp' option by default. This1312 option is ignored when the 'grep.patternType' option is set to a value1313 other than 'default'.13141315gpg.program::1316 Use this custom program instead of "gpg" found on $PATH when1317 making or verifying a PGP signature. The program must support the1318 same command line interface as GPG, namely, to verify a detached1319 signature, "gpg --verify $file - <$signature" is run, and the1320 program is expected to signal a good signature by exiting with1321 code 0, and to generate an ascii-armored detached signature, the1322 standard input of "gpg -bsau $key" is fed with the contents to be1323 signed, and the program is expected to send the result to its1324 standard output.13251326gui.commitmsgwidth::1327 Defines how wide the commit message window is in the1328 linkgit:git-gui[1]. "75" is the default.13291330gui.diffcontext::1331 Specifies how many context lines should be used in calls to diff1332 made by the linkgit:git-gui[1]. The default is "5".13331334gui.encoding::1335 Specifies the default encoding to use for displaying of1336 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1337 It can be overridden by setting the 'encoding' attribute1338 for relevant files (see linkgit:gitattributes[5]).1339 If this option is not set, the tools default to the1340 locale encoding.13411342gui.matchtrackingbranch::1343 Determines if new branches created with linkgit:git-gui[1] should1344 default to tracking remote branches with matching names or1345 not. Default: "false".13461347gui.newbranchtemplate::1348 Is used as suggested name when creating new branches using the1349 linkgit:git-gui[1].13501351gui.pruneduringfetch::1352 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1353 performing a fetch. The default value is "false".13541355gui.trustmtime::1356 Determines if linkgit:git-gui[1] should trust the file modification1357 timestamp or not. By default the timestamps are not trusted.13581359gui.spellingdictionary::1360 Specifies the dictionary used for spell checking commit messages in1361 the linkgit:git-gui[1]. When set to "none" spell checking is turned1362 off.13631364gui.fastcopyblame::1365 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1366 location detection. It makes blame significantly faster on huge1367 repositories at the expense of less thorough copy detection.13681369gui.copyblamethreshold::1370 Specifies the threshold to use in 'git gui blame' original location1371 detection, measured in alphanumeric characters. See the1372 linkgit:git-blame[1] manual for more information on copy detection.13731374gui.blamehistoryctx::1375 Specifies the radius of history context in days to show in1376 linkgit:gitk[1] for the selected commit, when the `Show History1377 Context` menu item is invoked from 'git gui blame'. If this1378 variable is set to zero, the whole history is shown.13791380guitool.<name>.cmd::1381 Specifies the shell command line to execute when the corresponding item1382 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1383 mandatory for every tool. The command is executed from the root of1384 the working directory, and in the environment it receives the name of1385 the tool as 'GIT_GUITOOL', the name of the currently selected file as1386 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1387 the head is detached, 'CUR_BRANCH' is empty).13881389guitool.<name>.needsfile::1390 Run the tool only if a diff is selected in the GUI. It guarantees1391 that 'FILENAME' is not empty.13921393guitool.<name>.noconsole::1394 Run the command silently, without creating a window to display its1395 output.13961397guitool.<name>.norescan::1398 Don't rescan the working directory for changes after the tool1399 finishes execution.14001401guitool.<name>.confirm::1402 Show a confirmation dialog before actually running the tool.14031404guitool.<name>.argprompt::1405 Request a string argument from the user, and pass it to the tool1406 through the 'ARGS' environment variable. Since requesting an1407 argument implies confirmation, the 'confirm' option has no effect1408 if this is enabled. If the option is set to 'true', 'yes', or '1',1409 the dialog uses a built-in generic prompt; otherwise the exact1410 value of the variable is used.14111412guitool.<name>.revprompt::1413 Request a single valid revision from the user, and set the1414 'REVISION' environment variable. In other aspects this option1415 is similar to 'argprompt', and can be used together with it.14161417guitool.<name>.revunmerged::1418 Show only unmerged branches in the 'revprompt' subdialog.1419 This is useful for tools similar to merge or rebase, but not1420 for things like checkout or reset.14211422guitool.<name>.title::1423 Specifies the title to use for the prompt dialog. The default1424 is the tool name.14251426guitool.<name>.prompt::1427 Specifies the general prompt string to display at the top of1428 the dialog, before subsections for 'argprompt' and 'revprompt'.1429 The default value includes the actual command.14301431help.browser::1432 Specify the browser that will be used to display help in the1433 'web' format. See linkgit:git-help[1].14341435help.format::1436 Override the default help format used by linkgit:git-help[1].1437 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1438 the default. 'web' and 'html' are the same.14391440help.autocorrect::1441 Automatically correct and execute mistyped commands after1442 waiting for the given number of deciseconds (0.1 sec). If more1443 than one command can be deduced from the entered text, nothing1444 will be executed. If the value of this option is negative,1445 the corrected command will be executed immediately. If the1446 value is 0 - the command will be just shown but not executed.1447 This is the default.14481449help.htmlpath::1450 Specify the path where the HTML documentation resides. File system paths1451 and URLs are supported. HTML pages will be prefixed with this path when1452 help is displayed in the 'web' format. This defaults to the documentation1453 path of your Git installation.14541455http.proxy::1456 Override the HTTP proxy, normally configured using the 'http_proxy',1457 'https_proxy', and 'all_proxy' environment variables (see1458 `curl(1)`). This can be overridden on a per-remote basis; see1459 remote.<name>.proxy14601461http.cookiefile::1462 File containing previously stored cookie lines which should be used1463 in the Git http session, if they match the server. The file format1464 of the file to read cookies from should be plain HTTP headers or1465 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1466 NOTE that the file specified with http.cookiefile is only used as1467 input unless http.saveCookies is set.14681469http.savecookies::1470 If set, store cookies received during requests to the file specified by1471 http.cookiefile. Has no effect if http.cookiefile is unset.14721473http.sslVerify::1474 Whether to verify the SSL certificate when fetching or pushing1475 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1476 variable.14771478http.sslCert::1479 File containing the SSL certificate when fetching or pushing1480 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1481 variable.14821483http.sslKey::1484 File containing the SSL private key when fetching or pushing1485 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1486 variable.14871488http.sslCertPasswordProtected::1489 Enable Git's password prompt for the SSL certificate. Otherwise1490 OpenSSL will prompt the user, possibly many times, if the1491 certificate or private key is encrypted. Can be overridden by the1492 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.14931494http.sslCAInfo::1495 File containing the certificates to verify the peer with when1496 fetching or pushing over HTTPS. Can be overridden by the1497 'GIT_SSL_CAINFO' environment variable.14981499http.sslCAPath::1500 Path containing files with the CA certificates to verify the peer1501 with when fetching or pushing over HTTPS. Can be overridden1502 by the 'GIT_SSL_CAPATH' environment variable.15031504http.sslTry::1505 Attempt to use AUTH SSL/TLS and encrypted data transfers1506 when connecting via regular FTP protocol. This might be needed1507 if the FTP server requires it for security reasons or you wish1508 to connect securely whenever remote FTP server supports it.1509 Default is false since it might trigger certificate verification1510 errors on misconfigured servers.15111512http.maxRequests::1513 How many HTTP requests to launch in parallel. Can be overridden1514 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15151516http.minSessions::1517 The number of curl sessions (counted across slots) to be kept across1518 requests. They will not be ended with curl_easy_cleanup() until1519 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1520 value will be capped at 1. Defaults to 1.15211522http.postBuffer::1523 Maximum size in bytes of the buffer used by smart HTTP1524 transports when POSTing data to the remote system.1525 For requests larger than this buffer size, HTTP/1.1 and1526 Transfer-Encoding: chunked is used to avoid creating a1527 massive pack file locally. Default is 1 MiB, which is1528 sufficient for most requests.15291530http.lowSpeedLimit, http.lowSpeedTime::1531 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1532 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1533 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1534 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15351536http.noEPSV::1537 A boolean which disables using of EPSV ftp command by curl.1538 This can helpful with some "poor" ftp servers which don't1539 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1540 environment variable. Default is false (curl will use EPSV).15411542http.useragent::1543 The HTTP USER_AGENT string presented to an HTTP server. The default1544 value represents the version of the client Git such as git/1.7.1.1545 This option allows you to override this value to a more common value1546 such as Mozilla/4.0. This may be necessary, for instance, if1547 connecting through a firewall that restricts HTTP connections to a set1548 of common USER_AGENT strings (but not including those like git/1.7.1).1549 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15501551http.<url>.*::1552 Any of the http.* options above can be applied selectively to some urls.1553 For a config key to match a URL, each element of the config key is1554 compared to that of the URL, in the following order:1555+1556--1557. Scheme (e.g., `https` in `https://example.com/`). This field1558 must match exactly between the config key and the URL.15591560. Host/domain name (e.g., `example.com` in `https://example.com/`).1561 This field must match exactly between the config key and the URL.15621563. Port number (e.g., `8080` in `http://example.com:8080/`).1564 This field must match exactly between the config key and the URL.1565 Omitted port numbers are automatically converted to the correct1566 default for the scheme before matching.15671568. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1569 path field of the config key must match the path field of the URL1570 either exactly or as a prefix of slash-delimited path elements. This means1571 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1572 match on a slash (`/`) boundary. Longer matches take precedence (so a config1573 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1574 key with just path `foo/`).15751576. User name (e.g., `user` in `https://user@example.com/repo.git`). If1577 the config key has a user name it must match the user name in the1578 URL exactly. If the config key does not have a user name, that1579 config key will match a URL with any user name (including none),1580 but at a lower precedence than a config key with a user name.1581--1582+1583The list above is ordered by decreasing precedence; a URL that matches1584a config key's path is preferred to one that matches its user name. For example,1585if the URL is `https://user@example.com/foo/bar` a config key match of1586`https://example.com/foo` will be preferred over a config key match of1587`https://user@example.com`.1588+1589All URLs are normalized before attempting any matching (the password part,1590if embedded in the URL, is always ignored for matching purposes) so that1591equivalent urls that are simply spelled differently will match properly.1592Environment variable settings always override any matches. The urls that are1593matched against are those given directly to Git commands. This means any URLs1594visited as a result of a redirection do not participate in matching.15951596i18n.commitEncoding::1597 Character encoding the commit messages are stored in; Git itself1598 does not care per se, but this information is necessary e.g. when1599 importing commits from emails or in the gitk graphical history1600 browser (and possibly at other places in the future or in other1601 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16021603i18n.logOutputEncoding::1604 Character encoding the commit messages are converted to when1605 running 'git log' and friends.16061607imap::1608 The configuration variables in the 'imap' section are described1609 in linkgit:git-imap-send[1].16101611init.templatedir::1612 Specify the directory from which templates will be copied.1613 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16141615instaweb.browser::1616 Specify the program that will be used to browse your working1617 repository in gitweb. See linkgit:git-instaweb[1].16181619instaweb.httpd::1620 The HTTP daemon command-line to start gitweb on your working1621 repository. See linkgit:git-instaweb[1].16221623instaweb.local::1624 If true the web server started by linkgit:git-instaweb[1] will1625 be bound to the local IP (127.0.0.1).16261627instaweb.modulepath::1628 The default module path for linkgit:git-instaweb[1] to use1629 instead of /usr/lib/apache2/modules. Only used if httpd1630 is Apache.16311632instaweb.port::1633 The port number to bind the gitweb httpd to. See1634 linkgit:git-instaweb[1].16351636interactive.singlekey::1637 In interactive commands, allow the user to provide one-letter1638 input with a single key (i.e., without hitting enter).1639 Currently this is used by the `--patch` mode of1640 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1641 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1642 setting is silently ignored if portable keystroke input1643 is not available.16441645log.abbrevCommit::1646 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1647 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1648 override this option with `--no-abbrev-commit`.16491650log.date::1651 Set the default date-time mode for the 'log' command.1652 Setting a value for log.date is similar to using 'git log''s1653 `--date` option. Possible values are `relative`, `local`,1654 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1655 for details.16561657log.decorate::1658 Print out the ref names of any commits that are shown by the log1659 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1660 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1661 specified, the full ref name (including prefix) will be printed.1662 This is the same as the log commands '--decorate' option.16631664log.showroot::1665 If true, the initial commit will be shown as a big creation event.1666 This is equivalent to a diff against an empty tree.1667 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1668 normally hide the root commit will now show it. True by default.16691670log.mailmap::1671 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1672 linkgit:git-whatchanged[1] assume `--use-mailmap`.16731674mailmap.file::1675 The location of an augmenting mailmap file. The default1676 mailmap, located in the root of the repository, is loaded1677 first, then the mailmap file pointed to by this variable.1678 The location of the mailmap file may be in a repository1679 subdirectory, or somewhere outside of the repository itself.1680 See linkgit:git-shortlog[1] and linkgit:git-blame[1].16811682mailmap.blob::1683 Like `mailmap.file`, but consider the value as a reference to a1684 blob in the repository. If both `mailmap.file` and1685 `mailmap.blob` are given, both are parsed, with entries from1686 `mailmap.file` taking precedence. In a bare repository, this1687 defaults to `HEAD:.mailmap`. In a non-bare repository, it1688 defaults to empty.16891690man.viewer::1691 Specify the programs that may be used to display help in the1692 'man' format. See linkgit:git-help[1].16931694man.<tool>.cmd::1695 Specify the command to invoke the specified man viewer. The1696 specified command is evaluated in shell with the man page1697 passed as argument. (See linkgit:git-help[1].)16981699man.<tool>.path::1700 Override the path for the given tool that may be used to1701 display help in the 'man' format. See linkgit:git-help[1].17021703include::merge-config.txt[]17041705mergetool.<tool>.path::1706 Override the path for the given tool. This is useful in case1707 your tool is not in the PATH.17081709mergetool.<tool>.cmd::1710 Specify the command to invoke the specified merge tool. The1711 specified command is evaluated in shell with the following1712 variables available: 'BASE' is the name of a temporary file1713 containing the common base of the files to be merged, if available;1714 'LOCAL' is the name of a temporary file containing the contents of1715 the file on the current branch; 'REMOTE' is the name of a temporary1716 file containing the contents of the file from the branch being1717 merged; 'MERGED' contains the name of the file to which the merge1718 tool should write the results of a successful merge.17191720mergetool.<tool>.trustExitCode::1721 For a custom merge command, specify whether the exit code of1722 the merge command can be used to determine whether the merge was1723 successful. If this is not set to true then the merge target file1724 timestamp is checked and the merge assumed to have been successful1725 if the file has been updated, otherwise the user is prompted to1726 indicate the success of the merge.17271728mergetool.keepBackup::1729 After performing a merge, the original file with conflict markers1730 can be saved as a file with a `.orig` extension. If this variable1731 is set to `false` then this file is not preserved. Defaults to1732 `true` (i.e. keep the backup files).17331734mergetool.keepTemporaries::1735 When invoking a custom merge tool, Git uses a set of temporary1736 files to pass to the tool. If the tool returns an error and this1737 variable is set to `true`, then these temporary files will be1738 preserved, otherwise they will be removed after the tool has1739 exited. Defaults to `false`.17401741mergetool.prompt::1742 Prompt before each invocation of the merge resolution program.17431744notes.displayRef::1745 The (fully qualified) refname from which to show notes when1746 showing commit messages. The value of this variable can be set1747 to a glob, in which case notes from all matching refs will be1748 shown. You may also specify this configuration variable1749 several times. A warning will be issued for refs that do not1750 exist, but a glob that does not match any refs is silently1751 ignored.1752+1753This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1754environment variable, which must be a colon separated list of refs or1755globs.1756+1757The effective value of "core.notesRef" (possibly overridden by1758GIT_NOTES_REF) is also implicitly added to the list of refs to be1759displayed.17601761notes.rewrite.<command>::1762 When rewriting commits with <command> (currently `amend` or1763 `rebase`) and this variable is set to `true`, Git1764 automatically copies your notes from the original to the1765 rewritten commit. Defaults to `true`, but see1766 "notes.rewriteRef" below.17671768notes.rewriteMode::1769 When copying notes during a rewrite (see the1770 "notes.rewrite.<command>" option), determines what to do if1771 the target commit already has a note. Must be one of1772 `overwrite`, `concatenate`, or `ignore`. Defaults to1773 `concatenate`.1774+1775This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1776environment variable.17771778notes.rewriteRef::1779 When copying notes during a rewrite, specifies the (fully1780 qualified) ref whose notes should be copied. The ref may be a1781 glob, in which case notes in all matching refs will be copied.1782 You may also specify this configuration several times.1783+1784Does not have a default value; you must configure this variable to1785enable note rewriting. Set it to `refs/notes/commits` to enable1786rewriting for the default commit notes.1787+1788This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1789environment variable, which must be a colon separated list of refs or1790globs.17911792pack.window::1793 The size of the window used by linkgit:git-pack-objects[1] when no1794 window size is given on the command line. Defaults to 10.17951796pack.depth::1797 The maximum delta depth used by linkgit:git-pack-objects[1] when no1798 maximum depth is given on the command line. Defaults to 50.17991800pack.windowMemory::1801 The window memory size limit used by linkgit:git-pack-objects[1]1802 when no limit is given on the command line. The value can be1803 suffixed with "k", "m", or "g". Defaults to 0, meaning no1804 limit.18051806pack.compression::1807 An integer -1..9, indicating the compression level for objects1808 in a pack file. -1 is the zlib default. 0 means no1809 compression, and 1..9 are various speed/size tradeoffs, 9 being1810 slowest. If not set, defaults to core.compression. If that is1811 not set, defaults to -1, the zlib default, which is "a default1812 compromise between speed and compression (currently equivalent1813 to level 6)."1814+1815Note that changing the compression level will not automatically recompress1816all existing objects. You can force recompression by passing the -F option1817to linkgit:git-repack[1].18181819pack.deltaCacheSize::1820 The maximum memory in bytes used for caching deltas in1821 linkgit:git-pack-objects[1] before writing them out to a pack.1822 This cache is used to speed up the writing object phase by not1823 having to recompute the final delta result once the best match1824 for all objects is found. Repacking large repositories on machines1825 which are tight with memory might be badly impacted by this though,1826 especially if this cache pushes the system into swapping.1827 A value of 0 means no limit. The smallest size of 1 byte may be1828 used to virtually disable this cache. Defaults to 256 MiB.18291830pack.deltaCacheLimit::1831 The maximum size of a delta, that is cached in1832 linkgit:git-pack-objects[1]. This cache is used to speed up the1833 writing object phase by not having to recompute the final delta1834 result once the best match for all objects is found. Defaults to 1000.18351836pack.threads::1837 Specifies the number of threads to spawn when searching for best1838 delta matches. This requires that linkgit:git-pack-objects[1]1839 be compiled with pthreads otherwise this option is ignored with a1840 warning. This is meant to reduce packing time on multiprocessor1841 machines. The required amount of memory for the delta search window1842 is however multiplied by the number of threads.1843 Specifying 0 will cause Git to auto-detect the number of CPU's1844 and set the number of threads accordingly.18451846pack.indexVersion::1847 Specify the default pack index version. Valid values are 1 for1848 legacy pack index used by Git versions prior to 1.5.2, and 2 for1849 the new pack index with capabilities for packs larger than 4 GB1850 as well as proper protection against the repacking of corrupted1851 packs. Version 2 is the default. Note that version 2 is enforced1852 and this config option ignored whenever the corresponding pack is1853 larger than 2 GB.1854+1855If you have an old Git that does not understand the version 2 `*.idx` file,1856cloning or fetching over a non native protocol (e.g. "http" and "rsync")1857that will copy both `*.pack` file and corresponding `*.idx` file from the1858other side may give you a repository that cannot be accessed with your1859older version of Git. If the `*.pack` file is smaller than 2 GB, however,1860you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1861the `*.idx` file.18621863pack.packSizeLimit::1864 The maximum size of a pack. This setting only affects1865 packing to a file when repacking, i.e. the git:// protocol1866 is unaffected. It can be overridden by the `--max-pack-size`1867 option of linkgit:git-repack[1]. The minimum size allowed is1868 limited to 1 MiB. The default is unlimited.1869 Common unit suffixes of 'k', 'm', or 'g' are1870 supported.18711872pager.<cmd>::1873 If the value is boolean, turns on or off pagination of the1874 output of a particular Git subcommand when writing to a tty.1875 Otherwise, turns on pagination for the subcommand using the1876 pager specified by the value of `pager.<cmd>`. If `--paginate`1877 or `--no-pager` is specified on the command line, it takes1878 precedence over this option. To disable pagination for all1879 commands, set `core.pager` or `GIT_PAGER` to `cat`.18801881pretty.<name>::1882 Alias for a --pretty= format string, as specified in1883 linkgit:git-log[1]. Any aliases defined here can be used just1884 as the built-in pretty formats could. For example,1885 running `git config pretty.changelog "format:* %H %s"`1886 would cause the invocation `git log --pretty=changelog`1887 to be equivalent to running `git log "--pretty=format:* %H %s"`.1888 Note that an alias with the same name as a built-in format1889 will be silently ignored.18901891pull.rebase::1892 When true, rebase branches on top of the fetched branch, instead1893 of merging the default branch from the default remote when "git1894 pull" is run. See "branch.<name>.rebase" for setting this on a1895 per-branch basis.1896+1897 When preserve, also pass `--preserve-merges` along to 'git rebase'1898 so that locally committed merge commits will not be flattened1899 by running 'git pull'.1900+1901*NOTE*: this is a possibly dangerous operation; do *not* use1902it unless you understand the implications (see linkgit:git-rebase[1]1903for details).19041905pull.octopus::1906 The default merge strategy to use when pulling multiple branches1907 at once.19081909pull.twohead::1910 The default merge strategy to use when pulling a single branch.19111912push.default::1913 Defines the action `git push` should take if no refspec is1914 explicitly given. Different values are well-suited for1915 specific workflows; for instance, in a purely central workflow1916 (i.e. the fetch source is equal to the push destination),1917 `upstream` is probably what you want. Possible values are:1918+1919--19201921* `nothing` - do not push anything (error out) unless a refspec is1922 explicitly given. This is primarily meant for people who want to1923 avoid mistakes by always being explicit.19241925* `current` - push the current branch to update a branch with the same1926 name on the receiving end. Works in both central and non-central1927 workflows.19281929* `upstream` - push the current branch back to the branch whose1930 changes are usually integrated into the current branch (which is1931 called `@{upstream}`). This mode only makes sense if you are1932 pushing to the same repository you would normally pull from1933 (i.e. central workflow).19341935* `simple` - in centralized workflow, work like `upstream` with an1936 added safety to refuse to push if the upstream branch's name is1937 different from the local one.1938+1939When pushing to a remote that is different from the remote you normally1940pull from, work as `current`. This is the safest option and is suited1941for beginners.1942+1943This mode will become the default in Git 2.0.19441945* `matching` - push all branches having the same name on both ends.1946 This makes the repository you are pushing to remember the set of1947 branches that will be pushed out (e.g. if you always push 'maint'1948 and 'master' there and no other branches, the repository you push1949 to will have these two branches, and your local 'maint' and1950 'master' will be pushed there).1951+1952To use this mode effectively, you have to make sure _all_ the1953branches you would push out are ready to be pushed out before1954running 'git push', as the whole point of this mode is to allow you1955to push all of the branches in one go. If you usually finish work1956on only one branch and push out the result, while other branches are1957unfinished, this mode is not for you. Also this mode is not1958suitable for pushing into a shared central repository, as other1959people may add new branches there, or update the tip of existing1960branches outside your control.1961+1962This is currently the default, but Git 2.0 will change the default1963to `simple`.19641965--19661967rebase.stat::1968 Whether to show a diffstat of what changed upstream since the last1969 rebase. False by default.19701971rebase.autosquash::1972 If set to true enable '--autosquash' option by default.19731974rebase.autostash::1975 When set to true, automatically create a temporary stash1976 before the operation begins, and apply it after the operation1977 ends. This means that you can run rebase on a dirty worktree.1978 However, use with care: the final stash application after a1979 successful rebase might result in non-trivial conflicts.1980 Defaults to false.19811982receive.autogc::1983 By default, git-receive-pack will run "git-gc --auto" after1984 receiving data from git-push and updating refs. You can stop1985 it by setting this variable to false.19861987receive.fsckObjects::1988 If it is set to true, git-receive-pack will check all received1989 objects. It will abort in the case of a malformed object or a1990 broken link. The result of an abort are only dangling objects.1991 Defaults to false. If not set, the value of `transfer.fsckObjects`1992 is used instead.19931994receive.unpackLimit::1995 If the number of objects received in a push is below this1996 limit then the objects will be unpacked into loose object1997 files. However if the number of received objects equals or1998 exceeds this limit then the received pack will be stored as1999 a pack, after adding any missing delta bases. Storing the2000 pack from a push can make the push operation complete faster,2001 especially on slow filesystems. If not set, the value of2002 `transfer.unpackLimit` is used instead.20032004receive.denyDeletes::2005 If set to true, git-receive-pack will deny a ref update that deletes2006 the ref. Use this to prevent such a ref deletion via a push.20072008receive.denyDeleteCurrent::2009 If set to true, git-receive-pack will deny a ref update that2010 deletes the currently checked out branch of a non-bare repository.20112012receive.denyCurrentBranch::2013 If set to true or "refuse", git-receive-pack will deny a ref update2014 to the currently checked out branch of a non-bare repository.2015 Such a push is potentially dangerous because it brings the HEAD2016 out of sync with the index and working tree. If set to "warn",2017 print a warning of such a push to stderr, but allow the push to2018 proceed. If set to false or "ignore", allow such pushes with no2019 message. Defaults to "refuse".20202021receive.denyNonFastForwards::2022 If set to true, git-receive-pack will deny a ref update which is2023 not a fast-forward. Use this to prevent such an update via a push,2024 even if that push is forced. This configuration variable is2025 set when initializing a shared repository.20262027receive.hiderefs::2028 String(s) `receive-pack` uses to decide which refs to omit2029 from its initial advertisement. Use more than one2030 definitions to specify multiple prefix strings. A ref that2031 are under the hierarchies listed on the value of this2032 variable is excluded, and is hidden when responding to `git2033 push`, and an attempt to update or delete a hidden ref by2034 `git push` is rejected.20352036receive.updateserverinfo::2037 If set to true, git-receive-pack will run git-update-server-info2038 after receiving data from git-push and updating refs.20392040remote.pushdefault::2041 The remote to push to by default. Overrides2042 `branch.<name>.remote` for all branches, and is overridden by2043 `branch.<name>.pushremote` for specific branches.20442045remote.<name>.url::2046 The URL of a remote repository. See linkgit:git-fetch[1] or2047 linkgit:git-push[1].20482049remote.<name>.pushurl::2050 The push URL of a remote repository. See linkgit:git-push[1].20512052remote.<name>.proxy::2053 For remotes that require curl (http, https and ftp), the URL to2054 the proxy to use for that remote. Set to the empty string to2055 disable proxying for that remote.20562057remote.<name>.fetch::2058 The default set of "refspec" for linkgit:git-fetch[1]. See2059 linkgit:git-fetch[1].20602061remote.<name>.push::2062 The default set of "refspec" for linkgit:git-push[1]. See2063 linkgit:git-push[1].20642065remote.<name>.mirror::2066 If true, pushing to this remote will automatically behave2067 as if the `--mirror` option was given on the command line.20682069remote.<name>.skipDefaultUpdate::2070 If true, this remote will be skipped by default when updating2071 using linkgit:git-fetch[1] or the `update` subcommand of2072 linkgit:git-remote[1].20732074remote.<name>.skipFetchAll::2075 If true, this remote will be skipped by default when updating2076 using linkgit:git-fetch[1] or the `update` subcommand of2077 linkgit:git-remote[1].20782079remote.<name>.receivepack::2080 The default program to execute on the remote side when pushing. See2081 option \--receive-pack of linkgit:git-push[1].20822083remote.<name>.uploadpack::2084 The default program to execute on the remote side when fetching. See2085 option \--upload-pack of linkgit:git-fetch-pack[1].20862087remote.<name>.tagopt::2088 Setting this value to \--no-tags disables automatic tag following when2089 fetching from remote <name>. Setting it to \--tags will fetch every2090 tag from remote <name>, even if they are not reachable from remote2091 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2092 override this setting. See options \--tags and \--no-tags of2093 linkgit:git-fetch[1].20942095remote.<name>.vcs::2096 Setting this to a value <vcs> will cause Git to interact with2097 the remote with the git-remote-<vcs> helper.20982099remote.<name>.prune::2100 When set to true, fetching from this remote by default will also2101 remove any remote-tracking branches which no longer exist on the2102 remote (as if the `--prune` option was give on the command line).2103 Overrides `fetch.prune` settings, if any.21042105remotes.<group>::2106 The list of remotes which are fetched by "git remote update2107 <group>". See linkgit:git-remote[1].21082109repack.usedeltabaseoffset::2110 By default, linkgit:git-repack[1] creates packs that use2111 delta-base offset. If you need to share your repository with2112 Git older than version 1.4.4, either directly or via a dumb2113 protocol such as http, then you need to set this option to2114 "false" and repack. Access from old Git versions over the2115 native protocol are unaffected by this option.21162117rerere.autoupdate::2118 When set to true, `git-rerere` updates the index with the2119 resulting contents after it cleanly resolves conflicts using2120 previously recorded resolution. Defaults to false.21212122rerere.enabled::2123 Activate recording of resolved conflicts, so that identical2124 conflict hunks can be resolved automatically, should they be2125 encountered again. By default, linkgit:git-rerere[1] is2126 enabled if there is an `rr-cache` directory under the2127 `$GIT_DIR`, e.g. if "rerere" was previously used in the2128 repository.21292130sendemail.identity::2131 A configuration identity. When given, causes values in the2132 'sendemail.<identity>' subsection to take precedence over2133 values in the 'sendemail' section. The default identity is2134 the value of 'sendemail.identity'.21352136sendemail.smtpencryption::2137 See linkgit:git-send-email[1] for description. Note that this2138 setting is not subject to the 'identity' mechanism.21392140sendemail.smtpssl::2141 Deprecated alias for 'sendemail.smtpencryption = ssl'.21422143sendemail.smtpsslcertpath::2144 Path to ca-certificates (either a directory or a single file).2145 Set it to an empty string to disable certificate verification.21462147sendemail.<identity>.*::2148 Identity-specific versions of the 'sendemail.*' parameters2149 found below, taking precedence over those when the this2150 identity is selected, through command-line or2151 'sendemail.identity'.21522153sendemail.aliasesfile::2154sendemail.aliasfiletype::2155sendemail.annotate::2156sendemail.bcc::2157sendemail.cc::2158sendemail.cccmd::2159sendemail.chainreplyto::2160sendemail.confirm::2161sendemail.envelopesender::2162sendemail.from::2163sendemail.multiedit::2164sendemail.signedoffbycc::2165sendemail.smtppass::2166sendemail.suppresscc::2167sendemail.suppressfrom::2168sendemail.to::2169sendemail.smtpdomain::2170sendemail.smtpserver::2171sendemail.smtpserverport::2172sendemail.smtpserveroption::2173sendemail.smtpuser::2174sendemail.thread::2175sendemail.validate::2176 See linkgit:git-send-email[1] for description.21772178sendemail.signedoffcc::2179 Deprecated alias for 'sendemail.signedoffbycc'.21802181showbranch.default::2182 The default set of branches for linkgit:git-show-branch[1].2183 See linkgit:git-show-branch[1].21842185status.relativePaths::2186 By default, linkgit:git-status[1] shows paths relative to the2187 current directory. Setting this variable to `false` shows paths2188 relative to the repository root (this was the default for Git2189 prior to v1.5.4).21902191status.short::2192 Set to true to enable --short by default in linkgit:git-status[1].2193 The option --no-short takes precedence over this variable.21942195status.branch::2196 Set to true to enable --branch by default in linkgit:git-status[1].2197 The option --no-branch takes precedence over this variable.21982199status.displayCommentPrefix::2200 If set to true, linkgit:git-status[1] will insert a comment2201 prefix before each output line (starting with2202 `core.commentChar`, i.e. `#` by default). This was the2203 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2204 Defaults to false.22052206status.showUntrackedFiles::2207 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2208 files which are not currently tracked by Git. Directories which2209 contain only untracked files, are shown with the directory name2210 only. Showing untracked files means that Git needs to lstat() all2211 all the files in the whole repository, which might be slow on some2212 systems. So, this variable controls how the commands displays2213 the untracked files. Possible values are:2214+2215--2216* `no` - Show no untracked files.2217* `normal` - Show untracked files and directories.2218* `all` - Show also individual files in untracked directories.2219--2220+2221If this variable is not specified, it defaults to 'normal'.2222This variable can be overridden with the -u|--untracked-files option2223of linkgit:git-status[1] and linkgit:git-commit[1].22242225status.submodulesummary::2226 Defaults to false.2227 If this is set to a non zero number or true (identical to -1 or an2228 unlimited number), the submodule summary will be enabled and a2229 summary of commits for modified submodules will be shown (see2230 --summary-limit option of linkgit:git-submodule[1]). Please note2231 that the summary output command will be suppressed for all2232 submodules when `diff.ignoreSubmodules` is set to 'all' or only2233 for those submodules where `submodule.<name>.ignore=all`. To2234 also view the summary for ignored submodules you can either use2235 the --ignore-submodules=dirty command line option or the 'git2236 submodule summary' command, which shows a similar output but does2237 not honor these settings.22382239submodule.<name>.path::2240submodule.<name>.url::2241submodule.<name>.update::2242 The path within this project, URL, and the updating strategy2243 for a submodule. These variables are initially populated2244 by 'git submodule init'; edit them to override the2245 URL and other values found in the `.gitmodules` file. See2246 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.22472248submodule.<name>.branch::2249 The remote branch name for a submodule, used by `git submodule2250 update --remote`. Set this option to override the value found in2251 the `.gitmodules` file. See linkgit:git-submodule[1] and2252 linkgit:gitmodules[5] for details.22532254submodule.<name>.fetchRecurseSubmodules::2255 This option can be used to control recursive fetching of this2256 submodule. It can be overridden by using the --[no-]recurse-submodules2257 command line option to "git fetch" and "git pull".2258 This setting will override that from in the linkgit:gitmodules[5]2259 file.22602261submodule.<name>.ignore::2262 Defines under what circumstances "git status" and the diff family show2263 a submodule as modified. When set to "all", it will never be considered2264 modified, "dirty" will ignore all changes to the submodules work tree and2265 takes only differences between the HEAD of the submodule and the commit2266 recorded in the superproject into account. "untracked" will additionally2267 let submodules with modified tracked files in their work tree show up.2268 Using "none" (the default when this option is not set) also shows2269 submodules that have untracked files in their work tree as changed.2270 This setting overrides any setting made in .gitmodules for this submodule,2271 both settings can be overridden on the command line by using the2272 "--ignore-submodules" option. The 'git submodule' commands are not2273 affected by this setting.22742275tar.umask::2276 This variable can be used to restrict the permission bits of2277 tar archive entries. The default is 0002, which turns off the2278 world write bit. The special value "user" indicates that the2279 archiving user's umask will be used instead. See umask(2) and2280 linkgit:git-archive[1].22812282transfer.fsckObjects::2283 When `fetch.fsckObjects` or `receive.fsckObjects` are2284 not set, the value of this variable is used instead.2285 Defaults to false.22862287transfer.hiderefs::2288 This variable can be used to set both `receive.hiderefs`2289 and `uploadpack.hiderefs` at the same time to the same2290 values. See entries for these other variables.22912292transfer.unpackLimit::2293 When `fetch.unpackLimit` or `receive.unpackLimit` are2294 not set, the value of this variable is used instead.2295 The default value is 100.22962297uploadpack.hiderefs::2298 String(s) `upload-pack` uses to decide which refs to omit2299 from its initial advertisement. Use more than one2300 definitions to specify multiple prefix strings. A ref that2301 are under the hierarchies listed on the value of this2302 variable is excluded, and is hidden from `git ls-remote`,2303 `git fetch`, etc. An attempt to fetch a hidden ref by `git2304 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.23052306uploadpack.allowtipsha1inwant::2307 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2308 to accept a fetch request that asks for an object at the tip2309 of a hidden ref (by default, such a request is rejected).2310 see also `uploadpack.hiderefs`.23112312uploadpack.keepalive::2313 When `upload-pack` has started `pack-objects`, there may be a2314 quiet period while `pack-objects` prepares the pack. Normally2315 it would output progress information, but if `--quiet` was used2316 for the fetch, `pack-objects` will output nothing at all until2317 the pack data begins. Some clients and networks may consider2318 the server to be hung and give up. Setting this option instructs2319 `upload-pack` to send an empty keepalive packet every2320 `uploadpack.keepalive` seconds. Setting this option to 02321 disables keepalive packets entirely. The default is 5 seconds.23222323url.<base>.insteadOf::2324 Any URL that starts with this value will be rewritten to2325 start, instead, with <base>. In cases where some site serves a2326 large number of repositories, and serves them with multiple2327 access methods, and some users need to use different access2328 methods, this feature allows people to specify any of the2329 equivalent URLs and have Git automatically rewrite the URL to2330 the best alternative for the particular user, even for a2331 never-before-seen repository on the site. When more than one2332 insteadOf strings match a given URL, the longest match is used.23332334url.<base>.pushInsteadOf::2335 Any URL that starts with this value will not be pushed to;2336 instead, it will be rewritten to start with <base>, and the2337 resulting URL will be pushed to. In cases where some site serves2338 a large number of repositories, and serves them with multiple2339 access methods, some of which do not allow push, this feature2340 allows people to specify a pull-only URL and have Git2341 automatically use an appropriate URL to push, even for a2342 never-before-seen repository on the site. When more than one2343 pushInsteadOf strings match a given URL, the longest match is2344 used. If a remote has an explicit pushurl, Git will ignore this2345 setting for that remote.23462347user.email::2348 Your email address to be recorded in any newly created commits.2349 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2350 'EMAIL' environment variables. See linkgit:git-commit-tree[1].23512352user.name::2353 Your full name to be recorded in any newly created commits.2354 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2355 environment variables. See linkgit:git-commit-tree[1].23562357user.signingkey::2358 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2359 key you want it to automatically when creating a signed tag or2360 commit, you can override the default selection with this variable.2361 This option is passed unchanged to gpg's --local-user parameter,2362 so you may specify a key using any method that gpg supports.23632364web.browser::2365 Specify a web browser that may be used by some commands.2366 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2367 may use it.