1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's 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 and only alphanumeric 16characters are allowed. Some variables may appear multiple times. 17 18Syntax 19~~~~~~ 20 21The syntax is fairly flexible and permissive; whitespaces are mostly 22ignored. The '#' and ';' characters begin comments to the end of line, 23blank lines are ignored. 24 25The file consists of sections and variables. A section begins with 26the name of the section in square brackets and continues until the next 27section begins. Section names are not case sensitive. Only alphanumeric 28characters, `-` and `.` are allowed in section names. Each variable 29must belong to some section, which means that there must be a section 30header before the first setting of a variable. 31 32Sections can be further divided into subsections. To begin a subsection 33put its name in double quotes, separated by space from the section name, 34in the section header, like in the example below: 35 36-------- 37 [section "subsection"] 38 39-------- 40 41Subsection names are case sensitive and can contain any characters except 42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 43respectively). Section headers cannot span multiple 44lines. Variables may belong directly to a section or to a given subsection. 45You can have `[section]` if you have `[section "subsection"]`, but you 46don't need to. 47 48There is also a case insensitive alternative `[section.subsection]` syntax. 49In this syntax, subsection names follow the same restrictions as for section 50names. 51 52All the other lines (and the remainder of the line after the section 53header) are recognized as setting variables, in the form 54'name = value'. If there is no equal sign on the line, the entire line 55is taken as 'name' and the variable is recognized as boolean "true". 56The variable names are case-insensitive and only alphanumeric 57characters and `-` are allowed. There can be more than one value 58for a given variable; we say then that variable is multivalued. 59 60Leading and trailing whitespace in a variable value is discarded. 61Internal whitespace within a variable value is retained verbatim. 62 63The values following the equals sign in variable assign are all either 64a string, an integer, or a boolean. Boolean values may be given as yes/no, 650/1, true/false or on/off. Case is not significant in boolean values, when 66converting value to the canonical form using '--bool' type specifier; 67'git config' will ensure that the output is "true" or "false". 68 69String values may be entirely or partially enclosed in double quotes. 70You need to enclose variable values in double quotes if you want to 71preserve leading or trailing whitespace, or if the variable value contains 72comment characters (i.e. it contains '#' or ';'). 73Double quote `"` and backslash `\` characters in variable values must 74be escaped: use `\"` for `"` and `\\` for `\`. 75 76The following escape sequences (beside `\"` and `\\`) are recognized: 77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 78and `\b` for backspace (BS). No other char escape sequence, nor octal 79char sequences are valid. 80 81Variable values ending in a `\` are continued on the next line in the 82customary UNIX fashion. 83 84Some variables may require a special value format. 85 86Example 87~~~~~~~ 88 89 # Core variables 90 [core] 91 ; Don't trust file modes 92 filemode = false 93 94 # Our diff algorithm 95 [diff] 96 external = /usr/local/bin/diff-wrapper 97 renames = true 98 99 [branch "devel"] 100 remote = origin 101 merge = refs/heads/devel 102 103 # Proxy settings 104 [core] 105 gitProxy="ssh" for "kernel.org" 106 gitProxy=default-proxy ; for the rest 107 108Variables 109~~~~~~~~~ 110 111Note that this list is non-comprehensive and not necessarily complete. 112For command-specific variables, you will find a more detailed description 113in the appropriate manual page. You will find a description of non-core 114porcelain configuration variables in the respective porcelain documentation. 115 116advice.*:: 117 When set to 'true', display the given optional help message. 118 When set to 'false', do not display. The configuration variables 119 are: 120+ 121-- 122 pushNonFastForward:: 123 Advice shown when linkgit:git-push[1] refuses 124 non-fast-forward refs. Default: true. 125 statusHints:: 126 Directions on how to stage/unstage/add shown in the 127 output of linkgit:git-status[1] and the template shown 128 when writing commit messages. Default: true. 129 commitBeforeMerge:: 130 Advice shown when linkgit:git-merge[1] refuses to 131 merge to avoid overwritting local changes. 132 Default: true. 133 resolveConflict:: 134 Advices shown by various commands when conflicts 135 prevent the operation from being performed. 136 Default: true. 137 implicitIdentity:: 138 Advice on how to set your identity configuration when 139 your information is guessed from the system username and 140 domain name. Default: true. 141 142 detachedHead:: 143 Advice shown when you used linkgit::git-checkout[1] to 144 move to the detach HEAD state, to instruct how to create 145 a local branch after the fact. Default: true. 146-- 147 148core.fileMode:: 149 If false, the executable bit differences between the index and 150 the working copy are ignored; useful on broken filesystems like FAT. 151 See linkgit:git-update-index[1]. 152+ 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 154will probe and set core.fileMode false if appropriate when the 155repository is created. 156 157core.ignoreCygwinFSTricks:: 158 This option is only used by Cygwin implementation of Git. If false, 159 the Cygwin stat() and lstat() functions are used. This may be useful 160 if your repository consists of a few separate directories joined in 161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 162 whenever it is possible and falls back to Cygwin functions only to 163 handle symbol links. The native mode is more than twice faster than 164 normal Cygwin l/stat() functions. True by default, unless core.filemode 165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 166 POSIX emulation is required to support core.filemode. 167 168core.ignorecase:: 169 If true, this option enables various workarounds to enable 170 git to work better on filesystems that are not case sensitive, 171 like FAT. For example, if a directory listing finds 172 "makefile" when git expects "Makefile", git will assume 173 it is really the same file, and continue to remember it as 174 "Makefile". 175+ 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 177will probe and set core.ignorecase true if appropriate when the repository 178is created. 179 180core.trustctime:: 181 If false, the ctime differences between the index and the 182 working copy are ignored; useful when the inode change time 183 is regularly modified by something outside Git (file system 184 crawlers and some backup systems). 185 See linkgit:git-update-index[1]. True by default. 186 187core.quotepath:: 188 The commands that output paths (e.g. 'ls-files', 189 'diff'), when not given the `-z` option, will quote 190 "unusual" characters in the pathname by enclosing the 191 pathname in a double-quote pair and with backslashes the 192 same way strings in C source code are quoted. If this 193 variable is set to false, the bytes higher than 0x80 are 194 not quoted but output as verbatim. Note that double 195 quote, backslash and control characters are always 196 quoted without `-z` regardless of the setting of this 197 variable. 198 199core.eol:: 200 Sets the line ending type to use in the working directory for 201 files that have the `text` property set. Alternatives are 202 'lf', 'crlf' and 'native', which uses the platform's native 203 line ending. The default value is `native`. See 204 linkgit:gitattributes[5] for more information on end-of-line 205 conversion. 206 207core.safecrlf:: 208 If true, makes git check if converting `CRLF` is reversible when 209 end-of-line conversion is active. Git will verify if a command 210 modifies a file in the work tree either directly or indirectly. 211 For example, committing a file followed by checking out the 212 same file should yield the original file in the work tree. If 213 this is not the case for the current setting of 214 `core.autocrlf`, git will reject the file. The variable can 215 be set to "warn", in which case git will only warn about an 216 irreversible conversion but continue the operation. 217+ 218CRLF conversion bears a slight chance of corrupting data. 219When it is enabled, git will convert CRLF to LF during commit and LF to 220CRLF during checkout. A file that contains a mixture of LF and 221CRLF before the commit cannot be recreated by git. For text 222files this is the right thing to do: it corrects line endings 223such that we have only LF line endings in the repository. 224But for binary files that are accidentally classified as text the 225conversion can corrupt data. 226+ 227If you recognize such corruption early you can easily fix it by 228setting the conversion type explicitly in .gitattributes. Right 229after committing you still have the original file in your work 230tree and this file is not yet corrupted. You can explicitly tell 231git that this file is binary and git will handle the file 232appropriately. 233+ 234Unfortunately, the desired effect of cleaning up text files with 235mixed line endings and the undesired effect of corrupting binary 236files cannot be distinguished. In both cases CRLFs are removed 237in an irreversible way. For text files this is the right thing 238to do because CRLFs are line endings, while for binary files 239converting CRLFs corrupts data. 240+ 241Note, this safety check does not mean that a checkout will generate a 242file identical to the original file for a different setting of 243`core.eol` and `core.autocrlf`, but only for the current one. For 244example, a text file with `LF` would be accepted with `core.eol=lf` 245and could later be checked out with `core.eol=crlf`, in which case the 246resulting file would contain `CRLF`, although the original file 247contained `LF`. However, in both work trees the line endings would be 248consistent, that is either all `LF` or all `CRLF`, but never mixed. A 249file with mixed line endings would be reported by the `core.safecrlf` 250mechanism. 251 252core.autocrlf:: 253 Setting this variable to "true" is almost the same as setting 254 the `text` attribute to "auto" on all files except that text 255 files are not guaranteed to be normalized: files that contain 256 `CRLF` in the repository will not be touched. Use this 257 setting if you want to have `CRLF` line endings in your 258 working directory even though the repository does not have 259 normalized line endings. This variable can be set to 'input', 260 in which case no output conversion is performed. 261 262core.symlinks:: 263 If false, symbolic links are checked out as small plain files that 264 contain the link text. linkgit:git-update-index[1] and 265 linkgit:git-add[1] will not change the recorded type to regular 266 file. Useful on filesystems like FAT that do not support 267 symbolic links. 268+ 269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 270will probe and set core.symlinks false if appropriate when the repository 271is created. 272 273core.gitProxy:: 274 A "proxy command" to execute (as 'command host port') instead 275 of establishing direct connection to the remote server when 276 using the git protocol for fetching. If the variable value is 277 in the "COMMAND for DOMAIN" format, the command is applied only 278 on hostnames ending with the specified domain string. This variable 279 may be set multiple times and is matched in the given order; 280 the first match wins. 281+ 282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 283(which always applies universally, without the special "for" 284handling). 285+ 286The special string `none` can be used as the proxy command to 287specify that no proxy be used for a given domain pattern. 288This is useful for excluding servers inside a firewall from 289proxy use, while defaulting to a common proxy for external domains. 290 291core.ignoreStat:: 292 If true, commands which modify both the working tree and the index 293 will mark the updated paths with the "assume unchanged" bit in the 294 index. These marked files are then assumed to stay unchanged in the 295 working copy, until you mark them otherwise manually - Git will not 296 detect the file changes by lstat() calls. This is useful on systems 297 where those are very slow, such as Microsoft Windows. 298 See linkgit:git-update-index[1]. 299 False by default. 300 301core.preferSymlinkRefs:: 302 Instead of the default "symref" format for HEAD 303 and other symbolic reference files, use symbolic links. 304 This is sometimes needed to work with old scripts that 305 expect HEAD to be a symbolic link. 306 307core.bare:: 308 If true this repository is assumed to be 'bare' and has no 309 working directory associated with it. If this is the case a 310 number of commands that require a working directory will be 311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 312+ 313This setting is automatically guessed by linkgit:git-clone[1] or 314linkgit:git-init[1] when the repository was created. By default a 315repository that ends in "/.git" is assumed to be not bare (bare = 316false), while all other repositories are assumed to be bare (bare 317= true). 318 319core.worktree:: 320 Set the path to the root of the work tree. 321 This can be overridden by the GIT_WORK_TREE environment 322 variable and the '--work-tree' command line option. It can be 323 an absolute path or a relative path to the .git directory, 324 either specified by --git-dir or GIT_DIR, or automatically 325 discovered. 326 If --git-dir or GIT_DIR are specified but none of 327 --work-tree, GIT_WORK_TREE and core.worktree is specified, 328 the current working directory is regarded as the root of the 329 work tree. 330+ 331Note that this variable is honored even when set in a configuration 332file in a ".git" subdirectory of a directory, and its value differs 333from the latter directory (e.g. "/path/to/.git/config" has 334core.worktree set to "/different/path"), which is most likely a 335misconfiguration. Running git commands in "/path/to" directory will 336still use "/different/path" as the root of the work tree and can cause 337great confusion to the users. 338 339core.logAllRefUpdates:: 340 Enable the reflog. Updates to a ref <ref> is logged to the file 341 "$GIT_DIR/logs/<ref>", by appending the new and old 342 SHA1, the date/time and the reason of the update, but 343 only when the file exists. If this configuration 344 variable is set to true, missing "$GIT_DIR/logs/<ref>" 345 file is automatically created for branch heads. 346+ 347This information can be used to determine what commit 348was the tip of a branch "2 days ago". 349+ 350This value is true by default in a repository that has 351a working directory associated with it, and false by 352default in a bare repository. 353 354core.repositoryFormatVersion:: 355 Internal variable identifying the repository format and layout 356 version. 357 358core.sharedRepository:: 359 When 'group' (or 'true'), the repository is made shareable between 360 several users in a group (making sure all the files and objects are 361 group-writable). When 'all' (or 'world' or 'everybody'), the 362 repository will be readable by all users, additionally to being 363 group-shareable. When 'umask' (or 'false'), git will use permissions 364 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 365 files in the repository will have this mode value. '0xxx' will override 366 user's umask value (whereas the other options will only override 367 requested parts of the user's umask value). Examples: '0660' will make 368 the repo read/write-able for the owner and group, but inaccessible to 369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 370 repository that is group-readable but not group-writable. 371 See linkgit:git-init[1]. False by default. 372 373core.warnAmbiguousRefs:: 374 If true, git will warn you if the ref name you passed it is ambiguous 375 and might match multiple refs in the .git/refs/ tree. True by default. 376 377core.compression:: 378 An integer -1..9, indicating a default compression level. 379 -1 is the zlib default. 0 means no compression, 380 and 1..9 are various speed/size tradeoffs, 9 being slowest. 381 If set, this provides a default to other compression variables, 382 such as 'core.loosecompression' and 'pack.compression'. 383 384core.loosecompression:: 385 An integer -1..9, indicating the compression level for objects that 386 are not in a pack file. -1 is the zlib default. 0 means no 387 compression, and 1..9 are various speed/size tradeoffs, 9 being 388 slowest. If not set, defaults to core.compression. If that is 389 not set, defaults to 1 (best speed). 390 391core.packedGitWindowSize:: 392 Number of bytes of a pack file to map into memory in a 393 single mapping operation. Larger window sizes may allow 394 your system to process a smaller number of large pack files 395 more quickly. Smaller window sizes will negatively affect 396 performance due to increased calls to the operating system's 397 memory manager, but may improve performance when accessing 398 a large number of large pack files. 399+ 400Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 401MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 402be reasonable for all users/operating systems. You probably do 403not need to adjust this value. 404+ 405Common unit suffixes of 'k', 'm', or 'g' are supported. 406 407core.packedGitLimit:: 408 Maximum number of bytes to map simultaneously into memory 409 from pack files. If Git needs to access more than this many 410 bytes at once to complete an operation it will unmap existing 411 regions to reclaim virtual address space within the process. 412+ 413Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 414This should be reasonable for all users/operating systems, except on 415the largest projects. You probably do not need to adjust this value. 416+ 417Common unit suffixes of 'k', 'm', or 'g' are supported. 418 419core.deltaBaseCacheLimit:: 420 Maximum number of bytes to reserve for caching base objects 421 that multiple deltafied objects reference. By storing the 422 entire decompressed base objects in a cache Git is able 423 to avoid unpacking and decompressing frequently used base 424 objects multiple times. 425+ 426Default is 16 MiB on all platforms. This should be reasonable 427for all users/operating systems, except on the largest projects. 428You probably do not need to adjust this value. 429+ 430Common unit suffixes of 'k', 'm', or 'g' are supported. 431 432core.bigFileThreshold:: 433 Files larger than this size are stored deflated, without 434 attempting delta compression. Storing large files without 435 delta compression avoids excessive memory usage, at the 436 slight expense of increased disk usage. 437+ 438Default is 512 MiB on all platforms. This should be reasonable 439for most projects as source code and other text files can still 440be delta compressed, but larger binary media files won't be. 441+ 442Common unit suffixes of 'k', 'm', or 'g' are supported. 443+ 444Currently only linkgit:git-fast-import[1] honors this setting. 445 446core.excludesfile:: 447 In addition to '.gitignore' (per-directory) and 448 '.git/info/exclude', git looks into this file for patterns 449 of files which are not meant to be tracked. "{tilde}/" is expanded 450 to the value of `$HOME` and "{tilde}user/" to the specified user's 451 home directory. See linkgit:gitignore[5]. 452 453core.editor:: 454 Commands such as `commit` and `tag` that lets you edit 455 messages by launching an editor uses the value of this 456 variable when it is set, and the environment variable 457 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 458 459core.pager:: 460 The command that git will use to paginate output. Can 461 be overridden with the `GIT_PAGER` environment 462 variable. Note that git sets the `LESS` environment 463 variable to `FRSX` if it is unset when it runs the 464 pager. One can change these settings by setting the 465 `LESS` variable to some other value. Alternately, 466 these settings can be overridden on a project or 467 global basis by setting the `core.pager` option. 468 Setting `core.pager` has no affect on the `LESS` 469 environment variable behaviour above, so if you want 470 to override git's default settings this way, you need 471 to be explicit. For example, to disable the S option 472 in a backward compatible manner, set `core.pager` 473 to `less -+$LESS -FRX`. This will be passed to the 474 shell by git, which will translate the final command to 475 `LESS=FRSX less -+FRSX -FRX`. 476 477core.whitespace:: 478 A comma separated list of common whitespace problems to 479 notice. 'git diff' will use `color.diff.whitespace` to 480 highlight them, and 'git apply --whitespace=error' will 481 consider them as errors. You can prefix `-` to disable 482 any of them (e.g. `-trailing-space`): 483+ 484* `blank-at-eol` treats trailing whitespaces at the end of the line 485 as an error (enabled by default). 486* `space-before-tab` treats a space character that appears immediately 487 before a tab character in the initial indent part of the line as an 488 error (enabled by default). 489* `indent-with-non-tab` treats a line that is indented with 8 or more 490 space characters as an error (not enabled by default). 491* `tab-in-indent` treats a tab character in the initial indent part of 492 the line as an error (not enabled by default). 493* `blank-at-eof` treats blank lines added at the end of file as an error 494 (enabled by default). 495* `trailing-space` is a short-hand to cover both `blank-at-eol` and 496 `blank-at-eof`. 497* `cr-at-eol` treats a carriage-return at the end of line as 498 part of the line terminator, i.e. with it, `trailing-space` 499 does not trigger if the character before such a carriage-return 500 is not a whitespace (not enabled by default). 501 502core.fsyncobjectfiles:: 503 This boolean will enable 'fsync()' when writing object files. 504+ 505This is a total waste of time and effort on a filesystem that orders 506data writes properly, but can be useful for filesystems that do not use 507journalling (traditional UNIX filesystems) or that only journal metadata 508and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 509 510core.preloadindex:: 511 Enable parallel index preload for operations like 'git diff' 512+ 513This can speed up operations like 'git diff' and 'git status' especially 514on filesystems like NFS that have weak caching semantics and thus 515relatively high IO latencies. With this set to 'true', git will do the 516index comparison to the filesystem data in parallel, allowing 517overlapping IO's. 518 519core.createObject:: 520 You can set this to 'link', in which case a hardlink followed by 521 a delete of the source are used to make sure that object creation 522 will not overwrite existing objects. 523+ 524On some file system/operating system combinations, this is unreliable. 525Set this config setting to 'rename' there; However, This will remove the 526check that makes sure that existing object files will not get overwritten. 527 528core.notesRef:: 529 When showing commit messages, also show notes which are stored in 530 the given ref. The ref must be fully qualified. If the given 531 ref does not exist, it is not an error but means that no 532 notes should be printed. 533+ 534This setting defaults to "refs/notes/commits", and it can be overridden by 535the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 536 537core.sparseCheckout:: 538 Enable "sparse checkout" feature. See section "Sparse checkout" in 539 linkgit:git-read-tree[1] for more information. 540 541add.ignore-errors:: 542 Tells 'git add' to continue adding files when some files cannot be 543 added due to indexing errors. Equivalent to the '--ignore-errors' 544 option of linkgit:git-add[1]. 545 546alias.*:: 547 Command aliases for the linkgit:git[1] command wrapper - e.g. 548 after defining "alias.last = cat-file commit HEAD", the invocation 549 "git last" is equivalent to "git cat-file commit HEAD". To avoid 550 confusion and troubles with script usage, aliases that 551 hide existing git commands are ignored. Arguments are split by 552 spaces, the usual shell quoting and escaping is supported. 553 quote pair and a backslash can be used to quote them. 554+ 555If the alias expansion is prefixed with an exclamation point, 556it will be treated as a shell command. For example, defining 557"alias.new = !gitk --all --not ORIG_HEAD", the invocation 558"git new" is equivalent to running the shell command 559"gitk --all --not ORIG_HEAD". Note that shell commands will be 560executed from the top-level directory of a repository, which may 561not necessarily be the current directory. 562 563am.keepcr:: 564 If true, git-am will call git-mailsplit for patches in mbox format 565 with parameter '--keep-cr'. In this case git-mailsplit will 566 not remove `\r` from lines ending with `\r\n`. Can be overrriden 567 by giving '--no-keep-cr' from the command line. 568 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 569 570apply.ignorewhitespace:: 571 When set to 'change', tells 'git apply' to ignore changes in 572 whitespace, in the same way as the '--ignore-space-change' 573 option. 574 When set to one of: no, none, never, false tells 'git apply' to 575 respect all whitespace differences. 576 See linkgit:git-apply[1]. 577 578apply.whitespace:: 579 Tells 'git apply' how to handle whitespaces, in the same way 580 as the '--whitespace' option. See linkgit:git-apply[1]. 581 582branch.autosetupmerge:: 583 Tells 'git branch' and 'git checkout' to set up new branches 584 so that linkgit:git-pull[1] will appropriately merge from the 585 starting point branch. Note that even if this option is not set, 586 this behavior can be chosen per-branch using the `--track` 587 and `--no-track` options. The valid settings are: `false` -- no 588 automatic setup is done; `true` -- automatic setup is done when the 589 starting point is a remote branch; `always` -- automatic setup is 590 done when the starting point is either a local branch or remote 591 branch. This option defaults to true. 592 593branch.autosetuprebase:: 594 When a new branch is created with 'git branch' or 'git checkout' 595 that tracks another branch, this variable tells git to set 596 up pull to rebase instead of merge (see "branch.<name>.rebase"). 597 When `never`, rebase is never automatically set to true. 598 When `local`, rebase is set to true for tracked branches of 599 other local branches. 600 When `remote`, rebase is set to true for tracked branches of 601 remote branches. 602 When `always`, rebase will be set to true for all tracking 603 branches. 604 See "branch.autosetupmerge" for details on how to set up a 605 branch to track another branch. 606 This option defaults to never. 607 608branch.<name>.remote:: 609 When in branch <name>, it tells 'git fetch' and 'git push' which 610 remote to fetch from/push to. It defaults to `origin` if no remote is 611 configured. `origin` is also used if you are not on any branch. 612 613branch.<name>.merge:: 614 Defines, together with branch.<name>.remote, the upstream branch 615 for the given branch. It tells 'git fetch'/'git pull' which 616 branch to merge and can also affect 'git push' (see push.default). 617 When in branch <name>, it tells 'git fetch' the default 618 refspec to be marked for merging in FETCH_HEAD. The value is 619 handled like the remote part of a refspec, and must match a 620 ref which is fetched from the remote given by 621 "branch.<name>.remote". 622 The merge information is used by 'git pull' (which at first calls 623 'git fetch') to lookup the default branch for merging. Without 624 this option, 'git pull' defaults to merge the first refspec fetched. 625 Specify multiple values to get an octopus merge. 626 If you wish to setup 'git pull' so that it merges into <name> from 627 another branch in the local repository, you can point 628 branch.<name>.merge to the desired branch, and use the special setting 629 `.` (a period) for branch.<name>.remote. 630 631branch.<name>.mergeoptions:: 632 Sets default options for merging into branch <name>. The syntax and 633 supported options are the same as those of linkgit:git-merge[1], but 634 option values containing whitespace characters are currently not 635 supported. 636 637branch.<name>.rebase:: 638 When true, rebase the branch <name> on top of the fetched branch, 639 instead of merging the default branch from the default remote when 640 "git pull" is run. 641 *NOTE*: this is a possibly dangerous operation; do *not* use 642 it unless you understand the implications (see linkgit:git-rebase[1] 643 for details). 644 645browser.<tool>.cmd:: 646 Specify the command to invoke the specified browser. The 647 specified command is evaluated in shell with the URLs passed 648 as arguments. (See linkgit:git-web--browse[1].) 649 650browser.<tool>.path:: 651 Override the path for the given tool that may be used to 652 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 653 working repository in gitweb (see linkgit:git-instaweb[1]). 654 655clean.requireForce:: 656 A boolean to make git-clean do nothing unless given -f 657 or -n. Defaults to true. 658 659color.branch:: 660 A boolean to enable/disable color in the output of 661 linkgit:git-branch[1]. May be set to `always`, 662 `false` (or `never`) or `auto` (or `true`), in which case colors are used 663 only when the output is to a terminal. Defaults to false. 664 665color.branch.<slot>:: 666 Use customized color for branch coloration. `<slot>` is one of 667 `current` (the current branch), `local` (a local branch), 668 `remote` (a tracking branch in refs/remotes/), `plain` (other 669 refs). 670+ 671The value for these configuration variables is a list of colors (at most 672two) and attributes (at most one), separated by spaces. The colors 673accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 674`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 675`blink` and `reverse`. The first color given is the foreground; the 676second is the background. The position of the attribute, if any, 677doesn't matter. 678 679color.diff:: 680 When set to `always`, always use colors in patch. 681 When false (or `never`), never. When set to `true` or `auto`, use 682 colors only when the output is to the terminal. Defaults to false. 683 684color.diff.<slot>:: 685 Use customized color for diff colorization. `<slot>` specifies 686 which part of the patch to use the specified color, and is one 687 of `plain` (context text), `meta` (metainformation), `frag` 688 (hunk header), 'func' (function in hunk header), `old` (removed lines), 689 `new` (added lines), `commit` (commit headers), or `whitespace` 690 (highlighting whitespace errors). The values of these variables may be 691 specified as in color.branch.<slot>. 692 693color.grep:: 694 When set to `always`, always highlight matches. When `false` (or 695 `never`), never. When set to `true` or `auto`, use color only 696 when the output is written to the terminal. Defaults to `false`. 697 698color.grep.<slot>:: 699 Use customized color for grep colorization. `<slot>` specifies which 700 part of the line to use the specified color, and is one of 701+ 702-- 703`context`;; 704 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 705`filename`;; 706 filename prefix (when not using `-h`) 707`function`;; 708 function name lines (when using `-p`) 709`linenumber`;; 710 line number prefix (when using `-n`) 711`match`;; 712 matching text 713`selected`;; 714 non-matching text in selected lines 715`separator`;; 716 separators between fields on a line (`:`, `-`, and `=`) 717 and between hunks (`--`) 718-- 719+ 720The values of these variables may be specified as in color.branch.<slot>. 721 722color.interactive:: 723 When set to `always`, always use colors for interactive prompts 724 and displays (such as those used by "git-add --interactive"). 725 When false (or `never`), never. When set to `true` or `auto`, use 726 colors only when the output is to the terminal. Defaults to false. 727 728color.interactive.<slot>:: 729 Use customized color for 'git add --interactive' 730 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 731 four distinct types of normal output from interactive 732 commands. The values of these variables may be specified as 733 in color.branch.<slot>. 734 735color.pager:: 736 A boolean to enable/disable colored output when the pager is in 737 use (default is true). 738 739color.showbranch:: 740 A boolean to enable/disable color in the output of 741 linkgit:git-show-branch[1]. May be set to `always`, 742 `false` (or `never`) or `auto` (or `true`), in which case colors are used 743 only when the output is to a terminal. Defaults to false. 744 745color.status:: 746 A boolean to enable/disable color in the output of 747 linkgit:git-status[1]. May be set to `always`, 748 `false` (or `never`) or `auto` (or `true`), in which case colors are used 749 only when the output is to a terminal. Defaults to false. 750 751color.status.<slot>:: 752 Use customized color for status colorization. `<slot>` is 753 one of `header` (the header text of the status message), 754 `added` or `updated` (files which are added but not committed), 755 `changed` (files which are changed but not added in the index), 756 `untracked` (files which are not tracked by git), or 757 `nobranch` (the color the 'no branch' warning is shown in, defaulting 758 to red). The values of these variables may be specified as in 759 color.branch.<slot>. 760 761color.ui:: 762 When set to `always`, always use colors in all git commands which 763 are capable of colored output. When false (or `never`), never. When 764 set to `true` or `auto`, use colors only when the output is to the 765 terminal. When more specific variables of color.* are set, they always 766 take precedence over this setting. Defaults to false. 767 768commit.status:: 769 A boolean to enable/disable inclusion of status information in the 770 commit message template when using an editor to prepare the commit 771 message. Defaults to true. 772 773commit.template:: 774 Specify a file to use as the template for new commit messages. 775 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 776 specified user's home directory. 777 778diff.autorefreshindex:: 779 When using 'git diff' to compare with work tree 780 files, do not consider stat-only change as changed. 781 Instead, silently run `git update-index --refresh` to 782 update the cached stat information for paths whose 783 contents in the work tree match the contents in the 784 index. This option defaults to true. Note that this 785 affects only 'git diff' Porcelain, and not lower level 786 'diff' commands such as 'git diff-files'. 787 788diff.external:: 789 If this config variable is set, diff generation is not 790 performed using the internal diff machinery, but using the 791 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 792 environment variable. The command is called with parameters 793 as described under "git Diffs" in linkgit:git[1]. Note: if 794 you want to use an external diff program only on a subset of 795 your files, you might want to use linkgit:gitattributes[5] instead. 796 797diff.mnemonicprefix:: 798 If set, 'git diff' uses a prefix pair that is different from the 799 standard "a/" and "b/" depending on what is being compared. When 800 this configuration is in effect, reverse diff output also swaps 801 the order of the prefixes: 802diff.noprefix:: 803 If set, 'git diff' does not show any source or destination prefix. 804`git diff`;; 805 compares the (i)ndex and the (w)ork tree; 806`git diff HEAD`;; 807 compares a (c)ommit and the (w)ork tree; 808`git diff --cached`;; 809 compares a (c)ommit and the (i)ndex; 810`git diff HEAD:file1 file2`;; 811 compares an (o)bject and a (w)ork tree entity; 812`git diff --no-index a b`;; 813 compares two non-git things (1) and (2). 814 815diff.renameLimit:: 816 The number of files to consider when performing the copy/rename 817 detection; equivalent to the 'git diff' option '-l'. 818 819diff.renames:: 820 Tells git to detect renames. If set to any boolean value, it 821 will enable basic rename detection. If set to "copies" or 822 "copy", it will detect copies, as well. 823 824diff.suppressBlankEmpty:: 825 A boolean to inhibit the standard behavior of printing a space 826 before each empty output line. Defaults to false. 827 828diff.tool:: 829 Controls which diff tool is used. `diff.tool` overrides 830 `merge.tool` when used by linkgit:git-difftool[1] and has 831 the same valid values as `merge.tool` minus "tortoisemerge" 832 and plus "kompare". 833 834difftool.<tool>.path:: 835 Override the path for the given tool. This is useful in case 836 your tool is not in the PATH. 837 838difftool.<tool>.cmd:: 839 Specify the command to invoke the specified diff tool. 840 The specified command is evaluated in shell with the following 841 variables available: 'LOCAL' is set to the name of the temporary 842 file containing the contents of the diff pre-image and 'REMOTE' 843 is set to the name of the temporary file containing the contents 844 of the diff post-image. 845 846difftool.prompt:: 847 Prompt before each invocation of the diff tool. 848 849diff.wordRegex:: 850 A POSIX Extended Regular Expression used to determine what is a "word" 851 when performing word-by-word difference calculations. Character 852 sequences that match the regular expression are "words", all other 853 characters are *ignorable* whitespace. 854 855fetch.unpackLimit:: 856 If the number of objects fetched over the git native 857 transfer is below this 858 limit, then the objects will be unpacked into loose object 859 files. However if the number of received objects equals or 860 exceeds this limit then the received pack will be stored as 861 a pack, after adding any missing delta bases. Storing the 862 pack from a push can make the push operation complete faster, 863 especially on slow filesystems. If not set, the value of 864 `transfer.unpackLimit` is used instead. 865 866format.attach:: 867 Enable multipart/mixed attachments as the default for 868 'format-patch'. The value can also be a double quoted string 869 which will enable attachments as the default and set the 870 value as the boundary. See the --attach option in 871 linkgit:git-format-patch[1]. 872 873format.numbered:: 874 A boolean which can enable or disable sequence numbers in patch 875 subjects. It defaults to "auto" which enables it only if there 876 is more than one patch. It can be enabled or disabled for all 877 messages by setting it to "true" or "false". See --numbered 878 option in linkgit:git-format-patch[1]. 879 880format.headers:: 881 Additional email headers to include in a patch to be submitted 882 by mail. See linkgit:git-format-patch[1]. 883 884format.cc:: 885 Additional "Cc:" headers to include in a patch to be submitted 886 by mail. See the --cc option in linkgit:git-format-patch[1]. 887 888format.subjectprefix:: 889 The default for format-patch is to output files with the '[PATCH]' 890 subject prefix. Use this variable to change that prefix. 891 892format.signature:: 893 The default for format-patch is to output a signature containing 894 the git version number. Use this variable to change that default. 895 Set this variable to the empty string ("") to suppress 896 signature generation. 897 898format.suffix:: 899 The default for format-patch is to output files with the suffix 900 `.patch`. Use this variable to change that suffix (make sure to 901 include the dot if you want it). 902 903format.pretty:: 904 The default pretty format for log/show/whatchanged command, 905 See linkgit:git-log[1], linkgit:git-show[1], 906 linkgit:git-whatchanged[1]. 907 908format.thread:: 909 The default threading style for 'git format-patch'. Can be 910 a boolean value, or `shallow` or `deep`. `shallow` threading 911 makes every mail a reply to the head of the series, 912 where the head is chosen from the cover letter, the 913 `\--in-reply-to`, and the first patch mail, in this order. 914 `deep` threading makes every mail a reply to the previous one. 915 A true boolean value is the same as `shallow`, and a false 916 value disables threading. 917 918format.signoff:: 919 A boolean value which lets you enable the `-s/--signoff` option of 920 format-patch by default. *Note:* Adding the Signed-off-by: line to a 921 patch should be a conscious act and means that you certify you have 922 the rights to submit this work under the same open source license. 923 Please see the 'SubmittingPatches' document for further discussion. 924 925gc.aggressiveWindow:: 926 The window size parameter used in the delta compression 927 algorithm used by 'git gc --aggressive'. This defaults 928 to 250. 929 930gc.auto:: 931 When there are approximately more than this many loose 932 objects in the repository, `git gc --auto` will pack them. 933 Some Porcelain commands use this command to perform a 934 light-weight garbage collection from time to time. The 935 default value is 6700. Setting this to 0 disables it. 936 937gc.autopacklimit:: 938 When there are more than this many packs that are not 939 marked with `*.keep` file in the repository, `git gc 940 --auto` consolidates them into one larger pack. The 941 default value is 50. Setting this to 0 disables it. 942 943gc.packrefs:: 944 Running `git pack-refs` in a repository renders it 945 unclonable by Git versions prior to 1.5.1.2 over dumb 946 transports such as HTTP. This variable determines whether 947 'git gc' runs `git pack-refs`. This can be set to `nobare` 948 to enable it within all non-bare repos or it can be set to a 949 boolean value. The default is `true`. 950 951gc.pruneexpire:: 952 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 953 Override the grace period with this config variable. The value 954 "now" may be used to disable this grace period and always prune 955 unreachable objects immediately. 956 957gc.reflogexpire:: 958gc.<pattern>.reflogexpire:: 959 'git reflog expire' removes reflog entries older than 960 this time; defaults to 90 days. With "<pattern>" (e.g. 961 "refs/stash") in the middle the setting applies only to 962 the refs that match the <pattern>. 963 964gc.reflogexpireunreachable:: 965gc.<ref>.reflogexpireunreachable:: 966 'git reflog expire' removes reflog entries older than 967 this time and are not reachable from the current tip; 968 defaults to 30 days. With "<pattern>" (e.g. "refs/stash") 969 in the middle, the setting applies only to the refs that 970 match the <pattern>. 971 972gc.rerereresolved:: 973 Records of conflicted merge you resolved earlier are 974 kept for this many days when 'git rerere gc' is run. 975 The default is 60 days. See linkgit:git-rerere[1]. 976 977gc.rerereunresolved:: 978 Records of conflicted merge you have not resolved are 979 kept for this many days when 'git rerere gc' is run. 980 The default is 15 days. See linkgit:git-rerere[1]. 981 982gitcvs.commitmsgannotation:: 983 Append this string to each commit message. Set to empty string 984 to disable this feature. Defaults to "via git-CVS emulator". 985 986gitcvs.enabled:: 987 Whether the CVS server interface is enabled for this repository. 988 See linkgit:git-cvsserver[1]. 989 990gitcvs.logfile:: 991 Path to a log file where the CVS server interface well... logs 992 various stuff. See linkgit:git-cvsserver[1]. 993 994gitcvs.usecrlfattr:: 995 If true, the server will look up the end-of-line conversion 996 attributes for files to determine the '-k' modes to use. If 997 the attributes force git to treat a file as text, 998 the '-k' mode will be left blank so cvs clients will 999 treat it as text. If they suppress text conversion, the file1000 will be set with '-kb' mode, which suppresses any newline munging1001 the client might otherwise do. If the attributes do not allow1002 the file type to be determined, then 'gitcvs.allbinary' is1003 used. See linkgit:gitattributes[5].10041005gitcvs.allbinary::1006 This is used if 'gitcvs.usecrlfattr' does not resolve1007 the correct '-kb' mode to use. If true, all1008 unresolved files are sent to the client in1009 mode '-kb'. This causes the client to treat them1010 as binary files, which suppresses any newline munging it1011 otherwise might do. Alternatively, if it is set to "guess",1012 then the contents of the file are examined to decide if1013 it is binary, similar to 'core.autocrlf'.10141015gitcvs.dbname::1016 Database used by git-cvsserver to cache revision information1017 derived from the git repository. The exact meaning depends on the1018 used database driver, for SQLite (which is the default driver) this1019 is a filename. Supports variable substitution (see1020 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1021 Default: '%Ggitcvs.%m.sqlite'10221023gitcvs.dbdriver::1024 Used Perl DBI driver. You can specify any available driver1025 for this here, but it might not work. git-cvsserver is tested1026 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1027 reported *not* to work with 'DBD::mysql'. Experimental feature.1028 May not contain double colons (`:`). Default: 'SQLite'.1029 See linkgit:git-cvsserver[1].10301031gitcvs.dbuser, gitcvs.dbpass::1032 Database user and password. Only useful if setting 'gitcvs.dbdriver',1033 since SQLite has no concept of database users and/or passwords.1034 'gitcvs.dbuser' supports variable substitution (see1035 linkgit:git-cvsserver[1] for details).10361037gitcvs.dbTableNamePrefix::1038 Database table name prefix. Prepended to the names of any1039 database tables used, allowing a single database to be used1040 for several repositories. Supports variable substitution (see1041 linkgit:git-cvsserver[1] for details). Any non-alphabetic1042 characters will be replaced with underscores.10431044All gitcvs variables except for 'gitcvs.usecrlfattr' and1045'gitcvs.allbinary' can also be specified as1046'gitcvs.<access_method>.<varname>' (where 'access_method'1047is one of "ext" and "pserver") to make them apply only for the given1048access method.10491050gui.commitmsgwidth::1051 Defines how wide the commit message window is in the1052 linkgit:git-gui[1]. "75" is the default.10531054gui.diffcontext::1055 Specifies how many context lines should be used in calls to diff1056 made by the linkgit:git-gui[1]. The default is "5".10571058gui.encoding::1059 Specifies the default encoding to use for displaying of1060 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1061 It can be overridden by setting the 'encoding' attribute1062 for relevant files (see linkgit:gitattributes[5]).1063 If this option is not set, the tools default to the1064 locale encoding.10651066gui.matchtrackingbranch::1067 Determines if new branches created with linkgit:git-gui[1] should1068 default to tracking remote branches with matching names or1069 not. Default: "false".10701071gui.newbranchtemplate::1072 Is used as suggested name when creating new branches using the1073 linkgit:git-gui[1].10741075gui.pruneduringfetch::1076 "true" if linkgit:git-gui[1] should prune tracking branches when1077 performing a fetch. The default value is "false".10781079gui.trustmtime::1080 Determines if linkgit:git-gui[1] should trust the file modification1081 timestamp or not. By default the timestamps are not trusted.10821083gui.spellingdictionary::1084 Specifies the dictionary used for spell checking commit messages in1085 the linkgit:git-gui[1]. When set to "none" spell checking is turned1086 off.10871088gui.fastcopyblame::1089 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1090 location detection. It makes blame significantly faster on huge1091 repositories at the expense of less thorough copy detection.10921093gui.copyblamethreshold::1094 Specifies the threshold to use in 'git gui blame' original location1095 detection, measured in alphanumeric characters. See the1096 linkgit:git-blame[1] manual for more information on copy detection.10971098gui.blamehistoryctx::1099 Specifies the radius of history context in days to show in1100 linkgit:gitk[1] for the selected commit, when the `Show History1101 Context` menu item is invoked from 'git gui blame'. If this1102 variable is set to zero, the whole history is shown.11031104guitool.<name>.cmd::1105 Specifies the shell command line to execute when the corresponding item1106 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1107 mandatory for every tool. The command is executed from the root of1108 the working directory, and in the environment it receives the name of1109 the tool as 'GIT_GUITOOL', the name of the currently selected file as1110 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1111 the head is detached, 'CUR_BRANCH' is empty).11121113guitool.<name>.needsfile::1114 Run the tool only if a diff is selected in the GUI. It guarantees1115 that 'FILENAME' is not empty.11161117guitool.<name>.noconsole::1118 Run the command silently, without creating a window to display its1119 output.11201121guitool.<name>.norescan::1122 Don't rescan the working directory for changes after the tool1123 finishes execution.11241125guitool.<name>.confirm::1126 Show a confirmation dialog before actually running the tool.11271128guitool.<name>.argprompt::1129 Request a string argument from the user, and pass it to the tool1130 through the 'ARGS' environment variable. Since requesting an1131 argument implies confirmation, the 'confirm' option has no effect1132 if this is enabled. If the option is set to 'true', 'yes', or '1',1133 the dialog uses a built-in generic prompt; otherwise the exact1134 value of the variable is used.11351136guitool.<name>.revprompt::1137 Request a single valid revision from the user, and set the1138 'REVISION' environment variable. In other aspects this option1139 is similar to 'argprompt', and can be used together with it.11401141guitool.<name>.revunmerged::1142 Show only unmerged branches in the 'revprompt' subdialog.1143 This is useful for tools similar to merge or rebase, but not1144 for things like checkout or reset.11451146guitool.<name>.title::1147 Specifies the title to use for the prompt dialog. The default1148 is the tool name.11491150guitool.<name>.prompt::1151 Specifies the general prompt string to display at the top of1152 the dialog, before subsections for 'argprompt' and 'revprompt'.1153 The default value includes the actual command.11541155help.browser::1156 Specify the browser that will be used to display help in the1157 'web' format. See linkgit:git-help[1].11581159help.format::1160 Override the default help format used by linkgit:git-help[1].1161 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1162 the default. 'web' and 'html' are the same.11631164help.autocorrect::1165 Automatically correct and execute mistyped commands after1166 waiting for the given number of deciseconds (0.1 sec). If more1167 than one command can be deduced from the entered text, nothing1168 will be executed. If the value of this option is negative,1169 the corrected command will be executed immediately. If the1170 value is 0 - the command will be just shown but not executed.1171 This is the default.11721173http.proxy::1174 Override the HTTP proxy, normally configured using the 'http_proxy'1175 environment variable (see linkgit:curl[1]). This can be overridden1176 on a per-remote basis; see remote.<name>.proxy11771178http.sslVerify::1179 Whether to verify the SSL certificate when fetching or pushing1180 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1181 variable.11821183http.sslCert::1184 File containing the SSL certificate when fetching or pushing1185 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1186 variable.11871188http.sslKey::1189 File containing the SSL private key when fetching or pushing1190 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1191 variable.11921193http.sslCertPasswordProtected::1194 Enable git's password prompt for the SSL certificate. Otherwise1195 OpenSSL will prompt the user, possibly many times, if the1196 certificate or private key is encrypted. Can be overridden by the1197 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.11981199http.sslCAInfo::1200 File containing the certificates to verify the peer with when1201 fetching or pushing over HTTPS. Can be overridden by the1202 'GIT_SSL_CAINFO' environment variable.12031204http.sslCAPath::1205 Path containing files with the CA certificates to verify the peer1206 with when fetching or pushing over HTTPS. Can be overridden1207 by the 'GIT_SSL_CAPATH' environment variable.12081209http.maxRequests::1210 How many HTTP requests to launch in parallel. Can be overridden1211 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12121213http.minSessions::1214 The number of curl sessions (counted across slots) to be kept across1215 requests. They will not be ended with curl_easy_cleanup() until1216 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1217 value will be capped at 1. Defaults to 1.12181219http.postBuffer::1220 Maximum size in bytes of the buffer used by smart HTTP1221 transports when POSTing data to the remote system.1222 For requests larger than this buffer size, HTTP/1.1 and1223 Transfer-Encoding: chunked is used to avoid creating a1224 massive pack file locally. Default is 1 MiB, which is1225 sufficient for most requests.12261227http.lowSpeedLimit, http.lowSpeedTime::1228 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1229 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1230 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1231 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12321233http.noEPSV::1234 A boolean which disables using of EPSV ftp command by curl.1235 This can helpful with some "poor" ftp servers which don't1236 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1237 environment variable. Default is false (curl will use EPSV).12381239i18n.commitEncoding::1240 Character encoding the commit messages are stored in; git itself1241 does not care per se, but this information is necessary e.g. when1242 importing commits from emails or in the gitk graphical history1243 browser (and possibly at other places in the future or in other1244 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12451246i18n.logOutputEncoding::1247 Character encoding the commit messages are converted to when1248 running 'git log' and friends.12491250imap::1251 The configuration variables in the 'imap' section are described1252 in linkgit:git-imap-send[1].12531254init.templatedir::1255 Specify the directory from which templates will be copied.1256 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12571258instaweb.browser::1259 Specify the program that will be used to browse your working1260 repository in gitweb. See linkgit:git-instaweb[1].12611262instaweb.httpd::1263 The HTTP daemon command-line to start gitweb on your working1264 repository. See linkgit:git-instaweb[1].12651266instaweb.local::1267 If true the web server started by linkgit:git-instaweb[1] will1268 be bound to the local IP (127.0.0.1).12691270instaweb.modulepath::1271 The module path for an apache httpd used by linkgit:git-instaweb[1].12721273instaweb.port::1274 The port number to bind the gitweb httpd to. See1275 linkgit:git-instaweb[1].12761277interactive.singlekey::1278 In interactive commands, allow the user to provide one-letter1279 input with a single key (i.e., without hitting enter).1280 Currently this is used only by the `\--patch` mode of1281 linkgit:git-add[1]. Note that this setting is silently1282 ignored if portable keystroke input is not available.12831284log.date::1285 Set default date-time mode for the log command. Setting log.date1286 value is similar to using 'git log'\'s --date option. The value is one of the1287 following alternatives: {relative,local,default,iso,rfc,short}.1288 See linkgit:git-log[1].12891290log.decorate::1291 Print out the ref names of any commits that are shown by the log1292 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1293 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1294 specified, the full ref name (including prefix) will be printed.1295 This is the same as the log commands '--decorate' option.12961297log.showroot::1298 If true, the initial commit will be shown as a big creation event.1299 This is equivalent to a diff against an empty tree.1300 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1301 normally hide the root commit will now show it. True by default.13021303mailmap.file::1304 The location of an augmenting mailmap file. The default1305 mailmap, located in the root of the repository, is loaded1306 first, then the mailmap file pointed to by this variable.1307 The location of the mailmap file may be in a repository1308 subdirectory, or somewhere outside of the repository itself.1309 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13101311man.viewer::1312 Specify the programs that may be used to display help in the1313 'man' format. See linkgit:git-help[1].13141315man.<tool>.cmd::1316 Specify the command to invoke the specified man viewer. The1317 specified command is evaluated in shell with the man page1318 passed as argument. (See linkgit:git-help[1].)13191320man.<tool>.path::1321 Override the path for the given tool that may be used to1322 display help in the 'man' format. See linkgit:git-help[1].13231324include::merge-config.txt[]13251326mergetool.<tool>.path::1327 Override the path for the given tool. This is useful in case1328 your tool is not in the PATH.13291330mergetool.<tool>.cmd::1331 Specify the command to invoke the specified merge tool. The1332 specified command is evaluated in shell with the following1333 variables available: 'BASE' is the name of a temporary file1334 containing the common base of the files to be merged, if available;1335 'LOCAL' is the name of a temporary file containing the contents of1336 the file on the current branch; 'REMOTE' is the name of a temporary1337 file containing the contents of the file from the branch being1338 merged; 'MERGED' contains the name of the file to which the merge1339 tool should write the results of a successful merge.13401341mergetool.<tool>.trustExitCode::1342 For a custom merge command, specify whether the exit code of1343 the merge command can be used to determine whether the merge was1344 successful. If this is not set to true then the merge target file1345 timestamp is checked and the merge assumed to have been successful1346 if the file has been updated, otherwise the user is prompted to1347 indicate the success of the merge.13481349mergetool.keepBackup::1350 After performing a merge, the original file with conflict markers1351 can be saved as a file with a `.orig` extension. If this variable1352 is set to `false` then this file is not preserved. Defaults to1353 `true` (i.e. keep the backup files).13541355mergetool.keepTemporaries::1356 When invoking a custom merge tool, git uses a set of temporary1357 files to pass to the tool. If the tool returns an error and this1358 variable is set to `true`, then these temporary files will be1359 preserved, otherwise they will be removed after the tool has1360 exited. Defaults to `false`.13611362mergetool.prompt::1363 Prompt before each invocation of the merge resolution program.13641365notes.displayRef::1366 The (fully qualified) refname from which to show notes when1367 showing commit messages. The value of this variable can be set1368 to a glob, in which case notes from all matching refs will be1369 shown. You may also specify this configuration variable1370 several times. A warning will be issued for refs that do not1371 exist, but a glob that does not match any refs is silently1372 ignored.1373+1374This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1375environment variable, which must be a colon separated list of refs or1376globs.1377+1378The effective value of "core.notesRef" (possibly overridden by1379GIT_NOTES_REF) is also implicitly added to the list of refs to be1380displayed.13811382notes.rewrite.<command>::1383 When rewriting commits with <command> (currently `amend` or1384 `rebase`) and this variable is set to `true`, git1385 automatically copies your notes from the original to the1386 rewritten commit. Defaults to `true`, but see1387 "notes.rewriteRef" below.13881389notes.rewriteMode::1390 When copying notes during a rewrite (see the1391 "notes.rewrite.<command>" option), determines what to do if1392 the target commit already has a note. Must be one of1393 `overwrite`, `concatenate`, or `ignore`. Defaults to1394 `concatenate`.1395+1396This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1397environment variable.13981399notes.rewriteRef::1400 When copying notes during a rewrite, specifies the (fully1401 qualified) ref whose notes should be copied. The ref may be a1402 glob, in which case notes in all matching refs will be copied.1403 You may also specify this configuration several times.1404+1405Does not have a default value; you must configure this variable to1406enable note rewriting.1407+1408This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1409environment variable, which must be a colon separated list of refs or1410globs.14111412pack.window::1413 The size of the window used by linkgit:git-pack-objects[1] when no1414 window size is given on the command line. Defaults to 10.14151416pack.depth::1417 The maximum delta depth used by linkgit:git-pack-objects[1] when no1418 maximum depth is given on the command line. Defaults to 50.14191420pack.windowMemory::1421 The window memory size limit used by linkgit:git-pack-objects[1]1422 when no limit is given on the command line. The value can be1423 suffixed with "k", "m", or "g". Defaults to 0, meaning no1424 limit.14251426pack.compression::1427 An integer -1..9, indicating the compression level for objects1428 in a pack file. -1 is the zlib default. 0 means no1429 compression, and 1..9 are various speed/size tradeoffs, 9 being1430 slowest. If not set, defaults to core.compression. If that is1431 not set, defaults to -1, the zlib default, which is "a default1432 compromise between speed and compression (currently equivalent1433 to level 6)."14341435pack.deltaCacheSize::1436 The maximum memory in bytes used for caching deltas in1437 linkgit:git-pack-objects[1] before writing them out to a pack.1438 This cache is used to speed up the writing object phase by not1439 having to recompute the final delta result once the best match1440 for all objects is found. Repacking large repositories on machines1441 which are tight with memory might be badly impacted by this though,1442 especially if this cache pushes the system into swapping.1443 A value of 0 means no limit. The smallest size of 1 byte may be1444 used to virtually disable this cache. Defaults to 256 MiB.14451446pack.deltaCacheLimit::1447 The maximum size of a delta, that is cached in1448 linkgit:git-pack-objects[1]. This cache is used to speed up the1449 writing object phase by not having to recompute the final delta1450 result once the best match for all objects is found. Defaults to 1000.14511452pack.threads::1453 Specifies the number of threads to spawn when searching for best1454 delta matches. This requires that linkgit:git-pack-objects[1]1455 be compiled with pthreads otherwise this option is ignored with a1456 warning. This is meant to reduce packing time on multiprocessor1457 machines. The required amount of memory for the delta search window1458 is however multiplied by the number of threads.1459 Specifying 0 will cause git to auto-detect the number of CPU's1460 and set the number of threads accordingly.14611462pack.indexVersion::1463 Specify the default pack index version. Valid values are 1 for1464 legacy pack index used by Git versions prior to 1.5.2, and 2 for1465 the new pack index with capabilities for packs larger than 4 GB1466 as well as proper protection against the repacking of corrupted1467 packs. Version 2 is the default. Note that version 2 is enforced1468 and this config option ignored whenever the corresponding pack is1469 larger than 2 GB.1470+1471If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1472cloning or fetching over a non native protocol (e.g. "http" and "rsync")1473that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1474other side may give you a repository that cannot be accessed with your1475older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1476you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1477the `{asterisk}.idx` file.14781479pack.packSizeLimit::1480 The maximum size of a pack. This setting only affects1481 packing to a file when repacking, i.e. the git:// protocol1482 is unaffected. It can be overridden by the `\--max-pack-size`1483 option of linkgit:git-repack[1]. The minimum size allowed is1484 limited to 1 MiB. The default is unlimited.1485 Common unit suffixes of 'k', 'm', or 'g' are1486 supported.14871488pager.<cmd>::1489 Allows turning on or off pagination of the output of a1490 particular git subcommand when writing to a tty. If1491 `\--paginate` or `\--no-pager` is specified on the command line,1492 it takes precedence over this option. To disable pagination for1493 all commands, set `core.pager` or `GIT_PAGER` to `cat`.14941495pretty.<name>::1496 Alias for a --pretty= format string, as specified in1497 linkgit:git-log[1]. Any aliases defined here can be used just1498 as the built-in pretty formats could. For example,1499 running `git config pretty.changelog "format:{asterisk} %H %s"`1500 would cause the invocation `git log --pretty=changelog`1501 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1502 Note that an alias with the same name as a built-in format1503 will be silently ignored.15041505pull.octopus::1506 The default merge strategy to use when pulling multiple branches1507 at once.15081509pull.twohead::1510 The default merge strategy to use when pulling a single branch.15111512push.default::1513 Defines the action git push should take if no refspec is given1514 on the command line, no refspec is configured in the remote, and1515 no refspec is implied by any of the options given on the command1516 line. Possible values are:1517+1518* `nothing` do not push anything.1519* `matching` push all matching branches.1520 All branches having the same name in both ends are considered to be1521 matching. This is the default.1522* `tracking` push the current branch to its upstream branch.1523* `current` push the current branch to a branch of the same name.15241525rebase.stat::1526 Whether to show a diffstat of what changed upstream since the last1527 rebase. False by default.15281529receive.autogc::1530 By default, git-receive-pack will run "git-gc --auto" after1531 receiving data from git-push and updating refs. You can stop1532 it by setting this variable to false.15331534receive.fsckObjects::1535 If it is set to true, git-receive-pack will check all received1536 objects. It will abort in the case of a malformed object or a1537 broken link. The result of an abort are only dangling objects.1538 Defaults to false.15391540receive.unpackLimit::1541 If the number of objects received in a push is below this1542 limit then the objects will be unpacked into loose object1543 files. However if the number of received objects equals or1544 exceeds this limit then the received pack will be stored as1545 a pack, after adding any missing delta bases. Storing the1546 pack from a push can make the push operation complete faster,1547 especially on slow filesystems. If not set, the value of1548 `transfer.unpackLimit` is used instead.15491550receive.denyDeletes::1551 If set to true, git-receive-pack will deny a ref update that deletes1552 the ref. Use this to prevent such a ref deletion via a push.15531554receive.denyCurrentBranch::1555 If set to true or "refuse", git-receive-pack will deny a ref update1556 to the currently checked out branch of a non-bare repository.1557 Such a push is potentially dangerous because it brings the HEAD1558 out of sync with the index and working tree. If set to "warn",1559 print a warning of such a push to stderr, but allow the push to1560 proceed. If set to false or "ignore", allow such pushes with no1561 message. Defaults to "refuse".15621563receive.denyNonFastForwards::1564 If set to true, git-receive-pack will deny a ref update which is1565 not a fast-forward. Use this to prevent such an update via a push,1566 even if that push is forced. This configuration variable is1567 set when initializing a shared repository.15681569receive.updateserverinfo::1570 If set to true, git-receive-pack will run git-update-server-info1571 after receiving data from git-push and updating refs.15721573remote.<name>.url::1574 The URL of a remote repository. See linkgit:git-fetch[1] or1575 linkgit:git-push[1].15761577remote.<name>.pushurl::1578 The push URL of a remote repository. See linkgit:git-push[1].15791580remote.<name>.proxy::1581 For remotes that require curl (http, https and ftp), the URL to1582 the proxy to use for that remote. Set to the empty string to1583 disable proxying for that remote.15841585remote.<name>.fetch::1586 The default set of "refspec" for linkgit:git-fetch[1]. See1587 linkgit:git-fetch[1].15881589remote.<name>.push::1590 The default set of "refspec" for linkgit:git-push[1]. See1591 linkgit:git-push[1].15921593remote.<name>.mirror::1594 If true, pushing to this remote will automatically behave1595 as if the `\--mirror` option was given on the command line.15961597remote.<name>.skipDefaultUpdate::1598 If true, this remote will be skipped by default when updating1599 using linkgit:git-fetch[1] or the `update` subcommand of1600 linkgit:git-remote[1].16011602remote.<name>.skipFetchAll::1603 If true, this remote will be skipped by default when updating1604 using linkgit:git-fetch[1] or the `update` subcommand of1605 linkgit:git-remote[1].16061607remote.<name>.receivepack::1608 The default program to execute on the remote side when pushing. See1609 option \--receive-pack of linkgit:git-push[1].16101611remote.<name>.uploadpack::1612 The default program to execute on the remote side when fetching. See1613 option \--upload-pack of linkgit:git-fetch-pack[1].16141615remote.<name>.tagopt::1616 Setting this value to \--no-tags disables automatic tag following when1617 fetching from remote <name>. Setting it to \--tags will fetch every1618 tag from remote <name>, even if they are not reachable from remote1619 branch heads.16201621remote.<name>.vcs::1622 Setting this to a value <vcs> will cause git to interact with1623 the remote with the git-remote-<vcs> helper.16241625remotes.<group>::1626 The list of remotes which are fetched by "git remote update1627 <group>". See linkgit:git-remote[1].16281629repack.usedeltabaseoffset::1630 By default, linkgit:git-repack[1] creates packs that use1631 delta-base offset. If you need to share your repository with1632 git older than version 1.4.4, either directly or via a dumb1633 protocol such as http, then you need to set this option to1634 "false" and repack. Access from old git versions over the1635 native protocol are unaffected by this option.16361637rerere.autoupdate::1638 When set to true, `git-rerere` updates the index with the1639 resulting contents after it cleanly resolves conflicts using1640 previously recorded resolution. Defaults to false.16411642rerere.enabled::1643 Activate recording of resolved conflicts, so that identical1644 conflict hunks can be resolved automatically, should they1645 be encountered again. linkgit:git-rerere[1] command is by1646 default enabled if you create `rr-cache` directory under1647 `$GIT_DIR`, but can be disabled by setting this option to false.16481649sendemail.identity::1650 A configuration identity. When given, causes values in the1651 'sendemail.<identity>' subsection to take precedence over1652 values in the 'sendemail' section. The default identity is1653 the value of 'sendemail.identity'.16541655sendemail.smtpencryption::1656 See linkgit:git-send-email[1] for description. Note that this1657 setting is not subject to the 'identity' mechanism.16581659sendemail.smtpssl::1660 Deprecated alias for 'sendemail.smtpencryption = ssl'.16611662sendemail.<identity>.*::1663 Identity-specific versions of the 'sendemail.*' parameters1664 found below, taking precedence over those when the this1665 identity is selected, through command-line or1666 'sendemail.identity'.16671668sendemail.aliasesfile::1669sendemail.aliasfiletype::1670sendemail.bcc::1671sendemail.cc::1672sendemail.cccmd::1673sendemail.chainreplyto::1674sendemail.confirm::1675sendemail.envelopesender::1676sendemail.from::1677sendemail.multiedit::1678sendemail.signedoffbycc::1679sendemail.smtppass::1680sendemail.suppresscc::1681sendemail.suppressfrom::1682sendemail.to::1683sendemail.smtpdomain::1684sendemail.smtpserver::1685sendemail.smtpserverport::1686sendemail.smtpuser::1687sendemail.thread::1688sendemail.validate::1689 See linkgit:git-send-email[1] for description.16901691sendemail.signedoffcc::1692 Deprecated alias for 'sendemail.signedoffbycc'.16931694showbranch.default::1695 The default set of branches for linkgit:git-show-branch[1].1696 See linkgit:git-show-branch[1].16971698status.relativePaths::1699 By default, linkgit:git-status[1] shows paths relative to the1700 current directory. Setting this variable to `false` shows paths1701 relative to the repository root (this was the default for git1702 prior to v1.5.4).17031704status.showUntrackedFiles::1705 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1706 files which are not currently tracked by Git. Directories which1707 contain only untracked files, are shown with the directory name1708 only. Showing untracked files means that Git needs to lstat() all1709 all the files in the whole repository, which might be slow on some1710 systems. So, this variable controls how the commands displays1711 the untracked files. Possible values are:1712+1713--1714 - 'no' - Show no untracked files1715 - 'normal' - Shows untracked files and directories1716 - 'all' - Shows also individual files in untracked directories.1717--1718+1719If this variable is not specified, it defaults to 'normal'.1720This variable can be overridden with the -u|--untracked-files option1721of linkgit:git-status[1] and linkgit:git-commit[1].17221723status.submodulesummary::1724 Defaults to false.1725 If this is set to a non zero number or true (identical to -1 or an1726 unlimited number), the submodule summary will be enabled and a1727 summary of commits for modified submodules will be shown (see1728 --summary-limit option of linkgit:git-submodule[1]).17291730tar.umask::1731 This variable can be used to restrict the permission bits of1732 tar archive entries. The default is 0002, which turns off the1733 world write bit. The special value "user" indicates that the1734 archiving user's umask will be used instead. See umask(2) and1735 linkgit:git-archive[1].17361737transfer.unpackLimit::1738 When `fetch.unpackLimit` or `receive.unpackLimit` are1739 not set, the value of this variable is used instead.1740 The default value is 100.17411742url.<base>.insteadOf::1743 Any URL that starts with this value will be rewritten to1744 start, instead, with <base>. In cases where some site serves a1745 large number of repositories, and serves them with multiple1746 access methods, and some users need to use different access1747 methods, this feature allows people to specify any of the1748 equivalent URLs and have git automatically rewrite the URL to1749 the best alternative for the particular user, even for a1750 never-before-seen repository on the site. When more than one1751 insteadOf strings match a given URL, the longest match is used.17521753url.<base>.pushInsteadOf::1754 Any URL that starts with this value will not be pushed to;1755 instead, it will be rewritten to start with <base>, and the1756 resulting URL will be pushed to. In cases where some site serves1757 a large number of repositories, and serves them with multiple1758 access methods, some of which do not allow push, this feature1759 allows people to specify a pull-only URL and have git1760 automatically use an appropriate URL to push, even for a1761 never-before-seen repository on the site. When more than one1762 pushInsteadOf strings match a given URL, the longest match is1763 used. If a remote has an explicit pushurl, git will ignore this1764 setting for that remote.17651766user.email::1767 Your email address to be recorded in any newly created commits.1768 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1769 'EMAIL' environment variables. See linkgit:git-commit-tree[1].17701771user.name::1772 Your full name to be recorded in any newly created commits.1773 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1774 environment variables. See linkgit:git-commit-tree[1].17751776user.signingkey::1777 If linkgit:git-tag[1] is not selecting the key you want it to1778 automatically when creating a signed tag, you can override the1779 default selection with this variable. This option is passed1780 unchanged to gpg's --local-user parameter, so you may specify a key1781 using any method that gpg supports.17821783web.browser::1784 Specify a web browser that may be used by some commands.1785 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1786 may use it.