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