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 952blame.showRoot:: 953 Do not treat root commits as boundaries in linkgit:git-blame[1]. 954 This option defaults to false. 955 956blame.blankBoundary:: 957 Show blank commit object name for boundary commits in 958 linkgit:git-blame[1]. This option defaults to false. 959 960blame.showEmail:: 961 Show the author email instead of author name in linkgit:git-blame[1]. 962 This option defaults to false. 963 964blame.date:: 965 Specifies the format used to output dates in linkgit:git-blame[1]. 966 If unset the iso format is used. For supported values, 967 see the discussion of the `--date` option at linkgit:git-log[1]. 968 969branch.autoSetupMerge:: 970 Tells 'git branch' and 'git checkout' to set up new branches 971 so that linkgit:git-pull[1] will appropriately merge from the 972 starting point branch. Note that even if this option is not set, 973 this behavior can be chosen per-branch using the `--track` 974 and `--no-track` options. The valid settings are: `false` -- no 975 automatic setup is done; `true` -- automatic setup is done when the 976 starting point is a remote-tracking branch; `always` -- 977 automatic setup is done when the starting point is either a 978 local branch or remote-tracking 979 branch. This option defaults to true. 980 981branch.autoSetupRebase:: 982 When a new branch is created with 'git branch' or 'git checkout' 983 that tracks another branch, this variable tells Git to set 984 up pull to rebase instead of merge (see "branch.<name>.rebase"). 985 When `never`, rebase is never automatically set to true. 986 When `local`, rebase is set to true for tracked branches of 987 other local branches. 988 When `remote`, rebase is set to true for tracked branches of 989 remote-tracking branches. 990 When `always`, rebase will be set to true for all tracking 991 branches. 992 See "branch.autoSetupMerge" for details on how to set up a 993 branch to track another branch. 994 This option defaults to never. 995 996branch.<name>.remote:: 997 When on branch <name>, it tells 'git fetch' and 'git push' 998 which remote to fetch from/push to. The remote to push to 999 may be overridden with `remote.pushDefault` (for all branches).1000 The remote to push to, for the current branch, may be further1001 overridden by `branch.<name>.pushRemote`. If no remote is1002 configured, or if you are not on any branch, it defaults to1003 `origin` for fetching and `remote.pushDefault` for pushing.1004 Additionally, `.` (a period) is the current local repository1005 (a dot-repository), see `branch.<name>.merge`'s final note below.10061007branch.<name>.pushRemote::1008 When on branch <name>, it overrides `branch.<name>.remote` for1009 pushing. It also overrides `remote.pushDefault` for pushing1010 from branch <name>. When you pull from one place (e.g. your1011 upstream) and push to another place (e.g. your own publishing1012 repository), you would want to set `remote.pushDefault` to1013 specify the remote to push to for all branches, and use this1014 option to override it for a specific branch.10151016branch.<name>.merge::1017 Defines, together with branch.<name>.remote, the upstream branch1018 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1019 branch to merge and can also affect 'git push' (see push.default).1020 When in branch <name>, it tells 'git fetch' the default1021 refspec to be marked for merging in FETCH_HEAD. The value is1022 handled like the remote part of a refspec, and must match a1023 ref which is fetched from the remote given by1024 "branch.<name>.remote".1025 The merge information is used by 'git pull' (which at first calls1026 'git fetch') to lookup the default branch for merging. Without1027 this option, 'git pull' defaults to merge the first refspec fetched.1028 Specify multiple values to get an octopus merge.1029 If you wish to setup 'git pull' so that it merges into <name> from1030 another branch in the local repository, you can point1031 branch.<name>.merge to the desired branch, and use the relative path1032 setting `.` (a period) for branch.<name>.remote.10331034branch.<name>.mergeOptions::1035 Sets default options for merging into branch <name>. The syntax and1036 supported options are the same as those of linkgit:git-merge[1], but1037 option values containing whitespace characters are currently not1038 supported.10391040branch.<name>.rebase::1041 When true, rebase the branch <name> on top of the fetched branch,1042 instead of merging the default branch from the default remote when1043 "git pull" is run. See "pull.rebase" for doing this in a non1044 branch-specific manner.1045+1046When preserve, also pass `--preserve-merges` along to 'git rebase'1047so that locally committed merge commits will not be flattened1048by running 'git pull'.1049+1050When the value is `interactive`, the rebase is run in interactive mode.1051+1052*NOTE*: this is a possibly dangerous operation; do *not* use1053it unless you understand the implications (see linkgit:git-rebase[1]1054for details).10551056branch.<name>.description::1057 Branch description, can be edited with1058 `git branch --edit-description`. Branch description is1059 automatically added in the format-patch cover letter or1060 request-pull summary.10611062browser.<tool>.cmd::1063 Specify the command to invoke the specified browser. The1064 specified command is evaluated in shell with the URLs passed1065 as arguments. (See linkgit:git-web{litdd}browse[1].)10661067browser.<tool>.path::1068 Override the path for the given tool that may be used to1069 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1070 working repository in gitweb (see linkgit:git-instaweb[1]).10711072clean.requireForce::1073 A boolean to make git-clean do nothing unless given -f,1074 -i or -n. Defaults to true.10751076color.branch::1077 A boolean to enable/disable color in the output of1078 linkgit:git-branch[1]. May be set to `always`,1079 `false` (or `never`) or `auto` (or `true`), in which case colors are used1080 only when the output is to a terminal. If unset, then the1081 value of `color.ui` is used (`auto` by default).10821083color.branch.<slot>::1084 Use customized color for branch coloration. `<slot>` is one of1085 `current` (the current branch), `local` (a local branch),1086 `remote` (a remote-tracking branch in refs/remotes/),1087 `upstream` (upstream tracking branch), `plain` (other1088 refs).10891090color.diff::1091 Whether to use ANSI escape sequences to add color to patches.1092 If this is set to `always`, linkgit:git-diff[1],1093 linkgit:git-log[1], and linkgit:git-show[1] will use color1094 for all patches. If it is set to `true` or `auto`, those1095 commands will only use color when output is to the terminal.1096 If unset, then the value of `color.ui` is used (`auto` by1097 default).1098+1099This does not affect linkgit:git-format-patch[1] or the1100'git-diff-{asterisk}' plumbing commands. Can be overridden on the1101command line with the `--color[=<when>]` option.11021103diff.colorMoved::1104 If set to either a valid `<mode>` or a true value, moved lines1105 in a diff are colored differently, for details of valid modes1106 see '--color-moved' in linkgit:git-diff[1]. If simply set to1107 true the default color mode will be used. When set to false,1108 moved lines are not colored.11091110color.diff.<slot>::1111 Use customized color for diff colorization. `<slot>` specifies1112 which part of the patch to use the specified color, and is one1113 of `context` (context text - `plain` is a historical synonym),1114 `meta` (metainformation), `frag`1115 (hunk header), 'func' (function in hunk header), `old` (removed lines),1116 `new` (added lines), `commit` (commit headers), `whitespace`1117 (highlighting whitespace errors), `oldMoved` (deleted lines),1118 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1119 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1120 and `newMovedAlternativeDimmed` (See the '<mode>'1121 setting of '--color-moved' in linkgit:git-diff[1] for details).11221123color.decorate.<slot>::1124 Use customized color for 'git log --decorate' output. `<slot>` is one1125 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1126 branches, remote-tracking branches, tags, stash and HEAD, respectively.11271128color.grep::1129 When set to `always`, always highlight matches. When `false` (or1130 `never`), never. When set to `true` or `auto`, use color only1131 when the output is written to the terminal. If unset, then the1132 value of `color.ui` is used (`auto` by default).11331134color.grep.<slot>::1135 Use customized color for grep colorization. `<slot>` specifies which1136 part of the line to use the specified color, and is one of1137+1138--1139`context`;;1140 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1141`filename`;;1142 filename prefix (when not using `-h`)1143`function`;;1144 function name lines (when using `-p`)1145`linenumber`;;1146 line number prefix (when using `-n`)1147`match`;;1148 matching text (same as setting `matchContext` and `matchSelected`)1149`matchContext`;;1150 matching text in context lines1151`matchSelected`;;1152 matching text in selected lines1153`selected`;;1154 non-matching text in selected lines1155`separator`;;1156 separators between fields on a line (`:`, `-`, and `=`)1157 and between hunks (`--`)1158--11591160color.interactive::1161 When set to `always`, always use colors for interactive prompts1162 and displays (such as those used by "git-add --interactive" and1163 "git-clean --interactive"). When false (or `never`), never.1164 When set to `true` or `auto`, use colors only when the output is1165 to the terminal. If unset, then the value of `color.ui` is1166 used (`auto` by default).11671168color.interactive.<slot>::1169 Use customized color for 'git add --interactive' and 'git clean1170 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1171 or `error`, for four distinct types of normal output from1172 interactive commands.11731174color.pager::1175 A boolean to enable/disable colored output when the pager is in1176 use (default is true).11771178color.showBranch::1179 A boolean to enable/disable color in the output of1180 linkgit:git-show-branch[1]. May be set to `always`,1181 `false` (or `never`) or `auto` (or `true`), in which case colors are used1182 only when the output is to a terminal. If unset, then the1183 value of `color.ui` is used (`auto` by default).11841185color.status::1186 A boolean to enable/disable color in the output of1187 linkgit:git-status[1]. May be set to `always`,1188 `false` (or `never`) or `auto` (or `true`), in which case colors are used1189 only when the output is to a terminal. If unset, then the1190 value of `color.ui` is used (`auto` by default).11911192color.status.<slot>::1193 Use customized color for status colorization. `<slot>` is1194 one of `header` (the header text of the status message),1195 `added` or `updated` (files which are added but not committed),1196 `changed` (files which are changed but not added in the index),1197 `untracked` (files which are not tracked by Git),1198 `branch` (the current branch),1199 `nobranch` (the color the 'no branch' warning is shown in, defaulting1200 to red),1201 `localBranch` or `remoteBranch` (the local and remote branch names,1202 respectively, when branch and tracking information is displayed in the1203 status short-format), or1204 `unmerged` (files which have unmerged changes).12051206color.ui::1207 This variable determines the default value for variables such1208 as `color.diff` and `color.grep` that control the use of color1209 per command family. Its scope will expand as more commands learn1210 configuration to set a default for the `--color` option. Set it1211 to `false` or `never` if you prefer Git commands not to use1212 color unless enabled explicitly with some other configuration1213 or the `--color` option. Set it to `always` if you want all1214 output not intended for machine consumption to use color, to1215 `true` or `auto` (this is the default since Git 1.8.4) if you1216 want such output to use color when written to the terminal.12171218column.ui::1219 Specify whether supported commands should output in columns.1220 This variable consists of a list of tokens separated by spaces1221 or commas:1222+1223These options control when the feature should be enabled1224(defaults to 'never'):1225+1226--1227`always`;;1228 always show in columns1229`never`;;1230 never show in columns1231`auto`;;1232 show in columns if the output is to the terminal1233--1234+1235These options control layout (defaults to 'column'). Setting any1236of these implies 'always' if none of 'always', 'never', or 'auto' are1237specified.1238+1239--1240`column`;;1241 fill columns before rows1242`row`;;1243 fill rows before columns1244`plain`;;1245 show in one column1246--1247+1248Finally, these options can be combined with a layout option (defaults1249to 'nodense'):1250+1251--1252`dense`;;1253 make unequal size columns to utilize more space1254`nodense`;;1255 make equal size columns1256--12571258column.branch::1259 Specify whether to output branch listing in `git branch` in columns.1260 See `column.ui` for details.12611262column.clean::1263 Specify the layout when list items in `git clean -i`, which always1264 shows files and directories in columns. See `column.ui` for details.12651266column.status::1267 Specify whether to output untracked files in `git status` in columns.1268 See `column.ui` for details.12691270column.tag::1271 Specify whether to output tag listing in `git tag` in columns.1272 See `column.ui` for details.12731274commit.cleanup::1275 This setting overrides the default of the `--cleanup` option in1276 `git commit`. See linkgit:git-commit[1] for details. Changing the1277 default can be useful when you always want to keep lines that begin1278 with comment character `#` in your log message, in which case you1279 would do `git config commit.cleanup whitespace` (note that you will1280 have to remove the help lines that begin with `#` in the commit log1281 template yourself, if you do this).12821283commit.gpgSign::12841285 A boolean to specify whether all commits should be GPG signed.1286 Use of this option when doing operations such as rebase can1287 result in a large number of commits being signed. It may be1288 convenient to use an agent to avoid typing your GPG passphrase1289 several times.12901291commit.status::1292 A boolean to enable/disable inclusion of status information in the1293 commit message template when using an editor to prepare the commit1294 message. Defaults to true.12951296commit.template::1297 Specify the pathname of a file to use as the template for1298 new commit messages.12991300commit.verbose::1301 A boolean or int to specify the level of verbose with `git commit`.1302 See linkgit:git-commit[1].13031304credential.helper::1305 Specify an external helper to be called when a username or1306 password credential is needed; the helper may consult external1307 storage to avoid prompting the user for the credentials. Note1308 that multiple helpers may be defined. See linkgit:gitcredentials[7]1309 for details.13101311credential.useHttpPath::1312 When acquiring credentials, consider the "path" component of an http1313 or https URL to be important. Defaults to false. See1314 linkgit:gitcredentials[7] for more information.13151316credential.username::1317 If no username is set for a network authentication, use this username1318 by default. See credential.<context>.* below, and1319 linkgit:gitcredentials[7].13201321credential.<url>.*::1322 Any of the credential.* options above can be applied selectively to1323 some credentials. For example "credential.https://example.com.username"1324 would set the default username only for https connections to1325 example.com. See linkgit:gitcredentials[7] for details on how URLs are1326 matched.13271328credentialCache.ignoreSIGHUP::1329 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13301331include::diff-config.txt[]13321333difftool.<tool>.path::1334 Override the path for the given tool. This is useful in case1335 your tool is not in the PATH.13361337difftool.<tool>.cmd::1338 Specify the command to invoke the specified diff tool.1339 The specified command is evaluated in shell with the following1340 variables available: 'LOCAL' is set to the name of the temporary1341 file containing the contents of the diff pre-image and 'REMOTE'1342 is set to the name of the temporary file containing the contents1343 of the diff post-image.13441345difftool.prompt::1346 Prompt before each invocation of the diff tool.13471348fastimport.unpackLimit::1349 If the number of objects imported by linkgit:git-fast-import[1]1350 is below this limit, then the objects will be unpacked into1351 loose object files. However if the number of imported objects1352 equals or exceeds this limit then the pack will be stored as a1353 pack. Storing the pack from a fast-import can make the import1354 operation complete faster, especially on slow filesystems. If1355 not set, the value of `transfer.unpackLimit` is used instead.13561357fetch.recurseSubmodules::1358 This option can be either set to a boolean value or to 'on-demand'.1359 Setting it to a boolean changes the behavior of fetch and pull to1360 unconditionally recurse into submodules when set to true or to not1361 recurse at all when set to false. When set to 'on-demand' (the default1362 value), fetch and pull will only recurse into a populated submodule1363 when its superproject retrieves a commit that updates the submodule's1364 reference.13651366fetch.fsckObjects::1367 If it is set to true, git-fetch-pack will check all fetched1368 objects. It will abort in the case of a malformed object or a1369 broken link. The result of an abort are only dangling objects.1370 Defaults to false. If not set, the value of `transfer.fsckObjects`1371 is used instead.13721373fetch.unpackLimit::1374 If the number of objects fetched over the Git native1375 transfer is below this1376 limit, then the objects will be unpacked into loose object1377 files. However if the number of received objects equals or1378 exceeds this limit then the received pack will be stored as1379 a pack, after adding any missing delta bases. Storing the1380 pack from a push can make the push operation complete faster,1381 especially on slow filesystems. If not set, the value of1382 `transfer.unpackLimit` is used instead.13831384fetch.prune::1385 If true, fetch will automatically behave as if the `--prune`1386 option was given on the command line. See also `remote.<name>.prune`.13871388fetch.output::1389 Control how ref update status is printed. Valid values are1390 `full` and `compact`. Default value is `full`. See section1391 OUTPUT in linkgit:git-fetch[1] for detail.13921393format.attach::1394 Enable multipart/mixed attachments as the default for1395 'format-patch'. The value can also be a double quoted string1396 which will enable attachments as the default and set the1397 value as the boundary. See the --attach option in1398 linkgit:git-format-patch[1].13991400format.from::1401 Provides the default value for the `--from` option to format-patch.1402 Accepts a boolean value, or a name and email address. If false,1403 format-patch defaults to `--no-from`, using commit authors directly in1404 the "From:" field of patch mails. If true, format-patch defaults to1405 `--from`, using your committer identity in the "From:" field of patch1406 mails and including a "From:" field in the body of the patch mail if1407 different. If set to a non-boolean value, format-patch uses that1408 value instead of your committer identity. Defaults to false.14091410format.numbered::1411 A boolean which can enable or disable sequence numbers in patch1412 subjects. It defaults to "auto" which enables it only if there1413 is more than one patch. It can be enabled or disabled for all1414 messages by setting it to "true" or "false". See --numbered1415 option in linkgit:git-format-patch[1].14161417format.headers::1418 Additional email headers to include in a patch to be submitted1419 by mail. See linkgit:git-format-patch[1].14201421format.to::1422format.cc::1423 Additional recipients to include in a patch to be submitted1424 by mail. See the --to and --cc options in1425 linkgit:git-format-patch[1].14261427format.subjectPrefix::1428 The default for format-patch is to output files with the '[PATCH]'1429 subject prefix. Use this variable to change that prefix.14301431format.signature::1432 The default for format-patch is to output a signature containing1433 the Git version number. Use this variable to change that default.1434 Set this variable to the empty string ("") to suppress1435 signature generation.14361437format.signatureFile::1438 Works just like format.signature except the contents of the1439 file specified by this variable will be used as the signature.14401441format.suffix::1442 The default for format-patch is to output files with the suffix1443 `.patch`. Use this variable to change that suffix (make sure to1444 include the dot if you want it).14451446format.pretty::1447 The default pretty format for log/show/whatchanged command,1448 See linkgit:git-log[1], linkgit:git-show[1],1449 linkgit:git-whatchanged[1].14501451format.thread::1452 The default threading style for 'git format-patch'. Can be1453 a boolean value, or `shallow` or `deep`. `shallow` threading1454 makes every mail a reply to the head of the series,1455 where the head is chosen from the cover letter, the1456 `--in-reply-to`, and the first patch mail, in this order.1457 `deep` threading makes every mail a reply to the previous one.1458 A true boolean value is the same as `shallow`, and a false1459 value disables threading.14601461format.signOff::1462 A boolean value which lets you enable the `-s/--signoff` option of1463 format-patch by default. *Note:* Adding the Signed-off-by: line to a1464 patch should be a conscious act and means that you certify you have1465 the rights to submit this work under the same open source license.1466 Please see the 'SubmittingPatches' document for further discussion.14671468format.coverLetter::1469 A boolean that controls whether to generate a cover-letter when1470 format-patch is invoked, but in addition can be set to "auto", to1471 generate a cover-letter only when there's more than one patch.14721473format.outputDirectory::1474 Set a custom directory to store the resulting files instead of the1475 current working directory.14761477format.useAutoBase::1478 A boolean value which lets you enable the `--base=auto` option of1479 format-patch by default.14801481filter.<driver>.clean::1482 The command which is used to convert the content of a worktree1483 file to a blob upon checkin. See linkgit:gitattributes[5] for1484 details.14851486filter.<driver>.smudge::1487 The command which is used to convert the content of a blob1488 object to a worktree file upon checkout. See1489 linkgit:gitattributes[5] for details.14901491fsck.<msg-id>::1492 Allows overriding the message type (error, warn or ignore) of a1493 specific message ID such as `missingEmail`.1494+1495For convenience, fsck prefixes the error/warning with the message ID,1496e.g. "missingEmail: invalid author/committer line - missing email" means1497that setting `fsck.missingEmail = ignore` will hide that issue.1498+1499This feature is intended to support working with legacy repositories1500which cannot be repaired without disruptive changes.15011502fsck.skipList::1503 The path to a sorted list of object names (i.e. one SHA-1 per1504 line) that are known to be broken in a non-fatal way and should1505 be ignored. This feature is useful when an established project1506 should be accepted despite early commits containing errors that1507 can be safely ignored such as invalid committer email addresses.1508 Note: corrupt objects cannot be skipped with this setting.15091510gc.aggressiveDepth::1511 The depth parameter used in the delta compression1512 algorithm used by 'git gc --aggressive'. This defaults1513 to 50.15141515gc.aggressiveWindow::1516 The window size parameter used in the delta compression1517 algorithm used by 'git gc --aggressive'. This defaults1518 to 250.15191520gc.auto::1521 When there are approximately more than this many loose1522 objects in the repository, `git gc --auto` will pack them.1523 Some Porcelain commands use this command to perform a1524 light-weight garbage collection from time to time. The1525 default value is 6700. Setting this to 0 disables it.15261527gc.autoPackLimit::1528 When there are more than this many packs that are not1529 marked with `*.keep` file in the repository, `git gc1530 --auto` consolidates them into one larger pack. The1531 default value is 50. Setting this to 0 disables it.15321533gc.autoDetach::1534 Make `git gc --auto` return immediately and run in background1535 if the system supports it. Default is true.15361537gc.logExpiry::1538 If the file gc.log exists, then `git gc --auto` won't run1539 unless that file is more than 'gc.logExpiry' old. Default is1540 "1.day". See `gc.pruneExpire` for more ways to specify its1541 value.15421543gc.packRefs::1544 Running `git pack-refs` in a repository renders it1545 unclonable by Git versions prior to 1.5.1.2 over dumb1546 transports such as HTTP. This variable determines whether1547 'git gc' runs `git pack-refs`. This can be set to `notbare`1548 to enable it within all non-bare repos or it can be set to a1549 boolean value. The default is `true`.15501551gc.pruneExpire::1552 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1553 Override the grace period with this config variable. The value1554 "now" may be used to disable this grace period and always prune1555 unreachable objects immediately, or "never" may be used to1556 suppress pruning. This feature helps prevent corruption when1557 'git gc' runs concurrently with another process writing to the1558 repository; see the "NOTES" section of linkgit:git-gc[1].15591560gc.worktreePruneExpire::1561 When 'git gc' is run, it calls1562 'git worktree prune --expire 3.months.ago'.1563 This config variable can be used to set a different grace1564 period. The value "now" may be used to disable the grace1565 period and prune `$GIT_DIR/worktrees` immediately, or "never"1566 may be used to suppress pruning.15671568gc.reflogExpire::1569gc.<pattern>.reflogExpire::1570 'git reflog expire' removes reflog entries older than1571 this time; defaults to 90 days. The value "now" expires all1572 entries immediately, and "never" suppresses expiration1573 altogether. With "<pattern>" (e.g.1574 "refs/stash") in the middle the setting applies only to1575 the refs that match the <pattern>.15761577gc.reflogExpireUnreachable::1578gc.<pattern>.reflogExpireUnreachable::1579 'git reflog expire' removes reflog entries older than1580 this time and are not reachable from the current tip;1581 defaults to 30 days. The value "now" expires all entries1582 immediately, and "never" suppresses expiration altogether.1583 With "<pattern>" (e.g. "refs/stash")1584 in the middle, the setting applies only to the refs that1585 match the <pattern>.15861587gc.rerereResolved::1588 Records of conflicted merge you resolved earlier are1589 kept for this many days when 'git rerere gc' is run.1590 You can also use more human-readable "1.month.ago", etc.1591 The default is 60 days. See linkgit:git-rerere[1].15921593gc.rerereUnresolved::1594 Records of conflicted merge you have not resolved are1595 kept for this many days when 'git rerere gc' is run.1596 You can also use more human-readable "1.month.ago", etc.1597 The default is 15 days. See linkgit:git-rerere[1].15981599gitcvs.commitMsgAnnotation::1600 Append this string to each commit message. Set to empty string1601 to disable this feature. Defaults to "via git-CVS emulator".16021603gitcvs.enabled::1604 Whether the CVS server interface is enabled for this repository.1605 See linkgit:git-cvsserver[1].16061607gitcvs.logFile::1608 Path to a log file where the CVS server interface well... logs1609 various stuff. See linkgit:git-cvsserver[1].16101611gitcvs.usecrlfattr::1612 If true, the server will look up the end-of-line conversion1613 attributes for files to determine the `-k` modes to use. If1614 the attributes force Git to treat a file as text,1615 the `-k` mode will be left blank so CVS clients will1616 treat it as text. If they suppress text conversion, the file1617 will be set with '-kb' mode, which suppresses any newline munging1618 the client might otherwise do. If the attributes do not allow1619 the file type to be determined, then `gitcvs.allBinary` is1620 used. See linkgit:gitattributes[5].16211622gitcvs.allBinary::1623 This is used if `gitcvs.usecrlfattr` does not resolve1624 the correct '-kb' mode to use. If true, all1625 unresolved files are sent to the client in1626 mode '-kb'. This causes the client to treat them1627 as binary files, which suppresses any newline munging it1628 otherwise might do. Alternatively, if it is set to "guess",1629 then the contents of the file are examined to decide if1630 it is binary, similar to `core.autocrlf`.16311632gitcvs.dbName::1633 Database used by git-cvsserver to cache revision information1634 derived from the Git repository. The exact meaning depends on the1635 used database driver, for SQLite (which is the default driver) this1636 is a filename. Supports variable substitution (see1637 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1638 Default: '%Ggitcvs.%m.sqlite'16391640gitcvs.dbDriver::1641 Used Perl DBI driver. You can specify any available driver1642 for this here, but it might not work. git-cvsserver is tested1643 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1644 reported *not* to work with 'DBD::mysql'. Experimental feature.1645 May not contain double colons (`:`). Default: 'SQLite'.1646 See linkgit:git-cvsserver[1].16471648gitcvs.dbUser, gitcvs.dbPass::1649 Database user and password. Only useful if setting `gitcvs.dbDriver`,1650 since SQLite has no concept of database users and/or passwords.1651 'gitcvs.dbUser' supports variable substitution (see1652 linkgit:git-cvsserver[1] for details).16531654gitcvs.dbTableNamePrefix::1655 Database table name prefix. Prepended to the names of any1656 database tables used, allowing a single database to be used1657 for several repositories. Supports variable substitution (see1658 linkgit:git-cvsserver[1] for details). Any non-alphabetic1659 characters will be replaced with underscores.16601661All gitcvs variables except for `gitcvs.usecrlfattr` and1662`gitcvs.allBinary` can also be specified as1663'gitcvs.<access_method>.<varname>' (where 'access_method'1664is one of "ext" and "pserver") to make them apply only for the given1665access method.16661667gitweb.category::1668gitweb.description::1669gitweb.owner::1670gitweb.url::1671 See linkgit:gitweb[1] for description.16721673gitweb.avatar::1674gitweb.blame::1675gitweb.grep::1676gitweb.highlight::1677gitweb.patches::1678gitweb.pickaxe::1679gitweb.remote_heads::1680gitweb.showSizes::1681gitweb.snapshot::1682 See linkgit:gitweb.conf[5] for description.16831684grep.lineNumber::1685 If set to true, enable `-n` option by default.16861687grep.patternType::1688 Set the default matching behavior. Using a value of 'basic', 'extended',1689 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1690 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1691 value 'default' will return to the default matching behavior.16921693grep.extendedRegexp::1694 If set to true, enable `--extended-regexp` option by default. This1695 option is ignored when the `grep.patternType` option is set to a value1696 other than 'default'.16971698grep.threads::1699 Number of grep worker threads to use.1700 See `grep.threads` in linkgit:git-grep[1] for more information.17011702grep.fallbackToNoIndex::1703 If set to true, fall back to git grep --no-index if git grep1704 is executed outside of a git repository. Defaults to false.17051706gpg.program::1707 Use this custom program instead of "`gpg`" found on `$PATH` when1708 making or verifying a PGP signature. The program must support the1709 same command-line interface as GPG, namely, to verify a detached1710 signature, "`gpg --verify $file - <$signature`" is run, and the1711 program is expected to signal a good signature by exiting with1712 code 0, and to generate an ASCII-armored detached signature, the1713 standard input of "`gpg -bsau $key`" is fed with the contents to be1714 signed, and the program is expected to send the result to its1715 standard output.17161717gui.commitMsgWidth::1718 Defines how wide the commit message window is in the1719 linkgit:git-gui[1]. "75" is the default.17201721gui.diffContext::1722 Specifies how many context lines should be used in calls to diff1723 made by the linkgit:git-gui[1]. The default is "5".17241725gui.displayUntracked::1726 Determines if linkgit:git-gui[1] shows untracked files1727 in the file list. The default is "true".17281729gui.encoding::1730 Specifies the default encoding to use for displaying of1731 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1732 It can be overridden by setting the 'encoding' attribute1733 for relevant files (see linkgit:gitattributes[5]).1734 If this option is not set, the tools default to the1735 locale encoding.17361737gui.matchTrackingBranch::1738 Determines if new branches created with linkgit:git-gui[1] should1739 default to tracking remote branches with matching names or1740 not. Default: "false".17411742gui.newBranchTemplate::1743 Is used as suggested name when creating new branches using the1744 linkgit:git-gui[1].17451746gui.pruneDuringFetch::1747 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1748 performing a fetch. The default value is "false".17491750gui.trustmtime::1751 Determines if linkgit:git-gui[1] should trust the file modification1752 timestamp or not. By default the timestamps are not trusted.17531754gui.spellingDictionary::1755 Specifies the dictionary used for spell checking commit messages in1756 the linkgit:git-gui[1]. When set to "none" spell checking is turned1757 off.17581759gui.fastCopyBlame::1760 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1761 location detection. It makes blame significantly faster on huge1762 repositories at the expense of less thorough copy detection.17631764gui.copyBlameThreshold::1765 Specifies the threshold to use in 'git gui blame' original location1766 detection, measured in alphanumeric characters. See the1767 linkgit:git-blame[1] manual for more information on copy detection.17681769gui.blamehistoryctx::1770 Specifies the radius of history context in days to show in1771 linkgit:gitk[1] for the selected commit, when the `Show History1772 Context` menu item is invoked from 'git gui blame'. If this1773 variable is set to zero, the whole history is shown.17741775guitool.<name>.cmd::1776 Specifies the shell command line to execute when the corresponding item1777 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1778 mandatory for every tool. The command is executed from the root of1779 the working directory, and in the environment it receives the name of1780 the tool as `GIT_GUITOOL`, the name of the currently selected file as1781 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1782 the head is detached, 'CUR_BRANCH' is empty).17831784guitool.<name>.needsFile::1785 Run the tool only if a diff is selected in the GUI. It guarantees1786 that 'FILENAME' is not empty.17871788guitool.<name>.noConsole::1789 Run the command silently, without creating a window to display its1790 output.17911792guitool.<name>.noRescan::1793 Don't rescan the working directory for changes after the tool1794 finishes execution.17951796guitool.<name>.confirm::1797 Show a confirmation dialog before actually running the tool.17981799guitool.<name>.argPrompt::1800 Request a string argument from the user, and pass it to the tool1801 through the `ARGS` environment variable. Since requesting an1802 argument implies confirmation, the 'confirm' option has no effect1803 if this is enabled. If the option is set to 'true', 'yes', or '1',1804 the dialog uses a built-in generic prompt; otherwise the exact1805 value of the variable is used.18061807guitool.<name>.revPrompt::1808 Request a single valid revision from the user, and set the1809 `REVISION` environment variable. In other aspects this option1810 is similar to 'argPrompt', and can be used together with it.18111812guitool.<name>.revUnmerged::1813 Show only unmerged branches in the 'revPrompt' subdialog.1814 This is useful for tools similar to merge or rebase, but not1815 for things like checkout or reset.18161817guitool.<name>.title::1818 Specifies the title to use for the prompt dialog. The default1819 is the tool name.18201821guitool.<name>.prompt::1822 Specifies the general prompt string to display at the top of1823 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1824 The default value includes the actual command.18251826help.browser::1827 Specify the browser that will be used to display help in the1828 'web' format. See linkgit:git-help[1].18291830help.format::1831 Override the default help format used by linkgit:git-help[1].1832 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1833 the default. 'web' and 'html' are the same.18341835help.autoCorrect::1836 Automatically correct and execute mistyped commands after1837 waiting for the given number of deciseconds (0.1 sec). If more1838 than one command can be deduced from the entered text, nothing1839 will be executed. If the value of this option is negative,1840 the corrected command will be executed immediately. If the1841 value is 0 - the command will be just shown but not executed.1842 This is the default.18431844help.htmlPath::1845 Specify the path where the HTML documentation resides. File system paths1846 and URLs are supported. HTML pages will be prefixed with this path when1847 help is displayed in the 'web' format. This defaults to the documentation1848 path of your Git installation.18491850http.proxy::1851 Override the HTTP proxy, normally configured using the 'http_proxy',1852 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1853 addition to the syntax understood by curl, it is possible to specify a1854 proxy string with a user name but no password, in which case git will1855 attempt to acquire one in the same way it does for other credentials. See1856 linkgit:gitcredentials[7] for more information. The syntax thus is1857 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1858 on a per-remote basis; see remote.<name>.proxy18591860http.proxyAuthMethod::1861 Set the method with which to authenticate against the HTTP proxy. This1862 only takes effect if the configured proxy string contains a user name part1863 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1864 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1865 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1866 variable. Possible values are:1867+1868--1869* `anyauth` - Automatically pick a suitable authentication method. It is1870 assumed that the proxy answers an unauthenticated request with a 4071871 status code and one or more Proxy-authenticate headers with supported1872 authentication methods. This is the default.1873* `basic` - HTTP Basic authentication1874* `digest` - HTTP Digest authentication; this prevents the password from being1875 transmitted to the proxy in clear text1876* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1877 of `curl(1)`)1878* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1879--18801881http.emptyAuth::1882 Attempt authentication without seeking a username or password. This1883 can be used to attempt GSS-Negotiate authentication without specifying1884 a username in the URL, as libcurl normally requires a username for1885 authentication.18861887http.delegation::1888 Control GSSAPI credential delegation. The delegation is disabled1889 by default in libcurl since version 7.21.7. Set parameter to tell1890 the server what it is allowed to delegate when it comes to user1891 credentials. Used with GSS/kerberos. Possible values are:1892+1893--1894* `none` - Don't allow any delegation.1895* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1896 Kerberos service ticket, which is a matter of realm policy.1897* `always` - Unconditionally allow the server to delegate.1898--189919001901http.extraHeader::1902 Pass an additional HTTP header when communicating with a server. If1903 more than one such entry exists, all of them are added as extra1904 headers. To allow overriding the settings inherited from the system1905 config, an empty value will reset the extra headers to the empty list.19061907http.cookieFile::1908 The pathname of a file containing previously stored cookie lines,1909 which should be used1910 in the Git http session, if they match the server. The file format1911 of the file to read cookies from should be plain HTTP headers or1912 the Netscape/Mozilla cookie file format (see `curl(1)`).1913 NOTE that the file specified with http.cookieFile is used only as1914 input unless http.saveCookies is set.19151916http.saveCookies::1917 If set, store cookies received during requests to the file specified by1918 http.cookieFile. Has no effect if http.cookieFile is unset.19191920http.sslVersion::1921 The SSL version to use when negotiating an SSL connection, if you1922 want to force the default. The available and default version1923 depend on whether libcurl was built against NSS or OpenSSL and the1924 particular configuration of the crypto library in use. Internally1925 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1926 documentation for more details on the format of this option and1927 for the ssl version supported. Actually the possible values of1928 this option are:19291930 - sslv21931 - sslv31932 - tlsv11933 - tlsv1.01934 - tlsv1.11935 - tlsv1.219361937+1938Can be overridden by the `GIT_SSL_VERSION` environment variable.1939To force git to use libcurl's default ssl version and ignore any1940explicit http.sslversion option, set `GIT_SSL_VERSION` to the1941empty string.19421943http.sslCipherList::1944 A list of SSL ciphers to use when negotiating an SSL connection.1945 The available ciphers depend on whether libcurl was built against1946 NSS or OpenSSL and the particular configuration of the crypto1947 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1948 option; see the libcurl documentation for more details on the format1949 of this list.1950+1951Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1952To force git to use libcurl's default cipher list and ignore any1953explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1954empty string.19551956http.sslVerify::1957 Whether to verify the SSL certificate when fetching or pushing1958 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1959 variable.19601961http.sslCert::1962 File containing the SSL certificate when fetching or pushing1963 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1964 variable.19651966http.sslKey::1967 File containing the SSL private key when fetching or pushing1968 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1969 variable.19701971http.sslCertPasswordProtected::1972 Enable Git's password prompt for the SSL certificate. Otherwise1973 OpenSSL will prompt the user, possibly many times, if the1974 certificate or private key is encrypted. Can be overridden by the1975 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19761977http.sslCAInfo::1978 File containing the certificates to verify the peer with when1979 fetching or pushing over HTTPS. Can be overridden by the1980 `GIT_SSL_CAINFO` environment variable.19811982http.sslCAPath::1983 Path containing files with the CA certificates to verify the peer1984 with when fetching or pushing over HTTPS. Can be overridden1985 by the `GIT_SSL_CAPATH` environment variable.19861987http.pinnedpubkey::1988 Public key of the https service. It may either be the filename of1989 a PEM or DER encoded public key file or a string starting with1990 'sha256//' followed by the base64 encoded sha256 hash of the1991 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1992 exit with an error if this option is set but not supported by1993 cURL.19941995http.sslTry::1996 Attempt to use AUTH SSL/TLS and encrypted data transfers1997 when connecting via regular FTP protocol. This might be needed1998 if the FTP server requires it for security reasons or you wish1999 to connect securely whenever remote FTP server supports it.2000 Default is false since it might trigger certificate verification2001 errors on misconfigured servers.20022003http.maxRequests::2004 How many HTTP requests to launch in parallel. Can be overridden2005 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20062007http.minSessions::2008 The number of curl sessions (counted across slots) to be kept across2009 requests. They will not be ended with curl_easy_cleanup() until2010 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2011 value will be capped at 1. Defaults to 1.20122013http.postBuffer::2014 Maximum size in bytes of the buffer used by smart HTTP2015 transports when POSTing data to the remote system.2016 For requests larger than this buffer size, HTTP/1.1 and2017 Transfer-Encoding: chunked is used to avoid creating a2018 massive pack file locally. Default is 1 MiB, which is2019 sufficient for most requests.20202021http.lowSpeedLimit, http.lowSpeedTime::2022 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2023 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2024 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2025 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20262027http.noEPSV::2028 A boolean which disables using of EPSV ftp command by curl.2029 This can helpful with some "poor" ftp servers which don't2030 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2031 environment variable. Default is false (curl will use EPSV).20322033http.userAgent::2034 The HTTP USER_AGENT string presented to an HTTP server. The default2035 value represents the version of the client Git such as git/1.7.1.2036 This option allows you to override this value to a more common value2037 such as Mozilla/4.0. This may be necessary, for instance, if2038 connecting through a firewall that restricts HTTP connections to a set2039 of common USER_AGENT strings (but not including those like git/1.7.1).2040 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20412042http.followRedirects::2043 Whether git should follow HTTP redirects. If set to `true`, git2044 will transparently follow any redirect issued by a server it2045 encounters. If set to `false`, git will treat all redirects as2046 errors. If set to `initial`, git will follow redirects only for2047 the initial request to a remote, but not for subsequent2048 follow-up HTTP requests. Since git uses the redirected URL as2049 the base for the follow-up requests, this is generally2050 sufficient. The default is `initial`.20512052http.<url>.*::2053 Any of the http.* options above can be applied selectively to some URLs.2054 For a config key to match a URL, each element of the config key is2055 compared to that of the URL, in the following order:2056+2057--2058. Scheme (e.g., `https` in `https://example.com/`). This field2059 must match exactly between the config key and the URL.20602061. Host/domain name (e.g., `example.com` in `https://example.com/`).2062 This field must match between the config key and the URL. It is2063 possible to specify a `*` as part of the host name to match all subdomains2064 at this level. `https://*.example.com/` for example would match2065 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20662067. Port number (e.g., `8080` in `http://example.com:8080/`).2068 This field must match exactly between the config key and the URL.2069 Omitted port numbers are automatically converted to the correct2070 default for the scheme before matching.20712072. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2073 path field of the config key must match the path field of the URL2074 either exactly or as a prefix of slash-delimited path elements. This means2075 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2076 match on a slash (`/`) boundary. Longer matches take precedence (so a config2077 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2078 key with just path `foo/`).20792080. User name (e.g., `user` in `https://user@example.com/repo.git`). If2081 the config key has a user name it must match the user name in the2082 URL exactly. If the config key does not have a user name, that2083 config key will match a URL with any user name (including none),2084 but at a lower precedence than a config key with a user name.2085--2086+2087The list above is ordered by decreasing precedence; a URL that matches2088a config key's path is preferred to one that matches its user name. For example,2089if the URL is `https://user@example.com/foo/bar` a config key match of2090`https://example.com/foo` will be preferred over a config key match of2091`https://user@example.com`.2092+2093All URLs are normalized before attempting any matching (the password part,2094if embedded in the URL, is always ignored for matching purposes) so that2095equivalent URLs that are simply spelled differently will match properly.2096Environment variable settings always override any matches. The URLs that are2097matched against are those given directly to Git commands. This means any URLs2098visited as a result of a redirection do not participate in matching.20992100ssh.variant::2101 Depending on the value of the environment variables `GIT_SSH` or2102 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git2103 auto-detects whether to adjust its command-line parameters for use2104 with plink or tortoiseplink, as opposed to the default (OpenSSH).2105+2106The config variable `ssh.variant` can be set to override this auto-detection;2107valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value2108will be treated as normal ssh. This setting can be overridden via the2109environment variable `GIT_SSH_VARIANT`.21102111i18n.commitEncoding::2112 Character encoding the commit messages are stored in; Git itself2113 does not care per se, but this information is necessary e.g. when2114 importing commits from emails or in the gitk graphical history2115 browser (and possibly at other places in the future or in other2116 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21172118i18n.logOutputEncoding::2119 Character encoding the commit messages are converted to when2120 running 'git log' and friends.21212122imap::2123 The configuration variables in the 'imap' section are described2124 in linkgit:git-imap-send[1].21252126index.version::2127 Specify the version with which new index files should be2128 initialized. This does not affect existing repositories.21292130init.templateDir::2131 Specify the directory from which templates will be copied.2132 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21332134instaweb.browser::2135 Specify the program that will be used to browse your working2136 repository in gitweb. See linkgit:git-instaweb[1].21372138instaweb.httpd::2139 The HTTP daemon command-line to start gitweb on your working2140 repository. See linkgit:git-instaweb[1].21412142instaweb.local::2143 If true the web server started by linkgit:git-instaweb[1] will2144 be bound to the local IP (127.0.0.1).21452146instaweb.modulePath::2147 The default module path for linkgit:git-instaweb[1] to use2148 instead of /usr/lib/apache2/modules. Only used if httpd2149 is Apache.21502151instaweb.port::2152 The port number to bind the gitweb httpd to. See2153 linkgit:git-instaweb[1].21542155interactive.singleKey::2156 In interactive commands, allow the user to provide one-letter2157 input with a single key (i.e., without hitting enter).2158 Currently this is used by the `--patch` mode of2159 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2160 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2161 setting is silently ignored if portable keystroke input2162 is not available; requires the Perl module Term::ReadKey.21632164interactive.diffFilter::2165 When an interactive command (such as `git add --patch`) shows2166 a colorized diff, git will pipe the diff through the shell2167 command defined by this configuration variable. The command may2168 mark up the diff further for human consumption, provided that it2169 retains a one-to-one correspondence with the lines in the2170 original diff. Defaults to disabled (no filtering).21712172log.abbrevCommit::2173 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2174 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2175 override this option with `--no-abbrev-commit`.21762177log.date::2178 Set the default date-time mode for the 'log' command.2179 Setting a value for log.date is similar to using 'git log''s2180 `--date` option. See linkgit:git-log[1] for details.21812182log.decorate::2183 Print out the ref names of any commits that are shown by the log2184 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2185 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2186 specified, the full ref name (including prefix) will be printed.2187 If 'auto' is specified, then if the output is going to a terminal,2188 the ref names are shown as if 'short' were given, otherwise no ref2189 names are shown. This is the same as the `--decorate` option2190 of the `git log`.21912192log.follow::2193 If `true`, `git log` will act as if the `--follow` option was used when2194 a single <path> is given. This has the same limitations as `--follow`,2195 i.e. it cannot be used to follow multiple files and does not work well2196 on non-linear history.21972198log.graphColors::2199 A list of colors, separated by commas, that can be used to draw2200 history lines in `git log --graph`.22012202log.showRoot::2203 If true, the initial commit will be shown as a big creation event.2204 This is equivalent to a diff against an empty tree.2205 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2206 normally hide the root commit will now show it. True by default.22072208log.showSignature::2209 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2210 linkgit:git-whatchanged[1] assume `--show-signature`.22112212log.mailmap::2213 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2214 linkgit:git-whatchanged[1] assume `--use-mailmap`.22152216mailinfo.scissors::2217 If true, makes linkgit:git-mailinfo[1] (and therefore2218 linkgit:git-am[1]) act by default as if the --scissors option2219 was provided on the command-line. When active, this features2220 removes everything from the message body before a scissors2221 line (i.e. consisting mainly of ">8", "8<" and "-").22222223mailmap.file::2224 The location of an augmenting mailmap file. The default2225 mailmap, located in the root of the repository, is loaded2226 first, then the mailmap file pointed to by this variable.2227 The location of the mailmap file may be in a repository2228 subdirectory, or somewhere outside of the repository itself.2229 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22302231mailmap.blob::2232 Like `mailmap.file`, but consider the value as a reference to a2233 blob in the repository. If both `mailmap.file` and2234 `mailmap.blob` are given, both are parsed, with entries from2235 `mailmap.file` taking precedence. In a bare repository, this2236 defaults to `HEAD:.mailmap`. In a non-bare repository, it2237 defaults to empty.22382239man.viewer::2240 Specify the programs that may be used to display help in the2241 'man' format. See linkgit:git-help[1].22422243man.<tool>.cmd::2244 Specify the command to invoke the specified man viewer. The2245 specified command is evaluated in shell with the man page2246 passed as argument. (See linkgit:git-help[1].)22472248man.<tool>.path::2249 Override the path for the given tool that may be used to2250 display help in the 'man' format. See linkgit:git-help[1].22512252include::merge-config.txt[]22532254mergetool.<tool>.path::2255 Override the path for the given tool. This is useful in case2256 your tool is not in the PATH.22572258mergetool.<tool>.cmd::2259 Specify the command to invoke the specified merge tool. The2260 specified command is evaluated in shell with the following2261 variables available: 'BASE' is the name of a temporary file2262 containing the common base of the files to be merged, if available;2263 'LOCAL' is the name of a temporary file containing the contents of2264 the file on the current branch; 'REMOTE' is the name of a temporary2265 file containing the contents of the file from the branch being2266 merged; 'MERGED' contains the name of the file to which the merge2267 tool should write the results of a successful merge.22682269mergetool.<tool>.trustExitCode::2270 For a custom merge command, specify whether the exit code of2271 the merge command can be used to determine whether the merge was2272 successful. If this is not set to true then the merge target file2273 timestamp is checked and the merge assumed to have been successful2274 if the file has been updated, otherwise the user is prompted to2275 indicate the success of the merge.22762277mergetool.meld.hasOutput::2278 Older versions of `meld` do not support the `--output` option.2279 Git will attempt to detect whether `meld` supports `--output`2280 by inspecting the output of `meld --help`. Configuring2281 `mergetool.meld.hasOutput` will make Git skip these checks and2282 use the configured value instead. Setting `mergetool.meld.hasOutput`2283 to `true` tells Git to unconditionally use the `--output` option,2284 and `false` avoids using `--output`.22852286mergetool.keepBackup::2287 After performing a merge, the original file with conflict markers2288 can be saved as a file with a `.orig` extension. If this variable2289 is set to `false` then this file is not preserved. Defaults to2290 `true` (i.e. keep the backup files).22912292mergetool.keepTemporaries::2293 When invoking a custom merge tool, Git uses a set of temporary2294 files to pass to the tool. If the tool returns an error and this2295 variable is set to `true`, then these temporary files will be2296 preserved, otherwise they will be removed after the tool has2297 exited. Defaults to `false`.22982299mergetool.writeToTemp::2300 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2301 conflicting files in the worktree by default. Git will attempt2302 to use a temporary directory for these files when set `true`.2303 Defaults to `false`.23042305mergetool.prompt::2306 Prompt before each invocation of the merge resolution program.23072308notes.mergeStrategy::2309 Which merge strategy to choose by default when resolving notes2310 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2311 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2312 section of linkgit:git-notes[1] for more information on each strategy.23132314notes.<name>.mergeStrategy::2315 Which merge strategy to choose when doing a notes merge into2316 refs/notes/<name>. This overrides the more general2317 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2318 linkgit:git-notes[1] for more information on the available strategies.23192320notes.displayRef::2321 The (fully qualified) refname from which to show notes when2322 showing commit messages. The value of this variable can be set2323 to a glob, in which case notes from all matching refs will be2324 shown. You may also specify this configuration variable2325 several times. A warning will be issued for refs that do not2326 exist, but a glob that does not match any refs is silently2327 ignored.2328+2329This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2330environment variable, which must be a colon separated list of refs or2331globs.2332+2333The effective value of "core.notesRef" (possibly overridden by2334GIT_NOTES_REF) is also implicitly added to the list of refs to be2335displayed.23362337notes.rewrite.<command>::2338 When rewriting commits with <command> (currently `amend` or2339 `rebase`) and this variable is set to `true`, Git2340 automatically copies your notes from the original to the2341 rewritten commit. Defaults to `true`, but see2342 "notes.rewriteRef" below.23432344notes.rewriteMode::2345 When copying notes during a rewrite (see the2346 "notes.rewrite.<command>" option), determines what to do if2347 the target commit already has a note. Must be one of2348 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2349 Defaults to `concatenate`.2350+2351This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2352environment variable.23532354notes.rewriteRef::2355 When copying notes during a rewrite, specifies the (fully2356 qualified) ref whose notes should be copied. The ref may be a2357 glob, in which case notes in all matching refs will be copied.2358 You may also specify this configuration several times.2359+2360Does not have a default value; you must configure this variable to2361enable note rewriting. Set it to `refs/notes/commits` to enable2362rewriting for the default commit notes.2363+2364This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2365environment variable, which must be a colon separated list of refs or2366globs.23672368pack.window::2369 The size of the window used by linkgit:git-pack-objects[1] when no2370 window size is given on the command line. Defaults to 10.23712372pack.depth::2373 The maximum delta depth used by linkgit:git-pack-objects[1] when no2374 maximum depth is given on the command line. Defaults to 50.23752376pack.windowMemory::2377 The maximum size of memory that is consumed by each thread2378 in linkgit:git-pack-objects[1] for pack window memory when2379 no limit is given on the command line. The value can be2380 suffixed with "k", "m", or "g". When left unconfigured (or2381 set explicitly to 0), there will be no limit.23822383pack.compression::2384 An integer -1..9, indicating the compression level for objects2385 in a pack file. -1 is the zlib default. 0 means no2386 compression, and 1..9 are various speed/size tradeoffs, 9 being2387 slowest. If not set, defaults to core.compression. If that is2388 not set, defaults to -1, the zlib default, which is "a default2389 compromise between speed and compression (currently equivalent2390 to level 6)."2391+2392Note that changing the compression level will not automatically recompress2393all existing objects. You can force recompression by passing the -F option2394to linkgit:git-repack[1].23952396pack.deltaCacheSize::2397 The maximum memory in bytes used for caching deltas in2398 linkgit:git-pack-objects[1] before writing them out to a pack.2399 This cache is used to speed up the writing object phase by not2400 having to recompute the final delta result once the best match2401 for all objects is found. Repacking large repositories on machines2402 which are tight with memory might be badly impacted by this though,2403 especially if this cache pushes the system into swapping.2404 A value of 0 means no limit. The smallest size of 1 byte may be2405 used to virtually disable this cache. Defaults to 256 MiB.24062407pack.deltaCacheLimit::2408 The maximum size of a delta, that is cached in2409 linkgit:git-pack-objects[1]. This cache is used to speed up the2410 writing object phase by not having to recompute the final delta2411 result once the best match for all objects is found. Defaults to 1000.24122413pack.threads::2414 Specifies the number of threads to spawn when searching for best2415 delta matches. This requires that linkgit:git-pack-objects[1]2416 be compiled with pthreads otherwise this option is ignored with a2417 warning. This is meant to reduce packing time on multiprocessor2418 machines. The required amount of memory for the delta search window2419 is however multiplied by the number of threads.2420 Specifying 0 will cause Git to auto-detect the number of CPU's2421 and set the number of threads accordingly.24222423pack.indexVersion::2424 Specify the default pack index version. Valid values are 1 for2425 legacy pack index used by Git versions prior to 1.5.2, and 2 for2426 the new pack index with capabilities for packs larger than 4 GB2427 as well as proper protection against the repacking of corrupted2428 packs. Version 2 is the default. Note that version 2 is enforced2429 and this config option ignored whenever the corresponding pack is2430 larger than 2 GB.2431+2432If you have an old Git that does not understand the version 2 `*.idx` file,2433cloning or fetching over a non native protocol (e.g. "http")2434that will copy both `*.pack` file and corresponding `*.idx` file from the2435other side may give you a repository that cannot be accessed with your2436older version of Git. If the `*.pack` file is smaller than 2 GB, however,2437you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2438the `*.idx` file.24392440pack.packSizeLimit::2441 The maximum size of a pack. This setting only affects2442 packing to a file when repacking, i.e. the git:// protocol2443 is unaffected. It can be overridden by the `--max-pack-size`2444 option of linkgit:git-repack[1]. Reaching this limit results2445 in the creation of multiple packfiles; which in turn prevents2446 bitmaps from being created.2447 The minimum size allowed is limited to 1 MiB.2448 The default is unlimited.2449 Common unit suffixes of 'k', 'm', or 'g' are2450 supported.24512452pack.useBitmaps::2453 When true, git will use pack bitmaps (if available) when packing2454 to stdout (e.g., during the server side of a fetch). Defaults to2455 true. You should not generally need to turn this off unless2456 you are debugging pack bitmaps.24572458pack.writeBitmaps (deprecated)::2459 This is a deprecated synonym for `repack.writeBitmaps`.24602461pack.writeBitmapHashCache::2462 When true, git will include a "hash cache" section in the bitmap2463 index (if one is written). This cache can be used to feed git's2464 delta heuristics, potentially leading to better deltas between2465 bitmapped and non-bitmapped objects (e.g., when serving a fetch2466 between an older, bitmapped pack and objects that have been2467 pushed since the last gc). The downside is that it consumes 42468 bytes per object of disk space, and that JGit's bitmap2469 implementation does not understand it, causing it to complain if2470 Git and JGit are used on the same repository. Defaults to false.24712472pager.<cmd>::2473 If the value is boolean, turns on or off pagination of the2474 output of a particular Git subcommand when writing to a tty.2475 Otherwise, turns on pagination for the subcommand using the2476 pager specified by the value of `pager.<cmd>`. If `--paginate`2477 or `--no-pager` is specified on the command line, it takes2478 precedence over this option. To disable pagination for all2479 commands, set `core.pager` or `GIT_PAGER` to `cat`.24802481pretty.<name>::2482 Alias for a --pretty= format string, as specified in2483 linkgit:git-log[1]. Any aliases defined here can be used just2484 as the built-in pretty formats could. For example,2485 running `git config pretty.changelog "format:* %H %s"`2486 would cause the invocation `git log --pretty=changelog`2487 to be equivalent to running `git log "--pretty=format:* %H %s"`.2488 Note that an alias with the same name as a built-in format2489 will be silently ignored.24902491protocol.allow::2492 If set, provide a user defined default policy for all protocols which2493 don't explicitly have a policy (`protocol.<name>.allow`). By default,2494 if unset, known-safe protocols (http, https, git, ssh, file) have a2495 default policy of `always`, known-dangerous protocols (ext) have a2496 default policy of `never`, and all other protocols have a default2497 policy of `user`. Supported policies:2498+2499--25002501* `always` - protocol is always able to be used.25022503* `never` - protocol is never able to be used.25042505* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2506 either unset or has a value of 1. This policy should be used when you want a2507 protocol to be directly usable by the user but don't want it used by commands which2508 execute clone/fetch/push commands without user input, e.g. recursive2509 submodule initialization.25102511--25122513protocol.<name>.allow::2514 Set a policy to be used by protocol `<name>` with clone/fetch/push2515 commands. See `protocol.allow` above for the available policies.2516+2517The protocol names currently used by git are:2518+2519--2520 - `file`: any local file-based path (including `file://` URLs,2521 or local paths)25222523 - `git`: the anonymous git protocol over a direct TCP2524 connection (or proxy, if configured)25252526 - `ssh`: git over ssh (including `host:path` syntax,2527 `ssh://`, etc).25282529 - `http`: git over http, both "smart http" and "dumb http".2530 Note that this does _not_ include `https`; if you want to configure2531 both, you must do so individually.25322533 - any external helpers are named by their protocol (e.g., use2534 `hg` to allow the `git-remote-hg` helper)2535--25362537pull.ff::2538 By default, Git does not create an extra merge commit when merging2539 a commit that is a descendant of the current commit. Instead, the2540 tip of the current branch is fast-forwarded. When set to `false`,2541 this variable tells Git to create an extra merge commit in such2542 a case (equivalent to giving the `--no-ff` option from the command2543 line). When set to `only`, only such fast-forward merges are2544 allowed (equivalent to giving the `--ff-only` option from the2545 command line). This setting overrides `merge.ff` when pulling.25462547pull.rebase::2548 When true, rebase branches on top of the fetched branch, instead2549 of merging the default branch from the default remote when "git2550 pull" is run. See "branch.<name>.rebase" for setting this on a2551 per-branch basis.2552+2553When preserve, also pass `--preserve-merges` along to 'git rebase'2554so that locally committed merge commits will not be flattened2555by running 'git pull'.2556+2557When the value is `interactive`, the rebase is run in interactive mode.2558+2559*NOTE*: this is a possibly dangerous operation; do *not* use2560it unless you understand the implications (see linkgit:git-rebase[1]2561for details).25622563pull.octopus::2564 The default merge strategy to use when pulling multiple branches2565 at once.25662567pull.twohead::2568 The default merge strategy to use when pulling a single branch.25692570push.default::2571 Defines the action `git push` should take if no refspec is2572 explicitly given. Different values are well-suited for2573 specific workflows; for instance, in a purely central workflow2574 (i.e. the fetch source is equal to the push destination),2575 `upstream` is probably what you want. Possible values are:2576+2577--25782579* `nothing` - do not push anything (error out) unless a refspec is2580 explicitly given. This is primarily meant for people who want to2581 avoid mistakes by always being explicit.25822583* `current` - push the current branch to update a branch with the same2584 name on the receiving end. Works in both central and non-central2585 workflows.25862587* `upstream` - push the current branch back to the branch whose2588 changes are usually integrated into the current branch (which is2589 called `@{upstream}`). This mode only makes sense if you are2590 pushing to the same repository you would normally pull from2591 (i.e. central workflow).25922593* `tracking` - This is a deprecated synonym for `upstream`.25942595* `simple` - in centralized workflow, work like `upstream` with an2596 added safety to refuse to push if the upstream branch's name is2597 different from the local one.2598+2599When pushing to a remote that is different from the remote you normally2600pull from, work as `current`. This is the safest option and is suited2601for beginners.2602+2603This mode has become the default in Git 2.0.26042605* `matching` - push all branches having the same name on both ends.2606 This makes the repository you are pushing to remember the set of2607 branches that will be pushed out (e.g. if you always push 'maint'2608 and 'master' there and no other branches, the repository you push2609 to will have these two branches, and your local 'maint' and2610 'master' will be pushed there).2611+2612To use this mode effectively, you have to make sure _all_ the2613branches you would push out are ready to be pushed out before2614running 'git push', as the whole point of this mode is to allow you2615to push all of the branches in one go. If you usually finish work2616on only one branch and push out the result, while other branches are2617unfinished, this mode is not for you. Also this mode is not2618suitable for pushing into a shared central repository, as other2619people may add new branches there, or update the tip of existing2620branches outside your control.2621+2622This used to be the default, but not since Git 2.0 (`simple` is the2623new default).26242625--26262627push.followTags::2628 If set to true enable `--follow-tags` option by default. You2629 may override this configuration at time of push by specifying2630 `--no-follow-tags`.26312632push.gpgSign::2633 May be set to a boolean value, or the string 'if-asked'. A true2634 value causes all pushes to be GPG signed, as if `--signed` is2635 passed to linkgit:git-push[1]. The string 'if-asked' causes2636 pushes to be signed if the server supports it, as if2637 `--signed=if-asked` is passed to 'git push'. A false value may2638 override a value from a lower-priority config file. An explicit2639 command-line flag always overrides this config option.26402641push.recurseSubmodules::2642 Make sure all submodule commits used by the revisions to be pushed2643 are available on a remote-tracking branch. If the value is 'check'2644 then Git will verify that all submodule commits that changed in the2645 revisions to be pushed are available on at least one remote of the2646 submodule. If any commits are missing, the push will be aborted and2647 exit with non-zero status. If the value is 'on-demand' then all2648 submodules that changed in the revisions to be pushed will be2649 pushed. If on-demand was not able to push all necessary revisions2650 it will also be aborted and exit with non-zero status. If the value2651 is 'no' then default behavior of ignoring submodules when pushing2652 is retained. You may override this configuration at time of push by2653 specifying '--recurse-submodules=check|on-demand|no'.26542655rebase.stat::2656 Whether to show a diffstat of what changed upstream since the last2657 rebase. False by default.26582659rebase.autoSquash::2660 If set to true enable `--autosquash` option by default.26612662rebase.autoStash::2663 When set to true, automatically create a temporary stash entry2664 before the operation begins, and apply it after the operation2665 ends. This means that you can run rebase on a dirty worktree.2666 However, use with care: the final stash application after a2667 successful rebase might result in non-trivial conflicts.2668 Defaults to false.26692670rebase.missingCommitsCheck::2671 If set to "warn", git rebase -i will print a warning if some2672 commits are removed (e.g. a line was deleted), however the2673 rebase will still proceed. If set to "error", it will print2674 the previous warning and stop the rebase, 'git rebase2675 --edit-todo' can then be used to correct the error. If set to2676 "ignore", no checking is done.2677 To drop a commit without warning or error, use the `drop`2678 command in the todo-list.2679 Defaults to "ignore".26802681rebase.instructionFormat::2682 A format string, as specified in linkgit:git-log[1], to be used for2683 the instruction list during an interactive rebase. The format will automatically2684 have the long commit hash prepended to the format.26852686receive.advertiseAtomic::2687 By default, git-receive-pack will advertise the atomic push2688 capability to its clients. If you don't want to advertise this2689 capability, set this variable to false.26902691receive.advertisePushOptions::2692 When set to true, git-receive-pack will advertise the push options2693 capability to its clients. False by default.26942695receive.autogc::2696 By default, git-receive-pack will run "git-gc --auto" after2697 receiving data from git-push and updating refs. You can stop2698 it by setting this variable to false.26992700receive.certNonceSeed::2701 By setting this variable to a string, `git receive-pack`2702 will accept a `git push --signed` and verifies it by using2703 a "nonce" protected by HMAC using this string as a secret2704 key.27052706receive.certNonceSlop::2707 When a `git push --signed` sent a push certificate with a2708 "nonce" that was issued by a receive-pack serving the same2709 repository within this many seconds, export the "nonce"2710 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2711 hooks (instead of what the receive-pack asked the sending2712 side to include). This may allow writing checks in2713 `pre-receive` and `post-receive` a bit easier. Instead of2714 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2715 that records by how many seconds the nonce is stale to2716 decide if they want to accept the certificate, they only2717 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27182719receive.fsckObjects::2720 If it is set to true, git-receive-pack will check all received2721 objects. It will abort in the case of a malformed object or a2722 broken link. The result of an abort are only dangling objects.2723 Defaults to false. If not set, the value of `transfer.fsckObjects`2724 is used instead.27252726receive.fsck.<msg-id>::2727 When `receive.fsckObjects` is set to true, errors can be switched2728 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2729 setting where the `<msg-id>` is the fsck message ID and the value2730 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2731 the error/warning with the message ID, e.g. "missingEmail: invalid2732 author/committer line - missing email" means that setting2733 `receive.fsck.missingEmail = ignore` will hide that issue.2734+2735This feature is intended to support working with legacy repositories2736which would not pass pushing when `receive.fsckObjects = true`, allowing2737the host to accept repositories with certain known issues but still catch2738other issues.27392740receive.fsck.skipList::2741 The path to a sorted list of object names (i.e. one SHA-1 per2742 line) that are known to be broken in a non-fatal way and should2743 be ignored. This feature is useful when an established project2744 should be accepted despite early commits containing errors that2745 can be safely ignored such as invalid committer email addresses.2746 Note: corrupt objects cannot be skipped with this setting.27472748receive.keepAlive::2749 After receiving the pack from the client, `receive-pack` may2750 produce no output (if `--quiet` was specified) while processing2751 the pack, causing some networks to drop the TCP connection.2752 With this option set, if `receive-pack` does not transmit2753 any data in this phase for `receive.keepAlive` seconds, it will2754 send a short keepalive packet. The default is 5 seconds; set2755 to 0 to disable keepalives entirely.27562757receive.unpackLimit::2758 If the number of objects received in a push is below this2759 limit then the objects will be unpacked into loose object2760 files. However if the number of received objects equals or2761 exceeds this limit then the received pack will be stored as2762 a pack, after adding any missing delta bases. Storing the2763 pack from a push can make the push operation complete faster,2764 especially on slow filesystems. If not set, the value of2765 `transfer.unpackLimit` is used instead.27662767receive.maxInputSize::2768 If the size of the incoming pack stream is larger than this2769 limit, then git-receive-pack will error out, instead of2770 accepting the pack file. If not set or set to 0, then the size2771 is unlimited.27722773receive.denyDeletes::2774 If set to true, git-receive-pack will deny a ref update that deletes2775 the ref. Use this to prevent such a ref deletion via a push.27762777receive.denyDeleteCurrent::2778 If set to true, git-receive-pack will deny a ref update that2779 deletes the currently checked out branch of a non-bare repository.27802781receive.denyCurrentBranch::2782 If set to true or "refuse", git-receive-pack will deny a ref update2783 to the currently checked out branch of a non-bare repository.2784 Such a push is potentially dangerous because it brings the HEAD2785 out of sync with the index and working tree. If set to "warn",2786 print a warning of such a push to stderr, but allow the push to2787 proceed. If set to false or "ignore", allow such pushes with no2788 message. Defaults to "refuse".2789+2790Another option is "updateInstead" which will update the working2791tree if pushing into the current branch. This option is2792intended for synchronizing working directories when one side is not easily2793accessible via interactive ssh (e.g. a live web site, hence the requirement2794that the working directory be clean). This mode also comes in handy when2795developing inside a VM to test and fix code on different Operating Systems.2796+2797By default, "updateInstead" will refuse the push if the working tree or2798the index have any difference from the HEAD, but the `push-to-checkout`2799hook can be used to customize this. See linkgit:githooks[5].28002801receive.denyNonFastForwards::2802 If set to true, git-receive-pack will deny a ref update which is2803 not a fast-forward. Use this to prevent such an update via a push,2804 even if that push is forced. This configuration variable is2805 set when initializing a shared repository.28062807receive.hideRefs::2808 This variable is the same as `transfer.hideRefs`, but applies2809 only to `receive-pack` (and so affects pushes, but not fetches).2810 An attempt to update or delete a hidden ref by `git push` is2811 rejected.28122813receive.updateServerInfo::2814 If set to true, git-receive-pack will run git-update-server-info2815 after receiving data from git-push and updating refs.28162817receive.shallowUpdate::2818 If set to true, .git/shallow can be updated when new refs2819 require new shallow roots. Otherwise those refs are rejected.28202821remote.pushDefault::2822 The remote to push to by default. Overrides2823 `branch.<name>.remote` for all branches, and is overridden by2824 `branch.<name>.pushRemote` for specific branches.28252826remote.<name>.url::2827 The URL of a remote repository. See linkgit:git-fetch[1] or2828 linkgit:git-push[1].28292830remote.<name>.pushurl::2831 The push URL of a remote repository. See linkgit:git-push[1].28322833remote.<name>.proxy::2834 For remotes that require curl (http, https and ftp), the URL to2835 the proxy to use for that remote. Set to the empty string to2836 disable proxying for that remote.28372838remote.<name>.proxyAuthMethod::2839 For remotes that require curl (http, https and ftp), the method to use for2840 authenticating against the proxy in use (probably set in2841 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28422843remote.<name>.fetch::2844 The default set of "refspec" for linkgit:git-fetch[1]. See2845 linkgit:git-fetch[1].28462847remote.<name>.push::2848 The default set of "refspec" for linkgit:git-push[1]. See2849 linkgit:git-push[1].28502851remote.<name>.mirror::2852 If true, pushing to this remote will automatically behave2853 as if the `--mirror` option was given on the command line.28542855remote.<name>.skipDefaultUpdate::2856 If true, this remote will be skipped by default when updating2857 using linkgit:git-fetch[1] or the `update` subcommand of2858 linkgit:git-remote[1].28592860remote.<name>.skipFetchAll::2861 If true, this remote will be skipped by default when updating2862 using linkgit:git-fetch[1] or the `update` subcommand of2863 linkgit:git-remote[1].28642865remote.<name>.receivepack::2866 The default program to execute on the remote side when pushing. See2867 option --receive-pack of linkgit:git-push[1].28682869remote.<name>.uploadpack::2870 The default program to execute on the remote side when fetching. See2871 option --upload-pack of linkgit:git-fetch-pack[1].28722873remote.<name>.tagOpt::2874 Setting this value to --no-tags disables automatic tag following when2875 fetching from remote <name>. Setting it to --tags will fetch every2876 tag from remote <name>, even if they are not reachable from remote2877 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2878 override this setting. See options --tags and --no-tags of2879 linkgit:git-fetch[1].28802881remote.<name>.vcs::2882 Setting this to a value <vcs> will cause Git to interact with2883 the remote with the git-remote-<vcs> helper.28842885remote.<name>.prune::2886 When set to true, fetching from this remote by default will also2887 remove any remote-tracking references that no longer exist on the2888 remote (as if the `--prune` option was given on the command line).2889 Overrides `fetch.prune` settings, if any.28902891remotes.<group>::2892 The list of remotes which are fetched by "git remote update2893 <group>". See linkgit:git-remote[1].28942895repack.useDeltaBaseOffset::2896 By default, linkgit:git-repack[1] creates packs that use2897 delta-base offset. If you need to share your repository with2898 Git older than version 1.4.4, either directly or via a dumb2899 protocol such as http, then you need to set this option to2900 "false" and repack. Access from old Git versions over the2901 native protocol are unaffected by this option.29022903repack.packKeptObjects::2904 If set to true, makes `git repack` act as if2905 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2906 details. Defaults to `false` normally, but `true` if a bitmap2907 index is being written (either via `--write-bitmap-index` or2908 `repack.writeBitmaps`).29092910repack.writeBitmaps::2911 When true, git will write a bitmap index when packing all2912 objects to disk (e.g., when `git repack -a` is run). This2913 index can speed up the "counting objects" phase of subsequent2914 packs created for clones and fetches, at the cost of some disk2915 space and extra time spent on the initial repack. This has2916 no effect if multiple packfiles are created.2917 Defaults to false.29182919rerere.autoUpdate::2920 When set to true, `git-rerere` updates the index with the2921 resulting contents after it cleanly resolves conflicts using2922 previously recorded resolution. Defaults to false.29232924rerere.enabled::2925 Activate recording of resolved conflicts, so that identical2926 conflict hunks can be resolved automatically, should they be2927 encountered again. By default, linkgit:git-rerere[1] is2928 enabled if there is an `rr-cache` directory under the2929 `$GIT_DIR`, e.g. if "rerere" was previously used in the2930 repository.29312932sendemail.identity::2933 A configuration identity. When given, causes values in the2934 'sendemail.<identity>' subsection to take precedence over2935 values in the 'sendemail' section. The default identity is2936 the value of `sendemail.identity`.29372938sendemail.smtpEncryption::2939 See linkgit:git-send-email[1] for description. Note that this2940 setting is not subject to the 'identity' mechanism.29412942sendemail.smtpssl (deprecated)::2943 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29442945sendemail.smtpsslcertpath::2946 Path to ca-certificates (either a directory or a single file).2947 Set it to an empty string to disable certificate verification.29482949sendemail.<identity>.*::2950 Identity-specific versions of the 'sendemail.*' parameters2951 found below, taking precedence over those when this2952 identity is selected, through either the command-line or2953 `sendemail.identity`.29542955sendemail.aliasesFile::2956sendemail.aliasFileType::2957sendemail.annotate::2958sendemail.bcc::2959sendemail.cc::2960sendemail.ccCmd::2961sendemail.chainReplyTo::2962sendemail.confirm::2963sendemail.envelopeSender::2964sendemail.from::2965sendemail.multiEdit::2966sendemail.signedoffbycc::2967sendemail.smtpPass::2968sendemail.suppresscc::2969sendemail.suppressFrom::2970sendemail.to::2971sendemail.smtpDomain::2972sendemail.smtpServer::2973sendemail.smtpServerPort::2974sendemail.smtpServerOption::2975sendemail.smtpUser::2976sendemail.thread::2977sendemail.transferEncoding::2978sendemail.validate::2979sendemail.xmailer::2980 See linkgit:git-send-email[1] for description.29812982sendemail.signedoffcc (deprecated)::2983 Deprecated alias for `sendemail.signedoffbycc`.29842985sendemail.smtpBatchSize::2986 Number of messages to be sent per connection, after that a relogin2987 will happen. If the value is 0 or undefined, send all messages in2988 one connection.2989 See also the `--batch-size` option of linkgit:git-send-email[1].29902991sendemail.smtpReloginDelay::2992 Seconds wait before reconnecting to smtp server.2993 See also the `--relogin-delay` option of linkgit:git-send-email[1].29942995showbranch.default::2996 The default set of branches for linkgit:git-show-branch[1].2997 See linkgit:git-show-branch[1].29982999splitIndex.maxPercentChange::3000 When the split index feature is used, this specifies the3001 percent of entries the split index can contain compared to the3002 total number of entries in both the split index and the shared3003 index before a new shared index is written.3004 The value should be between 0 and 100. If the value is 0 then3005 a new shared index is always written, if it is 100 a new3006 shared index is never written.3007 By default the value is 20, so a new shared index is written3008 if the number of entries in the split index would be greater3009 than 20 percent of the total number of entries.3010 See linkgit:git-update-index[1].30113012splitIndex.sharedIndexExpire::3013 When the split index feature is used, shared index files that3014 were not modified since the time this variable specifies will3015 be removed when a new shared index file is created. The value3016 "now" expires all entries immediately, and "never" suppresses3017 expiration altogether.3018 The default value is "2.weeks.ago".3019 Note that a shared index file is considered modified (for the3020 purpose of expiration) each time a new split-index file is3021 either created based on it or read from it.3022 See linkgit:git-update-index[1].30233024status.relativePaths::3025 By default, linkgit:git-status[1] shows paths relative to the3026 current directory. Setting this variable to `false` shows paths3027 relative to the repository root (this was the default for Git3028 prior to v1.5.4).30293030status.short::3031 Set to true to enable --short by default in linkgit:git-status[1].3032 The option --no-short takes precedence over this variable.30333034status.branch::3035 Set to true to enable --branch by default in linkgit:git-status[1].3036 The option --no-branch takes precedence over this variable.30373038status.displayCommentPrefix::3039 If set to true, linkgit:git-status[1] will insert a comment3040 prefix before each output line (starting with3041 `core.commentChar`, i.e. `#` by default). This was the3042 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3043 Defaults to false.30443045status.showStash::3046 If set to true, linkgit:git-status[1] will display the number of3047 entries currently stashed away.3048 Defaults to false.30493050status.showUntrackedFiles::3051 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3052 files which are not currently tracked by Git. Directories which3053 contain only untracked files, are shown with the directory name3054 only. Showing untracked files means that Git needs to lstat() all3055 the files in the whole repository, which might be slow on some3056 systems. So, this variable controls how the commands displays3057 the untracked files. Possible values are:3058+3059--3060* `no` - Show no untracked files.3061* `normal` - Show untracked files and directories.3062* `all` - Show also individual files in untracked directories.3063--3064+3065If this variable is not specified, it defaults to 'normal'.3066This variable can be overridden with the -u|--untracked-files option3067of linkgit:git-status[1] and linkgit:git-commit[1].30683069status.submoduleSummary::3070 Defaults to false.3071 If this is set to a non zero number or true (identical to -1 or an3072 unlimited number), the submodule summary will be enabled and a3073 summary of commits for modified submodules will be shown (see3074 --summary-limit option of linkgit:git-submodule[1]). Please note3075 that the summary output command will be suppressed for all3076 submodules when `diff.ignoreSubmodules` is set to 'all' or only3077 for those submodules where `submodule.<name>.ignore=all`. The only3078 exception to that rule is that status and commit will show staged3079 submodule changes. To3080 also view the summary for ignored submodules you can either use3081 the --ignore-submodules=dirty command-line option or the 'git3082 submodule summary' command, which shows a similar output but does3083 not honor these settings.30843085stash.showPatch::3086 If this is set to true, the `git stash show` command without an3087 option will show the stash entry in patch form. Defaults to false.3088 See description of 'show' command in linkgit:git-stash[1].30893090stash.showStat::3091 If this is set to true, the `git stash show` command without an3092 option will show diffstat of the stash entry. Defaults to true.3093 See description of 'show' command in linkgit:git-stash[1].30943095submodule.<name>.url::3096 The URL for a submodule. This variable is copied from the .gitmodules3097 file to the git config via 'git submodule init'. The user can change3098 the configured URL before obtaining the submodule via 'git submodule3099 update'. If neither submodule.<name>.active or submodule.active are3100 set, the presence of this variable is used as a fallback to indicate3101 whether the submodule is of interest to git commands.3102 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31033104submodule.<name>.update::3105 The method by which a submodule is updated by 'git submodule update',3106 which is the only affected command, others such as3107 'git checkout --recurse-submodules' are unaffected. It exists for3108 historical reasons, when 'git submodule' was the only command to3109 interact with submodules; settings like `submodule.active`3110 and `pull.rebase` are more specific. It is populated by3111 `git submodule init` from the linkgit:gitmodules[5] file.3112 See description of 'update' command in linkgit:git-submodule[1].31133114submodule.<name>.branch::3115 The remote branch name for a submodule, used by `git submodule3116 update --remote`. Set this option to override the value found in3117 the `.gitmodules` file. See linkgit:git-submodule[1] and3118 linkgit:gitmodules[5] for details.31193120submodule.<name>.fetchRecurseSubmodules::3121 This option can be used to control recursive fetching of this3122 submodule. It can be overridden by using the --[no-]recurse-submodules3123 command-line option to "git fetch" and "git pull".3124 This setting will override that from in the linkgit:gitmodules[5]3125 file.31263127submodule.<name>.ignore::3128 Defines under what circumstances "git status" and the diff family show3129 a submodule as modified. When set to "all", it will never be considered3130 modified (but it will nonetheless show up in the output of status and3131 commit when it has been staged), "dirty" will ignore all changes3132 to the submodules work tree and3133 takes only differences between the HEAD of the submodule and the commit3134 recorded in the superproject into account. "untracked" will additionally3135 let submodules with modified tracked files in their work tree show up.3136 Using "none" (the default when this option is not set) also shows3137 submodules that have untracked files in their work tree as changed.3138 This setting overrides any setting made in .gitmodules for this submodule,3139 both settings can be overridden on the command line by using the3140 "--ignore-submodules" option. The 'git submodule' commands are not3141 affected by this setting.31423143submodule.<name>.active::3144 Boolean value indicating if the submodule is of interest to git3145 commands. This config option takes precedence over the3146 submodule.active config option.31473148submodule.active::3149 A repeated field which contains a pathspec used to match against a3150 submodule's path to determine if the submodule is of interest to git3151 commands.31523153submodule.recurse::3154 Specifies if commands recurse into submodules by default. This3155 applies to all commands that have a `--recurse-submodules` option.3156 Defaults to false.31573158submodule.fetchJobs::3159 Specifies how many submodules are fetched/cloned at the same time.3160 A positive integer allows up to that number of submodules fetched3161 in parallel. A value of 0 will give some reasonable default.3162 If unset, it defaults to 1.31633164submodule.alternateLocation::3165 Specifies how the submodules obtain alternates when submodules are3166 cloned. Possible values are `no`, `superproject`.3167 By default `no` is assumed, which doesn't add references. When the3168 value is set to `superproject` the submodule to be cloned computes3169 its alternates location relative to the superprojects alternate.31703171submodule.alternateErrorStrategy::3172 Specifies how to treat errors with the alternates for a submodule3173 as computed via `submodule.alternateLocation`. Possible values are3174 `ignore`, `info`, `die`. Default is `die`.31753176tag.forceSignAnnotated::3177 A boolean to specify whether annotated tags created should be GPG signed.3178 If `--annotate` is specified on the command line, it takes3179 precedence over this option.31803181tag.sort::3182 This variable controls the sort ordering of tags when displayed by3183 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3184 value of this variable will be used as the default.31853186tar.umask::3187 This variable can be used to restrict the permission bits of3188 tar archive entries. The default is 0002, which turns off the3189 world write bit. The special value "user" indicates that the3190 archiving user's umask will be used instead. See umask(2) and3191 linkgit:git-archive[1].31923193transfer.fsckObjects::3194 When `fetch.fsckObjects` or `receive.fsckObjects` are3195 not set, the value of this variable is used instead.3196 Defaults to false.31973198transfer.hideRefs::3199 String(s) `receive-pack` and `upload-pack` use to decide which3200 refs to omit from their initial advertisements. Use more than3201 one definition to specify multiple prefix strings. A ref that is3202 under the hierarchies listed in the value of this variable is3203 excluded, and is hidden when responding to `git push` or `git3204 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3205 program-specific versions of this config.3206+3207You may also include a `!` in front of the ref name to negate the entry,3208explicitly exposing it, even if an earlier entry marked it as hidden.3209If you have multiple hideRefs values, later entries override earlier ones3210(and entries in more-specific config files override less-specific ones).3211+3212If a namespace is in use, the namespace prefix is stripped from each3213reference before it is matched against `transfer.hiderefs` patterns.3214For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3215the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3216is omitted from the advertisements but `refs/heads/master` and3217`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3218"have" lines. In order to match refs before stripping, add a `^` in front of3219the ref name. If you combine `!` and `^`, `!` must be specified first.3220+3221Even if you hide refs, a client may still be able to steal the target3222objects via the techniques described in the "SECURITY" section of the3223linkgit:gitnamespaces[7] man page; it's best to keep private data in a3224separate repository.32253226transfer.unpackLimit::3227 When `fetch.unpackLimit` or `receive.unpackLimit` are3228 not set, the value of this variable is used instead.3229 The default value is 100.32303231uploadarchive.allowUnreachable::3232 If true, allow clients to use `git archive --remote` to request3233 any tree, whether reachable from the ref tips or not. See the3234 discussion in the "SECURITY" section of3235 linkgit:git-upload-archive[1] for more details. Defaults to3236 `false`.32373238uploadpack.hideRefs::3239 This variable is the same as `transfer.hideRefs`, but applies3240 only to `upload-pack` (and so affects only fetches, not pushes).3241 An attempt to fetch a hidden ref by `git fetch` will fail. See3242 also `uploadpack.allowTipSHA1InWant`.32433244uploadpack.allowTipSHA1InWant::3245 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3246 to accept a fetch request that asks for an object at the tip3247 of a hidden ref (by default, such a request is rejected).3248 See also `uploadpack.hideRefs`. Even if this is false, a client3249 may be able to steal objects via the techniques described in the3250 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3251 best to keep private data in a separate repository.32523253uploadpack.allowReachableSHA1InWant::3254 Allow `upload-pack` to accept a fetch request that asks for an3255 object that is reachable from any ref tip. However, note that3256 calculating object reachability is computationally expensive.3257 Defaults to `false`. Even if this is false, a client may be able3258 to steal objects via the techniques described in the "SECURITY"3259 section of the linkgit:gitnamespaces[7] man page; it's best to3260 keep private data in a separate repository.32613262uploadpack.allowAnySHA1InWant::3263 Allow `upload-pack` to accept a fetch request that asks for any3264 object at all.3265 Defaults to `false`.32663267uploadpack.keepAlive::3268 When `upload-pack` has started `pack-objects`, there may be a3269 quiet period while `pack-objects` prepares the pack. Normally3270 it would output progress information, but if `--quiet` was used3271 for the fetch, `pack-objects` will output nothing at all until3272 the pack data begins. Some clients and networks may consider3273 the server to be hung and give up. Setting this option instructs3274 `upload-pack` to send an empty keepalive packet every3275 `uploadpack.keepAlive` seconds. Setting this option to 03276 disables keepalive packets entirely. The default is 5 seconds.32773278uploadpack.packObjectsHook::3279 If this option is set, when `upload-pack` would run3280 `git pack-objects` to create a packfile for a client, it will3281 run this shell command instead. The `pack-objects` command and3282 arguments it _would_ have run (including the `git pack-objects`3283 at the beginning) are appended to the shell command. The stdin3284 and stdout of the hook are treated as if `pack-objects` itself3285 was run. I.e., `upload-pack` will feed input intended for3286 `pack-objects` to the hook, and expects a completed packfile on3287 stdout.3288+3289Note that this configuration variable is ignored if it is seen in the3290repository-level config (this is a safety measure against fetching from3291untrusted repositories).32923293url.<base>.insteadOf::3294 Any URL that starts with this value will be rewritten to3295 start, instead, with <base>. In cases where some site serves a3296 large number of repositories, and serves them with multiple3297 access methods, and some users need to use different access3298 methods, this feature allows people to specify any of the3299 equivalent URLs and have Git automatically rewrite the URL to3300 the best alternative for the particular user, even for a3301 never-before-seen repository on the site. When more than one3302 insteadOf strings match a given URL, the longest match is used.3303+3304Note that any protocol restrictions will be applied to the rewritten3305URL. If the rewrite changes the URL to use a custom protocol or remote3306helper, you may need to adjust the `protocol.*.allow` config to permit3307the request. In particular, protocols you expect to use for submodules3308must be set to `always` rather than the default of `user`. See the3309description of `protocol.allow` above.33103311url.<base>.pushInsteadOf::3312 Any URL that starts with this value will not be pushed to;3313 instead, it will be rewritten to start with <base>, and the3314 resulting URL will be pushed to. In cases where some site serves3315 a large number of repositories, and serves them with multiple3316 access methods, some of which do not allow push, this feature3317 allows people to specify a pull-only URL and have Git3318 automatically use an appropriate URL to push, even for a3319 never-before-seen repository on the site. When more than one3320 pushInsteadOf strings match a given URL, the longest match is3321 used. If a remote has an explicit pushurl, Git will ignore this3322 setting for that remote.33233324user.email::3325 Your email address to be recorded in any newly created commits.3326 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3327 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33283329user.name::3330 Your full name to be recorded in any newly created commits.3331 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3332 environment variables. See linkgit:git-commit-tree[1].33333334user.useConfigOnly::3335 Instruct Git to avoid trying to guess defaults for `user.email`3336 and `user.name`, and instead retrieve the values only from the3337 configuration. For example, if you have multiple email addresses3338 and would like to use a different one for each repository, then3339 with this configuration option set to `true` in the global config3340 along with a name, Git will prompt you to set up an email before3341 making new commits in a newly cloned repository.3342 Defaults to `false`.33433344user.signingKey::3345 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3346 key you want it to automatically when creating a signed tag or3347 commit, you can override the default selection with this variable.3348 This option is passed unchanged to gpg's --local-user parameter,3349 so you may specify a key using any method that gpg supports.33503351versionsort.prereleaseSuffix (deprecated)::3352 Deprecated alias for `versionsort.suffix`. Ignored if3353 `versionsort.suffix` is set.33543355versionsort.suffix::3356 Even when version sort is used in linkgit:git-tag[1], tagnames3357 with the same base version but different suffixes are still sorted3358 lexicographically, resulting e.g. in prerelease tags appearing3359 after the main release (e.g. "1.0-rc1" after "1.0"). This3360 variable can be specified to determine the sorting order of tags3361 with different suffixes.3362+3363By specifying a single suffix in this variable, any tagname containing3364that suffix will appear before the corresponding main release. E.g. if3365the variable is set to "-rc", then all "1.0-rcX" tags will appear before3366"1.0". If specified multiple times, once per suffix, then the order of3367suffixes in the configuration will determine the sorting order of tagnames3368with those suffixes. E.g. if "-pre" appears before "-rc" in the3369configuration, then all "1.0-preX" tags will be listed before any3370"1.0-rcX" tags. The placement of the main release tag relative to tags3371with various suffixes can be determined by specifying the empty suffix3372among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3373"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3374are listed first, followed by "v4.8", then "v4.8-ckX" and finally3375"v4.8-bfsX".3376+3377If more than one suffixes match the same tagname, then that tagname will3378be sorted according to the suffix which starts at the earliest position in3379the tagname. If more than one different matching suffixes start at3380that earliest position, then that tagname will be sorted according to the3381longest of those suffixes.3382The sorting order between different suffixes is undefined if they are3383in multiple config files.33843385web.browser::3386 Specify a web browser that may be used by some commands.3387 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3388 may use it.