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.autocrlf:: 200 If true, makes git convert `CRLF` at the end of lines in text files to 201 `LF` when reading from the work tree, and convert in reverse when 202 writing to the work tree. The variable can be set to 203 'input', in which case the conversion happens only while 204 reading from the work tree but files are written out to the work 205 tree with `LF` at the end of lines. A file is considered 206 "text" (i.e. be subjected to the autocrlf mechanism) based on 207 the file's `crlf` attribute, or if `crlf` is unspecified, 208 based on the file's contents. See linkgit:gitattributes[5]. 209 210core.safecrlf:: 211 If true, makes git check if converting `CRLF` as controlled by 212 `core.autocrlf` is reversible. Git will verify if a command 213 modifies a file in the work tree either directly or indirectly. 214 For example, committing a file followed by checking out the 215 same file should yield the original file in the work tree. If 216 this is not the case for the current setting of 217 `core.autocrlf`, git will reject the file. The variable can 218 be set to "warn", in which case git will only warn about an 219 irreversible conversion but continue the operation. 220+ 221CRLF conversion bears a slight chance of corrupting data. 222autocrlf=true will convert CRLF to LF during commit and LF to 223CRLF during checkout. A file that contains a mixture of LF and 224CRLF before the commit cannot be recreated by git. For text 225files this is the right thing to do: it corrects line endings 226such that we have only LF line endings in the repository. 227But for binary files that are accidentally classified as text the 228conversion can corrupt data. 229+ 230If you recognize such corruption early you can easily fix it by 231setting the conversion type explicitly in .gitattributes. Right 232after committing you still have the original file in your work 233tree and this file is not yet corrupted. You can explicitly tell 234git that this file is binary and git will handle the file 235appropriately. 236+ 237Unfortunately, the desired effect of cleaning up text files with 238mixed line endings and the undesired effect of corrupting binary 239files cannot be distinguished. In both cases CRLFs are removed 240in an irreversible way. For text files this is the right thing 241to do because CRLFs are line endings, while for binary files 242converting CRLFs corrupts data. 243+ 244Note, this safety check does not mean that a checkout will generate a 245file identical to the original file for a different setting of 246`core.autocrlf`, but only for the current one. For example, a text 247file with `LF` would be accepted with `core.autocrlf=input` and could 248later be checked out with `core.autocrlf=true`, in which case the 249resulting file would contain `CRLF`, although the original file 250contained `LF`. However, in both work trees the line endings would be 251consistent, that is either all `LF` or all `CRLF`, but never mixed. A 252file with mixed line endings would be reported by the `core.safecrlf` 253mechanism. 254 255core.symlinks:: 256 If false, symbolic links are checked out as small plain files that 257 contain the link text. linkgit:git-update-index[1] and 258 linkgit:git-add[1] will not change the recorded type to regular 259 file. Useful on filesystems like FAT that do not support 260 symbolic links. 261+ 262The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 263will probe and set core.symlinks false if appropriate when the repository 264is created. 265 266core.gitProxy:: 267 A "proxy command" to execute (as 'command host port') instead 268 of establishing direct connection to the remote server when 269 using the git protocol for fetching. If the variable value is 270 in the "COMMAND for DOMAIN" format, the command is applied only 271 on hostnames ending with the specified domain string. This variable 272 may be set multiple times and is matched in the given order; 273 the first match wins. 274+ 275Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 276(which always applies universally, without the special "for" 277handling). 278+ 279The special string `none` can be used as the proxy command to 280specify that no proxy be used for a given domain pattern. 281This is useful for excluding servers inside a firewall from 282proxy use, while defaulting to a common proxy for external domains. 283 284core.ignoreStat:: 285 If true, commands which modify both the working tree and the index 286 will mark the updated paths with the "assume unchanged" bit in the 287 index. These marked files are then assumed to stay unchanged in the 288 working copy, until you mark them otherwise manually - Git will not 289 detect the file changes by lstat() calls. This is useful on systems 290 where those are very slow, such as Microsoft Windows. 291 See linkgit:git-update-index[1]. 292 False by default. 293 294core.preferSymlinkRefs:: 295 Instead of the default "symref" format for HEAD 296 and other symbolic reference files, use symbolic links. 297 This is sometimes needed to work with old scripts that 298 expect HEAD to be a symbolic link. 299 300core.bare:: 301 If true this repository is assumed to be 'bare' and has no 302 working directory associated with it. If this is the case a 303 number of commands that require a working directory will be 304 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 305+ 306This setting is automatically guessed by linkgit:git-clone[1] or 307linkgit:git-init[1] when the repository was created. By default a 308repository that ends in "/.git" is assumed to be not bare (bare = 309false), while all other repositories are assumed to be bare (bare 310= true). 311 312core.worktree:: 313 Set the path to the root of the work tree. 314 This can be overridden by the GIT_WORK_TREE environment 315 variable and the '--work-tree' command line option. It can be 316 an absolute path or a relative path to the .git directory, 317 either specified by --git-dir or GIT_DIR, or automatically 318 discovered. 319 If --git-dir or GIT_DIR are specified but none of 320 --work-tree, GIT_WORK_TREE and core.worktree is specified, 321 the current working directory is regarded as the root of the 322 work tree. 323+ 324Note that this variable is honored even when set in a configuration 325file in a ".git" subdirectory of a directory, and its value differs 326from the latter directory (e.g. "/path/to/.git/config" has 327core.worktree set to "/different/path"), which is most likely a 328misconfiguration. Running git commands in "/path/to" directory will 329still use "/different/path" as the root of the work tree and can cause 330great confusion to the users. 331 332core.logAllRefUpdates:: 333 Enable the reflog. Updates to a ref <ref> is logged to the file 334 "$GIT_DIR/logs/<ref>", by appending the new and old 335 SHA1, the date/time and the reason of the update, but 336 only when the file exists. If this configuration 337 variable is set to true, missing "$GIT_DIR/logs/<ref>" 338 file is automatically created for branch heads. 339+ 340This information can be used to determine what commit 341was the tip of a branch "2 days ago". 342+ 343This value is true by default in a repository that has 344a working directory associated with it, and false by 345default in a bare repository. 346 347core.repositoryFormatVersion:: 348 Internal variable identifying the repository format and layout 349 version. 350 351core.sharedRepository:: 352 When 'group' (or 'true'), the repository is made shareable between 353 several users in a group (making sure all the files and objects are 354 group-writable). When 'all' (or 'world' or 'everybody'), the 355 repository will be readable by all users, additionally to being 356 group-shareable. When 'umask' (or 'false'), git will use permissions 357 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 358 files in the repository will have this mode value. '0xxx' will override 359 user's umask value (whereas the other options will only override 360 requested parts of the user's umask value). Examples: '0660' will make 361 the repo read/write-able for the owner and group, but inaccessible to 362 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 363 repository that is group-readable but not group-writable. 364 See linkgit:git-init[1]. False by default. 365 366core.warnAmbiguousRefs:: 367 If true, git will warn you if the ref name you passed it is ambiguous 368 and might match multiple refs in the .git/refs/ tree. True by default. 369 370core.compression:: 371 An integer -1..9, indicating a default compression level. 372 -1 is the zlib default. 0 means no compression, 373 and 1..9 are various speed/size tradeoffs, 9 being slowest. 374 If set, this provides a default to other compression variables, 375 such as 'core.loosecompression' and 'pack.compression'. 376 377core.loosecompression:: 378 An integer -1..9, indicating the compression level for objects that 379 are not in a pack file. -1 is the zlib default. 0 means no 380 compression, and 1..9 are various speed/size tradeoffs, 9 being 381 slowest. If not set, defaults to core.compression. If that is 382 not set, defaults to 1 (best speed). 383 384core.packedGitWindowSize:: 385 Number of bytes of a pack file to map into memory in a 386 single mapping operation. Larger window sizes may allow 387 your system to process a smaller number of large pack files 388 more quickly. Smaller window sizes will negatively affect 389 performance due to increased calls to the operating system's 390 memory manager, but may improve performance when accessing 391 a large number of large pack files. 392+ 393Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 394MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 395be reasonable for all users/operating systems. You probably do 396not need to adjust this value. 397+ 398Common unit suffixes of 'k', 'm', or 'g' are supported. 399 400core.packedGitLimit:: 401 Maximum number of bytes to map simultaneously into memory 402 from pack files. If Git needs to access more than this many 403 bytes at once to complete an operation it will unmap existing 404 regions to reclaim virtual address space within the process. 405+ 406Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 407This should be reasonable for all users/operating systems, except on 408the largest projects. You probably do not need to adjust this value. 409+ 410Common unit suffixes of 'k', 'm', or 'g' are supported. 411 412core.deltaBaseCacheLimit:: 413 Maximum number of bytes to reserve for caching base objects 414 that multiple deltafied objects reference. By storing the 415 entire decompressed base objects in a cache Git is able 416 to avoid unpacking and decompressing frequently used base 417 objects multiple times. 418+ 419Default is 16 MiB on all platforms. This should be reasonable 420for all users/operating systems, except on the largest projects. 421You probably do not need to adjust this value. 422+ 423Common unit suffixes of 'k', 'm', or 'g' are supported. 424 425core.bigFileThreshold:: 426 Files larger than this size are stored deflated, without 427 attempting delta compression. Storing large files without 428 delta compression avoids excessive memory usage, at the 429 slight expense of increased disk usage. 430+ 431Default is 512 MiB on all platforms. This should be reasonable 432for most projects as source code and other text files can still 433be delta compressed, but larger binary media files won't be. 434+ 435Common unit suffixes of 'k', 'm', or 'g' are supported. 436+ 437Currently only linkgit:git-fast-import[1] honors this setting. 438 439core.excludesfile:: 440 In addition to '.gitignore' (per-directory) and 441 '.git/info/exclude', git looks into this file for patterns 442 of files which are not meant to be tracked. "{tilde}/" is expanded 443 to the value of `$HOME` and "{tilde}user/" to the specified user's 444 home directory. See linkgit:gitignore[5]. 445 446core.editor:: 447 Commands such as `commit` and `tag` that lets you edit 448 messages by launching an editor uses the value of this 449 variable when it is set, and the environment variable 450 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 451 452core.pager:: 453 The command that git will use to paginate output. Can 454 be overridden with the `GIT_PAGER` environment 455 variable. Note that git sets the `LESS` environment 456 variable to `FRSX` if it is unset when it runs the 457 pager. One can change these settings by setting the 458 `LESS` variable to some other value. Alternately, 459 these settings can be overridden on a project or 460 global basis by setting the `core.pager` option. 461 Setting `core.pager` has no affect on the `LESS` 462 environment variable behaviour above, so if you want 463 to override git's default settings this way, you need 464 to be explicit. For example, to disable the S option 465 in a backward compatible manner, set `core.pager` 466 to `less -+$LESS -FRX`. This will be passed to the 467 shell by git, which will translate the final command to 468 `LESS=FRSX less -+FRSX -FRX`. 469 470core.whitespace:: 471 A comma separated list of common whitespace problems to 472 notice. 'git diff' will use `color.diff.whitespace` to 473 highlight them, and 'git apply --whitespace=error' will 474 consider them as errors. You can prefix `-` to disable 475 any of them (e.g. `-trailing-space`): 476+ 477* `blank-at-eol` treats trailing whitespaces at the end of the line 478 as an error (enabled by default). 479* `space-before-tab` treats a space character that appears immediately 480 before a tab character in the initial indent part of the line as an 481 error (enabled by default). 482* `indent-with-non-tab` treats a line that is indented with 8 or more 483 space characters as an error (not enabled by default). 484* `tab-in-indent` treats a tab character in the initial indent part of 485 the line as an error (not enabled by default). 486* `blank-at-eof` treats blank lines added at the end of file as an error 487 (enabled by default). 488* `trailing-space` is a short-hand to cover both `blank-at-eol` and 489 `blank-at-eof`. 490* `cr-at-eol` treats a carriage-return at the end of line as 491 part of the line terminator, i.e. with it, `trailing-space` 492 does not trigger if the character before such a carriage-return 493 is not a whitespace (not enabled by default). 494 495core.fsyncobjectfiles:: 496 This boolean will enable 'fsync()' when writing object files. 497+ 498This is a total waste of time and effort on a filesystem that orders 499data writes properly, but can be useful for filesystems that do not use 500journalling (traditional UNIX filesystems) or that only journal metadata 501and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 502 503core.preloadindex:: 504 Enable parallel index preload for operations like 'git diff' 505+ 506This can speed up operations like 'git diff' and 'git status' especially 507on filesystems like NFS that have weak caching semantics and thus 508relatively high IO latencies. With this set to 'true', git will do the 509index comparison to the filesystem data in parallel, allowing 510overlapping IO's. 511 512core.createObject:: 513 You can set this to 'link', in which case a hardlink followed by 514 a delete of the source are used to make sure that object creation 515 will not overwrite existing objects. 516+ 517On some file system/operating system combinations, this is unreliable. 518Set this config setting to 'rename' there; However, This will remove the 519check that makes sure that existing object files will not get overwritten. 520 521core.notesRef:: 522 When showing commit messages, also show notes which are stored in 523 the given ref. The ref must be fully qualified. If the given 524 ref does not exist, it is not an error but means that no 525 notes should be printed. 526+ 527This setting defaults to "refs/notes/commits", and it can be overridden by 528the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 529 530core.sparseCheckout:: 531 Enable "sparse checkout" feature. See section "Sparse checkout" in 532 linkgit:git-read-tree[1] for more information. 533 534add.ignore-errors:: 535 Tells 'git add' to continue adding files when some files cannot be 536 added due to indexing errors. Equivalent to the '--ignore-errors' 537 option of linkgit:git-add[1]. 538 539alias.*:: 540 Command aliases for the linkgit:git[1] command wrapper - e.g. 541 after defining "alias.last = cat-file commit HEAD", the invocation 542 "git last" is equivalent to "git cat-file commit HEAD". To avoid 543 confusion and troubles with script usage, aliases that 544 hide existing git commands are ignored. Arguments are split by 545 spaces, the usual shell quoting and escaping is supported. 546 quote pair and a backslash can be used to quote them. 547+ 548If the alias expansion is prefixed with an exclamation point, 549it will be treated as a shell command. For example, defining 550"alias.new = !gitk --all --not ORIG_HEAD", the invocation 551"git new" is equivalent to running the shell command 552"gitk --all --not ORIG_HEAD". Note that shell commands will be 553executed from the top-level directory of a repository, which may 554not necessarily be the current directory. 555 556am.keepcr:: 557 If true, git-am will call git-mailsplit for patches in mbox format 558 with parameter '--keep-cr'. In this case git-mailsplit will 559 not remove `\r` from lines ending with `\r\n`. Can be overrriden 560 by giving '--no-keep-cr' from the command line. 561 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 562 563apply.ignorewhitespace:: 564 When set to 'change', tells 'git apply' to ignore changes in 565 whitespace, in the same way as the '--ignore-space-change' 566 option. 567 When set to one of: no, none, never, false tells 'git apply' to 568 respect all whitespace differences. 569 See linkgit:git-apply[1]. 570 571apply.whitespace:: 572 Tells 'git apply' how to handle whitespaces, in the same way 573 as the '--whitespace' option. See linkgit:git-apply[1]. 574 575branch.autosetupmerge:: 576 Tells 'git branch' and 'git checkout' to set up new branches 577 so that linkgit:git-pull[1] will appropriately merge from the 578 starting point branch. Note that even if this option is not set, 579 this behavior can be chosen per-branch using the `--track` 580 and `--no-track` options. The valid settings are: `false` -- no 581 automatic setup is done; `true` -- automatic setup is done when the 582 starting point is a remote branch; `always` -- automatic setup is 583 done when the starting point is either a local branch or remote 584 branch. This option defaults to true. 585 586branch.autosetuprebase:: 587 When a new branch is created with 'git branch' or 'git checkout' 588 that tracks another branch, this variable tells git to set 589 up pull to rebase instead of merge (see "branch.<name>.rebase"). 590 When `never`, rebase is never automatically set to true. 591 When `local`, rebase is set to true for tracked branches of 592 other local branches. 593 When `remote`, rebase is set to true for tracked branches of 594 remote branches. 595 When `always`, rebase will be set to true for all tracking 596 branches. 597 See "branch.autosetupmerge" for details on how to set up a 598 branch to track another branch. 599 This option defaults to never. 600 601branch.<name>.remote:: 602 When in branch <name>, it tells 'git fetch' and 'git push' which 603 remote to fetch from/push to. It defaults to `origin` if no remote is 604 configured. `origin` is also used if you are not on any branch. 605 606branch.<name>.merge:: 607 Defines, together with branch.<name>.remote, the upstream branch 608 for the given branch. It tells 'git fetch'/'git pull' which 609 branch to merge and can also affect 'git push' (see push.default). 610 When in branch <name>, it tells 'git fetch' the default 611 refspec to be marked for merging in FETCH_HEAD. The value is 612 handled like the remote part of a refspec, and must match a 613 ref which is fetched from the remote given by 614 "branch.<name>.remote". 615 The merge information is used by 'git pull' (which at first calls 616 'git fetch') to lookup the default branch for merging. Without 617 this option, 'git pull' defaults to merge the first refspec fetched. 618 Specify multiple values to get an octopus merge. 619 If you wish to setup 'git pull' so that it merges into <name> from 620 another branch in the local repository, you can point 621 branch.<name>.merge to the desired branch, and use the special setting 622 `.` (a period) for branch.<name>.remote. 623 624branch.<name>.mergeoptions:: 625 Sets default options for merging into branch <name>. The syntax and 626 supported options are the same as those of linkgit:git-merge[1], but 627 option values containing whitespace characters are currently not 628 supported. 629 630branch.<name>.rebase:: 631 When true, rebase the branch <name> on top of the fetched branch, 632 instead of merging the default branch from the default remote when 633 "git pull" is run. 634 *NOTE*: this is a possibly dangerous operation; do *not* use 635 it unless you understand the implications (see linkgit:git-rebase[1] 636 for details). 637 638browser.<tool>.cmd:: 639 Specify the command to invoke the specified browser. The 640 specified command is evaluated in shell with the URLs passed 641 as arguments. (See linkgit:git-web--browse[1].) 642 643browser.<tool>.path:: 644 Override the path for the given tool that may be used to 645 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 646 working repository in gitweb (see linkgit:git-instaweb[1]). 647 648clean.requireForce:: 649 A boolean to make git-clean do nothing unless given -f 650 or -n. Defaults to true. 651 652color.branch:: 653 A boolean to enable/disable color in the output of 654 linkgit:git-branch[1]. May be set to `always`, 655 `false` (or `never`) or `auto` (or `true`), in which case colors are used 656 only when the output is to a terminal. Defaults to false. 657 658color.branch.<slot>:: 659 Use customized color for branch coloration. `<slot>` is one of 660 `current` (the current branch), `local` (a local branch), 661 `remote` (a tracking branch in refs/remotes/), `plain` (other 662 refs). 663+ 664The value for these configuration variables is a list of colors (at most 665two) and attributes (at most one), separated by spaces. The colors 666accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 667`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 668`blink` and `reverse`. The first color given is the foreground; the 669second is the background. The position of the attribute, if any, 670doesn't matter. 671 672color.diff:: 673 When set to `always`, always use colors in patch. 674 When false (or `never`), never. When set to `true` or `auto`, use 675 colors only when the output is to the terminal. Defaults to false. 676 677color.diff.<slot>:: 678 Use customized color for diff colorization. `<slot>` specifies 679 which part of the patch to use the specified color, and is one 680 of `plain` (context text), `meta` (metainformation), `frag` 681 (hunk header), 'func' (function in hunk header), `old` (removed lines), 682 `new` (added lines), `commit` (commit headers), or `whitespace` 683 (highlighting whitespace errors). The values of these variables may be 684 specified as in color.branch.<slot>. 685 686color.grep:: 687 When set to `always`, always highlight matches. When `false` (or 688 `never`), never. When set to `true` or `auto`, use color only 689 when the output is written to the terminal. Defaults to `false`. 690 691color.grep.<slot>:: 692 Use customized color for grep colorization. `<slot>` specifies which 693 part of the line to use the specified color, and is one of 694+ 695-- 696`context`;; 697 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 698`filename`;; 699 filename prefix (when not using `-h`) 700`function`;; 701 function name lines (when using `-p`) 702`linenumber`;; 703 line number prefix (when using `-n`) 704`match`;; 705 matching text 706`selected`;; 707 non-matching text in selected lines 708`separator`;; 709 separators between fields on a line (`:`, `-`, and `=`) 710 and between hunks (`--`) 711-- 712+ 713The values of these variables may be specified as in color.branch.<slot>. 714 715color.interactive:: 716 When set to `always`, always use colors for interactive prompts 717 and displays (such as those used by "git-add --interactive"). 718 When false (or `never`), never. When set to `true` or `auto`, use 719 colors only when the output is to the terminal. Defaults to false. 720 721color.interactive.<slot>:: 722 Use customized color for 'git add --interactive' 723 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 724 four distinct types of normal output from interactive 725 commands. The values of these variables may be specified as 726 in color.branch.<slot>. 727 728color.pager:: 729 A boolean to enable/disable colored output when the pager is in 730 use (default is true). 731 732color.showbranch:: 733 A boolean to enable/disable color in the output of 734 linkgit:git-show-branch[1]. May be set to `always`, 735 `false` (or `never`) or `auto` (or `true`), in which case colors are used 736 only when the output is to a terminal. Defaults to false. 737 738color.status:: 739 A boolean to enable/disable color in the output of 740 linkgit:git-status[1]. May be set to `always`, 741 `false` (or `never`) or `auto` (or `true`), in which case colors are used 742 only when the output is to a terminal. Defaults to false. 743 744color.status.<slot>:: 745 Use customized color for status colorization. `<slot>` is 746 one of `header` (the header text of the status message), 747 `added` or `updated` (files which are added but not committed), 748 `changed` (files which are changed but not added in the index), 749 `untracked` (files which are not tracked by git), or 750 `nobranch` (the color the 'no branch' warning is shown in, defaulting 751 to red). The values of these variables may be specified as in 752 color.branch.<slot>. 753 754color.ui:: 755 When set to `always`, always use colors in all git commands which 756 are capable of colored output. When false (or `never`), never. When 757 set to `true` or `auto`, use colors only when the output is to the 758 terminal. When more specific variables of color.* are set, they always 759 take precedence over this setting. Defaults to false. 760 761commit.status:: 762 A boolean to enable/disable inclusion of status information in the 763 commit message template when using an editor to prepare the commit 764 message. Defaults to true. 765 766commit.template:: 767 Specify a file to use as the template for new commit messages. 768 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 769 specified user's home directory. 770 771diff.autorefreshindex:: 772 When using 'git diff' to compare with work tree 773 files, do not consider stat-only change as changed. 774 Instead, silently run `git update-index --refresh` to 775 update the cached stat information for paths whose 776 contents in the work tree match the contents in the 777 index. This option defaults to true. Note that this 778 affects only 'git diff' Porcelain, and not lower level 779 'diff' commands such as 'git diff-files'. 780 781diff.external:: 782 If this config variable is set, diff generation is not 783 performed using the internal diff machinery, but using the 784 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 785 environment variable. The command is called with parameters 786 as described under "git Diffs" in linkgit:git[1]. Note: if 787 you want to use an external diff program only on a subset of 788 your files, you might want to use linkgit:gitattributes[5] instead. 789 790diff.mnemonicprefix:: 791 If set, 'git diff' uses a prefix pair that is different from the 792 standard "a/" and "b/" depending on what is being compared. When 793 this configuration is in effect, reverse diff output also swaps 794 the order of the prefixes: 795diff.noprefix:: 796 If set, 'git diff' does not show any source or destination prefix. 797`git diff`;; 798 compares the (i)ndex and the (w)ork tree; 799`git diff HEAD`;; 800 compares a (c)ommit and the (w)ork tree; 801`git diff --cached`;; 802 compares a (c)ommit and the (i)ndex; 803`git diff HEAD:file1 file2`;; 804 compares an (o)bject and a (w)ork tree entity; 805`git diff --no-index a b`;; 806 compares two non-git things (1) and (2). 807 808diff.renameLimit:: 809 The number of files to consider when performing the copy/rename 810 detection; equivalent to the 'git diff' option '-l'. 811 812diff.renames:: 813 Tells git to detect renames. If set to any boolean value, it 814 will enable basic rename detection. If set to "copies" or 815 "copy", it will detect copies, as well. 816 817diff.suppressBlankEmpty:: 818 A boolean to inhibit the standard behavior of printing a space 819 before each empty output line. Defaults to false. 820 821diff.tool:: 822 Controls which diff tool is used. `diff.tool` overrides 823 `merge.tool` when used by linkgit:git-difftool[1] and has 824 the same valid values as `merge.tool` minus "tortoisemerge" 825 and plus "kompare". 826 827difftool.<tool>.path:: 828 Override the path for the given tool. This is useful in case 829 your tool is not in the PATH. 830 831difftool.<tool>.cmd:: 832 Specify the command to invoke the specified diff tool. 833 The specified command is evaluated in shell with the following 834 variables available: 'LOCAL' is set to the name of the temporary 835 file containing the contents of the diff pre-image and 'REMOTE' 836 is set to the name of the temporary file containing the contents 837 of the diff post-image. 838 839difftool.prompt:: 840 Prompt before each invocation of the diff tool. 841 842diff.wordRegex:: 843 A POSIX Extended Regular Expression used to determine what is a "word" 844 when performing word-by-word difference calculations. Character 845 sequences that match the regular expression are "words", all other 846 characters are *ignorable* whitespace. 847 848fetch.unpackLimit:: 849 If the number of objects fetched over the git native 850 transfer is below this 851 limit, then the objects will be unpacked into loose object 852 files. However if the number of received objects equals or 853 exceeds this limit then the received pack will be stored as 854 a pack, after adding any missing delta bases. Storing the 855 pack from a push can make the push operation complete faster, 856 especially on slow filesystems. If not set, the value of 857 `transfer.unpackLimit` is used instead. 858 859format.attach:: 860 Enable multipart/mixed attachments as the default for 861 'format-patch'. The value can also be a double quoted string 862 which will enable attachments as the default and set the 863 value as the boundary. See the --attach option in 864 linkgit:git-format-patch[1]. 865 866format.numbered:: 867 A boolean which can enable or disable sequence numbers in patch 868 subjects. It defaults to "auto" which enables it only if there 869 is more than one patch. It can be enabled or disabled for all 870 messages by setting it to "true" or "false". See --numbered 871 option in linkgit:git-format-patch[1]. 872 873format.headers:: 874 Additional email headers to include in a patch to be submitted 875 by mail. See linkgit:git-format-patch[1]. 876 877format.cc:: 878 Additional "Cc:" headers to include in a patch to be submitted 879 by mail. See the --cc option in linkgit:git-format-patch[1]. 880 881format.subjectprefix:: 882 The default for format-patch is to output files with the '[PATCH]' 883 subject prefix. Use this variable to change that prefix. 884 885format.suffix:: 886 The default for format-patch is to output files with the suffix 887 `.patch`. Use this variable to change that suffix (make sure to 888 include the dot if you want it). 889 890format.pretty:: 891 The default pretty format for log/show/whatchanged command, 892 See linkgit:git-log[1], linkgit:git-show[1], 893 linkgit:git-whatchanged[1]. 894 895format.thread:: 896 The default threading style for 'git format-patch'. Can be 897 a boolean value, or `shallow` or `deep`. `shallow` threading 898 makes every mail a reply to the head of the series, 899 where the head is chosen from the cover letter, the 900 `\--in-reply-to`, and the first patch mail, in this order. 901 `deep` threading makes every mail a reply to the previous one. 902 A true boolean value is the same as `shallow`, and a false 903 value disables threading. 904 905format.signoff:: 906 A boolean value which lets you enable the `-s/--signoff` option of 907 format-patch by default. *Note:* Adding the Signed-off-by: line to a 908 patch should be a conscious act and means that you certify you have 909 the rights to submit this work under the same open source license. 910 Please see the 'SubmittingPatches' document for further discussion. 911 912gc.aggressiveWindow:: 913 The window size parameter used in the delta compression 914 algorithm used by 'git gc --aggressive'. This defaults 915 to 250. 916 917gc.auto:: 918 When there are approximately more than this many loose 919 objects in the repository, `git gc --auto` will pack them. 920 Some Porcelain commands use this command to perform a 921 light-weight garbage collection from time to time. The 922 default value is 6700. Setting this to 0 disables it. 923 924gc.autopacklimit:: 925 When there are more than this many packs that are not 926 marked with `*.keep` file in the repository, `git gc 927 --auto` consolidates them into one larger pack. The 928 default value is 50. Setting this to 0 disables it. 929 930gc.packrefs:: 931 Running `git pack-refs` in a repository renders it 932 unclonable by Git versions prior to 1.5.1.2 over dumb 933 transports such as HTTP. This variable determines whether 934 'git gc' runs `git pack-refs`. This can be set to `nobare` 935 to enable it within all non-bare repos or it can be set to a 936 boolean value. The default is `true`. 937 938gc.pruneexpire:: 939 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 940 Override the grace period with this config variable. The value 941 "now" may be used to disable this grace period and always prune 942 unreachable objects immediately. 943 944gc.reflogexpire:: 945gc.<pattern>.reflogexpire:: 946 'git reflog expire' removes reflog entries older than 947 this time; defaults to 90 days. With "<pattern>" (e.g. 948 "refs/stash") in the middle the setting applies only to 949 the refs that match the <pattern>. 950 951gc.reflogexpireunreachable:: 952gc.<ref>.reflogexpireunreachable:: 953 'git reflog expire' removes reflog entries older than 954 this time and are not reachable from the current tip; 955 defaults to 30 days. With "<pattern>" (e.g. "refs/stash") 956 in the middle, the setting applies only to the refs that 957 match the <pattern>. 958 959gc.rerereresolved:: 960 Records of conflicted merge you resolved earlier are 961 kept for this many days when 'git rerere gc' is run. 962 The default is 60 days. See linkgit:git-rerere[1]. 963 964gc.rerereunresolved:: 965 Records of conflicted merge you have not resolved are 966 kept for this many days when 'git rerere gc' is run. 967 The default is 15 days. See linkgit:git-rerere[1]. 968 969gitcvs.commitmsgannotation:: 970 Append this string to each commit message. Set to empty string 971 to disable this feature. Defaults to "via git-CVS emulator". 972 973gitcvs.enabled:: 974 Whether the CVS server interface is enabled for this repository. 975 See linkgit:git-cvsserver[1]. 976 977gitcvs.logfile:: 978 Path to a log file where the CVS server interface well... logs 979 various stuff. See linkgit:git-cvsserver[1]. 980 981gitcvs.usecrlfattr:: 982 If true, the server will look up the `crlf` attribute for 983 files to determine the '-k' modes to use. If `crlf` is set, 984 the '-k' mode will be left blank, so cvs clients will 985 treat it as text. If `crlf` is explicitly unset, the file 986 will be set with '-kb' mode, which suppresses any newline munging 987 the client might otherwise do. If `crlf` is not specified, 988 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 989 990gitcvs.allbinary:: 991 This is used if 'gitcvs.usecrlfattr' does not resolve 992 the correct '-kb' mode to use. If true, all 993 unresolved files are sent to the client in 994 mode '-kb'. This causes the client to treat them 995 as binary files, which suppresses any newline munging it 996 otherwise might do. Alternatively, if it is set to "guess", 997 then the contents of the file are examined to decide if 998 it is binary, similar to 'core.autocrlf'. 9991000gitcvs.dbname::1001 Database used by git-cvsserver to cache revision information1002 derived from the git repository. The exact meaning depends on the1003 used database driver, for SQLite (which is the default driver) this1004 is a filename. Supports variable substitution (see1005 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1006 Default: '%Ggitcvs.%m.sqlite'10071008gitcvs.dbdriver::1009 Used Perl DBI driver. You can specify any available driver1010 for this here, but it might not work. git-cvsserver is tested1011 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1012 reported *not* to work with 'DBD::mysql'. Experimental feature.1013 May not contain double colons (`:`). Default: 'SQLite'.1014 See linkgit:git-cvsserver[1].10151016gitcvs.dbuser, gitcvs.dbpass::1017 Database user and password. Only useful if setting 'gitcvs.dbdriver',1018 since SQLite has no concept of database users and/or passwords.1019 'gitcvs.dbuser' supports variable substitution (see1020 linkgit:git-cvsserver[1] for details).10211022gitcvs.dbTableNamePrefix::1023 Database table name prefix. Prepended to the names of any1024 database tables used, allowing a single database to be used1025 for several repositories. Supports variable substitution (see1026 linkgit:git-cvsserver[1] for details). Any non-alphabetic1027 characters will be replaced with underscores.10281029All gitcvs variables except for 'gitcvs.usecrlfattr' and1030'gitcvs.allbinary' can also be specified as1031'gitcvs.<access_method>.<varname>' (where 'access_method'1032is one of "ext" and "pserver") to make them apply only for the given1033access method.10341035gui.commitmsgwidth::1036 Defines how wide the commit message window is in the1037 linkgit:git-gui[1]. "75" is the default.10381039gui.diffcontext::1040 Specifies how many context lines should be used in calls to diff1041 made by the linkgit:git-gui[1]. The default is "5".10421043gui.encoding::1044 Specifies the default encoding to use for displaying of1045 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1046 It can be overridden by setting the 'encoding' attribute1047 for relevant files (see linkgit:gitattributes[5]).1048 If this option is not set, the tools default to the1049 locale encoding.10501051gui.matchtrackingbranch::1052 Determines if new branches created with linkgit:git-gui[1] should1053 default to tracking remote branches with matching names or1054 not. Default: "false".10551056gui.newbranchtemplate::1057 Is used as suggested name when creating new branches using the1058 linkgit:git-gui[1].10591060gui.pruneduringfetch::1061 "true" if linkgit:git-gui[1] should prune tracking branches when1062 performing a fetch. The default value is "false".10631064gui.trustmtime::1065 Determines if linkgit:git-gui[1] should trust the file modification1066 timestamp or not. By default the timestamps are not trusted.10671068gui.spellingdictionary::1069 Specifies the dictionary used for spell checking commit messages in1070 the linkgit:git-gui[1]. When set to "none" spell checking is turned1071 off.10721073gui.fastcopyblame::1074 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1075 location detection. It makes blame significantly faster on huge1076 repositories at the expense of less thorough copy detection.10771078gui.copyblamethreshold::1079 Specifies the threshold to use in 'git gui blame' original location1080 detection, measured in alphanumeric characters. See the1081 linkgit:git-blame[1] manual for more information on copy detection.10821083gui.blamehistoryctx::1084 Specifies the radius of history context in days to show in1085 linkgit:gitk[1] for the selected commit, when the `Show History1086 Context` menu item is invoked from 'git gui blame'. If this1087 variable is set to zero, the whole history is shown.10881089guitool.<name>.cmd::1090 Specifies the shell command line to execute when the corresponding item1091 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1092 mandatory for every tool. The command is executed from the root of1093 the working directory, and in the environment it receives the name of1094 the tool as 'GIT_GUITOOL', the name of the currently selected file as1095 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1096 the head is detached, 'CUR_BRANCH' is empty).10971098guitool.<name>.needsfile::1099 Run the tool only if a diff is selected in the GUI. It guarantees1100 that 'FILENAME' is not empty.11011102guitool.<name>.noconsole::1103 Run the command silently, without creating a window to display its1104 output.11051106guitool.<name>.norescan::1107 Don't rescan the working directory for changes after the tool1108 finishes execution.11091110guitool.<name>.confirm::1111 Show a confirmation dialog before actually running the tool.11121113guitool.<name>.argprompt::1114 Request a string argument from the user, and pass it to the tool1115 through the 'ARGS' environment variable. Since requesting an1116 argument implies confirmation, the 'confirm' option has no effect1117 if this is enabled. If the option is set to 'true', 'yes', or '1',1118 the dialog uses a built-in generic prompt; otherwise the exact1119 value of the variable is used.11201121guitool.<name>.revprompt::1122 Request a single valid revision from the user, and set the1123 'REVISION' environment variable. In other aspects this option1124 is similar to 'argprompt', and can be used together with it.11251126guitool.<name>.revunmerged::1127 Show only unmerged branches in the 'revprompt' subdialog.1128 This is useful for tools similar to merge or rebase, but not1129 for things like checkout or reset.11301131guitool.<name>.title::1132 Specifies the title to use for the prompt dialog. The default1133 is the tool name.11341135guitool.<name>.prompt::1136 Specifies the general prompt string to display at the top of1137 the dialog, before subsections for 'argprompt' and 'revprompt'.1138 The default value includes the actual command.11391140help.browser::1141 Specify the browser that will be used to display help in the1142 'web' format. See linkgit:git-help[1].11431144help.format::1145 Override the default help format used by linkgit:git-help[1].1146 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1147 the default. 'web' and 'html' are the same.11481149help.autocorrect::1150 Automatically correct and execute mistyped commands after1151 waiting for the given number of deciseconds (0.1 sec). If more1152 than one command can be deduced from the entered text, nothing1153 will be executed. If the value of this option is negative,1154 the corrected command will be executed immediately. If the1155 value is 0 - the command will be just shown but not executed.1156 This is the default.11571158http.proxy::1159 Override the HTTP proxy, normally configured using the 'http_proxy'1160 environment variable (see linkgit:curl[1]). This can be overridden1161 on a per-remote basis; see remote.<name>.proxy11621163http.sslVerify::1164 Whether to verify the SSL certificate when fetching or pushing1165 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1166 variable.11671168http.sslCert::1169 File containing the SSL certificate when fetching or pushing1170 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1171 variable.11721173http.sslKey::1174 File containing the SSL private key when fetching or pushing1175 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1176 variable.11771178http.sslCertPasswordProtected::1179 Enable git's password prompt for the SSL certificate. Otherwise1180 OpenSSL will prompt the user, possibly many times, if the1181 certificate or private key is encrypted. Can be overridden by the1182 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.11831184http.sslCAInfo::1185 File containing the certificates to verify the peer with when1186 fetching or pushing over HTTPS. Can be overridden by the1187 'GIT_SSL_CAINFO' environment variable.11881189http.sslCAPath::1190 Path containing files with the CA certificates to verify the peer1191 with when fetching or pushing over HTTPS. Can be overridden1192 by the 'GIT_SSL_CAPATH' environment variable.11931194http.maxRequests::1195 How many HTTP requests to launch in parallel. Can be overridden1196 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.11971198http.minSessions::1199 The number of curl sessions (counted across slots) to be kept across1200 requests. They will not be ended with curl_easy_cleanup() until1201 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1202 value will be capped at 1. Defaults to 1.12031204http.postBuffer::1205 Maximum size in bytes of the buffer used by smart HTTP1206 transports when POSTing data to the remote system.1207 For requests larger than this buffer size, HTTP/1.1 and1208 Transfer-Encoding: chunked is used to avoid creating a1209 massive pack file locally. Default is 1 MiB, which is1210 sufficient for most requests.12111212http.lowSpeedLimit, http.lowSpeedTime::1213 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1214 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1215 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1216 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12171218http.noEPSV::1219 A boolean which disables using of EPSV ftp command by curl.1220 This can helpful with some "poor" ftp servers which don't1221 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1222 environment variable. Default is false (curl will use EPSV).12231224i18n.commitEncoding::1225 Character encoding the commit messages are stored in; git itself1226 does not care per se, but this information is necessary e.g. when1227 importing commits from emails or in the gitk graphical history1228 browser (and possibly at other places in the future or in other1229 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12301231i18n.logOutputEncoding::1232 Character encoding the commit messages are converted to when1233 running 'git log' and friends.12341235imap::1236 The configuration variables in the 'imap' section are described1237 in linkgit:git-imap-send[1].12381239init.templatedir::1240 Specify the directory from which templates will be copied.1241 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12421243instaweb.browser::1244 Specify the program that will be used to browse your working1245 repository in gitweb. See linkgit:git-instaweb[1].12461247instaweb.httpd::1248 The HTTP daemon command-line to start gitweb on your working1249 repository. See linkgit:git-instaweb[1].12501251instaweb.local::1252 If true the web server started by linkgit:git-instaweb[1] will1253 be bound to the local IP (127.0.0.1).12541255instaweb.modulepath::1256 The module path for an apache httpd used by linkgit:git-instaweb[1].12571258instaweb.port::1259 The port number to bind the gitweb httpd to. See1260 linkgit:git-instaweb[1].12611262interactive.singlekey::1263 In interactive commands, allow the user to provide one-letter1264 input with a single key (i.e., without hitting enter).1265 Currently this is used only by the `\--patch` mode of1266 linkgit:git-add[1]. Note that this setting is silently1267 ignored if portable keystroke input is not available.12681269log.date::1270 Set default date-time mode for the log command. Setting log.date1271 value is similar to using 'git log'\'s --date option. The value is one of the1272 following alternatives: {relative,local,default,iso,rfc,short}.1273 See linkgit:git-log[1].12741275log.decorate::1276 Print out the ref names of any commits that are shown by the log1277 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1278 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1279 specified, the full ref name (including prefix) will be printed.1280 This is the same as the log commands '--decorate' option.12811282log.showroot::1283 If true, the initial commit will be shown as a big creation event.1284 This is equivalent to a diff against an empty tree.1285 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1286 normally hide the root commit will now show it. True by default.12871288mailmap.file::1289 The location of an augmenting mailmap file. The default1290 mailmap, located in the root of the repository, is loaded1291 first, then the mailmap file pointed to by this variable.1292 The location of the mailmap file may be in a repository1293 subdirectory, or somewhere outside of the repository itself.1294 See linkgit:git-shortlog[1] and linkgit:git-blame[1].12951296man.viewer::1297 Specify the programs that may be used to display help in the1298 'man' format. See linkgit:git-help[1].12991300man.<tool>.cmd::1301 Specify the command to invoke the specified man viewer. The1302 specified command is evaluated in shell with the man page1303 passed as argument. (See linkgit:git-help[1].)13041305man.<tool>.path::1306 Override the path for the given tool that may be used to1307 display help in the 'man' format. See linkgit:git-help[1].13081309include::merge-config.txt[]13101311mergetool.<tool>.path::1312 Override the path for the given tool. This is useful in case1313 your tool is not in the PATH.13141315mergetool.<tool>.cmd::1316 Specify the command to invoke the specified merge tool. The1317 specified command is evaluated in shell with the following1318 variables available: 'BASE' is the name of a temporary file1319 containing the common base of the files to be merged, if available;1320 'LOCAL' is the name of a temporary file containing the contents of1321 the file on the current branch; 'REMOTE' is the name of a temporary1322 file containing the contents of the file from the branch being1323 merged; 'MERGED' contains the name of the file to which the merge1324 tool should write the results of a successful merge.13251326mergetool.<tool>.trustExitCode::1327 For a custom merge command, specify whether the exit code of1328 the merge command can be used to determine whether the merge was1329 successful. If this is not set to true then the merge target file1330 timestamp is checked and the merge assumed to have been successful1331 if the file has been updated, otherwise the user is prompted to1332 indicate the success of the merge.13331334mergetool.keepBackup::1335 After performing a merge, the original file with conflict markers1336 can be saved as a file with a `.orig` extension. If this variable1337 is set to `false` then this file is not preserved. Defaults to1338 `true` (i.e. keep the backup files).13391340mergetool.keepTemporaries::1341 When invoking a custom merge tool, git uses a set of temporary1342 files to pass to the tool. If the tool returns an error and this1343 variable is set to `true`, then these temporary files will be1344 preserved, otherwise they will be removed after the tool has1345 exited. Defaults to `false`.13461347mergetool.prompt::1348 Prompt before each invocation of the merge resolution program.13491350notes.displayRef::1351 The (fully qualified) refname from which to show notes when1352 showing commit messages. The value of this variable can be set1353 to a glob, in which case notes from all matching refs will be1354 shown. You may also specify this configuration variable1355 several times. A warning will be issued for refs that do not1356 exist, but a glob that does not match any refs is silently1357 ignored.1358+1359This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1360environment variable, which must be a colon separated list of refs or1361globs.1362+1363The effective value of "core.notesRef" (possibly overridden by1364GIT_NOTES_REF) is also implicitly added to the list of refs to be1365displayed.13661367notes.rewrite.<command>::1368 When rewriting commits with <command> (currently `amend` or1369 `rebase`) and this variable is set to `true`, git1370 automatically copies your notes from the original to the1371 rewritten commit. Defaults to `true`, but see1372 "notes.rewriteRef" below.13731374notes.rewriteMode::1375 When copying notes during a rewrite (see the1376 "notes.rewrite.<command>" option), determines what to do if1377 the target commit already has a note. Must be one of1378 `overwrite`, `concatenate`, or `ignore`. Defaults to1379 `concatenate`.1380+1381This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1382environment variable.13831384notes.rewriteRef::1385 When copying notes during a rewrite, specifies the (fully1386 qualified) ref whose notes should be copied. The ref may be a1387 glob, in which case notes in all matching refs will be copied.1388 You may also specify this configuration several times.1389+1390Does not have a default value; you must configure this variable to1391enable note rewriting.1392+1393This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1394environment variable, which must be a colon separated list of refs or1395globs.13961397pack.window::1398 The size of the window used by linkgit:git-pack-objects[1] when no1399 window size is given on the command line. Defaults to 10.14001401pack.depth::1402 The maximum delta depth used by linkgit:git-pack-objects[1] when no1403 maximum depth is given on the command line. Defaults to 50.14041405pack.windowMemory::1406 The window memory size limit used by linkgit:git-pack-objects[1]1407 when no limit is given on the command line. The value can be1408 suffixed with "k", "m", or "g". Defaults to 0, meaning no1409 limit.14101411pack.compression::1412 An integer -1..9, indicating the compression level for objects1413 in a pack file. -1 is the zlib default. 0 means no1414 compression, and 1..9 are various speed/size tradeoffs, 9 being1415 slowest. If not set, defaults to core.compression. If that is1416 not set, defaults to -1, the zlib default, which is "a default1417 compromise between speed and compression (currently equivalent1418 to level 6)."14191420pack.deltaCacheSize::1421 The maximum memory in bytes used for caching deltas in1422 linkgit:git-pack-objects[1] before writing them out to a pack.1423 This cache is used to speed up the writing object phase by not1424 having to recompute the final delta result once the best match1425 for all objects is found. Repacking large repositories on machines1426 which are tight with memory might be badly impacted by this though,1427 especially if this cache pushes the system into swapping.1428 A value of 0 means no limit. The smallest size of 1 byte may be1429 used to virtually disable this cache. Defaults to 256 MiB.14301431pack.deltaCacheLimit::1432 The maximum size of a delta, that is cached in1433 linkgit:git-pack-objects[1]. This cache is used to speed up the1434 writing object phase by not having to recompute the final delta1435 result once the best match for all objects is found. Defaults to 1000.14361437pack.threads::1438 Specifies the number of threads to spawn when searching for best1439 delta matches. This requires that linkgit:git-pack-objects[1]1440 be compiled with pthreads otherwise this option is ignored with a1441 warning. This is meant to reduce packing time on multiprocessor1442 machines. The required amount of memory for the delta search window1443 is however multiplied by the number of threads.1444 Specifying 0 will cause git to auto-detect the number of CPU's1445 and set the number of threads accordingly.14461447pack.indexVersion::1448 Specify the default pack index version. Valid values are 1 for1449 legacy pack index used by Git versions prior to 1.5.2, and 2 for1450 the new pack index with capabilities for packs larger than 4 GB1451 as well as proper protection against the repacking of corrupted1452 packs. Version 2 is the default. Note that version 2 is enforced1453 and this config option ignored whenever the corresponding pack is1454 larger than 2 GB.1455+1456If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1457cloning or fetching over a non native protocol (e.g. "http" and "rsync")1458that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1459other side may give you a repository that cannot be accessed with your1460older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1461you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1462the `{asterisk}.idx` file.14631464pack.packSizeLimit::1465 The maximum size of a pack. This setting only affects1466 packing to a file when repacking, i.e. the git:// protocol1467 is unaffected. It can be overridden by the `\--max-pack-size`1468 option of linkgit:git-repack[1]. The minimum size allowed is1469 limited to 1 MiB. The default is unlimited.1470 Common unit suffixes of 'k', 'm', or 'g' are1471 supported.14721473pager.<cmd>::1474 Allows turning on or off pagination of the output of a1475 particular git subcommand when writing to a tty. If1476 `\--paginate` or `\--no-pager` is specified on the command line,1477 it takes precedence over this option. To disable pagination for1478 all commands, set `core.pager` or `GIT_PAGER` to `cat`.14791480pretty.<name>::1481 Alias for a --pretty= format string, as specified in1482 linkgit:git-log[1]. Any aliases defined here can be used just1483 as the built-in pretty formats could. For example,1484 running `git config pretty.changelog "format:{asterisk} %H %s"`1485 would cause the invocation `git log --pretty=changelog`1486 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1487 Note that an alias with the same name as a built-in format1488 will be silently ignored.14891490pull.octopus::1491 The default merge strategy to use when pulling multiple branches1492 at once.14931494pull.twohead::1495 The default merge strategy to use when pulling a single branch.14961497push.default::1498 Defines the action git push should take if no refspec is given1499 on the command line, no refspec is configured in the remote, and1500 no refspec is implied by any of the options given on the command1501 line. Possible values are:1502+1503* `nothing` do not push anything.1504* `matching` push all matching branches.1505 All branches having the same name in both ends are considered to be1506 matching. This is the default.1507* `tracking` push the current branch to its upstream branch.1508* `current` push the current branch to a branch of the same name.15091510rebase.stat::1511 Whether to show a diffstat of what changed upstream since the last1512 rebase. False by default.15131514receive.autogc::1515 By default, git-receive-pack will run "git-gc --auto" after1516 receiving data from git-push and updating refs. You can stop1517 it by setting this variable to false.15181519receive.fsckObjects::1520 If it is set to true, git-receive-pack will check all received1521 objects. It will abort in the case of a malformed object or a1522 broken link. The result of an abort are only dangling objects.1523 Defaults to false.15241525receive.unpackLimit::1526 If the number of objects received in a push is below this1527 limit then the objects will be unpacked into loose object1528 files. However if the number of received objects equals or1529 exceeds this limit then the received pack will be stored as1530 a pack, after adding any missing delta bases. Storing the1531 pack from a push can make the push operation complete faster,1532 especially on slow filesystems. If not set, the value of1533 `transfer.unpackLimit` is used instead.15341535receive.denyDeletes::1536 If set to true, git-receive-pack will deny a ref update that deletes1537 the ref. Use this to prevent such a ref deletion via a push.15381539receive.denyCurrentBranch::1540 If set to true or "refuse", git-receive-pack will deny a ref update1541 to the currently checked out branch of a non-bare repository.1542 Such a push is potentially dangerous because it brings the HEAD1543 out of sync with the index and working tree. If set to "warn",1544 print a warning of such a push to stderr, but allow the push to1545 proceed. If set to false or "ignore", allow such pushes with no1546 message. Defaults to "refuse".15471548receive.denyNonFastForwards::1549 If set to true, git-receive-pack will deny a ref update which is1550 not a fast-forward. Use this to prevent such an update via a push,1551 even if that push is forced. This configuration variable is1552 set when initializing a shared repository.15531554receive.updateserverinfo::1555 If set to true, git-receive-pack will run git-update-server-info1556 after receiving data from git-push and updating refs.15571558remote.<name>.url::1559 The URL of a remote repository. See linkgit:git-fetch[1] or1560 linkgit:git-push[1].15611562remote.<name>.pushurl::1563 The push URL of a remote repository. See linkgit:git-push[1].15641565remote.<name>.proxy::1566 For remotes that require curl (http, https and ftp), the URL to1567 the proxy to use for that remote. Set to the empty string to1568 disable proxying for that remote.15691570remote.<name>.fetch::1571 The default set of "refspec" for linkgit:git-fetch[1]. See1572 linkgit:git-fetch[1].15731574remote.<name>.push::1575 The default set of "refspec" for linkgit:git-push[1]. See1576 linkgit:git-push[1].15771578remote.<name>.mirror::1579 If true, pushing to this remote will automatically behave1580 as if the `\--mirror` option was given on the command line.15811582remote.<name>.skipDefaultUpdate::1583 If true, this remote will be skipped by default when updating1584 using linkgit:git-fetch[1] or the `update` subcommand of1585 linkgit:git-remote[1].15861587remote.<name>.skipFetchAll::1588 If true, this remote will be skipped by default when updating1589 using linkgit:git-fetch[1] or the `update` subcommand of1590 linkgit:git-remote[1].15911592remote.<name>.receivepack::1593 The default program to execute on the remote side when pushing. See1594 option \--receive-pack of linkgit:git-push[1].15951596remote.<name>.uploadpack::1597 The default program to execute on the remote side when fetching. See1598 option \--upload-pack of linkgit:git-fetch-pack[1].15991600remote.<name>.tagopt::1601 Setting this value to \--no-tags disables automatic tag following when1602 fetching from remote <name>. Setting it to \--tags will fetch every1603 tag from remote <name>, even if they are not reachable from remote1604 branch heads.16051606remote.<name>.vcs::1607 Setting this to a value <vcs> will cause git to interact with1608 the remote with the git-remote-<vcs> helper.16091610remotes.<group>::1611 The list of remotes which are fetched by "git remote update1612 <group>". See linkgit:git-remote[1].16131614repack.usedeltabaseoffset::1615 By default, linkgit:git-repack[1] creates packs that use1616 delta-base offset. If you need to share your repository with1617 git older than version 1.4.4, either directly or via a dumb1618 protocol such as http, then you need to set this option to1619 "false" and repack. Access from old git versions over the1620 native protocol are unaffected by this option.16211622rerere.autoupdate::1623 When set to true, `git-rerere` updates the index with the1624 resulting contents after it cleanly resolves conflicts using1625 previously recorded resolution. Defaults to false.16261627rerere.enabled::1628 Activate recording of resolved conflicts, so that identical1629 conflict hunks can be resolved automatically, should they1630 be encountered again. linkgit:git-rerere[1] command is by1631 default enabled if you create `rr-cache` directory under1632 `$GIT_DIR`, but can be disabled by setting this option to false.16331634sendemail.identity::1635 A configuration identity. When given, causes values in the1636 'sendemail.<identity>' subsection to take precedence over1637 values in the 'sendemail' section. The default identity is1638 the value of 'sendemail.identity'.16391640sendemail.smtpencryption::1641 See linkgit:git-send-email[1] for description. Note that this1642 setting is not subject to the 'identity' mechanism.16431644sendemail.smtpssl::1645 Deprecated alias for 'sendemail.smtpencryption = ssl'.16461647sendemail.<identity>.*::1648 Identity-specific versions of the 'sendemail.*' parameters1649 found below, taking precedence over those when the this1650 identity is selected, through command-line or1651 'sendemail.identity'.16521653sendemail.aliasesfile::1654sendemail.aliasfiletype::1655sendemail.bcc::1656sendemail.cc::1657sendemail.cccmd::1658sendemail.chainreplyto::1659sendemail.confirm::1660sendemail.envelopesender::1661sendemail.from::1662sendemail.multiedit::1663sendemail.signedoffbycc::1664sendemail.smtppass::1665sendemail.suppresscc::1666sendemail.suppressfrom::1667sendemail.to::1668sendemail.smtpdomain::1669sendemail.smtpserver::1670sendemail.smtpserverport::1671sendemail.smtpuser::1672sendemail.thread::1673sendemail.validate::1674 See linkgit:git-send-email[1] for description.16751676sendemail.signedoffcc::1677 Deprecated alias for 'sendemail.signedoffbycc'.16781679showbranch.default::1680 The default set of branches for linkgit:git-show-branch[1].1681 See linkgit:git-show-branch[1].16821683status.relativePaths::1684 By default, linkgit:git-status[1] shows paths relative to the1685 current directory. Setting this variable to `false` shows paths1686 relative to the repository root (this was the default for git1687 prior to v1.5.4).16881689status.showUntrackedFiles::1690 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1691 files which are not currently tracked by Git. Directories which1692 contain only untracked files, are shown with the directory name1693 only. Showing untracked files means that Git needs to lstat() all1694 all the files in the whole repository, which might be slow on some1695 systems. So, this variable controls how the commands displays1696 the untracked files. Possible values are:1697+1698--1699 - 'no' - Show no untracked files1700 - 'normal' - Shows untracked files and directories1701 - 'all' - Shows also individual files in untracked directories.1702--1703+1704If this variable is not specified, it defaults to 'normal'.1705This variable can be overridden with the -u|--untracked-files option1706of linkgit:git-status[1] and linkgit:git-commit[1].17071708status.submodulesummary::1709 Defaults to false.1710 If this is set to a non zero number or true (identical to -1 or an1711 unlimited number), the submodule summary will be enabled and a1712 summary of commits for modified submodules will be shown (see1713 --summary-limit option of linkgit:git-submodule[1]).17141715tar.umask::1716 This variable can be used to restrict the permission bits of1717 tar archive entries. The default is 0002, which turns off the1718 world write bit. The special value "user" indicates that the1719 archiving user's umask will be used instead. See umask(2) and1720 linkgit:git-archive[1].17211722transfer.unpackLimit::1723 When `fetch.unpackLimit` or `receive.unpackLimit` are1724 not set, the value of this variable is used instead.1725 The default value is 100.17261727url.<base>.insteadOf::1728 Any URL that starts with this value will be rewritten to1729 start, instead, with <base>. In cases where some site serves a1730 large number of repositories, and serves them with multiple1731 access methods, and some users need to use different access1732 methods, this feature allows people to specify any of the1733 equivalent URLs and have git automatically rewrite the URL to1734 the best alternative for the particular user, even for a1735 never-before-seen repository on the site. When more than one1736 insteadOf strings match a given URL, the longest match is used.17371738url.<base>.pushInsteadOf::1739 Any URL that starts with this value will not be pushed to;1740 instead, it will be rewritten to start with <base>, and the1741 resulting URL will be pushed to. In cases where some site serves1742 a large number of repositories, and serves them with multiple1743 access methods, some of which do not allow push, this feature1744 allows people to specify a pull-only URL and have git1745 automatically use an appropriate URL to push, even for a1746 never-before-seen repository on the site. When more than one1747 pushInsteadOf strings match a given URL, the longest match is1748 used. If a remote has an explicit pushurl, git will ignore this1749 setting for that remote.17501751user.email::1752 Your email address to be recorded in any newly created commits.1753 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1754 'EMAIL' environment variables. See linkgit:git-commit-tree[1].17551756user.name::1757 Your full name to be recorded in any newly created commits.1758 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1759 environment variables. See linkgit:git-commit-tree[1].17601761user.signingkey::1762 If linkgit:git-tag[1] is not selecting the key you want it to1763 automatically when creating a signed tag, you can override the1764 default selection with this variable. This option is passed1765 unchanged to gpg's --local-user parameter, so you may specify a key1766 using any method that gpg supports.17671768web.browser::1769 Specify a web browser that may be used by some commands.1770 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1771 may use it.