1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive and only alphanumeric 16characters are allowed. Some variables may appear multiple times. 17 18Syntax 19~~~~~~ 20 21The syntax is fairly flexible and permissive; whitespaces are mostly 22ignored. The '#' and ';' characters begin comments to the end of line, 23blank lines are ignored. 24 25The file consists of sections and variables. A section begins with 26the name of the section in square brackets and continues until the next 27section begins. Section names are not case sensitive. Only alphanumeric 28characters, `-` and `.` are allowed in section names. Each variable 29must belong to some section, which means that there must be a section 30header before the first setting of a variable. 31 32Sections can be further divided into subsections. To begin a subsection 33put its name in double quotes, separated by space from the section name, 34in the section header, like in the example below: 35 36-------- 37 [section "subsection"] 38 39-------- 40 41Subsection names are case sensitive and can contain any characters except 42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 43respectively). Section headers cannot span multiple 44lines. Variables may belong directly to a section or to a given subsection. 45You can have `[section]` if you have `[section "subsection"]`, but you 46don't need to. 47 48There is also a case insensitive alternative `[section.subsection]` syntax. 49In this syntax, subsection names follow the same restrictions as for section 50names. 51 52All the other lines (and the remainder of the line after the section 53header) are recognized as setting variables, in the form 54'name = value'. If there is no equal sign on the line, the entire line 55is taken as 'name' and the variable is recognized as boolean "true". 56The variable names are case-insensitive and only alphanumeric 57characters and `-` are allowed. There can be more than one value 58for a given variable; we say then that variable is multivalued. 59 60Leading and trailing whitespace in a variable value is discarded. 61Internal whitespace within a variable value is retained verbatim. 62 63The values following the equals sign in variable assign are all either 64a string, an integer, or a boolean. Boolean values may be given as yes/no, 650/1, true/false or on/off. Case is not significant in boolean values, when 66converting value to the canonical form using '--bool' type specifier; 67'git config' will ensure that the output is "true" or "false". 68 69String values may be entirely or partially enclosed in double quotes. 70You need to enclose variable values in double quotes if you want to 71preserve leading or trailing whitespace, or if the variable value contains 72comment characters (i.e. it contains '#' or ';'). 73Double quote `"` and backslash `\` characters in variable values must 74be escaped: use `\"` for `"` and `\\` for `\`. 75 76The following escape sequences (beside `\"` and `\\`) are recognized: 77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 78and `\b` for backspace (BS). No other char escape sequence, nor octal 79char sequences are valid. 80 81Variable values ending in a `\` are continued on the next line in the 82customary UNIX fashion. 83 84Some variables may require a special value format. 85 86Example 87~~~~~~~ 88 89 # Core variables 90 [core] 91 ; Don't trust file modes 92 filemode = false 93 94 # Our diff algorithm 95 [diff] 96 external = /usr/local/bin/diff-wrapper 97 renames = true 98 99 [branch "devel"] 100 remote = origin 101 merge = refs/heads/devel 102 103 # Proxy settings 104 [core] 105 gitProxy="ssh" for "kernel.org" 106 gitProxy=default-proxy ; for the rest 107 108Variables 109~~~~~~~~~ 110 111Note that this list is non-comprehensive and not necessarily complete. 112For command-specific variables, you will find a more detailed description 113in the appropriate manual page. You will find a description of non-core 114porcelain configuration variables in the respective porcelain documentation. 115 116advice.*:: 117 When set to 'true', display the given optional help message. 118 When set to 'false', do not display. The configuration variables 119 are: 120+ 121-- 122 pushNonFastForward:: 123 Advice shown when linkgit:git-push[1] refuses 124 non-fast-forward refs. Default: true. 125 statusHints:: 126 Directions on how to stage/unstage/add shown in the 127 output of linkgit:git-status[1] and the template shown 128 when writing commit messages. Default: true. 129 commitBeforeMerge:: 130 Advice shown when linkgit:git-merge[1] refuses to 131 merge to avoid overwriting local changes. 132 Default: true. 133 resolveConflict:: 134 Advices shown by various commands when conflicts 135 prevent the operation from being performed. 136 Default: true. 137 implicitIdentity:: 138 Advice on how to set your identity configuration when 139 your information is guessed from the system username and 140 domain name. Default: true. 141 142 detachedHead:: 143 Advice shown when you used linkgit::git-checkout[1] to 144 move to the detach HEAD state, to instruct how to create 145 a local branch after the fact. Default: true. 146-- 147 148core.fileMode:: 149 If false, the executable bit differences between the index and 150 the working copy are ignored; useful on broken filesystems like FAT. 151 See linkgit:git-update-index[1]. 152+ 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 154will probe and set core.fileMode false if appropriate when the 155repository is created. 156 157core.ignoreCygwinFSTricks:: 158 This option is only used by Cygwin implementation of Git. If false, 159 the Cygwin stat() and lstat() functions are used. This may be useful 160 if your repository consists of a few separate directories joined in 161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 162 whenever it is possible and falls back to Cygwin functions only to 163 handle symbol links. The native mode is more than twice faster than 164 normal Cygwin l/stat() functions. True by default, unless core.filemode 165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 166 POSIX emulation is required to support core.filemode. 167 168core.ignorecase:: 169 If true, this option enables various workarounds to enable 170 git to work better on filesystems that are not case sensitive, 171 like FAT. For example, if a directory listing finds 172 "makefile" when git expects "Makefile", git will assume 173 it is really the same file, and continue to remember it as 174 "Makefile". 175+ 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 177will probe and set core.ignorecase true if appropriate when the repository 178is created. 179 180core.trustctime:: 181 If false, the ctime differences between the index and the 182 working copy are ignored; useful when the inode change time 183 is regularly modified by something outside Git (file system 184 crawlers and some backup systems). 185 See linkgit:git-update-index[1]. True by default. 186 187core.quotepath:: 188 The commands that output paths (e.g. 'ls-files', 189 'diff'), when not given the `-z` option, will quote 190 "unusual" characters in the pathname by enclosing the 191 pathname in a double-quote pair and with backslashes the 192 same way strings in C source code are quoted. If this 193 variable is set to false, the bytes higher than 0x80 are 194 not quoted but output as verbatim. Note that double 195 quote, backslash and control characters are always 196 quoted without `-z` regardless of the setting of this 197 variable. 198 199core.eol:: 200 Sets the line ending type to use in the working directory for 201 files that have the `text` property set. Alternatives are 202 'lf', 'crlf' and 'native', which uses the platform's native 203 line ending. The default value is `native`. See 204 linkgit:gitattributes[5] for more information on end-of-line 205 conversion. 206 207core.safecrlf:: 208 If true, makes git check if converting `CRLF` is reversible when 209 end-of-line conversion is active. Git will verify if a command 210 modifies a file in the work tree either directly or indirectly. 211 For example, committing a file followed by checking out the 212 same file should yield the original file in the work tree. If 213 this is not the case for the current setting of 214 `core.autocrlf`, git will reject the file. The variable can 215 be set to "warn", in which case git will only warn about an 216 irreversible conversion but continue the operation. 217+ 218CRLF conversion bears a slight chance of corrupting data. 219When it is enabled, git will convert CRLF to LF during commit and LF to 220CRLF during checkout. A file that contains a mixture of LF and 221CRLF before the commit cannot be recreated by git. For text 222files this is the right thing to do: it corrects line endings 223such that we have only LF line endings in the repository. 224But for binary files that are accidentally classified as text the 225conversion can corrupt data. 226+ 227If you recognize such corruption early you can easily fix it by 228setting the conversion type explicitly in .gitattributes. Right 229after committing you still have the original file in your work 230tree and this file is not yet corrupted. You can explicitly tell 231git that this file is binary and git will handle the file 232appropriately. 233+ 234Unfortunately, the desired effect of cleaning up text files with 235mixed line endings and the undesired effect of corrupting binary 236files cannot be distinguished. In both cases CRLFs are removed 237in an irreversible way. For text files this is the right thing 238to do because CRLFs are line endings, while for binary files 239converting CRLFs corrupts data. 240+ 241Note, this safety check does not mean that a checkout will generate a 242file identical to the original file for a different setting of 243`core.eol` and `core.autocrlf`, but only for the current one. For 244example, a text file with `LF` would be accepted with `core.eol=lf` 245and could later be checked out with `core.eol=crlf`, in which case the 246resulting file would contain `CRLF`, although the original file 247contained `LF`. However, in both work trees the line endings would be 248consistent, that is either all `LF` or all `CRLF`, but never mixed. A 249file with mixed line endings would be reported by the `core.safecrlf` 250mechanism. 251 252core.autocrlf:: 253 Setting this variable to "true" is almost the same as setting 254 the `text` attribute to "auto" on all files except that text 255 files are not guaranteed to be normalized: files that contain 256 `CRLF` in the repository will not be touched. Use this 257 setting if you want to have `CRLF` line endings in your 258 working directory even though the repository does not have 259 normalized line endings. This variable can be set to 'input', 260 in which case no output conversion is performed. 261 262core.symlinks:: 263 If false, symbolic links are checked out as small plain files that 264 contain the link text. linkgit:git-update-index[1] and 265 linkgit:git-add[1] will not change the recorded type to regular 266 file. Useful on filesystems like FAT that do not support 267 symbolic links. 268+ 269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 270will probe and set core.symlinks false if appropriate when the repository 271is created. 272 273core.gitProxy:: 274 A "proxy command" to execute (as 'command host port') instead 275 of establishing direct connection to the remote server when 276 using the git protocol for fetching. If the variable value is 277 in the "COMMAND for DOMAIN" format, the command is applied only 278 on hostnames ending with the specified domain string. This variable 279 may be set multiple times and is matched in the given order; 280 the first match wins. 281+ 282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 283(which always applies universally, without the special "for" 284handling). 285+ 286The special string `none` can be used as the proxy command to 287specify that no proxy be used for a given domain pattern. 288This is useful for excluding servers inside a firewall from 289proxy use, while defaulting to a common proxy for external domains. 290 291core.ignoreStat:: 292 If true, commands which modify both the working tree and the index 293 will mark the updated paths with the "assume unchanged" bit in the 294 index. These marked files are then assumed to stay unchanged in the 295 working copy, until you mark them otherwise manually - Git will not 296 detect the file changes by lstat() calls. This is useful on systems 297 where those are very slow, such as Microsoft Windows. 298 See linkgit:git-update-index[1]. 299 False by default. 300 301core.preferSymlinkRefs:: 302 Instead of the default "symref" format for HEAD 303 and other symbolic reference files, use symbolic links. 304 This is sometimes needed to work with old scripts that 305 expect HEAD to be a symbolic link. 306 307core.bare:: 308 If true this repository is assumed to be 'bare' and has no 309 working directory associated with it. If this is the case a 310 number of commands that require a working directory will be 311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 312+ 313This setting is automatically guessed by linkgit:git-clone[1] or 314linkgit:git-init[1] when the repository was created. By default a 315repository that ends in "/.git" is assumed to be not bare (bare = 316false), while all other repositories are assumed to be bare (bare 317= true). 318 319core.worktree:: 320 Set the path to the root of the work tree. 321 This can be overridden by the GIT_WORK_TREE environment 322 variable and the '--work-tree' command line option. It can be 323 an absolute path or a relative path to the .git directory, 324 either specified by --git-dir or GIT_DIR, or automatically 325 discovered. 326 If --git-dir or GIT_DIR are specified but none of 327 --work-tree, GIT_WORK_TREE and core.worktree is specified, 328 the current working directory is regarded as the root of the 329 work tree. 330+ 331Note that this variable is honored even when set in a configuration 332file in a ".git" subdirectory of a directory, and its value differs 333from the latter directory (e.g. "/path/to/.git/config" has 334core.worktree set to "/different/path"), which is most likely a 335misconfiguration. Running git commands in "/path/to" directory will 336still use "/different/path" as the root of the work tree and can cause 337great confusion to the users. 338 339core.logAllRefUpdates:: 340 Enable the reflog. Updates to a ref <ref> is logged to the file 341 "$GIT_DIR/logs/<ref>", by appending the new and old 342 SHA1, the date/time and the reason of the update, but 343 only when the file exists. If this configuration 344 variable is set to true, missing "$GIT_DIR/logs/<ref>" 345 file is automatically created for branch heads. 346+ 347This information can be used to determine what commit 348was the tip of a branch "2 days ago". 349+ 350This value is true by default in a repository that has 351a working directory associated with it, and false by 352default in a bare repository. 353 354core.repositoryFormatVersion:: 355 Internal variable identifying the repository format and layout 356 version. 357 358core.sharedRepository:: 359 When 'group' (or 'true'), the repository is made shareable between 360 several users in a group (making sure all the files and objects are 361 group-writable). When 'all' (or 'world' or 'everybody'), the 362 repository will be readable by all users, additionally to being 363 group-shareable. When 'umask' (or 'false'), git will use permissions 364 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 365 files in the repository will have this mode value. '0xxx' will override 366 user's umask value (whereas the other options will only override 367 requested parts of the user's umask value). Examples: '0660' will make 368 the repo read/write-able for the owner and group, but inaccessible to 369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 370 repository that is group-readable but not group-writable. 371 See linkgit:git-init[1]. False by default. 372 373core.warnAmbiguousRefs:: 374 If true, git will warn you if the ref name you passed it is ambiguous 375 and might match multiple refs in the .git/refs/ tree. True by default. 376 377core.abbrevguard:: 378 Even though git makes sure that it uses enough hexdigits to show 379 an abbreviated object name unambiguously, as more objects are 380 added to the repository over time, a short name that used to be 381 unique will stop being unique. Git uses this many extra hexdigits 382 that are more than necessary to make the object name currently 383 unique, in the hope that its output will stay unique a bit longer. 384 Defaults to 0. 385 386core.compression:: 387 An integer -1..9, indicating a default compression level. 388 -1 is the zlib default. 0 means no compression, 389 and 1..9 are various speed/size tradeoffs, 9 being slowest. 390 If set, this provides a default to other compression variables, 391 such as 'core.loosecompression' and 'pack.compression'. 392 393core.loosecompression:: 394 An integer -1..9, indicating the compression level for objects that 395 are not in a pack file. -1 is the zlib default. 0 means no 396 compression, and 1..9 are various speed/size tradeoffs, 9 being 397 slowest. If not set, defaults to core.compression. If that is 398 not set, defaults to 1 (best speed). 399 400core.packedGitWindowSize:: 401 Number of bytes of a pack file to map into memory in a 402 single mapping operation. Larger window sizes may allow 403 your system to process a smaller number of large pack files 404 more quickly. Smaller window sizes will negatively affect 405 performance due to increased calls to the operating system's 406 memory manager, but may improve performance when accessing 407 a large number of large pack files. 408+ 409Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 410MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 411be reasonable for all users/operating systems. You probably do 412not need to adjust this value. 413+ 414Common unit suffixes of 'k', 'm', or 'g' are supported. 415 416core.packedGitLimit:: 417 Maximum number of bytes to map simultaneously into memory 418 from pack files. If Git needs to access more than this many 419 bytes at once to complete an operation it will unmap existing 420 regions to reclaim virtual address space within the process. 421+ 422Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 423This should be reasonable for all users/operating systems, except on 424the largest projects. You probably do not need to adjust this value. 425+ 426Common unit suffixes of 'k', 'm', or 'g' are supported. 427 428core.deltaBaseCacheLimit:: 429 Maximum number of bytes to reserve for caching base objects 430 that may be referenced by multiple deltified objects. By storing the 431 entire decompressed base objects in a cache Git is able 432 to avoid unpacking and decompressing frequently used base 433 objects multiple times. 434+ 435Default is 16 MiB on all platforms. This should be reasonable 436for all users/operating systems, except on the largest projects. 437You probably do not need to adjust this value. 438+ 439Common unit suffixes of 'k', 'm', or 'g' are supported. 440 441core.bigFileThreshold:: 442 Files larger than this size are stored deflated, without 443 attempting delta compression. Storing large files without 444 delta compression avoids excessive memory usage, at the 445 slight expense of increased disk usage. 446+ 447Default is 512 MiB on all platforms. This should be reasonable 448for most projects as source code and other text files can still 449be delta compressed, but larger binary media files won't be. 450+ 451Common unit suffixes of 'k', 'm', or 'g' are supported. 452+ 453Currently only linkgit:git-fast-import[1] honors this setting. 454 455core.excludesfile:: 456 In addition to '.gitignore' (per-directory) and 457 '.git/info/exclude', git looks into this file for patterns 458 of files which are not meant to be tracked. "{tilde}/" is expanded 459 to the value of `$HOME` and "{tilde}user/" to the specified user's 460 home directory. See linkgit:gitignore[5]. 461 462core.askpass:: 463 Some commands (e.g. svn and http interfaces) that interactively 464 ask for a password can be told to use an external program given 465 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 466 environment variable. If not set, fall back to the value of the 467 'SSH_ASKPASS' environment variable or, failing that, a simple password 468 prompt. The external program shall be given a suitable prompt as 469 command line argument and write the password on its STDOUT. 470 471core.attributesfile:: 472 In addition to '.gitattributes' (per-directory) and 473 '.git/info/attributes', git looks into this file for attributes 474 (see linkgit:gitattributes[5]). Path expansions are made the same 475 way as for `core.excludesfile`. 476 477core.editor:: 478 Commands such as `commit` and `tag` that lets you edit 479 messages by launching an editor uses the value of this 480 variable when it is set, and the environment variable 481 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 482 483core.pager:: 484 The command that git will use to paginate output. Can 485 be overridden with the `GIT_PAGER` environment 486 variable. Note that git sets the `LESS` environment 487 variable to `FRSX` if it is unset when it runs the 488 pager. One can change these settings by setting the 489 `LESS` variable to some other value. Alternately, 490 these settings can be overridden on a project or 491 global basis by setting the `core.pager` option. 492 Setting `core.pager` has no affect on the `LESS` 493 environment variable behaviour above, so if you want 494 to override git's default settings this way, you need 495 to be explicit. For example, to disable the S option 496 in a backward compatible manner, set `core.pager` 497 to `less -+$LESS -FRX`. This will be passed to the 498 shell by git, which will translate the final command to 499 `LESS=FRSX less -+FRSX -FRX`. 500 501core.whitespace:: 502 A comma separated list of common whitespace problems to 503 notice. 'git diff' will use `color.diff.whitespace` to 504 highlight them, and 'git apply --whitespace=error' will 505 consider them as errors. You can prefix `-` to disable 506 any of them (e.g. `-trailing-space`): 507+ 508* `blank-at-eol` treats trailing whitespaces at the end of the line 509 as an error (enabled by default). 510* `space-before-tab` treats a space character that appears immediately 511 before a tab character in the initial indent part of the line as an 512 error (enabled by default). 513* `indent-with-non-tab` treats a line that is indented with 8 or more 514 space characters as an error (not enabled by default). 515* `tab-in-indent` treats a tab character in the initial indent part of 516 the line as an error (not enabled by default). 517* `blank-at-eof` treats blank lines added at the end of file as an error 518 (enabled by default). 519* `trailing-space` is a short-hand to cover both `blank-at-eol` and 520 `blank-at-eof`. 521* `cr-at-eol` treats a carriage-return at the end of line as 522 part of the line terminator, i.e. with it, `trailing-space` 523 does not trigger if the character before such a carriage-return 524 is not a whitespace (not enabled by default). 525 526core.fsyncobjectfiles:: 527 This boolean will enable 'fsync()' when writing object files. 528+ 529This is a total waste of time and effort on a filesystem that orders 530data writes properly, but can be useful for filesystems that do not use 531journalling (traditional UNIX filesystems) or that only journal metadata 532and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 533 534core.preloadindex:: 535 Enable parallel index preload for operations like 'git diff' 536+ 537This can speed up operations like 'git diff' and 'git status' especially 538on filesystems like NFS that have weak caching semantics and thus 539relatively high IO latencies. With this set to 'true', git will do the 540index comparison to the filesystem data in parallel, allowing 541overlapping IO's. 542 543core.createObject:: 544 You can set this to 'link', in which case a hardlink followed by 545 a delete of the source are used to make sure that object creation 546 will not overwrite existing objects. 547+ 548On some file system/operating system combinations, this is unreliable. 549Set this config setting to 'rename' there; However, This will remove the 550check that makes sure that existing object files will not get overwritten. 551 552core.notesRef:: 553 When showing commit messages, also show notes which are stored in 554 the given ref. The ref must be fully qualified. If the given 555 ref does not exist, it is not an error but means that no 556 notes should be printed. 557+ 558This setting defaults to "refs/notes/commits", and it can be overridden by 559the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 560 561core.sparseCheckout:: 562 Enable "sparse checkout" feature. See section "Sparse checkout" in 563 linkgit:git-read-tree[1] for more information. 564 565add.ignore-errors:: 566 Tells 'git add' to continue adding files when some files cannot be 567 added due to indexing errors. Equivalent to the '--ignore-errors' 568 option of linkgit:git-add[1]. 569 570alias.*:: 571 Command aliases for the linkgit:git[1] command wrapper - e.g. 572 after defining "alias.last = cat-file commit HEAD", the invocation 573 "git last" is equivalent to "git cat-file commit HEAD". To avoid 574 confusion and troubles with script usage, aliases that 575 hide existing git commands are ignored. Arguments are split by 576 spaces, the usual shell quoting and escaping is supported. 577 quote pair and a backslash can be used to quote them. 578+ 579If the alias expansion is prefixed with an exclamation point, 580it will be treated as a shell command. For example, defining 581"alias.new = !gitk --all --not ORIG_HEAD", the invocation 582"git new" is equivalent to running the shell command 583"gitk --all --not ORIG_HEAD". Note that shell commands will be 584executed from the top-level directory of a repository, which may 585not necessarily be the current directory. 586 587am.keepcr:: 588 If true, git-am will call git-mailsplit for patches in mbox format 589 with parameter '--keep-cr'. In this case git-mailsplit will 590 not remove `\r` from lines ending with `\r\n`. Can be overridden 591 by giving '--no-keep-cr' from the command line. 592 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 593 594apply.ignorewhitespace:: 595 When set to 'change', tells 'git apply' to ignore changes in 596 whitespace, in the same way as the '--ignore-space-change' 597 option. 598 When set to one of: no, none, never, false tells 'git apply' to 599 respect all whitespace differences. 600 See linkgit:git-apply[1]. 601 602apply.whitespace:: 603 Tells 'git apply' how to handle whitespaces, in the same way 604 as the '--whitespace' option. See linkgit:git-apply[1]. 605 606branch.autosetupmerge:: 607 Tells 'git branch' and 'git checkout' to set up new branches 608 so that linkgit:git-pull[1] will appropriately merge from the 609 starting point branch. Note that even if this option is not set, 610 this behavior can be chosen per-branch using the `--track` 611 and `--no-track` options. The valid settings are: `false` -- no 612 automatic setup is done; `true` -- automatic setup is done when the 613 starting point is a remote branch; `always` -- automatic setup is 614 done when the starting point is either a local branch or remote 615 branch. This option defaults to true. 616 617branch.autosetuprebase:: 618 When a new branch is created with 'git branch' or 'git checkout' 619 that tracks another branch, this variable tells git to set 620 up pull to rebase instead of merge (see "branch.<name>.rebase"). 621 When `never`, rebase is never automatically set to true. 622 When `local`, rebase is set to true for tracked branches of 623 other local branches. 624 When `remote`, rebase is set to true for tracked branches of 625 remote branches. 626 When `always`, rebase will be set to true for all tracking 627 branches. 628 See "branch.autosetupmerge" for details on how to set up a 629 branch to track another branch. 630 This option defaults to never. 631 632branch.<name>.remote:: 633 When in branch <name>, it tells 'git fetch' and 'git push' which 634 remote to fetch from/push to. It defaults to `origin` if no remote is 635 configured. `origin` is also used if you are not on any branch. 636 637branch.<name>.merge:: 638 Defines, together with branch.<name>.remote, the upstream branch 639 for the given branch. It tells 'git fetch'/'git pull' which 640 branch to merge and can also affect 'git push' (see push.default). 641 When in branch <name>, it tells 'git fetch' the default 642 refspec to be marked for merging in FETCH_HEAD. The value is 643 handled like the remote part of a refspec, and must match a 644 ref which is fetched from the remote given by 645 "branch.<name>.remote". 646 The merge information is used by 'git pull' (which at first calls 647 'git fetch') to lookup the default branch for merging. Without 648 this option, 'git pull' defaults to merge the first refspec fetched. 649 Specify multiple values to get an octopus merge. 650 If you wish to setup 'git pull' so that it merges into <name> from 651 another branch in the local repository, you can point 652 branch.<name>.merge to the desired branch, and use the special setting 653 `.` (a period) for branch.<name>.remote. 654 655branch.<name>.mergeoptions:: 656 Sets default options for merging into branch <name>. The syntax and 657 supported options are the same as those of linkgit:git-merge[1], but 658 option values containing whitespace characters are currently not 659 supported. 660 661branch.<name>.rebase:: 662 When true, rebase the branch <name> on top of the fetched branch, 663 instead of merging the default branch from the default remote when 664 "git pull" is run. 665 *NOTE*: this is a possibly dangerous operation; do *not* use 666 it unless you understand the implications (see linkgit:git-rebase[1] 667 for details). 668 669browser.<tool>.cmd:: 670 Specify the command to invoke the specified browser. The 671 specified command is evaluated in shell with the URLs passed 672 as arguments. (See linkgit:git-web--browse[1].) 673 674browser.<tool>.path:: 675 Override the path for the given tool that may be used to 676 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 677 working repository in gitweb (see linkgit:git-instaweb[1]). 678 679clean.requireForce:: 680 A boolean to make git-clean do nothing unless given -f 681 or -n. Defaults to true. 682 683color.branch:: 684 A boolean to enable/disable color in the output of 685 linkgit:git-branch[1]. May be set to `always`, 686 `false` (or `never`) or `auto` (or `true`), in which case colors are used 687 only when the output is to a terminal. Defaults to false. 688 689color.branch.<slot>:: 690 Use customized color for branch coloration. `<slot>` is one of 691 `current` (the current branch), `local` (a local branch), 692 `remote` (a tracking branch in refs/remotes/), `plain` (other 693 refs). 694+ 695The value for these configuration variables is a list of colors (at most 696two) and attributes (at most one), separated by spaces. The colors 697accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 698`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 699`blink` and `reverse`. The first color given is the foreground; the 700second is the background. The position of the attribute, if any, 701doesn't matter. 702 703color.diff:: 704 When set to `always`, always use colors in patch. 705 When false (or `never`), never. When set to `true` or `auto`, use 706 colors only when the output is to the terminal. Defaults to false. 707 708color.diff.<slot>:: 709 Use customized color for diff colorization. `<slot>` specifies 710 which part of the patch to use the specified color, and is one 711 of `plain` (context text), `meta` (metainformation), `frag` 712 (hunk header), 'func' (function in hunk header), `old` (removed lines), 713 `new` (added lines), `commit` (commit headers), or `whitespace` 714 (highlighting whitespace errors). The values of these variables may be 715 specified as in color.branch.<slot>. 716 717color.decorate.<slot>:: 718 Use customized color for 'git log --decorate' output. `<slot>` is one 719 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 720 branches, remote tracking branches, tags, stash and HEAD, respectively. 721 722color.grep:: 723 When set to `always`, always highlight matches. When `false` (or 724 `never`), never. When set to `true` or `auto`, use color only 725 when the output is written to the terminal. Defaults to `false`. 726 727color.grep.<slot>:: 728 Use customized color for grep colorization. `<slot>` specifies which 729 part of the line to use the specified color, and is one of 730+ 731-- 732`context`;; 733 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 734`filename`;; 735 filename prefix (when not using `-h`) 736`function`;; 737 function name lines (when using `-p`) 738`linenumber`;; 739 line number prefix (when using `-n`) 740`match`;; 741 matching text 742`selected`;; 743 non-matching text in selected lines 744`separator`;; 745 separators between fields on a line (`:`, `-`, and `=`) 746 and between hunks (`--`) 747-- 748+ 749The values of these variables may be specified as in color.branch.<slot>. 750 751color.interactive:: 752 When set to `always`, always use colors for interactive prompts 753 and displays (such as those used by "git-add --interactive"). 754 When false (or `never`), never. When set to `true` or `auto`, use 755 colors only when the output is to the terminal. Defaults to false. 756 757color.interactive.<slot>:: 758 Use customized color for 'git add --interactive' 759 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 760 four distinct types of normal output from interactive 761 commands. The values of these variables may be specified as 762 in color.branch.<slot>. 763 764color.pager:: 765 A boolean to enable/disable colored output when the pager is in 766 use (default is true). 767 768color.showbranch:: 769 A boolean to enable/disable color in the output of 770 linkgit:git-show-branch[1]. May be set to `always`, 771 `false` (or `never`) or `auto` (or `true`), in which case colors are used 772 only when the output is to a terminal. Defaults to false. 773 774color.status:: 775 A boolean to enable/disable color in the output of 776 linkgit:git-status[1]. May be set to `always`, 777 `false` (or `never`) or `auto` (or `true`), in which case colors are used 778 only when the output is to a terminal. Defaults to false. 779 780color.status.<slot>:: 781 Use customized color for status colorization. `<slot>` is 782 one of `header` (the header text of the status message), 783 `added` or `updated` (files which are added but not committed), 784 `changed` (files which are changed but not added in the index), 785 `untracked` (files which are not tracked by git), or 786 `nobranch` (the color the 'no branch' warning is shown in, defaulting 787 to red). The values of these variables may be specified as in 788 color.branch.<slot>. 789 790color.ui:: 791 When set to `always`, always use colors in all git commands which 792 are capable of colored output. When false (or `never`), never. When 793 set to `true` or `auto`, use colors only when the output is to the 794 terminal. When more specific variables of color.* are set, they always 795 take precedence over this setting. Defaults to false. 796 797commit.status:: 798 A boolean to enable/disable inclusion of status information in the 799 commit message template when using an editor to prepare the commit 800 message. Defaults to true. 801 802commit.template:: 803 Specify a file to use as the template for new commit messages. 804 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 805 specified user's home directory. 806 807diff.autorefreshindex:: 808 When using 'git diff' to compare with work tree 809 files, do not consider stat-only change as changed. 810 Instead, silently run `git update-index --refresh` to 811 update the cached stat information for paths whose 812 contents in the work tree match the contents in the 813 index. This option defaults to true. Note that this 814 affects only 'git diff' Porcelain, and not lower level 815 'diff' commands such as 'git diff-files'. 816 817diff.external:: 818 If this config variable is set, diff generation is not 819 performed using the internal diff machinery, but using the 820 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 821 environment variable. The command is called with parameters 822 as described under "git Diffs" in linkgit:git[1]. Note: if 823 you want to use an external diff program only on a subset of 824 your files, you might want to use linkgit:gitattributes[5] instead. 825 826diff.mnemonicprefix:: 827 If set, 'git diff' uses a prefix pair that is different from the 828 standard "a/" and "b/" depending on what is being compared. When 829 this configuration is in effect, reverse diff output also swaps 830 the order of the prefixes: 831`git diff`;; 832 compares the (i)ndex and the (w)ork tree; 833`git diff HEAD`;; 834 compares a (c)ommit and the (w)ork tree; 835`git diff --cached`;; 836 compares a (c)ommit and the (i)ndex; 837`git diff HEAD:file1 file2`;; 838 compares an (o)bject and a (w)ork tree entity; 839`git diff --no-index a b`;; 840 compares two non-git things (1) and (2). 841 842diff.noprefix:: 843 If set, 'git diff' does not show any source or destination prefix. 844 845diff.renameLimit:: 846 The number of files to consider when performing the copy/rename 847 detection; equivalent to the 'git diff' option '-l'. 848 849diff.renames:: 850 Tells git to detect renames. If set to any boolean value, it 851 will enable basic rename detection. If set to "copies" or 852 "copy", it will detect copies, as well. 853 854diff.ignoreSubmodules:: 855 Sets the default value of --ignore-submodules. Note that this 856 affects only 'git diff' Porcelain, and not lower level 'diff' 857 commands such as 'git diff-files'. 'git checkout' also honors 858 this setting when reporting uncommitted changes. 859 860diff.suppressBlankEmpty:: 861 A boolean to inhibit the standard behavior of printing a space 862 before each empty output line. Defaults to false. 863 864diff.tool:: 865 Controls which diff tool is used. `diff.tool` overrides 866 `merge.tool` when used by linkgit:git-difftool[1] and has 867 the same valid values as `merge.tool` minus "tortoisemerge" 868 and plus "kompare". 869 870difftool.<tool>.path:: 871 Override the path for the given tool. This is useful in case 872 your tool is not in the PATH. 873 874difftool.<tool>.cmd:: 875 Specify the command to invoke the specified diff tool. 876 The specified command is evaluated in shell with the following 877 variables available: 'LOCAL' is set to the name of the temporary 878 file containing the contents of the diff pre-image and 'REMOTE' 879 is set to the name of the temporary file containing the contents 880 of the diff post-image. 881 882difftool.prompt:: 883 Prompt before each invocation of the diff tool. 884 885diff.wordRegex:: 886 A POSIX Extended Regular Expression used to determine what is a "word" 887 when performing word-by-word difference calculations. Character 888 sequences that match the regular expression are "words", all other 889 characters are *ignorable* whitespace. 890 891fetch.unpackLimit:: 892 If the number of objects fetched over the git native 893 transfer is below this 894 limit, then the objects will be unpacked into loose object 895 files. However if the number of received objects equals or 896 exceeds this limit then the received pack will be stored as 897 a pack, after adding any missing delta bases. Storing the 898 pack from a push can make the push operation complete faster, 899 especially on slow filesystems. If not set, the value of 900 `transfer.unpackLimit` is used instead. 901 902format.attach:: 903 Enable multipart/mixed attachments as the default for 904 'format-patch'. The value can also be a double quoted string 905 which will enable attachments as the default and set the 906 value as the boundary. See the --attach option in 907 linkgit:git-format-patch[1]. 908 909format.numbered:: 910 A boolean which can enable or disable sequence numbers in patch 911 subjects. It defaults to "auto" which enables it only if there 912 is more than one patch. It can be enabled or disabled for all 913 messages by setting it to "true" or "false". See --numbered 914 option in linkgit:git-format-patch[1]. 915 916format.headers:: 917 Additional email headers to include in a patch to be submitted 918 by mail. See linkgit:git-format-patch[1]. 919 920format.to:: 921format.cc:: 922 Additional recipients to include in a patch to be submitted 923 by mail. See the --to and --cc options in 924 linkgit:git-format-patch[1]. 925 926format.subjectprefix:: 927 The default for format-patch is to output files with the '[PATCH]' 928 subject prefix. Use this variable to change that prefix. 929 930format.signature:: 931 The default for format-patch is to output a signature containing 932 the git version number. Use this variable to change that default. 933 Set this variable to the empty string ("") to suppress 934 signature generation. 935 936format.suffix:: 937 The default for format-patch is to output files with the suffix 938 `.patch`. Use this variable to change that suffix (make sure to 939 include the dot if you want it). 940 941format.pretty:: 942 The default pretty format for log/show/whatchanged command, 943 See linkgit:git-log[1], linkgit:git-show[1], 944 linkgit:git-whatchanged[1]. 945 946format.thread:: 947 The default threading style for 'git format-patch'. Can be 948 a boolean value, or `shallow` or `deep`. `shallow` threading 949 makes every mail a reply to the head of the series, 950 where the head is chosen from the cover letter, the 951 `\--in-reply-to`, and the first patch mail, in this order. 952 `deep` threading makes every mail a reply to the previous one. 953 A true boolean value is the same as `shallow`, and a false 954 value disables threading. 955 956format.signoff:: 957 A boolean value which lets you enable the `-s/--signoff` option of 958 format-patch by default. *Note:* Adding the Signed-off-by: line to a 959 patch should be a conscious act and means that you certify you have 960 the rights to submit this work under the same open source license. 961 Please see the 'SubmittingPatches' document for further discussion. 962 963gc.aggressiveWindow:: 964 The window size parameter used in the delta compression 965 algorithm used by 'git gc --aggressive'. This defaults 966 to 250. 967 968gc.auto:: 969 When there are approximately more than this many loose 970 objects in the repository, `git gc --auto` will pack them. 971 Some Porcelain commands use this command to perform a 972 light-weight garbage collection from time to time. The 973 default value is 6700. Setting this to 0 disables it. 974 975gc.autopacklimit:: 976 When there are more than this many packs that are not 977 marked with `*.keep` file in the repository, `git gc 978 --auto` consolidates them into one larger pack. The 979 default value is 50. Setting this to 0 disables it. 980 981gc.packrefs:: 982 Running `git pack-refs` in a repository renders it 983 unclonable by Git versions prior to 1.5.1.2 over dumb 984 transports such as HTTP. This variable determines whether 985 'git gc' runs `git pack-refs`. This can be set to `nobare` 986 to enable it within all non-bare repos or it can be set to a 987 boolean value. The default is `true`. 988 989gc.pruneexpire:: 990 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 991 Override the grace period with this config variable. The value 992 "now" may be used to disable this grace period and always prune 993 unreachable objects immediately. 994 995gc.reflogexpire:: 996gc.<pattern>.reflogexpire:: 997 'git reflog expire' removes reflog entries older than 998 this time; defaults to 90 days. With "<pattern>" (e.g. 999 "refs/stash") in the middle the setting applies only to1000 the refs that match the <pattern>.10011002gc.reflogexpireunreachable::1003gc.<ref>.reflogexpireunreachable::1004 'git reflog expire' removes reflog entries older than1005 this time and are not reachable from the current tip;1006 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1007 in the middle, the setting applies only to the refs that1008 match the <pattern>.10091010gc.rerereresolved::1011 Records of conflicted merge you resolved earlier are1012 kept for this many days when 'git rerere gc' is run.1013 The default is 60 days. See linkgit:git-rerere[1].10141015gc.rerereunresolved::1016 Records of conflicted merge you have not resolved are1017 kept for this many days when 'git rerere gc' is run.1018 The default is 15 days. See linkgit:git-rerere[1].10191020gitcvs.commitmsgannotation::1021 Append this string to each commit message. Set to empty string1022 to disable this feature. Defaults to "via git-CVS emulator".10231024gitcvs.enabled::1025 Whether the CVS server interface is enabled for this repository.1026 See linkgit:git-cvsserver[1].10271028gitcvs.logfile::1029 Path to a log file where the CVS server interface well... logs1030 various stuff. See linkgit:git-cvsserver[1].10311032gitcvs.usecrlfattr::1033 If true, the server will look up the end-of-line conversion1034 attributes for files to determine the '-k' modes to use. If1035 the attributes force git to treat a file as text,1036 the '-k' mode will be left blank so CVS clients will1037 treat it as text. If they suppress text conversion, the file1038 will be set with '-kb' mode, which suppresses any newline munging1039 the client might otherwise do. If the attributes do not allow1040 the file type to be determined, then 'gitcvs.allbinary' is1041 used. See linkgit:gitattributes[5].10421043gitcvs.allbinary::1044 This is used if 'gitcvs.usecrlfattr' does not resolve1045 the correct '-kb' mode to use. If true, all1046 unresolved files are sent to the client in1047 mode '-kb'. This causes the client to treat them1048 as binary files, which suppresses any newline munging it1049 otherwise might do. Alternatively, if it is set to "guess",1050 then the contents of the file are examined to decide if1051 it is binary, similar to 'core.autocrlf'.10521053gitcvs.dbname::1054 Database used by git-cvsserver to cache revision information1055 derived from the git repository. The exact meaning depends on the1056 used database driver, for SQLite (which is the default driver) this1057 is a filename. Supports variable substitution (see1058 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1059 Default: '%Ggitcvs.%m.sqlite'10601061gitcvs.dbdriver::1062 Used Perl DBI driver. You can specify any available driver1063 for this here, but it might not work. git-cvsserver is tested1064 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1065 reported *not* to work with 'DBD::mysql'. Experimental feature.1066 May not contain double colons (`:`). Default: 'SQLite'.1067 See linkgit:git-cvsserver[1].10681069gitcvs.dbuser, gitcvs.dbpass::1070 Database user and password. Only useful if setting 'gitcvs.dbdriver',1071 since SQLite has no concept of database users and/or passwords.1072 'gitcvs.dbuser' supports variable substitution (see1073 linkgit:git-cvsserver[1] for details).10741075gitcvs.dbTableNamePrefix::1076 Database table name prefix. Prepended to the names of any1077 database tables used, allowing a single database to be used1078 for several repositories. Supports variable substitution (see1079 linkgit:git-cvsserver[1] for details). Any non-alphabetic1080 characters will be replaced with underscores.10811082All gitcvs variables except for 'gitcvs.usecrlfattr' and1083'gitcvs.allbinary' can also be specified as1084'gitcvs.<access_method>.<varname>' (where 'access_method'1085is one of "ext" and "pserver") to make them apply only for the given1086access method.10871088gui.commitmsgwidth::1089 Defines how wide the commit message window is in the1090 linkgit:git-gui[1]. "75" is the default.10911092gui.diffcontext::1093 Specifies how many context lines should be used in calls to diff1094 made by the linkgit:git-gui[1]. The default is "5".10951096gui.encoding::1097 Specifies the default encoding to use for displaying of1098 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1099 It can be overridden by setting the 'encoding' attribute1100 for relevant files (see linkgit:gitattributes[5]).1101 If this option is not set, the tools default to the1102 locale encoding.11031104gui.matchtrackingbranch::1105 Determines if new branches created with linkgit:git-gui[1] should1106 default to tracking remote branches with matching names or1107 not. Default: "false".11081109gui.newbranchtemplate::1110 Is used as suggested name when creating new branches using the1111 linkgit:git-gui[1].11121113gui.pruneduringfetch::1114 "true" if linkgit:git-gui[1] should prune tracking branches when1115 performing a fetch. The default value is "false".11161117gui.trustmtime::1118 Determines if linkgit:git-gui[1] should trust the file modification1119 timestamp or not. By default the timestamps are not trusted.11201121gui.spellingdictionary::1122 Specifies the dictionary used for spell checking commit messages in1123 the linkgit:git-gui[1]. When set to "none" spell checking is turned1124 off.11251126gui.fastcopyblame::1127 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1128 location detection. It makes blame significantly faster on huge1129 repositories at the expense of less thorough copy detection.11301131gui.copyblamethreshold::1132 Specifies the threshold to use in 'git gui blame' original location1133 detection, measured in alphanumeric characters. See the1134 linkgit:git-blame[1] manual for more information on copy detection.11351136gui.blamehistoryctx::1137 Specifies the radius of history context in days to show in1138 linkgit:gitk[1] for the selected commit, when the `Show History1139 Context` menu item is invoked from 'git gui blame'. If this1140 variable is set to zero, the whole history is shown.11411142guitool.<name>.cmd::1143 Specifies the shell command line to execute when the corresponding item1144 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1145 mandatory for every tool. The command is executed from the root of1146 the working directory, and in the environment it receives the name of1147 the tool as 'GIT_GUITOOL', the name of the currently selected file as1148 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1149 the head is detached, 'CUR_BRANCH' is empty).11501151guitool.<name>.needsfile::1152 Run the tool only if a diff is selected in the GUI. It guarantees1153 that 'FILENAME' is not empty.11541155guitool.<name>.noconsole::1156 Run the command silently, without creating a window to display its1157 output.11581159guitool.<name>.norescan::1160 Don't rescan the working directory for changes after the tool1161 finishes execution.11621163guitool.<name>.confirm::1164 Show a confirmation dialog before actually running the tool.11651166guitool.<name>.argprompt::1167 Request a string argument from the user, and pass it to the tool1168 through the 'ARGS' environment variable. Since requesting an1169 argument implies confirmation, the 'confirm' option has no effect1170 if this is enabled. If the option is set to 'true', 'yes', or '1',1171 the dialog uses a built-in generic prompt; otherwise the exact1172 value of the variable is used.11731174guitool.<name>.revprompt::1175 Request a single valid revision from the user, and set the1176 'REVISION' environment variable. In other aspects this option1177 is similar to 'argprompt', and can be used together with it.11781179guitool.<name>.revunmerged::1180 Show only unmerged branches in the 'revprompt' subdialog.1181 This is useful for tools similar to merge or rebase, but not1182 for things like checkout or reset.11831184guitool.<name>.title::1185 Specifies the title to use for the prompt dialog. The default1186 is the tool name.11871188guitool.<name>.prompt::1189 Specifies the general prompt string to display at the top of1190 the dialog, before subsections for 'argprompt' and 'revprompt'.1191 The default value includes the actual command.11921193help.browser::1194 Specify the browser that will be used to display help in the1195 'web' format. See linkgit:git-help[1].11961197help.format::1198 Override the default help format used by linkgit:git-help[1].1199 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1200 the default. 'web' and 'html' are the same.12011202help.autocorrect::1203 Automatically correct and execute mistyped commands after1204 waiting for the given number of deciseconds (0.1 sec). If more1205 than one command can be deduced from the entered text, nothing1206 will be executed. If the value of this option is negative,1207 the corrected command will be executed immediately. If the1208 value is 0 - the command will be just shown but not executed.1209 This is the default.12101211http.proxy::1212 Override the HTTP proxy, normally configured using the 'http_proxy'1213 environment variable (see linkgit:curl[1]). This can be overridden1214 on a per-remote basis; see remote.<name>.proxy12151216http.sslVerify::1217 Whether to verify the SSL certificate when fetching or pushing1218 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1219 variable.12201221http.sslCert::1222 File containing the SSL certificate when fetching or pushing1223 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1224 variable.12251226http.sslKey::1227 File containing the SSL private key when fetching or pushing1228 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1229 variable.12301231http.sslCertPasswordProtected::1232 Enable git's password prompt for the SSL certificate. Otherwise1233 OpenSSL will prompt the user, possibly many times, if the1234 certificate or private key is encrypted. Can be overridden by the1235 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.12361237http.sslCAInfo::1238 File containing the certificates to verify the peer with when1239 fetching or pushing over HTTPS. Can be overridden by the1240 'GIT_SSL_CAINFO' environment variable.12411242http.sslCAPath::1243 Path containing files with the CA certificates to verify the peer1244 with when fetching or pushing over HTTPS. Can be overridden1245 by the 'GIT_SSL_CAPATH' environment variable.12461247http.maxRequests::1248 How many HTTP requests to launch in parallel. Can be overridden1249 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12501251http.minSessions::1252 The number of curl sessions (counted across slots) to be kept across1253 requests. They will not be ended with curl_easy_cleanup() until1254 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1255 value will be capped at 1. Defaults to 1.12561257http.postBuffer::1258 Maximum size in bytes of the buffer used by smart HTTP1259 transports when POSTing data to the remote system.1260 For requests larger than this buffer size, HTTP/1.1 and1261 Transfer-Encoding: chunked is used to avoid creating a1262 massive pack file locally. Default is 1 MiB, which is1263 sufficient for most requests.12641265http.lowSpeedLimit, http.lowSpeedTime::1266 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1267 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1268 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1269 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12701271http.noEPSV::1272 A boolean which disables using of EPSV ftp command by curl.1273 This can helpful with some "poor" ftp servers which don't1274 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1275 environment variable. Default is false (curl will use EPSV).12761277http.useragent::1278 The HTTP USER_AGENT string presented to an HTTP server. The default1279 value represents the version of the client git such as git/1.7.1.1280 This option allows you to override this value to a more common value1281 such as Mozilla/4.0. This may be necessary, for instance, if1282 connecting through a firewall that restricts HTTP connections to a set1283 of common USER_AGENT strings (but not including those like git/1.7.1).1284 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.12851286i18n.commitEncoding::1287 Character encoding the commit messages are stored in; git itself1288 does not care per se, but this information is necessary e.g. when1289 importing commits from emails or in the gitk graphical history1290 browser (and possibly at other places in the future or in other1291 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12921293i18n.logOutputEncoding::1294 Character encoding the commit messages are converted to when1295 running 'git log' and friends.12961297imap::1298 The configuration variables in the 'imap' section are described1299 in linkgit:git-imap-send[1].13001301init.templatedir::1302 Specify the directory from which templates will be copied.1303 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)13041305instaweb.browser::1306 Specify the program that will be used to browse your working1307 repository in gitweb. See linkgit:git-instaweb[1].13081309instaweb.httpd::1310 The HTTP daemon command-line to start gitweb on your working1311 repository. See linkgit:git-instaweb[1].13121313instaweb.local::1314 If true the web server started by linkgit:git-instaweb[1] will1315 be bound to the local IP (127.0.0.1).13161317instaweb.modulepath::1318 The default module path for linkgit:git-instaweb[1] to use1319 instead of /usr/lib/apache2/modules. Only used if httpd1320 is Apache.13211322instaweb.port::1323 The port number to bind the gitweb httpd to. See1324 linkgit:git-instaweb[1].13251326interactive.singlekey::1327 In interactive commands, allow the user to provide one-letter1328 input with a single key (i.e., without hitting enter).1329 Currently this is used only by the `\--patch` mode of1330 linkgit:git-add[1]. Note that this setting is silently1331 ignored if portable keystroke input is not available.13321333log.date::1334 Set the default date-time mode for the 'log' command.1335 Setting a value for log.date is similar to using 'git log''s1336 `\--date` option. Possible values are `relative`, `local`,1337 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1338 for details.13391340log.decorate::1341 Print out the ref names of any commits that are shown by the log1342 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1343 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1344 specified, the full ref name (including prefix) will be printed.1345 This is the same as the log commands '--decorate' option.13461347log.showroot::1348 If true, the initial commit will be shown as a big creation event.1349 This is equivalent to a diff against an empty tree.1350 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1351 normally hide the root commit will now show it. True by default.13521353mailmap.file::1354 The location of an augmenting mailmap file. The default1355 mailmap, located in the root of the repository, is loaded1356 first, then the mailmap file pointed to by this variable.1357 The location of the mailmap file may be in a repository1358 subdirectory, or somewhere outside of the repository itself.1359 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13601361man.viewer::1362 Specify the programs that may be used to display help in the1363 'man' format. See linkgit:git-help[1].13641365man.<tool>.cmd::1366 Specify the command to invoke the specified man viewer. The1367 specified command is evaluated in shell with the man page1368 passed as argument. (See linkgit:git-help[1].)13691370man.<tool>.path::1371 Override the path for the given tool that may be used to1372 display help in the 'man' format. See linkgit:git-help[1].13731374include::merge-config.txt[]13751376mergetool.<tool>.path::1377 Override the path for the given tool. This is useful in case1378 your tool is not in the PATH.13791380mergetool.<tool>.cmd::1381 Specify the command to invoke the specified merge tool. The1382 specified command is evaluated in shell with the following1383 variables available: 'BASE' is the name of a temporary file1384 containing the common base of the files to be merged, if available;1385 'LOCAL' is the name of a temporary file containing the contents of1386 the file on the current branch; 'REMOTE' is the name of a temporary1387 file containing the contents of the file from the branch being1388 merged; 'MERGED' contains the name of the file to which the merge1389 tool should write the results of a successful merge.13901391mergetool.<tool>.trustExitCode::1392 For a custom merge command, specify whether the exit code of1393 the merge command can be used to determine whether the merge was1394 successful. If this is not set to true then the merge target file1395 timestamp is checked and the merge assumed to have been successful1396 if the file has been updated, otherwise the user is prompted to1397 indicate the success of the merge.13981399mergetool.keepBackup::1400 After performing a merge, the original file with conflict markers1401 can be saved as a file with a `.orig` extension. If this variable1402 is set to `false` then this file is not preserved. Defaults to1403 `true` (i.e. keep the backup files).14041405mergetool.keepTemporaries::1406 When invoking a custom merge tool, git uses a set of temporary1407 files to pass to the tool. If the tool returns an error and this1408 variable is set to `true`, then these temporary files will be1409 preserved, otherwise they will be removed after the tool has1410 exited. Defaults to `false`.14111412mergetool.prompt::1413 Prompt before each invocation of the merge resolution program.14141415notes.displayRef::1416 The (fully qualified) refname from which to show notes when1417 showing commit messages. The value of this variable can be set1418 to a glob, in which case notes from all matching refs will be1419 shown. You may also specify this configuration variable1420 several times. A warning will be issued for refs that do not1421 exist, but a glob that does not match any refs is silently1422 ignored.1423+1424This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1425environment variable, which must be a colon separated list of refs or1426globs.1427+1428The effective value of "core.notesRef" (possibly overridden by1429GIT_NOTES_REF) is also implicitly added to the list of refs to be1430displayed.14311432notes.rewrite.<command>::1433 When rewriting commits with <command> (currently `amend` or1434 `rebase`) and this variable is set to `true`, git1435 automatically copies your notes from the original to the1436 rewritten commit. Defaults to `true`, but see1437 "notes.rewriteRef" below.14381439notes.rewriteMode::1440 When copying notes during a rewrite (see the1441 "notes.rewrite.<command>" option), determines what to do if1442 the target commit already has a note. Must be one of1443 `overwrite`, `concatenate`, or `ignore`. Defaults to1444 `concatenate`.1445+1446This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1447environment variable.14481449notes.rewriteRef::1450 When copying notes during a rewrite, specifies the (fully1451 qualified) ref whose notes should be copied. The ref may be a1452 glob, in which case notes in all matching refs will be copied.1453 You may also specify this configuration several times.1454+1455Does not have a default value; you must configure this variable to1456enable note rewriting.1457+1458This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1459environment variable, which must be a colon separated list of refs or1460globs.14611462pack.window::1463 The size of the window used by linkgit:git-pack-objects[1] when no1464 window size is given on the command line. Defaults to 10.14651466pack.depth::1467 The maximum delta depth used by linkgit:git-pack-objects[1] when no1468 maximum depth is given on the command line. Defaults to 50.14691470pack.windowMemory::1471 The window memory size limit used by linkgit:git-pack-objects[1]1472 when no limit is given on the command line. The value can be1473 suffixed with "k", "m", or "g". Defaults to 0, meaning no1474 limit.14751476pack.compression::1477 An integer -1..9, indicating the compression level for objects1478 in a pack file. -1 is the zlib default. 0 means no1479 compression, and 1..9 are various speed/size tradeoffs, 9 being1480 slowest. If not set, defaults to core.compression. If that is1481 not set, defaults to -1, the zlib default, which is "a default1482 compromise between speed and compression (currently equivalent1483 to level 6)."1484+1485Note that changing the compression level will not automatically recompress1486all existing objects. You can force recompression by passing the -F option1487to linkgit:git-repack[1].14881489pack.deltaCacheSize::1490 The maximum memory in bytes used for caching deltas in1491 linkgit:git-pack-objects[1] before writing them out to a pack.1492 This cache is used to speed up the writing object phase by not1493 having to recompute the final delta result once the best match1494 for all objects is found. Repacking large repositories on machines1495 which are tight with memory might be badly impacted by this though,1496 especially if this cache pushes the system into swapping.1497 A value of 0 means no limit. The smallest size of 1 byte may be1498 used to virtually disable this cache. Defaults to 256 MiB.14991500pack.deltaCacheLimit::1501 The maximum size of a delta, that is cached in1502 linkgit:git-pack-objects[1]. This cache is used to speed up the1503 writing object phase by not having to recompute the final delta1504 result once the best match for all objects is found. Defaults to 1000.15051506pack.threads::1507 Specifies the number of threads to spawn when searching for best1508 delta matches. This requires that linkgit:git-pack-objects[1]1509 be compiled with pthreads otherwise this option is ignored with a1510 warning. This is meant to reduce packing time on multiprocessor1511 machines. The required amount of memory for the delta search window1512 is however multiplied by the number of threads.1513 Specifying 0 will cause git to auto-detect the number of CPU's1514 and set the number of threads accordingly.15151516pack.indexVersion::1517 Specify the default pack index version. Valid values are 1 for1518 legacy pack index used by Git versions prior to 1.5.2, and 2 for1519 the new pack index with capabilities for packs larger than 4 GB1520 as well as proper protection against the repacking of corrupted1521 packs. Version 2 is the default. Note that version 2 is enforced1522 and this config option ignored whenever the corresponding pack is1523 larger than 2 GB.1524+1525If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1526cloning or fetching over a non native protocol (e.g. "http" and "rsync")1527that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1528other side may give you a repository that cannot be accessed with your1529older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1530you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1531the `{asterisk}.idx` file.15321533pack.packSizeLimit::1534 The maximum size of a pack. This setting only affects1535 packing to a file when repacking, i.e. the git:// protocol1536 is unaffected. It can be overridden by the `\--max-pack-size`1537 option of linkgit:git-repack[1]. The minimum size allowed is1538 limited to 1 MiB. The default is unlimited.1539 Common unit suffixes of 'k', 'm', or 'g' are1540 supported.15411542pager.<cmd>::1543 Allows turning on or off pagination of the output of a1544 particular git subcommand when writing to a tty. If1545 `\--paginate` or `\--no-pager` is specified on the command line,1546 it takes precedence over this option. To disable pagination for1547 all commands, set `core.pager` or `GIT_PAGER` to `cat`.15481549pretty.<name>::1550 Alias for a --pretty= format string, as specified in1551 linkgit:git-log[1]. Any aliases defined here can be used just1552 as the built-in pretty formats could. For example,1553 running `git config pretty.changelog "format:{asterisk} %H %s"`1554 would cause the invocation `git log --pretty=changelog`1555 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1556 Note that an alias with the same name as a built-in format1557 will be silently ignored.15581559pull.octopus::1560 The default merge strategy to use when pulling multiple branches1561 at once.15621563pull.twohead::1564 The default merge strategy to use when pulling a single branch.15651566push.default::1567 Defines the action git push should take if no refspec is given1568 on the command line, no refspec is configured in the remote, and1569 no refspec is implied by any of the options given on the command1570 line. Possible values are:1571+1572* `nothing` - do not push anything.1573* `matching` - push all matching branches.1574 All branches having the same name in both ends are considered to be1575 matching. This is the default.1576* `tracking` - push the current branch to its upstream branch.1577* `current` - push the current branch to a branch of the same name.15781579rebase.stat::1580 Whether to show a diffstat of what changed upstream since the last1581 rebase. False by default.15821583rebase.autosquash::1584 If set to true enable '--autosquash' option by default.15851586receive.autogc::1587 By default, git-receive-pack will run "git-gc --auto" after1588 receiving data from git-push and updating refs. You can stop1589 it by setting this variable to false.15901591receive.fsckObjects::1592 If it is set to true, git-receive-pack will check all received1593 objects. It will abort in the case of a malformed object or a1594 broken link. The result of an abort are only dangling objects.1595 Defaults to false.15961597receive.unpackLimit::1598 If the number of objects received in a push is below this1599 limit then the objects will be unpacked into loose object1600 files. However if the number of received objects equals or1601 exceeds this limit then the received pack will be stored as1602 a pack, after adding any missing delta bases. Storing the1603 pack from a push can make the push operation complete faster,1604 especially on slow filesystems. If not set, the value of1605 `transfer.unpackLimit` is used instead.16061607receive.denyDeletes::1608 If set to true, git-receive-pack will deny a ref update that deletes1609 the ref. Use this to prevent such a ref deletion via a push.16101611receive.denyDeleteCurrent::1612 If set to true, git-receive-pack will deny a ref update that1613 deletes the currently checked out branch of a non-bare repository.16141615receive.denyCurrentBranch::1616 If set to true or "refuse", git-receive-pack will deny a ref update1617 to the currently checked out branch of a non-bare repository.1618 Such a push is potentially dangerous because it brings the HEAD1619 out of sync with the index and working tree. If set to "warn",1620 print a warning of such a push to stderr, but allow the push to1621 proceed. If set to false or "ignore", allow such pushes with no1622 message. Defaults to "refuse".16231624receive.denyNonFastForwards::1625 If set to true, git-receive-pack will deny a ref update which is1626 not a fast-forward. Use this to prevent such an update via a push,1627 even if that push is forced. This configuration variable is1628 set when initializing a shared repository.16291630receive.updateserverinfo::1631 If set to true, git-receive-pack will run git-update-server-info1632 after receiving data from git-push and updating refs.16331634remote.<name>.url::1635 The URL of a remote repository. See linkgit:git-fetch[1] or1636 linkgit:git-push[1].16371638remote.<name>.pushurl::1639 The push URL of a remote repository. See linkgit:git-push[1].16401641remote.<name>.proxy::1642 For remotes that require curl (http, https and ftp), the URL to1643 the proxy to use for that remote. Set to the empty string to1644 disable proxying for that remote.16451646remote.<name>.fetch::1647 The default set of "refspec" for linkgit:git-fetch[1]. See1648 linkgit:git-fetch[1].16491650remote.<name>.push::1651 The default set of "refspec" for linkgit:git-push[1]. See1652 linkgit:git-push[1].16531654remote.<name>.mirror::1655 If true, pushing to this remote will automatically behave1656 as if the `\--mirror` option was given on the command line.16571658remote.<name>.skipDefaultUpdate::1659 If true, this remote will be skipped by default when updating1660 using linkgit:git-fetch[1] or the `update` subcommand of1661 linkgit:git-remote[1].16621663remote.<name>.skipFetchAll::1664 If true, this remote will be skipped by default when updating1665 using linkgit:git-fetch[1] or the `update` subcommand of1666 linkgit:git-remote[1].16671668remote.<name>.receivepack::1669 The default program to execute on the remote side when pushing. See1670 option \--receive-pack of linkgit:git-push[1].16711672remote.<name>.uploadpack::1673 The default program to execute on the remote side when fetching. See1674 option \--upload-pack of linkgit:git-fetch-pack[1].16751676remote.<name>.tagopt::1677 Setting this value to \--no-tags disables automatic tag following when1678 fetching from remote <name>. Setting it to \--tags will fetch every1679 tag from remote <name>, even if they are not reachable from remote1680 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1681 override this setting. See options \--tags and \--no-tags of1682 linkgit:git-fetch[1].16831684remote.<name>.vcs::1685 Setting this to a value <vcs> will cause git to interact with1686 the remote with the git-remote-<vcs> helper.16871688remotes.<group>::1689 The list of remotes which are fetched by "git remote update1690 <group>". See linkgit:git-remote[1].16911692repack.usedeltabaseoffset::1693 By default, linkgit:git-repack[1] creates packs that use1694 delta-base offset. If you need to share your repository with1695 git older than version 1.4.4, either directly or via a dumb1696 protocol such as http, then you need to set this option to1697 "false" and repack. Access from old git versions over the1698 native protocol are unaffected by this option.16991700rerere.autoupdate::1701 When set to true, `git-rerere` updates the index with the1702 resulting contents after it cleanly resolves conflicts using1703 previously recorded resolution. Defaults to false.17041705rerere.enabled::1706 Activate recording of resolved conflicts, so that identical1707 conflict hunks can be resolved automatically, should they1708 be encountered again. linkgit:git-rerere[1] command is by1709 default enabled if you create `rr-cache` directory under1710 `$GIT_DIR`, but can be disabled by setting this option to false.17111712sendemail.identity::1713 A configuration identity. When given, causes values in the1714 'sendemail.<identity>' subsection to take precedence over1715 values in the 'sendemail' section. The default identity is1716 the value of 'sendemail.identity'.17171718sendemail.smtpencryption::1719 See linkgit:git-send-email[1] for description. Note that this1720 setting is not subject to the 'identity' mechanism.17211722sendemail.smtpssl::1723 Deprecated alias for 'sendemail.smtpencryption = ssl'.17241725sendemail.<identity>.*::1726 Identity-specific versions of the 'sendemail.*' parameters1727 found below, taking precedence over those when the this1728 identity is selected, through command-line or1729 'sendemail.identity'.17301731sendemail.aliasesfile::1732sendemail.aliasfiletype::1733sendemail.bcc::1734sendemail.cc::1735sendemail.cccmd::1736sendemail.chainreplyto::1737sendemail.confirm::1738sendemail.envelopesender::1739sendemail.from::1740sendemail.multiedit::1741sendemail.signedoffbycc::1742sendemail.smtppass::1743sendemail.suppresscc::1744sendemail.suppressfrom::1745sendemail.to::1746sendemail.smtpdomain::1747sendemail.smtpserver::1748sendemail.smtpserverport::1749sendemail.smtpserveroption::1750sendemail.smtpuser::1751sendemail.thread::1752sendemail.validate::1753 See linkgit:git-send-email[1] for description.17541755sendemail.signedoffcc::1756 Deprecated alias for 'sendemail.signedoffbycc'.17571758showbranch.default::1759 The default set of branches for linkgit:git-show-branch[1].1760 See linkgit:git-show-branch[1].17611762status.relativePaths::1763 By default, linkgit:git-status[1] shows paths relative to the1764 current directory. Setting this variable to `false` shows paths1765 relative to the repository root (this was the default for git1766 prior to v1.5.4).17671768status.showUntrackedFiles::1769 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1770 files which are not currently tracked by Git. Directories which1771 contain only untracked files, are shown with the directory name1772 only. Showing untracked files means that Git needs to lstat() all1773 all the files in the whole repository, which might be slow on some1774 systems. So, this variable controls how the commands displays1775 the untracked files. Possible values are:1776+1777--1778* `no` - Show no untracked files.1779* `normal` - Show untracked files and directories.1780* `all` - Show also individual files in untracked directories.1781--1782+1783If this variable is not specified, it defaults to 'normal'.1784This variable can be overridden with the -u|--untracked-files option1785of linkgit:git-status[1] and linkgit:git-commit[1].17861787status.submodulesummary::1788 Defaults to false.1789 If this is set to a non zero number or true (identical to -1 or an1790 unlimited number), the submodule summary will be enabled and a1791 summary of commits for modified submodules will be shown (see1792 --summary-limit option of linkgit:git-submodule[1]).17931794submodule.<name>.path::1795submodule.<name>.url::1796submodule.<name>.update::1797 The path within this project, URL, and the updating strategy1798 for a submodule. These variables are initially populated1799 by 'git submodule init'; edit them to override the1800 URL and other values found in the `.gitmodules` file. See1801 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.18021803submodule.<name>.ignore::1804 Defines under what circumstances "git status" and the diff family show1805 a submodule as modified. When set to "all", it will never be considered1806 modified, "dirty" will ignore all changes to the submodules work tree and1807 takes only differences between the HEAD of the submodule and the commit1808 recorded in the superproject into account. "untracked" will additionally1809 let submodules with modified tracked files in their work tree show up.1810 Using "none" (the default when this option is not set) also shows1811 submodules that have untracked files in their work tree as changed.1812 This setting overrides any setting made in .gitmodules for this submodule,1813 both settings can be overridden on the command line by using the1814 "--ignore-submodules" option.18151816tar.umask::1817 This variable can be used to restrict the permission bits of1818 tar archive entries. The default is 0002, which turns off the1819 world write bit. The special value "user" indicates that the1820 archiving user's umask will be used instead. See umask(2) and1821 linkgit:git-archive[1].18221823transfer.unpackLimit::1824 When `fetch.unpackLimit` or `receive.unpackLimit` are1825 not set, the value of this variable is used instead.1826 The default value is 100.18271828url.<base>.insteadOf::1829 Any URL that starts with this value will be rewritten to1830 start, instead, with <base>. In cases where some site serves a1831 large number of repositories, and serves them with multiple1832 access methods, and some users need to use different access1833 methods, this feature allows people to specify any of the1834 equivalent URLs and have git automatically rewrite the URL to1835 the best alternative for the particular user, even for a1836 never-before-seen repository on the site. When more than one1837 insteadOf strings match a given URL, the longest match is used.18381839url.<base>.pushInsteadOf::1840 Any URL that starts with this value will not be pushed to;1841 instead, it will be rewritten to start with <base>, and the1842 resulting URL will be pushed to. In cases where some site serves1843 a large number of repositories, and serves them with multiple1844 access methods, some of which do not allow push, this feature1845 allows people to specify a pull-only URL and have git1846 automatically use an appropriate URL to push, even for a1847 never-before-seen repository on the site. When more than one1848 pushInsteadOf strings match a given URL, the longest match is1849 used. If a remote has an explicit pushurl, git will ignore this1850 setting for that remote.18511852user.email::1853 Your email address to be recorded in any newly created commits.1854 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1855 'EMAIL' environment variables. See linkgit:git-commit-tree[1].18561857user.name::1858 Your full name to be recorded in any newly created commits.1859 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1860 environment variables. See linkgit:git-commit-tree[1].18611862user.signingkey::1863 If linkgit:git-tag[1] is not selecting the key you want it to1864 automatically when creating a signed tag, you can override the1865 default selection with this variable. This option is passed1866 unchanged to gpg's --local-user parameter, so you may specify a key1867 using any method that gpg supports.18681869web.browser::1870 Specify a web browser that may be used by some commands.1871 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1872 may use it.