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.cc:: 874 Additional "Cc:" headers to include in a patch to be submitted 875 by mail. See the --cc option in linkgit:git-format-patch[1]. 876 877format.subjectprefix:: 878 The default for format-patch is to output files with the '[PATCH]' 879 subject prefix. Use this variable to change that prefix. 880 881format.suffix:: 882 The default for format-patch is to output files with the suffix 883 `.patch`. Use this variable to change that suffix (make sure to 884 include the dot if you want it). 885 886format.pretty:: 887 The default pretty format for log/show/whatchanged command, 888 See linkgit:git-log[1], linkgit:git-show[1], 889 linkgit:git-whatchanged[1]. 890 891format.thread:: 892 The default threading style for 'git format-patch'. Can be 893 a boolean value, or `shallow` or `deep`. `shallow` threading 894 makes every mail a reply to the head of the series, 895 where the head is chosen from the cover letter, the 896 `\--in-reply-to`, and the first patch mail, in this order. 897 `deep` threading makes every mail a reply to the previous one. 898 A true boolean value is the same as `shallow`, and a false 899 value disables threading. 900 901format.signoff:: 902 A boolean value which lets you enable the `-s/--signoff` option of 903 format-patch by default. *Note:* Adding the Signed-off-by: line to a 904 patch should be a conscious act and means that you certify you have 905 the rights to submit this work under the same open source license. 906 Please see the 'SubmittingPatches' document for further discussion. 907 908gc.aggressiveWindow:: 909 The window size parameter used in the delta compression 910 algorithm used by 'git gc --aggressive'. This defaults 911 to 250. 912 913gc.auto:: 914 When there are approximately more than this many loose 915 objects in the repository, `git gc --auto` will pack them. 916 Some Porcelain commands use this command to perform a 917 light-weight garbage collection from time to time. The 918 default value is 6700. Setting this to 0 disables it. 919 920gc.autopacklimit:: 921 When there are more than this many packs that are not 922 marked with `*.keep` file in the repository, `git gc 923 --auto` consolidates them into one larger pack. The 924 default value is 50. Setting this to 0 disables it. 925 926gc.packrefs:: 927 Running `git pack-refs` in a repository renders it 928 unclonable by Git versions prior to 1.5.1.2 over dumb 929 transports such as HTTP. This variable determines whether 930 'git gc' runs `git pack-refs`. This can be set to `nobare` 931 to enable it within all non-bare repos or it can be set to a 932 boolean value. The default is `true`. 933 934gc.pruneexpire:: 935 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 936 Override the grace period with this config variable. The value 937 "now" may be used to disable this grace period and always prune 938 unreachable objects immediately. 939 940gc.reflogexpire:: 941 'git reflog expire' removes reflog entries older than 942 this time; defaults to 90 days. 943 944gc.reflogexpireunreachable:: 945 'git reflog expire' removes reflog entries older than 946 this time and are not reachable from the current tip; 947 defaults to 30 days. 948 949gc.rerereresolved:: 950 Records of conflicted merge you resolved earlier are 951 kept for this many days when 'git rerere gc' is run. 952 The default is 60 days. See linkgit:git-rerere[1]. 953 954gc.rerereunresolved:: 955 Records of conflicted merge you have not resolved are 956 kept for this many days when 'git rerere gc' is run. 957 The default is 15 days. See linkgit:git-rerere[1]. 958 959gitcvs.commitmsgannotation:: 960 Append this string to each commit message. Set to empty string 961 to disable this feature. Defaults to "via git-CVS emulator". 962 963gitcvs.enabled:: 964 Whether the CVS server interface is enabled for this repository. 965 See linkgit:git-cvsserver[1]. 966 967gitcvs.logfile:: 968 Path to a log file where the CVS server interface well... logs 969 various stuff. See linkgit:git-cvsserver[1]. 970 971gitcvs.usecrlfattr:: 972 If true, the server will look up the `crlf` attribute for 973 files to determine the '-k' modes to use. If `crlf` is set, 974 the '-k' mode will be left blank, so cvs clients will 975 treat it as text. If `crlf` is explicitly unset, the file 976 will be set with '-kb' mode, which suppresses any newline munging 977 the client might otherwise do. If `crlf` is not specified, 978 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 979 980gitcvs.allbinary:: 981 This is used if 'gitcvs.usecrlfattr' does not resolve 982 the correct '-kb' mode to use. If true, all 983 unresolved files are sent to the client in 984 mode '-kb'. This causes the client to treat them 985 as binary files, which suppresses any newline munging it 986 otherwise might do. Alternatively, if it is set to "guess", 987 then the contents of the file are examined to decide if 988 it is binary, similar to 'core.autocrlf'. 989 990gitcvs.dbname:: 991 Database used by git-cvsserver to cache revision information 992 derived from the git repository. The exact meaning depends on the 993 used database driver, for SQLite (which is the default driver) this 994 is a filename. Supports variable substitution (see 995 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 996 Default: '%Ggitcvs.%m.sqlite' 997 998gitcvs.dbdriver:: 999 Used Perl DBI driver. You can specify any available driver1000 for this here, but it might not work. git-cvsserver is tested1001 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1002 reported *not* to work with 'DBD::mysql'. Experimental feature.1003 May not contain double colons (`:`). Default: 'SQLite'.1004 See linkgit:git-cvsserver[1].10051006gitcvs.dbuser, gitcvs.dbpass::1007 Database user and password. Only useful if setting 'gitcvs.dbdriver',1008 since SQLite has no concept of database users and/or passwords.1009 'gitcvs.dbuser' supports variable substitution (see1010 linkgit:git-cvsserver[1] for details).10111012gitcvs.dbTableNamePrefix::1013 Database table name prefix. Prepended to the names of any1014 database tables used, allowing a single database to be used1015 for several repositories. Supports variable substitution (see1016 linkgit:git-cvsserver[1] for details). Any non-alphabetic1017 characters will be replaced with underscores.10181019All gitcvs variables except for 'gitcvs.usecrlfattr' and1020'gitcvs.allbinary' can also be specified as1021'gitcvs.<access_method>.<varname>' (where 'access_method'1022is one of "ext" and "pserver") to make them apply only for the given1023access method.10241025gui.commitmsgwidth::1026 Defines how wide the commit message window is in the1027 linkgit:git-gui[1]. "75" is the default.10281029gui.diffcontext::1030 Specifies how many context lines should be used in calls to diff1031 made by the linkgit:git-gui[1]. The default is "5".10321033gui.encoding::1034 Specifies the default encoding to use for displaying of1035 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1036 It can be overridden by setting the 'encoding' attribute1037 for relevant files (see linkgit:gitattributes[5]).1038 If this option is not set, the tools default to the1039 locale encoding.10401041gui.matchtrackingbranch::1042 Determines if new branches created with linkgit:git-gui[1] should1043 default to tracking remote branches with matching names or1044 not. Default: "false".10451046gui.newbranchtemplate::1047 Is used as suggested name when creating new branches using the1048 linkgit:git-gui[1].10491050gui.pruneduringfetch::1051 "true" if linkgit:git-gui[1] should prune tracking branches when1052 performing a fetch. The default value is "false".10531054gui.trustmtime::1055 Determines if linkgit:git-gui[1] should trust the file modification1056 timestamp or not. By default the timestamps are not trusted.10571058gui.spellingdictionary::1059 Specifies the dictionary used for spell checking commit messages in1060 the linkgit:git-gui[1]. When set to "none" spell checking is turned1061 off.10621063gui.fastcopyblame::1064 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1065 location detection. It makes blame significantly faster on huge1066 repositories at the expense of less thorough copy detection.10671068gui.copyblamethreshold::1069 Specifies the threshold to use in 'git gui blame' original location1070 detection, measured in alphanumeric characters. See the1071 linkgit:git-blame[1] manual for more information on copy detection.10721073gui.blamehistoryctx::1074 Specifies the radius of history context in days to show in1075 linkgit:gitk[1] for the selected commit, when the `Show History1076 Context` menu item is invoked from 'git gui blame'. If this1077 variable is set to zero, the whole history is shown.10781079guitool.<name>.cmd::1080 Specifies the shell command line to execute when the corresponding item1081 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1082 mandatory for every tool. The command is executed from the root of1083 the working directory, and in the environment it receives the name of1084 the tool as 'GIT_GUITOOL', the name of the currently selected file as1085 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1086 the head is detached, 'CUR_BRANCH' is empty).10871088guitool.<name>.needsfile::1089 Run the tool only if a diff is selected in the GUI. It guarantees1090 that 'FILENAME' is not empty.10911092guitool.<name>.noconsole::1093 Run the command silently, without creating a window to display its1094 output.10951096guitool.<name>.norescan::1097 Don't rescan the working directory for changes after the tool1098 finishes execution.10991100guitool.<name>.confirm::1101 Show a confirmation dialog before actually running the tool.11021103guitool.<name>.argprompt::1104 Request a string argument from the user, and pass it to the tool1105 through the 'ARGS' environment variable. Since requesting an1106 argument implies confirmation, the 'confirm' option has no effect1107 if this is enabled. If the option is set to 'true', 'yes', or '1',1108 the dialog uses a built-in generic prompt; otherwise the exact1109 value of the variable is used.11101111guitool.<name>.revprompt::1112 Request a single valid revision from the user, and set the1113 'REVISION' environment variable. In other aspects this option1114 is similar to 'argprompt', and can be used together with it.11151116guitool.<name>.revunmerged::1117 Show only unmerged branches in the 'revprompt' subdialog.1118 This is useful for tools similar to merge or rebase, but not1119 for things like checkout or reset.11201121guitool.<name>.title::1122 Specifies the title to use for the prompt dialog. The default1123 is the tool name.11241125guitool.<name>.prompt::1126 Specifies the general prompt string to display at the top of1127 the dialog, before subsections for 'argprompt' and 'revprompt'.1128 The default value includes the actual command.11291130help.browser::1131 Specify the browser that will be used to display help in the1132 'web' format. See linkgit:git-help[1].11331134help.format::1135 Override the default help format used by linkgit:git-help[1].1136 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1137 the default. 'web' and 'html' are the same.11381139help.autocorrect::1140 Automatically correct and execute mistyped commands after1141 waiting for the given number of deciseconds (0.1 sec). If more1142 than one command can be deduced from the entered text, nothing1143 will be executed. If the value of this option is negative,1144 the corrected command will be executed immediately. If the1145 value is 0 - the command will be just shown but not executed.1146 This is the default.11471148http.proxy::1149 Override the HTTP proxy, normally configured using the 'http_proxy'1150 environment variable (see linkgit:curl[1]). This can be overridden1151 on a per-remote basis; see remote.<name>.proxy11521153http.sslVerify::1154 Whether to verify the SSL certificate when fetching or pushing1155 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1156 variable.11571158http.sslCert::1159 File containing the SSL certificate when fetching or pushing1160 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1161 variable.11621163http.sslKey::1164 File containing the SSL private key when fetching or pushing1165 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1166 variable.11671168http.sslCertPasswordProtected::1169 Enable git's password prompt for the SSL certificate. Otherwise1170 OpenSSL will prompt the user, possibly many times, if the1171 certificate or private key is encrypted. Can be overridden by the1172 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.11731174http.sslCAInfo::1175 File containing the certificates to verify the peer with when1176 fetching or pushing over HTTPS. Can be overridden by the1177 'GIT_SSL_CAINFO' environment variable.11781179http.sslCAPath::1180 Path containing files with the CA certificates to verify the peer1181 with when fetching or pushing over HTTPS. Can be overridden1182 by the 'GIT_SSL_CAPATH' environment variable.11831184http.maxRequests::1185 How many HTTP requests to launch in parallel. Can be overridden1186 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.11871188http.minSessions::1189 The number of curl sessions (counted across slots) to be kept across1190 requests. They will not be ended with curl_easy_cleanup() until1191 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1192 value will be capped at 1. Defaults to 1.11931194http.postBuffer::1195 Maximum size in bytes of the buffer used by smart HTTP1196 transports when POSTing data to the remote system.1197 For requests larger than this buffer size, HTTP/1.1 and1198 Transfer-Encoding: chunked is used to avoid creating a1199 massive pack file locally. Default is 1 MiB, which is1200 sufficient for most requests.12011202http.lowSpeedLimit, http.lowSpeedTime::1203 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1204 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1205 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1206 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12071208http.noEPSV::1209 A boolean which disables using of EPSV ftp command by curl.1210 This can helpful with some "poor" ftp servers which don't1211 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1212 environment variable. Default is false (curl will use EPSV).12131214i18n.commitEncoding::1215 Character encoding the commit messages are stored in; git itself1216 does not care per se, but this information is necessary e.g. when1217 importing commits from emails or in the gitk graphical history1218 browser (and possibly at other places in the future or in other1219 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12201221i18n.logOutputEncoding::1222 Character encoding the commit messages are converted to when1223 running 'git log' and friends.12241225imap::1226 The configuration variables in the 'imap' section are described1227 in linkgit:git-imap-send[1].12281229init.templatedir::1230 Specify the directory from which templates will be copied.1231 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12321233instaweb.browser::1234 Specify the program that will be used to browse your working1235 repository in gitweb. See linkgit:git-instaweb[1].12361237instaweb.httpd::1238 The HTTP daemon command-line to start gitweb on your working1239 repository. See linkgit:git-instaweb[1].12401241instaweb.local::1242 If true the web server started by linkgit:git-instaweb[1] will1243 be bound to the local IP (127.0.0.1).12441245instaweb.modulepath::1246 The module path for an apache httpd used by linkgit:git-instaweb[1].12471248instaweb.port::1249 The port number to bind the gitweb httpd to. See1250 linkgit:git-instaweb[1].12511252interactive.singlekey::1253 In interactive commands, allow the user to provide one-letter1254 input with a single key (i.e., without hitting enter).1255 Currently this is used only by the `\--patch` mode of1256 linkgit:git-add[1]. Note that this setting is silently1257 ignored if portable keystroke input is not available.12581259log.date::1260 Set default date-time mode for the log command. Setting log.date1261 value is similar to using 'git log'\'s --date option. The value is one of the1262 following alternatives: {relative,local,default,iso,rfc,short}.1263 See linkgit:git-log[1].12641265log.showroot::1266 If true, the initial commit will be shown as a big creation event.1267 This is equivalent to a diff against an empty tree.1268 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1269 normally hide the root commit will now show it. True by default.12701271mailmap.file::1272 The location of an augmenting mailmap file. The default1273 mailmap, located in the root of the repository, is loaded1274 first, then the mailmap file pointed to by this variable.1275 The location of the mailmap file may be in a repository1276 subdirectory, or somewhere outside of the repository itself.1277 See linkgit:git-shortlog[1] and linkgit:git-blame[1].12781279man.viewer::1280 Specify the programs that may be used to display help in the1281 'man' format. See linkgit:git-help[1].12821283man.<tool>.cmd::1284 Specify the command to invoke the specified man viewer. The1285 specified command is evaluated in shell with the man page1286 passed as argument. (See linkgit:git-help[1].)12871288man.<tool>.path::1289 Override the path for the given tool that may be used to1290 display help in the 'man' format. See linkgit:git-help[1].12911292include::merge-config.txt[]12931294mergetool.<tool>.path::1295 Override the path for the given tool. This is useful in case1296 your tool is not in the PATH.12971298mergetool.<tool>.cmd::1299 Specify the command to invoke the specified merge tool. The1300 specified command is evaluated in shell with the following1301 variables available: 'BASE' is the name of a temporary file1302 containing the common base of the files to be merged, if available;1303 'LOCAL' is the name of a temporary file containing the contents of1304 the file on the current branch; 'REMOTE' is the name of a temporary1305 file containing the contents of the file from the branch being1306 merged; 'MERGED' contains the name of the file to which the merge1307 tool should write the results of a successful merge.13081309mergetool.<tool>.trustExitCode::1310 For a custom merge command, specify whether the exit code of1311 the merge command can be used to determine whether the merge was1312 successful. If this is not set to true then the merge target file1313 timestamp is checked and the merge assumed to have been successful1314 if the file has been updated, otherwise the user is prompted to1315 indicate the success of the merge.13161317mergetool.keepBackup::1318 After performing a merge, the original file with conflict markers1319 can be saved as a file with a `.orig` extension. If this variable1320 is set to `false` then this file is not preserved. Defaults to1321 `true` (i.e. keep the backup files).13221323mergetool.keepTemporaries::1324 When invoking a custom merge tool, git uses a set of temporary1325 files to pass to the tool. If the tool returns an error and this1326 variable is set to `true`, then these temporary files will be1327 preserved, otherwise they will be removed after the tool has1328 exited. Defaults to `false`.13291330mergetool.prompt::1331 Prompt before each invocation of the merge resolution program.13321333notes.displayRef::1334 The (fully qualified) refname from which to show notes when1335 showing commit messages. The value of this variable can be set1336 to a glob, in which case notes from all matching refs will be1337 shown. You may also specify this configuration variable1338 several times. A warning will be issued for refs that do not1339 exist, but a glob that does not match any refs is silently1340 ignored.1341+1342This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1343environment variable, which must be a colon separated list of refs or1344globs.1345+1346The effective value of "core.notesRef" (possibly overridden by1347GIT_NOTES_REF) is also implicitly added to the list of refs to be1348displayed.13491350notes.rewrite.<command>::1351 When rewriting commits with <command> (currently `amend` or1352 `rebase`) and this variable is set to `true`, git1353 automatically copies your notes from the original to the1354 rewritten commit. Defaults to `true`, but see1355 "notes.rewriteRef" below.13561357notes.rewriteMode::1358 When copying notes during a rewrite (see the1359 "notes.rewrite.<command>" option), determines what to do if1360 the target commit already has a note. Must be one of1361 `overwrite`, `concatenate`, or `ignore`. Defaults to1362 `concatenate`.1363+1364This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1365environment variable.13661367notes.rewriteRef::1368 When copying notes during a rewrite, specifies the (fully1369 qualified) ref whose notes should be copied. The ref may be a1370 glob, in which case notes in all matching refs will be copied.1371 You may also specify this configuration several times.1372+1373Does not have a default value; you must configure this variable to1374enable note rewriting.1375+1376This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1377environment variable, which must be a colon separated list of refs or1378globs.13791380pack.window::1381 The size of the window used by linkgit:git-pack-objects[1] when no1382 window size is given on the command line. Defaults to 10.13831384pack.depth::1385 The maximum delta depth used by linkgit:git-pack-objects[1] when no1386 maximum depth is given on the command line. Defaults to 50.13871388pack.windowMemory::1389 The window memory size limit used by linkgit:git-pack-objects[1]1390 when no limit is given on the command line. The value can be1391 suffixed with "k", "m", or "g". Defaults to 0, meaning no1392 limit.13931394pack.compression::1395 An integer -1..9, indicating the compression level for objects1396 in a pack file. -1 is the zlib default. 0 means no1397 compression, and 1..9 are various speed/size tradeoffs, 9 being1398 slowest. If not set, defaults to core.compression. If that is1399 not set, defaults to -1, the zlib default, which is "a default1400 compromise between speed and compression (currently equivalent1401 to level 6)."14021403pack.deltaCacheSize::1404 The maximum memory in bytes used for caching deltas in1405 linkgit:git-pack-objects[1] before writing them out to a pack.1406 This cache is used to speed up the writing object phase by not1407 having to recompute the final delta result once the best match1408 for all objects is found. Repacking large repositories on machines1409 which are tight with memory might be badly impacted by this though,1410 especially if this cache pushes the system into swapping.1411 A value of 0 means no limit. The smallest size of 1 byte may be1412 used to virtually disable this cache. Defaults to 256 MiB.14131414pack.deltaCacheLimit::1415 The maximum size of a delta, that is cached in1416 linkgit:git-pack-objects[1]. This cache is used to speed up the1417 writing object phase by not having to recompute the final delta1418 result once the best match for all objects is found. Defaults to 1000.14191420pack.threads::1421 Specifies the number of threads to spawn when searching for best1422 delta matches. This requires that linkgit:git-pack-objects[1]1423 be compiled with pthreads otherwise this option is ignored with a1424 warning. This is meant to reduce packing time on multiprocessor1425 machines. The required amount of memory for the delta search window1426 is however multiplied by the number of threads.1427 Specifying 0 will cause git to auto-detect the number of CPU's1428 and set the number of threads accordingly.14291430pack.indexVersion::1431 Specify the default pack index version. Valid values are 1 for1432 legacy pack index used by Git versions prior to 1.5.2, and 2 for1433 the new pack index with capabilities for packs larger than 4 GB1434 as well as proper protection against the repacking of corrupted1435 packs. Version 2 is the default. Note that version 2 is enforced1436 and this config option ignored whenever the corresponding pack is1437 larger than 2 GB.1438+1439If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1440cloning or fetching over a non native protocol (e.g. "http" and "rsync")1441that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1442other side may give you a repository that cannot be accessed with your1443older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1444you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1445the `{asterisk}.idx` file.14461447pack.packSizeLimit::1448 The maximum size of a pack. This setting only affects1449 packing to a file when repacking, i.e. the git:// protocol1450 is unaffected. It can be overridden by the `\--max-pack-size`1451 option of linkgit:git-repack[1]. The minimum size allowed is1452 limited to 1 MiB. The default is unlimited.1453 Common unit suffixes of 'k', 'm', or 'g' are1454 supported.14551456pager.<cmd>::1457 Allows turning on or off pagination of the output of a1458 particular git subcommand when writing to a tty. If1459 `\--paginate` or `\--no-pager` is specified on the command line,1460 it takes precedence over this option. To disable pagination for1461 all commands, set `core.pager` or `GIT_PAGER` to `cat`.14621463pull.octopus::1464 The default merge strategy to use when pulling multiple branches1465 at once.14661467pull.twohead::1468 The default merge strategy to use when pulling a single branch.14691470push.default::1471 Defines the action git push should take if no refspec is given1472 on the command line, no refspec is configured in the remote, and1473 no refspec is implied by any of the options given on the command1474 line. Possible values are:1475+1476* `nothing` do not push anything.1477* `matching` push all matching branches.1478 All branches having the same name in both ends are considered to be1479 matching. This is the default.1480* `tracking` push the current branch to its upstream branch.1481* `current` push the current branch to a branch of the same name.14821483rebase.stat::1484 Whether to show a diffstat of what changed upstream since the last1485 rebase. False by default.14861487receive.autogc::1488 By default, git-receive-pack will run "git-gc --auto" after1489 receiving data from git-push and updating refs. You can stop1490 it by setting this variable to false.14911492receive.fsckObjects::1493 If it is set to true, git-receive-pack will check all received1494 objects. It will abort in the case of a malformed object or a1495 broken link. The result of an abort are only dangling objects.1496 Defaults to false.14971498receive.unpackLimit::1499 If the number of objects received in a push is below this1500 limit then the objects will be unpacked into loose object1501 files. However if the number of received objects equals or1502 exceeds this limit then the received pack will be stored as1503 a pack, after adding any missing delta bases. Storing the1504 pack from a push can make the push operation complete faster,1505 especially on slow filesystems. If not set, the value of1506 `transfer.unpackLimit` is used instead.15071508receive.denyDeletes::1509 If set to true, git-receive-pack will deny a ref update that deletes1510 the ref. Use this to prevent such a ref deletion via a push.15111512receive.denyCurrentBranch::1513 If set to true or "refuse", git-receive-pack will deny a ref update1514 to the currently checked out branch of a non-bare repository.1515 Such a push is potentially dangerous because it brings the HEAD1516 out of sync with the index and working tree. If set to "warn",1517 print a warning of such a push to stderr, but allow the push to1518 proceed. If set to false or "ignore", allow such pushes with no1519 message. Defaults to "refuse".15201521receive.denyNonFastForwards::1522 If set to true, git-receive-pack will deny a ref update which is1523 not a fast-forward. Use this to prevent such an update via a push,1524 even if that push is forced. This configuration variable is1525 set when initializing a shared repository.15261527receive.updateserverinfo::1528 If set to true, git-receive-pack will run git-update-server-info1529 after receiving data from git-push and updating refs.15301531remote.<name>.url::1532 The URL of a remote repository. See linkgit:git-fetch[1] or1533 linkgit:git-push[1].15341535remote.<name>.pushurl::1536 The push URL of a remote repository. See linkgit:git-push[1].15371538remote.<name>.proxy::1539 For remotes that require curl (http, https and ftp), the URL to1540 the proxy to use for that remote. Set to the empty string to1541 disable proxying for that remote.15421543remote.<name>.fetch::1544 The default set of "refspec" for linkgit:git-fetch[1]. See1545 linkgit:git-fetch[1].15461547remote.<name>.push::1548 The default set of "refspec" for linkgit:git-push[1]. See1549 linkgit:git-push[1].15501551remote.<name>.mirror::1552 If true, pushing to this remote will automatically behave1553 as if the `\--mirror` option was given on the command line.15541555remote.<name>.skipDefaultUpdate::1556 If true, this remote will be skipped by default when updating1557 using linkgit:git-fetch[1] or the `update` subcommand of1558 linkgit:git-remote[1].15591560remote.<name>.skipFetchAll::1561 If true, this remote will be skipped by default when updating1562 using linkgit:git-fetch[1] or the `update` subcommand of1563 linkgit:git-remote[1].15641565remote.<name>.receivepack::1566 The default program to execute on the remote side when pushing. See1567 option \--receive-pack of linkgit:git-push[1].15681569remote.<name>.uploadpack::1570 The default program to execute on the remote side when fetching. See1571 option \--upload-pack of linkgit:git-fetch-pack[1].15721573remote.<name>.tagopt::1574 Setting this value to \--no-tags disables automatic tag following when1575 fetching from remote <name>15761577remote.<name>.vcs::1578 Setting this to a value <vcs> will cause git to interact with1579 the remote with the git-remote-<vcs> helper.15801581remotes.<group>::1582 The list of remotes which are fetched by "git remote update1583 <group>". See linkgit:git-remote[1].15841585repack.usedeltabaseoffset::1586 By default, linkgit:git-repack[1] creates packs that use1587 delta-base offset. If you need to share your repository with1588 git older than version 1.4.4, either directly or via a dumb1589 protocol such as http, then you need to set this option to1590 "false" and repack. Access from old git versions over the1591 native protocol are unaffected by this option.15921593rerere.autoupdate::1594 When set to true, `git-rerere` updates the index with the1595 resulting contents after it cleanly resolves conflicts using1596 previously recorded resolution. Defaults to false.15971598rerere.enabled::1599 Activate recording of resolved conflicts, so that identical1600 conflict hunks can be resolved automatically, should they1601 be encountered again. linkgit:git-rerere[1] command is by1602 default enabled if you create `rr-cache` directory under1603 `$GIT_DIR`, but can be disabled by setting this option to false.16041605sendemail.identity::1606 A configuration identity. When given, causes values in the1607 'sendemail.<identity>' subsection to take precedence over1608 values in the 'sendemail' section. The default identity is1609 the value of 'sendemail.identity'.16101611sendemail.smtpencryption::1612 See linkgit:git-send-email[1] for description. Note that this1613 setting is not subject to the 'identity' mechanism.16141615sendemail.smtpssl::1616 Deprecated alias for 'sendemail.smtpencryption = ssl'.16171618sendemail.<identity>.*::1619 Identity-specific versions of the 'sendemail.*' parameters1620 found below, taking precedence over those when the this1621 identity is selected, through command-line or1622 'sendemail.identity'.16231624sendemail.aliasesfile::1625sendemail.aliasfiletype::1626sendemail.bcc::1627sendemail.cc::1628sendemail.cccmd::1629sendemail.chainreplyto::1630sendemail.confirm::1631sendemail.envelopesender::1632sendemail.from::1633sendemail.multiedit::1634sendemail.signedoffbycc::1635sendemail.smtppass::1636sendemail.suppresscc::1637sendemail.suppressfrom::1638sendemail.to::1639sendemail.smtpdomain::1640sendemail.smtpserver::1641sendemail.smtpserverport::1642sendemail.smtpuser::1643sendemail.thread::1644sendemail.validate::1645 See linkgit:git-send-email[1] for description.16461647sendemail.signedoffcc::1648 Deprecated alias for 'sendemail.signedoffbycc'.16491650showbranch.default::1651 The default set of branches for linkgit:git-show-branch[1].1652 See linkgit:git-show-branch[1].16531654status.relativePaths::1655 By default, linkgit:git-status[1] shows paths relative to the1656 current directory. Setting this variable to `false` shows paths1657 relative to the repository root (this was the default for git1658 prior to v1.5.4).16591660status.showUntrackedFiles::1661 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1662 files which are not currently tracked by Git. Directories which1663 contain only untracked files, are shown with the directory name1664 only. Showing untracked files means that Git needs to lstat() all1665 all the files in the whole repository, which might be slow on some1666 systems. So, this variable controls how the commands displays1667 the untracked files. Possible values are:1668+1669--1670 - 'no' - Show no untracked files1671 - 'normal' - Shows untracked files and directories1672 - 'all' - Shows also individual files in untracked directories.1673--1674+1675If this variable is not specified, it defaults to 'normal'.1676This variable can be overridden with the -u|--untracked-files option1677of linkgit:git-status[1] and linkgit:git-commit[1].16781679status.submodulesummary::1680 Defaults to false.1681 If this is set to a non zero number or true (identical to -1 or an1682 unlimited number), the submodule summary will be enabled and a1683 summary of commits for modified submodules will be shown (see1684 --summary-limit option of linkgit:git-submodule[1]).16851686tar.umask::1687 This variable can be used to restrict the permission bits of1688 tar archive entries. The default is 0002, which turns off the1689 world write bit. The special value "user" indicates that the1690 archiving user's umask will be used instead. See umask(2) and1691 linkgit:git-archive[1].16921693transfer.unpackLimit::1694 When `fetch.unpackLimit` or `receive.unpackLimit` are1695 not set, the value of this variable is used instead.1696 The default value is 100.16971698url.<base>.insteadOf::1699 Any URL that starts with this value will be rewritten to1700 start, instead, with <base>. In cases where some site serves a1701 large number of repositories, and serves them with multiple1702 access methods, and some users need to use different access1703 methods, this feature allows people to specify any of the1704 equivalent URLs and have git automatically rewrite the URL to1705 the best alternative for the particular user, even for a1706 never-before-seen repository on the site. When more than one1707 insteadOf strings match a given URL, the longest match is used.17081709url.<base>.pushInsteadOf::1710 Any URL that starts with this value will not be pushed to;1711 instead, it will be rewritten to start with <base>, and the1712 resulting URL will be pushed to. In cases where some site serves1713 a large number of repositories, and serves them with multiple1714 access methods, some of which do not allow push, this feature1715 allows people to specify a pull-only URL and have git1716 automatically use an appropriate URL to push, even for a1717 never-before-seen repository on the site. When more than one1718 pushInsteadOf strings match a given URL, the longest match is1719 used. If a remote has an explicit pushurl, git will ignore this1720 setting for that remote.17211722user.email::1723 Your email address to be recorded in any newly created commits.1724 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1725 'EMAIL' environment variables. See linkgit:git-commit-tree[1].17261727user.name::1728 Your full name to be recorded in any newly created commits.1729 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1730 environment variables. See linkgit:git-commit-tree[1].17311732user.signingkey::1733 If linkgit:git-tag[1] is not selecting the key you want it to1734 automatically when creating a signed tag, you can override the1735 default selection with this variable. This option is passed1736 unchanged to gpg's --local-user parameter, so you may specify a key1737 using any method that gpg supports.17381739web.browser::1740 Specify a web browser that may be used by some commands.1741 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1742 may use it.