1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82The `include` and `includeIf` sections allow you to include config 83directives from another source. These sections behave identically to 84each other with the exception that `includeIf` sections may be ignored 85if their condition does not evaluate to true; see "Conditional includes" 86below. 87 88You can include a config file from another by setting the special 89`include.path` (or `includeIf.*.path`) variable to the name of the file 90to be included. The variable takes a pathname as its value, and is 91subject to tilde expansion. These variables can be given multiple times. 92 93The contents of the included file are inserted immediately, as if they 94had been found at the location of the include directive. If the value of the 95variable is a relative path, the path is considered to 96be relative to the configuration file in which the include directive 97was found. See below for examples. 98 99Conditional includes 100~~~~~~~~~~~~~~~~~~~~ 101 102You can include a config file from another conditionally by setting a 103`includeIf.<condition>.path` variable to the name of the file to be 104included. 105 106The condition starts with a keyword followed by a colon and some data 107whose format and meaning depends on the keyword. Supported keywords 108are: 109 110`gitdir`:: 111 112 The data that follows the keyword `gitdir:` is used as a glob 113 pattern. If the location of the .git directory matches the 114 pattern, the include condition is met. 115+ 116The .git location may be auto-discovered, or come from `$GIT_DIR` 117environment variable. If the repository is auto discovered via a .git 118file (e.g. from submodules, or a linked worktree), the .git location 119would be the final location where the .git directory is, not where the 120.git file is. 121+ 122The pattern can contain standard globbing wildcards and two additional 123ones, `**/` and `/**`, that can match multiple path components. Please 124refer to linkgit:gitignore[5] for details. For convenience: 125 126 * If the pattern starts with `~/`, `~` will be substituted with the 127 content of the environment variable `HOME`. 128 129 * If the pattern starts with `./`, it is replaced with the directory 130 containing the current config file. 131 132 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 133 will be automatically prepended. For example, the pattern `foo/bar` 134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 135 136 * If the pattern ends with `/`, `**` will be automatically added. For 137 example, the pattern `foo/` becomes `foo/**`. In other words, it 138 matches "foo" and everything inside, recursively. 139 140`gitdir/i`:: 141 This is the same as `gitdir` except that matching is done 142 case-insensitively (e.g. on case-insensitive file sytems) 143 144A few more notes on matching via `gitdir` and `gitdir/i`: 145 146 * Symlinks in `$GIT_DIR` are not resolved before matching. 147 148 * Both the symlink & realpath versions of paths will be matched 149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 151 will match. 152+ 153This was not the case in the initial release of this feature in 154v2.13.0, which only matched the realpath version. Configuration that 155wants to be compatible with the initial release of this feature needs 156to either specify only the realpath version, or both versions. 157 158 * Note that "../" is not special and will match literally, which is 159 unlikely what you want. 160 161Example 162~~~~~~~ 163 164 # Core variables 165 [core] 166 ; Don't trust file modes 167 filemode = false 168 169 # Our diff algorithm 170 [diff] 171 external = /usr/local/bin/diff-wrapper 172 renames = true 173 174 [branch "devel"] 175 remote = origin 176 merge = refs/heads/devel 177 178 # Proxy settings 179 [core] 180 gitProxy="ssh" for "kernel.org" 181 gitProxy=default-proxy ; for the rest 182 183 [include] 184 path = /path/to/foo.inc ; include by absolute path 185 path = foo.inc ; find "foo.inc" relative to the current file 186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 187 188 ; include if $GIT_DIR is /path/to/foo/.git 189 [includeIf "gitdir:/path/to/foo/.git"] 190 path = /path/to/foo.inc 191 192 ; include for all repositories inside /path/to/group 193 [includeIf "gitdir:/path/to/group/"] 194 path = /path/to/foo.inc 195 196 ; include for all repositories inside $HOME/to/group 197 [includeIf "gitdir:~/to/group/"] 198 path = /path/to/foo.inc 199 200 ; relative paths are always relative to the including 201 ; file (if the condition is true); their location is not 202 ; affected by the condition 203 [includeIf "gitdir:/path/to/group/"] 204 path = foo.inc 205 206Values 207~~~~~~ 208 209Values of many variables are treated as a simple string, but there 210are variables that take values of specific types and there are rules 211as to how to spell them. 212 213boolean:: 214 215 When a variable is said to take a boolean value, many 216 synonyms are accepted for 'true' and 'false'; these are all 217 case-insensitive. 218 219 true;; Boolean true literals are `yes`, `on`, `true`, 220 and `1`. Also, a variable defined without `= <value>` 221 is taken as true. 222 223 false;; Boolean false literals are `no`, `off`, `false`, 224 `0` and the empty string. 225+ 226When converting value to the canonical form using `--bool` type 227specifier, 'git config' will ensure that the output is "true" or 228"false" (spelled in lowercase). 229 230integer:: 231 The value for many variables that specify various sizes can 232 be suffixed with `k`, `M`,... to mean "scale the number by 233 1024", "by 1024x1024", etc. 234 235color:: 236 The value for a variable that takes a color is a list of 237 colors (at most two, one for foreground and one for background) 238 and attributes (as many as you want), separated by spaces. 239+ 240The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 241`blue`, `magenta`, `cyan` and `white`. The first color given is the 242foreground; the second is the background. 243+ 244Colors may also be given as numbers between 0 and 255; these use ANSI 245256-color mode (but note that not all terminals may support this). If 246your terminal supports it, you may also specify 24-bit RGB values as 247hex, like `#ff0ab3`. 248+ 249The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 250`italic`, and `strike` (for crossed-out or "strikethrough" letters). 251The position of any attributes with respect to the colors 252(before, after, or in between), doesn't matter. Specific attributes may 253be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 254`no-ul`, etc). 255+ 256An empty color string produces no color effect at all. This can be used 257to avoid coloring specific elements without disabling color entirely. 258+ 259For git's pre-defined color slots, the attributes are meant to be reset 260at the beginning of each item in the colored output. So setting 261`color.decorate.branch` to `black` will paint that branch name in a 262plain `black`, even if the previous thing on the same output line (e.g. 263opening parenthesis before the list of branch names in `log --decorate` 264output) is set to be painted with `bold` or some other attribute. 265However, custom log formats may do more complicated and layered 266coloring, and the negated forms may be useful there. 267 268pathname:: 269 A variable that takes a pathname value can be given a 270 string that begins with "`~/`" or "`~user/`", and the usual 271 tilde expansion happens to such a string: `~/` 272 is expanded to the value of `$HOME`, and `~user/` to the 273 specified user's home directory. 274 275 276Variables 277~~~~~~~~~ 278 279Note that this list is non-comprehensive and not necessarily complete. 280For command-specific variables, you will find a more detailed description 281in the appropriate manual page. 282 283Other git-related tools may and do use their own variables. When 284inventing new variables for use in your own tool, make sure their 285names do not conflict with those that are used by Git itself and 286other popular tools, and describe them in your documentation. 287 288 289advice.*:: 290 These variables control various optional help messages designed to 291 aid new users. All 'advice.*' variables default to 'true', and you 292 can tell Git that you do not need help by setting these to 'false': 293+ 294-- 295 pushUpdateRejected:: 296 Set this variable to 'false' if you want to disable 297 'pushNonFFCurrent', 298 'pushNonFFMatching', 'pushAlreadyExists', 299 'pushFetchFirst', and 'pushNeedsForce' 300 simultaneously. 301 pushNonFFCurrent:: 302 Advice shown when linkgit:git-push[1] fails due to a 303 non-fast-forward update to the current branch. 304 pushNonFFMatching:: 305 Advice shown when you ran linkgit:git-push[1] and pushed 306 'matching refs' explicitly (i.e. you used ':', or 307 specified a refspec that isn't your current branch) and 308 it resulted in a non-fast-forward error. 309 pushAlreadyExists:: 310 Shown when linkgit:git-push[1] rejects an update that 311 does not qualify for fast-forwarding (e.g., a tag.) 312 pushFetchFirst:: 313 Shown when linkgit:git-push[1] rejects an update that 314 tries to overwrite a remote ref that points at an 315 object we do not have. 316 pushNeedsForce:: 317 Shown when linkgit:git-push[1] rejects an update that 318 tries to overwrite a remote ref that points at an 319 object that is not a commit-ish, or make the remote 320 ref point at an object that is not a commit-ish. 321 statusHints:: 322 Show directions on how to proceed from the current 323 state in the output of linkgit:git-status[1], in 324 the template shown when writing commit messages in 325 linkgit:git-commit[1], and in the help message shown 326 by linkgit:git-checkout[1] when switching branch. 327 statusUoption:: 328 Advise to consider using the `-u` option to linkgit:git-status[1] 329 when the command takes more than 2 seconds to enumerate untracked 330 files. 331 commitBeforeMerge:: 332 Advice shown when linkgit:git-merge[1] refuses to 333 merge to avoid overwriting local changes. 334 resolveConflict:: 335 Advice shown by various commands when conflicts 336 prevent the operation from being performed. 337 implicitIdentity:: 338 Advice on how to set your identity configuration when 339 your information is guessed from the system username and 340 domain name. 341 detachedHead:: 342 Advice shown when you used linkgit:git-checkout[1] to 343 move to the detach HEAD state, to instruct how to create 344 a local branch after the fact. 345 amWorkDir:: 346 Advice that shows the location of the patch file when 347 linkgit:git-am[1] fails to apply it. 348 rmHints:: 349 In case of failure in the output of linkgit:git-rm[1], 350 show directions on how to proceed from the current state. 351 addEmbeddedRepo:: 352 Advice on what to do when you've accidentally added one 353 git repo inside of another. 354-- 355 356core.fileMode:: 357 Tells Git if the executable bit of files in the working tree 358 is to be honored. 359+ 360Some filesystems lose the executable bit when a file that is 361marked as executable is checked out, or checks out a 362non-executable file with executable bit on. 363linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 364to see if it handles the executable bit correctly 365and this variable is automatically set as necessary. 366+ 367A repository, however, may be on a filesystem that handles 368the filemode correctly, and this variable is set to 'true' 369when created, but later may be made accessible from another 370environment that loses the filemode (e.g. exporting ext4 via 371CIFS mount, visiting a Cygwin created repository with 372Git for Windows or Eclipse). 373In such a case it may be necessary to set this variable to 'false'. 374See linkgit:git-update-index[1]. 375+ 376The default is true (when core.filemode is not specified in the config file). 377 378core.hideDotFiles:: 379 (Windows-only) If true, mark newly-created directories and files whose 380 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 381 directory is hidden, but no other files starting with a dot. The 382 default mode is 'dotGitOnly'. 383 384core.ignoreCase:: 385 If true, this option enables various workarounds to enable 386 Git to work better on filesystems that are not case sensitive, 387 like FAT. For example, if a directory listing finds 388 "makefile" when Git expects "Makefile", Git will assume 389 it is really the same file, and continue to remember it as 390 "Makefile". 391+ 392The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 393will probe and set core.ignoreCase true if appropriate when the repository 394is created. 395 396core.precomposeUnicode:: 397 This option is only used by Mac OS implementation of Git. 398 When core.precomposeUnicode=true, Git reverts the unicode decomposition 399 of filenames done by Mac OS. This is useful when sharing a repository 400 between Mac OS and Linux or Windows. 401 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 402 When false, file names are handled fully transparent by Git, 403 which is backward compatible with older versions of Git. 404 405core.protectHFS:: 406 If set to true, do not allow checkout of paths that would 407 be considered equivalent to `.git` on an HFS+ filesystem. 408 Defaults to `true` on Mac OS, and `false` elsewhere. 409 410core.protectNTFS:: 411 If set to true, do not allow checkout of paths that would 412 cause problems with the NTFS filesystem, e.g. conflict with 413 8.3 "short" names. 414 Defaults to `true` on Windows, and `false` elsewhere. 415 416core.trustctime:: 417 If false, the ctime differences between the index and the 418 working tree are ignored; useful when the inode change time 419 is regularly modified by something outside Git (file system 420 crawlers and some backup systems). 421 See linkgit:git-update-index[1]. True by default. 422 423core.splitIndex:: 424 If true, the split-index feature of the index will be used. 425 See linkgit:git-update-index[1]. False by default. 426 427core.untrackedCache:: 428 Determines what to do about the untracked cache feature of the 429 index. It will be kept, if this variable is unset or set to 430 `keep`. It will automatically be added if set to `true`. And 431 it will automatically be removed, if set to `false`. Before 432 setting it to `true`, you should check that mtime is working 433 properly on your system. 434 See linkgit:git-update-index[1]. `keep` by default. 435 436core.checkStat:: 437 Determines which stat fields to match between the index 438 and work tree. The user can set this to 'default' or 439 'minimal'. Default (or explicitly 'default'), is to check 440 all fields, including the sub-second part of mtime and ctime. 441 442core.quotePath:: 443 Commands that output paths (e.g. 'ls-files', 'diff'), will 444 quote "unusual" characters in the pathname by enclosing the 445 pathname in double-quotes and escaping those characters with 446 backslashes in the same way C escapes control characters (e.g. 447 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 448 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 449 UTF-8). If this variable is set to false, bytes higher than 450 0x80 are not considered "unusual" any more. Double-quotes, 451 backslash and control characters are always escaped regardless 452 of the setting of this variable. A simple space character is 453 not considered "unusual". Many commands can output pathnames 454 completely verbatim using the `-z` option. The default value 455 is true. 456 457core.eol:: 458 Sets the line ending type to use in the working directory for 459 files that have the `text` property set when core.autocrlf is false. 460 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 461 native line ending. The default value is `native`. See 462 linkgit:gitattributes[5] for more information on end-of-line 463 conversion. 464 465core.safecrlf:: 466 If true, makes Git check if converting `CRLF` is reversible when 467 end-of-line conversion is active. Git will verify if a command 468 modifies a file in the work tree either directly or indirectly. 469 For example, committing a file followed by checking out the 470 same file should yield the original file in the work tree. If 471 this is not the case for the current setting of 472 `core.autocrlf`, Git will reject the file. The variable can 473 be set to "warn", in which case Git will only warn about an 474 irreversible conversion but continue the operation. 475+ 476CRLF conversion bears a slight chance of corrupting data. 477When it is enabled, Git will convert CRLF to LF during commit and LF to 478CRLF during checkout. A file that contains a mixture of LF and 479CRLF before the commit cannot be recreated by Git. For text 480files this is the right thing to do: it corrects line endings 481such that we have only LF line endings in the repository. 482But for binary files that are accidentally classified as text the 483conversion can corrupt data. 484+ 485If you recognize such corruption early you can easily fix it by 486setting the conversion type explicitly in .gitattributes. Right 487after committing you still have the original file in your work 488tree and this file is not yet corrupted. You can explicitly tell 489Git that this file is binary and Git will handle the file 490appropriately. 491+ 492Unfortunately, the desired effect of cleaning up text files with 493mixed line endings and the undesired effect of corrupting binary 494files cannot be distinguished. In both cases CRLFs are removed 495in an irreversible way. For text files this is the right thing 496to do because CRLFs are line endings, while for binary files 497converting CRLFs corrupts data. 498+ 499Note, this safety check does not mean that a checkout will generate a 500file identical to the original file for a different setting of 501`core.eol` and `core.autocrlf`, but only for the current one. For 502example, a text file with `LF` would be accepted with `core.eol=lf` 503and could later be checked out with `core.eol=crlf`, in which case the 504resulting file would contain `CRLF`, although the original file 505contained `LF`. However, in both work trees the line endings would be 506consistent, that is either all `LF` or all `CRLF`, but never mixed. A 507file with mixed line endings would be reported by the `core.safecrlf` 508mechanism. 509 510core.autocrlf:: 511 Setting this variable to "true" is the same as setting 512 the `text` attribute to "auto" on all files and core.eol to "crlf". 513 Set to true if you want to have `CRLF` line endings in your 514 working directory and the repository has LF line endings. 515 This variable can be set to 'input', 516 in which case no output conversion is performed. 517 518core.symlinks:: 519 If false, symbolic links are checked out as small plain files that 520 contain the link text. linkgit:git-update-index[1] and 521 linkgit:git-add[1] will not change the recorded type to regular 522 file. Useful on filesystems like FAT that do not support 523 symbolic links. 524+ 525The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 526will probe and set core.symlinks false if appropriate when the repository 527is created. 528 529core.gitProxy:: 530 A "proxy command" to execute (as 'command host port') instead 531 of establishing direct connection to the remote server when 532 using the Git protocol for fetching. If the variable value is 533 in the "COMMAND for DOMAIN" format, the command is applied only 534 on hostnames ending with the specified domain string. This variable 535 may be set multiple times and is matched in the given order; 536 the first match wins. 537+ 538Can be overridden by the `GIT_PROXY_COMMAND` environment variable 539(which always applies universally, without the special "for" 540handling). 541+ 542The special string `none` can be used as the proxy command to 543specify that no proxy be used for a given domain pattern. 544This is useful for excluding servers inside a firewall from 545proxy use, while defaulting to a common proxy for external domains. 546 547core.sshCommand:: 548 If this variable is set, `git fetch` and `git push` will 549 use the specified command instead of `ssh` when they need to 550 connect to a remote system. The command is in the same form as 551 the `GIT_SSH_COMMAND` environment variable and is overridden 552 when the environment variable is set. 553 554core.ignoreStat:: 555 If true, Git will avoid using lstat() calls to detect if files have 556 changed by setting the "assume-unchanged" bit for those tracked files 557 which it has updated identically in both the index and working tree. 558+ 559When files are modified outside of Git, the user will need to stage 560the modified files explicitly (e.g. see 'Examples' section in 561linkgit:git-update-index[1]). 562Git will not normally detect changes to those files. 563+ 564This is useful on systems where lstat() calls are very slow, such as 565CIFS/Microsoft Windows. 566+ 567False by default. 568 569core.preferSymlinkRefs:: 570 Instead of the default "symref" format for HEAD 571 and other symbolic reference files, use symbolic links. 572 This is sometimes needed to work with old scripts that 573 expect HEAD to be a symbolic link. 574 575core.bare:: 576 If true this repository is assumed to be 'bare' and has no 577 working directory associated with it. If this is the case a 578 number of commands that require a working directory will be 579 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 580+ 581This setting is automatically guessed by linkgit:git-clone[1] or 582linkgit:git-init[1] when the repository was created. By default a 583repository that ends in "/.git" is assumed to be not bare (bare = 584false), while all other repositories are assumed to be bare (bare 585= true). 586 587core.worktree:: 588 Set the path to the root of the working tree. 589 If `GIT_COMMON_DIR` environment variable is set, core.worktree 590 is ignored and not used for determining the root of working tree. 591 This can be overridden by the `GIT_WORK_TREE` environment 592 variable and the `--work-tree` command-line option. 593 The value can be an absolute path or relative to the path to 594 the .git directory, which is either specified by --git-dir 595 or GIT_DIR, or automatically discovered. 596 If --git-dir or GIT_DIR is specified but none of 597 --work-tree, GIT_WORK_TREE and core.worktree is specified, 598 the current working directory is regarded as the top level 599 of your working tree. 600+ 601Note that this variable is honored even when set in a configuration 602file in a ".git" subdirectory of a directory and its value differs 603from the latter directory (e.g. "/path/to/.git/config" has 604core.worktree set to "/different/path"), which is most likely a 605misconfiguration. Running Git commands in the "/path/to" directory will 606still use "/different/path" as the root of the work tree and can cause 607confusion unless you know what you are doing (e.g. you are creating a 608read-only snapshot of the same index to a location different from the 609repository's usual working tree). 610 611core.logAllRefUpdates:: 612 Enable the reflog. Updates to a ref <ref> is logged to the file 613 "`$GIT_DIR/logs/<ref>`", by appending the new and old 614 SHA-1, the date/time and the reason of the update, but 615 only when the file exists. If this configuration 616 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 617 file is automatically created for branch heads (i.e. under 618 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 619 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 620 If it is set to `always`, then a missing reflog is automatically 621 created for any ref under `refs/`. 622+ 623This information can be used to determine what commit 624was the tip of a branch "2 days ago". 625+ 626This value is true by default in a repository that has 627a working directory associated with it, and false by 628default in a bare repository. 629 630core.repositoryFormatVersion:: 631 Internal variable identifying the repository format and layout 632 version. 633 634core.sharedRepository:: 635 When 'group' (or 'true'), the repository is made shareable between 636 several users in a group (making sure all the files and objects are 637 group-writable). When 'all' (or 'world' or 'everybody'), the 638 repository will be readable by all users, additionally to being 639 group-shareable. When 'umask' (or 'false'), Git will use permissions 640 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 641 files in the repository will have this mode value. '0xxx' will override 642 user's umask value (whereas the other options will only override 643 requested parts of the user's umask value). Examples: '0660' will make 644 the repo read/write-able for the owner and group, but inaccessible to 645 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 646 repository that is group-readable but not group-writable. 647 See linkgit:git-init[1]. False by default. 648 649core.warnAmbiguousRefs:: 650 If true, Git will warn you if the ref name you passed it is ambiguous 651 and might match multiple refs in the repository. True by default. 652 653core.compression:: 654 An integer -1..9, indicating a default compression level. 655 -1 is the zlib default. 0 means no compression, 656 and 1..9 are various speed/size tradeoffs, 9 being slowest. 657 If set, this provides a default to other compression variables, 658 such as `core.looseCompression` and `pack.compression`. 659 660core.looseCompression:: 661 An integer -1..9, indicating the compression level for objects that 662 are not in a pack file. -1 is the zlib default. 0 means no 663 compression, and 1..9 are various speed/size tradeoffs, 9 being 664 slowest. If not set, defaults to core.compression. If that is 665 not set, defaults to 1 (best speed). 666 667core.packedGitWindowSize:: 668 Number of bytes of a pack file to map into memory in a 669 single mapping operation. Larger window sizes may allow 670 your system to process a smaller number of large pack files 671 more quickly. Smaller window sizes will negatively affect 672 performance due to increased calls to the operating system's 673 memory manager, but may improve performance when accessing 674 a large number of large pack files. 675+ 676Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 677MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 678be reasonable for all users/operating systems. You probably do 679not need to adjust this value. 680+ 681Common unit suffixes of 'k', 'm', or 'g' are supported. 682 683core.packedGitLimit:: 684 Maximum number of bytes to map simultaneously into memory 685 from pack files. If Git needs to access more than this many 686 bytes at once to complete an operation it will unmap existing 687 regions to reclaim virtual address space within the process. 688+ 689Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 690unlimited) on 64 bit platforms. 691This should be reasonable for all users/operating systems, except on 692the largest projects. You probably do not need to adjust this value. 693+ 694Common unit suffixes of 'k', 'm', or 'g' are supported. 695 696core.deltaBaseCacheLimit:: 697 Maximum number of bytes to reserve for caching base objects 698 that may be referenced by multiple deltified objects. By storing the 699 entire decompressed base objects in a cache Git is able 700 to avoid unpacking and decompressing frequently used base 701 objects multiple times. 702+ 703Default is 96 MiB on all platforms. This should be reasonable 704for all users/operating systems, except on the largest projects. 705You probably do not need to adjust this value. 706+ 707Common unit suffixes of 'k', 'm', or 'g' are supported. 708 709core.bigFileThreshold:: 710 Files larger than this size are stored deflated, without 711 attempting delta compression. Storing large files without 712 delta compression avoids excessive memory usage, at the 713 slight expense of increased disk usage. Additionally files 714 larger than this size are always treated as binary. 715+ 716Default is 512 MiB on all platforms. This should be reasonable 717for most projects as source code and other text files can still 718be delta compressed, but larger binary media files won't be. 719+ 720Common unit suffixes of 'k', 'm', or 'g' are supported. 721 722core.excludesFile:: 723 Specifies the pathname to the file that contains patterns to 724 describe paths that are not meant to be tracked, in addition 725 to '.gitignore' (per-directory) and '.git/info/exclude'. 726 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 727 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 728 is used instead. See linkgit:gitignore[5]. 729 730core.askPass:: 731 Some commands (e.g. svn and http interfaces) that interactively 732 ask for a password can be told to use an external program given 733 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 734 environment variable. If not set, fall back to the value of the 735 `SSH_ASKPASS` environment variable or, failing that, a simple password 736 prompt. The external program shall be given a suitable prompt as 737 command-line argument and write the password on its STDOUT. 738 739core.attributesFile:: 740 In addition to '.gitattributes' (per-directory) and 741 '.git/info/attributes', Git looks into this file for attributes 742 (see linkgit:gitattributes[5]). Path expansions are made the same 743 way as for `core.excludesFile`. Its default value is 744 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 745 set or empty, `$HOME/.config/git/attributes` is used instead. 746 747core.hooksPath:: 748 By default Git will look for your hooks in the 749 '$GIT_DIR/hooks' directory. Set this to different path, 750 e.g. '/etc/git/hooks', and Git will try to find your hooks in 751 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 752 in '$GIT_DIR/hooks/pre-receive'. 753+ 754The path can be either absolute or relative. A relative path is 755taken as relative to the directory where the hooks are run (see 756the "DESCRIPTION" section of linkgit:githooks[5]). 757+ 758This configuration variable is useful in cases where you'd like to 759centrally configure your Git hooks instead of configuring them on a 760per-repository basis, or as a more flexible and centralized 761alternative to having an `init.templateDir` where you've changed 762default hooks. 763 764core.editor:: 765 Commands such as `commit` and `tag` that let you edit 766 messages by launching an editor use the value of this 767 variable when it is set, and the environment variable 768 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 769 770core.commentChar:: 771 Commands such as `commit` and `tag` that let you edit 772 messages consider a line that begins with this character 773 commented, and removes them after the editor returns 774 (default '#'). 775+ 776If set to "auto", `git-commit` would select a character that is not 777the beginning character of any line in existing commit messages. 778 779core.filesRefLockTimeout:: 780 The length of time, in milliseconds, to retry when trying to 781 lock an individual reference. Value 0 means not to retry at 782 all; -1 means to try indefinitely. Default is 100 (i.e., 783 retry for 100ms). 784 785core.packedRefsTimeout:: 786 The length of time, in milliseconds, to retry when trying to 787 lock the `packed-refs` file. Value 0 means not to retry at 788 all; -1 means to try indefinitely. Default is 1000 (i.e., 789 retry for 1 second). 790 791sequence.editor:: 792 Text editor used by `git rebase -i` for editing the rebase instruction file. 793 The value is meant to be interpreted by the shell when it is used. 794 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 795 When not configured the default commit message editor is used instead. 796 797core.pager:: 798 Text viewer for use by Git commands (e.g., 'less'). The value 799 is meant to be interpreted by the shell. The order of preference 800 is the `$GIT_PAGER` environment variable, then `core.pager` 801 configuration, then `$PAGER`, and then the default chosen at 802 compile time (usually 'less'). 803+ 804When the `LESS` environment variable is unset, Git sets it to `FRX` 805(if `LESS` environment variable is set, Git does not change it at 806all). If you want to selectively override Git's default setting 807for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 808be passed to the shell by Git, which will translate the final 809command to `LESS=FRX less -S`. The environment does not set the 810`S` option but the command line does, instructing less to truncate 811long lines. Similarly, setting `core.pager` to `less -+F` will 812deactivate the `F` option specified by the environment from the 813command-line, deactivating the "quit if one screen" behavior of 814`less`. One can specifically activate some flags for particular 815commands: for example, setting `pager.blame` to `less -S` enables 816line truncation only for `git blame`. 817+ 818Likewise, when the `LV` environment variable is unset, Git sets it 819to `-c`. You can override this setting by exporting `LV` with 820another value or setting `core.pager` to `lv +c`. 821 822core.whitespace:: 823 A comma separated list of common whitespace problems to 824 notice. 'git diff' will use `color.diff.whitespace` to 825 highlight them, and 'git apply --whitespace=error' will 826 consider them as errors. You can prefix `-` to disable 827 any of them (e.g. `-trailing-space`): 828+ 829* `blank-at-eol` treats trailing whitespaces at the end of the line 830 as an error (enabled by default). 831* `space-before-tab` treats a space character that appears immediately 832 before a tab character in the initial indent part of the line as an 833 error (enabled by default). 834* `indent-with-non-tab` treats a line that is indented with space 835 characters instead of the equivalent tabs as an error (not enabled by 836 default). 837* `tab-in-indent` treats a tab character in the initial indent part of 838 the line as an error (not enabled by default). 839* `blank-at-eof` treats blank lines added at the end of file as an error 840 (enabled by default). 841* `trailing-space` is a short-hand to cover both `blank-at-eol` and 842 `blank-at-eof`. 843* `cr-at-eol` treats a carriage-return at the end of line as 844 part of the line terminator, i.e. with it, `trailing-space` 845 does not trigger if the character before such a carriage-return 846 is not a whitespace (not enabled by default). 847* `tabwidth=<n>` tells how many character positions a tab occupies; this 848 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 849 errors. The default tab width is 8. Allowed values are 1 to 63. 850 851core.fsyncObjectFiles:: 852 This boolean will enable 'fsync()' when writing object files. 853+ 854This is a total waste of time and effort on a filesystem that orders 855data writes properly, but can be useful for filesystems that do not use 856journalling (traditional UNIX filesystems) or that only journal metadata 857and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 858 859core.preloadIndex:: 860 Enable parallel index preload for operations like 'git diff' 861+ 862This can speed up operations like 'git diff' and 'git status' especially 863on filesystems like NFS that have weak caching semantics and thus 864relatively high IO latencies. When enabled, Git will do the 865index comparison to the filesystem data in parallel, allowing 866overlapping IO's. Defaults to true. 867 868core.createObject:: 869 You can set this to 'link', in which case a hardlink followed by 870 a delete of the source are used to make sure that object creation 871 will not overwrite existing objects. 872+ 873On some file system/operating system combinations, this is unreliable. 874Set this config setting to 'rename' there; However, This will remove the 875check that makes sure that existing object files will not get overwritten. 876 877core.notesRef:: 878 When showing commit messages, also show notes which are stored in 879 the given ref. The ref must be fully qualified. If the given 880 ref does not exist, it is not an error but means that no 881 notes should be printed. 882+ 883This setting defaults to "refs/notes/commits", and it can be overridden by 884the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 885 886core.sparseCheckout:: 887 Enable "sparse checkout" feature. See section "Sparse checkout" in 888 linkgit:git-read-tree[1] for more information. 889 890core.abbrev:: 891 Set the length object names are abbreviated to. If 892 unspecified or set to "auto", an appropriate value is 893 computed based on the approximate number of packed objects 894 in your repository, which hopefully is enough for 895 abbreviated object names to stay unique for some time. 896 The minimum length is 4. 897 898add.ignoreErrors:: 899add.ignore-errors (deprecated):: 900 Tells 'git add' to continue adding files when some files cannot be 901 added due to indexing errors. Equivalent to the `--ignore-errors` 902 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 903 as it does not follow the usual naming convention for configuration 904 variables. 905 906alias.*:: 907 Command aliases for the linkgit:git[1] command wrapper - e.g. 908 after defining "alias.last = cat-file commit HEAD", the invocation 909 "git last" is equivalent to "git cat-file commit HEAD". To avoid 910 confusion and troubles with script usage, aliases that 911 hide existing Git commands are ignored. Arguments are split by 912 spaces, the usual shell quoting and escaping is supported. 913 A quote pair or a backslash can be used to quote them. 914+ 915If the alias expansion is prefixed with an exclamation point, 916it will be treated as a shell command. For example, defining 917"alias.new = !gitk --all --not ORIG_HEAD", the invocation 918"git new" is equivalent to running the shell command 919"gitk --all --not ORIG_HEAD". Note that shell commands will be 920executed from the top-level directory of a repository, which may 921not necessarily be the current directory. 922`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 923from the original current directory. See linkgit:git-rev-parse[1]. 924 925am.keepcr:: 926 If true, git-am will call git-mailsplit for patches in mbox format 927 with parameter `--keep-cr`. In this case git-mailsplit will 928 not remove `\r` from lines ending with `\r\n`. Can be overridden 929 by giving `--no-keep-cr` from the command line. 930 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 931 932am.threeWay:: 933 By default, `git am` will fail if the patch does not apply cleanly. When 934 set to true, this setting tells `git am` to fall back on 3-way merge if 935 the patch records the identity of blobs it is supposed to apply to and 936 we have those blobs available locally (equivalent to giving the `--3way` 937 option from the command line). Defaults to `false`. 938 See linkgit:git-am[1]. 939 940apply.ignoreWhitespace:: 941 When set to 'change', tells 'git apply' to ignore changes in 942 whitespace, in the same way as the `--ignore-space-change` 943 option. 944 When set to one of: no, none, never, false tells 'git apply' to 945 respect all whitespace differences. 946 See linkgit:git-apply[1]. 947 948apply.whitespace:: 949 Tells 'git apply' how to handle whitespaces, in the same way 950 as the `--whitespace` option. See linkgit:git-apply[1]. 951 952branch.autoSetupMerge:: 953 Tells 'git branch' and 'git checkout' to set up new branches 954 so that linkgit:git-pull[1] will appropriately merge from the 955 starting point branch. Note that even if this option is not set, 956 this behavior can be chosen per-branch using the `--track` 957 and `--no-track` options. The valid settings are: `false` -- no 958 automatic setup is done; `true` -- automatic setup is done when the 959 starting point is a remote-tracking branch; `always` -- 960 automatic setup is done when the starting point is either a 961 local branch or remote-tracking 962 branch. This option defaults to true. 963 964branch.autoSetupRebase:: 965 When a new branch is created with 'git branch' or 'git checkout' 966 that tracks another branch, this variable tells Git to set 967 up pull to rebase instead of merge (see "branch.<name>.rebase"). 968 When `never`, rebase is never automatically set to true. 969 When `local`, rebase is set to true for tracked branches of 970 other local branches. 971 When `remote`, rebase is set to true for tracked branches of 972 remote-tracking branches. 973 When `always`, rebase will be set to true for all tracking 974 branches. 975 See "branch.autoSetupMerge" for details on how to set up a 976 branch to track another branch. 977 This option defaults to never. 978 979branch.<name>.remote:: 980 When on branch <name>, it tells 'git fetch' and 'git push' 981 which remote to fetch from/push to. The remote to push to 982 may be overridden with `remote.pushDefault` (for all branches). 983 The remote to push to, for the current branch, may be further 984 overridden by `branch.<name>.pushRemote`. If no remote is 985 configured, or if you are not on any branch, it defaults to 986 `origin` for fetching and `remote.pushDefault` for pushing. 987 Additionally, `.` (a period) is the current local repository 988 (a dot-repository), see `branch.<name>.merge`'s final note below. 989 990branch.<name>.pushRemote:: 991 When on branch <name>, it overrides `branch.<name>.remote` for 992 pushing. It also overrides `remote.pushDefault` for pushing 993 from branch <name>. When you pull from one place (e.g. your 994 upstream) and push to another place (e.g. your own publishing 995 repository), you would want to set `remote.pushDefault` to 996 specify the remote to push to for all branches, and use this 997 option to override it for a specific branch. 998 999branch.<name>.merge::1000 Defines, together with branch.<name>.remote, the upstream branch1001 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1002 branch to merge and can also affect 'git push' (see push.default).1003 When in branch <name>, it tells 'git fetch' the default1004 refspec to be marked for merging in FETCH_HEAD. The value is1005 handled like the remote part of a refspec, and must match a1006 ref which is fetched from the remote given by1007 "branch.<name>.remote".1008 The merge information is used by 'git pull' (which at first calls1009 'git fetch') to lookup the default branch for merging. Without1010 this option, 'git pull' defaults to merge the first refspec fetched.1011 Specify multiple values to get an octopus merge.1012 If you wish to setup 'git pull' so that it merges into <name> from1013 another branch in the local repository, you can point1014 branch.<name>.merge to the desired branch, and use the relative path1015 setting `.` (a period) for branch.<name>.remote.10161017branch.<name>.mergeOptions::1018 Sets default options for merging into branch <name>. The syntax and1019 supported options are the same as those of linkgit:git-merge[1], but1020 option values containing whitespace characters are currently not1021 supported.10221023branch.<name>.rebase::1024 When true, rebase the branch <name> on top of the fetched branch,1025 instead of merging the default branch from the default remote when1026 "git pull" is run. See "pull.rebase" for doing this in a non1027 branch-specific manner.1028+1029When preserve, also pass `--preserve-merges` along to 'git rebase'1030so that locally committed merge commits will not be flattened1031by running 'git pull'.1032+1033When the value is `interactive`, the rebase is run in interactive mode.1034+1035*NOTE*: this is a possibly dangerous operation; do *not* use1036it unless you understand the implications (see linkgit:git-rebase[1]1037for details).10381039branch.<name>.description::1040 Branch description, can be edited with1041 `git branch --edit-description`. Branch description is1042 automatically added in the format-patch cover letter or1043 request-pull summary.10441045browser.<tool>.cmd::1046 Specify the command to invoke the specified browser. The1047 specified command is evaluated in shell with the URLs passed1048 as arguments. (See linkgit:git-web{litdd}browse[1].)10491050browser.<tool>.path::1051 Override the path for the given tool that may be used to1052 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1053 working repository in gitweb (see linkgit:git-instaweb[1]).10541055clean.requireForce::1056 A boolean to make git-clean do nothing unless given -f,1057 -i or -n. Defaults to true.10581059color.branch::1060 A boolean to enable/disable color in the output of1061 linkgit:git-branch[1]. May be set to `always`,1062 `false` (or `never`) or `auto` (or `true`), in which case colors are used1063 only when the output is to a terminal. If unset, then the1064 value of `color.ui` is used (`auto` by default).10651066color.branch.<slot>::1067 Use customized color for branch coloration. `<slot>` is one of1068 `current` (the current branch), `local` (a local branch),1069 `remote` (a remote-tracking branch in refs/remotes/),1070 `upstream` (upstream tracking branch), `plain` (other1071 refs).10721073color.diff::1074 Whether to use ANSI escape sequences to add color to patches.1075 If this is set to `always`, linkgit:git-diff[1],1076 linkgit:git-log[1], and linkgit:git-show[1] will use color1077 for all patches. If it is set to `true` or `auto`, those1078 commands will only use color when output is to the terminal.1079 If unset, then the value of `color.ui` is used (`auto` by1080 default).1081+1082This does not affect linkgit:git-format-patch[1] or the1083'git-diff-{asterisk}' plumbing commands. Can be overridden on the1084command line with the `--color[=<when>]` option.10851086diff.colorMoved::1087 If set to either a valid `<mode>` or a true value, moved lines1088 in a diff are colored differently, for details of valid modes1089 see '--color-moved' in linkgit:git-diff[1]. If simply set to1090 true the default color mode will be used. When set to false,1091 moved lines are not colored.10921093color.diff.<slot>::1094 Use customized color for diff colorization. `<slot>` specifies1095 which part of the patch to use the specified color, and is one1096 of `context` (context text - `plain` is a historical synonym),1097 `meta` (metainformation), `frag`1098 (hunk header), 'func' (function in hunk header), `old` (removed lines),1099 `new` (added lines), `commit` (commit headers), `whitespace`1100 (highlighting whitespace errors), `oldMoved` (deleted lines),1101 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1102 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1103 and `newMovedAlternativeDimmed` (See the '<mode>'1104 setting of '--color-moved' in linkgit:git-diff[1] for details).11051106color.decorate.<slot>::1107 Use customized color for 'git log --decorate' output. `<slot>` is one1108 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1109 branches, remote-tracking branches, tags, stash and HEAD, respectively.11101111color.grep::1112 When set to `always`, always highlight matches. When `false` (or1113 `never`), never. When set to `true` or `auto`, use color only1114 when the output is written to the terminal. If unset, then the1115 value of `color.ui` is used (`auto` by default).11161117color.grep.<slot>::1118 Use customized color for grep colorization. `<slot>` specifies which1119 part of the line to use the specified color, and is one of1120+1121--1122`context`;;1123 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1124`filename`;;1125 filename prefix (when not using `-h`)1126`function`;;1127 function name lines (when using `-p`)1128`linenumber`;;1129 line number prefix (when using `-n`)1130`match`;;1131 matching text (same as setting `matchContext` and `matchSelected`)1132`matchContext`;;1133 matching text in context lines1134`matchSelected`;;1135 matching text in selected lines1136`selected`;;1137 non-matching text in selected lines1138`separator`;;1139 separators between fields on a line (`:`, `-`, and `=`)1140 and between hunks (`--`)1141--11421143color.interactive::1144 When set to `always`, always use colors for interactive prompts1145 and displays (such as those used by "git-add --interactive" and1146 "git-clean --interactive"). When false (or `never`), never.1147 When set to `true` or `auto`, use colors only when the output is1148 to the terminal. If unset, then the value of `color.ui` is1149 used (`auto` by default).11501151color.interactive.<slot>::1152 Use customized color for 'git add --interactive' and 'git clean1153 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1154 or `error`, for four distinct types of normal output from1155 interactive commands.11561157color.pager::1158 A boolean to enable/disable colored output when the pager is in1159 use (default is true).11601161color.showBranch::1162 A boolean to enable/disable color in the output of1163 linkgit:git-show-branch[1]. May be set to `always`,1164 `false` (or `never`) or `auto` (or `true`), in which case colors are used1165 only when the output is to a terminal. If unset, then the1166 value of `color.ui` is used (`auto` by default).11671168color.status::1169 A boolean to enable/disable color in the output of1170 linkgit:git-status[1]. May be set to `always`,1171 `false` (or `never`) or `auto` (or `true`), in which case colors are used1172 only when the output is to a terminal. If unset, then the1173 value of `color.ui` is used (`auto` by default).11741175color.status.<slot>::1176 Use customized color for status colorization. `<slot>` is1177 one of `header` (the header text of the status message),1178 `added` or `updated` (files which are added but not committed),1179 `changed` (files which are changed but not added in the index),1180 `untracked` (files which are not tracked by Git),1181 `branch` (the current branch),1182 `nobranch` (the color the 'no branch' warning is shown in, defaulting1183 to red),1184 `localBranch` or `remoteBranch` (the local and remote branch names,1185 respectively, when branch and tracking information is displayed in the1186 status short-format), or1187 `unmerged` (files which have unmerged changes).11881189color.ui::1190 This variable determines the default value for variables such1191 as `color.diff` and `color.grep` that control the use of color1192 per command family. Its scope will expand as more commands learn1193 configuration to set a default for the `--color` option. Set it1194 to `false` or `never` if you prefer Git commands not to use1195 color unless enabled explicitly with some other configuration1196 or the `--color` option. Set it to `always` if you want all1197 output not intended for machine consumption to use color, to1198 `true` or `auto` (this is the default since Git 1.8.4) if you1199 want such output to use color when written to the terminal.12001201column.ui::1202 Specify whether supported commands should output in columns.1203 This variable consists of a list of tokens separated by spaces1204 or commas:1205+1206These options control when the feature should be enabled1207(defaults to 'never'):1208+1209--1210`always`;;1211 always show in columns1212`never`;;1213 never show in columns1214`auto`;;1215 show in columns if the output is to the terminal1216--1217+1218These options control layout (defaults to 'column'). Setting any1219of these implies 'always' if none of 'always', 'never', or 'auto' are1220specified.1221+1222--1223`column`;;1224 fill columns before rows1225`row`;;1226 fill rows before columns1227`plain`;;1228 show in one column1229--1230+1231Finally, these options can be combined with a layout option (defaults1232to 'nodense'):1233+1234--1235`dense`;;1236 make unequal size columns to utilize more space1237`nodense`;;1238 make equal size columns1239--12401241column.branch::1242 Specify whether to output branch listing in `git branch` in columns.1243 See `column.ui` for details.12441245column.clean::1246 Specify the layout when list items in `git clean -i`, which always1247 shows files and directories in columns. See `column.ui` for details.12481249column.status::1250 Specify whether to output untracked files in `git status` in columns.1251 See `column.ui` for details.12521253column.tag::1254 Specify whether to output tag listing in `git tag` in columns.1255 See `column.ui` for details.12561257commit.cleanup::1258 This setting overrides the default of the `--cleanup` option in1259 `git commit`. See linkgit:git-commit[1] for details. Changing the1260 default can be useful when you always want to keep lines that begin1261 with comment character `#` in your log message, in which case you1262 would do `git config commit.cleanup whitespace` (note that you will1263 have to remove the help lines that begin with `#` in the commit log1264 template yourself, if you do this).12651266commit.gpgSign::12671268 A boolean to specify whether all commits should be GPG signed.1269 Use of this option when doing operations such as rebase can1270 result in a large number of commits being signed. It may be1271 convenient to use an agent to avoid typing your GPG passphrase1272 several times.12731274commit.status::1275 A boolean to enable/disable inclusion of status information in the1276 commit message template when using an editor to prepare the commit1277 message. Defaults to true.12781279commit.template::1280 Specify the pathname of a file to use as the template for1281 new commit messages.12821283commit.verbose::1284 A boolean or int to specify the level of verbose with `git commit`.1285 See linkgit:git-commit[1].12861287credential.helper::1288 Specify an external helper to be called when a username or1289 password credential is needed; the helper may consult external1290 storage to avoid prompting the user for the credentials. Note1291 that multiple helpers may be defined. See linkgit:gitcredentials[7]1292 for details.12931294credential.useHttpPath::1295 When acquiring credentials, consider the "path" component of an http1296 or https URL to be important. Defaults to false. See1297 linkgit:gitcredentials[7] for more information.12981299credential.username::1300 If no username is set for a network authentication, use this username1301 by default. See credential.<context>.* below, and1302 linkgit:gitcredentials[7].13031304credential.<url>.*::1305 Any of the credential.* options above can be applied selectively to1306 some credentials. For example "credential.https://example.com.username"1307 would set the default username only for https connections to1308 example.com. See linkgit:gitcredentials[7] for details on how URLs are1309 matched.13101311credentialCache.ignoreSIGHUP::1312 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13131314include::diff-config.txt[]13151316difftool.<tool>.path::1317 Override the path for the given tool. This is useful in case1318 your tool is not in the PATH.13191320difftool.<tool>.cmd::1321 Specify the command to invoke the specified diff tool.1322 The specified command is evaluated in shell with the following1323 variables available: 'LOCAL' is set to the name of the temporary1324 file containing the contents of the diff pre-image and 'REMOTE'1325 is set to the name of the temporary file containing the contents1326 of the diff post-image.13271328difftool.prompt::1329 Prompt before each invocation of the diff tool.13301331fastimport.unpackLimit::1332 If the number of objects imported by linkgit:git-fast-import[1]1333 is below this limit, then the objects will be unpacked into1334 loose object files. However if the number of imported objects1335 equals or exceeds this limit then the pack will be stored as a1336 pack. Storing the pack from a fast-import can make the import1337 operation complete faster, especially on slow filesystems. If1338 not set, the value of `transfer.unpackLimit` is used instead.13391340fetch.recurseSubmodules::1341 This option can be either set to a boolean value or to 'on-demand'.1342 Setting it to a boolean changes the behavior of fetch and pull to1343 unconditionally recurse into submodules when set to true or to not1344 recurse at all when set to false. When set to 'on-demand' (the default1345 value), fetch and pull will only recurse into a populated submodule1346 when its superproject retrieves a commit that updates the submodule's1347 reference.13481349fetch.fsckObjects::1350 If it is set to true, git-fetch-pack will check all fetched1351 objects. It will abort in the case of a malformed object or a1352 broken link. The result of an abort are only dangling objects.1353 Defaults to false. If not set, the value of `transfer.fsckObjects`1354 is used instead.13551356fetch.unpackLimit::1357 If the number of objects fetched over the Git native1358 transfer is below this1359 limit, then the objects will be unpacked into loose object1360 files. However if the number of received objects equals or1361 exceeds this limit then the received pack will be stored as1362 a pack, after adding any missing delta bases. Storing the1363 pack from a push can make the push operation complete faster,1364 especially on slow filesystems. If not set, the value of1365 `transfer.unpackLimit` is used instead.13661367fetch.prune::1368 If true, fetch will automatically behave as if the `--prune`1369 option was given on the command line. See also `remote.<name>.prune`.13701371fetch.output::1372 Control how ref update status is printed. Valid values are1373 `full` and `compact`. Default value is `full`. See section1374 OUTPUT in linkgit:git-fetch[1] for detail.13751376format.attach::1377 Enable multipart/mixed attachments as the default for1378 'format-patch'. The value can also be a double quoted string1379 which will enable attachments as the default and set the1380 value as the boundary. See the --attach option in1381 linkgit:git-format-patch[1].13821383format.from::1384 Provides the default value for the `--from` option to format-patch.1385 Accepts a boolean value, or a name and email address. If false,1386 format-patch defaults to `--no-from`, using commit authors directly in1387 the "From:" field of patch mails. If true, format-patch defaults to1388 `--from`, using your committer identity in the "From:" field of patch1389 mails and including a "From:" field in the body of the patch mail if1390 different. If set to a non-boolean value, format-patch uses that1391 value instead of your committer identity. Defaults to false.13921393format.numbered::1394 A boolean which can enable or disable sequence numbers in patch1395 subjects. It defaults to "auto" which enables it only if there1396 is more than one patch. It can be enabled or disabled for all1397 messages by setting it to "true" or "false". See --numbered1398 option in linkgit:git-format-patch[1].13991400format.headers::1401 Additional email headers to include in a patch to be submitted1402 by mail. See linkgit:git-format-patch[1].14031404format.to::1405format.cc::1406 Additional recipients to include in a patch to be submitted1407 by mail. See the --to and --cc options in1408 linkgit:git-format-patch[1].14091410format.subjectPrefix::1411 The default for format-patch is to output files with the '[PATCH]'1412 subject prefix. Use this variable to change that prefix.14131414format.signature::1415 The default for format-patch is to output a signature containing1416 the Git version number. Use this variable to change that default.1417 Set this variable to the empty string ("") to suppress1418 signature generation.14191420format.signatureFile::1421 Works just like format.signature except the contents of the1422 file specified by this variable will be used as the signature.14231424format.suffix::1425 The default for format-patch is to output files with the suffix1426 `.patch`. Use this variable to change that suffix (make sure to1427 include the dot if you want it).14281429format.pretty::1430 The default pretty format for log/show/whatchanged command,1431 See linkgit:git-log[1], linkgit:git-show[1],1432 linkgit:git-whatchanged[1].14331434format.thread::1435 The default threading style for 'git format-patch'. Can be1436 a boolean value, or `shallow` or `deep`. `shallow` threading1437 makes every mail a reply to the head of the series,1438 where the head is chosen from the cover letter, the1439 `--in-reply-to`, and the first patch mail, in this order.1440 `deep` threading makes every mail a reply to the previous one.1441 A true boolean value is the same as `shallow`, and a false1442 value disables threading.14431444format.signOff::1445 A boolean value which lets you enable the `-s/--signoff` option of1446 format-patch by default. *Note:* Adding the Signed-off-by: line to a1447 patch should be a conscious act and means that you certify you have1448 the rights to submit this work under the same open source license.1449 Please see the 'SubmittingPatches' document for further discussion.14501451format.coverLetter::1452 A boolean that controls whether to generate a cover-letter when1453 format-patch is invoked, but in addition can be set to "auto", to1454 generate a cover-letter only when there's more than one patch.14551456format.outputDirectory::1457 Set a custom directory to store the resulting files instead of the1458 current working directory.14591460format.useAutoBase::1461 A boolean value which lets you enable the `--base=auto` option of1462 format-patch by default.14631464filter.<driver>.clean::1465 The command which is used to convert the content of a worktree1466 file to a blob upon checkin. See linkgit:gitattributes[5] for1467 details.14681469filter.<driver>.smudge::1470 The command which is used to convert the content of a blob1471 object to a worktree file upon checkout. See1472 linkgit:gitattributes[5] for details.14731474fsck.<msg-id>::1475 Allows overriding the message type (error, warn or ignore) of a1476 specific message ID such as `missingEmail`.1477+1478For convenience, fsck prefixes the error/warning with the message ID,1479e.g. "missingEmail: invalid author/committer line - missing email" means1480that setting `fsck.missingEmail = ignore` will hide that issue.1481+1482This feature is intended to support working with legacy repositories1483which cannot be repaired without disruptive changes.14841485fsck.skipList::1486 The path to a sorted list of object names (i.e. one SHA-1 per1487 line) that are known to be broken in a non-fatal way and should1488 be ignored. This feature is useful when an established project1489 should be accepted despite early commits containing errors that1490 can be safely ignored such as invalid committer email addresses.1491 Note: corrupt objects cannot be skipped with this setting.14921493gc.aggressiveDepth::1494 The depth parameter used in the delta compression1495 algorithm used by 'git gc --aggressive'. This defaults1496 to 50.14971498gc.aggressiveWindow::1499 The window size parameter used in the delta compression1500 algorithm used by 'git gc --aggressive'. This defaults1501 to 250.15021503gc.auto::1504 When there are approximately more than this many loose1505 objects in the repository, `git gc --auto` will pack them.1506 Some Porcelain commands use this command to perform a1507 light-weight garbage collection from time to time. The1508 default value is 6700. Setting this to 0 disables it.15091510gc.autoPackLimit::1511 When there are more than this many packs that are not1512 marked with `*.keep` file in the repository, `git gc1513 --auto` consolidates them into one larger pack. The1514 default value is 50. Setting this to 0 disables it.15151516gc.autoDetach::1517 Make `git gc --auto` return immediately and run in background1518 if the system supports it. Default is true.15191520gc.logExpiry::1521 If the file gc.log exists, then `git gc --auto` won't run1522 unless that file is more than 'gc.logExpiry' old. Default is1523 "1.day". See `gc.pruneExpire` for more ways to specify its1524 value.15251526gc.packRefs::1527 Running `git pack-refs` in a repository renders it1528 unclonable by Git versions prior to 1.5.1.2 over dumb1529 transports such as HTTP. This variable determines whether1530 'git gc' runs `git pack-refs`. This can be set to `notbare`1531 to enable it within all non-bare repos or it can be set to a1532 boolean value. The default is `true`.15331534gc.pruneExpire::1535 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1536 Override the grace period with this config variable. The value1537 "now" may be used to disable this grace period and always prune1538 unreachable objects immediately, or "never" may be used to1539 suppress pruning. This feature helps prevent corruption when1540 'git gc' runs concurrently with another process writing to the1541 repository; see the "NOTES" section of linkgit:git-gc[1].15421543gc.worktreePruneExpire::1544 When 'git gc' is run, it calls1545 'git worktree prune --expire 3.months.ago'.1546 This config variable can be used to set a different grace1547 period. The value "now" may be used to disable the grace1548 period and prune `$GIT_DIR/worktrees` immediately, or "never"1549 may be used to suppress pruning.15501551gc.reflogExpire::1552gc.<pattern>.reflogExpire::1553 'git reflog expire' removes reflog entries older than1554 this time; defaults to 90 days. The value "now" expires all1555 entries immediately, and "never" suppresses expiration1556 altogether. With "<pattern>" (e.g.1557 "refs/stash") in the middle the setting applies only to1558 the refs that match the <pattern>.15591560gc.reflogExpireUnreachable::1561gc.<pattern>.reflogExpireUnreachable::1562 'git reflog expire' removes reflog entries older than1563 this time and are not reachable from the current tip;1564 defaults to 30 days. The value "now" expires all entries1565 immediately, and "never" suppresses expiration altogether.1566 With "<pattern>" (e.g. "refs/stash")1567 in the middle, the setting applies only to the refs that1568 match the <pattern>.15691570gc.rerereResolved::1571 Records of conflicted merge you resolved earlier are1572 kept for this many days when 'git rerere gc' is run.1573 You can also use more human-readable "1.month.ago", etc.1574 The default is 60 days. See linkgit:git-rerere[1].15751576gc.rerereUnresolved::1577 Records of conflicted merge you have not resolved are1578 kept for this many days when 'git rerere gc' is run.1579 You can also use more human-readable "1.month.ago", etc.1580 The default is 15 days. See linkgit:git-rerere[1].15811582gitcvs.commitMsgAnnotation::1583 Append this string to each commit message. Set to empty string1584 to disable this feature. Defaults to "via git-CVS emulator".15851586gitcvs.enabled::1587 Whether the CVS server interface is enabled for this repository.1588 See linkgit:git-cvsserver[1].15891590gitcvs.logFile::1591 Path to a log file where the CVS server interface well... logs1592 various stuff. See linkgit:git-cvsserver[1].15931594gitcvs.usecrlfattr::1595 If true, the server will look up the end-of-line conversion1596 attributes for files to determine the `-k` modes to use. If1597 the attributes force Git to treat a file as text,1598 the `-k` mode will be left blank so CVS clients will1599 treat it as text. If they suppress text conversion, the file1600 will be set with '-kb' mode, which suppresses any newline munging1601 the client might otherwise do. If the attributes do not allow1602 the file type to be determined, then `gitcvs.allBinary` is1603 used. See linkgit:gitattributes[5].16041605gitcvs.allBinary::1606 This is used if `gitcvs.usecrlfattr` does not resolve1607 the correct '-kb' mode to use. If true, all1608 unresolved files are sent to the client in1609 mode '-kb'. This causes the client to treat them1610 as binary files, which suppresses any newline munging it1611 otherwise might do. Alternatively, if it is set to "guess",1612 then the contents of the file are examined to decide if1613 it is binary, similar to `core.autocrlf`.16141615gitcvs.dbName::1616 Database used by git-cvsserver to cache revision information1617 derived from the Git repository. The exact meaning depends on the1618 used database driver, for SQLite (which is the default driver) this1619 is a filename. Supports variable substitution (see1620 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1621 Default: '%Ggitcvs.%m.sqlite'16221623gitcvs.dbDriver::1624 Used Perl DBI driver. You can specify any available driver1625 for this here, but it might not work. git-cvsserver is tested1626 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1627 reported *not* to work with 'DBD::mysql'. Experimental feature.1628 May not contain double colons (`:`). Default: 'SQLite'.1629 See linkgit:git-cvsserver[1].16301631gitcvs.dbUser, gitcvs.dbPass::1632 Database user and password. Only useful if setting `gitcvs.dbDriver`,1633 since SQLite has no concept of database users and/or passwords.1634 'gitcvs.dbUser' supports variable substitution (see1635 linkgit:git-cvsserver[1] for details).16361637gitcvs.dbTableNamePrefix::1638 Database table name prefix. Prepended to the names of any1639 database tables used, allowing a single database to be used1640 for several repositories. Supports variable substitution (see1641 linkgit:git-cvsserver[1] for details). Any non-alphabetic1642 characters will be replaced with underscores.16431644All gitcvs variables except for `gitcvs.usecrlfattr` and1645`gitcvs.allBinary` can also be specified as1646'gitcvs.<access_method>.<varname>' (where 'access_method'1647is one of "ext" and "pserver") to make them apply only for the given1648access method.16491650gitweb.category::1651gitweb.description::1652gitweb.owner::1653gitweb.url::1654 See linkgit:gitweb[1] for description.16551656gitweb.avatar::1657gitweb.blame::1658gitweb.grep::1659gitweb.highlight::1660gitweb.patches::1661gitweb.pickaxe::1662gitweb.remote_heads::1663gitweb.showSizes::1664gitweb.snapshot::1665 See linkgit:gitweb.conf[5] for description.16661667grep.lineNumber::1668 If set to true, enable `-n` option by default.16691670grep.patternType::1671 Set the default matching behavior. Using a value of 'basic', 'extended',1672 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1673 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1674 value 'default' will return to the default matching behavior.16751676grep.extendedRegexp::1677 If set to true, enable `--extended-regexp` option by default. This1678 option is ignored when the `grep.patternType` option is set to a value1679 other than 'default'.16801681grep.threads::1682 Number of grep worker threads to use.1683 See `grep.threads` in linkgit:git-grep[1] for more information.16841685grep.fallbackToNoIndex::1686 If set to true, fall back to git grep --no-index if git grep1687 is executed outside of a git repository. Defaults to false.16881689gpg.program::1690 Use this custom program instead of "`gpg`" found on `$PATH` when1691 making or verifying a PGP signature. The program must support the1692 same command-line interface as GPG, namely, to verify a detached1693 signature, "`gpg --verify $file - <$signature`" is run, and the1694 program is expected to signal a good signature by exiting with1695 code 0, and to generate an ASCII-armored detached signature, the1696 standard input of "`gpg -bsau $key`" is fed with the contents to be1697 signed, and the program is expected to send the result to its1698 standard output.16991700gui.commitMsgWidth::1701 Defines how wide the commit message window is in the1702 linkgit:git-gui[1]. "75" is the default.17031704gui.diffContext::1705 Specifies how many context lines should be used in calls to diff1706 made by the linkgit:git-gui[1]. The default is "5".17071708gui.displayUntracked::1709 Determines if linkgit:git-gui[1] shows untracked files1710 in the file list. The default is "true".17111712gui.encoding::1713 Specifies the default encoding to use for displaying of1714 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1715 It can be overridden by setting the 'encoding' attribute1716 for relevant files (see linkgit:gitattributes[5]).1717 If this option is not set, the tools default to the1718 locale encoding.17191720gui.matchTrackingBranch::1721 Determines if new branches created with linkgit:git-gui[1] should1722 default to tracking remote branches with matching names or1723 not. Default: "false".17241725gui.newBranchTemplate::1726 Is used as suggested name when creating new branches using the1727 linkgit:git-gui[1].17281729gui.pruneDuringFetch::1730 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1731 performing a fetch. The default value is "false".17321733gui.trustmtime::1734 Determines if linkgit:git-gui[1] should trust the file modification1735 timestamp or not. By default the timestamps are not trusted.17361737gui.spellingDictionary::1738 Specifies the dictionary used for spell checking commit messages in1739 the linkgit:git-gui[1]. When set to "none" spell checking is turned1740 off.17411742gui.fastCopyBlame::1743 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1744 location detection. It makes blame significantly faster on huge1745 repositories at the expense of less thorough copy detection.17461747gui.copyBlameThreshold::1748 Specifies the threshold to use in 'git gui blame' original location1749 detection, measured in alphanumeric characters. See the1750 linkgit:git-blame[1] manual for more information on copy detection.17511752gui.blamehistoryctx::1753 Specifies the radius of history context in days to show in1754 linkgit:gitk[1] for the selected commit, when the `Show History1755 Context` menu item is invoked from 'git gui blame'. If this1756 variable is set to zero, the whole history is shown.17571758guitool.<name>.cmd::1759 Specifies the shell command line to execute when the corresponding item1760 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1761 mandatory for every tool. The command is executed from the root of1762 the working directory, and in the environment it receives the name of1763 the tool as `GIT_GUITOOL`, the name of the currently selected file as1764 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1765 the head is detached, 'CUR_BRANCH' is empty).17661767guitool.<name>.needsFile::1768 Run the tool only if a diff is selected in the GUI. It guarantees1769 that 'FILENAME' is not empty.17701771guitool.<name>.noConsole::1772 Run the command silently, without creating a window to display its1773 output.17741775guitool.<name>.noRescan::1776 Don't rescan the working directory for changes after the tool1777 finishes execution.17781779guitool.<name>.confirm::1780 Show a confirmation dialog before actually running the tool.17811782guitool.<name>.argPrompt::1783 Request a string argument from the user, and pass it to the tool1784 through the `ARGS` environment variable. Since requesting an1785 argument implies confirmation, the 'confirm' option has no effect1786 if this is enabled. If the option is set to 'true', 'yes', or '1',1787 the dialog uses a built-in generic prompt; otherwise the exact1788 value of the variable is used.17891790guitool.<name>.revPrompt::1791 Request a single valid revision from the user, and set the1792 `REVISION` environment variable. In other aspects this option1793 is similar to 'argPrompt', and can be used together with it.17941795guitool.<name>.revUnmerged::1796 Show only unmerged branches in the 'revPrompt' subdialog.1797 This is useful for tools similar to merge or rebase, but not1798 for things like checkout or reset.17991800guitool.<name>.title::1801 Specifies the title to use for the prompt dialog. The default1802 is the tool name.18031804guitool.<name>.prompt::1805 Specifies the general prompt string to display at the top of1806 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1807 The default value includes the actual command.18081809help.browser::1810 Specify the browser that will be used to display help in the1811 'web' format. See linkgit:git-help[1].18121813help.format::1814 Override the default help format used by linkgit:git-help[1].1815 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1816 the default. 'web' and 'html' are the same.18171818help.autoCorrect::1819 Automatically correct and execute mistyped commands after1820 waiting for the given number of deciseconds (0.1 sec). If more1821 than one command can be deduced from the entered text, nothing1822 will be executed. If the value of this option is negative,1823 the corrected command will be executed immediately. If the1824 value is 0 - the command will be just shown but not executed.1825 This is the default.18261827help.htmlPath::1828 Specify the path where the HTML documentation resides. File system paths1829 and URLs are supported. HTML pages will be prefixed with this path when1830 help is displayed in the 'web' format. This defaults to the documentation1831 path of your Git installation.18321833http.proxy::1834 Override the HTTP proxy, normally configured using the 'http_proxy',1835 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1836 addition to the syntax understood by curl, it is possible to specify a1837 proxy string with a user name but no password, in which case git will1838 attempt to acquire one in the same way it does for other credentials. See1839 linkgit:gitcredentials[7] for more information. The syntax thus is1840 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1841 on a per-remote basis; see remote.<name>.proxy18421843http.proxyAuthMethod::1844 Set the method with which to authenticate against the HTTP proxy. This1845 only takes effect if the configured proxy string contains a user name part1846 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1847 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1848 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1849 variable. Possible values are:1850+1851--1852* `anyauth` - Automatically pick a suitable authentication method. It is1853 assumed that the proxy answers an unauthenticated request with a 4071854 status code and one or more Proxy-authenticate headers with supported1855 authentication methods. This is the default.1856* `basic` - HTTP Basic authentication1857* `digest` - HTTP Digest authentication; this prevents the password from being1858 transmitted to the proxy in clear text1859* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1860 of `curl(1)`)1861* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1862--18631864http.emptyAuth::1865 Attempt authentication without seeking a username or password. This1866 can be used to attempt GSS-Negotiate authentication without specifying1867 a username in the URL, as libcurl normally requires a username for1868 authentication.18691870http.delegation::1871 Control GSSAPI credential delegation. The delegation is disabled1872 by default in libcurl since version 7.21.7. Set parameter to tell1873 the server what it is allowed to delegate when it comes to user1874 credentials. Used with GSS/kerberos. Possible values are:1875+1876--1877* `none` - Don't allow any delegation.1878* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1879 Kerberos service ticket, which is a matter of realm policy.1880* `always` - Unconditionally allow the server to delegate.1881--188218831884http.extraHeader::1885 Pass an additional HTTP header when communicating with a server. If1886 more than one such entry exists, all of them are added as extra1887 headers. To allow overriding the settings inherited from the system1888 config, an empty value will reset the extra headers to the empty list.18891890http.cookieFile::1891 The pathname of a file containing previously stored cookie lines,1892 which should be used1893 in the Git http session, if they match the server. The file format1894 of the file to read cookies from should be plain HTTP headers or1895 the Netscape/Mozilla cookie file format (see `curl(1)`).1896 NOTE that the file specified with http.cookieFile is used only as1897 input unless http.saveCookies is set.18981899http.saveCookies::1900 If set, store cookies received during requests to the file specified by1901 http.cookieFile. Has no effect if http.cookieFile is unset.19021903http.sslVersion::1904 The SSL version to use when negotiating an SSL connection, if you1905 want to force the default. The available and default version1906 depend on whether libcurl was built against NSS or OpenSSL and the1907 particular configuration of the crypto library in use. Internally1908 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1909 documentation for more details on the format of this option and1910 for the ssl version supported. Actually the possible values of1911 this option are:19121913 - sslv21914 - sslv31915 - tlsv11916 - tlsv1.01917 - tlsv1.11918 - tlsv1.219191920+1921Can be overridden by the `GIT_SSL_VERSION` environment variable.1922To force git to use libcurl's default ssl version and ignore any1923explicit http.sslversion option, set `GIT_SSL_VERSION` to the1924empty string.19251926http.sslCipherList::1927 A list of SSL ciphers to use when negotiating an SSL connection.1928 The available ciphers depend on whether libcurl was built against1929 NSS or OpenSSL and the particular configuration of the crypto1930 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1931 option; see the libcurl documentation for more details on the format1932 of this list.1933+1934Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1935To force git to use libcurl's default cipher list and ignore any1936explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1937empty string.19381939http.sslVerify::1940 Whether to verify the SSL certificate when fetching or pushing1941 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1942 variable.19431944http.sslCert::1945 File containing the SSL certificate when fetching or pushing1946 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1947 variable.19481949http.sslKey::1950 File containing the SSL private key when fetching or pushing1951 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1952 variable.19531954http.sslCertPasswordProtected::1955 Enable Git's password prompt for the SSL certificate. Otherwise1956 OpenSSL will prompt the user, possibly many times, if the1957 certificate or private key is encrypted. Can be overridden by the1958 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19591960http.sslCAInfo::1961 File containing the certificates to verify the peer with when1962 fetching or pushing over HTTPS. Can be overridden by the1963 `GIT_SSL_CAINFO` environment variable.19641965http.sslCAPath::1966 Path containing files with the CA certificates to verify the peer1967 with when fetching or pushing over HTTPS. Can be overridden1968 by the `GIT_SSL_CAPATH` environment variable.19691970http.pinnedpubkey::1971 Public key of the https service. It may either be the filename of1972 a PEM or DER encoded public key file or a string starting with1973 'sha256//' followed by the base64 encoded sha256 hash of the1974 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1975 exit with an error if this option is set but not supported by1976 cURL.19771978http.sslTry::1979 Attempt to use AUTH SSL/TLS and encrypted data transfers1980 when connecting via regular FTP protocol. This might be needed1981 if the FTP server requires it for security reasons or you wish1982 to connect securely whenever remote FTP server supports it.1983 Default is false since it might trigger certificate verification1984 errors on misconfigured servers.19851986http.maxRequests::1987 How many HTTP requests to launch in parallel. Can be overridden1988 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.19891990http.minSessions::1991 The number of curl sessions (counted across slots) to be kept across1992 requests. They will not be ended with curl_easy_cleanup() until1993 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1994 value will be capped at 1. Defaults to 1.19951996http.postBuffer::1997 Maximum size in bytes of the buffer used by smart HTTP1998 transports when POSTing data to the remote system.1999 For requests larger than this buffer size, HTTP/1.1 and2000 Transfer-Encoding: chunked is used to avoid creating a2001 massive pack file locally. Default is 1 MiB, which is2002 sufficient for most requests.20032004http.lowSpeedLimit, http.lowSpeedTime::2005 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2006 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2007 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2008 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20092010http.noEPSV::2011 A boolean which disables using of EPSV ftp command by curl.2012 This can helpful with some "poor" ftp servers which don't2013 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2014 environment variable. Default is false (curl will use EPSV).20152016http.userAgent::2017 The HTTP USER_AGENT string presented to an HTTP server. The default2018 value represents the version of the client Git such as git/1.7.1.2019 This option allows you to override this value to a more common value2020 such as Mozilla/4.0. This may be necessary, for instance, if2021 connecting through a firewall that restricts HTTP connections to a set2022 of common USER_AGENT strings (but not including those like git/1.7.1).2023 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20242025http.followRedirects::2026 Whether git should follow HTTP redirects. If set to `true`, git2027 will transparently follow any redirect issued by a server it2028 encounters. If set to `false`, git will treat all redirects as2029 errors. If set to `initial`, git will follow redirects only for2030 the initial request to a remote, but not for subsequent2031 follow-up HTTP requests. Since git uses the redirected URL as2032 the base for the follow-up requests, this is generally2033 sufficient. The default is `initial`.20342035http.<url>.*::2036 Any of the http.* options above can be applied selectively to some URLs.2037 For a config key to match a URL, each element of the config key is2038 compared to that of the URL, in the following order:2039+2040--2041. Scheme (e.g., `https` in `https://example.com/`). This field2042 must match exactly between the config key and the URL.20432044. Host/domain name (e.g., `example.com` in `https://example.com/`).2045 This field must match between the config key and the URL. It is2046 possible to specify a `*` as part of the host name to match all subdomains2047 at this level. `https://*.example.com/` for example would match2048 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20492050. Port number (e.g., `8080` in `http://example.com:8080/`).2051 This field must match exactly between the config key and the URL.2052 Omitted port numbers are automatically converted to the correct2053 default for the scheme before matching.20542055. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2056 path field of the config key must match the path field of the URL2057 either exactly or as a prefix of slash-delimited path elements. This means2058 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2059 match on a slash (`/`) boundary. Longer matches take precedence (so a config2060 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2061 key with just path `foo/`).20622063. User name (e.g., `user` in `https://user@example.com/repo.git`). If2064 the config key has a user name it must match the user name in the2065 URL exactly. If the config key does not have a user name, that2066 config key will match a URL with any user name (including none),2067 but at a lower precedence than a config key with a user name.2068--2069+2070The list above is ordered by decreasing precedence; a URL that matches2071a config key's path is preferred to one that matches its user name. For example,2072if the URL is `https://user@example.com/foo/bar` a config key match of2073`https://example.com/foo` will be preferred over a config key match of2074`https://user@example.com`.2075+2076All URLs are normalized before attempting any matching (the password part,2077if embedded in the URL, is always ignored for matching purposes) so that2078equivalent URLs that are simply spelled differently will match properly.2079Environment variable settings always override any matches. The URLs that are2080matched against are those given directly to Git commands. This means any URLs2081visited as a result of a redirection do not participate in matching.20822083ssh.variant::2084 By default, Git determines the command line arguments to use2085 based on the basename of the configured SSH command (configured2086 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2087 the config setting `core.sshCommand`). If the basename is2088 unrecognized, Git will attempt to detect support of OpenSSH2089 options by first invoking the configured SSH command with the2090 `-G` (print configuration) option and will subsequently use2091 OpenSSH options (if that is successful) or no options besides2092 the host and remote command (if it fails).2093+2094The config variable `ssh.variant` can be set to override this detection.2095Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2096`tortoiseplink`, `simple` (no options except the host and remote command).2097The default auto-detection can be explicitly requested using the value2098`auto`. Any other value is treated as `ssh`. This setting can also be2099overridden via the environment variable `GIT_SSH_VARIANT`.2100+2101The current command-line parameters used for each variant are as2102follows:2103+2104--21052106* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21072108* `simple` - [username@]host command21092110* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21112112* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21132114--2115+2116Except for the `simple` variant, command-line parameters are likely to2117change as git gains new features.21182119i18n.commitEncoding::2120 Character encoding the commit messages are stored in; Git itself2121 does not care per se, but this information is necessary e.g. when2122 importing commits from emails or in the gitk graphical history2123 browser (and possibly at other places in the future or in other2124 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21252126i18n.logOutputEncoding::2127 Character encoding the commit messages are converted to when2128 running 'git log' and friends.21292130imap::2131 The configuration variables in the 'imap' section are described2132 in linkgit:git-imap-send[1].21332134index.version::2135 Specify the version with which new index files should be2136 initialized. This does not affect existing repositories.21372138init.templateDir::2139 Specify the directory from which templates will be copied.2140 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21412142instaweb.browser::2143 Specify the program that will be used to browse your working2144 repository in gitweb. See linkgit:git-instaweb[1].21452146instaweb.httpd::2147 The HTTP daemon command-line to start gitweb on your working2148 repository. See linkgit:git-instaweb[1].21492150instaweb.local::2151 If true the web server started by linkgit:git-instaweb[1] will2152 be bound to the local IP (127.0.0.1).21532154instaweb.modulePath::2155 The default module path for linkgit:git-instaweb[1] to use2156 instead of /usr/lib/apache2/modules. Only used if httpd2157 is Apache.21582159instaweb.port::2160 The port number to bind the gitweb httpd to. See2161 linkgit:git-instaweb[1].21622163interactive.singleKey::2164 In interactive commands, allow the user to provide one-letter2165 input with a single key (i.e., without hitting enter).2166 Currently this is used by the `--patch` mode of2167 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2168 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2169 setting is silently ignored if portable keystroke input2170 is not available; requires the Perl module Term::ReadKey.21712172interactive.diffFilter::2173 When an interactive command (such as `git add --patch`) shows2174 a colorized diff, git will pipe the diff through the shell2175 command defined by this configuration variable. The command may2176 mark up the diff further for human consumption, provided that it2177 retains a one-to-one correspondence with the lines in the2178 original diff. Defaults to disabled (no filtering).21792180log.abbrevCommit::2181 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2182 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2183 override this option with `--no-abbrev-commit`.21842185log.date::2186 Set the default date-time mode for the 'log' command.2187 Setting a value for log.date is similar to using 'git log''s2188 `--date` option. See linkgit:git-log[1] for details.21892190log.decorate::2191 Print out the ref names of any commits that are shown by the log2192 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2193 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2194 specified, the full ref name (including prefix) will be printed.2195 If 'auto' is specified, then if the output is going to a terminal,2196 the ref names are shown as if 'short' were given, otherwise no ref2197 names are shown. This is the same as the `--decorate` option2198 of the `git log`.21992200log.follow::2201 If `true`, `git log` will act as if the `--follow` option was used when2202 a single <path> is given. This has the same limitations as `--follow`,2203 i.e. it cannot be used to follow multiple files and does not work well2204 on non-linear history.22052206log.graphColors::2207 A list of colors, separated by commas, that can be used to draw2208 history lines in `git log --graph`.22092210log.showRoot::2211 If true, the initial commit will be shown as a big creation event.2212 This is equivalent to a diff against an empty tree.2213 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2214 normally hide the root commit will now show it. True by default.22152216log.showSignature::2217 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2218 linkgit:git-whatchanged[1] assume `--show-signature`.22192220log.mailmap::2221 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2222 linkgit:git-whatchanged[1] assume `--use-mailmap`.22232224mailinfo.scissors::2225 If true, makes linkgit:git-mailinfo[1] (and therefore2226 linkgit:git-am[1]) act by default as if the --scissors option2227 was provided on the command-line. When active, this features2228 removes everything from the message body before a scissors2229 line (i.e. consisting mainly of ">8", "8<" and "-").22302231mailmap.file::2232 The location of an augmenting mailmap file. The default2233 mailmap, located in the root of the repository, is loaded2234 first, then the mailmap file pointed to by this variable.2235 The location of the mailmap file may be in a repository2236 subdirectory, or somewhere outside of the repository itself.2237 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22382239mailmap.blob::2240 Like `mailmap.file`, but consider the value as a reference to a2241 blob in the repository. If both `mailmap.file` and2242 `mailmap.blob` are given, both are parsed, with entries from2243 `mailmap.file` taking precedence. In a bare repository, this2244 defaults to `HEAD:.mailmap`. In a non-bare repository, it2245 defaults to empty.22462247man.viewer::2248 Specify the programs that may be used to display help in the2249 'man' format. See linkgit:git-help[1].22502251man.<tool>.cmd::2252 Specify the command to invoke the specified man viewer. The2253 specified command is evaluated in shell with the man page2254 passed as argument. (See linkgit:git-help[1].)22552256man.<tool>.path::2257 Override the path for the given tool that may be used to2258 display help in the 'man' format. See linkgit:git-help[1].22592260include::merge-config.txt[]22612262mergetool.<tool>.path::2263 Override the path for the given tool. This is useful in case2264 your tool is not in the PATH.22652266mergetool.<tool>.cmd::2267 Specify the command to invoke the specified merge tool. The2268 specified command is evaluated in shell with the following2269 variables available: 'BASE' is the name of a temporary file2270 containing the common base of the files to be merged, if available;2271 'LOCAL' is the name of a temporary file containing the contents of2272 the file on the current branch; 'REMOTE' is the name of a temporary2273 file containing the contents of the file from the branch being2274 merged; 'MERGED' contains the name of the file to which the merge2275 tool should write the results of a successful merge.22762277mergetool.<tool>.trustExitCode::2278 For a custom merge command, specify whether the exit code of2279 the merge command can be used to determine whether the merge was2280 successful. If this is not set to true then the merge target file2281 timestamp is checked and the merge assumed to have been successful2282 if the file has been updated, otherwise the user is prompted to2283 indicate the success of the merge.22842285mergetool.meld.hasOutput::2286 Older versions of `meld` do not support the `--output` option.2287 Git will attempt to detect whether `meld` supports `--output`2288 by inspecting the output of `meld --help`. Configuring2289 `mergetool.meld.hasOutput` will make Git skip these checks and2290 use the configured value instead. Setting `mergetool.meld.hasOutput`2291 to `true` tells Git to unconditionally use the `--output` option,2292 and `false` avoids using `--output`.22932294mergetool.keepBackup::2295 After performing a merge, the original file with conflict markers2296 can be saved as a file with a `.orig` extension. If this variable2297 is set to `false` then this file is not preserved. Defaults to2298 `true` (i.e. keep the backup files).22992300mergetool.keepTemporaries::2301 When invoking a custom merge tool, Git uses a set of temporary2302 files to pass to the tool. If the tool returns an error and this2303 variable is set to `true`, then these temporary files will be2304 preserved, otherwise they will be removed after the tool has2305 exited. Defaults to `false`.23062307mergetool.writeToTemp::2308 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2309 conflicting files in the worktree by default. Git will attempt2310 to use a temporary directory for these files when set `true`.2311 Defaults to `false`.23122313mergetool.prompt::2314 Prompt before each invocation of the merge resolution program.23152316notes.mergeStrategy::2317 Which merge strategy to choose by default when resolving notes2318 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2319 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2320 section of linkgit:git-notes[1] for more information on each strategy.23212322notes.<name>.mergeStrategy::2323 Which merge strategy to choose when doing a notes merge into2324 refs/notes/<name>. This overrides the more general2325 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2326 linkgit:git-notes[1] for more information on the available strategies.23272328notes.displayRef::2329 The (fully qualified) refname from which to show notes when2330 showing commit messages. The value of this variable can be set2331 to a glob, in which case notes from all matching refs will be2332 shown. You may also specify this configuration variable2333 several times. A warning will be issued for refs that do not2334 exist, but a glob that does not match any refs is silently2335 ignored.2336+2337This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2338environment variable, which must be a colon separated list of refs or2339globs.2340+2341The effective value of "core.notesRef" (possibly overridden by2342GIT_NOTES_REF) is also implicitly added to the list of refs to be2343displayed.23442345notes.rewrite.<command>::2346 When rewriting commits with <command> (currently `amend` or2347 `rebase`) and this variable is set to `true`, Git2348 automatically copies your notes from the original to the2349 rewritten commit. Defaults to `true`, but see2350 "notes.rewriteRef" below.23512352notes.rewriteMode::2353 When copying notes during a rewrite (see the2354 "notes.rewrite.<command>" option), determines what to do if2355 the target commit already has a note. Must be one of2356 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2357 Defaults to `concatenate`.2358+2359This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2360environment variable.23612362notes.rewriteRef::2363 When copying notes during a rewrite, specifies the (fully2364 qualified) ref whose notes should be copied. The ref may be a2365 glob, in which case notes in all matching refs will be copied.2366 You may also specify this configuration several times.2367+2368Does not have a default value; you must configure this variable to2369enable note rewriting. Set it to `refs/notes/commits` to enable2370rewriting for the default commit notes.2371+2372This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2373environment variable, which must be a colon separated list of refs or2374globs.23752376pack.window::2377 The size of the window used by linkgit:git-pack-objects[1] when no2378 window size is given on the command line. Defaults to 10.23792380pack.depth::2381 The maximum delta depth used by linkgit:git-pack-objects[1] when no2382 maximum depth is given on the command line. Defaults to 50.23832384pack.windowMemory::2385 The maximum size of memory that is consumed by each thread2386 in linkgit:git-pack-objects[1] for pack window memory when2387 no limit is given on the command line. The value can be2388 suffixed with "k", "m", or "g". When left unconfigured (or2389 set explicitly to 0), there will be no limit.23902391pack.compression::2392 An integer -1..9, indicating the compression level for objects2393 in a pack file. -1 is the zlib default. 0 means no2394 compression, and 1..9 are various speed/size tradeoffs, 9 being2395 slowest. If not set, defaults to core.compression. If that is2396 not set, defaults to -1, the zlib default, which is "a default2397 compromise between speed and compression (currently equivalent2398 to level 6)."2399+2400Note that changing the compression level will not automatically recompress2401all existing objects. You can force recompression by passing the -F option2402to linkgit:git-repack[1].24032404pack.deltaCacheSize::2405 The maximum memory in bytes used for caching deltas in2406 linkgit:git-pack-objects[1] before writing them out to a pack.2407 This cache is used to speed up the writing object phase by not2408 having to recompute the final delta result once the best match2409 for all objects is found. Repacking large repositories on machines2410 which are tight with memory might be badly impacted by this though,2411 especially if this cache pushes the system into swapping.2412 A value of 0 means no limit. The smallest size of 1 byte may be2413 used to virtually disable this cache. Defaults to 256 MiB.24142415pack.deltaCacheLimit::2416 The maximum size of a delta, that is cached in2417 linkgit:git-pack-objects[1]. This cache is used to speed up the2418 writing object phase by not having to recompute the final delta2419 result once the best match for all objects is found. Defaults to 1000.24202421pack.threads::2422 Specifies the number of threads to spawn when searching for best2423 delta matches. This requires that linkgit:git-pack-objects[1]2424 be compiled with pthreads otherwise this option is ignored with a2425 warning. This is meant to reduce packing time on multiprocessor2426 machines. The required amount of memory for the delta search window2427 is however multiplied by the number of threads.2428 Specifying 0 will cause Git to auto-detect the number of CPU's2429 and set the number of threads accordingly.24302431pack.indexVersion::2432 Specify the default pack index version. Valid values are 1 for2433 legacy pack index used by Git versions prior to 1.5.2, and 2 for2434 the new pack index with capabilities for packs larger than 4 GB2435 as well as proper protection against the repacking of corrupted2436 packs. Version 2 is the default. Note that version 2 is enforced2437 and this config option ignored whenever the corresponding pack is2438 larger than 2 GB.2439+2440If you have an old Git that does not understand the version 2 `*.idx` file,2441cloning or fetching over a non native protocol (e.g. "http")2442that will copy both `*.pack` file and corresponding `*.idx` file from the2443other side may give you a repository that cannot be accessed with your2444older version of Git. If the `*.pack` file is smaller than 2 GB, however,2445you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2446the `*.idx` file.24472448pack.packSizeLimit::2449 The maximum size of a pack. This setting only affects2450 packing to a file when repacking, i.e. the git:// protocol2451 is unaffected. It can be overridden by the `--max-pack-size`2452 option of linkgit:git-repack[1]. Reaching this limit results2453 in the creation of multiple packfiles; which in turn prevents2454 bitmaps from being created.2455 The minimum size allowed is limited to 1 MiB.2456 The default is unlimited.2457 Common unit suffixes of 'k', 'm', or 'g' are2458 supported.24592460pack.useBitmaps::2461 When true, git will use pack bitmaps (if available) when packing2462 to stdout (e.g., during the server side of a fetch). Defaults to2463 true. You should not generally need to turn this off unless2464 you are debugging pack bitmaps.24652466pack.writeBitmaps (deprecated)::2467 This is a deprecated synonym for `repack.writeBitmaps`.24682469pack.writeBitmapHashCache::2470 When true, git will include a "hash cache" section in the bitmap2471 index (if one is written). This cache can be used to feed git's2472 delta heuristics, potentially leading to better deltas between2473 bitmapped and non-bitmapped objects (e.g., when serving a fetch2474 between an older, bitmapped pack and objects that have been2475 pushed since the last gc). The downside is that it consumes 42476 bytes per object of disk space, and that JGit's bitmap2477 implementation does not understand it, causing it to complain if2478 Git and JGit are used on the same repository. Defaults to false.24792480pager.<cmd>::2481 If the value is boolean, turns on or off pagination of the2482 output of a particular Git subcommand when writing to a tty.2483 Otherwise, turns on pagination for the subcommand using the2484 pager specified by the value of `pager.<cmd>`. If `--paginate`2485 or `--no-pager` is specified on the command line, it takes2486 precedence over this option. To disable pagination for all2487 commands, set `core.pager` or `GIT_PAGER` to `cat`.24882489pretty.<name>::2490 Alias for a --pretty= format string, as specified in2491 linkgit:git-log[1]. Any aliases defined here can be used just2492 as the built-in pretty formats could. For example,2493 running `git config pretty.changelog "format:* %H %s"`2494 would cause the invocation `git log --pretty=changelog`2495 to be equivalent to running `git log "--pretty=format:* %H %s"`.2496 Note that an alias with the same name as a built-in format2497 will be silently ignored.24982499protocol.allow::2500 If set, provide a user defined default policy for all protocols which2501 don't explicitly have a policy (`protocol.<name>.allow`). By default,2502 if unset, known-safe protocols (http, https, git, ssh, file) have a2503 default policy of `always`, known-dangerous protocols (ext) have a2504 default policy of `never`, and all other protocols have a default2505 policy of `user`. Supported policies:2506+2507--25082509* `always` - protocol is always able to be used.25102511* `never` - protocol is never able to be used.25122513* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2514 either unset or has a value of 1. This policy should be used when you want a2515 protocol to be directly usable by the user but don't want it used by commands which2516 execute clone/fetch/push commands without user input, e.g. recursive2517 submodule initialization.25182519--25202521protocol.<name>.allow::2522 Set a policy to be used by protocol `<name>` with clone/fetch/push2523 commands. See `protocol.allow` above for the available policies.2524+2525The protocol names currently used by git are:2526+2527--2528 - `file`: any local file-based path (including `file://` URLs,2529 or local paths)25302531 - `git`: the anonymous git protocol over a direct TCP2532 connection (or proxy, if configured)25332534 - `ssh`: git over ssh (including `host:path` syntax,2535 `ssh://`, etc).25362537 - `http`: git over http, both "smart http" and "dumb http".2538 Note that this does _not_ include `https`; if you want to configure2539 both, you must do so individually.25402541 - any external helpers are named by their protocol (e.g., use2542 `hg` to allow the `git-remote-hg` helper)2543--25442545protocol.version::2546 Experimental. If set, clients will attempt to communicate with a2547 server using the specified protocol version. If unset, no2548 attempt will be made by the client to communicate using a2549 particular protocol version, this results in protocol version 02550 being used.2551 Supported versions:2552+2553--25542555* `0` - the original wire protocol.25562557* `1` - the original wire protocol with the addition of a version string2558 in the initial response from the server.25592560--25612562pull.ff::2563 By default, Git does not create an extra merge commit when merging2564 a commit that is a descendant of the current commit. Instead, the2565 tip of the current branch is fast-forwarded. When set to `false`,2566 this variable tells Git to create an extra merge commit in such2567 a case (equivalent to giving the `--no-ff` option from the command2568 line). When set to `only`, only such fast-forward merges are2569 allowed (equivalent to giving the `--ff-only` option from the2570 command line). This setting overrides `merge.ff` when pulling.25712572pull.rebase::2573 When true, rebase branches on top of the fetched branch, instead2574 of merging the default branch from the default remote when "git2575 pull" is run. See "branch.<name>.rebase" for setting this on a2576 per-branch basis.2577+2578When preserve, also pass `--preserve-merges` along to 'git rebase'2579so that locally committed merge commits will not be flattened2580by running 'git pull'.2581+2582When the value is `interactive`, the rebase is run in interactive mode.2583+2584*NOTE*: this is a possibly dangerous operation; do *not* use2585it unless you understand the implications (see linkgit:git-rebase[1]2586for details).25872588pull.octopus::2589 The default merge strategy to use when pulling multiple branches2590 at once.25912592pull.twohead::2593 The default merge strategy to use when pulling a single branch.25942595push.default::2596 Defines the action `git push` should take if no refspec is2597 explicitly given. Different values are well-suited for2598 specific workflows; for instance, in a purely central workflow2599 (i.e. the fetch source is equal to the push destination),2600 `upstream` is probably what you want. Possible values are:2601+2602--26032604* `nothing` - do not push anything (error out) unless a refspec is2605 explicitly given. This is primarily meant for people who want to2606 avoid mistakes by always being explicit.26072608* `current` - push the current branch to update a branch with the same2609 name on the receiving end. Works in both central and non-central2610 workflows.26112612* `upstream` - push the current branch back to the branch whose2613 changes are usually integrated into the current branch (which is2614 called `@{upstream}`). This mode only makes sense if you are2615 pushing to the same repository you would normally pull from2616 (i.e. central workflow).26172618* `tracking` - This is a deprecated synonym for `upstream`.26192620* `simple` - in centralized workflow, work like `upstream` with an2621 added safety to refuse to push if the upstream branch's name is2622 different from the local one.2623+2624When pushing to a remote that is different from the remote you normally2625pull from, work as `current`. This is the safest option and is suited2626for beginners.2627+2628This mode has become the default in Git 2.0.26292630* `matching` - push all branches having the same name on both ends.2631 This makes the repository you are pushing to remember the set of2632 branches that will be pushed out (e.g. if you always push 'maint'2633 and 'master' there and no other branches, the repository you push2634 to will have these two branches, and your local 'maint' and2635 'master' will be pushed there).2636+2637To use this mode effectively, you have to make sure _all_ the2638branches you would push out are ready to be pushed out before2639running 'git push', as the whole point of this mode is to allow you2640to push all of the branches in one go. If you usually finish work2641on only one branch and push out the result, while other branches are2642unfinished, this mode is not for you. Also this mode is not2643suitable for pushing into a shared central repository, as other2644people may add new branches there, or update the tip of existing2645branches outside your control.2646+2647This used to be the default, but not since Git 2.0 (`simple` is the2648new default).26492650--26512652push.followTags::2653 If set to true enable `--follow-tags` option by default. You2654 may override this configuration at time of push by specifying2655 `--no-follow-tags`.26562657push.gpgSign::2658 May be set to a boolean value, or the string 'if-asked'. A true2659 value causes all pushes to be GPG signed, as if `--signed` is2660 passed to linkgit:git-push[1]. The string 'if-asked' causes2661 pushes to be signed if the server supports it, as if2662 `--signed=if-asked` is passed to 'git push'. A false value may2663 override a value from a lower-priority config file. An explicit2664 command-line flag always overrides this config option.26652666push.recurseSubmodules::2667 Make sure all submodule commits used by the revisions to be pushed2668 are available on a remote-tracking branch. If the value is 'check'2669 then Git will verify that all submodule commits that changed in the2670 revisions to be pushed are available on at least one remote of the2671 submodule. If any commits are missing, the push will be aborted and2672 exit with non-zero status. If the value is 'on-demand' then all2673 submodules that changed in the revisions to be pushed will be2674 pushed. If on-demand was not able to push all necessary revisions2675 it will also be aborted and exit with non-zero status. If the value2676 is 'no' then default behavior of ignoring submodules when pushing2677 is retained. You may override this configuration at time of push by2678 specifying '--recurse-submodules=check|on-demand|no'.26792680rebase.stat::2681 Whether to show a diffstat of what changed upstream since the last2682 rebase. False by default.26832684rebase.autoSquash::2685 If set to true enable `--autosquash` option by default.26862687rebase.autoStash::2688 When set to true, automatically create a temporary stash entry2689 before the operation begins, and apply it after the operation2690 ends. This means that you can run rebase on a dirty worktree.2691 However, use with care: the final stash application after a2692 successful rebase might result in non-trivial conflicts.2693 Defaults to false.26942695rebase.missingCommitsCheck::2696 If set to "warn", git rebase -i will print a warning if some2697 commits are removed (e.g. a line was deleted), however the2698 rebase will still proceed. If set to "error", it will print2699 the previous warning and stop the rebase, 'git rebase2700 --edit-todo' can then be used to correct the error. If set to2701 "ignore", no checking is done.2702 To drop a commit without warning or error, use the `drop`2703 command in the todo-list.2704 Defaults to "ignore".27052706rebase.instructionFormat::2707 A format string, as specified in linkgit:git-log[1], to be used for2708 the instruction list during an interactive rebase. The format will automatically2709 have the long commit hash prepended to the format.27102711receive.advertiseAtomic::2712 By default, git-receive-pack will advertise the atomic push2713 capability to its clients. If you don't want to advertise this2714 capability, set this variable to false.27152716receive.advertisePushOptions::2717 When set to true, git-receive-pack will advertise the push options2718 capability to its clients. False by default.27192720receive.autogc::2721 By default, git-receive-pack will run "git-gc --auto" after2722 receiving data from git-push and updating refs. You can stop2723 it by setting this variable to false.27242725receive.certNonceSeed::2726 By setting this variable to a string, `git receive-pack`2727 will accept a `git push --signed` and verifies it by using2728 a "nonce" protected by HMAC using this string as a secret2729 key.27302731receive.certNonceSlop::2732 When a `git push --signed` sent a push certificate with a2733 "nonce" that was issued by a receive-pack serving the same2734 repository within this many seconds, export the "nonce"2735 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2736 hooks (instead of what the receive-pack asked the sending2737 side to include). This may allow writing checks in2738 `pre-receive` and `post-receive` a bit easier. Instead of2739 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2740 that records by how many seconds the nonce is stale to2741 decide if they want to accept the certificate, they only2742 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27432744receive.fsckObjects::2745 If it is set to true, git-receive-pack will check all received2746 objects. It will abort in the case of a malformed object or a2747 broken link. The result of an abort are only dangling objects.2748 Defaults to false. If not set, the value of `transfer.fsckObjects`2749 is used instead.27502751receive.fsck.<msg-id>::2752 When `receive.fsckObjects` is set to true, errors can be switched2753 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2754 setting where the `<msg-id>` is the fsck message ID and the value2755 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2756 the error/warning with the message ID, e.g. "missingEmail: invalid2757 author/committer line - missing email" means that setting2758 `receive.fsck.missingEmail = ignore` will hide that issue.2759+2760This feature is intended to support working with legacy repositories2761which would not pass pushing when `receive.fsckObjects = true`, allowing2762the host to accept repositories with certain known issues but still catch2763other issues.27642765receive.fsck.skipList::2766 The path to a sorted list of object names (i.e. one SHA-1 per2767 line) that are known to be broken in a non-fatal way and should2768 be ignored. This feature is useful when an established project2769 should be accepted despite early commits containing errors that2770 can be safely ignored such as invalid committer email addresses.2771 Note: corrupt objects cannot be skipped with this setting.27722773receive.keepAlive::2774 After receiving the pack from the client, `receive-pack` may2775 produce no output (if `--quiet` was specified) while processing2776 the pack, causing some networks to drop the TCP connection.2777 With this option set, if `receive-pack` does not transmit2778 any data in this phase for `receive.keepAlive` seconds, it will2779 send a short keepalive packet. The default is 5 seconds; set2780 to 0 to disable keepalives entirely.27812782receive.unpackLimit::2783 If the number of objects received in a push is below this2784 limit then the objects will be unpacked into loose object2785 files. However if the number of received objects equals or2786 exceeds this limit then the received pack will be stored as2787 a pack, after adding any missing delta bases. Storing the2788 pack from a push can make the push operation complete faster,2789 especially on slow filesystems. If not set, the value of2790 `transfer.unpackLimit` is used instead.27912792receive.maxInputSize::2793 If the size of the incoming pack stream is larger than this2794 limit, then git-receive-pack will error out, instead of2795 accepting the pack file. If not set or set to 0, then the size2796 is unlimited.27972798receive.denyDeletes::2799 If set to true, git-receive-pack will deny a ref update that deletes2800 the ref. Use this to prevent such a ref deletion via a push.28012802receive.denyDeleteCurrent::2803 If set to true, git-receive-pack will deny a ref update that2804 deletes the currently checked out branch of a non-bare repository.28052806receive.denyCurrentBranch::2807 If set to true or "refuse", git-receive-pack will deny a ref update2808 to the currently checked out branch of a non-bare repository.2809 Such a push is potentially dangerous because it brings the HEAD2810 out of sync with the index and working tree. If set to "warn",2811 print a warning of such a push to stderr, but allow the push to2812 proceed. If set to false or "ignore", allow such pushes with no2813 message. Defaults to "refuse".2814+2815Another option is "updateInstead" which will update the working2816tree if pushing into the current branch. This option is2817intended for synchronizing working directories when one side is not easily2818accessible via interactive ssh (e.g. a live web site, hence the requirement2819that the working directory be clean). This mode also comes in handy when2820developing inside a VM to test and fix code on different Operating Systems.2821+2822By default, "updateInstead" will refuse the push if the working tree or2823the index have any difference from the HEAD, but the `push-to-checkout`2824hook can be used to customize this. See linkgit:githooks[5].28252826receive.denyNonFastForwards::2827 If set to true, git-receive-pack will deny a ref update which is2828 not a fast-forward. Use this to prevent such an update via a push,2829 even if that push is forced. This configuration variable is2830 set when initializing a shared repository.28312832receive.hideRefs::2833 This variable is the same as `transfer.hideRefs`, but applies2834 only to `receive-pack` (and so affects pushes, but not fetches).2835 An attempt to update or delete a hidden ref by `git push` is2836 rejected.28372838receive.updateServerInfo::2839 If set to true, git-receive-pack will run git-update-server-info2840 after receiving data from git-push and updating refs.28412842receive.shallowUpdate::2843 If set to true, .git/shallow can be updated when new refs2844 require new shallow roots. Otherwise those refs are rejected.28452846remote.pushDefault::2847 The remote to push to by default. Overrides2848 `branch.<name>.remote` for all branches, and is overridden by2849 `branch.<name>.pushRemote` for specific branches.28502851remote.<name>.url::2852 The URL of a remote repository. See linkgit:git-fetch[1] or2853 linkgit:git-push[1].28542855remote.<name>.pushurl::2856 The push URL of a remote repository. See linkgit:git-push[1].28572858remote.<name>.proxy::2859 For remotes that require curl (http, https and ftp), the URL to2860 the proxy to use for that remote. Set to the empty string to2861 disable proxying for that remote.28622863remote.<name>.proxyAuthMethod::2864 For remotes that require curl (http, https and ftp), the method to use for2865 authenticating against the proxy in use (probably set in2866 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28672868remote.<name>.fetch::2869 The default set of "refspec" for linkgit:git-fetch[1]. See2870 linkgit:git-fetch[1].28712872remote.<name>.push::2873 The default set of "refspec" for linkgit:git-push[1]. See2874 linkgit:git-push[1].28752876remote.<name>.mirror::2877 If true, pushing to this remote will automatically behave2878 as if the `--mirror` option was given on the command line.28792880remote.<name>.skipDefaultUpdate::2881 If true, this remote will be skipped by default when updating2882 using linkgit:git-fetch[1] or the `update` subcommand of2883 linkgit:git-remote[1].28842885remote.<name>.skipFetchAll::2886 If true, this remote will be skipped by default when updating2887 using linkgit:git-fetch[1] or the `update` subcommand of2888 linkgit:git-remote[1].28892890remote.<name>.receivepack::2891 The default program to execute on the remote side when pushing. See2892 option --receive-pack of linkgit:git-push[1].28932894remote.<name>.uploadpack::2895 The default program to execute on the remote side when fetching. See2896 option --upload-pack of linkgit:git-fetch-pack[1].28972898remote.<name>.tagOpt::2899 Setting this value to --no-tags disables automatic tag following when2900 fetching from remote <name>. Setting it to --tags will fetch every2901 tag from remote <name>, even if they are not reachable from remote2902 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2903 override this setting. See options --tags and --no-tags of2904 linkgit:git-fetch[1].29052906remote.<name>.vcs::2907 Setting this to a value <vcs> will cause Git to interact with2908 the remote with the git-remote-<vcs> helper.29092910remote.<name>.prune::2911 When set to true, fetching from this remote by default will also2912 remove any remote-tracking references that no longer exist on the2913 remote (as if the `--prune` option was given on the command line).2914 Overrides `fetch.prune` settings, if any.29152916remotes.<group>::2917 The list of remotes which are fetched by "git remote update2918 <group>". See linkgit:git-remote[1].29192920repack.useDeltaBaseOffset::2921 By default, linkgit:git-repack[1] creates packs that use2922 delta-base offset. If you need to share your repository with2923 Git older than version 1.4.4, either directly or via a dumb2924 protocol such as http, then you need to set this option to2925 "false" and repack. Access from old Git versions over the2926 native protocol are unaffected by this option.29272928repack.packKeptObjects::2929 If set to true, makes `git repack` act as if2930 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2931 details. Defaults to `false` normally, but `true` if a bitmap2932 index is being written (either via `--write-bitmap-index` or2933 `repack.writeBitmaps`).29342935repack.writeBitmaps::2936 When true, git will write a bitmap index when packing all2937 objects to disk (e.g., when `git repack -a` is run). This2938 index can speed up the "counting objects" phase of subsequent2939 packs created for clones and fetches, at the cost of some disk2940 space and extra time spent on the initial repack. This has2941 no effect if multiple packfiles are created.2942 Defaults to false.29432944rerere.autoUpdate::2945 When set to true, `git-rerere` updates the index with the2946 resulting contents after it cleanly resolves conflicts using2947 previously recorded resolution. Defaults to false.29482949rerere.enabled::2950 Activate recording of resolved conflicts, so that identical2951 conflict hunks can be resolved automatically, should they be2952 encountered again. By default, linkgit:git-rerere[1] is2953 enabled if there is an `rr-cache` directory under the2954 `$GIT_DIR`, e.g. if "rerere" was previously used in the2955 repository.29562957sendemail.identity::2958 A configuration identity. When given, causes values in the2959 'sendemail.<identity>' subsection to take precedence over2960 values in the 'sendemail' section. The default identity is2961 the value of `sendemail.identity`.29622963sendemail.smtpEncryption::2964 See linkgit:git-send-email[1] for description. Note that this2965 setting is not subject to the 'identity' mechanism.29662967sendemail.smtpssl (deprecated)::2968 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29692970sendemail.smtpsslcertpath::2971 Path to ca-certificates (either a directory or a single file).2972 Set it to an empty string to disable certificate verification.29732974sendemail.<identity>.*::2975 Identity-specific versions of the 'sendemail.*' parameters2976 found below, taking precedence over those when this2977 identity is selected, through either the command-line or2978 `sendemail.identity`.29792980sendemail.aliasesFile::2981sendemail.aliasFileType::2982sendemail.annotate::2983sendemail.bcc::2984sendemail.cc::2985sendemail.ccCmd::2986sendemail.chainReplyTo::2987sendemail.confirm::2988sendemail.envelopeSender::2989sendemail.from::2990sendemail.multiEdit::2991sendemail.signedoffbycc::2992sendemail.smtpPass::2993sendemail.suppresscc::2994sendemail.suppressFrom::2995sendemail.to::2996sendemail.smtpDomain::2997sendemail.smtpServer::2998sendemail.smtpServerPort::2999sendemail.smtpServerOption::3000sendemail.smtpUser::3001sendemail.thread::3002sendemail.transferEncoding::3003sendemail.validate::3004sendemail.xmailer::3005 See linkgit:git-send-email[1] for description.30063007sendemail.signedoffcc (deprecated)::3008 Deprecated alias for `sendemail.signedoffbycc`.30093010sendemail.smtpBatchSize::3011 Number of messages to be sent per connection, after that a relogin3012 will happen. If the value is 0 or undefined, send all messages in3013 one connection.3014 See also the `--batch-size` option of linkgit:git-send-email[1].30153016sendemail.smtpReloginDelay::3017 Seconds wait before reconnecting to smtp server.3018 See also the `--relogin-delay` option of linkgit:git-send-email[1].30193020showbranch.default::3021 The default set of branches for linkgit:git-show-branch[1].3022 See linkgit:git-show-branch[1].30233024splitIndex.maxPercentChange::3025 When the split index feature is used, this specifies the3026 percent of entries the split index can contain compared to the3027 total number of entries in both the split index and the shared3028 index before a new shared index is written.3029 The value should be between 0 and 100. If the value is 0 then3030 a new shared index is always written, if it is 100 a new3031 shared index is never written.3032 By default the value is 20, so a new shared index is written3033 if the number of entries in the split index would be greater3034 than 20 percent of the total number of entries.3035 See linkgit:git-update-index[1].30363037splitIndex.sharedIndexExpire::3038 When the split index feature is used, shared index files that3039 were not modified since the time this variable specifies will3040 be removed when a new shared index file is created. The value3041 "now" expires all entries immediately, and "never" suppresses3042 expiration altogether.3043 The default value is "2.weeks.ago".3044 Note that a shared index file is considered modified (for the3045 purpose of expiration) each time a new split-index file is3046 either created based on it or read from it.3047 See linkgit:git-update-index[1].30483049status.relativePaths::3050 By default, linkgit:git-status[1] shows paths relative to the3051 current directory. Setting this variable to `false` shows paths3052 relative to the repository root (this was the default for Git3053 prior to v1.5.4).30543055status.short::3056 Set to true to enable --short by default in linkgit:git-status[1].3057 The option --no-short takes precedence over this variable.30583059status.branch::3060 Set to true to enable --branch by default in linkgit:git-status[1].3061 The option --no-branch takes precedence over this variable.30623063status.displayCommentPrefix::3064 If set to true, linkgit:git-status[1] will insert a comment3065 prefix before each output line (starting with3066 `core.commentChar`, i.e. `#` by default). This was the3067 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3068 Defaults to false.30693070status.showStash::3071 If set to true, linkgit:git-status[1] will display the number of3072 entries currently stashed away.3073 Defaults to false.30743075status.showUntrackedFiles::3076 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3077 files which are not currently tracked by Git. Directories which3078 contain only untracked files, are shown with the directory name3079 only. Showing untracked files means that Git needs to lstat() all3080 the files in the whole repository, which might be slow on some3081 systems. So, this variable controls how the commands displays3082 the untracked files. Possible values are:3083+3084--3085* `no` - Show no untracked files.3086* `normal` - Show untracked files and directories.3087* `all` - Show also individual files in untracked directories.3088--3089+3090If this variable is not specified, it defaults to 'normal'.3091This variable can be overridden with the -u|--untracked-files option3092of linkgit:git-status[1] and linkgit:git-commit[1].30933094status.submoduleSummary::3095 Defaults to false.3096 If this is set to a non zero number or true (identical to -1 or an3097 unlimited number), the submodule summary will be enabled and a3098 summary of commits for modified submodules will be shown (see3099 --summary-limit option of linkgit:git-submodule[1]). Please note3100 that the summary output command will be suppressed for all3101 submodules when `diff.ignoreSubmodules` is set to 'all' or only3102 for those submodules where `submodule.<name>.ignore=all`. The only3103 exception to that rule is that status and commit will show staged3104 submodule changes. To3105 also view the summary for ignored submodules you can either use3106 the --ignore-submodules=dirty command-line option or the 'git3107 submodule summary' command, which shows a similar output but does3108 not honor these settings.31093110stash.showPatch::3111 If this is set to true, the `git stash show` command without an3112 option will show the stash entry in patch form. Defaults to false.3113 See description of 'show' command in linkgit:git-stash[1].31143115stash.showStat::3116 If this is set to true, the `git stash show` command without an3117 option will show diffstat of the stash entry. Defaults to true.3118 See description of 'show' command in linkgit:git-stash[1].31193120submodule.<name>.url::3121 The URL for a submodule. This variable is copied from the .gitmodules3122 file to the git config via 'git submodule init'. The user can change3123 the configured URL before obtaining the submodule via 'git submodule3124 update'. If neither submodule.<name>.active or submodule.active are3125 set, the presence of this variable is used as a fallback to indicate3126 whether the submodule is of interest to git commands.3127 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31283129submodule.<name>.update::3130 The default update procedure for a submodule. This variable3131 is populated by `git submodule init` from the3132 linkgit:gitmodules[5] file. See description of 'update'3133 command in linkgit:git-submodule[1].31343135submodule.<name>.branch::3136 The remote branch name for a submodule, used by `git submodule3137 update --remote`. Set this option to override the value found in3138 the `.gitmodules` file. See linkgit:git-submodule[1] and3139 linkgit:gitmodules[5] for details.31403141submodule.<name>.fetchRecurseSubmodules::3142 This option can be used to control recursive fetching of this3143 submodule. It can be overridden by using the --[no-]recurse-submodules3144 command-line option to "git fetch" and "git pull".3145 This setting will override that from in the linkgit:gitmodules[5]3146 file.31473148submodule.<name>.ignore::3149 Defines under what circumstances "git status" and the diff family show3150 a submodule as modified. When set to "all", it will never be considered3151 modified (but it will nonetheless show up in the output of status and3152 commit when it has been staged), "dirty" will ignore all changes3153 to the submodules work tree and3154 takes only differences between the HEAD of the submodule and the commit3155 recorded in the superproject into account. "untracked" will additionally3156 let submodules with modified tracked files in their work tree show up.3157 Using "none" (the default when this option is not set) also shows3158 submodules that have untracked files in their work tree as changed.3159 This setting overrides any setting made in .gitmodules for this submodule,3160 both settings can be overridden on the command line by using the3161 "--ignore-submodules" option. The 'git submodule' commands are not3162 affected by this setting.31633164submodule.<name>.active::3165 Boolean value indicating if the submodule is of interest to git3166 commands. This config option takes precedence over the3167 submodule.active config option.31683169submodule.active::3170 A repeated field which contains a pathspec used to match against a3171 submodule's path to determine if the submodule is of interest to git3172 commands.31733174submodule.recurse::3175 Specifies if commands recurse into submodules by default. This3176 applies to all commands that have a `--recurse-submodules` option.3177 Defaults to false.31783179submodule.fetchJobs::3180 Specifies how many submodules are fetched/cloned at the same time.3181 A positive integer allows up to that number of submodules fetched3182 in parallel. A value of 0 will give some reasonable default.3183 If unset, it defaults to 1.31843185submodule.alternateLocation::3186 Specifies how the submodules obtain alternates when submodules are3187 cloned. Possible values are `no`, `superproject`.3188 By default `no` is assumed, which doesn't add references. When the3189 value is set to `superproject` the submodule to be cloned computes3190 its alternates location relative to the superprojects alternate.31913192submodule.alternateErrorStrategy::3193 Specifies how to treat errors with the alternates for a submodule3194 as computed via `submodule.alternateLocation`. Possible values are3195 `ignore`, `info`, `die`. Default is `die`.31963197tag.forceSignAnnotated::3198 A boolean to specify whether annotated tags created should be GPG signed.3199 If `--annotate` is specified on the command line, it takes3200 precedence over this option.32013202tag.sort::3203 This variable controls the sort ordering of tags when displayed by3204 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3205 value of this variable will be used as the default.32063207tar.umask::3208 This variable can be used to restrict the permission bits of3209 tar archive entries. The default is 0002, which turns off the3210 world write bit. The special value "user" indicates that the3211 archiving user's umask will be used instead. See umask(2) and3212 linkgit:git-archive[1].32133214transfer.fsckObjects::3215 When `fetch.fsckObjects` or `receive.fsckObjects` are3216 not set, the value of this variable is used instead.3217 Defaults to false.32183219transfer.hideRefs::3220 String(s) `receive-pack` and `upload-pack` use to decide which3221 refs to omit from their initial advertisements. Use more than3222 one definition to specify multiple prefix strings. A ref that is3223 under the hierarchies listed in the value of this variable is3224 excluded, and is hidden when responding to `git push` or `git3225 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3226 program-specific versions of this config.3227+3228You may also include a `!` in front of the ref name to negate the entry,3229explicitly exposing it, even if an earlier entry marked it as hidden.3230If you have multiple hideRefs values, later entries override earlier ones3231(and entries in more-specific config files override less-specific ones).3232+3233If a namespace is in use, the namespace prefix is stripped from each3234reference before it is matched against `transfer.hiderefs` patterns.3235For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3236the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3237is omitted from the advertisements but `refs/heads/master` and3238`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3239"have" lines. In order to match refs before stripping, add a `^` in front of3240the ref name. If you combine `!` and `^`, `!` must be specified first.3241+3242Even if you hide refs, a client may still be able to steal the target3243objects via the techniques described in the "SECURITY" section of the3244linkgit:gitnamespaces[7] man page; it's best to keep private data in a3245separate repository.32463247transfer.unpackLimit::3248 When `fetch.unpackLimit` or `receive.unpackLimit` are3249 not set, the value of this variable is used instead.3250 The default value is 100.32513252uploadarchive.allowUnreachable::3253 If true, allow clients to use `git archive --remote` to request3254 any tree, whether reachable from the ref tips or not. See the3255 discussion in the "SECURITY" section of3256 linkgit:git-upload-archive[1] for more details. Defaults to3257 `false`.32583259uploadpack.hideRefs::3260 This variable is the same as `transfer.hideRefs`, but applies3261 only to `upload-pack` (and so affects only fetches, not pushes).3262 An attempt to fetch a hidden ref by `git fetch` will fail. See3263 also `uploadpack.allowTipSHA1InWant`.32643265uploadpack.allowTipSHA1InWant::3266 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3267 to accept a fetch request that asks for an object at the tip3268 of a hidden ref (by default, such a request is rejected).3269 See also `uploadpack.hideRefs`. Even if this is false, a client3270 may be able to steal objects via the techniques described in the3271 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3272 best to keep private data in a separate repository.32733274uploadpack.allowReachableSHA1InWant::3275 Allow `upload-pack` to accept a fetch request that asks for an3276 object that is reachable from any ref tip. However, note that3277 calculating object reachability is computationally expensive.3278 Defaults to `false`. Even if this is false, a client may be able3279 to steal objects via the techniques described in the "SECURITY"3280 section of the linkgit:gitnamespaces[7] man page; it's best to3281 keep private data in a separate repository.32823283uploadpack.allowAnySHA1InWant::3284 Allow `upload-pack` to accept a fetch request that asks for any3285 object at all.3286 Defaults to `false`.32873288uploadpack.keepAlive::3289 When `upload-pack` has started `pack-objects`, there may be a3290 quiet period while `pack-objects` prepares the pack. Normally3291 it would output progress information, but if `--quiet` was used3292 for the fetch, `pack-objects` will output nothing at all until3293 the pack data begins. Some clients and networks may consider3294 the server to be hung and give up. Setting this option instructs3295 `upload-pack` to send an empty keepalive packet every3296 `uploadpack.keepAlive` seconds. Setting this option to 03297 disables keepalive packets entirely. The default is 5 seconds.32983299uploadpack.packObjectsHook::3300 If this option is set, when `upload-pack` would run3301 `git pack-objects` to create a packfile for a client, it will3302 run this shell command instead. The `pack-objects` command and3303 arguments it _would_ have run (including the `git pack-objects`3304 at the beginning) are appended to the shell command. The stdin3305 and stdout of the hook are treated as if `pack-objects` itself3306 was run. I.e., `upload-pack` will feed input intended for3307 `pack-objects` to the hook, and expects a completed packfile on3308 stdout.3309+3310Note that this configuration variable is ignored if it is seen in the3311repository-level config (this is a safety measure against fetching from3312untrusted repositories).33133314url.<base>.insteadOf::3315 Any URL that starts with this value will be rewritten to3316 start, instead, with <base>. In cases where some site serves a3317 large number of repositories, and serves them with multiple3318 access methods, and some users need to use different access3319 methods, this feature allows people to specify any of the3320 equivalent URLs and have Git automatically rewrite the URL to3321 the best alternative for the particular user, even for a3322 never-before-seen repository on the site. When more than one3323 insteadOf strings match a given URL, the longest match is used.3324+3325Note that any protocol restrictions will be applied to the rewritten3326URL. If the rewrite changes the URL to use a custom protocol or remote3327helper, you may need to adjust the `protocol.*.allow` config to permit3328the request. In particular, protocols you expect to use for submodules3329must be set to `always` rather than the default of `user`. See the3330description of `protocol.allow` above.33313332url.<base>.pushInsteadOf::3333 Any URL that starts with this value will not be pushed to;3334 instead, it will be rewritten to start with <base>, and the3335 resulting URL will be pushed to. In cases where some site serves3336 a large number of repositories, and serves them with multiple3337 access methods, some of which do not allow push, this feature3338 allows people to specify a pull-only URL and have Git3339 automatically use an appropriate URL to push, even for a3340 never-before-seen repository on the site. When more than one3341 pushInsteadOf strings match a given URL, the longest match is3342 used. If a remote has an explicit pushurl, Git will ignore this3343 setting for that remote.33443345user.email::3346 Your email address to be recorded in any newly created commits.3347 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3348 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33493350user.name::3351 Your full name to be recorded in any newly created commits.3352 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3353 environment variables. See linkgit:git-commit-tree[1].33543355user.useConfigOnly::3356 Instruct Git to avoid trying to guess defaults for `user.email`3357 and `user.name`, and instead retrieve the values only from the3358 configuration. For example, if you have multiple email addresses3359 and would like to use a different one for each repository, then3360 with this configuration option set to `true` in the global config3361 along with a name, Git will prompt you to set up an email before3362 making new commits in a newly cloned repository.3363 Defaults to `false`.33643365user.signingKey::3366 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3367 key you want it to automatically when creating a signed tag or3368 commit, you can override the default selection with this variable.3369 This option is passed unchanged to gpg's --local-user parameter,3370 so you may specify a key using any method that gpg supports.33713372versionsort.prereleaseSuffix (deprecated)::3373 Deprecated alias for `versionsort.suffix`. Ignored if3374 `versionsort.suffix` is set.33753376versionsort.suffix::3377 Even when version sort is used in linkgit:git-tag[1], tagnames3378 with the same base version but different suffixes are still sorted3379 lexicographically, resulting e.g. in prerelease tags appearing3380 after the main release (e.g. "1.0-rc1" after "1.0"). This3381 variable can be specified to determine the sorting order of tags3382 with different suffixes.3383+3384By specifying a single suffix in this variable, any tagname containing3385that suffix will appear before the corresponding main release. E.g. if3386the variable is set to "-rc", then all "1.0-rcX" tags will appear before3387"1.0". If specified multiple times, once per suffix, then the order of3388suffixes in the configuration will determine the sorting order of tagnames3389with those suffixes. E.g. if "-pre" appears before "-rc" in the3390configuration, then all "1.0-preX" tags will be listed before any3391"1.0-rcX" tags. The placement of the main release tag relative to tags3392with various suffixes can be determined by specifying the empty suffix3393among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3394"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3395are listed first, followed by "v4.8", then "v4.8-ckX" and finally3396"v4.8-bfsX".3397+3398If more than one suffixes match the same tagname, then that tagname will3399be sorted according to the suffix which starts at the earliest position in3400the tagname. If more than one different matching suffixes start at3401that earliest position, then that tagname will be sorted according to the3402longest of those suffixes.3403The sorting order between different suffixes is undefined if they are3404in multiple config files.34053406web.browser::3407 Specify a web browser that may be used by some commands.3408 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3409 may use it.