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