1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of 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 a section 30header before the 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 the example below: 35 36-------- 37 [section "subsection"] 38 39-------- 40 41Subsection names are case sensitive and can contain any characters except 42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 43respectively). Section headers 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 a case insensitive alternative `[section.subsection]` syntax. 49In this syntax, subsection names follow the same restrictions as for section 50names. 51 52All the other lines (and the remainder of the line after the section 53header) are recognized as setting variables, in the form 54'name = value'. If there is no equal sign on the line, the entire line 55is taken as 'name' and the variable is recognized as boolean "true". 56The variable names are case-insensitive and only alphanumeric 57characters and `-` are allowed. There can be more than one value 58for a given variable; we say then that variable is multivalued. 59 60Leading and trailing whitespace in a variable value is discarded. 61Internal whitespace within a variable value is retained verbatim. 62 63The values following the equals sign in variable assign are all either 64a string, an integer, or a boolean. Boolean values may be given as yes/no, 650/1, true/false or on/off. Case is not significant in boolean values, when 66converting value to the canonical form using '--bool' type specifier; 67'git config' will ensure that the output is "true" or "false". 68 69String values may be entirely or partially enclosed in double quotes. 70You need to enclose variable values in double quotes if you want to 71preserve leading or trailing whitespace, or if the variable value contains 72comment characters (i.e. it contains '#' or ';'). 73Double quote `"` and backslash `\` characters in variable values must 74be escaped: use `\"` for `"` and `\\` for `\`. 75 76The following escape sequences (beside `\"` and `\\`) are recognized: 77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 78and `\b` for backspace (BS). No other char escape sequence, nor octal 79char sequences are valid. 80 81Variable values ending in a `\` are continued on the next line in the 82customary UNIX fashion. 83 84Some variables may require a special value format. 85 86Example 87~~~~~~~ 88 89 # Core variables 90 [core] 91 ; Don't trust file modes 92 filemode = false 93 94 # Our diff algorithm 95 [diff] 96 external = /usr/local/bin/diff-wrapper 97 renames = true 98 99 [branch "devel"] 100 remote = origin 101 merge = refs/heads/devel 102 103 # Proxy settings 104 [core] 105 gitProxy="ssh" for "kernel.org" 106 gitProxy=default-proxy ; for the rest 107 108Variables 109~~~~~~~~~ 110 111Note that this list is non-comprehensive and not necessarily complete. 112For command-specific variables, you will find a more detailed description 113in the appropriate manual page. You will find a description of non-core 114porcelain configuration variables in the respective porcelain documentation. 115 116advice.*:: 117 When set to 'true', display the given optional help message. 118 When set to 'false', do not display. The configuration variables 119 are: 120+ 121-- 122 pushNonFastForward:: 123 Advice shown when linkgit:git-push[1] refuses 124 non-fast-forward refs. Default: true. 125 statusHints:: 126 Directions on how to stage/unstage/add shown in the 127 output of linkgit:git-status[1] and the template shown 128 when writing commit messages. Default: true. 129 commitBeforeMerge:: 130 Advice shown when linkgit:git-merge[1] refuses to 131 merge to avoid overwritting local changes. 132 Default: true. 133 resolveConflict:: 134 Advices shown by various commands when conflicts 135 prevent the operation from being performed. 136 Default: true. 137 implicitIdentity:: 138 Advice on how to set your identity configuration when 139 your information is guessed from the system username and 140 domain name. Default: true. 141-- 142 143core.fileMode:: 144 If false, the executable bit differences between the index and 145 the working copy are ignored; useful on broken filesystems like FAT. 146 See linkgit:git-update-index[1]. 147+ 148The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 149will probe and set core.fileMode false if appropriate when the 150repository is created. 151 152core.ignoreCygwinFSTricks:: 153 This option is only used by Cygwin implementation of Git. If false, 154 the Cygwin stat() and lstat() functions are used. This may be useful 155 if your repository consists of a few separate directories joined in 156 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 157 whenever it is possible and falls back to Cygwin functions only to 158 handle symbol links. The native mode is more than twice faster than 159 normal Cygwin l/stat() functions. True by default, unless core.filemode 160 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 161 POSIX emulation is required to support core.filemode. 162 163core.ignorecase:: 164 If true, this option enables various workarounds to enable 165 git to work better on filesystems that are not case sensitive, 166 like FAT. For example, if a directory listing finds 167 "makefile" when git expects "Makefile", git will assume 168 it is really the same file, and continue to remember it as 169 "Makefile". 170+ 171The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 172will probe and set core.ignorecase true if appropriate when the repository 173is created. 174 175core.trustctime:: 176 If false, the ctime differences between the index and the 177 working copy are ignored; useful when the inode change time 178 is regularly modified by something outside Git (file system 179 crawlers and some backup systems). 180 See linkgit:git-update-index[1]. True by default. 181 182core.quotepath:: 183 The commands that output paths (e.g. 'ls-files', 184 'diff'), when not given the `-z` option, will quote 185 "unusual" characters in the pathname by enclosing the 186 pathname in a double-quote pair and with backslashes the 187 same way strings in C source code are quoted. If this 188 variable is set to false, the bytes higher than 0x80 are 189 not quoted but output as verbatim. Note that double 190 quote, backslash and control characters are always 191 quoted without `-z` regardless of the setting of this 192 variable. 193 194core.autocrlf:: 195 If true, makes git convert `CRLF` at the end of lines in text files to 196 `LF` when reading from the filesystem, and convert in reverse when 197 writing to the filesystem. The variable can be set to 198 'input', in which case the conversion happens only while 199 reading from the filesystem but files are written out with 200 `LF` at the end of lines. A file is considered 201 "text" (i.e. be subjected to the autocrlf mechanism) based on 202 the file's `crlf` attribute, or if `crlf` is unspecified, 203 based on the file's contents. See linkgit:gitattributes[5]. 204 205core.safecrlf:: 206 If true, makes git check if converting `CRLF` as controlled by 207 `core.autocrlf` is reversible. Git will verify if a command 208 modifies a file in the work tree either directly or indirectly. 209 For example, committing a file followed by checking out the 210 same file should yield the original file in the work tree. If 211 this is not the case for the current setting of 212 `core.autocrlf`, git will reject the file. The variable can 213 be set to "warn", in which case git will only warn about an 214 irreversible conversion but continue the operation. 215+ 216CRLF conversion bears a slight chance of corrupting data. 217autocrlf=true will convert CRLF to LF during commit and LF to 218CRLF during checkout. A file that contains a mixture of LF and 219CRLF before the commit cannot be recreated by git. For text 220files this is the right thing to do: it corrects line endings 221such that we have only LF line endings in the repository. 222But for binary files that are accidentally classified as text the 223conversion can corrupt data. 224+ 225If you recognize such corruption early you can easily fix it by 226setting the conversion type explicitly in .gitattributes. Right 227after committing you still have the original file in your work 228tree and this file is not yet corrupted. You can explicitly tell 229git that this file is binary and git will handle the file 230appropriately. 231+ 232Unfortunately, the desired effect of cleaning up text files with 233mixed line endings and the undesired effect of corrupting binary 234files cannot be distinguished. In both cases CRLFs are removed 235in an irreversible way. For text files this is the right thing 236to do because CRLFs are line endings, while for binary files 237converting CRLFs corrupts data. 238+ 239Note, this safety check does not mean that a checkout will generate a 240file identical to the original file for a different setting of 241`core.autocrlf`, but only for the current one. For example, a text 242file with `LF` would be accepted with `core.autocrlf=input` and could 243later be checked out with `core.autocrlf=true`, in which case the 244resulting file would contain `CRLF`, although the original file 245contained `LF`. However, in both work trees the line endings would be 246consistent, that is either all `LF` or all `CRLF`, but never mixed. A 247file with mixed line endings would be reported by the `core.safecrlf` 248mechanism. 249 250core.symlinks:: 251 If false, symbolic links are checked out as small plain files that 252 contain the link text. linkgit:git-update-index[1] and 253 linkgit:git-add[1] will not change the recorded type to regular 254 file. Useful on filesystems like FAT that do not support 255 symbolic links. 256+ 257The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 258will probe and set core.symlinks false if appropriate when the repository 259is created. 260 261core.gitProxy:: 262 A "proxy command" to execute (as 'command host port') instead 263 of establishing direct connection to the remote server when 264 using the git protocol for fetching. If the variable value is 265 in the "COMMAND for DOMAIN" format, the command is applied only 266 on hostnames ending with the specified domain string. This variable 267 may be set multiple times and is matched in the given order; 268 the first match wins. 269+ 270Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 271(which always applies universally, without the special "for" 272handling). 273+ 274The special string `none` can be used as the proxy command to 275specify that no proxy be used for a given domain pattern. 276This is useful for excluding servers inside a firewall from 277proxy use, while defaulting to a common proxy for external domains. 278 279core.ignoreStat:: 280 If true, commands which modify both the working tree and the index 281 will mark the updated paths with the "assume unchanged" bit in the 282 index. These marked files are then assumed to stay unchanged in the 283 working copy, until you mark them otherwise manually - Git will not 284 detect the file changes by lstat() calls. This is useful on systems 285 where those are very slow, such as Microsoft Windows. 286 See linkgit:git-update-index[1]. 287 False by default. 288 289core.preferSymlinkRefs:: 290 Instead of the default "symref" format for HEAD 291 and other symbolic reference files, use symbolic links. 292 This is sometimes needed to work with old scripts that 293 expect HEAD to be a symbolic link. 294 295core.bare:: 296 If true this repository is assumed to be 'bare' and has no 297 working directory associated with it. If this is the case a 298 number of commands that require a working directory will be 299 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 300+ 301This setting is automatically guessed by linkgit:git-clone[1] or 302linkgit:git-init[1] when the repository was created. By default a 303repository that ends in "/.git" is assumed to be not bare (bare = 304false), while all other repositories are assumed to be bare (bare 305= true). 306 307core.worktree:: 308 Set the path to the root of the work tree. 309 This can be overridden by the GIT_WORK_TREE environment 310 variable and the '--work-tree' command line option. It can be 311 an absolute path or a relative path to the .git directory, 312 either specified by --git-dir or GIT_DIR, or automatically 313 discovered. 314 If --git-dir or GIT_DIR are specified but none of 315 --work-tree, GIT_WORK_TREE and core.worktree is specified, 316 the current working directory is regarded as the root of the 317 work tree. 318+ 319Note that this variable is honored even when set in a configuration 320file in a ".git" subdirectory of a directory, and its value differs 321from the latter directory (e.g. "/path/to/.git/config" has 322core.worktree set to "/different/path"), which is most likely a 323misconfiguration. Running git commands in "/path/to" directory will 324still use "/different/path" as the root of the work tree and can cause 325great confusion to the users. 326 327core.logAllRefUpdates:: 328 Enable the reflog. Updates to a ref <ref> is logged to the file 329 "$GIT_DIR/logs/<ref>", by appending the new and old 330 SHA1, the date/time and the reason of the update, but 331 only when the file exists. If this configuration 332 variable is set to true, missing "$GIT_DIR/logs/<ref>" 333 file is automatically created for branch heads. 334+ 335This information can be used to determine what commit 336was the tip of a branch "2 days ago". 337+ 338This value is true by default in a repository that has 339a working directory associated with it, and false by 340default in a bare repository. 341 342core.repositoryFormatVersion:: 343 Internal variable identifying the repository format and layout 344 version. 345 346core.sharedRepository:: 347 When 'group' (or 'true'), the repository is made shareable between 348 several users in a group (making sure all the files and objects are 349 group-writable). When 'all' (or 'world' or 'everybody'), the 350 repository will be readable by all users, additionally to being 351 group-shareable. When 'umask' (or 'false'), git will use permissions 352 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 353 files in the repository will have this mode value. '0xxx' will override 354 user's umask value (whereas the other options will only override 355 requested parts of the user's umask value). Examples: '0660' will make 356 the repo read/write-able for the owner and group, but inaccessible to 357 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 358 repository that is group-readable but not group-writable. 359 See linkgit:git-init[1]. False by default. 360 361core.warnAmbiguousRefs:: 362 If true, git will warn you if the ref name you passed it is ambiguous 363 and might match multiple refs in the .git/refs/ tree. True by default. 364 365core.compression:: 366 An integer -1..9, indicating a default compression level. 367 -1 is the zlib default. 0 means no compression, 368 and 1..9 are various speed/size tradeoffs, 9 being slowest. 369 If set, this provides a default to other compression variables, 370 such as 'core.loosecompression' and 'pack.compression'. 371 372core.loosecompression:: 373 An integer -1..9, indicating the compression level for objects that 374 are not in a pack file. -1 is the zlib default. 0 means no 375 compression, and 1..9 are various speed/size tradeoffs, 9 being 376 slowest. If not set, defaults to core.compression. If that is 377 not set, defaults to 1 (best speed). 378 379core.packedGitWindowSize:: 380 Number of bytes of a pack file to map into memory in a 381 single mapping operation. Larger window sizes may allow 382 your system to process a smaller number of large pack files 383 more quickly. Smaller window sizes will negatively affect 384 performance due to increased calls to the operating system's 385 memory manager, but may improve performance when accessing 386 a large number of large pack files. 387+ 388Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 389MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 390be reasonable for all users/operating systems. You probably do 391not need to adjust this value. 392+ 393Common unit suffixes of 'k', 'm', or 'g' are supported. 394 395core.packedGitLimit:: 396 Maximum number of bytes to map simultaneously into memory 397 from pack files. If Git needs to access more than this many 398 bytes at once to complete an operation it will unmap existing 399 regions to reclaim virtual address space within the process. 400+ 401Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 402This should be reasonable for all users/operating systems, except on 403the largest projects. You probably do not need to adjust this value. 404+ 405Common unit suffixes of 'k', 'm', or 'g' are supported. 406 407core.deltaBaseCacheLimit:: 408 Maximum number of bytes to reserve for caching base objects 409 that multiple deltafied objects reference. By storing the 410 entire decompressed base objects in a cache Git is able 411 to avoid unpacking and decompressing frequently used base 412 objects multiple times. 413+ 414Default is 16 MiB on all platforms. This should be reasonable 415for all users/operating systems, except on the largest projects. 416You probably do not need to adjust this value. 417+ 418Common unit suffixes of 'k', 'm', or 'g' are supported. 419 420core.excludesfile:: 421 In addition to '.gitignore' (per-directory) and 422 '.git/info/exclude', git looks into this file for patterns 423 of files which are not meant to be tracked. "{tilde}/" is expanded 424 to the value of `$HOME` and "{tilde}user/" to the specified user's 425 home directory. See linkgit:gitignore[5]. 426 427core.editor:: 428 Commands such as `commit` and `tag` that lets you edit 429 messages by launching an editor uses the value of this 430 variable when it is set, and the environment variable 431 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 432 433core.pager:: 434 The command that git will use to paginate output. Can 435 be overridden with the `GIT_PAGER` environment 436 variable. Note that git sets the `LESS` environment 437 variable to `FRSX` if it is unset when it runs the 438 pager. One can change these settings by setting the 439 `LESS` variable to some other value. Alternately, 440 these settings can be overridden on a project or 441 global basis by setting the `core.pager` option. 442 Setting `core.pager` has no affect on the `LESS` 443 environment variable behaviour above, so if you want 444 to override git's default settings this way, you need 445 to be explicit. For example, to disable the S option 446 in a backward compatible manner, set `core.pager` 447 to `less -+$LESS -FRX`. This will be passed to the 448 shell by git, which will translate the final command to 449 `LESS=FRSX less -+FRSX -FRX`. 450 451core.whitespace:: 452 A comma separated list of common whitespace problems to 453 notice. 'git diff' will use `color.diff.whitespace` to 454 highlight them, and 'git apply --whitespace=error' will 455 consider them as errors. You can prefix `-` to disable 456 any of them (e.g. `-trailing-space`): 457+ 458* `blank-at-eol` treats trailing whitespaces at the end of the line 459 as an error (enabled by default). 460* `space-before-tab` treats a space character that appears immediately 461 before a tab character in the initial indent part of the line as an 462 error (enabled by default). 463* `indent-with-non-tab` treats a line that is indented with 8 or more 464 space characters as an error (not enabled by default). 465* `blank-at-eof` treats blank lines added at the end of file as an error 466 (enabled by default). 467* `trailing-space` is a short-hand to cover both `blank-at-eol` and 468 `blank-at-eof`. 469* `cr-at-eol` treats a carriage-return at the end of line as 470 part of the line terminator, i.e. with it, `trailing-space` 471 does not trigger if the character before such a carriage-return 472 is not a whitespace (not enabled by default). 473 474core.fsyncobjectfiles:: 475 This boolean will enable 'fsync()' when writing object files. 476+ 477This is a total waste of time and effort on a filesystem that orders 478data writes properly, but can be useful for filesystems that do not use 479journalling (traditional UNIX filesystems) or that only journal metadata 480and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 481 482core.preloadindex:: 483 Enable parallel index preload for operations like 'git diff' 484+ 485This can speed up operations like 'git diff' and 'git status' especially 486on filesystems like NFS that have weak caching semantics and thus 487relatively high IO latencies. With this set to 'true', git will do the 488index comparison to the filesystem data in parallel, allowing 489overlapping IO's. 490 491core.createObject:: 492 You can set this to 'link', in which case a hardlink followed by 493 a delete of the source are used to make sure that object creation 494 will not overwrite existing objects. 495+ 496On some file system/operating system combinations, this is unreliable. 497Set this config setting to 'rename' there; However, This will remove the 498check that makes sure that existing object files will not get overwritten. 499 500core.notesRef:: 501 When showing commit messages, also show notes which are stored in 502 the given ref. This ref is expected to contain files named 503 after the full SHA-1 of the commit they annotate. The ref 504 must be fully qualified. 505+ 506If such a file exists in the given ref, the referenced blob is read, and 507appended to the commit message, separated by a "Notes (<refname>):" 508line (shortened to "Notes:" in the case of "refs/notes/commits"). If the 509given ref itself does not exist, it is not an error, but means that no 510notes should be printed. 511+ 512This setting defaults to "refs/notes/commits", and can be overridden by 513the `GIT_NOTES_REF` environment variable. 514 515core.sparseCheckout:: 516 Enable "sparse checkout" feature. See section "Sparse checkout" in 517 linkgit:git-read-tree[1] for more information. 518 519add.ignore-errors:: 520 Tells 'git add' to continue adding files when some files cannot be 521 added due to indexing errors. Equivalent to the '--ignore-errors' 522 option of linkgit:git-add[1]. 523 524alias.*:: 525 Command aliases for the linkgit:git[1] command wrapper - e.g. 526 after defining "alias.last = cat-file commit HEAD", the invocation 527 "git last" is equivalent to "git cat-file commit HEAD". To avoid 528 confusion and troubles with script usage, aliases that 529 hide existing git commands are ignored. Arguments are split by 530 spaces, the usual shell quoting and escaping is supported. 531 quote pair and a backslash can be used to quote them. 532+ 533If the alias expansion is prefixed with an exclamation point, 534it will be treated as a shell command. For example, defining 535"alias.new = !gitk --all --not ORIG_HEAD", the invocation 536"git new" is equivalent to running the shell command 537"gitk --all --not ORIG_HEAD". Note that shell commands will be 538executed from the top-level directory of a repository, which may 539not necessarily be the current directory. 540 541apply.ignorewhitespace:: 542 When set to 'change', tells 'git apply' to ignore changes in 543 whitespace, in the same way as the '--ignore-space-change' 544 option. 545 When set to one of: no, none, never, false tells 'git apply' to 546 respect all whitespace differences. 547 See linkgit:git-apply[1]. 548 549apply.whitespace:: 550 Tells 'git apply' how to handle whitespaces, in the same way 551 as the '--whitespace' option. See linkgit:git-apply[1]. 552 553branch.autosetupmerge:: 554 Tells 'git branch' and 'git checkout' to set up new branches 555 so that linkgit:git-pull[1] will appropriately merge from the 556 starting point branch. Note that even if this option is not set, 557 this behavior can be chosen per-branch using the `--track` 558 and `--no-track` options. The valid settings are: `false` -- no 559 automatic setup is done; `true` -- automatic setup is done when the 560 starting point is a remote branch; `always` -- automatic setup is 561 done when the starting point is either a local branch or remote 562 branch. This option defaults to true. 563 564branch.autosetuprebase:: 565 When a new branch is created with 'git branch' or 'git checkout' 566 that tracks another branch, this variable tells git to set 567 up pull to rebase instead of merge (see "branch.<name>.rebase"). 568 When `never`, rebase is never automatically set to true. 569 When `local`, rebase is set to true for tracked branches of 570 other local branches. 571 When `remote`, rebase is set to true for tracked branches of 572 remote branches. 573 When `always`, rebase will be set to true for all tracking 574 branches. 575 See "branch.autosetupmerge" for details on how to set up a 576 branch to track another branch. 577 This option defaults to never. 578 579branch.<name>.remote:: 580 When in branch <name>, it tells 'git fetch' and 'git push' which 581 remote to fetch from/push to. It defaults to `origin` if no remote is 582 configured. `origin` is also used if you are not on any branch. 583 584branch.<name>.merge:: 585 Defines, together with branch.<name>.remote, the upstream branch 586 for the given branch. It tells 'git fetch'/'git pull' which 587 branch to merge and can also affect 'git push' (see push.default). 588 When in branch <name>, it tells 'git fetch' the default 589 refspec to be marked for merging in FETCH_HEAD. The value is 590 handled like the remote part of a refspec, and must match a 591 ref which is fetched from the remote given by 592 "branch.<name>.remote". 593 The merge information is used by 'git pull' (which at first calls 594 'git fetch') to lookup the default branch for merging. Without 595 this option, 'git pull' defaults to merge the first refspec fetched. 596 Specify multiple values to get an octopus merge. 597 If you wish to setup 'git pull' so that it merges into <name> from 598 another branch in the local repository, you can point 599 branch.<name>.merge to the desired branch, and use the special setting 600 `.` (a period) for branch.<name>.remote. 601 602branch.<name>.mergeoptions:: 603 Sets default options for merging into branch <name>. The syntax and 604 supported options are the same as those of linkgit:git-merge[1], but 605 option values containing whitespace characters are currently not 606 supported. 607 608branch.<name>.rebase:: 609 When true, rebase the branch <name> on top of the fetched branch, 610 instead of merging the default branch from the default remote when 611 "git pull" is run. 612 *NOTE*: this is a possibly dangerous operation; do *not* use 613 it unless you understand the implications (see linkgit:git-rebase[1] 614 for details). 615 616browser.<tool>.cmd:: 617 Specify the command to invoke the specified browser. The 618 specified command is evaluated in shell with the URLs passed 619 as arguments. (See linkgit:git-web--browse[1].) 620 621browser.<tool>.path:: 622 Override the path for the given tool that may be used to 623 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 624 working repository in gitweb (see linkgit:git-instaweb[1]). 625 626clean.requireForce:: 627 A boolean to make git-clean do nothing unless given -f 628 or -n. Defaults to true. 629 630color.branch:: 631 A boolean to enable/disable color in the output of 632 linkgit:git-branch[1]. May be set to `always`, 633 `false` (or `never`) or `auto` (or `true`), in which case colors are used 634 only when the output is to a terminal. Defaults to false. 635 636color.branch.<slot>:: 637 Use customized color for branch coloration. `<slot>` is one of 638 `current` (the current branch), `local` (a local branch), 639 `remote` (a tracking branch in refs/remotes/), `plain` (other 640 refs). 641+ 642The value for these configuration variables is a list of colors (at most 643two) and attributes (at most one), separated by spaces. The colors 644accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 645`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 646`blink` and `reverse`. The first color given is the foreground; the 647second is the background. The position of the attribute, if any, 648doesn't matter. 649 650color.diff:: 651 When set to `always`, always use colors in patch. 652 When false (or `never`), never. When set to `true` or `auto`, use 653 colors only when the output is to the terminal. Defaults to false. 654 655color.diff.<slot>:: 656 Use customized color for diff colorization. `<slot>` specifies 657 which part of the patch to use the specified color, and is one 658 of `plain` (context text), `meta` (metainformation), `frag` 659 (hunk header), 'func' (function in hunk header), `old` (removed lines), 660 `new` (added lines), `commit` (commit headers), or `whitespace` 661 (highlighting whitespace errors). The values of these variables may be 662 specified as in color.branch.<slot>. 663 664color.grep:: 665 When set to `always`, always highlight matches. When `false` (or 666 `never`), never. When set to `true` or `auto`, use color only 667 when the output is written to the terminal. Defaults to `false`. 668 669color.grep.match:: 670 Use customized color for matches. The value of this variable 671 may be specified as in color.branch.<slot>. It is passed using 672 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when 673 calling an external 'grep'. 674 675color.interactive:: 676 When set to `always`, always use colors for interactive prompts 677 and displays (such as those used by "git-add --interactive"). 678 When false (or `never`), never. When set to `true` or `auto`, use 679 colors only when the output is to the terminal. Defaults to false. 680 681color.interactive.<slot>:: 682 Use customized color for 'git add --interactive' 683 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for 684 four distinct types of normal output from interactive 685 commands. The values of these variables may be specified as 686 in color.branch.<slot>. 687 688color.pager:: 689 A boolean to enable/disable colored output when the pager is in 690 use (default is true). 691 692color.showbranch:: 693 A boolean to enable/disable color in the output of 694 linkgit:git-show-branch[1]. May be set to `always`, 695 `false` (or `never`) or `auto` (or `true`), in which case colors are used 696 only when the output is to a terminal. Defaults to false. 697 698color.status:: 699 A boolean to enable/disable color in the output of 700 linkgit:git-status[1]. May be set to `always`, 701 `false` (or `never`) or `auto` (or `true`), in which case colors are used 702 only when the output is to a terminal. Defaults to false. 703 704color.status.<slot>:: 705 Use customized color for status colorization. `<slot>` is 706 one of `header` (the header text of the status message), 707 `added` or `updated` (files which are added but not committed), 708 `changed` (files which are changed but not added in the index), 709 `untracked` (files which are not tracked by git), or 710 `nobranch` (the color the 'no branch' warning is shown in, defaulting 711 to red). The values of these variables may be specified as in 712 color.branch.<slot>. 713 714color.ui:: 715 When set to `always`, always use colors in all git commands which 716 are capable of colored output. When false (or `never`), never. When 717 set to `true` or `auto`, use colors only when the output is to the 718 terminal. When more specific variables of color.* are set, they always 719 take precedence over this setting. Defaults to false. 720 721commit.status 722 A boolean to enable/disable inclusion of status information in the 723 commit message template when using an editor to prepare the commit 724 message. Defaults to true. 725 726commit.template:: 727 Specify a file to use as the template for new commit messages. 728 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the 729 specified user's home directory. 730 731diff.autorefreshindex:: 732 When using 'git diff' to compare with work tree 733 files, do not consider stat-only change as changed. 734 Instead, silently run `git update-index --refresh` to 735 update the cached stat information for paths whose 736 contents in the work tree match the contents in the 737 index. This option defaults to true. Note that this 738 affects only 'git diff' Porcelain, and not lower level 739 'diff' commands such as 'git diff-files'. 740 741diff.external:: 742 If this config variable is set, diff generation is not 743 performed using the internal diff machinery, but using the 744 given command. Can be overridden with the `GIT_EXTERNAL_DIFF' 745 environment variable. The command is called with parameters 746 as described under "git Diffs" in linkgit:git[1]. Note: if 747 you want to use an external diff program only on a subset of 748 your files, you might want to use linkgit:gitattributes[5] instead. 749 750diff.mnemonicprefix:: 751 If set, 'git diff' uses a prefix pair that is different from the 752 standard "a/" and "b/" depending on what is being compared. When 753 this configuration is in effect, reverse diff output also swaps 754 the order of the prefixes: 755`git diff`;; 756 compares the (i)ndex and the (w)ork tree; 757`git diff HEAD`;; 758 compares a (c)ommit and the (w)ork tree; 759`git diff --cached`;; 760 compares a (c)ommit and the (i)ndex; 761`git diff HEAD:file1 file2`;; 762 compares an (o)bject and a (w)ork tree entity; 763`git diff --no-index a b`;; 764 compares two non-git things (1) and (2). 765 766diff.renameLimit:: 767 The number of files to consider when performing the copy/rename 768 detection; equivalent to the 'git diff' option '-l'. 769 770diff.renames:: 771 Tells git to detect renames. If set to any boolean value, it 772 will enable basic rename detection. If set to "copies" or 773 "copy", it will detect copies, as well. 774 775diff.suppressBlankEmpty:: 776 A boolean to inhibit the standard behavior of printing a space 777 before each empty output line. Defaults to false. 778 779diff.tool:: 780 Controls which diff tool is used. `diff.tool` overrides 781 `merge.tool` when used by linkgit:git-difftool[1] and has 782 the same valid values as `merge.tool` minus "tortoisemerge" 783 and plus "kompare". 784 785difftool.<tool>.path:: 786 Override the path for the given tool. This is useful in case 787 your tool is not in the PATH. 788 789difftool.<tool>.cmd:: 790 Specify the command to invoke the specified diff tool. 791 The specified command is evaluated in shell with the following 792 variables available: 'LOCAL' is set to the name of the temporary 793 file containing the contents of the diff pre-image and 'REMOTE' 794 is set to the name of the temporary file containing the contents 795 of the diff post-image. 796 797difftool.prompt:: 798 Prompt before each invocation of the diff tool. 799 800diff.wordRegex:: 801 A POSIX Extended Regular Expression used to determine what is a "word" 802 when performing word-by-word difference calculations. Character 803 sequences that match the regular expression are "words", all other 804 characters are *ignorable* whitespace. 805 806fetch.unpackLimit:: 807 If the number of objects fetched over the git native 808 transfer is below this 809 limit, then the objects will be unpacked into loose object 810 files. However if the number of received objects equals or 811 exceeds this limit then the received pack will be stored as 812 a pack, after adding any missing delta bases. Storing the 813 pack from a push can make the push operation complete faster, 814 especially on slow filesystems. If not set, the value of 815 `transfer.unpackLimit` is used instead. 816 817format.attach:: 818 Enable multipart/mixed attachments as the default for 819 'format-patch'. The value can also be a double quoted string 820 which will enable attachments as the default and set the 821 value as the boundary. See the --attach option in 822 linkgit:git-format-patch[1]. 823 824format.numbered:: 825 A boolean which can enable or disable sequence numbers in patch 826 subjects. It defaults to "auto" which enables it only if there 827 is more than one patch. It can be enabled or disabled for all 828 messages by setting it to "true" or "false". See --numbered 829 option in linkgit:git-format-patch[1]. 830 831format.headers:: 832 Additional email headers to include in a patch to be submitted 833 by mail. See linkgit:git-format-patch[1]. 834 835format.cc:: 836 Additional "Cc:" headers to include in a patch to be submitted 837 by mail. See the --cc option in linkgit:git-format-patch[1]. 838 839format.subjectprefix:: 840 The default for format-patch is to output files with the '[PATCH]' 841 subject prefix. Use this variable to change that prefix. 842 843format.suffix:: 844 The default for format-patch is to output files with the suffix 845 `.patch`. Use this variable to change that suffix (make sure to 846 include the dot if you want it). 847 848format.pretty:: 849 The default pretty format for log/show/whatchanged command, 850 See linkgit:git-log[1], linkgit:git-show[1], 851 linkgit:git-whatchanged[1]. 852 853format.thread:: 854 The default threading style for 'git format-patch'. Can be 855 a boolean value, or `shallow` or `deep`. `shallow` threading 856 makes every mail a reply to the head of the series, 857 where the head is chosen from the cover letter, the 858 `\--in-reply-to`, and the first patch mail, in this order. 859 `deep` threading makes every mail a reply to the previous one. 860 A true boolean value is the same as `shallow`, and a false 861 value disables threading. 862 863format.signoff:: 864 A boolean value which lets you enable the `-s/--signoff` option of 865 format-patch by default. *Note:* Adding the Signed-off-by: line to a 866 patch should be a conscious act and means that you certify you have 867 the rights to submit this work under the same open source license. 868 Please see the 'SubmittingPatches' document for further discussion. 869 870gc.aggressiveWindow:: 871 The window size parameter used in the delta compression 872 algorithm used by 'git gc --aggressive'. This defaults 873 to 10. 874 875gc.auto:: 876 When there are approximately more than this many loose 877 objects in the repository, `git gc --auto` will pack them. 878 Some Porcelain commands use this command to perform a 879 light-weight garbage collection from time to time. The 880 default value is 6700. Setting this to 0 disables it. 881 882gc.autopacklimit:: 883 When there are more than this many packs that are not 884 marked with `*.keep` file in the repository, `git gc 885 --auto` consolidates them into one larger pack. The 886 default value is 50. Setting this to 0 disables it. 887 888gc.packrefs:: 889 Running `git pack-refs` in a repository renders it 890 unclonable by Git versions prior to 1.5.1.2 over dumb 891 transports such as HTTP. This variable determines whether 892 'git gc' runs `git pack-refs`. This can be set to `nobare` 893 to enable it within all non-bare repos or it can be set to a 894 boolean value. The default is `true`. 895 896gc.pruneexpire:: 897 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 898 Override the grace period with this config variable. The value 899 "now" may be used to disable this grace period and always prune 900 unreachable objects immediately. 901 902gc.reflogexpire:: 903 'git reflog expire' removes reflog entries older than 904 this time; defaults to 90 days. 905 906gc.reflogexpireunreachable:: 907 'git reflog expire' removes reflog entries older than 908 this time and are not reachable from the current tip; 909 defaults to 30 days. 910 911gc.rerereresolved:: 912 Records of conflicted merge you resolved earlier are 913 kept for this many days when 'git rerere gc' is run. 914 The default is 60 days. See linkgit:git-rerere[1]. 915 916gc.rerereunresolved:: 917 Records of conflicted merge you have not resolved are 918 kept for this many days when 'git rerere gc' is run. 919 The default is 15 days. See linkgit:git-rerere[1]. 920 921gitcvs.commitmsgannotation:: 922 Append this string to each commit message. Set to empty string 923 to disable this feature. Defaults to "via git-CVS emulator". 924 925gitcvs.enabled:: 926 Whether the CVS server interface is enabled for this repository. 927 See linkgit:git-cvsserver[1]. 928 929gitcvs.logfile:: 930 Path to a log file where the CVS server interface well... logs 931 various stuff. See linkgit:git-cvsserver[1]. 932 933gitcvs.usecrlfattr:: 934 If true, the server will look up the `crlf` attribute for 935 files to determine the '-k' modes to use. If `crlf` is set, 936 the '-k' mode will be left blank, so cvs clients will 937 treat it as text. If `crlf` is explicitly unset, the file 938 will be set with '-kb' mode, which suppresses any newline munging 939 the client might otherwise do. If `crlf` is not specified, 940 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. 941 942gitcvs.allbinary:: 943 This is used if 'gitcvs.usecrlfattr' does not resolve 944 the correct '-kb' mode to use. If true, all 945 unresolved files are sent to the client in 946 mode '-kb'. This causes the client to treat them 947 as binary files, which suppresses any newline munging it 948 otherwise might do. Alternatively, if it is set to "guess", 949 then the contents of the file are examined to decide if 950 it is binary, similar to 'core.autocrlf'. 951 952gitcvs.dbname:: 953 Database used by git-cvsserver to cache revision information 954 derived from the git repository. The exact meaning depends on the 955 used database driver, for SQLite (which is the default driver) this 956 is a filename. Supports variable substitution (see 957 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). 958 Default: '%Ggitcvs.%m.sqlite' 959 960gitcvs.dbdriver:: 961 Used Perl DBI driver. You can specify any available driver 962 for this here, but it might not work. git-cvsserver is tested 963 with 'DBD::SQLite', reported to work with 'DBD::Pg', and 964 reported *not* to work with 'DBD::mysql'. Experimental feature. 965 May not contain double colons (`:`). Default: 'SQLite'. 966 See linkgit:git-cvsserver[1]. 967 968gitcvs.dbuser, gitcvs.dbpass:: 969 Database user and password. Only useful if setting 'gitcvs.dbdriver', 970 since SQLite has no concept of database users and/or passwords. 971 'gitcvs.dbuser' supports variable substitution (see 972 linkgit:git-cvsserver[1] for details). 973 974gitcvs.dbTableNamePrefix:: 975 Database table name prefix. Prepended to the names of any 976 database tables used, allowing a single database to be used 977 for several repositories. Supports variable substitution (see 978 linkgit:git-cvsserver[1] for details). Any non-alphabetic 979 characters will be replaced with underscores. 980 981All gitcvs variables except for 'gitcvs.usecrlfattr' and 982'gitcvs.allbinary' can also be specified as 983'gitcvs.<access_method>.<varname>' (where 'access_method' 984is one of "ext" and "pserver") to make them apply only for the given 985access method. 986 987gui.commitmsgwidth:: 988 Defines how wide the commit message window is in the 989 linkgit:git-gui[1]. "75" is the default. 990 991gui.diffcontext:: 992 Specifies how many context lines should be used in calls to diff 993 made by the linkgit:git-gui[1]. The default is "5". 994 995gui.encoding:: 996 Specifies the default encoding to use for displaying of 997 file contents in linkgit:git-gui[1] and linkgit:gitk[1]. 998 It can be overridden by setting the 'encoding' attribute 999 for relevant files (see linkgit:gitattributes[5]).1000 If this option is not set, the tools default to the1001 locale encoding.10021003gui.matchtrackingbranch::1004 Determines if new branches created with linkgit:git-gui[1] should1005 default to tracking remote branches with matching names or1006 not. Default: "false".10071008gui.newbranchtemplate::1009 Is used as suggested name when creating new branches using the1010 linkgit:git-gui[1].10111012gui.pruneduringfetch::1013 "true" if linkgit:git-gui[1] should prune tracking branches when1014 performing a fetch. The default value is "false".10151016gui.trustmtime::1017 Determines if linkgit:git-gui[1] should trust the file modification1018 timestamp or not. By default the timestamps are not trusted.10191020gui.spellingdictionary::1021 Specifies the dictionary used for spell checking commit messages in1022 the linkgit:git-gui[1]. When set to "none" spell checking is turned1023 off.10241025gui.fastcopyblame::1026 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1027 location detection. It makes blame significantly faster on huge1028 repositories at the expense of less thorough copy detection.10291030gui.copyblamethreshold::1031 Specifies the threshold to use in 'git gui blame' original location1032 detection, measured in alphanumeric characters. See the1033 linkgit:git-blame[1] manual for more information on copy detection.10341035gui.blamehistoryctx::1036 Specifies the radius of history context in days to show in1037 linkgit:gitk[1] for the selected commit, when the `Show History1038 Context` menu item is invoked from 'git gui blame'. If this1039 variable is set to zero, the whole history is shown.10401041guitool.<name>.cmd::1042 Specifies the shell command line to execute when the corresponding item1043 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1044 mandatory for every tool. The command is executed from the root of1045 the working directory, and in the environment it receives the name of1046 the tool as 'GIT_GUITOOL', the name of the currently selected file as1047 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1048 the head is detached, 'CUR_BRANCH' is empty).10491050guitool.<name>.needsfile::1051 Run the tool only if a diff is selected in the GUI. It guarantees1052 that 'FILENAME' is not empty.10531054guitool.<name>.noconsole::1055 Run the command silently, without creating a window to display its1056 output.10571058guitool.<name>.norescan::1059 Don't rescan the working directory for changes after the tool1060 finishes execution.10611062guitool.<name>.confirm::1063 Show a confirmation dialog before actually running the tool.10641065guitool.<name>.argprompt::1066 Request a string argument from the user, and pass it to the tool1067 through the 'ARGS' environment variable. Since requesting an1068 argument implies confirmation, the 'confirm' option has no effect1069 if this is enabled. If the option is set to 'true', 'yes', or '1',1070 the dialog uses a built-in generic prompt; otherwise the exact1071 value of the variable is used.10721073guitool.<name>.revprompt::1074 Request a single valid revision from the user, and set the1075 'REVISION' environment variable. In other aspects this option1076 is similar to 'argprompt', and can be used together with it.10771078guitool.<name>.revunmerged::1079 Show only unmerged branches in the 'revprompt' subdialog.1080 This is useful for tools similar to merge or rebase, but not1081 for things like checkout or reset.10821083guitool.<name>.title::1084 Specifies the title to use for the prompt dialog. The default1085 is the tool name.10861087guitool.<name>.prompt::1088 Specifies the general prompt string to display at the top of1089 the dialog, before subsections for 'argprompt' and 'revprompt'.1090 The default value includes the actual command.10911092help.browser::1093 Specify the browser that will be used to display help in the1094 'web' format. See linkgit:git-help[1].10951096help.format::1097 Override the default help format used by linkgit:git-help[1].1098 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1099 the default. 'web' and 'html' are the same.11001101help.autocorrect::1102 Automatically correct and execute mistyped commands after1103 waiting for the given number of deciseconds (0.1 sec). If more1104 than one command can be deduced from the entered text, nothing1105 will be executed. If the value of this option is negative,1106 the corrected command will be executed immediately. If the1107 value is 0 - the command will be just shown but not executed.1108 This is the default.11091110http.proxy::1111 Override the HTTP proxy, normally configured using the 'http_proxy'1112 environment variable (see linkgit:curl[1]). This can be overridden1113 on a per-remote basis; see remote.<name>.proxy11141115http.sslVerify::1116 Whether to verify the SSL certificate when fetching or pushing1117 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1118 variable.11191120http.sslCert::1121 File containing the SSL certificate when fetching or pushing1122 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1123 variable.11241125http.sslKey::1126 File containing the SSL private key when fetching or pushing1127 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1128 variable.11291130http.sslCertPasswordProtected::1131 Enable git's password prompt for the SSL certificate. Otherwise1132 OpenSSL will prompt the user, possibly many times, if the1133 certificate or private key is encrypted. Can be overridden by the1134 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.11351136http.sslCAInfo::1137 File containing the certificates to verify the peer with when1138 fetching or pushing over HTTPS. Can be overridden by the1139 'GIT_SSL_CAINFO' environment variable.11401141http.sslCAPath::1142 Path containing files with the CA certificates to verify the peer1143 with when fetching or pushing over HTTPS. Can be overridden1144 by the 'GIT_SSL_CAPATH' environment variable.11451146http.maxRequests::1147 How many HTTP requests to launch in parallel. Can be overridden1148 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.11491150http.minSessions::1151 The number of curl sessions (counted across slots) to be kept across1152 requests. They will not be ended with curl_easy_cleanup() until1153 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1154 value will be capped at 1. Defaults to 1.11551156http.postBuffer::1157 Maximum size in bytes of the buffer used by smart HTTP1158 transports when POSTing data to the remote system.1159 For requests larger than this buffer size, HTTP/1.1 and1160 Transfer-Encoding: chunked is used to avoid creating a1161 massive pack file locally. Default is 1 MiB, which is1162 sufficient for most requests.11631164http.lowSpeedLimit, http.lowSpeedTime::1165 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1166 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1167 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1168 'GIT_HTTP_LOW_SPEED_TIME' environment variables.11691170http.noEPSV::1171 A boolean which disables using of EPSV ftp command by curl.1172 This can helpful with some "poor" ftp servers which don't1173 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1174 environment variable. Default is false (curl will use EPSV).11751176i18n.commitEncoding::1177 Character encoding the commit messages are stored in; git itself1178 does not care per se, but this information is necessary e.g. when1179 importing commits from emails or in the gitk graphical history1180 browser (and possibly at other places in the future or in other1181 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.11821183i18n.logOutputEncoding::1184 Character encoding the commit messages are converted to when1185 running 'git log' and friends.11861187imap::1188 The configuration variables in the 'imap' section are described1189 in linkgit:git-imap-send[1].11901191instaweb.browser::1192 Specify the program that will be used to browse your working1193 repository in gitweb. See linkgit:git-instaweb[1].11941195instaweb.httpd::1196 The HTTP daemon command-line to start gitweb on your working1197 repository. See linkgit:git-instaweb[1].11981199instaweb.local::1200 If true the web server started by linkgit:git-instaweb[1] will1201 be bound to the local IP (127.0.0.1).12021203instaweb.modulepath::1204 The module path for an apache httpd used by linkgit:git-instaweb[1].12051206instaweb.port::1207 The port number to bind the gitweb httpd to. See1208 linkgit:git-instaweb[1].12091210interactive.singlekey::1211 In interactive commands, allow the user to provide one-letter1212 input with a single key (i.e., without hitting enter).1213 Currently this is used only by the `\--patch` mode of1214 linkgit:git-add[1]. Note that this setting is silently1215 ignored if portable keystroke input is not available.12161217log.date::1218 Set default date-time mode for the log command. Setting log.date1219 value is similar to using 'git log'\'s --date option. The value is one of the1220 following alternatives: {relative,local,default,iso,rfc,short}.1221 See linkgit:git-log[1].12221223log.showroot::1224 If true, the initial commit will be shown as a big creation event.1225 This is equivalent to a diff against an empty tree.1226 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1227 normally hide the root commit will now show it. True by default.12281229mailmap.file::1230 The location of an augmenting mailmap file. The default1231 mailmap, located in the root of the repository, is loaded1232 first, then the mailmap file pointed to by this variable.1233 The location of the mailmap file may be in a repository1234 subdirectory, or somewhere outside of the repository itself.1235 See linkgit:git-shortlog[1] and linkgit:git-blame[1].12361237man.viewer::1238 Specify the programs that may be used to display help in the1239 'man' format. See linkgit:git-help[1].12401241man.<tool>.cmd::1242 Specify the command to invoke the specified man viewer. The1243 specified command is evaluated in shell with the man page1244 passed as argument. (See linkgit:git-help[1].)12451246man.<tool>.path::1247 Override the path for the given tool that may be used to1248 display help in the 'man' format. See linkgit:git-help[1].12491250include::merge-config.txt[]12511252mergetool.<tool>.path::1253 Override the path for the given tool. This is useful in case1254 your tool is not in the PATH.12551256mergetool.<tool>.cmd::1257 Specify the command to invoke the specified merge tool. The1258 specified command is evaluated in shell with the following1259 variables available: 'BASE' is the name of a temporary file1260 containing the common base of the files to be merged, if available;1261 'LOCAL' is the name of a temporary file containing the contents of1262 the file on the current branch; 'REMOTE' is the name of a temporary1263 file containing the contents of the file from the branch being1264 merged; 'MERGED' contains the name of the file to which the merge1265 tool should write the results of a successful merge.12661267mergetool.<tool>.trustExitCode::1268 For a custom merge command, specify whether the exit code of1269 the merge command can be used to determine whether the merge was1270 successful. If this is not set to true then the merge target file1271 timestamp is checked and the merge assumed to have been successful1272 if the file has been updated, otherwise the user is prompted to1273 indicate the success of the merge.12741275mergetool.keepBackup::1276 After performing a merge, the original file with conflict markers1277 can be saved as a file with a `.orig` extension. If this variable1278 is set to `false` then this file is not preserved. Defaults to1279 `true` (i.e. keep the backup files).12801281mergetool.keepTemporaries::1282 When invoking a custom merge tool, git uses a set of temporary1283 files to pass to the tool. If the tool returns an error and this1284 variable is set to `true`, then these temporary files will be1285 preserved, otherwise they will be removed after the tool has1286 exited. Defaults to `false`.12871288mergetool.prompt::1289 Prompt before each invocation of the merge resolution program.12901291notes.displayRef::1292 The (fully qualified) refname from which to show notes when1293 showing commit messages. The value of this variable can be set1294 to a glob, in which case notes from all matching refs will be1295 shown. You may also specify this configuration variable1296 several times. A warning will be issued for refs that do not1297 exist, but a glob that does not match any refs is silently1298 ignored.1299+1300This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1301environment variable, which must be a colon separated list of refs or1302globs.1303+1304The effective value of "core.notesRef" (possibly overridden by1305GIT_NOTES_REF) is also implicitly added to the list of refs to be1306displayed.13071308pack.window::1309 The size of the window used by linkgit:git-pack-objects[1] when no1310 window size is given on the command line. Defaults to 10.13111312pack.depth::1313 The maximum delta depth used by linkgit:git-pack-objects[1] when no1314 maximum depth is given on the command line. Defaults to 50.13151316pack.windowMemory::1317 The window memory size limit used by linkgit:git-pack-objects[1]1318 when no limit is given on the command line. The value can be1319 suffixed with "k", "m", or "g". Defaults to 0, meaning no1320 limit.13211322pack.compression::1323 An integer -1..9, indicating the compression level for objects1324 in a pack file. -1 is the zlib default. 0 means no1325 compression, and 1..9 are various speed/size tradeoffs, 9 being1326 slowest. If not set, defaults to core.compression. If that is1327 not set, defaults to -1, the zlib default, which is "a default1328 compromise between speed and compression (currently equivalent1329 to level 6)."13301331pack.deltaCacheSize::1332 The maximum memory in bytes used for caching deltas in1333 linkgit:git-pack-objects[1] before writing them out to a pack.1334 This cache is used to speed up the writing object phase by not1335 having to recompute the final delta result once the best match1336 for all objects is found. Repacking large repositories on machines1337 which are tight with memory might be badly impacted by this though,1338 especially if this cache pushes the system into swapping.1339 A value of 0 means no limit. The smallest size of 1 byte may be1340 used to virtually disable this cache. Defaults to 256 MiB.13411342pack.deltaCacheLimit::1343 The maximum size of a delta, that is cached in1344 linkgit:git-pack-objects[1]. This cache is used to speed up the1345 writing object phase by not having to recompute the final delta1346 result once the best match for all objects is found. Defaults to 1000.13471348pack.threads::1349 Specifies the number of threads to spawn when searching for best1350 delta matches. This requires that linkgit:git-pack-objects[1]1351 be compiled with pthreads otherwise this option is ignored with a1352 warning. This is meant to reduce packing time on multiprocessor1353 machines. The required amount of memory for the delta search window1354 is however multiplied by the number of threads.1355 Specifying 0 will cause git to auto-detect the number of CPU's1356 and set the number of threads accordingly.13571358pack.indexVersion::1359 Specify the default pack index version. Valid values are 1 for1360 legacy pack index used by Git versions prior to 1.5.2, and 2 for1361 the new pack index with capabilities for packs larger than 4 GB1362 as well as proper protection against the repacking of corrupted1363 packs. Version 2 is the default. Note that version 2 is enforced1364 and this config option ignored whenever the corresponding pack is1365 larger than 2 GB.1366+1367If you have an old git that does not understand the version 2 `{asterisk}.idx` file,1368cloning or fetching over a non native protocol (e.g. "http" and "rsync")1369that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the1370other side may give you a repository that cannot be accessed with your1371older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,1372you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1373the `{asterisk}.idx` file.13741375pack.packSizeLimit::1376 The default maximum size of a pack. This setting only affects1377 packing to a file, i.e. the git:// protocol is unaffected. It1378 can be overridden by the `\--max-pack-size` option of1379 linkgit:git-repack[1].13801381pager.<cmd>::1382 Allows turning on or off pagination of the output of a1383 particular git subcommand when writing to a tty. If1384 `\--paginate` or `\--no-pager` is specified on the command line,1385 it takes precedence over this option. To disable pagination for1386 all commands, set `core.pager` or `GIT_PAGER` to `cat`.13871388pull.octopus::1389 The default merge strategy to use when pulling multiple branches1390 at once.13911392pull.twohead::1393 The default merge strategy to use when pulling a single branch.13941395push.default::1396 Defines the action git push should take if no refspec is given1397 on the command line, no refspec is configured in the remote, and1398 no refspec is implied by any of the options given on the command1399 line. Possible values are:1400+1401* `nothing` do not push anything.1402* `matching` push all matching branches.1403 All branches having the same name in both ends are considered to be1404 matching. This is the default.1405* `tracking` push the current branch to its upstream branch.1406* `current` push the current branch to a branch of the same name.14071408rebase.stat::1409 Whether to show a diffstat of what changed upstream since the last1410 rebase. False by default.14111412receive.autogc::1413 By default, git-receive-pack will run "git-gc --auto" after1414 receiving data from git-push and updating refs. You can stop1415 it by setting this variable to false.14161417receive.fsckObjects::1418 If it is set to true, git-receive-pack will check all received1419 objects. It will abort in the case of a malformed object or a1420 broken link. The result of an abort are only dangling objects.1421 Defaults to false.14221423receive.unpackLimit::1424 If the number of objects received in a push is below this1425 limit then the objects will be unpacked into loose object1426 files. However if the number of received objects equals or1427 exceeds this limit then the received pack will be stored as1428 a pack, after adding any missing delta bases. Storing the1429 pack from a push can make the push operation complete faster,1430 especially on slow filesystems. If not set, the value of1431 `transfer.unpackLimit` is used instead.14321433receive.denyDeletes::1434 If set to true, git-receive-pack will deny a ref update that deletes1435 the ref. Use this to prevent such a ref deletion via a push.14361437receive.denyCurrentBranch::1438 If set to true or "refuse", receive-pack will deny a ref update1439 to the currently checked out branch of a non-bare repository.1440 Such a push is potentially dangerous because it brings the HEAD1441 out of sync with the index and working tree. If set to "warn",1442 print a warning of such a push to stderr, but allow the push to1443 proceed. If set to false or "ignore", allow such pushes with no1444 message. Defaults to "warn".14451446receive.denyNonFastForwards::1447 If set to true, git-receive-pack will deny a ref update which is1448 not a fast-forward. Use this to prevent such an update via a push,1449 even if that push is forced. This configuration variable is1450 set when initializing a shared repository.14511452receive.updateserverinfo::1453 If set to true, git-receive-pack will run git-update-server-info1454 after receiving data from git-push and updating refs.14551456remote.<name>.url::1457 The URL of a remote repository. See linkgit:git-fetch[1] or1458 linkgit:git-push[1].14591460remote.<name>.pushurl::1461 The push URL of a remote repository. See linkgit:git-push[1].14621463remote.<name>.proxy::1464 For remotes that require curl (http, https and ftp), the URL to1465 the proxy to use for that remote. Set to the empty string to1466 disable proxying for that remote.14671468remote.<name>.fetch::1469 The default set of "refspec" for linkgit:git-fetch[1]. See1470 linkgit:git-fetch[1].14711472remote.<name>.push::1473 The default set of "refspec" for linkgit:git-push[1]. See1474 linkgit:git-push[1].14751476remote.<name>.mirror::1477 If true, pushing to this remote will automatically behave1478 as if the `\--mirror` option was given on the command line.14791480remote.<name>.skipDefaultUpdate::1481 If true, this remote will be skipped by default when updating1482 using linkgit:git-fetch[1] or the `update` subcommand of1483 linkgit:git-remote[1].14841485remote.<name>.skipFetchAll::1486 If true, this remote will be skipped by default when updating1487 using linkgit:git-fetch[1] or the `update` subcommand of1488 linkgit:git-remote[1].14891490remote.<name>.receivepack::1491 The default program to execute on the remote side when pushing. See1492 option \--receive-pack of linkgit:git-push[1].14931494remote.<name>.uploadpack::1495 The default program to execute on the remote side when fetching. See1496 option \--upload-pack of linkgit:git-fetch-pack[1].14971498remote.<name>.tagopt::1499 Setting this value to \--no-tags disables automatic tag following when1500 fetching from remote <name>15011502remote.<name>.vcs::1503 Setting this to a value <vcs> will cause git to interact with1504 the remote with the git-remote-<vcs> helper.15051506remotes.<group>::1507 The list of remotes which are fetched by "git remote update1508 <group>". See linkgit:git-remote[1].15091510repack.usedeltabaseoffset::1511 By default, linkgit:git-repack[1] creates packs that use1512 delta-base offset. If you need to share your repository with1513 git older than version 1.4.4, either directly or via a dumb1514 protocol such as http, then you need to set this option to1515 "false" and repack. Access from old git versions over the1516 native protocol are unaffected by this option.15171518rerere.autoupdate::1519 When set to true, `git-rerere` updates the index with the1520 resulting contents after it cleanly resolves conflicts using1521 previously recorded resolution. Defaults to false.15221523rerere.enabled::1524 Activate recording of resolved conflicts, so that identical1525 conflict hunks can be resolved automatically, should they1526 be encountered again. linkgit:git-rerere[1] command is by1527 default enabled if you create `rr-cache` directory under1528 `$GIT_DIR`, but can be disabled by setting this option to false.15291530sendemail.identity::1531 A configuration identity. When given, causes values in the1532 'sendemail.<identity>' subsection to take precedence over1533 values in the 'sendemail' section. The default identity is1534 the value of 'sendemail.identity'.15351536sendemail.smtpencryption::1537 See linkgit:git-send-email[1] for description. Note that this1538 setting is not subject to the 'identity' mechanism.15391540sendemail.smtpssl::1541 Deprecated alias for 'sendemail.smtpencryption = ssl'.15421543sendemail.<identity>.*::1544 Identity-specific versions of the 'sendemail.*' parameters1545 found below, taking precedence over those when the this1546 identity is selected, through command-line or1547 'sendemail.identity'.15481549sendemail.aliasesfile::1550sendemail.aliasfiletype::1551sendemail.bcc::1552sendemail.cc::1553sendemail.cccmd::1554sendemail.chainreplyto::1555sendemail.confirm::1556sendemail.envelopesender::1557sendemail.from::1558sendemail.multiedit::1559sendemail.signedoffbycc::1560sendemail.smtppass::1561sendemail.suppresscc::1562sendemail.suppressfrom::1563sendemail.to::1564sendemail.smtpserver::1565sendemail.smtpserverport::1566sendemail.smtpuser::1567sendemail.thread::1568sendemail.validate::1569 See linkgit:git-send-email[1] for description.15701571sendemail.signedoffcc::1572 Deprecated alias for 'sendemail.signedoffbycc'.15731574showbranch.default::1575 The default set of branches for linkgit:git-show-branch[1].1576 See linkgit:git-show-branch[1].15771578status.relativePaths::1579 By default, linkgit:git-status[1] shows paths relative to the1580 current directory. Setting this variable to `false` shows paths1581 relative to the repository root (this was the default for git1582 prior to v1.5.4).15831584status.showUntrackedFiles::1585 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1586 files which are not currently tracked by Git. Directories which1587 contain only untracked files, are shown with the directory name1588 only. Showing untracked files means that Git needs to lstat() all1589 all the files in the whole repository, which might be slow on some1590 systems. So, this variable controls how the commands displays1591 the untracked files. Possible values are:1592+1593--1594 - 'no' - Show no untracked files1595 - 'normal' - Shows untracked files and directories1596 - 'all' - Shows also individual files in untracked directories.1597--1598+1599If this variable is not specified, it defaults to 'normal'.1600This variable can be overridden with the -u|--untracked-files option1601of linkgit:git-status[1] and linkgit:git-commit[1].16021603tar.umask::1604 This variable can be used to restrict the permission bits of1605 tar archive entries. The default is 0002, which turns off the1606 world write bit. The special value "user" indicates that the1607 archiving user's umask will be used instead. See umask(2) and1608 linkgit:git-archive[1].16091610transfer.unpackLimit::1611 When `fetch.unpackLimit` or `receive.unpackLimit` are1612 not set, the value of this variable is used instead.1613 The default value is 100.16141615url.<base>.insteadOf::1616 Any URL that starts with this value will be rewritten to1617 start, instead, with <base>. In cases where some site serves a1618 large number of repositories, and serves them with multiple1619 access methods, and some users need to use different access1620 methods, this feature allows people to specify any of the1621 equivalent URLs and have git automatically rewrite the URL to1622 the best alternative for the particular user, even for a1623 never-before-seen repository on the site. When more than one1624 insteadOf strings match a given URL, the longest match is used.16251626url.<base>.pushInsteadOf::1627 Any URL that starts with this value will not be pushed to;1628 instead, it will be rewritten to start with <base>, and the1629 resulting URL will be pushed to. In cases where some site serves1630 a large number of repositories, and serves them with multiple1631 access methods, some of which do not allow push, this feature1632 allows people to specify a pull-only URL and have git1633 automatically use an appropriate URL to push, even for a1634 never-before-seen repository on the site. When more than one1635 pushInsteadOf strings match a given URL, the longest match is1636 used. If a remote has an explicit pushurl, git will ignore this1637 setting for that remote.16381639user.email::1640 Your email address to be recorded in any newly created commits.1641 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and1642 'EMAIL' environment variables. See linkgit:git-commit-tree[1].16431644user.name::1645 Your full name to be recorded in any newly created commits.1646 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'1647 environment variables. See linkgit:git-commit-tree[1].16481649user.signingkey::1650 If linkgit:git-tag[1] is not selecting the key you want it to1651 automatically when creating a signed tag, you can override the1652 default selection with this variable. This option is passed1653 unchanged to gpg's --local-user parameter, so you may specify a key1654 using any method that gpg supports.16551656web.browser::1657 Specify a web browser that may be used by some commands.1658 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1659 may use it.