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: 362+ 363* `trailing-space` treats trailing whitespaces at the end of the line 364 as an error (enabled by default). 365* `space-before-tab` treats a space character that appears immediately 366 before a tab character in the initial indent part of the line as an 367 error (enabled by default). 368* `indent-with-non-tab` treats a line that is indented with 8 or more 369 space characters as an error (not enabled by default). 370* `cr-at-eol` treats a carriage-return at the end of line as 371 part of the line terminator, i.e. with it, `trailing-space` 372 does not trigger if the character before such a carriage-return 373 is not a whitespace (not enabled by default). 374 375core.fsyncobjectfiles:: 376 This boolean will enable 'fsync()' when writing object files. 377+ 378This is a total waste of time and effort on a filesystem that orders 379data writes properly, but can be useful for filesystems that do not use 380journalling (traditional UNIX filesystems) or that only journal metadata 381and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 382 383alias.*:: 384 Command aliases for the linkgit:git[1] command wrapper - e.g. 385 after defining "alias.last = cat-file commit HEAD", the invocation 386 "git last" is equivalent to "git cat-file commit HEAD". To avoid 387 confusion and troubles with script usage, aliases that 388 hide existing git commands are ignored. Arguments are split by 389 spaces, the usual shell quoting and escaping is supported. 390 quote pair and a backslash can be used to quote them. 391+ 392If the alias expansion is prefixed with an exclamation point, 393it will be treated as a shell command. For example, defining 394"alias.new = !gitk --all --not ORIG_HEAD", the invocation 395"git new" is equivalent to running the shell command 396"gitk --all --not ORIG_HEAD". 397 398apply.whitespace:: 399 Tells 'git-apply' how to handle whitespaces, in the same way 400 as the '--whitespace' option. See linkgit:git-apply[1]. 401 402branch.autosetupmerge:: 403 Tells 'git-branch' and 'git-checkout' to setup new branches 404 so that linkgit:git-pull[1] will appropriately merge from the 405 starting point branch. Note that even if this option is not set, 406 this behavior can be chosen per-branch using the `--track` 407 and `--no-track` options. The valid settings are: `false` -- no 408 automatic setup is done; `true` -- automatic setup is done when the 409 starting point is a remote branch; `always` -- automatic setup is 410 done when the starting point is either a local branch or remote 411 branch. This option defaults to true. 412 413branch.autosetuprebase:: 414 When a new branch is created with 'git-branch' or 'git-checkout' 415 that tracks another branch, this variable tells git to set 416 up pull to rebase instead of merge (see "branch.<name>.rebase"). 417 When `never`, rebase is never automatically set to true. 418 When `local`, rebase is set to true for tracked branches of 419 other local branches. 420 When `remote`, rebase is set to true for tracked branches of 421 remote branches. 422 When `always`, rebase will be set to true for all tracking 423 branches. 424 See "branch.autosetupmerge" for details on how to set up a 425 branch to track another branch. 426 This option defaults to never. 427 428branch.<name>.remote:: 429 When in branch <name>, it tells 'git-fetch' which remote to fetch. 430 If this option is not given, 'git-fetch' defaults to remote "origin". 431 432branch.<name>.merge:: 433 When in branch <name>, it tells 'git-fetch' the default 434 refspec to be marked for merging in FETCH_HEAD. The value is 435 handled like the remote part of a refspec, and must match a 436 ref which is fetched from the remote given by 437 "branch.<name>.remote". 438 The merge information is used by 'git-pull' (which at first calls 439 'git-fetch') to lookup the default branch for merging. Without 440 this option, 'git-pull' defaults to merge the first refspec fetched. 441 Specify multiple values to get an octopus merge. 442 If you wish to setup 'git-pull' so that it merges into <name> from 443 another branch in the local repository, you can point 444 branch.<name>.merge to the desired branch, and use the special setting 445 `.` (a period) for branch.<name>.remote. 446 447branch.<name>.mergeoptions:: 448 Sets default options for merging into branch <name>. The syntax and 449 supported options are equal to that of linkgit:git-merge[1], but 450 option values containing whitespace characters are currently not 451 supported. 452 453branch.<name>.rebase:: 454 When true, rebase the branch <name> on top of the fetched branch, 455 instead of merging the default branch from the default remote when 456 "git pull" is run. 457 *NOTE*: this is a possibly dangerous operation; do *not* use 458 it unless you understand the implications (see linkgit:git-rebase[1] 459 for details). 460 461browser.<tool>.cmd:: 462 Specify the command to invoke the specified browser. The 463 specified command is evaluated in shell with the URLs passed 464 as arguments. (See linkgit:git-web--browse[1].) 465 466browser.<tool>.path:: 467 Override the path for the given tool that may be used to 468 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 469 working repository in gitweb (see linkgit:git-instaweb[1]). 470 471clean.requireForce:: 472 A boolean to make git-clean do nothing unless given -f 473 or -n. Defaults to true. 474 475color.branch:: 476 A boolean to enable/disable color in the output of 477 linkgit:git-branch[1]. May be set to `always`, 478 `false` (or `never`) or `auto` (or `true`), in which case colors are used 479 only when the output is to a terminal. Defaults to false. 480 481color.branch.<slot>:: 482 Use customized color for branch coloration. `<slot>` is one of 483 `current` (the current branch), `local` (a local branch), 484 `remote` (a tracking branch in refs/remotes/), `plain` (other 485 refs). 486+ 487The value for these configuration variables is a list of colors (at most 488two) and attributes (at most one), separated by spaces. The colors 489accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 490`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 491`blink` and `reverse`. The first color given is the foreground; the 492second is the background. The position of the attribute, if any, 493doesn't matter. 494 495color.diff:: 496 When set to `always`, always use colors in patch. 497 When false (or `never`), never. When set to `true` or `auto`, use 498 colors only when the output is to the terminal. Defaults to false. 499 500color.diff.<slot>:: 501 Use customized color for diff colorization. `<slot>` specifies 502 which part of the patch to use the specified color, and is one 503 of `plain` (context text), `meta` (metainformation), `frag` 504 (hunk header), `old` (removed lines), `new` (added lines), 505 `commit` (commit headers), or `whitespace` (highlighting 506 whitespace errors). The values of these variables may be specified as 507 in color.branch.<slot>. 508 509color.interactive:: 510 When set to `always`, always use colors for interactive prompts 511 and displays (such as those used by "git-add --interactive"). 512 When false (or `never`), never. When set to `true` or `auto`, use 513 colors only when the output is to the terminal. Defaults to false. 514 515color.interactive.<slot>:: 516 Use customized color for 'git-add --interactive' 517 output. `<slot>` may be `prompt`, `header`, or `help`, for 518 three distinct types of normal output from interactive 519 programs. The values of these variables may be specified as 520 in color.branch.<slot>. 521 522color.pager:: 523 A boolean to enable/disable colored output when the pager is in 524 use (default is true). 525 526color.status:: 527 A boolean to enable/disable color in the output of 528 linkgit:git-status[1]. May be set to `always`, 529 `false` (or `never`) or `auto` (or `true`), in which case colors are used 530 only when the output is to a terminal. Defaults to false. 531 532color.status.<slot>:: 533 Use customized color for status colorization. `<slot>` is 534 one of `header` (the header text of the status message), 535 `added` or `updated` (files which are added but not committed), 536 `changed` (files which are changed but not added in the index), 537 `untracked` (files which are not tracked by git), or 538 `nobranch` (the color the 'no branch' warning is shown in, defaulting 539 to red). The values of these variables may be specified as in 540 color.branch.<slot>. 541 542commit.template:: 543 Specify a file to use as the template for new commit messages. 544 545color.ui:: 546 When set to `always`, always use colors in all git commands which 547 are capable of colored output. When false (or `never`), never. When 548 set to `true` or `auto`, use colors only when the output is to the 549 terminal. When more specific variables of color.* are set, they always 550 take precedence over this setting. Defaults to false. 551 552diff.autorefreshindex:: 553 When using 'git-diff' to compare with work tree 554 files, do not consider stat-only change as changed. 555 Instead, silently run `git update-index --refresh` to 556 update the cached stat information for paths whose 557 contents in the work tree match the contents in the 558 index. This option defaults to true. Note that this 559 affects only 'git-diff' Porcelain, and not lower level 560 'diff' commands, such as 'git-diff-files'. 561 562diff.external:: 563 If this config variable is set, diff generation is not 564 performed using the internal diff machinery, but using the 565 given command. Note: if you want to use an external diff 566 program only on a subset of your files, you might want to 567 use linkgit:gitattributes[5] instead. 568 569diff.renameLimit:: 570 The number of files to consider when performing the copy/rename 571 detection; equivalent to the 'git-diff' option '-l'. 572 573diff.renames:: 574 Tells git to detect renames. If set to any boolean value, it 575 will enable basic rename detection. If set to "copies" or 576 "copy", it will detect copies, as well. 577 578fetch.unpackLimit:: 579 If the number of objects fetched over the git native 580 transfer is below this 581 limit, then the objects will be unpacked into loose object 582 files. However if the number of received objects equals or 583 exceeds this limit then the received pack will be stored as 584 a pack, after adding any missing delta bases. Storing the 585 pack from a push can make the push operation complete faster, 586 especially on slow filesystems. If not set, the value of 587 `transfer.unpackLimit` is used instead. 588 589format.numbered:: 590 A boolean which can enable sequence numbers in patch subjects. 591 Setting this option to "auto" will enable it only if there is 592 more than one patch. See --numbered option in 593 linkgit:git-format-patch[1]. 594 595format.headers:: 596 Additional email headers to include in a patch to be submitted 597 by mail. See linkgit:git-format-patch[1]. 598 599format.suffix:: 600 The default for format-patch is to output files with the suffix 601 `.patch`. Use this variable to change that suffix (make sure to 602 include the dot if you want it). 603 604format.pretty:: 605 The default pretty format for log/show/whatchanged command, 606 See linkgit:git-log[1], linkgit:git-show[1], 607 linkgit:git-whatchanged[1]. 608 609gc.aggressiveWindow:: 610 The window size parameter used in the delta compression 611 algorithm used by 'git-gc --aggressive'. This defaults 612 to 10. 613 614gc.auto:: 615 When there are approximately more than this many loose 616 objects in the repository, `git gc --auto` will pack them. 617 Some Porcelain commands use this command to perform a 618 light-weight garbage collection from time to time. The 619 default value is 6700. Setting this to 0 disables it. 620 621gc.autopacklimit:: 622 When there are more than this many packs that are not 623 marked with `*.keep` file in the repository, `git gc 624 --auto` consolidates them into one larger pack. The 625 default value is 50. Setting this to 0 disables it. 626 627gc.packrefs:: 628 'git-gc' does not run `git pack-refs` in a bare repository by 629 default so that older dumb-transport clients can still fetch 630 from the repository. Setting this to `true` lets 'git-gc' 631 to run `git pack-refs`. Setting this to `false` tells 632 'git-gc' never to run `git pack-refs`. The default setting is 633 `notbare`. Enable it only when you know you do not have to 634 support such clients. The default setting will change to `true` 635 at some stage, and setting this to `false` will continue to 636 prevent `git pack-refs` from being run from 'git-gc'. 637 638gc.pruneexpire:: 639 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'. 640 Override the grace period with this config variable. 641 642gc.reflogexpire:: 643 'git-reflog expire' removes reflog entries older than 644 this time; defaults to 90 days. 645 646gc.reflogexpireunreachable:: 647 'git-reflog expire' removes reflog entries older than 648 this time and are not reachable from the current tip; 649 defaults to 30 days. 650 651gc.rerereresolved:: 652 Records of conflicted merge you resolved earlier are 653 kept for this many days when 'git-rerere gc' is run. 654 The default is 60 days. See linkgit:git-rerere[1]. 655 656gc.rerereunresolved:: 657 Records of conflicted merge you have not resolved are 658 kept for this many days when 'git-rerere gc' is run. 659 The default is 15 days. See linkgit:git-rerere[1]. 660 661rerere.autoupdate:: 662 When set to true, `git-rerere` updates the index with the 663 resulting contents after it cleanly resolves conflicts using 664 previously recorded resolution. Defaults to false. 665 666rerere.enabled:: 667 Activate recording of resolved conflicts, so that identical 668 conflict hunks can be resolved automatically, should they 669 be encountered again. linkgit:git-rerere[1] command is by 670 default enabled if you create `rr-cache` directory under 671 `$GIT_DIR`, but can be disabled by setting this option to false. 672 673gitcvs.enabled:: 674 Whether the CVS server interface is enabled for this repository. 675 See linkgit:git-cvsserver[1]. 676 677gitcvs.logfile:: 678 Path to a log file where the CVS server interface well... logs 679 various stuff. See linkgit:git-cvsserver[1]. 680 681gitcvs.usecrlfattr 682 If true, the server will look up the `crlf` attribute for 683 files to determine the '-k' modes to use. If `crlf` is set, 684 the '-k' mode will be left blank, so cvs clients will 685 treat it as text. If `crlf` is explicitly unset, the file 686 will be set with '-kb' mode, which supresses any newline munging 687 the client might otherwise do. If `crlf` is not specified, 688 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 689 690gitcvs.allbinary:: 691 This is used if 'gitcvs.usecrlfattr' does not resolve 692 the correct '-kb' mode to use. If true, all 693 unresolved files are sent to the client in 694 mode '-kb'. This causes the client to treat them 695 as binary files, which suppresses any newline munging it 696 otherwise might do. Alternatively, if it is set to "guess", 697 then the contents of the file are examined to decide if 698 it is binary, similar to 'core.autocrlf'. 699 700gitcvs.dbname:: 701 Database used by git-cvsserver to cache revision information 702 derived from the git repository. The exact meaning depends on the 703 used database driver, for SQLite (which is the default driver) this 704 is a filename. Supports variable substitution (see 705 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 706 Default: '%Ggitcvs.%m.sqlite' 707 708gitcvs.dbdriver:: 709 Used Perl DBI driver. You can specify any available driver 710 for this here, but it might not work. git-cvsserver is tested 711 with 'DBD::SQLite', reported to work with 'DBD::Pg', and 712 reported *not* to work with 'DBD::mysql'. Experimental feature. 713 May not contain double colons (`:`). Default: 'SQLite'. 714 See linkgit:git-cvsserver[1]. 715 716gitcvs.dbuser, gitcvs.dbpass:: 717 Database user and password. Only useful if setting 'gitcvs.dbdriver', 718 since SQLite has no concept of database users and/or passwords. 719 'gitcvs.dbuser' supports variable substitution (see 720 linkgit:git-cvsserver[1] for details). 721 722gitcvs.dbTableNamePrefix:: 723 Database table name prefix. Prepended to the names of any 724 database tables used, allowing a single database to be used 725 for several repositories. Supports variable substitution (see 726 linkgit:git-cvsserver[1] for details). Any non-alphabetic 727 characters will be replaced with underscores. 728 729All gitcvs variables except for 'gitcvs.usecrlfattr' and 730'gitcvs.allbinary' can also be specified as 731'gitcvs.<access_method>.<varname>' (where 'access_method' 732is one of "ext" and "pserver") to make them apply only for the given 733access method. 734 735gui.commitmsgwidth:: 736 Defines how wide the commit message window is in the 737 linkgit:git-gui[1]. "75" is the default. 738 739gui.diffcontext:: 740 Specifies how many context lines should be used in calls to diff 741 made by the linkgit:git-gui[1]. The default is "5". 742 743gui.matchtrackingbranch:: 744 Determines if new branches created with linkgit:git-gui[1] should 745 default to tracking remote branches with matching names or 746 not. Default: "false". 747 748gui.newbranchtemplate:: 749 Is used as suggested name when creating new branches using the 750 linkgit:git-gui[1]. 751 752gui.pruneduringfetch:: 753 "true" if linkgit:git-gui[1] should prune tracking branches when 754 performing a fetch. The default value is "false". 755 756gui.trustmtime:: 757 Determines if linkgit:git-gui[1] should trust the file modification 758 timestamp or not. By default the timestamps are not trusted. 759 760gui.spellingdictionary:: 761 Specifies the dictionary used for spell checking commit messages in 762 the linkgit:git-gui[1]. When set to "none" spell checking is turned 763 off. 764 765help.browser:: 766 Specify the browser that will be used to display help in the 767 'web' format. See linkgit:git-help[1]. 768 769help.format:: 770 Override the default help format used by linkgit:git-help[1]. 771 Values 'man', 'info', 'web' and 'html' are supported. 'man' is 772 the default. 'web' and 'html' are the same. 773 774http.proxy:: 775 Override the HTTP proxy, normally configured using the 'http_proxy' 776 environment variable (see linkgit:curl[1]). This can be overridden 777 on a per-remote basis; see remote.<name>.proxy 778 779http.sslVerify:: 780 Whether to verify the SSL certificate when fetching or pushing 781 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment 782 variable. 783 784http.sslCert:: 785 File containing the SSL certificate when fetching or pushing 786 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment 787 variable. 788 789http.sslKey:: 790 File containing the SSL private key when fetching or pushing 791 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment 792 variable. 793 794http.sslCAInfo:: 795 File containing the certificates to verify the peer with when 796 fetching or pushing over HTTPS. Can be overridden by the 797 'GIT_SSL_CAINFO' environment variable. 798 799http.sslCAPath:: 800 Path containing files with the CA certificates to verify the peer 801 with when fetching or pushing over HTTPS. Can be overridden 802 by the 'GIT_SSL_CAPATH' environment variable. 803 804http.maxRequests:: 805 How many HTTP requests to launch in parallel. Can be overridden 806 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. 807 808http.lowSpeedLimit, http.lowSpeedTime:: 809 If the HTTP transfer speed is less than 'http.lowSpeedLimit' 810 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. 811 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and 812 'GIT_HTTP_LOW_SPEED_TIME' environment variables. 813 814http.noEPSV:: 815 A boolean which disables using of EPSV ftp command by curl. 816 This can helpful with some "poor" ftp servers which don't 817 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' 818 environment variable. Default is false (curl will use EPSV). 819 820i18n.commitEncoding:: 821 Character encoding the commit messages are stored in; git itself 822 does not care per se, but this information is necessary e.g. when 823 importing commits from emails or in the gitk graphical history 824 browser (and possibly at other places in the future or in other 825 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. 826 827i18n.logOutputEncoding:: 828 Character encoding the commit messages are converted to when 829 running 'git-log' and friends. 830 831instaweb.browser:: 832 Specify the program that will be used to browse your working 833 repository in gitweb. See linkgit:git-instaweb[1]. 834 835instaweb.httpd:: 836 The HTTP daemon command-line to start gitweb on your working 837 repository. See linkgit:git-instaweb[1]. 838 839instaweb.local:: 840 If true the web server started by linkgit:git-instaweb[1] will 841 be bound to the local IP (127.0.0.1). 842 843instaweb.modulepath:: 844 The module path for an apache httpd used by linkgit:git-instaweb[1]. 845 846instaweb.port:: 847 The port number to bind the gitweb httpd to. See 848 linkgit:git-instaweb[1]. 849 850log.date:: 851 Set default date-time mode for the log command. Setting log.date 852 value is similar to using 'git-log'\'s --date option. The value is one of the 853 following alternatives: {relative,local,default,iso,rfc,short}. 854 See linkgit:git-log[1]. 855 856log.showroot:: 857 If true, the initial commit will be shown as a big creation event. 858 This is equivalent to a diff against an empty tree. 859 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which 860 normally hide the root commit will now show it. True by default. 861 862man.viewer:: 863 Specify the programs that may be used to display help in the 864 'man' format. See linkgit:git-help[1]. 865 866include::merge-config.txt[] 867 868man.<tool>.cmd:: 869 Specify the command to invoke the specified man viewer. The 870 specified command is evaluated in shell with the man page 871 passed as argument. (See linkgit:git-help[1].) 872 873man.<tool>.path:: 874 Override the path for the given tool that may be used to 875 display help in the 'man' format. See linkgit:git-help[1]. 876 877mergetool.<tool>.path:: 878 Override the path for the given tool. This is useful in case 879 your tool is not in the PATH. 880 881mergetool.<tool>.cmd:: 882 Specify the command to invoke the specified merge tool. The 883 specified command is evaluated in shell with the following 884 variables available: 'BASE' is the name of a temporary file 885 containing the common base of the files to be merged, if available; 886 'LOCAL' is the name of a temporary file containing the contents of 887 the file on the current branch; 'REMOTE' is the name of a temporary 888 file containing the contents of the file from the branch being 889 merged; 'MERGED' contains the name of the file to which the merge 890 tool should write the results of a successful merge. 891 892mergetool.<tool>.trustExitCode:: 893 For a custom merge command, specify whether the exit code of 894 the merge command can be used to determine whether the merge was 895 successful. If this is not set to true then the merge target file 896 timestamp is checked and the merge assumed to have been successful 897 if the file has been updated, otherwise the user is prompted to 898 indicate the success of the merge. 899 900mergetool.keepBackup:: 901 After performing a merge, the original file with conflict markers 902 can be saved as a file with a `.orig` extension. If this variable 903 is set to `false` then this file is not preserved. Defaults to 904 `true` (i.e. keep the backup files). 905 906pack.window:: 907 The size of the window used by linkgit:git-pack-objects[1] when no 908 window size is given on the command line. Defaults to 10. 909 910pack.depth:: 911 The maximum delta depth used by linkgit:git-pack-objects[1] when no 912 maximum depth is given on the command line. Defaults to 50. 913 914pack.windowMemory:: 915 The window memory size limit used by linkgit:git-pack-objects[1] 916 when no limit is given on the command line. The value can be 917 suffixed with "k", "m", or "g". Defaults to 0, meaning no 918 limit. 919 920pack.compression:: 921 An integer -1..9, indicating the compression level for objects 922 in a pack file. -1 is the zlib default. 0 means no 923 compression, and 1..9 are various speed/size tradeoffs, 9 being 924 slowest. If not set, defaults to core.compression. If that is 925 not set, defaults to -1, the zlib default, which is "a default 926 compromise between speed and compression (currently equivalent 927 to level 6)." 928 929pack.deltaCacheSize:: 930 The maximum memory in bytes used for caching deltas in 931 linkgit:git-pack-objects[1]. 932 A value of 0 means no limit. Defaults to 0. 933 934pack.deltaCacheLimit:: 935 The maximum size of a delta, that is cached in 936 linkgit:git-pack-objects[1]. Defaults to 1000. 937 938pack.threads:: 939 Specifies the number of threads to spawn when searching for best 940 delta matches. This requires that linkgit:git-pack-objects[1] 941 be compiled with pthreads otherwise this option is ignored with a 942 warning. This is meant to reduce packing time on multiprocessor 943 machines. The required amount of memory for the delta search window 944 is however multiplied by the number of threads. 945 Specifying 0 will cause git to auto-detect the number of CPU's 946 and set the number of threads accordingly. 947 948pack.indexVersion:: 949 Specify the default pack index version. Valid values are 1 for 950 legacy pack index used by Git versions prior to 1.5.2, and 2 for 951 the new pack index with capabilities for packs larger than 4 GB 952 as well as proper protection against the repacking of corrupted 953 packs. Version 2 is the default. Note that version 2 is enforced 954 and this config option ignored whenever the corresponding pack is 955 larger than 2 GB. 956+ 957If you have an old git that does not understand the version 2 `{asterisk}.idx` file, 958cloning or fetching over a non native protocol (e.g. "http" and "rsync") 959that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the 960other side may give you a repository that cannot be accessed with your 961older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however, 962you can use linkgit:git-index-pack[1] on the *.pack file to regenerate 963the `{asterisk}.idx` file. 964 965pack.packSizeLimit:: 966 The default maximum size of a pack. This setting only affects 967 packing to a file, i.e. the git:// protocol is unaffected. It 968 can be overridden by the `\--max-pack-size` option of 969 linkgit:git-repack[1]. 970 971pull.octopus:: 972 The default merge strategy to use when pulling multiple branches 973 at once. 974 975pull.twohead:: 976 The default merge strategy to use when pulling a single branch. 977 978remote.<name>.url:: 979 The URL of a remote repository. See linkgit:git-fetch[1] or 980 linkgit:git-push[1]. 981 982remote.<name>.proxy:: 983 For remotes that require curl (http, https and ftp), the URL to 984 the proxy to use for that remote. Set to the empty string to 985 disable proxying for that remote. 986 987remote.<name>.fetch:: 988 The default set of "refspec" for linkgit:git-fetch[1]. See 989 linkgit:git-fetch[1]. 990 991remote.<name>.push:: 992 The default set of "refspec" for linkgit:git-push[1]. See 993 linkgit:git-push[1]. 994 995remote.<name>.mirror:: 996 If true, pushing to this remote will automatically behave 997 as if the `\--mirror` option was given on the command line. 998 999remote.<name>.skipDefaultUpdate::1000 If true, this remote will be skipped by default when updating1001 using the update subcommand of linkgit:git-remote[1].10021003remote.<name>.receivepack::1004 The default program to execute on the remote side when pushing. See1005 option \--receive-pack of linkgit:git-push[1].10061007remote.<name>.uploadpack::1008 The default program to execute on the remote side when fetching. See1009 option \--upload-pack of linkgit:git-fetch-pack[1].10101011remote.<name>.tagopt::1012 Setting this value to \--no-tags disables automatic tag following when1013 fetching from remote <name>10141015remotes.<group>::1016 The list of remotes which are fetched by "git remote update1017 <group>". See linkgit:git-remote[1].10181019repack.usedeltabaseoffset::1020 By default, linkgit:git-repack[1] creates packs that use1021 delta-base offset. If you need to share your repository with1022 git older than version 1.4.4, either directly or via a dumb1023 protocol such as http, then you need to set this option to1024 "false" and repack. Access from old git versions over the1025 native protocol are unaffected by this option.10261027showbranch.default::1028 The default set of branches for linkgit:git-show-branch[1].1029 See linkgit:git-show-branch[1].10301031status.relativePaths::1032 By default, linkgit:git-status[1] shows paths relative to the1033 current directory. Setting this variable to `false` shows paths1034 relative to the repository root (this was the default for git1035 prior to v1.5.4).10361037status.showUntrackedFiles::1038 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1039 files which are not currently tracked by Git. Directories which1040 contain only untracked files, are shown with the directory name1041 only. Showing untracked files means that Git needs to lstat() all1042 all the files in the whole repository, which might be slow on some1043 systems. So, this variable controls how the commands displays1044 the untracked files. Possible values are:1045+1046--1047 - 'no' - Show no untracked files1048 - 'normal' - Shows untracked files and directories1049 - 'all' - Shows also individual files in untracked directories.1050--1051+1052If this variable is not specified, it defaults to 'normal'.1053This variable can be overridden with the -u|--untracked-files option1054of linkgit:git-status[1] and linkgit:git-commit[1].10551056tar.umask::1057 This variable can be used to restrict the permission bits of1058 tar archive entries. The default is 0002, which turns off the1059 world write bit. The special value "user" indicates that the1060 archiving user's umask will be used instead. See umask(2) and1061 linkgit:git-archive[1].10621063url.<base>.insteadOf::1064 Any URL that starts with this value will be rewritten to1065 start, instead, with <base>. In cases where some site serves a1066 large number of repositories, and serves them with multiple1067 access methods, and some users need to use different access1068 methods, this feature allows people to specify any of the1069 equivalent URLs and have git automatically rewrite the URL to1070 the best alternative for the particular user, even for a1071 never-before-seen repository on the site. When more than one1072 insteadOf strings match a given URL, the longest match is used.10731074user.email::1075 Your email address to be recorded in any newly created commits.1076 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1077 'EMAIL' environment variables. See linkgit:git-commit-tree[1].10781079user.name::1080 Your full name to be recorded in any newly created commits.1081 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1082 environment variables. See linkgit:git-commit-tree[1].10831084user.signingkey::1085 If linkgit:git-tag[1] is not selecting the key you want it to1086 automatically when creating a signed tag, you can override the1087 default selection with this variable. This option is passed1088 unchanged to gpg's --local-user parameter, so you may specify a key1089 using any method that gpg supports.10901091imap::1092 The configuration variables in the 'imap' section are described1093 in linkgit:git-imap-send[1].10941095receive.fsckObjects::1096 If it is set to true, git-receive-pack will check all received1097 objects. It will abort in the case of a malformed object or a1098 broken link. The result of an abort are only dangling objects.1099 Defaults to false.11001101receive.unpackLimit::1102 If the number of objects received in a push is below this1103 limit then the objects will be unpacked into loose object1104 files. However if the number of received objects equals or1105 exceeds this limit then the received pack will be stored as1106 a pack, after adding any missing delta bases. Storing the1107 pack from a push can make the push operation complete faster,1108 especially on slow filesystems. If not set, the value of1109 `transfer.unpackLimit` is used instead.11101111receive.denyNonFastForwards::1112 If set to true, git-receive-pack will deny a ref update which is1113 not a fast forward. Use this to prevent such an update via a push,1114 even if that push is forced. This configuration variable is1115 set when initializing a shared repository.11161117transfer.unpackLimit::1118 When `fetch.unpackLimit` or `receive.unpackLimit` are1119 not set, the value of this variable is used instead.1120 The default value is 100.11211122web.browser::1123 Specify a web browser that may be used by some commands.1124 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1125 may use it.