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.editor:: 463 Commands such as `commit` and `tag` that lets you edit 464 messages by launching an editor uses the value of this 465 variable when it is set, and the environment variable 466 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 467 468core.pager:: 469 The command that git will use to paginate output. Can 470 be overridden with the `GIT_PAGER` environment 471 variable. Note that git sets the `LESS` environment 472 variable to `FRSX` if it is unset when it runs the 473 pager. One can change these settings by setting the 474 `LESS` variable to some other value. Alternately, 475 these settings can be overridden on a project or 476 global basis by setting the `core.pager` option. 477 Setting `core.pager` has no affect on the `LESS` 478 environment variable behaviour above, so if you want 479 to override git's default settings this way, you need 480 to be explicit. For example, to disable the S option 481 in a backward compatible manner, set `core.pager` 482 to `less -+$LESS -FRX`. This will be passed to the 483 shell by git, which will translate the final command to 484 `LESS=FRSX less -+FRSX -FRX`. 485 486core.whitespace:: 487 A comma separated list of common whitespace problems to 488 notice. 'git diff' will use `color.diff.whitespace` to 489 highlight them, and 'git apply --whitespace=error' will 490 consider them as errors. You can prefix `-` to disable 491 any of them (e.g. `-trailing-space`): 492+ 493* `blank-at-eol` treats trailing whitespaces at the end of the line 494 as an error (enabled by default). 495* `space-before-tab` treats a space character that appears immediately 496 before a tab character in the initial indent part of the line as an 497 error (enabled by default). 498* `indent-with-non-tab` treats a line that is indented with 8 or more 499 space characters as an error (not enabled by default). 500* `tab-in-indent` treats a tab character in the initial indent part of 501 the line as an error (not enabled by default). 502* `blank-at-eof` treats blank lines added at the end of file as an error 503 (enabled by default). 504* `trailing-space` is a short-hand to cover both `blank-at-eol` and 505 `blank-at-eof`. 506* `cr-at-eol` treats a carriage-return at the end of line as 507 part of the line terminator, i.e. with it, `trailing-space` 508 does not trigger if the character before such a carriage-return 509 is not a whitespace (not enabled by default). 510 511core.fsyncobjectfiles:: 512 This boolean will enable 'fsync()' when writing object files. 513+ 514This is a total waste of time and effort on a filesystem that orders 515data writes properly, but can be useful for filesystems that do not use 516journalling (traditional UNIX filesystems) or that only journal metadata 517and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 518 519core.preloadindex:: 520 Enable parallel index preload for operations like 'git diff' 521+ 522This can speed up operations like 'git diff' and 'git status' especially 523on filesystems like NFS that have weak caching semantics and thus 524relatively high IO latencies. With this set to 'true', git will do the 525index comparison to the filesystem data in parallel, allowing 526overlapping IO's. 527 528core.createObject:: 529 You can set this to 'link', in which case a hardlink followed by 530 a delete of the source are used to make sure that object creation 531 will not overwrite existing objects. 532+ 533On some file system/operating system combinations, this is unreliable. 534Set this config setting to 'rename' there; However, This will remove the 535check that makes sure that existing object files will not get overwritten. 536 537core.notesRef:: 538 When showing commit messages, also show notes which are stored in 539 the given ref. The ref must be fully qualified. If the given 540 ref does not exist, it is not an error but means that no 541 notes should be printed. 542+ 543This setting defaults to "refs/notes/commits", and it can be overridden by 544the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 545 546core.sparseCheckout:: 547 Enable "sparse checkout" feature. See section "Sparse checkout" in 548 linkgit:git-read-tree[1] for more information. 549 550add.ignore-errors:: 551 Tells 'git add' to continue adding files when some files cannot be 552 added due to indexing errors. Equivalent to the '--ignore-errors' 553 option of linkgit:git-add[1]. 554 555alias.*:: 556 Command aliases for the linkgit:git[1] command wrapper - e.g. 557 after defining "alias.last = cat-file commit HEAD", the invocation 558 "git last" is equivalent to "git cat-file commit HEAD". To avoid 559 confusion and troubles with script usage, aliases that 560 hide existing git commands are ignored. Arguments are split by 561 spaces, the usual shell quoting and escaping is supported. 562 quote pair and a backslash can be used to quote them. 563+ 564If the alias expansion is prefixed with an exclamation point, 565it will be treated as a shell command. For example, defining 566"alias.new = !gitk --all --not ORIG_HEAD", the invocation 567"git new" is equivalent to running the shell command 568"gitk --all --not ORIG_HEAD". Note that shell commands will be 569executed from the top-level directory of a repository, which may 570not necessarily be the current directory. 571 572am.keepcr:: 573 If true, git-am will call git-mailsplit for patches in mbox format 574 with parameter '--keep-cr'. In this case git-mailsplit will 575 not remove `\r` from lines ending with `\r\n`. Can be overridden 576 by giving '--no-keep-cr' from the command line. 577 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 578 579apply.ignorewhitespace:: 580 When set to 'change', tells 'git apply' to ignore changes in 581 whitespace, in the same way as the '--ignore-space-change' 582 option. 583 When set to one of: no, none, never, false tells 'git apply' to 584 respect all whitespace differences. 585 See linkgit:git-apply[1]. 586 587apply.whitespace:: 588 Tells 'git apply' how to handle whitespaces, in the same way 589 as the '--whitespace' option. See linkgit:git-apply[1]. 590 591branch.autosetupmerge:: 592 Tells 'git branch' and 'git checkout' to set up new branches 593 so that linkgit:git-pull[1] will appropriately merge from the 594 starting point branch. Note that even if this option is not set, 595 this behavior can be chosen per-branch using the `--track` 596 and `--no-track` options. The valid settings are: `false` -- no 597 automatic setup is done; `true` -- automatic setup is done when the 598 starting point is a remote branch; `always` -- automatic setup is 599 done when the starting point is either a local branch or remote 600 branch. This option defaults to true. 601 602branch.autosetuprebase:: 603 When a new branch is created with 'git branch' or 'git checkout' 604 that tracks another branch, this variable tells git to set 605 up pull to rebase instead of merge (see "branch.<name>.rebase"). 606 When `never`, rebase is never automatically set to true. 607 When `local`, rebase is set to true for tracked branches of 608 other local branches. 609 When `remote`, rebase is set to true for tracked branches of 610 remote branches. 611 When `always`, rebase will be set to true for all tracking 612 branches. 613 See "branch.autosetupmerge" for details on how to set up a 614 branch to track another branch. 615 This option defaults to never. 616 617branch.<name>.remote:: 618 When in branch <name>, it tells 'git fetch' and 'git push' which 619 remote to fetch from/push to. It defaults to `origin` if no remote is 620 configured. `origin` is also used if you are not on any branch. 621 622branch.<name>.merge:: 623 Defines, together with branch.<name>.remote, the upstream branch 624 for the given branch. It tells 'git fetch'/'git pull' which 625 branch to merge and can also affect 'git push' (see push.default). 626 When in branch <name>, it tells 'git fetch' the default 627 refspec to be marked for merging in FETCH_HEAD. The value is 628 handled like the remote part of a refspec, and must match a 629 ref which is fetched from the remote given by 630 "branch.<name>.remote". 631 The merge information is used by 'git pull' (which at first calls 632 'git fetch') to lookup the default branch for merging. Without 633 this option, 'git pull' defaults to merge the first refspec fetched. 634 Specify multiple values to get an octopus merge. 635 If you wish to setup 'git pull' so that it merges into <name> from 636 another branch in the local repository, you can point 637 branch.<name>.merge to the desired branch, and use the special setting 638 `.` (a period) for branch.<name>.remote. 639 640branch.<name>.mergeoptions:: 641 Sets default options for merging into branch <name>. The syntax and 642 supported options are the same as those of linkgit:git-merge[1], but 643 option values containing whitespace characters are currently not 644 supported. 645 646branch.<name>.rebase:: 647 When true, rebase the branch <name> on top of the fetched branch, 648 instead of merging the default branch from the default remote when 649 "git pull" is run. 650 *NOTE*: this is a possibly dangerous operation; do *not* use 651 it unless you understand the implications (see linkgit:git-rebase[1] 652 for details). 653 654browser.<tool>.cmd:: 655 Specify the command to invoke the specified browser. The 656 specified command is evaluated in shell with the URLs passed 657 as arguments. (See linkgit:git-web--browse[1].) 658 659browser.<tool>.path:: 660 Override the path for the given tool that may be used to 661 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 662 working repository in gitweb (see linkgit:git-instaweb[1]). 663 664clean.requireForce:: 665 A boolean to make git-clean do nothing unless given -f 666 or -n. Defaults to true. 667 668color.branch:: 669 A boolean to enable/disable color in the output of 670 linkgit:git-branch[1]. May be set to `always`, 671 `false` (or `never`) or `auto` (or `true`), in which case colors are used 672 only when the output is to a terminal. Defaults to false. 673 674color.branch.<slot>:: 675 Use customized color for branch coloration. `<slot>` is one of 676 `current` (the current branch), `local` (a local branch), 677 `remote` (a tracking branch in refs/remotes/), `plain` (other 678 refs). 679+ 680The value for these configuration variables is a list of colors (at most 681two) and attributes (at most one), separated by spaces. The colors 682accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 683`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 684`blink` and `reverse`. The first color given is the foreground; the 685second is the background. The position of the attribute, if any, 686doesn't matter. 687 688color.diff:: 689 When set to `always`, always use colors in patch. 690 When false (or `never`), never. When set to `true` or `auto`, use 691 colors only when the output is to the terminal. Defaults to false. 692 693color.diff.<slot>:: 694 Use customized color for diff colorization. `<slot>` specifies 695 which part of the patch to use the specified color, and is one 696 of `plain` (context text), `meta` (metainformation), `frag` 697 (hunk header), 'func' (function in hunk header), `old` (removed lines), 698 `new` (added lines), `commit` (commit headers), or `whitespace` 699 (highlighting whitespace errors). The values of these variables may be 700 specified as in color.branch.<slot>. 701 702color.decorate.<slot>:: 703 Use customized color for 'git log --decorate' output. `<slot>` is one 704 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 705 branches, remote tracking branches, tags, stash and HEAD, respectively. 706 707color.grep:: 708 When set to `always`, always highlight matches. When `false` (or 709 `never`), never. When set to `true` or `auto`, use color only 710 when the output is written to the terminal. Defaults to `false`. 711 712color.grep.<slot>:: 713 Use customized color for grep colorization. `<slot>` specifies which 714 part of the line to use the specified color, and is one of 715+ 716-- 717`context`;; 718 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 719`filename`;; 720 filename prefix (when not using `-h`) 721`function`;; 722 function name lines (when using `-p`) 723`linenumber`;; 724 line number prefix (when using `-n`) 725`match`;; 726 matching text 727`selected`;; 728 non-matching text in selected lines 729`separator`;; 730 separators between fields on a line (`:`, `-`, and `=`) 731 and between hunks (`--`) 732-- 733+ 734The values of these variables may be specified as in color.branch.<slot>. 735 736color.interactive:: 737 When set to `always`, always use colors for interactive prompts 738 and displays (such as those used by "git-add --interactive"). 739 When false (or `never`), never. When set to `true` or `auto`, use 740 colors only when the output is to the terminal. Defaults to false. 741 742color.interactive.<slot>:: 743 Use customized color for 'git add --interactive' 744 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 745 four distinct types of normal output from interactive 746 commands. The values of these variables may be specified as 747 in color.branch.<slot>. 748 749color.pager:: 750 A boolean to enable/disable colored output when the pager is in 751 use (default is true). 752 753color.showbranch:: 754 A boolean to enable/disable color in the output of 755 linkgit:git-show-branch[1]. May be set to `always`, 756 `false` (or `never`) or `auto` (or `true`), in which case colors are used 757 only when the output is to a terminal. Defaults to false. 758 759color.status:: 760 A boolean to enable/disable color in the output of 761 linkgit:git-status[1]. May be set to `always`, 762 `false` (or `never`) or `auto` (or `true`), in which case colors are used 763 only when the output is to a terminal. Defaults to false. 764 765color.status.<slot>:: 766 Use customized color for status colorization. `<slot>` is 767 one of `header` (the header text of the status message), 768 `added` or `updated` (files which are added but not committed), 769 `changed` (files which are changed but not added in the index), 770 `untracked` (files which are not tracked by git), or 771 `nobranch` (the color the 'no branch' warning is shown in, defaulting 772 to red). The values of these variables may be specified as in 773 color.branch.<slot>. 774 775color.ui:: 776 When set to `always`, always use colors in all git commands which 777 are capable of colored output. When false (or `never`), never. When 778 set to `true` or `auto`, use colors only when the output is to the 779 terminal. When more specific variables of color.* are set, they always 780 take precedence over this setting. Defaults to false. 781 782commit.status:: 783 A boolean to enable/disable inclusion of status information in the 784 commit message template when using an editor to prepare the commit 785 message. Defaults to true. 786 787commit.template:: 788 Specify a file to use as the template for new commit messages. 789 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 790 specified user's home directory. 791 792diff.autorefreshindex:: 793 When using 'git diff' to compare with work tree 794 files, do not consider stat-only change as changed. 795 Instead, silently run `git update-index --refresh` to 796 update the cached stat information for paths whose 797 contents in the work tree match the contents in the 798 index. This option defaults to true. Note that this 799 affects only 'git diff' Porcelain, and not lower level 800 'diff' commands such as 'git diff-files'. 801 802diff.external:: 803 If this config variable is set, diff generation is not 804 performed using the internal diff machinery, but using the 805 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 806 environment variable. The command is called with parameters 807 as described under "git Diffs" in linkgit:git[1]. Note: if 808 you want to use an external diff program only on a subset of 809 your files, you might want to use linkgit:gitattributes[5] instead. 810 811diff.mnemonicprefix:: 812 If set, 'git diff' uses a prefix pair that is different from the 813 standard "a/" and "b/" depending on what is being compared. When 814 this configuration is in effect, reverse diff output also swaps 815 the order of the prefixes: 816`git diff`;; 817 compares the (i)ndex and the (w)ork tree; 818`git diff HEAD`;; 819 compares a (c)ommit and the (w)ork tree; 820`git diff --cached`;; 821 compares a (c)ommit and the (i)ndex; 822`git diff HEAD:file1 file2`;; 823 compares an (o)bject and a (w)ork tree entity; 824`git diff --no-index a b`;; 825 compares two non-git things (1) and (2). 826 827diff.noprefix:: 828 If set, 'git diff' does not show any source or destination prefix. 829 830diff.renameLimit:: 831 The number of files to consider when performing the copy/rename 832 detection; equivalent to the 'git diff' option '-l'. 833 834diff.renames:: 835 Tells git to detect renames. If set to any boolean value, it 836 will enable basic rename detection. If set to "copies" or 837 "copy", it will detect copies, as well. 838 839diff.ignoreSubmodules:: 840 Sets the default value of --ignore-submodules. Note that this 841 affects only 'git diff' Porcelain, and not lower level 'diff' 842 commands such as 'git diff-files'. 'git checkout' also honors 843 this setting when reporting uncommitted changes. 844 845diff.suppressBlankEmpty:: 846 A boolean to inhibit the standard behavior of printing a space 847 before each empty output line. Defaults to false. 848 849diff.tool:: 850 Controls which diff tool is used. `diff.tool` overrides 851 `merge.tool` when used by linkgit:git-difftool[1] and has 852 the same valid values as `merge.tool` minus "tortoisemerge" 853 and plus "kompare". 854 855difftool.<tool>.path:: 856 Override the path for the given tool. This is useful in case 857 your tool is not in the PATH. 858 859difftool.<tool>.cmd:: 860 Specify the command to invoke the specified diff tool. 861 The specified command is evaluated in shell with the following 862 variables available: 'LOCAL' is set to the name of the temporary 863 file containing the contents of the diff pre-image and 'REMOTE' 864 is set to the name of the temporary file containing the contents 865 of the diff post-image. 866 867difftool.prompt:: 868 Prompt before each invocation of the diff tool. 869 870diff.wordRegex:: 871 A POSIX Extended Regular Expression used to determine what is a "word" 872 when performing word-by-word difference calculations. Character 873 sequences that match the regular expression are "words", all other 874 characters are *ignorable* whitespace. 875 876fetch.unpackLimit:: 877 If the number of objects fetched over the git native 878 transfer is below this 879 limit, then the objects will be unpacked into loose object 880 files. However if the number of received objects equals or 881 exceeds this limit then the received pack will be stored as 882 a pack, after adding any missing delta bases. Storing the 883 pack from a push can make the push operation complete faster, 884 especially on slow filesystems. If not set, the value of 885 `transfer.unpackLimit` is used instead. 886 887format.attach:: 888 Enable multipart/mixed attachments as the default for 889 'format-patch'. The value can also be a double quoted string 890 which will enable attachments as the default and set the 891 value as the boundary. See the --attach option in 892 linkgit:git-format-patch[1]. 893 894format.numbered:: 895 A boolean which can enable or disable sequence numbers in patch 896 subjects. It defaults to "auto" which enables it only if there 897 is more than one patch. It can be enabled or disabled for all 898 messages by setting it to "true" or "false". See --numbered 899 option in linkgit:git-format-patch[1]. 900 901format.headers:: 902 Additional email headers to include in a patch to be submitted 903 by mail. See linkgit:git-format-patch[1]. 904 905format.to:: 906format.cc:: 907 Additional recipients to include in a patch to be submitted 908 by mail. See the --to and --cc options in 909 linkgit:git-format-patch[1]. 910 911format.subjectprefix:: 912 The default for format-patch is to output files with the '[PATCH]' 913 subject prefix. Use this variable to change that prefix. 914 915format.signature:: 916 The default for format-patch is to output a signature containing 917 the git version number. Use this variable to change that default. 918 Set this variable to the empty string ("") to suppress 919 signature generation. 920 921format.suffix:: 922 The default for format-patch is to output files with the suffix 923 `.patch`. Use this variable to change that suffix (make sure to 924 include the dot if you want it). 925 926format.pretty:: 927 The default pretty format for log/show/whatchanged command, 928 See linkgit:git-log[1], linkgit:git-show[1], 929 linkgit:git-whatchanged[1]. 930 931format.thread:: 932 The default threading style for 'git format-patch'. Can be 933 a boolean value, or `shallow` or `deep`. `shallow` threading 934 makes every mail a reply to the head of the series, 935 where the head is chosen from the cover letter, the 936 `\--in-reply-to`, and the first patch mail, in this order. 937 `deep` threading makes every mail a reply to the previous one. 938 A true boolean value is the same as `shallow`, and a false 939 value disables threading. 940 941format.signoff:: 942 A boolean value which lets you enable the `-s/--signoff` option of 943 format-patch by default. *Note:* Adding the Signed-off-by: line to a 944 patch should be a conscious act and means that you certify you have 945 the rights to submit this work under the same open source license. 946 Please see the 'SubmittingPatches' document for further discussion. 947 948gc.aggressiveWindow:: 949 The window size parameter used in the delta compression 950 algorithm used by 'git gc --aggressive'. This defaults 951 to 250. 952 953gc.auto:: 954 When there are approximately more than this many loose 955 objects in the repository, `git gc --auto` will pack them. 956 Some Porcelain commands use this command to perform a 957 light-weight garbage collection from time to time. The 958 default value is 6700. Setting this to 0 disables it. 959 960gc.autopacklimit:: 961 When there are more than this many packs that are not 962 marked with `*.keep` file in the repository, `git gc 963 --auto` consolidates them into one larger pack. The 964 default value is 50. Setting this to 0 disables it. 965 966gc.packrefs:: 967 Running `git pack-refs` in a repository renders it 968 unclonable by Git versions prior to 1.5.1.2 over dumb 969 transports such as HTTP. This variable determines whether 970 'git gc' runs `git pack-refs`. This can be set to `nobare` 971 to enable it within all non-bare repos or it can be set to a 972 boolean value. The default is `true`. 973 974gc.pruneexpire:: 975 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 976 Override the grace period with this config variable. The value 977 "now" may be used to disable this grace period and always prune 978 unreachable objects immediately. 979 980gc.reflogexpire:: 981gc.<pattern>.reflogexpire:: 982 'git reflog expire' removes reflog entries older than 983 this time; defaults to 90 days. With "<pattern>" (e.g. 984 "refs/stash") in the middle the setting applies only to 985 the refs that match the <pattern>. 986 987gc.reflogexpireunreachable:: 988gc.<ref>.reflogexpireunreachable:: 989 'git reflog expire' removes reflog entries older than 990 this time and are not reachable from the current tip; 991 defaults to 30 days. With "<pattern>" (e.g. "refs/stash") 992 in the middle, the setting applies only to the refs that 993 match the <pattern>. 994 995gc.rerereresolved:: 996 Records of conflicted merge you resolved earlier are 997 kept for this many days when 'git rerere gc' is run. 998 The default is 60 days. See linkgit:git-rerere[1]. 9991000gc.rerereunresolved::1001 Records of conflicted merge you have not resolved are1002 kept for this many days when 'git rerere gc' is run.1003 The default is 15 days. See linkgit:git-rerere[1].10041005gitcvs.commitmsgannotation::1006 Append this string to each commit message. Set to empty string1007 to disable this feature. Defaults to "via git-CVS emulator".10081009gitcvs.enabled::1010 Whether the CVS server interface is enabled for this repository.1011 See linkgit:git-cvsserver[1].10121013gitcvs.logfile::1014 Path to a log file where the CVS server interface well... logs1015 various stuff. See linkgit:git-cvsserver[1].10161017gitcvs.usecrlfattr::1018 If true, the server will look up the end-of-line conversion1019 attributes for files to determine the '-k' modes to use. If1020 the attributes force git to treat a file as text,1021 the '-k' mode will be left blank so CVS clients will1022 treat it as text. If they suppress text conversion, the file1023 will be set with '-kb' mode, which suppresses any newline munging1024 the client might otherwise do. If the attributes do not allow1025 the file type to be determined, then 'gitcvs.allbinary' is1026 used. See linkgit:gitattributes[5].10271028gitcvs.allbinary::1029 This is used if 'gitcvs.usecrlfattr' does not resolve1030 the correct '-kb' mode to use. If true, all1031 unresolved files are sent to the client in1032 mode '-kb'. This causes the client to treat them1033 as binary files, which suppresses any newline munging it1034 otherwise might do. Alternatively, if it is set to "guess",1035 then the contents of the file are examined to decide if1036 it is binary, similar to 'core.autocrlf'.10371038gitcvs.dbname::1039 Database used by git-cvsserver to cache revision information1040 derived from the git repository. The exact meaning depends on the1041 used database driver, for SQLite (which is the default driver) this1042 is a filename. Supports variable substitution (see1043 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1044 Default: '%Ggitcvs.%m.sqlite'10451046gitcvs.dbdriver::1047 Used Perl DBI driver. You can specify any available driver1048 for this here, but it might not work. git-cvsserver is tested1049 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1050 reported *not* to work with 'DBD::mysql'. Experimental feature.1051 May not contain double colons (`:`). Default: 'SQLite'.1052 See linkgit:git-cvsserver[1].10531054gitcvs.dbuser, gitcvs.dbpass::1055 Database user and password. Only useful if setting 'gitcvs.dbdriver',1056 since SQLite has no concept of database users and/or passwords.1057 'gitcvs.dbuser' supports variable substitution (see1058 linkgit:git-cvsserver[1] for details).10591060gitcvs.dbTableNamePrefix::1061 Database table name prefix. Prepended to the names of any1062 database tables used, allowing a single database to be used1063 for several repositories. Supports variable substitution (see1064 linkgit:git-cvsserver[1] for details). Any non-alphabetic1065 characters will be replaced with underscores.10661067All gitcvs variables except for 'gitcvs.usecrlfattr' and1068'gitcvs.allbinary' can also be specified as1069'gitcvs.<access_method>.<varname>' (where 'access_method'1070is one of "ext" and "pserver") to make them apply only for the given1071access method.10721073gui.commitmsgwidth::1074 Defines how wide the commit message window is in the1075 linkgit:git-gui[1]. "75" is the default.10761077gui.diffcontext::1078 Specifies how many context lines should be used in calls to diff1079 made by the linkgit:git-gui[1]. The default is "5".10801081gui.encoding::1082 Specifies the default encoding to use for displaying of1083 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1084 It can be overridden by setting the 'encoding' attribute1085 for relevant files (see linkgit:gitattributes[5]).1086 If this option is not set, the tools default to the1087 locale encoding.10881089gui.matchtrackingbranch::1090 Determines if new branches created with linkgit:git-gui[1] should1091 default to tracking remote branches with matching names or1092 not. Default: "false".10931094gui.newbranchtemplate::1095 Is used as suggested name when creating new branches using the1096 linkgit:git-gui[1].10971098gui.pruneduringfetch::1099 "true" if linkgit:git-gui[1] should prune tracking branches when1100 performing a fetch. The default value is "false".11011102gui.trustmtime::1103 Determines if linkgit:git-gui[1] should trust the file modification1104 timestamp or not. By default the timestamps are not trusted.11051106gui.spellingdictionary::1107 Specifies the dictionary used for spell checking commit messages in1108 the linkgit:git-gui[1]. When set to "none" spell checking is turned1109 off.11101111gui.fastcopyblame::1112 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1113 location detection. It makes blame significantly faster on huge1114 repositories at the expense of less thorough copy detection.11151116gui.copyblamethreshold::1117 Specifies the threshold to use in 'git gui blame' original location1118 detection, measured in alphanumeric characters. See the1119 linkgit:git-blame[1] manual for more information on copy detection.11201121gui.blamehistoryctx::1122 Specifies the radius of history context in days to show in1123 linkgit:gitk[1] for the selected commit, when the `Show History1124 Context` menu item is invoked from 'git gui blame'. If this1125 variable is set to zero, the whole history is shown.11261127guitool.<name>.cmd::1128 Specifies the shell command line to execute when the corresponding item1129 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1130 mandatory for every tool. The command is executed from the root of1131 the working directory, and in the environment it receives the name of1132 the tool as 'GIT_GUITOOL', the name of the currently selected file as1133 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1134 the head is detached, 'CUR_BRANCH' is empty).11351136guitool.<name>.needsfile::1137 Run the tool only if a diff is selected in the GUI. It guarantees1138 that 'FILENAME' is not empty.11391140guitool.<name>.noconsole::1141 Run the command silently, without creating a window to display its1142 output.11431144guitool.<name>.norescan::1145 Don't rescan the working directory for changes after the tool1146 finishes execution.11471148guitool.<name>.confirm::1149 Show a confirmation dialog before actually running the tool.11501151guitool.<name>.argprompt::1152 Request a string argument from the user, and pass it to the tool1153 through the 'ARGS' environment variable. Since requesting an1154 argument implies confirmation, the 'confirm' option has no effect1155 if this is enabled. If the option is set to 'true', 'yes', or '1',1156 the dialog uses a built-in generic prompt; otherwise the exact1157 value of the variable is used.11581159guitool.<name>.revprompt::1160 Request a single valid revision from the user, and set the1161 'REVISION' environment variable. In other aspects this option1162 is similar to 'argprompt', and can be used together with it.11631164guitool.<name>.revunmerged::1165 Show only unmerged branches in the 'revprompt' subdialog.1166 This is useful for tools similar to merge or rebase, but not1167 for things like checkout or reset.11681169guitool.<name>.title::1170 Specifies the title to use for the prompt dialog. The default1171 is the tool name.11721173guitool.<name>.prompt::1174 Specifies the general prompt string to display at the top of1175 the dialog, before subsections for 'argprompt' and 'revprompt'.1176 The default value includes the actual command.11771178help.browser::1179 Specify the browser that will be used to display help in the1180 'web' format. See linkgit:git-help[1].11811182help.format::1183 Override the default help format used by linkgit:git-help[1].1184 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1185 the default. 'web' and 'html' are the same.11861187help.autocorrect::1188 Automatically correct and execute mistyped commands after1189 waiting for the given number of deciseconds (0.1 sec). If more1190 than one command can be deduced from the entered text, nothing1191 will be executed. If the value of this option is negative,1192 the corrected command will be executed immediately. If the1193 value is 0 - the command will be just shown but not executed.1194 This is the default.11951196http.proxy::1197 Override the HTTP proxy, normally configured using the 'http_proxy'1198 environment variable (see linkgit:curl[1]). This can be overridden1199 on a per-remote basis; see remote.<name>.proxy12001201http.sslVerify::1202 Whether to verify the SSL certificate when fetching or pushing1203 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1204 variable.12051206http.sslCert::1207 File containing the SSL certificate when fetching or pushing1208 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1209 variable.12101211http.sslKey::1212 File containing the SSL private key when fetching or pushing1213 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1214 variable.12151216http.sslCertPasswordProtected::1217 Enable git's password prompt for the SSL certificate. Otherwise1218 OpenSSL will prompt the user, possibly many times, if the1219 certificate or private key is encrypted. Can be overridden by the1220 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.12211222http.sslCAInfo::1223 File containing the certificates to verify the peer with when1224 fetching or pushing over HTTPS. Can be overridden by the1225 'GIT_SSL_CAINFO' environment variable.12261227http.sslCAPath::1228 Path containing files with the CA certificates to verify the peer1229 with when fetching or pushing over HTTPS. Can be overridden1230 by the 'GIT_SSL_CAPATH' environment variable.12311232http.maxRequests::1233 How many HTTP requests to launch in parallel. Can be overridden1234 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12351236http.minSessions::1237 The number of curl sessions (counted across slots) to be kept across1238 requests. They will not be ended with curl_easy_cleanup() until1239 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1240 value will be capped at 1. Defaults to 1.12411242http.postBuffer::1243 Maximum size in bytes of the buffer used by smart HTTP1244 transports when POSTing data to the remote system.1245 For requests larger than this buffer size, HTTP/1.1 and1246 Transfer-Encoding: chunked is used to avoid creating a1247 massive pack file locally. Default is 1 MiB, which is1248 sufficient for most requests.12491250http.lowSpeedLimit, http.lowSpeedTime::1251 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1252 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1253 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1254 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12551256http.noEPSV::1257 A boolean which disables using of EPSV ftp command by curl.1258 This can helpful with some "poor" ftp servers which don't1259 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1260 environment variable. Default is false (curl will use EPSV).12611262http.useragent::1263 The HTTP USER_AGENT string presented to an HTTP server. The default1264 value represents the version of the client git such as git/1.7.1.1265 This option allows you to override this value to a more common value1266 such as Mozilla/4.0. This may be necessary, for instance, if1267 connecting through a firewall that restricts HTTP connections to a set1268 of common USER_AGENT strings (but not including those like git/1.7.1).1269 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.12701271i18n.commitEncoding::1272 Character encoding the commit messages are stored in; git itself1273 does not care per se, but this information is necessary e.g. when1274 importing commits from emails or in the gitk graphical history1275 browser (and possibly at other places in the future or in other1276 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12771278i18n.logOutputEncoding::1279 Character encoding the commit messages are converted to when1280 running 'git log' and friends.12811282imap::1283 The configuration variables in the 'imap' section are described1284 in linkgit:git-imap-send[1].12851286init.templatedir::1287 Specify the directory from which templates will be copied.1288 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12891290instaweb.browser::1291 Specify the program that will be used to browse your working1292 repository in gitweb. See linkgit:git-instaweb[1].12931294instaweb.httpd::1295 The HTTP daemon command-line to start gitweb on your working1296 repository. See linkgit:git-instaweb[1].12971298instaweb.local::1299 If true the web server started by linkgit:git-instaweb[1] will1300 be bound to the local IP (127.0.0.1).13011302instaweb.modulepath::1303 The default module path for linkgit:git-instaweb[1] to use1304 instead of /usr/lib/apache2/modules. Only used if httpd1305 is Apache.13061307instaweb.port::1308 The port number to bind the gitweb httpd to. See1309 linkgit:git-instaweb[1].13101311interactive.singlekey::1312 In interactive commands, allow the user to provide one-letter1313 input with a single key (i.e., without hitting enter).1314 Currently this is used only by the `\--patch` mode of1315 linkgit:git-add[1]. Note that this setting is silently1316 ignored if portable keystroke input is not available.13171318log.date::1319 Set the default date-time mode for the 'log' command.1320 Setting a value for log.date is similar to using 'git log''s1321 `\--date` option. Possible values are `relative`, `local`,1322 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1323 for details.13241325log.decorate::1326 Print out the ref names of any commits that are shown by the log1327 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1328 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1329 specified, the full ref name (including prefix) will be printed.1330 This is the same as the log commands '--decorate' option.13311332log.showroot::1333 If true, the initial commit will be shown as a big creation event.1334 This is equivalent to a diff against an empty tree.1335 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1336 normally hide the root commit will now show it. True by default.13371338mailmap.file::1339 The location of an augmenting mailmap file. The default1340 mailmap, located in the root of the repository, is loaded1341 first, then the mailmap file pointed to by this variable.1342 The location of the mailmap file may be in a repository1343 subdirectory, or somewhere outside of the repository itself.1344 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13451346man.viewer::1347 Specify the programs that may be used to display help in the1348 'man' format. See linkgit:git-help[1].13491350man.<tool>.cmd::1351 Specify the command to invoke the specified man viewer. The1352 specified command is evaluated in shell with the man page1353 passed as argument. (See linkgit:git-help[1].)13541355man.<tool>.path::1356 Override the path for the given tool that may be used to1357 display help in the 'man' format. See linkgit:git-help[1].13581359include::merge-config.txt[]13601361mergetool.<tool>.path::1362 Override the path for the given tool. This is useful in case1363 your tool is not in the PATH.13641365mergetool.<tool>.cmd::1366 Specify the command to invoke the specified merge tool. The1367 specified command is evaluated in shell with the following1368 variables available: 'BASE' is the name of a temporary file1369 containing the common base of the files to be merged, if available;1370 'LOCAL' is the name of a temporary file containing the contents of1371 the file on the current branch; 'REMOTE' is the name of a temporary1372 file containing the contents of the file from the branch being1373 merged; 'MERGED' contains the name of the file to which the merge1374 tool should write the results of a successful merge.13751376mergetool.<tool>.trustExitCode::1377 For a custom merge command, specify whether the exit code of1378 the merge command can be used to determine whether the merge was1379 successful. If this is not set to true then the merge target file1380 timestamp is checked and the merge assumed to have been successful1381 if the file has been updated, otherwise the user is prompted to1382 indicate the success of the merge.13831384mergetool.keepBackup::1385 After performing a merge, the original file with conflict markers1386 can be saved as a file with a `.orig` extension. If this variable1387 is set to `false` then this file is not preserved. Defaults to1388 `true` (i.e. keep the backup files).13891390mergetool.keepTemporaries::1391 When invoking a custom merge tool, git uses a set of temporary1392 files to pass to the tool. If the tool returns an error and this1393 variable is set to `true`, then these temporary files will be1394 preserved, otherwise they will be removed after the tool has1395 exited. Defaults to `false`.13961397mergetool.prompt::1398 Prompt before each invocation of the merge resolution program.13991400notes.displayRef::1401 The (fully qualified) refname from which to show notes when1402 showing commit messages. The value of this variable can be set1403 to a glob, in which case notes from all matching refs will be1404 shown. You may also specify this configuration variable1405 several times. A warning will be issued for refs that do not1406 exist, but a glob that does not match any refs is silently1407 ignored.1408+1409This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1410environment variable, which must be a colon separated list of refs or1411globs.1412+1413The effective value of "core.notesRef" (possibly overridden by1414GIT_NOTES_REF) is also implicitly added to the list of refs to be1415displayed.14161417notes.rewrite.<command>::1418 When rewriting commits with <command> (currently `amend` or1419 `rebase`) and this variable is set to `true`, git1420 automatically copies your notes from the original to the1421 rewritten commit. Defaults to `true`, but see1422 "notes.rewriteRef" below.14231424notes.rewriteMode::1425 When copying notes during a rewrite (see the1426 "notes.rewrite.<command>" option), determines what to do if1427 the target commit already has a note. Must be one of1428 `overwrite`, `concatenate`, or `ignore`. Defaults to1429 `concatenate`.1430+1431This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1432environment variable.14331434notes.rewriteRef::1435 When copying notes during a rewrite, specifies the (fully1436 qualified) ref whose notes should be copied. The ref may be a1437 glob, in which case notes in all matching refs will be copied.1438 You may also specify this configuration several times.1439+1440Does not have a default value; you must configure this variable to1441enable note rewriting.1442+1443This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1444environment variable, which must be a colon separated list of refs or1445globs.14461447pack.window::1448 The size of the window used by linkgit:git-pack-objects[1] when no1449 window size is given on the command line. Defaults to 10.14501451pack.depth::1452 The maximum delta depth used by linkgit:git-pack-objects[1] when no1453 maximum depth is given on the command line. Defaults to 50.14541455pack.windowMemory::1456 The window memory size limit used by linkgit:git-pack-objects[1]1457 when no limit is given on the command line. The value can be1458 suffixed with "k", "m", or "g". Defaults to 0, meaning no1459 limit.14601461pack.compression::1462 An integer -1..9, indicating the compression level for objects1463 in a pack file. -1 is the zlib default. 0 means no1464 compression, and 1..9 are various speed/size tradeoffs, 9 being1465 slowest. If not set, defaults to core.compression. If that is1466 not set, defaults to -1, the zlib default, which is "a default1467 compromise between speed and compression (currently equivalent1468 to level 6)."1469+1470Note that changing the compression level will not automatically recompress1471all existing objects. You can force recompression by passing the -F option1472to linkgit:git-repack[1].14731474pack.deltaCacheSize::1475 The maximum memory in bytes used for caching deltas in1476 linkgit:git-pack-objects[1] before writing them out to a pack.1477 This cache is used to speed up the writing object phase by not1478 having to recompute the final delta result once the best match1479 for all objects is found. Repacking large repositories on machines1480 which are tight with memory might be badly impacted by this though,1481 especially if this cache pushes the system into swapping.1482 A value of 0 means no limit. The smallest size of 1 byte may be1483 used to virtually disable this cache. Defaults to 256 MiB.14841485pack.deltaCacheLimit::1486 The maximum size of a delta, that is cached in1487 linkgit:git-pack-objects[1]. This cache is used to speed up the1488 writing object phase by not having to recompute the final delta1489 result once the best match for all objects is found. Defaults to 1000.14901491pack.threads::1492 Specifies the number of threads to spawn when searching for best1493 delta matches. This requires that linkgit:git-pack-objects[1]1494 be compiled with pthreads otherwise this option is ignored with a1495 warning. This is meant to reduce packing time on multiprocessor1496 machines. The required amount of memory for the delta search window1497 is however multiplied by the number of threads.1498 Specifying 0 will cause git to auto-detect the number of CPU's1499 and set the number of threads accordingly.15001501pack.indexVersion::1502 Specify the default pack index version. Valid values are 1 for1503 legacy pack index used by Git versions prior to 1.5.2, and 2 for1504 the new pack index with capabilities for packs larger than 4 GB1505 as well as proper protection against the repacking of corrupted1506 packs. Version 2 is the default. Note that version 2 is enforced1507 and this config option ignored whenever the corresponding pack is1508 larger than 2 GB.1509+1510If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1511cloning or fetching over a non native protocol (e.g. "http" and "rsync")1512that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1513other side may give you a repository that cannot be accessed with your1514older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1515you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1516the `{asterisk}.idx` file.15171518pack.packSizeLimit::1519 The maximum size of a pack. This setting only affects1520 packing to a file when repacking, i.e. the git:// protocol1521 is unaffected. It can be overridden by the `\--max-pack-size`1522 option of linkgit:git-repack[1]. The minimum size allowed is1523 limited to 1 MiB. The default is unlimited.1524 Common unit suffixes of 'k', 'm', or 'g' are1525 supported.15261527pager.<cmd>::1528 Allows turning on or off pagination of the output of a1529 particular git subcommand when writing to a tty. If1530 `\--paginate` or `\--no-pager` is specified on the command line,1531 it takes precedence over this option. To disable pagination for1532 all commands, set `core.pager` or `GIT_PAGER` to `cat`.15331534pretty.<name>::1535 Alias for a --pretty= format string, as specified in1536 linkgit:git-log[1]. Any aliases defined here can be used just1537 as the built-in pretty formats could. For example,1538 running `git config pretty.changelog "format:{asterisk} %H %s"`1539 would cause the invocation `git log --pretty=changelog`1540 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1541 Note that an alias with the same name as a built-in format1542 will be silently ignored.15431544pull.octopus::1545 The default merge strategy to use when pulling multiple branches1546 at once.15471548pull.twohead::1549 The default merge strategy to use when pulling a single branch.15501551push.default::1552 Defines the action git push should take if no refspec is given1553 on the command line, no refspec is configured in the remote, and1554 no refspec is implied by any of the options given on the command1555 line. Possible values are:1556+1557* `nothing` do not push anything.1558* `matching` push all matching branches.1559 All branches having the same name in both ends are considered to be1560 matching. This is the default.1561* `tracking` push the current branch to its upstream branch.1562* `current` push the current branch to a branch of the same name.15631564rebase.stat::1565 Whether to show a diffstat of what changed upstream since the last1566 rebase. False by default.15671568rebase.autosquash::1569 If set to true enable '--autosquash' option by default.15701571receive.autogc::1572 By default, git-receive-pack will run "git-gc --auto" after1573 receiving data from git-push and updating refs. You can stop1574 it by setting this variable to false.15751576receive.fsckObjects::1577 If it is set to true, git-receive-pack will check all received1578 objects. It will abort in the case of a malformed object or a1579 broken link. The result of an abort are only dangling objects.1580 Defaults to false.15811582receive.unpackLimit::1583 If the number of objects received in a push is below this1584 limit then the objects will be unpacked into loose object1585 files. However if the number of received objects equals or1586 exceeds this limit then the received pack will be stored as1587 a pack, after adding any missing delta bases. Storing the1588 pack from a push can make the push operation complete faster,1589 especially on slow filesystems. If not set, the value of1590 `transfer.unpackLimit` is used instead.15911592receive.denyDeletes::1593 If set to true, git-receive-pack will deny a ref update that deletes1594 the ref. Use this to prevent such a ref deletion via a push.15951596receive.denyDeleteCurrent::1597 If set to true, git-receive-pack will deny a ref update that1598 deletes the currently checked out branch of a non-bare repository.15991600receive.denyCurrentBranch::1601 If set to true or "refuse", git-receive-pack will deny a ref update1602 to the currently checked out branch of a non-bare repository.1603 Such a push is potentially dangerous because it brings the HEAD1604 out of sync with the index and working tree. If set to "warn",1605 print a warning of such a push to stderr, but allow the push to1606 proceed. If set to false or "ignore", allow such pushes with no1607 message. Defaults to "refuse".16081609receive.denyNonFastForwards::1610 If set to true, git-receive-pack will deny a ref update which is1611 not a fast-forward. Use this to prevent such an update via a push,1612 even if that push is forced. This configuration variable is1613 set when initializing a shared repository.16141615receive.updateserverinfo::1616 If set to true, git-receive-pack will run git-update-server-info1617 after receiving data from git-push and updating refs.16181619remote.<name>.url::1620 The URL of a remote repository. See linkgit:git-fetch[1] or1621 linkgit:git-push[1].16221623remote.<name>.pushurl::1624 The push URL of a remote repository. See linkgit:git-push[1].16251626remote.<name>.proxy::1627 For remotes that require curl (http, https and ftp), the URL to1628 the proxy to use for that remote. Set to the empty string to1629 disable proxying for that remote.16301631remote.<name>.fetch::1632 The default set of "refspec" for linkgit:git-fetch[1]. See1633 linkgit:git-fetch[1].16341635remote.<name>.push::1636 The default set of "refspec" for linkgit:git-push[1]. See1637 linkgit:git-push[1].16381639remote.<name>.mirror::1640 If true, pushing to this remote will automatically behave1641 as if the `\--mirror` option was given on the command line.16421643remote.<name>.skipDefaultUpdate::1644 If true, this remote will be skipped by default when updating1645 using linkgit:git-fetch[1] or the `update` subcommand of1646 linkgit:git-remote[1].16471648remote.<name>.skipFetchAll::1649 If true, this remote will be skipped by default when updating1650 using linkgit:git-fetch[1] or the `update` subcommand of1651 linkgit:git-remote[1].16521653remote.<name>.receivepack::1654 The default program to execute on the remote side when pushing. See1655 option \--receive-pack of linkgit:git-push[1].16561657remote.<name>.uploadpack::1658 The default program to execute on the remote side when fetching. See1659 option \--upload-pack of linkgit:git-fetch-pack[1].16601661remote.<name>.tagopt::1662 Setting this value to \--no-tags disables automatic tag following when1663 fetching from remote <name>. Setting it to \--tags will fetch every1664 tag from remote <name>, even if they are not reachable from remote1665 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1666 override this setting. See options \--tags and \--no-tags of1667 linkgit:git-fetch[1].16681669remote.<name>.vcs::1670 Setting this to a value <vcs> will cause git to interact with1671 the remote with the git-remote-<vcs> helper.16721673remotes.<group>::1674 The list of remotes which are fetched by "git remote update1675 <group>". See linkgit:git-remote[1].16761677repack.usedeltabaseoffset::1678 By default, linkgit:git-repack[1] creates packs that use1679 delta-base offset. If you need to share your repository with1680 git older than version 1.4.4, either directly or via a dumb1681 protocol such as http, then you need to set this option to1682 "false" and repack. Access from old git versions over the1683 native protocol are unaffected by this option.16841685rerere.autoupdate::1686 When set to true, `git-rerere` updates the index with the1687 resulting contents after it cleanly resolves conflicts using1688 previously recorded resolution. Defaults to false.16891690rerere.enabled::1691 Activate recording of resolved conflicts, so that identical1692 conflict hunks can be resolved automatically, should they1693 be encountered again. linkgit:git-rerere[1] command is by1694 default enabled if you create `rr-cache` directory under1695 `$GIT_DIR`, but can be disabled by setting this option to false.16961697sendemail.identity::1698 A configuration identity. When given, causes values in the1699 'sendemail.<identity>' subsection to take precedence over1700 values in the 'sendemail' section. The default identity is1701 the value of 'sendemail.identity'.17021703sendemail.smtpencryption::1704 See linkgit:git-send-email[1] for description. Note that this1705 setting is not subject to the 'identity' mechanism.17061707sendemail.smtpssl::1708 Deprecated alias for 'sendemail.smtpencryption = ssl'.17091710sendemail.<identity>.*::1711 Identity-specific versions of the 'sendemail.*' parameters1712 found below, taking precedence over those when the this1713 identity is selected, through command-line or1714 'sendemail.identity'.17151716sendemail.aliasesfile::1717sendemail.aliasfiletype::1718sendemail.bcc::1719sendemail.cc::1720sendemail.cccmd::1721sendemail.chainreplyto::1722sendemail.confirm::1723sendemail.envelopesender::1724sendemail.from::1725sendemail.multiedit::1726sendemail.signedoffbycc::1727sendemail.smtppass::1728sendemail.suppresscc::1729sendemail.suppressfrom::1730sendemail.to::1731sendemail.smtpdomain::1732sendemail.smtpserver::1733sendemail.smtpserverport::1734sendemail.smtpuser::1735sendemail.thread::1736sendemail.validate::1737 See linkgit:git-send-email[1] for description.17381739sendemail.signedoffcc::1740 Deprecated alias for 'sendemail.signedoffbycc'.17411742showbranch.default::1743 The default set of branches for linkgit:git-show-branch[1].1744 See linkgit:git-show-branch[1].17451746status.relativePaths::1747 By default, linkgit:git-status[1] shows paths relative to the1748 current directory. Setting this variable to `false` shows paths1749 relative to the repository root (this was the default for git1750 prior to v1.5.4).17511752status.showUntrackedFiles::1753 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1754 files which are not currently tracked by Git. Directories which1755 contain only untracked files, are shown with the directory name1756 only. Showing untracked files means that Git needs to lstat() all1757 all the files in the whole repository, which might be slow on some1758 systems. So, this variable controls how the commands displays1759 the untracked files. Possible values are:1760+1761--1762 - 'no' - Show no untracked files1763 - 'normal' - Shows untracked files and directories1764 - 'all' - Shows also individual files in untracked directories.1765--1766+1767If this variable is not specified, it defaults to 'normal'.1768This variable can be overridden with the -u|--untracked-files option1769of linkgit:git-status[1] and linkgit:git-commit[1].17701771status.submodulesummary::1772 Defaults to false.1773 If this is set to a non zero number or true (identical to -1 or an1774 unlimited number), the submodule summary will be enabled and a1775 summary of commits for modified submodules will be shown (see1776 --summary-limit option of linkgit:git-submodule[1]).17771778submodule.<name>.path::1779submodule.<name>.url::1780submodule.<name>.update::1781 The path within this project, URL, and the updating strategy1782 for a submodule. These variables are initially populated1783 by 'git submodule init'; edit them to override the1784 URL and other values found in the `.gitmodules` file. See1785 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.17861787submodule.<name>.ignore::1788 Defines under what circumstances "git status" and the diff family show1789 a submodule as modified. When set to "all", it will never be considered1790 modified, "dirty" will ignore all changes to the submodules work tree and1791 takes only differences between the HEAD of the submodule and the commit1792 recorded in the superproject into account. "untracked" will additionally1793 let submodules with modified tracked files in their work tree show up.1794 Using "none" (the default when this option is not set) also shows1795 submodules that have untracked files in their work tree as changed.1796 This setting overrides any setting made in .gitmodules for this submodule,1797 both settings can be overridden on the command line by using the1798 "--ignore-submodules" option.17991800tar.umask::1801 This variable can be used to restrict the permission bits of1802 tar archive entries. The default is 0002, which turns off the1803 world write bit. The special value "user" indicates that the1804 archiving user's umask will be used instead. See umask(2) and1805 linkgit:git-archive[1].18061807transfer.unpackLimit::1808 When `fetch.unpackLimit` or `receive.unpackLimit` are1809 not set, the value of this variable is used instead.1810 The default value is 100.18111812url.<base>.insteadOf::1813 Any URL that starts with this value will be rewritten to1814 start, instead, with <base>. In cases where some site serves a1815 large number of repositories, and serves them with multiple1816 access methods, and some users need to use different access1817 methods, this feature allows people to specify any of the1818 equivalent URLs and have git automatically rewrite the URL to1819 the best alternative for the particular user, even for a1820 never-before-seen repository on the site. When more than one1821 insteadOf strings match a given URL, the longest match is used.18221823url.<base>.pushInsteadOf::1824 Any URL that starts with this value will not be pushed to;1825 instead, it will be rewritten to start with <base>, and the1826 resulting URL will be pushed to. In cases where some site serves1827 a large number of repositories, and serves them with multiple1828 access methods, some of which do not allow push, this feature1829 allows people to specify a pull-only URL and have git1830 automatically use an appropriate URL to push, even for a1831 never-before-seen repository on the site. When more than one1832 pushInsteadOf strings match a given URL, the longest match is1833 used. If a remote has an explicit pushurl, git will ignore this1834 setting for that remote.18351836user.email::1837 Your email address to be recorded in any newly created commits.1838 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1839 'EMAIL' environment variables. See linkgit:git-commit-tree[1].18401841user.name::1842 Your full name to be recorded in any newly created commits.1843 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1844 environment variables. See linkgit:git-commit-tree[1].18451846user.signingkey::1847 If linkgit:git-tag[1] is not selecting the key you want it to1848 automatically when creating a signed tag, you can override the1849 default selection with this variable. This option is passed1850 unchanged to gpg's --local-user parameter, so you may specify a key1851 using any method that gpg supports.18521853web.browser::1854 Specify a web browser that may be used by some commands.1855 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1856 may use it.