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