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