1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive and only alphanumeric 16characters are allowed. Some variables may appear multiple times. 17 18Syntax 19~~~~~~ 20 21The syntax is fairly flexible and permissive; whitespaces are mostly 22ignored. The '#' and ';' characters begin comments to the end of line, 23blank lines are ignored. 24 25The file consists of sections and variables. A section begins with 26the name of the section in square brackets and continues until the next 27section begins. Section names are not case sensitive. Only alphanumeric 28characters, `-` and `.` are allowed in section names. Each variable 29must belong to some section, which means that there must be a section 30header before the first setting of a variable. 31 32Sections can be further divided into subsections. To begin a subsection 33put its name in double quotes, separated by space from the section name, 34in the section header, like in the example below: 35 36-------- 37 [section "subsection"] 38 39-------- 40 41Subsection names are case sensitive and can contain any characters except 42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 43respectively). Section headers cannot span multiple 44lines. Variables may belong directly to a section or to a given subsection. 45You can have `[section]` if you have `[section "subsection"]`, but you 46don't need to. 47 48There is also a case insensitive alternative `[section.subsection]` syntax. 49In this syntax, subsection names follow the same restrictions as for section 50names. 51 52All the other lines (and the remainder of the line after the section 53header) are recognized as setting variables, in the form 54'name = value'. If there is no equal sign on the line, the entire line 55is taken as 'name' and the variable is recognized as boolean "true". 56The variable names are case-insensitive and only alphanumeric 57characters and `-` are allowed. There can be more than one value 58for a given variable; we say then that variable is multivalued. 59 60Leading and trailing whitespace in a variable value is discarded. 61Internal whitespace within a variable value is retained verbatim. 62 63The values following the equals sign in variable assign are all either 64a string, an integer, or a boolean. Boolean values may be given as yes/no, 650/1, true/false or on/off. Case is not significant in boolean values, when 66converting value to the canonical form using '--bool' type specifier; 67'git config' will ensure that the output is "true" or "false". 68 69String values may be entirely or partially enclosed in double quotes. 70You need to enclose variable values in double quotes if you want to 71preserve leading or trailing whitespace, or if the variable value contains 72comment characters (i.e. it contains '#' or ';'). 73Double quote `"` and backslash `\` characters in variable values must 74be escaped: use `\"` for `"` and `\\` for `\`. 75 76The following escape sequences (beside `\"` and `\\`) are recognized: 77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 78and `\b` for backspace (BS). No other char escape sequence, nor octal 79char sequences are valid. 80 81Variable values ending in a `\` are continued on the next line in the 82customary UNIX fashion. 83 84Some variables may require a special value format. 85 86Example 87~~~~~~~ 88 89 # Core variables 90 [core] 91 ; Don't trust file modes 92 filemode = false 93 94 # Our diff algorithm 95 [diff] 96 external = /usr/local/bin/diff-wrapper 97 renames = true 98 99 [branch "devel"] 100 remote = origin 101 merge = refs/heads/devel 102 103 # Proxy settings 104 [core] 105 gitProxy="ssh" for "kernel.org" 106 gitProxy=default-proxy ; for the rest 107 108Variables 109~~~~~~~~~ 110 111Note that this list is non-comprehensive and not necessarily complete. 112For command-specific variables, you will find a more detailed description 113in the appropriate manual page. You will find a description of non-core 114porcelain configuration variables in the respective porcelain documentation. 115 116advice.*:: 117 When set to 'true', display the given optional help message. 118 When set to 'false', do not display. The configuration variables 119 are: 120+ 121-- 122 pushNonFastForward:: 123 Advice shown when linkgit:git-push[1] refuses 124 non-fast-forward refs. Default: true. 125 statusHints:: 126 Directions on how to stage/unstage/add shown in the 127 output of linkgit:git-status[1] and the template shown 128 when writing commit messages. Default: true. 129 commitBeforeMerge:: 130 Advice shown when linkgit:git-merge[1] refuses to 131 merge to avoid overwriting local changes. 132 Default: true. 133 resolveConflict:: 134 Advices shown by various commands when conflicts 135 prevent the operation from being performed. 136 Default: true. 137 implicitIdentity:: 138 Advice on how to set your identity configuration when 139 your information is guessed from the system username and 140 domain name. Default: true. 141 142 detachedHead:: 143 Advice shown when you used linkgit::git-checkout[1] to 144 move to the detach HEAD state, to instruct how to create 145 a local branch after the fact. Default: true. 146-- 147 148core.fileMode:: 149 If false, the executable bit differences between the index and 150 the working copy are ignored; useful on broken filesystems like FAT. 151 See linkgit:git-update-index[1]. 152+ 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 154will probe and set core.fileMode false if appropriate when the 155repository is created. 156 157core.ignoreCygwinFSTricks:: 158 This option is only used by Cygwin implementation of Git. If false, 159 the Cygwin stat() and lstat() functions are used. This may be useful 160 if your repository consists of a few separate directories joined in 161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 162 whenever it is possible and falls back to Cygwin functions only to 163 handle symbol links. The native mode is more than twice faster than 164 normal Cygwin l/stat() functions. True by default, unless core.filemode 165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 166 POSIX emulation is required to support core.filemode. 167 168core.ignorecase:: 169 If true, this option enables various workarounds to enable 170 git to work better on filesystems that are not case sensitive, 171 like FAT. For example, if a directory listing finds 172 "makefile" when git expects "Makefile", git will assume 173 it is really the same file, and continue to remember it as 174 "Makefile". 175+ 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 177will probe and set core.ignorecase true if appropriate when the repository 178is created. 179 180core.trustctime:: 181 If false, the ctime differences between the index and the 182 working copy are ignored; useful when the inode change time 183 is regularly modified by something outside Git (file system 184 crawlers and some backup systems). 185 See linkgit:git-update-index[1]. True by default. 186 187core.quotepath:: 188 The commands that output paths (e.g. 'ls-files', 189 'diff'), when not given the `-z` option, will quote 190 "unusual" characters in the pathname by enclosing the 191 pathname in a double-quote pair and with backslashes the 192 same way strings in C source code are quoted. If this 193 variable is set to false, the bytes higher than 0x80 are 194 not quoted but output as verbatim. Note that double 195 quote, backslash and control characters are always 196 quoted without `-z` regardless of the setting of this 197 variable. 198 199core.eol:: 200 Sets the line ending type to use in the working directory for 201 files that have the `text` property set. Alternatives are 202 'lf', 'crlf' and 'native', which uses the platform's native 203 line ending. The default value is `native`. See 204 linkgit:gitattributes[5] for more information on end-of-line 205 conversion. 206 207core.safecrlf:: 208 If true, makes git check if converting `CRLF` is reversible when 209 end-of-line conversion is active. Git will verify if a command 210 modifies a file in the work tree either directly or indirectly. 211 For example, committing a file followed by checking out the 212 same file should yield the original file in the work tree. If 213 this is not the case for the current setting of 214 `core.autocrlf`, git will reject the file. The variable can 215 be set to "warn", in which case git will only warn about an 216 irreversible conversion but continue the operation. 217+ 218CRLF conversion bears a slight chance of corrupting data. 219When it is enabled, git will convert CRLF to LF during commit and LF to 220CRLF during checkout. A file that contains a mixture of LF and 221CRLF before the commit cannot be recreated by git. For text 222files this is the right thing to do: it corrects line endings 223such that we have only LF line endings in the repository. 224But for binary files that are accidentally classified as text the 225conversion can corrupt data. 226+ 227If you recognize such corruption early you can easily fix it by 228setting the conversion type explicitly in .gitattributes. Right 229after committing you still have the original file in your work 230tree and this file is not yet corrupted. You can explicitly tell 231git that this file is binary and git will handle the file 232appropriately. 233+ 234Unfortunately, the desired effect of cleaning up text files with 235mixed line endings and the undesired effect of corrupting binary 236files cannot be distinguished. In both cases CRLFs are removed 237in an irreversible way. For text files this is the right thing 238to do because CRLFs are line endings, while for binary files 239converting CRLFs corrupts data. 240+ 241Note, this safety check does not mean that a checkout will generate a 242file identical to the original file for a different setting of 243`core.eol` and `core.autocrlf`, but only for the current one. For 244example, a text file with `LF` would be accepted with `core.eol=lf` 245and could later be checked out with `core.eol=crlf`, in which case the 246resulting file would contain `CRLF`, although the original file 247contained `LF`. However, in both work trees the line endings would be 248consistent, that is either all `LF` or all `CRLF`, but never mixed. A 249file with mixed line endings would be reported by the `core.safecrlf` 250mechanism. 251 252core.autocrlf:: 253 Setting this variable to "true" is almost the same as setting 254 the `text` attribute to "auto" on all files except that text 255 files are not guaranteed to be normalized: files that contain 256 `CRLF` in the repository will not be touched. Use this 257 setting if you want to have `CRLF` line endings in your 258 working directory even though the repository does not have 259 normalized line endings. This variable can be set to 'input', 260 in which case no output conversion is performed. 261 262core.symlinks:: 263 If false, symbolic links are checked out as small plain files that 264 contain the link text. linkgit:git-update-index[1] and 265 linkgit:git-add[1] will not change the recorded type to regular 266 file. Useful on filesystems like FAT that do not support 267 symbolic links. 268+ 269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 270will probe and set core.symlinks false if appropriate when the repository 271is created. 272 273core.gitProxy:: 274 A "proxy command" to execute (as 'command host port') instead 275 of establishing direct connection to the remote server when 276 using the git protocol for fetching. If the variable value is 277 in the "COMMAND for DOMAIN" format, the command is applied only 278 on hostnames ending with the specified domain string. This variable 279 may be set multiple times and is matched in the given order; 280 the first match wins. 281+ 282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 283(which always applies universally, without the special "for" 284handling). 285+ 286The special string `none` can be used as the proxy command to 287specify that no proxy be used for a given domain pattern. 288This is useful for excluding servers inside a firewall from 289proxy use, while defaulting to a common proxy for external domains. 290 291core.ignoreStat:: 292 If true, commands which modify both the working tree and the index 293 will mark the updated paths with the "assume unchanged" bit in the 294 index. These marked files are then assumed to stay unchanged in the 295 working copy, until you mark them otherwise manually - Git will not 296 detect the file changes by lstat() calls. This is useful on systems 297 where those are very slow, such as Microsoft Windows. 298 See linkgit:git-update-index[1]. 299 False by default. 300 301core.preferSymlinkRefs:: 302 Instead of the default "symref" format for HEAD 303 and other symbolic reference files, use symbolic links. 304 This is sometimes needed to work with old scripts that 305 expect HEAD to be a symbolic link. 306 307core.bare:: 308 If true this repository is assumed to be 'bare' and has no 309 working directory associated with it. If this is the case a 310 number of commands that require a working directory will be 311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 312+ 313This setting is automatically guessed by linkgit:git-clone[1] or 314linkgit:git-init[1] when the repository was created. By default a 315repository that ends in "/.git" is assumed to be not bare (bare = 316false), while all other repositories are assumed to be bare (bare 317= true). 318 319core.worktree:: 320 Set the path to the root of the work tree. 321 This can be overridden by the GIT_WORK_TREE environment 322 variable and the '--work-tree' command line option. It can be 323 an absolute path or a relative path to the .git directory, 324 either specified by --git-dir or GIT_DIR, or automatically 325 discovered. 326 If --git-dir or GIT_DIR are specified but none of 327 --work-tree, GIT_WORK_TREE and core.worktree is specified, 328 the current working directory is regarded as the root of the 329 work tree. 330+ 331Note that this variable is honored even when set in a configuration 332file in a ".git" subdirectory of a directory, and its value differs 333from the latter directory (e.g. "/path/to/.git/config" has 334core.worktree set to "/different/path"), which is most likely a 335misconfiguration. Running git commands in "/path/to" directory will 336still use "/different/path" as the root of the work tree and can cause 337great confusion to the users. 338 339core.logAllRefUpdates:: 340 Enable the reflog. Updates to a ref <ref> is logged to the file 341 "$GIT_DIR/logs/<ref>", by appending the new and old 342 SHA1, the date/time and the reason of the update, but 343 only when the file exists. If this configuration 344 variable is set to true, missing "$GIT_DIR/logs/<ref>" 345 file is automatically created for branch heads. 346+ 347This information can be used to determine what commit 348was the tip of a branch "2 days ago". 349+ 350This value is true by default in a repository that has 351a working directory associated with it, and false by 352default in a bare repository. 353 354core.repositoryFormatVersion:: 355 Internal variable identifying the repository format and layout 356 version. 357 358core.sharedRepository:: 359 When 'group' (or 'true'), the repository is made shareable between 360 several users in a group (making sure all the files and objects are 361 group-writable). When 'all' (or 'world' or 'everybody'), the 362 repository will be readable by all users, additionally to being 363 group-shareable. When 'umask' (or 'false'), git will use permissions 364 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 365 files in the repository will have this mode value. '0xxx' will override 366 user's umask value (whereas the other options will only override 367 requested parts of the user's umask value). Examples: '0660' will make 368 the repo read/write-able for the owner and group, but inaccessible to 369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 370 repository that is group-readable but not group-writable. 371 See linkgit:git-init[1]. False by default. 372 373core.warnAmbiguousRefs:: 374 If true, git will warn you if the ref name you passed it is ambiguous 375 and might match multiple refs in the .git/refs/ tree. True by default. 376 377core.compression:: 378 An integer -1..9, indicating a default compression level. 379 -1 is the zlib default. 0 means no compression, 380 and 1..9 are various speed/size tradeoffs, 9 being slowest. 381 If set, this provides a default to other compression variables, 382 such as 'core.loosecompression' and 'pack.compression'. 383 384core.loosecompression:: 385 An integer -1..9, indicating the compression level for objects that 386 are not in a pack file. -1 is the zlib default. 0 means no 387 compression, and 1..9 are various speed/size tradeoffs, 9 being 388 slowest. If not set, defaults to core.compression. If that is 389 not set, defaults to 1 (best speed). 390 391core.packedGitWindowSize:: 392 Number of bytes of a pack file to map into memory in a 393 single mapping operation. Larger window sizes may allow 394 your system to process a smaller number of large pack files 395 more quickly. Smaller window sizes will negatively affect 396 performance due to increased calls to the operating system's 397 memory manager, but may improve performance when accessing 398 a large number of large pack files. 399+ 400Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 401MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 402be reasonable for all users/operating systems. You probably do 403not need to adjust this value. 404+ 405Common unit suffixes of 'k', 'm', or 'g' are supported. 406 407core.packedGitLimit:: 408 Maximum number of bytes to map simultaneously into memory 409 from pack files. If Git needs to access more than this many 410 bytes at once to complete an operation it will unmap existing 411 regions to reclaim virtual address space within the process. 412+ 413Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 414This should be reasonable for all users/operating systems, except on 415the largest projects. You probably do not need to adjust this value. 416+ 417Common unit suffixes of 'k', 'm', or 'g' are supported. 418 419core.deltaBaseCacheLimit:: 420 Maximum number of bytes to reserve for caching base objects 421 that may be referenced by multiple deltified objects. By storing the 422 entire decompressed base objects in a cache Git is able 423 to avoid unpacking and decompressing frequently used base 424 objects multiple times. 425+ 426Default is 16 MiB on all platforms. This should be reasonable 427for all users/operating systems, except on the largest projects. 428You probably do not need to adjust this value. 429+ 430Common unit suffixes of 'k', 'm', or 'g' are supported. 431 432core.bigFileThreshold:: 433 Files larger than this size are stored deflated, without 434 attempting delta compression. Storing large files without 435 delta compression avoids excessive memory usage, at the 436 slight expense of increased disk usage. 437+ 438Default is 512 MiB on all platforms. This should be reasonable 439for most projects as source code and other text files can still 440be delta compressed, but larger binary media files won't be. 441+ 442Common unit suffixes of 'k', 'm', or 'g' are supported. 443+ 444Currently only linkgit:git-fast-import[1] honors this setting. 445 446core.excludesfile:: 447 In addition to '.gitignore' (per-directory) and 448 '.git/info/exclude', git looks into this file for patterns 449 of files which are not meant to be tracked. "{tilde}/" is expanded 450 to the value of `$HOME` and "{tilde}user/" to the specified user's 451 home directory. See linkgit:gitignore[5]. 452 453core.askpass:: 454 Some commands (e.g. svn and http interfaces) that interactively 455 ask for a password can be told to use an external program given 456 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 457 environment variable. If not set, fall back to the value of the 458 'SSH_ASKPASS' environment variable or, failing that, a simple password 459 prompt. The external program shall be given a suitable prompt as 460 command line argument and write the password on its STDOUT. 461 462core.attributesfile:: 463 In addition to '.gitattributes' (per-directory) and 464 '.git/info/attributes', git looks into this file for attributes 465 (see linkgit:gitattributes[5]). Path expansions are made the same 466 way as for `core.excludesfile`. 467 468core.editor:: 469 Commands such as `commit` and `tag` that lets you edit 470 messages by launching an editor uses the value of this 471 variable when it is set, and the environment variable 472 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 473 474core.pager:: 475 The command that git will use to paginate output. Can 476 be overridden with the `GIT_PAGER` environment 477 variable. Note that git sets the `LESS` environment 478 variable to `FRSX` if it is unset when it runs the 479 pager. One can change these settings by setting the 480 `LESS` variable to some other value. Alternately, 481 these settings can be overridden on a project or 482 global basis by setting the `core.pager` option. 483 Setting `core.pager` has no affect on the `LESS` 484 environment variable behaviour above, so if you want 485 to override git's default settings this way, you need 486 to be explicit. For example, to disable the S option 487 in a backward compatible manner, set `core.pager` 488 to `less -+$LESS -FRX`. This will be passed to the 489 shell by git, which will translate the final command to 490 `LESS=FRSX less -+FRSX -FRX`. 491 492core.whitespace:: 493 A comma separated list of common whitespace problems to 494 notice. 'git diff' will use `color.diff.whitespace` to 495 highlight them, and 'git apply --whitespace=error' will 496 consider them as errors. You can prefix `-` to disable 497 any of them (e.g. `-trailing-space`): 498+ 499* `blank-at-eol` treats trailing whitespaces at the end of the line 500 as an error (enabled by default). 501* `space-before-tab` treats a space character that appears immediately 502 before a tab character in the initial indent part of the line as an 503 error (enabled by default). 504* `indent-with-non-tab` treats a line that is indented with 8 or more 505 space characters as an error (not enabled by default). 506* `tab-in-indent` treats a tab character in the initial indent part of 507 the line as an error (not enabled by default). 508* `blank-at-eof` treats blank lines added at the end of file as an error 509 (enabled by default). 510* `trailing-space` is a short-hand to cover both `blank-at-eol` and 511 `blank-at-eof`. 512* `cr-at-eol` treats a carriage-return at the end of line as 513 part of the line terminator, i.e. with it, `trailing-space` 514 does not trigger if the character before such a carriage-return 515 is not a whitespace (not enabled by default). 516 517core.fsyncobjectfiles:: 518 This boolean will enable 'fsync()' when writing object files. 519+ 520This is a total waste of time and effort on a filesystem that orders 521data writes properly, but can be useful for filesystems that do not use 522journalling (traditional UNIX filesystems) or that only journal metadata 523and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 524 525core.preloadindex:: 526 Enable parallel index preload for operations like 'git diff' 527+ 528This can speed up operations like 'git diff' and 'git status' especially 529on filesystems like NFS that have weak caching semantics and thus 530relatively high IO latencies. With this set to 'true', git will do the 531index comparison to the filesystem data in parallel, allowing 532overlapping IO's. 533 534core.createObject:: 535 You can set this to 'link', in which case a hardlink followed by 536 a delete of the source are used to make sure that object creation 537 will not overwrite existing objects. 538+ 539On some file system/operating system combinations, this is unreliable. 540Set this config setting to 'rename' there; However, This will remove the 541check that makes sure that existing object files will not get overwritten. 542 543core.notesRef:: 544 When showing commit messages, also show notes which are stored in 545 the given ref. The ref must be fully qualified. If the given 546 ref does not exist, it is not an error but means that no 547 notes should be printed. 548+ 549This setting defaults to "refs/notes/commits", and it can be overridden by 550the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 551 552core.sparseCheckout:: 553 Enable "sparse checkout" feature. See section "Sparse checkout" in 554 linkgit:git-read-tree[1] for more information. 555 556add.ignore-errors:: 557 Tells 'git add' to continue adding files when some files cannot be 558 added due to indexing errors. Equivalent to the '--ignore-errors' 559 option of linkgit:git-add[1]. 560 561alias.*:: 562 Command aliases for the linkgit:git[1] command wrapper - e.g. 563 after defining "alias.last = cat-file commit HEAD", the invocation 564 "git last" is equivalent to "git cat-file commit HEAD". To avoid 565 confusion and troubles with script usage, aliases that 566 hide existing git commands are ignored. Arguments are split by 567 spaces, the usual shell quoting and escaping is supported. 568 quote pair and a backslash can be used to quote them. 569+ 570If the alias expansion is prefixed with an exclamation point, 571it will be treated as a shell command. For example, defining 572"alias.new = !gitk --all --not ORIG_HEAD", the invocation 573"git new" is equivalent to running the shell command 574"gitk --all --not ORIG_HEAD". Note that shell commands will be 575executed from the top-level directory of a repository, which may 576not necessarily be the current directory. 577 578am.keepcr:: 579 If true, git-am will call git-mailsplit for patches in mbox format 580 with parameter '--keep-cr'. In this case git-mailsplit will 581 not remove `\r` from lines ending with `\r\n`. Can be overridden 582 by giving '--no-keep-cr' from the command line. 583 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 584 585apply.ignorewhitespace:: 586 When set to 'change', tells 'git apply' to ignore changes in 587 whitespace, in the same way as the '--ignore-space-change' 588 option. 589 When set to one of: no, none, never, false tells 'git apply' to 590 respect all whitespace differences. 591 See linkgit:git-apply[1]. 592 593apply.whitespace:: 594 Tells 'git apply' how to handle whitespaces, in the same way 595 as the '--whitespace' option. See linkgit:git-apply[1]. 596 597branch.autosetupmerge:: 598 Tells 'git branch' and 'git checkout' to set up new branches 599 so that linkgit:git-pull[1] will appropriately merge from the 600 starting point branch. Note that even if this option is not set, 601 this behavior can be chosen per-branch using the `--track` 602 and `--no-track` options. The valid settings are: `false` -- no 603 automatic setup is done; `true` -- automatic setup is done when the 604 starting point is a remote-tracking branch; `always` -- 605 automatic setup is done when the starting point is either a 606 local branch or remote-tracking 607 branch. This option defaults to true. 608 609branch.autosetuprebase:: 610 When a new branch is created with 'git branch' or 'git checkout' 611 that tracks another branch, this variable tells git to set 612 up pull to rebase instead of merge (see "branch.<name>.rebase"). 613 When `never`, rebase is never automatically set to true. 614 When `local`, rebase is set to true for tracked branches of 615 other local branches. 616 When `remote`, rebase is set to true for tracked branches of 617 remote-tracking branches. 618 When `always`, rebase will be set to true for all tracking 619 branches. 620 See "branch.autosetupmerge" for details on how to set up a 621 branch to track another branch. 622 This option defaults to never. 623 624branch.<name>.remote:: 625 When in branch <name>, it tells 'git fetch' and 'git push' which 626 remote to fetch from/push to. It defaults to `origin` if no remote is 627 configured. `origin` is also used if you are not on any branch. 628 629branch.<name>.merge:: 630 Defines, together with branch.<name>.remote, the upstream branch 631 for the given branch. It tells 'git fetch'/'git pull' which 632 branch to merge and can also affect 'git push' (see push.default). 633 When in branch <name>, it tells 'git fetch' the default 634 refspec to be marked for merging in FETCH_HEAD. The value is 635 handled like the remote part of a refspec, and must match a 636 ref which is fetched from the remote given by 637 "branch.<name>.remote". 638 The merge information is used by 'git pull' (which at first calls 639 'git fetch') to lookup the default branch for merging. Without 640 this option, 'git pull' defaults to merge the first refspec fetched. 641 Specify multiple values to get an octopus merge. 642 If you wish to setup 'git pull' so that it merges into <name> from 643 another branch in the local repository, you can point 644 branch.<name>.merge to the desired branch, and use the special setting 645 `.` (a period) for branch.<name>.remote. 646 647branch.<name>.mergeoptions:: 648 Sets default options for merging into branch <name>. The syntax and 649 supported options are the same as those of linkgit:git-merge[1], but 650 option values containing whitespace characters are currently not 651 supported. 652 653branch.<name>.rebase:: 654 When true, rebase the branch <name> on top of the fetched branch, 655 instead of merging the default branch from the default remote when 656 "git pull" is run. 657 *NOTE*: this is a possibly dangerous operation; do *not* use 658 it unless you understand the implications (see linkgit:git-rebase[1] 659 for details). 660 661browser.<tool>.cmd:: 662 Specify the command to invoke the specified browser. The 663 specified command is evaluated in shell with the URLs passed 664 as arguments. (See linkgit:git-web--browse[1].) 665 666browser.<tool>.path:: 667 Override the path for the given tool that may be used to 668 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 669 working repository in gitweb (see linkgit:git-instaweb[1]). 670 671clean.requireForce:: 672 A boolean to make git-clean do nothing unless given -f 673 or -n. Defaults to true. 674 675color.branch:: 676 A boolean to enable/disable color in the output of 677 linkgit:git-branch[1]. May be set to `always`, 678 `false` (or `never`) or `auto` (or `true`), in which case colors are used 679 only when the output is to a terminal. Defaults to false. 680 681color.branch.<slot>:: 682 Use customized color for branch coloration. `<slot>` is one of 683 `current` (the current branch), `local` (a local branch), 684 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other 685 refs). 686+ 687The value for these configuration variables is a list of colors (at most 688two) and attributes (at most one), separated by spaces. The colors 689accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 690`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 691`blink` and `reverse`. The first color given is the foreground; the 692second is the background. The position of the attribute, if any, 693doesn't matter. 694 695color.diff:: 696 When set to `always`, always use colors in patch. 697 When false (or `never`), never. When set to `true` or `auto`, use 698 colors only when the output is to the terminal. Defaults to false. 699 700color.diff.<slot>:: 701 Use customized color for diff colorization. `<slot>` specifies 702 which part of the patch to use the specified color, and is one 703 of `plain` (context text), `meta` (metainformation), `frag` 704 (hunk header), 'func' (function in hunk header), `old` (removed lines), 705 `new` (added lines), `commit` (commit headers), or `whitespace` 706 (highlighting whitespace errors). The values of these variables may be 707 specified as in color.branch.<slot>. 708 709color.decorate.<slot>:: 710 Use customized color for 'git log --decorate' output. `<slot>` is one 711 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 712 branches, remote-tracking branches, tags, stash and HEAD, respectively. 713 714color.grep:: 715 When set to `always`, always highlight matches. When `false` (or 716 `never`), never. When set to `true` or `auto`, use color only 717 when the output is written to the terminal. Defaults to `false`. 718 719color.grep.<slot>:: 720 Use customized color for grep colorization. `<slot>` specifies which 721 part of the line to use the specified color, and is one of 722+ 723-- 724`context`;; 725 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 726`filename`;; 727 filename prefix (when not using `-h`) 728`function`;; 729 function name lines (when using `-p`) 730`linenumber`;; 731 line number prefix (when using `-n`) 732`match`;; 733 matching text 734`selected`;; 735 non-matching text in selected lines 736`separator`;; 737 separators between fields on a line (`:`, `-`, and `=`) 738 and between hunks (`--`) 739-- 740+ 741The values of these variables may be specified as in color.branch.<slot>. 742 743color.interactive:: 744 When set to `always`, always use colors for interactive prompts 745 and displays (such as those used by "git-add --interactive"). 746 When false (or `never`), never. When set to `true` or `auto`, use 747 colors only when the output is to the terminal. Defaults to false. 748 749color.interactive.<slot>:: 750 Use customized color for 'git add --interactive' 751 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 752 four distinct types of normal output from interactive 753 commands. The values of these variables may be specified as 754 in color.branch.<slot>. 755 756color.pager:: 757 A boolean to enable/disable colored output when the pager is in 758 use (default is true). 759 760color.showbranch:: 761 A boolean to enable/disable color in the output of 762 linkgit:git-show-branch[1]. May be set to `always`, 763 `false` (or `never`) or `auto` (or `true`), in which case colors are used 764 only when the output is to a terminal. Defaults to false. 765 766color.status:: 767 A boolean to enable/disable color in the output of 768 linkgit:git-status[1]. May be set to `always`, 769 `false` (or `never`) or `auto` (or `true`), in which case colors are used 770 only when the output is to a terminal. Defaults to false. 771 772color.status.<slot>:: 773 Use customized color for status colorization. `<slot>` is 774 one of `header` (the header text of the status message), 775 `added` or `updated` (files which are added but not committed), 776 `changed` (files which are changed but not added in the index), 777 `untracked` (files which are not tracked by git), 778 `branch` (the current branch), or 779 `nobranch` (the color the 'no branch' warning is shown in, defaulting 780 to red). The values of these variables may be specified as in 781 color.branch.<slot>. 782 783color.ui:: 784 When set to `always`, always use colors in all git commands which 785 are capable of colored output. When false (or `never`), never. When 786 set to `true` or `auto`, use colors only when the output is to the 787 terminal. When more specific variables of color.* are set, they always 788 take precedence over this setting. Defaults to false. 789 790commit.status:: 791 A boolean to enable/disable inclusion of status information in the 792 commit message template when using an editor to prepare the commit 793 message. Defaults to true. 794 795commit.template:: 796 Specify a file to use as the template for new commit messages. 797 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 798 specified user's home directory. 799 800diff.autorefreshindex:: 801 When using 'git diff' to compare with work tree 802 files, do not consider stat-only change as changed. 803 Instead, silently run `git update-index --refresh` to 804 update the cached stat information for paths whose 805 contents in the work tree match the contents in the 806 index. This option defaults to true. Note that this 807 affects only 'git diff' Porcelain, and not lower level 808 'diff' commands such as 'git diff-files'. 809 810diff.external:: 811 If this config variable is set, diff generation is not 812 performed using the internal diff machinery, but using the 813 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 814 environment variable. The command is called with parameters 815 as described under "git Diffs" in linkgit:git[1]. Note: if 816 you want to use an external diff program only on a subset of 817 your files, you might want to use linkgit:gitattributes[5] instead. 818 819diff.mnemonicprefix:: 820 If set, 'git diff' uses a prefix pair that is different from the 821 standard "a/" and "b/" depending on what is being compared. When 822 this configuration is in effect, reverse diff output also swaps 823 the order of the prefixes: 824`git diff`;; 825 compares the (i)ndex and the (w)ork tree; 826`git diff HEAD`;; 827 compares a (c)ommit and the (w)ork tree; 828`git diff --cached`;; 829 compares a (c)ommit and the (i)ndex; 830`git diff HEAD:file1 file2`;; 831 compares an (o)bject and a (w)ork tree entity; 832`git diff --no-index a b`;; 833 compares two non-git things (1) and (2). 834 835diff.noprefix:: 836 If set, 'git diff' does not show any source or destination prefix. 837 838diff.renameLimit:: 839 The number of files to consider when performing the copy/rename 840 detection; equivalent to the 'git diff' option '-l'. 841 842diff.renames:: 843 Tells git to detect renames. If set to any boolean value, it 844 will enable basic rename detection. If set to "copies" or 845 "copy", it will detect copies, as well. 846 847diff.ignoreSubmodules:: 848 Sets the default value of --ignore-submodules. Note that this 849 affects only 'git diff' Porcelain, and not lower level 'diff' 850 commands such as 'git diff-files'. 'git checkout' also honors 851 this setting when reporting uncommitted changes. 852 853diff.suppressBlankEmpty:: 854 A boolean to inhibit the standard behavior of printing a space 855 before each empty output line. Defaults to false. 856 857diff.tool:: 858 Controls which diff tool is used. `diff.tool` overrides 859 `merge.tool` when used by linkgit:git-difftool[1] and has 860 the same valid values as `merge.tool` minus "tortoisemerge" 861 and plus "kompare". 862 863difftool.<tool>.path:: 864 Override the path for the given tool. This is useful in case 865 your tool is not in the PATH. 866 867difftool.<tool>.cmd:: 868 Specify the command to invoke the specified diff tool. 869 The specified command is evaluated in shell with the following 870 variables available: 'LOCAL' is set to the name of the temporary 871 file containing the contents of the diff pre-image and 'REMOTE' 872 is set to the name of the temporary file containing the contents 873 of the diff post-image. 874 875difftool.prompt:: 876 Prompt before each invocation of the diff tool. 877 878diff.wordRegex:: 879 A POSIX Extended Regular Expression used to determine what is a "word" 880 when performing word-by-word difference calculations. Character 881 sequences that match the regular expression are "words", all other 882 characters are *ignorable* whitespace. 883 884fetch.unpackLimit:: 885 If the number of objects fetched over the git native 886 transfer is below this 887 limit, then the objects will be unpacked into loose object 888 files. However if the number of received objects equals or 889 exceeds this limit then the received pack will be stored as 890 a pack, after adding any missing delta bases. Storing the 891 pack from a push can make the push operation complete faster, 892 especially on slow filesystems. If not set, the value of 893 `transfer.unpackLimit` is used instead. 894 895format.attach:: 896 Enable multipart/mixed attachments as the default for 897 'format-patch'. The value can also be a double quoted string 898 which will enable attachments as the default and set the 899 value as the boundary. See the --attach option in 900 linkgit:git-format-patch[1]. 901 902format.numbered:: 903 A boolean which can enable or disable sequence numbers in patch 904 subjects. It defaults to "auto" which enables it only if there 905 is more than one patch. It can be enabled or disabled for all 906 messages by setting it to "true" or "false". See --numbered 907 option in linkgit:git-format-patch[1]. 908 909format.headers:: 910 Additional email headers to include in a patch to be submitted 911 by mail. See linkgit:git-format-patch[1]. 912 913format.to:: 914format.cc:: 915 Additional recipients to include in a patch to be submitted 916 by mail. See the --to and --cc options in 917 linkgit:git-format-patch[1]. 918 919format.subjectprefix:: 920 The default for format-patch is to output files with the '[PATCH]' 921 subject prefix. Use this variable to change that prefix. 922 923format.signature:: 924 The default for format-patch is to output a signature containing 925 the git version number. Use this variable to change that default. 926 Set this variable to the empty string ("") to suppress 927 signature generation. 928 929format.suffix:: 930 The default for format-patch is to output files with the suffix 931 `.patch`. Use this variable to change that suffix (make sure to 932 include the dot if you want it). 933 934format.pretty:: 935 The default pretty format for log/show/whatchanged command, 936 See linkgit:git-log[1], linkgit:git-show[1], 937 linkgit:git-whatchanged[1]. 938 939format.thread:: 940 The default threading style for 'git format-patch'. Can be 941 a boolean value, or `shallow` or `deep`. `shallow` threading 942 makes every mail a reply to the head of the series, 943 where the head is chosen from the cover letter, the 944 `\--in-reply-to`, and the first patch mail, in this order. 945 `deep` threading makes every mail a reply to the previous one. 946 A true boolean value is the same as `shallow`, and a false 947 value disables threading. 948 949format.signoff:: 950 A boolean value which lets you enable the `-s/--signoff` option of 951 format-patch by default. *Note:* Adding the Signed-off-by: line to a 952 patch should be a conscious act and means that you certify you have 953 the rights to submit this work under the same open source license. 954 Please see the 'SubmittingPatches' document for further discussion. 955 956gc.aggressiveWindow:: 957 The window size parameter used in the delta compression 958 algorithm used by 'git gc --aggressive'. This defaults 959 to 250. 960 961gc.auto:: 962 When there are approximately more than this many loose 963 objects in the repository, `git gc --auto` will pack them. 964 Some Porcelain commands use this command to perform a 965 light-weight garbage collection from time to time. The 966 default value is 6700. Setting this to 0 disables it. 967 968gc.autopacklimit:: 969 When there are more than this many packs that are not 970 marked with `*.keep` file in the repository, `git gc 971 --auto` consolidates them into one larger pack. The 972 default value is 50. Setting this to 0 disables it. 973 974gc.packrefs:: 975 Running `git pack-refs` in a repository renders it 976 unclonable by Git versions prior to 1.5.1.2 over dumb 977 transports such as HTTP. This variable determines whether 978 'git gc' runs `git pack-refs`. This can be set to `nobare` 979 to enable it within all non-bare repos or it can be set to a 980 boolean value. The default is `true`. 981 982gc.pruneexpire:: 983 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 984 Override the grace period with this config variable. The value 985 "now" may be used to disable this grace period and always prune 986 unreachable objects immediately. 987 988gc.reflogexpire:: 989gc.<pattern>.reflogexpire:: 990 'git reflog expire' removes reflog entries older than 991 this time; defaults to 90 days. With "<pattern>" (e.g. 992 "refs/stash") in the middle the setting applies only to 993 the refs that match the <pattern>. 994 995gc.reflogexpireunreachable:: 996gc.<ref>.reflogexpireunreachable:: 997 'git reflog expire' removes reflog entries older than 998 this time and are not reachable from the current tip; 999 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1000 in the middle, the setting applies only to the refs that1001 match the <pattern>.10021003gc.rerereresolved::1004 Records of conflicted merge you resolved earlier are1005 kept for this many days when 'git rerere gc' is run.1006 The default is 60 days. See linkgit:git-rerere[1].10071008gc.rerereunresolved::1009 Records of conflicted merge you have not resolved are1010 kept for this many days when 'git rerere gc' is run.1011 The default is 15 days. See linkgit:git-rerere[1].10121013gitcvs.commitmsgannotation::1014 Append this string to each commit message. Set to empty string1015 to disable this feature. Defaults to "via git-CVS emulator".10161017gitcvs.enabled::1018 Whether the CVS server interface is enabled for this repository.1019 See linkgit:git-cvsserver[1].10201021gitcvs.logfile::1022 Path to a log file where the CVS server interface well... logs1023 various stuff. See linkgit:git-cvsserver[1].10241025gitcvs.usecrlfattr::1026 If true, the server will look up the end-of-line conversion1027 attributes for files to determine the '-k' modes to use. If1028 the attributes force git to treat a file as text,1029 the '-k' mode will be left blank so CVS clients will1030 treat it as text. If they suppress text conversion, the file1031 will be set with '-kb' mode, which suppresses any newline munging1032 the client might otherwise do. If the attributes do not allow1033 the file type to be determined, then 'gitcvs.allbinary' is1034 used. See linkgit:gitattributes[5].10351036gitcvs.allbinary::1037 This is used if 'gitcvs.usecrlfattr' does not resolve1038 the correct '-kb' mode to use. If true, all1039 unresolved files are sent to the client in1040 mode '-kb'. This causes the client to treat them1041 as binary files, which suppresses any newline munging it1042 otherwise might do. Alternatively, if it is set to "guess",1043 then the contents of the file are examined to decide if1044 it is binary, similar to 'core.autocrlf'.10451046gitcvs.dbname::1047 Database used by git-cvsserver to cache revision information1048 derived from the git repository. The exact meaning depends on the1049 used database driver, for SQLite (which is the default driver) this1050 is a filename. Supports variable substitution (see1051 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1052 Default: '%Ggitcvs.%m.sqlite'10531054gitcvs.dbdriver::1055 Used Perl DBI driver. You can specify any available driver1056 for this here, but it might not work. git-cvsserver is tested1057 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1058 reported *not* to work with 'DBD::mysql'. Experimental feature.1059 May not contain double colons (`:`). Default: 'SQLite'.1060 See linkgit:git-cvsserver[1].10611062gitcvs.dbuser, gitcvs.dbpass::1063 Database user and password. Only useful if setting 'gitcvs.dbdriver',1064 since SQLite has no concept of database users and/or passwords.1065 'gitcvs.dbuser' supports variable substitution (see1066 linkgit:git-cvsserver[1] for details).10671068gitcvs.dbTableNamePrefix::1069 Database table name prefix. Prepended to the names of any1070 database tables used, allowing a single database to be used1071 for several repositories. Supports variable substitution (see1072 linkgit:git-cvsserver[1] for details). Any non-alphabetic1073 characters will be replaced with underscores.10741075All gitcvs variables except for 'gitcvs.usecrlfattr' and1076'gitcvs.allbinary' can also be specified as1077'gitcvs.<access_method>.<varname>' (where 'access_method'1078is one of "ext" and "pserver") to make them apply only for the given1079access method.10801081gui.commitmsgwidth::1082 Defines how wide the commit message window is in the1083 linkgit:git-gui[1]. "75" is the default.10841085gui.diffcontext::1086 Specifies how many context lines should be used in calls to diff1087 made by the linkgit:git-gui[1]. The default is "5".10881089gui.encoding::1090 Specifies the default encoding to use for displaying of1091 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1092 It can be overridden by setting the 'encoding' attribute1093 for relevant files (see linkgit:gitattributes[5]).1094 If this option is not set, the tools default to the1095 locale encoding.10961097gui.matchtrackingbranch::1098 Determines if new branches created with linkgit:git-gui[1] should1099 default to tracking remote branches with matching names or1100 not. Default: "false".11011102gui.newbranchtemplate::1103 Is used as suggested name when creating new branches using the1104 linkgit:git-gui[1].11051106gui.pruneduringfetch::1107 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1108 performing a fetch. The default value is "false".11091110gui.trustmtime::1111 Determines if linkgit:git-gui[1] should trust the file modification1112 timestamp or not. By default the timestamps are not trusted.11131114gui.spellingdictionary::1115 Specifies the dictionary used for spell checking commit messages in1116 the linkgit:git-gui[1]. When set to "none" spell checking is turned1117 off.11181119gui.fastcopyblame::1120 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1121 location detection. It makes blame significantly faster on huge1122 repositories at the expense of less thorough copy detection.11231124gui.copyblamethreshold::1125 Specifies the threshold to use in 'git gui blame' original location1126 detection, measured in alphanumeric characters. See the1127 linkgit:git-blame[1] manual for more information on copy detection.11281129gui.blamehistoryctx::1130 Specifies the radius of history context in days to show in1131 linkgit:gitk[1] for the selected commit, when the `Show History1132 Context` menu item is invoked from 'git gui blame'. If this1133 variable is set to zero, the whole history is shown.11341135guitool.<name>.cmd::1136 Specifies the shell command line to execute when the corresponding item1137 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1138 mandatory for every tool. The command is executed from the root of1139 the working directory, and in the environment it receives the name of1140 the tool as 'GIT_GUITOOL', the name of the currently selected file as1141 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1142 the head is detached, 'CUR_BRANCH' is empty).11431144guitool.<name>.needsfile::1145 Run the tool only if a diff is selected in the GUI. It guarantees1146 that 'FILENAME' is not empty.11471148guitool.<name>.noconsole::1149 Run the command silently, without creating a window to display its1150 output.11511152guitool.<name>.norescan::1153 Don't rescan the working directory for changes after the tool1154 finishes execution.11551156guitool.<name>.confirm::1157 Show a confirmation dialog before actually running the tool.11581159guitool.<name>.argprompt::1160 Request a string argument from the user, and pass it to the tool1161 through the 'ARGS' environment variable. Since requesting an1162 argument implies confirmation, the 'confirm' option has no effect1163 if this is enabled. If the option is set to 'true', 'yes', or '1',1164 the dialog uses a built-in generic prompt; otherwise the exact1165 value of the variable is used.11661167guitool.<name>.revprompt::1168 Request a single valid revision from the user, and set the1169 'REVISION' environment variable. In other aspects this option1170 is similar to 'argprompt', and can be used together with it.11711172guitool.<name>.revunmerged::1173 Show only unmerged branches in the 'revprompt' subdialog.1174 This is useful for tools similar to merge or rebase, but not1175 for things like checkout or reset.11761177guitool.<name>.title::1178 Specifies the title to use for the prompt dialog. The default1179 is the tool name.11801181guitool.<name>.prompt::1182 Specifies the general prompt string to display at the top of1183 the dialog, before subsections for 'argprompt' and 'revprompt'.1184 The default value includes the actual command.11851186help.browser::1187 Specify the browser that will be used to display help in the1188 'web' format. See linkgit:git-help[1].11891190help.format::1191 Override the default help format used by linkgit:git-help[1].1192 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1193 the default. 'web' and 'html' are the same.11941195help.autocorrect::1196 Automatically correct and execute mistyped commands after1197 waiting for the given number of deciseconds (0.1 sec). If more1198 than one command can be deduced from the entered text, nothing1199 will be executed. If the value of this option is negative,1200 the corrected command will be executed immediately. If the1201 value is 0 - the command will be just shown but not executed.1202 This is the default.12031204http.proxy::1205 Override the HTTP proxy, normally configured using the 'http_proxy'1206 environment variable (see linkgit:curl[1]). This can be overridden1207 on a per-remote basis; see remote.<name>.proxy12081209http.sslVerify::1210 Whether to verify the SSL certificate when fetching or pushing1211 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1212 variable.12131214http.sslCert::1215 File containing the SSL certificate when fetching or pushing1216 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1217 variable.12181219http.sslKey::1220 File containing the SSL private key when fetching or pushing1221 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1222 variable.12231224http.sslCertPasswordProtected::1225 Enable git's password prompt for the SSL certificate. Otherwise1226 OpenSSL will prompt the user, possibly many times, if the1227 certificate or private key is encrypted. Can be overridden by the1228 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.12291230http.sslCAInfo::1231 File containing the certificates to verify the peer with when1232 fetching or pushing over HTTPS. Can be overridden by the1233 'GIT_SSL_CAINFO' environment variable.12341235http.sslCAPath::1236 Path containing files with the CA certificates to verify the peer1237 with when fetching or pushing over HTTPS. Can be overridden1238 by the 'GIT_SSL_CAPATH' environment variable.12391240http.maxRequests::1241 How many HTTP requests to launch in parallel. Can be overridden1242 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12431244http.minSessions::1245 The number of curl sessions (counted across slots) to be kept across1246 requests. They will not be ended with curl_easy_cleanup() until1247 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1248 value will be capped at 1. Defaults to 1.12491250http.postBuffer::1251 Maximum size in bytes of the buffer used by smart HTTP1252 transports when POSTing data to the remote system.1253 For requests larger than this buffer size, HTTP/1.1 and1254 Transfer-Encoding: chunked is used to avoid creating a1255 massive pack file locally. Default is 1 MiB, which is1256 sufficient for most requests.12571258http.lowSpeedLimit, http.lowSpeedTime::1259 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1260 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1261 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1262 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12631264http.noEPSV::1265 A boolean which disables using of EPSV ftp command by curl.1266 This can helpful with some "poor" ftp servers which don't1267 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1268 environment variable. Default is false (curl will use EPSV).12691270http.useragent::1271 The HTTP USER_AGENT string presented to an HTTP server. The default1272 value represents the version of the client git such as git/1.7.1.1273 This option allows you to override this value to a more common value1274 such as Mozilla/4.0. This may be necessary, for instance, if1275 connecting through a firewall that restricts HTTP connections to a set1276 of common USER_AGENT strings (but not including those like git/1.7.1).1277 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.12781279i18n.commitEncoding::1280 Character encoding the commit messages are stored in; git itself1281 does not care per se, but this information is necessary e.g. when1282 importing commits from emails or in the gitk graphical history1283 browser (and possibly at other places in the future or in other1284 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12851286i18n.logOutputEncoding::1287 Character encoding the commit messages are converted to when1288 running 'git log' and friends.12891290imap::1291 The configuration variables in the 'imap' section are described1292 in linkgit:git-imap-send[1].12931294init.templatedir::1295 Specify the directory from which templates will be copied.1296 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12971298instaweb.browser::1299 Specify the program that will be used to browse your working1300 repository in gitweb. See linkgit:git-instaweb[1].13011302instaweb.httpd::1303 The HTTP daemon command-line to start gitweb on your working1304 repository. See linkgit:git-instaweb[1].13051306instaweb.local::1307 If true the web server started by linkgit:git-instaweb[1] will1308 be bound to the local IP (127.0.0.1).13091310instaweb.modulepath::1311 The default module path for linkgit:git-instaweb[1] to use1312 instead of /usr/lib/apache2/modules. Only used if httpd1313 is Apache.13141315instaweb.port::1316 The port number to bind the gitweb httpd to. See1317 linkgit:git-instaweb[1].13181319interactive.singlekey::1320 In interactive commands, allow the user to provide one-letter1321 input with a single key (i.e., without hitting enter).1322 Currently this is used only by the `\--patch` mode of1323 linkgit:git-add[1]. Note that this setting is silently1324 ignored if portable keystroke input is not available.13251326log.date::1327 Set the default date-time mode for the 'log' command.1328 Setting a value for log.date is similar to using 'git log''s1329 `\--date` option. Possible values are `relative`, `local`,1330 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1331 for details.13321333log.decorate::1334 Print out the ref names of any commits that are shown by the log1335 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1336 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1337 specified, the full ref name (including prefix) will be printed.1338 This is the same as the log commands '--decorate' option.13391340log.showroot::1341 If true, the initial commit will be shown as a big creation event.1342 This is equivalent to a diff against an empty tree.1343 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1344 normally hide the root commit will now show it. True by default.13451346mailmap.file::1347 The location of an augmenting mailmap file. The default1348 mailmap, located in the root of the repository, is loaded1349 first, then the mailmap file pointed to by this variable.1350 The location of the mailmap file may be in a repository1351 subdirectory, or somewhere outside of the repository itself.1352 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13531354man.viewer::1355 Specify the programs that may be used to display help in the1356 'man' format. See linkgit:git-help[1].13571358man.<tool>.cmd::1359 Specify the command to invoke the specified man viewer. The1360 specified command is evaluated in shell with the man page1361 passed as argument. (See linkgit:git-help[1].)13621363man.<tool>.path::1364 Override the path for the given tool that may be used to1365 display help in the 'man' format. See linkgit:git-help[1].13661367include::merge-config.txt[]13681369mergetool.<tool>.path::1370 Override the path for the given tool. This is useful in case1371 your tool is not in the PATH.13721373mergetool.<tool>.cmd::1374 Specify the command to invoke the specified merge tool. The1375 specified command is evaluated in shell with the following1376 variables available: 'BASE' is the name of a temporary file1377 containing the common base of the files to be merged, if available;1378 'LOCAL' is the name of a temporary file containing the contents of1379 the file on the current branch; 'REMOTE' is the name of a temporary1380 file containing the contents of the file from the branch being1381 merged; 'MERGED' contains the name of the file to which the merge1382 tool should write the results of a successful merge.13831384mergetool.<tool>.trustExitCode::1385 For a custom merge command, specify whether the exit code of1386 the merge command can be used to determine whether the merge was1387 successful. If this is not set to true then the merge target file1388 timestamp is checked and the merge assumed to have been successful1389 if the file has been updated, otherwise the user is prompted to1390 indicate the success of the merge.13911392mergetool.keepBackup::1393 After performing a merge, the original file with conflict markers1394 can be saved as a file with a `.orig` extension. If this variable1395 is set to `false` then this file is not preserved. Defaults to1396 `true` (i.e. keep the backup files).13971398mergetool.keepTemporaries::1399 When invoking a custom merge tool, git uses a set of temporary1400 files to pass to the tool. If the tool returns an error and this1401 variable is set to `true`, then these temporary files will be1402 preserved, otherwise they will be removed after the tool has1403 exited. Defaults to `false`.14041405mergetool.prompt::1406 Prompt before each invocation of the merge resolution program.14071408notes.displayRef::1409 The (fully qualified) refname from which to show notes when1410 showing commit messages. The value of this variable can be set1411 to a glob, in which case notes from all matching refs will be1412 shown. You may also specify this configuration variable1413 several times. A warning will be issued for refs that do not1414 exist, but a glob that does not match any refs is silently1415 ignored.1416+1417This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1418environment variable, which must be a colon separated list of refs or1419globs.1420+1421The effective value of "core.notesRef" (possibly overridden by1422GIT_NOTES_REF) is also implicitly added to the list of refs to be1423displayed.14241425notes.rewrite.<command>::1426 When rewriting commits with <command> (currently `amend` or1427 `rebase`) and this variable is set to `true`, git1428 automatically copies your notes from the original to the1429 rewritten commit. Defaults to `true`, but see1430 "notes.rewriteRef" below.14311432notes.rewriteMode::1433 When copying notes during a rewrite (see the1434 "notes.rewrite.<command>" option), determines what to do if1435 the target commit already has a note. Must be one of1436 `overwrite`, `concatenate`, or `ignore`. Defaults to1437 `concatenate`.1438+1439This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1440environment variable.14411442notes.rewriteRef::1443 When copying notes during a rewrite, specifies the (fully1444 qualified) ref whose notes should be copied. The ref may be a1445 glob, in which case notes in all matching refs will be copied.1446 You may also specify this configuration several times.1447+1448Does not have a default value; you must configure this variable to1449enable note rewriting.1450+1451This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1452environment variable, which must be a colon separated list of refs or1453globs.14541455pack.window::1456 The size of the window used by linkgit:git-pack-objects[1] when no1457 window size is given on the command line. Defaults to 10.14581459pack.depth::1460 The maximum delta depth used by linkgit:git-pack-objects[1] when no1461 maximum depth is given on the command line. Defaults to 50.14621463pack.windowMemory::1464 The window memory size limit used by linkgit:git-pack-objects[1]1465 when no limit is given on the command line. The value can be1466 suffixed with "k", "m", or "g". Defaults to 0, meaning no1467 limit.14681469pack.compression::1470 An integer -1..9, indicating the compression level for objects1471 in a pack file. -1 is the zlib default. 0 means no1472 compression, and 1..9 are various speed/size tradeoffs, 9 being1473 slowest. If not set, defaults to core.compression. If that is1474 not set, defaults to -1, the zlib default, which is "a default1475 compromise between speed and compression (currently equivalent1476 to level 6)."1477+1478Note that changing the compression level will not automatically recompress1479all existing objects. You can force recompression by passing the -F option1480to linkgit:git-repack[1].14811482pack.deltaCacheSize::1483 The maximum memory in bytes used for caching deltas in1484 linkgit:git-pack-objects[1] before writing them out to a pack.1485 This cache is used to speed up the writing object phase by not1486 having to recompute the final delta result once the best match1487 for all objects is found. Repacking large repositories on machines1488 which are tight with memory might be badly impacted by this though,1489 especially if this cache pushes the system into swapping.1490 A value of 0 means no limit. The smallest size of 1 byte may be1491 used to virtually disable this cache. Defaults to 256 MiB.14921493pack.deltaCacheLimit::1494 The maximum size of a delta, that is cached in1495 linkgit:git-pack-objects[1]. This cache is used to speed up the1496 writing object phase by not having to recompute the final delta1497 result once the best match for all objects is found. Defaults to 1000.14981499pack.threads::1500 Specifies the number of threads to spawn when searching for best1501 delta matches. This requires that linkgit:git-pack-objects[1]1502 be compiled with pthreads otherwise this option is ignored with a1503 warning. This is meant to reduce packing time on multiprocessor1504 machines. The required amount of memory for the delta search window1505 is however multiplied by the number of threads.1506 Specifying 0 will cause git to auto-detect the number of CPU's1507 and set the number of threads accordingly.15081509pack.indexVersion::1510 Specify the default pack index version. Valid values are 1 for1511 legacy pack index used by Git versions prior to 1.5.2, and 2 for1512 the new pack index with capabilities for packs larger than 4 GB1513 as well as proper protection against the repacking of corrupted1514 packs. Version 2 is the default. Note that version 2 is enforced1515 and this config option ignored whenever the corresponding pack is1516 larger than 2 GB.1517+1518If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1519cloning or fetching over a non native protocol (e.g. "http" and "rsync")1520that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1521other side may give you a repository that cannot be accessed with your1522older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1523you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1524the `{asterisk}.idx` file.15251526pack.packSizeLimit::1527 The maximum size of a pack. This setting only affects1528 packing to a file when repacking, i.e. the git:// protocol1529 is unaffected. It can be overridden by the `\--max-pack-size`1530 option of linkgit:git-repack[1]. The minimum size allowed is1531 limited to 1 MiB. The default is unlimited.1532 Common unit suffixes of 'k', 'm', or 'g' are1533 supported.15341535pager.<cmd>::1536 Allows turning on or off pagination of the output of a1537 particular git subcommand when writing to a tty. If1538 `\--paginate` or `\--no-pager` is specified on the command line,1539 it takes precedence over this option. To disable pagination for1540 all commands, set `core.pager` or `GIT_PAGER` to `cat`.15411542pretty.<name>::1543 Alias for a --pretty= format string, as specified in1544 linkgit:git-log[1]. Any aliases defined here can be used just1545 as the built-in pretty formats could. For example,1546 running `git config pretty.changelog "format:{asterisk} %H %s"`1547 would cause the invocation `git log --pretty=changelog`1548 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1549 Note that an alias with the same name as a built-in format1550 will be silently ignored.15511552pull.octopus::1553 The default merge strategy to use when pulling multiple branches1554 at once.15551556pull.twohead::1557 The default merge strategy to use when pulling a single branch.15581559push.default::1560 Defines the action git push should take if no refspec is given1561 on the command line, no refspec is configured in the remote, and1562 no refspec is implied by any of the options given on the command1563 line. Possible values are:1564+1565* `nothing` - do not push anything.1566* `matching` - push all matching branches.1567 All branches having the same name in both ends are considered to be1568 matching. This is the default.1569* `tracking` - push the current branch to its upstream branch.1570* `current` - push the current branch to a branch of the same name.15711572rebase.stat::1573 Whether to show a diffstat of what changed upstream since the last1574 rebase. False by default.15751576rebase.autosquash::1577 If set to true enable '--autosquash' option by default.15781579receive.autogc::1580 By default, git-receive-pack will run "git-gc --auto" after1581 receiving data from git-push and updating refs. You can stop1582 it by setting this variable to false.15831584receive.fsckObjects::1585 If it is set to true, git-receive-pack will check all received1586 objects. It will abort in the case of a malformed object or a1587 broken link. The result of an abort are only dangling objects.1588 Defaults to false.15891590receive.unpackLimit::1591 If the number of objects received in a push is below this1592 limit then the objects will be unpacked into loose object1593 files. However if the number of received objects equals or1594 exceeds this limit then the received pack will be stored as1595 a pack, after adding any missing delta bases. Storing the1596 pack from a push can make the push operation complete faster,1597 especially on slow filesystems. If not set, the value of1598 `transfer.unpackLimit` is used instead.15991600receive.denyDeletes::1601 If set to true, git-receive-pack will deny a ref update that deletes1602 the ref. Use this to prevent such a ref deletion via a push.16031604receive.denyDeleteCurrent::1605 If set to true, git-receive-pack will deny a ref update that1606 deletes the currently checked out branch of a non-bare repository.16071608receive.denyCurrentBranch::1609 If set to true or "refuse", git-receive-pack will deny a ref update1610 to the currently checked out branch of a non-bare repository.1611 Such a push is potentially dangerous because it brings the HEAD1612 out of sync with the index and working tree. If set to "warn",1613 print a warning of such a push to stderr, but allow the push to1614 proceed. If set to false or "ignore", allow such pushes with no1615 message. Defaults to "refuse".16161617receive.denyNonFastForwards::1618 If set to true, git-receive-pack will deny a ref update which is1619 not a fast-forward. Use this to prevent such an update via a push,1620 even if that push is forced. This configuration variable is1621 set when initializing a shared repository.16221623receive.updateserverinfo::1624 If set to true, git-receive-pack will run git-update-server-info1625 after receiving data from git-push and updating refs.16261627remote.<name>.url::1628 The URL of a remote repository. See linkgit:git-fetch[1] or1629 linkgit:git-push[1].16301631remote.<name>.pushurl::1632 The push URL of a remote repository. See linkgit:git-push[1].16331634remote.<name>.proxy::1635 For remotes that require curl (http, https and ftp), the URL to1636 the proxy to use for that remote. Set to the empty string to1637 disable proxying for that remote.16381639remote.<name>.fetch::1640 The default set of "refspec" for linkgit:git-fetch[1]. See1641 linkgit:git-fetch[1].16421643remote.<name>.push::1644 The default set of "refspec" for linkgit:git-push[1]. See1645 linkgit:git-push[1].16461647remote.<name>.mirror::1648 If true, pushing to this remote will automatically behave1649 as if the `\--mirror` option was given on the command line.16501651remote.<name>.skipDefaultUpdate::1652 If true, this remote will be skipped by default when updating1653 using linkgit:git-fetch[1] or the `update` subcommand of1654 linkgit:git-remote[1].16551656remote.<name>.skipFetchAll::1657 If true, this remote will be skipped by default when updating1658 using linkgit:git-fetch[1] or the `update` subcommand of1659 linkgit:git-remote[1].16601661remote.<name>.receivepack::1662 The default program to execute on the remote side when pushing. See1663 option \--receive-pack of linkgit:git-push[1].16641665remote.<name>.uploadpack::1666 The default program to execute on the remote side when fetching. See1667 option \--upload-pack of linkgit:git-fetch-pack[1].16681669remote.<name>.tagopt::1670 Setting this value to \--no-tags disables automatic tag following when1671 fetching from remote <name>. Setting it to \--tags will fetch every1672 tag from remote <name>, even if they are not reachable from remote1673 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1674 override this setting. See options \--tags and \--no-tags of1675 linkgit:git-fetch[1].16761677remote.<name>.vcs::1678 Setting this to a value <vcs> will cause git to interact with1679 the remote with the git-remote-<vcs> helper.16801681remotes.<group>::1682 The list of remotes which are fetched by "git remote update1683 <group>". See linkgit:git-remote[1].16841685repack.usedeltabaseoffset::1686 By default, linkgit:git-repack[1] creates packs that use1687 delta-base offset. If you need to share your repository with1688 git older than version 1.4.4, either directly or via a dumb1689 protocol such as http, then you need to set this option to1690 "false" and repack. Access from old git versions over the1691 native protocol are unaffected by this option.16921693rerere.autoupdate::1694 When set to true, `git-rerere` updates the index with the1695 resulting contents after it cleanly resolves conflicts using1696 previously recorded resolution. Defaults to false.16971698rerere.enabled::1699 Activate recording of resolved conflicts, so that identical1700 conflict hunks can be resolved automatically, should they1701 be encountered again. linkgit:git-rerere[1] command is by1702 default enabled if you create `rr-cache` directory under1703 `$GIT_DIR`, but can be disabled by setting this option to false.17041705sendemail.identity::1706 A configuration identity. When given, causes values in the1707 'sendemail.<identity>' subsection to take precedence over1708 values in the 'sendemail' section. The default identity is1709 the value of 'sendemail.identity'.17101711sendemail.smtpencryption::1712 See linkgit:git-send-email[1] for description. Note that this1713 setting is not subject to the 'identity' mechanism.17141715sendemail.smtpssl::1716 Deprecated alias for 'sendemail.smtpencryption = ssl'.17171718sendemail.<identity>.*::1719 Identity-specific versions of the 'sendemail.*' parameters1720 found below, taking precedence over those when the this1721 identity is selected, through command-line or1722 'sendemail.identity'.17231724sendemail.aliasesfile::1725sendemail.aliasfiletype::1726sendemail.bcc::1727sendemail.cc::1728sendemail.cccmd::1729sendemail.chainreplyto::1730sendemail.confirm::1731sendemail.envelopesender::1732sendemail.from::1733sendemail.multiedit::1734sendemail.signedoffbycc::1735sendemail.smtppass::1736sendemail.suppresscc::1737sendemail.suppressfrom::1738sendemail.to::1739sendemail.smtpdomain::1740sendemail.smtpserver::1741sendemail.smtpserverport::1742sendemail.smtpserveroption::1743sendemail.smtpuser::1744sendemail.thread::1745sendemail.validate::1746 See linkgit:git-send-email[1] for description.17471748sendemail.signedoffcc::1749 Deprecated alias for 'sendemail.signedoffbycc'.17501751showbranch.default::1752 The default set of branches for linkgit:git-show-branch[1].1753 See linkgit:git-show-branch[1].17541755status.relativePaths::1756 By default, linkgit:git-status[1] shows paths relative to the1757 current directory. Setting this variable to `false` shows paths1758 relative to the repository root (this was the default for git1759 prior to v1.5.4).17601761status.showUntrackedFiles::1762 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1763 files which are not currently tracked by Git. Directories which1764 contain only untracked files, are shown with the directory name1765 only. Showing untracked files means that Git needs to lstat() all1766 all the files in the whole repository, which might be slow on some1767 systems. So, this variable controls how the commands displays1768 the untracked files. Possible values are:1769+1770--1771* `no` - Show no untracked files.1772* `normal` - Show untracked files and directories.1773* `all` - Show also individual files in untracked directories.1774--1775+1776If this variable is not specified, it defaults to 'normal'.1777This variable can be overridden with the -u|--untracked-files option1778of linkgit:git-status[1] and linkgit:git-commit[1].17791780status.submodulesummary::1781 Defaults to false.1782 If this is set to a non zero number or true (identical to -1 or an1783 unlimited number), the submodule summary will be enabled and a1784 summary of commits for modified submodules will be shown (see1785 --summary-limit option of linkgit:git-submodule[1]).17861787submodule.<name>.path::1788submodule.<name>.url::1789submodule.<name>.update::1790 The path within this project, URL, and the updating strategy1791 for a submodule. These variables are initially populated1792 by 'git submodule init'; edit them to override the1793 URL and other values found in the `.gitmodules` file. See1794 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.17951796submodule.<name>.ignore::1797 Defines under what circumstances "git status" and the diff family show1798 a submodule as modified. When set to "all", it will never be considered1799 modified, "dirty" will ignore all changes to the submodules work tree and1800 takes only differences between the HEAD of the submodule and the commit1801 recorded in the superproject into account. "untracked" will additionally1802 let submodules with modified tracked files in their work tree show up.1803 Using "none" (the default when this option is not set) also shows1804 submodules that have untracked files in their work tree as changed.1805 This setting overrides any setting made in .gitmodules for this submodule,1806 both settings can be overridden on the command line by using the1807 "--ignore-submodules" option.18081809tar.umask::1810 This variable can be used to restrict the permission bits of1811 tar archive entries. The default is 0002, which turns off the1812 world write bit. The special value "user" indicates that the1813 archiving user's umask will be used instead. See umask(2) and1814 linkgit:git-archive[1].18151816transfer.unpackLimit::1817 When `fetch.unpackLimit` or `receive.unpackLimit` are1818 not set, the value of this variable is used instead.1819 The default value is 100.18201821url.<base>.insteadOf::1822 Any URL that starts with this value will be rewritten to1823 start, instead, with <base>. In cases where some site serves a1824 large number of repositories, and serves them with multiple1825 access methods, and some users need to use different access1826 methods, this feature allows people to specify any of the1827 equivalent URLs and have git automatically rewrite the URL to1828 the best alternative for the particular user, even for a1829 never-before-seen repository on the site. When more than one1830 insteadOf strings match a given URL, the longest match is used.18311832url.<base>.pushInsteadOf::1833 Any URL that starts with this value will not be pushed to;1834 instead, it will be rewritten to start with <base>, and the1835 resulting URL will be pushed to. In cases where some site serves1836 a large number of repositories, and serves them with multiple1837 access methods, some of which do not allow push, this feature1838 allows people to specify a pull-only URL and have git1839 automatically use an appropriate URL to push, even for a1840 never-before-seen repository on the site. When more than one1841 pushInsteadOf strings match a given URL, the longest match is1842 used. If a remote has an explicit pushurl, git will ignore this1843 setting for that remote.18441845user.email::1846 Your email address to be recorded in any newly created commits.1847 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1848 'EMAIL' environment variables. See linkgit:git-commit-tree[1].18491850user.name::1851 Your full name to be recorded in any newly created commits.1852 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1853 environment variables. See linkgit:git-commit-tree[1].18541855user.signingkey::1856 If linkgit:git-tag[1] is not selecting the key you want it to1857 automatically when creating a signed tag, you can override the1858 default selection with this variable. This option is passed1859 unchanged to gpg's --local-user parameter, so you may specify a key1860 using any method that gpg supports.18611862web.browser::1863 Specify a web browser that may be used by some commands.1864 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1865 may use it.