1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82The `include` and `includeIf` sections allow you to include config 83directives from another source. These sections behave identically to 84each other with the exception that `includeIf` sections may be ignored 85if their condition does not evaluate to true; see "Conditional includes" 86below. 87 88You can include a config file from another by setting the special 89`include.path` (or `includeIf.*.path`) variable to the name of the file 90to be included. The variable takes a pathname as its value, and is 91subject to tilde expansion. These variables can be given multiple times. 92 93The contents of the included file are inserted immediately, as if they 94had been found at the location of the include directive. If the value of the 95variable is a relative path, the path is considered to 96be relative to the configuration file in which the include directive 97was found. See below for examples. 98 99Conditional includes 100~~~~~~~~~~~~~~~~~~~~ 101 102You can include a config file from another conditionally by setting a 103`includeIf.<condition>.path` variable to the name of the file to be 104included. 105 106The condition starts with a keyword followed by a colon and some data 107whose format and meaning depends on the keyword. Supported keywords 108are: 109 110`gitdir`:: 111 112 The data that follows the keyword `gitdir:` is used as a glob 113 pattern. If the location of the .git directory matches the 114 pattern, the include condition is met. 115+ 116The .git location may be auto-discovered, or come from `$GIT_DIR` 117environment variable. If the repository is auto discovered via a .git 118file (e.g. from submodules, or a linked worktree), the .git location 119would be the final location where the .git directory is, not where the 120.git file is. 121+ 122The pattern can contain standard globbing wildcards and two additional 123ones, `**/` and `/**`, that can match multiple path components. Please 124refer to linkgit:gitignore[5] for details. For convenience: 125 126 * If the pattern starts with `~/`, `~` will be substituted with the 127 content of the environment variable `HOME`. 128 129 * If the pattern starts with `./`, it is replaced with the directory 130 containing the current config file. 131 132 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 133 will be automatically prepended. For example, the pattern `foo/bar` 134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 135 136 * If the pattern ends with `/`, `**` will be automatically added. For 137 example, the pattern `foo/` becomes `foo/**`. In other words, it 138 matches "foo" and everything inside, recursively. 139 140`gitdir/i`:: 141 This is the same as `gitdir` except that matching is done 142 case-insensitively (e.g. on case-insensitive file sytems) 143 144A few more notes on matching via `gitdir` and `gitdir/i`: 145 146 * Symlinks in `$GIT_DIR` are not resolved before matching. 147 148 * Both the symlink & realpath versions of paths will be matched 149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 151 will match. 152+ 153This was not the case in the initial release of this feature in 154v2.13.0, which only matched the realpath version. Configuration that 155wants to be compatible with the initial release of this feature needs 156to either specify only the realpath version, or both versions. 157 158 * Note that "../" is not special and will match literally, which is 159 unlikely what you want. 160 161Example 162~~~~~~~ 163 164 # Core variables 165 [core] 166 ; Don't trust file modes 167 filemode = false 168 169 # Our diff algorithm 170 [diff] 171 external = /usr/local/bin/diff-wrapper 172 renames = true 173 174 [branch "devel"] 175 remote = origin 176 merge = refs/heads/devel 177 178 # Proxy settings 179 [core] 180 gitProxy="ssh" for "kernel.org" 181 gitProxy=default-proxy ; for the rest 182 183 [include] 184 path = /path/to/foo.inc ; include by absolute path 185 path = foo.inc ; find "foo.inc" relative to the current file 186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 187 188 ; include if $GIT_DIR is /path/to/foo/.git 189 [includeIf "gitdir:/path/to/foo/.git"] 190 path = /path/to/foo.inc 191 192 ; include for all repositories inside /path/to/group 193 [includeIf "gitdir:/path/to/group/"] 194 path = /path/to/foo.inc 195 196 ; include for all repositories inside $HOME/to/group 197 [includeIf "gitdir:~/to/group/"] 198 path = /path/to/foo.inc 199 200 ; relative paths are always relative to the including 201 ; file (if the condition is true); their location is not 202 ; affected by the condition 203 [includeIf "gitdir:/path/to/group/"] 204 path = foo.inc 205 206Values 207~~~~~~ 208 209Values of many variables are treated as a simple string, but there 210are variables that take values of specific types and there are rules 211as to how to spell them. 212 213boolean:: 214 215 When a variable is said to take a boolean value, many 216 synonyms are accepted for 'true' and 'false'; these are all 217 case-insensitive. 218 219 true;; Boolean true literals are `yes`, `on`, `true`, 220 and `1`. Also, a variable defined without `= <value>` 221 is taken as true. 222 223 false;; Boolean false literals are `no`, `off`, `false`, 224 `0` and the empty string. 225+ 226When converting value to the canonical form using `--bool` type 227specifier, 'git config' will ensure that the output is "true" or 228"false" (spelled in lowercase). 229 230integer:: 231 The value for many variables that specify various sizes can 232 be suffixed with `k`, `M`,... to mean "scale the number by 233 1024", "by 1024x1024", etc. 234 235color:: 236 The value for a variable that takes a color is a list of 237 colors (at most two, one for foreground and one for background) 238 and attributes (as many as you want), separated by spaces. 239+ 240The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 241`blue`, `magenta`, `cyan` and `white`. The first color given is the 242foreground; the second is the background. 243+ 244Colors may also be given as numbers between 0 and 255; these use ANSI 245256-color mode (but note that not all terminals may support this). If 246your terminal supports it, you may also specify 24-bit RGB values as 247hex, like `#ff0ab3`. 248+ 249The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 250`italic`, and `strike` (for crossed-out or "strikethrough" letters). 251The position of any attributes with respect to the colors 252(before, after, or in between), doesn't matter. Specific attributes may 253be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 254`no-ul`, etc). 255+ 256An empty color string produces no color effect at all. This can be used 257to avoid coloring specific elements without disabling color entirely. 258+ 259For git's pre-defined color slots, the attributes are meant to be reset 260at the beginning of each item in the colored output. So setting 261`color.decorate.branch` to `black` will paint that branch name in a 262plain `black`, even if the previous thing on the same output line (e.g. 263opening parenthesis before the list of branch names in `log --decorate` 264output) is set to be painted with `bold` or some other attribute. 265However, custom log formats may do more complicated and layered 266coloring, and the negated forms may be useful there. 267 268pathname:: 269 A variable that takes a pathname value can be given a 270 string that begins with "`~/`" or "`~user/`", and the usual 271 tilde expansion happens to such a string: `~/` 272 is expanded to the value of `$HOME`, and `~user/` to the 273 specified user's home directory. 274 275 276Variables 277~~~~~~~~~ 278 279Note that this list is non-comprehensive and not necessarily complete. 280For command-specific variables, you will find a more detailed description 281in the appropriate manual page. 282 283Other git-related tools may and do use their own variables. When 284inventing new variables for use in your own tool, make sure their 285names do not conflict with those that are used by Git itself and 286other popular tools, and describe them in your documentation. 287 288 289advice.*:: 290 These variables control various optional help messages designed to 291 aid new users. All 'advice.*' variables default to 'true', and you 292 can tell Git that you do not need help by setting these to 'false': 293+ 294-- 295 pushUpdateRejected:: 296 Set this variable to 'false' if you want to disable 297 'pushNonFFCurrent', 298 'pushNonFFMatching', 'pushAlreadyExists', 299 'pushFetchFirst', and 'pushNeedsForce' 300 simultaneously. 301 pushNonFFCurrent:: 302 Advice shown when linkgit:git-push[1] fails due to a 303 non-fast-forward update to the current branch. 304 pushNonFFMatching:: 305 Advice shown when you ran linkgit:git-push[1] and pushed 306 'matching refs' explicitly (i.e. you used ':', or 307 specified a refspec that isn't your current branch) and 308 it resulted in a non-fast-forward error. 309 pushAlreadyExists:: 310 Shown when linkgit:git-push[1] rejects an update that 311 does not qualify for fast-forwarding (e.g., a tag.) 312 pushFetchFirst:: 313 Shown when linkgit:git-push[1] rejects an update that 314 tries to overwrite a remote ref that points at an 315 object we do not have. 316 pushNeedsForce:: 317 Shown when linkgit:git-push[1] rejects an update that 318 tries to overwrite a remote ref that points at an 319 object that is not a commit-ish, or make the remote 320 ref point at an object that is not a commit-ish. 321 statusHints:: 322 Show directions on how to proceed from the current 323 state in the output of linkgit:git-status[1], in 324 the template shown when writing commit messages in 325 linkgit:git-commit[1], and in the help message shown 326 by linkgit:git-checkout[1] when switching branch. 327 statusUoption:: 328 Advise to consider using the `-u` option to linkgit:git-status[1] 329 when the command takes more than 2 seconds to enumerate untracked 330 files. 331 commitBeforeMerge:: 332 Advice shown when linkgit:git-merge[1] refuses to 333 merge to avoid overwriting local changes. 334 resolveConflict:: 335 Advice shown by various commands when conflicts 336 prevent the operation from being performed. 337 implicitIdentity:: 338 Advice on how to set your identity configuration when 339 your information is guessed from the system username and 340 domain name. 341 detachedHead:: 342 Advice shown when you used linkgit:git-checkout[1] to 343 move to the detach HEAD state, to instruct how to create 344 a local branch after the fact. 345 amWorkDir:: 346 Advice that shows the location of the patch file when 347 linkgit:git-am[1] fails to apply it. 348 rmHints:: 349 In case of failure in the output of linkgit:git-rm[1], 350 show directions on how to proceed from the current state. 351 addEmbeddedRepo:: 352 Advice on what to do when you've accidentally added one 353 git repo inside of another. 354 ignoredHook:: 355 Advice shown if an hook is ignored because the hook is not 356 set as executable. 357 waitingForEditor:: 358 Print a message to the terminal whenever Git is waiting for 359 editor input from the user. 360-- 361 362core.fileMode:: 363 Tells Git if the executable bit of files in the working tree 364 is to be honored. 365+ 366Some filesystems lose the executable bit when a file that is 367marked as executable is checked out, or checks out a 368non-executable file with executable bit on. 369linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 370to see if it handles the executable bit correctly 371and this variable is automatically set as necessary. 372+ 373A repository, however, may be on a filesystem that handles 374the filemode correctly, and this variable is set to 'true' 375when created, but later may be made accessible from another 376environment that loses the filemode (e.g. exporting ext4 via 377CIFS mount, visiting a Cygwin created repository with 378Git for Windows or Eclipse). 379In such a case it may be necessary to set this variable to 'false'. 380See linkgit:git-update-index[1]. 381+ 382The default is true (when core.filemode is not specified in the config file). 383 384core.hideDotFiles:: 385 (Windows-only) If true, mark newly-created directories and files whose 386 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 387 directory is hidden, but no other files starting with a dot. The 388 default mode is 'dotGitOnly'. 389 390core.ignoreCase:: 391 If true, this option enables various workarounds to enable 392 Git to work better on filesystems that are not case sensitive, 393 like FAT. For example, if a directory listing finds 394 "makefile" when Git expects "Makefile", Git will assume 395 it is really the same file, and continue to remember it as 396 "Makefile". 397+ 398The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 399will probe and set core.ignoreCase true if appropriate when the repository 400is created. 401 402core.precomposeUnicode:: 403 This option is only used by Mac OS implementation of Git. 404 When core.precomposeUnicode=true, Git reverts the unicode decomposition 405 of filenames done by Mac OS. This is useful when sharing a repository 406 between Mac OS and Linux or Windows. 407 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 408 When false, file names are handled fully transparent by Git, 409 which is backward compatible with older versions of Git. 410 411core.protectHFS:: 412 If set to true, do not allow checkout of paths that would 413 be considered equivalent to `.git` on an HFS+ filesystem. 414 Defaults to `true` on Mac OS, and `false` elsewhere. 415 416core.protectNTFS:: 417 If set to true, do not allow checkout of paths that would 418 cause problems with the NTFS filesystem, e.g. conflict with 419 8.3 "short" names. 420 Defaults to `true` on Windows, and `false` elsewhere. 421 422core.fsmonitor:: 423 If set, the value of this variable is used as a command which 424 will identify all files that may have changed since the 425 requested date/time. This information is used to speed up git by 426 avoiding unnecessary processing of files that have not changed. 427 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 428 429core.trustctime:: 430 If false, the ctime differences between the index and the 431 working tree are ignored; useful when the inode change time 432 is regularly modified by something outside Git (file system 433 crawlers and some backup systems). 434 See linkgit:git-update-index[1]. True by default. 435 436core.splitIndex:: 437 If true, the split-index feature of the index will be used. 438 See linkgit:git-update-index[1]. False by default. 439 440core.untrackedCache:: 441 Determines what to do about the untracked cache feature of the 442 index. It will be kept, if this variable is unset or set to 443 `keep`. It will automatically be added if set to `true`. And 444 it will automatically be removed, if set to `false`. Before 445 setting it to `true`, you should check that mtime is working 446 properly on your system. 447 See linkgit:git-update-index[1]. `keep` by default. 448 449core.checkStat:: 450 Determines which stat fields to match between the index 451 and work tree. The user can set this to 'default' or 452 'minimal'. Default (or explicitly 'default'), is to check 453 all fields, including the sub-second part of mtime and ctime. 454 455core.quotePath:: 456 Commands that output paths (e.g. 'ls-files', 'diff'), will 457 quote "unusual" characters in the pathname by enclosing the 458 pathname in double-quotes and escaping those characters with 459 backslashes in the same way C escapes control characters (e.g. 460 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 461 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 462 UTF-8). If this variable is set to false, bytes higher than 463 0x80 are not considered "unusual" any more. Double-quotes, 464 backslash and control characters are always escaped regardless 465 of the setting of this variable. A simple space character is 466 not considered "unusual". Many commands can output pathnames 467 completely verbatim using the `-z` option. The default value 468 is true. 469 470core.eol:: 471 Sets the line ending type to use in the working directory for 472 files that have the `text` property set when core.autocrlf is false. 473 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 474 native line ending. The default value is `native`. See 475 linkgit:gitattributes[5] for more information on end-of-line 476 conversion. 477 478core.safecrlf:: 479 If true, makes Git check if converting `CRLF` is reversible when 480 end-of-line conversion is active. Git will verify if a command 481 modifies a file in the work tree either directly or indirectly. 482 For example, committing a file followed by checking out the 483 same file should yield the original file in the work tree. If 484 this is not the case for the current setting of 485 `core.autocrlf`, Git will reject the file. The variable can 486 be set to "warn", in which case Git will only warn about an 487 irreversible conversion but continue the operation. 488+ 489CRLF conversion bears a slight chance of corrupting data. 490When it is enabled, Git will convert CRLF to LF during commit and LF to 491CRLF during checkout. A file that contains a mixture of LF and 492CRLF before the commit cannot be recreated by Git. For text 493files this is the right thing to do: it corrects line endings 494such that we have only LF line endings in the repository. 495But for binary files that are accidentally classified as text the 496conversion can corrupt data. 497+ 498If you recognize such corruption early you can easily fix it by 499setting the conversion type explicitly in .gitattributes. Right 500after committing you still have the original file in your work 501tree and this file is not yet corrupted. You can explicitly tell 502Git that this file is binary and Git will handle the file 503appropriately. 504+ 505Unfortunately, the desired effect of cleaning up text files with 506mixed line endings and the undesired effect of corrupting binary 507files cannot be distinguished. In both cases CRLFs are removed 508in an irreversible way. For text files this is the right thing 509to do because CRLFs are line endings, while for binary files 510converting CRLFs corrupts data. 511+ 512Note, this safety check does not mean that a checkout will generate a 513file identical to the original file for a different setting of 514`core.eol` and `core.autocrlf`, but only for the current one. For 515example, a text file with `LF` would be accepted with `core.eol=lf` 516and could later be checked out with `core.eol=crlf`, in which case the 517resulting file would contain `CRLF`, although the original file 518contained `LF`. However, in both work trees the line endings would be 519consistent, that is either all `LF` or all `CRLF`, but never mixed. A 520file with mixed line endings would be reported by the `core.safecrlf` 521mechanism. 522 523core.autocrlf:: 524 Setting this variable to "true" is the same as setting 525 the `text` attribute to "auto" on all files and core.eol to "crlf". 526 Set to true if you want to have `CRLF` line endings in your 527 working directory and the repository has LF line endings. 528 This variable can be set to 'input', 529 in which case no output conversion is performed. 530 531core.symlinks:: 532 If false, symbolic links are checked out as small plain files that 533 contain the link text. linkgit:git-update-index[1] and 534 linkgit:git-add[1] will not change the recorded type to regular 535 file. Useful on filesystems like FAT that do not support 536 symbolic links. 537+ 538The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 539will probe and set core.symlinks false if appropriate when the repository 540is created. 541 542core.gitProxy:: 543 A "proxy command" to execute (as 'command host port') instead 544 of establishing direct connection to the remote server when 545 using the Git protocol for fetching. If the variable value is 546 in the "COMMAND for DOMAIN" format, the command is applied only 547 on hostnames ending with the specified domain string. This variable 548 may be set multiple times and is matched in the given order; 549 the first match wins. 550+ 551Can be overridden by the `GIT_PROXY_COMMAND` environment variable 552(which always applies universally, without the special "for" 553handling). 554+ 555The special string `none` can be used as the proxy command to 556specify that no proxy be used for a given domain pattern. 557This is useful for excluding servers inside a firewall from 558proxy use, while defaulting to a common proxy for external domains. 559 560core.sshCommand:: 561 If this variable is set, `git fetch` and `git push` will 562 use the specified command instead of `ssh` when they need to 563 connect to a remote system. The command is in the same form as 564 the `GIT_SSH_COMMAND` environment variable and is overridden 565 when the environment variable is set. 566 567core.ignoreStat:: 568 If true, Git will avoid using lstat() calls to detect if files have 569 changed by setting the "assume-unchanged" bit for those tracked files 570 which it has updated identically in both the index and working tree. 571+ 572When files are modified outside of Git, the user will need to stage 573the modified files explicitly (e.g. see 'Examples' section in 574linkgit:git-update-index[1]). 575Git will not normally detect changes to those files. 576+ 577This is useful on systems where lstat() calls are very slow, such as 578CIFS/Microsoft Windows. 579+ 580False by default. 581 582core.preferSymlinkRefs:: 583 Instead of the default "symref" format for HEAD 584 and other symbolic reference files, use symbolic links. 585 This is sometimes needed to work with old scripts that 586 expect HEAD to be a symbolic link. 587 588core.bare:: 589 If true this repository is assumed to be 'bare' and has no 590 working directory associated with it. If this is the case a 591 number of commands that require a working directory will be 592 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 593+ 594This setting is automatically guessed by linkgit:git-clone[1] or 595linkgit:git-init[1] when the repository was created. By default a 596repository that ends in "/.git" is assumed to be not bare (bare = 597false), while all other repositories are assumed to be bare (bare 598= true). 599 600core.worktree:: 601 Set the path to the root of the working tree. 602 If `GIT_COMMON_DIR` environment variable is set, core.worktree 603 is ignored and not used for determining the root of working tree. 604 This can be overridden by the `GIT_WORK_TREE` environment 605 variable and the `--work-tree` command-line option. 606 The value can be an absolute path or relative to the path to 607 the .git directory, which is either specified by --git-dir 608 or GIT_DIR, or automatically discovered. 609 If --git-dir or GIT_DIR is specified but none of 610 --work-tree, GIT_WORK_TREE and core.worktree is specified, 611 the current working directory is regarded as the top level 612 of your working tree. 613+ 614Note that this variable is honored even when set in a configuration 615file in a ".git" subdirectory of a directory and its value differs 616from the latter directory (e.g. "/path/to/.git/config" has 617core.worktree set to "/different/path"), which is most likely a 618misconfiguration. Running Git commands in the "/path/to" directory will 619still use "/different/path" as the root of the work tree and can cause 620confusion unless you know what you are doing (e.g. you are creating a 621read-only snapshot of the same index to a location different from the 622repository's usual working tree). 623 624core.logAllRefUpdates:: 625 Enable the reflog. Updates to a ref <ref> is logged to the file 626 "`$GIT_DIR/logs/<ref>`", by appending the new and old 627 SHA-1, the date/time and the reason of the update, but 628 only when the file exists. If this configuration 629 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 630 file is automatically created for branch heads (i.e. under 631 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 632 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 633 If it is set to `always`, then a missing reflog is automatically 634 created for any ref under `refs/`. 635+ 636This information can be used to determine what commit 637was the tip of a branch "2 days ago". 638+ 639This value is true by default in a repository that has 640a working directory associated with it, and false by 641default in a bare repository. 642 643core.repositoryFormatVersion:: 644 Internal variable identifying the repository format and layout 645 version. 646 647core.sharedRepository:: 648 When 'group' (or 'true'), the repository is made shareable between 649 several users in a group (making sure all the files and objects are 650 group-writable). When 'all' (or 'world' or 'everybody'), the 651 repository will be readable by all users, additionally to being 652 group-shareable. When 'umask' (or 'false'), Git will use permissions 653 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 654 files in the repository will have this mode value. '0xxx' will override 655 user's umask value (whereas the other options will only override 656 requested parts of the user's umask value). Examples: '0660' will make 657 the repo read/write-able for the owner and group, but inaccessible to 658 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 659 repository that is group-readable but not group-writable. 660 See linkgit:git-init[1]. False by default. 661 662core.warnAmbiguousRefs:: 663 If true, Git will warn you if the ref name you passed it is ambiguous 664 and might match multiple refs in the repository. True by default. 665 666core.compression:: 667 An integer -1..9, indicating a default compression level. 668 -1 is the zlib default. 0 means no compression, 669 and 1..9 are various speed/size tradeoffs, 9 being slowest. 670 If set, this provides a default to other compression variables, 671 such as `core.looseCompression` and `pack.compression`. 672 673core.looseCompression:: 674 An integer -1..9, indicating the compression level for objects that 675 are not in a pack file. -1 is the zlib default. 0 means no 676 compression, and 1..9 are various speed/size tradeoffs, 9 being 677 slowest. If not set, defaults to core.compression. If that is 678 not set, defaults to 1 (best speed). 679 680core.packedGitWindowSize:: 681 Number of bytes of a pack file to map into memory in a 682 single mapping operation. Larger window sizes may allow 683 your system to process a smaller number of large pack files 684 more quickly. Smaller window sizes will negatively affect 685 performance due to increased calls to the operating system's 686 memory manager, but may improve performance when accessing 687 a large number of large pack files. 688+ 689Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 690MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 691be reasonable for all users/operating systems. You probably do 692not need to adjust this value. 693+ 694Common unit suffixes of 'k', 'm', or 'g' are supported. 695 696core.packedGitLimit:: 697 Maximum number of bytes to map simultaneously into memory 698 from pack files. If Git needs to access more than this many 699 bytes at once to complete an operation it will unmap existing 700 regions to reclaim virtual address space within the process. 701+ 702Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 703unlimited) on 64 bit platforms. 704This should be reasonable for all users/operating systems, except on 705the largest projects. You probably do not need to adjust this value. 706+ 707Common unit suffixes of 'k', 'm', or 'g' are supported. 708 709core.deltaBaseCacheLimit:: 710 Maximum number of bytes to reserve for caching base objects 711 that may be referenced by multiple deltified objects. By storing the 712 entire decompressed base objects in a cache Git is able 713 to avoid unpacking and decompressing frequently used base 714 objects multiple times. 715+ 716Default is 96 MiB on all platforms. This should be reasonable 717for all users/operating systems, except on the largest projects. 718You probably do not need to adjust this value. 719+ 720Common unit suffixes of 'k', 'm', or 'g' are supported. 721 722core.bigFileThreshold:: 723 Files larger than this size are stored deflated, without 724 attempting delta compression. Storing large files without 725 delta compression avoids excessive memory usage, at the 726 slight expense of increased disk usage. Additionally files 727 larger than this size are always treated as binary. 728+ 729Default is 512 MiB on all platforms. This should be reasonable 730for most projects as source code and other text files can still 731be delta compressed, but larger binary media files won't be. 732+ 733Common unit suffixes of 'k', 'm', or 'g' are supported. 734 735core.excludesFile:: 736 Specifies the pathname to the file that contains patterns to 737 describe paths that are not meant to be tracked, in addition 738 to '.gitignore' (per-directory) and '.git/info/exclude'. 739 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 740 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 741 is used instead. See linkgit:gitignore[5]. 742 743core.askPass:: 744 Some commands (e.g. svn and http interfaces) that interactively 745 ask for a password can be told to use an external program given 746 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 747 environment variable. If not set, fall back to the value of the 748 `SSH_ASKPASS` environment variable or, failing that, a simple password 749 prompt. The external program shall be given a suitable prompt as 750 command-line argument and write the password on its STDOUT. 751 752core.attributesFile:: 753 In addition to '.gitattributes' (per-directory) and 754 '.git/info/attributes', Git looks into this file for attributes 755 (see linkgit:gitattributes[5]). Path expansions are made the same 756 way as for `core.excludesFile`. Its default value is 757 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 758 set or empty, `$HOME/.config/git/attributes` is used instead. 759 760core.hooksPath:: 761 By default Git will look for your hooks in the 762 '$GIT_DIR/hooks' directory. Set this to different path, 763 e.g. '/etc/git/hooks', and Git will try to find your hooks in 764 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 765 in '$GIT_DIR/hooks/pre-receive'. 766+ 767The path can be either absolute or relative. A relative path is 768taken as relative to the directory where the hooks are run (see 769the "DESCRIPTION" section of linkgit:githooks[5]). 770+ 771This configuration variable is useful in cases where you'd like to 772centrally configure your Git hooks instead of configuring them on a 773per-repository basis, or as a more flexible and centralized 774alternative to having an `init.templateDir` where you've changed 775default hooks. 776 777core.editor:: 778 Commands such as `commit` and `tag` that let you edit 779 messages by launching an editor use the value of this 780 variable when it is set, and the environment variable 781 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 782 783core.commentChar:: 784 Commands such as `commit` and `tag` that let you edit 785 messages consider a line that begins with this character 786 commented, and removes them after the editor returns 787 (default '#'). 788+ 789If set to "auto", `git-commit` would select a character that is not 790the beginning character of any line in existing commit messages. 791 792core.filesRefLockTimeout:: 793 The length of time, in milliseconds, to retry when trying to 794 lock an individual reference. Value 0 means not to retry at 795 all; -1 means to try indefinitely. Default is 100 (i.e., 796 retry for 100ms). 797 798core.packedRefsTimeout:: 799 The length of time, in milliseconds, to retry when trying to 800 lock the `packed-refs` file. Value 0 means not to retry at 801 all; -1 means to try indefinitely. Default is 1000 (i.e., 802 retry for 1 second). 803 804sequence.editor:: 805 Text editor used by `git rebase -i` for editing the rebase instruction file. 806 The value is meant to be interpreted by the shell when it is used. 807 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 808 When not configured the default commit message editor is used instead. 809 810core.pager:: 811 Text viewer for use by Git commands (e.g., 'less'). The value 812 is meant to be interpreted by the shell. The order of preference 813 is the `$GIT_PAGER` environment variable, then `core.pager` 814 configuration, then `$PAGER`, and then the default chosen at 815 compile time (usually 'less'). 816+ 817When the `LESS` environment variable is unset, Git sets it to `FRX` 818(if `LESS` environment variable is set, Git does not change it at 819all). If you want to selectively override Git's default setting 820for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 821be passed to the shell by Git, which will translate the final 822command to `LESS=FRX less -S`. The environment does not set the 823`S` option but the command line does, instructing less to truncate 824long lines. Similarly, setting `core.pager` to `less -+F` will 825deactivate the `F` option specified by the environment from the 826command-line, deactivating the "quit if one screen" behavior of 827`less`. One can specifically activate some flags for particular 828commands: for example, setting `pager.blame` to `less -S` enables 829line truncation only for `git blame`. 830+ 831Likewise, when the `LV` environment variable is unset, Git sets it 832to `-c`. You can override this setting by exporting `LV` with 833another value or setting `core.pager` to `lv +c`. 834 835core.whitespace:: 836 A comma separated list of common whitespace problems to 837 notice. 'git diff' will use `color.diff.whitespace` to 838 highlight them, and 'git apply --whitespace=error' will 839 consider them as errors. You can prefix `-` to disable 840 any of them (e.g. `-trailing-space`): 841+ 842* `blank-at-eol` treats trailing whitespaces at the end of the line 843 as an error (enabled by default). 844* `space-before-tab` treats a space character that appears immediately 845 before a tab character in the initial indent part of the line as an 846 error (enabled by default). 847* `indent-with-non-tab` treats a line that is indented with space 848 characters instead of the equivalent tabs as an error (not enabled by 849 default). 850* `tab-in-indent` treats a tab character in the initial indent part of 851 the line as an error (not enabled by default). 852* `blank-at-eof` treats blank lines added at the end of file as an error 853 (enabled by default). 854* `trailing-space` is a short-hand to cover both `blank-at-eol` and 855 `blank-at-eof`. 856* `cr-at-eol` treats a carriage-return at the end of line as 857 part of the line terminator, i.e. with it, `trailing-space` 858 does not trigger if the character before such a carriage-return 859 is not a whitespace (not enabled by default). 860* `tabwidth=<n>` tells how many character positions a tab occupies; this 861 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 862 errors. The default tab width is 8. Allowed values are 1 to 63. 863 864core.fsyncObjectFiles:: 865 This boolean will enable 'fsync()' when writing object files. 866+ 867This is a total waste of time and effort on a filesystem that orders 868data writes properly, but can be useful for filesystems that do not use 869journalling (traditional UNIX filesystems) or that only journal metadata 870and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 871 872core.preloadIndex:: 873 Enable parallel index preload for operations like 'git diff' 874+ 875This can speed up operations like 'git diff' and 'git status' especially 876on filesystems like NFS that have weak caching semantics and thus 877relatively high IO latencies. When enabled, Git will do the 878index comparison to the filesystem data in parallel, allowing 879overlapping IO's. Defaults to true. 880 881core.createObject:: 882 You can set this to 'link', in which case a hardlink followed by 883 a delete of the source are used to make sure that object creation 884 will not overwrite existing objects. 885+ 886On some file system/operating system combinations, this is unreliable. 887Set this config setting to 'rename' there; However, This will remove the 888check that makes sure that existing object files will not get overwritten. 889 890core.notesRef:: 891 When showing commit messages, also show notes which are stored in 892 the given ref. The ref must be fully qualified. If the given 893 ref does not exist, it is not an error but means that no 894 notes should be printed. 895+ 896This setting defaults to "refs/notes/commits", and it can be overridden by 897the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 898 899core.sparseCheckout:: 900 Enable "sparse checkout" feature. See section "Sparse checkout" in 901 linkgit:git-read-tree[1] for more information. 902 903core.abbrev:: 904 Set the length object names are abbreviated to. If 905 unspecified or set to "auto", an appropriate value is 906 computed based on the approximate number of packed objects 907 in your repository, which hopefully is enough for 908 abbreviated object names to stay unique for some time. 909 The minimum length is 4. 910 911add.ignoreErrors:: 912add.ignore-errors (deprecated):: 913 Tells 'git add' to continue adding files when some files cannot be 914 added due to indexing errors. Equivalent to the `--ignore-errors` 915 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 916 as it does not follow the usual naming convention for configuration 917 variables. 918 919alias.*:: 920 Command aliases for the linkgit:git[1] command wrapper - e.g. 921 after defining "alias.last = cat-file commit HEAD", the invocation 922 "git last" is equivalent to "git cat-file commit HEAD". To avoid 923 confusion and troubles with script usage, aliases that 924 hide existing Git commands are ignored. Arguments are split by 925 spaces, the usual shell quoting and escaping is supported. 926 A quote pair or a backslash can be used to quote them. 927+ 928If the alias expansion is prefixed with an exclamation point, 929it will be treated as a shell command. For example, defining 930"alias.new = !gitk --all --not ORIG_HEAD", the invocation 931"git new" is equivalent to running the shell command 932"gitk --all --not ORIG_HEAD". Note that shell commands will be 933executed from the top-level directory of a repository, which may 934not necessarily be the current directory. 935`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 936from the original current directory. See linkgit:git-rev-parse[1]. 937 938am.keepcr:: 939 If true, git-am will call git-mailsplit for patches in mbox format 940 with parameter `--keep-cr`. In this case git-mailsplit will 941 not remove `\r` from lines ending with `\r\n`. Can be overridden 942 by giving `--no-keep-cr` from the command line. 943 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 944 945am.threeWay:: 946 By default, `git am` will fail if the patch does not apply cleanly. When 947 set to true, this setting tells `git am` to fall back on 3-way merge if 948 the patch records the identity of blobs it is supposed to apply to and 949 we have those blobs available locally (equivalent to giving the `--3way` 950 option from the command line). Defaults to `false`. 951 See linkgit:git-am[1]. 952 953apply.ignoreWhitespace:: 954 When set to 'change', tells 'git apply' to ignore changes in 955 whitespace, in the same way as the `--ignore-space-change` 956 option. 957 When set to one of: no, none, never, false tells 'git apply' to 958 respect all whitespace differences. 959 See linkgit:git-apply[1]. 960 961apply.whitespace:: 962 Tells 'git apply' how to handle whitespaces, in the same way 963 as the `--whitespace` option. See linkgit:git-apply[1]. 964 965blame.showRoot:: 966 Do not treat root commits as boundaries in linkgit:git-blame[1]. 967 This option defaults to false. 968 969blame.blankBoundary:: 970 Show blank commit object name for boundary commits in 971 linkgit:git-blame[1]. This option defaults to false. 972 973blame.showEmail:: 974 Show the author email instead of author name in linkgit:git-blame[1]. 975 This option defaults to false. 976 977blame.date:: 978 Specifies the format used to output dates in linkgit:git-blame[1]. 979 If unset the iso format is used. For supported values, 980 see the discussion of the `--date` option at linkgit:git-log[1]. 981 982branch.autoSetupMerge:: 983 Tells 'git branch' and 'git checkout' to set up new branches 984 so that linkgit:git-pull[1] will appropriately merge from the 985 starting point branch. Note that even if this option is not set, 986 this behavior can be chosen per-branch using the `--track` 987 and `--no-track` options. The valid settings are: `false` -- no 988 automatic setup is done; `true` -- automatic setup is done when the 989 starting point is a remote-tracking branch; `always` -- 990 automatic setup is done when the starting point is either a 991 local branch or remote-tracking 992 branch. This option defaults to true. 993 994branch.autoSetupRebase:: 995 When a new branch is created with 'git branch' or 'git checkout' 996 that tracks another branch, this variable tells Git to set 997 up pull to rebase instead of merge (see "branch.<name>.rebase"). 998 When `never`, rebase is never automatically set to true. 999 When `local`, rebase is set to true for tracked branches of1000 other local branches.1001 When `remote`, rebase is set to true for tracked branches of1002 remote-tracking branches.1003 When `always`, rebase will be set to true for all tracking1004 branches.1005 See "branch.autoSetupMerge" for details on how to set up a1006 branch to track another branch.1007 This option defaults to never.10081009branch.<name>.remote::1010 When on branch <name>, it tells 'git fetch' and 'git push'1011 which remote to fetch from/push to. The remote to push to1012 may be overridden with `remote.pushDefault` (for all branches).1013 The remote to push to, for the current branch, may be further1014 overridden by `branch.<name>.pushRemote`. If no remote is1015 configured, or if you are not on any branch, it defaults to1016 `origin` for fetching and `remote.pushDefault` for pushing.1017 Additionally, `.` (a period) is the current local repository1018 (a dot-repository), see `branch.<name>.merge`'s final note below.10191020branch.<name>.pushRemote::1021 When on branch <name>, it overrides `branch.<name>.remote` for1022 pushing. It also overrides `remote.pushDefault` for pushing1023 from branch <name>. When you pull from one place (e.g. your1024 upstream) and push to another place (e.g. your own publishing1025 repository), you would want to set `remote.pushDefault` to1026 specify the remote to push to for all branches, and use this1027 option to override it for a specific branch.10281029branch.<name>.merge::1030 Defines, together with branch.<name>.remote, the upstream branch1031 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1032 branch to merge and can also affect 'git push' (see push.default).1033 When in branch <name>, it tells 'git fetch' the default1034 refspec to be marked for merging in FETCH_HEAD. The value is1035 handled like the remote part of a refspec, and must match a1036 ref which is fetched from the remote given by1037 "branch.<name>.remote".1038 The merge information is used by 'git pull' (which at first calls1039 'git fetch') to lookup the default branch for merging. Without1040 this option, 'git pull' defaults to merge the first refspec fetched.1041 Specify multiple values to get an octopus merge.1042 If you wish to setup 'git pull' so that it merges into <name> from1043 another branch in the local repository, you can point1044 branch.<name>.merge to the desired branch, and use the relative path1045 setting `.` (a period) for branch.<name>.remote.10461047branch.<name>.mergeOptions::1048 Sets default options for merging into branch <name>. The syntax and1049 supported options are the same as those of linkgit:git-merge[1], but1050 option values containing whitespace characters are currently not1051 supported.10521053branch.<name>.rebase::1054 When true, rebase the branch <name> on top of the fetched branch,1055 instead of merging the default branch from the default remote when1056 "git pull" is run. See "pull.rebase" for doing this in a non1057 branch-specific manner.1058+1059When preserve, also pass `--preserve-merges` along to 'git rebase'1060so that locally committed merge commits will not be flattened1061by running 'git pull'.1062+1063When the value is `interactive`, the rebase is run in interactive mode.1064+1065*NOTE*: this is a possibly dangerous operation; do *not* use1066it unless you understand the implications (see linkgit:git-rebase[1]1067for details).10681069branch.<name>.description::1070 Branch description, can be edited with1071 `git branch --edit-description`. Branch description is1072 automatically added in the format-patch cover letter or1073 request-pull summary.10741075browser.<tool>.cmd::1076 Specify the command to invoke the specified browser. The1077 specified command is evaluated in shell with the URLs passed1078 as arguments. (See linkgit:git-web{litdd}browse[1].)10791080browser.<tool>.path::1081 Override the path for the given tool that may be used to1082 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1083 working repository in gitweb (see linkgit:git-instaweb[1]).10841085clean.requireForce::1086 A boolean to make git-clean do nothing unless given -f,1087 -i or -n. Defaults to true.10881089color.branch::1090 A boolean to enable/disable color in the output of1091 linkgit:git-branch[1]. May be set to `always`,1092 `false` (or `never`) or `auto` (or `true`), in which case colors are used1093 only when the output is to a terminal. If unset, then the1094 value of `color.ui` is used (`auto` by default).10951096color.branch.<slot>::1097 Use customized color for branch coloration. `<slot>` is one of1098 `current` (the current branch), `local` (a local branch),1099 `remote` (a remote-tracking branch in refs/remotes/),1100 `upstream` (upstream tracking branch), `plain` (other1101 refs).11021103color.diff::1104 Whether to use ANSI escape sequences to add color to patches.1105 If this is set to `always`, linkgit:git-diff[1],1106 linkgit:git-log[1], and linkgit:git-show[1] will use color1107 for all patches. If it is set to `true` or `auto`, those1108 commands will only use color when output is to the terminal.1109 If unset, then the value of `color.ui` is used (`auto` by1110 default).1111+1112This does not affect linkgit:git-format-patch[1] or the1113'git-diff-{asterisk}' plumbing commands. Can be overridden on the1114command line with the `--color[=<when>]` option.11151116diff.colorMoved::1117 If set to either a valid `<mode>` or a true value, moved lines1118 in a diff are colored differently, for details of valid modes1119 see '--color-moved' in linkgit:git-diff[1]. If simply set to1120 true the default color mode will be used. When set to false,1121 moved lines are not colored.11221123color.diff.<slot>::1124 Use customized color for diff colorization. `<slot>` specifies1125 which part of the patch to use the specified color, and is one1126 of `context` (context text - `plain` is a historical synonym),1127 `meta` (metainformation), `frag`1128 (hunk header), 'func' (function in hunk header), `old` (removed lines),1129 `new` (added lines), `commit` (commit headers), `whitespace`1130 (highlighting whitespace errors), `oldMoved` (deleted lines),1131 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1132 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1133 and `newMovedAlternativeDimmed` (See the '<mode>'1134 setting of '--color-moved' in linkgit:git-diff[1] for details).11351136color.decorate.<slot>::1137 Use customized color for 'git log --decorate' output. `<slot>` is one1138 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1139 branches, remote-tracking branches, tags, stash and HEAD, respectively.11401141color.grep::1142 When set to `always`, always highlight matches. When `false` (or1143 `never`), never. When set to `true` or `auto`, use color only1144 when the output is written to the terminal. If unset, then the1145 value of `color.ui` is used (`auto` by default).11461147color.grep.<slot>::1148 Use customized color for grep colorization. `<slot>` specifies which1149 part of the line to use the specified color, and is one of1150+1151--1152`context`;;1153 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1154`filename`;;1155 filename prefix (when not using `-h`)1156`function`;;1157 function name lines (when using `-p`)1158`linenumber`;;1159 line number prefix (when using `-n`)1160`match`;;1161 matching text (same as setting `matchContext` and `matchSelected`)1162`matchContext`;;1163 matching text in context lines1164`matchSelected`;;1165 matching text in selected lines1166`selected`;;1167 non-matching text in selected lines1168`separator`;;1169 separators between fields on a line (`:`, `-`, and `=`)1170 and between hunks (`--`)1171--11721173color.interactive::1174 When set to `always`, always use colors for interactive prompts1175 and displays (such as those used by "git-add --interactive" and1176 "git-clean --interactive"). When false (or `never`), never.1177 When set to `true` or `auto`, use colors only when the output is1178 to the terminal. If unset, then the value of `color.ui` is1179 used (`auto` by default).11801181color.interactive.<slot>::1182 Use customized color for 'git add --interactive' and 'git clean1183 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1184 or `error`, for four distinct types of normal output from1185 interactive commands.11861187color.pager::1188 A boolean to enable/disable colored output when the pager is in1189 use (default is true).11901191color.showBranch::1192 A boolean to enable/disable color in the output of1193 linkgit:git-show-branch[1]. May be set to `always`,1194 `false` (or `never`) or `auto` (or `true`), in which case colors are used1195 only when the output is to a terminal. If unset, then the1196 value of `color.ui` is used (`auto` by default).11971198color.status::1199 A boolean to enable/disable color in the output of1200 linkgit:git-status[1]. May be set to `always`,1201 `false` (or `never`) or `auto` (or `true`), in which case colors are used1202 only when the output is to a terminal. If unset, then the1203 value of `color.ui` is used (`auto` by default).12041205color.status.<slot>::1206 Use customized color for status colorization. `<slot>` is1207 one of `header` (the header text of the status message),1208 `added` or `updated` (files which are added but not committed),1209 `changed` (files which are changed but not added in the index),1210 `untracked` (files which are not tracked by Git),1211 `branch` (the current branch),1212 `nobranch` (the color the 'no branch' warning is shown in, defaulting1213 to red),1214 `localBranch` or `remoteBranch` (the local and remote branch names,1215 respectively, when branch and tracking information is displayed in the1216 status short-format), or1217 `unmerged` (files which have unmerged changes).12181219color.ui::1220 This variable determines the default value for variables such1221 as `color.diff` and `color.grep` that control the use of color1222 per command family. Its scope will expand as more commands learn1223 configuration to set a default for the `--color` option. Set it1224 to `false` or `never` if you prefer Git commands not to use1225 color unless enabled explicitly with some other configuration1226 or the `--color` option. Set it to `always` if you want all1227 output not intended for machine consumption to use color, to1228 `true` or `auto` (this is the default since Git 1.8.4) if you1229 want such output to use color when written to the terminal.12301231column.ui::1232 Specify whether supported commands should output in columns.1233 This variable consists of a list of tokens separated by spaces1234 or commas:1235+1236These options control when the feature should be enabled1237(defaults to 'never'):1238+1239--1240`always`;;1241 always show in columns1242`never`;;1243 never show in columns1244`auto`;;1245 show in columns if the output is to the terminal1246--1247+1248These options control layout (defaults to 'column'). Setting any1249of these implies 'always' if none of 'always', 'never', or 'auto' are1250specified.1251+1252--1253`column`;;1254 fill columns before rows1255`row`;;1256 fill rows before columns1257`plain`;;1258 show in one column1259--1260+1261Finally, these options can be combined with a layout option (defaults1262to 'nodense'):1263+1264--1265`dense`;;1266 make unequal size columns to utilize more space1267`nodense`;;1268 make equal size columns1269--12701271column.branch::1272 Specify whether to output branch listing in `git branch` in columns.1273 See `column.ui` for details.12741275column.clean::1276 Specify the layout when list items in `git clean -i`, which always1277 shows files and directories in columns. See `column.ui` for details.12781279column.status::1280 Specify whether to output untracked files in `git status` in columns.1281 See `column.ui` for details.12821283column.tag::1284 Specify whether to output tag listing in `git tag` in columns.1285 See `column.ui` for details.12861287commit.cleanup::1288 This setting overrides the default of the `--cleanup` option in1289 `git commit`. See linkgit:git-commit[1] for details. Changing the1290 default can be useful when you always want to keep lines that begin1291 with comment character `#` in your log message, in which case you1292 would do `git config commit.cleanup whitespace` (note that you will1293 have to remove the help lines that begin with `#` in the commit log1294 template yourself, if you do this).12951296commit.gpgSign::12971298 A boolean to specify whether all commits should be GPG signed.1299 Use of this option when doing operations such as rebase can1300 result in a large number of commits being signed. It may be1301 convenient to use an agent to avoid typing your GPG passphrase1302 several times.13031304commit.status::1305 A boolean to enable/disable inclusion of status information in the1306 commit message template when using an editor to prepare the commit1307 message. Defaults to true.13081309commit.template::1310 Specify the pathname of a file to use as the template for1311 new commit messages.13121313commit.verbose::1314 A boolean or int to specify the level of verbose with `git commit`.1315 See linkgit:git-commit[1].13161317credential.helper::1318 Specify an external helper to be called when a username or1319 password credential is needed; the helper may consult external1320 storage to avoid prompting the user for the credentials. Note1321 that multiple helpers may be defined. See linkgit:gitcredentials[7]1322 for details.13231324credential.useHttpPath::1325 When acquiring credentials, consider the "path" component of an http1326 or https URL to be important. Defaults to false. See1327 linkgit:gitcredentials[7] for more information.13281329credential.username::1330 If no username is set for a network authentication, use this username1331 by default. See credential.<context>.* below, and1332 linkgit:gitcredentials[7].13331334credential.<url>.*::1335 Any of the credential.* options above can be applied selectively to1336 some credentials. For example "credential.https://example.com.username"1337 would set the default username only for https connections to1338 example.com. See linkgit:gitcredentials[7] for details on how URLs are1339 matched.13401341credentialCache.ignoreSIGHUP::1342 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13431344include::diff-config.txt[]13451346difftool.<tool>.path::1347 Override the path for the given tool. This is useful in case1348 your tool is not in the PATH.13491350difftool.<tool>.cmd::1351 Specify the command to invoke the specified diff tool.1352 The specified command is evaluated in shell with the following1353 variables available: 'LOCAL' is set to the name of the temporary1354 file containing the contents of the diff pre-image and 'REMOTE'1355 is set to the name of the temporary file containing the contents1356 of the diff post-image.13571358difftool.prompt::1359 Prompt before each invocation of the diff tool.13601361fastimport.unpackLimit::1362 If the number of objects imported by linkgit:git-fast-import[1]1363 is below this limit, then the objects will be unpacked into1364 loose object files. However if the number of imported objects1365 equals or exceeds this limit then the pack will be stored as a1366 pack. Storing the pack from a fast-import can make the import1367 operation complete faster, especially on slow filesystems. If1368 not set, the value of `transfer.unpackLimit` is used instead.13691370fetch.recurseSubmodules::1371 This option can be either set to a boolean value or to 'on-demand'.1372 Setting it to a boolean changes the behavior of fetch and pull to1373 unconditionally recurse into submodules when set to true or to not1374 recurse at all when set to false. When set to 'on-demand' (the default1375 value), fetch and pull will only recurse into a populated submodule1376 when its superproject retrieves a commit that updates the submodule's1377 reference.13781379fetch.fsckObjects::1380 If it is set to true, git-fetch-pack will check all fetched1381 objects. It will abort in the case of a malformed object or a1382 broken link. The result of an abort are only dangling objects.1383 Defaults to false. If not set, the value of `transfer.fsckObjects`1384 is used instead.13851386fetch.unpackLimit::1387 If the number of objects fetched over the Git native1388 transfer is below this1389 limit, then the objects will be unpacked into loose object1390 files. However if the number of received objects equals or1391 exceeds this limit then the received pack will be stored as1392 a pack, after adding any missing delta bases. Storing the1393 pack from a push can make the push operation complete faster,1394 especially on slow filesystems. If not set, the value of1395 `transfer.unpackLimit` is used instead.13961397fetch.prune::1398 If true, fetch will automatically behave as if the `--prune`1399 option was given on the command line. See also `remote.<name>.prune`.14001401fetch.output::1402 Control how ref update status is printed. Valid values are1403 `full` and `compact`. Default value is `full`. See section1404 OUTPUT in linkgit:git-fetch[1] for detail.14051406format.attach::1407 Enable multipart/mixed attachments as the default for1408 'format-patch'. The value can also be a double quoted string1409 which will enable attachments as the default and set the1410 value as the boundary. See the --attach option in1411 linkgit:git-format-patch[1].14121413format.from::1414 Provides the default value for the `--from` option to format-patch.1415 Accepts a boolean value, or a name and email address. If false,1416 format-patch defaults to `--no-from`, using commit authors directly in1417 the "From:" field of patch mails. If true, format-patch defaults to1418 `--from`, using your committer identity in the "From:" field of patch1419 mails and including a "From:" field in the body of the patch mail if1420 different. If set to a non-boolean value, format-patch uses that1421 value instead of your committer identity. Defaults to false.14221423format.numbered::1424 A boolean which can enable or disable sequence numbers in patch1425 subjects. It defaults to "auto" which enables it only if there1426 is more than one patch. It can be enabled or disabled for all1427 messages by setting it to "true" or "false". See --numbered1428 option in linkgit:git-format-patch[1].14291430format.headers::1431 Additional email headers to include in a patch to be submitted1432 by mail. See linkgit:git-format-patch[1].14331434format.to::1435format.cc::1436 Additional recipients to include in a patch to be submitted1437 by mail. See the --to and --cc options in1438 linkgit:git-format-patch[1].14391440format.subjectPrefix::1441 The default for format-patch is to output files with the '[PATCH]'1442 subject prefix. Use this variable to change that prefix.14431444format.signature::1445 The default for format-patch is to output a signature containing1446 the Git version number. Use this variable to change that default.1447 Set this variable to the empty string ("") to suppress1448 signature generation.14491450format.signatureFile::1451 Works just like format.signature except the contents of the1452 file specified by this variable will be used as the signature.14531454format.suffix::1455 The default for format-patch is to output files with the suffix1456 `.patch`. Use this variable to change that suffix (make sure to1457 include the dot if you want it).14581459format.pretty::1460 The default pretty format for log/show/whatchanged command,1461 See linkgit:git-log[1], linkgit:git-show[1],1462 linkgit:git-whatchanged[1].14631464format.thread::1465 The default threading style for 'git format-patch'. Can be1466 a boolean value, or `shallow` or `deep`. `shallow` threading1467 makes every mail a reply to the head of the series,1468 where the head is chosen from the cover letter, the1469 `--in-reply-to`, and the first patch mail, in this order.1470 `deep` threading makes every mail a reply to the previous one.1471 A true boolean value is the same as `shallow`, and a false1472 value disables threading.14731474format.signOff::1475 A boolean value which lets you enable the `-s/--signoff` option of1476 format-patch by default. *Note:* Adding the Signed-off-by: line to a1477 patch should be a conscious act and means that you certify you have1478 the rights to submit this work under the same open source license.1479 Please see the 'SubmittingPatches' document for further discussion.14801481format.coverLetter::1482 A boolean that controls whether to generate a cover-letter when1483 format-patch is invoked, but in addition can be set to "auto", to1484 generate a cover-letter only when there's more than one patch.14851486format.outputDirectory::1487 Set a custom directory to store the resulting files instead of the1488 current working directory.14891490format.useAutoBase::1491 A boolean value which lets you enable the `--base=auto` option of1492 format-patch by default.14931494filter.<driver>.clean::1495 The command which is used to convert the content of a worktree1496 file to a blob upon checkin. See linkgit:gitattributes[5] for1497 details.14981499filter.<driver>.smudge::1500 The command which is used to convert the content of a blob1501 object to a worktree file upon checkout. See1502 linkgit:gitattributes[5] for details.15031504fsck.<msg-id>::1505 Allows overriding the message type (error, warn or ignore) of a1506 specific message ID such as `missingEmail`.1507+1508For convenience, fsck prefixes the error/warning with the message ID,1509e.g. "missingEmail: invalid author/committer line - missing email" means1510that setting `fsck.missingEmail = ignore` will hide that issue.1511+1512This feature is intended to support working with legacy repositories1513which cannot be repaired without disruptive changes.15141515fsck.skipList::1516 The path to a sorted list of object names (i.e. one SHA-1 per1517 line) that are known to be broken in a non-fatal way and should1518 be ignored. This feature is useful when an established project1519 should be accepted despite early commits containing errors that1520 can be safely ignored such as invalid committer email addresses.1521 Note: corrupt objects cannot be skipped with this setting.15221523gc.aggressiveDepth::1524 The depth parameter used in the delta compression1525 algorithm used by 'git gc --aggressive'. This defaults1526 to 50.15271528gc.aggressiveWindow::1529 The window size parameter used in the delta compression1530 algorithm used by 'git gc --aggressive'. This defaults1531 to 250.15321533gc.auto::1534 When there are approximately more than this many loose1535 objects in the repository, `git gc --auto` will pack them.1536 Some Porcelain commands use this command to perform a1537 light-weight garbage collection from time to time. The1538 default value is 6700. Setting this to 0 disables it.15391540gc.autoPackLimit::1541 When there are more than this many packs that are not1542 marked with `*.keep` file in the repository, `git gc1543 --auto` consolidates them into one larger pack. The1544 default value is 50. Setting this to 0 disables it.15451546gc.autoDetach::1547 Make `git gc --auto` return immediately and run in background1548 if the system supports it. Default is true.15491550gc.logExpiry::1551 If the file gc.log exists, then `git gc --auto` won't run1552 unless that file is more than 'gc.logExpiry' old. Default is1553 "1.day". See `gc.pruneExpire` for more ways to specify its1554 value.15551556gc.packRefs::1557 Running `git pack-refs` in a repository renders it1558 unclonable by Git versions prior to 1.5.1.2 over dumb1559 transports such as HTTP. This variable determines whether1560 'git gc' runs `git pack-refs`. This can be set to `notbare`1561 to enable it within all non-bare repos or it can be set to a1562 boolean value. The default is `true`.15631564gc.pruneExpire::1565 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1566 Override the grace period with this config variable. The value1567 "now" may be used to disable this grace period and always prune1568 unreachable objects immediately, or "never" may be used to1569 suppress pruning. This feature helps prevent corruption when1570 'git gc' runs concurrently with another process writing to the1571 repository; see the "NOTES" section of linkgit:git-gc[1].15721573gc.worktreePruneExpire::1574 When 'git gc' is run, it calls1575 'git worktree prune --expire 3.months.ago'.1576 This config variable can be used to set a different grace1577 period. The value "now" may be used to disable the grace1578 period and prune `$GIT_DIR/worktrees` immediately, or "never"1579 may be used to suppress pruning.15801581gc.reflogExpire::1582gc.<pattern>.reflogExpire::1583 'git reflog expire' removes reflog entries older than1584 this time; defaults to 90 days. The value "now" expires all1585 entries immediately, and "never" suppresses expiration1586 altogether. With "<pattern>" (e.g.1587 "refs/stash") in the middle the setting applies only to1588 the refs that match the <pattern>.15891590gc.reflogExpireUnreachable::1591gc.<pattern>.reflogExpireUnreachable::1592 'git reflog expire' removes reflog entries older than1593 this time and are not reachable from the current tip;1594 defaults to 30 days. The value "now" expires all entries1595 immediately, and "never" suppresses expiration altogether.1596 With "<pattern>" (e.g. "refs/stash")1597 in the middle, the setting applies only to the refs that1598 match the <pattern>.15991600gc.rerereResolved::1601 Records of conflicted merge you resolved earlier are1602 kept for this many days when 'git rerere gc' is run.1603 You can also use more human-readable "1.month.ago", etc.1604 The default is 60 days. See linkgit:git-rerere[1].16051606gc.rerereUnresolved::1607 Records of conflicted merge you have not resolved are1608 kept for this many days when 'git rerere gc' is run.1609 You can also use more human-readable "1.month.ago", etc.1610 The default is 15 days. See linkgit:git-rerere[1].16111612gitcvs.commitMsgAnnotation::1613 Append this string to each commit message. Set to empty string1614 to disable this feature. Defaults to "via git-CVS emulator".16151616gitcvs.enabled::1617 Whether the CVS server interface is enabled for this repository.1618 See linkgit:git-cvsserver[1].16191620gitcvs.logFile::1621 Path to a log file where the CVS server interface well... logs1622 various stuff. See linkgit:git-cvsserver[1].16231624gitcvs.usecrlfattr::1625 If true, the server will look up the end-of-line conversion1626 attributes for files to determine the `-k` modes to use. If1627 the attributes force Git to treat a file as text,1628 the `-k` mode will be left blank so CVS clients will1629 treat it as text. If they suppress text conversion, the file1630 will be set with '-kb' mode, which suppresses any newline munging1631 the client might otherwise do. If the attributes do not allow1632 the file type to be determined, then `gitcvs.allBinary` is1633 used. See linkgit:gitattributes[5].16341635gitcvs.allBinary::1636 This is used if `gitcvs.usecrlfattr` does not resolve1637 the correct '-kb' mode to use. If true, all1638 unresolved files are sent to the client in1639 mode '-kb'. This causes the client to treat them1640 as binary files, which suppresses any newline munging it1641 otherwise might do. Alternatively, if it is set to "guess",1642 then the contents of the file are examined to decide if1643 it is binary, similar to `core.autocrlf`.16441645gitcvs.dbName::1646 Database used by git-cvsserver to cache revision information1647 derived from the Git repository. The exact meaning depends on the1648 used database driver, for SQLite (which is the default driver) this1649 is a filename. Supports variable substitution (see1650 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1651 Default: '%Ggitcvs.%m.sqlite'16521653gitcvs.dbDriver::1654 Used Perl DBI driver. You can specify any available driver1655 for this here, but it might not work. git-cvsserver is tested1656 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1657 reported *not* to work with 'DBD::mysql'. Experimental feature.1658 May not contain double colons (`:`). Default: 'SQLite'.1659 See linkgit:git-cvsserver[1].16601661gitcvs.dbUser, gitcvs.dbPass::1662 Database user and password. Only useful if setting `gitcvs.dbDriver`,1663 since SQLite has no concept of database users and/or passwords.1664 'gitcvs.dbUser' supports variable substitution (see1665 linkgit:git-cvsserver[1] for details).16661667gitcvs.dbTableNamePrefix::1668 Database table name prefix. Prepended to the names of any1669 database tables used, allowing a single database to be used1670 for several repositories. Supports variable substitution (see1671 linkgit:git-cvsserver[1] for details). Any non-alphabetic1672 characters will be replaced with underscores.16731674All gitcvs variables except for `gitcvs.usecrlfattr` and1675`gitcvs.allBinary` can also be specified as1676'gitcvs.<access_method>.<varname>' (where 'access_method'1677is one of "ext" and "pserver") to make them apply only for the given1678access method.16791680gitweb.category::1681gitweb.description::1682gitweb.owner::1683gitweb.url::1684 See linkgit:gitweb[1] for description.16851686gitweb.avatar::1687gitweb.blame::1688gitweb.grep::1689gitweb.highlight::1690gitweb.patches::1691gitweb.pickaxe::1692gitweb.remote_heads::1693gitweb.showSizes::1694gitweb.snapshot::1695 See linkgit:gitweb.conf[5] for description.16961697grep.lineNumber::1698 If set to true, enable `-n` option by default.16991700grep.patternType::1701 Set the default matching behavior. Using a value of 'basic', 'extended',1702 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1703 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1704 value 'default' will return to the default matching behavior.17051706grep.extendedRegexp::1707 If set to true, enable `--extended-regexp` option by default. This1708 option is ignored when the `grep.patternType` option is set to a value1709 other than 'default'.17101711grep.threads::1712 Number of grep worker threads to use.1713 See `grep.threads` in linkgit:git-grep[1] for more information.17141715grep.fallbackToNoIndex::1716 If set to true, fall back to git grep --no-index if git grep1717 is executed outside of a git repository. Defaults to false.17181719gpg.program::1720 Use this custom program instead of "`gpg`" found on `$PATH` when1721 making or verifying a PGP signature. The program must support the1722 same command-line interface as GPG, namely, to verify a detached1723 signature, "`gpg --verify $file - <$signature`" is run, and the1724 program is expected to signal a good signature by exiting with1725 code 0, and to generate an ASCII-armored detached signature, the1726 standard input of "`gpg -bsau $key`" is fed with the contents to be1727 signed, and the program is expected to send the result to its1728 standard output.17291730gui.commitMsgWidth::1731 Defines how wide the commit message window is in the1732 linkgit:git-gui[1]. "75" is the default.17331734gui.diffContext::1735 Specifies how many context lines should be used in calls to diff1736 made by the linkgit:git-gui[1]. The default is "5".17371738gui.displayUntracked::1739 Determines if linkgit:git-gui[1] shows untracked files1740 in the file list. The default is "true".17411742gui.encoding::1743 Specifies the default encoding to use for displaying of1744 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1745 It can be overridden by setting the 'encoding' attribute1746 for relevant files (see linkgit:gitattributes[5]).1747 If this option is not set, the tools default to the1748 locale encoding.17491750gui.matchTrackingBranch::1751 Determines if new branches created with linkgit:git-gui[1] should1752 default to tracking remote branches with matching names or1753 not. Default: "false".17541755gui.newBranchTemplate::1756 Is used as suggested name when creating new branches using the1757 linkgit:git-gui[1].17581759gui.pruneDuringFetch::1760 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1761 performing a fetch. The default value is "false".17621763gui.trustmtime::1764 Determines if linkgit:git-gui[1] should trust the file modification1765 timestamp or not. By default the timestamps are not trusted.17661767gui.spellingDictionary::1768 Specifies the dictionary used for spell checking commit messages in1769 the linkgit:git-gui[1]. When set to "none" spell checking is turned1770 off.17711772gui.fastCopyBlame::1773 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1774 location detection. It makes blame significantly faster on huge1775 repositories at the expense of less thorough copy detection.17761777gui.copyBlameThreshold::1778 Specifies the threshold to use in 'git gui blame' original location1779 detection, measured in alphanumeric characters. See the1780 linkgit:git-blame[1] manual for more information on copy detection.17811782gui.blamehistoryctx::1783 Specifies the radius of history context in days to show in1784 linkgit:gitk[1] for the selected commit, when the `Show History1785 Context` menu item is invoked from 'git gui blame'. If this1786 variable is set to zero, the whole history is shown.17871788guitool.<name>.cmd::1789 Specifies the shell command line to execute when the corresponding item1790 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1791 mandatory for every tool. The command is executed from the root of1792 the working directory, and in the environment it receives the name of1793 the tool as `GIT_GUITOOL`, the name of the currently selected file as1794 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1795 the head is detached, 'CUR_BRANCH' is empty).17961797guitool.<name>.needsFile::1798 Run the tool only if a diff is selected in the GUI. It guarantees1799 that 'FILENAME' is not empty.18001801guitool.<name>.noConsole::1802 Run the command silently, without creating a window to display its1803 output.18041805guitool.<name>.noRescan::1806 Don't rescan the working directory for changes after the tool1807 finishes execution.18081809guitool.<name>.confirm::1810 Show a confirmation dialog before actually running the tool.18111812guitool.<name>.argPrompt::1813 Request a string argument from the user, and pass it to the tool1814 through the `ARGS` environment variable. Since requesting an1815 argument implies confirmation, the 'confirm' option has no effect1816 if this is enabled. If the option is set to 'true', 'yes', or '1',1817 the dialog uses a built-in generic prompt; otherwise the exact1818 value of the variable is used.18191820guitool.<name>.revPrompt::1821 Request a single valid revision from the user, and set the1822 `REVISION` environment variable. In other aspects this option1823 is similar to 'argPrompt', and can be used together with it.18241825guitool.<name>.revUnmerged::1826 Show only unmerged branches in the 'revPrompt' subdialog.1827 This is useful for tools similar to merge or rebase, but not1828 for things like checkout or reset.18291830guitool.<name>.title::1831 Specifies the title to use for the prompt dialog. The default1832 is the tool name.18331834guitool.<name>.prompt::1835 Specifies the general prompt string to display at the top of1836 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1837 The default value includes the actual command.18381839help.browser::1840 Specify the browser that will be used to display help in the1841 'web' format. See linkgit:git-help[1].18421843help.format::1844 Override the default help format used by linkgit:git-help[1].1845 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1846 the default. 'web' and 'html' are the same.18471848help.autoCorrect::1849 Automatically correct and execute mistyped commands after1850 waiting for the given number of deciseconds (0.1 sec). If more1851 than one command can be deduced from the entered text, nothing1852 will be executed. If the value of this option is negative,1853 the corrected command will be executed immediately. If the1854 value is 0 - the command will be just shown but not executed.1855 This is the default.18561857help.htmlPath::1858 Specify the path where the HTML documentation resides. File system paths1859 and URLs are supported. HTML pages will be prefixed with this path when1860 help is displayed in the 'web' format. This defaults to the documentation1861 path of your Git installation.18621863http.proxy::1864 Override the HTTP proxy, normally configured using the 'http_proxy',1865 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1866 addition to the syntax understood by curl, it is possible to specify a1867 proxy string with a user name but no password, in which case git will1868 attempt to acquire one in the same way it does for other credentials. See1869 linkgit:gitcredentials[7] for more information. The syntax thus is1870 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1871 on a per-remote basis; see remote.<name>.proxy18721873http.proxyAuthMethod::1874 Set the method with which to authenticate against the HTTP proxy. This1875 only takes effect if the configured proxy string contains a user name part1876 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1877 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1878 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1879 variable. Possible values are:1880+1881--1882* `anyauth` - Automatically pick a suitable authentication method. It is1883 assumed that the proxy answers an unauthenticated request with a 4071884 status code and one or more Proxy-authenticate headers with supported1885 authentication methods. This is the default.1886* `basic` - HTTP Basic authentication1887* `digest` - HTTP Digest authentication; this prevents the password from being1888 transmitted to the proxy in clear text1889* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1890 of `curl(1)`)1891* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1892--18931894http.emptyAuth::1895 Attempt authentication without seeking a username or password. This1896 can be used to attempt GSS-Negotiate authentication without specifying1897 a username in the URL, as libcurl normally requires a username for1898 authentication.18991900http.delegation::1901 Control GSSAPI credential delegation. The delegation is disabled1902 by default in libcurl since version 7.21.7. Set parameter to tell1903 the server what it is allowed to delegate when it comes to user1904 credentials. Used with GSS/kerberos. Possible values are:1905+1906--1907* `none` - Don't allow any delegation.1908* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1909 Kerberos service ticket, which is a matter of realm policy.1910* `always` - Unconditionally allow the server to delegate.1911--191219131914http.extraHeader::1915 Pass an additional HTTP header when communicating with a server. If1916 more than one such entry exists, all of them are added as extra1917 headers. To allow overriding the settings inherited from the system1918 config, an empty value will reset the extra headers to the empty list.19191920http.cookieFile::1921 The pathname of a file containing previously stored cookie lines,1922 which should be used1923 in the Git http session, if they match the server. The file format1924 of the file to read cookies from should be plain HTTP headers or1925 the Netscape/Mozilla cookie file format (see `curl(1)`).1926 NOTE that the file specified with http.cookieFile is used only as1927 input unless http.saveCookies is set.19281929http.saveCookies::1930 If set, store cookies received during requests to the file specified by1931 http.cookieFile. Has no effect if http.cookieFile is unset.19321933http.sslVersion::1934 The SSL version to use when negotiating an SSL connection, if you1935 want to force the default. The available and default version1936 depend on whether libcurl was built against NSS or OpenSSL and the1937 particular configuration of the crypto library in use. Internally1938 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1939 documentation for more details on the format of this option and1940 for the ssl version supported. Actually the possible values of1941 this option are:19421943 - sslv21944 - sslv31945 - tlsv11946 - tlsv1.01947 - tlsv1.11948 - tlsv1.219491950+1951Can be overridden by the `GIT_SSL_VERSION` environment variable.1952To force git to use libcurl's default ssl version and ignore any1953explicit http.sslversion option, set `GIT_SSL_VERSION` to the1954empty string.19551956http.sslCipherList::1957 A list of SSL ciphers to use when negotiating an SSL connection.1958 The available ciphers depend on whether libcurl was built against1959 NSS or OpenSSL and the particular configuration of the crypto1960 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1961 option; see the libcurl documentation for more details on the format1962 of this list.1963+1964Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1965To force git to use libcurl's default cipher list and ignore any1966explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1967empty string.19681969http.sslVerify::1970 Whether to verify the SSL certificate when fetching or pushing1971 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1972 variable.19731974http.sslCert::1975 File containing the SSL certificate when fetching or pushing1976 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1977 variable.19781979http.sslKey::1980 File containing the SSL private key when fetching or pushing1981 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1982 variable.19831984http.sslCertPasswordProtected::1985 Enable Git's password prompt for the SSL certificate. Otherwise1986 OpenSSL will prompt the user, possibly many times, if the1987 certificate or private key is encrypted. Can be overridden by the1988 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19891990http.sslCAInfo::1991 File containing the certificates to verify the peer with when1992 fetching or pushing over HTTPS. Can be overridden by the1993 `GIT_SSL_CAINFO` environment variable.19941995http.sslCAPath::1996 Path containing files with the CA certificates to verify the peer1997 with when fetching or pushing over HTTPS. Can be overridden1998 by the `GIT_SSL_CAPATH` environment variable.19992000http.pinnedpubkey::2001 Public key of the https service. It may either be the filename of2002 a PEM or DER encoded public key file or a string starting with2003 'sha256//' followed by the base64 encoded sha256 hash of the2004 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2005 exit with an error if this option is set but not supported by2006 cURL.20072008http.sslTry::2009 Attempt to use AUTH SSL/TLS and encrypted data transfers2010 when connecting via regular FTP protocol. This might be needed2011 if the FTP server requires it for security reasons or you wish2012 to connect securely whenever remote FTP server supports it.2013 Default is false since it might trigger certificate verification2014 errors on misconfigured servers.20152016http.maxRequests::2017 How many HTTP requests to launch in parallel. Can be overridden2018 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20192020http.minSessions::2021 The number of curl sessions (counted across slots) to be kept across2022 requests. They will not be ended with curl_easy_cleanup() until2023 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2024 value will be capped at 1. Defaults to 1.20252026http.postBuffer::2027 Maximum size in bytes of the buffer used by smart HTTP2028 transports when POSTing data to the remote system.2029 For requests larger than this buffer size, HTTP/1.1 and2030 Transfer-Encoding: chunked is used to avoid creating a2031 massive pack file locally. Default is 1 MiB, which is2032 sufficient for most requests.20332034http.lowSpeedLimit, http.lowSpeedTime::2035 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2036 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2037 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2038 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20392040http.noEPSV::2041 A boolean which disables using of EPSV ftp command by curl.2042 This can helpful with some "poor" ftp servers which don't2043 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2044 environment variable. Default is false (curl will use EPSV).20452046http.userAgent::2047 The HTTP USER_AGENT string presented to an HTTP server. The default2048 value represents the version of the client Git such as git/1.7.1.2049 This option allows you to override this value to a more common value2050 such as Mozilla/4.0. This may be necessary, for instance, if2051 connecting through a firewall that restricts HTTP connections to a set2052 of common USER_AGENT strings (but not including those like git/1.7.1).2053 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20542055http.followRedirects::2056 Whether git should follow HTTP redirects. If set to `true`, git2057 will transparently follow any redirect issued by a server it2058 encounters. If set to `false`, git will treat all redirects as2059 errors. If set to `initial`, git will follow redirects only for2060 the initial request to a remote, but not for subsequent2061 follow-up HTTP requests. Since git uses the redirected URL as2062 the base for the follow-up requests, this is generally2063 sufficient. The default is `initial`.20642065http.<url>.*::2066 Any of the http.* options above can be applied selectively to some URLs.2067 For a config key to match a URL, each element of the config key is2068 compared to that of the URL, in the following order:2069+2070--2071. Scheme (e.g., `https` in `https://example.com/`). This field2072 must match exactly between the config key and the URL.20732074. Host/domain name (e.g., `example.com` in `https://example.com/`).2075 This field must match between the config key and the URL. It is2076 possible to specify a `*` as part of the host name to match all subdomains2077 at this level. `https://*.example.com/` for example would match2078 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20792080. Port number (e.g., `8080` in `http://example.com:8080/`).2081 This field must match exactly between the config key and the URL.2082 Omitted port numbers are automatically converted to the correct2083 default for the scheme before matching.20842085. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2086 path field of the config key must match the path field of the URL2087 either exactly or as a prefix of slash-delimited path elements. This means2088 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2089 match on a slash (`/`) boundary. Longer matches take precedence (so a config2090 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2091 key with just path `foo/`).20922093. User name (e.g., `user` in `https://user@example.com/repo.git`). If2094 the config key has a user name it must match the user name in the2095 URL exactly. If the config key does not have a user name, that2096 config key will match a URL with any user name (including none),2097 but at a lower precedence than a config key with a user name.2098--2099+2100The list above is ordered by decreasing precedence; a URL that matches2101a config key's path is preferred to one that matches its user name. For example,2102if the URL is `https://user@example.com/foo/bar` a config key match of2103`https://example.com/foo` will be preferred over a config key match of2104`https://user@example.com`.2105+2106All URLs are normalized before attempting any matching (the password part,2107if embedded in the URL, is always ignored for matching purposes) so that2108equivalent URLs that are simply spelled differently will match properly.2109Environment variable settings always override any matches. The URLs that are2110matched against are those given directly to Git commands. This means any URLs2111visited as a result of a redirection do not participate in matching.21122113ssh.variant::2114 By default, Git determines the command line arguments to use2115 based on the basename of the configured SSH command (configured2116 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2117 the config setting `core.sshCommand`). If the basename is2118 unrecognized, Git will attempt to detect support of OpenSSH2119 options by first invoking the configured SSH command with the2120 `-G` (print configuration) option and will subsequently use2121 OpenSSH options (if that is successful) or no options besides2122 the host and remote command (if it fails).2123+2124The config variable `ssh.variant` can be set to override this detection.2125Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2126`tortoiseplink`, `simple` (no options except the host and remote command).2127The default auto-detection can be explicitly requested using the value2128`auto`. Any other value is treated as `ssh`. This setting can also be2129overridden via the environment variable `GIT_SSH_VARIANT`.2130+2131The current command-line parameters used for each variant are as2132follows:2133+2134--21352136* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21372138* `simple` - [username@]host command21392140* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21412142* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21432144--2145+2146Except for the `simple` variant, command-line parameters are likely to2147change as git gains new features.21482149i18n.commitEncoding::2150 Character encoding the commit messages are stored in; Git itself2151 does not care per se, but this information is necessary e.g. when2152 importing commits from emails or in the gitk graphical history2153 browser (and possibly at other places in the future or in other2154 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21552156i18n.logOutputEncoding::2157 Character encoding the commit messages are converted to when2158 running 'git log' and friends.21592160imap::2161 The configuration variables in the 'imap' section are described2162 in linkgit:git-imap-send[1].21632164index.version::2165 Specify the version with which new index files should be2166 initialized. This does not affect existing repositories.21672168init.templateDir::2169 Specify the directory from which templates will be copied.2170 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21712172instaweb.browser::2173 Specify the program that will be used to browse your working2174 repository in gitweb. See linkgit:git-instaweb[1].21752176instaweb.httpd::2177 The HTTP daemon command-line to start gitweb on your working2178 repository. See linkgit:git-instaweb[1].21792180instaweb.local::2181 If true the web server started by linkgit:git-instaweb[1] will2182 be bound to the local IP (127.0.0.1).21832184instaweb.modulePath::2185 The default module path for linkgit:git-instaweb[1] to use2186 instead of /usr/lib/apache2/modules. Only used if httpd2187 is Apache.21882189instaweb.port::2190 The port number to bind the gitweb httpd to. See2191 linkgit:git-instaweb[1].21922193interactive.singleKey::2194 In interactive commands, allow the user to provide one-letter2195 input with a single key (i.e., without hitting enter).2196 Currently this is used by the `--patch` mode of2197 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2198 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2199 setting is silently ignored if portable keystroke input2200 is not available; requires the Perl module Term::ReadKey.22012202interactive.diffFilter::2203 When an interactive command (such as `git add --patch`) shows2204 a colorized diff, git will pipe the diff through the shell2205 command defined by this configuration variable. The command may2206 mark up the diff further for human consumption, provided that it2207 retains a one-to-one correspondence with the lines in the2208 original diff. Defaults to disabled (no filtering).22092210log.abbrevCommit::2211 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2212 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2213 override this option with `--no-abbrev-commit`.22142215log.date::2216 Set the default date-time mode for the 'log' command.2217 Setting a value for log.date is similar to using 'git log''s2218 `--date` option. See linkgit:git-log[1] for details.22192220log.decorate::2221 Print out the ref names of any commits that are shown by the log2222 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2223 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2224 specified, the full ref name (including prefix) will be printed.2225 If 'auto' is specified, then if the output is going to a terminal,2226 the ref names are shown as if 'short' were given, otherwise no ref2227 names are shown. This is the same as the `--decorate` option2228 of the `git log`.22292230log.follow::2231 If `true`, `git log` will act as if the `--follow` option was used when2232 a single <path> is given. This has the same limitations as `--follow`,2233 i.e. it cannot be used to follow multiple files and does not work well2234 on non-linear history.22352236log.graphColors::2237 A list of colors, separated by commas, that can be used to draw2238 history lines in `git log --graph`.22392240log.showRoot::2241 If true, the initial commit will be shown as a big creation event.2242 This is equivalent to a diff against an empty tree.2243 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2244 normally hide the root commit will now show it. True by default.22452246log.showSignature::2247 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2248 linkgit:git-whatchanged[1] assume `--show-signature`.22492250log.mailmap::2251 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2252 linkgit:git-whatchanged[1] assume `--use-mailmap`.22532254mailinfo.scissors::2255 If true, makes linkgit:git-mailinfo[1] (and therefore2256 linkgit:git-am[1]) act by default as if the --scissors option2257 was provided on the command-line. When active, this features2258 removes everything from the message body before a scissors2259 line (i.e. consisting mainly of ">8", "8<" and "-").22602261mailmap.file::2262 The location of an augmenting mailmap file. The default2263 mailmap, located in the root of the repository, is loaded2264 first, then the mailmap file pointed to by this variable.2265 The location of the mailmap file may be in a repository2266 subdirectory, or somewhere outside of the repository itself.2267 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22682269mailmap.blob::2270 Like `mailmap.file`, but consider the value as a reference to a2271 blob in the repository. If both `mailmap.file` and2272 `mailmap.blob` are given, both are parsed, with entries from2273 `mailmap.file` taking precedence. In a bare repository, this2274 defaults to `HEAD:.mailmap`. In a non-bare repository, it2275 defaults to empty.22762277man.viewer::2278 Specify the programs that may be used to display help in the2279 'man' format. See linkgit:git-help[1].22802281man.<tool>.cmd::2282 Specify the command to invoke the specified man viewer. The2283 specified command is evaluated in shell with the man page2284 passed as argument. (See linkgit:git-help[1].)22852286man.<tool>.path::2287 Override the path for the given tool that may be used to2288 display help in the 'man' format. See linkgit:git-help[1].22892290include::merge-config.txt[]22912292mergetool.<tool>.path::2293 Override the path for the given tool. This is useful in case2294 your tool is not in the PATH.22952296mergetool.<tool>.cmd::2297 Specify the command to invoke the specified merge tool. The2298 specified command is evaluated in shell with the following2299 variables available: 'BASE' is the name of a temporary file2300 containing the common base of the files to be merged, if available;2301 'LOCAL' is the name of a temporary file containing the contents of2302 the file on the current branch; 'REMOTE' is the name of a temporary2303 file containing the contents of the file from the branch being2304 merged; 'MERGED' contains the name of the file to which the merge2305 tool should write the results of a successful merge.23062307mergetool.<tool>.trustExitCode::2308 For a custom merge command, specify whether the exit code of2309 the merge command can be used to determine whether the merge was2310 successful. If this is not set to true then the merge target file2311 timestamp is checked and the merge assumed to have been successful2312 if the file has been updated, otherwise the user is prompted to2313 indicate the success of the merge.23142315mergetool.meld.hasOutput::2316 Older versions of `meld` do not support the `--output` option.2317 Git will attempt to detect whether `meld` supports `--output`2318 by inspecting the output of `meld --help`. Configuring2319 `mergetool.meld.hasOutput` will make Git skip these checks and2320 use the configured value instead. Setting `mergetool.meld.hasOutput`2321 to `true` tells Git to unconditionally use the `--output` option,2322 and `false` avoids using `--output`.23232324mergetool.keepBackup::2325 After performing a merge, the original file with conflict markers2326 can be saved as a file with a `.orig` extension. If this variable2327 is set to `false` then this file is not preserved. Defaults to2328 `true` (i.e. keep the backup files).23292330mergetool.keepTemporaries::2331 When invoking a custom merge tool, Git uses a set of temporary2332 files to pass to the tool. If the tool returns an error and this2333 variable is set to `true`, then these temporary files will be2334 preserved, otherwise they will be removed after the tool has2335 exited. Defaults to `false`.23362337mergetool.writeToTemp::2338 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2339 conflicting files in the worktree by default. Git will attempt2340 to use a temporary directory for these files when set `true`.2341 Defaults to `false`.23422343mergetool.prompt::2344 Prompt before each invocation of the merge resolution program.23452346notes.mergeStrategy::2347 Which merge strategy to choose by default when resolving notes2348 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2349 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2350 section of linkgit:git-notes[1] for more information on each strategy.23512352notes.<name>.mergeStrategy::2353 Which merge strategy to choose when doing a notes merge into2354 refs/notes/<name>. This overrides the more general2355 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2356 linkgit:git-notes[1] for more information on the available strategies.23572358notes.displayRef::2359 The (fully qualified) refname from which to show notes when2360 showing commit messages. The value of this variable can be set2361 to a glob, in which case notes from all matching refs will be2362 shown. You may also specify this configuration variable2363 several times. A warning will be issued for refs that do not2364 exist, but a glob that does not match any refs is silently2365 ignored.2366+2367This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2368environment variable, which must be a colon separated list of refs or2369globs.2370+2371The effective value of "core.notesRef" (possibly overridden by2372GIT_NOTES_REF) is also implicitly added to the list of refs to be2373displayed.23742375notes.rewrite.<command>::2376 When rewriting commits with <command> (currently `amend` or2377 `rebase`) and this variable is set to `true`, Git2378 automatically copies your notes from the original to the2379 rewritten commit. Defaults to `true`, but see2380 "notes.rewriteRef" below.23812382notes.rewriteMode::2383 When copying notes during a rewrite (see the2384 "notes.rewrite.<command>" option), determines what to do if2385 the target commit already has a note. Must be one of2386 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2387 Defaults to `concatenate`.2388+2389This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2390environment variable.23912392notes.rewriteRef::2393 When copying notes during a rewrite, specifies the (fully2394 qualified) ref whose notes should be copied. The ref may be a2395 glob, in which case notes in all matching refs will be copied.2396 You may also specify this configuration several times.2397+2398Does not have a default value; you must configure this variable to2399enable note rewriting. Set it to `refs/notes/commits` to enable2400rewriting for the default commit notes.2401+2402This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2403environment variable, which must be a colon separated list of refs or2404globs.24052406pack.window::2407 The size of the window used by linkgit:git-pack-objects[1] when no2408 window size is given on the command line. Defaults to 10.24092410pack.depth::2411 The maximum delta depth used by linkgit:git-pack-objects[1] when no2412 maximum depth is given on the command line. Defaults to 50.24132414pack.windowMemory::2415 The maximum size of memory that is consumed by each thread2416 in linkgit:git-pack-objects[1] for pack window memory when2417 no limit is given on the command line. The value can be2418 suffixed with "k", "m", or "g". When left unconfigured (or2419 set explicitly to 0), there will be no limit.24202421pack.compression::2422 An integer -1..9, indicating the compression level for objects2423 in a pack file. -1 is the zlib default. 0 means no2424 compression, and 1..9 are various speed/size tradeoffs, 9 being2425 slowest. If not set, defaults to core.compression. If that is2426 not set, defaults to -1, the zlib default, which is "a default2427 compromise between speed and compression (currently equivalent2428 to level 6)."2429+2430Note that changing the compression level will not automatically recompress2431all existing objects. You can force recompression by passing the -F option2432to linkgit:git-repack[1].24332434pack.deltaCacheSize::2435 The maximum memory in bytes used for caching deltas in2436 linkgit:git-pack-objects[1] before writing them out to a pack.2437 This cache is used to speed up the writing object phase by not2438 having to recompute the final delta result once the best match2439 for all objects is found. Repacking large repositories on machines2440 which are tight with memory might be badly impacted by this though,2441 especially if this cache pushes the system into swapping.2442 A value of 0 means no limit. The smallest size of 1 byte may be2443 used to virtually disable this cache. Defaults to 256 MiB.24442445pack.deltaCacheLimit::2446 The maximum size of a delta, that is cached in2447 linkgit:git-pack-objects[1]. This cache is used to speed up the2448 writing object phase by not having to recompute the final delta2449 result once the best match for all objects is found. Defaults to 1000.24502451pack.threads::2452 Specifies the number of threads to spawn when searching for best2453 delta matches. This requires that linkgit:git-pack-objects[1]2454 be compiled with pthreads otherwise this option is ignored with a2455 warning. This is meant to reduce packing time on multiprocessor2456 machines. The required amount of memory for the delta search window2457 is however multiplied by the number of threads.2458 Specifying 0 will cause Git to auto-detect the number of CPU's2459 and set the number of threads accordingly.24602461pack.indexVersion::2462 Specify the default pack index version. Valid values are 1 for2463 legacy pack index used by Git versions prior to 1.5.2, and 2 for2464 the new pack index with capabilities for packs larger than 4 GB2465 as well as proper protection against the repacking of corrupted2466 packs. Version 2 is the default. Note that version 2 is enforced2467 and this config option ignored whenever the corresponding pack is2468 larger than 2 GB.2469+2470If you have an old Git that does not understand the version 2 `*.idx` file,2471cloning or fetching over a non native protocol (e.g. "http")2472that will copy both `*.pack` file and corresponding `*.idx` file from the2473other side may give you a repository that cannot be accessed with your2474older version of Git. If the `*.pack` file is smaller than 2 GB, however,2475you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2476the `*.idx` file.24772478pack.packSizeLimit::2479 The maximum size of a pack. This setting only affects2480 packing to a file when repacking, i.e. the git:// protocol2481 is unaffected. It can be overridden by the `--max-pack-size`2482 option of linkgit:git-repack[1]. Reaching this limit results2483 in the creation of multiple packfiles; which in turn prevents2484 bitmaps from being created.2485 The minimum size allowed is limited to 1 MiB.2486 The default is unlimited.2487 Common unit suffixes of 'k', 'm', or 'g' are2488 supported.24892490pack.useBitmaps::2491 When true, git will use pack bitmaps (if available) when packing2492 to stdout (e.g., during the server side of a fetch). Defaults to2493 true. You should not generally need to turn this off unless2494 you are debugging pack bitmaps.24952496pack.writeBitmaps (deprecated)::2497 This is a deprecated synonym for `repack.writeBitmaps`.24982499pack.writeBitmapHashCache::2500 When true, git will include a "hash cache" section in the bitmap2501 index (if one is written). This cache can be used to feed git's2502 delta heuristics, potentially leading to better deltas between2503 bitmapped and non-bitmapped objects (e.g., when serving a fetch2504 between an older, bitmapped pack and objects that have been2505 pushed since the last gc). The downside is that it consumes 42506 bytes per object of disk space, and that JGit's bitmap2507 implementation does not understand it, causing it to complain if2508 Git and JGit are used on the same repository. Defaults to false.25092510pager.<cmd>::2511 If the value is boolean, turns on or off pagination of the2512 output of a particular Git subcommand when writing to a tty.2513 Otherwise, turns on pagination for the subcommand using the2514 pager specified by the value of `pager.<cmd>`. If `--paginate`2515 or `--no-pager` is specified on the command line, it takes2516 precedence over this option. To disable pagination for all2517 commands, set `core.pager` or `GIT_PAGER` to `cat`.25182519pretty.<name>::2520 Alias for a --pretty= format string, as specified in2521 linkgit:git-log[1]. Any aliases defined here can be used just2522 as the built-in pretty formats could. For example,2523 running `git config pretty.changelog "format:* %H %s"`2524 would cause the invocation `git log --pretty=changelog`2525 to be equivalent to running `git log "--pretty=format:* %H %s"`.2526 Note that an alias with the same name as a built-in format2527 will be silently ignored.25282529protocol.allow::2530 If set, provide a user defined default policy for all protocols which2531 don't explicitly have a policy (`protocol.<name>.allow`). By default,2532 if unset, known-safe protocols (http, https, git, ssh, file) have a2533 default policy of `always`, known-dangerous protocols (ext) have a2534 default policy of `never`, and all other protocols have a default2535 policy of `user`. Supported policies:2536+2537--25382539* `always` - protocol is always able to be used.25402541* `never` - protocol is never able to be used.25422543* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2544 either unset or has a value of 1. This policy should be used when you want a2545 protocol to be directly usable by the user but don't want it used by commands which2546 execute clone/fetch/push commands without user input, e.g. recursive2547 submodule initialization.25482549--25502551protocol.<name>.allow::2552 Set a policy to be used by protocol `<name>` with clone/fetch/push2553 commands. See `protocol.allow` above for the available policies.2554+2555The protocol names currently used by git are:2556+2557--2558 - `file`: any local file-based path (including `file://` URLs,2559 or local paths)25602561 - `git`: the anonymous git protocol over a direct TCP2562 connection (or proxy, if configured)25632564 - `ssh`: git over ssh (including `host:path` syntax,2565 `ssh://`, etc).25662567 - `http`: git over http, both "smart http" and "dumb http".2568 Note that this does _not_ include `https`; if you want to configure2569 both, you must do so individually.25702571 - any external helpers are named by their protocol (e.g., use2572 `hg` to allow the `git-remote-hg` helper)2573--25742575protocol.version::2576 Experimental. If set, clients will attempt to communicate with a2577 server using the specified protocol version. If unset, no2578 attempt will be made by the client to communicate using a2579 particular protocol version, this results in protocol version 02580 being used.2581 Supported versions:2582+2583--25842585* `0` - the original wire protocol.25862587* `1` - the original wire protocol with the addition of a version string2588 in the initial response from the server.25892590--25912592pull.ff::2593 By default, Git does not create an extra merge commit when merging2594 a commit that is a descendant of the current commit. Instead, the2595 tip of the current branch is fast-forwarded. When set to `false`,2596 this variable tells Git to create an extra merge commit in such2597 a case (equivalent to giving the `--no-ff` option from the command2598 line). When set to `only`, only such fast-forward merges are2599 allowed (equivalent to giving the `--ff-only` option from the2600 command line). This setting overrides `merge.ff` when pulling.26012602pull.rebase::2603 When true, rebase branches on top of the fetched branch, instead2604 of merging the default branch from the default remote when "git2605 pull" is run. See "branch.<name>.rebase" for setting this on a2606 per-branch basis.2607+2608When preserve, also pass `--preserve-merges` along to 'git rebase'2609so that locally committed merge commits will not be flattened2610by running 'git pull'.2611+2612When the value is `interactive`, the rebase is run in interactive mode.2613+2614*NOTE*: this is a possibly dangerous operation; do *not* use2615it unless you understand the implications (see linkgit:git-rebase[1]2616for details).26172618pull.octopus::2619 The default merge strategy to use when pulling multiple branches2620 at once.26212622pull.twohead::2623 The default merge strategy to use when pulling a single branch.26242625push.default::2626 Defines the action `git push` should take if no refspec is2627 explicitly given. Different values are well-suited for2628 specific workflows; for instance, in a purely central workflow2629 (i.e. the fetch source is equal to the push destination),2630 `upstream` is probably what you want. Possible values are:2631+2632--26332634* `nothing` - do not push anything (error out) unless a refspec is2635 explicitly given. This is primarily meant for people who want to2636 avoid mistakes by always being explicit.26372638* `current` - push the current branch to update a branch with the same2639 name on the receiving end. Works in both central and non-central2640 workflows.26412642* `upstream` - push the current branch back to the branch whose2643 changes are usually integrated into the current branch (which is2644 called `@{upstream}`). This mode only makes sense if you are2645 pushing to the same repository you would normally pull from2646 (i.e. central workflow).26472648* `tracking` - This is a deprecated synonym for `upstream`.26492650* `simple` - in centralized workflow, work like `upstream` with an2651 added safety to refuse to push if the upstream branch's name is2652 different from the local one.2653+2654When pushing to a remote that is different from the remote you normally2655pull from, work as `current`. This is the safest option and is suited2656for beginners.2657+2658This mode has become the default in Git 2.0.26592660* `matching` - push all branches having the same name on both ends.2661 This makes the repository you are pushing to remember the set of2662 branches that will be pushed out (e.g. if you always push 'maint'2663 and 'master' there and no other branches, the repository you push2664 to will have these two branches, and your local 'maint' and2665 'master' will be pushed there).2666+2667To use this mode effectively, you have to make sure _all_ the2668branches you would push out are ready to be pushed out before2669running 'git push', as the whole point of this mode is to allow you2670to push all of the branches in one go. If you usually finish work2671on only one branch and push out the result, while other branches are2672unfinished, this mode is not for you. Also this mode is not2673suitable for pushing into a shared central repository, as other2674people may add new branches there, or update the tip of existing2675branches outside your control.2676+2677This used to be the default, but not since Git 2.0 (`simple` is the2678new default).26792680--26812682push.followTags::2683 If set to true enable `--follow-tags` option by default. You2684 may override this configuration at time of push by specifying2685 `--no-follow-tags`.26862687push.gpgSign::2688 May be set to a boolean value, or the string 'if-asked'. A true2689 value causes all pushes to be GPG signed, as if `--signed` is2690 passed to linkgit:git-push[1]. The string 'if-asked' causes2691 pushes to be signed if the server supports it, as if2692 `--signed=if-asked` is passed to 'git push'. A false value may2693 override a value from a lower-priority config file. An explicit2694 command-line flag always overrides this config option.26952696push.pushOption::2697 When no `--push-option=<option>` argument is given from the2698 command line, `git push` behaves as if each <value> of2699 this variable is given as `--push-option=<value>`.2700+2701This is a multi-valued variable, and an empty value can be used in a2702higher priority configuration file (e.g. `.git/config` in a2703repository) to clear the values inherited from a lower priority2704configuration files (e.g. `$HOME/.gitconfig`).2705+2706--27072708Example:27092710/etc/gitconfig2711 push.pushoption = a2712 push.pushoption = b27132714~/.gitconfig2715 push.pushoption = c27162717repo/.git/config2718 push.pushoption =2719 push.pushoption = b27202721This will result in only b (a and c are cleared).27222723--27242725push.recurseSubmodules::2726 Make sure all submodule commits used by the revisions to be pushed2727 are available on a remote-tracking branch. If the value is 'check'2728 then Git will verify that all submodule commits that changed in the2729 revisions to be pushed are available on at least one remote of the2730 submodule. If any commits are missing, the push will be aborted and2731 exit with non-zero status. If the value is 'on-demand' then all2732 submodules that changed in the revisions to be pushed will be2733 pushed. If on-demand was not able to push all necessary revisions2734 it will also be aborted and exit with non-zero status. If the value2735 is 'no' then default behavior of ignoring submodules when pushing2736 is retained. You may override this configuration at time of push by2737 specifying '--recurse-submodules=check|on-demand|no'.27382739include::rebase-config.txt[]27402741receive.advertiseAtomic::2742 By default, git-receive-pack will advertise the atomic push2743 capability to its clients. If you don't want to advertise this2744 capability, set this variable to false.27452746receive.advertisePushOptions::2747 When set to true, git-receive-pack will advertise the push options2748 capability to its clients. False by default.27492750receive.autogc::2751 By default, git-receive-pack will run "git-gc --auto" after2752 receiving data from git-push and updating refs. You can stop2753 it by setting this variable to false.27542755receive.certNonceSeed::2756 By setting this variable to a string, `git receive-pack`2757 will accept a `git push --signed` and verifies it by using2758 a "nonce" protected by HMAC using this string as a secret2759 key.27602761receive.certNonceSlop::2762 When a `git push --signed` sent a push certificate with a2763 "nonce" that was issued by a receive-pack serving the same2764 repository within this many seconds, export the "nonce"2765 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2766 hooks (instead of what the receive-pack asked the sending2767 side to include). This may allow writing checks in2768 `pre-receive` and `post-receive` a bit easier. Instead of2769 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2770 that records by how many seconds the nonce is stale to2771 decide if they want to accept the certificate, they only2772 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27732774receive.fsckObjects::2775 If it is set to true, git-receive-pack will check all received2776 objects. It will abort in the case of a malformed object or a2777 broken link. The result of an abort are only dangling objects.2778 Defaults to false. If not set, the value of `transfer.fsckObjects`2779 is used instead.27802781receive.fsck.<msg-id>::2782 When `receive.fsckObjects` is set to true, errors can be switched2783 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2784 setting where the `<msg-id>` is the fsck message ID and the value2785 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2786 the error/warning with the message ID, e.g. "missingEmail: invalid2787 author/committer line - missing email" means that setting2788 `receive.fsck.missingEmail = ignore` will hide that issue.2789+2790This feature is intended to support working with legacy repositories2791which would not pass pushing when `receive.fsckObjects = true`, allowing2792the host to accept repositories with certain known issues but still catch2793other issues.27942795receive.fsck.skipList::2796 The path to a sorted list of object names (i.e. one SHA-1 per2797 line) that are known to be broken in a non-fatal way and should2798 be ignored. This feature is useful when an established project2799 should be accepted despite early commits containing errors that2800 can be safely ignored such as invalid committer email addresses.2801 Note: corrupt objects cannot be skipped with this setting.28022803receive.keepAlive::2804 After receiving the pack from the client, `receive-pack` may2805 produce no output (if `--quiet` was specified) while processing2806 the pack, causing some networks to drop the TCP connection.2807 With this option set, if `receive-pack` does not transmit2808 any data in this phase for `receive.keepAlive` seconds, it will2809 send a short keepalive packet. The default is 5 seconds; set2810 to 0 to disable keepalives entirely.28112812receive.unpackLimit::2813 If the number of objects received in a push is below this2814 limit then the objects will be unpacked into loose object2815 files. However if the number of received objects equals or2816 exceeds this limit then the received pack will be stored as2817 a pack, after adding any missing delta bases. Storing the2818 pack from a push can make the push operation complete faster,2819 especially on slow filesystems. If not set, the value of2820 `transfer.unpackLimit` is used instead.28212822receive.maxInputSize::2823 If the size of the incoming pack stream is larger than this2824 limit, then git-receive-pack will error out, instead of2825 accepting the pack file. If not set or set to 0, then the size2826 is unlimited.28272828receive.denyDeletes::2829 If set to true, git-receive-pack will deny a ref update that deletes2830 the ref. Use this to prevent such a ref deletion via a push.28312832receive.denyDeleteCurrent::2833 If set to true, git-receive-pack will deny a ref update that2834 deletes the currently checked out branch of a non-bare repository.28352836receive.denyCurrentBranch::2837 If set to true or "refuse", git-receive-pack will deny a ref update2838 to the currently checked out branch of a non-bare repository.2839 Such a push is potentially dangerous because it brings the HEAD2840 out of sync with the index and working tree. If set to "warn",2841 print a warning of such a push to stderr, but allow the push to2842 proceed. If set to false or "ignore", allow such pushes with no2843 message. Defaults to "refuse".2844+2845Another option is "updateInstead" which will update the working2846tree if pushing into the current branch. This option is2847intended for synchronizing working directories when one side is not easily2848accessible via interactive ssh (e.g. a live web site, hence the requirement2849that the working directory be clean). This mode also comes in handy when2850developing inside a VM to test and fix code on different Operating Systems.2851+2852By default, "updateInstead" will refuse the push if the working tree or2853the index have any difference from the HEAD, but the `push-to-checkout`2854hook can be used to customize this. See linkgit:githooks[5].28552856receive.denyNonFastForwards::2857 If set to true, git-receive-pack will deny a ref update which is2858 not a fast-forward. Use this to prevent such an update via a push,2859 even if that push is forced. This configuration variable is2860 set when initializing a shared repository.28612862receive.hideRefs::2863 This variable is the same as `transfer.hideRefs`, but applies2864 only to `receive-pack` (and so affects pushes, but not fetches).2865 An attempt to update or delete a hidden ref by `git push` is2866 rejected.28672868receive.updateServerInfo::2869 If set to true, git-receive-pack will run git-update-server-info2870 after receiving data from git-push and updating refs.28712872receive.shallowUpdate::2873 If set to true, .git/shallow can be updated when new refs2874 require new shallow roots. Otherwise those refs are rejected.28752876remote.pushDefault::2877 The remote to push to by default. Overrides2878 `branch.<name>.remote` for all branches, and is overridden by2879 `branch.<name>.pushRemote` for specific branches.28802881remote.<name>.url::2882 The URL of a remote repository. See linkgit:git-fetch[1] or2883 linkgit:git-push[1].28842885remote.<name>.pushurl::2886 The push URL of a remote repository. See linkgit:git-push[1].28872888remote.<name>.proxy::2889 For remotes that require curl (http, https and ftp), the URL to2890 the proxy to use for that remote. Set to the empty string to2891 disable proxying for that remote.28922893remote.<name>.proxyAuthMethod::2894 For remotes that require curl (http, https and ftp), the method to use for2895 authenticating against the proxy in use (probably set in2896 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28972898remote.<name>.fetch::2899 The default set of "refspec" for linkgit:git-fetch[1]. See2900 linkgit:git-fetch[1].29012902remote.<name>.push::2903 The default set of "refspec" for linkgit:git-push[1]. See2904 linkgit:git-push[1].29052906remote.<name>.mirror::2907 If true, pushing to this remote will automatically behave2908 as if the `--mirror` option was given on the command line.29092910remote.<name>.skipDefaultUpdate::2911 If true, this remote will be skipped by default when updating2912 using linkgit:git-fetch[1] or the `update` subcommand of2913 linkgit:git-remote[1].29142915remote.<name>.skipFetchAll::2916 If true, this remote will be skipped by default when updating2917 using linkgit:git-fetch[1] or the `update` subcommand of2918 linkgit:git-remote[1].29192920remote.<name>.receivepack::2921 The default program to execute on the remote side when pushing. See2922 option --receive-pack of linkgit:git-push[1].29232924remote.<name>.uploadpack::2925 The default program to execute on the remote side when fetching. See2926 option --upload-pack of linkgit:git-fetch-pack[1].29272928remote.<name>.tagOpt::2929 Setting this value to --no-tags disables automatic tag following when2930 fetching from remote <name>. Setting it to --tags will fetch every2931 tag from remote <name>, even if they are not reachable from remote2932 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2933 override this setting. See options --tags and --no-tags of2934 linkgit:git-fetch[1].29352936remote.<name>.vcs::2937 Setting this to a value <vcs> will cause Git to interact with2938 the remote with the git-remote-<vcs> helper.29392940remote.<name>.prune::2941 When set to true, fetching from this remote by default will also2942 remove any remote-tracking references that no longer exist on the2943 remote (as if the `--prune` option was given on the command line).2944 Overrides `fetch.prune` settings, if any.29452946remotes.<group>::2947 The list of remotes which are fetched by "git remote update2948 <group>". See linkgit:git-remote[1].29492950repack.useDeltaBaseOffset::2951 By default, linkgit:git-repack[1] creates packs that use2952 delta-base offset. If you need to share your repository with2953 Git older than version 1.4.4, either directly or via a dumb2954 protocol such as http, then you need to set this option to2955 "false" and repack. Access from old Git versions over the2956 native protocol are unaffected by this option.29572958repack.packKeptObjects::2959 If set to true, makes `git repack` act as if2960 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2961 details. Defaults to `false` normally, but `true` if a bitmap2962 index is being written (either via `--write-bitmap-index` or2963 `repack.writeBitmaps`).29642965repack.writeBitmaps::2966 When true, git will write a bitmap index when packing all2967 objects to disk (e.g., when `git repack -a` is run). This2968 index can speed up the "counting objects" phase of subsequent2969 packs created for clones and fetches, at the cost of some disk2970 space and extra time spent on the initial repack. This has2971 no effect if multiple packfiles are created.2972 Defaults to false.29732974rerere.autoUpdate::2975 When set to true, `git-rerere` updates the index with the2976 resulting contents after it cleanly resolves conflicts using2977 previously recorded resolution. Defaults to false.29782979rerere.enabled::2980 Activate recording of resolved conflicts, so that identical2981 conflict hunks can be resolved automatically, should they be2982 encountered again. By default, linkgit:git-rerere[1] is2983 enabled if there is an `rr-cache` directory under the2984 `$GIT_DIR`, e.g. if "rerere" was previously used in the2985 repository.29862987sendemail.identity::2988 A configuration identity. When given, causes values in the2989 'sendemail.<identity>' subsection to take precedence over2990 values in the 'sendemail' section. The default identity is2991 the value of `sendemail.identity`.29922993sendemail.smtpEncryption::2994 See linkgit:git-send-email[1] for description. Note that this2995 setting is not subject to the 'identity' mechanism.29962997sendemail.smtpssl (deprecated)::2998 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29993000sendemail.smtpsslcertpath::3001 Path to ca-certificates (either a directory or a single file).3002 Set it to an empty string to disable certificate verification.30033004sendemail.<identity>.*::3005 Identity-specific versions of the 'sendemail.*' parameters3006 found below, taking precedence over those when this3007 identity is selected, through either the command-line or3008 `sendemail.identity`.30093010sendemail.aliasesFile::3011sendemail.aliasFileType::3012sendemail.annotate::3013sendemail.bcc::3014sendemail.cc::3015sendemail.ccCmd::3016sendemail.chainReplyTo::3017sendemail.confirm::3018sendemail.envelopeSender::3019sendemail.from::3020sendemail.multiEdit::3021sendemail.signedoffbycc::3022sendemail.smtpPass::3023sendemail.suppresscc::3024sendemail.suppressFrom::3025sendemail.to::3026sendemail.tocmd::3027sendemail.smtpDomain::3028sendemail.smtpServer::3029sendemail.smtpServerPort::3030sendemail.smtpServerOption::3031sendemail.smtpUser::3032sendemail.thread::3033sendemail.transferEncoding::3034sendemail.validate::3035sendemail.xmailer::3036 See linkgit:git-send-email[1] for description.30373038sendemail.signedoffcc (deprecated)::3039 Deprecated alias for `sendemail.signedoffbycc`.30403041sendemail.smtpBatchSize::3042 Number of messages to be sent per connection, after that a relogin3043 will happen. If the value is 0 or undefined, send all messages in3044 one connection.3045 See also the `--batch-size` option of linkgit:git-send-email[1].30463047sendemail.smtpReloginDelay::3048 Seconds wait before reconnecting to smtp server.3049 See also the `--relogin-delay` option of linkgit:git-send-email[1].30503051showbranch.default::3052 The default set of branches for linkgit:git-show-branch[1].3053 See linkgit:git-show-branch[1].30543055splitIndex.maxPercentChange::3056 When the split index feature is used, this specifies the3057 percent of entries the split index can contain compared to the3058 total number of entries in both the split index and the shared3059 index before a new shared index is written.3060 The value should be between 0 and 100. If the value is 0 then3061 a new shared index is always written, if it is 100 a new3062 shared index is never written.3063 By default the value is 20, so a new shared index is written3064 if the number of entries in the split index would be greater3065 than 20 percent of the total number of entries.3066 See linkgit:git-update-index[1].30673068splitIndex.sharedIndexExpire::3069 When the split index feature is used, shared index files that3070 were not modified since the time this variable specifies will3071 be removed when a new shared index file is created. The value3072 "now" expires all entries immediately, and "never" suppresses3073 expiration altogether.3074 The default value is "2.weeks.ago".3075 Note that a shared index file is considered modified (for the3076 purpose of expiration) each time a new split-index file is3077 either created based on it or read from it.3078 See linkgit:git-update-index[1].30793080status.relativePaths::3081 By default, linkgit:git-status[1] shows paths relative to the3082 current directory. Setting this variable to `false` shows paths3083 relative to the repository root (this was the default for Git3084 prior to v1.5.4).30853086status.short::3087 Set to true to enable --short by default in linkgit:git-status[1].3088 The option --no-short takes precedence over this variable.30893090status.branch::3091 Set to true to enable --branch by default in linkgit:git-status[1].3092 The option --no-branch takes precedence over this variable.30933094status.displayCommentPrefix::3095 If set to true, linkgit:git-status[1] will insert a comment3096 prefix before each output line (starting with3097 `core.commentChar`, i.e. `#` by default). This was the3098 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3099 Defaults to false.31003101status.showStash::3102 If set to true, linkgit:git-status[1] will display the number of3103 entries currently stashed away.3104 Defaults to false.31053106status.showUntrackedFiles::3107 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3108 files which are not currently tracked by Git. Directories which3109 contain only untracked files, are shown with the directory name3110 only. Showing untracked files means that Git needs to lstat() all3111 the files in the whole repository, which might be slow on some3112 systems. So, this variable controls how the commands displays3113 the untracked files. Possible values are:3114+3115--3116* `no` - Show no untracked files.3117* `normal` - Show untracked files and directories.3118* `all` - Show also individual files in untracked directories.3119--3120+3121If this variable is not specified, it defaults to 'normal'.3122This variable can be overridden with the -u|--untracked-files option3123of linkgit:git-status[1] and linkgit:git-commit[1].31243125status.submoduleSummary::3126 Defaults to false.3127 If this is set to a non zero number or true (identical to -1 or an3128 unlimited number), the submodule summary will be enabled and a3129 summary of commits for modified submodules will be shown (see3130 --summary-limit option of linkgit:git-submodule[1]). Please note3131 that the summary output command will be suppressed for all3132 submodules when `diff.ignoreSubmodules` is set to 'all' or only3133 for those submodules where `submodule.<name>.ignore=all`. The only3134 exception to that rule is that status and commit will show staged3135 submodule changes. To3136 also view the summary for ignored submodules you can either use3137 the --ignore-submodules=dirty command-line option or the 'git3138 submodule summary' command, which shows a similar output but does3139 not honor these settings.31403141stash.showPatch::3142 If this is set to true, the `git stash show` command without an3143 option will show the stash entry in patch form. Defaults to false.3144 See description of 'show' command in linkgit:git-stash[1].31453146stash.showStat::3147 If this is set to true, the `git stash show` command without an3148 option will show diffstat of the stash entry. Defaults to true.3149 See description of 'show' command in linkgit:git-stash[1].31503151submodule.<name>.url::3152 The URL for a submodule. This variable is copied from the .gitmodules3153 file to the git config via 'git submodule init'. The user can change3154 the configured URL before obtaining the submodule via 'git submodule3155 update'. If neither submodule.<name>.active or submodule.active are3156 set, the presence of this variable is used as a fallback to indicate3157 whether the submodule is of interest to git commands.3158 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31593160submodule.<name>.update::3161 The method by which a submodule is updated by 'git submodule update',3162 which is the only affected command, others such as3163 'git checkout --recurse-submodules' are unaffected. It exists for3164 historical reasons, when 'git submodule' was the only command to3165 interact with submodules; settings like `submodule.active`3166 and `pull.rebase` are more specific. It is populated by3167 `git submodule init` from the linkgit:gitmodules[5] file.3168 See description of 'update' command in linkgit:git-submodule[1].31693170submodule.<name>.branch::3171 The remote branch name for a submodule, used by `git submodule3172 update --remote`. Set this option to override the value found in3173 the `.gitmodules` file. See linkgit:git-submodule[1] and3174 linkgit:gitmodules[5] for details.31753176submodule.<name>.fetchRecurseSubmodules::3177 This option can be used to control recursive fetching of this3178 submodule. It can be overridden by using the --[no-]recurse-submodules3179 command-line option to "git fetch" and "git pull".3180 This setting will override that from in the linkgit:gitmodules[5]3181 file.31823183submodule.<name>.ignore::3184 Defines under what circumstances "git status" and the diff family show3185 a submodule as modified. When set to "all", it will never be considered3186 modified (but it will nonetheless show up in the output of status and3187 commit when it has been staged), "dirty" will ignore all changes3188 to the submodules work tree and3189 takes only differences between the HEAD of the submodule and the commit3190 recorded in the superproject into account. "untracked" will additionally3191 let submodules with modified tracked files in their work tree show up.3192 Using "none" (the default when this option is not set) also shows3193 submodules that have untracked files in their work tree as changed.3194 This setting overrides any setting made in .gitmodules for this submodule,3195 both settings can be overridden on the command line by using the3196 "--ignore-submodules" option. The 'git submodule' commands are not3197 affected by this setting.31983199submodule.<name>.active::3200 Boolean value indicating if the submodule is of interest to git3201 commands. This config option takes precedence over the3202 submodule.active config option.32033204submodule.active::3205 A repeated field which contains a pathspec used to match against a3206 submodule's path to determine if the submodule is of interest to git3207 commands.32083209submodule.recurse::3210 Specifies if commands recurse into submodules by default. This3211 applies to all commands that have a `--recurse-submodules` option.3212 Defaults to false.32133214submodule.fetchJobs::3215 Specifies how many submodules are fetched/cloned at the same time.3216 A positive integer allows up to that number of submodules fetched3217 in parallel. A value of 0 will give some reasonable default.3218 If unset, it defaults to 1.32193220submodule.alternateLocation::3221 Specifies how the submodules obtain alternates when submodules are3222 cloned. Possible values are `no`, `superproject`.3223 By default `no` is assumed, which doesn't add references. When the3224 value is set to `superproject` the submodule to be cloned computes3225 its alternates location relative to the superprojects alternate.32263227submodule.alternateErrorStrategy::3228 Specifies how to treat errors with the alternates for a submodule3229 as computed via `submodule.alternateLocation`. Possible values are3230 `ignore`, `info`, `die`. Default is `die`.32313232tag.forceSignAnnotated::3233 A boolean to specify whether annotated tags created should be GPG signed.3234 If `--annotate` is specified on the command line, it takes3235 precedence over this option.32363237tag.sort::3238 This variable controls the sort ordering of tags when displayed by3239 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3240 value of this variable will be used as the default.32413242tar.umask::3243 This variable can be used to restrict the permission bits of3244 tar archive entries. The default is 0002, which turns off the3245 world write bit. The special value "user" indicates that the3246 archiving user's umask will be used instead. See umask(2) and3247 linkgit:git-archive[1].32483249transfer.fsckObjects::3250 When `fetch.fsckObjects` or `receive.fsckObjects` are3251 not set, the value of this variable is used instead.3252 Defaults to false.32533254transfer.hideRefs::3255 String(s) `receive-pack` and `upload-pack` use to decide which3256 refs to omit from their initial advertisements. Use more than3257 one definition to specify multiple prefix strings. A ref that is3258 under the hierarchies listed in the value of this variable is3259 excluded, and is hidden when responding to `git push` or `git3260 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3261 program-specific versions of this config.3262+3263You may also include a `!` in front of the ref name to negate the entry,3264explicitly exposing it, even if an earlier entry marked it as hidden.3265If you have multiple hideRefs values, later entries override earlier ones3266(and entries in more-specific config files override less-specific ones).3267+3268If a namespace is in use, the namespace prefix is stripped from each3269reference before it is matched against `transfer.hiderefs` patterns.3270For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3271the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3272is omitted from the advertisements but `refs/heads/master` and3273`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3274"have" lines. In order to match refs before stripping, add a `^` in front of3275the ref name. If you combine `!` and `^`, `!` must be specified first.3276+3277Even if you hide refs, a client may still be able to steal the target3278objects via the techniques described in the "SECURITY" section of the3279linkgit:gitnamespaces[7] man page; it's best to keep private data in a3280separate repository.32813282transfer.unpackLimit::3283 When `fetch.unpackLimit` or `receive.unpackLimit` are3284 not set, the value of this variable is used instead.3285 The default value is 100.32863287uploadarchive.allowUnreachable::3288 If true, allow clients to use `git archive --remote` to request3289 any tree, whether reachable from the ref tips or not. See the3290 discussion in the "SECURITY" section of3291 linkgit:git-upload-archive[1] for more details. Defaults to3292 `false`.32933294uploadpack.hideRefs::3295 This variable is the same as `transfer.hideRefs`, but applies3296 only to `upload-pack` (and so affects only fetches, not pushes).3297 An attempt to fetch a hidden ref by `git fetch` will fail. See3298 also `uploadpack.allowTipSHA1InWant`.32993300uploadpack.allowTipSHA1InWant::3301 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3302 to accept a fetch request that asks for an object at the tip3303 of a hidden ref (by default, such a request is rejected).3304 See also `uploadpack.hideRefs`. Even if this is false, a client3305 may be able to steal objects via the techniques described in the3306 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3307 best to keep private data in a separate repository.33083309uploadpack.allowReachableSHA1InWant::3310 Allow `upload-pack` to accept a fetch request that asks for an3311 object that is reachable from any ref tip. However, note that3312 calculating object reachability is computationally expensive.3313 Defaults to `false`. Even if this is false, a client may be able3314 to steal objects via the techniques described in the "SECURITY"3315 section of the linkgit:gitnamespaces[7] man page; it's best to3316 keep private data in a separate repository.33173318uploadpack.allowAnySHA1InWant::3319 Allow `upload-pack` to accept a fetch request that asks for any3320 object at all.3321 Defaults to `false`.33223323uploadpack.keepAlive::3324 When `upload-pack` has started `pack-objects`, there may be a3325 quiet period while `pack-objects` prepares the pack. Normally3326 it would output progress information, but if `--quiet` was used3327 for the fetch, `pack-objects` will output nothing at all until3328 the pack data begins. Some clients and networks may consider3329 the server to be hung and give up. Setting this option instructs3330 `upload-pack` to send an empty keepalive packet every3331 `uploadpack.keepAlive` seconds. Setting this option to 03332 disables keepalive packets entirely. The default is 5 seconds.33333334uploadpack.packObjectsHook::3335 If this option is set, when `upload-pack` would run3336 `git pack-objects` to create a packfile for a client, it will3337 run this shell command instead. The `pack-objects` command and3338 arguments it _would_ have run (including the `git pack-objects`3339 at the beginning) are appended to the shell command. The stdin3340 and stdout of the hook are treated as if `pack-objects` itself3341 was run. I.e., `upload-pack` will feed input intended for3342 `pack-objects` to the hook, and expects a completed packfile on3343 stdout.3344+3345Note that this configuration variable is ignored if it is seen in the3346repository-level config (this is a safety measure against fetching from3347untrusted repositories).33483349url.<base>.insteadOf::3350 Any URL that starts with this value will be rewritten to3351 start, instead, with <base>. In cases where some site serves a3352 large number of repositories, and serves them with multiple3353 access methods, and some users need to use different access3354 methods, this feature allows people to specify any of the3355 equivalent URLs and have Git automatically rewrite the URL to3356 the best alternative for the particular user, even for a3357 never-before-seen repository on the site. When more than one3358 insteadOf strings match a given URL, the longest match is used.3359+3360Note that any protocol restrictions will be applied to the rewritten3361URL. If the rewrite changes the URL to use a custom protocol or remote3362helper, you may need to adjust the `protocol.*.allow` config to permit3363the request. In particular, protocols you expect to use for submodules3364must be set to `always` rather than the default of `user`. See the3365description of `protocol.allow` above.33663367url.<base>.pushInsteadOf::3368 Any URL that starts with this value will not be pushed to;3369 instead, it will be rewritten to start with <base>, and the3370 resulting URL will be pushed to. In cases where some site serves3371 a large number of repositories, and serves them with multiple3372 access methods, some of which do not allow push, this feature3373 allows people to specify a pull-only URL and have Git3374 automatically use an appropriate URL to push, even for a3375 never-before-seen repository on the site. When more than one3376 pushInsteadOf strings match a given URL, the longest match is3377 used. If a remote has an explicit pushurl, Git will ignore this3378 setting for that remote.33793380user.email::3381 Your email address to be recorded in any newly created commits.3382 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3383 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33843385user.name::3386 Your full name to be recorded in any newly created commits.3387 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3388 environment variables. See linkgit:git-commit-tree[1].33893390user.useConfigOnly::3391 Instruct Git to avoid trying to guess defaults for `user.email`3392 and `user.name`, and instead retrieve the values only from the3393 configuration. For example, if you have multiple email addresses3394 and would like to use a different one for each repository, then3395 with this configuration option set to `true` in the global config3396 along with a name, Git will prompt you to set up an email before3397 making new commits in a newly cloned repository.3398 Defaults to `false`.33993400user.signingKey::3401 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3402 key you want it to automatically when creating a signed tag or3403 commit, you can override the default selection with this variable.3404 This option is passed unchanged to gpg's --local-user parameter,3405 so you may specify a key using any method that gpg supports.34063407versionsort.prereleaseSuffix (deprecated)::3408 Deprecated alias for `versionsort.suffix`. Ignored if3409 `versionsort.suffix` is set.34103411versionsort.suffix::3412 Even when version sort is used in linkgit:git-tag[1], tagnames3413 with the same base version but different suffixes are still sorted3414 lexicographically, resulting e.g. in prerelease tags appearing3415 after the main release (e.g. "1.0-rc1" after "1.0"). This3416 variable can be specified to determine the sorting order of tags3417 with different suffixes.3418+3419By specifying a single suffix in this variable, any tagname containing3420that suffix will appear before the corresponding main release. E.g. if3421the variable is set to "-rc", then all "1.0-rcX" tags will appear before3422"1.0". If specified multiple times, once per suffix, then the order of3423suffixes in the configuration will determine the sorting order of tagnames3424with those suffixes. E.g. if "-pre" appears before "-rc" in the3425configuration, then all "1.0-preX" tags will be listed before any3426"1.0-rcX" tags. The placement of the main release tag relative to tags3427with various suffixes can be determined by specifying the empty suffix3428among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3429"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3430are listed first, followed by "v4.8", then "v4.8-ckX" and finally3431"v4.8-bfsX".3432+3433If more than one suffixes match the same tagname, then that tagname will3434be sorted according to the suffix which starts at the earliest position in3435the tagname. If more than one different matching suffixes start at3436that earliest position, then that tagname will be sorted according to the3437longest of those suffixes.3438The sorting order between different suffixes is undefined if they are3439in multiple config files.34403441web.browser::3442 Specify a web browser that may be used by some commands.3443 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3444 may use it.34453446worktree.guessRemote::3447 With `add`, if no branch argument, and neither of `-b` nor3448 `-B` nor `--detach` are given, the command defaults to3449 creating a new branch from HEAD. If `worktree.guessRemote` is3450 set to true, `worktree add` tries to find a remote-tracking3451 branch whose name uniquely matches the new branch name. If3452 such a branch exists, it is checked out and set as "upstream"3453 for the new branch. If no such match can be found, it falls3454 back to creating a new branch from the current HEAD.