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* `blank-at-eof` treats blank lines added at the end of file as an error 485 (enabled by default). 486* `trailing-space` is a short-hand to cover both `blank-at-eol` and 487 `blank-at-eof`. 488* `cr-at-eol` treats a carriage-return at the end of line as 489 part of the line terminator, i.e. with it, `trailing-space` 490 does not trigger if the character before such a carriage-return 491 is not a whitespace (not enabled by default). 492 493core.fsyncobjectfiles:: 494 This boolean will enable 'fsync()' when writing object files. 495+ 496This is a total waste of time and effort on a filesystem that orders 497data writes properly, but can be useful for filesystems that do not use 498journalling (traditional UNIX filesystems) or that only journal metadata 499and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 500 501core.preloadindex:: 502 Enable parallel index preload for operations like 'git diff' 503+ 504This can speed up operations like 'git diff' and 'git status' especially 505on filesystems like NFS that have weak caching semantics and thus 506relatively high IO latencies. With this set to 'true', git will do the 507index comparison to the filesystem data in parallel, allowing 508overlapping IO's. 509 510core.createObject:: 511 You can set this to 'link', in which case a hardlink followed by 512 a delete of the source are used to make sure that object creation 513 will not overwrite existing objects. 514+ 515On some file system/operating system combinations, this is unreliable. 516Set this config setting to 'rename' there; However, This will remove the 517check that makes sure that existing object files will not get overwritten. 518 519core.notesRef:: 520 When showing commit messages, also show notes which are stored in 521 the given ref. The ref must be fully qualified. If the given 522 ref does not exist, it is not an error but means that no 523 notes should be printed. 524+ 525This setting defaults to "refs/notes/commits", and it can be overridden by 526the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 527 528core.sparseCheckout:: 529 Enable "sparse checkout" feature. See section "Sparse checkout" in 530 linkgit:git-read-tree[1] for more information. 531 532add.ignore-errors:: 533 Tells 'git add' to continue adding files when some files cannot be 534 added due to indexing errors. Equivalent to the '--ignore-errors' 535 option of linkgit:git-add[1]. 536 537alias.*:: 538 Command aliases for the linkgit:git[1] command wrapper - e.g. 539 after defining "alias.last = cat-file commit HEAD", the invocation 540 "git last" is equivalent to "git cat-file commit HEAD". To avoid 541 confusion and troubles with script usage, aliases that 542 hide existing git commands are ignored. Arguments are split by 543 spaces, the usual shell quoting and escaping is supported. 544 quote pair and a backslash can be used to quote them. 545+ 546If the alias expansion is prefixed with an exclamation point, 547it will be treated as a shell command. For example, defining 548"alias.new = !gitk --all --not ORIG_HEAD", the invocation 549"git new" is equivalent to running the shell command 550"gitk --all --not ORIG_HEAD". Note that shell commands will be 551executed from the top-level directory of a repository, which may 552not necessarily be the current directory. 553 554am.keepcr:: 555 If true, git-am will call git-mailsplit for patches in mbox format 556 with parameter '--keep-cr'. In this case git-mailsplit will 557 not remove `\r` from lines ending with `\r\n`. Can be overrriden 558 by giving '--no-keep-cr' from the command line. 559 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 560 561apply.ignorewhitespace:: 562 When set to 'change', tells 'git apply' to ignore changes in 563 whitespace, in the same way as the '--ignore-space-change' 564 option. 565 When set to one of: no, none, never, false tells 'git apply' to 566 respect all whitespace differences. 567 See linkgit:git-apply[1]. 568 569apply.whitespace:: 570 Tells 'git apply' how to handle whitespaces, in the same way 571 as the '--whitespace' option. See linkgit:git-apply[1]. 572 573branch.autosetupmerge:: 574 Tells 'git branch' and 'git checkout' to set up new branches 575 so that linkgit:git-pull[1] will appropriately merge from the 576 starting point branch. Note that even if this option is not set, 577 this behavior can be chosen per-branch using the `--track` 578 and `--no-track` options. The valid settings are: `false` -- no 579 automatic setup is done; `true` -- automatic setup is done when the 580 starting point is a remote branch; `always` -- automatic setup is 581 done when the starting point is either a local branch or remote 582 branch. This option defaults to true. 583 584branch.autosetuprebase:: 585 When a new branch is created with 'git branch' or 'git checkout' 586 that tracks another branch, this variable tells git to set 587 up pull to rebase instead of merge (see "branch.<name>.rebase"). 588 When `never`, rebase is never automatically set to true. 589 When `local`, rebase is set to true for tracked branches of 590 other local branches. 591 When `remote`, rebase is set to true for tracked branches of 592 remote branches. 593 When `always`, rebase will be set to true for all tracking 594 branches. 595 See "branch.autosetupmerge" for details on how to set up a 596 branch to track another branch. 597 This option defaults to never. 598 599branch.<name>.remote:: 600 When in branch <name>, it tells 'git fetch' and 'git push' which 601 remote to fetch from/push to. It defaults to `origin` if no remote is 602 configured. `origin` is also used if you are not on any branch. 603 604branch.<name>.merge:: 605 Defines, together with branch.<name>.remote, the upstream branch 606 for the given branch. It tells 'git fetch'/'git pull' which 607 branch to merge and can also affect 'git push' (see push.default). 608 When in branch <name>, it tells 'git fetch' the default 609 refspec to be marked for merging in FETCH_HEAD. The value is 610 handled like the remote part of a refspec, and must match a 611 ref which is fetched from the remote given by 612 "branch.<name>.remote". 613 The merge information is used by 'git pull' (which at first calls 614 'git fetch') to lookup the default branch for merging. Without 615 this option, 'git pull' defaults to merge the first refspec fetched. 616 Specify multiple values to get an octopus merge. 617 If you wish to setup 'git pull' so that it merges into <name> from 618 another branch in the local repository, you can point 619 branch.<name>.merge to the desired branch, and use the special setting 620 `.` (a period) for branch.<name>.remote. 621 622branch.<name>.mergeoptions:: 623 Sets default options for merging into branch <name>. The syntax and 624 supported options are the same as those of linkgit:git-merge[1], but 625 option values containing whitespace characters are currently not 626 supported. 627 628branch.<name>.rebase:: 629 When true, rebase the branch <name> on top of the fetched branch, 630 instead of merging the default branch from the default remote when 631 "git pull" is run. 632 *NOTE*: this is a possibly dangerous operation; do *not* use 633 it unless you understand the implications (see linkgit:git-rebase[1] 634 for details). 635 636browser.<tool>.cmd:: 637 Specify the command to invoke the specified browser. The 638 specified command is evaluated in shell with the URLs passed 639 as arguments. (See linkgit:git-web--browse[1].) 640 641browser.<tool>.path:: 642 Override the path for the given tool that may be used to 643 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 644 working repository in gitweb (see linkgit:git-instaweb[1]). 645 646clean.requireForce:: 647 A boolean to make git-clean do nothing unless given -f 648 or -n. Defaults to true. 649 650color.branch:: 651 A boolean to enable/disable color in the output of 652 linkgit:git-branch[1]. May be set to `always`, 653 `false` (or `never`) or `auto` (or `true`), in which case colors are used 654 only when the output is to a terminal. Defaults to false. 655 656color.branch.<slot>:: 657 Use customized color for branch coloration. `<slot>` is one of 658 `current` (the current branch), `local` (a local branch), 659 `remote` (a tracking branch in refs/remotes/), `plain` (other 660 refs). 661+ 662The value for these configuration variables is a list of colors (at most 663two) and attributes (at most one), separated by spaces. The colors 664accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 665`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 666`blink` and `reverse`. The first color given is the foreground; the 667second is the background. The position of the attribute, if any, 668doesn't matter. 669 670color.diff:: 671 When set to `always`, always use colors in patch. 672 When false (or `never`), never. When set to `true` or `auto`, use 673 colors only when the output is to the terminal. Defaults to false. 674 675color.diff.<slot>:: 676 Use customized color for diff colorization. `<slot>` specifies 677 which part of the patch to use the specified color, and is one 678 of `plain` (context text), `meta` (metainformation), `frag` 679 (hunk header), 'func' (function in hunk header), `old` (removed lines), 680 `new` (added lines), `commit` (commit headers), or `whitespace` 681 (highlighting whitespace errors). The values of these variables may be 682 specified as in color.branch.<slot>. 683 684color.grep:: 685 When set to `always`, always highlight matches. When `false` (or 686 `never`), never. When set to `true` or `auto`, use color only 687 when the output is written to the terminal. Defaults to `false`. 688 689color.grep.<slot>:: 690 Use customized color for grep colorization. `<slot>` specifies which 691 part of the line to use the specified color, and is one of 692+ 693-- 694`context`;; 695 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 696`filename`;; 697 filename prefix (when not using `-h`) 698`function`;; 699 function name lines (when using `-p`) 700`linenumber`;; 701 line number prefix (when using `-n`) 702`match`;; 703 matching text 704`selected`;; 705 non-matching text in selected lines 706`separator`;; 707 separators between fields on a line (`:`, `-`, and `=`) 708 and between hunks (`--`) 709-- 710+ 711The values of these variables may be specified as in color.branch.<slot>. 712 713color.interactive:: 714 When set to `always`, always use colors for interactive prompts 715 and displays (such as those used by "git-add --interactive"). 716 When false (or `never`), never. When set to `true` or `auto`, use 717 colors only when the output is to the terminal. Defaults to false. 718 719color.interactive.<slot>:: 720 Use customized color for 'git add --interactive' 721 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 722 four distinct types of normal output from interactive 723 commands. The values of these variables may be specified as 724 in color.branch.<slot>. 725 726color.pager:: 727 A boolean to enable/disable colored output when the pager is in 728 use (default is true). 729 730color.showbranch:: 731 A boolean to enable/disable color in the output of 732 linkgit:git-show-branch[1]. May be set to `always`, 733 `false` (or `never`) or `auto` (or `true`), in which case colors are used 734 only when the output is to a terminal. Defaults to false. 735 736color.status:: 737 A boolean to enable/disable color in the output of 738 linkgit:git-status[1]. May be set to `always`, 739 `false` (or `never`) or `auto` (or `true`), in which case colors are used 740 only when the output is to a terminal. Defaults to false. 741 742color.status.<slot>:: 743 Use customized color for status colorization. `<slot>` is 744 one of `header` (the header text of the status message), 745 `added` or `updated` (files which are added but not committed), 746 `changed` (files which are changed but not added in the index), 747 `untracked` (files which are not tracked by git), or 748 `nobranch` (the color the 'no branch' warning is shown in, defaulting 749 to red). The values of these variables may be specified as in 750 color.branch.<slot>. 751 752color.ui:: 753 When set to `always`, always use colors in all git commands which 754 are capable of colored output. When false (or `never`), never. When 755 set to `true` or `auto`, use colors only when the output is to the 756 terminal. When more specific variables of color.* are set, they always 757 take precedence over this setting. Defaults to false. 758 759commit.status:: 760 A boolean to enable/disable inclusion of status information in the 761 commit message template when using an editor to prepare the commit 762 message. Defaults to true. 763 764commit.template:: 765 Specify a file to use as the template for new commit messages. 766 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 767 specified user's home directory. 768 769diff.autorefreshindex:: 770 When using 'git diff' to compare with work tree 771 files, do not consider stat-only change as changed. 772 Instead, silently run `git update-index --refresh` to 773 update the cached stat information for paths whose 774 contents in the work tree match the contents in the 775 index. This option defaults to true. Note that this 776 affects only 'git diff' Porcelain, and not lower level 777 'diff' commands such as 'git diff-files'. 778 779diff.external:: 780 If this config variable is set, diff generation is not 781 performed using the internal diff machinery, but using the 782 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 783 environment variable. The command is called with parameters 784 as described under "git Diffs" in linkgit:git[1]. Note: if 785 you want to use an external diff program only on a subset of 786 your files, you might want to use linkgit:gitattributes[5] instead. 787 788diff.mnemonicprefix:: 789 If set, 'git diff' uses a prefix pair that is different from the 790 standard "a/" and "b/" depending on what is being compared. When 791 this configuration is in effect, reverse diff output also swaps 792 the order of the prefixes: 793`git diff`;; 794 compares the (i)ndex and the (w)ork tree; 795`git diff HEAD`;; 796 compares a (c)ommit and the (w)ork tree; 797`git diff --cached`;; 798 compares a (c)ommit and the (i)ndex; 799`git diff HEAD:file1 file2`;; 800 compares an (o)bject and a (w)ork tree entity; 801`git diff --no-index a b`;; 802 compares two non-git things (1) and (2). 803 804diff.renameLimit:: 805 The number of files to consider when performing the copy/rename 806 detection; equivalent to the 'git diff' option '-l'. 807 808diff.renames:: 809 Tells git to detect renames. If set to any boolean value, it 810 will enable basic rename detection. If set to "copies" or 811 "copy", it will detect copies, as well. 812 813diff.suppressBlankEmpty:: 814 A boolean to inhibit the standard behavior of printing a space 815 before each empty output line. Defaults to false. 816 817diff.tool:: 818 Controls which diff tool is used. `diff.tool` overrides 819 `merge.tool` when used by linkgit:git-difftool[1] and has 820 the same valid values as `merge.tool` minus "tortoisemerge" 821 and plus "kompare". 822 823difftool.<tool>.path:: 824 Override the path for the given tool. This is useful in case 825 your tool is not in the PATH. 826 827difftool.<tool>.cmd:: 828 Specify the command to invoke the specified diff tool. 829 The specified command is evaluated in shell with the following 830 variables available: 'LOCAL' is set to the name of the temporary 831 file containing the contents of the diff pre-image and 'REMOTE' 832 is set to the name of the temporary file containing the contents 833 of the diff post-image. 834 835difftool.prompt:: 836 Prompt before each invocation of the diff tool. 837 838diff.wordRegex:: 839 A POSIX Extended Regular Expression used to determine what is a "word" 840 when performing word-by-word difference calculations. Character 841 sequences that match the regular expression are "words", all other 842 characters are *ignorable* whitespace. 843 844fetch.unpackLimit:: 845 If the number of objects fetched over the git native 846 transfer is below this 847 limit, then the objects will be unpacked into loose object 848 files. However if the number of received objects equals or 849 exceeds this limit then the received pack will be stored as 850 a pack, after adding any missing delta bases. Storing the 851 pack from a push can make the push operation complete faster, 852 especially on slow filesystems. If not set, the value of 853 `transfer.unpackLimit` is used instead. 854 855format.attach:: 856 Enable multipart/mixed attachments as the default for 857 'format-patch'. The value can also be a double quoted string 858 which will enable attachments as the default and set the 859 value as the boundary. See the --attach option in 860 linkgit:git-format-patch[1]. 861 862format.numbered:: 863 A boolean which can enable or disable sequence numbers in patch 864 subjects. It defaults to "auto" which enables it only if there 865 is more than one patch. It can be enabled or disabled for all 866 messages by setting it to "true" or "false". See --numbered 867 option in linkgit:git-format-patch[1]. 868 869format.headers:: 870 Additional email headers to include in a patch to be submitted 871 by mail. See linkgit:git-format-patch[1]. 872 873format.to:: 874format.cc:: 875 Additional recipients to include in a patch to be submitted 876 by mail. See the --to and --cc options in 877 linkgit:git-format-patch[1]. 878 879format.subjectprefix:: 880 The default for format-patch is to output files with the '[PATCH]' 881 subject prefix. Use this variable to change that prefix. 882 883format.suffix:: 884 The default for format-patch is to output files with the suffix 885 `.patch`. Use this variable to change that suffix (make sure to 886 include the dot if you want it). 887 888format.pretty:: 889 The default pretty format for log/show/whatchanged command, 890 See linkgit:git-log[1], linkgit:git-show[1], 891 linkgit:git-whatchanged[1]. 892 893format.thread:: 894 The default threading style for 'git format-patch'. Can be 895 a boolean value, or `shallow` or `deep`. `shallow` threading 896 makes every mail a reply to the head of the series, 897 where the head is chosen from the cover letter, the 898 `\--in-reply-to`, and the first patch mail, in this order. 899 `deep` threading makes every mail a reply to the previous one. 900 A true boolean value is the same as `shallow`, and a false 901 value disables threading. 902 903format.signoff:: 904 A boolean value which lets you enable the `-s/--signoff` option of 905 format-patch by default. *Note:* Adding the Signed-off-by: line to a 906 patch should be a conscious act and means that you certify you have 907 the rights to submit this work under the same open source license. 908 Please see the 'SubmittingPatches' document for further discussion. 909 910gc.aggressiveWindow:: 911 The window size parameter used in the delta compression 912 algorithm used by 'git gc --aggressive'. This defaults 913 to 250. 914 915gc.auto:: 916 When there are approximately more than this many loose 917 objects in the repository, `git gc --auto` will pack them. 918 Some Porcelain commands use this command to perform a 919 light-weight garbage collection from time to time. The 920 default value is 6700. Setting this to 0 disables it. 921 922gc.autopacklimit:: 923 When there are more than this many packs that are not 924 marked with `*.keep` file in the repository, `git gc 925 --auto` consolidates them into one larger pack. The 926 default value is 50. Setting this to 0 disables it. 927 928gc.packrefs:: 929 Running `git pack-refs` in a repository renders it 930 unclonable by Git versions prior to 1.5.1.2 over dumb 931 transports such as HTTP. This variable determines whether 932 'git gc' runs `git pack-refs`. This can be set to `nobare` 933 to enable it within all non-bare repos or it can be set to a 934 boolean value. The default is `true`. 935 936gc.pruneexpire:: 937 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 938 Override the grace period with this config variable. The value 939 "now" may be used to disable this grace period and always prune 940 unreachable objects immediately. 941 942gc.reflogexpire:: 943 'git reflog expire' removes reflog entries older than 944 this time; defaults to 90 days. 945 946gc.reflogexpireunreachable:: 947 'git reflog expire' removes reflog entries older than 948 this time and are not reachable from the current tip; 949 defaults to 30 days. 950 951gc.rerereresolved:: 952 Records of conflicted merge you resolved earlier are 953 kept for this many days when 'git rerere gc' is run. 954 The default is 60 days. See linkgit:git-rerere[1]. 955 956gc.rerereunresolved:: 957 Records of conflicted merge you have not resolved are 958 kept for this many days when 'git rerere gc' is run. 959 The default is 15 days. See linkgit:git-rerere[1]. 960 961gitcvs.commitmsgannotation:: 962 Append this string to each commit message. Set to empty string 963 to disable this feature. Defaults to "via git-CVS emulator". 964 965gitcvs.enabled:: 966 Whether the CVS server interface is enabled for this repository. 967 See linkgit:git-cvsserver[1]. 968 969gitcvs.logfile:: 970 Path to a log file where the CVS server interface well... logs 971 various stuff. See linkgit:git-cvsserver[1]. 972 973gitcvs.usecrlfattr:: 974 If true, the server will look up the `crlf` attribute for 975 files to determine the '-k' modes to use. If `crlf` is set, 976 the '-k' mode will be left blank, so cvs clients will 977 treat it as text. If `crlf` is explicitly unset, the file 978 will be set with '-kb' mode, which suppresses any newline munging 979 the client might otherwise do. If `crlf` is not specified, 980 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 981 982gitcvs.allbinary:: 983 This is used if 'gitcvs.usecrlfattr' does not resolve 984 the correct '-kb' mode to use. If true, all 985 unresolved files are sent to the client in 986 mode '-kb'. This causes the client to treat them 987 as binary files, which suppresses any newline munging it 988 otherwise might do. Alternatively, if it is set to "guess", 989 then the contents of the file are examined to decide if 990 it is binary, similar to 'core.autocrlf'. 991 992gitcvs.dbname:: 993 Database used by git-cvsserver to cache revision information 994 derived from the git repository. The exact meaning depends on the 995 used database driver, for SQLite (which is the default driver) this 996 is a filename. Supports variable substitution (see 997 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 998 Default: '%Ggitcvs.%m.sqlite' 9991000gitcvs.dbdriver::1001 Used Perl DBI driver. You can specify any available driver1002 for this here, but it might not work. git-cvsserver is tested1003 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1004 reported *not* to work with 'DBD::mysql'. Experimental feature.1005 May not contain double colons (`:`). Default: 'SQLite'.1006 See linkgit:git-cvsserver[1].10071008gitcvs.dbuser, gitcvs.dbpass::1009 Database user and password. Only useful if setting 'gitcvs.dbdriver',1010 since SQLite has no concept of database users and/or passwords.1011 'gitcvs.dbuser' supports variable substitution (see1012 linkgit:git-cvsserver[1] for details).10131014gitcvs.dbTableNamePrefix::1015 Database table name prefix. Prepended to the names of any1016 database tables used, allowing a single database to be used1017 for several repositories. Supports variable substitution (see1018 linkgit:git-cvsserver[1] for details). Any non-alphabetic1019 characters will be replaced with underscores.10201021All gitcvs variables except for 'gitcvs.usecrlfattr' and1022'gitcvs.allbinary' can also be specified as1023'gitcvs.<access_method>.<varname>' (where 'access_method'1024is one of "ext" and "pserver") to make them apply only for the given1025access method.10261027gui.commitmsgwidth::1028 Defines how wide the commit message window is in the1029 linkgit:git-gui[1]. "75" is the default.10301031gui.diffcontext::1032 Specifies how many context lines should be used in calls to diff1033 made by the linkgit:git-gui[1]. The default is "5".10341035gui.encoding::1036 Specifies the default encoding to use for displaying of1037 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1038 It can be overridden by setting the 'encoding' attribute1039 for relevant files (see linkgit:gitattributes[5]).1040 If this option is not set, the tools default to the1041 locale encoding.10421043gui.matchtrackingbranch::1044 Determines if new branches created with linkgit:git-gui[1] should1045 default to tracking remote branches with matching names or1046 not. Default: "false".10471048gui.newbranchtemplate::1049 Is used as suggested name when creating new branches using the1050 linkgit:git-gui[1].10511052gui.pruneduringfetch::1053 "true" if linkgit:git-gui[1] should prune tracking branches when1054 performing a fetch. The default value is "false".10551056gui.trustmtime::1057 Determines if linkgit:git-gui[1] should trust the file modification1058 timestamp or not. By default the timestamps are not trusted.10591060gui.spellingdictionary::1061 Specifies the dictionary used for spell checking commit messages in1062 the linkgit:git-gui[1]. When set to "none" spell checking is turned1063 off.10641065gui.fastcopyblame::1066 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1067 location detection. It makes blame significantly faster on huge1068 repositories at the expense of less thorough copy detection.10691070gui.copyblamethreshold::1071 Specifies the threshold to use in 'git gui blame' original location1072 detection, measured in alphanumeric characters. See the1073 linkgit:git-blame[1] manual for more information on copy detection.10741075gui.blamehistoryctx::1076 Specifies the radius of history context in days to show in1077 linkgit:gitk[1] for the selected commit, when the `Show History1078 Context` menu item is invoked from 'git gui blame'. If this1079 variable is set to zero, the whole history is shown.10801081guitool.<name>.cmd::1082 Specifies the shell command line to execute when the corresponding item1083 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1084 mandatory for every tool. The command is executed from the root of1085 the working directory, and in the environment it receives the name of1086 the tool as 'GIT_GUITOOL', the name of the currently selected file as1087 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1088 the head is detached, 'CUR_BRANCH' is empty).10891090guitool.<name>.needsfile::1091 Run the tool only if a diff is selected in the GUI. It guarantees1092 that 'FILENAME' is not empty.10931094guitool.<name>.noconsole::1095 Run the command silently, without creating a window to display its1096 output.10971098guitool.<name>.norescan::1099 Don't rescan the working directory for changes after the tool1100 finishes execution.11011102guitool.<name>.confirm::1103 Show a confirmation dialog before actually running the tool.11041105guitool.<name>.argprompt::1106 Request a string argument from the user, and pass it to the tool1107 through the 'ARGS' environment variable. Since requesting an1108 argument implies confirmation, the 'confirm' option has no effect1109 if this is enabled. If the option is set to 'true', 'yes', or '1',1110 the dialog uses a built-in generic prompt; otherwise the exact1111 value of the variable is used.11121113guitool.<name>.revprompt::1114 Request a single valid revision from the user, and set the1115 'REVISION' environment variable. In other aspects this option1116 is similar to 'argprompt', and can be used together with it.11171118guitool.<name>.revunmerged::1119 Show only unmerged branches in the 'revprompt' subdialog.1120 This is useful for tools similar to merge or rebase, but not1121 for things like checkout or reset.11221123guitool.<name>.title::1124 Specifies the title to use for the prompt dialog. The default1125 is the tool name.11261127guitool.<name>.prompt::1128 Specifies the general prompt string to display at the top of1129 the dialog, before subsections for 'argprompt' and 'revprompt'.1130 The default value includes the actual command.11311132help.browser::1133 Specify the browser that will be used to display help in the1134 'web' format. See linkgit:git-help[1].11351136help.format::1137 Override the default help format used by linkgit:git-help[1].1138 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1139 the default. 'web' and 'html' are the same.11401141help.autocorrect::1142 Automatically correct and execute mistyped commands after1143 waiting for the given number of deciseconds (0.1 sec). If more1144 than one command can be deduced from the entered text, nothing1145 will be executed. If the value of this option is negative,1146 the corrected command will be executed immediately. If the1147 value is 0 - the command will be just shown but not executed.1148 This is the default.11491150http.proxy::1151 Override the HTTP proxy, normally configured using the 'http_proxy'1152 environment variable (see linkgit:curl[1]). This can be overridden1153 on a per-remote basis; see remote.<name>.proxy11541155http.sslVerify::1156 Whether to verify the SSL certificate when fetching or pushing1157 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1158 variable.11591160http.sslCert::1161 File containing the SSL certificate when fetching or pushing1162 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1163 variable.11641165http.sslKey::1166 File containing the SSL private key when fetching or pushing1167 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1168 variable.11691170http.sslCertPasswordProtected::1171 Enable git's password prompt for the SSL certificate. Otherwise1172 OpenSSL will prompt the user, possibly many times, if the1173 certificate or private key is encrypted. Can be overridden by the1174 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.11751176http.sslCAInfo::1177 File containing the certificates to verify the peer with when1178 fetching or pushing over HTTPS. Can be overridden by the1179 'GIT_SSL_CAINFO' environment variable.11801181http.sslCAPath::1182 Path containing files with the CA certificates to verify the peer1183 with when fetching or pushing over HTTPS. Can be overridden1184 by the 'GIT_SSL_CAPATH' environment variable.11851186http.maxRequests::1187 How many HTTP requests to launch in parallel. Can be overridden1188 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.11891190http.minSessions::1191 The number of curl sessions (counted across slots) to be kept across1192 requests. They will not be ended with curl_easy_cleanup() until1193 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1194 value will be capped at 1. Defaults to 1.11951196http.postBuffer::1197 Maximum size in bytes of the buffer used by smart HTTP1198 transports when POSTing data to the remote system.1199 For requests larger than this buffer size, HTTP/1.1 and1200 Transfer-Encoding: chunked is used to avoid creating a1201 massive pack file locally. Default is 1 MiB, which is1202 sufficient for most requests.12031204http.lowSpeedLimit, http.lowSpeedTime::1205 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1206 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1207 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1208 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12091210http.noEPSV::1211 A boolean which disables using of EPSV ftp command by curl.1212 This can helpful with some "poor" ftp servers which don't1213 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1214 environment variable. Default is false (curl will use EPSV).12151216i18n.commitEncoding::1217 Character encoding the commit messages are stored in; git itself1218 does not care per se, but this information is necessary e.g. when1219 importing commits from emails or in the gitk graphical history1220 browser (and possibly at other places in the future or in other1221 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12221223i18n.logOutputEncoding::1224 Character encoding the commit messages are converted to when1225 running 'git log' and friends.12261227imap::1228 The configuration variables in the 'imap' section are described1229 in linkgit:git-imap-send[1].12301231init.templatedir::1232 Specify the directory from which templates will be copied.1233 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12341235instaweb.browser::1236 Specify the program that will be used to browse your working1237 repository in gitweb. See linkgit:git-instaweb[1].12381239instaweb.httpd::1240 The HTTP daemon command-line to start gitweb on your working1241 repository. See linkgit:git-instaweb[1].12421243instaweb.local::1244 If true the web server started by linkgit:git-instaweb[1] will1245 be bound to the local IP (127.0.0.1).12461247instaweb.modulepath::1248 The module path for an apache httpd used by linkgit:git-instaweb[1].12491250instaweb.port::1251 The port number to bind the gitweb httpd to. See1252 linkgit:git-instaweb[1].12531254interactive.singlekey::1255 In interactive commands, allow the user to provide one-letter1256 input with a single key (i.e., without hitting enter).1257 Currently this is used only by the `\--patch` mode of1258 linkgit:git-add[1]. Note that this setting is silently1259 ignored if portable keystroke input is not available.12601261log.date::1262 Set default date-time mode for the log command. Setting log.date1263 value is similar to using 'git log'\'s --date option. The value is one of the1264 following alternatives: {relative,local,default,iso,rfc,short}.1265 See linkgit:git-log[1].12661267log.showroot::1268 If true, the initial commit will be shown as a big creation event.1269 This is equivalent to a diff against an empty tree.1270 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1271 normally hide the root commit will now show it. True by default.12721273mailmap.file::1274 The location of an augmenting mailmap file. The default1275 mailmap, located in the root of the repository, is loaded1276 first, then the mailmap file pointed to by this variable.1277 The location of the mailmap file may be in a repository1278 subdirectory, or somewhere outside of the repository itself.1279 See linkgit:git-shortlog[1] and linkgit:git-blame[1].12801281man.viewer::1282 Specify the programs that may be used to display help in the1283 'man' format. See linkgit:git-help[1].12841285man.<tool>.cmd::1286 Specify the command to invoke the specified man viewer. The1287 specified command is evaluated in shell with the man page1288 passed as argument. (See linkgit:git-help[1].)12891290man.<tool>.path::1291 Override the path for the given tool that may be used to1292 display help in the 'man' format. See linkgit:git-help[1].12931294include::merge-config.txt[]12951296mergetool.<tool>.path::1297 Override the path for the given tool. This is useful in case1298 your tool is not in the PATH.12991300mergetool.<tool>.cmd::1301 Specify the command to invoke the specified merge tool. The1302 specified command is evaluated in shell with the following1303 variables available: 'BASE' is the name of a temporary file1304 containing the common base of the files to be merged, if available;1305 'LOCAL' is the name of a temporary file containing the contents of1306 the file on the current branch; 'REMOTE' is the name of a temporary1307 file containing the contents of the file from the branch being1308 merged; 'MERGED' contains the name of the file to which the merge1309 tool should write the results of a successful merge.13101311mergetool.<tool>.trustExitCode::1312 For a custom merge command, specify whether the exit code of1313 the merge command can be used to determine whether the merge was1314 successful. If this is not set to true then the merge target file1315 timestamp is checked and the merge assumed to have been successful1316 if the file has been updated, otherwise the user is prompted to1317 indicate the success of the merge.13181319mergetool.keepBackup::1320 After performing a merge, the original file with conflict markers1321 can be saved as a file with a `.orig` extension. If this variable1322 is set to `false` then this file is not preserved. Defaults to1323 `true` (i.e. keep the backup files).13241325mergetool.keepTemporaries::1326 When invoking a custom merge tool, git uses a set of temporary1327 files to pass to the tool. If the tool returns an error and this1328 variable is set to `true`, then these temporary files will be1329 preserved, otherwise they will be removed after the tool has1330 exited. Defaults to `false`.13311332mergetool.prompt::1333 Prompt before each invocation of the merge resolution program.13341335notes.displayRef::1336 The (fully qualified) refname from which to show notes when1337 showing commit messages. The value of this variable can be set1338 to a glob, in which case notes from all matching refs will be1339 shown. You may also specify this configuration variable1340 several times. A warning will be issued for refs that do not1341 exist, but a glob that does not match any refs is silently1342 ignored.1343+1344This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1345environment variable, which must be a colon separated list of refs or1346globs.1347+1348The effective value of "core.notesRef" (possibly overridden by1349GIT_NOTES_REF) is also implicitly added to the list of refs to be1350displayed.13511352notes.rewrite.<command>::1353 When rewriting commits with <command> (currently `amend` or1354 `rebase`) and this variable is set to `true`, git1355 automatically copies your notes from the original to the1356 rewritten commit. Defaults to `true`, but see1357 "notes.rewriteRef" below.13581359notes.rewriteMode::1360 When copying notes during a rewrite (see the1361 "notes.rewrite.<command>" option), determines what to do if1362 the target commit already has a note. Must be one of1363 `overwrite`, `concatenate`, or `ignore`. Defaults to1364 `concatenate`.1365+1366This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1367environment variable.13681369notes.rewriteRef::1370 When copying notes during a rewrite, specifies the (fully1371 qualified) ref whose notes should be copied. The ref may be a1372 glob, in which case notes in all matching refs will be copied.1373 You may also specify this configuration several times.1374+1375Does not have a default value; you must configure this variable to1376enable note rewriting.1377+1378This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1379environment variable, which must be a colon separated list of refs or1380globs.13811382pack.window::1383 The size of the window used by linkgit:git-pack-objects[1] when no1384 window size is given on the command line. Defaults to 10.13851386pack.depth::1387 The maximum delta depth used by linkgit:git-pack-objects[1] when no1388 maximum depth is given on the command line. Defaults to 50.13891390pack.windowMemory::1391 The window memory size limit used by linkgit:git-pack-objects[1]1392 when no limit is given on the command line. The value can be1393 suffixed with "k", "m", or "g". Defaults to 0, meaning no1394 limit.13951396pack.compression::1397 An integer -1..9, indicating the compression level for objects1398 in a pack file. -1 is the zlib default. 0 means no1399 compression, and 1..9 are various speed/size tradeoffs, 9 being1400 slowest. If not set, defaults to core.compression. If that is1401 not set, defaults to -1, the zlib default, which is "a default1402 compromise between speed and compression (currently equivalent1403 to level 6)."14041405pack.deltaCacheSize::1406 The maximum memory in bytes used for caching deltas in1407 linkgit:git-pack-objects[1] before writing them out to a pack.1408 This cache is used to speed up the writing object phase by not1409 having to recompute the final delta result once the best match1410 for all objects is found. Repacking large repositories on machines1411 which are tight with memory might be badly impacted by this though,1412 especially if this cache pushes the system into swapping.1413 A value of 0 means no limit. The smallest size of 1 byte may be1414 used to virtually disable this cache. Defaults to 256 MiB.14151416pack.deltaCacheLimit::1417 The maximum size of a delta, that is cached in1418 linkgit:git-pack-objects[1]. This cache is used to speed up the1419 writing object phase by not having to recompute the final delta1420 result once the best match for all objects is found. Defaults to 1000.14211422pack.threads::1423 Specifies the number of threads to spawn when searching for best1424 delta matches. This requires that linkgit:git-pack-objects[1]1425 be compiled with pthreads otherwise this option is ignored with a1426 warning. This is meant to reduce packing time on multiprocessor1427 machines. The required amount of memory for the delta search window1428 is however multiplied by the number of threads.1429 Specifying 0 will cause git to auto-detect the number of CPU's1430 and set the number of threads accordingly.14311432pack.indexVersion::1433 Specify the default pack index version. Valid values are 1 for1434 legacy pack index used by Git versions prior to 1.5.2, and 2 for1435 the new pack index with capabilities for packs larger than 4 GB1436 as well as proper protection against the repacking of corrupted1437 packs. Version 2 is the default. Note that version 2 is enforced1438 and this config option ignored whenever the corresponding pack is1439 larger than 2 GB.1440+1441If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1442cloning or fetching over a non native protocol (e.g. "http" and "rsync")1443that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1444other side may give you a repository that cannot be accessed with your1445older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1446you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1447the `{asterisk}.idx` file.14481449pack.packSizeLimit::1450 The maximum size of a pack. This setting only affects1451 packing to a file when repacking, i.e. the git:// protocol1452 is unaffected. It can be overridden by the `\--max-pack-size`1453 option of linkgit:git-repack[1]. The minimum size allowed is1454 limited to 1 MiB. The default is unlimited.1455 Common unit suffixes of 'k', 'm', or 'g' are1456 supported.14571458pager.<cmd>::1459 Allows turning on or off pagination of the output of a1460 particular git subcommand when writing to a tty. If1461 `\--paginate` or `\--no-pager` is specified on the command line,1462 it takes precedence over this option. To disable pagination for1463 all commands, set `core.pager` or `GIT_PAGER` to `cat`.14641465pull.octopus::1466 The default merge strategy to use when pulling multiple branches1467 at once.14681469pull.twohead::1470 The default merge strategy to use when pulling a single branch.14711472push.default::1473 Defines the action git push should take if no refspec is given1474 on the command line, no refspec is configured in the remote, and1475 no refspec is implied by any of the options given on the command1476 line. Possible values are:1477+1478* `nothing` do not push anything.1479* `matching` push all matching branches.1480 All branches having the same name in both ends are considered to be1481 matching. This is the default.1482* `tracking` push the current branch to its upstream branch.1483* `current` push the current branch to a branch of the same name.14841485rebase.stat::1486 Whether to show a diffstat of what changed upstream since the last1487 rebase. False by default.14881489receive.autogc::1490 By default, git-receive-pack will run "git-gc --auto" after1491 receiving data from git-push and updating refs. You can stop1492 it by setting this variable to false.14931494receive.fsckObjects::1495 If it is set to true, git-receive-pack will check all received1496 objects. It will abort in the case of a malformed object or a1497 broken link. The result of an abort are only dangling objects.1498 Defaults to false.14991500receive.unpackLimit::1501 If the number of objects received in a push is below this1502 limit then the objects will be unpacked into loose object1503 files. However if the number of received objects equals or1504 exceeds this limit then the received pack will be stored as1505 a pack, after adding any missing delta bases. Storing the1506 pack from a push can make the push operation complete faster,1507 especially on slow filesystems. If not set, the value of1508 `transfer.unpackLimit` is used instead.15091510receive.denyDeletes::1511 If set to true, git-receive-pack will deny a ref update that deletes1512 the ref. Use this to prevent such a ref deletion via a push.15131514receive.denyCurrentBranch::1515 If set to true or "refuse", git-receive-pack will deny a ref update1516 to the currently checked out branch of a non-bare repository.1517 Such a push is potentially dangerous because it brings the HEAD1518 out of sync with the index and working tree. If set to "warn",1519 print a warning of such a push to stderr, but allow the push to1520 proceed. If set to false or "ignore", allow such pushes with no1521 message. Defaults to "refuse".15221523receive.denyNonFastForwards::1524 If set to true, git-receive-pack will deny a ref update which is1525 not a fast-forward. Use this to prevent such an update via a push,1526 even if that push is forced. This configuration variable is1527 set when initializing a shared repository.15281529receive.updateserverinfo::1530 If set to true, git-receive-pack will run git-update-server-info1531 after receiving data from git-push and updating refs.15321533remote.<name>.url::1534 The URL of a remote repository. See linkgit:git-fetch[1] or1535 linkgit:git-push[1].15361537remote.<name>.pushurl::1538 The push URL of a remote repository. See linkgit:git-push[1].15391540remote.<name>.proxy::1541 For remotes that require curl (http, https and ftp), the URL to1542 the proxy to use for that remote. Set to the empty string to1543 disable proxying for that remote.15441545remote.<name>.fetch::1546 The default set of "refspec" for linkgit:git-fetch[1]. See1547 linkgit:git-fetch[1].15481549remote.<name>.push::1550 The default set of "refspec" for linkgit:git-push[1]. See1551 linkgit:git-push[1].15521553remote.<name>.mirror::1554 If true, pushing to this remote will automatically behave1555 as if the `\--mirror` option was given on the command line.15561557remote.<name>.skipDefaultUpdate::1558 If true, this remote will be skipped by default when updating1559 using linkgit:git-fetch[1] or the `update` subcommand of1560 linkgit:git-remote[1].15611562remote.<name>.skipFetchAll::1563 If true, this remote will be skipped by default when updating1564 using linkgit:git-fetch[1] or the `update` subcommand of1565 linkgit:git-remote[1].15661567remote.<name>.receivepack::1568 The default program to execute on the remote side when pushing. See1569 option \--receive-pack of linkgit:git-push[1].15701571remote.<name>.uploadpack::1572 The default program to execute on the remote side when fetching. See1573 option \--upload-pack of linkgit:git-fetch-pack[1].15741575remote.<name>.tagopt::1576 Setting this value to \--no-tags disables automatic tag following when1577 fetching from remote <name>15781579remote.<name>.vcs::1580 Setting this to a value <vcs> will cause git to interact with1581 the remote with the git-remote-<vcs> helper.15821583remotes.<group>::1584 The list of remotes which are fetched by "git remote update1585 <group>". See linkgit:git-remote[1].15861587repack.usedeltabaseoffset::1588 By default, linkgit:git-repack[1] creates packs that use1589 delta-base offset. If you need to share your repository with1590 git older than version 1.4.4, either directly or via a dumb1591 protocol such as http, then you need to set this option to1592 "false" and repack. Access from old git versions over the1593 native protocol are unaffected by this option.15941595rerere.autoupdate::1596 When set to true, `git-rerere` updates the index with the1597 resulting contents after it cleanly resolves conflicts using1598 previously recorded resolution. Defaults to false.15991600rerere.enabled::1601 Activate recording of resolved conflicts, so that identical1602 conflict hunks can be resolved automatically, should they1603 be encountered again. linkgit:git-rerere[1] command is by1604 default enabled if you create `rr-cache` directory under1605 `$GIT_DIR`, but can be disabled by setting this option to false.16061607sendemail.identity::1608 A configuration identity. When given, causes values in the1609 'sendemail.<identity>' subsection to take precedence over1610 values in the 'sendemail' section. The default identity is1611 the value of 'sendemail.identity'.16121613sendemail.smtpencryption::1614 See linkgit:git-send-email[1] for description. Note that this1615 setting is not subject to the 'identity' mechanism.16161617sendemail.smtpssl::1618 Deprecated alias for 'sendemail.smtpencryption = ssl'.16191620sendemail.<identity>.*::1621 Identity-specific versions of the 'sendemail.*' parameters1622 found below, taking precedence over those when the this1623 identity is selected, through command-line or1624 'sendemail.identity'.16251626sendemail.aliasesfile::1627sendemail.aliasfiletype::1628sendemail.bcc::1629sendemail.cc::1630sendemail.cccmd::1631sendemail.chainreplyto::1632sendemail.confirm::1633sendemail.envelopesender::1634sendemail.from::1635sendemail.multiedit::1636sendemail.signedoffbycc::1637sendemail.smtppass::1638sendemail.suppresscc::1639sendemail.suppressfrom::1640sendemail.to::1641sendemail.smtpdomain::1642sendemail.smtpserver::1643sendemail.smtpserverport::1644sendemail.smtpuser::1645sendemail.thread::1646sendemail.validate::1647 See linkgit:git-send-email[1] for description.16481649sendemail.signedoffcc::1650 Deprecated alias for 'sendemail.signedoffbycc'.16511652showbranch.default::1653 The default set of branches for linkgit:git-show-branch[1].1654 See linkgit:git-show-branch[1].16551656status.relativePaths::1657 By default, linkgit:git-status[1] shows paths relative to the1658 current directory. Setting this variable to `false` shows paths1659 relative to the repository root (this was the default for git1660 prior to v1.5.4).16611662status.showUntrackedFiles::1663 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1664 files which are not currently tracked by Git. Directories which1665 contain only untracked files, are shown with the directory name1666 only. Showing untracked files means that Git needs to lstat() all1667 all the files in the whole repository, which might be slow on some1668 systems. So, this variable controls how the commands displays1669 the untracked files. Possible values are:1670+1671--1672 - 'no' - Show no untracked files1673 - 'normal' - Shows untracked files and directories1674 - 'all' - Shows also individual files in untracked directories.1675--1676+1677If this variable is not specified, it defaults to 'normal'.1678This variable can be overridden with the -u|--untracked-files option1679of linkgit:git-status[1] and linkgit:git-commit[1].16801681status.submodulesummary::1682 Defaults to false.1683 If this is set to a non zero number or true (identical to -1 or an1684 unlimited number), the submodule summary will be enabled and a1685 summary of commits for modified submodules will be shown (see1686 --summary-limit option of linkgit:git-submodule[1]).16871688submodule.<name>.path::1689submodule.<name>.url::1690submodule.<name>.update::1691 The path within this project, URL, and the updating strategy1692 for a submodule. These variables are initially populated1693 by 'git submodule init'; edit them to override the1694 URL and other values found in the `.gitmodules` file. See1695 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.16961697tar.umask::1698 This variable can be used to restrict the permission bits of1699 tar archive entries. The default is 0002, which turns off the1700 world write bit. The special value "user" indicates that the1701 archiving user's umask will be used instead. See umask(2) and1702 linkgit:git-archive[1].17031704transfer.unpackLimit::1705 When `fetch.unpackLimit` or `receive.unpackLimit` are1706 not set, the value of this variable is used instead.1707 The default value is 100.17081709url.<base>.insteadOf::1710 Any URL that starts with this value will be rewritten to1711 start, instead, with <base>. In cases where some site serves a1712 large number of repositories, and serves them with multiple1713 access methods, and some users need to use different access1714 methods, this feature allows people to specify any of the1715 equivalent URLs and have git automatically rewrite the URL to1716 the best alternative for the particular user, even for a1717 never-before-seen repository on the site. When more than one1718 insteadOf strings match a given URL, the longest match is used.17191720url.<base>.pushInsteadOf::1721 Any URL that starts with this value will not be pushed to;1722 instead, it will be rewritten to start with <base>, and the1723 resulting URL will be pushed to. In cases where some site serves1724 a large number of repositories, and serves them with multiple1725 access methods, some of which do not allow push, this feature1726 allows people to specify a pull-only URL and have git1727 automatically use an appropriate URL to push, even for a1728 never-before-seen repository on the site. When more than one1729 pushInsteadOf strings match a given URL, the longest match is1730 used. If a remote has an explicit pushurl, git will ignore this1731 setting for that remote.17321733user.email::1734 Your email address to be recorded in any newly created commits.1735 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1736 'EMAIL' environment variables. See linkgit:git-commit-tree[1].17371738user.name::1739 Your full name to be recorded in any newly created commits.1740 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1741 environment variables. See linkgit:git-commit-tree[1].17421743user.signingkey::1744 If linkgit:git-tag[1] is not selecting the key you want it to1745 automatically when creating a signed tag, you can override the1746 default selection with this variable. This option is passed1747 unchanged to gpg's --local-user parameter, so you may specify a key1748 using any method that gpg supports.17491750web.browser::1751 Specify a web browser that may be used by some commands.1752 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1753 may use it.