1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' 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, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be 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). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 amWorkDir:: 348 Advice that shows the location of the patch file when 349 linkgit:git-am[1] fails to apply it. 350 rmHints:: 351 In case of failure in the output of linkgit:git-rm[1], 352 show directions on how to proceed from the current state. 353 addEmbeddedRepo:: 354 Advice on what to do when you've accidentally added one 355 git repo inside of another. 356 ignoredHook:: 357 Advice shown if an hook is ignored because the hook is not 358 set as executable. 359 waitingForEditor:: 360 Print a message to the terminal whenever Git is waiting for 361 editor input from the user. 362-- 363 364core.fileMode:: 365 Tells Git if the executable bit of files in the working tree 366 is to be honored. 367+ 368Some filesystems lose the executable bit when a file that is 369marked as executable is checked out, or checks out a 370non-executable file with executable bit on. 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 372to see if it handles the executable bit correctly 373and this variable is automatically set as necessary. 374+ 375A repository, however, may be on a filesystem that handles 376the filemode correctly, and this variable is set to 'true' 377when created, but later may be made accessible from another 378environment that loses the filemode (e.g. exporting ext4 via 379CIFS mount, visiting a Cygwin created repository with 380Git for Windows or Eclipse). 381In such a case it may be necessary to set this variable to 'false'. 382See linkgit:git-update-index[1]. 383+ 384The default is true (when core.filemode is not specified in the config file). 385 386core.hideDotFiles:: 387 (Windows-only) If true, mark newly-created directories and files whose 388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 389 directory is hidden, but no other files starting with a dot. The 390 default mode is 'dotGitOnly'. 391 392core.ignoreCase:: 393 If true, this option enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like FAT. For example, if a directory listing finds 396 "makefile" when Git expects "Makefile", Git will assume 397 it is really the same file, and continue to remember it as 398 "Makefile". 399+ 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 401will probe and set core.ignoreCase true if appropriate when the repository 402is created. 403 404core.precomposeUnicode:: 405 This option is only used by Mac OS implementation of Git. 406 When core.precomposeUnicode=true, Git reverts the unicode decomposition 407 of filenames done by Mac OS. This is useful when sharing a repository 408 between Mac OS and Linux or Windows. 409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 410 When false, file names are handled fully transparent by Git, 411 which is backward compatible with older versions of Git. 412 413core.protectHFS:: 414 If set to true, do not allow checkout of paths that would 415 be considered equivalent to `.git` on an HFS+ filesystem. 416 Defaults to `true` on Mac OS, and `false` elsewhere. 417 418core.protectNTFS:: 419 If set to true, do not allow checkout of paths that would 420 cause problems with the NTFS filesystem, e.g. conflict with 421 8.3 "short" names. 422 Defaults to `true` on Windows, and `false` elsewhere. 423 424core.fsmonitor:: 425 If set, the value of this variable is used as a command which 426 will identify all files that may have changed since the 427 requested date/time. This information is used to speed up git by 428 avoiding unnecessary processing of files that have not changed. 429 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 430 431core.trustctime:: 432 If false, the ctime differences between the index and the 433 working tree are ignored; useful when the inode change time 434 is regularly modified by something outside Git (file system 435 crawlers and some backup systems). 436 See linkgit:git-update-index[1]. True by default. 437 438core.splitIndex:: 439 If true, the split-index feature of the index will be used. 440 See linkgit:git-update-index[1]. False by default. 441 442core.untrackedCache:: 443 Determines what to do about the untracked cache feature of the 444 index. It will be kept, if this variable is unset or set to 445 `keep`. It will automatically be added if set to `true`. And 446 it will automatically be removed, if set to `false`. Before 447 setting it to `true`, you should check that mtime is working 448 properly on your system. 449 See linkgit:git-update-index[1]. `keep` by default. 450 451core.checkStat:: 452 Determines which stat fields to match between the index 453 and work tree. The user can set this to 'default' or 454 'minimal'. Default (or explicitly 'default'), is to check 455 all fields, including the sub-second part of mtime and ctime. 456 457core.quotePath:: 458 Commands that output paths (e.g. 'ls-files', 'diff'), will 459 quote "unusual" characters in the pathname by enclosing the 460 pathname in double-quotes and escaping those characters with 461 backslashes in the same way C escapes control characters (e.g. 462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 464 UTF-8). If this variable is set to false, bytes higher than 465 0x80 are not considered "unusual" any more. Double-quotes, 466 backslash and control characters are always escaped regardless 467 of the setting of this variable. A simple space character is 468 not considered "unusual". Many commands can output pathnames 469 completely verbatim using the `-z` option. The default value 470 is true. 471 472core.eol:: 473 Sets the line ending type to use in the working directory for 474 files that have the `text` property set when core.autocrlf is false. 475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 476 native line ending. The default value is `native`. See 477 linkgit:gitattributes[5] for more information on end-of-line 478 conversion. 479 480core.safecrlf:: 481 If true, makes Git check if converting `CRLF` is reversible when 482 end-of-line conversion is active. Git will verify if a command 483 modifies a file in the work tree either directly or indirectly. 484 For example, committing a file followed by checking out the 485 same file should yield the original file in the work tree. If 486 this is not the case for the current setting of 487 `core.autocrlf`, Git will reject the file. The variable can 488 be set to "warn", in which case Git will only warn about an 489 irreversible conversion but continue the operation. 490+ 491CRLF conversion bears a slight chance of corrupting data. 492When it is enabled, Git will convert CRLF to LF during commit and LF to 493CRLF during checkout. A file that contains a mixture of LF and 494CRLF before the commit cannot be recreated by Git. For text 495files this is the right thing to do: it corrects line endings 496such that we have only LF line endings in the repository. 497But for binary files that are accidentally classified as text the 498conversion can corrupt data. 499+ 500If you recognize such corruption early you can easily fix it by 501setting the conversion type explicitly in .gitattributes. Right 502after committing you still have the original file in your work 503tree and this file is not yet corrupted. You can explicitly tell 504Git that this file is binary and Git will handle the file 505appropriately. 506+ 507Unfortunately, the desired effect of cleaning up text files with 508mixed line endings and the undesired effect of corrupting binary 509files cannot be distinguished. In both cases CRLFs are removed 510in an irreversible way. For text files this is the right thing 511to do because CRLFs are line endings, while for binary files 512converting CRLFs corrupts data. 513+ 514Note, this safety check does not mean that a checkout will generate a 515file identical to the original file for a different setting of 516`core.eol` and `core.autocrlf`, but only for the current one. For 517example, a text file with `LF` would be accepted with `core.eol=lf` 518and could later be checked out with `core.eol=crlf`, in which case the 519resulting file would contain `CRLF`, although the original file 520contained `LF`. However, in both work trees the line endings would be 521consistent, that is either all `LF` or all `CRLF`, but never mixed. A 522file with mixed line endings would be reported by the `core.safecrlf` 523mechanism. 524 525core.autocrlf:: 526 Setting this variable to "true" is the same as setting 527 the `text` attribute to "auto" on all files and core.eol to "crlf". 528 Set to true if you want to have `CRLF` line endings in your 529 working directory and the repository has LF line endings. 530 This variable can be set to 'input', 531 in which case no output conversion is performed. 532 533core.symlinks:: 534 If false, symbolic links are checked out as small plain files that 535 contain the link text. linkgit:git-update-index[1] and 536 linkgit:git-add[1] will not change the recorded type to regular 537 file. Useful on filesystems like FAT that do not support 538 symbolic links. 539+ 540The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 541will probe and set core.symlinks false if appropriate when the repository 542is created. 543 544core.gitProxy:: 545 A "proxy command" to execute (as 'command host port') instead 546 of establishing direct connection to the remote server when 547 using the Git protocol for fetching. If the variable value is 548 in the "COMMAND for DOMAIN" format, the command is applied only 549 on hostnames ending with the specified domain string. This variable 550 may be set multiple times and is matched in the given order; 551 the first match wins. 552+ 553Can be overridden by the `GIT_PROXY_COMMAND` environment variable 554(which always applies universally, without the special "for" 555handling). 556+ 557The special string `none` can be used as the proxy command to 558specify that no proxy be used for a given domain pattern. 559This is useful for excluding servers inside a firewall from 560proxy use, while defaulting to a common proxy for external domains. 561 562core.sshCommand:: 563 If this variable is set, `git fetch` and `git push` will 564 use the specified command instead of `ssh` when they need to 565 connect to a remote system. The command is in the same form as 566 the `GIT_SSH_COMMAND` environment variable and is overridden 567 when the environment variable is set. 568 569core.ignoreStat:: 570 If true, Git will avoid using lstat() calls to detect if files have 571 changed by setting the "assume-unchanged" bit for those tracked files 572 which it has updated identically in both the index and working tree. 573+ 574When files are modified outside of Git, the user will need to stage 575the modified files explicitly (e.g. see 'Examples' section in 576linkgit:git-update-index[1]). 577Git will not normally detect changes to those files. 578+ 579This is useful on systems where lstat() calls are very slow, such as 580CIFS/Microsoft Windows. 581+ 582False by default. 583 584core.preferSymlinkRefs:: 585 Instead of the default "symref" format for HEAD 586 and other symbolic reference files, use symbolic links. 587 This is sometimes needed to work with old scripts that 588 expect HEAD to be a symbolic link. 589 590core.bare:: 591 If true this repository is assumed to be 'bare' and has no 592 working directory associated with it. If this is the case a 593 number of commands that require a working directory will be 594 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 595+ 596This setting is automatically guessed by linkgit:git-clone[1] or 597linkgit:git-init[1] when the repository was created. By default a 598repository that ends in "/.git" is assumed to be not bare (bare = 599false), while all other repositories are assumed to be bare (bare 600= true). 601 602core.worktree:: 603 Set the path to the root of the working tree. 604 If `GIT_COMMON_DIR` environment variable is set, core.worktree 605 is ignored and not used for determining the root of working tree. 606 This can be overridden by the `GIT_WORK_TREE` environment 607 variable and the `--work-tree` command-line option. 608 The value can be an absolute path or relative to the path to 609 the .git directory, which is either specified by --git-dir 610 or GIT_DIR, or automatically discovered. 611 If --git-dir or GIT_DIR is specified but none of 612 --work-tree, GIT_WORK_TREE and core.worktree is specified, 613 the current working directory is regarded as the top level 614 of your working tree. 615+ 616Note that this variable is honored even when set in a configuration 617file in a ".git" subdirectory of a directory and its value differs 618from the latter directory (e.g. "/path/to/.git/config" has 619core.worktree set to "/different/path"), which is most likely a 620misconfiguration. Running Git commands in the "/path/to" directory will 621still use "/different/path" as the root of the work tree and can cause 622confusion unless you know what you are doing (e.g. you are creating a 623read-only snapshot of the same index to a location different from the 624repository's usual working tree). 625 626core.logAllRefUpdates:: 627 Enable the reflog. Updates to a ref <ref> is logged to the file 628 "`$GIT_DIR/logs/<ref>`", by appending the new and old 629 SHA-1, the date/time and the reason of the update, but 630 only when the file exists. If this configuration 631 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 632 file is automatically created for branch heads (i.e. under 633 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 634 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 635 If it is set to `always`, then a missing reflog is automatically 636 created for any ref under `refs/`. 637+ 638This information can be used to determine what commit 639was the tip of a branch "2 days ago". 640+ 641This value is true by default in a repository that has 642a working directory associated with it, and false by 643default in a bare repository. 644 645core.repositoryFormatVersion:: 646 Internal variable identifying the repository format and layout 647 version. 648 649core.sharedRepository:: 650 When 'group' (or 'true'), the repository is made shareable between 651 several users in a group (making sure all the files and objects are 652 group-writable). When 'all' (or 'world' or 'everybody'), the 653 repository will be readable by all users, additionally to being 654 group-shareable. When 'umask' (or 'false'), Git will use permissions 655 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 656 files in the repository will have this mode value. '0xxx' will override 657 user's umask value (whereas the other options will only override 658 requested parts of the user's umask value). Examples: '0660' will make 659 the repo read/write-able for the owner and group, but inaccessible to 660 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 661 repository that is group-readable but not group-writable. 662 See linkgit:git-init[1]. False by default. 663 664core.warnAmbiguousRefs:: 665 If true, Git will warn you if the ref name you passed it is ambiguous 666 and might match multiple refs in the repository. True by default. 667 668core.compression:: 669 An integer -1..9, indicating a default compression level. 670 -1 is the zlib default. 0 means no compression, 671 and 1..9 are various speed/size tradeoffs, 9 being slowest. 672 If set, this provides a default to other compression variables, 673 such as `core.looseCompression` and `pack.compression`. 674 675core.looseCompression:: 676 An integer -1..9, indicating the compression level for objects that 677 are not in a pack file. -1 is the zlib default. 0 means no 678 compression, and 1..9 are various speed/size tradeoffs, 9 being 679 slowest. If not set, defaults to core.compression. If that is 680 not set, defaults to 1 (best speed). 681 682core.packedGitWindowSize:: 683 Number of bytes of a pack file to map into memory in a 684 single mapping operation. Larger window sizes may allow 685 your system to process a smaller number of large pack files 686 more quickly. Smaller window sizes will negatively affect 687 performance due to increased calls to the operating system's 688 memory manager, but may improve performance when accessing 689 a large number of large pack files. 690+ 691Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 692MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 693be reasonable for all users/operating systems. You probably do 694not need to adjust this value. 695+ 696Common unit suffixes of 'k', 'm', or 'g' are supported. 697 698core.packedGitLimit:: 699 Maximum number of bytes to map simultaneously into memory 700 from pack files. If Git needs to access more than this many 701 bytes at once to complete an operation it will unmap existing 702 regions to reclaim virtual address space within the process. 703+ 704Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 705unlimited) on 64 bit platforms. 706This should be reasonable for all users/operating systems, except on 707the largest projects. You probably do not need to adjust this value. 708+ 709Common unit suffixes of 'k', 'm', or 'g' are supported. 710 711core.deltaBaseCacheLimit:: 712 Maximum number of bytes to reserve for caching base objects 713 that may be referenced by multiple deltified objects. By storing the 714 entire decompressed base objects in a cache Git is able 715 to avoid unpacking and decompressing frequently used base 716 objects multiple times. 717+ 718Default is 96 MiB on all platforms. This should be reasonable 719for all users/operating systems, except on the largest projects. 720You probably do not need to adjust this value. 721+ 722Common unit suffixes of 'k', 'm', or 'g' are supported. 723 724core.bigFileThreshold:: 725 Files larger than this size are stored deflated, without 726 attempting delta compression. Storing large files without 727 delta compression avoids excessive memory usage, at the 728 slight expense of increased disk usage. Additionally files 729 larger than this size are always treated as binary. 730+ 731Default is 512 MiB on all platforms. This should be reasonable 732for most projects as source code and other text files can still 733be delta compressed, but larger binary media files won't be. 734+ 735Common unit suffixes of 'k', 'm', or 'g' are supported. 736 737core.excludesFile:: 738 Specifies the pathname to the file that contains patterns to 739 describe paths that are not meant to be tracked, in addition 740 to '.gitignore' (per-directory) and '.git/info/exclude'. 741 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 742 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 743 is used instead. See linkgit:gitignore[5]. 744 745core.askPass:: 746 Some commands (e.g. svn and http interfaces) that interactively 747 ask for a password can be told to use an external program given 748 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 749 environment variable. If not set, fall back to the value of the 750 `SSH_ASKPASS` environment variable or, failing that, a simple password 751 prompt. The external program shall be given a suitable prompt as 752 command-line argument and write the password on its STDOUT. 753 754core.attributesFile:: 755 In addition to '.gitattributes' (per-directory) and 756 '.git/info/attributes', Git looks into this file for attributes 757 (see linkgit:gitattributes[5]). Path expansions are made the same 758 way as for `core.excludesFile`. Its default value is 759 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 760 set or empty, `$HOME/.config/git/attributes` is used instead. 761 762core.hooksPath:: 763 By default Git will look for your hooks in the 764 '$GIT_DIR/hooks' directory. Set this to different path, 765 e.g. '/etc/git/hooks', and Git will try to find your hooks in 766 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 767 in '$GIT_DIR/hooks/pre-receive'. 768+ 769The path can be either absolute or relative. A relative path is 770taken as relative to the directory where the hooks are run (see 771the "DESCRIPTION" section of linkgit:githooks[5]). 772+ 773This configuration variable is useful in cases where you'd like to 774centrally configure your Git hooks instead of configuring them on a 775per-repository basis, or as a more flexible and centralized 776alternative to having an `init.templateDir` where you've changed 777default hooks. 778 779core.editor:: 780 Commands such as `commit` and `tag` that let you edit 781 messages by launching an editor use the value of this 782 variable when it is set, and the environment variable 783 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 784 785core.commentChar:: 786 Commands such as `commit` and `tag` that let you edit 787 messages consider a line that begins with this character 788 commented, and removes them after the editor returns 789 (default '#'). 790+ 791If set to "auto", `git-commit` would select a character that is not 792the beginning character of any line in existing commit messages. 793 794core.filesRefLockTimeout:: 795 The length of time, in milliseconds, to retry when trying to 796 lock an individual reference. Value 0 means not to retry at 797 all; -1 means to try indefinitely. Default is 100 (i.e., 798 retry for 100ms). 799 800core.packedRefsTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock the `packed-refs` file. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 1000 (i.e., 804 retry for 1 second). 805 806sequence.editor:: 807 Text editor used by `git rebase -i` for editing the rebase instruction file. 808 The value is meant to be interpreted by the shell when it is used. 809 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 810 When not configured the default commit message editor is used instead. 811 812core.pager:: 813 Text viewer for use by Git commands (e.g., 'less'). The value 814 is meant to be interpreted by the shell. The order of preference 815 is the `$GIT_PAGER` environment variable, then `core.pager` 816 configuration, then `$PAGER`, and then the default chosen at 817 compile time (usually 'less'). 818+ 819When the `LESS` environment variable is unset, Git sets it to `FRX` 820(if `LESS` environment variable is set, Git does not change it at 821all). If you want to selectively override Git's default setting 822for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 823be passed to the shell by Git, which will translate the final 824command to `LESS=FRX less -S`. The environment does not set the 825`S` option but the command line does, instructing less to truncate 826long lines. Similarly, setting `core.pager` to `less -+F` will 827deactivate the `F` option specified by the environment from the 828command-line, deactivating the "quit if one screen" behavior of 829`less`. One can specifically activate some flags for particular 830commands: for example, setting `pager.blame` to `less -S` enables 831line truncation only for `git blame`. 832+ 833Likewise, when the `LV` environment variable is unset, Git sets it 834to `-c`. You can override this setting by exporting `LV` with 835another value or setting `core.pager` to `lv +c`. 836 837core.whitespace:: 838 A comma separated list of common whitespace problems to 839 notice. 'git diff' will use `color.diff.whitespace` to 840 highlight them, and 'git apply --whitespace=error' will 841 consider them as errors. You can prefix `-` to disable 842 any of them (e.g. `-trailing-space`): 843+ 844* `blank-at-eol` treats trailing whitespaces at the end of the line 845 as an error (enabled by default). 846* `space-before-tab` treats a space character that appears immediately 847 before a tab character in the initial indent part of the line as an 848 error (enabled by default). 849* `indent-with-non-tab` treats a line that is indented with space 850 characters instead of the equivalent tabs as an error (not enabled by 851 default). 852* `tab-in-indent` treats a tab character in the initial indent part of 853 the line as an error (not enabled by default). 854* `blank-at-eof` treats blank lines added at the end of file as an error 855 (enabled by default). 856* `trailing-space` is a short-hand to cover both `blank-at-eol` and 857 `blank-at-eof`. 858* `cr-at-eol` treats a carriage-return at the end of line as 859 part of the line terminator, i.e. with it, `trailing-space` 860 does not trigger if the character before such a carriage-return 861 is not a whitespace (not enabled by default). 862* `tabwidth=<n>` tells how many character positions a tab occupies; this 863 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 864 errors. The default tab width is 8. Allowed values are 1 to 63. 865 866core.fsyncObjectFiles:: 867 This boolean will enable 'fsync()' when writing object files. 868+ 869This is a total waste of time and effort on a filesystem that orders 870data writes properly, but can be useful for filesystems that do not use 871journalling (traditional UNIX filesystems) or that only journal metadata 872and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 873 874core.preloadIndex:: 875 Enable parallel index preload for operations like 'git diff' 876+ 877This can speed up operations like 'git diff' and 'git status' especially 878on filesystems like NFS that have weak caching semantics and thus 879relatively high IO latencies. When enabled, Git will do the 880index comparison to the filesystem data in parallel, allowing 881overlapping IO's. Defaults to true. 882 883core.createObject:: 884 You can set this to 'link', in which case a hardlink followed by 885 a delete of the source are used to make sure that object creation 886 will not overwrite existing objects. 887+ 888On some file system/operating system combinations, this is unreliable. 889Set this config setting to 'rename' there; However, This will remove the 890check that makes sure that existing object files will not get overwritten. 891 892core.notesRef:: 893 When showing commit messages, also show notes which are stored in 894 the given ref. The ref must be fully qualified. If the given 895 ref does not exist, it is not an error but means that no 896 notes should be printed. 897+ 898This setting defaults to "refs/notes/commits", and it can be overridden by 899the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 900 901core.sparseCheckout:: 902 Enable "sparse checkout" feature. See section "Sparse checkout" in 903 linkgit:git-read-tree[1] for more information. 904 905core.abbrev:: 906 Set the length object names are abbreviated to. If 907 unspecified or set to "auto", an appropriate value is 908 computed based on the approximate number of packed objects 909 in your repository, which hopefully is enough for 910 abbreviated object names to stay unique for some time. 911 The minimum length is 4. 912 913add.ignoreErrors:: 914add.ignore-errors (deprecated):: 915 Tells 'git add' to continue adding files when some files cannot be 916 added due to indexing errors. Equivalent to the `--ignore-errors` 917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 918 as it does not follow the usual naming convention for configuration 919 variables. 920 921alias.*:: 922 Command aliases for the linkgit:git[1] command wrapper - e.g. 923 after defining "alias.last = cat-file commit HEAD", the invocation 924 "git last" is equivalent to "git cat-file commit HEAD". To avoid 925 confusion and troubles with script usage, aliases that 926 hide existing Git commands are ignored. Arguments are split by 927 spaces, the usual shell quoting and escaping is supported. 928 A quote pair or a backslash can be used to quote them. 929+ 930If the alias expansion is prefixed with an exclamation point, 931it will be treated as a shell command. For example, defining 932"alias.new = !gitk --all --not ORIG_HEAD", the invocation 933"git new" is equivalent to running the shell command 934"gitk --all --not ORIG_HEAD". Note that shell commands will be 935executed from the top-level directory of a repository, which may 936not necessarily be the current directory. 937`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 938from the original current directory. See linkgit:git-rev-parse[1]. 939 940am.keepcr:: 941 If true, git-am will call git-mailsplit for patches in mbox format 942 with parameter `--keep-cr`. In this case git-mailsplit will 943 not remove `\r` from lines ending with `\r\n`. Can be overridden 944 by giving `--no-keep-cr` from the command line. 945 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 946 947am.threeWay:: 948 By default, `git am` will fail if the patch does not apply cleanly. When 949 set to true, this setting tells `git am` to fall back on 3-way merge if 950 the patch records the identity of blobs it is supposed to apply to and 951 we have those blobs available locally (equivalent to giving the `--3way` 952 option from the command line). Defaults to `false`. 953 See linkgit:git-am[1]. 954 955apply.ignoreWhitespace:: 956 When set to 'change', tells 'git apply' to ignore changes in 957 whitespace, in the same way as the `--ignore-space-change` 958 option. 959 When set to one of: no, none, never, false tells 'git apply' to 960 respect all whitespace differences. 961 See linkgit:git-apply[1]. 962 963apply.whitespace:: 964 Tells 'git apply' how to handle whitespaces, in the same way 965 as the `--whitespace` option. See linkgit:git-apply[1]. 966 967blame.showRoot:: 968 Do not treat root commits as boundaries in linkgit:git-blame[1]. 969 This option defaults to false. 970 971blame.blankBoundary:: 972 Show blank commit object name for boundary commits in 973 linkgit:git-blame[1]. This option defaults to false. 974 975blame.showEmail:: 976 Show the author email instead of author name in linkgit:git-blame[1]. 977 This option defaults to false. 978 979blame.date:: 980 Specifies the format used to output dates in linkgit:git-blame[1]. 981 If unset the iso format is used. For supported values, 982 see the discussion of the `--date` option at linkgit:git-log[1]. 983 984branch.autoSetupMerge:: 985 Tells 'git branch' and 'git checkout' to set up new branches 986 so that linkgit:git-pull[1] will appropriately merge from the 987 starting point branch. Note that even if this option is not set, 988 this behavior can be chosen per-branch using the `--track` 989 and `--no-track` options. The valid settings are: `false` -- no 990 automatic setup is done; `true` -- automatic setup is done when the 991 starting point is a remote-tracking branch; `always` -- 992 automatic setup is done when the starting point is either a 993 local branch or remote-tracking 994 branch. This option defaults to true. 995 996branch.autoSetupRebase:: 997 When a new branch is created with 'git branch' or 'git checkout' 998 that tracks another branch, this variable tells Git to set 999 up pull to rebase instead of merge (see "branch.<name>.rebase").1000 When `never`, rebase is never automatically set to true.1001 When `local`, rebase is set to true for tracked branches of1002 other local branches.1003 When `remote`, rebase is set to true for tracked branches of1004 remote-tracking branches.1005 When `always`, rebase will be set to true for all tracking1006 branches.1007 See "branch.autoSetupMerge" for details on how to set up a1008 branch to track another branch.1009 This option defaults to never.10101011branch.<name>.remote::1012 When on branch <name>, it tells 'git fetch' and 'git push'1013 which remote to fetch from/push to. The remote to push to1014 may be overridden with `remote.pushDefault` (for all branches).1015 The remote to push to, for the current branch, may be further1016 overridden by `branch.<name>.pushRemote`. If no remote is1017 configured, or if you are not on any branch, it defaults to1018 `origin` for fetching and `remote.pushDefault` for pushing.1019 Additionally, `.` (a period) is the current local repository1020 (a dot-repository), see `branch.<name>.merge`'s final note below.10211022branch.<name>.pushRemote::1023 When on branch <name>, it overrides `branch.<name>.remote` for1024 pushing. It also overrides `remote.pushDefault` for pushing1025 from branch <name>. When you pull from one place (e.g. your1026 upstream) and push to another place (e.g. your own publishing1027 repository), you would want to set `remote.pushDefault` to1028 specify the remote to push to for all branches, and use this1029 option to override it for a specific branch.10301031branch.<name>.merge::1032 Defines, together with branch.<name>.remote, the upstream branch1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1034 branch to merge and can also affect 'git push' (see push.default).1035 When in branch <name>, it tells 'git fetch' the default1036 refspec to be marked for merging in FETCH_HEAD. The value is1037 handled like the remote part of a refspec, and must match a1038 ref which is fetched from the remote given by1039 "branch.<name>.remote".1040 The merge information is used by 'git pull' (which at first calls1041 'git fetch') to lookup the default branch for merging. Without1042 this option, 'git pull' defaults to merge the first refspec fetched.1043 Specify multiple values to get an octopus merge.1044 If you wish to setup 'git pull' so that it merges into <name> from1045 another branch in the local repository, you can point1046 branch.<name>.merge to the desired branch, and use the relative path1047 setting `.` (a period) for branch.<name>.remote.10481049branch.<name>.mergeOptions::1050 Sets default options for merging into branch <name>. The syntax and1051 supported options are the same as those of linkgit:git-merge[1], but1052 option values containing whitespace characters are currently not1053 supported.10541055branch.<name>.rebase::1056 When true, rebase the branch <name> on top of the fetched branch,1057 instead of merging the default branch from the default remote when1058 "git pull" is run. See "pull.rebase" for doing this in a non1059 branch-specific manner.1060+1061When preserve, also pass `--preserve-merges` along to 'git rebase'1062so that locally committed merge commits will not be flattened1063by running 'git pull'.1064+1065When the value is `interactive`, the rebase is run in interactive mode.1066+1067*NOTE*: this is a possibly dangerous operation; do *not* use1068it unless you understand the implications (see linkgit:git-rebase[1]1069for details).10701071branch.<name>.description::1072 Branch description, can be edited with1073 `git branch --edit-description`. Branch description is1074 automatically added in the format-patch cover letter or1075 request-pull summary.10761077browser.<tool>.cmd::1078 Specify the command to invoke the specified browser. The1079 specified command is evaluated in shell with the URLs passed1080 as arguments. (See linkgit:git-web{litdd}browse[1].)10811082browser.<tool>.path::1083 Override the path for the given tool that may be used to1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1085 working repository in gitweb (see linkgit:git-instaweb[1]).10861087clean.requireForce::1088 A boolean to make git-clean do nothing unless given -f,1089 -i or -n. Defaults to true.10901091color.advice::1092 A boolean to enable/disable color in hints (e.g. when a push1093 failed, see `advice.*` for a list). May be set to `always`,1094 `false` (or `never`) or `auto` (or `true`), in which case colors1095 are used only when the error output goes to a terminal. If1096 unset, then the value of `color.ui` is used (`auto` by default).10971098color.advice.hint::1099 Use customized color for hints.11001101color.branch::1102 A boolean to enable/disable color in the output of1103 linkgit:git-branch[1]. May be set to `always`,1104 `false` (or `never`) or `auto` (or `true`), in which case colors are used1105 only when the output is to a terminal. If unset, then the1106 value of `color.ui` is used (`auto` by default).11071108color.branch.<slot>::1109 Use customized color for branch coloration. `<slot>` is one of1110 `current` (the current branch), `local` (a local branch),1111 `remote` (a remote-tracking branch in refs/remotes/),1112 `upstream` (upstream tracking branch), `plain` (other1113 refs).11141115color.diff::1116 Whether to use ANSI escape sequences to add color to patches.1117 If this is set to `always`, linkgit:git-diff[1],1118 linkgit:git-log[1], and linkgit:git-show[1] will use color1119 for all patches. If it is set to `true` or `auto`, those1120 commands will only use color when output is to the terminal.1121 If unset, then the value of `color.ui` is used (`auto` by1122 default).1123+1124This does not affect linkgit:git-format-patch[1] or the1125'git-diff-{asterisk}' plumbing commands. Can be overridden on the1126command line with the `--color[=<when>]` option.11271128diff.colorMoved::1129 If set to either a valid `<mode>` or a true value, moved lines1130 in a diff are colored differently, for details of valid modes1131 see '--color-moved' in linkgit:git-diff[1]. If simply set to1132 true the default color mode will be used. When set to false,1133 moved lines are not colored.11341135color.diff.<slot>::1136 Use customized color for diff colorization. `<slot>` specifies1137 which part of the patch to use the specified color, and is one1138 of `context` (context text - `plain` is a historical synonym),1139 `meta` (metainformation), `frag`1140 (hunk header), 'func' (function in hunk header), `old` (removed lines),1141 `new` (added lines), `commit` (commit headers), `whitespace`1142 (highlighting whitespace errors), `oldMoved` (deleted lines),1143 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1144 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1145 and `newMovedAlternativeDimmed` (See the '<mode>'1146 setting of '--color-moved' in linkgit:git-diff[1] for details).11471148color.decorate.<slot>::1149 Use customized color for 'git log --decorate' output. `<slot>` is one1150 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1151 branches, remote-tracking branches, tags, stash and HEAD, respectively.11521153color.grep::1154 When set to `always`, always highlight matches. When `false` (or1155 `never`), never. When set to `true` or `auto`, use color only1156 when the output is written to the terminal. If unset, then the1157 value of `color.ui` is used (`auto` by default).11581159color.grep.<slot>::1160 Use customized color for grep colorization. `<slot>` specifies which1161 part of the line to use the specified color, and is one of1162+1163--1164`context`;;1165 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1166`filename`;;1167 filename prefix (when not using `-h`)1168`function`;;1169 function name lines (when using `-p`)1170`linenumber`;;1171 line number prefix (when using `-n`)1172`match`;;1173 matching text (same as setting `matchContext` and `matchSelected`)1174`matchContext`;;1175 matching text in context lines1176`matchSelected`;;1177 matching text in selected lines1178`selected`;;1179 non-matching text in selected lines1180`separator`;;1181 separators between fields on a line (`:`, `-`, and `=`)1182 and between hunks (`--`)1183--11841185color.interactive::1186 When set to `always`, always use colors for interactive prompts1187 and displays (such as those used by "git-add --interactive" and1188 "git-clean --interactive"). When false (or `never`), never.1189 When set to `true` or `auto`, use colors only when the output is1190 to the terminal. If unset, then the value of `color.ui` is1191 used (`auto` by default).11921193color.interactive.<slot>::1194 Use customized color for 'git add --interactive' and 'git clean1195 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1196 or `error`, for four distinct types of normal output from1197 interactive commands.11981199color.pager::1200 A boolean to enable/disable colored output when the pager is in1201 use (default is true).12021203color.push::1204 A boolean to enable/disable color in push errors. May be set to1205 `always`, `false` (or `never`) or `auto` (or `true`), in which1206 case colors are used only when the error output goes to a terminal.1207 If unset, then the value of `color.ui` is used (`auto` by default).12081209color.push.error::1210 Use customized color for push errors.12111212color.showBranch::1213 A boolean to enable/disable color in the output of1214 linkgit:git-show-branch[1]. May be set to `always`,1215 `false` (or `never`) or `auto` (or `true`), in which case colors are used1216 only when the output is to a terminal. If unset, then the1217 value of `color.ui` is used (`auto` by default).12181219color.status::1220 A boolean to enable/disable color in the output of1221 linkgit:git-status[1]. May be set to `always`,1222 `false` (or `never`) or `auto` (or `true`), in which case colors are used1223 only when the output is to a terminal. If unset, then the1224 value of `color.ui` is used (`auto` by default).12251226color.status.<slot>::1227 Use customized color for status colorization. `<slot>` is1228 one of `header` (the header text of the status message),1229 `added` or `updated` (files which are added but not committed),1230 `changed` (files which are changed but not added in the index),1231 `untracked` (files which are not tracked by Git),1232 `branch` (the current branch),1233 `nobranch` (the color the 'no branch' warning is shown in, defaulting1234 to red),1235 `localBranch` or `remoteBranch` (the local and remote branch names,1236 respectively, when branch and tracking information is displayed in the1237 status short-format), or1238 `unmerged` (files which have unmerged changes).12391240color.transport::1241 A boolean to enable/disable color when pushes are rejected. May be1242 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1243 case colors are used only when the error output goes to a terminal.1244 If unset, then the value of `color.ui` is used (`auto` by default).12451246color.transport.rejected::1247 Use customized color when a push was rejected.12481249color.ui::1250 This variable determines the default value for variables such1251 as `color.diff` and `color.grep` that control the use of color1252 per command family. Its scope will expand as more commands learn1253 configuration to set a default for the `--color` option. Set it1254 to `false` or `never` if you prefer Git commands not to use1255 color unless enabled explicitly with some other configuration1256 or the `--color` option. Set it to `always` if you want all1257 output not intended for machine consumption to use color, to1258 `true` or `auto` (this is the default since Git 1.8.4) if you1259 want such output to use color when written to the terminal.12601261column.ui::1262 Specify whether supported commands should output in columns.1263 This variable consists of a list of tokens separated by spaces1264 or commas:1265+1266These options control when the feature should be enabled1267(defaults to 'never'):1268+1269--1270`always`;;1271 always show in columns1272`never`;;1273 never show in columns1274`auto`;;1275 show in columns if the output is to the terminal1276--1277+1278These options control layout (defaults to 'column'). Setting any1279of these implies 'always' if none of 'always', 'never', or 'auto' are1280specified.1281+1282--1283`column`;;1284 fill columns before rows1285`row`;;1286 fill rows before columns1287`plain`;;1288 show in one column1289--1290+1291Finally, these options can be combined with a layout option (defaults1292to 'nodense'):1293+1294--1295`dense`;;1296 make unequal size columns to utilize more space1297`nodense`;;1298 make equal size columns1299--13001301column.branch::1302 Specify whether to output branch listing in `git branch` in columns.1303 See `column.ui` for details.13041305column.clean::1306 Specify the layout when list items in `git clean -i`, which always1307 shows files and directories in columns. See `column.ui` for details.13081309column.status::1310 Specify whether to output untracked files in `git status` in columns.1311 See `column.ui` for details.13121313column.tag::1314 Specify whether to output tag listing in `git tag` in columns.1315 See `column.ui` for details.13161317commit.cleanup::1318 This setting overrides the default of the `--cleanup` option in1319 `git commit`. See linkgit:git-commit[1] for details. Changing the1320 default can be useful when you always want to keep lines that begin1321 with comment character `#` in your log message, in which case you1322 would do `git config commit.cleanup whitespace` (note that you will1323 have to remove the help lines that begin with `#` in the commit log1324 template yourself, if you do this).13251326commit.gpgSign::13271328 A boolean to specify whether all commits should be GPG signed.1329 Use of this option when doing operations such as rebase can1330 result in a large number of commits being signed. It may be1331 convenient to use an agent to avoid typing your GPG passphrase1332 several times.13331334commit.status::1335 A boolean to enable/disable inclusion of status information in the1336 commit message template when using an editor to prepare the commit1337 message. Defaults to true.13381339commit.template::1340 Specify the pathname of a file to use as the template for1341 new commit messages.13421343commit.verbose::1344 A boolean or int to specify the level of verbose with `git commit`.1345 See linkgit:git-commit[1].13461347credential.helper::1348 Specify an external helper to be called when a username or1349 password credential is needed; the helper may consult external1350 storage to avoid prompting the user for the credentials. Note1351 that multiple helpers may be defined. See linkgit:gitcredentials[7]1352 for details.13531354credential.useHttpPath::1355 When acquiring credentials, consider the "path" component of an http1356 or https URL to be important. Defaults to false. See1357 linkgit:gitcredentials[7] for more information.13581359credential.username::1360 If no username is set for a network authentication, use this username1361 by default. See credential.<context>.* below, and1362 linkgit:gitcredentials[7].13631364credential.<url>.*::1365 Any of the credential.* options above can be applied selectively to1366 some credentials. For example "credential.https://example.com.username"1367 would set the default username only for https connections to1368 example.com. See linkgit:gitcredentials[7] for details on how URLs are1369 matched.13701371credentialCache.ignoreSIGHUP::1372 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13731374include::diff-config.txt[]13751376difftool.<tool>.path::1377 Override the path for the given tool. This is useful in case1378 your tool is not in the PATH.13791380difftool.<tool>.cmd::1381 Specify the command to invoke the specified diff tool.1382 The specified command is evaluated in shell with the following1383 variables available: 'LOCAL' is set to the name of the temporary1384 file containing the contents of the diff pre-image and 'REMOTE'1385 is set to the name of the temporary file containing the contents1386 of the diff post-image.13871388difftool.prompt::1389 Prompt before each invocation of the diff tool.13901391fastimport.unpackLimit::1392 If the number of objects imported by linkgit:git-fast-import[1]1393 is below this limit, then the objects will be unpacked into1394 loose object files. However if the number of imported objects1395 equals or exceeds this limit then the pack will be stored as a1396 pack. Storing the pack from a fast-import can make the import1397 operation complete faster, especially on slow filesystems. If1398 not set, the value of `transfer.unpackLimit` is used instead.13991400fetch.recurseSubmodules::1401 This option can be either set to a boolean value or to 'on-demand'.1402 Setting it to a boolean changes the behavior of fetch and pull to1403 unconditionally recurse into submodules when set to true or to not1404 recurse at all when set to false. When set to 'on-demand' (the default1405 value), fetch and pull will only recurse into a populated submodule1406 when its superproject retrieves a commit that updates the submodule's1407 reference.14081409fetch.fsckObjects::1410 If it is set to true, git-fetch-pack will check all fetched1411 objects. It will abort in the case of a malformed object or a1412 broken link. The result of an abort are only dangling objects.1413 Defaults to false. If not set, the value of `transfer.fsckObjects`1414 is used instead.14151416fetch.unpackLimit::1417 If the number of objects fetched over the Git native1418 transfer is below this1419 limit, then the objects will be unpacked into loose object1420 files. However if the number of received objects equals or1421 exceeds this limit then the received pack will be stored as1422 a pack, after adding any missing delta bases. Storing the1423 pack from a push can make the push operation complete faster,1424 especially on slow filesystems. If not set, the value of1425 `transfer.unpackLimit` is used instead.14261427fetch.prune::1428 If true, fetch will automatically behave as if the `--prune`1429 option was given on the command line. See also `remote.<name>.prune`1430 and the PRUNING section of linkgit:git-fetch[1].14311432fetch.pruneTags::1433 If true, fetch will automatically behave as if the1434 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1435 if not set already. This allows for setting both this option1436 and `fetch.prune` to maintain a 1=1 mapping to upstream1437 refs. See also `remote.<name>.pruneTags` and the PRUNING1438 section of linkgit:git-fetch[1].14391440fetch.output::1441 Control how ref update status is printed. Valid values are1442 `full` and `compact`. Default value is `full`. See section1443 OUTPUT in linkgit:git-fetch[1] for detail.14441445format.attach::1446 Enable multipart/mixed attachments as the default for1447 'format-patch'. The value can also be a double quoted string1448 which will enable attachments as the default and set the1449 value as the boundary. See the --attach option in1450 linkgit:git-format-patch[1].14511452format.from::1453 Provides the default value for the `--from` option to format-patch.1454 Accepts a boolean value, or a name and email address. If false,1455 format-patch defaults to `--no-from`, using commit authors directly in1456 the "From:" field of patch mails. If true, format-patch defaults to1457 `--from`, using your committer identity in the "From:" field of patch1458 mails and including a "From:" field in the body of the patch mail if1459 different. If set to a non-boolean value, format-patch uses that1460 value instead of your committer identity. Defaults to false.14611462format.numbered::1463 A boolean which can enable or disable sequence numbers in patch1464 subjects. It defaults to "auto" which enables it only if there1465 is more than one patch. It can be enabled or disabled for all1466 messages by setting it to "true" or "false". See --numbered1467 option in linkgit:git-format-patch[1].14681469format.headers::1470 Additional email headers to include in a patch to be submitted1471 by mail. See linkgit:git-format-patch[1].14721473format.to::1474format.cc::1475 Additional recipients to include in a patch to be submitted1476 by mail. See the --to and --cc options in1477 linkgit:git-format-patch[1].14781479format.subjectPrefix::1480 The default for format-patch is to output files with the '[PATCH]'1481 subject prefix. Use this variable to change that prefix.14821483format.signature::1484 The default for format-patch is to output a signature containing1485 the Git version number. Use this variable to change that default.1486 Set this variable to the empty string ("") to suppress1487 signature generation.14881489format.signatureFile::1490 Works just like format.signature except the contents of the1491 file specified by this variable will be used as the signature.14921493format.suffix::1494 The default for format-patch is to output files with the suffix1495 `.patch`. Use this variable to change that suffix (make sure to1496 include the dot if you want it).14971498format.pretty::1499 The default pretty format for log/show/whatchanged command,1500 See linkgit:git-log[1], linkgit:git-show[1],1501 linkgit:git-whatchanged[1].15021503format.thread::1504 The default threading style for 'git format-patch'. Can be1505 a boolean value, or `shallow` or `deep`. `shallow` threading1506 makes every mail a reply to the head of the series,1507 where the head is chosen from the cover letter, the1508 `--in-reply-to`, and the first patch mail, in this order.1509 `deep` threading makes every mail a reply to the previous one.1510 A true boolean value is the same as `shallow`, and a false1511 value disables threading.15121513format.signOff::1514 A boolean value which lets you enable the `-s/--signoff` option of1515 format-patch by default. *Note:* Adding the Signed-off-by: line to a1516 patch should be a conscious act and means that you certify you have1517 the rights to submit this work under the same open source license.1518 Please see the 'SubmittingPatches' document for further discussion.15191520format.coverLetter::1521 A boolean that controls whether to generate a cover-letter when1522 format-patch is invoked, but in addition can be set to "auto", to1523 generate a cover-letter only when there's more than one patch.15241525format.outputDirectory::1526 Set a custom directory to store the resulting files instead of the1527 current working directory.15281529format.useAutoBase::1530 A boolean value which lets you enable the `--base=auto` option of1531 format-patch by default.15321533filter.<driver>.clean::1534 The command which is used to convert the content of a worktree1535 file to a blob upon checkin. See linkgit:gitattributes[5] for1536 details.15371538filter.<driver>.smudge::1539 The command which is used to convert the content of a blob1540 object to a worktree file upon checkout. See1541 linkgit:gitattributes[5] for details.15421543fsck.<msg-id>::1544 Allows overriding the message type (error, warn or ignore) of a1545 specific message ID such as `missingEmail`.1546+1547For convenience, fsck prefixes the error/warning with the message ID,1548e.g. "missingEmail: invalid author/committer line - missing email" means1549that setting `fsck.missingEmail = ignore` will hide that issue.1550+1551This feature is intended to support working with legacy repositories1552which cannot be repaired without disruptive changes.15531554fsck.skipList::1555 The path to a sorted list of object names (i.e. one SHA-1 per1556 line) that are known to be broken in a non-fatal way and should1557 be ignored. This feature is useful when an established project1558 should be accepted despite early commits containing errors that1559 can be safely ignored such as invalid committer email addresses.1560 Note: corrupt objects cannot be skipped with this setting.15611562gc.aggressiveDepth::1563 The depth parameter used in the delta compression1564 algorithm used by 'git gc --aggressive'. This defaults1565 to 50.15661567gc.aggressiveWindow::1568 The window size parameter used in the delta compression1569 algorithm used by 'git gc --aggressive'. This defaults1570 to 250.15711572gc.auto::1573 When there are approximately more than this many loose1574 objects in the repository, `git gc --auto` will pack them.1575 Some Porcelain commands use this command to perform a1576 light-weight garbage collection from time to time. The1577 default value is 6700. Setting this to 0 disables it.15781579gc.autoPackLimit::1580 When there are more than this many packs that are not1581 marked with `*.keep` file in the repository, `git gc1582 --auto` consolidates them into one larger pack. The1583 default value is 50. Setting this to 0 disables it.15841585gc.autoDetach::1586 Make `git gc --auto` return immediately and run in background1587 if the system supports it. Default is true.15881589gc.logExpiry::1590 If the file gc.log exists, then `git gc --auto` won't run1591 unless that file is more than 'gc.logExpiry' old. Default is1592 "1.day". See `gc.pruneExpire` for more ways to specify its1593 value.15941595gc.packRefs::1596 Running `git pack-refs` in a repository renders it1597 unclonable by Git versions prior to 1.5.1.2 over dumb1598 transports such as HTTP. This variable determines whether1599 'git gc' runs `git pack-refs`. This can be set to `notbare`1600 to enable it within all non-bare repos or it can be set to a1601 boolean value. The default is `true`.16021603gc.pruneExpire::1604 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1605 Override the grace period with this config variable. The value1606 "now" may be used to disable this grace period and always prune1607 unreachable objects immediately, or "never" may be used to1608 suppress pruning. This feature helps prevent corruption when1609 'git gc' runs concurrently with another process writing to the1610 repository; see the "NOTES" section of linkgit:git-gc[1].16111612gc.worktreePruneExpire::1613 When 'git gc' is run, it calls1614 'git worktree prune --expire 3.months.ago'.1615 This config variable can be used to set a different grace1616 period. The value "now" may be used to disable the grace1617 period and prune `$GIT_DIR/worktrees` immediately, or "never"1618 may be used to suppress pruning.16191620gc.reflogExpire::1621gc.<pattern>.reflogExpire::1622 'git reflog expire' removes reflog entries older than1623 this time; defaults to 90 days. The value "now" expires all1624 entries immediately, and "never" suppresses expiration1625 altogether. With "<pattern>" (e.g.1626 "refs/stash") in the middle the setting applies only to1627 the refs that match the <pattern>.16281629gc.reflogExpireUnreachable::1630gc.<pattern>.reflogExpireUnreachable::1631 'git reflog expire' removes reflog entries older than1632 this time and are not reachable from the current tip;1633 defaults to 30 days. The value "now" expires all entries1634 immediately, and "never" suppresses expiration altogether.1635 With "<pattern>" (e.g. "refs/stash")1636 in the middle, the setting applies only to the refs that1637 match the <pattern>.16381639gc.rerereResolved::1640 Records of conflicted merge you resolved earlier are1641 kept for this many days when 'git rerere gc' is run.1642 You can also use more human-readable "1.month.ago", etc.1643 The default is 60 days. See linkgit:git-rerere[1].16441645gc.rerereUnresolved::1646 Records of conflicted merge you have not resolved are1647 kept for this many days when 'git rerere gc' is run.1648 You can also use more human-readable "1.month.ago", etc.1649 The default is 15 days. See linkgit:git-rerere[1].16501651gitcvs.commitMsgAnnotation::1652 Append this string to each commit message. Set to empty string1653 to disable this feature. Defaults to "via git-CVS emulator".16541655gitcvs.enabled::1656 Whether the CVS server interface is enabled for this repository.1657 See linkgit:git-cvsserver[1].16581659gitcvs.logFile::1660 Path to a log file where the CVS server interface well... logs1661 various stuff. See linkgit:git-cvsserver[1].16621663gitcvs.usecrlfattr::1664 If true, the server will look up the end-of-line conversion1665 attributes for files to determine the `-k` modes to use. If1666 the attributes force Git to treat a file as text,1667 the `-k` mode will be left blank so CVS clients will1668 treat it as text. If they suppress text conversion, the file1669 will be set with '-kb' mode, which suppresses any newline munging1670 the client might otherwise do. If the attributes do not allow1671 the file type to be determined, then `gitcvs.allBinary` is1672 used. See linkgit:gitattributes[5].16731674gitcvs.allBinary::1675 This is used if `gitcvs.usecrlfattr` does not resolve1676 the correct '-kb' mode to use. If true, all1677 unresolved files are sent to the client in1678 mode '-kb'. This causes the client to treat them1679 as binary files, which suppresses any newline munging it1680 otherwise might do. Alternatively, if it is set to "guess",1681 then the contents of the file are examined to decide if1682 it is binary, similar to `core.autocrlf`.16831684gitcvs.dbName::1685 Database used by git-cvsserver to cache revision information1686 derived from the Git repository. The exact meaning depends on the1687 used database driver, for SQLite (which is the default driver) this1688 is a filename. Supports variable substitution (see1689 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1690 Default: '%Ggitcvs.%m.sqlite'16911692gitcvs.dbDriver::1693 Used Perl DBI driver. You can specify any available driver1694 for this here, but it might not work. git-cvsserver is tested1695 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1696 reported *not* to work with 'DBD::mysql'. Experimental feature.1697 May not contain double colons (`:`). Default: 'SQLite'.1698 See linkgit:git-cvsserver[1].16991700gitcvs.dbUser, gitcvs.dbPass::1701 Database user and password. Only useful if setting `gitcvs.dbDriver`,1702 since SQLite has no concept of database users and/or passwords.1703 'gitcvs.dbUser' supports variable substitution (see1704 linkgit:git-cvsserver[1] for details).17051706gitcvs.dbTableNamePrefix::1707 Database table name prefix. Prepended to the names of any1708 database tables used, allowing a single database to be used1709 for several repositories. Supports variable substitution (see1710 linkgit:git-cvsserver[1] for details). Any non-alphabetic1711 characters will be replaced with underscores.17121713All gitcvs variables except for `gitcvs.usecrlfattr` and1714`gitcvs.allBinary` can also be specified as1715'gitcvs.<access_method>.<varname>' (where 'access_method'1716is one of "ext" and "pserver") to make them apply only for the given1717access method.17181719gitweb.category::1720gitweb.description::1721gitweb.owner::1722gitweb.url::1723 See linkgit:gitweb[1] for description.17241725gitweb.avatar::1726gitweb.blame::1727gitweb.grep::1728gitweb.highlight::1729gitweb.patches::1730gitweb.pickaxe::1731gitweb.remote_heads::1732gitweb.showSizes::1733gitweb.snapshot::1734 See linkgit:gitweb.conf[5] for description.17351736grep.lineNumber::1737 If set to true, enable `-n` option by default.17381739grep.patternType::1740 Set the default matching behavior. Using a value of 'basic', 'extended',1741 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1742 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1743 value 'default' will return to the default matching behavior.17441745grep.extendedRegexp::1746 If set to true, enable `--extended-regexp` option by default. This1747 option is ignored when the `grep.patternType` option is set to a value1748 other than 'default'.17491750grep.threads::1751 Number of grep worker threads to use.1752 See `grep.threads` in linkgit:git-grep[1] for more information.17531754grep.fallbackToNoIndex::1755 If set to true, fall back to git grep --no-index if git grep1756 is executed outside of a git repository. Defaults to false.17571758gpg.program::1759 Use this custom program instead of "`gpg`" found on `$PATH` when1760 making or verifying a PGP signature. The program must support the1761 same command-line interface as GPG, namely, to verify a detached1762 signature, "`gpg --verify $file - <$signature`" is run, and the1763 program is expected to signal a good signature by exiting with1764 code 0, and to generate an ASCII-armored detached signature, the1765 standard input of "`gpg -bsau $key`" is fed with the contents to be1766 signed, and the program is expected to send the result to its1767 standard output.17681769gui.commitMsgWidth::1770 Defines how wide the commit message window is in the1771 linkgit:git-gui[1]. "75" is the default.17721773gui.diffContext::1774 Specifies how many context lines should be used in calls to diff1775 made by the linkgit:git-gui[1]. The default is "5".17761777gui.displayUntracked::1778 Determines if linkgit:git-gui[1] shows untracked files1779 in the file list. The default is "true".17801781gui.encoding::1782 Specifies the default encoding to use for displaying of1783 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1784 It can be overridden by setting the 'encoding' attribute1785 for relevant files (see linkgit:gitattributes[5]).1786 If this option is not set, the tools default to the1787 locale encoding.17881789gui.matchTrackingBranch::1790 Determines if new branches created with linkgit:git-gui[1] should1791 default to tracking remote branches with matching names or1792 not. Default: "false".17931794gui.newBranchTemplate::1795 Is used as suggested name when creating new branches using the1796 linkgit:git-gui[1].17971798gui.pruneDuringFetch::1799 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1800 performing a fetch. The default value is "false".18011802gui.trustmtime::1803 Determines if linkgit:git-gui[1] should trust the file modification1804 timestamp or not. By default the timestamps are not trusted.18051806gui.spellingDictionary::1807 Specifies the dictionary used for spell checking commit messages in1808 the linkgit:git-gui[1]. When set to "none" spell checking is turned1809 off.18101811gui.fastCopyBlame::1812 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1813 location detection. It makes blame significantly faster on huge1814 repositories at the expense of less thorough copy detection.18151816gui.copyBlameThreshold::1817 Specifies the threshold to use in 'git gui blame' original location1818 detection, measured in alphanumeric characters. See the1819 linkgit:git-blame[1] manual for more information on copy detection.18201821gui.blamehistoryctx::1822 Specifies the radius of history context in days to show in1823 linkgit:gitk[1] for the selected commit, when the `Show History1824 Context` menu item is invoked from 'git gui blame'. If this1825 variable is set to zero, the whole history is shown.18261827guitool.<name>.cmd::1828 Specifies the shell command line to execute when the corresponding item1829 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1830 mandatory for every tool. The command is executed from the root of1831 the working directory, and in the environment it receives the name of1832 the tool as `GIT_GUITOOL`, the name of the currently selected file as1833 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1834 the head is detached, 'CUR_BRANCH' is empty).18351836guitool.<name>.needsFile::1837 Run the tool only if a diff is selected in the GUI. It guarantees1838 that 'FILENAME' is not empty.18391840guitool.<name>.noConsole::1841 Run the command silently, without creating a window to display its1842 output.18431844guitool.<name>.noRescan::1845 Don't rescan the working directory for changes after the tool1846 finishes execution.18471848guitool.<name>.confirm::1849 Show a confirmation dialog before actually running the tool.18501851guitool.<name>.argPrompt::1852 Request a string argument from the user, and pass it to the tool1853 through the `ARGS` environment variable. Since requesting an1854 argument implies confirmation, the 'confirm' option has no effect1855 if this is enabled. If the option is set to 'true', 'yes', or '1',1856 the dialog uses a built-in generic prompt; otherwise the exact1857 value of the variable is used.18581859guitool.<name>.revPrompt::1860 Request a single valid revision from the user, and set the1861 `REVISION` environment variable. In other aspects this option1862 is similar to 'argPrompt', and can be used together with it.18631864guitool.<name>.revUnmerged::1865 Show only unmerged branches in the 'revPrompt' subdialog.1866 This is useful for tools similar to merge or rebase, but not1867 for things like checkout or reset.18681869guitool.<name>.title::1870 Specifies the title to use for the prompt dialog. The default1871 is the tool name.18721873guitool.<name>.prompt::1874 Specifies the general prompt string to display at the top of1875 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1876 The default value includes the actual command.18771878help.browser::1879 Specify the browser that will be used to display help in the1880 'web' format. See linkgit:git-help[1].18811882help.format::1883 Override the default help format used by linkgit:git-help[1].1884 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1885 the default. 'web' and 'html' are the same.18861887help.autoCorrect::1888 Automatically correct and execute mistyped commands after1889 waiting for the given number of deciseconds (0.1 sec). If more1890 than one command can be deduced from the entered text, nothing1891 will be executed. If the value of this option is negative,1892 the corrected command will be executed immediately. If the1893 value is 0 - the command will be just shown but not executed.1894 This is the default.18951896help.htmlPath::1897 Specify the path where the HTML documentation resides. File system paths1898 and URLs are supported. HTML pages will be prefixed with this path when1899 help is displayed in the 'web' format. This defaults to the documentation1900 path of your Git installation.19011902http.proxy::1903 Override the HTTP proxy, normally configured using the 'http_proxy',1904 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1905 addition to the syntax understood by curl, it is possible to specify a1906 proxy string with a user name but no password, in which case git will1907 attempt to acquire one in the same way it does for other credentials. See1908 linkgit:gitcredentials[7] for more information. The syntax thus is1909 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1910 on a per-remote basis; see remote.<name>.proxy19111912http.proxyAuthMethod::1913 Set the method with which to authenticate against the HTTP proxy. This1914 only takes effect if the configured proxy string contains a user name part1915 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1916 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1917 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1918 variable. Possible values are:1919+1920--1921* `anyauth` - Automatically pick a suitable authentication method. It is1922 assumed that the proxy answers an unauthenticated request with a 4071923 status code and one or more Proxy-authenticate headers with supported1924 authentication methods. This is the default.1925* `basic` - HTTP Basic authentication1926* `digest` - HTTP Digest authentication; this prevents the password from being1927 transmitted to the proxy in clear text1928* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1929 of `curl(1)`)1930* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1931--19321933http.emptyAuth::1934 Attempt authentication without seeking a username or password. This1935 can be used to attempt GSS-Negotiate authentication without specifying1936 a username in the URL, as libcurl normally requires a username for1937 authentication.19381939http.delegation::1940 Control GSSAPI credential delegation. The delegation is disabled1941 by default in libcurl since version 7.21.7. Set parameter to tell1942 the server what it is allowed to delegate when it comes to user1943 credentials. Used with GSS/kerberos. Possible values are:1944+1945--1946* `none` - Don't allow any delegation.1947* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1948 Kerberos service ticket, which is a matter of realm policy.1949* `always` - Unconditionally allow the server to delegate.1950--195119521953http.extraHeader::1954 Pass an additional HTTP header when communicating with a server. If1955 more than one such entry exists, all of them are added as extra1956 headers. To allow overriding the settings inherited from the system1957 config, an empty value will reset the extra headers to the empty list.19581959http.cookieFile::1960 The pathname of a file containing previously stored cookie lines,1961 which should be used1962 in the Git http session, if they match the server. The file format1963 of the file to read cookies from should be plain HTTP headers or1964 the Netscape/Mozilla cookie file format (see `curl(1)`).1965 NOTE that the file specified with http.cookieFile is used only as1966 input unless http.saveCookies is set.19671968http.saveCookies::1969 If set, store cookies received during requests to the file specified by1970 http.cookieFile. Has no effect if http.cookieFile is unset.19711972http.sslVersion::1973 The SSL version to use when negotiating an SSL connection, if you1974 want to force the default. The available and default version1975 depend on whether libcurl was built against NSS or OpenSSL and the1976 particular configuration of the crypto library in use. Internally1977 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1978 documentation for more details on the format of this option and1979 for the ssl version supported. Actually the possible values of1980 this option are:19811982 - sslv21983 - sslv31984 - tlsv11985 - tlsv1.01986 - tlsv1.11987 - tlsv1.21988 - tlsv1.319891990+1991Can be overridden by the `GIT_SSL_VERSION` environment variable.1992To force git to use libcurl's default ssl version and ignore any1993explicit http.sslversion option, set `GIT_SSL_VERSION` to the1994empty string.19951996http.sslCipherList::1997 A list of SSL ciphers to use when negotiating an SSL connection.1998 The available ciphers depend on whether libcurl was built against1999 NSS or OpenSSL and the particular configuration of the crypto2000 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2001 option; see the libcurl documentation for more details on the format2002 of this list.2003+2004Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2005To force git to use libcurl's default cipher list and ignore any2006explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2007empty string.20082009http.sslVerify::2010 Whether to verify the SSL certificate when fetching or pushing2011 over HTTPS. Defaults to true. Can be overridden by the2012 `GIT_SSL_NO_VERIFY` environment variable.20132014http.sslCert::2015 File containing the SSL certificate when fetching or pushing2016 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2017 variable.20182019http.sslKey::2020 File containing the SSL private key when fetching or pushing2021 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2022 variable.20232024http.sslCertPasswordProtected::2025 Enable Git's password prompt for the SSL certificate. Otherwise2026 OpenSSL will prompt the user, possibly many times, if the2027 certificate or private key is encrypted. Can be overridden by the2028 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20292030http.sslCAInfo::2031 File containing the certificates to verify the peer with when2032 fetching or pushing over HTTPS. Can be overridden by the2033 `GIT_SSL_CAINFO` environment variable.20342035http.sslCAPath::2036 Path containing files with the CA certificates to verify the peer2037 with when fetching or pushing over HTTPS. Can be overridden2038 by the `GIT_SSL_CAPATH` environment variable.20392040http.pinnedpubkey::2041 Public key of the https service. It may either be the filename of2042 a PEM or DER encoded public key file or a string starting with2043 'sha256//' followed by the base64 encoded sha256 hash of the2044 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2045 exit with an error if this option is set but not supported by2046 cURL.20472048http.sslTry::2049 Attempt to use AUTH SSL/TLS and encrypted data transfers2050 when connecting via regular FTP protocol. This might be needed2051 if the FTP server requires it for security reasons or you wish2052 to connect securely whenever remote FTP server supports it.2053 Default is false since it might trigger certificate verification2054 errors on misconfigured servers.20552056http.maxRequests::2057 How many HTTP requests to launch in parallel. Can be overridden2058 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20592060http.minSessions::2061 The number of curl sessions (counted across slots) to be kept across2062 requests. They will not be ended with curl_easy_cleanup() until2063 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2064 value will be capped at 1. Defaults to 1.20652066http.postBuffer::2067 Maximum size in bytes of the buffer used by smart HTTP2068 transports when POSTing data to the remote system.2069 For requests larger than this buffer size, HTTP/1.1 and2070 Transfer-Encoding: chunked is used to avoid creating a2071 massive pack file locally. Default is 1 MiB, which is2072 sufficient for most requests.20732074http.lowSpeedLimit, http.lowSpeedTime::2075 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2076 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2077 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2078 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20792080http.noEPSV::2081 A boolean which disables using of EPSV ftp command by curl.2082 This can helpful with some "poor" ftp servers which don't2083 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2084 environment variable. Default is false (curl will use EPSV).20852086http.userAgent::2087 The HTTP USER_AGENT string presented to an HTTP server. The default2088 value represents the version of the client Git such as git/1.7.1.2089 This option allows you to override this value to a more common value2090 such as Mozilla/4.0. This may be necessary, for instance, if2091 connecting through a firewall that restricts HTTP connections to a set2092 of common USER_AGENT strings (but not including those like git/1.7.1).2093 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20942095http.followRedirects::2096 Whether git should follow HTTP redirects. If set to `true`, git2097 will transparently follow any redirect issued by a server it2098 encounters. If set to `false`, git will treat all redirects as2099 errors. If set to `initial`, git will follow redirects only for2100 the initial request to a remote, but not for subsequent2101 follow-up HTTP requests. Since git uses the redirected URL as2102 the base for the follow-up requests, this is generally2103 sufficient. The default is `initial`.21042105http.<url>.*::2106 Any of the http.* options above can be applied selectively to some URLs.2107 For a config key to match a URL, each element of the config key is2108 compared to that of the URL, in the following order:2109+2110--2111. Scheme (e.g., `https` in `https://example.com/`). This field2112 must match exactly between the config key and the URL.21132114. Host/domain name (e.g., `example.com` in `https://example.com/`).2115 This field must match between the config key and the URL. It is2116 possible to specify a `*` as part of the host name to match all subdomains2117 at this level. `https://*.example.com/` for example would match2118 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.21192120. Port number (e.g., `8080` in `http://example.com:8080/`).2121 This field must match exactly between the config key and the URL.2122 Omitted port numbers are automatically converted to the correct2123 default for the scheme before matching.21242125. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2126 path field of the config key must match the path field of the URL2127 either exactly or as a prefix of slash-delimited path elements. This means2128 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2129 match on a slash (`/`) boundary. Longer matches take precedence (so a config2130 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2131 key with just path `foo/`).21322133. User name (e.g., `user` in `https://user@example.com/repo.git`). If2134 the config key has a user name it must match the user name in the2135 URL exactly. If the config key does not have a user name, that2136 config key will match a URL with any user name (including none),2137 but at a lower precedence than a config key with a user name.2138--2139+2140The list above is ordered by decreasing precedence; a URL that matches2141a config key's path is preferred to one that matches its user name. For example,2142if the URL is `https://user@example.com/foo/bar` a config key match of2143`https://example.com/foo` will be preferred over a config key match of2144`https://user@example.com`.2145+2146All URLs are normalized before attempting any matching (the password part,2147if embedded in the URL, is always ignored for matching purposes) so that2148equivalent URLs that are simply spelled differently will match properly.2149Environment variable settings always override any matches. The URLs that are2150matched against are those given directly to Git commands. This means any URLs2151visited as a result of a redirection do not participate in matching.21522153ssh.variant::2154 By default, Git determines the command line arguments to use2155 based on the basename of the configured SSH command (configured2156 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2157 the config setting `core.sshCommand`). If the basename is2158 unrecognized, Git will attempt to detect support of OpenSSH2159 options by first invoking the configured SSH command with the2160 `-G` (print configuration) option and will subsequently use2161 OpenSSH options (if that is successful) or no options besides2162 the host and remote command (if it fails).2163+2164The config variable `ssh.variant` can be set to override this detection.2165Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2166`tortoiseplink`, `simple` (no options except the host and remote command).2167The default auto-detection can be explicitly requested using the value2168`auto`. Any other value is treated as `ssh`. This setting can also be2169overridden via the environment variable `GIT_SSH_VARIANT`.2170+2171The current command-line parameters used for each variant are as2172follows:2173+2174--21752176* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21772178* `simple` - [username@]host command21792180* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21812182* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21832184--2185+2186Except for the `simple` variant, command-line parameters are likely to2187change as git gains new features.21882189i18n.commitEncoding::2190 Character encoding the commit messages are stored in; Git itself2191 does not care per se, but this information is necessary e.g. when2192 importing commits from emails or in the gitk graphical history2193 browser (and possibly at other places in the future or in other2194 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21952196i18n.logOutputEncoding::2197 Character encoding the commit messages are converted to when2198 running 'git log' and friends.21992200imap::2201 The configuration variables in the 'imap' section are described2202 in linkgit:git-imap-send[1].22032204index.version::2205 Specify the version with which new index files should be2206 initialized. This does not affect existing repositories.22072208init.templateDir::2209 Specify the directory from which templates will be copied.2210 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)22112212instaweb.browser::2213 Specify the program that will be used to browse your working2214 repository in gitweb. See linkgit:git-instaweb[1].22152216instaweb.httpd::2217 The HTTP daemon command-line to start gitweb on your working2218 repository. See linkgit:git-instaweb[1].22192220instaweb.local::2221 If true the web server started by linkgit:git-instaweb[1] will2222 be bound to the local IP (127.0.0.1).22232224instaweb.modulePath::2225 The default module path for linkgit:git-instaweb[1] to use2226 instead of /usr/lib/apache2/modules. Only used if httpd2227 is Apache.22282229instaweb.port::2230 The port number to bind the gitweb httpd to. See2231 linkgit:git-instaweb[1].22322233interactive.singleKey::2234 In interactive commands, allow the user to provide one-letter2235 input with a single key (i.e., without hitting enter).2236 Currently this is used by the `--patch` mode of2237 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2238 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2239 setting is silently ignored if portable keystroke input2240 is not available; requires the Perl module Term::ReadKey.22412242interactive.diffFilter::2243 When an interactive command (such as `git add --patch`) shows2244 a colorized diff, git will pipe the diff through the shell2245 command defined by this configuration variable. The command may2246 mark up the diff further for human consumption, provided that it2247 retains a one-to-one correspondence with the lines in the2248 original diff. Defaults to disabled (no filtering).22492250log.abbrevCommit::2251 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2252 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2253 override this option with `--no-abbrev-commit`.22542255log.date::2256 Set the default date-time mode for the 'log' command.2257 Setting a value for log.date is similar to using 'git log''s2258 `--date` option. See linkgit:git-log[1] for details.22592260log.decorate::2261 Print out the ref names of any commits that are shown by the log2262 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2263 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2264 specified, the full ref name (including prefix) will be printed.2265 If 'auto' is specified, then if the output is going to a terminal,2266 the ref names are shown as if 'short' were given, otherwise no ref2267 names are shown. This is the same as the `--decorate` option2268 of the `git log`.22692270log.follow::2271 If `true`, `git log` will act as if the `--follow` option was used when2272 a single <path> is given. This has the same limitations as `--follow`,2273 i.e. it cannot be used to follow multiple files and does not work well2274 on non-linear history.22752276log.graphColors::2277 A list of colors, separated by commas, that can be used to draw2278 history lines in `git log --graph`.22792280log.showRoot::2281 If true, the initial commit will be shown as a big creation event.2282 This is equivalent to a diff against an empty tree.2283 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2284 normally hide the root commit will now show it. True by default.22852286log.showSignature::2287 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2288 linkgit:git-whatchanged[1] assume `--show-signature`.22892290log.mailmap::2291 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2292 linkgit:git-whatchanged[1] assume `--use-mailmap`.22932294mailinfo.scissors::2295 If true, makes linkgit:git-mailinfo[1] (and therefore2296 linkgit:git-am[1]) act by default as if the --scissors option2297 was provided on the command-line. When active, this features2298 removes everything from the message body before a scissors2299 line (i.e. consisting mainly of ">8", "8<" and "-").23002301mailmap.file::2302 The location of an augmenting mailmap file. The default2303 mailmap, located in the root of the repository, is loaded2304 first, then the mailmap file pointed to by this variable.2305 The location of the mailmap file may be in a repository2306 subdirectory, or somewhere outside of the repository itself.2307 See linkgit:git-shortlog[1] and linkgit:git-blame[1].23082309mailmap.blob::2310 Like `mailmap.file`, but consider the value as a reference to a2311 blob in the repository. If both `mailmap.file` and2312 `mailmap.blob` are given, both are parsed, with entries from2313 `mailmap.file` taking precedence. In a bare repository, this2314 defaults to `HEAD:.mailmap`. In a non-bare repository, it2315 defaults to empty.23162317man.viewer::2318 Specify the programs that may be used to display help in the2319 'man' format. See linkgit:git-help[1].23202321man.<tool>.cmd::2322 Specify the command to invoke the specified man viewer. The2323 specified command is evaluated in shell with the man page2324 passed as argument. (See linkgit:git-help[1].)23252326man.<tool>.path::2327 Override the path for the given tool that may be used to2328 display help in the 'man' format. See linkgit:git-help[1].23292330include::merge-config.txt[]23312332mergetool.<tool>.path::2333 Override the path for the given tool. This is useful in case2334 your tool is not in the PATH.23352336mergetool.<tool>.cmd::2337 Specify the command to invoke the specified merge tool. The2338 specified command is evaluated in shell with the following2339 variables available: 'BASE' is the name of a temporary file2340 containing the common base of the files to be merged, if available;2341 'LOCAL' is the name of a temporary file containing the contents of2342 the file on the current branch; 'REMOTE' is the name of a temporary2343 file containing the contents of the file from the branch being2344 merged; 'MERGED' contains the name of the file to which the merge2345 tool should write the results of a successful merge.23462347mergetool.<tool>.trustExitCode::2348 For a custom merge command, specify whether the exit code of2349 the merge command can be used to determine whether the merge was2350 successful. If this is not set to true then the merge target file2351 timestamp is checked and the merge assumed to have been successful2352 if the file has been updated, otherwise the user is prompted to2353 indicate the success of the merge.23542355mergetool.meld.hasOutput::2356 Older versions of `meld` do not support the `--output` option.2357 Git will attempt to detect whether `meld` supports `--output`2358 by inspecting the output of `meld --help`. Configuring2359 `mergetool.meld.hasOutput` will make Git skip these checks and2360 use the configured value instead. Setting `mergetool.meld.hasOutput`2361 to `true` tells Git to unconditionally use the `--output` option,2362 and `false` avoids using `--output`.23632364mergetool.keepBackup::2365 After performing a merge, the original file with conflict markers2366 can be saved as a file with a `.orig` extension. If this variable2367 is set to `false` then this file is not preserved. Defaults to2368 `true` (i.e. keep the backup files).23692370mergetool.keepTemporaries::2371 When invoking a custom merge tool, Git uses a set of temporary2372 files to pass to the tool. If the tool returns an error and this2373 variable is set to `true`, then these temporary files will be2374 preserved, otherwise they will be removed after the tool has2375 exited. Defaults to `false`.23762377mergetool.writeToTemp::2378 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2379 conflicting files in the worktree by default. Git will attempt2380 to use a temporary directory for these files when set `true`.2381 Defaults to `false`.23822383mergetool.prompt::2384 Prompt before each invocation of the merge resolution program.23852386notes.mergeStrategy::2387 Which merge strategy to choose by default when resolving notes2388 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2389 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2390 section of linkgit:git-notes[1] for more information on each strategy.23912392notes.<name>.mergeStrategy::2393 Which merge strategy to choose when doing a notes merge into2394 refs/notes/<name>. This overrides the more general2395 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2396 linkgit:git-notes[1] for more information on the available strategies.23972398notes.displayRef::2399 The (fully qualified) refname from which to show notes when2400 showing commit messages. The value of this variable can be set2401 to a glob, in which case notes from all matching refs will be2402 shown. You may also specify this configuration variable2403 several times. A warning will be issued for refs that do not2404 exist, but a glob that does not match any refs is silently2405 ignored.2406+2407This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2408environment variable, which must be a colon separated list of refs or2409globs.2410+2411The effective value of "core.notesRef" (possibly overridden by2412GIT_NOTES_REF) is also implicitly added to the list of refs to be2413displayed.24142415notes.rewrite.<command>::2416 When rewriting commits with <command> (currently `amend` or2417 `rebase`) and this variable is set to `true`, Git2418 automatically copies your notes from the original to the2419 rewritten commit. Defaults to `true`, but see2420 "notes.rewriteRef" below.24212422notes.rewriteMode::2423 When copying notes during a rewrite (see the2424 "notes.rewrite.<command>" option), determines what to do if2425 the target commit already has a note. Must be one of2426 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2427 Defaults to `concatenate`.2428+2429This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2430environment variable.24312432notes.rewriteRef::2433 When copying notes during a rewrite, specifies the (fully2434 qualified) ref whose notes should be copied. The ref may be a2435 glob, in which case notes in all matching refs will be copied.2436 You may also specify this configuration several times.2437+2438Does not have a default value; you must configure this variable to2439enable note rewriting. Set it to `refs/notes/commits` to enable2440rewriting for the default commit notes.2441+2442This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2443environment variable, which must be a colon separated list of refs or2444globs.24452446pack.window::2447 The size of the window used by linkgit:git-pack-objects[1] when no2448 window size is given on the command line. Defaults to 10.24492450pack.depth::2451 The maximum delta depth used by linkgit:git-pack-objects[1] when no2452 maximum depth is given on the command line. Defaults to 50.24532454pack.windowMemory::2455 The maximum size of memory that is consumed by each thread2456 in linkgit:git-pack-objects[1] for pack window memory when2457 no limit is given on the command line. The value can be2458 suffixed with "k", "m", or "g". When left unconfigured (or2459 set explicitly to 0), there will be no limit.24602461pack.compression::2462 An integer -1..9, indicating the compression level for objects2463 in a pack file. -1 is the zlib default. 0 means no2464 compression, and 1..9 are various speed/size tradeoffs, 9 being2465 slowest. If not set, defaults to core.compression. If that is2466 not set, defaults to -1, the zlib default, which is "a default2467 compromise between speed and compression (currently equivalent2468 to level 6)."2469+2470Note that changing the compression level will not automatically recompress2471all existing objects. You can force recompression by passing the -F option2472to linkgit:git-repack[1].24732474pack.deltaCacheSize::2475 The maximum memory in bytes used for caching deltas in2476 linkgit:git-pack-objects[1] before writing them out to a pack.2477 This cache is used to speed up the writing object phase by not2478 having to recompute the final delta result once the best match2479 for all objects is found. Repacking large repositories on machines2480 which are tight with memory might be badly impacted by this though,2481 especially if this cache pushes the system into swapping.2482 A value of 0 means no limit. The smallest size of 1 byte may be2483 used to virtually disable this cache. Defaults to 256 MiB.24842485pack.deltaCacheLimit::2486 The maximum size of a delta, that is cached in2487 linkgit:git-pack-objects[1]. This cache is used to speed up the2488 writing object phase by not having to recompute the final delta2489 result once the best match for all objects is found. Defaults to 1000.24902491pack.threads::2492 Specifies the number of threads to spawn when searching for best2493 delta matches. This requires that linkgit:git-pack-objects[1]2494 be compiled with pthreads otherwise this option is ignored with a2495 warning. This is meant to reduce packing time on multiprocessor2496 machines. The required amount of memory for the delta search window2497 is however multiplied by the number of threads.2498 Specifying 0 will cause Git to auto-detect the number of CPU's2499 and set the number of threads accordingly.25002501pack.indexVersion::2502 Specify the default pack index version. Valid values are 1 for2503 legacy pack index used by Git versions prior to 1.5.2, and 2 for2504 the new pack index with capabilities for packs larger than 4 GB2505 as well as proper protection against the repacking of corrupted2506 packs. Version 2 is the default. Note that version 2 is enforced2507 and this config option ignored whenever the corresponding pack is2508 larger than 2 GB.2509+2510If you have an old Git that does not understand the version 2 `*.idx` file,2511cloning or fetching over a non native protocol (e.g. "http")2512that will copy both `*.pack` file and corresponding `*.idx` file from the2513other side may give you a repository that cannot be accessed with your2514older version of Git. If the `*.pack` file is smaller than 2 GB, however,2515you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2516the `*.idx` file.25172518pack.packSizeLimit::2519 The maximum size of a pack. This setting only affects2520 packing to a file when repacking, i.e. the git:// protocol2521 is unaffected. It can be overridden by the `--max-pack-size`2522 option of linkgit:git-repack[1]. Reaching this limit results2523 in the creation of multiple packfiles; which in turn prevents2524 bitmaps from being created.2525 The minimum size allowed is limited to 1 MiB.2526 The default is unlimited.2527 Common unit suffixes of 'k', 'm', or 'g' are2528 supported.25292530pack.useBitmaps::2531 When true, git will use pack bitmaps (if available) when packing2532 to stdout (e.g., during the server side of a fetch). Defaults to2533 true. You should not generally need to turn this off unless2534 you are debugging pack bitmaps.25352536pack.writeBitmaps (deprecated)::2537 This is a deprecated synonym for `repack.writeBitmaps`.25382539pack.writeBitmapHashCache::2540 When true, git will include a "hash cache" section in the bitmap2541 index (if one is written). This cache can be used to feed git's2542 delta heuristics, potentially leading to better deltas between2543 bitmapped and non-bitmapped objects (e.g., when serving a fetch2544 between an older, bitmapped pack and objects that have been2545 pushed since the last gc). The downside is that it consumes 42546 bytes per object of disk space, and that JGit's bitmap2547 implementation does not understand it, causing it to complain if2548 Git and JGit are used on the same repository. Defaults to false.25492550pager.<cmd>::2551 If the value is boolean, turns on or off pagination of the2552 output of a particular Git subcommand when writing to a tty.2553 Otherwise, turns on pagination for the subcommand using the2554 pager specified by the value of `pager.<cmd>`. If `--paginate`2555 or `--no-pager` is specified on the command line, it takes2556 precedence over this option. To disable pagination for all2557 commands, set `core.pager` or `GIT_PAGER` to `cat`.25582559pretty.<name>::2560 Alias for a --pretty= format string, as specified in2561 linkgit:git-log[1]. Any aliases defined here can be used just2562 as the built-in pretty formats could. For example,2563 running `git config pretty.changelog "format:* %H %s"`2564 would cause the invocation `git log --pretty=changelog`2565 to be equivalent to running `git log "--pretty=format:* %H %s"`.2566 Note that an alias with the same name as a built-in format2567 will be silently ignored.25682569protocol.allow::2570 If set, provide a user defined default policy for all protocols which2571 don't explicitly have a policy (`protocol.<name>.allow`). By default,2572 if unset, known-safe protocols (http, https, git, ssh, file) have a2573 default policy of `always`, known-dangerous protocols (ext) have a2574 default policy of `never`, and all other protocols have a default2575 policy of `user`. Supported policies:2576+2577--25782579* `always` - protocol is always able to be used.25802581* `never` - protocol is never able to be used.25822583* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2584 either unset or has a value of 1. This policy should be used when you want a2585 protocol to be directly usable by the user but don't want it used by commands which2586 execute clone/fetch/push commands without user input, e.g. recursive2587 submodule initialization.25882589--25902591protocol.<name>.allow::2592 Set a policy to be used by protocol `<name>` with clone/fetch/push2593 commands. See `protocol.allow` above for the available policies.2594+2595The protocol names currently used by git are:2596+2597--2598 - `file`: any local file-based path (including `file://` URLs,2599 or local paths)26002601 - `git`: the anonymous git protocol over a direct TCP2602 connection (or proxy, if configured)26032604 - `ssh`: git over ssh (including `host:path` syntax,2605 `ssh://`, etc).26062607 - `http`: git over http, both "smart http" and "dumb http".2608 Note that this does _not_ include `https`; if you want to configure2609 both, you must do so individually.26102611 - any external helpers are named by their protocol (e.g., use2612 `hg` to allow the `git-remote-hg` helper)2613--26142615protocol.version::2616 Experimental. If set, clients will attempt to communicate with a2617 server using the specified protocol version. If unset, no2618 attempt will be made by the client to communicate using a2619 particular protocol version, this results in protocol version 02620 being used.2621 Supported versions:2622+2623--26242625* `0` - the original wire protocol.26262627* `1` - the original wire protocol with the addition of a version string2628 in the initial response from the server.26292630--26312632pull.ff::2633 By default, Git does not create an extra merge commit when merging2634 a commit that is a descendant of the current commit. Instead, the2635 tip of the current branch is fast-forwarded. When set to `false`,2636 this variable tells Git to create an extra merge commit in such2637 a case (equivalent to giving the `--no-ff` option from the command2638 line). When set to `only`, only such fast-forward merges are2639 allowed (equivalent to giving the `--ff-only` option from the2640 command line). This setting overrides `merge.ff` when pulling.26412642pull.rebase::2643 When true, rebase branches on top of the fetched branch, instead2644 of merging the default branch from the default remote when "git2645 pull" is run. See "branch.<name>.rebase" for setting this on a2646 per-branch basis.2647+2648When preserve, also pass `--preserve-merges` along to 'git rebase'2649so that locally committed merge commits will not be flattened2650by running 'git pull'.2651+2652When the value is `interactive`, the rebase is run in interactive mode.2653+2654*NOTE*: this is a possibly dangerous operation; do *not* use2655it unless you understand the implications (see linkgit:git-rebase[1]2656for details).26572658pull.octopus::2659 The default merge strategy to use when pulling multiple branches2660 at once.26612662pull.twohead::2663 The default merge strategy to use when pulling a single branch.26642665push.default::2666 Defines the action `git push` should take if no refspec is2667 explicitly given. Different values are well-suited for2668 specific workflows; for instance, in a purely central workflow2669 (i.e. the fetch source is equal to the push destination),2670 `upstream` is probably what you want. Possible values are:2671+2672--26732674* `nothing` - do not push anything (error out) unless a refspec is2675 explicitly given. This is primarily meant for people who want to2676 avoid mistakes by always being explicit.26772678* `current` - push the current branch to update a branch with the same2679 name on the receiving end. Works in both central and non-central2680 workflows.26812682* `upstream` - push the current branch back to the branch whose2683 changes are usually integrated into the current branch (which is2684 called `@{upstream}`). This mode only makes sense if you are2685 pushing to the same repository you would normally pull from2686 (i.e. central workflow).26872688* `tracking` - This is a deprecated synonym for `upstream`.26892690* `simple` - in centralized workflow, work like `upstream` with an2691 added safety to refuse to push if the upstream branch's name is2692 different from the local one.2693+2694When pushing to a remote that is different from the remote you normally2695pull from, work as `current`. This is the safest option and is suited2696for beginners.2697+2698This mode has become the default in Git 2.0.26992700* `matching` - push all branches having the same name on both ends.2701 This makes the repository you are pushing to remember the set of2702 branches that will be pushed out (e.g. if you always push 'maint'2703 and 'master' there and no other branches, the repository you push2704 to will have these two branches, and your local 'maint' and2705 'master' will be pushed there).2706+2707To use this mode effectively, you have to make sure _all_ the2708branches you would push out are ready to be pushed out before2709running 'git push', as the whole point of this mode is to allow you2710to push all of the branches in one go. If you usually finish work2711on only one branch and push out the result, while other branches are2712unfinished, this mode is not for you. Also this mode is not2713suitable for pushing into a shared central repository, as other2714people may add new branches there, or update the tip of existing2715branches outside your control.2716+2717This used to be the default, but not since Git 2.0 (`simple` is the2718new default).27192720--27212722push.followTags::2723 If set to true enable `--follow-tags` option by default. You2724 may override this configuration at time of push by specifying2725 `--no-follow-tags`.27262727push.gpgSign::2728 May be set to a boolean value, or the string 'if-asked'. A true2729 value causes all pushes to be GPG signed, as if `--signed` is2730 passed to linkgit:git-push[1]. The string 'if-asked' causes2731 pushes to be signed if the server supports it, as if2732 `--signed=if-asked` is passed to 'git push'. A false value may2733 override a value from a lower-priority config file. An explicit2734 command-line flag always overrides this config option.27352736push.pushOption::2737 When no `--push-option=<option>` argument is given from the2738 command line, `git push` behaves as if each <value> of2739 this variable is given as `--push-option=<value>`.2740+2741This is a multi-valued variable, and an empty value can be used in a2742higher priority configuration file (e.g. `.git/config` in a2743repository) to clear the values inherited from a lower priority2744configuration files (e.g. `$HOME/.gitconfig`).2745+2746--27472748Example:27492750/etc/gitconfig2751 push.pushoption = a2752 push.pushoption = b27532754~/.gitconfig2755 push.pushoption = c27562757repo/.git/config2758 push.pushoption =2759 push.pushoption = b27602761This will result in only b (a and c are cleared).27622763--27642765push.recurseSubmodules::2766 Make sure all submodule commits used by the revisions to be pushed2767 are available on a remote-tracking branch. If the value is 'check'2768 then Git will verify that all submodule commits that changed in the2769 revisions to be pushed are available on at least one remote of the2770 submodule. If any commits are missing, the push will be aborted and2771 exit with non-zero status. If the value is 'on-demand' then all2772 submodules that changed in the revisions to be pushed will be2773 pushed. If on-demand was not able to push all necessary revisions2774 it will also be aborted and exit with non-zero status. If the value2775 is 'no' then default behavior of ignoring submodules when pushing2776 is retained. You may override this configuration at time of push by2777 specifying '--recurse-submodules=check|on-demand|no'.27782779include::rebase-config.txt[]27802781receive.advertiseAtomic::2782 By default, git-receive-pack will advertise the atomic push2783 capability to its clients. If you don't want to advertise this2784 capability, set this variable to false.27852786receive.advertisePushOptions::2787 When set to true, git-receive-pack will advertise the push options2788 capability to its clients. False by default.27892790receive.autogc::2791 By default, git-receive-pack will run "git-gc --auto" after2792 receiving data from git-push and updating refs. You can stop2793 it by setting this variable to false.27942795receive.certNonceSeed::2796 By setting this variable to a string, `git receive-pack`2797 will accept a `git push --signed` and verifies it by using2798 a "nonce" protected by HMAC using this string as a secret2799 key.28002801receive.certNonceSlop::2802 When a `git push --signed` sent a push certificate with a2803 "nonce" that was issued by a receive-pack serving the same2804 repository within this many seconds, export the "nonce"2805 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2806 hooks (instead of what the receive-pack asked the sending2807 side to include). This may allow writing checks in2808 `pre-receive` and `post-receive` a bit easier. Instead of2809 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2810 that records by how many seconds the nonce is stale to2811 decide if they want to accept the certificate, they only2812 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.28132814receive.fsckObjects::2815 If it is set to true, git-receive-pack will check all received2816 objects. It will abort in the case of a malformed object or a2817 broken link. The result of an abort are only dangling objects.2818 Defaults to false. If not set, the value of `transfer.fsckObjects`2819 is used instead.28202821receive.fsck.<msg-id>::2822 When `receive.fsckObjects` is set to true, errors can be switched2823 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2824 setting where the `<msg-id>` is the fsck message ID and the value2825 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2826 the error/warning with the message ID, e.g. "missingEmail: invalid2827 author/committer line - missing email" means that setting2828 `receive.fsck.missingEmail = ignore` will hide that issue.2829+2830This feature is intended to support working with legacy repositories2831which would not pass pushing when `receive.fsckObjects = true`, allowing2832the host to accept repositories with certain known issues but still catch2833other issues.28342835receive.fsck.skipList::2836 The path to a sorted list of object names (i.e. one SHA-1 per2837 line) that are known to be broken in a non-fatal way and should2838 be ignored. This feature is useful when an established project2839 should be accepted despite early commits containing errors that2840 can be safely ignored such as invalid committer email addresses.2841 Note: corrupt objects cannot be skipped with this setting.28422843receive.keepAlive::2844 After receiving the pack from the client, `receive-pack` may2845 produce no output (if `--quiet` was specified) while processing2846 the pack, causing some networks to drop the TCP connection.2847 With this option set, if `receive-pack` does not transmit2848 any data in this phase for `receive.keepAlive` seconds, it will2849 send a short keepalive packet. The default is 5 seconds; set2850 to 0 to disable keepalives entirely.28512852receive.unpackLimit::2853 If the number of objects received in a push is below this2854 limit then the objects will be unpacked into loose object2855 files. However if the number of received objects equals or2856 exceeds this limit then the received pack will be stored as2857 a pack, after adding any missing delta bases. Storing the2858 pack from a push can make the push operation complete faster,2859 especially on slow filesystems. If not set, the value of2860 `transfer.unpackLimit` is used instead.28612862receive.maxInputSize::2863 If the size of the incoming pack stream is larger than this2864 limit, then git-receive-pack will error out, instead of2865 accepting the pack file. If not set or set to 0, then the size2866 is unlimited.28672868receive.denyDeletes::2869 If set to true, git-receive-pack will deny a ref update that deletes2870 the ref. Use this to prevent such a ref deletion via a push.28712872receive.denyDeleteCurrent::2873 If set to true, git-receive-pack will deny a ref update that2874 deletes the currently checked out branch of a non-bare repository.28752876receive.denyCurrentBranch::2877 If set to true or "refuse", git-receive-pack will deny a ref update2878 to the currently checked out branch of a non-bare repository.2879 Such a push is potentially dangerous because it brings the HEAD2880 out of sync with the index and working tree. If set to "warn",2881 print a warning of such a push to stderr, but allow the push to2882 proceed. If set to false or "ignore", allow such pushes with no2883 message. Defaults to "refuse".2884+2885Another option is "updateInstead" which will update the working2886tree if pushing into the current branch. This option is2887intended for synchronizing working directories when one side is not easily2888accessible via interactive ssh (e.g. a live web site, hence the requirement2889that the working directory be clean). This mode also comes in handy when2890developing inside a VM to test and fix code on different Operating Systems.2891+2892By default, "updateInstead" will refuse the push if the working tree or2893the index have any difference from the HEAD, but the `push-to-checkout`2894hook can be used to customize this. See linkgit:githooks[5].28952896receive.denyNonFastForwards::2897 If set to true, git-receive-pack will deny a ref update which is2898 not a fast-forward. Use this to prevent such an update via a push,2899 even if that push is forced. This configuration variable is2900 set when initializing a shared repository.29012902receive.hideRefs::2903 This variable is the same as `transfer.hideRefs`, but applies2904 only to `receive-pack` (and so affects pushes, but not fetches).2905 An attempt to update or delete a hidden ref by `git push` is2906 rejected.29072908receive.updateServerInfo::2909 If set to true, git-receive-pack will run git-update-server-info2910 after receiving data from git-push and updating refs.29112912receive.shallowUpdate::2913 If set to true, .git/shallow can be updated when new refs2914 require new shallow roots. Otherwise those refs are rejected.29152916remote.pushDefault::2917 The remote to push to by default. Overrides2918 `branch.<name>.remote` for all branches, and is overridden by2919 `branch.<name>.pushRemote` for specific branches.29202921remote.<name>.url::2922 The URL of a remote repository. See linkgit:git-fetch[1] or2923 linkgit:git-push[1].29242925remote.<name>.pushurl::2926 The push URL of a remote repository. See linkgit:git-push[1].29272928remote.<name>.proxy::2929 For remotes that require curl (http, https and ftp), the URL to2930 the proxy to use for that remote. Set to the empty string to2931 disable proxying for that remote.29322933remote.<name>.proxyAuthMethod::2934 For remotes that require curl (http, https and ftp), the method to use for2935 authenticating against the proxy in use (probably set in2936 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29372938remote.<name>.fetch::2939 The default set of "refspec" for linkgit:git-fetch[1]. See2940 linkgit:git-fetch[1].29412942remote.<name>.push::2943 The default set of "refspec" for linkgit:git-push[1]. See2944 linkgit:git-push[1].29452946remote.<name>.mirror::2947 If true, pushing to this remote will automatically behave2948 as if the `--mirror` option was given on the command line.29492950remote.<name>.skipDefaultUpdate::2951 If true, this remote will be skipped by default when updating2952 using linkgit:git-fetch[1] or the `update` subcommand of2953 linkgit:git-remote[1].29542955remote.<name>.skipFetchAll::2956 If true, this remote will be skipped by default when updating2957 using linkgit:git-fetch[1] or the `update` subcommand of2958 linkgit:git-remote[1].29592960remote.<name>.receivepack::2961 The default program to execute on the remote side when pushing. See2962 option --receive-pack of linkgit:git-push[1].29632964remote.<name>.uploadpack::2965 The default program to execute on the remote side when fetching. See2966 option --upload-pack of linkgit:git-fetch-pack[1].29672968remote.<name>.tagOpt::2969 Setting this value to --no-tags disables automatic tag following when2970 fetching from remote <name>. Setting it to --tags will fetch every2971 tag from remote <name>, even if they are not reachable from remote2972 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2973 override this setting. See options --tags and --no-tags of2974 linkgit:git-fetch[1].29752976remote.<name>.vcs::2977 Setting this to a value <vcs> will cause Git to interact with2978 the remote with the git-remote-<vcs> helper.29792980remote.<name>.prune::2981 When set to true, fetching from this remote by default will also2982 remove any remote-tracking references that no longer exist on the2983 remote (as if the `--prune` option was given on the command line).2984 Overrides `fetch.prune` settings, if any.29852986remote.<name>.pruneTags::2987 When set to true, fetching from this remote by default will also2988 remove any local tags that no longer exist on the remote if pruning2989 is activated in general via `remote.<name>.prune`, `fetch.prune` or2990 `--prune`. Overrides `fetch.pruneTags` settings, if any.2991+2992See also `remote.<name>.prune` and the PRUNING section of2993linkgit:git-fetch[1].29942995remotes.<group>::2996 The list of remotes which are fetched by "git remote update2997 <group>". See linkgit:git-remote[1].29982999repack.useDeltaBaseOffset::3000 By default, linkgit:git-repack[1] creates packs that use3001 delta-base offset. If you need to share your repository with3002 Git older than version 1.4.4, either directly or via a dumb3003 protocol such as http, then you need to set this option to3004 "false" and repack. Access from old Git versions over the3005 native protocol are unaffected by this option.30063007repack.packKeptObjects::3008 If set to true, makes `git repack` act as if3009 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3010 details. Defaults to `false` normally, but `true` if a bitmap3011 index is being written (either via `--write-bitmap-index` or3012 `repack.writeBitmaps`).30133014repack.writeBitmaps::3015 When true, git will write a bitmap index when packing all3016 objects to disk (e.g., when `git repack -a` is run). This3017 index can speed up the "counting objects" phase of subsequent3018 packs created for clones and fetches, at the cost of some disk3019 space and extra time spent on the initial repack. This has3020 no effect if multiple packfiles are created.3021 Defaults to false.30223023rerere.autoUpdate::3024 When set to true, `git-rerere` updates the index with the3025 resulting contents after it cleanly resolves conflicts using3026 previously recorded resolution. Defaults to false.30273028rerere.enabled::3029 Activate recording of resolved conflicts, so that identical3030 conflict hunks can be resolved automatically, should they be3031 encountered again. By default, linkgit:git-rerere[1] is3032 enabled if there is an `rr-cache` directory under the3033 `$GIT_DIR`, e.g. if "rerere" was previously used in the3034 repository.30353036sendemail.identity::3037 A configuration identity. When given, causes values in the3038 'sendemail.<identity>' subsection to take precedence over3039 values in the 'sendemail' section. The default identity is3040 the value of `sendemail.identity`.30413042sendemail.smtpEncryption::3043 See linkgit:git-send-email[1] for description. Note that this3044 setting is not subject to the 'identity' mechanism.30453046sendemail.smtpssl (deprecated)::3047 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30483049sendemail.smtpsslcertpath::3050 Path to ca-certificates (either a directory or a single file).3051 Set it to an empty string to disable certificate verification.30523053sendemail.<identity>.*::3054 Identity-specific versions of the 'sendemail.*' parameters3055 found below, taking precedence over those when this3056 identity is selected, through either the command-line or3057 `sendemail.identity`.30583059sendemail.aliasesFile::3060sendemail.aliasFileType::3061sendemail.annotate::3062sendemail.bcc::3063sendemail.cc::3064sendemail.ccCmd::3065sendemail.chainReplyTo::3066sendemail.confirm::3067sendemail.envelopeSender::3068sendemail.from::3069sendemail.multiEdit::3070sendemail.signedoffbycc::3071sendemail.smtpPass::3072sendemail.suppresscc::3073sendemail.suppressFrom::3074sendemail.to::3075sendemail.tocmd::3076sendemail.smtpDomain::3077sendemail.smtpServer::3078sendemail.smtpServerPort::3079sendemail.smtpServerOption::3080sendemail.smtpUser::3081sendemail.thread::3082sendemail.transferEncoding::3083sendemail.validate::3084sendemail.xmailer::3085 See linkgit:git-send-email[1] for description.30863087sendemail.signedoffcc (deprecated)::3088 Deprecated alias for `sendemail.signedoffbycc`.30893090sendemail.smtpBatchSize::3091 Number of messages to be sent per connection, after that a relogin3092 will happen. If the value is 0 or undefined, send all messages in3093 one connection.3094 See also the `--batch-size` option of linkgit:git-send-email[1].30953096sendemail.smtpReloginDelay::3097 Seconds wait before reconnecting to smtp server.3098 See also the `--relogin-delay` option of linkgit:git-send-email[1].30993100showbranch.default::3101 The default set of branches for linkgit:git-show-branch[1].3102 See linkgit:git-show-branch[1].31033104splitIndex.maxPercentChange::3105 When the split index feature is used, this specifies the3106 percent of entries the split index can contain compared to the3107 total number of entries in both the split index and the shared3108 index before a new shared index is written.3109 The value should be between 0 and 100. If the value is 0 then3110 a new shared index is always written, if it is 100 a new3111 shared index is never written.3112 By default the value is 20, so a new shared index is written3113 if the number of entries in the split index would be greater3114 than 20 percent of the total number of entries.3115 See linkgit:git-update-index[1].31163117splitIndex.sharedIndexExpire::3118 When the split index feature is used, shared index files that3119 were not modified since the time this variable specifies will3120 be removed when a new shared index file is created. The value3121 "now" expires all entries immediately, and "never" suppresses3122 expiration altogether.3123 The default value is "2.weeks.ago".3124 Note that a shared index file is considered modified (for the3125 purpose of expiration) each time a new split-index file is3126 either created based on it or read from it.3127 See linkgit:git-update-index[1].31283129status.relativePaths::3130 By default, linkgit:git-status[1] shows paths relative to the3131 current directory. Setting this variable to `false` shows paths3132 relative to the repository root (this was the default for Git3133 prior to v1.5.4).31343135status.short::3136 Set to true to enable --short by default in linkgit:git-status[1].3137 The option --no-short takes precedence over this variable.31383139status.branch::3140 Set to true to enable --branch by default in linkgit:git-status[1].3141 The option --no-branch takes precedence over this variable.31423143status.displayCommentPrefix::3144 If set to true, linkgit:git-status[1] will insert a comment3145 prefix before each output line (starting with3146 `core.commentChar`, i.e. `#` by default). This was the3147 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3148 Defaults to false.31493150status.showStash::3151 If set to true, linkgit:git-status[1] will display the number of3152 entries currently stashed away.3153 Defaults to false.31543155status.showUntrackedFiles::3156 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3157 files which are not currently tracked by Git. Directories which3158 contain only untracked files, are shown with the directory name3159 only. Showing untracked files means that Git needs to lstat() all3160 the files in the whole repository, which might be slow on some3161 systems. So, this variable controls how the commands displays3162 the untracked files. Possible values are:3163+3164--3165* `no` - Show no untracked files.3166* `normal` - Show untracked files and directories.3167* `all` - Show also individual files in untracked directories.3168--3169+3170If this variable is not specified, it defaults to 'normal'.3171This variable can be overridden with the -u|--untracked-files option3172of linkgit:git-status[1] and linkgit:git-commit[1].31733174status.submoduleSummary::3175 Defaults to false.3176 If this is set to a non zero number or true (identical to -1 or an3177 unlimited number), the submodule summary will be enabled and a3178 summary of commits for modified submodules will be shown (see3179 --summary-limit option of linkgit:git-submodule[1]). Please note3180 that the summary output command will be suppressed for all3181 submodules when `diff.ignoreSubmodules` is set to 'all' or only3182 for those submodules where `submodule.<name>.ignore=all`. The only3183 exception to that rule is that status and commit will show staged3184 submodule changes. To3185 also view the summary for ignored submodules you can either use3186 the --ignore-submodules=dirty command-line option or the 'git3187 submodule summary' command, which shows a similar output but does3188 not honor these settings.31893190stash.showPatch::3191 If this is set to true, the `git stash show` command without an3192 option will show the stash entry in patch form. Defaults to false.3193 See description of 'show' command in linkgit:git-stash[1].31943195stash.showStat::3196 If this is set to true, the `git stash show` command without an3197 option will show diffstat of the stash entry. Defaults to true.3198 See description of 'show' command in linkgit:git-stash[1].31993200submodule.<name>.url::3201 The URL for a submodule. This variable is copied from the .gitmodules3202 file to the git config via 'git submodule init'. The user can change3203 the configured URL before obtaining the submodule via 'git submodule3204 update'. If neither submodule.<name>.active or submodule.active are3205 set, the presence of this variable is used as a fallback to indicate3206 whether the submodule is of interest to git commands.3207 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.32083209submodule.<name>.update::3210 The method by which a submodule is updated by 'git submodule update',3211 which is the only affected command, others such as3212 'git checkout --recurse-submodules' are unaffected. It exists for3213 historical reasons, when 'git submodule' was the only command to3214 interact with submodules; settings like `submodule.active`3215 and `pull.rebase` are more specific. It is populated by3216 `git submodule init` from the linkgit:gitmodules[5] file.3217 See description of 'update' command in linkgit:git-submodule[1].32183219submodule.<name>.branch::3220 The remote branch name for a submodule, used by `git submodule3221 update --remote`. Set this option to override the value found in3222 the `.gitmodules` file. See linkgit:git-submodule[1] and3223 linkgit:gitmodules[5] for details.32243225submodule.<name>.fetchRecurseSubmodules::3226 This option can be used to control recursive fetching of this3227 submodule. It can be overridden by using the --[no-]recurse-submodules3228 command-line option to "git fetch" and "git pull".3229 This setting will override that from in the linkgit:gitmodules[5]3230 file.32313232submodule.<name>.ignore::3233 Defines under what circumstances "git status" and the diff family show3234 a submodule as modified. When set to "all", it will never be considered3235 modified (but it will nonetheless show up in the output of status and3236 commit when it has been staged), "dirty" will ignore all changes3237 to the submodules work tree and3238 takes only differences between the HEAD of the submodule and the commit3239 recorded in the superproject into account. "untracked" will additionally3240 let submodules with modified tracked files in their work tree show up.3241 Using "none" (the default when this option is not set) also shows3242 submodules that have untracked files in their work tree as changed.3243 This setting overrides any setting made in .gitmodules for this submodule,3244 both settings can be overridden on the command line by using the3245 "--ignore-submodules" option. The 'git submodule' commands are not3246 affected by this setting.32473248submodule.<name>.active::3249 Boolean value indicating if the submodule is of interest to git3250 commands. This config option takes precedence over the3251 submodule.active config option.32523253submodule.active::3254 A repeated field which contains a pathspec used to match against a3255 submodule's path to determine if the submodule is of interest to git3256 commands.32573258submodule.recurse::3259 Specifies if commands recurse into submodules by default. This3260 applies to all commands that have a `--recurse-submodules` option,3261 except `clone`.3262 Defaults to false.32633264submodule.fetchJobs::3265 Specifies how many submodules are fetched/cloned at the same time.3266 A positive integer allows up to that number of submodules fetched3267 in parallel. A value of 0 will give some reasonable default.3268 If unset, it defaults to 1.32693270submodule.alternateLocation::3271 Specifies how the submodules obtain alternates when submodules are3272 cloned. Possible values are `no`, `superproject`.3273 By default `no` is assumed, which doesn't add references. When the3274 value is set to `superproject` the submodule to be cloned computes3275 its alternates location relative to the superprojects alternate.32763277submodule.alternateErrorStrategy::3278 Specifies how to treat errors with the alternates for a submodule3279 as computed via `submodule.alternateLocation`. Possible values are3280 `ignore`, `info`, `die`. Default is `die`.32813282tag.forceSignAnnotated::3283 A boolean to specify whether annotated tags created should be GPG signed.3284 If `--annotate` is specified on the command line, it takes3285 precedence over this option.32863287tag.sort::3288 This variable controls the sort ordering of tags when displayed by3289 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3290 value of this variable will be used as the default.32913292tar.umask::3293 This variable can be used to restrict the permission bits of3294 tar archive entries. The default is 0002, which turns off the3295 world write bit. The special value "user" indicates that the3296 archiving user's umask will be used instead. See umask(2) and3297 linkgit:git-archive[1].32983299transfer.fsckObjects::3300 When `fetch.fsckObjects` or `receive.fsckObjects` are3301 not set, the value of this variable is used instead.3302 Defaults to false.33033304transfer.hideRefs::3305 String(s) `receive-pack` and `upload-pack` use to decide which3306 refs to omit from their initial advertisements. Use more than3307 one definition to specify multiple prefix strings. A ref that is3308 under the hierarchies listed in the value of this variable is3309 excluded, and is hidden when responding to `git push` or `git3310 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3311 program-specific versions of this config.3312+3313You may also include a `!` in front of the ref name to negate the entry,3314explicitly exposing it, even if an earlier entry marked it as hidden.3315If you have multiple hideRefs values, later entries override earlier ones3316(and entries in more-specific config files override less-specific ones).3317+3318If a namespace is in use, the namespace prefix is stripped from each3319reference before it is matched against `transfer.hiderefs` patterns.3320For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3321the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3322is omitted from the advertisements but `refs/heads/master` and3323`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3324"have" lines. In order to match refs before stripping, add a `^` in front of3325the ref name. If you combine `!` and `^`, `!` must be specified first.3326+3327Even if you hide refs, a client may still be able to steal the target3328objects via the techniques described in the "SECURITY" section of the3329linkgit:gitnamespaces[7] man page; it's best to keep private data in a3330separate repository.33313332transfer.unpackLimit::3333 When `fetch.unpackLimit` or `receive.unpackLimit` are3334 not set, the value of this variable is used instead.3335 The default value is 100.33363337uploadarchive.allowUnreachable::3338 If true, allow clients to use `git archive --remote` to request3339 any tree, whether reachable from the ref tips or not. See the3340 discussion in the "SECURITY" section of3341 linkgit:git-upload-archive[1] for more details. Defaults to3342 `false`.33433344uploadpack.hideRefs::3345 This variable is the same as `transfer.hideRefs`, but applies3346 only to `upload-pack` (and so affects only fetches, not pushes).3347 An attempt to fetch a hidden ref by `git fetch` will fail. See3348 also `uploadpack.allowTipSHA1InWant`.33493350uploadpack.allowTipSHA1InWant::3351 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3352 to accept a fetch request that asks for an object at the tip3353 of a hidden ref (by default, such a request is rejected).3354 See also `uploadpack.hideRefs`. Even if this is false, a client3355 may be able to steal objects via the techniques described in the3356 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3357 best to keep private data in a separate repository.33583359uploadpack.allowReachableSHA1InWant::3360 Allow `upload-pack` to accept a fetch request that asks for an3361 object that is reachable from any ref tip. However, note that3362 calculating object reachability is computationally expensive.3363 Defaults to `false`. Even if this is false, a client may be able3364 to steal objects via the techniques described in the "SECURITY"3365 section of the linkgit:gitnamespaces[7] man page; it's best to3366 keep private data in a separate repository.33673368uploadpack.allowAnySHA1InWant::3369 Allow `upload-pack` to accept a fetch request that asks for any3370 object at all.3371 Defaults to `false`.33723373uploadpack.keepAlive::3374 When `upload-pack` has started `pack-objects`, there may be a3375 quiet period while `pack-objects` prepares the pack. Normally3376 it would output progress information, but if `--quiet` was used3377 for the fetch, `pack-objects` will output nothing at all until3378 the pack data begins. Some clients and networks may consider3379 the server to be hung and give up. Setting this option instructs3380 `upload-pack` to send an empty keepalive packet every3381 `uploadpack.keepAlive` seconds. Setting this option to 03382 disables keepalive packets entirely. The default is 5 seconds.33833384uploadpack.packObjectsHook::3385 If this option is set, when `upload-pack` would run3386 `git pack-objects` to create a packfile for a client, it will3387 run this shell command instead. The `pack-objects` command and3388 arguments it _would_ have run (including the `git pack-objects`3389 at the beginning) are appended to the shell command. The stdin3390 and stdout of the hook are treated as if `pack-objects` itself3391 was run. I.e., `upload-pack` will feed input intended for3392 `pack-objects` to the hook, and expects a completed packfile on3393 stdout.33943395uploadpack.allowFilter::3396 If this option is set, `upload-pack` will support partial3397 clone and partial fetch object filtering.3398+3399Note that this configuration variable is ignored if it is seen in the3400repository-level config (this is a safety measure against fetching from3401untrusted repositories).34023403url.<base>.insteadOf::3404 Any URL that starts with this value will be rewritten to3405 start, instead, with <base>. In cases where some site serves a3406 large number of repositories, and serves them with multiple3407 access methods, and some users need to use different access3408 methods, this feature allows people to specify any of the3409 equivalent URLs and have Git automatically rewrite the URL to3410 the best alternative for the particular user, even for a3411 never-before-seen repository on the site. When more than one3412 insteadOf strings match a given URL, the longest match is used.3413+3414Note that any protocol restrictions will be applied to the rewritten3415URL. If the rewrite changes the URL to use a custom protocol or remote3416helper, you may need to adjust the `protocol.*.allow` config to permit3417the request. In particular, protocols you expect to use for submodules3418must be set to `always` rather than the default of `user`. See the3419description of `protocol.allow` above.34203421url.<base>.pushInsteadOf::3422 Any URL that starts with this value will not be pushed to;3423 instead, it will be rewritten to start with <base>, and the3424 resulting URL will be pushed to. In cases where some site serves3425 a large number of repositories, and serves them with multiple3426 access methods, some of which do not allow push, this feature3427 allows people to specify a pull-only URL and have Git3428 automatically use an appropriate URL to push, even for a3429 never-before-seen repository on the site. When more than one3430 pushInsteadOf strings match a given URL, the longest match is3431 used. If a remote has an explicit pushurl, Git will ignore this3432 setting for that remote.34333434user.email::3435 Your email address to be recorded in any newly created commits.3436 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3437 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34383439user.name::3440 Your full name to be recorded in any newly created commits.3441 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3442 environment variables. See linkgit:git-commit-tree[1].34433444user.useConfigOnly::3445 Instruct Git to avoid trying to guess defaults for `user.email`3446 and `user.name`, and instead retrieve the values only from the3447 configuration. For example, if you have multiple email addresses3448 and would like to use a different one for each repository, then3449 with this configuration option set to `true` in the global config3450 along with a name, Git will prompt you to set up an email before3451 making new commits in a newly cloned repository.3452 Defaults to `false`.34533454user.signingKey::3455 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3456 key you want it to automatically when creating a signed tag or3457 commit, you can override the default selection with this variable.3458 This option is passed unchanged to gpg's --local-user parameter,3459 so you may specify a key using any method that gpg supports.34603461versionsort.prereleaseSuffix (deprecated)::3462 Deprecated alias for `versionsort.suffix`. Ignored if3463 `versionsort.suffix` is set.34643465versionsort.suffix::3466 Even when version sort is used in linkgit:git-tag[1], tagnames3467 with the same base version but different suffixes are still sorted3468 lexicographically, resulting e.g. in prerelease tags appearing3469 after the main release (e.g. "1.0-rc1" after "1.0"). This3470 variable can be specified to determine the sorting order of tags3471 with different suffixes.3472+3473By specifying a single suffix in this variable, any tagname containing3474that suffix will appear before the corresponding main release. E.g. if3475the variable is set to "-rc", then all "1.0-rcX" tags will appear before3476"1.0". If specified multiple times, once per suffix, then the order of3477suffixes in the configuration will determine the sorting order of tagnames3478with those suffixes. E.g. if "-pre" appears before "-rc" in the3479configuration, then all "1.0-preX" tags will be listed before any3480"1.0-rcX" tags. The placement of the main release tag relative to tags3481with various suffixes can be determined by specifying the empty suffix3482among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3483"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3484are listed first, followed by "v4.8", then "v4.8-ckX" and finally3485"v4.8-bfsX".3486+3487If more than one suffixes match the same tagname, then that tagname will3488be sorted according to the suffix which starts at the earliest position in3489the tagname. If more than one different matching suffixes start at3490that earliest position, then that tagname will be sorted according to the3491longest of those suffixes.3492The sorting order between different suffixes is undefined if they are3493in multiple config files.34943495web.browser::3496 Specify a web browser that may be used by some commands.3497 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3498 may use it.34993500worktree.guessRemote::3501 With `add`, if no branch argument, and neither of `-b` nor3502 `-B` nor `--detach` are given, the command defaults to3503 creating a new branch from HEAD. If `worktree.guessRemote` is3504 set to true, `worktree add` tries to find a remote-tracking3505 branch whose name uniquely matches the new branch name. If3506 such a branch exists, it is checked out and set as "upstream"3507 for the new branch. If no such match can be found, it falls3508 back to creating a new branch from the current HEAD.