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