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 (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82The `include` and `includeIf` sections allow you to include config 83directives from another source. These sections behave identically to 84each other with the exception that `includeIf` sections may be ignored 85if their condition does not evaluate to true; see "Conditional includes" 86below. 87 88You can include a config file from another by setting the special 89`include.path` (or `includeIf.*.path`) variable to the name of the file 90to be included. The variable takes a pathname as its value, and is 91subject to tilde expansion. These variables can be given multiple times. 92 93The contents of the included file are inserted immediately, as if they 94had been found at the location of the include directive. If the value of the 95variable is a relative path, the path is considered to 96be relative to the configuration file in which the include directive 97was found. See below for examples. 98 99Conditional includes 100~~~~~~~~~~~~~~~~~~~~ 101 102You can include a config file from another conditionally by setting a 103`includeIf.<condition>.path` variable to the name of the file to be 104included. 105 106The condition starts with a keyword followed by a colon and some data 107whose format and meaning depends on the keyword. Supported keywords 108are: 109 110`gitdir`:: 111 112 The data that follows the keyword `gitdir:` is used as a glob 113 pattern. If the location of the .git directory matches the 114 pattern, the include condition is met. 115+ 116The .git location may be auto-discovered, or come from `$GIT_DIR` 117environment variable. If the repository is auto discovered via a .git 118file (e.g. from submodules, or a linked worktree), the .git location 119would be the final location where the .git directory is, not where the 120.git file is. 121+ 122The pattern can contain standard globbing wildcards and two additional 123ones, `**/` and `/**`, that can match multiple path components. Please 124refer to linkgit:gitignore[5] for details. For convenience: 125 126 * If the pattern starts with `~/`, `~` will be substituted with the 127 content of the environment variable `HOME`. 128 129 * If the pattern starts with `./`, it is replaced with the directory 130 containing the current config file. 131 132 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 133 will be automatically prepended. For example, the pattern `foo/bar` 134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 135 136 * If the pattern ends with `/`, `**` will be automatically added. For 137 example, the pattern `foo/` becomes `foo/**`. In other words, it 138 matches "foo" and everything inside, recursively. 139 140`gitdir/i`:: 141 This is the same as `gitdir` except that matching is done 142 case-insensitively (e.g. on case-insensitive file sytems) 143 144A few more notes on matching via `gitdir` and `gitdir/i`: 145 146 * Symlinks in `$GIT_DIR` are not resolved before matching. 147 148 * Both the symlink & realpath versions of paths will be matched 149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 151 will match. 152+ 153This was not the case in the initial release of this feature in 154v2.13.0, which only matched the realpath version. Configuration that 155wants to be compatible with the initial release of this feature needs 156to either specify only the realpath version, or both versions. 157 158 * Note that "../" is not special and will match literally, which is 159 unlikely what you want. 160 161Example 162~~~~~~~ 163 164 # Core variables 165 [core] 166 ; Don't trust file modes 167 filemode = false 168 169 # Our diff algorithm 170 [diff] 171 external = /usr/local/bin/diff-wrapper 172 renames = true 173 174 [branch "devel"] 175 remote = origin 176 merge = refs/heads/devel 177 178 # Proxy settings 179 [core] 180 gitProxy="ssh" for "kernel.org" 181 gitProxy=default-proxy ; for the rest 182 183 [include] 184 path = /path/to/foo.inc ; include by absolute path 185 path = foo.inc ; find "foo.inc" relative to the current file 186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 187 188 ; include if $GIT_DIR is /path/to/foo/.git 189 [includeIf "gitdir:/path/to/foo/.git"] 190 path = /path/to/foo.inc 191 192 ; include for all repositories inside /path/to/group 193 [includeIf "gitdir:/path/to/group/"] 194 path = /path/to/foo.inc 195 196 ; include for all repositories inside $HOME/to/group 197 [includeIf "gitdir:~/to/group/"] 198 path = /path/to/foo.inc 199 200 ; relative paths are always relative to the including 201 ; file (if the condition is true); their location is not 202 ; affected by the condition 203 [includeIf "gitdir:/path/to/group/"] 204 path = foo.inc 205 206Values 207~~~~~~ 208 209Values of many variables are treated as a simple string, but there 210are variables that take values of specific types and there are rules 211as to how to spell them. 212 213boolean:: 214 215 When a variable is said to take a boolean value, many 216 synonyms are accepted for 'true' and 'false'; these are all 217 case-insensitive. 218 219 true;; Boolean true literals are `yes`, `on`, `true`, 220 and `1`. Also, a variable defined without `= <value>` 221 is taken as true. 222 223 false;; Boolean false literals are `no`, `off`, `false`, 224 `0` and the empty string. 225+ 226When converting value to the canonical form using `--bool` type 227specifier, 'git config' will ensure that the output is "true" or 228"false" (spelled in lowercase). 229 230integer:: 231 The value for many variables that specify various sizes can 232 be suffixed with `k`, `M`,... to mean "scale the number by 233 1024", "by 1024x1024", etc. 234 235color:: 236 The value for a variable that takes a color is a list of 237 colors (at most two, one for foreground and one for background) 238 and attributes (as many as you want), separated by spaces. 239+ 240The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 241`blue`, `magenta`, `cyan` and `white`. The first color given is the 242foreground; the second is the background. 243+ 244Colors may also be given as numbers between 0 and 255; these use ANSI 245256-color mode (but note that not all terminals may support this). If 246your terminal supports it, you may also specify 24-bit RGB values as 247hex, like `#ff0ab3`. 248+ 249The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 250`italic`, and `strike` (for crossed-out or "strikethrough" letters). 251The position of any attributes with respect to the colors 252(before, after, or in between), doesn't matter. Specific attributes may 253be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 254`no-ul`, etc). 255+ 256An empty color string produces no color effect at all. This can be used 257to avoid coloring specific elements without disabling color entirely. 258+ 259For git's pre-defined color slots, the attributes are meant to be reset 260at the beginning of each item in the colored output. So setting 261`color.decorate.branch` to `black` will paint that branch name in a 262plain `black`, even if the previous thing on the same output line (e.g. 263opening parenthesis before the list of branch names in `log --decorate` 264output) is set to be painted with `bold` or some other attribute. 265However, custom log formats may do more complicated and layered 266coloring, and the negated forms may be useful there. 267 268pathname:: 269 A variable that takes a pathname value can be given a 270 string that begins with "`~/`" or "`~user/`", and the usual 271 tilde expansion happens to such a string: `~/` 272 is expanded to the value of `$HOME`, and `~user/` to the 273 specified user's home directory. 274 275 276Variables 277~~~~~~~~~ 278 279Note that this list is non-comprehensive and not necessarily complete. 280For command-specific variables, you will find a more detailed description 281in the appropriate manual page. 282 283Other git-related tools may and do use their own variables. When 284inventing new variables for use in your own tool, make sure their 285names do not conflict with those that are used by Git itself and 286other popular tools, and describe them in your documentation. 287 288 289advice.*:: 290 These variables control various optional help messages designed to 291 aid new users. All 'advice.*' variables default to 'true', and you 292 can tell Git that you do not need help by setting these to 'false': 293+ 294-- 295 pushUpdateRejected:: 296 Set this variable to 'false' if you want to disable 297 'pushNonFFCurrent', 298 'pushNonFFMatching', 'pushAlreadyExists', 299 'pushFetchFirst', and 'pushNeedsForce' 300 simultaneously. 301 pushNonFFCurrent:: 302 Advice shown when linkgit:git-push[1] fails due to a 303 non-fast-forward update to the current branch. 304 pushNonFFMatching:: 305 Advice shown when you ran linkgit:git-push[1] and pushed 306 'matching refs' explicitly (i.e. you used ':', or 307 specified a refspec that isn't your current branch) and 308 it resulted in a non-fast-forward error. 309 pushAlreadyExists:: 310 Shown when linkgit:git-push[1] rejects an update that 311 does not qualify for fast-forwarding (e.g., a tag.) 312 pushFetchFirst:: 313 Shown when linkgit:git-push[1] rejects an update that 314 tries to overwrite a remote ref that points at an 315 object we do not have. 316 pushNeedsForce:: 317 Shown when linkgit:git-push[1] rejects an update that 318 tries to overwrite a remote ref that points at an 319 object that is not a commit-ish, or make the remote 320 ref point at an object that is not a commit-ish. 321 statusHints:: 322 Show directions on how to proceed from the current 323 state in the output of linkgit:git-status[1], in 324 the template shown when writing commit messages in 325 linkgit:git-commit[1], and in the help message shown 326 by linkgit:git-checkout[1] when switching branch. 327 statusUoption:: 328 Advise to consider using the `-u` option to linkgit:git-status[1] 329 when the command takes more than 2 seconds to enumerate untracked 330 files. 331 commitBeforeMerge:: 332 Advice shown when linkgit:git-merge[1] refuses to 333 merge to avoid overwriting local changes. 334 resolveConflict:: 335 Advice shown by various commands when conflicts 336 prevent the operation from being performed. 337 implicitIdentity:: 338 Advice on how to set your identity configuration when 339 your information is guessed from the system username and 340 domain name. 341 detachedHead:: 342 Advice shown when you used linkgit:git-checkout[1] to 343 move to the detach HEAD state, to instruct how to create 344 a local branch after the fact. 345 amWorkDir:: 346 Advice that shows the location of the patch file when 347 linkgit:git-am[1] fails to apply it. 348 rmHints:: 349 In case of failure in the output of linkgit:git-rm[1], 350 show directions on how to proceed from the current state. 351 addEmbeddedRepo:: 352 Advice on what to do when you've accidentally added one 353 git repo inside of another. 354 ignoredHook:: 355 Advice shown if an hook is ignored because the hook is not 356 set as executable. 357-- 358 359core.fileMode:: 360 Tells Git if the executable bit of files in the working tree 361 is to be honored. 362+ 363Some filesystems lose the executable bit when a file that is 364marked as executable is checked out, or checks out a 365non-executable file with executable bit on. 366linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 367to see if it handles the executable bit correctly 368and this variable is automatically set as necessary. 369+ 370A repository, however, may be on a filesystem that handles 371the filemode correctly, and this variable is set to 'true' 372when created, but later may be made accessible from another 373environment that loses the filemode (e.g. exporting ext4 via 374CIFS mount, visiting a Cygwin created repository with 375Git for Windows or Eclipse). 376In such a case it may be necessary to set this variable to 'false'. 377See linkgit:git-update-index[1]. 378+ 379The default is true (when core.filemode is not specified in the config file). 380 381core.hideDotFiles:: 382 (Windows-only) If true, mark newly-created directories and files whose 383 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 384 directory is hidden, but no other files starting with a dot. The 385 default mode is 'dotGitOnly'. 386 387core.ignoreCase:: 388 If true, this option enables various workarounds to enable 389 Git to work better on filesystems that are not case sensitive, 390 like FAT. For example, if a directory listing finds 391 "makefile" when Git expects "Makefile", Git will assume 392 it is really the same file, and continue to remember it as 393 "Makefile". 394+ 395The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 396will probe and set core.ignoreCase true if appropriate when the repository 397is created. 398 399core.precomposeUnicode:: 400 This option is only used by Mac OS implementation of Git. 401 When core.precomposeUnicode=true, Git reverts the unicode decomposition 402 of filenames done by Mac OS. This is useful when sharing a repository 403 between Mac OS and Linux or Windows. 404 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 405 When false, file names are handled fully transparent by Git, 406 which is backward compatible with older versions of Git. 407 408core.protectHFS:: 409 If set to true, do not allow checkout of paths that would 410 be considered equivalent to `.git` on an HFS+ filesystem. 411 Defaults to `true` on Mac OS, and `false` elsewhere. 412 413core.protectNTFS:: 414 If set to true, do not allow checkout of paths that would 415 cause problems with the NTFS filesystem, e.g. conflict with 416 8.3 "short" names. 417 Defaults to `true` on Windows, and `false` elsewhere. 418 419core.fsmonitor:: 420 If set, the value of this variable is used as a command which 421 will identify all files that may have changed since the 422 requested date/time. This information is used to speed up git by 423 avoiding unnecessary processing of files that have not changed. 424 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 425 426core.trustctime:: 427 If false, the ctime differences between the index and the 428 working tree are ignored; useful when the inode change time 429 is regularly modified by something outside Git (file system 430 crawlers and some backup systems). 431 See linkgit:git-update-index[1]. True by default. 432 433core.splitIndex:: 434 If true, the split-index feature of the index will be used. 435 See linkgit:git-update-index[1]. False by default. 436 437core.untrackedCache:: 438 Determines what to do about the untracked cache feature of the 439 index. It will be kept, if this variable is unset or set to 440 `keep`. It will automatically be added if set to `true`. And 441 it will automatically be removed, if set to `false`. Before 442 setting it to `true`, you should check that mtime is working 443 properly on your system. 444 See linkgit:git-update-index[1]. `keep` by default. 445 446core.checkStat:: 447 Determines which stat fields to match between the index 448 and work tree. The user can set this to 'default' or 449 'minimal'. Default (or explicitly 'default'), is to check 450 all fields, including the sub-second part of mtime and ctime. 451 452core.quotePath:: 453 Commands that output paths (e.g. 'ls-files', 'diff'), will 454 quote "unusual" characters in the pathname by enclosing the 455 pathname in double-quotes and escaping those characters with 456 backslashes in the same way C escapes control characters (e.g. 457 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 458 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 459 UTF-8). If this variable is set to false, bytes higher than 460 0x80 are not considered "unusual" any more. Double-quotes, 461 backslash and control characters are always escaped regardless 462 of the setting of this variable. A simple space character is 463 not considered "unusual". Many commands can output pathnames 464 completely verbatim using the `-z` option. The default value 465 is true. 466 467core.eol:: 468 Sets the line ending type to use in the working directory for 469 files that have the `text` property set when core.autocrlf is false. 470 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 471 native line ending. The default value is `native`. See 472 linkgit:gitattributes[5] for more information on end-of-line 473 conversion. 474 475core.safecrlf:: 476 If true, makes Git check if converting `CRLF` is reversible when 477 end-of-line conversion is active. Git will verify if a command 478 modifies a file in the work tree either directly or indirectly. 479 For example, committing a file followed by checking out the 480 same file should yield the original file in the work tree. If 481 this is not the case for the current setting of 482 `core.autocrlf`, Git will reject the file. The variable can 483 be set to "warn", in which case Git will only warn about an 484 irreversible conversion but continue the operation. 485+ 486CRLF conversion bears a slight chance of corrupting data. 487When it is enabled, Git will convert CRLF to LF during commit and LF to 488CRLF during checkout. A file that contains a mixture of LF and 489CRLF before the commit cannot be recreated by Git. For text 490files this is the right thing to do: it corrects line endings 491such that we have only LF line endings in the repository. 492But for binary files that are accidentally classified as text the 493conversion can corrupt data. 494+ 495If you recognize such corruption early you can easily fix it by 496setting the conversion type explicitly in .gitattributes. Right 497after committing you still have the original file in your work 498tree and this file is not yet corrupted. You can explicitly tell 499Git that this file is binary and Git will handle the file 500appropriately. 501+ 502Unfortunately, the desired effect of cleaning up text files with 503mixed line endings and the undesired effect of corrupting binary 504files cannot be distinguished. In both cases CRLFs are removed 505in an irreversible way. For text files this is the right thing 506to do because CRLFs are line endings, while for binary files 507converting CRLFs corrupts data. 508+ 509Note, this safety check does not mean that a checkout will generate a 510file identical to the original file for a different setting of 511`core.eol` and `core.autocrlf`, but only for the current one. For 512example, a text file with `LF` would be accepted with `core.eol=lf` 513and could later be checked out with `core.eol=crlf`, in which case the 514resulting file would contain `CRLF`, although the original file 515contained `LF`. However, in both work trees the line endings would be 516consistent, that is either all `LF` or all `CRLF`, but never mixed. A 517file with mixed line endings would be reported by the `core.safecrlf` 518mechanism. 519 520core.autocrlf:: 521 Setting this variable to "true" is the same as setting 522 the `text` attribute to "auto" on all files and core.eol to "crlf". 523 Set to true if you want to have `CRLF` line endings in your 524 working directory and the repository has LF line endings. 525 This variable can be set to 'input', 526 in which case no output conversion is performed. 527 528core.symlinks:: 529 If false, symbolic links are checked out as small plain files that 530 contain the link text. linkgit:git-update-index[1] and 531 linkgit:git-add[1] will not change the recorded type to regular 532 file. Useful on filesystems like FAT that do not support 533 symbolic links. 534+ 535The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 536will probe and set core.symlinks false if appropriate when the repository 537is created. 538 539core.gitProxy:: 540 A "proxy command" to execute (as 'command host port') instead 541 of establishing direct connection to the remote server when 542 using the Git protocol for fetching. If the variable value is 543 in the "COMMAND for DOMAIN" format, the command is applied only 544 on hostnames ending with the specified domain string. This variable 545 may be set multiple times and is matched in the given order; 546 the first match wins. 547+ 548Can be overridden by the `GIT_PROXY_COMMAND` environment variable 549(which always applies universally, without the special "for" 550handling). 551+ 552The special string `none` can be used as the proxy command to 553specify that no proxy be used for a given domain pattern. 554This is useful for excluding servers inside a firewall from 555proxy use, while defaulting to a common proxy for external domains. 556 557core.sshCommand:: 558 If this variable is set, `git fetch` and `git push` will 559 use the specified command instead of `ssh` when they need to 560 connect to a remote system. The command is in the same form as 561 the `GIT_SSH_COMMAND` environment variable and is overridden 562 when the environment variable is set. 563 564core.ignoreStat:: 565 If true, Git will avoid using lstat() calls to detect if files have 566 changed by setting the "assume-unchanged" bit for those tracked files 567 which it has updated identically in both the index and working tree. 568+ 569When files are modified outside of Git, the user will need to stage 570the modified files explicitly (e.g. see 'Examples' section in 571linkgit:git-update-index[1]). 572Git will not normally detect changes to those files. 573+ 574This is useful on systems where lstat() calls are very slow, such as 575CIFS/Microsoft Windows. 576+ 577False by default. 578 579core.preferSymlinkRefs:: 580 Instead of the default "symref" format for HEAD 581 and other symbolic reference files, use symbolic links. 582 This is sometimes needed to work with old scripts that 583 expect HEAD to be a symbolic link. 584 585core.bare:: 586 If true this repository is assumed to be 'bare' and has no 587 working directory associated with it. If this is the case a 588 number of commands that require a working directory will be 589 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 590+ 591This setting is automatically guessed by linkgit:git-clone[1] or 592linkgit:git-init[1] when the repository was created. By default a 593repository that ends in "/.git" is assumed to be not bare (bare = 594false), while all other repositories are assumed to be bare (bare 595= true). 596 597core.worktree:: 598 Set the path to the root of the working tree. 599 If `GIT_COMMON_DIR` environment variable is set, core.worktree 600 is ignored and not used for determining the root of working tree. 601 This can be overridden by the `GIT_WORK_TREE` environment 602 variable and the `--work-tree` command-line option. 603 The value can be an absolute path or relative to the path to 604 the .git directory, which is either specified by --git-dir 605 or GIT_DIR, or automatically discovered. 606 If --git-dir or GIT_DIR is specified but none of 607 --work-tree, GIT_WORK_TREE and core.worktree is specified, 608 the current working directory is regarded as the top level 609 of your working tree. 610+ 611Note that this variable is honored even when set in a configuration 612file in a ".git" subdirectory of a directory and its value differs 613from the latter directory (e.g. "/path/to/.git/config" has 614core.worktree set to "/different/path"), which is most likely a 615misconfiguration. Running Git commands in the "/path/to" directory will 616still use "/different/path" as the root of the work tree and can cause 617confusion unless you know what you are doing (e.g. you are creating a 618read-only snapshot of the same index to a location different from the 619repository's usual working tree). 620 621core.logAllRefUpdates:: 622 Enable the reflog. Updates to a ref <ref> is logged to the file 623 "`$GIT_DIR/logs/<ref>`", by appending the new and old 624 SHA-1, the date/time and the reason of the update, but 625 only when the file exists. If this configuration 626 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 627 file is automatically created for branch heads (i.e. under 628 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 629 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 630 If it is set to `always`, then a missing reflog is automatically 631 created for any ref under `refs/`. 632+ 633This information can be used to determine what commit 634was the tip of a branch "2 days ago". 635+ 636This value is true by default in a repository that has 637a working directory associated with it, and false by 638default in a bare repository. 639 640core.repositoryFormatVersion:: 641 Internal variable identifying the repository format and layout 642 version. 643 644core.sharedRepository:: 645 When 'group' (or 'true'), the repository is made shareable between 646 several users in a group (making sure all the files and objects are 647 group-writable). When 'all' (or 'world' or 'everybody'), the 648 repository will be readable by all users, additionally to being 649 group-shareable. When 'umask' (or 'false'), Git will use permissions 650 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 651 files in the repository will have this mode value. '0xxx' will override 652 user's umask value (whereas the other options will only override 653 requested parts of the user's umask value). Examples: '0660' will make 654 the repo read/write-able for the owner and group, but inaccessible to 655 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 656 repository that is group-readable but not group-writable. 657 See linkgit:git-init[1]. False by default. 658 659core.warnAmbiguousRefs:: 660 If true, Git will warn you if the ref name you passed it is ambiguous 661 and might match multiple refs in the repository. True by default. 662 663core.compression:: 664 An integer -1..9, indicating a default compression level. 665 -1 is the zlib default. 0 means no compression, 666 and 1..9 are various speed/size tradeoffs, 9 being slowest. 667 If set, this provides a default to other compression variables, 668 such as `core.looseCompression` and `pack.compression`. 669 670core.looseCompression:: 671 An integer -1..9, indicating the compression level for objects that 672 are not in a pack file. -1 is the zlib default. 0 means no 673 compression, and 1..9 are various speed/size tradeoffs, 9 being 674 slowest. If not set, defaults to core.compression. If that is 675 not set, defaults to 1 (best speed). 676 677core.packedGitWindowSize:: 678 Number of bytes of a pack file to map into memory in a 679 single mapping operation. Larger window sizes may allow 680 your system to process a smaller number of large pack files 681 more quickly. Smaller window sizes will negatively affect 682 performance due to increased calls to the operating system's 683 memory manager, but may improve performance when accessing 684 a large number of large pack files. 685+ 686Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 687MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 688be reasonable for all users/operating systems. You probably do 689not need to adjust this value. 690+ 691Common unit suffixes of 'k', 'm', or 'g' are supported. 692 693core.packedGitLimit:: 694 Maximum number of bytes to map simultaneously into memory 695 from pack files. If Git needs to access more than this many 696 bytes at once to complete an operation it will unmap existing 697 regions to reclaim virtual address space within the process. 698+ 699Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 700unlimited) on 64 bit platforms. 701This should be reasonable for all users/operating systems, except on 702the largest projects. You probably do not need to adjust this value. 703+ 704Common unit suffixes of 'k', 'm', or 'g' are supported. 705 706core.deltaBaseCacheLimit:: 707 Maximum number of bytes to reserve for caching base objects 708 that may be referenced by multiple deltified objects. By storing the 709 entire decompressed base objects in a cache Git is able 710 to avoid unpacking and decompressing frequently used base 711 objects multiple times. 712+ 713Default is 96 MiB on all platforms. This should be reasonable 714for all users/operating systems, except on the largest projects. 715You probably do not need to adjust this value. 716+ 717Common unit suffixes of 'k', 'm', or 'g' are supported. 718 719core.bigFileThreshold:: 720 Files larger than this size are stored deflated, without 721 attempting delta compression. Storing large files without 722 delta compression avoids excessive memory usage, at the 723 slight expense of increased disk usage. Additionally files 724 larger than this size are always treated as binary. 725+ 726Default is 512 MiB on all platforms. This should be reasonable 727for most projects as source code and other text files can still 728be delta compressed, but larger binary media files won't be. 729+ 730Common unit suffixes of 'k', 'm', or 'g' are supported. 731 732core.excludesFile:: 733 Specifies the pathname to the file that contains patterns to 734 describe paths that are not meant to be tracked, in addition 735 to '.gitignore' (per-directory) and '.git/info/exclude'. 736 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 737 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 738 is used instead. See linkgit:gitignore[5]. 739 740core.askPass:: 741 Some commands (e.g. svn and http interfaces) that interactively 742 ask for a password can be told to use an external program given 743 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 744 environment variable. If not set, fall back to the value of the 745 `SSH_ASKPASS` environment variable or, failing that, a simple password 746 prompt. The external program shall be given a suitable prompt as 747 command-line argument and write the password on its STDOUT. 748 749core.attributesFile:: 750 In addition to '.gitattributes' (per-directory) and 751 '.git/info/attributes', Git looks into this file for attributes 752 (see linkgit:gitattributes[5]). Path expansions are made the same 753 way as for `core.excludesFile`. Its default value is 754 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 755 set or empty, `$HOME/.config/git/attributes` is used instead. 756 757core.hooksPath:: 758 By default Git will look for your hooks in the 759 '$GIT_DIR/hooks' directory. Set this to different path, 760 e.g. '/etc/git/hooks', and Git will try to find your hooks in 761 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 762 in '$GIT_DIR/hooks/pre-receive'. 763+ 764The path can be either absolute or relative. A relative path is 765taken as relative to the directory where the hooks are run (see 766the "DESCRIPTION" section of linkgit:githooks[5]). 767+ 768This configuration variable is useful in cases where you'd like to 769centrally configure your Git hooks instead of configuring them on a 770per-repository basis, or as a more flexible and centralized 771alternative to having an `init.templateDir` where you've changed 772default hooks. 773 774core.editor:: 775 Commands such as `commit` and `tag` that let you edit 776 messages by launching an editor use the value of this 777 variable when it is set, and the environment variable 778 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 779 780core.commentChar:: 781 Commands such as `commit` and `tag` that let you edit 782 messages consider a line that begins with this character 783 commented, and removes them after the editor returns 784 (default '#'). 785+ 786If set to "auto", `git-commit` would select a character that is not 787the beginning character of any line in existing commit messages. 788 789core.filesRefLockTimeout:: 790 The length of time, in milliseconds, to retry when trying to 791 lock an individual reference. Value 0 means not to retry at 792 all; -1 means to try indefinitely. Default is 100 (i.e., 793 retry for 100ms). 794 795core.packedRefsTimeout:: 796 The length of time, in milliseconds, to retry when trying to 797 lock the `packed-refs` file. Value 0 means not to retry at 798 all; -1 means to try indefinitely. Default is 1000 (i.e., 799 retry for 1 second). 800 801sequence.editor:: 802 Text editor used by `git rebase -i` for editing the rebase instruction file. 803 The value is meant to be interpreted by the shell when it is used. 804 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 805 When not configured the default commit message editor is used instead. 806 807core.pager:: 808 Text viewer for use by Git commands (e.g., 'less'). The value 809 is meant to be interpreted by the shell. The order of preference 810 is the `$GIT_PAGER` environment variable, then `core.pager` 811 configuration, then `$PAGER`, and then the default chosen at 812 compile time (usually 'less'). 813+ 814When the `LESS` environment variable is unset, Git sets it to `FRX` 815(if `LESS` environment variable is set, Git does not change it at 816all). If you want to selectively override Git's default setting 817for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 818be passed to the shell by Git, which will translate the final 819command to `LESS=FRX less -S`. The environment does not set the 820`S` option but the command line does, instructing less to truncate 821long lines. Similarly, setting `core.pager` to `less -+F` will 822deactivate the `F` option specified by the environment from the 823command-line, deactivating the "quit if one screen" behavior of 824`less`. One can specifically activate some flags for particular 825commands: for example, setting `pager.blame` to `less -S` enables 826line truncation only for `git blame`. 827+ 828Likewise, when the `LV` environment variable is unset, Git sets it 829to `-c`. You can override this setting by exporting `LV` with 830another value or setting `core.pager` to `lv +c`. 831 832core.whitespace:: 833 A comma separated list of common whitespace problems to 834 notice. 'git diff' will use `color.diff.whitespace` to 835 highlight them, and 'git apply --whitespace=error' will 836 consider them as errors. You can prefix `-` to disable 837 any of them (e.g. `-trailing-space`): 838+ 839* `blank-at-eol` treats trailing whitespaces at the end of the line 840 as an error (enabled by default). 841* `space-before-tab` treats a space character that appears immediately 842 before a tab character in the initial indent part of the line as an 843 error (enabled by default). 844* `indent-with-non-tab` treats a line that is indented with space 845 characters instead of the equivalent tabs as an error (not enabled by 846 default). 847* `tab-in-indent` treats a tab character in the initial indent part of 848 the line as an error (not enabled by default). 849* `blank-at-eof` treats blank lines added at the end of file as an error 850 (enabled by default). 851* `trailing-space` is a short-hand to cover both `blank-at-eol` and 852 `blank-at-eof`. 853* `cr-at-eol` treats a carriage-return at the end of line as 854 part of the line terminator, i.e. with it, `trailing-space` 855 does not trigger if the character before such a carriage-return 856 is not a whitespace (not enabled by default). 857* `tabwidth=<n>` tells how many character positions a tab occupies; this 858 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 859 errors. The default tab width is 8. Allowed values are 1 to 63. 860 861core.fsyncObjectFiles:: 862 This boolean will enable 'fsync()' when writing object files. 863+ 864This is a total waste of time and effort on a filesystem that orders 865data writes properly, but can be useful for filesystems that do not use 866journalling (traditional UNIX filesystems) or that only journal metadata 867and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 868 869core.preloadIndex:: 870 Enable parallel index preload for operations like 'git diff' 871+ 872This can speed up operations like 'git diff' and 'git status' especially 873on filesystems like NFS that have weak caching semantics and thus 874relatively high IO latencies. When enabled, Git will do the 875index comparison to the filesystem data in parallel, allowing 876overlapping IO's. Defaults to true. 877 878core.createObject:: 879 You can set this to 'link', in which case a hardlink followed by 880 a delete of the source are used to make sure that object creation 881 will not overwrite existing objects. 882+ 883On some file system/operating system combinations, this is unreliable. 884Set this config setting to 'rename' there; However, This will remove the 885check that makes sure that existing object files will not get overwritten. 886 887core.notesRef:: 888 When showing commit messages, also show notes which are stored in 889 the given ref. The ref must be fully qualified. If the given 890 ref does not exist, it is not an error but means that no 891 notes should be printed. 892+ 893This setting defaults to "refs/notes/commits", and it can be overridden by 894the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 895 896core.sparseCheckout:: 897 Enable "sparse checkout" feature. See section "Sparse checkout" in 898 linkgit:git-read-tree[1] for more information. 899 900core.abbrev:: 901 Set the length object names are abbreviated to. If 902 unspecified or set to "auto", an appropriate value is 903 computed based on the approximate number of packed objects 904 in your repository, which hopefully is enough for 905 abbreviated object names to stay unique for some time. 906 The minimum length is 4. 907 908add.ignoreErrors:: 909add.ignore-errors (deprecated):: 910 Tells 'git add' to continue adding files when some files cannot be 911 added due to indexing errors. Equivalent to the `--ignore-errors` 912 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 913 as it does not follow the usual naming convention for configuration 914 variables. 915 916alias.*:: 917 Command aliases for the linkgit:git[1] command wrapper - e.g. 918 after defining "alias.last = cat-file commit HEAD", the invocation 919 "git last" is equivalent to "git cat-file commit HEAD". To avoid 920 confusion and troubles with script usage, aliases that 921 hide existing Git commands are ignored. Arguments are split by 922 spaces, the usual shell quoting and escaping is supported. 923 A quote pair or a backslash can be used to quote them. 924+ 925If the alias expansion is prefixed with an exclamation point, 926it will be treated as a shell command. For example, defining 927"alias.new = !gitk --all --not ORIG_HEAD", the invocation 928"git new" is equivalent to running the shell command 929"gitk --all --not ORIG_HEAD". Note that shell commands will be 930executed from the top-level directory of a repository, which may 931not necessarily be the current directory. 932`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 933from the original current directory. See linkgit:git-rev-parse[1]. 934 935am.keepcr:: 936 If true, git-am will call git-mailsplit for patches in mbox format 937 with parameter `--keep-cr`. In this case git-mailsplit will 938 not remove `\r` from lines ending with `\r\n`. Can be overridden 939 by giving `--no-keep-cr` from the command line. 940 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 941 942am.threeWay:: 943 By default, `git am` will fail if the patch does not apply cleanly. When 944 set to true, this setting tells `git am` to fall back on 3-way merge if 945 the patch records the identity of blobs it is supposed to apply to and 946 we have those blobs available locally (equivalent to giving the `--3way` 947 option from the command line). Defaults to `false`. 948 See linkgit:git-am[1]. 949 950apply.ignoreWhitespace:: 951 When set to 'change', tells 'git apply' to ignore changes in 952 whitespace, in the same way as the `--ignore-space-change` 953 option. 954 When set to one of: no, none, never, false tells 'git apply' to 955 respect all whitespace differences. 956 See linkgit:git-apply[1]. 957 958apply.whitespace:: 959 Tells 'git apply' how to handle whitespaces, in the same way 960 as the `--whitespace` option. See linkgit:git-apply[1]. 961 962blame.showRoot:: 963 Do not treat root commits as boundaries in linkgit:git-blame[1]. 964 This option defaults to false. 965 966blame.blankBoundary:: 967 Show blank commit object name for boundary commits in 968 linkgit:git-blame[1]. This option defaults to false. 969 970blame.showEmail:: 971 Show the author email instead of author name in linkgit:git-blame[1]. 972 This option defaults to false. 973 974blame.date:: 975 Specifies the format used to output dates in linkgit:git-blame[1]. 976 If unset the iso format is used. For supported values, 977 see the discussion of the `--date` option at linkgit:git-log[1]. 978 979branch.autoSetupMerge:: 980 Tells 'git branch' and 'git checkout' to set up new branches 981 so that linkgit:git-pull[1] will appropriately merge from the 982 starting point branch. Note that even if this option is not set, 983 this behavior can be chosen per-branch using the `--track` 984 and `--no-track` options. The valid settings are: `false` -- no 985 automatic setup is done; `true` -- automatic setup is done when the 986 starting point is a remote-tracking branch; `always` -- 987 automatic setup is done when the starting point is either a 988 local branch or remote-tracking 989 branch. This option defaults to true. 990 991branch.autoSetupRebase:: 992 When a new branch is created with 'git branch' or 'git checkout' 993 that tracks another branch, this variable tells Git to set 994 up pull to rebase instead of merge (see "branch.<name>.rebase"). 995 When `never`, rebase is never automatically set to true. 996 When `local`, rebase is set to true for tracked branches of 997 other local branches. 998 When `remote`, rebase is set to true for tracked branches of 999 remote-tracking branches.1000 When `always`, rebase will be set to true for all tracking1001 branches.1002 See "branch.autoSetupMerge" for details on how to set up a1003 branch to track another branch.1004 This option defaults to never.10051006branch.<name>.remote::1007 When on branch <name>, it tells 'git fetch' and 'git push'1008 which remote to fetch from/push to. The remote to push to1009 may be overridden with `remote.pushDefault` (for all branches).1010 The remote to push to, for the current branch, may be further1011 overridden by `branch.<name>.pushRemote`. If no remote is1012 configured, or if you are not on any branch, it defaults to1013 `origin` for fetching and `remote.pushDefault` for pushing.1014 Additionally, `.` (a period) is the current local repository1015 (a dot-repository), see `branch.<name>.merge`'s final note below.10161017branch.<name>.pushRemote::1018 When on branch <name>, it overrides `branch.<name>.remote` for1019 pushing. It also overrides `remote.pushDefault` for pushing1020 from branch <name>. When you pull from one place (e.g. your1021 upstream) and push to another place (e.g. your own publishing1022 repository), you would want to set `remote.pushDefault` to1023 specify the remote to push to for all branches, and use this1024 option to override it for a specific branch.10251026branch.<name>.merge::1027 Defines, together with branch.<name>.remote, the upstream branch1028 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1029 branch to merge and can also affect 'git push' (see push.default).1030 When in branch <name>, it tells 'git fetch' the default1031 refspec to be marked for merging in FETCH_HEAD. The value is1032 handled like the remote part of a refspec, and must match a1033 ref which is fetched from the remote given by1034 "branch.<name>.remote".1035 The merge information is used by 'git pull' (which at first calls1036 'git fetch') to lookup the default branch for merging. Without1037 this option, 'git pull' defaults to merge the first refspec fetched.1038 Specify multiple values to get an octopus merge.1039 If you wish to setup 'git pull' so that it merges into <name> from1040 another branch in the local repository, you can point1041 branch.<name>.merge to the desired branch, and use the relative path1042 setting `.` (a period) for branch.<name>.remote.10431044branch.<name>.mergeOptions::1045 Sets default options for merging into branch <name>. The syntax and1046 supported options are the same as those of linkgit:git-merge[1], but1047 option values containing whitespace characters are currently not1048 supported.10491050branch.<name>.rebase::1051 When true, rebase the branch <name> on top of the fetched branch,1052 instead of merging the default branch from the default remote when1053 "git pull" is run. See "pull.rebase" for doing this in a non1054 branch-specific manner.1055+1056When preserve, also pass `--preserve-merges` along to 'git rebase'1057so that locally committed merge commits will not be flattened1058by running 'git pull'.1059+1060When the value is `interactive`, the rebase is run in interactive mode.1061+1062*NOTE*: this is a possibly dangerous operation; do *not* use1063it unless you understand the implications (see linkgit:git-rebase[1]1064for details).10651066branch.<name>.description::1067 Branch description, can be edited with1068 `git branch --edit-description`. Branch description is1069 automatically added in the format-patch cover letter or1070 request-pull summary.10711072browser.<tool>.cmd::1073 Specify the command to invoke the specified browser. The1074 specified command is evaluated in shell with the URLs passed1075 as arguments. (See linkgit:git-web{litdd}browse[1].)10761077browser.<tool>.path::1078 Override the path for the given tool that may be used to1079 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1080 working repository in gitweb (see linkgit:git-instaweb[1]).10811082clean.requireForce::1083 A boolean to make git-clean do nothing unless given -f,1084 -i or -n. Defaults to true.10851086color.branch::1087 A boolean to enable/disable color in the output of1088 linkgit:git-branch[1]. May be set to `always`,1089 `false` (or `never`) or `auto` (or `true`), in which case colors are used1090 only when the output is to a terminal. If unset, then the1091 value of `color.ui` is used (`auto` by default).10921093color.branch.<slot>::1094 Use customized color for branch coloration. `<slot>` is one of1095 `current` (the current branch), `local` (a local branch),1096 `remote` (a remote-tracking branch in refs/remotes/),1097 `upstream` (upstream tracking branch), `plain` (other1098 refs).10991100color.diff::1101 Whether to use ANSI escape sequences to add color to patches.1102 If this is set to `always`, linkgit:git-diff[1],1103 linkgit:git-log[1], and linkgit:git-show[1] will use color1104 for all patches. If it is set to `true` or `auto`, those1105 commands will only use color when output is to the terminal.1106 If unset, then the value of `color.ui` is used (`auto` by1107 default).1108+1109This does not affect linkgit:git-format-patch[1] or the1110'git-diff-{asterisk}' plumbing commands. Can be overridden on the1111command line with the `--color[=<when>]` option.11121113diff.colorMoved::1114 If set to either a valid `<mode>` or a true value, moved lines1115 in a diff are colored differently, for details of valid modes1116 see '--color-moved' in linkgit:git-diff[1]. If simply set to1117 true the default color mode will be used. When set to false,1118 moved lines are not colored.11191120color.diff.<slot>::1121 Use customized color for diff colorization. `<slot>` specifies1122 which part of the patch to use the specified color, and is one1123 of `context` (context text - `plain` is a historical synonym),1124 `meta` (metainformation), `frag`1125 (hunk header), 'func' (function in hunk header), `old` (removed lines),1126 `new` (added lines), `commit` (commit headers), `whitespace`1127 (highlighting whitespace errors), `oldMoved` (deleted lines),1128 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1129 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1130 and `newMovedAlternativeDimmed` (See the '<mode>'1131 setting of '--color-moved' in linkgit:git-diff[1] for details).11321133color.decorate.<slot>::1134 Use customized color for 'git log --decorate' output. `<slot>` is one1135 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1136 branches, remote-tracking branches, tags, stash and HEAD, respectively.11371138color.grep::1139 When set to `always`, always highlight matches. When `false` (or1140 `never`), never. When set to `true` or `auto`, use color only1141 when the output is written to the terminal. If unset, then the1142 value of `color.ui` is used (`auto` by default).11431144color.grep.<slot>::1145 Use customized color for grep colorization. `<slot>` specifies which1146 part of the line to use the specified color, and is one of1147+1148--1149`context`;;1150 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1151`filename`;;1152 filename prefix (when not using `-h`)1153`function`;;1154 function name lines (when using `-p`)1155`linenumber`;;1156 line number prefix (when using `-n`)1157`match`;;1158 matching text (same as setting `matchContext` and `matchSelected`)1159`matchContext`;;1160 matching text in context lines1161`matchSelected`;;1162 matching text in selected lines1163`selected`;;1164 non-matching text in selected lines1165`separator`;;1166 separators between fields on a line (`:`, `-`, and `=`)1167 and between hunks (`--`)1168--11691170color.interactive::1171 When set to `always`, always use colors for interactive prompts1172 and displays (such as those used by "git-add --interactive" and1173 "git-clean --interactive"). When false (or `never`), never.1174 When set to `true` or `auto`, use colors only when the output is1175 to the terminal. If unset, then the value of `color.ui` is1176 used (`auto` by default).11771178color.interactive.<slot>::1179 Use customized color for 'git add --interactive' and 'git clean1180 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1181 or `error`, for four distinct types of normal output from1182 interactive commands.11831184color.pager::1185 A boolean to enable/disable colored output when the pager is in1186 use (default is true).11871188color.showBranch::1189 A boolean to enable/disable color in the output of1190 linkgit:git-show-branch[1]. May be set to `always`,1191 `false` (or `never`) or `auto` (or `true`), in which case colors are used1192 only when the output is to a terminal. If unset, then the1193 value of `color.ui` is used (`auto` by default).11941195color.status::1196 A boolean to enable/disable color in the output of1197 linkgit:git-status[1]. May be set to `always`,1198 `false` (or `never`) or `auto` (or `true`), in which case colors are used1199 only when the output is to a terminal. If unset, then the1200 value of `color.ui` is used (`auto` by default).12011202color.status.<slot>::1203 Use customized color for status colorization. `<slot>` is1204 one of `header` (the header text of the status message),1205 `added` or `updated` (files which are added but not committed),1206 `changed` (files which are changed but not added in the index),1207 `untracked` (files which are not tracked by Git),1208 `branch` (the current branch),1209 `nobranch` (the color the 'no branch' warning is shown in, defaulting1210 to red),1211 `localBranch` or `remoteBranch` (the local and remote branch names,1212 respectively, when branch and tracking information is displayed in the1213 status short-format), or1214 `unmerged` (files which have unmerged changes).12151216color.ui::1217 This variable determines the default value for variables such1218 as `color.diff` and `color.grep` that control the use of color1219 per command family. Its scope will expand as more commands learn1220 configuration to set a default for the `--color` option. Set it1221 to `false` or `never` if you prefer Git commands not to use1222 color unless enabled explicitly with some other configuration1223 or the `--color` option. Set it to `always` if you want all1224 output not intended for machine consumption to use color, to1225 `true` or `auto` (this is the default since Git 1.8.4) if you1226 want such output to use color when written to the terminal.12271228column.ui::1229 Specify whether supported commands should output in columns.1230 This variable consists of a list of tokens separated by spaces1231 or commas:1232+1233These options control when the feature should be enabled1234(defaults to 'never'):1235+1236--1237`always`;;1238 always show in columns1239`never`;;1240 never show in columns1241`auto`;;1242 show in columns if the output is to the terminal1243--1244+1245These options control layout (defaults to 'column'). Setting any1246of these implies 'always' if none of 'always', 'never', or 'auto' are1247specified.1248+1249--1250`column`;;1251 fill columns before rows1252`row`;;1253 fill rows before columns1254`plain`;;1255 show in one column1256--1257+1258Finally, these options can be combined with a layout option (defaults1259to 'nodense'):1260+1261--1262`dense`;;1263 make unequal size columns to utilize more space1264`nodense`;;1265 make equal size columns1266--12671268column.branch::1269 Specify whether to output branch listing in `git branch` in columns.1270 See `column.ui` for details.12711272column.clean::1273 Specify the layout when list items in `git clean -i`, which always1274 shows files and directories in columns. See `column.ui` for details.12751276column.status::1277 Specify whether to output untracked files in `git status` in columns.1278 See `column.ui` for details.12791280column.tag::1281 Specify whether to output tag listing in `git tag` in columns.1282 See `column.ui` for details.12831284commit.cleanup::1285 This setting overrides the default of the `--cleanup` option in1286 `git commit`. See linkgit:git-commit[1] for details. Changing the1287 default can be useful when you always want to keep lines that begin1288 with comment character `#` in your log message, in which case you1289 would do `git config commit.cleanup whitespace` (note that you will1290 have to remove the help lines that begin with `#` in the commit log1291 template yourself, if you do this).12921293commit.gpgSign::12941295 A boolean to specify whether all commits should be GPG signed.1296 Use of this option when doing operations such as rebase can1297 result in a large number of commits being signed. It may be1298 convenient to use an agent to avoid typing your GPG passphrase1299 several times.13001301commit.status::1302 A boolean to enable/disable inclusion of status information in the1303 commit message template when using an editor to prepare the commit1304 message. Defaults to true.13051306commit.template::1307 Specify the pathname of a file to use as the template for1308 new commit messages.13091310commit.verbose::1311 A boolean or int to specify the level of verbose with `git commit`.1312 See linkgit:git-commit[1].13131314credential.helper::1315 Specify an external helper to be called when a username or1316 password credential is needed; the helper may consult external1317 storage to avoid prompting the user for the credentials. Note1318 that multiple helpers may be defined. See linkgit:gitcredentials[7]1319 for details.13201321credential.useHttpPath::1322 When acquiring credentials, consider the "path" component of an http1323 or https URL to be important. Defaults to false. See1324 linkgit:gitcredentials[7] for more information.13251326credential.username::1327 If no username is set for a network authentication, use this username1328 by default. See credential.<context>.* below, and1329 linkgit:gitcredentials[7].13301331credential.<url>.*::1332 Any of the credential.* options above can be applied selectively to1333 some credentials. For example "credential.https://example.com.username"1334 would set the default username only for https connections to1335 example.com. See linkgit:gitcredentials[7] for details on how URLs are1336 matched.13371338credentialCache.ignoreSIGHUP::1339 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13401341include::diff-config.txt[]13421343difftool.<tool>.path::1344 Override the path for the given tool. This is useful in case1345 your tool is not in the PATH.13461347difftool.<tool>.cmd::1348 Specify the command to invoke the specified diff tool.1349 The specified command is evaluated in shell with the following1350 variables available: 'LOCAL' is set to the name of the temporary1351 file containing the contents of the diff pre-image and 'REMOTE'1352 is set to the name of the temporary file containing the contents1353 of the diff post-image.13541355difftool.prompt::1356 Prompt before each invocation of the diff tool.13571358fastimport.unpackLimit::1359 If the number of objects imported by linkgit:git-fast-import[1]1360 is below this limit, then the objects will be unpacked into1361 loose object files. However if the number of imported objects1362 equals or exceeds this limit then the pack will be stored as a1363 pack. Storing the pack from a fast-import can make the import1364 operation complete faster, especially on slow filesystems. If1365 not set, the value of `transfer.unpackLimit` is used instead.13661367fetch.recurseSubmodules::1368 This option can be either set to a boolean value or to 'on-demand'.1369 Setting it to a boolean changes the behavior of fetch and pull to1370 unconditionally recurse into submodules when set to true or to not1371 recurse at all when set to false. When set to 'on-demand' (the default1372 value), fetch and pull will only recurse into a populated submodule1373 when its superproject retrieves a commit that updates the submodule's1374 reference.13751376fetch.fsckObjects::1377 If it is set to true, git-fetch-pack will check all fetched1378 objects. It will abort in the case of a malformed object or a1379 broken link. The result of an abort are only dangling objects.1380 Defaults to false. If not set, the value of `transfer.fsckObjects`1381 is used instead.13821383fetch.unpackLimit::1384 If the number of objects fetched over the Git native1385 transfer is below this1386 limit, then the objects will be unpacked into loose object1387 files. However if the number of received objects equals or1388 exceeds this limit then the received pack will be stored as1389 a pack, after adding any missing delta bases. Storing the1390 pack from a push can make the push operation complete faster,1391 especially on slow filesystems. If not set, the value of1392 `transfer.unpackLimit` is used instead.13931394fetch.prune::1395 If true, fetch will automatically behave as if the `--prune`1396 option was given on the command line. See also `remote.<name>.prune`.13971398fetch.output::1399 Control how ref update status is printed. Valid values are1400 `full` and `compact`. Default value is `full`. See section1401 OUTPUT in linkgit:git-fetch[1] for detail.14021403format.attach::1404 Enable multipart/mixed attachments as the default for1405 'format-patch'. The value can also be a double quoted string1406 which will enable attachments as the default and set the1407 value as the boundary. See the --attach option in1408 linkgit:git-format-patch[1].14091410format.from::1411 Provides the default value for the `--from` option to format-patch.1412 Accepts a boolean value, or a name and email address. If false,1413 format-patch defaults to `--no-from`, using commit authors directly in1414 the "From:" field of patch mails. If true, format-patch defaults to1415 `--from`, using your committer identity in the "From:" field of patch1416 mails and including a "From:" field in the body of the patch mail if1417 different. If set to a non-boolean value, format-patch uses that1418 value instead of your committer identity. Defaults to false.14191420format.numbered::1421 A boolean which can enable or disable sequence numbers in patch1422 subjects. It defaults to "auto" which enables it only if there1423 is more than one patch. It can be enabled or disabled for all1424 messages by setting it to "true" or "false". See --numbered1425 option in linkgit:git-format-patch[1].14261427format.headers::1428 Additional email headers to include in a patch to be submitted1429 by mail. See linkgit:git-format-patch[1].14301431format.to::1432format.cc::1433 Additional recipients to include in a patch to be submitted1434 by mail. See the --to and --cc options in1435 linkgit:git-format-patch[1].14361437format.subjectPrefix::1438 The default for format-patch is to output files with the '[PATCH]'1439 subject prefix. Use this variable to change that prefix.14401441format.signature::1442 The default for format-patch is to output a signature containing1443 the Git version number. Use this variable to change that default.1444 Set this variable to the empty string ("") to suppress1445 signature generation.14461447format.signatureFile::1448 Works just like format.signature except the contents of the1449 file specified by this variable will be used as the signature.14501451format.suffix::1452 The default for format-patch is to output files with the suffix1453 `.patch`. Use this variable to change that suffix (make sure to1454 include the dot if you want it).14551456format.pretty::1457 The default pretty format for log/show/whatchanged command,1458 See linkgit:git-log[1], linkgit:git-show[1],1459 linkgit:git-whatchanged[1].14601461format.thread::1462 The default threading style for 'git format-patch'. Can be1463 a boolean value, or `shallow` or `deep`. `shallow` threading1464 makes every mail a reply to the head of the series,1465 where the head is chosen from the cover letter, the1466 `--in-reply-to`, and the first patch mail, in this order.1467 `deep` threading makes every mail a reply to the previous one.1468 A true boolean value is the same as `shallow`, and a false1469 value disables threading.14701471format.signOff::1472 A boolean value which lets you enable the `-s/--signoff` option of1473 format-patch by default. *Note:* Adding the Signed-off-by: line to a1474 patch should be a conscious act and means that you certify you have1475 the rights to submit this work under the same open source license.1476 Please see the 'SubmittingPatches' document for further discussion.14771478format.coverLetter::1479 A boolean that controls whether to generate a cover-letter when1480 format-patch is invoked, but in addition can be set to "auto", to1481 generate a cover-letter only when there's more than one patch.14821483format.outputDirectory::1484 Set a custom directory to store the resulting files instead of the1485 current working directory.14861487format.useAutoBase::1488 A boolean value which lets you enable the `--base=auto` option of1489 format-patch by default.14901491filter.<driver>.clean::1492 The command which is used to convert the content of a worktree1493 file to a blob upon checkin. See linkgit:gitattributes[5] for1494 details.14951496filter.<driver>.smudge::1497 The command which is used to convert the content of a blob1498 object to a worktree file upon checkout. See1499 linkgit:gitattributes[5] for details.15001501fsck.<msg-id>::1502 Allows overriding the message type (error, warn or ignore) of a1503 specific message ID such as `missingEmail`.1504+1505For convenience, fsck prefixes the error/warning with the message ID,1506e.g. "missingEmail: invalid author/committer line - missing email" means1507that setting `fsck.missingEmail = ignore` will hide that issue.1508+1509This feature is intended to support working with legacy repositories1510which cannot be repaired without disruptive changes.15111512fsck.skipList::1513 The path to a sorted list of object names (i.e. one SHA-1 per1514 line) that are known to be broken in a non-fatal way and should1515 be ignored. This feature is useful when an established project1516 should be accepted despite early commits containing errors that1517 can be safely ignored such as invalid committer email addresses.1518 Note: corrupt objects cannot be skipped with this setting.15191520gc.aggressiveDepth::1521 The depth parameter used in the delta compression1522 algorithm used by 'git gc --aggressive'. This defaults1523 to 50.15241525gc.aggressiveWindow::1526 The window size parameter used in the delta compression1527 algorithm used by 'git gc --aggressive'. This defaults1528 to 250.15291530gc.auto::1531 When there are approximately more than this many loose1532 objects in the repository, `git gc --auto` will pack them.1533 Some Porcelain commands use this command to perform a1534 light-weight garbage collection from time to time. The1535 default value is 6700. Setting this to 0 disables it.15361537gc.autoPackLimit::1538 When there are more than this many packs that are not1539 marked with `*.keep` file in the repository, `git gc1540 --auto` consolidates them into one larger pack. The1541 default value is 50. Setting this to 0 disables it.15421543gc.autoDetach::1544 Make `git gc --auto` return immediately and run in background1545 if the system supports it. Default is true.15461547gc.logExpiry::1548 If the file gc.log exists, then `git gc --auto` won't run1549 unless that file is more than 'gc.logExpiry' old. Default is1550 "1.day". See `gc.pruneExpire` for more ways to specify its1551 value.15521553gc.packRefs::1554 Running `git pack-refs` in a repository renders it1555 unclonable by Git versions prior to 1.5.1.2 over dumb1556 transports such as HTTP. This variable determines whether1557 'git gc' runs `git pack-refs`. This can be set to `notbare`1558 to enable it within all non-bare repos or it can be set to a1559 boolean value. The default is `true`.15601561gc.pruneExpire::1562 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1563 Override the grace period with this config variable. The value1564 "now" may be used to disable this grace period and always prune1565 unreachable objects immediately, or "never" may be used to1566 suppress pruning. This feature helps prevent corruption when1567 'git gc' runs concurrently with another process writing to the1568 repository; see the "NOTES" section of linkgit:git-gc[1].15691570gc.worktreePruneExpire::1571 When 'git gc' is run, it calls1572 'git worktree prune --expire 3.months.ago'.1573 This config variable can be used to set a different grace1574 period. The value "now" may be used to disable the grace1575 period and prune `$GIT_DIR/worktrees` immediately, or "never"1576 may be used to suppress pruning.15771578gc.reflogExpire::1579gc.<pattern>.reflogExpire::1580 'git reflog expire' removes reflog entries older than1581 this time; defaults to 90 days. The value "now" expires all1582 entries immediately, and "never" suppresses expiration1583 altogether. With "<pattern>" (e.g.1584 "refs/stash") in the middle the setting applies only to1585 the refs that match the <pattern>.15861587gc.reflogExpireUnreachable::1588gc.<pattern>.reflogExpireUnreachable::1589 'git reflog expire' removes reflog entries older than1590 this time and are not reachable from the current tip;1591 defaults to 30 days. The value "now" expires all entries1592 immediately, and "never" suppresses expiration altogether.1593 With "<pattern>" (e.g. "refs/stash")1594 in the middle, the setting applies only to the refs that1595 match the <pattern>.15961597gc.rerereResolved::1598 Records of conflicted merge you resolved earlier are1599 kept for this many days when 'git rerere gc' is run.1600 You can also use more human-readable "1.month.ago", etc.1601 The default is 60 days. See linkgit:git-rerere[1].16021603gc.rerereUnresolved::1604 Records of conflicted merge you have not resolved are1605 kept for this many days when 'git rerere gc' is run.1606 You can also use more human-readable "1.month.ago", etc.1607 The default is 15 days. See linkgit:git-rerere[1].16081609gitcvs.commitMsgAnnotation::1610 Append this string to each commit message. Set to empty string1611 to disable this feature. Defaults to "via git-CVS emulator".16121613gitcvs.enabled::1614 Whether the CVS server interface is enabled for this repository.1615 See linkgit:git-cvsserver[1].16161617gitcvs.logFile::1618 Path to a log file where the CVS server interface well... logs1619 various stuff. See linkgit:git-cvsserver[1].16201621gitcvs.usecrlfattr::1622 If true, the server will look up the end-of-line conversion1623 attributes for files to determine the `-k` modes to use. If1624 the attributes force Git to treat a file as text,1625 the `-k` mode will be left blank so CVS clients will1626 treat it as text. If they suppress text conversion, the file1627 will be set with '-kb' mode, which suppresses any newline munging1628 the client might otherwise do. If the attributes do not allow1629 the file type to be determined, then `gitcvs.allBinary` is1630 used. See linkgit:gitattributes[5].16311632gitcvs.allBinary::1633 This is used if `gitcvs.usecrlfattr` does not resolve1634 the correct '-kb' mode to use. If true, all1635 unresolved files are sent to the client in1636 mode '-kb'. This causes the client to treat them1637 as binary files, which suppresses any newline munging it1638 otherwise might do. Alternatively, if it is set to "guess",1639 then the contents of the file are examined to decide if1640 it is binary, similar to `core.autocrlf`.16411642gitcvs.dbName::1643 Database used by git-cvsserver to cache revision information1644 derived from the Git repository. The exact meaning depends on the1645 used database driver, for SQLite (which is the default driver) this1646 is a filename. Supports variable substitution (see1647 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1648 Default: '%Ggitcvs.%m.sqlite'16491650gitcvs.dbDriver::1651 Used Perl DBI driver. You can specify any available driver1652 for this here, but it might not work. git-cvsserver is tested1653 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1654 reported *not* to work with 'DBD::mysql'. Experimental feature.1655 May not contain double colons (`:`). Default: 'SQLite'.1656 See linkgit:git-cvsserver[1].16571658gitcvs.dbUser, gitcvs.dbPass::1659 Database user and password. Only useful if setting `gitcvs.dbDriver`,1660 since SQLite has no concept of database users and/or passwords.1661 'gitcvs.dbUser' supports variable substitution (see1662 linkgit:git-cvsserver[1] for details).16631664gitcvs.dbTableNamePrefix::1665 Database table name prefix. Prepended to the names of any1666 database tables used, allowing a single database to be used1667 for several repositories. Supports variable substitution (see1668 linkgit:git-cvsserver[1] for details). Any non-alphabetic1669 characters will be replaced with underscores.16701671All gitcvs variables except for `gitcvs.usecrlfattr` and1672`gitcvs.allBinary` can also be specified as1673'gitcvs.<access_method>.<varname>' (where 'access_method'1674is one of "ext" and "pserver") to make them apply only for the given1675access method.16761677gitweb.category::1678gitweb.description::1679gitweb.owner::1680gitweb.url::1681 See linkgit:gitweb[1] for description.16821683gitweb.avatar::1684gitweb.blame::1685gitweb.grep::1686gitweb.highlight::1687gitweb.patches::1688gitweb.pickaxe::1689gitweb.remote_heads::1690gitweb.showSizes::1691gitweb.snapshot::1692 See linkgit:gitweb.conf[5] for description.16931694grep.lineNumber::1695 If set to true, enable `-n` option by default.16961697grep.patternType::1698 Set the default matching behavior. Using a value of 'basic', 'extended',1699 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1700 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1701 value 'default' will return to the default matching behavior.17021703grep.extendedRegexp::1704 If set to true, enable `--extended-regexp` option by default. This1705 option is ignored when the `grep.patternType` option is set to a value1706 other than 'default'.17071708grep.threads::1709 Number of grep worker threads to use.1710 See `grep.threads` in linkgit:git-grep[1] for more information.17111712grep.fallbackToNoIndex::1713 If set to true, fall back to git grep --no-index if git grep1714 is executed outside of a git repository. Defaults to false.17151716gpg.program::1717 Use this custom program instead of "`gpg`" found on `$PATH` when1718 making or verifying a PGP signature. The program must support the1719 same command-line interface as GPG, namely, to verify a detached1720 signature, "`gpg --verify $file - <$signature`" is run, and the1721 program is expected to signal a good signature by exiting with1722 code 0, and to generate an ASCII-armored detached signature, the1723 standard input of "`gpg -bsau $key`" is fed with the contents to be1724 signed, and the program is expected to send the result to its1725 standard output.17261727gui.commitMsgWidth::1728 Defines how wide the commit message window is in the1729 linkgit:git-gui[1]. "75" is the default.17301731gui.diffContext::1732 Specifies how many context lines should be used in calls to diff1733 made by the linkgit:git-gui[1]. The default is "5".17341735gui.displayUntracked::1736 Determines if linkgit:git-gui[1] shows untracked files1737 in the file list. The default is "true".17381739gui.encoding::1740 Specifies the default encoding to use for displaying of1741 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1742 It can be overridden by setting the 'encoding' attribute1743 for relevant files (see linkgit:gitattributes[5]).1744 If this option is not set, the tools default to the1745 locale encoding.17461747gui.matchTrackingBranch::1748 Determines if new branches created with linkgit:git-gui[1] should1749 default to tracking remote branches with matching names or1750 not. Default: "false".17511752gui.newBranchTemplate::1753 Is used as suggested name when creating new branches using the1754 linkgit:git-gui[1].17551756gui.pruneDuringFetch::1757 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1758 performing a fetch. The default value is "false".17591760gui.trustmtime::1761 Determines if linkgit:git-gui[1] should trust the file modification1762 timestamp or not. By default the timestamps are not trusted.17631764gui.spellingDictionary::1765 Specifies the dictionary used for spell checking commit messages in1766 the linkgit:git-gui[1]. When set to "none" spell checking is turned1767 off.17681769gui.fastCopyBlame::1770 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1771 location detection. It makes blame significantly faster on huge1772 repositories at the expense of less thorough copy detection.17731774gui.copyBlameThreshold::1775 Specifies the threshold to use in 'git gui blame' original location1776 detection, measured in alphanumeric characters. See the1777 linkgit:git-blame[1] manual for more information on copy detection.17781779gui.blamehistoryctx::1780 Specifies the radius of history context in days to show in1781 linkgit:gitk[1] for the selected commit, when the `Show History1782 Context` menu item is invoked from 'git gui blame'. If this1783 variable is set to zero, the whole history is shown.17841785guitool.<name>.cmd::1786 Specifies the shell command line to execute when the corresponding item1787 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1788 mandatory for every tool. The command is executed from the root of1789 the working directory, and in the environment it receives the name of1790 the tool as `GIT_GUITOOL`, the name of the currently selected file as1791 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1792 the head is detached, 'CUR_BRANCH' is empty).17931794guitool.<name>.needsFile::1795 Run the tool only if a diff is selected in the GUI. It guarantees1796 that 'FILENAME' is not empty.17971798guitool.<name>.noConsole::1799 Run the command silently, without creating a window to display its1800 output.18011802guitool.<name>.noRescan::1803 Don't rescan the working directory for changes after the tool1804 finishes execution.18051806guitool.<name>.confirm::1807 Show a confirmation dialog before actually running the tool.18081809guitool.<name>.argPrompt::1810 Request a string argument from the user, and pass it to the tool1811 through the `ARGS` environment variable. Since requesting an1812 argument implies confirmation, the 'confirm' option has no effect1813 if this is enabled. If the option is set to 'true', 'yes', or '1',1814 the dialog uses a built-in generic prompt; otherwise the exact1815 value of the variable is used.18161817guitool.<name>.revPrompt::1818 Request a single valid revision from the user, and set the1819 `REVISION` environment variable. In other aspects this option1820 is similar to 'argPrompt', and can be used together with it.18211822guitool.<name>.revUnmerged::1823 Show only unmerged branches in the 'revPrompt' subdialog.1824 This is useful for tools similar to merge or rebase, but not1825 for things like checkout or reset.18261827guitool.<name>.title::1828 Specifies the title to use for the prompt dialog. The default1829 is the tool name.18301831guitool.<name>.prompt::1832 Specifies the general prompt string to display at the top of1833 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1834 The default value includes the actual command.18351836help.browser::1837 Specify the browser that will be used to display help in the1838 'web' format. See linkgit:git-help[1].18391840help.format::1841 Override the default help format used by linkgit:git-help[1].1842 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1843 the default. 'web' and 'html' are the same.18441845help.autoCorrect::1846 Automatically correct and execute mistyped commands after1847 waiting for the given number of deciseconds (0.1 sec). If more1848 than one command can be deduced from the entered text, nothing1849 will be executed. If the value of this option is negative,1850 the corrected command will be executed immediately. If the1851 value is 0 - the command will be just shown but not executed.1852 This is the default.18531854help.htmlPath::1855 Specify the path where the HTML documentation resides. File system paths1856 and URLs are supported. HTML pages will be prefixed with this path when1857 help is displayed in the 'web' format. This defaults to the documentation1858 path of your Git installation.18591860http.proxy::1861 Override the HTTP proxy, normally configured using the 'http_proxy',1862 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1863 addition to the syntax understood by curl, it is possible to specify a1864 proxy string with a user name but no password, in which case git will1865 attempt to acquire one in the same way it does for other credentials. See1866 linkgit:gitcredentials[7] for more information. The syntax thus is1867 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1868 on a per-remote basis; see remote.<name>.proxy18691870http.proxyAuthMethod::1871 Set the method with which to authenticate against the HTTP proxy. This1872 only takes effect if the configured proxy string contains a user name part1873 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1874 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1875 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1876 variable. Possible values are:1877+1878--1879* `anyauth` - Automatically pick a suitable authentication method. It is1880 assumed that the proxy answers an unauthenticated request with a 4071881 status code and one or more Proxy-authenticate headers with supported1882 authentication methods. This is the default.1883* `basic` - HTTP Basic authentication1884* `digest` - HTTP Digest authentication; this prevents the password from being1885 transmitted to the proxy in clear text1886* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1887 of `curl(1)`)1888* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1889--18901891http.emptyAuth::1892 Attempt authentication without seeking a username or password. This1893 can be used to attempt GSS-Negotiate authentication without specifying1894 a username in the URL, as libcurl normally requires a username for1895 authentication.18961897http.delegation::1898 Control GSSAPI credential delegation. The delegation is disabled1899 by default in libcurl since version 7.21.7. Set parameter to tell1900 the server what it is allowed to delegate when it comes to user1901 credentials. Used with GSS/kerberos. Possible values are:1902+1903--1904* `none` - Don't allow any delegation.1905* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1906 Kerberos service ticket, which is a matter of realm policy.1907* `always` - Unconditionally allow the server to delegate.1908--190919101911http.extraHeader::1912 Pass an additional HTTP header when communicating with a server. If1913 more than one such entry exists, all of them are added as extra1914 headers. To allow overriding the settings inherited from the system1915 config, an empty value will reset the extra headers to the empty list.19161917http.cookieFile::1918 The pathname of a file containing previously stored cookie lines,1919 which should be used1920 in the Git http session, if they match the server. The file format1921 of the file to read cookies from should be plain HTTP headers or1922 the Netscape/Mozilla cookie file format (see `curl(1)`).1923 NOTE that the file specified with http.cookieFile is used only as1924 input unless http.saveCookies is set.19251926http.saveCookies::1927 If set, store cookies received during requests to the file specified by1928 http.cookieFile. Has no effect if http.cookieFile is unset.19291930http.sslVersion::1931 The SSL version to use when negotiating an SSL connection, if you1932 want to force the default. The available and default version1933 depend on whether libcurl was built against NSS or OpenSSL and the1934 particular configuration of the crypto library in use. Internally1935 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1936 documentation for more details on the format of this option and1937 for the ssl version supported. Actually the possible values of1938 this option are:19391940 - sslv21941 - sslv31942 - tlsv11943 - tlsv1.01944 - tlsv1.11945 - tlsv1.219461947+1948Can be overridden by the `GIT_SSL_VERSION` environment variable.1949To force git to use libcurl's default ssl version and ignore any1950explicit http.sslversion option, set `GIT_SSL_VERSION` to the1951empty string.19521953http.sslCipherList::1954 A list of SSL ciphers to use when negotiating an SSL connection.1955 The available ciphers depend on whether libcurl was built against1956 NSS or OpenSSL and the particular configuration of the crypto1957 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1958 option; see the libcurl documentation for more details on the format1959 of this list.1960+1961Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1962To force git to use libcurl's default cipher list and ignore any1963explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1964empty string.19651966http.sslVerify::1967 Whether to verify the SSL certificate when fetching or pushing1968 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1969 variable.19701971http.sslCert::1972 File containing the SSL certificate when fetching or pushing1973 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1974 variable.19751976http.sslKey::1977 File containing the SSL private key when fetching or pushing1978 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1979 variable.19801981http.sslCertPasswordProtected::1982 Enable Git's password prompt for the SSL certificate. Otherwise1983 OpenSSL will prompt the user, possibly many times, if the1984 certificate or private key is encrypted. Can be overridden by the1985 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19861987http.sslCAInfo::1988 File containing the certificates to verify the peer with when1989 fetching or pushing over HTTPS. Can be overridden by the1990 `GIT_SSL_CAINFO` environment variable.19911992http.sslCAPath::1993 Path containing files with the CA certificates to verify the peer1994 with when fetching or pushing over HTTPS. Can be overridden1995 by the `GIT_SSL_CAPATH` environment variable.19961997http.pinnedpubkey::1998 Public key of the https service. It may either be the filename of1999 a PEM or DER encoded public key file or a string starting with2000 'sha256//' followed by the base64 encoded sha256 hash of the2001 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2002 exit with an error if this option is set but not supported by2003 cURL.20042005http.sslTry::2006 Attempt to use AUTH SSL/TLS and encrypted data transfers2007 when connecting via regular FTP protocol. This might be needed2008 if the FTP server requires it for security reasons or you wish2009 to connect securely whenever remote FTP server supports it.2010 Default is false since it might trigger certificate verification2011 errors on misconfigured servers.20122013http.maxRequests::2014 How many HTTP requests to launch in parallel. Can be overridden2015 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20162017http.minSessions::2018 The number of curl sessions (counted across slots) to be kept across2019 requests. They will not be ended with curl_easy_cleanup() until2020 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2021 value will be capped at 1. Defaults to 1.20222023http.postBuffer::2024 Maximum size in bytes of the buffer used by smart HTTP2025 transports when POSTing data to the remote system.2026 For requests larger than this buffer size, HTTP/1.1 and2027 Transfer-Encoding: chunked is used to avoid creating a2028 massive pack file locally. Default is 1 MiB, which is2029 sufficient for most requests.20302031http.lowSpeedLimit, http.lowSpeedTime::2032 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2033 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2034 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2035 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20362037http.noEPSV::2038 A boolean which disables using of EPSV ftp command by curl.2039 This can helpful with some "poor" ftp servers which don't2040 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2041 environment variable. Default is false (curl will use EPSV).20422043http.userAgent::2044 The HTTP USER_AGENT string presented to an HTTP server. The default2045 value represents the version of the client Git such as git/1.7.1.2046 This option allows you to override this value to a more common value2047 such as Mozilla/4.0. This may be necessary, for instance, if2048 connecting through a firewall that restricts HTTP connections to a set2049 of common USER_AGENT strings (but not including those like git/1.7.1).2050 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20512052http.followRedirects::2053 Whether git should follow HTTP redirects. If set to `true`, git2054 will transparently follow any redirect issued by a server it2055 encounters. If set to `false`, git will treat all redirects as2056 errors. If set to `initial`, git will follow redirects only for2057 the initial request to a remote, but not for subsequent2058 follow-up HTTP requests. Since git uses the redirected URL as2059 the base for the follow-up requests, this is generally2060 sufficient. The default is `initial`.20612062http.<url>.*::2063 Any of the http.* options above can be applied selectively to some URLs.2064 For a config key to match a URL, each element of the config key is2065 compared to that of the URL, in the following order:2066+2067--2068. Scheme (e.g., `https` in `https://example.com/`). This field2069 must match exactly between the config key and the URL.20702071. Host/domain name (e.g., `example.com` in `https://example.com/`).2072 This field must match between the config key and the URL. It is2073 possible to specify a `*` as part of the host name to match all subdomains2074 at this level. `https://*.example.com/` for example would match2075 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20762077. Port number (e.g., `8080` in `http://example.com:8080/`).2078 This field must match exactly between the config key and the URL.2079 Omitted port numbers are automatically converted to the correct2080 default for the scheme before matching.20812082. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2083 path field of the config key must match the path field of the URL2084 either exactly or as a prefix of slash-delimited path elements. This means2085 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2086 match on a slash (`/`) boundary. Longer matches take precedence (so a config2087 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2088 key with just path `foo/`).20892090. User name (e.g., `user` in `https://user@example.com/repo.git`). If2091 the config key has a user name it must match the user name in the2092 URL exactly. If the config key does not have a user name, that2093 config key will match a URL with any user name (including none),2094 but at a lower precedence than a config key with a user name.2095--2096+2097The list above is ordered by decreasing precedence; a URL that matches2098a config key's path is preferred to one that matches its user name. For example,2099if the URL is `https://user@example.com/foo/bar` a config key match of2100`https://example.com/foo` will be preferred over a config key match of2101`https://user@example.com`.2102+2103All URLs are normalized before attempting any matching (the password part,2104if embedded in the URL, is always ignored for matching purposes) so that2105equivalent URLs that are simply spelled differently will match properly.2106Environment variable settings always override any matches. The URLs that are2107matched against are those given directly to Git commands. This means any URLs2108visited as a result of a redirection do not participate in matching.21092110ssh.variant::2111 By default, Git determines the command line arguments to use2112 based on the basename of the configured SSH command (configured2113 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2114 the config setting `core.sshCommand`). If the basename is2115 unrecognized, Git will attempt to detect support of OpenSSH2116 options by first invoking the configured SSH command with the2117 `-G` (print configuration) option and will subsequently use2118 OpenSSH options (if that is successful) or no options besides2119 the host and remote command (if it fails).2120+2121The config variable `ssh.variant` can be set to override this detection.2122Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2123`tortoiseplink`, `simple` (no options except the host and remote command).2124The default auto-detection can be explicitly requested using the value2125`auto`. Any other value is treated as `ssh`. This setting can also be2126overridden via the environment variable `GIT_SSH_VARIANT`.2127+2128The current command-line parameters used for each variant are as2129follows:2130+2131--21322133* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21342135* `simple` - [username@]host command21362137* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21382139* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21402141--2142+2143Except for the `simple` variant, command-line parameters are likely to2144change as git gains new features.21452146i18n.commitEncoding::2147 Character encoding the commit messages are stored in; Git itself2148 does not care per se, but this information is necessary e.g. when2149 importing commits from emails or in the gitk graphical history2150 browser (and possibly at other places in the future or in other2151 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21522153i18n.logOutputEncoding::2154 Character encoding the commit messages are converted to when2155 running 'git log' and friends.21562157imap::2158 The configuration variables in the 'imap' section are described2159 in linkgit:git-imap-send[1].21602161index.version::2162 Specify the version with which new index files should be2163 initialized. This does not affect existing repositories.21642165init.templateDir::2166 Specify the directory from which templates will be copied.2167 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21682169instaweb.browser::2170 Specify the program that will be used to browse your working2171 repository in gitweb. See linkgit:git-instaweb[1].21722173instaweb.httpd::2174 The HTTP daemon command-line to start gitweb on your working2175 repository. See linkgit:git-instaweb[1].21762177instaweb.local::2178 If true the web server started by linkgit:git-instaweb[1] will2179 be bound to the local IP (127.0.0.1).21802181instaweb.modulePath::2182 The default module path for linkgit:git-instaweb[1] to use2183 instead of /usr/lib/apache2/modules. Only used if httpd2184 is Apache.21852186instaweb.port::2187 The port number to bind the gitweb httpd to. See2188 linkgit:git-instaweb[1].21892190interactive.singleKey::2191 In interactive commands, allow the user to provide one-letter2192 input with a single key (i.e., without hitting enter).2193 Currently this is used by the `--patch` mode of2194 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2195 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2196 setting is silently ignored if portable keystroke input2197 is not available; requires the Perl module Term::ReadKey.21982199interactive.diffFilter::2200 When an interactive command (such as `git add --patch`) shows2201 a colorized diff, git will pipe the diff through the shell2202 command defined by this configuration variable. The command may2203 mark up the diff further for human consumption, provided that it2204 retains a one-to-one correspondence with the lines in the2205 original diff. Defaults to disabled (no filtering).22062207log.abbrevCommit::2208 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2209 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2210 override this option with `--no-abbrev-commit`.22112212log.date::2213 Set the default date-time mode for the 'log' command.2214 Setting a value for log.date is similar to using 'git log''s2215 `--date` option. See linkgit:git-log[1] for details.22162217log.decorate::2218 Print out the ref names of any commits that are shown by the log2219 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2220 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2221 specified, the full ref name (including prefix) will be printed.2222 If 'auto' is specified, then if the output is going to a terminal,2223 the ref names are shown as if 'short' were given, otherwise no ref2224 names are shown. This is the same as the `--decorate` option2225 of the `git log`.22262227log.follow::2228 If `true`, `git log` will act as if the `--follow` option was used when2229 a single <path> is given. This has the same limitations as `--follow`,2230 i.e. it cannot be used to follow multiple files and does not work well2231 on non-linear history.22322233log.graphColors::2234 A list of colors, separated by commas, that can be used to draw2235 history lines in `git log --graph`.22362237log.showRoot::2238 If true, the initial commit will be shown as a big creation event.2239 This is equivalent to a diff against an empty tree.2240 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2241 normally hide the root commit will now show it. True by default.22422243log.showSignature::2244 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2245 linkgit:git-whatchanged[1] assume `--show-signature`.22462247log.mailmap::2248 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2249 linkgit:git-whatchanged[1] assume `--use-mailmap`.22502251mailinfo.scissors::2252 If true, makes linkgit:git-mailinfo[1] (and therefore2253 linkgit:git-am[1]) act by default as if the --scissors option2254 was provided on the command-line. When active, this features2255 removes everything from the message body before a scissors2256 line (i.e. consisting mainly of ">8", "8<" and "-").22572258mailmap.file::2259 The location of an augmenting mailmap file. The default2260 mailmap, located in the root of the repository, is loaded2261 first, then the mailmap file pointed to by this variable.2262 The location of the mailmap file may be in a repository2263 subdirectory, or somewhere outside of the repository itself.2264 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22652266mailmap.blob::2267 Like `mailmap.file`, but consider the value as a reference to a2268 blob in the repository. If both `mailmap.file` and2269 `mailmap.blob` are given, both are parsed, with entries from2270 `mailmap.file` taking precedence. In a bare repository, this2271 defaults to `HEAD:.mailmap`. In a non-bare repository, it2272 defaults to empty.22732274man.viewer::2275 Specify the programs that may be used to display help in the2276 'man' format. See linkgit:git-help[1].22772278man.<tool>.cmd::2279 Specify the command to invoke the specified man viewer. The2280 specified command is evaluated in shell with the man page2281 passed as argument. (See linkgit:git-help[1].)22822283man.<tool>.path::2284 Override the path for the given tool that may be used to2285 display help in the 'man' format. See linkgit:git-help[1].22862287include::merge-config.txt[]22882289mergetool.<tool>.path::2290 Override the path for the given tool. This is useful in case2291 your tool is not in the PATH.22922293mergetool.<tool>.cmd::2294 Specify the command to invoke the specified merge tool. The2295 specified command is evaluated in shell with the following2296 variables available: 'BASE' is the name of a temporary file2297 containing the common base of the files to be merged, if available;2298 'LOCAL' is the name of a temporary file containing the contents of2299 the file on the current branch; 'REMOTE' is the name of a temporary2300 file containing the contents of the file from the branch being2301 merged; 'MERGED' contains the name of the file to which the merge2302 tool should write the results of a successful merge.23032304mergetool.<tool>.trustExitCode::2305 For a custom merge command, specify whether the exit code of2306 the merge command can be used to determine whether the merge was2307 successful. If this is not set to true then the merge target file2308 timestamp is checked and the merge assumed to have been successful2309 if the file has been updated, otherwise the user is prompted to2310 indicate the success of the merge.23112312mergetool.meld.hasOutput::2313 Older versions of `meld` do not support the `--output` option.2314 Git will attempt to detect whether `meld` supports `--output`2315 by inspecting the output of `meld --help`. Configuring2316 `mergetool.meld.hasOutput` will make Git skip these checks and2317 use the configured value instead. Setting `mergetool.meld.hasOutput`2318 to `true` tells Git to unconditionally use the `--output` option,2319 and `false` avoids using `--output`.23202321mergetool.keepBackup::2322 After performing a merge, the original file with conflict markers2323 can be saved as a file with a `.orig` extension. If this variable2324 is set to `false` then this file is not preserved. Defaults to2325 `true` (i.e. keep the backup files).23262327mergetool.keepTemporaries::2328 When invoking a custom merge tool, Git uses a set of temporary2329 files to pass to the tool. If the tool returns an error and this2330 variable is set to `true`, then these temporary files will be2331 preserved, otherwise they will be removed after the tool has2332 exited. Defaults to `false`.23332334mergetool.writeToTemp::2335 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2336 conflicting files in the worktree by default. Git will attempt2337 to use a temporary directory for these files when set `true`.2338 Defaults to `false`.23392340mergetool.prompt::2341 Prompt before each invocation of the merge resolution program.23422343notes.mergeStrategy::2344 Which merge strategy to choose by default when resolving notes2345 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2346 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2347 section of linkgit:git-notes[1] for more information on each strategy.23482349notes.<name>.mergeStrategy::2350 Which merge strategy to choose when doing a notes merge into2351 refs/notes/<name>. This overrides the more general2352 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2353 linkgit:git-notes[1] for more information on the available strategies.23542355notes.displayRef::2356 The (fully qualified) refname from which to show notes when2357 showing commit messages. The value of this variable can be set2358 to a glob, in which case notes from all matching refs will be2359 shown. You may also specify this configuration variable2360 several times. A warning will be issued for refs that do not2361 exist, but a glob that does not match any refs is silently2362 ignored.2363+2364This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2365environment variable, which must be a colon separated list of refs or2366globs.2367+2368The effective value of "core.notesRef" (possibly overridden by2369GIT_NOTES_REF) is also implicitly added to the list of refs to be2370displayed.23712372notes.rewrite.<command>::2373 When rewriting commits with <command> (currently `amend` or2374 `rebase`) and this variable is set to `true`, Git2375 automatically copies your notes from the original to the2376 rewritten commit. Defaults to `true`, but see2377 "notes.rewriteRef" below.23782379notes.rewriteMode::2380 When copying notes during a rewrite (see the2381 "notes.rewrite.<command>" option), determines what to do if2382 the target commit already has a note. Must be one of2383 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2384 Defaults to `concatenate`.2385+2386This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2387environment variable.23882389notes.rewriteRef::2390 When copying notes during a rewrite, specifies the (fully2391 qualified) ref whose notes should be copied. The ref may be a2392 glob, in which case notes in all matching refs will be copied.2393 You may also specify this configuration several times.2394+2395Does not have a default value; you must configure this variable to2396enable note rewriting. Set it to `refs/notes/commits` to enable2397rewriting for the default commit notes.2398+2399This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2400environment variable, which must be a colon separated list of refs or2401globs.24022403pack.window::2404 The size of the window used by linkgit:git-pack-objects[1] when no2405 window size is given on the command line. Defaults to 10.24062407pack.depth::2408 The maximum delta depth used by linkgit:git-pack-objects[1] when no2409 maximum depth is given on the command line. Defaults to 50.24102411pack.windowMemory::2412 The maximum size of memory that is consumed by each thread2413 in linkgit:git-pack-objects[1] for pack window memory when2414 no limit is given on the command line. The value can be2415 suffixed with "k", "m", or "g". When left unconfigured (or2416 set explicitly to 0), there will be no limit.24172418pack.compression::2419 An integer -1..9, indicating the compression level for objects2420 in a pack file. -1 is the zlib default. 0 means no2421 compression, and 1..9 are various speed/size tradeoffs, 9 being2422 slowest. If not set, defaults to core.compression. If that is2423 not set, defaults to -1, the zlib default, which is "a default2424 compromise between speed and compression (currently equivalent2425 to level 6)."2426+2427Note that changing the compression level will not automatically recompress2428all existing objects. You can force recompression by passing the -F option2429to linkgit:git-repack[1].24302431pack.deltaCacheSize::2432 The maximum memory in bytes used for caching deltas in2433 linkgit:git-pack-objects[1] before writing them out to a pack.2434 This cache is used to speed up the writing object phase by not2435 having to recompute the final delta result once the best match2436 for all objects is found. Repacking large repositories on machines2437 which are tight with memory might be badly impacted by this though,2438 especially if this cache pushes the system into swapping.2439 A value of 0 means no limit. The smallest size of 1 byte may be2440 used to virtually disable this cache. Defaults to 256 MiB.24412442pack.deltaCacheLimit::2443 The maximum size of a delta, that is cached in2444 linkgit:git-pack-objects[1]. This cache is used to speed up the2445 writing object phase by not having to recompute the final delta2446 result once the best match for all objects is found. Defaults to 1000.24472448pack.threads::2449 Specifies the number of threads to spawn when searching for best2450 delta matches. This requires that linkgit:git-pack-objects[1]2451 be compiled with pthreads otherwise this option is ignored with a2452 warning. This is meant to reduce packing time on multiprocessor2453 machines. The required amount of memory for the delta search window2454 is however multiplied by the number of threads.2455 Specifying 0 will cause Git to auto-detect the number of CPU's2456 and set the number of threads accordingly.24572458pack.indexVersion::2459 Specify the default pack index version. Valid values are 1 for2460 legacy pack index used by Git versions prior to 1.5.2, and 2 for2461 the new pack index with capabilities for packs larger than 4 GB2462 as well as proper protection against the repacking of corrupted2463 packs. Version 2 is the default. Note that version 2 is enforced2464 and this config option ignored whenever the corresponding pack is2465 larger than 2 GB.2466+2467If you have an old Git that does not understand the version 2 `*.idx` file,2468cloning or fetching over a non native protocol (e.g. "http")2469that will copy both `*.pack` file and corresponding `*.idx` file from the2470other side may give you a repository that cannot be accessed with your2471older version of Git. If the `*.pack` file is smaller than 2 GB, however,2472you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2473the `*.idx` file.24742475pack.packSizeLimit::2476 The maximum size of a pack. This setting only affects2477 packing to a file when repacking, i.e. the git:// protocol2478 is unaffected. It can be overridden by the `--max-pack-size`2479 option of linkgit:git-repack[1]. Reaching this limit results2480 in the creation of multiple packfiles; which in turn prevents2481 bitmaps from being created.2482 The minimum size allowed is limited to 1 MiB.2483 The default is unlimited.2484 Common unit suffixes of 'k', 'm', or 'g' are2485 supported.24862487pack.useBitmaps::2488 When true, git will use pack bitmaps (if available) when packing2489 to stdout (e.g., during the server side of a fetch). Defaults to2490 true. You should not generally need to turn this off unless2491 you are debugging pack bitmaps.24922493pack.writeBitmaps (deprecated)::2494 This is a deprecated synonym for `repack.writeBitmaps`.24952496pack.writeBitmapHashCache::2497 When true, git will include a "hash cache" section in the bitmap2498 index (if one is written). This cache can be used to feed git's2499 delta heuristics, potentially leading to better deltas between2500 bitmapped and non-bitmapped objects (e.g., when serving a fetch2501 between an older, bitmapped pack and objects that have been2502 pushed since the last gc). The downside is that it consumes 42503 bytes per object of disk space, and that JGit's bitmap2504 implementation does not understand it, causing it to complain if2505 Git and JGit are used on the same repository. Defaults to false.25062507pager.<cmd>::2508 If the value is boolean, turns on or off pagination of the2509 output of a particular Git subcommand when writing to a tty.2510 Otherwise, turns on pagination for the subcommand using the2511 pager specified by the value of `pager.<cmd>`. If `--paginate`2512 or `--no-pager` is specified on the command line, it takes2513 precedence over this option. To disable pagination for all2514 commands, set `core.pager` or `GIT_PAGER` to `cat`.25152516pretty.<name>::2517 Alias for a --pretty= format string, as specified in2518 linkgit:git-log[1]. Any aliases defined here can be used just2519 as the built-in pretty formats could. For example,2520 running `git config pretty.changelog "format:* %H %s"`2521 would cause the invocation `git log --pretty=changelog`2522 to be equivalent to running `git log "--pretty=format:* %H %s"`.2523 Note that an alias with the same name as a built-in format2524 will be silently ignored.25252526protocol.allow::2527 If set, provide a user defined default policy for all protocols which2528 don't explicitly have a policy (`protocol.<name>.allow`). By default,2529 if unset, known-safe protocols (http, https, git, ssh, file) have a2530 default policy of `always`, known-dangerous protocols (ext) have a2531 default policy of `never`, and all other protocols have a default2532 policy of `user`. Supported policies:2533+2534--25352536* `always` - protocol is always able to be used.25372538* `never` - protocol is never able to be used.25392540* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2541 either unset or has a value of 1. This policy should be used when you want a2542 protocol to be directly usable by the user but don't want it used by commands which2543 execute clone/fetch/push commands without user input, e.g. recursive2544 submodule initialization.25452546--25472548protocol.<name>.allow::2549 Set a policy to be used by protocol `<name>` with clone/fetch/push2550 commands. See `protocol.allow` above for the available policies.2551+2552The protocol names currently used by git are:2553+2554--2555 - `file`: any local file-based path (including `file://` URLs,2556 or local paths)25572558 - `git`: the anonymous git protocol over a direct TCP2559 connection (or proxy, if configured)25602561 - `ssh`: git over ssh (including `host:path` syntax,2562 `ssh://`, etc).25632564 - `http`: git over http, both "smart http" and "dumb http".2565 Note that this does _not_ include `https`; if you want to configure2566 both, you must do so individually.25672568 - any external helpers are named by their protocol (e.g., use2569 `hg` to allow the `git-remote-hg` helper)2570--25712572protocol.version::2573 Experimental. If set, clients will attempt to communicate with a2574 server using the specified protocol version. If unset, no2575 attempt will be made by the client to communicate using a2576 particular protocol version, this results in protocol version 02577 being used.2578 Supported versions:2579+2580--25812582* `0` - the original wire protocol.25832584* `1` - the original wire protocol with the addition of a version string2585 in the initial response from the server.25862587--25882589pull.ff::2590 By default, Git does not create an extra merge commit when merging2591 a commit that is a descendant of the current commit. Instead, the2592 tip of the current branch is fast-forwarded. When set to `false`,2593 this variable tells Git to create an extra merge commit in such2594 a case (equivalent to giving the `--no-ff` option from the command2595 line). When set to `only`, only such fast-forward merges are2596 allowed (equivalent to giving the `--ff-only` option from the2597 command line). This setting overrides `merge.ff` when pulling.25982599pull.rebase::2600 When true, rebase branches on top of the fetched branch, instead2601 of merging the default branch from the default remote when "git2602 pull" is run. See "branch.<name>.rebase" for setting this on a2603 per-branch basis.2604+2605When preserve, also pass `--preserve-merges` along to 'git rebase'2606so that locally committed merge commits will not be flattened2607by running 'git pull'.2608+2609When the value is `interactive`, the rebase is run in interactive mode.2610+2611*NOTE*: this is a possibly dangerous operation; do *not* use2612it unless you understand the implications (see linkgit:git-rebase[1]2613for details).26142615pull.octopus::2616 The default merge strategy to use when pulling multiple branches2617 at once.26182619pull.twohead::2620 The default merge strategy to use when pulling a single branch.26212622push.default::2623 Defines the action `git push` should take if no refspec is2624 explicitly given. Different values are well-suited for2625 specific workflows; for instance, in a purely central workflow2626 (i.e. the fetch source is equal to the push destination),2627 `upstream` is probably what you want. Possible values are:2628+2629--26302631* `nothing` - do not push anything (error out) unless a refspec is2632 explicitly given. This is primarily meant for people who want to2633 avoid mistakes by always being explicit.26342635* `current` - push the current branch to update a branch with the same2636 name on the receiving end. Works in both central and non-central2637 workflows.26382639* `upstream` - push the current branch back to the branch whose2640 changes are usually integrated into the current branch (which is2641 called `@{upstream}`). This mode only makes sense if you are2642 pushing to the same repository you would normally pull from2643 (i.e. central workflow).26442645* `tracking` - This is a deprecated synonym for `upstream`.26462647* `simple` - in centralized workflow, work like `upstream` with an2648 added safety to refuse to push if the upstream branch's name is2649 different from the local one.2650+2651When pushing to a remote that is different from the remote you normally2652pull from, work as `current`. This is the safest option and is suited2653for beginners.2654+2655This mode has become the default in Git 2.0.26562657* `matching` - push all branches having the same name on both ends.2658 This makes the repository you are pushing to remember the set of2659 branches that will be pushed out (e.g. if you always push 'maint'2660 and 'master' there and no other branches, the repository you push2661 to will have these two branches, and your local 'maint' and2662 'master' will be pushed there).2663+2664To use this mode effectively, you have to make sure _all_ the2665branches you would push out are ready to be pushed out before2666running 'git push', as the whole point of this mode is to allow you2667to push all of the branches in one go. If you usually finish work2668on only one branch and push out the result, while other branches are2669unfinished, this mode is not for you. Also this mode is not2670suitable for pushing into a shared central repository, as other2671people may add new branches there, or update the tip of existing2672branches outside your control.2673+2674This used to be the default, but not since Git 2.0 (`simple` is the2675new default).26762677--26782679push.followTags::2680 If set to true enable `--follow-tags` option by default. You2681 may override this configuration at time of push by specifying2682 `--no-follow-tags`.26832684push.gpgSign::2685 May be set to a boolean value, or the string 'if-asked'. A true2686 value causes all pushes to be GPG signed, as if `--signed` is2687 passed to linkgit:git-push[1]. The string 'if-asked' causes2688 pushes to be signed if the server supports it, as if2689 `--signed=if-asked` is passed to 'git push'. A false value may2690 override a value from a lower-priority config file. An explicit2691 command-line flag always overrides this config option.26922693push.pushOption::2694 When no `--push-option=<option>` argument is given from the2695 command line, `git push` behaves as if each <value> of2696 this variable is given as `--push-option=<value>`.2697+2698This is a multi-valued variable, and an empty value can be used in a2699higher priority configuration file (e.g. `.git/config` in a2700repository) to clear the values inherited from a lower priority2701configuration files (e.g. `$HOME/.gitconfig`).2702+2703--27042705Example:27062707/etc/gitconfig2708 push.pushoption = a2709 push.pushoption = b27102711~/.gitconfig2712 push.pushoption = c27132714repo/.git/config2715 push.pushoption =2716 push.pushoption = b27172718This will result in only b (a and c are cleared).27192720--27212722push.recurseSubmodules::2723 Make sure all submodule commits used by the revisions to be pushed2724 are available on a remote-tracking branch. If the value is 'check'2725 then Git will verify that all submodule commits that changed in the2726 revisions to be pushed are available on at least one remote of the2727 submodule. If any commits are missing, the push will be aborted and2728 exit with non-zero status. If the value is 'on-demand' then all2729 submodules that changed in the revisions to be pushed will be2730 pushed. If on-demand was not able to push all necessary revisions2731 it will also be aborted and exit with non-zero status. If the value2732 is 'no' then default behavior of ignoring submodules when pushing2733 is retained. You may override this configuration at time of push by2734 specifying '--recurse-submodules=check|on-demand|no'.27352736rebase.stat::2737 Whether to show a diffstat of what changed upstream since the last2738 rebase. False by default.27392740rebase.autoSquash::2741 If set to true enable `--autosquash` option by default.27422743rebase.autoStash::2744 When set to true, automatically create a temporary stash entry2745 before the operation begins, and apply it after the operation2746 ends. This means that you can run rebase on a dirty worktree.2747 However, use with care: the final stash application after a2748 successful rebase might result in non-trivial conflicts.2749 Defaults to false.27502751rebase.missingCommitsCheck::2752 If set to "warn", git rebase -i will print a warning if some2753 commits are removed (e.g. a line was deleted), however the2754 rebase will still proceed. If set to "error", it will print2755 the previous warning and stop the rebase, 'git rebase2756 --edit-todo' can then be used to correct the error. If set to2757 "ignore", no checking is done.2758 To drop a commit without warning or error, use the `drop`2759 command in the todo-list.2760 Defaults to "ignore".27612762rebase.instructionFormat::2763 A format string, as specified in linkgit:git-log[1], to be used for2764 the instruction list during an interactive rebase. The format will automatically2765 have the long commit hash prepended to the format.27662767receive.advertiseAtomic::2768 By default, git-receive-pack will advertise the atomic push2769 capability to its clients. If you don't want to advertise this2770 capability, set this variable to false.27712772receive.advertisePushOptions::2773 When set to true, git-receive-pack will advertise the push options2774 capability to its clients. False by default.27752776receive.autogc::2777 By default, git-receive-pack will run "git-gc --auto" after2778 receiving data from git-push and updating refs. You can stop2779 it by setting this variable to false.27802781receive.certNonceSeed::2782 By setting this variable to a string, `git receive-pack`2783 will accept a `git push --signed` and verifies it by using2784 a "nonce" protected by HMAC using this string as a secret2785 key.27862787receive.certNonceSlop::2788 When a `git push --signed` sent a push certificate with a2789 "nonce" that was issued by a receive-pack serving the same2790 repository within this many seconds, export the "nonce"2791 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2792 hooks (instead of what the receive-pack asked the sending2793 side to include). This may allow writing checks in2794 `pre-receive` and `post-receive` a bit easier. Instead of2795 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2796 that records by how many seconds the nonce is stale to2797 decide if they want to accept the certificate, they only2798 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27992800receive.fsckObjects::2801 If it is set to true, git-receive-pack will check all received2802 objects. It will abort in the case of a malformed object or a2803 broken link. The result of an abort are only dangling objects.2804 Defaults to false. If not set, the value of `transfer.fsckObjects`2805 is used instead.28062807receive.fsck.<msg-id>::2808 When `receive.fsckObjects` is set to true, errors can be switched2809 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2810 setting where the `<msg-id>` is the fsck message ID and the value2811 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2812 the error/warning with the message ID, e.g. "missingEmail: invalid2813 author/committer line - missing email" means that setting2814 `receive.fsck.missingEmail = ignore` will hide that issue.2815+2816This feature is intended to support working with legacy repositories2817which would not pass pushing when `receive.fsckObjects = true`, allowing2818the host to accept repositories with certain known issues but still catch2819other issues.28202821receive.fsck.skipList::2822 The path to a sorted list of object names (i.e. one SHA-1 per2823 line) that are known to be broken in a non-fatal way and should2824 be ignored. This feature is useful when an established project2825 should be accepted despite early commits containing errors that2826 can be safely ignored such as invalid committer email addresses.2827 Note: corrupt objects cannot be skipped with this setting.28282829receive.keepAlive::2830 After receiving the pack from the client, `receive-pack` may2831 produce no output (if `--quiet` was specified) while processing2832 the pack, causing some networks to drop the TCP connection.2833 With this option set, if `receive-pack` does not transmit2834 any data in this phase for `receive.keepAlive` seconds, it will2835 send a short keepalive packet. The default is 5 seconds; set2836 to 0 to disable keepalives entirely.28372838receive.unpackLimit::2839 If the number of objects received in a push is below this2840 limit then the objects will be unpacked into loose object2841 files. However if the number of received objects equals or2842 exceeds this limit then the received pack will be stored as2843 a pack, after adding any missing delta bases. Storing the2844 pack from a push can make the push operation complete faster,2845 especially on slow filesystems. If not set, the value of2846 `transfer.unpackLimit` is used instead.28472848receive.maxInputSize::2849 If the size of the incoming pack stream is larger than this2850 limit, then git-receive-pack will error out, instead of2851 accepting the pack file. If not set or set to 0, then the size2852 is unlimited.28532854receive.denyDeletes::2855 If set to true, git-receive-pack will deny a ref update that deletes2856 the ref. Use this to prevent such a ref deletion via a push.28572858receive.denyDeleteCurrent::2859 If set to true, git-receive-pack will deny a ref update that2860 deletes the currently checked out branch of a non-bare repository.28612862receive.denyCurrentBranch::2863 If set to true or "refuse", git-receive-pack will deny a ref update2864 to the currently checked out branch of a non-bare repository.2865 Such a push is potentially dangerous because it brings the HEAD2866 out of sync with the index and working tree. If set to "warn",2867 print a warning of such a push to stderr, but allow the push to2868 proceed. If set to false or "ignore", allow such pushes with no2869 message. Defaults to "refuse".2870+2871Another option is "updateInstead" which will update the working2872tree if pushing into the current branch. This option is2873intended for synchronizing working directories when one side is not easily2874accessible via interactive ssh (e.g. a live web site, hence the requirement2875that the working directory be clean). This mode also comes in handy when2876developing inside a VM to test and fix code on different Operating Systems.2877+2878By default, "updateInstead" will refuse the push if the working tree or2879the index have any difference from the HEAD, but the `push-to-checkout`2880hook can be used to customize this. See linkgit:githooks[5].28812882receive.denyNonFastForwards::2883 If set to true, git-receive-pack will deny a ref update which is2884 not a fast-forward. Use this to prevent such an update via a push,2885 even if that push is forced. This configuration variable is2886 set when initializing a shared repository.28872888receive.hideRefs::2889 This variable is the same as `transfer.hideRefs`, but applies2890 only to `receive-pack` (and so affects pushes, but not fetches).2891 An attempt to update or delete a hidden ref by `git push` is2892 rejected.28932894receive.updateServerInfo::2895 If set to true, git-receive-pack will run git-update-server-info2896 after receiving data from git-push and updating refs.28972898receive.shallowUpdate::2899 If set to true, .git/shallow can be updated when new refs2900 require new shallow roots. Otherwise those refs are rejected.29012902remote.pushDefault::2903 The remote to push to by default. Overrides2904 `branch.<name>.remote` for all branches, and is overridden by2905 `branch.<name>.pushRemote` for specific branches.29062907remote.<name>.url::2908 The URL of a remote repository. See linkgit:git-fetch[1] or2909 linkgit:git-push[1].29102911remote.<name>.pushurl::2912 The push URL of a remote repository. See linkgit:git-push[1].29132914remote.<name>.proxy::2915 For remotes that require curl (http, https and ftp), the URL to2916 the proxy to use for that remote. Set to the empty string to2917 disable proxying for that remote.29182919remote.<name>.proxyAuthMethod::2920 For remotes that require curl (http, https and ftp), the method to use for2921 authenticating against the proxy in use (probably set in2922 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29232924remote.<name>.fetch::2925 The default set of "refspec" for linkgit:git-fetch[1]. See2926 linkgit:git-fetch[1].29272928remote.<name>.push::2929 The default set of "refspec" for linkgit:git-push[1]. See2930 linkgit:git-push[1].29312932remote.<name>.mirror::2933 If true, pushing to this remote will automatically behave2934 as if the `--mirror` option was given on the command line.29352936remote.<name>.skipDefaultUpdate::2937 If true, this remote will be skipped by default when updating2938 using linkgit:git-fetch[1] or the `update` subcommand of2939 linkgit:git-remote[1].29402941remote.<name>.skipFetchAll::2942 If true, this remote will be skipped by default when updating2943 using linkgit:git-fetch[1] or the `update` subcommand of2944 linkgit:git-remote[1].29452946remote.<name>.receivepack::2947 The default program to execute on the remote side when pushing. See2948 option --receive-pack of linkgit:git-push[1].29492950remote.<name>.uploadpack::2951 The default program to execute on the remote side when fetching. See2952 option --upload-pack of linkgit:git-fetch-pack[1].29532954remote.<name>.tagOpt::2955 Setting this value to --no-tags disables automatic tag following when2956 fetching from remote <name>. Setting it to --tags will fetch every2957 tag from remote <name>, even if they are not reachable from remote2958 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2959 override this setting. See options --tags and --no-tags of2960 linkgit:git-fetch[1].29612962remote.<name>.vcs::2963 Setting this to a value <vcs> will cause Git to interact with2964 the remote with the git-remote-<vcs> helper.29652966remote.<name>.prune::2967 When set to true, fetching from this remote by default will also2968 remove any remote-tracking references that no longer exist on the2969 remote (as if the `--prune` option was given on the command line).2970 Overrides `fetch.prune` settings, if any.29712972remotes.<group>::2973 The list of remotes which are fetched by "git remote update2974 <group>". See linkgit:git-remote[1].29752976repack.useDeltaBaseOffset::2977 By default, linkgit:git-repack[1] creates packs that use2978 delta-base offset. If you need to share your repository with2979 Git older than version 1.4.4, either directly or via a dumb2980 protocol such as http, then you need to set this option to2981 "false" and repack. Access from old Git versions over the2982 native protocol are unaffected by this option.29832984repack.packKeptObjects::2985 If set to true, makes `git repack` act as if2986 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2987 details. Defaults to `false` normally, but `true` if a bitmap2988 index is being written (either via `--write-bitmap-index` or2989 `repack.writeBitmaps`).29902991repack.writeBitmaps::2992 When true, git will write a bitmap index when packing all2993 objects to disk (e.g., when `git repack -a` is run). This2994 index can speed up the "counting objects" phase of subsequent2995 packs created for clones and fetches, at the cost of some disk2996 space and extra time spent on the initial repack. This has2997 no effect if multiple packfiles are created.2998 Defaults to false.29993000rerere.autoUpdate::3001 When set to true, `git-rerere` updates the index with the3002 resulting contents after it cleanly resolves conflicts using3003 previously recorded resolution. Defaults to false.30043005rerere.enabled::3006 Activate recording of resolved conflicts, so that identical3007 conflict hunks can be resolved automatically, should they be3008 encountered again. By default, linkgit:git-rerere[1] is3009 enabled if there is an `rr-cache` directory under the3010 `$GIT_DIR`, e.g. if "rerere" was previously used in the3011 repository.30123013sendemail.identity::3014 A configuration identity. When given, causes values in the3015 'sendemail.<identity>' subsection to take precedence over3016 values in the 'sendemail' section. The default identity is3017 the value of `sendemail.identity`.30183019sendemail.smtpEncryption::3020 See linkgit:git-send-email[1] for description. Note that this3021 setting is not subject to the 'identity' mechanism.30223023sendemail.smtpssl (deprecated)::3024 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30253026sendemail.smtpsslcertpath::3027 Path to ca-certificates (either a directory or a single file).3028 Set it to an empty string to disable certificate verification.30293030sendemail.<identity>.*::3031 Identity-specific versions of the 'sendemail.*' parameters3032 found below, taking precedence over those when this3033 identity is selected, through either the command-line or3034 `sendemail.identity`.30353036sendemail.aliasesFile::3037sendemail.aliasFileType::3038sendemail.annotate::3039sendemail.bcc::3040sendemail.cc::3041sendemail.ccCmd::3042sendemail.chainReplyTo::3043sendemail.confirm::3044sendemail.envelopeSender::3045sendemail.from::3046sendemail.multiEdit::3047sendemail.signedoffbycc::3048sendemail.smtpPass::3049sendemail.suppresscc::3050sendemail.suppressFrom::3051sendemail.to::3052sendemail.tocmd::3053sendemail.smtpDomain::3054sendemail.smtpServer::3055sendemail.smtpServerPort::3056sendemail.smtpServerOption::3057sendemail.smtpUser::3058sendemail.thread::3059sendemail.transferEncoding::3060sendemail.validate::3061sendemail.xmailer::3062 See linkgit:git-send-email[1] for description.30633064sendemail.signedoffcc (deprecated)::3065 Deprecated alias for `sendemail.signedoffbycc`.30663067sendemail.smtpBatchSize::3068 Number of messages to be sent per connection, after that a relogin3069 will happen. If the value is 0 or undefined, send all messages in3070 one connection.3071 See also the `--batch-size` option of linkgit:git-send-email[1].30723073sendemail.smtpReloginDelay::3074 Seconds wait before reconnecting to smtp server.3075 See also the `--relogin-delay` option of linkgit:git-send-email[1].30763077showbranch.default::3078 The default set of branches for linkgit:git-show-branch[1].3079 See linkgit:git-show-branch[1].30803081splitIndex.maxPercentChange::3082 When the split index feature is used, this specifies the3083 percent of entries the split index can contain compared to the3084 total number of entries in both the split index and the shared3085 index before a new shared index is written.3086 The value should be between 0 and 100. If the value is 0 then3087 a new shared index is always written, if it is 100 a new3088 shared index is never written.3089 By default the value is 20, so a new shared index is written3090 if the number of entries in the split index would be greater3091 than 20 percent of the total number of entries.3092 See linkgit:git-update-index[1].30933094splitIndex.sharedIndexExpire::3095 When the split index feature is used, shared index files that3096 were not modified since the time this variable specifies will3097 be removed when a new shared index file is created. The value3098 "now" expires all entries immediately, and "never" suppresses3099 expiration altogether.3100 The default value is "2.weeks.ago".3101 Note that a shared index file is considered modified (for the3102 purpose of expiration) each time a new split-index file is3103 either created based on it or read from it.3104 See linkgit:git-update-index[1].31053106status.relativePaths::3107 By default, linkgit:git-status[1] shows paths relative to the3108 current directory. Setting this variable to `false` shows paths3109 relative to the repository root (this was the default for Git3110 prior to v1.5.4).31113112status.short::3113 Set to true to enable --short by default in linkgit:git-status[1].3114 The option --no-short takes precedence over this variable.31153116status.branch::3117 Set to true to enable --branch by default in linkgit:git-status[1].3118 The option --no-branch takes precedence over this variable.31193120status.displayCommentPrefix::3121 If set to true, linkgit:git-status[1] will insert a comment3122 prefix before each output line (starting with3123 `core.commentChar`, i.e. `#` by default). This was the3124 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3125 Defaults to false.31263127status.showStash::3128 If set to true, linkgit:git-status[1] will display the number of3129 entries currently stashed away.3130 Defaults to false.31313132status.showUntrackedFiles::3133 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3134 files which are not currently tracked by Git. Directories which3135 contain only untracked files, are shown with the directory name3136 only. Showing untracked files means that Git needs to lstat() all3137 the files in the whole repository, which might be slow on some3138 systems. So, this variable controls how the commands displays3139 the untracked files. Possible values are:3140+3141--3142* `no` - Show no untracked files.3143* `normal` - Show untracked files and directories.3144* `all` - Show also individual files in untracked directories.3145--3146+3147If this variable is not specified, it defaults to 'normal'.3148This variable can be overridden with the -u|--untracked-files option3149of linkgit:git-status[1] and linkgit:git-commit[1].31503151status.submoduleSummary::3152 Defaults to false.3153 If this is set to a non zero number or true (identical to -1 or an3154 unlimited number), the submodule summary will be enabled and a3155 summary of commits for modified submodules will be shown (see3156 --summary-limit option of linkgit:git-submodule[1]). Please note3157 that the summary output command will be suppressed for all3158 submodules when `diff.ignoreSubmodules` is set to 'all' or only3159 for those submodules where `submodule.<name>.ignore=all`. The only3160 exception to that rule is that status and commit will show staged3161 submodule changes. To3162 also view the summary for ignored submodules you can either use3163 the --ignore-submodules=dirty command-line option or the 'git3164 submodule summary' command, which shows a similar output but does3165 not honor these settings.31663167stash.showPatch::3168 If this is set to true, the `git stash show` command without an3169 option will show the stash entry in patch form. Defaults to false.3170 See description of 'show' command in linkgit:git-stash[1].31713172stash.showStat::3173 If this is set to true, the `git stash show` command without an3174 option will show diffstat of the stash entry. Defaults to true.3175 See description of 'show' command in linkgit:git-stash[1].31763177submodule.<name>.url::3178 The URL for a submodule. This variable is copied from the .gitmodules3179 file to the git config via 'git submodule init'. The user can change3180 the configured URL before obtaining the submodule via 'git submodule3181 update'. If neither submodule.<name>.active or submodule.active are3182 set, the presence of this variable is used as a fallback to indicate3183 whether the submodule is of interest to git commands.3184 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31853186submodule.<name>.update::3187 The method by which a submodule is updated by 'git submodule update',3188 which is the only affected command, others such as3189 'git checkout --recurse-submodules' are unaffected. It exists for3190 historical reasons, when 'git submodule' was the only command to3191 interact with submodules; settings like `submodule.active`3192 and `pull.rebase` are more specific. It is populated by3193 `git submodule init` from the linkgit:gitmodules[5] file.3194 See description of 'update' command in linkgit:git-submodule[1].31953196submodule.<name>.branch::3197 The remote branch name for a submodule, used by `git submodule3198 update --remote`. Set this option to override the value found in3199 the `.gitmodules` file. See linkgit:git-submodule[1] and3200 linkgit:gitmodules[5] for details.32013202submodule.<name>.fetchRecurseSubmodules::3203 This option can be used to control recursive fetching of this3204 submodule. It can be overridden by using the --[no-]recurse-submodules3205 command-line option to "git fetch" and "git pull".3206 This setting will override that from in the linkgit:gitmodules[5]3207 file.32083209submodule.<name>.ignore::3210 Defines under what circumstances "git status" and the diff family show3211 a submodule as modified. When set to "all", it will never be considered3212 modified (but it will nonetheless show up in the output of status and3213 commit when it has been staged), "dirty" will ignore all changes3214 to the submodules work tree and3215 takes only differences between the HEAD of the submodule and the commit3216 recorded in the superproject into account. "untracked" will additionally3217 let submodules with modified tracked files in their work tree show up.3218 Using "none" (the default when this option is not set) also shows3219 submodules that have untracked files in their work tree as changed.3220 This setting overrides any setting made in .gitmodules for this submodule,3221 both settings can be overridden on the command line by using the3222 "--ignore-submodules" option. The 'git submodule' commands are not3223 affected by this setting.32243225submodule.<name>.active::3226 Boolean value indicating if the submodule is of interest to git3227 commands. This config option takes precedence over the3228 submodule.active config option.32293230submodule.active::3231 A repeated field which contains a pathspec used to match against a3232 submodule's path to determine if the submodule is of interest to git3233 commands.32343235submodule.recurse::3236 Specifies if commands recurse into submodules by default. This3237 applies to all commands that have a `--recurse-submodules` option.3238 Defaults to false.32393240submodule.fetchJobs::3241 Specifies how many submodules are fetched/cloned at the same time.3242 A positive integer allows up to that number of submodules fetched3243 in parallel. A value of 0 will give some reasonable default.3244 If unset, it defaults to 1.32453246submodule.alternateLocation::3247 Specifies how the submodules obtain alternates when submodules are3248 cloned. Possible values are `no`, `superproject`.3249 By default `no` is assumed, which doesn't add references. When the3250 value is set to `superproject` the submodule to be cloned computes3251 its alternates location relative to the superprojects alternate.32523253submodule.alternateErrorStrategy::3254 Specifies how to treat errors with the alternates for a submodule3255 as computed via `submodule.alternateLocation`. Possible values are3256 `ignore`, `info`, `die`. Default is `die`.32573258tag.forceSignAnnotated::3259 A boolean to specify whether annotated tags created should be GPG signed.3260 If `--annotate` is specified on the command line, it takes3261 precedence over this option.32623263tag.sort::3264 This variable controls the sort ordering of tags when displayed by3265 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3266 value of this variable will be used as the default.32673268tar.umask::3269 This variable can be used to restrict the permission bits of3270 tar archive entries. The default is 0002, which turns off the3271 world write bit. The special value "user" indicates that the3272 archiving user's umask will be used instead. See umask(2) and3273 linkgit:git-archive[1].32743275transfer.fsckObjects::3276 When `fetch.fsckObjects` or `receive.fsckObjects` are3277 not set, the value of this variable is used instead.3278 Defaults to false.32793280transfer.hideRefs::3281 String(s) `receive-pack` and `upload-pack` use to decide which3282 refs to omit from their initial advertisements. Use more than3283 one definition to specify multiple prefix strings. A ref that is3284 under the hierarchies listed in the value of this variable is3285 excluded, and is hidden when responding to `git push` or `git3286 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3287 program-specific versions of this config.3288+3289You may also include a `!` in front of the ref name to negate the entry,3290explicitly exposing it, even if an earlier entry marked it as hidden.3291If you have multiple hideRefs values, later entries override earlier ones3292(and entries in more-specific config files override less-specific ones).3293+3294If a namespace is in use, the namespace prefix is stripped from each3295reference before it is matched against `transfer.hiderefs` patterns.3296For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3297the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3298is omitted from the advertisements but `refs/heads/master` and3299`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3300"have" lines. In order to match refs before stripping, add a `^` in front of3301the ref name. If you combine `!` and `^`, `!` must be specified first.3302+3303Even if you hide refs, a client may still be able to steal the target3304objects via the techniques described in the "SECURITY" section of the3305linkgit:gitnamespaces[7] man page; it's best to keep private data in a3306separate repository.33073308transfer.unpackLimit::3309 When `fetch.unpackLimit` or `receive.unpackLimit` are3310 not set, the value of this variable is used instead.3311 The default value is 100.33123313uploadarchive.allowUnreachable::3314 If true, allow clients to use `git archive --remote` to request3315 any tree, whether reachable from the ref tips or not. See the3316 discussion in the "SECURITY" section of3317 linkgit:git-upload-archive[1] for more details. Defaults to3318 `false`.33193320uploadpack.hideRefs::3321 This variable is the same as `transfer.hideRefs`, but applies3322 only to `upload-pack` (and so affects only fetches, not pushes).3323 An attempt to fetch a hidden ref by `git fetch` will fail. See3324 also `uploadpack.allowTipSHA1InWant`.33253326uploadpack.allowTipSHA1InWant::3327 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3328 to accept a fetch request that asks for an object at the tip3329 of a hidden ref (by default, such a request is rejected).3330 See also `uploadpack.hideRefs`. Even if this is false, a client3331 may be able to steal objects via the techniques described in the3332 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3333 best to keep private data in a separate repository.33343335uploadpack.allowReachableSHA1InWant::3336 Allow `upload-pack` to accept a fetch request that asks for an3337 object that is reachable from any ref tip. However, note that3338 calculating object reachability is computationally expensive.3339 Defaults to `false`. Even if this is false, a client may be able3340 to steal objects via the techniques described in the "SECURITY"3341 section of the linkgit:gitnamespaces[7] man page; it's best to3342 keep private data in a separate repository.33433344uploadpack.allowAnySHA1InWant::3345 Allow `upload-pack` to accept a fetch request that asks for any3346 object at all.3347 Defaults to `false`.33483349uploadpack.keepAlive::3350 When `upload-pack` has started `pack-objects`, there may be a3351 quiet period while `pack-objects` prepares the pack. Normally3352 it would output progress information, but if `--quiet` was used3353 for the fetch, `pack-objects` will output nothing at all until3354 the pack data begins. Some clients and networks may consider3355 the server to be hung and give up. Setting this option instructs3356 `upload-pack` to send an empty keepalive packet every3357 `uploadpack.keepAlive` seconds. Setting this option to 03358 disables keepalive packets entirely. The default is 5 seconds.33593360uploadpack.packObjectsHook::3361 If this option is set, when `upload-pack` would run3362 `git pack-objects` to create a packfile for a client, it will3363 run this shell command instead. The `pack-objects` command and3364 arguments it _would_ have run (including the `git pack-objects`3365 at the beginning) are appended to the shell command. The stdin3366 and stdout of the hook are treated as if `pack-objects` itself3367 was run. I.e., `upload-pack` will feed input intended for3368 `pack-objects` to the hook, and expects a completed packfile on3369 stdout.3370+3371Note that this configuration variable is ignored if it is seen in the3372repository-level config (this is a safety measure against fetching from3373untrusted repositories).33743375url.<base>.insteadOf::3376 Any URL that starts with this value will be rewritten to3377 start, instead, with <base>. In cases where some site serves a3378 large number of repositories, and serves them with multiple3379 access methods, and some users need to use different access3380 methods, this feature allows people to specify any of the3381 equivalent URLs and have Git automatically rewrite the URL to3382 the best alternative for the particular user, even for a3383 never-before-seen repository on the site. When more than one3384 insteadOf strings match a given URL, the longest match is used.3385+3386Note that any protocol restrictions will be applied to the rewritten3387URL. If the rewrite changes the URL to use a custom protocol or remote3388helper, you may need to adjust the `protocol.*.allow` config to permit3389the request. In particular, protocols you expect to use for submodules3390must be set to `always` rather than the default of `user`. See the3391description of `protocol.allow` above.33923393url.<base>.pushInsteadOf::3394 Any URL that starts with this value will not be pushed to;3395 instead, it will be rewritten to start with <base>, and the3396 resulting URL will be pushed to. In cases where some site serves3397 a large number of repositories, and serves them with multiple3398 access methods, some of which do not allow push, this feature3399 allows people to specify a pull-only URL and have Git3400 automatically use an appropriate URL to push, even for a3401 never-before-seen repository on the site. When more than one3402 pushInsteadOf strings match a given URL, the longest match is3403 used. If a remote has an explicit pushurl, Git will ignore this3404 setting for that remote.34053406user.email::3407 Your email address to be recorded in any newly created commits.3408 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3409 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34103411user.name::3412 Your full name to be recorded in any newly created commits.3413 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3414 environment variables. See linkgit:git-commit-tree[1].34153416user.useConfigOnly::3417 Instruct Git to avoid trying to guess defaults for `user.email`3418 and `user.name`, and instead retrieve the values only from the3419 configuration. For example, if you have multiple email addresses3420 and would like to use a different one for each repository, then3421 with this configuration option set to `true` in the global config3422 along with a name, Git will prompt you to set up an email before3423 making new commits in a newly cloned repository.3424 Defaults to `false`.34253426user.signingKey::3427 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3428 key you want it to automatically when creating a signed tag or3429 commit, you can override the default selection with this variable.3430 This option is passed unchanged to gpg's --local-user parameter,3431 so you may specify a key using any method that gpg supports.34323433versionsort.prereleaseSuffix (deprecated)::3434 Deprecated alias for `versionsort.suffix`. Ignored if3435 `versionsort.suffix` is set.34363437versionsort.suffix::3438 Even when version sort is used in linkgit:git-tag[1], tagnames3439 with the same base version but different suffixes are still sorted3440 lexicographically, resulting e.g. in prerelease tags appearing3441 after the main release (e.g. "1.0-rc1" after "1.0"). This3442 variable can be specified to determine the sorting order of tags3443 with different suffixes.3444+3445By specifying a single suffix in this variable, any tagname containing3446that suffix will appear before the corresponding main release. E.g. if3447the variable is set to "-rc", then all "1.0-rcX" tags will appear before3448"1.0". If specified multiple times, once per suffix, then the order of3449suffixes in the configuration will determine the sorting order of tagnames3450with those suffixes. E.g. if "-pre" appears before "-rc" in the3451configuration, then all "1.0-preX" tags will be listed before any3452"1.0-rcX" tags. The placement of the main release tag relative to tags3453with various suffixes can be determined by specifying the empty suffix3454among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3455"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3456are listed first, followed by "v4.8", then "v4.8-ckX" and finally3457"v4.8-bfsX".3458+3459If more than one suffixes match the same tagname, then that tagname will3460be sorted according to the suffix which starts at the earliest position in3461the tagname. If more than one different matching suffixes start at3462that earliest position, then that tagname will be sorted according to the3463longest of those suffixes.3464The sorting order between different suffixes is undefined if they are3465in multiple config files.34663467web.browser::3468 Specify a web browser that may be used by some commands.3469 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3470 may use it.