1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's behavior. `.git/config` file for each repository 6is used to store the information for that repository, and 7`$HOME/.gitconfig` is used to store per user information to give 8fallback values for `.git/config` file. The file `/etc/gitconfig` 9can be used to store system-wide defaults. 10 11They can be used by both the git plumbing 12and the porcelains. The variables are divided into sections, where 13in the fully qualified variable name 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 section 30header before 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 example below: 35 36-------- 37 [section "subsection"] 38 39-------- 40 41Subsection names can contain any characters except newline (doublequote 42'`"`' and backslash have to be escaped as '`\"`' and '`\\`', 43respectively) and are case sensitive. Section header 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 (case insensitive) alternative `[section.subsection]` syntax. 49In this syntax subsection names follow the same restrictions as for section 50name. 51 52All the other lines are recognized as setting variables, in the form 53'name = value'. If there is no equal sign on the line, the entire line 54is taken as 'name' and the variable is recognized as boolean "true". 55The variable names are case-insensitive and only alphanumeric 56characters and '`-`' are allowed. There can be more than one value 57for a given variable; we say then that variable is multivalued. 58 59Leading and trailing whitespace in a variable value is discarded. 60Internal whitespace within a variable value is retained verbatim. 61 62The values following the equals sign in variable assign are all either 63a string, an integer, or a boolean. Boolean values may be given as yes/no, 640/1 or true/false. Case is not significant in boolean values, when 65converting value to the canonical form using '--bool' type specifier; 66'git-config' will ensure that the output is "true" or "false". 67 68String values may be entirely or partially enclosed in double quotes. 69You need to enclose variable value in double quotes if you want to 70preserve leading or trailing whitespace, or if variable value contains 71beginning of comment characters (if it contains '#' or ';'). 72Double quote '`"`' and backslash '`\`' characters in variable value must 73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'. 74 75The following escape sequences (beside '`\"`' and '`\\`') are recognized: 76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB) 77and '`\b`' for backspace (BS). No other char escape sequence, nor octal 78char sequences are valid. 79 80Variable value ending in a '`\`' is continued on the next line in the 81customary UNIX fashion. 82 83Some variables may require special value format. 84 85Example 86~~~~~~~ 87 88 # Core variables 89 [core] 90 ; Don't trust file modes 91 filemode = false 92 93 # Our diff algorithm 94 [diff] 95 external = /usr/local/bin/diff-wrapper 96 renames = true 97 98 [branch "devel"] 99 remote = origin 100 merge = refs/heads/devel 101 102 # Proxy settings 103 [core] 104 gitProxy="ssh" for "kernel.org" 105 gitProxy=default-proxy ; for the rest 106 107Variables 108~~~~~~~~~ 109 110Note that this list is non-comprehensive and not necessarily complete. 111For command-specific variables, you will find a more detailed description 112in the appropriate manual page. You will find a description of non-core 113porcelain configuration variables in the respective porcelain documentation. 114 115core.fileMode:: 116 If false, the executable bit differences between the index and 117 the working copy are ignored; useful on broken filesystems like FAT. 118 See linkgit:git-update-index[1]. True by default. 119 120core.ignoreCygwinFSTricks:: 121 This option is only used by Cygwin implementation of Git. If false, 122 the Cygwin stat() and lstat() functions are used. This may be useful 123 if your repository consists of a few separate directories joined in 124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 125 whenever it is possible and falls back to Cygwin functions only to 126 handle symbol links. The native mode is more than twice faster than 127 normal Cygwin l/stat() functions. True by default. 128 129core.trustctime:: 130 If false, the ctime differences between the index and the 131 working copy are ignored; useful when the inode change time 132 is regularly modified by something outside Git (file system 133 crawlers and some backup systems). 134 See linkgit:git-update-index[1]. True by default. 135 136core.quotepath:: 137 The commands that output paths (e.g. 'ls-files', 138 'diff'), when not given the `-z` option, will quote 139 "unusual" characters in the pathname by enclosing the 140 pathname in a double-quote pair and with backslashes the 141 same way strings in C source code are quoted. If this 142 variable is set to false, the bytes higher than 0x80 are 143 not quoted but output as verbatim. Note that double 144 quote, backslash and control characters are always 145 quoted without `-z` regardless of the setting of this 146 variable. 147 148core.autocrlf:: 149 If true, makes git convert `CRLF` at the end of lines in text files to 150 `LF` when reading from the filesystem, and convert in reverse when 151 writing to the filesystem. The variable can be set to 152 'input', in which case the conversion happens only while 153 reading from the filesystem but files are written out with 154 `LF` at the end of lines. Currently, which paths to consider 155 "text" (i.e. be subjected to the autocrlf mechanism) is 156 decided purely based on the contents. 157 158core.safecrlf:: 159 If true, makes git check if converting `CRLF` as controlled by 160 `core.autocrlf` is reversible. Git will verify if a command 161 modifies a file in the work tree either directly or indirectly. 162 For example, committing a file followed by checking out the 163 same file should yield the original file in the work tree. If 164 this is not the case for the current setting of 165 `core.autocrlf`, git will reject the file. The variable can 166 be set to "warn", in which case git will only warn about an 167 irreversible conversion but continue the operation. 168+ 169CRLF conversion bears a slight chance of corrupting data. 170autocrlf=true will convert CRLF to LF during commit and LF to 171CRLF during checkout. A file that contains a mixture of LF and 172CRLF before the commit cannot be recreated by git. For text 173files this is the right thing to do: it corrects line endings 174such that we have only LF line endings in the repository. 175But for binary files that are accidentally classified as text the 176conversion can corrupt data. 177+ 178If you recognize such corruption early you can easily fix it by 179setting the conversion type explicitly in .gitattributes. Right 180after committing you still have the original file in your work 181tree and this file is not yet corrupted. You can explicitly tell 182git that this file is binary and git will handle the file 183appropriately. 184+ 185Unfortunately, the desired effect of cleaning up text files with 186mixed line endings and the undesired effect of corrupting binary 187files cannot be distinguished. In both cases CRLFs are removed 188in an irreversible way. For text files this is the right thing 189to do because CRLFs are line endings, while for binary files 190converting CRLFs corrupts data. 191+ 192Note, this safety check does not mean that a checkout will generate a 193file identical to the original file for a different setting of 194`core.autocrlf`, but only for the current one. For example, a text 195file with `LF` would be accepted with `core.autocrlf=input` and could 196later be checked out with `core.autocrlf=true`, in which case the 197resulting file would contain `CRLF`, although the original file 198contained `LF`. However, in both work trees the line endings would be 199consistent, that is either all `LF` or all `CRLF`, but never mixed. A 200file with mixed line endings would be reported by the `core.safecrlf` 201mechanism. 202 203core.symlinks:: 204 If false, symbolic links are checked out as small plain files that 205 contain the link text. linkgit:git-update-index[1] and 206 linkgit:git-add[1] will not change the recorded type to regular 207 file. Useful on filesystems like FAT that do not support 208 symbolic links. True by default. 209 210core.gitProxy:: 211 A "proxy command" to execute (as 'command host port') instead 212 of establishing direct connection to the remote server when 213 using the git protocol for fetching. If the variable value is 214 in the "COMMAND for DOMAIN" format, the command is applied only 215 on hostnames ending with the specified domain string. This variable 216 may be set multiple times and is matched in the given order; 217 the first match wins. 218+ 219Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 220(which always applies universally, without the special "for" 221handling). 222 223core.ignoreStat:: 224 If true, commands which modify both the working tree and the index 225 will mark the updated paths with the "assume unchanged" bit in the 226 index. These marked files are then assumed to stay unchanged in the 227 working copy, until you mark them otherwise manually - Git will not 228 detect the file changes by lstat() calls. This is useful on systems 229 where those are very slow, such as Microsoft Windows. 230 See linkgit:git-update-index[1]. 231 False by default. 232 233core.preferSymlinkRefs:: 234 Instead of the default "symref" format for HEAD 235 and other symbolic reference files, use symbolic links. 236 This is sometimes needed to work with old scripts that 237 expect HEAD to be a symbolic link. 238 239core.bare:: 240 If true this repository is assumed to be 'bare' and has no 241 working directory associated with it. If this is the case a 242 number of commands that require a working directory will be 243 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 244+ 245This setting is automatically guessed by linkgit:git-clone[1] or 246linkgit:git-init[1] when the repository was created. By default a 247repository that ends in "/.git" is assumed to be not bare (bare = 248false), while all other repositories are assumed to be bare (bare 249= true). 250 251core.worktree:: 252 Set the path to the working tree. The value will not be 253 used in combination with repositories found automatically in 254 a .git directory (i.e. $GIT_DIR is not set). 255 This can be overridden by the GIT_WORK_TREE environment 256 variable and the '--work-tree' command line option. It can be 257 a absolute path or relative path to the directory specified by 258 --git-dir or GIT_DIR. 259 Note: If --git-dir or GIT_DIR are specified but none of 260 --work-tree, GIT_WORK_TREE and core.worktree is specified, 261 the current working directory is regarded as the top directory 262 of your working tree. 263 264core.logAllRefUpdates:: 265 Enable the reflog. Updates to a ref <ref> is logged to the file 266 "$GIT_DIR/logs/<ref>", by appending the new and old 267 SHA1, the date/time and the reason of the update, but 268 only when the file exists. If this configuration 269 variable is set to true, missing "$GIT_DIR/logs/<ref>" 270 file is automatically created for branch heads. 271+ 272This information can be used to determine what commit 273was the tip of a branch "2 days ago". 274+ 275This value is true by default in a repository that has 276a working directory associated with it, and false by 277default in a bare repository. 278 279core.repositoryFormatVersion:: 280 Internal variable identifying the repository format and layout 281 version. 282 283core.sharedRepository:: 284 When 'group' (or 'true'), the repository is made shareable between 285 several users in a group (making sure all the files and objects are 286 group-writable). When 'all' (or 'world' or 'everybody'), the 287 repository will be readable by all users, additionally to being 288 group-shareable. When 'umask' (or 'false'), git will use permissions 289 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 290 files in the repository will have this mode value. '0xxx' will override 291 user's umask value, and thus, users with a safe umask (0077) can use 292 this option. Examples: '0660' is equivalent to 'group'. '0640' is a 293 repository that is group-readable but not group-writable. 294 See linkgit:git-init[1]. False by default. 295 296core.warnAmbiguousRefs:: 297 If true, git will warn you if the ref name you passed it is ambiguous 298 and might match multiple refs in the .git/refs/ tree. True by default. 299 300core.compression:: 301 An integer -1..9, indicating a default compression level. 302 -1 is the zlib default. 0 means no compression, 303 and 1..9 are various speed/size tradeoffs, 9 being slowest. 304 If set, this provides a default to other compression variables, 305 such as 'core.loosecompression' and 'pack.compression'. 306 307core.loosecompression:: 308 An integer -1..9, indicating the compression level for objects that 309 are not in a pack file. -1 is the zlib default. 0 means no 310 compression, and 1..9 are various speed/size tradeoffs, 9 being 311 slowest. If not set, defaults to core.compression. If that is 312 not set, defaults to 1 (best speed). 313 314core.packedGitWindowSize:: 315 Number of bytes of a pack file to map into memory in a 316 single mapping operation. Larger window sizes may allow 317 your system to process a smaller number of large pack files 318 more quickly. Smaller window sizes will negatively affect 319 performance due to increased calls to the operating system's 320 memory manager, but may improve performance when accessing 321 a large number of large pack files. 322+ 323Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 324MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 325be reasonable for all users/operating systems. You probably do 326not need to adjust this value. 327+ 328Common unit suffixes of 'k', 'm', or 'g' are supported. 329 330core.packedGitLimit:: 331 Maximum number of bytes to map simultaneously into memory 332 from pack files. If Git needs to access more than this many 333 bytes at once to complete an operation it will unmap existing 334 regions to reclaim virtual address space within the process. 335+ 336Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 337This should be reasonable for all users/operating systems, except on 338the largest projects. You probably do not need to adjust this value. 339+ 340Common unit suffixes of 'k', 'm', or 'g' are supported. 341 342core.deltaBaseCacheLimit:: 343 Maximum number of bytes to reserve for caching base objects 344 that multiple deltafied objects reference. By storing the 345 entire decompressed base objects in a cache Git is able 346 to avoid unpacking and decompressing frequently used base 347 objects multiple times. 348+ 349Default is 16 MiB on all platforms. This should be reasonable 350for all users/operating systems, except on the largest projects. 351You probably do not need to adjust this value. 352+ 353Common unit suffixes of 'k', 'm', or 'g' are supported. 354 355core.excludesfile:: 356 In addition to '.gitignore' (per-directory) and 357 '.git/info/exclude', git looks into this file for patterns 358 of files which are not meant to be tracked. See 359 linkgit:gitignore[5]. 360 361core.editor:: 362 Commands such as `commit` and `tag` that lets you edit 363 messages by launching an editor uses the value of this 364 variable when it is set, and the environment variable 365 `GIT_EDITOR` is not set. The order of preference is 366 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and 367 `EDITOR` environment variables and then finally `vi`. 368 369core.pager:: 370 The command that git will use to paginate output. Can 371 be overridden with the `GIT_PAGER` environment 372 variable. Note that git sets the `LESS` environment 373 variable to `FRSX` if it is unset when it runs the 374 pager. One can change these settings by setting the 375 `LESS` variable to some other value. Alternately, 376 these settings can be overridden on a project or 377 global basis by setting the `core.pager` option. 378 Setting `core.pager` has no affect on the `LESS` 379 environment variable behaviour above, so if you want 380 to override git's default settings this way, you need 381 to be explicit. For example, to disable the S option 382 in a backward compatible manner, set `core.pager` 383 to "`less -+$LESS -FRX`". This will be passed to the 384 shell by git, which will translate the final command to 385 "`LESS=FRSX less -+FRSX -FRX`". 386 387core.whitespace:: 388 A comma separated list of common whitespace problems to 389 notice. 'git-diff' will use `color.diff.whitespace` to 390 highlight them, and 'git-apply --whitespace=error' will 391 consider them as errors. You can prefix `-` to disable 392 any of them (e.g. `-trailing-space`): 393+ 394* `trailing-space` treats trailing whitespaces at the end of the line 395 as an error (enabled by default). 396* `space-before-tab` treats a space character that appears immediately 397 before a tab character in the initial indent part of the line as an 398 error (enabled by default). 399* `indent-with-non-tab` treats a line that is indented with 8 or more 400 space characters as an error (not enabled by default). 401* `cr-at-eol` treats a carriage-return at the end of line as 402 part of the line terminator, i.e. with it, `trailing-space` 403 does not trigger if the character before such a carriage-return 404 is not a whitespace (not enabled by default). 405 406core.fsyncobjectfiles:: 407 This boolean will enable 'fsync()' when writing object files. 408+ 409This is a total waste of time and effort on a filesystem that orders 410data writes properly, but can be useful for filesystems that do not use 411journalling (traditional UNIX filesystems) or that only journal metadata 412and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 413 414alias.*:: 415 Command aliases for the linkgit:git[1] command wrapper - e.g. 416 after defining "alias.last = cat-file commit HEAD", the invocation 417 "git last" is equivalent to "git cat-file commit HEAD". To avoid 418 confusion and troubles with script usage, aliases that 419 hide existing git commands are ignored. Arguments are split by 420 spaces, the usual shell quoting and escaping is supported. 421 quote pair and a backslash can be used to quote them. 422+ 423If the alias expansion is prefixed with an exclamation point, 424it will be treated as a shell command. For example, defining 425"alias.new = !gitk --all --not ORIG_HEAD", the invocation 426"git new" is equivalent to running the shell command 427"gitk --all --not ORIG_HEAD". 428 429apply.whitespace:: 430 Tells 'git-apply' how to handle whitespaces, in the same way 431 as the '--whitespace' option. See linkgit:git-apply[1]. 432 433branch.autosetupmerge:: 434 Tells 'git-branch' and 'git-checkout' to setup new branches 435 so that linkgit:git-pull[1] will appropriately merge from the 436 starting point branch. Note that even if this option is not set, 437 this behavior can be chosen per-branch using the `--track` 438 and `--no-track` options. The valid settings are: `false` -- no 439 automatic setup is done; `true` -- automatic setup is done when the 440 starting point is a remote branch; `always` -- automatic setup is 441 done when the starting point is either a local branch or remote 442 branch. This option defaults to true. 443 444branch.autosetuprebase:: 445 When a new branch is created with 'git-branch' or 'git-checkout' 446 that tracks another branch, this variable tells git to set 447 up pull to rebase instead of merge (see "branch.<name>.rebase"). 448 When `never`, rebase is never automatically set to true. 449 When `local`, rebase is set to true for tracked branches of 450 other local branches. 451 When `remote`, rebase is set to true for tracked branches of 452 remote branches. 453 When `always`, rebase will be set to true for all tracking 454 branches. 455 See "branch.autosetupmerge" for details on how to set up a 456 branch to track another branch. 457 This option defaults to never. 458 459branch.<name>.remote:: 460 When in branch <name>, it tells 'git-fetch' which remote to fetch. 461 If this option is not given, 'git-fetch' defaults to remote "origin". 462 463branch.<name>.merge:: 464 When in branch <name>, it tells 'git-fetch' the default 465 refspec to be marked for merging in FETCH_HEAD. The value is 466 handled like the remote part of a refspec, and must match a 467 ref which is fetched from the remote given by 468 "branch.<name>.remote". 469 The merge information is used by 'git-pull' (which at first calls 470 'git-fetch') to lookup the default branch for merging. Without 471 this option, 'git-pull' defaults to merge the first refspec fetched. 472 Specify multiple values to get an octopus merge. 473 If you wish to setup 'git-pull' so that it merges into <name> from 474 another branch in the local repository, you can point 475 branch.<name>.merge to the desired branch, and use the special setting 476 `.` (a period) for branch.<name>.remote. 477 478branch.<name>.mergeoptions:: 479 Sets default options for merging into branch <name>. The syntax and 480 supported options are equal to that of linkgit:git-merge[1], but 481 option values containing whitespace characters are currently not 482 supported. 483 484branch.<name>.rebase:: 485 When true, rebase the branch <name> on top of the fetched branch, 486 instead of merging the default branch from the default remote when 487 "git pull" is run. 488 *NOTE*: this is a possibly dangerous operation; do *not* use 489 it unless you understand the implications (see linkgit:git-rebase[1] 490 for details). 491 492browser.<tool>.cmd:: 493 Specify the command to invoke the specified browser. The 494 specified command is evaluated in shell with the URLs passed 495 as arguments. (See linkgit:git-web--browse[1].) 496 497browser.<tool>.path:: 498 Override the path for the given tool that may be used to 499 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 500 working repository in gitweb (see linkgit:git-instaweb[1]). 501 502clean.requireForce:: 503 A boolean to make git-clean do nothing unless given -f 504 or -n. Defaults to true. 505 506color.branch:: 507 A boolean to enable/disable color in the output of 508 linkgit:git-branch[1]. May be set to `always`, 509 `false` (or `never`) or `auto` (or `true`), in which case colors are used 510 only when the output is to a terminal. Defaults to false. 511 512color.branch.<slot>:: 513 Use customized color for branch coloration. `<slot>` is one of 514 `current` (the current branch), `local` (a local branch), 515 `remote` (a tracking branch in refs/remotes/), `plain` (other 516 refs). 517+ 518The value for these configuration variables is a list of colors (at most 519two) and attributes (at most one), separated by spaces. The colors 520accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 521`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 522`blink` and `reverse`. The first color given is the foreground; the 523second is the background. The position of the attribute, if any, 524doesn't matter. 525 526color.diff:: 527 When set to `always`, always use colors in patch. 528 When false (or `never`), never. When set to `true` or `auto`, use 529 colors only when the output is to the terminal. Defaults to false. 530 531color.diff.<slot>:: 532 Use customized color for diff colorization. `<slot>` specifies 533 which part of the patch to use the specified color, and is one 534 of `plain` (context text), `meta` (metainformation), `frag` 535 (hunk header), `old` (removed lines), `new` (added lines), 536 `commit` (commit headers), or `whitespace` (highlighting 537 whitespace errors). The values of these variables may be specified as 538 in color.branch.<slot>. 539 540color.interactive:: 541 When set to `always`, always use colors for interactive prompts 542 and displays (such as those used by "git-add --interactive"). 543 When false (or `never`), never. When set to `true` or `auto`, use 544 colors only when the output is to the terminal. Defaults to false. 545 546color.interactive.<slot>:: 547 Use customized color for 'git-add --interactive' 548 output. `<slot>` may be `prompt`, `header`, or `help`, for 549 three distinct types of normal output from interactive 550 programs. The values of these variables may be specified as 551 in color.branch.<slot>. 552 553color.pager:: 554 A boolean to enable/disable colored output when the pager is in 555 use (default is true). 556 557color.status:: 558 A boolean to enable/disable color in the output of 559 linkgit:git-status[1]. May be set to `always`, 560 `false` (or `never`) or `auto` (or `true`), in which case colors are used 561 only when the output is to a terminal. Defaults to false. 562 563color.status.<slot>:: 564 Use customized color for status colorization. `<slot>` is 565 one of `header` (the header text of the status message), 566 `added` or `updated` (files which are added but not committed), 567 `changed` (files which are changed but not added in the index), 568 `untracked` (files which are not tracked by git), or 569 `nobranch` (the color the 'no branch' warning is shown in, defaulting 570 to red). The values of these variables may be specified as in 571 color.branch.<slot>. 572 573commit.template:: 574 Specify a file to use as the template for new commit messages. 575 576color.ui:: 577 When set to `always`, always use colors in all git commands which 578 are capable of colored output. When false (or `never`), never. When 579 set to `true` or `auto`, use colors only when the output is to the 580 terminal. When more specific variables of color.* are set, they always 581 take precedence over this setting. Defaults to false. 582 583diff.autorefreshindex:: 584 When using 'git-diff' to compare with work tree 585 files, do not consider stat-only change as changed. 586 Instead, silently run `git update-index --refresh` to 587 update the cached stat information for paths whose 588 contents in the work tree match the contents in the 589 index. This option defaults to true. Note that this 590 affects only 'git-diff' Porcelain, and not lower level 591 'diff' commands, such as 'git-diff-files'. 592 593diff.suppress-blank-empty:: 594 A boolean to inhibit the standard behavior of printing a space 595 before each empty output line. Defaults to false. 596 597diff.external:: 598 If this config variable is set, diff generation is not 599 performed using the internal diff machinery, but using the 600 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 601 environment variable. The command is called with parameters 602 as described under "git Diffs" in linkgit:git[1]. Note: if 603 you want to use an external diff program only on a subset of 604 your files, you might want to use linkgit:gitattributes[5] instead. 605 606diff.mnemonicprefix:: 607 If set, 'git-diff' uses a prefix pair that is different from the 608 standard "a/" and "b/" depending on what is being compared. When 609 this configuration is in effect, reverse diff output also swaps 610 the order of the prefixes: 611'git-diff';; 612 compares the (i)ndex and the (w)ork tree; 613'git-diff HEAD';; 614 compares a (c)ommit and the (w)ork tree; 615'git diff --cached';; 616 compares a (c)ommit and the (i)ndex; 617'git-diff HEAD:file1 file2';; 618 compares an (o)bject and a (w)ork tree entity; 619'git diff --no-index a b';; 620 compares two non-git things (1) and (2). 621 622diff.renameLimit:: 623 The number of files to consider when performing the copy/rename 624 detection; equivalent to the 'git-diff' option '-l'. 625 626diff.renames:: 627 Tells git to detect renames. If set to any boolean value, it 628 will enable basic rename detection. If set to "copies" or 629 "copy", it will detect copies, as well. 630 631fetch.unpackLimit:: 632 If the number of objects fetched over the git native 633 transfer is below this 634 limit, then the objects will be unpacked into loose object 635 files. However if the number of received objects equals or 636 exceeds this limit then the received pack will be stored as 637 a pack, after adding any missing delta bases. Storing the 638 pack from a push can make the push operation complete faster, 639 especially on slow filesystems. If not set, the value of 640 `transfer.unpackLimit` is used instead. 641 642format.numbered:: 643 A boolean which can enable or disable sequence numbers in patch 644 subjects. It defaults to "auto" which enables it only if there 645 is more than one patch. It can be enabled or disabled for all 646 messages by setting it to "true" or "false". See --numbered 647 option in linkgit:git-format-patch[1]. 648 649format.headers:: 650 Additional email headers to include in a patch to be submitted 651 by mail. See linkgit:git-format-patch[1]. 652 653format.suffix:: 654 The default for format-patch is to output files with the suffix 655 `.patch`. Use this variable to change that suffix (make sure to 656 include the dot if you want it). 657 658format.pretty:: 659 The default pretty format for log/show/whatchanged command, 660 See linkgit:git-log[1], linkgit:git-show[1], 661 linkgit:git-whatchanged[1]. 662 663gc.aggressiveWindow:: 664 The window size parameter used in the delta compression 665 algorithm used by 'git-gc --aggressive'. This defaults 666 to 10. 667 668gc.auto:: 669 When there are approximately more than this many loose 670 objects in the repository, `git gc --auto` will pack them. 671 Some Porcelain commands use this command to perform a 672 light-weight garbage collection from time to time. The 673 default value is 6700. Setting this to 0 disables it. 674 675gc.autopacklimit:: 676 When there are more than this many packs that are not 677 marked with `*.keep` file in the repository, `git gc 678 --auto` consolidates them into one larger pack. The 679 default value is 50. Setting this to 0 disables it. 680 681gc.packrefs:: 682 'git-gc' does not run `git pack-refs` in a bare repository by 683 default so that older dumb-transport clients can still fetch 684 from the repository. Setting this to `true` lets 'git-gc' 685 to run `git pack-refs`. Setting this to `false` tells 686 'git-gc' never to run `git pack-refs`. The default setting is 687 `notbare`. Enable it only when you know you do not have to 688 support such clients. The default setting will change to `true` 689 at some stage, and setting this to `false` will continue to 690 prevent `git pack-refs` from being run from 'git-gc'. 691 692gc.pruneexpire:: 693 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'. 694 Override the grace period with this config variable. 695 696gc.reflogexpire:: 697 'git-reflog expire' removes reflog entries older than 698 this time; defaults to 90 days. 699 700gc.reflogexpireunreachable:: 701 'git-reflog expire' removes reflog entries older than 702 this time and are not reachable from the current tip; 703 defaults to 30 days. 704 705gc.rerereresolved:: 706 Records of conflicted merge you resolved earlier are 707 kept for this many days when 'git-rerere gc' is run. 708 The default is 60 days. See linkgit:git-rerere[1]. 709 710gc.rerereunresolved:: 711 Records of conflicted merge you have not resolved are 712 kept for this many days when 'git-rerere gc' is run. 713 The default is 15 days. See linkgit:git-rerere[1]. 714 715rerere.autoupdate:: 716 When set to true, `git-rerere` updates the index with the 717 resulting contents after it cleanly resolves conflicts using 718 previously recorded resolution. Defaults to false. 719 720rerere.enabled:: 721 Activate recording of resolved conflicts, so that identical 722 conflict hunks can be resolved automatically, should they 723 be encountered again. linkgit:git-rerere[1] command is by 724 default enabled if you create `rr-cache` directory under 725 `$GIT_DIR`, but can be disabled by setting this option to false. 726 727gitcvs.enabled:: 728 Whether the CVS server interface is enabled for this repository. 729 See linkgit:git-cvsserver[1]. 730 731gitcvs.logfile:: 732 Path to a log file where the CVS server interface well... logs 733 various stuff. See linkgit:git-cvsserver[1]. 734 735gitcvs.usecrlfattr:: 736 If true, the server will look up the `crlf` attribute for 737 files to determine the '-k' modes to use. If `crlf` is set, 738 the '-k' mode will be left blank, so cvs clients will 739 treat it as text. If `crlf` is explicitly unset, the file 740 will be set with '-kb' mode, which suppresses any newline munging 741 the client might otherwise do. If `crlf` is not specified, 742 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 743 744gitcvs.allbinary:: 745 This is used if 'gitcvs.usecrlfattr' does not resolve 746 the correct '-kb' mode to use. If true, all 747 unresolved files are sent to the client in 748 mode '-kb'. This causes the client to treat them 749 as binary files, which suppresses any newline munging it 750 otherwise might do. Alternatively, if it is set to "guess", 751 then the contents of the file are examined to decide if 752 it is binary, similar to 'core.autocrlf'. 753 754gitcvs.dbname:: 755 Database used by git-cvsserver to cache revision information 756 derived from the git repository. The exact meaning depends on the 757 used database driver, for SQLite (which is the default driver) this 758 is a filename. Supports variable substitution (see 759 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 760 Default: '%Ggitcvs.%m.sqlite' 761 762gitcvs.dbdriver:: 763 Used Perl DBI driver. You can specify any available driver 764 for this here, but it might not work. git-cvsserver is tested 765 with 'DBD::SQLite', reported to work with 'DBD::Pg', and 766 reported *not* to work with 'DBD::mysql'. Experimental feature. 767 May not contain double colons (`:`). Default: 'SQLite'. 768 See linkgit:git-cvsserver[1]. 769 770gitcvs.dbuser, gitcvs.dbpass:: 771 Database user and password. Only useful if setting 'gitcvs.dbdriver', 772 since SQLite has no concept of database users and/or passwords. 773 'gitcvs.dbuser' supports variable substitution (see 774 linkgit:git-cvsserver[1] for details). 775 776gitcvs.dbTableNamePrefix:: 777 Database table name prefix. Prepended to the names of any 778 database tables used, allowing a single database to be used 779 for several repositories. Supports variable substitution (see 780 linkgit:git-cvsserver[1] for details). Any non-alphabetic 781 characters will be replaced with underscores. 782 783All gitcvs variables except for 'gitcvs.usecrlfattr' and 784'gitcvs.allbinary' can also be specified as 785'gitcvs.<access_method>.<varname>' (where 'access_method' 786is one of "ext" and "pserver") to make them apply only for the given 787access method. 788 789gui.commitmsgwidth:: 790 Defines how wide the commit message window is in the 791 linkgit:git-gui[1]. "75" is the default. 792 793gui.diffcontext:: 794 Specifies how many context lines should be used in calls to diff 795 made by the linkgit:git-gui[1]. The default is "5". 796 797gui.matchtrackingbranch:: 798 Determines if new branches created with linkgit:git-gui[1] should 799 default to tracking remote branches with matching names or 800 not. Default: "false". 801 802gui.newbranchtemplate:: 803 Is used as suggested name when creating new branches using the 804 linkgit:git-gui[1]. 805 806gui.pruneduringfetch:: 807 "true" if linkgit:git-gui[1] should prune tracking branches when 808 performing a fetch. The default value is "false". 809 810gui.trustmtime:: 811 Determines if linkgit:git-gui[1] should trust the file modification 812 timestamp or not. By default the timestamps are not trusted. 813 814gui.spellingdictionary:: 815 Specifies the dictionary used for spell checking commit messages in 816 the linkgit:git-gui[1]. When set to "none" spell checking is turned 817 off. 818 819help.browser:: 820 Specify the browser that will be used to display help in the 821 'web' format. See linkgit:git-help[1]. 822 823help.format:: 824 Override the default help format used by linkgit:git-help[1]. 825 Values 'man', 'info', 'web' and 'html' are supported. 'man' is 826 the default. 'web' and 'html' are the same. 827 828help.autocorrect:: 829 Automatically correct and execute mistyped commands after 830 waiting for the given number of deciseconds (0.1 sec). If more 831 than one command can be deduced from the entered text, nothing 832 will be executed. If the value of this option is negative, 833 the corrected command will be executed immediately. If the 834 value is 0 - the command will be just shown but not executed. 835 This is the default. 836 837http.proxy:: 838 Override the HTTP proxy, normally configured using the 'http_proxy' 839 environment variable (see linkgit:curl[1]). This can be overridden 840 on a per-remote basis; see remote.<name>.proxy 841 842http.sslVerify:: 843 Whether to verify the SSL certificate when fetching or pushing 844 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment 845 variable. 846 847http.sslCert:: 848 File containing the SSL certificate when fetching or pushing 849 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment 850 variable. 851 852http.sslKey:: 853 File containing the SSL private key when fetching or pushing 854 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment 855 variable. 856 857http.sslCAInfo:: 858 File containing the certificates to verify the peer with when 859 fetching or pushing over HTTPS. Can be overridden by the 860 'GIT_SSL_CAINFO' environment variable. 861 862http.sslCAPath:: 863 Path containing files with the CA certificates to verify the peer 864 with when fetching or pushing over HTTPS. Can be overridden 865 by the 'GIT_SSL_CAPATH' environment variable. 866 867http.maxRequests:: 868 How many HTTP requests to launch in parallel. Can be overridden 869 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. 870 871http.lowSpeedLimit, http.lowSpeedTime:: 872 If the HTTP transfer speed is less than 'http.lowSpeedLimit' 873 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. 874 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and 875 'GIT_HTTP_LOW_SPEED_TIME' environment variables. 876 877http.noEPSV:: 878 A boolean which disables using of EPSV ftp command by curl. 879 This can helpful with some "poor" ftp servers which don't 880 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' 881 environment variable. Default is false (curl will use EPSV). 882 883i18n.commitEncoding:: 884 Character encoding the commit messages are stored in; git itself 885 does not care per se, but this information is necessary e.g. when 886 importing commits from emails or in the gitk graphical history 887 browser (and possibly at other places in the future or in other 888 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. 889 890i18n.logOutputEncoding:: 891 Character encoding the commit messages are converted to when 892 running 'git-log' and friends. 893 894instaweb.browser:: 895 Specify the program that will be used to browse your working 896 repository in gitweb. See linkgit:git-instaweb[1]. 897 898instaweb.httpd:: 899 The HTTP daemon command-line to start gitweb on your working 900 repository. See linkgit:git-instaweb[1]. 901 902instaweb.local:: 903 If true the web server started by linkgit:git-instaweb[1] will 904 be bound to the local IP (127.0.0.1). 905 906instaweb.modulepath:: 907 The module path for an apache httpd used by linkgit:git-instaweb[1]. 908 909instaweb.port:: 910 The port number to bind the gitweb httpd to. See 911 linkgit:git-instaweb[1]. 912 913log.date:: 914 Set default date-time mode for the log command. Setting log.date 915 value is similar to using 'git-log'\'s --date option. The value is one of the 916 following alternatives: {relative,local,default,iso,rfc,short}. 917 See linkgit:git-log[1]. 918 919log.showroot:: 920 If true, the initial commit will be shown as a big creation event. 921 This is equivalent to a diff against an empty tree. 922 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which 923 normally hide the root commit will now show it. True by default. 924 925man.viewer:: 926 Specify the programs that may be used to display help in the 927 'man' format. See linkgit:git-help[1]. 928 929include::merge-config.txt[] 930 931man.<tool>.cmd:: 932 Specify the command to invoke the specified man viewer. The 933 specified command is evaluated in shell with the man page 934 passed as argument. (See linkgit:git-help[1].) 935 936man.<tool>.path:: 937 Override the path for the given tool that may be used to 938 display help in the 'man' format. See linkgit:git-help[1]. 939 940merge.conflictstyle:: 941 Specify the style in which conflicted hunks are written out to 942 working tree files upon merge. The default is "merge", which 943 shows `<<<<<<<` conflict marker, change made by one side, 944 `=======` marker, change made by the other side, and then 945 `>>>>>>>` marker. An alternate style, "diff3", adds `|||||||` 946 marker and the original text before `=======` marker. 947 948mergetool.<tool>.path:: 949 Override the path for the given tool. This is useful in case 950 your tool is not in the PATH. 951 952mergetool.<tool>.cmd:: 953 Specify the command to invoke the specified merge tool. The 954 specified command is evaluated in shell with the following 955 variables available: 'BASE' is the name of a temporary file 956 containing the common base of the files to be merged, if available; 957 'LOCAL' is the name of a temporary file containing the contents of 958 the file on the current branch; 'REMOTE' is the name of a temporary 959 file containing the contents of the file from the branch being 960 merged; 'MERGED' contains the name of the file to which the merge 961 tool should write the results of a successful merge. 962 963mergetool.<tool>.trustExitCode:: 964 For a custom merge command, specify whether the exit code of 965 the merge command can be used to determine whether the merge was 966 successful. If this is not set to true then the merge target file 967 timestamp is checked and the merge assumed to have been successful 968 if the file has been updated, otherwise the user is prompted to 969 indicate the success of the merge. 970 971mergetool.keepBackup:: 972 After performing a merge, the original file with conflict markers 973 can be saved as a file with a `.orig` extension. If this variable 974 is set to `false` then this file is not preserved. Defaults to 975 `true` (i.e. keep the backup files). 976 977pack.window:: 978 The size of the window used by linkgit:git-pack-objects[1] when no 979 window size is given on the command line. Defaults to 10. 980 981pack.depth:: 982 The maximum delta depth used by linkgit:git-pack-objects[1] when no 983 maximum depth is given on the command line. Defaults to 50. 984 985pack.windowMemory:: 986 The window memory size limit used by linkgit:git-pack-objects[1] 987 when no limit is given on the command line. The value can be 988 suffixed with "k", "m", or "g". Defaults to 0, meaning no 989 limit. 990 991pack.compression:: 992 An integer -1..9, indicating the compression level for objects 993 in a pack file. -1 is the zlib default. 0 means no 994 compression, and 1..9 are various speed/size tradeoffs, 9 being 995 slowest. If not set, defaults to core.compression. If that is 996 not set, defaults to -1, the zlib default, which is "a default 997 compromise between speed and compression (currently equivalent 998 to level 6)." 9991000pack.deltaCacheSize::1001 The maximum memory in bytes used for caching deltas in1002 linkgit:git-pack-objects[1].1003 A value of 0 means no limit. Defaults to 0.10041005pack.deltaCacheLimit::1006 The maximum size of a delta, that is cached in1007 linkgit:git-pack-objects[1]. Defaults to 1000.10081009pack.threads::1010 Specifies the number of threads to spawn when searching for best1011 delta matches. This requires that linkgit:git-pack-objects[1]1012 be compiled with pthreads otherwise this option is ignored with a1013 warning. This is meant to reduce packing time on multiprocessor1014 machines. The required amount of memory for the delta search window1015 is however multiplied by the number of threads.1016 Specifying 0 will cause git to auto-detect the number of CPU's1017 and set the number of threads accordingly.10181019pack.indexVersion::1020 Specify the default pack index version. Valid values are 1 for1021 legacy pack index used by Git versions prior to 1.5.2, and 2 for1022 the new pack index with capabilities for packs larger than 4 GB1023 as well as proper protection against the repacking of corrupted1024 packs. Version 2 is the default. Note that version 2 is enforced1025 and this config option ignored whenever the corresponding pack is1026 larger than 2 GB.1027+1028If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1029cloning or fetching over a non native protocol (e.g. "http" and "rsync")1030that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1031other side may give you a repository that cannot be accessed with your1032older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1033you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1034the `{asterisk}.idx` file.10351036pack.packSizeLimit::1037 The default maximum size of a pack. This setting only affects1038 packing to a file, i.e. the git:// protocol is unaffected. It1039 can be overridden by the `\--max-pack-size` option of1040 linkgit:git-repack[1].10411042pager.<cmd>::1043 Allows turning on or off pagination of the output of a1044 particular git subcommand when writing to a tty. If1045 `\--paginate` or `\--no-pager` is specified on the command line,1046 it takes precedence over this option. To disable pagination for1047 all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".10481049pull.octopus::1050 The default merge strategy to use when pulling multiple branches1051 at once.10521053pull.twohead::1054 The default merge strategy to use when pulling a single branch.10551056remote.<name>.url::1057 The URL of a remote repository. See linkgit:git-fetch[1] or1058 linkgit:git-push[1].10591060remote.<name>.proxy::1061 For remotes that require curl (http, https and ftp), the URL to1062 the proxy to use for that remote. Set to the empty string to1063 disable proxying for that remote.10641065remote.<name>.fetch::1066 The default set of "refspec" for linkgit:git-fetch[1]. See1067 linkgit:git-fetch[1].10681069remote.<name>.push::1070 The default set of "refspec" for linkgit:git-push[1]. See1071 linkgit:git-push[1].10721073remote.<name>.mirror::1074 If true, pushing to this remote will automatically behave1075 as if the `\--mirror` option was given on the command line.10761077remote.<name>.skipDefaultUpdate::1078 If true, this remote will be skipped by default when updating1079 using the update subcommand of linkgit:git-remote[1].10801081remote.<name>.receivepack::1082 The default program to execute on the remote side when pushing. See1083 option \--receive-pack of linkgit:git-push[1].10841085remote.<name>.uploadpack::1086 The default program to execute on the remote side when fetching. See1087 option \--upload-pack of linkgit:git-fetch-pack[1].10881089remote.<name>.tagopt::1090 Setting this value to \--no-tags disables automatic tag following when1091 fetching from remote <name>10921093remotes.<group>::1094 The list of remotes which are fetched by "git remote update1095 <group>". See linkgit:git-remote[1].10961097repack.usedeltabaseoffset::1098 By default, linkgit:git-repack[1] creates packs that use1099 delta-base offset. If you need to share your repository with1100 git older than version 1.4.4, either directly or via a dumb1101 protocol such as http, then you need to set this option to1102 "false" and repack. Access from old git versions over the1103 native protocol are unaffected by this option.11041105showbranch.default::1106 The default set of branches for linkgit:git-show-branch[1].1107 See linkgit:git-show-branch[1].11081109status.relativePaths::1110 By default, linkgit:git-status[1] shows paths relative to the1111 current directory. Setting this variable to `false` shows paths1112 relative to the repository root (this was the default for git1113 prior to v1.5.4).11141115status.showUntrackedFiles::1116 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1117 files which are not currently tracked by Git. Directories which1118 contain only untracked files, are shown with the directory name1119 only. Showing untracked files means that Git needs to lstat() all1120 all the files in the whole repository, which might be slow on some1121 systems. So, this variable controls how the commands displays1122 the untracked files. Possible values are:1123+1124--1125 - 'no' - Show no untracked files1126 - 'normal' - Shows untracked files and directories1127 - 'all' - Shows also individual files in untracked directories.1128--1129+1130If this variable is not specified, it defaults to 'normal'.1131This variable can be overridden with the -u|--untracked-files option1132of linkgit:git-status[1] and linkgit:git-commit[1].11331134tar.umask::1135 This variable can be used to restrict the permission bits of1136 tar archive entries. The default is 0002, which turns off the1137 world write bit. The special value "user" indicates that the1138 archiving user's umask will be used instead. See umask(2) and1139 linkgit:git-archive[1].11401141url.<base>.insteadOf::1142 Any URL that starts with this value will be rewritten to1143 start, instead, with <base>. In cases where some site serves a1144 large number of repositories, and serves them with multiple1145 access methods, and some users need to use different access1146 methods, this feature allows people to specify any of the1147 equivalent URLs and have git automatically rewrite the URL to1148 the best alternative for the particular user, even for a1149 never-before-seen repository on the site. When more than one1150 insteadOf strings match a given URL, the longest match is used.11511152user.email::1153 Your email address to be recorded in any newly created commits.1154 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1155 'EMAIL' environment variables. See linkgit:git-commit-tree[1].11561157user.name::1158 Your full name to be recorded in any newly created commits.1159 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1160 environment variables. See linkgit:git-commit-tree[1].11611162user.signingkey::1163 If linkgit:git-tag[1] is not selecting the key you want it to1164 automatically when creating a signed tag, you can override the1165 default selection with this variable. This option is passed1166 unchanged to gpg's --local-user parameter, so you may specify a key1167 using any method that gpg supports.11681169imap::1170 The configuration variables in the 'imap' section are described1171 in linkgit:git-imap-send[1].11721173receive.fsckObjects::1174 If it is set to true, git-receive-pack will check all received1175 objects. It will abort in the case of a malformed object or a1176 broken link. The result of an abort are only dangling objects.1177 Defaults to false.11781179receive.unpackLimit::1180 If the number of objects received in a push is below this1181 limit then the objects will be unpacked into loose object1182 files. However if the number of received objects equals or1183 exceeds this limit then the received pack will be stored as1184 a pack, after adding any missing delta bases. Storing the1185 pack from a push can make the push operation complete faster,1186 especially on slow filesystems. If not set, the value of1187 `transfer.unpackLimit` is used instead.11881189receive.denyNonFastForwards::1190 If set to true, git-receive-pack will deny a ref update which is1191 not a fast forward. Use this to prevent such an update via a push,1192 even if that push is forced. This configuration variable is1193 set when initializing a shared repository.11941195transfer.unpackLimit::1196 When `fetch.unpackLimit` or `receive.unpackLimit` are1197 not set, the value of this variable is used instead.1198 The default value is 100.11991200web.browser::1201 Specify a web browser that may be used by some commands.1202 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1203 may use it.