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-- 130 131core.fileMode:: 132 If false, the executable bit differences between the index and 133 the working copy are ignored; useful on broken filesystems like FAT. 134 See linkgit:git-update-index[1]. True by default. 135 136core.ignoreCygwinFSTricks:: 137 This option is only used by Cygwin implementation of Git. If false, 138 the Cygwin stat() and lstat() functions are used. This may be useful 139 if your repository consists of a few separate directories joined in 140 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 141 whenever it is possible and falls back to Cygwin functions only to 142 handle symbol links. The native mode is more than twice faster than 143 normal Cygwin l/stat() functions. True by default, unless core.filemode 144 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 145 POSIX emulation is required to support core.filemode. 146 147core.trustctime:: 148 If false, the ctime differences between the index and the 149 working copy are ignored; useful when the inode change time 150 is regularly modified by something outside Git (file system 151 crawlers and some backup systems). 152 See linkgit:git-update-index[1]. True by default. 153 154core.quotepath:: 155 The commands that output paths (e.g. 'ls-files', 156 'diff'), when not given the `-z` option, will quote 157 "unusual" characters in the pathname by enclosing the 158 pathname in a double-quote pair and with backslashes the 159 same way strings in C source code are quoted. If this 160 variable is set to false, the bytes higher than 0x80 are 161 not quoted but output as verbatim. Note that double 162 quote, backslash and control characters are always 163 quoted without `-z` regardless of the setting of this 164 variable. 165 166core.autocrlf:: 167 If true, makes git convert `CRLF` at the end of lines in text files to 168 `LF` when reading from the filesystem, and convert in reverse when 169 writing to the filesystem. The variable can be set to 170 'input', in which case the conversion happens only while 171 reading from the filesystem but files are written out with 172 `LF` at the end of lines. Currently, which paths to consider 173 "text" (i.e. be subjected to the autocrlf mechanism) is 174 decided purely based on the contents. 175 176core.safecrlf:: 177 If true, makes git check if converting `CRLF` as controlled by 178 `core.autocrlf` is reversible. Git will verify if a command 179 modifies a file in the work tree either directly or indirectly. 180 For example, committing a file followed by checking out the 181 same file should yield the original file in the work tree. If 182 this is not the case for the current setting of 183 `core.autocrlf`, git will reject the file. The variable can 184 be set to "warn", in which case git will only warn about an 185 irreversible conversion but continue the operation. 186+ 187CRLF conversion bears a slight chance of corrupting data. 188autocrlf=true will convert CRLF to LF during commit and LF to 189CRLF during checkout. A file that contains a mixture of LF and 190CRLF before the commit cannot be recreated by git. For text 191files this is the right thing to do: it corrects line endings 192such that we have only LF line endings in the repository. 193But for binary files that are accidentally classified as text the 194conversion can corrupt data. 195+ 196If you recognize such corruption early you can easily fix it by 197setting the conversion type explicitly in .gitattributes. Right 198after committing you still have the original file in your work 199tree and this file is not yet corrupted. You can explicitly tell 200git that this file is binary and git will handle the file 201appropriately. 202+ 203Unfortunately, the desired effect of cleaning up text files with 204mixed line endings and the undesired effect of corrupting binary 205files cannot be distinguished. In both cases CRLFs are removed 206in an irreversible way. For text files this is the right thing 207to do because CRLFs are line endings, while for binary files 208converting CRLFs corrupts data. 209+ 210Note, this safety check does not mean that a checkout will generate a 211file identical to the original file for a different setting of 212`core.autocrlf`, but only for the current one. For example, a text 213file with `LF` would be accepted with `core.autocrlf=input` and could 214later be checked out with `core.autocrlf=true`, in which case the 215resulting file would contain `CRLF`, although the original file 216contained `LF`. However, in both work trees the line endings would be 217consistent, that is either all `LF` or all `CRLF`, but never mixed. A 218file with mixed line endings would be reported by the `core.safecrlf` 219mechanism. 220 221core.symlinks:: 222 If false, symbolic links are checked out as small plain files that 223 contain the link text. linkgit:git-update-index[1] and 224 linkgit:git-add[1] will not change the recorded type to regular 225 file. Useful on filesystems like FAT that do not support 226 symbolic links. True by default. 227 228core.gitProxy:: 229 A "proxy command" to execute (as 'command host port') instead 230 of establishing direct connection to the remote server when 231 using the git protocol for fetching. If the variable value is 232 in the "COMMAND for DOMAIN" format, the command is applied only 233 on hostnames ending with the specified domain string. This variable 234 may be set multiple times and is matched in the given order; 235 the first match wins. 236+ 237Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 238(which always applies universally, without the special "for" 239handling). 240+ 241The special string `none` can be used as the proxy command to 242specify that no proxy be used for a given domain pattern. 243This is useful for excluding servers inside a firewall from 244proxy use, while defaulting to a common proxy for external domains. 245 246core.ignoreStat:: 247 If true, commands which modify both the working tree and the index 248 will mark the updated paths with the "assume unchanged" bit in the 249 index. These marked files are then assumed to stay unchanged in the 250 working copy, until you mark them otherwise manually - Git will not 251 detect the file changes by lstat() calls. This is useful on systems 252 where those are very slow, such as Microsoft Windows. 253 See linkgit:git-update-index[1]. 254 False by default. 255 256core.preferSymlinkRefs:: 257 Instead of the default "symref" format for HEAD 258 and other symbolic reference files, use symbolic links. 259 This is sometimes needed to work with old scripts that 260 expect HEAD to be a symbolic link. 261 262core.bare:: 263 If true this repository is assumed to be 'bare' and has no 264 working directory associated with it. If this is the case a 265 number of commands that require a working directory will be 266 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 267+ 268This setting is automatically guessed by linkgit:git-clone[1] or 269linkgit:git-init[1] when the repository was created. By default a 270repository that ends in "/.git" is assumed to be not bare (bare = 271false), while all other repositories are assumed to be bare (bare 272= true). 273 274core.worktree:: 275 Set the path to the working tree. The value will not be 276 used in combination with repositories found automatically in 277 a .git directory (i.e. $GIT_DIR is not set). 278 This can be overridden by the GIT_WORK_TREE environment 279 variable and the '--work-tree' command line option. It can be 280 a absolute path or relative path to the directory specified by 281 --git-dir or GIT_DIR. 282 Note: If --git-dir or GIT_DIR are specified but none of 283 --work-tree, GIT_WORK_TREE and core.worktree is specified, 284 the current working directory is regarded as the top directory 285 of your working tree. 286 287core.logAllRefUpdates:: 288 Enable the reflog. Updates to a ref <ref> is logged to the file 289 "$GIT_DIR/logs/<ref>", by appending the new and old 290 SHA1, the date/time and the reason of the update, but 291 only when the file exists. If this configuration 292 variable is set to true, missing "$GIT_DIR/logs/<ref>" 293 file is automatically created for branch heads. 294+ 295This information can be used to determine what commit 296was the tip of a branch "2 days ago". 297+ 298This value is true by default in a repository that has 299a working directory associated with it, and false by 300default in a bare repository. 301 302core.repositoryFormatVersion:: 303 Internal variable identifying the repository format and layout 304 version. 305 306core.sharedRepository:: 307 When 'group' (or 'true'), the repository is made shareable between 308 several users in a group (making sure all the files and objects are 309 group-writable). When 'all' (or 'world' or 'everybody'), the 310 repository will be readable by all users, additionally to being 311 group-shareable. When 'umask' (or 'false'), git will use permissions 312 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 313 files in the repository will have this mode value. '0xxx' will override 314 user's umask value (whereas the other options will only override 315 requested parts of the user's umask value). Examples: '0660' will make 316 the repo read/write-able for the owner and group, but inaccessible to 317 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 318 repository that is group-readable but not group-writable. 319 See linkgit:git-init[1]. False by default. 320 321core.warnAmbiguousRefs:: 322 If true, git will warn you if the ref name you passed it is ambiguous 323 and might match multiple refs in the .git/refs/ tree. True by default. 324 325core.compression:: 326 An integer -1..9, indicating a default compression level. 327 -1 is the zlib default. 0 means no compression, 328 and 1..9 are various speed/size tradeoffs, 9 being slowest. 329 If set, this provides a default to other compression variables, 330 such as 'core.loosecompression' and 'pack.compression'. 331 332core.loosecompression:: 333 An integer -1..9, indicating the compression level for objects that 334 are not in a pack file. -1 is the zlib default. 0 means no 335 compression, and 1..9 are various speed/size tradeoffs, 9 being 336 slowest. If not set, defaults to core.compression. If that is 337 not set, defaults to 1 (best speed). 338 339core.packedGitWindowSize:: 340 Number of bytes of a pack file to map into memory in a 341 single mapping operation. Larger window sizes may allow 342 your system to process a smaller number of large pack files 343 more quickly. Smaller window sizes will negatively affect 344 performance due to increased calls to the operating system's 345 memory manager, but may improve performance when accessing 346 a large number of large pack files. 347+ 348Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 349MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 350be reasonable for all users/operating systems. You probably do 351not need to adjust this value. 352+ 353Common unit suffixes of 'k', 'm', or 'g' are supported. 354 355core.packedGitLimit:: 356 Maximum number of bytes to map simultaneously into memory 357 from pack files. If Git needs to access more than this many 358 bytes at once to complete an operation it will unmap existing 359 regions to reclaim virtual address space within the process. 360+ 361Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 362This should be reasonable for all users/operating systems, except on 363the largest projects. You probably do not need to adjust this value. 364+ 365Common unit suffixes of 'k', 'm', or 'g' are supported. 366 367core.deltaBaseCacheLimit:: 368 Maximum number of bytes to reserve for caching base objects 369 that multiple deltafied objects reference. By storing the 370 entire decompressed base objects in a cache Git is able 371 to avoid unpacking and decompressing frequently used base 372 objects multiple times. 373+ 374Default is 16 MiB on all platforms. This should be reasonable 375for all users/operating systems, except on the largest projects. 376You probably do not need to adjust this value. 377+ 378Common unit suffixes of 'k', 'm', or 'g' are supported. 379 380core.excludesfile:: 381 In addition to '.gitignore' (per-directory) and 382 '.git/info/exclude', git looks into this file for patterns 383 of files which are not meant to be tracked. "~/" and "~user/" 384 are expanded to the specified user's home directory. See 385 linkgit:gitignore[5]. 386 387core.editor:: 388 Commands such as `commit` and `tag` that lets you edit 389 messages by launching an editor uses the value of this 390 variable when it is set, and the environment variable 391 `GIT_EDITOR` is not set. The order of preference is 392 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and 393 `EDITOR` environment variables and then finally `vi`. 394 395core.pager:: 396 The command that git will use to paginate output. Can 397 be overridden with the `GIT_PAGER` environment 398 variable. Note that git sets the `LESS` environment 399 variable to `FRSX` if it is unset when it runs the 400 pager. One can change these settings by setting the 401 `LESS` variable to some other value. Alternately, 402 these settings can be overridden on a project or 403 global basis by setting the `core.pager` option. 404 Setting `core.pager` has no affect on the `LESS` 405 environment variable behaviour above, so if you want 406 to override git's default settings this way, you need 407 to be explicit. For example, to disable the S option 408 in a backward compatible manner, set `core.pager` 409 to `less -+$LESS -FRX`. This will be passed to the 410 shell by git, which will translate the final command to 411 `LESS=FRSX less -+FRSX -FRX`. 412 413core.whitespace:: 414 A comma separated list of common whitespace problems to 415 notice. 'git-diff' will use `color.diff.whitespace` to 416 highlight them, and 'git-apply --whitespace=error' will 417 consider them as errors. You can prefix `-` to disable 418 any of them (e.g. `-trailing-space`): 419+ 420* `trailing-space` treats trailing whitespaces at the end of the line 421 as an error (enabled by default). 422* `space-before-tab` treats a space character that appears immediately 423 before a tab character in the initial indent part of the line as an 424 error (enabled by default). 425* `indent-with-non-tab` treats a line that is indented with 8 or more 426 space characters as an error (not enabled by default). 427* `cr-at-eol` treats a carriage-return at the end of line as 428 part of the line terminator, i.e. with it, `trailing-space` 429 does not trigger if the character before such a carriage-return 430 is not a whitespace (not enabled by default). 431 432core.fsyncobjectfiles:: 433 This boolean will enable 'fsync()' when writing object files. 434+ 435This is a total waste of time and effort on a filesystem that orders 436data writes properly, but can be useful for filesystems that do not use 437journalling (traditional UNIX filesystems) or that only journal metadata 438and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 439 440core.preloadindex:: 441 Enable parallel index preload for operations like 'git diff' 442+ 443This can speed up operations like 'git diff' and 'git status' especially 444on filesystems like NFS that have weak caching semantics and thus 445relatively high IO latencies. With this set to 'true', git will do the 446index comparison to the filesystem data in parallel, allowing 447overlapping IO's. 448 449core.createObject:: 450 You can set this to 'link', in which case a hardlink followed by 451 a delete of the source are used to make sure that object creation 452 will not overwrite existing objects. 453+ 454On some file system/operating system combinations, this is unreliable. 455Set this config setting to 'rename' there; However, This will remove the 456check that makes sure that existing object files will not get overwritten. 457 458add.ignore-errors:: 459 Tells 'git-add' to continue adding files when some files cannot be 460 added due to indexing errors. Equivalent to the '--ignore-errors' 461 option of linkgit:git-add[1]. 462 463alias.*:: 464 Command aliases for the linkgit:git[1] command wrapper - e.g. 465 after defining "alias.last = cat-file commit HEAD", the invocation 466 "git last" is equivalent to "git cat-file commit HEAD". To avoid 467 confusion and troubles with script usage, aliases that 468 hide existing git commands are ignored. Arguments are split by 469 spaces, the usual shell quoting and escaping is supported. 470 quote pair and a backslash can be used to quote them. 471+ 472If the alias expansion is prefixed with an exclamation point, 473it will be treated as a shell command. For example, defining 474"alias.new = !gitk --all --not ORIG_HEAD", the invocation 475"git new" is equivalent to running the shell command 476"gitk --all --not ORIG_HEAD". Note that shell commands will be 477executed from the top-level directory of a repository, which may 478not necessarily be the current directory. 479 480apply.ignorewhitespace:: 481 When set to 'change', tells 'git-apply' to ignore changes in 482 whitespace, in the same way as the '--ignore-space-change' 483 option. 484 When set to one of: no, none, never, false tells 'git-apply' to 485 respect all whitespace differences. 486 See linkgit:git-apply[1]. 487 488apply.whitespace:: 489 Tells 'git-apply' how to handle whitespaces, in the same way 490 as the '--whitespace' option. See linkgit:git-apply[1]. 491 492branch.autosetupmerge:: 493 Tells 'git-branch' and 'git-checkout' to setup new branches 494 so that linkgit:git-pull[1] will appropriately merge from the 495 starting point branch. Note that even if this option is not set, 496 this behavior can be chosen per-branch using the `--track` 497 and `--no-track` options. The valid settings are: `false` -- no 498 automatic setup is done; `true` -- automatic setup is done when the 499 starting point is a remote branch; `always` -- automatic setup is 500 done when the starting point is either a local branch or remote 501 branch. This option defaults to true. 502 503branch.autosetuprebase:: 504 When a new branch is created with 'git-branch' or 'git-checkout' 505 that tracks another branch, this variable tells git to set 506 up pull to rebase instead of merge (see "branch.<name>.rebase"). 507 When `never`, rebase is never automatically set to true. 508 When `local`, rebase is set to true for tracked branches of 509 other local branches. 510 When `remote`, rebase is set to true for tracked branches of 511 remote branches. 512 When `always`, rebase will be set to true for all tracking 513 branches. 514 See "branch.autosetupmerge" for details on how to set up a 515 branch to track another branch. 516 This option defaults to never. 517 518branch.<name>.remote:: 519 When in branch <name>, it tells 'git-fetch' and 'git-push' which 520 remote to fetch from/push to. It defaults to `origin` if no remote is 521 configured. `origin` is also used if you are not on any branch. 522 523branch.<name>.merge:: 524 Defines, together with branch.<name>.remote, the upstream branch 525 for the given branch. It tells 'git-fetch'/'git-pull' which 526 branch to merge and can also affect 'git-push' (see push.default). 527 When in branch <name>, it tells 'git-fetch' the default 528 refspec to be marked for merging in FETCH_HEAD. The value is 529 handled like the remote part of a refspec, and must match a 530 ref which is fetched from the remote given by 531 "branch.<name>.remote". 532 The merge information is used by 'git-pull' (which at first calls 533 'git-fetch') to lookup the default branch for merging. Without 534 this option, 'git-pull' defaults to merge the first refspec fetched. 535 Specify multiple values to get an octopus merge. 536 If you wish to setup 'git-pull' so that it merges into <name> from 537 another branch in the local repository, you can point 538 branch.<name>.merge to the desired branch, and use the special setting 539 `.` (a period) for branch.<name>.remote. 540 541branch.<name>.mergeoptions:: 542 Sets default options for merging into branch <name>. The syntax and 543 supported options are the same as those of linkgit:git-merge[1], but 544 option values containing whitespace characters are currently not 545 supported. 546 547branch.<name>.rebase:: 548 When true, rebase the branch <name> on top of the fetched branch, 549 instead of merging the default branch from the default remote when 550 "git pull" is run. 551 *NOTE*: this is a possibly dangerous operation; do *not* use 552 it unless you understand the implications (see linkgit:git-rebase[1] 553 for details). 554 555browser.<tool>.cmd:: 556 Specify the command to invoke the specified browser. The 557 specified command is evaluated in shell with the URLs passed 558 as arguments. (See linkgit:git-web--browse[1].) 559 560browser.<tool>.path:: 561 Override the path for the given tool that may be used to 562 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 563 working repository in gitweb (see linkgit:git-instaweb[1]). 564 565clean.requireForce:: 566 A boolean to make git-clean do nothing unless given -f 567 or -n. Defaults to true. 568 569color.branch:: 570 A boolean to enable/disable color in the output of 571 linkgit:git-branch[1]. May be set to `always`, 572 `false` (or `never`) or `auto` (or `true`), in which case colors are used 573 only when the output is to a terminal. Defaults to false. 574 575color.branch.<slot>:: 576 Use customized color for branch coloration. `<slot>` is one of 577 `current` (the current branch), `local` (a local branch), 578 `remote` (a tracking branch in refs/remotes/), `plain` (other 579 refs). 580+ 581The value for these configuration variables is a list of colors (at most 582two) and attributes (at most one), separated by spaces. The colors 583accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 584`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 585`blink` and `reverse`. The first color given is the foreground; the 586second is the background. The position of the attribute, if any, 587doesn't matter. 588 589color.diff:: 590 When set to `always`, always use colors in patch. 591 When false (or `never`), never. When set to `true` or `auto`, use 592 colors only when the output is to the terminal. Defaults to false. 593 594color.diff.<slot>:: 595 Use customized color for diff colorization. `<slot>` specifies 596 which part of the patch to use the specified color, and is one 597 of `plain` (context text), `meta` (metainformation), `frag` 598 (hunk header), `old` (removed lines), `new` (added lines), 599 `commit` (commit headers), or `whitespace` (highlighting 600 whitespace errors). The values of these variables may be specified as 601 in color.branch.<slot>. 602 603color.grep:: 604 When set to `always`, always highlight matches. When `false` (or 605 `never`), never. When set to `true` or `auto`, use color only 606 when the output is written to the terminal. Defaults to `false`. 607 608color.grep.external:: 609 The string value of this variable is passed to an external 'grep' 610 command as a command line option if match highlighting is turned 611 on. If set to an empty string, no option is passed at all, 612 turning off coloring for external 'grep' calls; this is the default. 613 For GNU grep, set it to `--color=always` to highlight matches even 614 when a pager is used. 615 616color.grep.match:: 617 Use customized color for matches. The value of this variable 618 may be specified as in color.branch.<slot>. It is passed using 619 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when 620 calling an external 'grep'. 621 622color.interactive:: 623 When set to `always`, always use colors for interactive prompts 624 and displays (such as those used by "git-add --interactive"). 625 When false (or `never`), never. When set to `true` or `auto`, use 626 colors only when the output is to the terminal. Defaults to false. 627 628color.interactive.<slot>:: 629 Use customized color for 'git-add --interactive' 630 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 631 four distinct types of normal output from interactive 632 commands. The values of these variables may be specified as 633 in color.branch.<slot>. 634 635color.pager:: 636 A boolean to enable/disable colored output when the pager is in 637 use (default is true). 638 639color.showbranch:: 640 A boolean to enable/disable color in the output of 641 linkgit:git-show-branch[1]. May be set to `always`, 642 `false` (or `never`) or `auto` (or `true`), in which case colors are used 643 only when the output is to a terminal. Defaults to false. 644 645color.status:: 646 A boolean to enable/disable color in the output of 647 linkgit:git-status[1]. May be set to `always`, 648 `false` (or `never`) or `auto` (or `true`), in which case colors are used 649 only when the output is to a terminal. Defaults to false. 650 651color.status.<slot>:: 652 Use customized color for status colorization. `<slot>` is 653 one of `header` (the header text of the status message), 654 `added` or `updated` (files which are added but not committed), 655 `changed` (files which are changed but not added in the index), 656 `untracked` (files which are not tracked by git), or 657 `nobranch` (the color the 'no branch' warning is shown in, defaulting 658 to red). The values of these variables may be specified as in 659 color.branch.<slot>. 660 661color.ui:: 662 When set to `always`, always use colors in all git commands which 663 are capable of colored output. When false (or `never`), never. When 664 set to `true` or `auto`, use colors only when the output is to the 665 terminal. When more specific variables of color.* are set, they always 666 take precedence over this setting. Defaults to false. 667 668commit.template:: 669 Specify a file to use as the template for new commit messages. 670 "~/" and "~user/" are expanded to the specified user's home directory. 671 672diff.autorefreshindex:: 673 When using 'git-diff' to compare with work tree 674 files, do not consider stat-only change as changed. 675 Instead, silently run `git update-index --refresh` to 676 update the cached stat information for paths whose 677 contents in the work tree match the contents in the 678 index. This option defaults to true. Note that this 679 affects only 'git-diff' Porcelain, and not lower level 680 'diff' commands, such as 'git-diff-files'. 681 682diff.external:: 683 If this config variable is set, diff generation is not 684 performed using the internal diff machinery, but using the 685 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 686 environment variable. The command is called with parameters 687 as described under "git Diffs" in linkgit:git[1]. Note: if 688 you want to use an external diff program only on a subset of 689 your files, you might want to use linkgit:gitattributes[5] instead. 690 691diff.mnemonicprefix:: 692 If set, 'git-diff' uses a prefix pair that is different from the 693 standard "a/" and "b/" depending on what is being compared. When 694 this configuration is in effect, reverse diff output also swaps 695 the order of the prefixes: 696'git-diff';; 697 compares the (i)ndex and the (w)ork tree; 698'git-diff HEAD';; 699 compares a (c)ommit and the (w)ork tree; 700'git diff --cached';; 701 compares a (c)ommit and the (i)ndex; 702'git-diff HEAD:file1 file2';; 703 compares an (o)bject and a (w)ork tree entity; 704'git diff --no-index a b';; 705 compares two non-git things (1) and (2). 706 707diff.renameLimit:: 708 The number of files to consider when performing the copy/rename 709 detection; equivalent to the 'git-diff' option '-l'. 710 711diff.renames:: 712 Tells git to detect renames. If set to any boolean value, it 713 will enable basic rename detection. If set to "copies" or 714 "copy", it will detect copies, as well. 715 716diff.suppressBlankEmpty:: 717 A boolean to inhibit the standard behavior of printing a space 718 before each empty output line. Defaults to false. 719 720diff.tool:: 721 Controls which diff tool is used. `diff.tool` overrides 722 `merge.tool` when used by linkgit:git-difftool[1] and has 723 the same valid values as `merge.tool` minus "tortoisemerge" 724 and plus "kompare". 725 726difftool.<tool>.path:: 727 Override the path for the given tool. This is useful in case 728 your tool is not in the PATH. 729 730difftool.<tool>.cmd:: 731 Specify the command to invoke the specified diff tool. 732 The specified command is evaluated in shell with the following 733 variables available: 'LOCAL' is set to the name of the temporary 734 file containing the contents of the diff pre-image and 'REMOTE' 735 is set to the name of the temporary file containing the contents 736 of the diff post-image. 737 738difftool.prompt:: 739 Prompt before each invocation of the diff tool. 740 741diff.wordRegex:: 742 A POSIX Extended Regular Expression used to determine what is a "word" 743 when performing word-by-word difference calculations. Character 744 sequences that match the regular expression are "words", all other 745 characters are *ignorable* whitespace. 746 747fetch.unpackLimit:: 748 If the number of objects fetched over the git native 749 transfer is below this 750 limit, then the objects will be unpacked into loose object 751 files. However if the number of received objects equals or 752 exceeds this limit then the received pack will be stored as 753 a pack, after adding any missing delta bases. Storing the 754 pack from a push can make the push operation complete faster, 755 especially on slow filesystems. If not set, the value of 756 `transfer.unpackLimit` is used instead. 757 758format.attach:: 759 Enable multipart/mixed attachments as the default for 760 'format-patch'. The value can also be a double quoted string 761 which will enable attachments as the default and set the 762 value as the boundary. See the --attach option in 763 linkgit:git-format-patch[1]. 764 765format.numbered:: 766 A boolean which can enable or disable sequence numbers in patch 767 subjects. It defaults to "auto" which enables it only if there 768 is more than one patch. It can be enabled or disabled for all 769 messages by setting it to "true" or "false". See --numbered 770 option in linkgit:git-format-patch[1]. 771 772format.headers:: 773 Additional email headers to include in a patch to be submitted 774 by mail. See linkgit:git-format-patch[1]. 775 776format.cc:: 777 Additional "Cc:" headers to include in a patch to be submitted 778 by mail. See the --cc option in linkgit:git-format-patch[1]. 779 780format.subjectprefix:: 781 The default for format-patch is to output files with the '[PATCH]' 782 subject prefix. Use this variable to change that prefix. 783 784format.suffix:: 785 The default for format-patch is to output files with the suffix 786 `.patch`. Use this variable to change that suffix (make sure to 787 include the dot if you want it). 788 789format.pretty:: 790 The default pretty format for log/show/whatchanged command, 791 See linkgit:git-log[1], linkgit:git-show[1], 792 linkgit:git-whatchanged[1]. 793 794format.thread:: 795 The default threading style for 'git-format-patch'. Can be 796 either a boolean value, `shallow` or `deep`. `shallow` 797 threading makes every mail a reply to the head of the series, 798 where the head is chosen from the cover letter, the 799 `\--in-reply-to`, and the first patch mail, in this order. 800 `deep` threading makes every mail a reply to the previous one. 801 A true boolean value is the same as `shallow`, and a false 802 value disables threading. 803 804format.signoff:: 805 A boolean value which lets you enable the `-s/--signoff` option of 806 format-patch by default. *Note:* Adding the Signed-off-by: line to a 807 patch should be a conscious act and means that you certify you have 808 the rights to submit this work under the same open source license. 809 Please see the 'SubmittingPatches' document for further discussion. 810 811gc.aggressiveWindow:: 812 The window size parameter used in the delta compression 813 algorithm used by 'git-gc --aggressive'. This defaults 814 to 10. 815 816gc.auto:: 817 When there are approximately more than this many loose 818 objects in the repository, `git gc --auto` will pack them. 819 Some Porcelain commands use this command to perform a 820 light-weight garbage collection from time to time. The 821 default value is 6700. Setting this to 0 disables it. 822 823gc.autopacklimit:: 824 When there are more than this many packs that are not 825 marked with `*.keep` file in the repository, `git gc 826 --auto` consolidates them into one larger pack. The 827 default value is 50. Setting this to 0 disables it. 828 829gc.packrefs:: 830 'git-gc' does not run `git pack-refs` in a bare repository by 831 default so that older dumb-transport clients can still fetch 832 from the repository. Setting this to `true` lets 'git-gc' 833 to run `git pack-refs`. Setting this to `false` tells 834 'git-gc' never to run `git pack-refs`. The default setting is 835 `notbare`. Enable it only when you know you do not have to 836 support such clients. The default setting will change to `true` 837 at some stage, and setting this to `false` will continue to 838 prevent `git pack-refs` from being run from 'git-gc'. 839 840gc.pruneexpire:: 841 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'. 842 Override the grace period with this config variable. The value 843 "now" may be used to disable this grace period and always prune 844 unreachable objects immediately. 845 846gc.reflogexpire:: 847 'git-reflog expire' removes reflog entries older than 848 this time; defaults to 90 days. 849 850gc.reflogexpireunreachable:: 851 'git-reflog expire' removes reflog entries older than 852 this time and are not reachable from the current tip; 853 defaults to 30 days. 854 855gc.rerereresolved:: 856 Records of conflicted merge you resolved earlier are 857 kept for this many days when 'git-rerere gc' is run. 858 The default is 60 days. See linkgit:git-rerere[1]. 859 860gc.rerereunresolved:: 861 Records of conflicted merge you have not resolved are 862 kept for this many days when 'git-rerere gc' is run. 863 The default is 15 days. See linkgit:git-rerere[1]. 864 865gitcvs.commitmsgannotation:: 866 Append this string to each commit message. Set to empty string 867 to disable this feature. Defaults to "via git-CVS emulator". 868 869gitcvs.enabled:: 870 Whether the CVS server interface is enabled for this repository. 871 See linkgit:git-cvsserver[1]. 872 873gitcvs.logfile:: 874 Path to a log file where the CVS server interface well... logs 875 various stuff. See linkgit:git-cvsserver[1]. 876 877gitcvs.usecrlfattr:: 878 If true, the server will look up the `crlf` attribute for 879 files to determine the '-k' modes to use. If `crlf` is set, 880 the '-k' mode will be left blank, so cvs clients will 881 treat it as text. If `crlf` is explicitly unset, the file 882 will be set with '-kb' mode, which suppresses any newline munging 883 the client might otherwise do. If `crlf` is not specified, 884 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 885 886gitcvs.allbinary:: 887 This is used if 'gitcvs.usecrlfattr' does not resolve 888 the correct '-kb' mode to use. If true, all 889 unresolved files are sent to the client in 890 mode '-kb'. This causes the client to treat them 891 as binary files, which suppresses any newline munging it 892 otherwise might do. Alternatively, if it is set to "guess", 893 then the contents of the file are examined to decide if 894 it is binary, similar to 'core.autocrlf'. 895 896gitcvs.dbname:: 897 Database used by git-cvsserver to cache revision information 898 derived from the git repository. The exact meaning depends on the 899 used database driver, for SQLite (which is the default driver) this 900 is a filename. Supports variable substitution (see 901 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 902 Default: '%Ggitcvs.%m.sqlite' 903 904gitcvs.dbdriver:: 905 Used Perl DBI driver. You can specify any available driver 906 for this here, but it might not work. git-cvsserver is tested 907 with 'DBD::SQLite', reported to work with 'DBD::Pg', and 908 reported *not* to work with 'DBD::mysql'. Experimental feature. 909 May not contain double colons (`:`). Default: 'SQLite'. 910 See linkgit:git-cvsserver[1]. 911 912gitcvs.dbuser, gitcvs.dbpass:: 913 Database user and password. Only useful if setting 'gitcvs.dbdriver', 914 since SQLite has no concept of database users and/or passwords. 915 'gitcvs.dbuser' supports variable substitution (see 916 linkgit:git-cvsserver[1] for details). 917 918gitcvs.dbTableNamePrefix:: 919 Database table name prefix. Prepended to the names of any 920 database tables used, allowing a single database to be used 921 for several repositories. Supports variable substitution (see 922 linkgit:git-cvsserver[1] for details). Any non-alphabetic 923 characters will be replaced with underscores. 924 925All gitcvs variables except for 'gitcvs.usecrlfattr' and 926'gitcvs.allbinary' can also be specified as 927'gitcvs.<access_method>.<varname>' (where 'access_method' 928is one of "ext" and "pserver") to make them apply only for the given 929access method. 930 931gui.commitmsgwidth:: 932 Defines how wide the commit message window is in the 933 linkgit:git-gui[1]. "75" is the default. 934 935gui.diffcontext:: 936 Specifies how many context lines should be used in calls to diff 937 made by the linkgit:git-gui[1]. The default is "5". 938 939gui.encoding:: 940 Specifies the default encoding to use for displaying of 941 file contents in linkgit:git-gui[1] and linkgit:gitk[1]. 942 It can be overridden by setting the 'encoding' attribute 943 for relevant files (see linkgit:gitattributes[5]). 944 If this option is not set, the tools default to the 945 locale encoding. 946 947gui.matchtrackingbranch:: 948 Determines if new branches created with linkgit:git-gui[1] should 949 default to tracking remote branches with matching names or 950 not. Default: "false". 951 952gui.newbranchtemplate:: 953 Is used as suggested name when creating new branches using the 954 linkgit:git-gui[1]. 955 956gui.pruneduringfetch:: 957 "true" if linkgit:git-gui[1] should prune tracking branches when 958 performing a fetch. The default value is "false". 959 960gui.trustmtime:: 961 Determines if linkgit:git-gui[1] should trust the file modification 962 timestamp or not. By default the timestamps are not trusted. 963 964gui.spellingdictionary:: 965 Specifies the dictionary used for spell checking commit messages in 966 the linkgit:git-gui[1]. When set to "none" spell checking is turned 967 off. 968 969gui.fastcopyblame:: 970 If true, 'git gui blame' uses '-C' instead of '-C -C' for original 971 location detection. It makes blame significantly faster on huge 972 repositories at the expense of less thorough copy detection. 973 974gui.copyblamethreshold:: 975 Specifies the threshold to use in 'git gui blame' original location 976 detection, measured in alphanumeric characters. See the 977 linkgit:git-blame[1] manual for more information on copy detection. 978 979gui.blamehistoryctx:: 980 Specifies the radius of history context in days to show in 981 linkgit:gitk[1] for the selected commit, when the `Show History 982 Context` menu item is invoked from 'git gui blame'. If this 983 variable is set to zero, the whole history is shown. 984 985guitool.<name>.cmd:: 986 Specifies the shell command line to execute when the corresponding item 987 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is 988 mandatory for every tool. The command is executed from the root of 989 the working directory, and in the environment it receives the name of 990 the tool as 'GIT_GUITOOL', the name of the currently selected file as 991 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if 992 the head is detached, 'CUR_BRANCH' is empty). 993 994guitool.<name>.needsfile:: 995 Run the tool only if a diff is selected in the GUI. It guarantees 996 that 'FILENAME' is not empty. 997 998guitool.<name>.noconsole:: 999 Run the command silently, without creating a window to display its1000 output.10011002guitool.<name>.norescan::1003 Don't rescan the working directory for changes after the tool1004 finishes execution.10051006guitool.<name>.confirm::1007 Show a confirmation dialog before actually running the tool.10081009guitool.<name>.argprompt::1010 Request a string argument from the user, and pass it to the tool1011 through the 'ARGS' environment variable. Since requesting an1012 argument implies confirmation, the 'confirm' option has no effect1013 if this is enabled. If the option is set to 'true', 'yes', or '1',1014 the dialog uses a built-in generic prompt; otherwise the exact1015 value of the variable is used.10161017guitool.<name>.revprompt::1018 Request a single valid revision from the user, and set the1019 'REVISION' environment variable. In other aspects this option1020 is similar to 'argprompt', and can be used together with it.10211022guitool.<name>.revunmerged::1023 Show only unmerged branches in the 'revprompt' subdialog.1024 This is useful for tools similar to merge or rebase, but not1025 for things like checkout or reset.10261027guitool.<name>.title::1028 Specifies the title to use for the prompt dialog. The default1029 is the tool name.10301031guitool.<name>.prompt::1032 Specifies the general prompt string to display at the top of1033 the dialog, before subsections for 'argprompt' and 'revprompt'.1034 The default value includes the actual command.10351036help.browser::1037 Specify the browser that will be used to display help in the1038 'web' format. See linkgit:git-help[1].10391040help.format::1041 Override the default help format used by linkgit:git-help[1].1042 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1043 the default. 'web' and 'html' are the same.10441045help.autocorrect::1046 Automatically correct and execute mistyped commands after1047 waiting for the given number of deciseconds (0.1 sec). If more1048 than one command can be deduced from the entered text, nothing1049 will be executed. If the value of this option is negative,1050 the corrected command will be executed immediately. If the1051 value is 0 - the command will be just shown but not executed.1052 This is the default.10531054http.proxy::1055 Override the HTTP proxy, normally configured using the 'http_proxy'1056 environment variable (see linkgit:curl[1]). This can be overridden1057 on a per-remote basis; see remote.<name>.proxy10581059http.sslVerify::1060 Whether to verify the SSL certificate when fetching or pushing1061 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1062 variable.10631064http.sslCert::1065 File containing the SSL certificate when fetching or pushing1066 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1067 variable.10681069http.sslKey::1070 File containing the SSL private key when fetching or pushing1071 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1072 variable.10731074http.sslCertPasswordProtected::1075 Enable git's password prompt for the SSL certificate. Otherwise1076 OpenSSL will prompt the user, possibly many times, if the1077 certificate or private key is encrypted. Can be overridden by the1078 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.10791080http.sslCAInfo::1081 File containing the certificates to verify the peer with when1082 fetching or pushing over HTTPS. Can be overridden by the1083 'GIT_SSL_CAINFO' environment variable.10841085http.sslCAPath::1086 Path containing files with the CA certificates to verify the peer1087 with when fetching or pushing over HTTPS. Can be overridden1088 by the 'GIT_SSL_CAPATH' environment variable.10891090http.maxRequests::1091 How many HTTP requests to launch in parallel. Can be overridden1092 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.10931094http.lowSpeedLimit, http.lowSpeedTime::1095 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1096 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1097 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1098 'GIT_HTTP_LOW_SPEED_TIME' environment variables.10991100http.noEPSV::1101 A boolean which disables using of EPSV ftp command by curl.1102 This can helpful with some "poor" ftp servers which don't1103 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1104 environment variable. Default is false (curl will use EPSV).11051106i18n.commitEncoding::1107 Character encoding the commit messages are stored in; git itself1108 does not care per se, but this information is necessary e.g. when1109 importing commits from emails or in the gitk graphical history1110 browser (and possibly at other places in the future or in other1111 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.11121113i18n.logOutputEncoding::1114 Character encoding the commit messages are converted to when1115 running 'git-log' and friends.11161117imap::1118 The configuration variables in the 'imap' section are described1119 in linkgit:git-imap-send[1].11201121instaweb.browser::1122 Specify the program that will be used to browse your working1123 repository in gitweb. See linkgit:git-instaweb[1].11241125instaweb.httpd::1126 The HTTP daemon command-line to start gitweb on your working1127 repository. See linkgit:git-instaweb[1].11281129instaweb.local::1130 If true the web server started by linkgit:git-instaweb[1] will1131 be bound to the local IP (127.0.0.1).11321133instaweb.modulepath::1134 The module path for an apache httpd used by linkgit:git-instaweb[1].11351136instaweb.port::1137 The port number to bind the gitweb httpd to. See1138 linkgit:git-instaweb[1].11391140interactive.singlekey::1141 In interactive commands, allow the user to provide one-letter1142 input with a single key (i.e., without hitting enter).1143 Currently this is used only by the `\--patch` mode of1144 linkgit:git-add[1]. Note that this setting is silently1145 ignored if portable keystroke input is not available.11461147log.date::1148 Set default date-time mode for the log command. Setting log.date1149 value is similar to using 'git-log'\'s --date option. The value is one of the1150 following alternatives: {relative,local,default,iso,rfc,short}.1151 See linkgit:git-log[1].11521153log.showroot::1154 If true, the initial commit will be shown as a big creation event.1155 This is equivalent to a diff against an empty tree.1156 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1157 normally hide the root commit will now show it. True by default.11581159mailmap.file::1160 The location of an augmenting mailmap file. The default1161 mailmap, located in the root of the repository, is loaded1162 first, then the mailmap file pointed to by this variable.1163 The location of the mailmap file may be in a repository1164 subdirectory, or somewhere outside of the repository itself.1165 See linkgit:git-shortlog[1] and linkgit:git-blame[1].11661167man.viewer::1168 Specify the programs that may be used to display help in the1169 'man' format. See linkgit:git-help[1].11701171man.<tool>.cmd::1172 Specify the command to invoke the specified man viewer. The1173 specified command is evaluated in shell with the man page1174 passed as argument. (See linkgit:git-help[1].)11751176man.<tool>.path::1177 Override the path for the given tool that may be used to1178 display help in the 'man' format. See linkgit:git-help[1].11791180include::merge-config.txt[]11811182mergetool.<tool>.path::1183 Override the path for the given tool. This is useful in case1184 your tool is not in the PATH.11851186mergetool.<tool>.cmd::1187 Specify the command to invoke the specified merge tool. The1188 specified command is evaluated in shell with the following1189 variables available: 'BASE' is the name of a temporary file1190 containing the common base of the files to be merged, if available;1191 'LOCAL' is the name of a temporary file containing the contents of1192 the file on the current branch; 'REMOTE' is the name of a temporary1193 file containing the contents of the file from the branch being1194 merged; 'MERGED' contains the name of the file to which the merge1195 tool should write the results of a successful merge.11961197mergetool.<tool>.trustExitCode::1198 For a custom merge command, specify whether the exit code of1199 the merge command can be used to determine whether the merge was1200 successful. If this is not set to true then the merge target file1201 timestamp is checked and the merge assumed to have been successful1202 if the file has been updated, otherwise the user is prompted to1203 indicate the success of the merge.12041205mergetool.keepBackup::1206 After performing a merge, the original file with conflict markers1207 can be saved as a file with a `.orig` extension. If this variable1208 is set to `false` then this file is not preserved. Defaults to1209 `true` (i.e. keep the backup files).12101211mergetool.keepTemporaries::1212 When invoking a custom merge tool, git uses a set of temporary1213 files to pass to the tool. If the tool returns an error and this1214 variable is set to `true`, then these temporary files will be1215 preserved, otherwise they will be removed after the tool has1216 exited. Defaults to `false`.12171218mergetool.prompt::1219 Prompt before each invocation of the merge resolution program.12201221pack.window::1222 The size of the window used by linkgit:git-pack-objects[1] when no1223 window size is given on the command line. Defaults to 10.12241225pack.depth::1226 The maximum delta depth used by linkgit:git-pack-objects[1] when no1227 maximum depth is given on the command line. Defaults to 50.12281229pack.windowMemory::1230 The window memory size limit used by linkgit:git-pack-objects[1]1231 when no limit is given on the command line. The value can be1232 suffixed with "k", "m", or "g". Defaults to 0, meaning no1233 limit.12341235pack.compression::1236 An integer -1..9, indicating the compression level for objects1237 in a pack file. -1 is the zlib default. 0 means no1238 compression, and 1..9 are various speed/size tradeoffs, 9 being1239 slowest. If not set, defaults to core.compression. If that is1240 not set, defaults to -1, the zlib default, which is "a default1241 compromise between speed and compression (currently equivalent1242 to level 6)."12431244pack.deltaCacheSize::1245 The maximum memory in bytes used for caching deltas in1246 linkgit:git-pack-objects[1] before writing them out to a pack.1247 This cache is used to speed up the writing object phase by not1248 having to recompute the final delta result once the best match1249 for all objects is found. Repacking large repositories on machines1250 which are tight with memory might be badly impacted by this though,1251 especially if this cache pushes the system into swapping.1252 A value of 0 means no limit. The smallest size of 1 byte may be1253 used to virtually disable this cache. Defaults to 256 MiB.12541255pack.deltaCacheLimit::1256 The maximum size of a delta, that is cached in1257 linkgit:git-pack-objects[1]. This cache is used to speed up the1258 writing object phase by not having to recompute the final delta1259 result once the best match for all objects is found. Defaults to 1000.12601261pack.threads::1262 Specifies the number of threads to spawn when searching for best1263 delta matches. This requires that linkgit:git-pack-objects[1]1264 be compiled with pthreads otherwise this option is ignored with a1265 warning. This is meant to reduce packing time on multiprocessor1266 machines. The required amount of memory for the delta search window1267 is however multiplied by the number of threads.1268 Specifying 0 will cause git to auto-detect the number of CPU's1269 and set the number of threads accordingly.12701271pack.indexVersion::1272 Specify the default pack index version. Valid values are 1 for1273 legacy pack index used by Git versions prior to 1.5.2, and 2 for1274 the new pack index with capabilities for packs larger than 4 GB1275 as well as proper protection against the repacking of corrupted1276 packs. Version 2 is the default. Note that version 2 is enforced1277 and this config option ignored whenever the corresponding pack is1278 larger than 2 GB.1279+1280If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1281cloning or fetching over a non native protocol (e.g. "http" and "rsync")1282that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1283other side may give you a repository that cannot be accessed with your1284older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1285you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1286the `{asterisk}.idx` file.12871288pack.packSizeLimit::1289 The default maximum size of a pack. This setting only affects1290 packing to a file, i.e. the git:// protocol is unaffected. It1291 can be overridden by the `\--max-pack-size` option of1292 linkgit:git-repack[1].12931294pager.<cmd>::1295 Allows turning on or off pagination of the output of a1296 particular git subcommand when writing to a tty. If1297 `\--paginate` or `\--no-pager` is specified on the command line,1298 it takes precedence over this option. To disable pagination for1299 all commands, set `core.pager` or `GIT_PAGER` to `cat`.13001301pull.octopus::1302 The default merge strategy to use when pulling multiple branches1303 at once.13041305pull.twohead::1306 The default merge strategy to use when pulling a single branch.13071308push.default::1309 Defines the action git push should take if no refspec is given1310 on the command line, no refspec is configured in the remote, and1311 no refspec is implied by any of the options given on the command1312 line. Possible values are:1313+1314* `nothing` do not push anything.1315* `matching` push all matching branches.1316 All branches having the same name in both ends are considered to be1317 matching. This is the default.1318* `tracking` push the current branch to its upstream branch.1319* `current` push the current branch to a branch of the same name.13201321rebase.stat::1322 Whether to show a diffstat of what changed upstream since the last1323 rebase. False by default.13241325receive.fsckObjects::1326 If it is set to true, git-receive-pack will check all received1327 objects. It will abort in the case of a malformed object or a1328 broken link. The result of an abort are only dangling objects.1329 Defaults to false.13301331receive.unpackLimit::1332 If the number of objects received in a push is below this1333 limit then the objects will be unpacked into loose object1334 files. However if the number of received objects equals or1335 exceeds this limit then the received pack will be stored as1336 a pack, after adding any missing delta bases. Storing the1337 pack from a push can make the push operation complete faster,1338 especially on slow filesystems. If not set, the value of1339 `transfer.unpackLimit` is used instead.13401341receive.denyDeletes::1342 If set to true, git-receive-pack will deny a ref update that deletes1343 the ref. Use this to prevent such a ref deletion via a push.13441345receive.denyCurrentBranch::1346 If set to true or "refuse", receive-pack will deny a ref update1347 to the currently checked out branch of a non-bare repository.1348 Such a push is potentially dangerous because it brings the HEAD1349 out of sync with the index and working tree. If set to "warn",1350 print a warning of such a push to stderr, but allow the push to1351 proceed. If set to false or "ignore", allow such pushes with no1352 message. Defaults to "warn".13531354receive.denyNonFastForwards::1355 If set to true, git-receive-pack will deny a ref update which is1356 not a fast forward. Use this to prevent such an update via a push,1357 even if that push is forced. This configuration variable is1358 set when initializing a shared repository.13591360remote.<name>.url::1361 The URL of a remote repository. See linkgit:git-fetch[1] or1362 linkgit:git-push[1].13631364remote.<name>.pushurl::1365 The push URL of a remote repository. See linkgit:git-push[1].13661367remote.<name>.proxy::1368 For remotes that require curl (http, https and ftp), the URL to1369 the proxy to use for that remote. Set to the empty string to1370 disable proxying for that remote.13711372remote.<name>.fetch::1373 The default set of "refspec" for linkgit:git-fetch[1]. See1374 linkgit:git-fetch[1].13751376remote.<name>.push::1377 The default set of "refspec" for linkgit:git-push[1]. See1378 linkgit:git-push[1].13791380remote.<name>.mirror::1381 If true, pushing to this remote will automatically behave1382 as if the `\--mirror` option was given on the command line.13831384remote.<name>.skipDefaultUpdate::1385 If true, this remote will be skipped by default when updating1386 using the update subcommand of linkgit:git-remote[1].13871388remote.<name>.receivepack::1389 The default program to execute on the remote side when pushing. See1390 option \--receive-pack of linkgit:git-push[1].13911392remote.<name>.uploadpack::1393 The default program to execute on the remote side when fetching. See1394 option \--upload-pack of linkgit:git-fetch-pack[1].13951396remote.<name>.tagopt::1397 Setting this value to \--no-tags disables automatic tag following when1398 fetching from remote <name>13991400remotes.<group>::1401 The list of remotes which are fetched by "git remote update1402 <group>". See linkgit:git-remote[1].14031404repack.usedeltabaseoffset::1405 By default, linkgit:git-repack[1] creates packs that use1406 delta-base offset. If you need to share your repository with1407 git older than version 1.4.4, either directly or via a dumb1408 protocol such as http, then you need to set this option to1409 "false" and repack. Access from old git versions over the1410 native protocol are unaffected by this option.14111412rerere.autoupdate::1413 When set to true, `git-rerere` updates the index with the1414 resulting contents after it cleanly resolves conflicts using1415 previously recorded resolution. Defaults to false.14161417rerere.enabled::1418 Activate recording of resolved conflicts, so that identical1419 conflict hunks can be resolved automatically, should they1420 be encountered again. linkgit:git-rerere[1] command is by1421 default enabled if you create `rr-cache` directory under1422 `$GIT_DIR`, but can be disabled by setting this option to false.14231424sendemail.identity::1425 A configuration identity. When given, causes values in the1426 'sendemail.<identity>' subsection to take precedence over1427 values in the 'sendemail' section. The default identity is1428 the value of 'sendemail.identity'.14291430sendemail.smtpencryption::1431 See linkgit:git-send-email[1] for description. Note that this1432 setting is not subject to the 'identity' mechanism.14331434sendemail.smtpssl::1435 Deprecated alias for 'sendemail.smtpencryption = ssl'.14361437sendemail.<identity>.*::1438 Identity-specific versions of the 'sendemail.*' parameters1439 found below, taking precedence over those when the this1440 identity is selected, through command-line or1441 'sendemail.identity'.14421443sendemail.aliasesfile::1444sendemail.aliasfiletype::1445sendemail.bcc::1446sendemail.cc::1447sendemail.cccmd::1448sendemail.chainreplyto::1449sendemail.confirm::1450sendemail.envelopesender::1451sendemail.from::1452sendemail.multiedit::1453sendemail.signedoffbycc::1454sendemail.smtppass::1455sendemail.suppresscc::1456sendemail.suppressfrom::1457sendemail.to::1458sendemail.smtpserver::1459sendemail.smtpserverport::1460sendemail.smtpuser::1461sendemail.thread::1462sendemail.validate::1463 See linkgit:git-send-email[1] for description.14641465sendemail.signedoffcc::1466 Deprecated alias for 'sendemail.signedoffbycc'.14671468showbranch.default::1469 The default set of branches for linkgit:git-show-branch[1].1470 See linkgit:git-show-branch[1].14711472status.relativePaths::1473 By default, linkgit:git-status[1] shows paths relative to the1474 current directory. Setting this variable to `false` shows paths1475 relative to the repository root (this was the default for git1476 prior to v1.5.4).14771478status.showUntrackedFiles::1479 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1480 files which are not currently tracked by Git. Directories which1481 contain only untracked files, are shown with the directory name1482 only. Showing untracked files means that Git needs to lstat() all1483 all the files in the whole repository, which might be slow on some1484 systems. So, this variable controls how the commands displays1485 the untracked files. Possible values are:1486+1487--1488 - 'no' - Show no untracked files1489 - 'normal' - Shows untracked files and directories1490 - 'all' - Shows also individual files in untracked directories.1491--1492+1493If this variable is not specified, it defaults to 'normal'.1494This variable can be overridden with the -u|--untracked-files option1495of linkgit:git-status[1] and linkgit:git-commit[1].14961497tar.umask::1498 This variable can be used to restrict the permission bits of1499 tar archive entries. The default is 0002, which turns off the1500 world write bit. The special value "user" indicates that the1501 archiving user's umask will be used instead. See umask(2) and1502 linkgit:git-archive[1].15031504transfer.unpackLimit::1505 When `fetch.unpackLimit` or `receive.unpackLimit` are1506 not set, the value of this variable is used instead.1507 The default value is 100.15081509url.<base>.insteadOf::1510 Any URL that starts with this value will be rewritten to1511 start, instead, with <base>. In cases where some site serves a1512 large number of repositories, and serves them with multiple1513 access methods, and some users need to use different access1514 methods, this feature allows people to specify any of the1515 equivalent URLs and have git automatically rewrite the URL to1516 the best alternative for the particular user, even for a1517 never-before-seen repository on the site. When more than one1518 insteadOf strings match a given URL, the longest match is used.15191520url.<base>.pushInsteadOf::1521 Any URL that starts with this value will not be pushed to;1522 instead, it will be rewritten to start with <base>, and the1523 resulting URL will be pushed to. In cases where some site serves1524 a large number of repositories, and serves them with multiple1525 access methods, some of which do not allow push, this feature1526 allows people to specify a pull-only URL and have git1527 automatically use an appropriate URL to push, even for a1528 never-before-seen repository on the site. When more than one1529 pushInsteadOf strings match a given URL, the longest match is1530 used. If a remote has an explicit pushurl, git will ignore this1531 setting for that remote.15321533user.email::1534 Your email address to be recorded in any newly created commits.1535 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1536 'EMAIL' environment variables. See linkgit:git-commit-tree[1].15371538user.name::1539 Your full name to be recorded in any newly created commits.1540 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1541 environment variables. See linkgit:git-commit-tree[1].15421543user.signingkey::1544 If linkgit:git-tag[1] is not selecting the key you want it to1545 automatically when creating a signed tag, you can override the1546 default selection with this variable. This option is passed1547 unchanged to gpg's --local-user parameter, so you may specify a key1548 using any method that gpg supports.15491550web.browser::1551 Specify a web browser that may be used by some commands.1552 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1553 may use it.