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-- 355 356core.fileMode:: 357 Tells Git if the executable bit of files in the working tree 358 is to be honored. 359+ 360Some filesystems lose the executable bit when a file that is 361marked as executable is checked out, or checks out a 362non-executable file with executable bit on. 363linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 364to see if it handles the executable bit correctly 365and this variable is automatically set as necessary. 366+ 367A repository, however, may be on a filesystem that handles 368the filemode correctly, and this variable is set to 'true' 369when created, but later may be made accessible from another 370environment that loses the filemode (e.g. exporting ext4 via 371CIFS mount, visiting a Cygwin created repository with 372Git for Windows or Eclipse). 373In such a case it may be necessary to set this variable to 'false'. 374See linkgit:git-update-index[1]. 375+ 376The default is true (when core.filemode is not specified in the config file). 377 378core.hideDotFiles:: 379 (Windows-only) If true, mark newly-created directories and files whose 380 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 381 directory is hidden, but no other files starting with a dot. The 382 default mode is 'dotGitOnly'. 383 384core.ignoreCase:: 385 If true, this option enables various workarounds to enable 386 Git to work better on filesystems that are not case sensitive, 387 like FAT. For example, if a directory listing finds 388 "makefile" when Git expects "Makefile", Git will assume 389 it is really the same file, and continue to remember it as 390 "Makefile". 391+ 392The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 393will probe and set core.ignoreCase true if appropriate when the repository 394is created. 395 396core.precomposeUnicode:: 397 This option is only used by Mac OS implementation of Git. 398 When core.precomposeUnicode=true, Git reverts the unicode decomposition 399 of filenames done by Mac OS. This is useful when sharing a repository 400 between Mac OS and Linux or Windows. 401 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 402 When false, file names are handled fully transparent by Git, 403 which is backward compatible with older versions of Git. 404 405core.protectHFS:: 406 If set to true, do not allow checkout of paths that would 407 be considered equivalent to `.git` on an HFS+ filesystem. 408 Defaults to `true` on Mac OS, and `false` elsewhere. 409 410core.protectNTFS:: 411 If set to true, do not allow checkout of paths that would 412 cause problems with the NTFS filesystem, e.g. conflict with 413 8.3 "short" names. 414 Defaults to `true` on Windows, and `false` elsewhere. 415 416core.trustctime:: 417 If false, the ctime differences between the index and the 418 working tree are ignored; useful when the inode change time 419 is regularly modified by something outside Git (file system 420 crawlers and some backup systems). 421 See linkgit:git-update-index[1]. True by default. 422 423core.splitIndex:: 424 If true, the split-index feature of the index will be used. 425 See linkgit:git-update-index[1]. False by default. 426 427core.untrackedCache:: 428 Determines what to do about the untracked cache feature of the 429 index. It will be kept, if this variable is unset or set to 430 `keep`. It will automatically be added if set to `true`. And 431 it will automatically be removed, if set to `false`. Before 432 setting it to `true`, you should check that mtime is working 433 properly on your system. 434 See linkgit:git-update-index[1]. `keep` by default. 435 436core.checkStat:: 437 Determines which stat fields to match between the index 438 and work tree. The user can set this to 'default' or 439 'minimal'. Default (or explicitly 'default'), is to check 440 all fields, including the sub-second part of mtime and ctime. 441 442core.quotePath:: 443 Commands that output paths (e.g. 'ls-files', 'diff'), will 444 quote "unusual" characters in the pathname by enclosing the 445 pathname in double-quotes and escaping those characters with 446 backslashes in the same way C escapes control characters (e.g. 447 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 448 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 449 UTF-8). If this variable is set to false, bytes higher than 450 0x80 are not considered "unusual" any more. Double-quotes, 451 backslash and control characters are always escaped regardless 452 of the setting of this variable. A simple space character is 453 not considered "unusual". Many commands can output pathnames 454 completely verbatim using the `-z` option. The default value 455 is true. 456 457core.eol:: 458 Sets the line ending type to use in the working directory for 459 files that have the `text` property set when core.autocrlf is false. 460 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 461 native line ending. The default value is `native`. See 462 linkgit:gitattributes[5] for more information on end-of-line 463 conversion. 464 465core.safecrlf:: 466 If true, makes Git check if converting `CRLF` is reversible when 467 end-of-line conversion is active. Git will verify if a command 468 modifies a file in the work tree either directly or indirectly. 469 For example, committing a file followed by checking out the 470 same file should yield the original file in the work tree. If 471 this is not the case for the current setting of 472 `core.autocrlf`, Git will reject the file. The variable can 473 be set to "warn", in which case Git will only warn about an 474 irreversible conversion but continue the operation. 475+ 476CRLF conversion bears a slight chance of corrupting data. 477When it is enabled, Git will convert CRLF to LF during commit and LF to 478CRLF during checkout. A file that contains a mixture of LF and 479CRLF before the commit cannot be recreated by Git. For text 480files this is the right thing to do: it corrects line endings 481such that we have only LF line endings in the repository. 482But for binary files that are accidentally classified as text the 483conversion can corrupt data. 484+ 485If you recognize such corruption early you can easily fix it by 486setting the conversion type explicitly in .gitattributes. Right 487after committing you still have the original file in your work 488tree and this file is not yet corrupted. You can explicitly tell 489Git that this file is binary and Git will handle the file 490appropriately. 491+ 492Unfortunately, the desired effect of cleaning up text files with 493mixed line endings and the undesired effect of corrupting binary 494files cannot be distinguished. In both cases CRLFs are removed 495in an irreversible way. For text files this is the right thing 496to do because CRLFs are line endings, while for binary files 497converting CRLFs corrupts data. 498+ 499Note, this safety check does not mean that a checkout will generate a 500file identical to the original file for a different setting of 501`core.eol` and `core.autocrlf`, but only for the current one. For 502example, a text file with `LF` would be accepted with `core.eol=lf` 503and could later be checked out with `core.eol=crlf`, in which case the 504resulting file would contain `CRLF`, although the original file 505contained `LF`. However, in both work trees the line endings would be 506consistent, that is either all `LF` or all `CRLF`, but never mixed. A 507file with mixed line endings would be reported by the `core.safecrlf` 508mechanism. 509 510core.autocrlf:: 511 Setting this variable to "true" is the same as setting 512 the `text` attribute to "auto" on all files and core.eol to "crlf". 513 Set to true if you want to have `CRLF` line endings in your 514 working directory and the repository has LF line endings. 515 This variable can be set to 'input', 516 in which case no output conversion is performed. 517 518core.symlinks:: 519 If false, symbolic links are checked out as small plain files that 520 contain the link text. linkgit:git-update-index[1] and 521 linkgit:git-add[1] will not change the recorded type to regular 522 file. Useful on filesystems like FAT that do not support 523 symbolic links. 524+ 525The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 526will probe and set core.symlinks false if appropriate when the repository 527is created. 528 529core.gitProxy:: 530 A "proxy command" to execute (as 'command host port') instead 531 of establishing direct connection to the remote server when 532 using the Git protocol for fetching. If the variable value is 533 in the "COMMAND for DOMAIN" format, the command is applied only 534 on hostnames ending with the specified domain string. This variable 535 may be set multiple times and is matched in the given order; 536 the first match wins. 537+ 538Can be overridden by the `GIT_PROXY_COMMAND` environment variable 539(which always applies universally, without the special "for" 540handling). 541+ 542The special string `none` can be used as the proxy command to 543specify that no proxy be used for a given domain pattern. 544This is useful for excluding servers inside a firewall from 545proxy use, while defaulting to a common proxy for external domains. 546 547core.sshCommand:: 548 If this variable is set, `git fetch` and `git push` will 549 use the specified command instead of `ssh` when they need to 550 connect to a remote system. The command is in the same form as 551 the `GIT_SSH_COMMAND` environment variable and is overridden 552 when the environment variable is set. 553 554core.ignoreStat:: 555 If true, Git will avoid using lstat() calls to detect if files have 556 changed by setting the "assume-unchanged" bit for those tracked files 557 which it has updated identically in both the index and working tree. 558+ 559When files are modified outside of Git, the user will need to stage 560the modified files explicitly (e.g. see 'Examples' section in 561linkgit:git-update-index[1]). 562Git will not normally detect changes to those files. 563+ 564This is useful on systems where lstat() calls are very slow, such as 565CIFS/Microsoft Windows. 566+ 567False by default. 568 569core.preferSymlinkRefs:: 570 Instead of the default "symref" format for HEAD 571 and other symbolic reference files, use symbolic links. 572 This is sometimes needed to work with old scripts that 573 expect HEAD to be a symbolic link. 574 575core.bare:: 576 If true this repository is assumed to be 'bare' and has no 577 working directory associated with it. If this is the case a 578 number of commands that require a working directory will be 579 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 580+ 581This setting is automatically guessed by linkgit:git-clone[1] or 582linkgit:git-init[1] when the repository was created. By default a 583repository that ends in "/.git" is assumed to be not bare (bare = 584false), while all other repositories are assumed to be bare (bare 585= true). 586 587core.worktree:: 588 Set the path to the root of the working tree. 589 If `GIT_COMMON_DIR` environment variable is set, core.worktree 590 is ignored and not used for determining the root of working tree. 591 This can be overridden by the `GIT_WORK_TREE` environment 592 variable and the `--work-tree` command-line option. 593 The value can be an absolute path or relative to the path to 594 the .git directory, which is either specified by --git-dir 595 or GIT_DIR, or automatically discovered. 596 If --git-dir or GIT_DIR is specified but none of 597 --work-tree, GIT_WORK_TREE and core.worktree is specified, 598 the current working directory is regarded as the top level 599 of your working tree. 600+ 601Note that this variable is honored even when set in a configuration 602file in a ".git" subdirectory of a directory and its value differs 603from the latter directory (e.g. "/path/to/.git/config" has 604core.worktree set to "/different/path"), which is most likely a 605misconfiguration. Running Git commands in the "/path/to" directory will 606still use "/different/path" as the root of the work tree and can cause 607confusion unless you know what you are doing (e.g. you are creating a 608read-only snapshot of the same index to a location different from the 609repository's usual working tree). 610 611core.logAllRefUpdates:: 612 Enable the reflog. Updates to a ref <ref> is logged to the file 613 "`$GIT_DIR/logs/<ref>`", by appending the new and old 614 SHA-1, the date/time and the reason of the update, but 615 only when the file exists. If this configuration 616 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 617 file is automatically created for branch heads (i.e. under 618 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 619 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 620 If it is set to `always`, then a missing reflog is automatically 621 created for any ref under `refs/`. 622+ 623This information can be used to determine what commit 624was the tip of a branch "2 days ago". 625+ 626This value is true by default in a repository that has 627a working directory associated with it, and false by 628default in a bare repository. 629 630core.repositoryFormatVersion:: 631 Internal variable identifying the repository format and layout 632 version. 633 634core.sharedRepository:: 635 When 'group' (or 'true'), the repository is made shareable between 636 several users in a group (making sure all the files and objects are 637 group-writable). When 'all' (or 'world' or 'everybody'), the 638 repository will be readable by all users, additionally to being 639 group-shareable. When 'umask' (or 'false'), Git will use permissions 640 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 641 files in the repository will have this mode value. '0xxx' will override 642 user's umask value (whereas the other options will only override 643 requested parts of the user's umask value). Examples: '0660' will make 644 the repo read/write-able for the owner and group, but inaccessible to 645 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 646 repository that is group-readable but not group-writable. 647 See linkgit:git-init[1]. False by default. 648 649core.warnAmbiguousRefs:: 650 If true, Git will warn you if the ref name you passed it is ambiguous 651 and might match multiple refs in the repository. True by default. 652 653core.compression:: 654 An integer -1..9, indicating a default compression level. 655 -1 is the zlib default. 0 means no compression, 656 and 1..9 are various speed/size tradeoffs, 9 being slowest. 657 If set, this provides a default to other compression variables, 658 such as `core.looseCompression` and `pack.compression`. 659 660core.looseCompression:: 661 An integer -1..9, indicating the compression level for objects that 662 are not in a pack file. -1 is the zlib default. 0 means no 663 compression, and 1..9 are various speed/size tradeoffs, 9 being 664 slowest. If not set, defaults to core.compression. If that is 665 not set, defaults to 1 (best speed). 666 667core.packedGitWindowSize:: 668 Number of bytes of a pack file to map into memory in a 669 single mapping operation. Larger window sizes may allow 670 your system to process a smaller number of large pack files 671 more quickly. Smaller window sizes will negatively affect 672 performance due to increased calls to the operating system's 673 memory manager, but may improve performance when accessing 674 a large number of large pack files. 675+ 676Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 677MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 678be reasonable for all users/operating systems. You probably do 679not need to adjust this value. 680+ 681Common unit suffixes of 'k', 'm', or 'g' are supported. 682 683core.packedGitLimit:: 684 Maximum number of bytes to map simultaneously into memory 685 from pack files. If Git needs to access more than this many 686 bytes at once to complete an operation it will unmap existing 687 regions to reclaim virtual address space within the process. 688+ 689Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 690unlimited) on 64 bit platforms. 691This should be reasonable for all users/operating systems, except on 692the largest projects. You probably do not need to adjust this value. 693+ 694Common unit suffixes of 'k', 'm', or 'g' are supported. 695 696core.deltaBaseCacheLimit:: 697 Maximum number of bytes to reserve for caching base objects 698 that may be referenced by multiple deltified objects. By storing the 699 entire decompressed base objects in a cache Git is able 700 to avoid unpacking and decompressing frequently used base 701 objects multiple times. 702+ 703Default is 96 MiB on all platforms. This should be reasonable 704for all users/operating systems, except on the largest projects. 705You probably do not need to adjust this value. 706+ 707Common unit suffixes of 'k', 'm', or 'g' are supported. 708 709core.bigFileThreshold:: 710 Files larger than this size are stored deflated, without 711 attempting delta compression. Storing large files without 712 delta compression avoids excessive memory usage, at the 713 slight expense of increased disk usage. Additionally files 714 larger than this size are always treated as binary. 715+ 716Default is 512 MiB on all platforms. This should be reasonable 717for most projects as source code and other text files can still 718be delta compressed, but larger binary media files won't be. 719+ 720Common unit suffixes of 'k', 'm', or 'g' are supported. 721 722core.excludesFile:: 723 Specifies the pathname to the file that contains patterns to 724 describe paths that are not meant to be tracked, in addition 725 to '.gitignore' (per-directory) and '.git/info/exclude'. 726 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 727 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 728 is used instead. See linkgit:gitignore[5]. 729 730core.askPass:: 731 Some commands (e.g. svn and http interfaces) that interactively 732 ask for a password can be told to use an external program given 733 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 734 environment variable. If not set, fall back to the value of the 735 `SSH_ASKPASS` environment variable or, failing that, a simple password 736 prompt. The external program shall be given a suitable prompt as 737 command-line argument and write the password on its STDOUT. 738 739core.attributesFile:: 740 In addition to '.gitattributes' (per-directory) and 741 '.git/info/attributes', Git looks into this file for attributes 742 (see linkgit:gitattributes[5]). Path expansions are made the same 743 way as for `core.excludesFile`. Its default value is 744 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 745 set or empty, `$HOME/.config/git/attributes` is used instead. 746 747core.hooksPath:: 748 By default Git will look for your hooks in the 749 '$GIT_DIR/hooks' directory. Set this to different path, 750 e.g. '/etc/git/hooks', and Git will try to find your hooks in 751 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 752 in '$GIT_DIR/hooks/pre-receive'. 753+ 754The path can be either absolute or relative. A relative path is 755taken as relative to the directory where the hooks are run (see 756the "DESCRIPTION" section of linkgit:githooks[5]). 757+ 758This configuration variable is useful in cases where you'd like to 759centrally configure your Git hooks instead of configuring them on a 760per-repository basis, or as a more flexible and centralized 761alternative to having an `init.templateDir` where you've changed 762default hooks. 763 764core.editor:: 765 Commands such as `commit` and `tag` that let you edit 766 messages by launching an editor use the value of this 767 variable when it is set, and the environment variable 768 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 769 770core.commentChar:: 771 Commands such as `commit` and `tag` that let you edit 772 messages consider a line that begins with this character 773 commented, and removes them after the editor returns 774 (default '#'). 775+ 776If set to "auto", `git-commit` would select a character that is not 777the beginning character of any line in existing commit messages. 778 779core.filesRefLockTimeout:: 780 The length of time, in milliseconds, to retry when trying to 781 lock an individual reference. Value 0 means not to retry at 782 all; -1 means to try indefinitely. Default is 100 (i.e., 783 retry for 100ms). 784 785core.packedRefsTimeout:: 786 The length of time, in milliseconds, to retry when trying to 787 lock the `packed-refs` file. Value 0 means not to retry at 788 all; -1 means to try indefinitely. Default is 1000 (i.e., 789 retry for 1 second). 790 791sequence.editor:: 792 Text editor used by `git rebase -i` for editing the rebase instruction file. 793 The value is meant to be interpreted by the shell when it is used. 794 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 795 When not configured the default commit message editor is used instead. 796 797core.pager:: 798 Text viewer for use by Git commands (e.g., 'less'). The value 799 is meant to be interpreted by the shell. The order of preference 800 is the `$GIT_PAGER` environment variable, then `core.pager` 801 configuration, then `$PAGER`, and then the default chosen at 802 compile time (usually 'less'). 803+ 804When the `LESS` environment variable is unset, Git sets it to `FRX` 805(if `LESS` environment variable is set, Git does not change it at 806all). If you want to selectively override Git's default setting 807for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 808be passed to the shell by Git, which will translate the final 809command to `LESS=FRX less -S`. The environment does not set the 810`S` option but the command line does, instructing less to truncate 811long lines. Similarly, setting `core.pager` to `less -+F` will 812deactivate the `F` option specified by the environment from the 813command-line, deactivating the "quit if one screen" behavior of 814`less`. One can specifically activate some flags for particular 815commands: for example, setting `pager.blame` to `less -S` enables 816line truncation only for `git blame`. 817+ 818Likewise, when the `LV` environment variable is unset, Git sets it 819to `-c`. You can override this setting by exporting `LV` with 820another value or setting `core.pager` to `lv +c`. 821 822core.whitespace:: 823 A comma separated list of common whitespace problems to 824 notice. 'git diff' will use `color.diff.whitespace` to 825 highlight them, and 'git apply --whitespace=error' will 826 consider them as errors. You can prefix `-` to disable 827 any of them (e.g. `-trailing-space`): 828+ 829* `blank-at-eol` treats trailing whitespaces at the end of the line 830 as an error (enabled by default). 831* `space-before-tab` treats a space character that appears immediately 832 before a tab character in the initial indent part of the line as an 833 error (enabled by default). 834* `indent-with-non-tab` treats a line that is indented with space 835 characters instead of the equivalent tabs as an error (not enabled by 836 default). 837* `tab-in-indent` treats a tab character in the initial indent part of 838 the line as an error (not enabled by default). 839* `blank-at-eof` treats blank lines added at the end of file as an error 840 (enabled by default). 841* `trailing-space` is a short-hand to cover both `blank-at-eol` and 842 `blank-at-eof`. 843* `cr-at-eol` treats a carriage-return at the end of line as 844 part of the line terminator, i.e. with it, `trailing-space` 845 does not trigger if the character before such a carriage-return 846 is not a whitespace (not enabled by default). 847* `tabwidth=<n>` tells how many character positions a tab occupies; this 848 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 849 errors. The default tab width is 8. Allowed values are 1 to 63. 850 851core.fsyncObjectFiles:: 852 This boolean will enable 'fsync()' when writing object files. 853+ 854This is a total waste of time and effort on a filesystem that orders 855data writes properly, but can be useful for filesystems that do not use 856journalling (traditional UNIX filesystems) or that only journal metadata 857and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 858 859core.preloadIndex:: 860 Enable parallel index preload for operations like 'git diff' 861+ 862This can speed up operations like 'git diff' and 'git status' especially 863on filesystems like NFS that have weak caching semantics and thus 864relatively high IO latencies. When enabled, Git will do the 865index comparison to the filesystem data in parallel, allowing 866overlapping IO's. Defaults to true. 867 868core.createObject:: 869 You can set this to 'link', in which case a hardlink followed by 870 a delete of the source are used to make sure that object creation 871 will not overwrite existing objects. 872+ 873On some file system/operating system combinations, this is unreliable. 874Set this config setting to 'rename' there; However, This will remove the 875check that makes sure that existing object files will not get overwritten. 876 877core.notesRef:: 878 When showing commit messages, also show notes which are stored in 879 the given ref. The ref must be fully qualified. If the given 880 ref does not exist, it is not an error but means that no 881 notes should be printed. 882+ 883This setting defaults to "refs/notes/commits", and it can be overridden by 884the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 885 886core.sparseCheckout:: 887 Enable "sparse checkout" feature. See section "Sparse checkout" in 888 linkgit:git-read-tree[1] for more information. 889 890core.abbrev:: 891 Set the length object names are abbreviated to. If 892 unspecified or set to "auto", an appropriate value is 893 computed based on the approximate number of packed objects 894 in your repository, which hopefully is enough for 895 abbreviated object names to stay unique for some time. 896 The minimum length is 4. 897 898add.ignoreErrors:: 899add.ignore-errors (deprecated):: 900 Tells 'git add' to continue adding files when some files cannot be 901 added due to indexing errors. Equivalent to the `--ignore-errors` 902 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 903 as it does not follow the usual naming convention for configuration 904 variables. 905 906alias.*:: 907 Command aliases for the linkgit:git[1] command wrapper - e.g. 908 after defining "alias.last = cat-file commit HEAD", the invocation 909 "git last" is equivalent to "git cat-file commit HEAD". To avoid 910 confusion and troubles with script usage, aliases that 911 hide existing Git commands are ignored. Arguments are split by 912 spaces, the usual shell quoting and escaping is supported. 913 A quote pair or a backslash can be used to quote them. 914+ 915If the alias expansion is prefixed with an exclamation point, 916it will be treated as a shell command. For example, defining 917"alias.new = !gitk --all --not ORIG_HEAD", the invocation 918"git new" is equivalent to running the shell command 919"gitk --all --not ORIG_HEAD". Note that shell commands will be 920executed from the top-level directory of a repository, which may 921not necessarily be the current directory. 922`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 923from the original current directory. See linkgit:git-rev-parse[1]. 924 925am.keepcr:: 926 If true, git-am will call git-mailsplit for patches in mbox format 927 with parameter `--keep-cr`. In this case git-mailsplit will 928 not remove `\r` from lines ending with `\r\n`. Can be overridden 929 by giving `--no-keep-cr` from the command line. 930 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 931 932am.threeWay:: 933 By default, `git am` will fail if the patch does not apply cleanly. When 934 set to true, this setting tells `git am` to fall back on 3-way merge if 935 the patch records the identity of blobs it is supposed to apply to and 936 we have those blobs available locally (equivalent to giving the `--3way` 937 option from the command line). Defaults to `false`. 938 See linkgit:git-am[1]. 939 940apply.ignoreWhitespace:: 941 When set to 'change', tells 'git apply' to ignore changes in 942 whitespace, in the same way as the `--ignore-space-change` 943 option. 944 When set to one of: no, none, never, false tells 'git apply' to 945 respect all whitespace differences. 946 See linkgit:git-apply[1]. 947 948apply.whitespace:: 949 Tells 'git apply' how to handle whitespaces, in the same way 950 as the `--whitespace` option. See linkgit:git-apply[1]. 951 952branch.autoSetupMerge:: 953 Tells 'git branch' and 'git checkout' to set up new branches 954 so that linkgit:git-pull[1] will appropriately merge from the 955 starting point branch. Note that even if this option is not set, 956 this behavior can be chosen per-branch using the `--track` 957 and `--no-track` options. The valid settings are: `false` -- no 958 automatic setup is done; `true` -- automatic setup is done when the 959 starting point is a remote-tracking branch; `always` -- 960 automatic setup is done when the starting point is either a 961 local branch or remote-tracking 962 branch. This option defaults to true. 963 964branch.autoSetupRebase:: 965 When a new branch is created with 'git branch' or 'git checkout' 966 that tracks another branch, this variable tells Git to set 967 up pull to rebase instead of merge (see "branch.<name>.rebase"). 968 When `never`, rebase is never automatically set to true. 969 When `local`, rebase is set to true for tracked branches of 970 other local branches. 971 When `remote`, rebase is set to true for tracked branches of 972 remote-tracking branches. 973 When `always`, rebase will be set to true for all tracking 974 branches. 975 See "branch.autoSetupMerge" for details on how to set up a 976 branch to track another branch. 977 This option defaults to never. 978 979branch.<name>.remote:: 980 When on branch <name>, it tells 'git fetch' and 'git push' 981 which remote to fetch from/push to. The remote to push to 982 may be overridden with `remote.pushDefault` (for all branches). 983 The remote to push to, for the current branch, may be further 984 overridden by `branch.<name>.pushRemote`. If no remote is 985 configured, or if you are not on any branch, it defaults to 986 `origin` for fetching and `remote.pushDefault` for pushing. 987 Additionally, `.` (a period) is the current local repository 988 (a dot-repository), see `branch.<name>.merge`'s final note below. 989 990branch.<name>.pushRemote:: 991 When on branch <name>, it overrides `branch.<name>.remote` for 992 pushing. It also overrides `remote.pushDefault` for pushing 993 from branch <name>. When you pull from one place (e.g. your 994 upstream) and push to another place (e.g. your own publishing 995 repository), you would want to set `remote.pushDefault` to 996 specify the remote to push to for all branches, and use this 997 option to override it for a specific branch. 998 999branch.<name>.merge::1000 Defines, together with branch.<name>.remote, the upstream branch1001 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1002 branch to merge and can also affect 'git push' (see push.default).1003 When in branch <name>, it tells 'git fetch' the default1004 refspec to be marked for merging in FETCH_HEAD. The value is1005 handled like the remote part of a refspec, and must match a1006 ref which is fetched from the remote given by1007 "branch.<name>.remote".1008 The merge information is used by 'git pull' (which at first calls1009 'git fetch') to lookup the default branch for merging. Without1010 this option, 'git pull' defaults to merge the first refspec fetched.1011 Specify multiple values to get an octopus merge.1012 If you wish to setup 'git pull' so that it merges into <name> from1013 another branch in the local repository, you can point1014 branch.<name>.merge to the desired branch, and use the relative path1015 setting `.` (a period) for branch.<name>.remote.10161017branch.<name>.mergeOptions::1018 Sets default options for merging into branch <name>. The syntax and1019 supported options are the same as those of linkgit:git-merge[1], but1020 option values containing whitespace characters are currently not1021 supported.10221023branch.<name>.rebase::1024 When true, rebase the branch <name> on top of the fetched branch,1025 instead of merging the default branch from the default remote when1026 "git pull" is run. See "pull.rebase" for doing this in a non1027 branch-specific manner.1028+1029When preserve, also pass `--preserve-merges` along to 'git rebase'1030so that locally committed merge commits will not be flattened1031by running 'git pull'.1032+1033When the value is `interactive`, the rebase is run in interactive mode.1034+1035*NOTE*: this is a possibly dangerous operation; do *not* use1036it unless you understand the implications (see linkgit:git-rebase[1]1037for details).10381039branch.<name>.description::1040 Branch description, can be edited with1041 `git branch --edit-description`. Branch description is1042 automatically added in the format-patch cover letter or1043 request-pull summary.10441045browser.<tool>.cmd::1046 Specify the command to invoke the specified browser. The1047 specified command is evaluated in shell with the URLs passed1048 as arguments. (See linkgit:git-web{litdd}browse[1].)10491050browser.<tool>.path::1051 Override the path for the given tool that may be used to1052 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1053 working repository in gitweb (see linkgit:git-instaweb[1]).10541055clean.requireForce::1056 A boolean to make git-clean do nothing unless given -f,1057 -i or -n. Defaults to true.10581059color.branch::1060 A boolean to enable/disable color in the output of1061 linkgit:git-branch[1]. May be set to `false` (or `never`) to1062 disable color entirely, `auto` (or `true` or `always`) in which1063 case colors are used only when the output is to a terminal. If1064 unset, then the value of `color.ui` is used (`auto` by default).10651066color.branch.<slot>::1067 Use customized color for branch coloration. `<slot>` is one of1068 `current` (the current branch), `local` (a local branch),1069 `remote` (a remote-tracking branch in refs/remotes/),1070 `upstream` (upstream tracking branch), `plain` (other1071 refs).10721073color.diff::1074 Whether to use ANSI escape sequences to add color to patches.1075 If this is set to `true` or `auto`, linkgit:git-diff[1],1076 linkgit:git-log[1], and linkgit:git-show[1] will use color1077 when output is to the terminal. The value `always` is a1078 historical synonym for `auto`. If unset, then the value of1079 `color.ui` is used (`auto` by default).1080+1081This does not affect linkgit:git-format-patch[1] or the1082'git-diff-{asterisk}' plumbing commands. Can be overridden on the1083command line with the `--color[=<when>]` option.10841085diff.colorMoved::1086 If set to either a valid `<mode>` or a true value, moved lines1087 in a diff are colored differently, for details of valid modes1088 see '--color-moved' in linkgit:git-diff[1]. If simply set to1089 true the default color mode will be used. When set to false,1090 moved lines are not colored.10911092color.diff.<slot>::1093 Use customized color for diff colorization. `<slot>` specifies1094 which part of the patch to use the specified color, and is one1095 of `context` (context text - `plain` is a historical synonym),1096 `meta` (metainformation), `frag`1097 (hunk header), 'func' (function in hunk header), `old` (removed lines),1098 `new` (added lines), `commit` (commit headers), `whitespace`1099 (highlighting whitespace errors), `oldMoved` (deleted lines),1100 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1101 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1102 and `newMovedAlternativeDimmed` (See the '<mode>'1103 setting of '--color-moved' in linkgit:git-diff[1] for details).11041105color.decorate.<slot>::1106 Use customized color for 'git log --decorate' output. `<slot>` is one1107 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1108 branches, remote-tracking branches, tags, stash and HEAD, respectively.11091110color.grep::1111 When set to `always`, always highlight matches. When `false` (or1112 `never`), never. When set to `true` or `auto`, use color only1113 when the output is written to the terminal. If unset, then the1114 value of `color.ui` is used (`auto` by default).11151116color.grep.<slot>::1117 Use customized color for grep colorization. `<slot>` specifies which1118 part of the line to use the specified color, and is one of1119+1120--1121`context`;;1122 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1123`filename`;;1124 filename prefix (when not using `-h`)1125`function`;;1126 function name lines (when using `-p`)1127`linenumber`;;1128 line number prefix (when using `-n`)1129`match`;;1130 matching text (same as setting `matchContext` and `matchSelected`)1131`matchContext`;;1132 matching text in context lines1133`matchSelected`;;1134 matching text in selected lines1135`selected`;;1136 non-matching text in selected lines1137`separator`;;1138 separators between fields on a line (`:`, `-`, and `=`)1139 and between hunks (`--`)1140--11411142color.interactive::1143 When set to `true` or `auto`, use colors for interactive prompts1144 and displays (such as those used by "git-add --interactive" and1145 "git-clean --interactive") when the output is to the terminal.1146 When false (or `never`), never show colors. The value `always`1147 is a historical synonym for `auto`. If unset, then the value of1148 `color.ui` is used (`auto` by default).11491150color.interactive.<slot>::1151 Use customized color for 'git add --interactive' and 'git clean1152 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1153 or `error`, for four distinct types of normal output from1154 interactive commands.11551156color.pager::1157 A boolean to enable/disable colored output when the pager is in1158 use (default is true).11591160color.showBranch::1161 A boolean to enable/disable color in the output of1162 linkgit:git-show-branch[1]. May be set to `always`,1163 `false` (or `never`) or `auto` (or `true`), in which case colors are used1164 only when the output is to a terminal. If unset, then the1165 value of `color.ui` is used (`auto` by default).11661167color.status::1168 A boolean to enable/disable color in the output of1169 linkgit:git-status[1]. May be set to `always`,1170 `false` (or `never`) or `auto` (or `true`), in which case colors are used1171 only when the output is to a terminal. If unset, then the1172 value of `color.ui` is used (`auto` by default).11731174color.status.<slot>::1175 Use customized color for status colorization. `<slot>` is1176 one of `header` (the header text of the status message),1177 `added` or `updated` (files which are added but not committed),1178 `changed` (files which are changed but not added in the index),1179 `untracked` (files which are not tracked by Git),1180 `branch` (the current branch),1181 `nobranch` (the color the 'no branch' warning is shown in, defaulting1182 to red),1183 `localBranch` or `remoteBranch` (the local and remote branch names,1184 respectively, when branch and tracking information is displayed in the1185 status short-format), or1186 `unmerged` (files which have unmerged changes).11871188color.ui::1189 This variable determines the default value for variables such1190 as `color.diff` and `color.grep` that control the use of color1191 per command family. Its scope will expand as more commands learn1192 configuration to set a default for the `--color` option. Set it1193 to `false` or `never` if you prefer Git commands not to use1194 color unless enabled explicitly with some other configuration1195 or the `--color` option. Set it to `true` or `auto` to enable1196 color when output is written to the terminal (this is also the1197 default since Git 1.8.4). The value `always` is a historical1198 synonym for `auto`.11991200column.ui::1201 Specify whether supported commands should output in columns.1202 This variable consists of a list of tokens separated by spaces1203 or commas:1204+1205These options control when the feature should be enabled1206(defaults to 'never'):1207+1208--1209`always`;;1210 always show in columns1211`never`;;1212 never show in columns1213`auto`;;1214 show in columns if the output is to the terminal1215--1216+1217These options control layout (defaults to 'column'). Setting any1218of these implies 'always' if none of 'always', 'never', or 'auto' are1219specified.1220+1221--1222`column`;;1223 fill columns before rows1224`row`;;1225 fill rows before columns1226`plain`;;1227 show in one column1228--1229+1230Finally, these options can be combined with a layout option (defaults1231to 'nodense'):1232+1233--1234`dense`;;1235 make unequal size columns to utilize more space1236`nodense`;;1237 make equal size columns1238--12391240column.branch::1241 Specify whether to output branch listing in `git branch` in columns.1242 See `column.ui` for details.12431244column.clean::1245 Specify the layout when list items in `git clean -i`, which always1246 shows files and directories in columns. See `column.ui` for details.12471248column.status::1249 Specify whether to output untracked files in `git status` in columns.1250 See `column.ui` for details.12511252column.tag::1253 Specify whether to output tag listing in `git tag` in columns.1254 See `column.ui` for details.12551256commit.cleanup::1257 This setting overrides the default of the `--cleanup` option in1258 `git commit`. See linkgit:git-commit[1] for details. Changing the1259 default can be useful when you always want to keep lines that begin1260 with comment character `#` in your log message, in which case you1261 would do `git config commit.cleanup whitespace` (note that you will1262 have to remove the help lines that begin with `#` in the commit log1263 template yourself, if you do this).12641265commit.gpgSign::12661267 A boolean to specify whether all commits should be GPG signed.1268 Use of this option when doing operations such as rebase can1269 result in a large number of commits being signed. It may be1270 convenient to use an agent to avoid typing your GPG passphrase1271 several times.12721273commit.status::1274 A boolean to enable/disable inclusion of status information in the1275 commit message template when using an editor to prepare the commit1276 message. Defaults to true.12771278commit.template::1279 Specify the pathname of a file to use as the template for1280 new commit messages.12811282commit.verbose::1283 A boolean or int to specify the level of verbose with `git commit`.1284 See linkgit:git-commit[1].12851286credential.helper::1287 Specify an external helper to be called when a username or1288 password credential is needed; the helper may consult external1289 storage to avoid prompting the user for the credentials. Note1290 that multiple helpers may be defined. See linkgit:gitcredentials[7]1291 for details.12921293credential.useHttpPath::1294 When acquiring credentials, consider the "path" component of an http1295 or https URL to be important. Defaults to false. See1296 linkgit:gitcredentials[7] for more information.12971298credential.username::1299 If no username is set for a network authentication, use this username1300 by default. See credential.<context>.* below, and1301 linkgit:gitcredentials[7].13021303credential.<url>.*::1304 Any of the credential.* options above can be applied selectively to1305 some credentials. For example "credential.https://example.com.username"1306 would set the default username only for https connections to1307 example.com. See linkgit:gitcredentials[7] for details on how URLs are1308 matched.13091310credentialCache.ignoreSIGHUP::1311 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13121313include::diff-config.txt[]13141315difftool.<tool>.path::1316 Override the path for the given tool. This is useful in case1317 your tool is not in the PATH.13181319difftool.<tool>.cmd::1320 Specify the command to invoke the specified diff tool.1321 The specified command is evaluated in shell with the following1322 variables available: 'LOCAL' is set to the name of the temporary1323 file containing the contents of the diff pre-image and 'REMOTE'1324 is set to the name of the temporary file containing the contents1325 of the diff post-image.13261327difftool.prompt::1328 Prompt before each invocation of the diff tool.13291330fastimport.unpackLimit::1331 If the number of objects imported by linkgit:git-fast-import[1]1332 is below this limit, then the objects will be unpacked into1333 loose object files. However if the number of imported objects1334 equals or exceeds this limit then the pack will be stored as a1335 pack. Storing the pack from a fast-import can make the import1336 operation complete faster, especially on slow filesystems. If1337 not set, the value of `transfer.unpackLimit` is used instead.13381339fetch.recurseSubmodules::1340 This option can be either set to a boolean value or to 'on-demand'.1341 Setting it to a boolean changes the behavior of fetch and pull to1342 unconditionally recurse into submodules when set to true or to not1343 recurse at all when set to false. When set to 'on-demand' (the default1344 value), fetch and pull will only recurse into a populated submodule1345 when its superproject retrieves a commit that updates the submodule's1346 reference.13471348fetch.fsckObjects::1349 If it is set to true, git-fetch-pack will check all fetched1350 objects. It will abort in the case of a malformed object or a1351 broken link. The result of an abort are only dangling objects.1352 Defaults to false. If not set, the value of `transfer.fsckObjects`1353 is used instead.13541355fetch.unpackLimit::1356 If the number of objects fetched over the Git native1357 transfer is below this1358 limit, then the objects will be unpacked into loose object1359 files. However if the number of received objects equals or1360 exceeds this limit then the received pack will be stored as1361 a pack, after adding any missing delta bases. Storing the1362 pack from a push can make the push operation complete faster,1363 especially on slow filesystems. If not set, the value of1364 `transfer.unpackLimit` is used instead.13651366fetch.prune::1367 If true, fetch will automatically behave as if the `--prune`1368 option was given on the command line. See also `remote.<name>.prune`.13691370fetch.output::1371 Control how ref update status is printed. Valid values are1372 `full` and `compact`. Default value is `full`. See section1373 OUTPUT in linkgit:git-fetch[1] for detail.13741375format.attach::1376 Enable multipart/mixed attachments as the default for1377 'format-patch'. The value can also be a double quoted string1378 which will enable attachments as the default and set the1379 value as the boundary. See the --attach option in1380 linkgit:git-format-patch[1].13811382format.from::1383 Provides the default value for the `--from` option to format-patch.1384 Accepts a boolean value, or a name and email address. If false,1385 format-patch defaults to `--no-from`, using commit authors directly in1386 the "From:" field of patch mails. If true, format-patch defaults to1387 `--from`, using your committer identity in the "From:" field of patch1388 mails and including a "From:" field in the body of the patch mail if1389 different. If set to a non-boolean value, format-patch uses that1390 value instead of your committer identity. Defaults to false.13911392format.numbered::1393 A boolean which can enable or disable sequence numbers in patch1394 subjects. It defaults to "auto" which enables it only if there1395 is more than one patch. It can be enabled or disabled for all1396 messages by setting it to "true" or "false". See --numbered1397 option in linkgit:git-format-patch[1].13981399format.headers::1400 Additional email headers to include in a patch to be submitted1401 by mail. See linkgit:git-format-patch[1].14021403format.to::1404format.cc::1405 Additional recipients to include in a patch to be submitted1406 by mail. See the --to and --cc options in1407 linkgit:git-format-patch[1].14081409format.subjectPrefix::1410 The default for format-patch is to output files with the '[PATCH]'1411 subject prefix. Use this variable to change that prefix.14121413format.signature::1414 The default for format-patch is to output a signature containing1415 the Git version number. Use this variable to change that default.1416 Set this variable to the empty string ("") to suppress1417 signature generation.14181419format.signatureFile::1420 Works just like format.signature except the contents of the1421 file specified by this variable will be used as the signature.14221423format.suffix::1424 The default for format-patch is to output files with the suffix1425 `.patch`. Use this variable to change that suffix (make sure to1426 include the dot if you want it).14271428format.pretty::1429 The default pretty format for log/show/whatchanged command,1430 See linkgit:git-log[1], linkgit:git-show[1],1431 linkgit:git-whatchanged[1].14321433format.thread::1434 The default threading style for 'git format-patch'. Can be1435 a boolean value, or `shallow` or `deep`. `shallow` threading1436 makes every mail a reply to the head of the series,1437 where the head is chosen from the cover letter, the1438 `--in-reply-to`, and the first patch mail, in this order.1439 `deep` threading makes every mail a reply to the previous one.1440 A true boolean value is the same as `shallow`, and a false1441 value disables threading.14421443format.signOff::1444 A boolean value which lets you enable the `-s/--signoff` option of1445 format-patch by default. *Note:* Adding the Signed-off-by: line to a1446 patch should be a conscious act and means that you certify you have1447 the rights to submit this work under the same open source license.1448 Please see the 'SubmittingPatches' document for further discussion.14491450format.coverLetter::1451 A boolean that controls whether to generate a cover-letter when1452 format-patch is invoked, but in addition can be set to "auto", to1453 generate a cover-letter only when there's more than one patch.14541455format.outputDirectory::1456 Set a custom directory to store the resulting files instead of the1457 current working directory.14581459format.useAutoBase::1460 A boolean value which lets you enable the `--base=auto` option of1461 format-patch by default.14621463filter.<driver>.clean::1464 The command which is used to convert the content of a worktree1465 file to a blob upon checkin. See linkgit:gitattributes[5] for1466 details.14671468filter.<driver>.smudge::1469 The command which is used to convert the content of a blob1470 object to a worktree file upon checkout. See1471 linkgit:gitattributes[5] for details.14721473fsck.<msg-id>::1474 Allows overriding the message type (error, warn or ignore) of a1475 specific message ID such as `missingEmail`.1476+1477For convenience, fsck prefixes the error/warning with the message ID,1478e.g. "missingEmail: invalid author/committer line - missing email" means1479that setting `fsck.missingEmail = ignore` will hide that issue.1480+1481This feature is intended to support working with legacy repositories1482which cannot be repaired without disruptive changes.14831484fsck.skipList::1485 The path to a sorted list of object names (i.e. one SHA-1 per1486 line) that are known to be broken in a non-fatal way and should1487 be ignored. This feature is useful when an established project1488 should be accepted despite early commits containing errors that1489 can be safely ignored such as invalid committer email addresses.1490 Note: corrupt objects cannot be skipped with this setting.14911492gc.aggressiveDepth::1493 The depth parameter used in the delta compression1494 algorithm used by 'git gc --aggressive'. This defaults1495 to 50.14961497gc.aggressiveWindow::1498 The window size parameter used in the delta compression1499 algorithm used by 'git gc --aggressive'. This defaults1500 to 250.15011502gc.auto::1503 When there are approximately more than this many loose1504 objects in the repository, `git gc --auto` will pack them.1505 Some Porcelain commands use this command to perform a1506 light-weight garbage collection from time to time. The1507 default value is 6700. Setting this to 0 disables it.15081509gc.autoPackLimit::1510 When there are more than this many packs that are not1511 marked with `*.keep` file in the repository, `git gc1512 --auto` consolidates them into one larger pack. The1513 default value is 50. Setting this to 0 disables it.15141515gc.autoDetach::1516 Make `git gc --auto` return immediately and run in background1517 if the system supports it. Default is true.15181519gc.logExpiry::1520 If the file gc.log exists, then `git gc --auto` won't run1521 unless that file is more than 'gc.logExpiry' old. Default is1522 "1.day". See `gc.pruneExpire` for more ways to specify its1523 value.15241525gc.packRefs::1526 Running `git pack-refs` in a repository renders it1527 unclonable by Git versions prior to 1.5.1.2 over dumb1528 transports such as HTTP. This variable determines whether1529 'git gc' runs `git pack-refs`. This can be set to `notbare`1530 to enable it within all non-bare repos or it can be set to a1531 boolean value. The default is `true`.15321533gc.pruneExpire::1534 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1535 Override the grace period with this config variable. The value1536 "now" may be used to disable this grace period and always prune1537 unreachable objects immediately, or "never" may be used to1538 suppress pruning. This feature helps prevent corruption when1539 'git gc' runs concurrently with another process writing to the1540 repository; see the "NOTES" section of linkgit:git-gc[1].15411542gc.worktreePruneExpire::1543 When 'git gc' is run, it calls1544 'git worktree prune --expire 3.months.ago'.1545 This config variable can be used to set a different grace1546 period. The value "now" may be used to disable the grace1547 period and prune `$GIT_DIR/worktrees` immediately, or "never"1548 may be used to suppress pruning.15491550gc.reflogExpire::1551gc.<pattern>.reflogExpire::1552 'git reflog expire' removes reflog entries older than1553 this time; defaults to 90 days. The value "now" expires all1554 entries immediately, and "never" suppresses expiration1555 altogether. With "<pattern>" (e.g.1556 "refs/stash") in the middle the setting applies only to1557 the refs that match the <pattern>.15581559gc.reflogExpireUnreachable::1560gc.<pattern>.reflogExpireUnreachable::1561 'git reflog expire' removes reflog entries older than1562 this time and are not reachable from the current tip;1563 defaults to 30 days. The value "now" expires all entries1564 immediately, and "never" suppresses expiration altogether.1565 With "<pattern>" (e.g. "refs/stash")1566 in the middle, the setting applies only to the refs that1567 match the <pattern>.15681569gc.rerereResolved::1570 Records of conflicted merge you resolved earlier are1571 kept for this many days when 'git rerere gc' is run.1572 You can also use more human-readable "1.month.ago", etc.1573 The default is 60 days. See linkgit:git-rerere[1].15741575gc.rerereUnresolved::1576 Records of conflicted merge you have not resolved are1577 kept for this many days when 'git rerere gc' is run.1578 You can also use more human-readable "1.month.ago", etc.1579 The default is 15 days. See linkgit:git-rerere[1].15801581gitcvs.commitMsgAnnotation::1582 Append this string to each commit message. Set to empty string1583 to disable this feature. Defaults to "via git-CVS emulator".15841585gitcvs.enabled::1586 Whether the CVS server interface is enabled for this repository.1587 See linkgit:git-cvsserver[1].15881589gitcvs.logFile::1590 Path to a log file where the CVS server interface well... logs1591 various stuff. See linkgit:git-cvsserver[1].15921593gitcvs.usecrlfattr::1594 If true, the server will look up the end-of-line conversion1595 attributes for files to determine the `-k` modes to use. If1596 the attributes force Git to treat a file as text,1597 the `-k` mode will be left blank so CVS clients will1598 treat it as text. If they suppress text conversion, the file1599 will be set with '-kb' mode, which suppresses any newline munging1600 the client might otherwise do. If the attributes do not allow1601 the file type to be determined, then `gitcvs.allBinary` is1602 used. See linkgit:gitattributes[5].16031604gitcvs.allBinary::1605 This is used if `gitcvs.usecrlfattr` does not resolve1606 the correct '-kb' mode to use. If true, all1607 unresolved files are sent to the client in1608 mode '-kb'. This causes the client to treat them1609 as binary files, which suppresses any newline munging it1610 otherwise might do. Alternatively, if it is set to "guess",1611 then the contents of the file are examined to decide if1612 it is binary, similar to `core.autocrlf`.16131614gitcvs.dbName::1615 Database used by git-cvsserver to cache revision information1616 derived from the Git repository. The exact meaning depends on the1617 used database driver, for SQLite (which is the default driver) this1618 is a filename. Supports variable substitution (see1619 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1620 Default: '%Ggitcvs.%m.sqlite'16211622gitcvs.dbDriver::1623 Used Perl DBI driver. You can specify any available driver1624 for this here, but it might not work. git-cvsserver is tested1625 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1626 reported *not* to work with 'DBD::mysql'. Experimental feature.1627 May not contain double colons (`:`). Default: 'SQLite'.1628 See linkgit:git-cvsserver[1].16291630gitcvs.dbUser, gitcvs.dbPass::1631 Database user and password. Only useful if setting `gitcvs.dbDriver`,1632 since SQLite has no concept of database users and/or passwords.1633 'gitcvs.dbUser' supports variable substitution (see1634 linkgit:git-cvsserver[1] for details).16351636gitcvs.dbTableNamePrefix::1637 Database table name prefix. Prepended to the names of any1638 database tables used, allowing a single database to be used1639 for several repositories. Supports variable substitution (see1640 linkgit:git-cvsserver[1] for details). Any non-alphabetic1641 characters will be replaced with underscores.16421643All gitcvs variables except for `gitcvs.usecrlfattr` and1644`gitcvs.allBinary` can also be specified as1645'gitcvs.<access_method>.<varname>' (where 'access_method'1646is one of "ext" and "pserver") to make them apply only for the given1647access method.16481649gitweb.category::1650gitweb.description::1651gitweb.owner::1652gitweb.url::1653 See linkgit:gitweb[1] for description.16541655gitweb.avatar::1656gitweb.blame::1657gitweb.grep::1658gitweb.highlight::1659gitweb.patches::1660gitweb.pickaxe::1661gitweb.remote_heads::1662gitweb.showSizes::1663gitweb.snapshot::1664 See linkgit:gitweb.conf[5] for description.16651666grep.lineNumber::1667 If set to true, enable `-n` option by default.16681669grep.patternType::1670 Set the default matching behavior. Using a value of 'basic', 'extended',1671 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1672 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1673 value 'default' will return to the default matching behavior.16741675grep.extendedRegexp::1676 If set to true, enable `--extended-regexp` option by default. This1677 option is ignored when the `grep.patternType` option is set to a value1678 other than 'default'.16791680grep.threads::1681 Number of grep worker threads to use.1682 See `grep.threads` in linkgit:git-grep[1] for more information.16831684grep.fallbackToNoIndex::1685 If set to true, fall back to git grep --no-index if git grep1686 is executed outside of a git repository. Defaults to false.16871688gpg.program::1689 Use this custom program instead of "`gpg`" found on `$PATH` when1690 making or verifying a PGP signature. The program must support the1691 same command-line interface as GPG, namely, to verify a detached1692 signature, "`gpg --verify $file - <$signature`" is run, and the1693 program is expected to signal a good signature by exiting with1694 code 0, and to generate an ASCII-armored detached signature, the1695 standard input of "`gpg -bsau $key`" is fed with the contents to be1696 signed, and the program is expected to send the result to its1697 standard output.16981699gui.commitMsgWidth::1700 Defines how wide the commit message window is in the1701 linkgit:git-gui[1]. "75" is the default.17021703gui.diffContext::1704 Specifies how many context lines should be used in calls to diff1705 made by the linkgit:git-gui[1]. The default is "5".17061707gui.displayUntracked::1708 Determines if linkgit:git-gui[1] shows untracked files1709 in the file list. The default is "true".17101711gui.encoding::1712 Specifies the default encoding to use for displaying of1713 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1714 It can be overridden by setting the 'encoding' attribute1715 for relevant files (see linkgit:gitattributes[5]).1716 If this option is not set, the tools default to the1717 locale encoding.17181719gui.matchTrackingBranch::1720 Determines if new branches created with linkgit:git-gui[1] should1721 default to tracking remote branches with matching names or1722 not. Default: "false".17231724gui.newBranchTemplate::1725 Is used as suggested name when creating new branches using the1726 linkgit:git-gui[1].17271728gui.pruneDuringFetch::1729 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1730 performing a fetch. The default value is "false".17311732gui.trustmtime::1733 Determines if linkgit:git-gui[1] should trust the file modification1734 timestamp or not. By default the timestamps are not trusted.17351736gui.spellingDictionary::1737 Specifies the dictionary used for spell checking commit messages in1738 the linkgit:git-gui[1]. When set to "none" spell checking is turned1739 off.17401741gui.fastCopyBlame::1742 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1743 location detection. It makes blame significantly faster on huge1744 repositories at the expense of less thorough copy detection.17451746gui.copyBlameThreshold::1747 Specifies the threshold to use in 'git gui blame' original location1748 detection, measured in alphanumeric characters. See the1749 linkgit:git-blame[1] manual for more information on copy detection.17501751gui.blamehistoryctx::1752 Specifies the radius of history context in days to show in1753 linkgit:gitk[1] for the selected commit, when the `Show History1754 Context` menu item is invoked from 'git gui blame'. If this1755 variable is set to zero, the whole history is shown.17561757guitool.<name>.cmd::1758 Specifies the shell command line to execute when the corresponding item1759 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1760 mandatory for every tool. The command is executed from the root of1761 the working directory, and in the environment it receives the name of1762 the tool as `GIT_GUITOOL`, the name of the currently selected file as1763 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1764 the head is detached, 'CUR_BRANCH' is empty).17651766guitool.<name>.needsFile::1767 Run the tool only if a diff is selected in the GUI. It guarantees1768 that 'FILENAME' is not empty.17691770guitool.<name>.noConsole::1771 Run the command silently, without creating a window to display its1772 output.17731774guitool.<name>.noRescan::1775 Don't rescan the working directory for changes after the tool1776 finishes execution.17771778guitool.<name>.confirm::1779 Show a confirmation dialog before actually running the tool.17801781guitool.<name>.argPrompt::1782 Request a string argument from the user, and pass it to the tool1783 through the `ARGS` environment variable. Since requesting an1784 argument implies confirmation, the 'confirm' option has no effect1785 if this is enabled. If the option is set to 'true', 'yes', or '1',1786 the dialog uses a built-in generic prompt; otherwise the exact1787 value of the variable is used.17881789guitool.<name>.revPrompt::1790 Request a single valid revision from the user, and set the1791 `REVISION` environment variable. In other aspects this option1792 is similar to 'argPrompt', and can be used together with it.17931794guitool.<name>.revUnmerged::1795 Show only unmerged branches in the 'revPrompt' subdialog.1796 This is useful for tools similar to merge or rebase, but not1797 for things like checkout or reset.17981799guitool.<name>.title::1800 Specifies the title to use for the prompt dialog. The default1801 is the tool name.18021803guitool.<name>.prompt::1804 Specifies the general prompt string to display at the top of1805 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1806 The default value includes the actual command.18071808help.browser::1809 Specify the browser that will be used to display help in the1810 'web' format. See linkgit:git-help[1].18111812help.format::1813 Override the default help format used by linkgit:git-help[1].1814 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1815 the default. 'web' and 'html' are the same.18161817help.autoCorrect::1818 Automatically correct and execute mistyped commands after1819 waiting for the given number of deciseconds (0.1 sec). If more1820 than one command can be deduced from the entered text, nothing1821 will be executed. If the value of this option is negative,1822 the corrected command will be executed immediately. If the1823 value is 0 - the command will be just shown but not executed.1824 This is the default.18251826help.htmlPath::1827 Specify the path where the HTML documentation resides. File system paths1828 and URLs are supported. HTML pages will be prefixed with this path when1829 help is displayed in the 'web' format. This defaults to the documentation1830 path of your Git installation.18311832http.proxy::1833 Override the HTTP proxy, normally configured using the 'http_proxy',1834 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1835 addition to the syntax understood by curl, it is possible to specify a1836 proxy string with a user name but no password, in which case git will1837 attempt to acquire one in the same way it does for other credentials. See1838 linkgit:gitcredentials[7] for more information. The syntax thus is1839 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1840 on a per-remote basis; see remote.<name>.proxy18411842http.proxyAuthMethod::1843 Set the method with which to authenticate against the HTTP proxy. This1844 only takes effect if the configured proxy string contains a user name part1845 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1846 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1847 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1848 variable. Possible values are:1849+1850--1851* `anyauth` - Automatically pick a suitable authentication method. It is1852 assumed that the proxy answers an unauthenticated request with a 4071853 status code and one or more Proxy-authenticate headers with supported1854 authentication methods. This is the default.1855* `basic` - HTTP Basic authentication1856* `digest` - HTTP Digest authentication; this prevents the password from being1857 transmitted to the proxy in clear text1858* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1859 of `curl(1)`)1860* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1861--18621863http.emptyAuth::1864 Attempt authentication without seeking a username or password. This1865 can be used to attempt GSS-Negotiate authentication without specifying1866 a username in the URL, as libcurl normally requires a username for1867 authentication.18681869http.delegation::1870 Control GSSAPI credential delegation. The delegation is disabled1871 by default in libcurl since version 7.21.7. Set parameter to tell1872 the server what it is allowed to delegate when it comes to user1873 credentials. Used with GSS/kerberos. Possible values are:1874+1875--1876* `none` - Don't allow any delegation.1877* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1878 Kerberos service ticket, which is a matter of realm policy.1879* `always` - Unconditionally allow the server to delegate.1880--188118821883http.extraHeader::1884 Pass an additional HTTP header when communicating with a server. If1885 more than one such entry exists, all of them are added as extra1886 headers. To allow overriding the settings inherited from the system1887 config, an empty value will reset the extra headers to the empty list.18881889http.cookieFile::1890 The pathname of a file containing previously stored cookie lines,1891 which should be used1892 in the Git http session, if they match the server. The file format1893 of the file to read cookies from should be plain HTTP headers or1894 the Netscape/Mozilla cookie file format (see `curl(1)`).1895 NOTE that the file specified with http.cookieFile is used only as1896 input unless http.saveCookies is set.18971898http.saveCookies::1899 If set, store cookies received during requests to the file specified by1900 http.cookieFile. Has no effect if http.cookieFile is unset.19011902http.sslVersion::1903 The SSL version to use when negotiating an SSL connection, if you1904 want to force the default. The available and default version1905 depend on whether libcurl was built against NSS or OpenSSL and the1906 particular configuration of the crypto library in use. Internally1907 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1908 documentation for more details on the format of this option and1909 for the ssl version supported. Actually the possible values of1910 this option are:19111912 - sslv21913 - sslv31914 - tlsv11915 - tlsv1.01916 - tlsv1.11917 - tlsv1.219181919+1920Can be overridden by the `GIT_SSL_VERSION` environment variable.1921To force git to use libcurl's default ssl version and ignore any1922explicit http.sslversion option, set `GIT_SSL_VERSION` to the1923empty string.19241925http.sslCipherList::1926 A list of SSL ciphers to use when negotiating an SSL connection.1927 The available ciphers depend on whether libcurl was built against1928 NSS or OpenSSL and the particular configuration of the crypto1929 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1930 option; see the libcurl documentation for more details on the format1931 of this list.1932+1933Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1934To force git to use libcurl's default cipher list and ignore any1935explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1936empty string.19371938http.sslVerify::1939 Whether to verify the SSL certificate when fetching or pushing1940 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1941 variable.19421943http.sslCert::1944 File containing the SSL certificate when fetching or pushing1945 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1946 variable.19471948http.sslKey::1949 File containing the SSL private key when fetching or pushing1950 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1951 variable.19521953http.sslCertPasswordProtected::1954 Enable Git's password prompt for the SSL certificate. Otherwise1955 OpenSSL will prompt the user, possibly many times, if the1956 certificate or private key is encrypted. Can be overridden by the1957 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19581959http.sslCAInfo::1960 File containing the certificates to verify the peer with when1961 fetching or pushing over HTTPS. Can be overridden by the1962 `GIT_SSL_CAINFO` environment variable.19631964http.sslCAPath::1965 Path containing files with the CA certificates to verify the peer1966 with when fetching or pushing over HTTPS. Can be overridden1967 by the `GIT_SSL_CAPATH` environment variable.19681969http.pinnedpubkey::1970 Public key of the https service. It may either be the filename of1971 a PEM or DER encoded public key file or a string starting with1972 'sha256//' followed by the base64 encoded sha256 hash of the1973 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1974 exit with an error if this option is set but not supported by1975 cURL.19761977http.sslTry::1978 Attempt to use AUTH SSL/TLS and encrypted data transfers1979 when connecting via regular FTP protocol. This might be needed1980 if the FTP server requires it for security reasons or you wish1981 to connect securely whenever remote FTP server supports it.1982 Default is false since it might trigger certificate verification1983 errors on misconfigured servers.19841985http.maxRequests::1986 How many HTTP requests to launch in parallel. Can be overridden1987 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.19881989http.minSessions::1990 The number of curl sessions (counted across slots) to be kept across1991 requests. They will not be ended with curl_easy_cleanup() until1992 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1993 value will be capped at 1. Defaults to 1.19941995http.postBuffer::1996 Maximum size in bytes of the buffer used by smart HTTP1997 transports when POSTing data to the remote system.1998 For requests larger than this buffer size, HTTP/1.1 and1999 Transfer-Encoding: chunked is used to avoid creating a2000 massive pack file locally. Default is 1 MiB, which is2001 sufficient for most requests.20022003http.lowSpeedLimit, http.lowSpeedTime::2004 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2005 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2006 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2007 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20082009http.noEPSV::2010 A boolean which disables using of EPSV ftp command by curl.2011 This can helpful with some "poor" ftp servers which don't2012 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2013 environment variable. Default is false (curl will use EPSV).20142015http.userAgent::2016 The HTTP USER_AGENT string presented to an HTTP server. The default2017 value represents the version of the client Git such as git/1.7.1.2018 This option allows you to override this value to a more common value2019 such as Mozilla/4.0. This may be necessary, for instance, if2020 connecting through a firewall that restricts HTTP connections to a set2021 of common USER_AGENT strings (but not including those like git/1.7.1).2022 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20232024http.followRedirects::2025 Whether git should follow HTTP redirects. If set to `true`, git2026 will transparently follow any redirect issued by a server it2027 encounters. If set to `false`, git will treat all redirects as2028 errors. If set to `initial`, git will follow redirects only for2029 the initial request to a remote, but not for subsequent2030 follow-up HTTP requests. Since git uses the redirected URL as2031 the base for the follow-up requests, this is generally2032 sufficient. The default is `initial`.20332034http.<url>.*::2035 Any of the http.* options above can be applied selectively to some URLs.2036 For a config key to match a URL, each element of the config key is2037 compared to that of the URL, in the following order:2038+2039--2040. Scheme (e.g., `https` in `https://example.com/`). This field2041 must match exactly between the config key and the URL.20422043. Host/domain name (e.g., `example.com` in `https://example.com/`).2044 This field must match between the config key and the URL. It is2045 possible to specify a `*` as part of the host name to match all subdomains2046 at this level. `https://*.example.com/` for example would match2047 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20482049. Port number (e.g., `8080` in `http://example.com:8080/`).2050 This field must match exactly between the config key and the URL.2051 Omitted port numbers are automatically converted to the correct2052 default for the scheme before matching.20532054. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2055 path field of the config key must match the path field of the URL2056 either exactly or as a prefix of slash-delimited path elements. This means2057 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2058 match on a slash (`/`) boundary. Longer matches take precedence (so a config2059 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2060 key with just path `foo/`).20612062. User name (e.g., `user` in `https://user@example.com/repo.git`). If2063 the config key has a user name it must match the user name in the2064 URL exactly. If the config key does not have a user name, that2065 config key will match a URL with any user name (including none),2066 but at a lower precedence than a config key with a user name.2067--2068+2069The list above is ordered by decreasing precedence; a URL that matches2070a config key's path is preferred to one that matches its user name. For example,2071if the URL is `https://user@example.com/foo/bar` a config key match of2072`https://example.com/foo` will be preferred over a config key match of2073`https://user@example.com`.2074+2075All URLs are normalized before attempting any matching (the password part,2076if embedded in the URL, is always ignored for matching purposes) so that2077equivalent URLs that are simply spelled differently will match properly.2078Environment variable settings always override any matches. The URLs that are2079matched against are those given directly to Git commands. This means any URLs2080visited as a result of a redirection do not participate in matching.20812082ssh.variant::2083 Depending on the value of the environment variables `GIT_SSH` or2084 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git2085 auto-detects whether to adjust its command-line parameters for use2086 with plink or tortoiseplink, as opposed to the default (OpenSSH).2087+2088The config variable `ssh.variant` can be set to override this auto-detection;2089valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value2090will be treated as normal ssh. This setting can be overridden via the2091environment variable `GIT_SSH_VARIANT`.20922093i18n.commitEncoding::2094 Character encoding the commit messages are stored in; Git itself2095 does not care per se, but this information is necessary e.g. when2096 importing commits from emails or in the gitk graphical history2097 browser (and possibly at other places in the future or in other2098 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.20992100i18n.logOutputEncoding::2101 Character encoding the commit messages are converted to when2102 running 'git log' and friends.21032104imap::2105 The configuration variables in the 'imap' section are described2106 in linkgit:git-imap-send[1].21072108index.version::2109 Specify the version with which new index files should be2110 initialized. This does not affect existing repositories.21112112init.templateDir::2113 Specify the directory from which templates will be copied.2114 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21152116instaweb.browser::2117 Specify the program that will be used to browse your working2118 repository in gitweb. See linkgit:git-instaweb[1].21192120instaweb.httpd::2121 The HTTP daemon command-line to start gitweb on your working2122 repository. See linkgit:git-instaweb[1].21232124instaweb.local::2125 If true the web server started by linkgit:git-instaweb[1] will2126 be bound to the local IP (127.0.0.1).21272128instaweb.modulePath::2129 The default module path for linkgit:git-instaweb[1] to use2130 instead of /usr/lib/apache2/modules. Only used if httpd2131 is Apache.21322133instaweb.port::2134 The port number to bind the gitweb httpd to. See2135 linkgit:git-instaweb[1].21362137interactive.singleKey::2138 In interactive commands, allow the user to provide one-letter2139 input with a single key (i.e., without hitting enter).2140 Currently this is used by the `--patch` mode of2141 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2142 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2143 setting is silently ignored if portable keystroke input2144 is not available; requires the Perl module Term::ReadKey.21452146interactive.diffFilter::2147 When an interactive command (such as `git add --patch`) shows2148 a colorized diff, git will pipe the diff through the shell2149 command defined by this configuration variable. The command may2150 mark up the diff further for human consumption, provided that it2151 retains a one-to-one correspondence with the lines in the2152 original diff. Defaults to disabled (no filtering).21532154log.abbrevCommit::2155 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2156 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2157 override this option with `--no-abbrev-commit`.21582159log.date::2160 Set the default date-time mode for the 'log' command.2161 Setting a value for log.date is similar to using 'git log''s2162 `--date` option. See linkgit:git-log[1] for details.21632164log.decorate::2165 Print out the ref names of any commits that are shown by the log2166 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2167 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2168 specified, the full ref name (including prefix) will be printed.2169 If 'auto' is specified, then if the output is going to a terminal,2170 the ref names are shown as if 'short' were given, otherwise no ref2171 names are shown. This is the same as the `--decorate` option2172 of the `git log`.21732174log.follow::2175 If `true`, `git log` will act as if the `--follow` option was used when2176 a single <path> is given. This has the same limitations as `--follow`,2177 i.e. it cannot be used to follow multiple files and does not work well2178 on non-linear history.21792180log.graphColors::2181 A list of colors, separated by commas, that can be used to draw2182 history lines in `git log --graph`.21832184log.showRoot::2185 If true, the initial commit will be shown as a big creation event.2186 This is equivalent to a diff against an empty tree.2187 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2188 normally hide the root commit will now show it. True by default.21892190log.showSignature::2191 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2192 linkgit:git-whatchanged[1] assume `--show-signature`.21932194log.mailmap::2195 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2196 linkgit:git-whatchanged[1] assume `--use-mailmap`.21972198mailinfo.scissors::2199 If true, makes linkgit:git-mailinfo[1] (and therefore2200 linkgit:git-am[1]) act by default as if the --scissors option2201 was provided on the command-line. When active, this features2202 removes everything from the message body before a scissors2203 line (i.e. consisting mainly of ">8", "8<" and "-").22042205mailmap.file::2206 The location of an augmenting mailmap file. The default2207 mailmap, located in the root of the repository, is loaded2208 first, then the mailmap file pointed to by this variable.2209 The location of the mailmap file may be in a repository2210 subdirectory, or somewhere outside of the repository itself.2211 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22122213mailmap.blob::2214 Like `mailmap.file`, but consider the value as a reference to a2215 blob in the repository. If both `mailmap.file` and2216 `mailmap.blob` are given, both are parsed, with entries from2217 `mailmap.file` taking precedence. In a bare repository, this2218 defaults to `HEAD:.mailmap`. In a non-bare repository, it2219 defaults to empty.22202221man.viewer::2222 Specify the programs that may be used to display help in the2223 'man' format. See linkgit:git-help[1].22242225man.<tool>.cmd::2226 Specify the command to invoke the specified man viewer. The2227 specified command is evaluated in shell with the man page2228 passed as argument. (See linkgit:git-help[1].)22292230man.<tool>.path::2231 Override the path for the given tool that may be used to2232 display help in the 'man' format. See linkgit:git-help[1].22332234include::merge-config.txt[]22352236mergetool.<tool>.path::2237 Override the path for the given tool. This is useful in case2238 your tool is not in the PATH.22392240mergetool.<tool>.cmd::2241 Specify the command to invoke the specified merge tool. The2242 specified command is evaluated in shell with the following2243 variables available: 'BASE' is the name of a temporary file2244 containing the common base of the files to be merged, if available;2245 'LOCAL' is the name of a temporary file containing the contents of2246 the file on the current branch; 'REMOTE' is the name of a temporary2247 file containing the contents of the file from the branch being2248 merged; 'MERGED' contains the name of the file to which the merge2249 tool should write the results of a successful merge.22502251mergetool.<tool>.trustExitCode::2252 For a custom merge command, specify whether the exit code of2253 the merge command can be used to determine whether the merge was2254 successful. If this is not set to true then the merge target file2255 timestamp is checked and the merge assumed to have been successful2256 if the file has been updated, otherwise the user is prompted to2257 indicate the success of the merge.22582259mergetool.meld.hasOutput::2260 Older versions of `meld` do not support the `--output` option.2261 Git will attempt to detect whether `meld` supports `--output`2262 by inspecting the output of `meld --help`. Configuring2263 `mergetool.meld.hasOutput` will make Git skip these checks and2264 use the configured value instead. Setting `mergetool.meld.hasOutput`2265 to `true` tells Git to unconditionally use the `--output` option,2266 and `false` avoids using `--output`.22672268mergetool.keepBackup::2269 After performing a merge, the original file with conflict markers2270 can be saved as a file with a `.orig` extension. If this variable2271 is set to `false` then this file is not preserved. Defaults to2272 `true` (i.e. keep the backup files).22732274mergetool.keepTemporaries::2275 When invoking a custom merge tool, Git uses a set of temporary2276 files to pass to the tool. If the tool returns an error and this2277 variable is set to `true`, then these temporary files will be2278 preserved, otherwise they will be removed after the tool has2279 exited. Defaults to `false`.22802281mergetool.writeToTemp::2282 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2283 conflicting files in the worktree by default. Git will attempt2284 to use a temporary directory for these files when set `true`.2285 Defaults to `false`.22862287mergetool.prompt::2288 Prompt before each invocation of the merge resolution program.22892290notes.mergeStrategy::2291 Which merge strategy to choose by default when resolving notes2292 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2293 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2294 section of linkgit:git-notes[1] for more information on each strategy.22952296notes.<name>.mergeStrategy::2297 Which merge strategy to choose when doing a notes merge into2298 refs/notes/<name>. This overrides the more general2299 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2300 linkgit:git-notes[1] for more information on the available strategies.23012302notes.displayRef::2303 The (fully qualified) refname from which to show notes when2304 showing commit messages. The value of this variable can be set2305 to a glob, in which case notes from all matching refs will be2306 shown. You may also specify this configuration variable2307 several times. A warning will be issued for refs that do not2308 exist, but a glob that does not match any refs is silently2309 ignored.2310+2311This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2312environment variable, which must be a colon separated list of refs or2313globs.2314+2315The effective value of "core.notesRef" (possibly overridden by2316GIT_NOTES_REF) is also implicitly added to the list of refs to be2317displayed.23182319notes.rewrite.<command>::2320 When rewriting commits with <command> (currently `amend` or2321 `rebase`) and this variable is set to `true`, Git2322 automatically copies your notes from the original to the2323 rewritten commit. Defaults to `true`, but see2324 "notes.rewriteRef" below.23252326notes.rewriteMode::2327 When copying notes during a rewrite (see the2328 "notes.rewrite.<command>" option), determines what to do if2329 the target commit already has a note. Must be one of2330 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2331 Defaults to `concatenate`.2332+2333This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2334environment variable.23352336notes.rewriteRef::2337 When copying notes during a rewrite, specifies the (fully2338 qualified) ref whose notes should be copied. The ref may be a2339 glob, in which case notes in all matching refs will be copied.2340 You may also specify this configuration several times.2341+2342Does not have a default value; you must configure this variable to2343enable note rewriting. Set it to `refs/notes/commits` to enable2344rewriting for the default commit notes.2345+2346This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2347environment variable, which must be a colon separated list of refs or2348globs.23492350pack.window::2351 The size of the window used by linkgit:git-pack-objects[1] when no2352 window size is given on the command line. Defaults to 10.23532354pack.depth::2355 The maximum delta depth used by linkgit:git-pack-objects[1] when no2356 maximum depth is given on the command line. Defaults to 50.23572358pack.windowMemory::2359 The maximum size of memory that is consumed by each thread2360 in linkgit:git-pack-objects[1] for pack window memory when2361 no limit is given on the command line. The value can be2362 suffixed with "k", "m", or "g". When left unconfigured (or2363 set explicitly to 0), there will be no limit.23642365pack.compression::2366 An integer -1..9, indicating the compression level for objects2367 in a pack file. -1 is the zlib default. 0 means no2368 compression, and 1..9 are various speed/size tradeoffs, 9 being2369 slowest. If not set, defaults to core.compression. If that is2370 not set, defaults to -1, the zlib default, which is "a default2371 compromise between speed and compression (currently equivalent2372 to level 6)."2373+2374Note that changing the compression level will not automatically recompress2375all existing objects. You can force recompression by passing the -F option2376to linkgit:git-repack[1].23772378pack.deltaCacheSize::2379 The maximum memory in bytes used for caching deltas in2380 linkgit:git-pack-objects[1] before writing them out to a pack.2381 This cache is used to speed up the writing object phase by not2382 having to recompute the final delta result once the best match2383 for all objects is found. Repacking large repositories on machines2384 which are tight with memory might be badly impacted by this though,2385 especially if this cache pushes the system into swapping.2386 A value of 0 means no limit. The smallest size of 1 byte may be2387 used to virtually disable this cache. Defaults to 256 MiB.23882389pack.deltaCacheLimit::2390 The maximum size of a delta, that is cached in2391 linkgit:git-pack-objects[1]. This cache is used to speed up the2392 writing object phase by not having to recompute the final delta2393 result once the best match for all objects is found. Defaults to 1000.23942395pack.threads::2396 Specifies the number of threads to spawn when searching for best2397 delta matches. This requires that linkgit:git-pack-objects[1]2398 be compiled with pthreads otherwise this option is ignored with a2399 warning. This is meant to reduce packing time on multiprocessor2400 machines. The required amount of memory for the delta search window2401 is however multiplied by the number of threads.2402 Specifying 0 will cause Git to auto-detect the number of CPU's2403 and set the number of threads accordingly.24042405pack.indexVersion::2406 Specify the default pack index version. Valid values are 1 for2407 legacy pack index used by Git versions prior to 1.5.2, and 2 for2408 the new pack index with capabilities for packs larger than 4 GB2409 as well as proper protection against the repacking of corrupted2410 packs. Version 2 is the default. Note that version 2 is enforced2411 and this config option ignored whenever the corresponding pack is2412 larger than 2 GB.2413+2414If you have an old Git that does not understand the version 2 `*.idx` file,2415cloning or fetching over a non native protocol (e.g. "http")2416that will copy both `*.pack` file and corresponding `*.idx` file from the2417other side may give you a repository that cannot be accessed with your2418older version of Git. If the `*.pack` file is smaller than 2 GB, however,2419you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2420the `*.idx` file.24212422pack.packSizeLimit::2423 The maximum size of a pack. This setting only affects2424 packing to a file when repacking, i.e. the git:// protocol2425 is unaffected. It can be overridden by the `--max-pack-size`2426 option of linkgit:git-repack[1]. Reaching this limit results2427 in the creation of multiple packfiles; which in turn prevents2428 bitmaps from being created.2429 The minimum size allowed is limited to 1 MiB.2430 The default is unlimited.2431 Common unit suffixes of 'k', 'm', or 'g' are2432 supported.24332434pack.useBitmaps::2435 When true, git will use pack bitmaps (if available) when packing2436 to stdout (e.g., during the server side of a fetch). Defaults to2437 true. You should not generally need to turn this off unless2438 you are debugging pack bitmaps.24392440pack.writeBitmaps (deprecated)::2441 This is a deprecated synonym for `repack.writeBitmaps`.24422443pack.writeBitmapHashCache::2444 When true, git will include a "hash cache" section in the bitmap2445 index (if one is written). This cache can be used to feed git's2446 delta heuristics, potentially leading to better deltas between2447 bitmapped and non-bitmapped objects (e.g., when serving a fetch2448 between an older, bitmapped pack and objects that have been2449 pushed since the last gc). The downside is that it consumes 42450 bytes per object of disk space, and that JGit's bitmap2451 implementation does not understand it, causing it to complain if2452 Git and JGit are used on the same repository. Defaults to false.24532454pager.<cmd>::2455 If the value is boolean, turns on or off pagination of the2456 output of a particular Git subcommand when writing to a tty.2457 Otherwise, turns on pagination for the subcommand using the2458 pager specified by the value of `pager.<cmd>`. If `--paginate`2459 or `--no-pager` is specified on the command line, it takes2460 precedence over this option. To disable pagination for all2461 commands, set `core.pager` or `GIT_PAGER` to `cat`.24622463pretty.<name>::2464 Alias for a --pretty= format string, as specified in2465 linkgit:git-log[1]. Any aliases defined here can be used just2466 as the built-in pretty formats could. For example,2467 running `git config pretty.changelog "format:* %H %s"`2468 would cause the invocation `git log --pretty=changelog`2469 to be equivalent to running `git log "--pretty=format:* %H %s"`.2470 Note that an alias with the same name as a built-in format2471 will be silently ignored.24722473protocol.allow::2474 If set, provide a user defined default policy for all protocols which2475 don't explicitly have a policy (`protocol.<name>.allow`). By default,2476 if unset, known-safe protocols (http, https, git, ssh, file) have a2477 default policy of `always`, known-dangerous protocols (ext) have a2478 default policy of `never`, and all other protocols have a default2479 policy of `user`. Supported policies:2480+2481--24822483* `always` - protocol is always able to be used.24842485* `never` - protocol is never able to be used.24862487* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2488 either unset or has a value of 1. This policy should be used when you want a2489 protocol to be directly usable by the user but don't want it used by commands which2490 execute clone/fetch/push commands without user input, e.g. recursive2491 submodule initialization.24922493--24942495protocol.<name>.allow::2496 Set a policy to be used by protocol `<name>` with clone/fetch/push2497 commands. See `protocol.allow` above for the available policies.2498+2499The protocol names currently used by git are:2500+2501--2502 - `file`: any local file-based path (including `file://` URLs,2503 or local paths)25042505 - `git`: the anonymous git protocol over a direct TCP2506 connection (or proxy, if configured)25072508 - `ssh`: git over ssh (including `host:path` syntax,2509 `ssh://`, etc).25102511 - `http`: git over http, both "smart http" and "dumb http".2512 Note that this does _not_ include `https`; if you want to configure2513 both, you must do so individually.25142515 - any external helpers are named by their protocol (e.g., use2516 `hg` to allow the `git-remote-hg` helper)2517--25182519pull.ff::2520 By default, Git does not create an extra merge commit when merging2521 a commit that is a descendant of the current commit. Instead, the2522 tip of the current branch is fast-forwarded. When set to `false`,2523 this variable tells Git to create an extra merge commit in such2524 a case (equivalent to giving the `--no-ff` option from the command2525 line). When set to `only`, only such fast-forward merges are2526 allowed (equivalent to giving the `--ff-only` option from the2527 command line). This setting overrides `merge.ff` when pulling.25282529pull.rebase::2530 When true, rebase branches on top of the fetched branch, instead2531 of merging the default branch from the default remote when "git2532 pull" is run. See "branch.<name>.rebase" for setting this on a2533 per-branch basis.2534+2535When preserve, also pass `--preserve-merges` along to 'git rebase'2536so that locally committed merge commits will not be flattened2537by running 'git pull'.2538+2539When the value is `interactive`, the rebase is run in interactive mode.2540+2541*NOTE*: this is a possibly dangerous operation; do *not* use2542it unless you understand the implications (see linkgit:git-rebase[1]2543for details).25442545pull.octopus::2546 The default merge strategy to use when pulling multiple branches2547 at once.25482549pull.twohead::2550 The default merge strategy to use when pulling a single branch.25512552push.default::2553 Defines the action `git push` should take if no refspec is2554 explicitly given. Different values are well-suited for2555 specific workflows; for instance, in a purely central workflow2556 (i.e. the fetch source is equal to the push destination),2557 `upstream` is probably what you want. Possible values are:2558+2559--25602561* `nothing` - do not push anything (error out) unless a refspec is2562 explicitly given. This is primarily meant for people who want to2563 avoid mistakes by always being explicit.25642565* `current` - push the current branch to update a branch with the same2566 name on the receiving end. Works in both central and non-central2567 workflows.25682569* `upstream` - push the current branch back to the branch whose2570 changes are usually integrated into the current branch (which is2571 called `@{upstream}`). This mode only makes sense if you are2572 pushing to the same repository you would normally pull from2573 (i.e. central workflow).25742575* `tracking` - This is a deprecated synonym for `upstream`.25762577* `simple` - in centralized workflow, work like `upstream` with an2578 added safety to refuse to push if the upstream branch's name is2579 different from the local one.2580+2581When pushing to a remote that is different from the remote you normally2582pull from, work as `current`. This is the safest option and is suited2583for beginners.2584+2585This mode has become the default in Git 2.0.25862587* `matching` - push all branches having the same name on both ends.2588 This makes the repository you are pushing to remember the set of2589 branches that will be pushed out (e.g. if you always push 'maint'2590 and 'master' there and no other branches, the repository you push2591 to will have these two branches, and your local 'maint' and2592 'master' will be pushed there).2593+2594To use this mode effectively, you have to make sure _all_ the2595branches you would push out are ready to be pushed out before2596running 'git push', as the whole point of this mode is to allow you2597to push all of the branches in one go. If you usually finish work2598on only one branch and push out the result, while other branches are2599unfinished, this mode is not for you. Also this mode is not2600suitable for pushing into a shared central repository, as other2601people may add new branches there, or update the tip of existing2602branches outside your control.2603+2604This used to be the default, but not since Git 2.0 (`simple` is the2605new default).26062607--26082609push.followTags::2610 If set to true enable `--follow-tags` option by default. You2611 may override this configuration at time of push by specifying2612 `--no-follow-tags`.26132614push.gpgSign::2615 May be set to a boolean value, or the string 'if-asked'. A true2616 value causes all pushes to be GPG signed, as if `--signed` is2617 passed to linkgit:git-push[1]. The string 'if-asked' causes2618 pushes to be signed if the server supports it, as if2619 `--signed=if-asked` is passed to 'git push'. A false value may2620 override a value from a lower-priority config file. An explicit2621 command-line flag always overrides this config option.26222623push.recurseSubmodules::2624 Make sure all submodule commits used by the revisions to be pushed2625 are available on a remote-tracking branch. If the value is 'check'2626 then Git will verify that all submodule commits that changed in the2627 revisions to be pushed are available on at least one remote of the2628 submodule. If any commits are missing, the push will be aborted and2629 exit with non-zero status. If the value is 'on-demand' then all2630 submodules that changed in the revisions to be pushed will be2631 pushed. If on-demand was not able to push all necessary revisions2632 it will also be aborted and exit with non-zero status. If the value2633 is 'no' then default behavior of ignoring submodules when pushing2634 is retained. You may override this configuration at time of push by2635 specifying '--recurse-submodules=check|on-demand|no'.26362637rebase.stat::2638 Whether to show a diffstat of what changed upstream since the last2639 rebase. False by default.26402641rebase.autoSquash::2642 If set to true enable `--autosquash` option by default.26432644rebase.autoStash::2645 When set to true, automatically create a temporary stash entry2646 before the operation begins, and apply it after the operation2647 ends. This means that you can run rebase on a dirty worktree.2648 However, use with care: the final stash application after a2649 successful rebase might result in non-trivial conflicts.2650 Defaults to false.26512652rebase.missingCommitsCheck::2653 If set to "warn", git rebase -i will print a warning if some2654 commits are removed (e.g. a line was deleted), however the2655 rebase will still proceed. If set to "error", it will print2656 the previous warning and stop the rebase, 'git rebase2657 --edit-todo' can then be used to correct the error. If set to2658 "ignore", no checking is done.2659 To drop a commit without warning or error, use the `drop`2660 command in the todo-list.2661 Defaults to "ignore".26622663rebase.instructionFormat::2664 A format string, as specified in linkgit:git-log[1], to be used for2665 the instruction list during an interactive rebase. The format will automatically2666 have the long commit hash prepended to the format.26672668receive.advertiseAtomic::2669 By default, git-receive-pack will advertise the atomic push2670 capability to its clients. If you don't want to advertise this2671 capability, set this variable to false.26722673receive.advertisePushOptions::2674 When set to true, git-receive-pack will advertise the push options2675 capability to its clients. False by default.26762677receive.autogc::2678 By default, git-receive-pack will run "git-gc --auto" after2679 receiving data from git-push and updating refs. You can stop2680 it by setting this variable to false.26812682receive.certNonceSeed::2683 By setting this variable to a string, `git receive-pack`2684 will accept a `git push --signed` and verifies it by using2685 a "nonce" protected by HMAC using this string as a secret2686 key.26872688receive.certNonceSlop::2689 When a `git push --signed` sent a push certificate with a2690 "nonce" that was issued by a receive-pack serving the same2691 repository within this many seconds, export the "nonce"2692 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2693 hooks (instead of what the receive-pack asked the sending2694 side to include). This may allow writing checks in2695 `pre-receive` and `post-receive` a bit easier. Instead of2696 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2697 that records by how many seconds the nonce is stale to2698 decide if they want to accept the certificate, they only2699 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27002701receive.fsckObjects::2702 If it is set to true, git-receive-pack will check all received2703 objects. It will abort in the case of a malformed object or a2704 broken link. The result of an abort are only dangling objects.2705 Defaults to false. If not set, the value of `transfer.fsckObjects`2706 is used instead.27072708receive.fsck.<msg-id>::2709 When `receive.fsckObjects` is set to true, errors can be switched2710 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2711 setting where the `<msg-id>` is the fsck message ID and the value2712 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2713 the error/warning with the message ID, e.g. "missingEmail: invalid2714 author/committer line - missing email" means that setting2715 `receive.fsck.missingEmail = ignore` will hide that issue.2716+2717This feature is intended to support working with legacy repositories2718which would not pass pushing when `receive.fsckObjects = true`, allowing2719the host to accept repositories with certain known issues but still catch2720other issues.27212722receive.fsck.skipList::2723 The path to a sorted list of object names (i.e. one SHA-1 per2724 line) that are known to be broken in a non-fatal way and should2725 be ignored. This feature is useful when an established project2726 should be accepted despite early commits containing errors that2727 can be safely ignored such as invalid committer email addresses.2728 Note: corrupt objects cannot be skipped with this setting.27292730receive.keepAlive::2731 After receiving the pack from the client, `receive-pack` may2732 produce no output (if `--quiet` was specified) while processing2733 the pack, causing some networks to drop the TCP connection.2734 With this option set, if `receive-pack` does not transmit2735 any data in this phase for `receive.keepAlive` seconds, it will2736 send a short keepalive packet. The default is 5 seconds; set2737 to 0 to disable keepalives entirely.27382739receive.unpackLimit::2740 If the number of objects received in a push is below this2741 limit then the objects will be unpacked into loose object2742 files. However if the number of received objects equals or2743 exceeds this limit then the received pack will be stored as2744 a pack, after adding any missing delta bases. Storing the2745 pack from a push can make the push operation complete faster,2746 especially on slow filesystems. If not set, the value of2747 `transfer.unpackLimit` is used instead.27482749receive.maxInputSize::2750 If the size of the incoming pack stream is larger than this2751 limit, then git-receive-pack will error out, instead of2752 accepting the pack file. If not set or set to 0, then the size2753 is unlimited.27542755receive.denyDeletes::2756 If set to true, git-receive-pack will deny a ref update that deletes2757 the ref. Use this to prevent such a ref deletion via a push.27582759receive.denyDeleteCurrent::2760 If set to true, git-receive-pack will deny a ref update that2761 deletes the currently checked out branch of a non-bare repository.27622763receive.denyCurrentBranch::2764 If set to true or "refuse", git-receive-pack will deny a ref update2765 to the currently checked out branch of a non-bare repository.2766 Such a push is potentially dangerous because it brings the HEAD2767 out of sync with the index and working tree. If set to "warn",2768 print a warning of such a push to stderr, but allow the push to2769 proceed. If set to false or "ignore", allow such pushes with no2770 message. Defaults to "refuse".2771+2772Another option is "updateInstead" which will update the working2773tree if pushing into the current branch. This option is2774intended for synchronizing working directories when one side is not easily2775accessible via interactive ssh (e.g. a live web site, hence the requirement2776that the working directory be clean). This mode also comes in handy when2777developing inside a VM to test and fix code on different Operating Systems.2778+2779By default, "updateInstead" will refuse the push if the working tree or2780the index have any difference from the HEAD, but the `push-to-checkout`2781hook can be used to customize this. See linkgit:githooks[5].27822783receive.denyNonFastForwards::2784 If set to true, git-receive-pack will deny a ref update which is2785 not a fast-forward. Use this to prevent such an update via a push,2786 even if that push is forced. This configuration variable is2787 set when initializing a shared repository.27882789receive.hideRefs::2790 This variable is the same as `transfer.hideRefs`, but applies2791 only to `receive-pack` (and so affects pushes, but not fetches).2792 An attempt to update or delete a hidden ref by `git push` is2793 rejected.27942795receive.updateServerInfo::2796 If set to true, git-receive-pack will run git-update-server-info2797 after receiving data from git-push and updating refs.27982799receive.shallowUpdate::2800 If set to true, .git/shallow can be updated when new refs2801 require new shallow roots. Otherwise those refs are rejected.28022803remote.pushDefault::2804 The remote to push to by default. Overrides2805 `branch.<name>.remote` for all branches, and is overridden by2806 `branch.<name>.pushRemote` for specific branches.28072808remote.<name>.url::2809 The URL of a remote repository. See linkgit:git-fetch[1] or2810 linkgit:git-push[1].28112812remote.<name>.pushurl::2813 The push URL of a remote repository. See linkgit:git-push[1].28142815remote.<name>.proxy::2816 For remotes that require curl (http, https and ftp), the URL to2817 the proxy to use for that remote. Set to the empty string to2818 disable proxying for that remote.28192820remote.<name>.proxyAuthMethod::2821 For remotes that require curl (http, https and ftp), the method to use for2822 authenticating against the proxy in use (probably set in2823 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28242825remote.<name>.fetch::2826 The default set of "refspec" for linkgit:git-fetch[1]. See2827 linkgit:git-fetch[1].28282829remote.<name>.push::2830 The default set of "refspec" for linkgit:git-push[1]. See2831 linkgit:git-push[1].28322833remote.<name>.mirror::2834 If true, pushing to this remote will automatically behave2835 as if the `--mirror` option was given on the command line.28362837remote.<name>.skipDefaultUpdate::2838 If true, this remote will be skipped by default when updating2839 using linkgit:git-fetch[1] or the `update` subcommand of2840 linkgit:git-remote[1].28412842remote.<name>.skipFetchAll::2843 If true, this remote will be skipped by default when updating2844 using linkgit:git-fetch[1] or the `update` subcommand of2845 linkgit:git-remote[1].28462847remote.<name>.receivepack::2848 The default program to execute on the remote side when pushing. See2849 option --receive-pack of linkgit:git-push[1].28502851remote.<name>.uploadpack::2852 The default program to execute on the remote side when fetching. See2853 option --upload-pack of linkgit:git-fetch-pack[1].28542855remote.<name>.tagOpt::2856 Setting this value to --no-tags disables automatic tag following when2857 fetching from remote <name>. Setting it to --tags will fetch every2858 tag from remote <name>, even if they are not reachable from remote2859 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2860 override this setting. See options --tags and --no-tags of2861 linkgit:git-fetch[1].28622863remote.<name>.vcs::2864 Setting this to a value <vcs> will cause Git to interact with2865 the remote with the git-remote-<vcs> helper.28662867remote.<name>.prune::2868 When set to true, fetching from this remote by default will also2869 remove any remote-tracking references that no longer exist on the2870 remote (as if the `--prune` option was given on the command line).2871 Overrides `fetch.prune` settings, if any.28722873remotes.<group>::2874 The list of remotes which are fetched by "git remote update2875 <group>". See linkgit:git-remote[1].28762877repack.useDeltaBaseOffset::2878 By default, linkgit:git-repack[1] creates packs that use2879 delta-base offset. If you need to share your repository with2880 Git older than version 1.4.4, either directly or via a dumb2881 protocol such as http, then you need to set this option to2882 "false" and repack. Access from old Git versions over the2883 native protocol are unaffected by this option.28842885repack.packKeptObjects::2886 If set to true, makes `git repack` act as if2887 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2888 details. Defaults to `false` normally, but `true` if a bitmap2889 index is being written (either via `--write-bitmap-index` or2890 `repack.writeBitmaps`).28912892repack.writeBitmaps::2893 When true, git will write a bitmap index when packing all2894 objects to disk (e.g., when `git repack -a` is run). This2895 index can speed up the "counting objects" phase of subsequent2896 packs created for clones and fetches, at the cost of some disk2897 space and extra time spent on the initial repack. This has2898 no effect if multiple packfiles are created.2899 Defaults to false.29002901rerere.autoUpdate::2902 When set to true, `git-rerere` updates the index with the2903 resulting contents after it cleanly resolves conflicts using2904 previously recorded resolution. Defaults to false.29052906rerere.enabled::2907 Activate recording of resolved conflicts, so that identical2908 conflict hunks can be resolved automatically, should they be2909 encountered again. By default, linkgit:git-rerere[1] is2910 enabled if there is an `rr-cache` directory under the2911 `$GIT_DIR`, e.g. if "rerere" was previously used in the2912 repository.29132914sendemail.identity::2915 A configuration identity. When given, causes values in the2916 'sendemail.<identity>' subsection to take precedence over2917 values in the 'sendemail' section. The default identity is2918 the value of `sendemail.identity`.29192920sendemail.smtpEncryption::2921 See linkgit:git-send-email[1] for description. Note that this2922 setting is not subject to the 'identity' mechanism.29232924sendemail.smtpssl (deprecated)::2925 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29262927sendemail.smtpsslcertpath::2928 Path to ca-certificates (either a directory or a single file).2929 Set it to an empty string to disable certificate verification.29302931sendemail.<identity>.*::2932 Identity-specific versions of the 'sendemail.*' parameters2933 found below, taking precedence over those when this2934 identity is selected, through either the command-line or2935 `sendemail.identity`.29362937sendemail.aliasesFile::2938sendemail.aliasFileType::2939sendemail.annotate::2940sendemail.bcc::2941sendemail.cc::2942sendemail.ccCmd::2943sendemail.chainReplyTo::2944sendemail.confirm::2945sendemail.envelopeSender::2946sendemail.from::2947sendemail.multiEdit::2948sendemail.signedoffbycc::2949sendemail.smtpPass::2950sendemail.suppresscc::2951sendemail.suppressFrom::2952sendemail.to::2953sendemail.smtpDomain::2954sendemail.smtpServer::2955sendemail.smtpServerPort::2956sendemail.smtpServerOption::2957sendemail.smtpUser::2958sendemail.thread::2959sendemail.transferEncoding::2960sendemail.validate::2961sendemail.xmailer::2962 See linkgit:git-send-email[1] for description.29632964sendemail.signedoffcc (deprecated)::2965 Deprecated alias for `sendemail.signedoffbycc`.29662967sendemail.smtpBatchSize::2968 Number of messages to be sent per connection, after that a relogin2969 will happen. If the value is 0 or undefined, send all messages in2970 one connection.2971 See also the `--batch-size` option of linkgit:git-send-email[1].29722973sendemail.smtpReloginDelay::2974 Seconds wait before reconnecting to smtp server.2975 See also the `--relogin-delay` option of linkgit:git-send-email[1].29762977showbranch.default::2978 The default set of branches for linkgit:git-show-branch[1].2979 See linkgit:git-show-branch[1].29802981splitIndex.maxPercentChange::2982 When the split index feature is used, this specifies the2983 percent of entries the split index can contain compared to the2984 total number of entries in both the split index and the shared2985 index before a new shared index is written.2986 The value should be between 0 and 100. If the value is 0 then2987 a new shared index is always written, if it is 100 a new2988 shared index is never written.2989 By default the value is 20, so a new shared index is written2990 if the number of entries in the split index would be greater2991 than 20 percent of the total number of entries.2992 See linkgit:git-update-index[1].29932994splitIndex.sharedIndexExpire::2995 When the split index feature is used, shared index files that2996 were not modified since the time this variable specifies will2997 be removed when a new shared index file is created. The value2998 "now" expires all entries immediately, and "never" suppresses2999 expiration altogether.3000 The default value is "2.weeks.ago".3001 Note that a shared index file is considered modified (for the3002 purpose of expiration) each time a new split-index file is3003 either created based on it or read from it.3004 See linkgit:git-update-index[1].30053006status.relativePaths::3007 By default, linkgit:git-status[1] shows paths relative to the3008 current directory. Setting this variable to `false` shows paths3009 relative to the repository root (this was the default for Git3010 prior to v1.5.4).30113012status.short::3013 Set to true to enable --short by default in linkgit:git-status[1].3014 The option --no-short takes precedence over this variable.30153016status.branch::3017 Set to true to enable --branch by default in linkgit:git-status[1].3018 The option --no-branch takes precedence over this variable.30193020status.displayCommentPrefix::3021 If set to true, linkgit:git-status[1] will insert a comment3022 prefix before each output line (starting with3023 `core.commentChar`, i.e. `#` by default). This was the3024 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3025 Defaults to false.30263027status.showStash::3028 If set to true, linkgit:git-status[1] will display the number of3029 entries currently stashed away.3030 Defaults to false.30313032status.showUntrackedFiles::3033 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3034 files which are not currently tracked by Git. Directories which3035 contain only untracked files, are shown with the directory name3036 only. Showing untracked files means that Git needs to lstat() all3037 the files in the whole repository, which might be slow on some3038 systems. So, this variable controls how the commands displays3039 the untracked files. Possible values are:3040+3041--3042* `no` - Show no untracked files.3043* `normal` - Show untracked files and directories.3044* `all` - Show also individual files in untracked directories.3045--3046+3047If this variable is not specified, it defaults to 'normal'.3048This variable can be overridden with the -u|--untracked-files option3049of linkgit:git-status[1] and linkgit:git-commit[1].30503051status.submoduleSummary::3052 Defaults to false.3053 If this is set to a non zero number or true (identical to -1 or an3054 unlimited number), the submodule summary will be enabled and a3055 summary of commits for modified submodules will be shown (see3056 --summary-limit option of linkgit:git-submodule[1]). Please note3057 that the summary output command will be suppressed for all3058 submodules when `diff.ignoreSubmodules` is set to 'all' or only3059 for those submodules where `submodule.<name>.ignore=all`. The only3060 exception to that rule is that status and commit will show staged3061 submodule changes. To3062 also view the summary for ignored submodules you can either use3063 the --ignore-submodules=dirty command-line option or the 'git3064 submodule summary' command, which shows a similar output but does3065 not honor these settings.30663067stash.showPatch::3068 If this is set to true, the `git stash show` command without an3069 option will show the stash entry in patch form. Defaults to false.3070 See description of 'show' command in linkgit:git-stash[1].30713072stash.showStat::3073 If this is set to true, the `git stash show` command without an3074 option will show diffstat of the stash entry. Defaults to true.3075 See description of 'show' command in linkgit:git-stash[1].30763077submodule.<name>.url::3078 The URL for a submodule. This variable is copied from the .gitmodules3079 file to the git config via 'git submodule init'. The user can change3080 the configured URL before obtaining the submodule via 'git submodule3081 update'. If neither submodule.<name>.active or submodule.active are3082 set, the presence of this variable is used as a fallback to indicate3083 whether the submodule is of interest to git commands.3084 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.30853086submodule.<name>.update::3087 The method by which a submodule is updated by 'git submodule update',3088 which is the only affected command, others such as3089 'git checkout --recurse-submodules' are unaffected. It exists for3090 historical reasons, when 'git submodule' was the only command to3091 interact with submodules; settings like `submodule.active`3092 and `pull.rebase` are more specific. It is populated by3093 `git submodule init` from the linkgit:gitmodules[5] file.3094 See description of 'update' command in linkgit:git-submodule[1].30953096submodule.<name>.branch::3097 The remote branch name for a submodule, used by `git submodule3098 update --remote`. Set this option to override the value found in3099 the `.gitmodules` file. See linkgit:git-submodule[1] and3100 linkgit:gitmodules[5] for details.31013102submodule.<name>.fetchRecurseSubmodules::3103 This option can be used to control recursive fetching of this3104 submodule. It can be overridden by using the --[no-]recurse-submodules3105 command-line option to "git fetch" and "git pull".3106 This setting will override that from in the linkgit:gitmodules[5]3107 file.31083109submodule.<name>.ignore::3110 Defines under what circumstances "git status" and the diff family show3111 a submodule as modified. When set to "all", it will never be considered3112 modified (but it will nonetheless show up in the output of status and3113 commit when it has been staged), "dirty" will ignore all changes3114 to the submodules work tree and3115 takes only differences between the HEAD of the submodule and the commit3116 recorded in the superproject into account. "untracked" will additionally3117 let submodules with modified tracked files in their work tree show up.3118 Using "none" (the default when this option is not set) also shows3119 submodules that have untracked files in their work tree as changed.3120 This setting overrides any setting made in .gitmodules for this submodule,3121 both settings can be overridden on the command line by using the3122 "--ignore-submodules" option. The 'git submodule' commands are not3123 affected by this setting.31243125submodule.<name>.active::3126 Boolean value indicating if the submodule is of interest to git3127 commands. This config option takes precedence over the3128 submodule.active config option.31293130submodule.active::3131 A repeated field which contains a pathspec used to match against a3132 submodule's path to determine if the submodule is of interest to git3133 commands.31343135submodule.recurse::3136 Specifies if commands recurse into submodules by default. This3137 applies to all commands that have a `--recurse-submodules` option.3138 Defaults to false.31393140submodule.fetchJobs::3141 Specifies how many submodules are fetched/cloned at the same time.3142 A positive integer allows up to that number of submodules fetched3143 in parallel. A value of 0 will give some reasonable default.3144 If unset, it defaults to 1.31453146submodule.alternateLocation::3147 Specifies how the submodules obtain alternates when submodules are3148 cloned. Possible values are `no`, `superproject`.3149 By default `no` is assumed, which doesn't add references. When the3150 value is set to `superproject` the submodule to be cloned computes3151 its alternates location relative to the superprojects alternate.31523153submodule.alternateErrorStrategy::3154 Specifies how to treat errors with the alternates for a submodule3155 as computed via `submodule.alternateLocation`. Possible values are3156 `ignore`, `info`, `die`. Default is `die`.31573158tag.forceSignAnnotated::3159 A boolean to specify whether annotated tags created should be GPG signed.3160 If `--annotate` is specified on the command line, it takes3161 precedence over this option.31623163tag.sort::3164 This variable controls the sort ordering of tags when displayed by3165 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3166 value of this variable will be used as the default.31673168tar.umask::3169 This variable can be used to restrict the permission bits of3170 tar archive entries. The default is 0002, which turns off the3171 world write bit. The special value "user" indicates that the3172 archiving user's umask will be used instead. See umask(2) and3173 linkgit:git-archive[1].31743175transfer.fsckObjects::3176 When `fetch.fsckObjects` or `receive.fsckObjects` are3177 not set, the value of this variable is used instead.3178 Defaults to false.31793180transfer.hideRefs::3181 String(s) `receive-pack` and `upload-pack` use to decide which3182 refs to omit from their initial advertisements. Use more than3183 one definition to specify multiple prefix strings. A ref that is3184 under the hierarchies listed in the value of this variable is3185 excluded, and is hidden when responding to `git push` or `git3186 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3187 program-specific versions of this config.3188+3189You may also include a `!` in front of the ref name to negate the entry,3190explicitly exposing it, even if an earlier entry marked it as hidden.3191If you have multiple hideRefs values, later entries override earlier ones3192(and entries in more-specific config files override less-specific ones).3193+3194If a namespace is in use, the namespace prefix is stripped from each3195reference before it is matched against `transfer.hiderefs` patterns.3196For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3197the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3198is omitted from the advertisements but `refs/heads/master` and3199`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3200"have" lines. In order to match refs before stripping, add a `^` in front of3201the ref name. If you combine `!` and `^`, `!` must be specified first.3202+3203Even if you hide refs, a client may still be able to steal the target3204objects via the techniques described in the "SECURITY" section of the3205linkgit:gitnamespaces[7] man page; it's best to keep private data in a3206separate repository.32073208transfer.unpackLimit::3209 When `fetch.unpackLimit` or `receive.unpackLimit` are3210 not set, the value of this variable is used instead.3211 The default value is 100.32123213uploadarchive.allowUnreachable::3214 If true, allow clients to use `git archive --remote` to request3215 any tree, whether reachable from the ref tips or not. See the3216 discussion in the "SECURITY" section of3217 linkgit:git-upload-archive[1] for more details. Defaults to3218 `false`.32193220uploadpack.hideRefs::3221 This variable is the same as `transfer.hideRefs`, but applies3222 only to `upload-pack` (and so affects only fetches, not pushes).3223 An attempt to fetch a hidden ref by `git fetch` will fail. See3224 also `uploadpack.allowTipSHA1InWant`.32253226uploadpack.allowTipSHA1InWant::3227 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3228 to accept a fetch request that asks for an object at the tip3229 of a hidden ref (by default, such a request is rejected).3230 See also `uploadpack.hideRefs`. Even if this is false, a client3231 may be able to steal objects via the techniques described in the3232 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3233 best to keep private data in a separate repository.32343235uploadpack.allowReachableSHA1InWant::3236 Allow `upload-pack` to accept a fetch request that asks for an3237 object that is reachable from any ref tip. However, note that3238 calculating object reachability is computationally expensive.3239 Defaults to `false`. Even if this is false, a client may be able3240 to steal objects via the techniques described in the "SECURITY"3241 section of the linkgit:gitnamespaces[7] man page; it's best to3242 keep private data in a separate repository.32433244uploadpack.allowAnySHA1InWant::3245 Allow `upload-pack` to accept a fetch request that asks for any3246 object at all.3247 Defaults to `false`.32483249uploadpack.keepAlive::3250 When `upload-pack` has started `pack-objects`, there may be a3251 quiet period while `pack-objects` prepares the pack. Normally3252 it would output progress information, but if `--quiet` was used3253 for the fetch, `pack-objects` will output nothing at all until3254 the pack data begins. Some clients and networks may consider3255 the server to be hung and give up. Setting this option instructs3256 `upload-pack` to send an empty keepalive packet every3257 `uploadpack.keepAlive` seconds. Setting this option to 03258 disables keepalive packets entirely. The default is 5 seconds.32593260uploadpack.packObjectsHook::3261 If this option is set, when `upload-pack` would run3262 `git pack-objects` to create a packfile for a client, it will3263 run this shell command instead. The `pack-objects` command and3264 arguments it _would_ have run (including the `git pack-objects`3265 at the beginning) are appended to the shell command. The stdin3266 and stdout of the hook are treated as if `pack-objects` itself3267 was run. I.e., `upload-pack` will feed input intended for3268 `pack-objects` to the hook, and expects a completed packfile on3269 stdout.3270+3271Note that this configuration variable is ignored if it is seen in the3272repository-level config (this is a safety measure against fetching from3273untrusted repositories).32743275url.<base>.insteadOf::3276 Any URL that starts with this value will be rewritten to3277 start, instead, with <base>. In cases where some site serves a3278 large number of repositories, and serves them with multiple3279 access methods, and some users need to use different access3280 methods, this feature allows people to specify any of the3281 equivalent URLs and have Git automatically rewrite the URL to3282 the best alternative for the particular user, even for a3283 never-before-seen repository on the site. When more than one3284 insteadOf strings match a given URL, the longest match is used.3285+3286Note that any protocol restrictions will be applied to the rewritten3287URL. If the rewrite changes the URL to use a custom protocol or remote3288helper, you may need to adjust the `protocol.*.allow` config to permit3289the request. In particular, protocols you expect to use for submodules3290must be set to `always` rather than the default of `user`. See the3291description of `protocol.allow` above.32923293url.<base>.pushInsteadOf::3294 Any URL that starts with this value will not be pushed to;3295 instead, it will be rewritten to start with <base>, and the3296 resulting URL will be pushed to. In cases where some site serves3297 a large number of repositories, and serves them with multiple3298 access methods, some of which do not allow push, this feature3299 allows people to specify a pull-only URL and have Git3300 automatically use an appropriate URL to push, even for a3301 never-before-seen repository on the site. When more than one3302 pushInsteadOf strings match a given URL, the longest match is3303 used. If a remote has an explicit pushurl, Git will ignore this3304 setting for that remote.33053306user.email::3307 Your email address to be recorded in any newly created commits.3308 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3309 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33103311user.name::3312 Your full name to be recorded in any newly created commits.3313 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3314 environment variables. See linkgit:git-commit-tree[1].33153316user.useConfigOnly::3317 Instruct Git to avoid trying to guess defaults for `user.email`3318 and `user.name`, and instead retrieve the values only from the3319 configuration. For example, if you have multiple email addresses3320 and would like to use a different one for each repository, then3321 with this configuration option set to `true` in the global config3322 along with a name, Git will prompt you to set up an email before3323 making new commits in a newly cloned repository.3324 Defaults to `false`.33253326user.signingKey::3327 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3328 key you want it to automatically when creating a signed tag or3329 commit, you can override the default selection with this variable.3330 This option is passed unchanged to gpg's --local-user parameter,3331 so you may specify a key using any method that gpg supports.33323333versionsort.prereleaseSuffix (deprecated)::3334 Deprecated alias for `versionsort.suffix`. Ignored if3335 `versionsort.suffix` is set.33363337versionsort.suffix::3338 Even when version sort is used in linkgit:git-tag[1], tagnames3339 with the same base version but different suffixes are still sorted3340 lexicographically, resulting e.g. in prerelease tags appearing3341 after the main release (e.g. "1.0-rc1" after "1.0"). This3342 variable can be specified to determine the sorting order of tags3343 with different suffixes.3344+3345By specifying a single suffix in this variable, any tagname containing3346that suffix will appear before the corresponding main release. E.g. if3347the variable is set to "-rc", then all "1.0-rcX" tags will appear before3348"1.0". If specified multiple times, once per suffix, then the order of3349suffixes in the configuration will determine the sorting order of tagnames3350with those suffixes. E.g. if "-pre" appears before "-rc" in the3351configuration, then all "1.0-preX" tags will be listed before any3352"1.0-rcX" tags. The placement of the main release tag relative to tags3353with various suffixes can be determined by specifying the empty suffix3354among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3355"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3356are listed first, followed by "v4.8", then "v4.8-ckX" and finally3357"v4.8-bfsX".3358+3359If more than one suffixes match the same tagname, then that tagname will3360be sorted according to the suffix which starts at the earliest position in3361the tagname. If more than one different matching suffixes start at3362that earliest position, then that tagname will be sorted according to the3363longest of those suffixes.3364The sorting order between different suffixes is undefined if they are3365in multiple config files.33663367web.browser::3368 Specify a web browser that may be used by some commands.3369 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3370 may use it.