1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82The `include` and `includeIf` sections allow you to include config 83directives from another source. These sections behave identically to 84each other with the exception that `includeIf` sections may be ignored 85if their condition does not evaluate to true; see "Conditional includes" 86below. 87 88You can include a config file from another by setting the special 89`include.path` (or `includeIf.*.path`) variable to the name of the file 90to be included. The variable takes a pathname as its value, and is 91subject to tilde expansion. These variables can be given multiple times. 92 93The contents of the included file are inserted immediately, as if they 94had been found at the location of the include directive. If the value of the 95variable is a relative path, the path is considered to 96be relative to the configuration file in which the include directive 97was found. See below for examples. 98 99Conditional includes 100~~~~~~~~~~~~~~~~~~~~ 101 102You can include a config file from another conditionally by setting a 103`includeIf.<condition>.path` variable to the name of the file to be 104included. 105 106The condition starts with a keyword followed by a colon and some data 107whose format and meaning depends on the keyword. Supported keywords 108are: 109 110`gitdir`:: 111 112 The data that follows the keyword `gitdir:` is used as a glob 113 pattern. If the location of the .git directory matches the 114 pattern, the include condition is met. 115+ 116The .git location may be auto-discovered, or come from `$GIT_DIR` 117environment variable. If the repository is auto discovered via a .git 118file (e.g. from submodules, or a linked worktree), the .git location 119would be the final location where the .git directory is, not where the 120.git file is. 121+ 122The pattern can contain standard globbing wildcards and two additional 123ones, `**/` and `/**`, that can match multiple path components. Please 124refer to linkgit:gitignore[5] for details. For convenience: 125 126 * If the pattern starts with `~/`, `~` will be substituted with the 127 content of the environment variable `HOME`. 128 129 * If the pattern starts with `./`, it is replaced with the directory 130 containing the current config file. 131 132 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 133 will be automatically prepended. For example, the pattern `foo/bar` 134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 135 136 * If the pattern ends with `/`, `**` will be automatically added. For 137 example, the pattern `foo/` becomes `foo/**`. In other words, it 138 matches "foo" and everything inside, recursively. 139 140`gitdir/i`:: 141 This is the same as `gitdir` except that matching is done 142 case-insensitively (e.g. on case-insensitive file sytems) 143 144A few more notes on matching via `gitdir` and `gitdir/i`: 145 146 * Symlinks in `$GIT_DIR` are not resolved before matching. 147 148 * Both the symlink & realpath versions of paths will be matched 149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 151 will match. 152+ 153This was not the case in the initial release of this feature in 154v2.13.0, which only matched the realpath version. Configuration that 155wants to be compatible with the initial release of this feature needs 156to either specify only the realpath version, or both versions. 157 158 * Note that "../" is not special and will match literally, which is 159 unlikely what you want. 160 161Example 162~~~~~~~ 163 164 # Core variables 165 [core] 166 ; Don't trust file modes 167 filemode = false 168 169 # Our diff algorithm 170 [diff] 171 external = /usr/local/bin/diff-wrapper 172 renames = true 173 174 [branch "devel"] 175 remote = origin 176 merge = refs/heads/devel 177 178 # Proxy settings 179 [core] 180 gitProxy="ssh" for "kernel.org" 181 gitProxy=default-proxy ; for the rest 182 183 [include] 184 path = /path/to/foo.inc ; include by absolute path 185 path = foo.inc ; find "foo.inc" relative to the current file 186 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 187 188 ; include if $GIT_DIR is /path/to/foo/.git 189 [includeIf "gitdir:/path/to/foo/.git"] 190 path = /path/to/foo.inc 191 192 ; include for all repositories inside /path/to/group 193 [includeIf "gitdir:/path/to/group/"] 194 path = /path/to/foo.inc 195 196 ; include for all repositories inside $HOME/to/group 197 [includeIf "gitdir:~/to/group/"] 198 path = /path/to/foo.inc 199 200 ; relative paths are always relative to the including 201 ; file (if the condition is true); their location is not 202 ; affected by the condition 203 [includeIf "gitdir:/path/to/group/"] 204 path = foo.inc 205 206Values 207~~~~~~ 208 209Values of many variables are treated as a simple string, but there 210are variables that take values of specific types and there are rules 211as to how to spell them. 212 213boolean:: 214 215 When a variable is said to take a boolean value, many 216 synonyms are accepted for 'true' and 'false'; these are all 217 case-insensitive. 218 219 true;; Boolean true literals are `yes`, `on`, `true`, 220 and `1`. Also, a variable defined without `= <value>` 221 is taken as true. 222 223 false;; Boolean false literals are `no`, `off`, `false`, 224 `0` and the empty string. 225+ 226When converting value to the canonical form using `--bool` type 227specifier, 'git config' will ensure that the output is "true" or 228"false" (spelled in lowercase). 229 230integer:: 231 The value for many variables that specify various sizes can 232 be suffixed with `k`, `M`,... to mean "scale the number by 233 1024", "by 1024x1024", etc. 234 235color:: 236 The value for a variable that takes a color is a list of 237 colors (at most two, one for foreground and one for background) 238 and attributes (as many as you want), separated by spaces. 239+ 240The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 241`blue`, `magenta`, `cyan` and `white`. The first color given is the 242foreground; the second is the background. 243+ 244Colors may also be given as numbers between 0 and 255; these use ANSI 245256-color mode (but note that not all terminals may support this). If 246your terminal supports it, you may also specify 24-bit RGB values as 247hex, like `#ff0ab3`. 248+ 249The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 250`italic`, and `strike` (for crossed-out or "strikethrough" letters). 251The position of any attributes with respect to the colors 252(before, after, or in between), doesn't matter. Specific attributes may 253be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 254`no-ul`, etc). 255+ 256An empty color string produces no color effect at all. This can be used 257to avoid coloring specific elements without disabling color entirely. 258+ 259For git's pre-defined color slots, the attributes are meant to be reset 260at the beginning of each item in the colored output. So setting 261`color.decorate.branch` to `black` will paint that branch name in a 262plain `black`, even if the previous thing on the same output line (e.g. 263opening parenthesis before the list of branch names in `log --decorate` 264output) is set to be painted with `bold` or some other attribute. 265However, custom log formats may do more complicated and layered 266coloring, and the negated forms may be useful there. 267 268pathname:: 269 A variable that takes a pathname value can be given a 270 string that begins with "`~/`" or "`~user/`", and the usual 271 tilde expansion happens to such a string: `~/` 272 is expanded to the value of `$HOME`, and `~user/` to the 273 specified user's home directory. 274 275 276Variables 277~~~~~~~~~ 278 279Note that this list is non-comprehensive and not necessarily complete. 280For command-specific variables, you will find a more detailed description 281in the appropriate manual page. 282 283Other git-related tools may and do use their own variables. When 284inventing new variables for use in your own tool, make sure their 285names do not conflict with those that are used by Git itself and 286other popular tools, and describe them in your documentation. 287 288 289advice.*:: 290 These variables control various optional help messages designed to 291 aid new users. All 'advice.*' variables default to 'true', and you 292 can tell Git that you do not need help by setting these to 'false': 293+ 294-- 295 pushUpdateRejected:: 296 Set this variable to 'false' if you want to disable 297 'pushNonFFCurrent', 298 'pushNonFFMatching', 'pushAlreadyExists', 299 'pushFetchFirst', and 'pushNeedsForce' 300 simultaneously. 301 pushNonFFCurrent:: 302 Advice shown when linkgit:git-push[1] fails due to a 303 non-fast-forward update to the current branch. 304 pushNonFFMatching:: 305 Advice shown when you ran linkgit:git-push[1] and pushed 306 'matching refs' explicitly (i.e. you used ':', or 307 specified a refspec that isn't your current branch) and 308 it resulted in a non-fast-forward error. 309 pushAlreadyExists:: 310 Shown when linkgit:git-push[1] rejects an update that 311 does not qualify for fast-forwarding (e.g., a tag.) 312 pushFetchFirst:: 313 Shown when linkgit:git-push[1] rejects an update that 314 tries to overwrite a remote ref that points at an 315 object we do not have. 316 pushNeedsForce:: 317 Shown when linkgit:git-push[1] rejects an update that 318 tries to overwrite a remote ref that points at an 319 object that is not a commit-ish, or make the remote 320 ref point at an object that is not a commit-ish. 321 statusHints:: 322 Show directions on how to proceed from the current 323 state in the output of linkgit:git-status[1], in 324 the template shown when writing commit messages in 325 linkgit:git-commit[1], and in the help message shown 326 by linkgit:git-checkout[1] when switching branch. 327 statusUoption:: 328 Advise to consider using the `-u` option to linkgit:git-status[1] 329 when the command takes more than 2 seconds to enumerate untracked 330 files. 331 commitBeforeMerge:: 332 Advice shown when linkgit:git-merge[1] refuses to 333 merge to avoid overwriting local changes. 334 resolveConflict:: 335 Advice shown by various commands when conflicts 336 prevent the operation from being performed. 337 implicitIdentity:: 338 Advice on how to set your identity configuration when 339 your information is guessed from the system username and 340 domain name. 341 detachedHead:: 342 Advice shown when you used linkgit:git-checkout[1] to 343 move to the detach HEAD state, to instruct how to create 344 a local branch after the fact. 345 amWorkDir:: 346 Advice that shows the location of the patch file when 347 linkgit:git-am[1] fails to apply it. 348 rmHints:: 349 In case of failure in the output of linkgit:git-rm[1], 350 show directions on how to proceed from the current state. 351 addEmbeddedRepo:: 352 Advice on what to do when you've accidentally added one 353 git repo inside of another. 354 ignoredHook:: 355 Advice shown if an hook is ignored because the hook is not 356 set as executable. 357-- 358 359core.fileMode:: 360 Tells Git if the executable bit of files in the working tree 361 is to be honored. 362+ 363Some filesystems lose the executable bit when a file that is 364marked as executable is checked out, or checks out a 365non-executable file with executable bit on. 366linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 367to see if it handles the executable bit correctly 368and this variable is automatically set as necessary. 369+ 370A repository, however, may be on a filesystem that handles 371the filemode correctly, and this variable is set to 'true' 372when created, but later may be made accessible from another 373environment that loses the filemode (e.g. exporting ext4 via 374CIFS mount, visiting a Cygwin created repository with 375Git for Windows or Eclipse). 376In such a case it may be necessary to set this variable to 'false'. 377See linkgit:git-update-index[1]. 378+ 379The default is true (when core.filemode is not specified in the config file). 380 381core.hideDotFiles:: 382 (Windows-only) If true, mark newly-created directories and files whose 383 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 384 directory is hidden, but no other files starting with a dot. The 385 default mode is 'dotGitOnly'. 386 387core.ignoreCase:: 388 If true, this option enables various workarounds to enable 389 Git to work better on filesystems that are not case sensitive, 390 like FAT. For example, if a directory listing finds 391 "makefile" when Git expects "Makefile", Git will assume 392 it is really the same file, and continue to remember it as 393 "Makefile". 394+ 395The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 396will probe and set core.ignoreCase true if appropriate when the repository 397is created. 398 399core.precomposeUnicode:: 400 This option is only used by Mac OS implementation of Git. 401 When core.precomposeUnicode=true, Git reverts the unicode decomposition 402 of filenames done by Mac OS. This is useful when sharing a repository 403 between Mac OS and Linux or Windows. 404 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 405 When false, file names are handled fully transparent by Git, 406 which is backward compatible with older versions of Git. 407 408core.protectHFS:: 409 If set to true, do not allow checkout of paths that would 410 be considered equivalent to `.git` on an HFS+ filesystem. 411 Defaults to `true` on Mac OS, and `false` elsewhere. 412 413core.protectNTFS:: 414 If set to true, do not allow checkout of paths that would 415 cause problems with the NTFS filesystem, e.g. conflict with 416 8.3 "short" names. 417 Defaults to `true` on Windows, and `false` elsewhere. 418 419core.trustctime:: 420 If false, the ctime differences between the index and the 421 working tree are ignored; useful when the inode change time 422 is regularly modified by something outside Git (file system 423 crawlers and some backup systems). 424 See linkgit:git-update-index[1]. True by default. 425 426core.splitIndex:: 427 If true, the split-index feature of the index will be used. 428 See linkgit:git-update-index[1]. False by default. 429 430core.untrackedCache:: 431 Determines what to do about the untracked cache feature of the 432 index. It will be kept, if this variable is unset or set to 433 `keep`. It will automatically be added if set to `true`. And 434 it will automatically be removed, if set to `false`. Before 435 setting it to `true`, you should check that mtime is working 436 properly on your system. 437 See linkgit:git-update-index[1]. `keep` by default. 438 439core.checkStat:: 440 Determines which stat fields to match between the index 441 and work tree. The user can set this to 'default' or 442 'minimal'. Default (or explicitly 'default'), is to check 443 all fields, including the sub-second part of mtime and ctime. 444 445core.quotePath:: 446 Commands that output paths (e.g. 'ls-files', 'diff'), will 447 quote "unusual" characters in the pathname by enclosing the 448 pathname in double-quotes and escaping those characters with 449 backslashes in the same way C escapes control characters (e.g. 450 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 451 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 452 UTF-8). If this variable is set to false, bytes higher than 453 0x80 are not considered "unusual" any more. Double-quotes, 454 backslash and control characters are always escaped regardless 455 of the setting of this variable. A simple space character is 456 not considered "unusual". Many commands can output pathnames 457 completely verbatim using the `-z` option. The default value 458 is true. 459 460core.eol:: 461 Sets the line ending type to use in the working directory for 462 files that have the `text` property set when core.autocrlf is false. 463 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 464 native line ending. The default value is `native`. See 465 linkgit:gitattributes[5] for more information on end-of-line 466 conversion. 467 468core.safecrlf:: 469 If true, makes Git check if converting `CRLF` is reversible when 470 end-of-line conversion is active. Git will verify if a command 471 modifies a file in the work tree either directly or indirectly. 472 For example, committing a file followed by checking out the 473 same file should yield the original file in the work tree. If 474 this is not the case for the current setting of 475 `core.autocrlf`, Git will reject the file. The variable can 476 be set to "warn", in which case Git will only warn about an 477 irreversible conversion but continue the operation. 478+ 479CRLF conversion bears a slight chance of corrupting data. 480When it is enabled, Git will convert CRLF to LF during commit and LF to 481CRLF during checkout. A file that contains a mixture of LF and 482CRLF before the commit cannot be recreated by Git. For text 483files this is the right thing to do: it corrects line endings 484such that we have only LF line endings in the repository. 485But for binary files that are accidentally classified as text the 486conversion can corrupt data. 487+ 488If you recognize such corruption early you can easily fix it by 489setting the conversion type explicitly in .gitattributes. Right 490after committing you still have the original file in your work 491tree and this file is not yet corrupted. You can explicitly tell 492Git that this file is binary and Git will handle the file 493appropriately. 494+ 495Unfortunately, the desired effect of cleaning up text files with 496mixed line endings and the undesired effect of corrupting binary 497files cannot be distinguished. In both cases CRLFs are removed 498in an irreversible way. For text files this is the right thing 499to do because CRLFs are line endings, while for binary files 500converting CRLFs corrupts data. 501+ 502Note, this safety check does not mean that a checkout will generate a 503file identical to the original file for a different setting of 504`core.eol` and `core.autocrlf`, but only for the current one. For 505example, a text file with `LF` would be accepted with `core.eol=lf` 506and could later be checked out with `core.eol=crlf`, in which case the 507resulting file would contain `CRLF`, although the original file 508contained `LF`. However, in both work trees the line endings would be 509consistent, that is either all `LF` or all `CRLF`, but never mixed. A 510file with mixed line endings would be reported by the `core.safecrlf` 511mechanism. 512 513core.autocrlf:: 514 Setting this variable to "true" is the same as setting 515 the `text` attribute to "auto" on all files and core.eol to "crlf". 516 Set to true if you want to have `CRLF` line endings in your 517 working directory and the repository has LF line endings. 518 This variable can be set to 'input', 519 in which case no output conversion is performed. 520 521core.symlinks:: 522 If false, symbolic links are checked out as small plain files that 523 contain the link text. linkgit:git-update-index[1] and 524 linkgit:git-add[1] will not change the recorded type to regular 525 file. Useful on filesystems like FAT that do not support 526 symbolic links. 527+ 528The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 529will probe and set core.symlinks false if appropriate when the repository 530is created. 531 532core.gitProxy:: 533 A "proxy command" to execute (as 'command host port') instead 534 of establishing direct connection to the remote server when 535 using the Git protocol for fetching. If the variable value is 536 in the "COMMAND for DOMAIN" format, the command is applied only 537 on hostnames ending with the specified domain string. This variable 538 may be set multiple times and is matched in the given order; 539 the first match wins. 540+ 541Can be overridden by the `GIT_PROXY_COMMAND` environment variable 542(which always applies universally, without the special "for" 543handling). 544+ 545The special string `none` can be used as the proxy command to 546specify that no proxy be used for a given domain pattern. 547This is useful for excluding servers inside a firewall from 548proxy use, while defaulting to a common proxy for external domains. 549 550core.sshCommand:: 551 If this variable is set, `git fetch` and `git push` will 552 use the specified command instead of `ssh` when they need to 553 connect to a remote system. The command is in the same form as 554 the `GIT_SSH_COMMAND` environment variable and is overridden 555 when the environment variable is set. 556 557core.ignoreStat:: 558 If true, Git will avoid using lstat() calls to detect if files have 559 changed by setting the "assume-unchanged" bit for those tracked files 560 which it has updated identically in both the index and working tree. 561+ 562When files are modified outside of Git, the user will need to stage 563the modified files explicitly (e.g. see 'Examples' section in 564linkgit:git-update-index[1]). 565Git will not normally detect changes to those files. 566+ 567This is useful on systems where lstat() calls are very slow, such as 568CIFS/Microsoft Windows. 569+ 570False by default. 571 572core.preferSymlinkRefs:: 573 Instead of the default "symref" format for HEAD 574 and other symbolic reference files, use symbolic links. 575 This is sometimes needed to work with old scripts that 576 expect HEAD to be a symbolic link. 577 578core.bare:: 579 If true this repository is assumed to be 'bare' and has no 580 working directory associated with it. If this is the case a 581 number of commands that require a working directory will be 582 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 583+ 584This setting is automatically guessed by linkgit:git-clone[1] or 585linkgit:git-init[1] when the repository was created. By default a 586repository that ends in "/.git" is assumed to be not bare (bare = 587false), while all other repositories are assumed to be bare (bare 588= true). 589 590core.worktree:: 591 Set the path to the root of the working tree. 592 If `GIT_COMMON_DIR` environment variable is set, core.worktree 593 is ignored and not used for determining the root of working tree. 594 This can be overridden by the `GIT_WORK_TREE` environment 595 variable and the `--work-tree` command-line option. 596 The value can be an absolute path or relative to the path to 597 the .git directory, which is either specified by --git-dir 598 or GIT_DIR, or automatically discovered. 599 If --git-dir or GIT_DIR is specified but none of 600 --work-tree, GIT_WORK_TREE and core.worktree is specified, 601 the current working directory is regarded as the top level 602 of your working tree. 603+ 604Note that this variable is honored even when set in a configuration 605file in a ".git" subdirectory of a directory and its value differs 606from the latter directory (e.g. "/path/to/.git/config" has 607core.worktree set to "/different/path"), which is most likely a 608misconfiguration. Running Git commands in the "/path/to" directory will 609still use "/different/path" as the root of the work tree and can cause 610confusion unless you know what you are doing (e.g. you are creating a 611read-only snapshot of the same index to a location different from the 612repository's usual working tree). 613 614core.logAllRefUpdates:: 615 Enable the reflog. Updates to a ref <ref> is logged to the file 616 "`$GIT_DIR/logs/<ref>`", by appending the new and old 617 SHA-1, the date/time and the reason of the update, but 618 only when the file exists. If this configuration 619 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 620 file is automatically created for branch heads (i.e. under 621 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 622 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 623 If it is set to `always`, then a missing reflog is automatically 624 created for any ref under `refs/`. 625+ 626This information can be used to determine what commit 627was the tip of a branch "2 days ago". 628+ 629This value is true by default in a repository that has 630a working directory associated with it, and false by 631default in a bare repository. 632 633core.repositoryFormatVersion:: 634 Internal variable identifying the repository format and layout 635 version. 636 637core.sharedRepository:: 638 When 'group' (or 'true'), the repository is made shareable between 639 several users in a group (making sure all the files and objects are 640 group-writable). When 'all' (or 'world' or 'everybody'), the 641 repository will be readable by all users, additionally to being 642 group-shareable. When 'umask' (or 'false'), Git will use permissions 643 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 644 files in the repository will have this mode value. '0xxx' will override 645 user's umask value (whereas the other options will only override 646 requested parts of the user's umask value). Examples: '0660' will make 647 the repo read/write-able for the owner and group, but inaccessible to 648 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 649 repository that is group-readable but not group-writable. 650 See linkgit:git-init[1]. False by default. 651 652core.warnAmbiguousRefs:: 653 If true, Git will warn you if the ref name you passed it is ambiguous 654 and might match multiple refs in the repository. True by default. 655 656core.compression:: 657 An integer -1..9, indicating a default compression level. 658 -1 is the zlib default. 0 means no compression, 659 and 1..9 are various speed/size tradeoffs, 9 being slowest. 660 If set, this provides a default to other compression variables, 661 such as `core.looseCompression` and `pack.compression`. 662 663core.looseCompression:: 664 An integer -1..9, indicating the compression level for objects that 665 are not in a pack file. -1 is the zlib default. 0 means no 666 compression, and 1..9 are various speed/size tradeoffs, 9 being 667 slowest. If not set, defaults to core.compression. If that is 668 not set, defaults to 1 (best speed). 669 670core.packedGitWindowSize:: 671 Number of bytes of a pack file to map into memory in a 672 single mapping operation. Larger window sizes may allow 673 your system to process a smaller number of large pack files 674 more quickly. Smaller window sizes will negatively affect 675 performance due to increased calls to the operating system's 676 memory manager, but may improve performance when accessing 677 a large number of large pack files. 678+ 679Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 680MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 681be reasonable for all users/operating systems. You probably do 682not need to adjust this value. 683+ 684Common unit suffixes of 'k', 'm', or 'g' are supported. 685 686core.packedGitLimit:: 687 Maximum number of bytes to map simultaneously into memory 688 from pack files. If Git needs to access more than this many 689 bytes at once to complete an operation it will unmap existing 690 regions to reclaim virtual address space within the process. 691+ 692Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 693unlimited) on 64 bit platforms. 694This should be reasonable for all users/operating systems, except on 695the largest projects. You probably do not need to adjust this value. 696+ 697Common unit suffixes of 'k', 'm', or 'g' are supported. 698 699core.deltaBaseCacheLimit:: 700 Maximum number of bytes to reserve for caching base objects 701 that may be referenced by multiple deltified objects. By storing the 702 entire decompressed base objects in a cache Git is able 703 to avoid unpacking and decompressing frequently used base 704 objects multiple times. 705+ 706Default is 96 MiB on all platforms. This should be reasonable 707for all users/operating systems, except on the largest projects. 708You probably do not need to adjust this value. 709+ 710Common unit suffixes of 'k', 'm', or 'g' are supported. 711 712core.bigFileThreshold:: 713 Files larger than this size are stored deflated, without 714 attempting delta compression. Storing large files without 715 delta compression avoids excessive memory usage, at the 716 slight expense of increased disk usage. Additionally files 717 larger than this size are always treated as binary. 718+ 719Default is 512 MiB on all platforms. This should be reasonable 720for most projects as source code and other text files can still 721be delta compressed, but larger binary media files won't be. 722+ 723Common unit suffixes of 'k', 'm', or 'g' are supported. 724 725core.excludesFile:: 726 Specifies the pathname to the file that contains patterns to 727 describe paths that are not meant to be tracked, in addition 728 to '.gitignore' (per-directory) and '.git/info/exclude'. 729 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 730 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 731 is used instead. See linkgit:gitignore[5]. 732 733core.askPass:: 734 Some commands (e.g. svn and http interfaces) that interactively 735 ask for a password can be told to use an external program given 736 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 737 environment variable. If not set, fall back to the value of the 738 `SSH_ASKPASS` environment variable or, failing that, a simple password 739 prompt. The external program shall be given a suitable prompt as 740 command-line argument and write the password on its STDOUT. 741 742core.attributesFile:: 743 In addition to '.gitattributes' (per-directory) and 744 '.git/info/attributes', Git looks into this file for attributes 745 (see linkgit:gitattributes[5]). Path expansions are made the same 746 way as for `core.excludesFile`. Its default value is 747 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 748 set or empty, `$HOME/.config/git/attributes` is used instead. 749 750core.hooksPath:: 751 By default Git will look for your hooks in the 752 '$GIT_DIR/hooks' directory. Set this to different path, 753 e.g. '/etc/git/hooks', and Git will try to find your hooks in 754 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 755 in '$GIT_DIR/hooks/pre-receive'. 756+ 757The path can be either absolute or relative. A relative path is 758taken as relative to the directory where the hooks are run (see 759the "DESCRIPTION" section of linkgit:githooks[5]). 760+ 761This configuration variable is useful in cases where you'd like to 762centrally configure your Git hooks instead of configuring them on a 763per-repository basis, or as a more flexible and centralized 764alternative to having an `init.templateDir` where you've changed 765default hooks. 766 767core.editor:: 768 Commands such as `commit` and `tag` that let you edit 769 messages by launching an editor use the value of this 770 variable when it is set, and the environment variable 771 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 772 773core.commentChar:: 774 Commands such as `commit` and `tag` that let you edit 775 messages consider a line that begins with this character 776 commented, and removes them after the editor returns 777 (default '#'). 778+ 779If set to "auto", `git-commit` would select a character that is not 780the beginning character of any line in existing commit messages. 781 782core.filesRefLockTimeout:: 783 The length of time, in milliseconds, to retry when trying to 784 lock an individual reference. Value 0 means not to retry at 785 all; -1 means to try indefinitely. Default is 100 (i.e., 786 retry for 100ms). 787 788core.packedRefsTimeout:: 789 The length of time, in milliseconds, to retry when trying to 790 lock the `packed-refs` file. Value 0 means not to retry at 791 all; -1 means to try indefinitely. Default is 1000 (i.e., 792 retry for 1 second). 793 794sequence.editor:: 795 Text editor used by `git rebase -i` for editing the rebase instruction file. 796 The value is meant to be interpreted by the shell when it is used. 797 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 798 When not configured the default commit message editor is used instead. 799 800core.pager:: 801 Text viewer for use by Git commands (e.g., 'less'). The value 802 is meant to be interpreted by the shell. The order of preference 803 is the `$GIT_PAGER` environment variable, then `core.pager` 804 configuration, then `$PAGER`, and then the default chosen at 805 compile time (usually 'less'). 806+ 807When the `LESS` environment variable is unset, Git sets it to `FRX` 808(if `LESS` environment variable is set, Git does not change it at 809all). If you want to selectively override Git's default setting 810for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 811be passed to the shell by Git, which will translate the final 812command to `LESS=FRX less -S`. The environment does not set the 813`S` option but the command line does, instructing less to truncate 814long lines. Similarly, setting `core.pager` to `less -+F` will 815deactivate the `F` option specified by the environment from the 816command-line, deactivating the "quit if one screen" behavior of 817`less`. One can specifically activate some flags for particular 818commands: for example, setting `pager.blame` to `less -S` enables 819line truncation only for `git blame`. 820+ 821Likewise, when the `LV` environment variable is unset, Git sets it 822to `-c`. You can override this setting by exporting `LV` with 823another value or setting `core.pager` to `lv +c`. 824 825core.whitespace:: 826 A comma separated list of common whitespace problems to 827 notice. 'git diff' will use `color.diff.whitespace` to 828 highlight them, and 'git apply --whitespace=error' will 829 consider them as errors. You can prefix `-` to disable 830 any of them (e.g. `-trailing-space`): 831+ 832* `blank-at-eol` treats trailing whitespaces at the end of the line 833 as an error (enabled by default). 834* `space-before-tab` treats a space character that appears immediately 835 before a tab character in the initial indent part of the line as an 836 error (enabled by default). 837* `indent-with-non-tab` treats a line that is indented with space 838 characters instead of the equivalent tabs as an error (not enabled by 839 default). 840* `tab-in-indent` treats a tab character in the initial indent part of 841 the line as an error (not enabled by default). 842* `blank-at-eof` treats blank lines added at the end of file as an error 843 (enabled by default). 844* `trailing-space` is a short-hand to cover both `blank-at-eol` and 845 `blank-at-eof`. 846* `cr-at-eol` treats a carriage-return at the end of line as 847 part of the line terminator, i.e. with it, `trailing-space` 848 does not trigger if the character before such a carriage-return 849 is not a whitespace (not enabled by default). 850* `tabwidth=<n>` tells how many character positions a tab occupies; this 851 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 852 errors. The default tab width is 8. Allowed values are 1 to 63. 853 854core.fsyncObjectFiles:: 855 This boolean will enable 'fsync()' when writing object files. 856+ 857This is a total waste of time and effort on a filesystem that orders 858data writes properly, but can be useful for filesystems that do not use 859journalling (traditional UNIX filesystems) or that only journal metadata 860and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 861 862core.preloadIndex:: 863 Enable parallel index preload for operations like 'git diff' 864+ 865This can speed up operations like 'git diff' and 'git status' especially 866on filesystems like NFS that have weak caching semantics and thus 867relatively high IO latencies. When enabled, Git will do the 868index comparison to the filesystem data in parallel, allowing 869overlapping IO's. Defaults to true. 870 871core.createObject:: 872 You can set this to 'link', in which case a hardlink followed by 873 a delete of the source are used to make sure that object creation 874 will not overwrite existing objects. 875+ 876On some file system/operating system combinations, this is unreliable. 877Set this config setting to 'rename' there; However, This will remove the 878check that makes sure that existing object files will not get overwritten. 879 880core.notesRef:: 881 When showing commit messages, also show notes which are stored in 882 the given ref. The ref must be fully qualified. If the given 883 ref does not exist, it is not an error but means that no 884 notes should be printed. 885+ 886This setting defaults to "refs/notes/commits", and it can be overridden by 887the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 888 889core.sparseCheckout:: 890 Enable "sparse checkout" feature. See section "Sparse checkout" in 891 linkgit:git-read-tree[1] for more information. 892 893core.abbrev:: 894 Set the length object names are abbreviated to. If 895 unspecified or set to "auto", an appropriate value is 896 computed based on the approximate number of packed objects 897 in your repository, which hopefully is enough for 898 abbreviated object names to stay unique for some time. 899 The minimum length is 4. 900 901add.ignoreErrors:: 902add.ignore-errors (deprecated):: 903 Tells 'git add' to continue adding files when some files cannot be 904 added due to indexing errors. Equivalent to the `--ignore-errors` 905 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 906 as it does not follow the usual naming convention for configuration 907 variables. 908 909alias.*:: 910 Command aliases for the linkgit:git[1] command wrapper - e.g. 911 after defining "alias.last = cat-file commit HEAD", the invocation 912 "git last" is equivalent to "git cat-file commit HEAD". To avoid 913 confusion and troubles with script usage, aliases that 914 hide existing Git commands are ignored. Arguments are split by 915 spaces, the usual shell quoting and escaping is supported. 916 A quote pair or a backslash can be used to quote them. 917+ 918If the alias expansion is prefixed with an exclamation point, 919it will be treated as a shell command. For example, defining 920"alias.new = !gitk --all --not ORIG_HEAD", the invocation 921"git new" is equivalent to running the shell command 922"gitk --all --not ORIG_HEAD". Note that shell commands will be 923executed from the top-level directory of a repository, which may 924not necessarily be the current directory. 925`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 926from the original current directory. See linkgit:git-rev-parse[1]. 927 928am.keepcr:: 929 If true, git-am will call git-mailsplit for patches in mbox format 930 with parameter `--keep-cr`. In this case git-mailsplit will 931 not remove `\r` from lines ending with `\r\n`. Can be overridden 932 by giving `--no-keep-cr` from the command line. 933 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 934 935am.threeWay:: 936 By default, `git am` will fail if the patch does not apply cleanly. When 937 set to true, this setting tells `git am` to fall back on 3-way merge if 938 the patch records the identity of blobs it is supposed to apply to and 939 we have those blobs available locally (equivalent to giving the `--3way` 940 option from the command line). Defaults to `false`. 941 See linkgit:git-am[1]. 942 943apply.ignoreWhitespace:: 944 When set to 'change', tells 'git apply' to ignore changes in 945 whitespace, in the same way as the `--ignore-space-change` 946 option. 947 When set to one of: no, none, never, false tells 'git apply' to 948 respect all whitespace differences. 949 See linkgit:git-apply[1]. 950 951apply.whitespace:: 952 Tells 'git apply' how to handle whitespaces, in the same way 953 as the `--whitespace` option. See linkgit:git-apply[1]. 954 955branch.autoSetupMerge:: 956 Tells 'git branch' and 'git checkout' to set up new branches 957 so that linkgit:git-pull[1] will appropriately merge from the 958 starting point branch. Note that even if this option is not set, 959 this behavior can be chosen per-branch using the `--track` 960 and `--no-track` options. The valid settings are: `false` -- no 961 automatic setup is done; `true` -- automatic setup is done when the 962 starting point is a remote-tracking branch; `always` -- 963 automatic setup is done when the starting point is either a 964 local branch or remote-tracking 965 branch. This option defaults to true. 966 967branch.autoSetupRebase:: 968 When a new branch is created with 'git branch' or 'git checkout' 969 that tracks another branch, this variable tells Git to set 970 up pull to rebase instead of merge (see "branch.<name>.rebase"). 971 When `never`, rebase is never automatically set to true. 972 When `local`, rebase is set to true for tracked branches of 973 other local branches. 974 When `remote`, rebase is set to true for tracked branches of 975 remote-tracking branches. 976 When `always`, rebase will be set to true for all tracking 977 branches. 978 See "branch.autoSetupMerge" for details on how to set up a 979 branch to track another branch. 980 This option defaults to never. 981 982branch.<name>.remote:: 983 When on branch <name>, it tells 'git fetch' and 'git push' 984 which remote to fetch from/push to. The remote to push to 985 may be overridden with `remote.pushDefault` (for all branches). 986 The remote to push to, for the current branch, may be further 987 overridden by `branch.<name>.pushRemote`. If no remote is 988 configured, or if you are not on any branch, it defaults to 989 `origin` for fetching and `remote.pushDefault` for pushing. 990 Additionally, `.` (a period) is the current local repository 991 (a dot-repository), see `branch.<name>.merge`'s final note below. 992 993branch.<name>.pushRemote:: 994 When on branch <name>, it overrides `branch.<name>.remote` for 995 pushing. It also overrides `remote.pushDefault` for pushing 996 from branch <name>. When you pull from one place (e.g. your 997 upstream) and push to another place (e.g. your own publishing 998 repository), you would want to set `remote.pushDefault` to 999 specify the remote to push to for all branches, and use this1000 option to override it for a specific branch.10011002branch.<name>.merge::1003 Defines, together with branch.<name>.remote, the upstream branch1004 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1005 branch to merge and can also affect 'git push' (see push.default).1006 When in branch <name>, it tells 'git fetch' the default1007 refspec to be marked for merging in FETCH_HEAD. The value is1008 handled like the remote part of a refspec, and must match a1009 ref which is fetched from the remote given by1010 "branch.<name>.remote".1011 The merge information is used by 'git pull' (which at first calls1012 'git fetch') to lookup the default branch for merging. Without1013 this option, 'git pull' defaults to merge the first refspec fetched.1014 Specify multiple values to get an octopus merge.1015 If you wish to setup 'git pull' so that it merges into <name> from1016 another branch in the local repository, you can point1017 branch.<name>.merge to the desired branch, and use the relative path1018 setting `.` (a period) for branch.<name>.remote.10191020branch.<name>.mergeOptions::1021 Sets default options for merging into branch <name>. The syntax and1022 supported options are the same as those of linkgit:git-merge[1], but1023 option values containing whitespace characters are currently not1024 supported.10251026branch.<name>.rebase::1027 When true, rebase the branch <name> on top of the fetched branch,1028 instead of merging the default branch from the default remote when1029 "git pull" is run. See "pull.rebase" for doing this in a non1030 branch-specific manner.1031+1032When preserve, also pass `--preserve-merges` along to 'git rebase'1033so that locally committed merge commits will not be flattened1034by running 'git pull'.1035+1036When the value is `interactive`, the rebase is run in interactive mode.1037+1038*NOTE*: this is a possibly dangerous operation; do *not* use1039it unless you understand the implications (see linkgit:git-rebase[1]1040for details).10411042branch.<name>.description::1043 Branch description, can be edited with1044 `git branch --edit-description`. Branch description is1045 automatically added in the format-patch cover letter or1046 request-pull summary.10471048browser.<tool>.cmd::1049 Specify the command to invoke the specified browser. The1050 specified command is evaluated in shell with the URLs passed1051 as arguments. (See linkgit:git-web{litdd}browse[1].)10521053browser.<tool>.path::1054 Override the path for the given tool that may be used to1055 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1056 working repository in gitweb (see linkgit:git-instaweb[1]).10571058clean.requireForce::1059 A boolean to make git-clean do nothing unless given -f,1060 -i or -n. Defaults to true.10611062color.branch::1063 A boolean to enable/disable color in the output of1064 linkgit:git-branch[1]. May be set to `always`,1065 `false` (or `never`) or `auto` (or `true`), in which case colors are used1066 only when the output is to a terminal. If unset, then the1067 value of `color.ui` is used (`auto` by default).10681069color.branch.<slot>::1070 Use customized color for branch coloration. `<slot>` is one of1071 `current` (the current branch), `local` (a local branch),1072 `remote` (a remote-tracking branch in refs/remotes/),1073 `upstream` (upstream tracking branch), `plain` (other1074 refs).10751076color.diff::1077 Whether to use ANSI escape sequences to add color to patches.1078 If this is set to `always`, linkgit:git-diff[1],1079 linkgit:git-log[1], and linkgit:git-show[1] will use color1080 for all patches. If it is set to `true` or `auto`, those1081 commands will only use color when output is to the terminal.1082 If unset, then the value of `color.ui` is used (`auto` by1083 default).1084+1085This does not affect linkgit:git-format-patch[1] or the1086'git-diff-{asterisk}' plumbing commands. Can be overridden on the1087command line with the `--color[=<when>]` option.10881089diff.colorMoved::1090 If set to either a valid `<mode>` or a true value, moved lines1091 in a diff are colored differently, for details of valid modes1092 see '--color-moved' in linkgit:git-diff[1]. If simply set to1093 true the default color mode will be used. When set to false,1094 moved lines are not colored.10951096color.diff.<slot>::1097 Use customized color for diff colorization. `<slot>` specifies1098 which part of the patch to use the specified color, and is one1099 of `context` (context text - `plain` is a historical synonym),1100 `meta` (metainformation), `frag`1101 (hunk header), 'func' (function in hunk header), `old` (removed lines),1102 `new` (added lines), `commit` (commit headers), `whitespace`1103 (highlighting whitespace errors), `oldMoved` (deleted lines),1104 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1105 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1106 and `newMovedAlternativeDimmed` (See the '<mode>'1107 setting of '--color-moved' in linkgit:git-diff[1] for details).11081109color.decorate.<slot>::1110 Use customized color for 'git log --decorate' output. `<slot>` is one1111 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1112 branches, remote-tracking branches, tags, stash and HEAD, respectively.11131114color.grep::1115 When set to `always`, always highlight matches. When `false` (or1116 `never`), never. When set to `true` or `auto`, use color only1117 when the output is written to the terminal. If unset, then the1118 value of `color.ui` is used (`auto` by default).11191120color.grep.<slot>::1121 Use customized color for grep colorization. `<slot>` specifies which1122 part of the line to use the specified color, and is one of1123+1124--1125`context`;;1126 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1127`filename`;;1128 filename prefix (when not using `-h`)1129`function`;;1130 function name lines (when using `-p`)1131`linenumber`;;1132 line number prefix (when using `-n`)1133`match`;;1134 matching text (same as setting `matchContext` and `matchSelected`)1135`matchContext`;;1136 matching text in context lines1137`matchSelected`;;1138 matching text in selected lines1139`selected`;;1140 non-matching text in selected lines1141`separator`;;1142 separators between fields on a line (`:`, `-`, and `=`)1143 and between hunks (`--`)1144--11451146color.interactive::1147 When set to `always`, always use colors for interactive prompts1148 and displays (such as those used by "git-add --interactive" and1149 "git-clean --interactive"). When false (or `never`), never.1150 When set to `true` or `auto`, use colors only when the output is1151 to the terminal. If unset, then the value of `color.ui` is1152 used (`auto` by default).11531154color.interactive.<slot>::1155 Use customized color for 'git add --interactive' and 'git clean1156 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1157 or `error`, for four distinct types of normal output from1158 interactive commands.11591160color.pager::1161 A boolean to enable/disable colored output when the pager is in1162 use (default is true).11631164color.showBranch::1165 A boolean to enable/disable color in the output of1166 linkgit:git-show-branch[1]. May be set to `always`,1167 `false` (or `never`) or `auto` (or `true`), in which case colors are used1168 only when the output is to a terminal. If unset, then the1169 value of `color.ui` is used (`auto` by default).11701171color.status::1172 A boolean to enable/disable color in the output of1173 linkgit:git-status[1]. May be set to `always`,1174 `false` (or `never`) or `auto` (or `true`), in which case colors are used1175 only when the output is to a terminal. If unset, then the1176 value of `color.ui` is used (`auto` by default).11771178color.status.<slot>::1179 Use customized color for status colorization. `<slot>` is1180 one of `header` (the header text of the status message),1181 `added` or `updated` (files which are added but not committed),1182 `changed` (files which are changed but not added in the index),1183 `untracked` (files which are not tracked by Git),1184 `branch` (the current branch),1185 `nobranch` (the color the 'no branch' warning is shown in, defaulting1186 to red),1187 `localBranch` or `remoteBranch` (the local and remote branch names,1188 respectively, when branch and tracking information is displayed in the1189 status short-format), or1190 `unmerged` (files which have unmerged changes).11911192color.ui::1193 This variable determines the default value for variables such1194 as `color.diff` and `color.grep` that control the use of color1195 per command family. Its scope will expand as more commands learn1196 configuration to set a default for the `--color` option. Set it1197 to `false` or `never` if you prefer Git commands not to use1198 color unless enabled explicitly with some other configuration1199 or the `--color` option. Set it to `always` if you want all1200 output not intended for machine consumption to use color, to1201 `true` or `auto` (this is the default since Git 1.8.4) if you1202 want such output to use color when written to the terminal.12031204column.ui::1205 Specify whether supported commands should output in columns.1206 This variable consists of a list of tokens separated by spaces1207 or commas:1208+1209These options control when the feature should be enabled1210(defaults to 'never'):1211+1212--1213`always`;;1214 always show in columns1215`never`;;1216 never show in columns1217`auto`;;1218 show in columns if the output is to the terminal1219--1220+1221These options control layout (defaults to 'column'). Setting any1222of these implies 'always' if none of 'always', 'never', or 'auto' are1223specified.1224+1225--1226`column`;;1227 fill columns before rows1228`row`;;1229 fill rows before columns1230`plain`;;1231 show in one column1232--1233+1234Finally, these options can be combined with a layout option (defaults1235to 'nodense'):1236+1237--1238`dense`;;1239 make unequal size columns to utilize more space1240`nodense`;;1241 make equal size columns1242--12431244column.branch::1245 Specify whether to output branch listing in `git branch` in columns.1246 See `column.ui` for details.12471248column.clean::1249 Specify the layout when list items in `git clean -i`, which always1250 shows files and directories in columns. See `column.ui` for details.12511252column.status::1253 Specify whether to output untracked files in `git status` in columns.1254 See `column.ui` for details.12551256column.tag::1257 Specify whether to output tag listing in `git tag` in columns.1258 See `column.ui` for details.12591260commit.cleanup::1261 This setting overrides the default of the `--cleanup` option in1262 `git commit`. See linkgit:git-commit[1] for details. Changing the1263 default can be useful when you always want to keep lines that begin1264 with comment character `#` in your log message, in which case you1265 would do `git config commit.cleanup whitespace` (note that you will1266 have to remove the help lines that begin with `#` in the commit log1267 template yourself, if you do this).12681269commit.gpgSign::12701271 A boolean to specify whether all commits should be GPG signed.1272 Use of this option when doing operations such as rebase can1273 result in a large number of commits being signed. It may be1274 convenient to use an agent to avoid typing your GPG passphrase1275 several times.12761277commit.status::1278 A boolean to enable/disable inclusion of status information in the1279 commit message template when using an editor to prepare the commit1280 message. Defaults to true.12811282commit.template::1283 Specify the pathname of a file to use as the template for1284 new commit messages.12851286commit.verbose::1287 A boolean or int to specify the level of verbose with `git commit`.1288 See linkgit:git-commit[1].12891290credential.helper::1291 Specify an external helper to be called when a username or1292 password credential is needed; the helper may consult external1293 storage to avoid prompting the user for the credentials. Note1294 that multiple helpers may be defined. See linkgit:gitcredentials[7]1295 for details.12961297credential.useHttpPath::1298 When acquiring credentials, consider the "path" component of an http1299 or https URL to be important. Defaults to false. See1300 linkgit:gitcredentials[7] for more information.13011302credential.username::1303 If no username is set for a network authentication, use this username1304 by default. See credential.<context>.* below, and1305 linkgit:gitcredentials[7].13061307credential.<url>.*::1308 Any of the credential.* options above can be applied selectively to1309 some credentials. For example "credential.https://example.com.username"1310 would set the default username only for https connections to1311 example.com. See linkgit:gitcredentials[7] for details on how URLs are1312 matched.13131314credentialCache.ignoreSIGHUP::1315 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13161317include::diff-config.txt[]13181319difftool.<tool>.path::1320 Override the path for the given tool. This is useful in case1321 your tool is not in the PATH.13221323difftool.<tool>.cmd::1324 Specify the command to invoke the specified diff tool.1325 The specified command is evaluated in shell with the following1326 variables available: 'LOCAL' is set to the name of the temporary1327 file containing the contents of the diff pre-image and 'REMOTE'1328 is set to the name of the temporary file containing the contents1329 of the diff post-image.13301331difftool.prompt::1332 Prompt before each invocation of the diff tool.13331334fastimport.unpackLimit::1335 If the number of objects imported by linkgit:git-fast-import[1]1336 is below this limit, then the objects will be unpacked into1337 loose object files. However if the number of imported objects1338 equals or exceeds this limit then the pack will be stored as a1339 pack. Storing the pack from a fast-import can make the import1340 operation complete faster, especially on slow filesystems. If1341 not set, the value of `transfer.unpackLimit` is used instead.13421343fetch.recurseSubmodules::1344 This option can be either set to a boolean value or to 'on-demand'.1345 Setting it to a boolean changes the behavior of fetch and pull to1346 unconditionally recurse into submodules when set to true or to not1347 recurse at all when set to false. When set to 'on-demand' (the default1348 value), fetch and pull will only recurse into a populated submodule1349 when its superproject retrieves a commit that updates the submodule's1350 reference.13511352fetch.fsckObjects::1353 If it is set to true, git-fetch-pack will check all fetched1354 objects. It will abort in the case of a malformed object or a1355 broken link. The result of an abort are only dangling objects.1356 Defaults to false. If not set, the value of `transfer.fsckObjects`1357 is used instead.13581359fetch.unpackLimit::1360 If the number of objects fetched over the Git native1361 transfer is below this1362 limit, then the objects will be unpacked into loose object1363 files. However if the number of received objects equals or1364 exceeds this limit then the received pack will be stored as1365 a pack, after adding any missing delta bases. Storing the1366 pack from a push can make the push operation complete faster,1367 especially on slow filesystems. If not set, the value of1368 `transfer.unpackLimit` is used instead.13691370fetch.prune::1371 If true, fetch will automatically behave as if the `--prune`1372 option was given on the command line. See also `remote.<name>.prune`.13731374fetch.output::1375 Control how ref update status is printed. Valid values are1376 `full` and `compact`. Default value is `full`. See section1377 OUTPUT in linkgit:git-fetch[1] for detail.13781379format.attach::1380 Enable multipart/mixed attachments as the default for1381 'format-patch'. The value can also be a double quoted string1382 which will enable attachments as the default and set the1383 value as the boundary. See the --attach option in1384 linkgit:git-format-patch[1].13851386format.from::1387 Provides the default value for the `--from` option to format-patch.1388 Accepts a boolean value, or a name and email address. If false,1389 format-patch defaults to `--no-from`, using commit authors directly in1390 the "From:" field of patch mails. If true, format-patch defaults to1391 `--from`, using your committer identity in the "From:" field of patch1392 mails and including a "From:" field in the body of the patch mail if1393 different. If set to a non-boolean value, format-patch uses that1394 value instead of your committer identity. Defaults to false.13951396format.numbered::1397 A boolean which can enable or disable sequence numbers in patch1398 subjects. It defaults to "auto" which enables it only if there1399 is more than one patch. It can be enabled or disabled for all1400 messages by setting it to "true" or "false". See --numbered1401 option in linkgit:git-format-patch[1].14021403format.headers::1404 Additional email headers to include in a patch to be submitted1405 by mail. See linkgit:git-format-patch[1].14061407format.to::1408format.cc::1409 Additional recipients to include in a patch to be submitted1410 by mail. See the --to and --cc options in1411 linkgit:git-format-patch[1].14121413format.subjectPrefix::1414 The default for format-patch is to output files with the '[PATCH]'1415 subject prefix. Use this variable to change that prefix.14161417format.signature::1418 The default for format-patch is to output a signature containing1419 the Git version number. Use this variable to change that default.1420 Set this variable to the empty string ("") to suppress1421 signature generation.14221423format.signatureFile::1424 Works just like format.signature except the contents of the1425 file specified by this variable will be used as the signature.14261427format.suffix::1428 The default for format-patch is to output files with the suffix1429 `.patch`. Use this variable to change that suffix (make sure to1430 include the dot if you want it).14311432format.pretty::1433 The default pretty format for log/show/whatchanged command,1434 See linkgit:git-log[1], linkgit:git-show[1],1435 linkgit:git-whatchanged[1].14361437format.thread::1438 The default threading style for 'git format-patch'. Can be1439 a boolean value, or `shallow` or `deep`. `shallow` threading1440 makes every mail a reply to the head of the series,1441 where the head is chosen from the cover letter, the1442 `--in-reply-to`, and the first patch mail, in this order.1443 `deep` threading makes every mail a reply to the previous one.1444 A true boolean value is the same as `shallow`, and a false1445 value disables threading.14461447format.signOff::1448 A boolean value which lets you enable the `-s/--signoff` option of1449 format-patch by default. *Note:* Adding the Signed-off-by: line to a1450 patch should be a conscious act and means that you certify you have1451 the rights to submit this work under the same open source license.1452 Please see the 'SubmittingPatches' document for further discussion.14531454format.coverLetter::1455 A boolean that controls whether to generate a cover-letter when1456 format-patch is invoked, but in addition can be set to "auto", to1457 generate a cover-letter only when there's more than one patch.14581459format.outputDirectory::1460 Set a custom directory to store the resulting files instead of the1461 current working directory.14621463format.useAutoBase::1464 A boolean value which lets you enable the `--base=auto` option of1465 format-patch by default.14661467filter.<driver>.clean::1468 The command which is used to convert the content of a worktree1469 file to a blob upon checkin. See linkgit:gitattributes[5] for1470 details.14711472filter.<driver>.smudge::1473 The command which is used to convert the content of a blob1474 object to a worktree file upon checkout. See1475 linkgit:gitattributes[5] for details.14761477fsck.<msg-id>::1478 Allows overriding the message type (error, warn or ignore) of a1479 specific message ID such as `missingEmail`.1480+1481For convenience, fsck prefixes the error/warning with the message ID,1482e.g. "missingEmail: invalid author/committer line - missing email" means1483that setting `fsck.missingEmail = ignore` will hide that issue.1484+1485This feature is intended to support working with legacy repositories1486which cannot be repaired without disruptive changes.14871488fsck.skipList::1489 The path to a sorted list of object names (i.e. one SHA-1 per1490 line) that are known to be broken in a non-fatal way and should1491 be ignored. This feature is useful when an established project1492 should be accepted despite early commits containing errors that1493 can be safely ignored such as invalid committer email addresses.1494 Note: corrupt objects cannot be skipped with this setting.14951496gc.aggressiveDepth::1497 The depth parameter used in the delta compression1498 algorithm used by 'git gc --aggressive'. This defaults1499 to 50.15001501gc.aggressiveWindow::1502 The window size parameter used in the delta compression1503 algorithm used by 'git gc --aggressive'. This defaults1504 to 250.15051506gc.auto::1507 When there are approximately more than this many loose1508 objects in the repository, `git gc --auto` will pack them.1509 Some Porcelain commands use this command to perform a1510 light-weight garbage collection from time to time. The1511 default value is 6700. Setting this to 0 disables it.15121513gc.autoPackLimit::1514 When there are more than this many packs that are not1515 marked with `*.keep` file in the repository, `git gc1516 --auto` consolidates them into one larger pack. The1517 default value is 50. Setting this to 0 disables it.15181519gc.autoDetach::1520 Make `git gc --auto` return immediately and run in background1521 if the system supports it. Default is true.15221523gc.logExpiry::1524 If the file gc.log exists, then `git gc --auto` won't run1525 unless that file is more than 'gc.logExpiry' old. Default is1526 "1.day". See `gc.pruneExpire` for more ways to specify its1527 value.15281529gc.packRefs::1530 Running `git pack-refs` in a repository renders it1531 unclonable by Git versions prior to 1.5.1.2 over dumb1532 transports such as HTTP. This variable determines whether1533 'git gc' runs `git pack-refs`. This can be set to `notbare`1534 to enable it within all non-bare repos or it can be set to a1535 boolean value. The default is `true`.15361537gc.pruneExpire::1538 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1539 Override the grace period with this config variable. The value1540 "now" may be used to disable this grace period and always prune1541 unreachable objects immediately, or "never" may be used to1542 suppress pruning. This feature helps prevent corruption when1543 'git gc' runs concurrently with another process writing to the1544 repository; see the "NOTES" section of linkgit:git-gc[1].15451546gc.worktreePruneExpire::1547 When 'git gc' is run, it calls1548 'git worktree prune --expire 3.months.ago'.1549 This config variable can be used to set a different grace1550 period. The value "now" may be used to disable the grace1551 period and prune `$GIT_DIR/worktrees` immediately, or "never"1552 may be used to suppress pruning.15531554gc.reflogExpire::1555gc.<pattern>.reflogExpire::1556 'git reflog expire' removes reflog entries older than1557 this time; defaults to 90 days. The value "now" expires all1558 entries immediately, and "never" suppresses expiration1559 altogether. With "<pattern>" (e.g.1560 "refs/stash") in the middle the setting applies only to1561 the refs that match the <pattern>.15621563gc.reflogExpireUnreachable::1564gc.<pattern>.reflogExpireUnreachable::1565 'git reflog expire' removes reflog entries older than1566 this time and are not reachable from the current tip;1567 defaults to 30 days. The value "now" expires all entries1568 immediately, and "never" suppresses expiration altogether.1569 With "<pattern>" (e.g. "refs/stash")1570 in the middle, the setting applies only to the refs that1571 match the <pattern>.15721573gc.rerereResolved::1574 Records of conflicted merge you resolved earlier are1575 kept for this many days when 'git rerere gc' is run.1576 You can also use more human-readable "1.month.ago", etc.1577 The default is 60 days. See linkgit:git-rerere[1].15781579gc.rerereUnresolved::1580 Records of conflicted merge you have not resolved are1581 kept for this many days when 'git rerere gc' is run.1582 You can also use more human-readable "1.month.ago", etc.1583 The default is 15 days. See linkgit:git-rerere[1].15841585gitcvs.commitMsgAnnotation::1586 Append this string to each commit message. Set to empty string1587 to disable this feature. Defaults to "via git-CVS emulator".15881589gitcvs.enabled::1590 Whether the CVS server interface is enabled for this repository.1591 See linkgit:git-cvsserver[1].15921593gitcvs.logFile::1594 Path to a log file where the CVS server interface well... logs1595 various stuff. See linkgit:git-cvsserver[1].15961597gitcvs.usecrlfattr::1598 If true, the server will look up the end-of-line conversion1599 attributes for files to determine the `-k` modes to use. If1600 the attributes force Git to treat a file as text,1601 the `-k` mode will be left blank so CVS clients will1602 treat it as text. If they suppress text conversion, the file1603 will be set with '-kb' mode, which suppresses any newline munging1604 the client might otherwise do. If the attributes do not allow1605 the file type to be determined, then `gitcvs.allBinary` is1606 used. See linkgit:gitattributes[5].16071608gitcvs.allBinary::1609 This is used if `gitcvs.usecrlfattr` does not resolve1610 the correct '-kb' mode to use. If true, all1611 unresolved files are sent to the client in1612 mode '-kb'. This causes the client to treat them1613 as binary files, which suppresses any newline munging it1614 otherwise might do. Alternatively, if it is set to "guess",1615 then the contents of the file are examined to decide if1616 it is binary, similar to `core.autocrlf`.16171618gitcvs.dbName::1619 Database used by git-cvsserver to cache revision information1620 derived from the Git repository. The exact meaning depends on the1621 used database driver, for SQLite (which is the default driver) this1622 is a filename. Supports variable substitution (see1623 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1624 Default: '%Ggitcvs.%m.sqlite'16251626gitcvs.dbDriver::1627 Used Perl DBI driver. You can specify any available driver1628 for this here, but it might not work. git-cvsserver is tested1629 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1630 reported *not* to work with 'DBD::mysql'. Experimental feature.1631 May not contain double colons (`:`). Default: 'SQLite'.1632 See linkgit:git-cvsserver[1].16331634gitcvs.dbUser, gitcvs.dbPass::1635 Database user and password. Only useful if setting `gitcvs.dbDriver`,1636 since SQLite has no concept of database users and/or passwords.1637 'gitcvs.dbUser' supports variable substitution (see1638 linkgit:git-cvsserver[1] for details).16391640gitcvs.dbTableNamePrefix::1641 Database table name prefix. Prepended to the names of any1642 database tables used, allowing a single database to be used1643 for several repositories. Supports variable substitution (see1644 linkgit:git-cvsserver[1] for details). Any non-alphabetic1645 characters will be replaced with underscores.16461647All gitcvs variables except for `gitcvs.usecrlfattr` and1648`gitcvs.allBinary` can also be specified as1649'gitcvs.<access_method>.<varname>' (where 'access_method'1650is one of "ext" and "pserver") to make them apply only for the given1651access method.16521653gitweb.category::1654gitweb.description::1655gitweb.owner::1656gitweb.url::1657 See linkgit:gitweb[1] for description.16581659gitweb.avatar::1660gitweb.blame::1661gitweb.grep::1662gitweb.highlight::1663gitweb.patches::1664gitweb.pickaxe::1665gitweb.remote_heads::1666gitweb.showSizes::1667gitweb.snapshot::1668 See linkgit:gitweb.conf[5] for description.16691670grep.lineNumber::1671 If set to true, enable `-n` option by default.16721673grep.patternType::1674 Set the default matching behavior. Using a value of 'basic', 'extended',1675 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1676 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1677 value 'default' will return to the default matching behavior.16781679grep.extendedRegexp::1680 If set to true, enable `--extended-regexp` option by default. This1681 option is ignored when the `grep.patternType` option is set to a value1682 other than 'default'.16831684grep.threads::1685 Number of grep worker threads to use.1686 See `grep.threads` in linkgit:git-grep[1] for more information.16871688grep.fallbackToNoIndex::1689 If set to true, fall back to git grep --no-index if git grep1690 is executed outside of a git repository. Defaults to false.16911692gpg.program::1693 Use this custom program instead of "`gpg`" found on `$PATH` when1694 making or verifying a PGP signature. The program must support the1695 same command-line interface as GPG, namely, to verify a detached1696 signature, "`gpg --verify $file - <$signature`" is run, and the1697 program is expected to signal a good signature by exiting with1698 code 0, and to generate an ASCII-armored detached signature, the1699 standard input of "`gpg -bsau $key`" is fed with the contents to be1700 signed, and the program is expected to send the result to its1701 standard output.17021703gui.commitMsgWidth::1704 Defines how wide the commit message window is in the1705 linkgit:git-gui[1]. "75" is the default.17061707gui.diffContext::1708 Specifies how many context lines should be used in calls to diff1709 made by the linkgit:git-gui[1]. The default is "5".17101711gui.displayUntracked::1712 Determines if linkgit:git-gui[1] shows untracked files1713 in the file list. The default is "true".17141715gui.encoding::1716 Specifies the default encoding to use for displaying of1717 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1718 It can be overridden by setting the 'encoding' attribute1719 for relevant files (see linkgit:gitattributes[5]).1720 If this option is not set, the tools default to the1721 locale encoding.17221723gui.matchTrackingBranch::1724 Determines if new branches created with linkgit:git-gui[1] should1725 default to tracking remote branches with matching names or1726 not. Default: "false".17271728gui.newBranchTemplate::1729 Is used as suggested name when creating new branches using the1730 linkgit:git-gui[1].17311732gui.pruneDuringFetch::1733 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1734 performing a fetch. The default value is "false".17351736gui.trustmtime::1737 Determines if linkgit:git-gui[1] should trust the file modification1738 timestamp or not. By default the timestamps are not trusted.17391740gui.spellingDictionary::1741 Specifies the dictionary used for spell checking commit messages in1742 the linkgit:git-gui[1]. When set to "none" spell checking is turned1743 off.17441745gui.fastCopyBlame::1746 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1747 location detection. It makes blame significantly faster on huge1748 repositories at the expense of less thorough copy detection.17491750gui.copyBlameThreshold::1751 Specifies the threshold to use in 'git gui blame' original location1752 detection, measured in alphanumeric characters. See the1753 linkgit:git-blame[1] manual for more information on copy detection.17541755gui.blamehistoryctx::1756 Specifies the radius of history context in days to show in1757 linkgit:gitk[1] for the selected commit, when the `Show History1758 Context` menu item is invoked from 'git gui blame'. If this1759 variable is set to zero, the whole history is shown.17601761guitool.<name>.cmd::1762 Specifies the shell command line to execute when the corresponding item1763 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1764 mandatory for every tool. The command is executed from the root of1765 the working directory, and in the environment it receives the name of1766 the tool as `GIT_GUITOOL`, the name of the currently selected file as1767 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1768 the head is detached, 'CUR_BRANCH' is empty).17691770guitool.<name>.needsFile::1771 Run the tool only if a diff is selected in the GUI. It guarantees1772 that 'FILENAME' is not empty.17731774guitool.<name>.noConsole::1775 Run the command silently, without creating a window to display its1776 output.17771778guitool.<name>.noRescan::1779 Don't rescan the working directory for changes after the tool1780 finishes execution.17811782guitool.<name>.confirm::1783 Show a confirmation dialog before actually running the tool.17841785guitool.<name>.argPrompt::1786 Request a string argument from the user, and pass it to the tool1787 through the `ARGS` environment variable. Since requesting an1788 argument implies confirmation, the 'confirm' option has no effect1789 if this is enabled. If the option is set to 'true', 'yes', or '1',1790 the dialog uses a built-in generic prompt; otherwise the exact1791 value of the variable is used.17921793guitool.<name>.revPrompt::1794 Request a single valid revision from the user, and set the1795 `REVISION` environment variable. In other aspects this option1796 is similar to 'argPrompt', and can be used together with it.17971798guitool.<name>.revUnmerged::1799 Show only unmerged branches in the 'revPrompt' subdialog.1800 This is useful for tools similar to merge or rebase, but not1801 for things like checkout or reset.18021803guitool.<name>.title::1804 Specifies the title to use for the prompt dialog. The default1805 is the tool name.18061807guitool.<name>.prompt::1808 Specifies the general prompt string to display at the top of1809 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1810 The default value includes the actual command.18111812help.browser::1813 Specify the browser that will be used to display help in the1814 'web' format. See linkgit:git-help[1].18151816help.format::1817 Override the default help format used by linkgit:git-help[1].1818 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1819 the default. 'web' and 'html' are the same.18201821help.autoCorrect::1822 Automatically correct and execute mistyped commands after1823 waiting for the given number of deciseconds (0.1 sec). If more1824 than one command can be deduced from the entered text, nothing1825 will be executed. If the value of this option is negative,1826 the corrected command will be executed immediately. If the1827 value is 0 - the command will be just shown but not executed.1828 This is the default.18291830help.htmlPath::1831 Specify the path where the HTML documentation resides. File system paths1832 and URLs are supported. HTML pages will be prefixed with this path when1833 help is displayed in the 'web' format. This defaults to the documentation1834 path of your Git installation.18351836http.proxy::1837 Override the HTTP proxy, normally configured using the 'http_proxy',1838 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1839 addition to the syntax understood by curl, it is possible to specify a1840 proxy string with a user name but no password, in which case git will1841 attempt to acquire one in the same way it does for other credentials. See1842 linkgit:gitcredentials[7] for more information. The syntax thus is1843 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1844 on a per-remote basis; see remote.<name>.proxy18451846http.proxyAuthMethod::1847 Set the method with which to authenticate against the HTTP proxy. This1848 only takes effect if the configured proxy string contains a user name part1849 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1850 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1851 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1852 variable. Possible values are:1853+1854--1855* `anyauth` - Automatically pick a suitable authentication method. It is1856 assumed that the proxy answers an unauthenticated request with a 4071857 status code and one or more Proxy-authenticate headers with supported1858 authentication methods. This is the default.1859* `basic` - HTTP Basic authentication1860* `digest` - HTTP Digest authentication; this prevents the password from being1861 transmitted to the proxy in clear text1862* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1863 of `curl(1)`)1864* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1865--18661867http.emptyAuth::1868 Attempt authentication without seeking a username or password. This1869 can be used to attempt GSS-Negotiate authentication without specifying1870 a username in the URL, as libcurl normally requires a username for1871 authentication.18721873http.delegation::1874 Control GSSAPI credential delegation. The delegation is disabled1875 by default in libcurl since version 7.21.7. Set parameter to tell1876 the server what it is allowed to delegate when it comes to user1877 credentials. Used with GSS/kerberos. Possible values are:1878+1879--1880* `none` - Don't allow any delegation.1881* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1882 Kerberos service ticket, which is a matter of realm policy.1883* `always` - Unconditionally allow the server to delegate.1884--188518861887http.extraHeader::1888 Pass an additional HTTP header when communicating with a server. If1889 more than one such entry exists, all of them are added as extra1890 headers. To allow overriding the settings inherited from the system1891 config, an empty value will reset the extra headers to the empty list.18921893http.cookieFile::1894 The pathname of a file containing previously stored cookie lines,1895 which should be used1896 in the Git http session, if they match the server. The file format1897 of the file to read cookies from should be plain HTTP headers or1898 the Netscape/Mozilla cookie file format (see `curl(1)`).1899 NOTE that the file specified with http.cookieFile is used only as1900 input unless http.saveCookies is set.19011902http.saveCookies::1903 If set, store cookies received during requests to the file specified by1904 http.cookieFile. Has no effect if http.cookieFile is unset.19051906http.sslVersion::1907 The SSL version to use when negotiating an SSL connection, if you1908 want to force the default. The available and default version1909 depend on whether libcurl was built against NSS or OpenSSL and the1910 particular configuration of the crypto library in use. Internally1911 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1912 documentation for more details on the format of this option and1913 for the ssl version supported. Actually the possible values of1914 this option are:19151916 - sslv21917 - sslv31918 - tlsv11919 - tlsv1.01920 - tlsv1.11921 - tlsv1.219221923+1924Can be overridden by the `GIT_SSL_VERSION` environment variable.1925To force git to use libcurl's default ssl version and ignore any1926explicit http.sslversion option, set `GIT_SSL_VERSION` to the1927empty string.19281929http.sslCipherList::1930 A list of SSL ciphers to use when negotiating an SSL connection.1931 The available ciphers depend on whether libcurl was built against1932 NSS or OpenSSL and the particular configuration of the crypto1933 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1934 option; see the libcurl documentation for more details on the format1935 of this list.1936+1937Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1938To force git to use libcurl's default cipher list and ignore any1939explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1940empty string.19411942http.sslVerify::1943 Whether to verify the SSL certificate when fetching or pushing1944 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1945 variable.19461947http.sslCert::1948 File containing the SSL certificate when fetching or pushing1949 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1950 variable.19511952http.sslKey::1953 File containing the SSL private key when fetching or pushing1954 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1955 variable.19561957http.sslCertPasswordProtected::1958 Enable Git's password prompt for the SSL certificate. Otherwise1959 OpenSSL will prompt the user, possibly many times, if the1960 certificate or private key is encrypted. Can be overridden by the1961 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19621963http.sslCAInfo::1964 File containing the certificates to verify the peer with when1965 fetching or pushing over HTTPS. Can be overridden by the1966 `GIT_SSL_CAINFO` environment variable.19671968http.sslCAPath::1969 Path containing files with the CA certificates to verify the peer1970 with when fetching or pushing over HTTPS. Can be overridden1971 by the `GIT_SSL_CAPATH` environment variable.19721973http.pinnedpubkey::1974 Public key of the https service. It may either be the filename of1975 a PEM or DER encoded public key file or a string starting with1976 'sha256//' followed by the base64 encoded sha256 hash of the1977 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1978 exit with an error if this option is set but not supported by1979 cURL.19801981http.sslTry::1982 Attempt to use AUTH SSL/TLS and encrypted data transfers1983 when connecting via regular FTP protocol. This might be needed1984 if the FTP server requires it for security reasons or you wish1985 to connect securely whenever remote FTP server supports it.1986 Default is false since it might trigger certificate verification1987 errors on misconfigured servers.19881989http.maxRequests::1990 How many HTTP requests to launch in parallel. Can be overridden1991 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.19921993http.minSessions::1994 The number of curl sessions (counted across slots) to be kept across1995 requests. They will not be ended with curl_easy_cleanup() until1996 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1997 value will be capped at 1. Defaults to 1.19981999http.postBuffer::2000 Maximum size in bytes of the buffer used by smart HTTP2001 transports when POSTing data to the remote system.2002 For requests larger than this buffer size, HTTP/1.1 and2003 Transfer-Encoding: chunked is used to avoid creating a2004 massive pack file locally. Default is 1 MiB, which is2005 sufficient for most requests.20062007http.lowSpeedLimit, http.lowSpeedTime::2008 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2009 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2010 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2011 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20122013http.noEPSV::2014 A boolean which disables using of EPSV ftp command by curl.2015 This can helpful with some "poor" ftp servers which don't2016 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2017 environment variable. Default is false (curl will use EPSV).20182019http.userAgent::2020 The HTTP USER_AGENT string presented to an HTTP server. The default2021 value represents the version of the client Git such as git/1.7.1.2022 This option allows you to override this value to a more common value2023 such as Mozilla/4.0. This may be necessary, for instance, if2024 connecting through a firewall that restricts HTTP connections to a set2025 of common USER_AGENT strings (but not including those like git/1.7.1).2026 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20272028http.followRedirects::2029 Whether git should follow HTTP redirects. If set to `true`, git2030 will transparently follow any redirect issued by a server it2031 encounters. If set to `false`, git will treat all redirects as2032 errors. If set to `initial`, git will follow redirects only for2033 the initial request to a remote, but not for subsequent2034 follow-up HTTP requests. Since git uses the redirected URL as2035 the base for the follow-up requests, this is generally2036 sufficient. The default is `initial`.20372038http.<url>.*::2039 Any of the http.* options above can be applied selectively to some URLs.2040 For a config key to match a URL, each element of the config key is2041 compared to that of the URL, in the following order:2042+2043--2044. Scheme (e.g., `https` in `https://example.com/`). This field2045 must match exactly between the config key and the URL.20462047. Host/domain name (e.g., `example.com` in `https://example.com/`).2048 This field must match between the config key and the URL. It is2049 possible to specify a `*` as part of the host name to match all subdomains2050 at this level. `https://*.example.com/` for example would match2051 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20522053. Port number (e.g., `8080` in `http://example.com:8080/`).2054 This field must match exactly between the config key and the URL.2055 Omitted port numbers are automatically converted to the correct2056 default for the scheme before matching.20572058. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2059 path field of the config key must match the path field of the URL2060 either exactly or as a prefix of slash-delimited path elements. This means2061 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2062 match on a slash (`/`) boundary. Longer matches take precedence (so a config2063 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2064 key with just path `foo/`).20652066. User name (e.g., `user` in `https://user@example.com/repo.git`). If2067 the config key has a user name it must match the user name in the2068 URL exactly. If the config key does not have a user name, that2069 config key will match a URL with any user name (including none),2070 but at a lower precedence than a config key with a user name.2071--2072+2073The list above is ordered by decreasing precedence; a URL that matches2074a config key's path is preferred to one that matches its user name. For example,2075if the URL is `https://user@example.com/foo/bar` a config key match of2076`https://example.com/foo` will be preferred over a config key match of2077`https://user@example.com`.2078+2079All URLs are normalized before attempting any matching (the password part,2080if embedded in the URL, is always ignored for matching purposes) so that2081equivalent URLs that are simply spelled differently will match properly.2082Environment variable settings always override any matches. The URLs that are2083matched against are those given directly to Git commands. This means any URLs2084visited as a result of a redirection do not participate in matching.20852086ssh.variant::2087 Depending on the value of the environment variables `GIT_SSH` or2088 `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git2089 auto-detects whether to adjust its command-line parameters for use2090 with plink or tortoiseplink, as opposed to the default (OpenSSH).2091+2092The config variable `ssh.variant` can be set to override this auto-detection;2093valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value2094will be treated as normal ssh. This setting can be overridden via the2095environment variable `GIT_SSH_VARIANT`.20962097i18n.commitEncoding::2098 Character encoding the commit messages are stored in; Git itself2099 does not care per se, but this information is necessary e.g. when2100 importing commits from emails or in the gitk graphical history2101 browser (and possibly at other places in the future or in other2102 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21032104i18n.logOutputEncoding::2105 Character encoding the commit messages are converted to when2106 running 'git log' and friends.21072108imap::2109 The configuration variables in the 'imap' section are described2110 in linkgit:git-imap-send[1].21112112index.version::2113 Specify the version with which new index files should be2114 initialized. This does not affect existing repositories.21152116init.templateDir::2117 Specify the directory from which templates will be copied.2118 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21192120instaweb.browser::2121 Specify the program that will be used to browse your working2122 repository in gitweb. See linkgit:git-instaweb[1].21232124instaweb.httpd::2125 The HTTP daemon command-line to start gitweb on your working2126 repository. See linkgit:git-instaweb[1].21272128instaweb.local::2129 If true the web server started by linkgit:git-instaweb[1] will2130 be bound to the local IP (127.0.0.1).21312132instaweb.modulePath::2133 The default module path for linkgit:git-instaweb[1] to use2134 instead of /usr/lib/apache2/modules. Only used if httpd2135 is Apache.21362137instaweb.port::2138 The port number to bind the gitweb httpd to. See2139 linkgit:git-instaweb[1].21402141interactive.singleKey::2142 In interactive commands, allow the user to provide one-letter2143 input with a single key (i.e., without hitting enter).2144 Currently this is used by the `--patch` mode of2145 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2146 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2147 setting is silently ignored if portable keystroke input2148 is not available; requires the Perl module Term::ReadKey.21492150interactive.diffFilter::2151 When an interactive command (such as `git add --patch`) shows2152 a colorized diff, git will pipe the diff through the shell2153 command defined by this configuration variable. The command may2154 mark up the diff further for human consumption, provided that it2155 retains a one-to-one correspondence with the lines in the2156 original diff. Defaults to disabled (no filtering).21572158log.abbrevCommit::2159 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2160 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2161 override this option with `--no-abbrev-commit`.21622163log.date::2164 Set the default date-time mode for the 'log' command.2165 Setting a value for log.date is similar to using 'git log''s2166 `--date` option. See linkgit:git-log[1] for details.21672168log.decorate::2169 Print out the ref names of any commits that are shown by the log2170 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2171 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2172 specified, the full ref name (including prefix) will be printed.2173 If 'auto' is specified, then if the output is going to a terminal,2174 the ref names are shown as if 'short' were given, otherwise no ref2175 names are shown. This is the same as the `--decorate` option2176 of the `git log`.21772178log.follow::2179 If `true`, `git log` will act as if the `--follow` option was used when2180 a single <path> is given. This has the same limitations as `--follow`,2181 i.e. it cannot be used to follow multiple files and does not work well2182 on non-linear history.21832184log.graphColors::2185 A list of colors, separated by commas, that can be used to draw2186 history lines in `git log --graph`.21872188log.showRoot::2189 If true, the initial commit will be shown as a big creation event.2190 This is equivalent to a diff against an empty tree.2191 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2192 normally hide the root commit will now show it. True by default.21932194log.showSignature::2195 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2196 linkgit:git-whatchanged[1] assume `--show-signature`.21972198log.mailmap::2199 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2200 linkgit:git-whatchanged[1] assume `--use-mailmap`.22012202mailinfo.scissors::2203 If true, makes linkgit:git-mailinfo[1] (and therefore2204 linkgit:git-am[1]) act by default as if the --scissors option2205 was provided on the command-line. When active, this features2206 removes everything from the message body before a scissors2207 line (i.e. consisting mainly of ">8", "8<" and "-").22082209mailmap.file::2210 The location of an augmenting mailmap file. The default2211 mailmap, located in the root of the repository, is loaded2212 first, then the mailmap file pointed to by this variable.2213 The location of the mailmap file may be in a repository2214 subdirectory, or somewhere outside of the repository itself.2215 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22162217mailmap.blob::2218 Like `mailmap.file`, but consider the value as a reference to a2219 blob in the repository. If both `mailmap.file` and2220 `mailmap.blob` are given, both are parsed, with entries from2221 `mailmap.file` taking precedence. In a bare repository, this2222 defaults to `HEAD:.mailmap`. In a non-bare repository, it2223 defaults to empty.22242225man.viewer::2226 Specify the programs that may be used to display help in the2227 'man' format. See linkgit:git-help[1].22282229man.<tool>.cmd::2230 Specify the command to invoke the specified man viewer. The2231 specified command is evaluated in shell with the man page2232 passed as argument. (See linkgit:git-help[1].)22332234man.<tool>.path::2235 Override the path for the given tool that may be used to2236 display help in the 'man' format. See linkgit:git-help[1].22372238include::merge-config.txt[]22392240mergetool.<tool>.path::2241 Override the path for the given tool. This is useful in case2242 your tool is not in the PATH.22432244mergetool.<tool>.cmd::2245 Specify the command to invoke the specified merge tool. The2246 specified command is evaluated in shell with the following2247 variables available: 'BASE' is the name of a temporary file2248 containing the common base of the files to be merged, if available;2249 'LOCAL' is the name of a temporary file containing the contents of2250 the file on the current branch; 'REMOTE' is the name of a temporary2251 file containing the contents of the file from the branch being2252 merged; 'MERGED' contains the name of the file to which the merge2253 tool should write the results of a successful merge.22542255mergetool.<tool>.trustExitCode::2256 For a custom merge command, specify whether the exit code of2257 the merge command can be used to determine whether the merge was2258 successful. If this is not set to true then the merge target file2259 timestamp is checked and the merge assumed to have been successful2260 if the file has been updated, otherwise the user is prompted to2261 indicate the success of the merge.22622263mergetool.meld.hasOutput::2264 Older versions of `meld` do not support the `--output` option.2265 Git will attempt to detect whether `meld` supports `--output`2266 by inspecting the output of `meld --help`. Configuring2267 `mergetool.meld.hasOutput` will make Git skip these checks and2268 use the configured value instead. Setting `mergetool.meld.hasOutput`2269 to `true` tells Git to unconditionally use the `--output` option,2270 and `false` avoids using `--output`.22712272mergetool.keepBackup::2273 After performing a merge, the original file with conflict markers2274 can be saved as a file with a `.orig` extension. If this variable2275 is set to `false` then this file is not preserved. Defaults to2276 `true` (i.e. keep the backup files).22772278mergetool.keepTemporaries::2279 When invoking a custom merge tool, Git uses a set of temporary2280 files to pass to the tool. If the tool returns an error and this2281 variable is set to `true`, then these temporary files will be2282 preserved, otherwise they will be removed after the tool has2283 exited. Defaults to `false`.22842285mergetool.writeToTemp::2286 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2287 conflicting files in the worktree by default. Git will attempt2288 to use a temporary directory for these files when set `true`.2289 Defaults to `false`.22902291mergetool.prompt::2292 Prompt before each invocation of the merge resolution program.22932294notes.mergeStrategy::2295 Which merge strategy to choose by default when resolving notes2296 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2297 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2298 section of linkgit:git-notes[1] for more information on each strategy.22992300notes.<name>.mergeStrategy::2301 Which merge strategy to choose when doing a notes merge into2302 refs/notes/<name>. This overrides the more general2303 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2304 linkgit:git-notes[1] for more information on the available strategies.23052306notes.displayRef::2307 The (fully qualified) refname from which to show notes when2308 showing commit messages. The value of this variable can be set2309 to a glob, in which case notes from all matching refs will be2310 shown. You may also specify this configuration variable2311 several times. A warning will be issued for refs that do not2312 exist, but a glob that does not match any refs is silently2313 ignored.2314+2315This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2316environment variable, which must be a colon separated list of refs or2317globs.2318+2319The effective value of "core.notesRef" (possibly overridden by2320GIT_NOTES_REF) is also implicitly added to the list of refs to be2321displayed.23222323notes.rewrite.<command>::2324 When rewriting commits with <command> (currently `amend` or2325 `rebase`) and this variable is set to `true`, Git2326 automatically copies your notes from the original to the2327 rewritten commit. Defaults to `true`, but see2328 "notes.rewriteRef" below.23292330notes.rewriteMode::2331 When copying notes during a rewrite (see the2332 "notes.rewrite.<command>" option), determines what to do if2333 the target commit already has a note. Must be one of2334 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2335 Defaults to `concatenate`.2336+2337This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2338environment variable.23392340notes.rewriteRef::2341 When copying notes during a rewrite, specifies the (fully2342 qualified) ref whose notes should be copied. The ref may be a2343 glob, in which case notes in all matching refs will be copied.2344 You may also specify this configuration several times.2345+2346Does not have a default value; you must configure this variable to2347enable note rewriting. Set it to `refs/notes/commits` to enable2348rewriting for the default commit notes.2349+2350This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2351environment variable, which must be a colon separated list of refs or2352globs.23532354pack.window::2355 The size of the window used by linkgit:git-pack-objects[1] when no2356 window size is given on the command line. Defaults to 10.23572358pack.depth::2359 The maximum delta depth used by linkgit:git-pack-objects[1] when no2360 maximum depth is given on the command line. Defaults to 50.23612362pack.windowMemory::2363 The maximum size of memory that is consumed by each thread2364 in linkgit:git-pack-objects[1] for pack window memory when2365 no limit is given on the command line. The value can be2366 suffixed with "k", "m", or "g". When left unconfigured (or2367 set explicitly to 0), there will be no limit.23682369pack.compression::2370 An integer -1..9, indicating the compression level for objects2371 in a pack file. -1 is the zlib default. 0 means no2372 compression, and 1..9 are various speed/size tradeoffs, 9 being2373 slowest. If not set, defaults to core.compression. If that is2374 not set, defaults to -1, the zlib default, which is "a default2375 compromise between speed and compression (currently equivalent2376 to level 6)."2377+2378Note that changing the compression level will not automatically recompress2379all existing objects. You can force recompression by passing the -F option2380to linkgit:git-repack[1].23812382pack.deltaCacheSize::2383 The maximum memory in bytes used for caching deltas in2384 linkgit:git-pack-objects[1] before writing them out to a pack.2385 This cache is used to speed up the writing object phase by not2386 having to recompute the final delta result once the best match2387 for all objects is found. Repacking large repositories on machines2388 which are tight with memory might be badly impacted by this though,2389 especially if this cache pushes the system into swapping.2390 A value of 0 means no limit. The smallest size of 1 byte may be2391 used to virtually disable this cache. Defaults to 256 MiB.23922393pack.deltaCacheLimit::2394 The maximum size of a delta, that is cached in2395 linkgit:git-pack-objects[1]. This cache is used to speed up the2396 writing object phase by not having to recompute the final delta2397 result once the best match for all objects is found. Defaults to 1000.23982399pack.threads::2400 Specifies the number of threads to spawn when searching for best2401 delta matches. This requires that linkgit:git-pack-objects[1]2402 be compiled with pthreads otherwise this option is ignored with a2403 warning. This is meant to reduce packing time on multiprocessor2404 machines. The required amount of memory for the delta search window2405 is however multiplied by the number of threads.2406 Specifying 0 will cause Git to auto-detect the number of CPU's2407 and set the number of threads accordingly.24082409pack.indexVersion::2410 Specify the default pack index version. Valid values are 1 for2411 legacy pack index used by Git versions prior to 1.5.2, and 2 for2412 the new pack index with capabilities for packs larger than 4 GB2413 as well as proper protection against the repacking of corrupted2414 packs. Version 2 is the default. Note that version 2 is enforced2415 and this config option ignored whenever the corresponding pack is2416 larger than 2 GB.2417+2418If you have an old Git that does not understand the version 2 `*.idx` file,2419cloning or fetching over a non native protocol (e.g. "http")2420that will copy both `*.pack` file and corresponding `*.idx` file from the2421other side may give you a repository that cannot be accessed with your2422older version of Git. If the `*.pack` file is smaller than 2 GB, however,2423you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2424the `*.idx` file.24252426pack.packSizeLimit::2427 The maximum size of a pack. This setting only affects2428 packing to a file when repacking, i.e. the git:// protocol2429 is unaffected. It can be overridden by the `--max-pack-size`2430 option of linkgit:git-repack[1]. Reaching this limit results2431 in the creation of multiple packfiles; which in turn prevents2432 bitmaps from being created.2433 The minimum size allowed is limited to 1 MiB.2434 The default is unlimited.2435 Common unit suffixes of 'k', 'm', or 'g' are2436 supported.24372438pack.useBitmaps::2439 When true, git will use pack bitmaps (if available) when packing2440 to stdout (e.g., during the server side of a fetch). Defaults to2441 true. You should not generally need to turn this off unless2442 you are debugging pack bitmaps.24432444pack.writeBitmaps (deprecated)::2445 This is a deprecated synonym for `repack.writeBitmaps`.24462447pack.writeBitmapHashCache::2448 When true, git will include a "hash cache" section in the bitmap2449 index (if one is written). This cache can be used to feed git's2450 delta heuristics, potentially leading to better deltas between2451 bitmapped and non-bitmapped objects (e.g., when serving a fetch2452 between an older, bitmapped pack and objects that have been2453 pushed since the last gc). The downside is that it consumes 42454 bytes per object of disk space, and that JGit's bitmap2455 implementation does not understand it, causing it to complain if2456 Git and JGit are used on the same repository. Defaults to false.24572458pager.<cmd>::2459 If the value is boolean, turns on or off pagination of the2460 output of a particular Git subcommand when writing to a tty.2461 Otherwise, turns on pagination for the subcommand using the2462 pager specified by the value of `pager.<cmd>`. If `--paginate`2463 or `--no-pager` is specified on the command line, it takes2464 precedence over this option. To disable pagination for all2465 commands, set `core.pager` or `GIT_PAGER` to `cat`.24662467pretty.<name>::2468 Alias for a --pretty= format string, as specified in2469 linkgit:git-log[1]. Any aliases defined here can be used just2470 as the built-in pretty formats could. For example,2471 running `git config pretty.changelog "format:* %H %s"`2472 would cause the invocation `git log --pretty=changelog`2473 to be equivalent to running `git log "--pretty=format:* %H %s"`.2474 Note that an alias with the same name as a built-in format2475 will be silently ignored.24762477protocol.allow::2478 If set, provide a user defined default policy for all protocols which2479 don't explicitly have a policy (`protocol.<name>.allow`). By default,2480 if unset, known-safe protocols (http, https, git, ssh, file) have a2481 default policy of `always`, known-dangerous protocols (ext) have a2482 default policy of `never`, and all other protocols have a default2483 policy of `user`. Supported policies:2484+2485--24862487* `always` - protocol is always able to be used.24882489* `never` - protocol is never able to be used.24902491* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2492 either unset or has a value of 1. This policy should be used when you want a2493 protocol to be directly usable by the user but don't want it used by commands which2494 execute clone/fetch/push commands without user input, e.g. recursive2495 submodule initialization.24962497--24982499protocol.<name>.allow::2500 Set a policy to be used by protocol `<name>` with clone/fetch/push2501 commands. See `protocol.allow` above for the available policies.2502+2503The protocol names currently used by git are:2504+2505--2506 - `file`: any local file-based path (including `file://` URLs,2507 or local paths)25082509 - `git`: the anonymous git protocol over a direct TCP2510 connection (or proxy, if configured)25112512 - `ssh`: git over ssh (including `host:path` syntax,2513 `ssh://`, etc).25142515 - `http`: git over http, both "smart http" and "dumb http".2516 Note that this does _not_ include `https`; if you want to configure2517 both, you must do so individually.25182519 - any external helpers are named by their protocol (e.g., use2520 `hg` to allow the `git-remote-hg` helper)2521--25222523pull.ff::2524 By default, Git does not create an extra merge commit when merging2525 a commit that is a descendant of the current commit. Instead, the2526 tip of the current branch is fast-forwarded. When set to `false`,2527 this variable tells Git to create an extra merge commit in such2528 a case (equivalent to giving the `--no-ff` option from the command2529 line). When set to `only`, only such fast-forward merges are2530 allowed (equivalent to giving the `--ff-only` option from the2531 command line). This setting overrides `merge.ff` when pulling.25322533pull.rebase::2534 When true, rebase branches on top of the fetched branch, instead2535 of merging the default branch from the default remote when "git2536 pull" is run. See "branch.<name>.rebase" for setting this on a2537 per-branch basis.2538+2539When preserve, also pass `--preserve-merges` along to 'git rebase'2540so that locally committed merge commits will not be flattened2541by running 'git pull'.2542+2543When the value is `interactive`, the rebase is run in interactive mode.2544+2545*NOTE*: this is a possibly dangerous operation; do *not* use2546it unless you understand the implications (see linkgit:git-rebase[1]2547for details).25482549pull.octopus::2550 The default merge strategy to use when pulling multiple branches2551 at once.25522553pull.twohead::2554 The default merge strategy to use when pulling a single branch.25552556push.default::2557 Defines the action `git push` should take if no refspec is2558 explicitly given. Different values are well-suited for2559 specific workflows; for instance, in a purely central workflow2560 (i.e. the fetch source is equal to the push destination),2561 `upstream` is probably what you want. Possible values are:2562+2563--25642565* `nothing` - do not push anything (error out) unless a refspec is2566 explicitly given. This is primarily meant for people who want to2567 avoid mistakes by always being explicit.25682569* `current` - push the current branch to update a branch with the same2570 name on the receiving end. Works in both central and non-central2571 workflows.25722573* `upstream` - push the current branch back to the branch whose2574 changes are usually integrated into the current branch (which is2575 called `@{upstream}`). This mode only makes sense if you are2576 pushing to the same repository you would normally pull from2577 (i.e. central workflow).25782579* `tracking` - This is a deprecated synonym for `upstream`.25802581* `simple` - in centralized workflow, work like `upstream` with an2582 added safety to refuse to push if the upstream branch's name is2583 different from the local one.2584+2585When pushing to a remote that is different from the remote you normally2586pull from, work as `current`. This is the safest option and is suited2587for beginners.2588+2589This mode has become the default in Git 2.0.25902591* `matching` - push all branches having the same name on both ends.2592 This makes the repository you are pushing to remember the set of2593 branches that will be pushed out (e.g. if you always push 'maint'2594 and 'master' there and no other branches, the repository you push2595 to will have these two branches, and your local 'maint' and2596 'master' will be pushed there).2597+2598To use this mode effectively, you have to make sure _all_ the2599branches you would push out are ready to be pushed out before2600running 'git push', as the whole point of this mode is to allow you2601to push all of the branches in one go. If you usually finish work2602on only one branch and push out the result, while other branches are2603unfinished, this mode is not for you. Also this mode is not2604suitable for pushing into a shared central repository, as other2605people may add new branches there, or update the tip of existing2606branches outside your control.2607+2608This used to be the default, but not since Git 2.0 (`simple` is the2609new default).26102611--26122613push.followTags::2614 If set to true enable `--follow-tags` option by default. You2615 may override this configuration at time of push by specifying2616 `--no-follow-tags`.26172618push.gpgSign::2619 May be set to a boolean value, or the string 'if-asked'. A true2620 value causes all pushes to be GPG signed, as if `--signed` is2621 passed to linkgit:git-push[1]. The string 'if-asked' causes2622 pushes to be signed if the server supports it, as if2623 `--signed=if-asked` is passed to 'git push'. A false value may2624 override a value from a lower-priority config file. An explicit2625 command-line flag always overrides this config option.26262627push.recurseSubmodules::2628 Make sure all submodule commits used by the revisions to be pushed2629 are available on a remote-tracking branch. If the value is 'check'2630 then Git will verify that all submodule commits that changed in the2631 revisions to be pushed are available on at least one remote of the2632 submodule. If any commits are missing, the push will be aborted and2633 exit with non-zero status. If the value is 'on-demand' then all2634 submodules that changed in the revisions to be pushed will be2635 pushed. If on-demand was not able to push all necessary revisions2636 it will also be aborted and exit with non-zero status. If the value2637 is 'no' then default behavior of ignoring submodules when pushing2638 is retained. You may override this configuration at time of push by2639 specifying '--recurse-submodules=check|on-demand|no'.26402641rebase.stat::2642 Whether to show a diffstat of what changed upstream since the last2643 rebase. False by default.26442645rebase.autoSquash::2646 If set to true enable `--autosquash` option by default.26472648rebase.autoStash::2649 When set to true, automatically create a temporary stash entry2650 before the operation begins, and apply it after the operation2651 ends. This means that you can run rebase on a dirty worktree.2652 However, use with care: the final stash application after a2653 successful rebase might result in non-trivial conflicts.2654 Defaults to false.26552656rebase.missingCommitsCheck::2657 If set to "warn", git rebase -i will print a warning if some2658 commits are removed (e.g. a line was deleted), however the2659 rebase will still proceed. If set to "error", it will print2660 the previous warning and stop the rebase, 'git rebase2661 --edit-todo' can then be used to correct the error. If set to2662 "ignore", no checking is done.2663 To drop a commit without warning or error, use the `drop`2664 command in the todo-list.2665 Defaults to "ignore".26662667rebase.instructionFormat::2668 A format string, as specified in linkgit:git-log[1], to be used for2669 the instruction list during an interactive rebase. The format will automatically2670 have the long commit hash prepended to the format.26712672receive.advertiseAtomic::2673 By default, git-receive-pack will advertise the atomic push2674 capability to its clients. If you don't want to advertise this2675 capability, set this variable to false.26762677receive.advertisePushOptions::2678 When set to true, git-receive-pack will advertise the push options2679 capability to its clients. False by default.26802681receive.autogc::2682 By default, git-receive-pack will run "git-gc --auto" after2683 receiving data from git-push and updating refs. You can stop2684 it by setting this variable to false.26852686receive.certNonceSeed::2687 By setting this variable to a string, `git receive-pack`2688 will accept a `git push --signed` and verifies it by using2689 a "nonce" protected by HMAC using this string as a secret2690 key.26912692receive.certNonceSlop::2693 When a `git push --signed` sent a push certificate with a2694 "nonce" that was issued by a receive-pack serving the same2695 repository within this many seconds, export the "nonce"2696 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2697 hooks (instead of what the receive-pack asked the sending2698 side to include). This may allow writing checks in2699 `pre-receive` and `post-receive` a bit easier. Instead of2700 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2701 that records by how many seconds the nonce is stale to2702 decide if they want to accept the certificate, they only2703 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27042705receive.fsckObjects::2706 If it is set to true, git-receive-pack will check all received2707 objects. It will abort in the case of a malformed object or a2708 broken link. The result of an abort are only dangling objects.2709 Defaults to false. If not set, the value of `transfer.fsckObjects`2710 is used instead.27112712receive.fsck.<msg-id>::2713 When `receive.fsckObjects` is set to true, errors can be switched2714 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2715 setting where the `<msg-id>` is the fsck message ID and the value2716 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2717 the error/warning with the message ID, e.g. "missingEmail: invalid2718 author/committer line - missing email" means that setting2719 `receive.fsck.missingEmail = ignore` will hide that issue.2720+2721This feature is intended to support working with legacy repositories2722which would not pass pushing when `receive.fsckObjects = true`, allowing2723the host to accept repositories with certain known issues but still catch2724other issues.27252726receive.fsck.skipList::2727 The path to a sorted list of object names (i.e. one SHA-1 per2728 line) that are known to be broken in a non-fatal way and should2729 be ignored. This feature is useful when an established project2730 should be accepted despite early commits containing errors that2731 can be safely ignored such as invalid committer email addresses.2732 Note: corrupt objects cannot be skipped with this setting.27332734receive.keepAlive::2735 After receiving the pack from the client, `receive-pack` may2736 produce no output (if `--quiet` was specified) while processing2737 the pack, causing some networks to drop the TCP connection.2738 With this option set, if `receive-pack` does not transmit2739 any data in this phase for `receive.keepAlive` seconds, it will2740 send a short keepalive packet. The default is 5 seconds; set2741 to 0 to disable keepalives entirely.27422743receive.unpackLimit::2744 If the number of objects received in a push is below this2745 limit then the objects will be unpacked into loose object2746 files. However if the number of received objects equals or2747 exceeds this limit then the received pack will be stored as2748 a pack, after adding any missing delta bases. Storing the2749 pack from a push can make the push operation complete faster,2750 especially on slow filesystems. If not set, the value of2751 `transfer.unpackLimit` is used instead.27522753receive.maxInputSize::2754 If the size of the incoming pack stream is larger than this2755 limit, then git-receive-pack will error out, instead of2756 accepting the pack file. If not set or set to 0, then the size2757 is unlimited.27582759receive.denyDeletes::2760 If set to true, git-receive-pack will deny a ref update that deletes2761 the ref. Use this to prevent such a ref deletion via a push.27622763receive.denyDeleteCurrent::2764 If set to true, git-receive-pack will deny a ref update that2765 deletes the currently checked out branch of a non-bare repository.27662767receive.denyCurrentBranch::2768 If set to true or "refuse", git-receive-pack will deny a ref update2769 to the currently checked out branch of a non-bare repository.2770 Such a push is potentially dangerous because it brings the HEAD2771 out of sync with the index and working tree. If set to "warn",2772 print a warning of such a push to stderr, but allow the push to2773 proceed. If set to false or "ignore", allow such pushes with no2774 message. Defaults to "refuse".2775+2776Another option is "updateInstead" which will update the working2777tree if pushing into the current branch. This option is2778intended for synchronizing working directories when one side is not easily2779accessible via interactive ssh (e.g. a live web site, hence the requirement2780that the working directory be clean). This mode also comes in handy when2781developing inside a VM to test and fix code on different Operating Systems.2782+2783By default, "updateInstead" will refuse the push if the working tree or2784the index have any difference from the HEAD, but the `push-to-checkout`2785hook can be used to customize this. See linkgit:githooks[5].27862787receive.denyNonFastForwards::2788 If set to true, git-receive-pack will deny a ref update which is2789 not a fast-forward. Use this to prevent such an update via a push,2790 even if that push is forced. This configuration variable is2791 set when initializing a shared repository.27922793receive.hideRefs::2794 This variable is the same as `transfer.hideRefs`, but applies2795 only to `receive-pack` (and so affects pushes, but not fetches).2796 An attempt to update or delete a hidden ref by `git push` is2797 rejected.27982799receive.updateServerInfo::2800 If set to true, git-receive-pack will run git-update-server-info2801 after receiving data from git-push and updating refs.28022803receive.shallowUpdate::2804 If set to true, .git/shallow can be updated when new refs2805 require new shallow roots. Otherwise those refs are rejected.28062807remote.pushDefault::2808 The remote to push to by default. Overrides2809 `branch.<name>.remote` for all branches, and is overridden by2810 `branch.<name>.pushRemote` for specific branches.28112812remote.<name>.url::2813 The URL of a remote repository. See linkgit:git-fetch[1] or2814 linkgit:git-push[1].28152816remote.<name>.pushurl::2817 The push URL of a remote repository. See linkgit:git-push[1].28182819remote.<name>.proxy::2820 For remotes that require curl (http, https and ftp), the URL to2821 the proxy to use for that remote. Set to the empty string to2822 disable proxying for that remote.28232824remote.<name>.proxyAuthMethod::2825 For remotes that require curl (http, https and ftp), the method to use for2826 authenticating against the proxy in use (probably set in2827 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28282829remote.<name>.fetch::2830 The default set of "refspec" for linkgit:git-fetch[1]. See2831 linkgit:git-fetch[1].28322833remote.<name>.push::2834 The default set of "refspec" for linkgit:git-push[1]. See2835 linkgit:git-push[1].28362837remote.<name>.mirror::2838 If true, pushing to this remote will automatically behave2839 as if the `--mirror` option was given on the command line.28402841remote.<name>.skipDefaultUpdate::2842 If true, this remote will be skipped by default when updating2843 using linkgit:git-fetch[1] or the `update` subcommand of2844 linkgit:git-remote[1].28452846remote.<name>.skipFetchAll::2847 If true, this remote will be skipped by default when updating2848 using linkgit:git-fetch[1] or the `update` subcommand of2849 linkgit:git-remote[1].28502851remote.<name>.receivepack::2852 The default program to execute on the remote side when pushing. See2853 option --receive-pack of linkgit:git-push[1].28542855remote.<name>.uploadpack::2856 The default program to execute on the remote side when fetching. See2857 option --upload-pack of linkgit:git-fetch-pack[1].28582859remote.<name>.tagOpt::2860 Setting this value to --no-tags disables automatic tag following when2861 fetching from remote <name>. Setting it to --tags will fetch every2862 tag from remote <name>, even if they are not reachable from remote2863 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2864 override this setting. See options --tags and --no-tags of2865 linkgit:git-fetch[1].28662867remote.<name>.vcs::2868 Setting this to a value <vcs> will cause Git to interact with2869 the remote with the git-remote-<vcs> helper.28702871remote.<name>.prune::2872 When set to true, fetching from this remote by default will also2873 remove any remote-tracking references that no longer exist on the2874 remote (as if the `--prune` option was given on the command line).2875 Overrides `fetch.prune` settings, if any.28762877remotes.<group>::2878 The list of remotes which are fetched by "git remote update2879 <group>". See linkgit:git-remote[1].28802881repack.useDeltaBaseOffset::2882 By default, linkgit:git-repack[1] creates packs that use2883 delta-base offset. If you need to share your repository with2884 Git older than version 1.4.4, either directly or via a dumb2885 protocol such as http, then you need to set this option to2886 "false" and repack. Access from old Git versions over the2887 native protocol are unaffected by this option.28882889repack.packKeptObjects::2890 If set to true, makes `git repack` act as if2891 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2892 details. Defaults to `false` normally, but `true` if a bitmap2893 index is being written (either via `--write-bitmap-index` or2894 `repack.writeBitmaps`).28952896repack.writeBitmaps::2897 When true, git will write a bitmap index when packing all2898 objects to disk (e.g., when `git repack -a` is run). This2899 index can speed up the "counting objects" phase of subsequent2900 packs created for clones and fetches, at the cost of some disk2901 space and extra time spent on the initial repack. This has2902 no effect if multiple packfiles are created.2903 Defaults to false.29042905rerere.autoUpdate::2906 When set to true, `git-rerere` updates the index with the2907 resulting contents after it cleanly resolves conflicts using2908 previously recorded resolution. Defaults to false.29092910rerere.enabled::2911 Activate recording of resolved conflicts, so that identical2912 conflict hunks can be resolved automatically, should they be2913 encountered again. By default, linkgit:git-rerere[1] is2914 enabled if there is an `rr-cache` directory under the2915 `$GIT_DIR`, e.g. if "rerere" was previously used in the2916 repository.29172918sendemail.identity::2919 A configuration identity. When given, causes values in the2920 'sendemail.<identity>' subsection to take precedence over2921 values in the 'sendemail' section. The default identity is2922 the value of `sendemail.identity`.29232924sendemail.smtpEncryption::2925 See linkgit:git-send-email[1] for description. Note that this2926 setting is not subject to the 'identity' mechanism.29272928sendemail.smtpssl (deprecated)::2929 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29302931sendemail.smtpsslcertpath::2932 Path to ca-certificates (either a directory or a single file).2933 Set it to an empty string to disable certificate verification.29342935sendemail.<identity>.*::2936 Identity-specific versions of the 'sendemail.*' parameters2937 found below, taking precedence over those when this2938 identity is selected, through either the command-line or2939 `sendemail.identity`.29402941sendemail.aliasesFile::2942sendemail.aliasFileType::2943sendemail.annotate::2944sendemail.bcc::2945sendemail.cc::2946sendemail.ccCmd::2947sendemail.chainReplyTo::2948sendemail.confirm::2949sendemail.envelopeSender::2950sendemail.from::2951sendemail.multiEdit::2952sendemail.signedoffbycc::2953sendemail.smtpPass::2954sendemail.suppresscc::2955sendemail.suppressFrom::2956sendemail.to::2957sendemail.smtpDomain::2958sendemail.smtpServer::2959sendemail.smtpServerPort::2960sendemail.smtpServerOption::2961sendemail.smtpUser::2962sendemail.thread::2963sendemail.transferEncoding::2964sendemail.validate::2965sendemail.xmailer::2966 See linkgit:git-send-email[1] for description.29672968sendemail.signedoffcc (deprecated)::2969 Deprecated alias for `sendemail.signedoffbycc`.29702971sendemail.smtpBatchSize::2972 Number of messages to be sent per connection, after that a relogin2973 will happen. If the value is 0 or undefined, send all messages in2974 one connection.2975 See also the `--batch-size` option of linkgit:git-send-email[1].29762977sendemail.smtpReloginDelay::2978 Seconds wait before reconnecting to smtp server.2979 See also the `--relogin-delay` option of linkgit:git-send-email[1].29802981showbranch.default::2982 The default set of branches for linkgit:git-show-branch[1].2983 See linkgit:git-show-branch[1].29842985splitIndex.maxPercentChange::2986 When the split index feature is used, this specifies the2987 percent of entries the split index can contain compared to the2988 total number of entries in both the split index and the shared2989 index before a new shared index is written.2990 The value should be between 0 and 100. If the value is 0 then2991 a new shared index is always written, if it is 100 a new2992 shared index is never written.2993 By default the value is 20, so a new shared index is written2994 if the number of entries in the split index would be greater2995 than 20 percent of the total number of entries.2996 See linkgit:git-update-index[1].29972998splitIndex.sharedIndexExpire::2999 When the split index feature is used, shared index files that3000 were not modified since the time this variable specifies will3001 be removed when a new shared index file is created. The value3002 "now" expires all entries immediately, and "never" suppresses3003 expiration altogether.3004 The default value is "2.weeks.ago".3005 Note that a shared index file is considered modified (for the3006 purpose of expiration) each time a new split-index file is3007 either created based on it or read from it.3008 See linkgit:git-update-index[1].30093010status.relativePaths::3011 By default, linkgit:git-status[1] shows paths relative to the3012 current directory. Setting this variable to `false` shows paths3013 relative to the repository root (this was the default for Git3014 prior to v1.5.4).30153016status.short::3017 Set to true to enable --short by default in linkgit:git-status[1].3018 The option --no-short takes precedence over this variable.30193020status.branch::3021 Set to true to enable --branch by default in linkgit:git-status[1].3022 The option --no-branch takes precedence over this variable.30233024status.displayCommentPrefix::3025 If set to true, linkgit:git-status[1] will insert a comment3026 prefix before each output line (starting with3027 `core.commentChar`, i.e. `#` by default). This was the3028 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3029 Defaults to false.30303031status.showStash::3032 If set to true, linkgit:git-status[1] will display the number of3033 entries currently stashed away.3034 Defaults to false.30353036status.showUntrackedFiles::3037 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3038 files which are not currently tracked by Git. Directories which3039 contain only untracked files, are shown with the directory name3040 only. Showing untracked files means that Git needs to lstat() all3041 the files in the whole repository, which might be slow on some3042 systems. So, this variable controls how the commands displays3043 the untracked files. Possible values are:3044+3045--3046* `no` - Show no untracked files.3047* `normal` - Show untracked files and directories.3048* `all` - Show also individual files in untracked directories.3049--3050+3051If this variable is not specified, it defaults to 'normal'.3052This variable can be overridden with the -u|--untracked-files option3053of linkgit:git-status[1] and linkgit:git-commit[1].30543055status.submoduleSummary::3056 Defaults to false.3057 If this is set to a non zero number or true (identical to -1 or an3058 unlimited number), the submodule summary will be enabled and a3059 summary of commits for modified submodules will be shown (see3060 --summary-limit option of linkgit:git-submodule[1]). Please note3061 that the summary output command will be suppressed for all3062 submodules when `diff.ignoreSubmodules` is set to 'all' or only3063 for those submodules where `submodule.<name>.ignore=all`. The only3064 exception to that rule is that status and commit will show staged3065 submodule changes. To3066 also view the summary for ignored submodules you can either use3067 the --ignore-submodules=dirty command-line option or the 'git3068 submodule summary' command, which shows a similar output but does3069 not honor these settings.30703071stash.showPatch::3072 If this is set to true, the `git stash show` command without an3073 option will show the stash entry in patch form. Defaults to false.3074 See description of 'show' command in linkgit:git-stash[1].30753076stash.showStat::3077 If this is set to true, the `git stash show` command without an3078 option will show diffstat of the stash entry. Defaults to true.3079 See description of 'show' command in linkgit:git-stash[1].30803081submodule.<name>.url::3082 The URL for a submodule. This variable is copied from the .gitmodules3083 file to the git config via 'git submodule init'. The user can change3084 the configured URL before obtaining the submodule via 'git submodule3085 update'. If neither submodule.<name>.active or submodule.active are3086 set, the presence of this variable is used as a fallback to indicate3087 whether the submodule is of interest to git commands.3088 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.30893090submodule.<name>.update::3091 The method by which a submodule is updated by 'git submodule update',3092 which is the only affected command, others such as3093 'git checkout --recurse-submodules' are unaffected. It exists for3094 historical reasons, when 'git submodule' was the only command to3095 interact with submodules; settings like `submodule.active`3096 and `pull.rebase` are more specific. It is populated by3097 `git submodule init` from the linkgit:gitmodules[5] file.3098 See description of 'update' command in linkgit:git-submodule[1].30993100submodule.<name>.branch::3101 The remote branch name for a submodule, used by `git submodule3102 update --remote`. Set this option to override the value found in3103 the `.gitmodules` file. See linkgit:git-submodule[1] and3104 linkgit:gitmodules[5] for details.31053106submodule.<name>.fetchRecurseSubmodules::3107 This option can be used to control recursive fetching of this3108 submodule. It can be overridden by using the --[no-]recurse-submodules3109 command-line option to "git fetch" and "git pull".3110 This setting will override that from in the linkgit:gitmodules[5]3111 file.31123113submodule.<name>.ignore::3114 Defines under what circumstances "git status" and the diff family show3115 a submodule as modified. When set to "all", it will never be considered3116 modified (but it will nonetheless show up in the output of status and3117 commit when it has been staged), "dirty" will ignore all changes3118 to the submodules work tree and3119 takes only differences between the HEAD of the submodule and the commit3120 recorded in the superproject into account. "untracked" will additionally3121 let submodules with modified tracked files in their work tree show up.3122 Using "none" (the default when this option is not set) also shows3123 submodules that have untracked files in their work tree as changed.3124 This setting overrides any setting made in .gitmodules for this submodule,3125 both settings can be overridden on the command line by using the3126 "--ignore-submodules" option. The 'git submodule' commands are not3127 affected by this setting.31283129submodule.<name>.active::3130 Boolean value indicating if the submodule is of interest to git3131 commands. This config option takes precedence over the3132 submodule.active config option.31333134submodule.active::3135 A repeated field which contains a pathspec used to match against a3136 submodule's path to determine if the submodule is of interest to git3137 commands.31383139submodule.recurse::3140 Specifies if commands recurse into submodules by default. This3141 applies to all commands that have a `--recurse-submodules` option.3142 Defaults to false.31433144submodule.fetchJobs::3145 Specifies how many submodules are fetched/cloned at the same time.3146 A positive integer allows up to that number of submodules fetched3147 in parallel. A value of 0 will give some reasonable default.3148 If unset, it defaults to 1.31493150submodule.alternateLocation::3151 Specifies how the submodules obtain alternates when submodules are3152 cloned. Possible values are `no`, `superproject`.3153 By default `no` is assumed, which doesn't add references. When the3154 value is set to `superproject` the submodule to be cloned computes3155 its alternates location relative to the superprojects alternate.31563157submodule.alternateErrorStrategy::3158 Specifies how to treat errors with the alternates for a submodule3159 as computed via `submodule.alternateLocation`. Possible values are3160 `ignore`, `info`, `die`. Default is `die`.31613162tag.forceSignAnnotated::3163 A boolean to specify whether annotated tags created should be GPG signed.3164 If `--annotate` is specified on the command line, it takes3165 precedence over this option.31663167tag.sort::3168 This variable controls the sort ordering of tags when displayed by3169 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3170 value of this variable will be used as the default.31713172tar.umask::3173 This variable can be used to restrict the permission bits of3174 tar archive entries. The default is 0002, which turns off the3175 world write bit. The special value "user" indicates that the3176 archiving user's umask will be used instead. See umask(2) and3177 linkgit:git-archive[1].31783179transfer.fsckObjects::3180 When `fetch.fsckObjects` or `receive.fsckObjects` are3181 not set, the value of this variable is used instead.3182 Defaults to false.31833184transfer.hideRefs::3185 String(s) `receive-pack` and `upload-pack` use to decide which3186 refs to omit from their initial advertisements. Use more than3187 one definition to specify multiple prefix strings. A ref that is3188 under the hierarchies listed in the value of this variable is3189 excluded, and is hidden when responding to `git push` or `git3190 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3191 program-specific versions of this config.3192+3193You may also include a `!` in front of the ref name to negate the entry,3194explicitly exposing it, even if an earlier entry marked it as hidden.3195If you have multiple hideRefs values, later entries override earlier ones3196(and entries in more-specific config files override less-specific ones).3197+3198If a namespace is in use, the namespace prefix is stripped from each3199reference before it is matched against `transfer.hiderefs` patterns.3200For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3201the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3202is omitted from the advertisements but `refs/heads/master` and3203`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3204"have" lines. In order to match refs before stripping, add a `^` in front of3205the ref name. If you combine `!` and `^`, `!` must be specified first.3206+3207Even if you hide refs, a client may still be able to steal the target3208objects via the techniques described in the "SECURITY" section of the3209linkgit:gitnamespaces[7] man page; it's best to keep private data in a3210separate repository.32113212transfer.unpackLimit::3213 When `fetch.unpackLimit` or `receive.unpackLimit` are3214 not set, the value of this variable is used instead.3215 The default value is 100.32163217uploadarchive.allowUnreachable::3218 If true, allow clients to use `git archive --remote` to request3219 any tree, whether reachable from the ref tips or not. See the3220 discussion in the "SECURITY" section of3221 linkgit:git-upload-archive[1] for more details. Defaults to3222 `false`.32233224uploadpack.hideRefs::3225 This variable is the same as `transfer.hideRefs`, but applies3226 only to `upload-pack` (and so affects only fetches, not pushes).3227 An attempt to fetch a hidden ref by `git fetch` will fail. See3228 also `uploadpack.allowTipSHA1InWant`.32293230uploadpack.allowTipSHA1InWant::3231 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3232 to accept a fetch request that asks for an object at the tip3233 of a hidden ref (by default, such a request is rejected).3234 See also `uploadpack.hideRefs`. Even if this is false, a client3235 may be able to steal objects via the techniques described in the3236 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3237 best to keep private data in a separate repository.32383239uploadpack.allowReachableSHA1InWant::3240 Allow `upload-pack` to accept a fetch request that asks for an3241 object that is reachable from any ref tip. However, note that3242 calculating object reachability is computationally expensive.3243 Defaults to `false`. Even if this is false, a client may be able3244 to steal objects via the techniques described in the "SECURITY"3245 section of the linkgit:gitnamespaces[7] man page; it's best to3246 keep private data in a separate repository.32473248uploadpack.allowAnySHA1InWant::3249 Allow `upload-pack` to accept a fetch request that asks for any3250 object at all.3251 Defaults to `false`.32523253uploadpack.keepAlive::3254 When `upload-pack` has started `pack-objects`, there may be a3255 quiet period while `pack-objects` prepares the pack. Normally3256 it would output progress information, but if `--quiet` was used3257 for the fetch, `pack-objects` will output nothing at all until3258 the pack data begins. Some clients and networks may consider3259 the server to be hung and give up. Setting this option instructs3260 `upload-pack` to send an empty keepalive packet every3261 `uploadpack.keepAlive` seconds. Setting this option to 03262 disables keepalive packets entirely. The default is 5 seconds.32633264uploadpack.packObjectsHook::3265 If this option is set, when `upload-pack` would run3266 `git pack-objects` to create a packfile for a client, it will3267 run this shell command instead. The `pack-objects` command and3268 arguments it _would_ have run (including the `git pack-objects`3269 at the beginning) are appended to the shell command. The stdin3270 and stdout of the hook are treated as if `pack-objects` itself3271 was run. I.e., `upload-pack` will feed input intended for3272 `pack-objects` to the hook, and expects a completed packfile on3273 stdout.3274+3275Note that this configuration variable is ignored if it is seen in the3276repository-level config (this is a safety measure against fetching from3277untrusted repositories).32783279url.<base>.insteadOf::3280 Any URL that starts with this value will be rewritten to3281 start, instead, with <base>. In cases where some site serves a3282 large number of repositories, and serves them with multiple3283 access methods, and some users need to use different access3284 methods, this feature allows people to specify any of the3285 equivalent URLs and have Git automatically rewrite the URL to3286 the best alternative for the particular user, even for a3287 never-before-seen repository on the site. When more than one3288 insteadOf strings match a given URL, the longest match is used.3289+3290Note that any protocol restrictions will be applied to the rewritten3291URL. If the rewrite changes the URL to use a custom protocol or remote3292helper, you may need to adjust the `protocol.*.allow` config to permit3293the request. In particular, protocols you expect to use for submodules3294must be set to `always` rather than the default of `user`. See the3295description of `protocol.allow` above.32963297url.<base>.pushInsteadOf::3298 Any URL that starts with this value will not be pushed to;3299 instead, it will be rewritten to start with <base>, and the3300 resulting URL will be pushed to. In cases where some site serves3301 a large number of repositories, and serves them with multiple3302 access methods, some of which do not allow push, this feature3303 allows people to specify a pull-only URL and have Git3304 automatically use an appropriate URL to push, even for a3305 never-before-seen repository on the site. When more than one3306 pushInsteadOf strings match a given URL, the longest match is3307 used. If a remote has an explicit pushurl, Git will ignore this3308 setting for that remote.33093310user.email::3311 Your email address to be recorded in any newly created commits.3312 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3313 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33143315user.name::3316 Your full name to be recorded in any newly created commits.3317 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3318 environment variables. See linkgit:git-commit-tree[1].33193320user.useConfigOnly::3321 Instruct Git to avoid trying to guess defaults for `user.email`3322 and `user.name`, and instead retrieve the values only from the3323 configuration. For example, if you have multiple email addresses3324 and would like to use a different one for each repository, then3325 with this configuration option set to `true` in the global config3326 along with a name, Git will prompt you to set up an email before3327 making new commits in a newly cloned repository.3328 Defaults to `false`.33293330user.signingKey::3331 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3332 key you want it to automatically when creating a signed tag or3333 commit, you can override the default selection with this variable.3334 This option is passed unchanged to gpg's --local-user parameter,3335 so you may specify a key using any method that gpg supports.33363337versionsort.prereleaseSuffix (deprecated)::3338 Deprecated alias for `versionsort.suffix`. Ignored if3339 `versionsort.suffix` is set.33403341versionsort.suffix::3342 Even when version sort is used in linkgit:git-tag[1], tagnames3343 with the same base version but different suffixes are still sorted3344 lexicographically, resulting e.g. in prerelease tags appearing3345 after the main release (e.g. "1.0-rc1" after "1.0"). This3346 variable can be specified to determine the sorting order of tags3347 with different suffixes.3348+3349By specifying a single suffix in this variable, any tagname containing3350that suffix will appear before the corresponding main release. E.g. if3351the variable is set to "-rc", then all "1.0-rcX" tags will appear before3352"1.0". If specified multiple times, once per suffix, then the order of3353suffixes in the configuration will determine the sorting order of tagnames3354with those suffixes. E.g. if "-pre" appears before "-rc" in the3355configuration, then all "1.0-preX" tags will be listed before any3356"1.0-rcX" tags. The placement of the main release tag relative to tags3357with various suffixes can be determined by specifying the empty suffix3358among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3359"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3360are listed first, followed by "v4.8", then "v4.8-ckX" and finally3361"v4.8-bfsX".3362+3363If more than one suffixes match the same tagname, then that tagname will3364be sorted according to the suffix which starts at the earliest position in3365the tagname. If more than one different matching suffixes start at3366that earliest position, then that tagname will be sorted according to the3367longest of those suffixes.3368The sorting order between different suffixes is undefined if they are3369in multiple config files.33703371web.browser::3372 Specify a web browser that may be used by some commands.3373 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3374 may use it.