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:: 551add.ignoreErrors:: 552 Tells 'git add' to continue adding files when some files cannot be 553 added due to indexing errors. Equivalent to the '--ignore-errors' 554 option of linkgit:git-add[1]. Older versions of git accept only 555 `add.ignore-errors`, which does not follow the usual naming 556 convention for configuration variables. Newer versions of git 557 honor `add.ignoreErrors` as well. 558 559alias.*:: 560 Command aliases for the linkgit:git[1] command wrapper - e.g. 561 after defining "alias.last = cat-file commit HEAD", the invocation 562 "git last" is equivalent to "git cat-file commit HEAD". To avoid 563 confusion and troubles with script usage, aliases that 564 hide existing git commands are ignored. Arguments are split by 565 spaces, the usual shell quoting and escaping is supported. 566 quote pair and a backslash can be used to quote them. 567+ 568If the alias expansion is prefixed with an exclamation point, 569it will be treated as a shell command. For example, defining 570"alias.new = !gitk --all --not ORIG_HEAD", the invocation 571"git new" is equivalent to running the shell command 572"gitk --all --not ORIG_HEAD". Note that shell commands will be 573executed from the top-level directory of a repository, which may 574not necessarily be the current directory. 575 576am.keepcr:: 577 If true, git-am will call git-mailsplit for patches in mbox format 578 with parameter '--keep-cr'. In this case git-mailsplit will 579 not remove `\r` from lines ending with `\r\n`. Can be overridden 580 by giving '--no-keep-cr' from the command line. 581 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 582 583apply.ignorewhitespace:: 584 When set to 'change', tells 'git apply' to ignore changes in 585 whitespace, in the same way as the '--ignore-space-change' 586 option. 587 When set to one of: no, none, never, false tells 'git apply' to 588 respect all whitespace differences. 589 See linkgit:git-apply[1]. 590 591apply.whitespace:: 592 Tells 'git apply' how to handle whitespaces, in the same way 593 as the '--whitespace' option. See linkgit:git-apply[1]. 594 595branch.autosetupmerge:: 596 Tells 'git branch' and 'git checkout' to set up new branches 597 so that linkgit:git-pull[1] will appropriately merge from the 598 starting point branch. Note that even if this option is not set, 599 this behavior can be chosen per-branch using the `--track` 600 and `--no-track` options. The valid settings are: `false` -- no 601 automatic setup is done; `true` -- automatic setup is done when the 602 starting point is a remote branch; `always` -- automatic setup is 603 done when the starting point is either a local branch or remote 604 branch. This option defaults to true. 605 606branch.autosetuprebase:: 607 When a new branch is created with 'git branch' or 'git checkout' 608 that tracks another branch, this variable tells git to set 609 up pull to rebase instead of merge (see "branch.<name>.rebase"). 610 When `never`, rebase is never automatically set to true. 611 When `local`, rebase is set to true for tracked branches of 612 other local branches. 613 When `remote`, rebase is set to true for tracked branches of 614 remote branches. 615 When `always`, rebase will be set to true for all tracking 616 branches. 617 See "branch.autosetupmerge" for details on how to set up a 618 branch to track another branch. 619 This option defaults to never. 620 621branch.<name>.remote:: 622 When in branch <name>, it tells 'git fetch' and 'git push' which 623 remote to fetch from/push to. It defaults to `origin` if no remote is 624 configured. `origin` is also used if you are not on any branch. 625 626branch.<name>.merge:: 627 Defines, together with branch.<name>.remote, the upstream branch 628 for the given branch. It tells 'git fetch'/'git pull' which 629 branch to merge and can also affect 'git push' (see push.default). 630 When in branch <name>, it tells 'git fetch' the default 631 refspec to be marked for merging in FETCH_HEAD. The value is 632 handled like the remote part of a refspec, and must match a 633 ref which is fetched from the remote given by 634 "branch.<name>.remote". 635 The merge information is used by 'git pull' (which at first calls 636 'git fetch') to lookup the default branch for merging. Without 637 this option, 'git pull' defaults to merge the first refspec fetched. 638 Specify multiple values to get an octopus merge. 639 If you wish to setup 'git pull' so that it merges into <name> from 640 another branch in the local repository, you can point 641 branch.<name>.merge to the desired branch, and use the special setting 642 `.` (a period) for branch.<name>.remote. 643 644branch.<name>.mergeoptions:: 645 Sets default options for merging into branch <name>. The syntax and 646 supported options are the same as those of linkgit:git-merge[1], but 647 option values containing whitespace characters are currently not 648 supported. 649 650branch.<name>.rebase:: 651 When true, rebase the branch <name> on top of the fetched branch, 652 instead of merging the default branch from the default remote when 653 "git pull" is run. 654 *NOTE*: this is a possibly dangerous operation; do *not* use 655 it unless you understand the implications (see linkgit:git-rebase[1] 656 for details). 657 658browser.<tool>.cmd:: 659 Specify the command to invoke the specified browser. The 660 specified command is evaluated in shell with the URLs passed 661 as arguments. (See linkgit:git-web--browse[1].) 662 663browser.<tool>.path:: 664 Override the path for the given tool that may be used to 665 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 666 working repository in gitweb (see linkgit:git-instaweb[1]). 667 668clean.requireForce:: 669 A boolean to make git-clean do nothing unless given -f 670 or -n. Defaults to true. 671 672color.branch:: 673 A boolean to enable/disable color in the output of 674 linkgit:git-branch[1]. May be set to `always`, 675 `false` (or `never`) or `auto` (or `true`), in which case colors are used 676 only when the output is to a terminal. Defaults to false. 677 678color.branch.<slot>:: 679 Use customized color for branch coloration. `<slot>` is one of 680 `current` (the current branch), `local` (a local branch), 681 `remote` (a tracking branch in refs/remotes/), `plain` (other 682 refs). 683+ 684The value for these configuration variables is a list of colors (at most 685two) and attributes (at most one), separated by spaces. The colors 686accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 687`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 688`blink` and `reverse`. The first color given is the foreground; the 689second is the background. The position of the attribute, if any, 690doesn't matter. 691 692color.diff:: 693 When set to `always`, always use colors in patch. 694 When false (or `never`), never. When set to `true` or `auto`, use 695 colors only when the output is to the terminal. Defaults to false. 696 697color.diff.<slot>:: 698 Use customized color for diff colorization. `<slot>` specifies 699 which part of the patch to use the specified color, and is one 700 of `plain` (context text), `meta` (metainformation), `frag` 701 (hunk header), 'func' (function in hunk header), `old` (removed lines), 702 `new` (added lines), `commit` (commit headers), or `whitespace` 703 (highlighting whitespace errors). The values of these variables may be 704 specified as in color.branch.<slot>. 705 706color.decorate.<slot>:: 707 Use customized color for 'git log --decorate' output. `<slot>` is one 708 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 709 branches, remote tracking branches, tags, stash and HEAD, respectively. 710 711color.grep:: 712 When set to `always`, always highlight matches. When `false` (or 713 `never`), never. When set to `true` or `auto`, use color only 714 when the output is written to the terminal. Defaults to `false`. 715 716color.grep.<slot>:: 717 Use customized color for grep colorization. `<slot>` specifies which 718 part of the line to use the specified color, and is one of 719+ 720-- 721`context`;; 722 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 723`filename`;; 724 filename prefix (when not using `-h`) 725`function`;; 726 function name lines (when using `-p`) 727`linenumber`;; 728 line number prefix (when using `-n`) 729`match`;; 730 matching text 731`selected`;; 732 non-matching text in selected lines 733`separator`;; 734 separators between fields on a line (`:`, `-`, and `=`) 735 and between hunks (`--`) 736-- 737+ 738The values of these variables may be specified as in color.branch.<slot>. 739 740color.interactive:: 741 When set to `always`, always use colors for interactive prompts 742 and displays (such as those used by "git-add --interactive"). 743 When false (or `never`), never. When set to `true` or `auto`, use 744 colors only when the output is to the terminal. Defaults to false. 745 746color.interactive.<slot>:: 747 Use customized color for 'git add --interactive' 748 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 749 four distinct types of normal output from interactive 750 commands. The values of these variables may be specified as 751 in color.branch.<slot>. 752 753color.pager:: 754 A boolean to enable/disable colored output when the pager is in 755 use (default is true). 756 757color.showbranch:: 758 A boolean to enable/disable color in the output of 759 linkgit:git-show-branch[1]. May be set to `always`, 760 `false` (or `never`) or `auto` (or `true`), in which case colors are used 761 only when the output is to a terminal. Defaults to false. 762 763color.status:: 764 A boolean to enable/disable color in the output of 765 linkgit:git-status[1]. May be set to `always`, 766 `false` (or `never`) or `auto` (or `true`), in which case colors are used 767 only when the output is to a terminal. Defaults to false. 768 769color.status.<slot>:: 770 Use customized color for status colorization. `<slot>` is 771 one of `header` (the header text of the status message), 772 `added` or `updated` (files which are added but not committed), 773 `changed` (files which are changed but not added in the index), 774 `untracked` (files which are not tracked by git), or 775 `nobranch` (the color the 'no branch' warning is shown in, defaulting 776 to red). The values of these variables may be specified as in 777 color.branch.<slot>. 778 779color.ui:: 780 When set to `always`, always use colors in all git commands which 781 are capable of colored output. When false (or `never`), never. When 782 set to `true` or `auto`, use colors only when the output is to the 783 terminal. When more specific variables of color.* are set, they always 784 take precedence over this setting. Defaults to false. 785 786commit.status:: 787 A boolean to enable/disable inclusion of status information in the 788 commit message template when using an editor to prepare the commit 789 message. Defaults to true. 790 791commit.template:: 792 Specify a file to use as the template for new commit messages. 793 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 794 specified user's home directory. 795 796diff.autorefreshindex:: 797 When using 'git diff' to compare with work tree 798 files, do not consider stat-only change as changed. 799 Instead, silently run `git update-index --refresh` to 800 update the cached stat information for paths whose 801 contents in the work tree match the contents in the 802 index. This option defaults to true. Note that this 803 affects only 'git diff' Porcelain, and not lower level 804 'diff' commands such as 'git diff-files'. 805 806diff.external:: 807 If this config variable is set, diff generation is not 808 performed using the internal diff machinery, but using the 809 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 810 environment variable. The command is called with parameters 811 as described under "git Diffs" in linkgit:git[1]. Note: if 812 you want to use an external diff program only on a subset of 813 your files, you might want to use linkgit:gitattributes[5] instead. 814 815diff.mnemonicprefix:: 816 If set, 'git diff' uses a prefix pair that is different from the 817 standard "a/" and "b/" depending on what is being compared. When 818 this configuration is in effect, reverse diff output also swaps 819 the order of the prefixes: 820`git diff`;; 821 compares the (i)ndex and the (w)ork tree; 822`git diff HEAD`;; 823 compares a (c)ommit and the (w)ork tree; 824`git diff --cached`;; 825 compares a (c)ommit and the (i)ndex; 826`git diff HEAD:file1 file2`;; 827 compares an (o)bject and a (w)ork tree entity; 828`git diff --no-index a b`;; 829 compares two non-git things (1) and (2). 830 831diff.noprefix:: 832 If set, 'git diff' does not show any source or destination prefix. 833 834diff.renameLimit:: 835 The number of files to consider when performing the copy/rename 836 detection; equivalent to the 'git diff' option '-l'. 837 838diff.renames:: 839 Tells git to detect renames. If set to any boolean value, it 840 will enable basic rename detection. If set to "copies" or 841 "copy", it will detect copies, as well. 842 843diff.ignoreSubmodules:: 844 Sets the default value of --ignore-submodules. Note that this 845 affects only 'git diff' Porcelain, and not lower level 'diff' 846 commands such as 'git diff-files'. 'git checkout' also honors 847 this setting when reporting uncommitted changes. 848 849diff.suppressBlankEmpty:: 850 A boolean to inhibit the standard behavior of printing a space 851 before each empty output line. Defaults to false. 852 853diff.tool:: 854 Controls which diff tool is used. `diff.tool` overrides 855 `merge.tool` when used by linkgit:git-difftool[1] and has 856 the same valid values as `merge.tool` minus "tortoisemerge" 857 and plus "kompare". 858 859difftool.<tool>.path:: 860 Override the path for the given tool. This is useful in case 861 your tool is not in the PATH. 862 863difftool.<tool>.cmd:: 864 Specify the command to invoke the specified diff tool. 865 The specified command is evaluated in shell with the following 866 variables available: 'LOCAL' is set to the name of the temporary 867 file containing the contents of the diff pre-image and 'REMOTE' 868 is set to the name of the temporary file containing the contents 869 of the diff post-image. 870 871difftool.prompt:: 872 Prompt before each invocation of the diff tool. 873 874diff.wordRegex:: 875 A POSIX Extended Regular Expression used to determine what is a "word" 876 when performing word-by-word difference calculations. Character 877 sequences that match the regular expression are "words", all other 878 characters are *ignorable* whitespace. 879 880fetch.unpackLimit:: 881 If the number of objects fetched over the git native 882 transfer is below this 883 limit, then the objects will be unpacked into loose object 884 files. However if the number of received objects equals or 885 exceeds this limit then the received pack will be stored as 886 a pack, after adding any missing delta bases. Storing the 887 pack from a push can make the push operation complete faster, 888 especially on slow filesystems. If not set, the value of 889 `transfer.unpackLimit` is used instead. 890 891format.attach:: 892 Enable multipart/mixed attachments as the default for 893 'format-patch'. The value can also be a double quoted string 894 which will enable attachments as the default and set the 895 value as the boundary. See the --attach option in 896 linkgit:git-format-patch[1]. 897 898format.numbered:: 899 A boolean which can enable or disable sequence numbers in patch 900 subjects. It defaults to "auto" which enables it only if there 901 is more than one patch. It can be enabled or disabled for all 902 messages by setting it to "true" or "false". See --numbered 903 option in linkgit:git-format-patch[1]. 904 905format.headers:: 906 Additional email headers to include in a patch to be submitted 907 by mail. See linkgit:git-format-patch[1]. 908 909format.to:: 910format.cc:: 911 Additional recipients to include in a patch to be submitted 912 by mail. See the --to and --cc options in 913 linkgit:git-format-patch[1]. 914 915format.subjectprefix:: 916 The default for format-patch is to output files with the '[PATCH]' 917 subject prefix. Use this variable to change that prefix. 918 919format.signature:: 920 The default for format-patch is to output a signature containing 921 the git version number. Use this variable to change that default. 922 Set this variable to the empty string ("") to suppress 923 signature generation. 924 925format.suffix:: 926 The default for format-patch is to output files with the suffix 927 `.patch`. Use this variable to change that suffix (make sure to 928 include the dot if you want it). 929 930format.pretty:: 931 The default pretty format for log/show/whatchanged command, 932 See linkgit:git-log[1], linkgit:git-show[1], 933 linkgit:git-whatchanged[1]. 934 935format.thread:: 936 The default threading style for 'git format-patch'. Can be 937 a boolean value, or `shallow` or `deep`. `shallow` threading 938 makes every mail a reply to the head of the series, 939 where the head is chosen from the cover letter, the 940 `\--in-reply-to`, and the first patch mail, in this order. 941 `deep` threading makes every mail a reply to the previous one. 942 A true boolean value is the same as `shallow`, and a false 943 value disables threading. 944 945format.signoff:: 946 A boolean value which lets you enable the `-s/--signoff` option of 947 format-patch by default. *Note:* Adding the Signed-off-by: line to a 948 patch should be a conscious act and means that you certify you have 949 the rights to submit this work under the same open source license. 950 Please see the 'SubmittingPatches' document for further discussion. 951 952gc.aggressiveWindow:: 953 The window size parameter used in the delta compression 954 algorithm used by 'git gc --aggressive'. This defaults 955 to 250. 956 957gc.auto:: 958 When there are approximately more than this many loose 959 objects in the repository, `git gc --auto` will pack them. 960 Some Porcelain commands use this command to perform a 961 light-weight garbage collection from time to time. The 962 default value is 6700. Setting this to 0 disables it. 963 964gc.autopacklimit:: 965 When there are more than this many packs that are not 966 marked with `*.keep` file in the repository, `git gc 967 --auto` consolidates them into one larger pack. The 968 default value is 50. Setting this to 0 disables it. 969 970gc.packrefs:: 971 Running `git pack-refs` in a repository renders it 972 unclonable by Git versions prior to 1.5.1.2 over dumb 973 transports such as HTTP. This variable determines whether 974 'git gc' runs `git pack-refs`. This can be set to `nobare` 975 to enable it within all non-bare repos or it can be set to a 976 boolean value. The default is `true`. 977 978gc.pruneexpire:: 979 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 980 Override the grace period with this config variable. The value 981 "now" may be used to disable this grace period and always prune 982 unreachable objects immediately. 983 984gc.reflogexpire:: 985gc.<pattern>.reflogexpire:: 986 'git reflog expire' removes reflog entries older than 987 this time; defaults to 90 days. With "<pattern>" (e.g. 988 "refs/stash") in the middle the setting applies only to 989 the refs that match the <pattern>. 990 991gc.reflogexpireunreachable:: 992gc.<ref>.reflogexpireunreachable:: 993 'git reflog expire' removes reflog entries older than 994 this time and are not reachable from the current tip; 995 defaults to 30 days. With "<pattern>" (e.g. "refs/stash") 996 in the middle, the setting applies only to the refs that 997 match the <pattern>. 998 999gc.rerereresolved::1000 Records of conflicted merge you resolved earlier are1001 kept for this many days when 'git rerere gc' is run.1002 The default is 60 days. See linkgit:git-rerere[1].10031004gc.rerereunresolved::1005 Records of conflicted merge you have not resolved are1006 kept for this many days when 'git rerere gc' is run.1007 The default is 15 days. See linkgit:git-rerere[1].10081009gitcvs.commitmsgannotation::1010 Append this string to each commit message. Set to empty string1011 to disable this feature. Defaults to "via git-CVS emulator".10121013gitcvs.enabled::1014 Whether the CVS server interface is enabled for this repository.1015 See linkgit:git-cvsserver[1].10161017gitcvs.logfile::1018 Path to a log file where the CVS server interface well... logs1019 various stuff. See linkgit:git-cvsserver[1].10201021gitcvs.usecrlfattr::1022 If true, the server will look up the end-of-line conversion1023 attributes for files to determine the '-k' modes to use. If1024 the attributes force git to treat a file as text,1025 the '-k' mode will be left blank so CVS clients will1026 treat it as text. If they suppress text conversion, the file1027 will be set with '-kb' mode, which suppresses any newline munging1028 the client might otherwise do. If the attributes do not allow1029 the file type to be determined, then 'gitcvs.allbinary' is1030 used. See linkgit:gitattributes[5].10311032gitcvs.allbinary::1033 This is used if 'gitcvs.usecrlfattr' does not resolve1034 the correct '-kb' mode to use. If true, all1035 unresolved files are sent to the client in1036 mode '-kb'. This causes the client to treat them1037 as binary files, which suppresses any newline munging it1038 otherwise might do. Alternatively, if it is set to "guess",1039 then the contents of the file are examined to decide if1040 it is binary, similar to 'core.autocrlf'.10411042gitcvs.dbname::1043 Database used by git-cvsserver to cache revision information1044 derived from the git repository. The exact meaning depends on the1045 used database driver, for SQLite (which is the default driver) this1046 is a filename. Supports variable substitution (see1047 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1048 Default: '%Ggitcvs.%m.sqlite'10491050gitcvs.dbdriver::1051 Used Perl DBI driver. You can specify any available driver1052 for this here, but it might not work. git-cvsserver is tested1053 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1054 reported *not* to work with 'DBD::mysql'. Experimental feature.1055 May not contain double colons (`:`). Default: 'SQLite'.1056 See linkgit:git-cvsserver[1].10571058gitcvs.dbuser, gitcvs.dbpass::1059 Database user and password. Only useful if setting 'gitcvs.dbdriver',1060 since SQLite has no concept of database users and/or passwords.1061 'gitcvs.dbuser' supports variable substitution (see1062 linkgit:git-cvsserver[1] for details).10631064gitcvs.dbTableNamePrefix::1065 Database table name prefix. Prepended to the names of any1066 database tables used, allowing a single database to be used1067 for several repositories. Supports variable substitution (see1068 linkgit:git-cvsserver[1] for details). Any non-alphabetic1069 characters will be replaced with underscores.10701071All gitcvs variables except for 'gitcvs.usecrlfattr' and1072'gitcvs.allbinary' can also be specified as1073'gitcvs.<access_method>.<varname>' (where 'access_method'1074is one of "ext" and "pserver") to make them apply only for the given1075access method.10761077gui.commitmsgwidth::1078 Defines how wide the commit message window is in the1079 linkgit:git-gui[1]. "75" is the default.10801081gui.diffcontext::1082 Specifies how many context lines should be used in calls to diff1083 made by the linkgit:git-gui[1]. The default is "5".10841085gui.encoding::1086 Specifies the default encoding to use for displaying of1087 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1088 It can be overridden by setting the 'encoding' attribute1089 for relevant files (see linkgit:gitattributes[5]).1090 If this option is not set, the tools default to the1091 locale encoding.10921093gui.matchtrackingbranch::1094 Determines if new branches created with linkgit:git-gui[1] should1095 default to tracking remote branches with matching names or1096 not. Default: "false".10971098gui.newbranchtemplate::1099 Is used as suggested name when creating new branches using the1100 linkgit:git-gui[1].11011102gui.pruneduringfetch::1103 "true" if linkgit:git-gui[1] should prune tracking branches when1104 performing a fetch. The default value is "false".11051106gui.trustmtime::1107 Determines if linkgit:git-gui[1] should trust the file modification1108 timestamp or not. By default the timestamps are not trusted.11091110gui.spellingdictionary::1111 Specifies the dictionary used for spell checking commit messages in1112 the linkgit:git-gui[1]. When set to "none" spell checking is turned1113 off.11141115gui.fastcopyblame::1116 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1117 location detection. It makes blame significantly faster on huge1118 repositories at the expense of less thorough copy detection.11191120gui.copyblamethreshold::1121 Specifies the threshold to use in 'git gui blame' original location1122 detection, measured in alphanumeric characters. See the1123 linkgit:git-blame[1] manual for more information on copy detection.11241125gui.blamehistoryctx::1126 Specifies the radius of history context in days to show in1127 linkgit:gitk[1] for the selected commit, when the `Show History1128 Context` menu item is invoked from 'git gui blame'. If this1129 variable is set to zero, the whole history is shown.11301131guitool.<name>.cmd::1132 Specifies the shell command line to execute when the corresponding item1133 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1134 mandatory for every tool. The command is executed from the root of1135 the working directory, and in the environment it receives the name of1136 the tool as 'GIT_GUITOOL', the name of the currently selected file as1137 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1138 the head is detached, 'CUR_BRANCH' is empty).11391140guitool.<name>.needsfile::1141 Run the tool only if a diff is selected in the GUI. It guarantees1142 that 'FILENAME' is not empty.11431144guitool.<name>.noconsole::1145 Run the command silently, without creating a window to display its1146 output.11471148guitool.<name>.norescan::1149 Don't rescan the working directory for changes after the tool1150 finishes execution.11511152guitool.<name>.confirm::1153 Show a confirmation dialog before actually running the tool.11541155guitool.<name>.argprompt::1156 Request a string argument from the user, and pass it to the tool1157 through the 'ARGS' environment variable. Since requesting an1158 argument implies confirmation, the 'confirm' option has no effect1159 if this is enabled. If the option is set to 'true', 'yes', or '1',1160 the dialog uses a built-in generic prompt; otherwise the exact1161 value of the variable is used.11621163guitool.<name>.revprompt::1164 Request a single valid revision from the user, and set the1165 'REVISION' environment variable. In other aspects this option1166 is similar to 'argprompt', and can be used together with it.11671168guitool.<name>.revunmerged::1169 Show only unmerged branches in the 'revprompt' subdialog.1170 This is useful for tools similar to merge or rebase, but not1171 for things like checkout or reset.11721173guitool.<name>.title::1174 Specifies the title to use for the prompt dialog. The default1175 is the tool name.11761177guitool.<name>.prompt::1178 Specifies the general prompt string to display at the top of1179 the dialog, before subsections for 'argprompt' and 'revprompt'.1180 The default value includes the actual command.11811182help.browser::1183 Specify the browser that will be used to display help in the1184 'web' format. See linkgit:git-help[1].11851186help.format::1187 Override the default help format used by linkgit:git-help[1].1188 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1189 the default. 'web' and 'html' are the same.11901191help.autocorrect::1192 Automatically correct and execute mistyped commands after1193 waiting for the given number of deciseconds (0.1 sec). If more1194 than one command can be deduced from the entered text, nothing1195 will be executed. If the value of this option is negative,1196 the corrected command will be executed immediately. If the1197 value is 0 - the command will be just shown but not executed.1198 This is the default.11991200http.proxy::1201 Override the HTTP proxy, normally configured using the 'http_proxy'1202 environment variable (see linkgit:curl[1]). This can be overridden1203 on a per-remote basis; see remote.<name>.proxy12041205http.sslVerify::1206 Whether to verify the SSL certificate when fetching or pushing1207 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1208 variable.12091210http.sslCert::1211 File containing the SSL certificate when fetching or pushing1212 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1213 variable.12141215http.sslKey::1216 File containing the SSL private key when fetching or pushing1217 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1218 variable.12191220http.sslCertPasswordProtected::1221 Enable git's password prompt for the SSL certificate. Otherwise1222 OpenSSL will prompt the user, possibly many times, if the1223 certificate or private key is encrypted. Can be overridden by the1224 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.12251226http.sslCAInfo::1227 File containing the certificates to verify the peer with when1228 fetching or pushing over HTTPS. Can be overridden by the1229 'GIT_SSL_CAINFO' environment variable.12301231http.sslCAPath::1232 Path containing files with the CA certificates to verify the peer1233 with when fetching or pushing over HTTPS. Can be overridden1234 by the 'GIT_SSL_CAPATH' environment variable.12351236http.maxRequests::1237 How many HTTP requests to launch in parallel. Can be overridden1238 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.12391240http.minSessions::1241 The number of curl sessions (counted across slots) to be kept across1242 requests. They will not be ended with curl_easy_cleanup() until1243 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1244 value will be capped at 1. Defaults to 1.12451246http.postBuffer::1247 Maximum size in bytes of the buffer used by smart HTTP1248 transports when POSTing data to the remote system.1249 For requests larger than this buffer size, HTTP/1.1 and1250 Transfer-Encoding: chunked is used to avoid creating a1251 massive pack file locally. Default is 1 MiB, which is1252 sufficient for most requests.12531254http.lowSpeedLimit, http.lowSpeedTime::1255 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1256 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1257 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1258 'GIT_HTTP_LOW_SPEED_TIME' environment variables.12591260http.noEPSV::1261 A boolean which disables using of EPSV ftp command by curl.1262 This can helpful with some "poor" ftp servers which don't1263 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1264 environment variable. Default is false (curl will use EPSV).12651266http.useragent::1267 The HTTP USER_AGENT string presented to an HTTP server. The default1268 value represents the version of the client git such as git/1.7.1.1269 This option allows you to override this value to a more common value1270 such as Mozilla/4.0. This may be necessary, for instance, if1271 connecting through a firewall that restricts HTTP connections to a set1272 of common USER_AGENT strings (but not including those like git/1.7.1).1273 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.12741275i18n.commitEncoding::1276 Character encoding the commit messages are stored in; git itself1277 does not care per se, but this information is necessary e.g. when1278 importing commits from emails or in the gitk graphical history1279 browser (and possibly at other places in the future or in other1280 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.12811282i18n.logOutputEncoding::1283 Character encoding the commit messages are converted to when1284 running 'git log' and friends.12851286imap::1287 The configuration variables in the 'imap' section are described1288 in linkgit:git-imap-send[1].12891290init.templatedir::1291 Specify the directory from which templates will be copied.1292 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)12931294instaweb.browser::1295 Specify the program that will be used to browse your working1296 repository in gitweb. See linkgit:git-instaweb[1].12971298instaweb.httpd::1299 The HTTP daemon command-line to start gitweb on your working1300 repository. See linkgit:git-instaweb[1].13011302instaweb.local::1303 If true the web server started by linkgit:git-instaweb[1] will1304 be bound to the local IP (127.0.0.1).13051306instaweb.modulepath::1307 The default module path for linkgit:git-instaweb[1] to use1308 instead of /usr/lib/apache2/modules. Only used if httpd1309 is Apache.13101311instaweb.port::1312 The port number to bind the gitweb httpd to. See1313 linkgit:git-instaweb[1].13141315interactive.singlekey::1316 In interactive commands, allow the user to provide one-letter1317 input with a single key (i.e., without hitting enter).1318 Currently this is used only by the `\--patch` mode of1319 linkgit:git-add[1]. Note that this setting is silently1320 ignored if portable keystroke input is not available.13211322log.date::1323 Set the default date-time mode for the 'log' command.1324 Setting a value for log.date is similar to using 'git log''s1325 `\--date` option. Possible values are `relative`, `local`,1326 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1327 for details.13281329log.decorate::1330 Print out the ref names of any commits that are shown by the log1331 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1332 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1333 specified, the full ref name (including prefix) will be printed.1334 This is the same as the log commands '--decorate' option.13351336log.showroot::1337 If true, the initial commit will be shown as a big creation event.1338 This is equivalent to a diff against an empty tree.1339 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1340 normally hide the root commit will now show it. True by default.13411342mailmap.file::1343 The location of an augmenting mailmap file. The default1344 mailmap, located in the root of the repository, is loaded1345 first, then the mailmap file pointed to by this variable.1346 The location of the mailmap file may be in a repository1347 subdirectory, or somewhere outside of the repository itself.1348 See linkgit:git-shortlog[1] and linkgit:git-blame[1].13491350man.viewer::1351 Specify the programs that may be used to display help in the1352 'man' format. See linkgit:git-help[1].13531354man.<tool>.cmd::1355 Specify the command to invoke the specified man viewer. The1356 specified command is evaluated in shell with the man page1357 passed as argument. (See linkgit:git-help[1].)13581359man.<tool>.path::1360 Override the path for the given tool that may be used to1361 display help in the 'man' format. See linkgit:git-help[1].13621363include::merge-config.txt[]13641365mergetool.<tool>.path::1366 Override the path for the given tool. This is useful in case1367 your tool is not in the PATH.13681369mergetool.<tool>.cmd::1370 Specify the command to invoke the specified merge tool. The1371 specified command is evaluated in shell with the following1372 variables available: 'BASE' is the name of a temporary file1373 containing the common base of the files to be merged, if available;1374 'LOCAL' is the name of a temporary file containing the contents of1375 the file on the current branch; 'REMOTE' is the name of a temporary1376 file containing the contents of the file from the branch being1377 merged; 'MERGED' contains the name of the file to which the merge1378 tool should write the results of a successful merge.13791380mergetool.<tool>.trustExitCode::1381 For a custom merge command, specify whether the exit code of1382 the merge command can be used to determine whether the merge was1383 successful. If this is not set to true then the merge target file1384 timestamp is checked and the merge assumed to have been successful1385 if the file has been updated, otherwise the user is prompted to1386 indicate the success of the merge.13871388mergetool.keepBackup::1389 After performing a merge, the original file with conflict markers1390 can be saved as a file with a `.orig` extension. If this variable1391 is set to `false` then this file is not preserved. Defaults to1392 `true` (i.e. keep the backup files).13931394mergetool.keepTemporaries::1395 When invoking a custom merge tool, git uses a set of temporary1396 files to pass to the tool. If the tool returns an error and this1397 variable is set to `true`, then these temporary files will be1398 preserved, otherwise they will be removed after the tool has1399 exited. Defaults to `false`.14001401mergetool.prompt::1402 Prompt before each invocation of the merge resolution program.14031404notes.displayRef::1405 The (fully qualified) refname from which to show notes when1406 showing commit messages. The value of this variable can be set1407 to a glob, in which case notes from all matching refs will be1408 shown. You may also specify this configuration variable1409 several times. A warning will be issued for refs that do not1410 exist, but a glob that does not match any refs is silently1411 ignored.1412+1413This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1414environment variable, which must be a colon separated list of refs or1415globs.1416+1417The effective value of "core.notesRef" (possibly overridden by1418GIT_NOTES_REF) is also implicitly added to the list of refs to be1419displayed.14201421notes.rewrite.<command>::1422 When rewriting commits with <command> (currently `amend` or1423 `rebase`) and this variable is set to `true`, git1424 automatically copies your notes from the original to the1425 rewritten commit. Defaults to `true`, but see1426 "notes.rewriteRef" below.14271428notes.rewriteMode::1429 When copying notes during a rewrite (see the1430 "notes.rewrite.<command>" option), determines what to do if1431 the target commit already has a note. Must be one of1432 `overwrite`, `concatenate`, or `ignore`. Defaults to1433 `concatenate`.1434+1435This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1436environment variable.14371438notes.rewriteRef::1439 When copying notes during a rewrite, specifies the (fully1440 qualified) ref whose notes should be copied. The ref may be a1441 glob, in which case notes in all matching refs will be copied.1442 You may also specify this configuration several times.1443+1444Does not have a default value; you must configure this variable to1445enable note rewriting.1446+1447This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1448environment variable, which must be a colon separated list of refs or1449globs.14501451pack.window::1452 The size of the window used by linkgit:git-pack-objects[1] when no1453 window size is given on the command line. Defaults to 10.14541455pack.depth::1456 The maximum delta depth used by linkgit:git-pack-objects[1] when no1457 maximum depth is given on the command line. Defaults to 50.14581459pack.windowMemory::1460 The window memory size limit used by linkgit:git-pack-objects[1]1461 when no limit is given on the command line. The value can be1462 suffixed with "k", "m", or "g". Defaults to 0, meaning no1463 limit.14641465pack.compression::1466 An integer -1..9, indicating the compression level for objects1467 in a pack file. -1 is the zlib default. 0 means no1468 compression, and 1..9 are various speed/size tradeoffs, 9 being1469 slowest. If not set, defaults to core.compression. If that is1470 not set, defaults to -1, the zlib default, which is "a default1471 compromise between speed and compression (currently equivalent1472 to level 6)."1473+1474Note that changing the compression level will not automatically recompress1475all existing objects. You can force recompression by passing the -F option1476to linkgit:git-repack[1].14771478pack.deltaCacheSize::1479 The maximum memory in bytes used for caching deltas in1480 linkgit:git-pack-objects[1] before writing them out to a pack.1481 This cache is used to speed up the writing object phase by not1482 having to recompute the final delta result once the best match1483 for all objects is found. Repacking large repositories on machines1484 which are tight with memory might be badly impacted by this though,1485 especially if this cache pushes the system into swapping.1486 A value of 0 means no limit. The smallest size of 1 byte may be1487 used to virtually disable this cache. Defaults to 256 MiB.14881489pack.deltaCacheLimit::1490 The maximum size of a delta, that is cached in1491 linkgit:git-pack-objects[1]. This cache is used to speed up the1492 writing object phase by not having to recompute the final delta1493 result once the best match for all objects is found. Defaults to 1000.14941495pack.threads::1496 Specifies the number of threads to spawn when searching for best1497 delta matches. This requires that linkgit:git-pack-objects[1]1498 be compiled with pthreads otherwise this option is ignored with a1499 warning. This is meant to reduce packing time on multiprocessor1500 machines. The required amount of memory for the delta search window1501 is however multiplied by the number of threads.1502 Specifying 0 will cause git to auto-detect the number of CPU's1503 and set the number of threads accordingly.15041505pack.indexVersion::1506 Specify the default pack index version. Valid values are 1 for1507 legacy pack index used by Git versions prior to 1.5.2, and 2 for1508 the new pack index with capabilities for packs larger than 4 GB1509 as well as proper protection against the repacking of corrupted1510 packs. Version 2 is the default. Note that version 2 is enforced1511 and this config option ignored whenever the corresponding pack is1512 larger than 2 GB.1513+1514If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1515cloning or fetching over a non native protocol (e.g. "http" and "rsync")1516that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1517other side may give you a repository that cannot be accessed with your1518older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1519you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1520the `{asterisk}.idx` file.15211522pack.packSizeLimit::1523 The maximum size of a pack. This setting only affects1524 packing to a file when repacking, i.e. the git:// protocol1525 is unaffected. It can be overridden by the `\--max-pack-size`1526 option of linkgit:git-repack[1]. The minimum size allowed is1527 limited to 1 MiB. The default is unlimited.1528 Common unit suffixes of 'k', 'm', or 'g' are1529 supported.15301531pager.<cmd>::1532 Allows turning on or off pagination of the output of a1533 particular git subcommand when writing to a tty. If1534 `\--paginate` or `\--no-pager` is specified on the command line,1535 it takes precedence over this option. To disable pagination for1536 all commands, set `core.pager` or `GIT_PAGER` to `cat`.15371538pretty.<name>::1539 Alias for a --pretty= format string, as specified in1540 linkgit:git-log[1]. Any aliases defined here can be used just1541 as the built-in pretty formats could. For example,1542 running `git config pretty.changelog "format:{asterisk} %H %s"`1543 would cause the invocation `git log --pretty=changelog`1544 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.1545 Note that an alias with the same name as a built-in format1546 will be silently ignored.15471548pull.octopus::1549 The default merge strategy to use when pulling multiple branches1550 at once.15511552pull.twohead::1553 The default merge strategy to use when pulling a single branch.15541555push.default::1556 Defines the action git push should take if no refspec is given1557 on the command line, no refspec is configured in the remote, and1558 no refspec is implied by any of the options given on the command1559 line. Possible values are:1560+1561* `nothing` - do not push anything.1562* `matching` - push all matching branches.1563 All branches having the same name in both ends are considered to be1564 matching. This is the default.1565* `tracking` - push the current branch to its upstream branch.1566* `current` - push the current branch to a branch of the same name.15671568rebase.stat::1569 Whether to show a diffstat of what changed upstream since the last1570 rebase. False by default.15711572rebase.autosquash::1573 If set to true enable '--autosquash' option by default.15741575receive.autogc::1576 By default, git-receive-pack will run "git-gc --auto" after1577 receiving data from git-push and updating refs. You can stop1578 it by setting this variable to false.15791580receive.fsckObjects::1581 If it is set to true, git-receive-pack will check all received1582 objects. It will abort in the case of a malformed object or a1583 broken link. The result of an abort are only dangling objects.1584 Defaults to false.15851586receive.unpackLimit::1587 If the number of objects received in a push is below this1588 limit then the objects will be unpacked into loose object1589 files. However if the number of received objects equals or1590 exceeds this limit then the received pack will be stored as1591 a pack, after adding any missing delta bases. Storing the1592 pack from a push can make the push operation complete faster,1593 especially on slow filesystems. If not set, the value of1594 `transfer.unpackLimit` is used instead.15951596receive.denyDeletes::1597 If set to true, git-receive-pack will deny a ref update that deletes1598 the ref. Use this to prevent such a ref deletion via a push.15991600receive.denyDeleteCurrent::1601 If set to true, git-receive-pack will deny a ref update that1602 deletes the currently checked out branch of a non-bare repository.16031604receive.denyCurrentBranch::1605 If set to true or "refuse", git-receive-pack will deny a ref update1606 to the currently checked out branch of a non-bare repository.1607 Such a push is potentially dangerous because it brings the HEAD1608 out of sync with the index and working tree. If set to "warn",1609 print a warning of such a push to stderr, but allow the push to1610 proceed. If set to false or "ignore", allow such pushes with no1611 message. Defaults to "refuse".16121613receive.denyNonFastForwards::1614 If set to true, git-receive-pack will deny a ref update which is1615 not a fast-forward. Use this to prevent such an update via a push,1616 even if that push is forced. This configuration variable is1617 set when initializing a shared repository.16181619receive.updateserverinfo::1620 If set to true, git-receive-pack will run git-update-server-info1621 after receiving data from git-push and updating refs.16221623remote.<name>.url::1624 The URL of a remote repository. See linkgit:git-fetch[1] or1625 linkgit:git-push[1].16261627remote.<name>.pushurl::1628 The push URL of a remote repository. See linkgit:git-push[1].16291630remote.<name>.proxy::1631 For remotes that require curl (http, https and ftp), the URL to1632 the proxy to use for that remote. Set to the empty string to1633 disable proxying for that remote.16341635remote.<name>.fetch::1636 The default set of "refspec" for linkgit:git-fetch[1]. See1637 linkgit:git-fetch[1].16381639remote.<name>.push::1640 The default set of "refspec" for linkgit:git-push[1]. See1641 linkgit:git-push[1].16421643remote.<name>.mirror::1644 If true, pushing to this remote will automatically behave1645 as if the `\--mirror` option was given on the command line.16461647remote.<name>.skipDefaultUpdate::1648 If true, this remote will be skipped by default when updating1649 using linkgit:git-fetch[1] or the `update` subcommand of1650 linkgit:git-remote[1].16511652remote.<name>.skipFetchAll::1653 If true, this remote will be skipped by default when updating1654 using linkgit:git-fetch[1] or the `update` subcommand of1655 linkgit:git-remote[1].16561657remote.<name>.receivepack::1658 The default program to execute on the remote side when pushing. See1659 option \--receive-pack of linkgit:git-push[1].16601661remote.<name>.uploadpack::1662 The default program to execute on the remote side when fetching. See1663 option \--upload-pack of linkgit:git-fetch-pack[1].16641665remote.<name>.tagopt::1666 Setting this value to \--no-tags disables automatic tag following when1667 fetching from remote <name>. Setting it to \--tags will fetch every1668 tag from remote <name>, even if they are not reachable from remote1669 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1670 override this setting. See options \--tags and \--no-tags of1671 linkgit:git-fetch[1].16721673remote.<name>.vcs::1674 Setting this to a value <vcs> will cause git to interact with1675 the remote with the git-remote-<vcs> helper.16761677remotes.<group>::1678 The list of remotes which are fetched by "git remote update1679 <group>". See linkgit:git-remote[1].16801681repack.usedeltabaseoffset::1682 By default, linkgit:git-repack[1] creates packs that use1683 delta-base offset. If you need to share your repository with1684 git older than version 1.4.4, either directly or via a dumb1685 protocol such as http, then you need to set this option to1686 "false" and repack. Access from old git versions over the1687 native protocol are unaffected by this option.16881689rerere.autoupdate::1690 When set to true, `git-rerere` updates the index with the1691 resulting contents after it cleanly resolves conflicts using1692 previously recorded resolution. Defaults to false.16931694rerere.enabled::1695 Activate recording of resolved conflicts, so that identical1696 conflict hunks can be resolved automatically, should they1697 be encountered again. linkgit:git-rerere[1] command is by1698 default enabled if you create `rr-cache` directory under1699 `$GIT_DIR`, but can be disabled by setting this option to false.17001701sendemail.identity::1702 A configuration identity. When given, causes values in the1703 'sendemail.<identity>' subsection to take precedence over1704 values in the 'sendemail' section. The default identity is1705 the value of 'sendemail.identity'.17061707sendemail.smtpencryption::1708 See linkgit:git-send-email[1] for description. Note that this1709 setting is not subject to the 'identity' mechanism.17101711sendemail.smtpssl::1712 Deprecated alias for 'sendemail.smtpencryption = ssl'.17131714sendemail.<identity>.*::1715 Identity-specific versions of the 'sendemail.*' parameters1716 found below, taking precedence over those when the this1717 identity is selected, through command-line or1718 'sendemail.identity'.17191720sendemail.aliasesfile::1721sendemail.aliasfiletype::1722sendemail.bcc::1723sendemail.cc::1724sendemail.cccmd::1725sendemail.chainreplyto::1726sendemail.confirm::1727sendemail.envelopesender::1728sendemail.from::1729sendemail.multiedit::1730sendemail.signedoffbycc::1731sendemail.smtppass::1732sendemail.suppresscc::1733sendemail.suppressfrom::1734sendemail.to::1735sendemail.smtpdomain::1736sendemail.smtpserver::1737sendemail.smtpserverport::1738sendemail.smtpuser::1739sendemail.thread::1740sendemail.validate::1741 See linkgit:git-send-email[1] for description.17421743sendemail.signedoffcc::1744 Deprecated alias for 'sendemail.signedoffbycc'.17451746showbranch.default::1747 The default set of branches for linkgit:git-show-branch[1].1748 See linkgit:git-show-branch[1].17491750status.relativePaths::1751 By default, linkgit:git-status[1] shows paths relative to the1752 current directory. Setting this variable to `false` shows paths1753 relative to the repository root (this was the default for git1754 prior to v1.5.4).17551756status.showUntrackedFiles::1757 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1758 files which are not currently tracked by Git. Directories which1759 contain only untracked files, are shown with the directory name1760 only. Showing untracked files means that Git needs to lstat() all1761 all the files in the whole repository, which might be slow on some1762 systems. So, this variable controls how the commands displays1763 the untracked files. Possible values are:1764+1765--1766* `no` - Show no untracked files.1767* `normal` - Show untracked files and directories.1768* `all` - Show also individual files in untracked directories.1769--1770+1771If this variable is not specified, it defaults to 'normal'.1772This variable can be overridden with the -u|--untracked-files option1773of linkgit:git-status[1] and linkgit:git-commit[1].17741775status.submodulesummary::1776 Defaults to false.1777 If this is set to a non zero number or true (identical to -1 or an1778 unlimited number), the submodule summary will be enabled and a1779 summary of commits for modified submodules will be shown (see1780 --summary-limit option of linkgit:git-submodule[1]).17811782submodule.<name>.path::1783submodule.<name>.url::1784submodule.<name>.update::1785 The path within this project, URL, and the updating strategy1786 for a submodule. These variables are initially populated1787 by 'git submodule init'; edit them to override the1788 URL and other values found in the `.gitmodules` file. See1789 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.17901791submodule.<name>.ignore::1792 Defines under what circumstances "git status" and the diff family show1793 a submodule as modified. When set to "all", it will never be considered1794 modified, "dirty" will ignore all changes to the submodules work tree and1795 takes only differences between the HEAD of the submodule and the commit1796 recorded in the superproject into account. "untracked" will additionally1797 let submodules with modified tracked files in their work tree show up.1798 Using "none" (the default when this option is not set) also shows1799 submodules that have untracked files in their work tree as changed.1800 This setting overrides any setting made in .gitmodules for this submodule,1801 both settings can be overridden on the command line by using the1802 "--ignore-submodules" option.18031804tar.umask::1805 This variable can be used to restrict the permission bits of1806 tar archive entries. The default is 0002, which turns off the1807 world write bit. The special value "user" indicates that the1808 archiving user's umask will be used instead. See umask(2) and1809 linkgit:git-archive[1].18101811transfer.unpackLimit::1812 When `fetch.unpackLimit` or `receive.unpackLimit` are1813 not set, the value of this variable is used instead.1814 The default value is 100.18151816url.<base>.insteadOf::1817 Any URL that starts with this value will be rewritten to1818 start, instead, with <base>. In cases where some site serves a1819 large number of repositories, and serves them with multiple1820 access methods, and some users need to use different access1821 methods, this feature allows people to specify any of the1822 equivalent URLs and have git automatically rewrite the URL to1823 the best alternative for the particular user, even for a1824 never-before-seen repository on the site. When more than one1825 insteadOf strings match a given URL, the longest match is used.18261827url.<base>.pushInsteadOf::1828 Any URL that starts with this value will not be pushed to;1829 instead, it will be rewritten to start with <base>, and the1830 resulting URL will be pushed to. In cases where some site serves1831 a large number of repositories, and serves them with multiple1832 access methods, some of which do not allow push, this feature1833 allows people to specify a pull-only URL and have git1834 automatically use an appropriate URL to push, even for a1835 never-before-seen repository on the site. When more than one1836 pushInsteadOf strings match a given URL, the longest match is1837 used. If a remote has an explicit pushurl, git will ignore this1838 setting for that remote.18391840user.email::1841 Your email address to be recorded in any newly created commits.1842 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1843 'EMAIL' environment variables. See linkgit:git-commit-tree[1].18441845user.name::1846 Your full name to be recorded in any newly created commits.1847 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1848 environment variables. See linkgit:git-commit-tree[1].18491850user.signingkey::1851 If linkgit:git-tag[1] is not selecting the key you want it to1852 automatically when creating a signed tag, you can override the1853 default selection with this variable. This option is passed1854 unchanged to gpg's --local-user parameter, so you may specify a key1855 using any method that gpg supports.18561857web.browser::1858 Specify a web browser that may be used by some commands.1859 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1860 may use it.