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 overwriting 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 may be referenced by multiple deltified objects. 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 overridden 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.decorate.<slot>:: 694 Use customized color for 'git log --decorate' output. `<slot>` is one 695 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 696 branches, remote tracking branches, tags, stash and HEAD, respectively. 697 698color.grep:: 699 When set to `always`, always highlight matches. When `false` (or 700 `never`), never. When set to `true` or `auto`, use color only 701 when the output is written to the terminal. Defaults to `false`. 702 703color.grep.<slot>:: 704 Use customized color for grep colorization. `<slot>` specifies which 705 part of the line to use the specified color, and is one of 706+ 707-- 708`context`;; 709 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 710`filename`;; 711 filename prefix (when not using `-h`) 712`function`;; 713 function name lines (when using `-p`) 714`linenumber`;; 715 line number prefix (when using `-n`) 716`match`;; 717 matching text 718`selected`;; 719 non-matching text in selected lines 720`separator`;; 721 separators between fields on a line (`:`, `-`, and `=`) 722 and between hunks (`--`) 723-- 724+ 725The values of these variables may be specified as in color.branch.<slot>. 726 727color.interactive:: 728 When set to `always`, always use colors for interactive prompts 729 and displays (such as those used by "git-add --interactive"). 730 When false (or `never`), never. When set to `true` or `auto`, use 731 colors only when the output is to the terminal. Defaults to false. 732 733color.interactive.<slot>:: 734 Use customized color for 'git add --interactive' 735 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 736 four distinct types of normal output from interactive 737 commands. The values of these variables may be specified as 738 in color.branch.<slot>. 739 740color.pager:: 741 A boolean to enable/disable colored output when the pager is in 742 use (default is true). 743 744color.showbranch:: 745 A boolean to enable/disable color in the output of 746 linkgit:git-show-branch[1]. May be set to `always`, 747 `false` (or `never`) or `auto` (or `true`), in which case colors are used 748 only when the output is to a terminal. Defaults to false. 749 750color.status:: 751 A boolean to enable/disable color in the output of 752 linkgit:git-status[1]. May be set to `always`, 753 `false` (or `never`) or `auto` (or `true`), in which case colors are used 754 only when the output is to a terminal. Defaults to false. 755 756color.status.<slot>:: 757 Use customized color for status colorization. `<slot>` is 758 one of `header` (the header text of the status message), 759 `added` or `updated` (files which are added but not committed), 760 `changed` (files which are changed but not added in the index), 761 `untracked` (files which are not tracked by git), or 762 `nobranch` (the color the 'no branch' warning is shown in, defaulting 763 to red). The values of these variables may be specified as in 764 color.branch.<slot>. 765 766color.ui:: 767 When set to `always`, always use colors in all git commands which 768 are capable of colored output. When false (or `never`), never. When 769 set to `true` or `auto`, use colors only when the output is to the 770 terminal. When more specific variables of color.* are set, they always 771 take precedence over this setting. Defaults to false. 772 773commit.status:: 774 A boolean to enable/disable inclusion of status information in the 775 commit message template when using an editor to prepare the commit 776 message. Defaults to true. 777 778commit.template:: 779 Specify a file to use as the template for new commit messages. 780 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 781 specified user's home directory. 782 783diff.autorefreshindex:: 784 When using 'git diff' to compare with work tree 785 files, do not consider stat-only change as changed. 786 Instead, silently run `git update-index --refresh` to 787 update the cached stat information for paths whose 788 contents in the work tree match the contents in the 789 index. This option defaults to true. Note that this 790 affects only 'git diff' Porcelain, and not lower level 791 'diff' commands such as 'git diff-files'. 792 793diff.external:: 794 If this config variable is set, diff generation is not 795 performed using the internal diff machinery, but using the 796 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 797 environment variable. The command is called with parameters 798 as described under "git Diffs" in linkgit:git[1]. Note: if 799 you want to use an external diff program only on a subset of 800 your files, you might want to use linkgit:gitattributes[5] instead. 801 802diff.mnemonicprefix:: 803 If set, 'git diff' uses a prefix pair that is different from the 804 standard "a/" and "b/" depending on what is being compared. When 805 this configuration is in effect, reverse diff output also swaps 806 the order of the prefixes: 807diff.noprefix:: 808 If set, 'git diff' does not show any source or destination prefix. 809`git diff`;; 810 compares the (i)ndex and the (w)ork tree; 811`git diff HEAD`;; 812 compares a (c)ommit and the (w)ork tree; 813`git diff --cached`;; 814 compares a (c)ommit and the (i)ndex; 815`git diff HEAD:file1 file2`;; 816 compares an (o)bject and a (w)ork tree entity; 817`git diff --no-index a b`;; 818 compares two non-git things (1) and (2). 819 820diff.renameLimit:: 821 The number of files to consider when performing the copy/rename 822 detection; equivalent to the 'git diff' option '-l'. 823 824diff.renames:: 825 Tells git to detect renames. If set to any boolean value, it 826 will enable basic rename detection. If set to "copies" or 827 "copy", it will detect copies, as well. 828 829diff.ignoreSubmodules:: 830 Sets the default value of --ignore-submodules. Note that this 831 affects only 'git diff' Porcelain, and not lower level 'diff' 832 commands such as 'git diff-files'. 833 834diff.suppressBlankEmpty:: 835 A boolean to inhibit the standard behavior of printing a space 836 before each empty output line. Defaults to false. 837 838diff.tool:: 839 Controls which diff tool is used. `diff.tool` overrides 840 `merge.tool` when used by linkgit:git-difftool[1] and has 841 the same valid values as `merge.tool` minus "tortoisemerge" 842 and plus "kompare". 843 844difftool.<tool>.path:: 845 Override the path for the given tool. This is useful in case 846 your tool is not in the PATH. 847 848difftool.<tool>.cmd:: 849 Specify the command to invoke the specified diff tool. 850 The specified command is evaluated in shell with the following 851 variables available: 'LOCAL' is set to the name of the temporary 852 file containing the contents of the diff pre-image and 'REMOTE' 853 is set to the name of the temporary file containing the contents 854 of the diff post-image. 855 856difftool.prompt:: 857 Prompt before each invocation of the diff tool. 858 859diff.wordRegex:: 860 A POSIX Extended Regular Expression used to determine what is a "word" 861 when performing word-by-word difference calculations. Character 862 sequences that match the regular expression are "words", all other 863 characters are *ignorable* whitespace. 864 865fetch.unpackLimit:: 866 If the number of objects fetched over the git native 867 transfer is below this 868 limit, then the objects will be unpacked into loose object 869 files. However if the number of received objects equals or 870 exceeds this limit then the received pack will be stored as 871 a pack, after adding any missing delta bases. Storing the 872 pack from a push can make the push operation complete faster, 873 especially on slow filesystems. If not set, the value of 874 `transfer.unpackLimit` is used instead. 875 876format.attach:: 877 Enable multipart/mixed attachments as the default for 878 'format-patch'. The value can also be a double quoted string 879 which will enable attachments as the default and set the 880 value as the boundary. See the --attach option in 881 linkgit:git-format-patch[1]. 882 883format.numbered:: 884 A boolean which can enable or disable sequence numbers in patch 885 subjects. It defaults to "auto" which enables it only if there 886 is more than one patch. It can be enabled or disabled for all 887 messages by setting it to "true" or "false". See --numbered 888 option in linkgit:git-format-patch[1]. 889 890format.headers:: 891 Additional email headers to include in a patch to be submitted 892 by mail. See linkgit:git-format-patch[1]. 893 894format.to:: 895format.cc:: 896 Additional recipients to include in a patch to be submitted 897 by mail. See the --to and --cc options in 898 linkgit:git-format-patch[1]. 899 900format.subjectprefix:: 901 The default for format-patch is to output files with the '[PATCH]' 902 subject prefix. Use this variable to change that prefix. 903 904format.signature:: 905 The default for format-patch is to output a signature containing 906 the git version number. Use this variable to change that default. 907 Set this variable to the empty string ("") to suppress 908 signature generation. 909 910format.suffix:: 911 The default for format-patch is to output files with the suffix 912 `.patch`. Use this variable to change that suffix (make sure to 913 include the dot if you want it). 914 915format.pretty:: 916 The default pretty format for log/show/whatchanged command, 917 See linkgit:git-log[1], linkgit:git-show[1], 918 linkgit:git-whatchanged[1]. 919 920format.thread:: 921 The default threading style for 'git format-patch'. Can be 922 a boolean value, or `shallow` or `deep`. `shallow` threading 923 makes every mail a reply to the head of the series, 924 where the head is chosen from the cover letter, the 925 `\--in-reply-to`, and the first patch mail, in this order. 926 `deep` threading makes every mail a reply to the previous one. 927 A true boolean value is the same as `shallow`, and a false 928 value disables threading. 929 930format.signoff:: 931 A boolean value which lets you enable the `-s/--signoff` option of 932 format-patch by default. *Note:* Adding the Signed-off-by: line to a 933 patch should be a conscious act and means that you certify you have 934 the rights to submit this work under the same open source license. 935 Please see the 'SubmittingPatches' document for further discussion. 936 937gc.aggressiveWindow:: 938 The window size parameter used in the delta compression 939 algorithm used by 'git gc --aggressive'. This defaults 940 to 250. 941 942gc.auto:: 943 When there are approximately more than this many loose 944 objects in the repository, `git gc --auto` will pack them. 945 Some Porcelain commands use this command to perform a 946 light-weight garbage collection from time to time. The 947 default value is 6700. Setting this to 0 disables it. 948 949gc.autopacklimit:: 950 When there are more than this many packs that are not 951 marked with `*.keep` file in the repository, `git gc 952 --auto` consolidates them into one larger pack. The 953 default value is 50. Setting this to 0 disables it. 954 955gc.packrefs:: 956 Running `git pack-refs` in a repository renders it 957 unclonable by Git versions prior to 1.5.1.2 over dumb 958 transports such as HTTP. This variable determines whether 959 'git gc' runs `git pack-refs`. This can be set to `nobare` 960 to enable it within all non-bare repos or it can be set to a 961 boolean value. The default is `true`. 962 963gc.pruneexpire:: 964 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 965 Override the grace period with this config variable. The value 966 "now" may be used to disable this grace period and always prune 967 unreachable objects immediately. 968 969gc.reflogexpire:: 970gc.<pattern>.reflogexpire:: 971 'git reflog expire' removes reflog entries older than 972 this time; defaults to 90 days. With "<pattern>" (e.g. 973 "refs/stash") in the middle the setting applies only to 974 the refs that match the <pattern>. 975 976gc.reflogexpireunreachable:: 977gc.<ref>.reflogexpireunreachable:: 978 'git reflog expire' removes reflog entries older than 979 this time and are not reachable from the current tip; 980 defaults to 30 days. With "<pattern>" (e.g. "refs/stash") 981 in the middle, the setting applies only to the refs that 982 match the <pattern>. 983 984gc.rerereresolved:: 985 Records of conflicted merge you resolved earlier are 986 kept for this many days when 'git rerere gc' is run. 987 The default is 60 days. See linkgit:git-rerere[1]. 988 989gc.rerereunresolved:: 990 Records of conflicted merge you have not resolved are 991 kept for this many days when 'git rerere gc' is run. 992 The default is 15 days. See linkgit:git-rerere[1]. 993 994gitcvs.commitmsgannotation:: 995 Append this string to each commit message. Set to empty string 996 to disable this feature. Defaults to "via git-CVS emulator". 997 998gitcvs.enabled:: 999 Whether the CVS server interface is enabled for this repository.1000 See linkgit:git-cvsserver[1].10011002gitcvs.logfile::1003 Path to a log file where the CVS server interface well... logs1004 various stuff. See linkgit:git-cvsserver[1].10051006gitcvs.usecrlfattr::1007 If true, the server will look up the end-of-line conversion1008 attributes for files to determine the '-k' modes to use. If1009 the attributes force git to treat a file as text,1010 the '-k' mode will be left blank so CVS clients will1011 treat it as text. If they suppress text conversion, the file1012 will be set with '-kb' mode, which suppresses any newline munging1013 the client might otherwise do. If the attributes do not allow1014 the file type to be determined, then 'gitcvs.allbinary' is1015 used. See linkgit:gitattributes[5].10161017gitcvs.allbinary::1018 This is used if 'gitcvs.usecrlfattr' does not resolve1019 the correct '-kb' mode to use. If true, all1020 unresolved files are sent to the client in1021 mode '-kb'. This causes the client to treat them1022 as binary files, which suppresses any newline munging it1023 otherwise might do. Alternatively, if it is set to "guess",1024 then the contents of the file are examined to decide if1025 it is binary, similar to 'core.autocrlf'.10261027gitcvs.dbname::1028 Database used by git-cvsserver to cache revision information1029 derived from the git repository. The exact meaning depends on the1030 used database driver, for SQLite (which is the default driver) this1031 is a filename. Supports variable substitution (see1032 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1033 Default: '%Ggitcvs.%m.sqlite'10341035gitcvs.dbdriver::1036 Used Perl DBI driver. You can specify any available driver1037 for this here, but it might not work. git-cvsserver is tested1038 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1039 reported *not* to work with 'DBD::mysql'. Experimental feature.1040 May not contain double colons (`:`). Default: 'SQLite'.1041 See linkgit:git-cvsserver[1].10421043gitcvs.dbuser, gitcvs.dbpass::1044 Database user and password. Only useful if setting 'gitcvs.dbdriver',1045 since SQLite has no concept of database users and/or passwords.1046 'gitcvs.dbuser' supports variable substitution (see1047 linkgit:git-cvsserver[1] for details).10481049gitcvs.dbTableNamePrefix::1050 Database table name prefix. Prepended to the names of any1051 database tables used, allowing a single database to be used1052 for several repositories. Supports variable substitution (see1053 linkgit:git-cvsserver[1] for details). Any non-alphabetic1054 characters will be replaced with underscores.10551056All gitcvs variables except for 'gitcvs.usecrlfattr' and1057'gitcvs.allbinary' can also be specified as1058'gitcvs.<access_method>.<varname>' (where 'access_method'1059is one of "ext" and "pserver") to make them apply only for the given1060access method.10611062gui.commitmsgwidth::1063 Defines how wide the commit message window is in the1064 linkgit:git-gui[1]. "75" is the default.10651066gui.diffcontext::1067 Specifies how many context lines should be used in calls to diff1068 made by the linkgit:git-gui[1]. The default is "5".10691070gui.encoding::1071 Specifies the default encoding to use for displaying of1072 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1073 It can be overridden by setting the 'encoding' attribute1074 for relevant files (see linkgit:gitattributes[5]).1075 If this option is not set, the tools default to the1076 locale encoding.10771078gui.matchtrackingbranch::1079 Determines if new branches created with linkgit:git-gui[1] should1080 default to tracking remote branches with matching names or1081 not. Default: "false".10821083gui.newbranchtemplate::1084 Is used as suggested name when creating new branches using the1085 linkgit:git-gui[1].10861087gui.pruneduringfetch::1088 "true" if linkgit:git-gui[1] should prune tracking branches when1089 performing a fetch. The default value is "false".10901091gui.trustmtime::1092 Determines if linkgit:git-gui[1] should trust the file modification1093 timestamp or not. By default the timestamps are not trusted.10941095gui.spellingdictionary::1096 Specifies the dictionary used for spell checking commit messages in1097 the linkgit:git-gui[1]. When set to "none" spell checking is turned1098 off.10991100gui.fastcopyblame::1101 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1102 location detection. It makes blame significantly faster on huge1103 repositories at the expense of less thorough copy detection.11041105gui.copyblamethreshold::1106 Specifies the threshold to use in 'git gui blame' original location1107 detection, measured in alphanumeric characters. See the1108 linkgit:git-blame[1] manual for more information on copy detection.11091110gui.blamehistoryctx::1111 Specifies the radius of history context in days to show in1112 linkgit:gitk[1] for the selected commit, when the `Show History1113 Context` menu item is invoked from 'git gui blame'. If this1114 variable is set to zero, the whole history is shown.11151116guitool.<name>.cmd::1117 Specifies the shell command line to execute when the corresponding item1118 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1119 mandatory for every tool. The command is executed from the root of1120 the working directory, and in the environment it receives the name of1121 the tool as 'GIT_GUITOOL', the name of the currently selected file as1122 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1123 the head is detached, 'CUR_BRANCH' is empty).11241125guitool.<name>.needsfile::1126 Run the tool only if a diff is selected in the GUI. It guarantees1127 that 'FILENAME' is not empty.11281129guitool.<name>.noconsole::1130 Run the command silently, without creating a window to display its1131 output.11321133guitool.<name>.norescan::1134 Don't rescan the working directory for changes after the tool1135 finishes execution.11361137guitool.<name>.confirm::1138 Show a confirmation dialog before actually running the tool.11391140guitool.<name>.argprompt::1141 Request a string argument from the user, and pass it to the tool1142 through the 'ARGS' environment variable. Since requesting an1143 argument implies confirmation, the 'confirm' option has no effect1144 if this is enabled. If the option is set to 'true', 'yes', or '1',1145 the dialog uses a built-in generic prompt; otherwise the exact1146 value of the variable is used.11471148guitool.<name>.revprompt::1149 Request a single valid revision from the user, and set the1150 'REVISION' environment variable. In other aspects this option1151 is similar to 'argprompt', and can be used together with it.11521153guitool.<name>.revunmerged::1154 Show only unmerged branches in the 'revprompt' subdialog.1155 This is useful for tools similar to merge or rebase, but not1156 for things like checkout or reset.11571158guitool.<name>.title::1159 Specifies the title to use for the prompt dialog. The default1160 is the tool name.11611162guitool.<name>.prompt::1163 Specifies the general prompt string to display at the top of1164 the dialog, before subsections for 'argprompt' and 'revprompt'.1165 The default value includes the actual command.11661167help.browser::1168 Specify the browser that will be used to display help in the1169 'web' format. See linkgit:git-help[1].11701171help.format::1172 Override the default help format used by linkgit:git-help[1].1173 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1174 the default. 'web' and 'html' are the same.11751176help.autocorrect::1177 Automatically correct and execute mistyped commands after1178 waiting for the given number of deciseconds (0.1 sec). If more1179 than one command can be deduced from the entered text, nothing1180 will be executed. If the value of this option is negative,1181 the corrected command will be executed immediately. If the1182 value is 0 - the command will be just shown but not executed.1183 This is the default.11841185http.proxy::1186 Override the HTTP proxy, normally configured using the 'http_proxy'1187 environment variable (see linkgit:curl[1]). This can be overridden1188 on a per-remote basis; see remote.<name>.proxy11891190http.sslVerify::1191 Whether to verify the SSL certificate when fetching or pushing1192 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1193 variable.11941195http.sslCert::1196 File containing the SSL certificate when fetching or pushing1197 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1198 variable.11991200http.sslKey::1201 File containing the SSL private key when fetching or pushing1202 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1203 variable.12041205http.sslCertPasswordProtected::1206 Enable git's password prompt for the SSL certificate. Otherwise1207 OpenSSL will prompt the user, possibly many times, if the1208 certificate or private key is encrypted. Can be overridden by the1209 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.12101211http.sslCAInfo::1212 File containing the certificates to verify the peer with when1213 fetching or pushing over HTTPS. Can be overridden by the1214 'GIT_SSL_CAINFO' environment variable.12151216http.sslCAPath::1217 Path containing files with the CA certificates to verify the peer1218 with when fetching or pushing over HTTPS. Can be overridden1219 by the 'GIT_SSL_CAPATH' environment variable.12201221http.maxRequests::1222 How many HTTP requests to launch in parallel. Can be overridden1223 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12241225http.minSessions::1226 The number of curl sessions (counted across slots) to be kept across1227 requests. They will not be ended with curl_easy_cleanup() until1228 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1229 value will be capped at 1. Defaults to 1.12301231http.postBuffer::1232 Maximum size in bytes of the buffer used by smart HTTP1233 transports when POSTing data to the remote system.1234 For requests larger than this buffer size, HTTP/1.1 and1235 Transfer-Encoding: chunked is used to avoid creating a1236 massive pack file locally. Default is 1 MiB, which is1237 sufficient for most requests.12381239http.lowSpeedLimit, http.lowSpeedTime::1240 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1241 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1242 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1243 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12441245http.noEPSV::1246 A boolean which disables using of EPSV ftp command by curl.1247 This can helpful with some "poor" ftp servers which don't1248 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1249 environment variable. Default is false (curl will use EPSV).12501251http.useragent::1252 The HTTP USER_AGENT string presented to an HTTP server. The default1253 value represents the version of the client git such as git/1.7.1.1254 This option allows you to override this value to a more common value1255 such as Mozilla/4.0. This may be necessary, for instance, if1256 connecting through a firewall that restricts HTTP connections to a set1257 of common USER_AGENT strings (but not including those like git/1.7.1).1258 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.12591260i18n.commitEncoding::1261 Character encoding the commit messages are stored in; git itself1262 does not care per se, but this information is necessary e.g. when1263 importing commits from emails or in the gitk graphical history1264 browser (and possibly at other places in the future or in other1265 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12661267i18n.logOutputEncoding::1268 Character encoding the commit messages are converted to when1269 running 'git log' and friends.12701271imap::1272 The configuration variables in the 'imap' section are described1273 in linkgit:git-imap-send[1].12741275init.templatedir::1276 Specify the directory from which templates will be copied.1277 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12781279instaweb.browser::1280 Specify the program that will be used to browse your working1281 repository in gitweb. See linkgit:git-instaweb[1].12821283instaweb.httpd::1284 The HTTP daemon command-line to start gitweb on your working1285 repository. See linkgit:git-instaweb[1].12861287instaweb.local::1288 If true the web server started by linkgit:git-instaweb[1] will1289 be bound to the local IP (127.0.0.1).12901291instaweb.modulepath::1292 The default module path for linkgit:git-instaweb[1] to use1293 instead of /usr/lib/apache2/modules. Only used if httpd1294 is Apache.12951296instaweb.port::1297 The port number to bind the gitweb httpd to. See1298 linkgit:git-instaweb[1].12991300interactive.singlekey::1301 In interactive commands, allow the user to provide one-letter1302 input with a single key (i.e., without hitting enter).1303 Currently this is used only by the `\--patch` mode of1304 linkgit:git-add[1]. Note that this setting is silently1305 ignored if portable keystroke input is not available.13061307log.date::1308 Set default date-time mode for the log command. Setting log.date1309 value is similar to using 'git log'\'s --date option. The value is one of the1310 following alternatives: {relative,local,default,iso,rfc,short}.1311 See linkgit:git-log[1].13121313log.decorate::1314 Print out the ref names of any commits that are shown by the log1315 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1316 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1317 specified, the full ref name (including prefix) will be printed.1318 This is the same as the log commands '--decorate' option.13191320log.showroot::1321 If true, the initial commit will be shown as a big creation event.1322 This is equivalent to a diff against an empty tree.1323 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1324 normally hide the root commit will now show it. True by default.13251326mailmap.file::1327 The location of an augmenting mailmap file. The default1328 mailmap, located in the root of the repository, is loaded1329 first, then the mailmap file pointed to by this variable.1330 The location of the mailmap file may be in a repository1331 subdirectory, or somewhere outside of the repository itself.1332 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13331334man.viewer::1335 Specify the programs that may be used to display help in the1336 'man' format. See linkgit:git-help[1].13371338man.<tool>.cmd::1339 Specify the command to invoke the specified man viewer. The1340 specified command is evaluated in shell with the man page1341 passed as argument. (See linkgit:git-help[1].)13421343man.<tool>.path::1344 Override the path for the given tool that may be used to1345 display help in the 'man' format. See linkgit:git-help[1].13461347include::merge-config.txt[]13481349mergetool.<tool>.path::1350 Override the path for the given tool. This is useful in case1351 your tool is not in the PATH.13521353mergetool.<tool>.cmd::1354 Specify the command to invoke the specified merge tool. The1355 specified command is evaluated in shell with the following1356 variables available: 'BASE' is the name of a temporary file1357 containing the common base of the files to be merged, if available;1358 'LOCAL' is the name of a temporary file containing the contents of1359 the file on the current branch; 'REMOTE' is the name of a temporary1360 file containing the contents of the file from the branch being1361 merged; 'MERGED' contains the name of the file to which the merge1362 tool should write the results of a successful merge.13631364mergetool.<tool>.trustExitCode::1365 For a custom merge command, specify whether the exit code of1366 the merge command can be used to determine whether the merge was1367 successful. If this is not set to true then the merge target file1368 timestamp is checked and the merge assumed to have been successful1369 if the file has been updated, otherwise the user is prompted to1370 indicate the success of the merge.13711372mergetool.keepBackup::1373 After performing a merge, the original file with conflict markers1374 can be saved as a file with a `.orig` extension. If this variable1375 is set to `false` then this file is not preserved. Defaults to1376 `true` (i.e. keep the backup files).13771378mergetool.keepTemporaries::1379 When invoking a custom merge tool, git uses a set of temporary1380 files to pass to the tool. If the tool returns an error and this1381 variable is set to `true`, then these temporary files will be1382 preserved, otherwise they will be removed after the tool has1383 exited. Defaults to `false`.13841385mergetool.prompt::1386 Prompt before each invocation of the merge resolution program.13871388notes.displayRef::1389 The (fully qualified) refname from which to show notes when1390 showing commit messages. The value of this variable can be set1391 to a glob, in which case notes from all matching refs will be1392 shown. You may also specify this configuration variable1393 several times. A warning will be issued for refs that do not1394 exist, but a glob that does not match any refs is silently1395 ignored.1396+1397This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1398environment variable, which must be a colon separated list of refs or1399globs.1400+1401The effective value of "core.notesRef" (possibly overridden by1402GIT_NOTES_REF) is also implicitly added to the list of refs to be1403displayed.14041405notes.rewrite.<command>::1406 When rewriting commits with <command> (currently `amend` or1407 `rebase`) and this variable is set to `true`, git1408 automatically copies your notes from the original to the1409 rewritten commit. Defaults to `true`, but see1410 "notes.rewriteRef" below.14111412notes.rewriteMode::1413 When copying notes during a rewrite (see the1414 "notes.rewrite.<command>" option), determines what to do if1415 the target commit already has a note. Must be one of1416 `overwrite`, `concatenate`, or `ignore`. Defaults to1417 `concatenate`.1418+1419This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1420environment variable.14211422notes.rewriteRef::1423 When copying notes during a rewrite, specifies the (fully1424 qualified) ref whose notes should be copied. The ref may be a1425 glob, in which case notes in all matching refs will be copied.1426 You may also specify this configuration several times.1427+1428Does not have a default value; you must configure this variable to1429enable note rewriting.1430+1431This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1432environment variable, which must be a colon separated list of refs or1433globs.14341435pack.window::1436 The size of the window used by linkgit:git-pack-objects[1] when no1437 window size is given on the command line. Defaults to 10.14381439pack.depth::1440 The maximum delta depth used by linkgit:git-pack-objects[1] when no1441 maximum depth is given on the command line. Defaults to 50.14421443pack.windowMemory::1444 The window memory size limit used by linkgit:git-pack-objects[1]1445 when no limit is given on the command line. The value can be1446 suffixed with "k", "m", or "g". Defaults to 0, meaning no1447 limit.14481449pack.compression::1450 An integer -1..9, indicating the compression level for objects1451 in a pack file. -1 is the zlib default. 0 means no1452 compression, and 1..9 are various speed/size tradeoffs, 9 being1453 slowest. If not set, defaults to core.compression. If that is1454 not set, defaults to -1, the zlib default, which is "a default1455 compromise between speed and compression (currently equivalent1456 to level 6)."14571458pack.deltaCacheSize::1459 The maximum memory in bytes used for caching deltas in1460 linkgit:git-pack-objects[1] before writing them out to a pack.1461 This cache is used to speed up the writing object phase by not1462 having to recompute the final delta result once the best match1463 for all objects is found. Repacking large repositories on machines1464 which are tight with memory might be badly impacted by this though,1465 especially if this cache pushes the system into swapping.1466 A value of 0 means no limit. The smallest size of 1 byte may be1467 used to virtually disable this cache. Defaults to 256 MiB.14681469pack.deltaCacheLimit::1470 The maximum size of a delta, that is cached in1471 linkgit:git-pack-objects[1]. This cache is used to speed up the1472 writing object phase by not having to recompute the final delta1473 result once the best match for all objects is found. Defaults to 1000.14741475pack.threads::1476 Specifies the number of threads to spawn when searching for best1477 delta matches. This requires that linkgit:git-pack-objects[1]1478 be compiled with pthreads otherwise this option is ignored with a1479 warning. This is meant to reduce packing time on multiprocessor1480 machines. The required amount of memory for the delta search window1481 is however multiplied by the number of threads.1482 Specifying 0 will cause git to auto-detect the number of CPU's1483 and set the number of threads accordingly.14841485pack.indexVersion::1486 Specify the default pack index version. Valid values are 1 for1487 legacy pack index used by Git versions prior to 1.5.2, and 2 for1488 the new pack index with capabilities for packs larger than 4 GB1489 as well as proper protection against the repacking of corrupted1490 packs. Version 2 is the default. Note that version 2 is enforced1491 and this config option ignored whenever the corresponding pack is1492 larger than 2 GB.1493+1494If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1495cloning or fetching over a non native protocol (e.g. "http" and "rsync")1496that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1497other side may give you a repository that cannot be accessed with your1498older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1499you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1500the `{asterisk}.idx` file.15011502pack.packSizeLimit::1503 The maximum size of a pack. This setting only affects1504 packing to a file when repacking, i.e. the git:// protocol1505 is unaffected. It can be overridden by the `\--max-pack-size`1506 option of linkgit:git-repack[1]. The minimum size allowed is1507 limited to 1 MiB. The default is unlimited.1508 Common unit suffixes of 'k', 'm', or 'g' are1509 supported.15101511pager.<cmd>::1512 Allows turning on or off pagination of the output of a1513 particular git subcommand when writing to a tty. If1514 `\--paginate` or `\--no-pager` is specified on the command line,1515 it takes precedence over this option. To disable pagination for1516 all commands, set `core.pager` or `GIT_PAGER` to `cat`.15171518pretty.<name>::1519 Alias for a --pretty= format string, as specified in1520 linkgit:git-log[1]. Any aliases defined here can be used just1521 as the built-in pretty formats could. For example,1522 running `git config pretty.changelog "format:{asterisk} %H %s"`1523 would cause the invocation `git log --pretty=changelog`1524 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1525 Note that an alias with the same name as a built-in format1526 will be silently ignored.15271528pull.octopus::1529 The default merge strategy to use when pulling multiple branches1530 at once.15311532pull.twohead::1533 The default merge strategy to use when pulling a single branch.15341535push.default::1536 Defines the action git push should take if no refspec is given1537 on the command line, no refspec is configured in the remote, and1538 no refspec is implied by any of the options given on the command1539 line. Possible values are:1540+1541* `nothing` do not push anything.1542* `matching` push all matching branches.1543 All branches having the same name in both ends are considered to be1544 matching. This is the default.1545* `tracking` push the current branch to its upstream branch.1546* `current` push the current branch to a branch of the same name.15471548rebase.stat::1549 Whether to show a diffstat of what changed upstream since the last1550 rebase. False by default.15511552receive.autogc::1553 By default, git-receive-pack will run "git-gc --auto" after1554 receiving data from git-push and updating refs. You can stop1555 it by setting this variable to false.15561557receive.fsckObjects::1558 If it is set to true, git-receive-pack will check all received1559 objects. It will abort in the case of a malformed object or a1560 broken link. The result of an abort are only dangling objects.1561 Defaults to false.15621563receive.unpackLimit::1564 If the number of objects received in a push is below this1565 limit then the objects will be unpacked into loose object1566 files. However if the number of received objects equals or1567 exceeds this limit then the received pack will be stored as1568 a pack, after adding any missing delta bases. Storing the1569 pack from a push can make the push operation complete faster,1570 especially on slow filesystems. If not set, the value of1571 `transfer.unpackLimit` is used instead.15721573receive.denyDeletes::1574 If set to true, git-receive-pack will deny a ref update that deletes1575 the ref. Use this to prevent such a ref deletion via a push.15761577receive.denyDeleteCurrent::1578 If set to true, git-receive-pack will deny a ref update that1579 deletes the currently checked out branch of a non-bare repository.15801581receive.denyCurrentBranch::1582 If set to true or "refuse", git-receive-pack will deny a ref update1583 to the currently checked out branch of a non-bare repository.1584 Such a push is potentially dangerous because it brings the HEAD1585 out of sync with the index and working tree. If set to "warn",1586 print a warning of such a push to stderr, but allow the push to1587 proceed. If set to false or "ignore", allow such pushes with no1588 message. Defaults to "refuse".15891590receive.denyNonFastForwards::1591 If set to true, git-receive-pack will deny a ref update which is1592 not a fast-forward. Use this to prevent such an update via a push,1593 even if that push is forced. This configuration variable is1594 set when initializing a shared repository.15951596receive.updateserverinfo::1597 If set to true, git-receive-pack will run git-update-server-info1598 after receiving data from git-push and updating refs.15991600remote.<name>.url::1601 The URL of a remote repository. See linkgit:git-fetch[1] or1602 linkgit:git-push[1].16031604remote.<name>.pushurl::1605 The push URL of a remote repository. See linkgit:git-push[1].16061607remote.<name>.proxy::1608 For remotes that require curl (http, https and ftp), the URL to1609 the proxy to use for that remote. Set to the empty string to1610 disable proxying for that remote.16111612remote.<name>.fetch::1613 The default set of "refspec" for linkgit:git-fetch[1]. See1614 linkgit:git-fetch[1].16151616remote.<name>.push::1617 The default set of "refspec" for linkgit:git-push[1]. See1618 linkgit:git-push[1].16191620remote.<name>.mirror::1621 If true, pushing to this remote will automatically behave1622 as if the `\--mirror` option was given on the command line.16231624remote.<name>.skipDefaultUpdate::1625 If true, this remote will be skipped by default when updating1626 using linkgit:git-fetch[1] or the `update` subcommand of1627 linkgit:git-remote[1].16281629remote.<name>.skipFetchAll::1630 If true, this remote will be skipped by default when updating1631 using linkgit:git-fetch[1] or the `update` subcommand of1632 linkgit:git-remote[1].16331634remote.<name>.receivepack::1635 The default program to execute on the remote side when pushing. See1636 option \--receive-pack of linkgit:git-push[1].16371638remote.<name>.uploadpack::1639 The default program to execute on the remote side when fetching. See1640 option \--upload-pack of linkgit:git-fetch-pack[1].16411642remote.<name>.tagopt::1643 Setting this value to \--no-tags disables automatic tag following when1644 fetching from remote <name>. Setting it to \--tags will fetch every1645 tag from remote <name>, even if they are not reachable from remote1646 branch heads.16471648remote.<name>.vcs::1649 Setting this to a value <vcs> will cause git to interact with1650 the remote with the git-remote-<vcs> helper.16511652remotes.<group>::1653 The list of remotes which are fetched by "git remote update1654 <group>". See linkgit:git-remote[1].16551656repack.usedeltabaseoffset::1657 By default, linkgit:git-repack[1] creates packs that use1658 delta-base offset. If you need to share your repository with1659 git older than version 1.4.4, either directly or via a dumb1660 protocol such as http, then you need to set this option to1661 "false" and repack. Access from old git versions over the1662 native protocol are unaffected by this option.16631664rerere.autoupdate::1665 When set to true, `git-rerere` updates the index with the1666 resulting contents after it cleanly resolves conflicts using1667 previously recorded resolution. Defaults to false.16681669rerere.enabled::1670 Activate recording of resolved conflicts, so that identical1671 conflict hunks can be resolved automatically, should they1672 be encountered again. linkgit:git-rerere[1] command is by1673 default enabled if you create `rr-cache` directory under1674 `$GIT_DIR`, but can be disabled by setting this option to false.16751676sendemail.identity::1677 A configuration identity. When given, causes values in the1678 'sendemail.<identity>' subsection to take precedence over1679 values in the 'sendemail' section. The default identity is1680 the value of 'sendemail.identity'.16811682sendemail.smtpencryption::1683 See linkgit:git-send-email[1] for description. Note that this1684 setting is not subject to the 'identity' mechanism.16851686sendemail.smtpssl::1687 Deprecated alias for 'sendemail.smtpencryption = ssl'.16881689sendemail.<identity>.*::1690 Identity-specific versions of the 'sendemail.*' parameters1691 found below, taking precedence over those when the this1692 identity is selected, through command-line or1693 'sendemail.identity'.16941695sendemail.aliasesfile::1696sendemail.aliasfiletype::1697sendemail.bcc::1698sendemail.cc::1699sendemail.cccmd::1700sendemail.chainreplyto::1701sendemail.confirm::1702sendemail.envelopesender::1703sendemail.from::1704sendemail.multiedit::1705sendemail.signedoffbycc::1706sendemail.smtppass::1707sendemail.suppresscc::1708sendemail.suppressfrom::1709sendemail.to::1710sendemail.smtpdomain::1711sendemail.smtpserver::1712sendemail.smtpserverport::1713sendemail.smtpuser::1714sendemail.thread::1715sendemail.validate::1716 See linkgit:git-send-email[1] for description.17171718sendemail.signedoffcc::1719 Deprecated alias for 'sendemail.signedoffbycc'.17201721showbranch.default::1722 The default set of branches for linkgit:git-show-branch[1].1723 See linkgit:git-show-branch[1].17241725status.relativePaths::1726 By default, linkgit:git-status[1] shows paths relative to the1727 current directory. Setting this variable to `false` shows paths1728 relative to the repository root (this was the default for git1729 prior to v1.5.4).17301731status.showUntrackedFiles::1732 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1733 files which are not currently tracked by Git. Directories which1734 contain only untracked files, are shown with the directory name1735 only. Showing untracked files means that Git needs to lstat() all1736 all the files in the whole repository, which might be slow on some1737 systems. So, this variable controls how the commands displays1738 the untracked files. Possible values are:1739+1740--1741 - 'no' - Show no untracked files1742 - 'normal' - Shows untracked files and directories1743 - 'all' - Shows also individual files in untracked directories.1744--1745+1746If this variable is not specified, it defaults to 'normal'.1747This variable can be overridden with the -u|--untracked-files option1748of linkgit:git-status[1] and linkgit:git-commit[1].17491750status.submodulesummary::1751 Defaults to false.1752 If this is set to a non zero number or true (identical to -1 or an1753 unlimited number), the submodule summary will be enabled and a1754 summary of commits for modified submodules will be shown (see1755 --summary-limit option of linkgit:git-submodule[1]).17561757submodule.<name>.path::1758submodule.<name>.url::1759submodule.<name>.update::1760 The path within this project, URL, and the updating strategy1761 for a submodule. These variables are initially populated1762 by 'git submodule init'; edit them to override the1763 URL and other values found in the `.gitmodules` file. See1764 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.17651766submodule.<name>.ignore::1767 Defines under what circumstances "git status" and the diff family show1768 a submodule as modified. When set to "all", it will never be considered1769 modified, "dirty" will ignore all changes to the submodules work tree and1770 takes only differences between the HEAD of the submodule and the commit1771 recorded in the superproject into account. "untracked" will additionally1772 let submodules with modified tracked files in their work tree show up.1773 Using "none" (the default when this option is not set) also shows1774 submodules that have untracked files in their work tree as changed.1775 This setting overrides any setting made in .gitmodules for this submodule,1776 both settings can be overridden on the command line by using the1777 "--ignore-submodules" option.17781779tar.umask::1780 This variable can be used to restrict the permission bits of1781 tar archive entries. The default is 0002, which turns off the1782 world write bit. The special value "user" indicates that the1783 archiving user's umask will be used instead. See umask(2) and1784 linkgit:git-archive[1].17851786transfer.unpackLimit::1787 When `fetch.unpackLimit` or `receive.unpackLimit` are1788 not set, the value of this variable is used instead.1789 The default value is 100.17901791url.<base>.insteadOf::1792 Any URL that starts with this value will be rewritten to1793 start, instead, with <base>. In cases where some site serves a1794 large number of repositories, and serves them with multiple1795 access methods, and some users need to use different access1796 methods, this feature allows people to specify any of the1797 equivalent URLs and have git automatically rewrite the URL to1798 the best alternative for the particular user, even for a1799 never-before-seen repository on the site. When more than one1800 insteadOf strings match a given URL, the longest match is used.18011802url.<base>.pushInsteadOf::1803 Any URL that starts with this value will not be pushed to;1804 instead, it will be rewritten to start with <base>, and the1805 resulting URL will be pushed to. In cases where some site serves1806 a large number of repositories, and serves them with multiple1807 access methods, some of which do not allow push, this feature1808 allows people to specify a pull-only URL and have git1809 automatically use an appropriate URL to push, even for a1810 never-before-seen repository on the site. When more than one1811 pushInsteadOf strings match a given URL, the longest match is1812 used. If a remote has an explicit pushurl, git will ignore this1813 setting for that remote.18141815user.email::1816 Your email address to be recorded in any newly created commits.1817 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1818 'EMAIL' environment variables. See linkgit:git-commit-tree[1].18191820user.name::1821 Your full name to be recorded in any newly created commits.1822 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1823 environment variables. See linkgit:git-commit-tree[1].18241825user.signingkey::1826 If linkgit:git-tag[1] is not selecting the key you want it to1827 automatically when creating a signed tag, you can override the1828 default selection with this variable. This option is passed1829 unchanged to gpg's --local-user parameter, so you may specify a key1830 using any method that gpg supports.18311832web.browser::1833 Specify a web browser that may be used by some commands.1834 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1835 may use it.