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 82You can include one config file from another by setting the special 83`include.path` variable to the name of the file to be included. The 84included file is expanded immediately, as if its contents had been 85found at the location of the include directive. If the value of the 86`include.path` variable is a relative path, the path is considered to be 87relative to the configuration file in which the include directive was 88found. The value of `include.path` is subject to tilde expansion: `~/` 89is expanded to the value of `$HOME`, and `~user/` to the specified 90user's home directory. See below for examples. 91 92Example 93~~~~~~~ 94 95 # Core variables 96 [core] 97 ; Don't trust file modes 98 filemode = false 99 100 # Our diff algorithm 101 [diff] 102 external = /usr/local/bin/diff-wrapper 103 renames = true 104 105 [branch "devel"] 106 remote = origin 107 merge = refs/heads/devel 108 109 # Proxy settings 110 [core] 111 gitProxy="ssh" for "kernel.org" 112 gitProxy=default-proxy ; for the rest 113 114 [include] 115 path = /path/to/foo.inc ; include by absolute path 116 path = foo ; expand "foo" relative to the current file 117 path = ~/foo ; expand "foo" in your $HOME directory 118 119 120Values 121~~~~~~ 122 123Values of many variables are treated as a simple string, but there 124are variables that take values of specific types and there are rules 125as to how to spell them. 126 127boolean:: 128 129 When a variable is said to take a boolean value, many 130 synonyms are accepted for 'true' and 'false'; these are all 131 case-insensitive. 132 133 true;; Boolean true can be spelled as `yes`, `on`, `true`, 134 or `1`. Also, a variable defined without `= <value>` 135 is taken as true. 136 137 false;; Boolean false can be spelled as `no`, `off`, 138 `false`, or `0`. 139+ 140When converting value to the canonical form using '--bool' type 141specifier; 'git config' will ensure that the output is "true" or 142"false" (spelled in lowercase). 143 144integer:: 145 The value for many variables that specify various sizes can 146 be suffixed with `k`, `M`,... to mean "scale the number by 147 1024", "by 1024x1024", etc. 148 149color:: 150 The value for a variables that takes a color is a list of 151 colors (at most two) and attributes (at most one), separated 152 by spaces. The colors accepted are `normal`, `black`, 153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and 154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and 155 `reverse`. The first color given is the foreground; the 156 second is the background. The position of the attribute, if 157 any, doesn't matter. Attributes may be turned off specifically 158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc). 159+ 160Colors (foreground and background) may also be given as numbers between 1610 and 255; these use ANSI 256-color mode (but note that not all 162terminals may support this). If your terminal supports it, you may also 163specify 24-bit RGB values as hex, like `#ff0ab3`. 164+ 165The attributes are meant to be reset at the beginning of each item 166in the colored output, so setting color.decorate.branch to `black` 167will paint that branch name in a plain `black`, even if the previous 168thing on the same output line (e.g. opening parenthesis before the 169list of branch names in `log --decorate` output) is set to be 170painted with `bold` or some other attribute. 171 172 173Variables 174~~~~~~~~~ 175 176Note that this list is non-comprehensive and not necessarily complete. 177For command-specific variables, you will find a more detailed description 178in the appropriate manual page. 179 180Other git-related tools may and do use their own variables. When 181inventing new variables for use in your own tool, make sure their 182names do not conflict with those that are used by Git itself and 183other popular tools, and describe them in your documentation. 184 185 186advice.*:: 187 These variables control various optional help messages designed to 188 aid new users. All 'advice.*' variables default to 'true', and you 189 can tell Git that you do not need help by setting these to 'false': 190+ 191-- 192 pushUpdateRejected:: 193 Set this variable to 'false' if you want to disable 194 'pushNonFFCurrent', 195 'pushNonFFMatching', 'pushAlreadyExists', 196 'pushFetchFirst', and 'pushNeedsForce' 197 simultaneously. 198 pushNonFFCurrent:: 199 Advice shown when linkgit:git-push[1] fails due to a 200 non-fast-forward update to the current branch. 201 pushNonFFMatching:: 202 Advice shown when you ran linkgit:git-push[1] and pushed 203 'matching refs' explicitly (i.e. you used ':', or 204 specified a refspec that isn't your current branch) and 205 it resulted in a non-fast-forward error. 206 pushAlreadyExists:: 207 Shown when linkgit:git-push[1] rejects an update that 208 does not qualify for fast-forwarding (e.g., a tag.) 209 pushFetchFirst:: 210 Shown when linkgit:git-push[1] rejects an update that 211 tries to overwrite a remote ref that points at an 212 object we do not have. 213 pushNeedsForce:: 214 Shown when linkgit:git-push[1] rejects an update that 215 tries to overwrite a remote ref that points at an 216 object that is not a commit-ish, or make the remote 217 ref point at an object that is not a commit-ish. 218 statusHints:: 219 Show directions on how to proceed from the current 220 state in the output of linkgit:git-status[1], in 221 the template shown when writing commit messages in 222 linkgit:git-commit[1], and in the help message shown 223 by linkgit:git-checkout[1] when switching branch. 224 statusUoption:: 225 Advise to consider using the `-u` option to linkgit:git-status[1] 226 when the command takes more than 2 seconds to enumerate untracked 227 files. 228 commitBeforeMerge:: 229 Advice shown when linkgit:git-merge[1] refuses to 230 merge to avoid overwriting local changes. 231 resolveConflict:: 232 Advice shown by various commands when conflicts 233 prevent the operation from being performed. 234 implicitIdentity:: 235 Advice on how to set your identity configuration when 236 your information is guessed from the system username and 237 domain name. 238 detachedHead:: 239 Advice shown when you used linkgit:git-checkout[1] to 240 move to the detach HEAD state, to instruct how to create 241 a local branch after the fact. 242 amWorkDir:: 243 Advice that shows the location of the patch file when 244 linkgit:git-am[1] fails to apply it. 245 rmHints:: 246 In case of failure in the output of linkgit:git-rm[1], 247 show directions on how to proceed from the current state. 248-- 249 250core.fileMode:: 251 Tells Git if the executable bit of files in the working tree 252 is to be honored. 253+ 254Some filesystems lose the executable bit when a file that is 255marked as executable is checked out, or checks out an 256non-executable file with executable bit on. 257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 258to see if it handles the executable bit correctly 259and this variable is automatically set as necessary. 260+ 261A repository, however, may be on a filesystem that handles 262the filemode correctly, and this variable is set to 'true' 263when created, but later may be made accessible from another 264environment that loses the filemode (e.g. exporting ext4 via 265CIFS mount, visiting a Cygwin created repository with 266Git for Windows or Eclipse). 267In such a case it may be necessary to set this variable to 'false'. 268See linkgit:git-update-index[1]. 269+ 270The default is true (when core.filemode is not specified in the config file). 271 272core.ignoreCase:: 273 If true, this option enables various workarounds to enable 274 Git to work better on filesystems that are not case sensitive, 275 like FAT. For example, if a directory listing finds 276 "makefile" when Git expects "Makefile", Git will assume 277 it is really the same file, and continue to remember it as 278 "Makefile". 279+ 280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 281will probe and set core.ignoreCase true if appropriate when the repository 282is created. 283 284core.precomposeUnicode:: 285 This option is only used by Mac OS implementation of Git. 286 When core.precomposeUnicode=true, Git reverts the unicode decomposition 287 of filenames done by Mac OS. This is useful when sharing a repository 288 between Mac OS and Linux or Windows. 289 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 290 When false, file names are handled fully transparent by Git, 291 which is backward compatible with older versions of Git. 292 293core.protectHFS:: 294 If set to true, do not allow checkout of paths that would 295 be considered equivalent to `.git` on an HFS+ filesystem. 296 Defaults to `true` on Mac OS, and `false` elsewhere. 297 298core.protectNTFS:: 299 If set to true, do not allow checkout of paths that would 300 cause problems with the NTFS filesystem, e.g. conflict with 301 8.3 "short" names. 302 Defaults to `true` on Windows, and `false` elsewhere. 303 304core.trustctime:: 305 If false, the ctime differences between the index and the 306 working tree are ignored; useful when the inode change time 307 is regularly modified by something outside Git (file system 308 crawlers and some backup systems). 309 See linkgit:git-update-index[1]. True by default. 310 311core.untrackedCache:: 312 Determines what to do about the untracked cache feature of the 313 index. It will be kept, if this variable is unset or set to 314 `keep`. It will automatically be added if set to `true`. And 315 it will automatically be removed, if set to `false`. Before 316 setting it to `true`, you should check that mtime is working 317 properly on your system. 318 See linkgit:git-update-index[1]. `keep` by default. 319 320core.checkStat:: 321 Determines which stat fields to match between the index 322 and work tree. The user can set this to 'default' or 323 'minimal'. Default (or explicitly 'default'), is to check 324 all fields, including the sub-second part of mtime and ctime. 325 326core.quotePath:: 327 The commands that output paths (e.g. 'ls-files', 328 'diff'), when not given the `-z` option, will quote 329 "unusual" characters in the pathname by enclosing the 330 pathname in a double-quote pair and with backslashes the 331 same way strings in C source code are quoted. If this 332 variable is set to false, the bytes higher than 0x80 are 333 not quoted but output as verbatim. Note that double 334 quote, backslash and control characters are always 335 quoted without `-z` regardless of the setting of this 336 variable. 337 338core.eol:: 339 Sets the line ending type to use in the working directory for 340 files that have the `text` property set when core.autocrlf is false. 341 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 342 native line ending. The default value is `native`. See 343 linkgit:gitattributes[5] for more information on end-of-line 344 conversion. 345 346core.safecrlf:: 347 If true, makes Git check if converting `CRLF` is reversible when 348 end-of-line conversion is active. Git will verify if a command 349 modifies a file in the work tree either directly or indirectly. 350 For example, committing a file followed by checking out the 351 same file should yield the original file in the work tree. If 352 this is not the case for the current setting of 353 `core.autocrlf`, Git will reject the file. The variable can 354 be set to "warn", in which case Git will only warn about an 355 irreversible conversion but continue the operation. 356+ 357CRLF conversion bears a slight chance of corrupting data. 358When it is enabled, Git will convert CRLF to LF during commit and LF to 359CRLF during checkout. A file that contains a mixture of LF and 360CRLF before the commit cannot be recreated by Git. For text 361files this is the right thing to do: it corrects line endings 362such that we have only LF line endings in the repository. 363But for binary files that are accidentally classified as text the 364conversion can corrupt data. 365+ 366If you recognize such corruption early you can easily fix it by 367setting the conversion type explicitly in .gitattributes. Right 368after committing you still have the original file in your work 369tree and this file is not yet corrupted. You can explicitly tell 370Git that this file is binary and Git will handle the file 371appropriately. 372+ 373Unfortunately, the desired effect of cleaning up text files with 374mixed line endings and the undesired effect of corrupting binary 375files cannot be distinguished. In both cases CRLFs are removed 376in an irreversible way. For text files this is the right thing 377to do because CRLFs are line endings, while for binary files 378converting CRLFs corrupts data. 379+ 380Note, this safety check does not mean that a checkout will generate a 381file identical to the original file for a different setting of 382`core.eol` and `core.autocrlf`, but only for the current one. For 383example, a text file with `LF` would be accepted with `core.eol=lf` 384and could later be checked out with `core.eol=crlf`, in which case the 385resulting file would contain `CRLF`, although the original file 386contained `LF`. However, in both work trees the line endings would be 387consistent, that is either all `LF` or all `CRLF`, but never mixed. A 388file with mixed line endings would be reported by the `core.safecrlf` 389mechanism. 390 391core.autocrlf:: 392 Setting this variable to "true" is the same as setting 393 the `text` attribute to "auto" on all files and core.eol to "crlf". 394 Set to true if you want to have `CRLF` line endings in your 395 working directory and the repository has LF line endings. 396 This variable can be set to 'input', 397 in which case no output conversion is performed. 398 399core.symlinks:: 400 If false, symbolic links are checked out as small plain files that 401 contain the link text. linkgit:git-update-index[1] and 402 linkgit:git-add[1] will not change the recorded type to regular 403 file. Useful on filesystems like FAT that do not support 404 symbolic links. 405+ 406The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 407will probe and set core.symlinks false if appropriate when the repository 408is created. 409 410core.gitProxy:: 411 A "proxy command" to execute (as 'command host port') instead 412 of establishing direct connection to the remote server when 413 using the Git protocol for fetching. If the variable value is 414 in the "COMMAND for DOMAIN" format, the command is applied only 415 on hostnames ending with the specified domain string. This variable 416 may be set multiple times and is matched in the given order; 417 the first match wins. 418+ 419Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 420(which always applies universally, without the special "for" 421handling). 422+ 423The special string `none` can be used as the proxy command to 424specify that no proxy be used for a given domain pattern. 425This is useful for excluding servers inside a firewall from 426proxy use, while defaulting to a common proxy for external domains. 427 428core.ignoreStat:: 429 If true, Git will avoid using lstat() calls to detect if files have 430 changed by setting the "assume-unchanged" bit for those tracked files 431 which it has updated identically in both the index and working tree. 432+ 433When files are modified outside of Git, the user will need to stage 434the modified files explicitly (e.g. see 'Examples' section in 435linkgit:git-update-index[1]). 436Git will not normally detect changes to those files. 437+ 438This is useful on systems where lstat() calls are very slow, such as 439CIFS/Microsoft Windows. 440+ 441False by default. 442 443core.preferSymlinkRefs:: 444 Instead of the default "symref" format for HEAD 445 and other symbolic reference files, use symbolic links. 446 This is sometimes needed to work with old scripts that 447 expect HEAD to be a symbolic link. 448 449core.bare:: 450 If true this repository is assumed to be 'bare' and has no 451 working directory associated with it. If this is the case a 452 number of commands that require a working directory will be 453 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 454+ 455This setting is automatically guessed by linkgit:git-clone[1] or 456linkgit:git-init[1] when the repository was created. By default a 457repository that ends in "/.git" is assumed to be not bare (bare = 458false), while all other repositories are assumed to be bare (bare 459= true). 460 461core.worktree:: 462 Set the path to the root of the working tree. 463 If GIT_COMMON_DIR environment variable is set, core.worktree 464 is ignored and not used for determining the root of working tree. 465 This can be overridden by the GIT_WORK_TREE environment 466 variable and the '--work-tree' command-line option. 467 The value can be an absolute path or relative to the path to 468 the .git directory, which is either specified by --git-dir 469 or GIT_DIR, or automatically discovered. 470 If --git-dir or GIT_DIR is specified but none of 471 --work-tree, GIT_WORK_TREE and core.worktree is specified, 472 the current working directory is regarded as the top level 473 of your working tree. 474+ 475Note that this variable is honored even when set in a configuration 476file in a ".git" subdirectory of a directory and its value differs 477from the latter directory (e.g. "/path/to/.git/config" has 478core.worktree set to "/different/path"), which is most likely a 479misconfiguration. Running Git commands in the "/path/to" directory will 480still use "/different/path" as the root of the work tree and can cause 481confusion unless you know what you are doing (e.g. you are creating a 482read-only snapshot of the same index to a location different from the 483repository's usual working tree). 484 485core.logAllRefUpdates:: 486 Enable the reflog. Updates to a ref <ref> is logged to the file 487 "$GIT_DIR/logs/<ref>", by appending the new and old 488 SHA-1, the date/time and the reason of the update, but 489 only when the file exists. If this configuration 490 variable is set to true, missing "$GIT_DIR/logs/<ref>" 491 file is automatically created for branch heads (i.e. under 492 refs/heads/), remote refs (i.e. under refs/remotes/), 493 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 494+ 495This information can be used to determine what commit 496was the tip of a branch "2 days ago". 497+ 498This value is true by default in a repository that has 499a working directory associated with it, and false by 500default in a bare repository. 501 502core.repositoryFormatVersion:: 503 Internal variable identifying the repository format and layout 504 version. 505 506core.sharedRepository:: 507 When 'group' (or 'true'), the repository is made shareable between 508 several users in a group (making sure all the files and objects are 509 group-writable). When 'all' (or 'world' or 'everybody'), the 510 repository will be readable by all users, additionally to being 511 group-shareable. When 'umask' (or 'false'), Git will use permissions 512 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 513 files in the repository will have this mode value. '0xxx' will override 514 user's umask value (whereas the other options will only override 515 requested parts of the user's umask value). Examples: '0660' will make 516 the repo read/write-able for the owner and group, but inaccessible to 517 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 518 repository that is group-readable but not group-writable. 519 See linkgit:git-init[1]. False by default. 520 521core.warnAmbiguousRefs:: 522 If true, Git will warn you if the ref name you passed it is ambiguous 523 and might match multiple refs in the repository. True by default. 524 525core.compression:: 526 An integer -1..9, indicating a default compression level. 527 -1 is the zlib default. 0 means no compression, 528 and 1..9 are various speed/size tradeoffs, 9 being slowest. 529 If set, this provides a default to other compression variables, 530 such as 'core.looseCompression' and 'pack.compression'. 531 532core.looseCompression:: 533 An integer -1..9, indicating the compression level for objects that 534 are not in a pack file. -1 is the zlib default. 0 means no 535 compression, and 1..9 are various speed/size tradeoffs, 9 being 536 slowest. If not set, defaults to core.compression. If that is 537 not set, defaults to 1 (best speed). 538 539core.packedGitWindowSize:: 540 Number of bytes of a pack file to map into memory in a 541 single mapping operation. Larger window sizes may allow 542 your system to process a smaller number of large pack files 543 more quickly. Smaller window sizes will negatively affect 544 performance due to increased calls to the operating system's 545 memory manager, but may improve performance when accessing 546 a large number of large pack files. 547+ 548Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 549MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 550be reasonable for all users/operating systems. You probably do 551not need to adjust this value. 552+ 553Common unit suffixes of 'k', 'm', or 'g' are supported. 554 555core.packedGitLimit:: 556 Maximum number of bytes to map simultaneously into memory 557 from pack files. If Git needs to access more than this many 558 bytes at once to complete an operation it will unmap existing 559 regions to reclaim virtual address space within the process. 560+ 561Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 562This should be reasonable for all users/operating systems, except on 563the largest projects. You probably do not need to adjust this value. 564+ 565Common unit suffixes of 'k', 'm', or 'g' are supported. 566 567core.deltaBaseCacheLimit:: 568 Maximum number of bytes to reserve for caching base objects 569 that may be referenced by multiple deltified objects. By storing the 570 entire decompressed base objects in a cache Git is able 571 to avoid unpacking and decompressing frequently used base 572 objects multiple times. 573+ 574Default is 96 MiB on all platforms. This should be reasonable 575for all users/operating systems, except on the largest projects. 576You probably do not need to adjust this value. 577+ 578Common unit suffixes of 'k', 'm', or 'g' are supported. 579 580core.bigFileThreshold:: 581 Files larger than this size are stored deflated, without 582 attempting delta compression. Storing large files without 583 delta compression avoids excessive memory usage, at the 584 slight expense of increased disk usage. Additionally files 585 larger than this size are always treated as binary. 586+ 587Default is 512 MiB on all platforms. This should be reasonable 588for most projects as source code and other text files can still 589be delta compressed, but larger binary media files won't be. 590+ 591Common unit suffixes of 'k', 'm', or 'g' are supported. 592 593core.excludesFile:: 594 In addition to '.gitignore' (per-directory) and 595 '.git/info/exclude', Git looks into this file for patterns 596 of files which are not meant to be tracked. "`~/`" is expanded 597 to the value of `$HOME` and "`~user/`" to the specified user's 598 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 599 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 600 is used instead. See linkgit:gitignore[5]. 601 602core.askPass:: 603 Some commands (e.g. svn and http interfaces) that interactively 604 ask for a password can be told to use an external program given 605 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 606 environment variable. If not set, fall back to the value of the 607 'SSH_ASKPASS' environment variable or, failing that, a simple password 608 prompt. The external program shall be given a suitable prompt as 609 command-line argument and write the password on its STDOUT. 610 611core.attributesFile:: 612 In addition to '.gitattributes' (per-directory) and 613 '.git/info/attributes', Git looks into this file for attributes 614 (see linkgit:gitattributes[5]). Path expansions are made the same 615 way as for `core.excludesFile`. Its default value is 616 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 617 set or empty, $HOME/.config/git/attributes is used instead. 618 619core.editor:: 620 Commands such as `commit` and `tag` that lets you edit 621 messages by launching an editor uses the value of this 622 variable when it is set, and the environment variable 623 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 624 625core.commentChar:: 626 Commands such as `commit` and `tag` that lets you edit 627 messages consider a line that begins with this character 628 commented, and removes them after the editor returns 629 (default '#'). 630+ 631If set to "auto", `git-commit` would select a character that is not 632the beginning character of any line in existing commit messages. 633 634core.packedRefsTimeout:: 635 The length of time, in milliseconds, to retry when trying to 636 lock the `packed-refs` file. Value 0 means not to retry at 637 all; -1 means to try indefinitely. Default is 1000 (i.e., 638 retry for 1 second). 639 640sequence.editor:: 641 Text editor used by `git rebase -i` for editing the rebase instruction file. 642 The value is meant to be interpreted by the shell when it is used. 643 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 644 When not configured the default commit message editor is used instead. 645 646core.pager:: 647 Text viewer for use by Git commands (e.g., 'less'). The value 648 is meant to be interpreted by the shell. The order of preference 649 is the `$GIT_PAGER` environment variable, then `core.pager` 650 configuration, then `$PAGER`, and then the default chosen at 651 compile time (usually 'less'). 652+ 653When the `LESS` environment variable is unset, Git sets it to `FRX` 654(if `LESS` environment variable is set, Git does not change it at 655all). If you want to selectively override Git's default setting 656for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 657be passed to the shell by Git, which will translate the final 658command to `LESS=FRX less -S`. The environment does not set the 659`S` option but the command line does, instructing less to truncate 660long lines. Similarly, setting `core.pager` to `less -+F` will 661deactivate the `F` option specified by the environment from the 662command-line, deactivating the "quit if one screen" behavior of 663`less`. One can specifically activate some flags for particular 664commands: for example, setting `pager.blame` to `less -S` enables 665line truncation only for `git blame`. 666+ 667Likewise, when the `LV` environment variable is unset, Git sets it 668to `-c`. You can override this setting by exporting `LV` with 669another value or setting `core.pager` to `lv +c`. 670 671core.whitespace:: 672 A comma separated list of common whitespace problems to 673 notice. 'git diff' will use `color.diff.whitespace` to 674 highlight them, and 'git apply --whitespace=error' will 675 consider them as errors. You can prefix `-` to disable 676 any of them (e.g. `-trailing-space`): 677+ 678* `blank-at-eol` treats trailing whitespaces at the end of the line 679 as an error (enabled by default). 680* `space-before-tab` treats a space character that appears immediately 681 before a tab character in the initial indent part of the line as an 682 error (enabled by default). 683* `indent-with-non-tab` treats a line that is indented with space 684 characters instead of the equivalent tabs as an error (not enabled by 685 default). 686* `tab-in-indent` treats a tab character in the initial indent part of 687 the line as an error (not enabled by default). 688* `blank-at-eof` treats blank lines added at the end of file as an error 689 (enabled by default). 690* `trailing-space` is a short-hand to cover both `blank-at-eol` and 691 `blank-at-eof`. 692* `cr-at-eol` treats a carriage-return at the end of line as 693 part of the line terminator, i.e. with it, `trailing-space` 694 does not trigger if the character before such a carriage-return 695 is not a whitespace (not enabled by default). 696* `tabwidth=<n>` tells how many character positions a tab occupies; this 697 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 698 errors. The default tab width is 8. Allowed values are 1 to 63. 699 700core.fsyncObjectFiles:: 701 This boolean will enable 'fsync()' when writing object files. 702+ 703This is a total waste of time and effort on a filesystem that orders 704data writes properly, but can be useful for filesystems that do not use 705journalling (traditional UNIX filesystems) or that only journal metadata 706and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 707 708core.preloadIndex:: 709 Enable parallel index preload for operations like 'git diff' 710+ 711This can speed up operations like 'git diff' and 'git status' especially 712on filesystems like NFS that have weak caching semantics and thus 713relatively high IO latencies. When enabled, Git will do the 714index comparison to the filesystem data in parallel, allowing 715overlapping IO's. Defaults to true. 716 717core.createObject:: 718 You can set this to 'link', in which case a hardlink followed by 719 a delete of the source are used to make sure that object creation 720 will not overwrite existing objects. 721+ 722On some file system/operating system combinations, this is unreliable. 723Set this config setting to 'rename' there; However, This will remove the 724check that makes sure that existing object files will not get overwritten. 725 726core.notesRef:: 727 When showing commit messages, also show notes which are stored in 728 the given ref. The ref must be fully qualified. If the given 729 ref does not exist, it is not an error but means that no 730 notes should be printed. 731+ 732This setting defaults to "refs/notes/commits", and it can be overridden by 733the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 734 735core.sparseCheckout:: 736 Enable "sparse checkout" feature. See section "Sparse checkout" in 737 linkgit:git-read-tree[1] for more information. 738 739core.abbrev:: 740 Set the length object names are abbreviated to. If unspecified, 741 many commands abbreviate to 7 hexdigits, which may not be enough 742 for abbreviated object names to stay unique for sufficiently long 743 time. 744 745add.ignoreErrors:: 746add.ignore-errors (deprecated):: 747 Tells 'git add' to continue adding files when some files cannot be 748 added due to indexing errors. Equivalent to the '--ignore-errors' 749 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 750 as it does not follow the usual naming convention for configuration 751 variables. 752 753alias.*:: 754 Command aliases for the linkgit:git[1] command wrapper - e.g. 755 after defining "alias.last = cat-file commit HEAD", the invocation 756 "git last" is equivalent to "git cat-file commit HEAD". To avoid 757 confusion and troubles with script usage, aliases that 758 hide existing Git commands are ignored. Arguments are split by 759 spaces, the usual shell quoting and escaping is supported. 760 A quote pair or a backslash can be used to quote them. 761+ 762If the alias expansion is prefixed with an exclamation point, 763it will be treated as a shell command. For example, defining 764"alias.new = !gitk --all --not ORIG_HEAD", the invocation 765"git new" is equivalent to running the shell command 766"gitk --all --not ORIG_HEAD". Note that shell commands will be 767executed from the top-level directory of a repository, which may 768not necessarily be the current directory. 769'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 770from the original current directory. See linkgit:git-rev-parse[1]. 771 772am.keepcr:: 773 If true, git-am will call git-mailsplit for patches in mbox format 774 with parameter '--keep-cr'. In this case git-mailsplit will 775 not remove `\r` from lines ending with `\r\n`. Can be overridden 776 by giving '--no-keep-cr' from the command line. 777 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 778 779am.threeWay:: 780 By default, `git am` will fail if the patch does not apply cleanly. When 781 set to true, this setting tells `git am` to fall back on 3-way merge if 782 the patch records the identity of blobs it is supposed to apply to and 783 we have those blobs available locally (equivalent to giving the `--3way` 784 option from the command line). Defaults to `false`. 785 See linkgit:git-am[1]. 786 787apply.ignoreWhitespace:: 788 When set to 'change', tells 'git apply' to ignore changes in 789 whitespace, in the same way as the '--ignore-space-change' 790 option. 791 When set to one of: no, none, never, false tells 'git apply' to 792 respect all whitespace differences. 793 See linkgit:git-apply[1]. 794 795apply.whitespace:: 796 Tells 'git apply' how to handle whitespaces, in the same way 797 as the '--whitespace' option. See linkgit:git-apply[1]. 798 799branch.autoSetupMerge:: 800 Tells 'git branch' and 'git checkout' to set up new branches 801 so that linkgit:git-pull[1] will appropriately merge from the 802 starting point branch. Note that even if this option is not set, 803 this behavior can be chosen per-branch using the `--track` 804 and `--no-track` options. The valid settings are: `false` -- no 805 automatic setup is done; `true` -- automatic setup is done when the 806 starting point is a remote-tracking branch; `always` -- 807 automatic setup is done when the starting point is either a 808 local branch or remote-tracking 809 branch. This option defaults to true. 810 811branch.autoSetupRebase:: 812 When a new branch is created with 'git branch' or 'git checkout' 813 that tracks another branch, this variable tells Git to set 814 up pull to rebase instead of merge (see "branch.<name>.rebase"). 815 When `never`, rebase is never automatically set to true. 816 When `local`, rebase is set to true for tracked branches of 817 other local branches. 818 When `remote`, rebase is set to true for tracked branches of 819 remote-tracking branches. 820 When `always`, rebase will be set to true for all tracking 821 branches. 822 See "branch.autoSetupMerge" for details on how to set up a 823 branch to track another branch. 824 This option defaults to never. 825 826branch.<name>.remote:: 827 When on branch <name>, it tells 'git fetch' and 'git push' 828 which remote to fetch from/push to. The remote to push to 829 may be overridden with `remote.pushDefault` (for all branches). 830 The remote to push to, for the current branch, may be further 831 overridden by `branch.<name>.pushRemote`. If no remote is 832 configured, or if you are not on any branch, it defaults to 833 `origin` for fetching and `remote.pushDefault` for pushing. 834 Additionally, `.` (a period) is the current local repository 835 (a dot-repository), see `branch.<name>.merge`'s final note below. 836 837branch.<name>.pushRemote:: 838 When on branch <name>, it overrides `branch.<name>.remote` for 839 pushing. It also overrides `remote.pushDefault` for pushing 840 from branch <name>. When you pull from one place (e.g. your 841 upstream) and push to another place (e.g. your own publishing 842 repository), you would want to set `remote.pushDefault` to 843 specify the remote to push to for all branches, and use this 844 option to override it for a specific branch. 845 846branch.<name>.merge:: 847 Defines, together with branch.<name>.remote, the upstream branch 848 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 849 branch to merge and can also affect 'git push' (see push.default). 850 When in branch <name>, it tells 'git fetch' the default 851 refspec to be marked for merging in FETCH_HEAD. The value is 852 handled like the remote part of a refspec, and must match a 853 ref which is fetched from the remote given by 854 "branch.<name>.remote". 855 The merge information is used by 'git pull' (which at first calls 856 'git fetch') to lookup the default branch for merging. Without 857 this option, 'git pull' defaults to merge the first refspec fetched. 858 Specify multiple values to get an octopus merge. 859 If you wish to setup 'git pull' so that it merges into <name> from 860 another branch in the local repository, you can point 861 branch.<name>.merge to the desired branch, and use the relative path 862 setting `.` (a period) for branch.<name>.remote. 863 864branch.<name>.mergeOptions:: 865 Sets default options for merging into branch <name>. The syntax and 866 supported options are the same as those of linkgit:git-merge[1], but 867 option values containing whitespace characters are currently not 868 supported. 869 870branch.<name>.rebase:: 871 When true, rebase the branch <name> on top of the fetched branch, 872 instead of merging the default branch from the default remote when 873 "git pull" is run. See "pull.rebase" for doing this in a non 874 branch-specific manner. 875+ 876When preserve, also pass `--preserve-merges` along to 'git rebase' 877so that locally committed merge commits will not be flattened 878by running 'git pull'. 879+ 880When the value is `interactive`, the rebase is run in interactive mode. 881+ 882*NOTE*: this is a possibly dangerous operation; do *not* use 883it unless you understand the implications (see linkgit:git-rebase[1] 884for details). 885 886branch.<name>.description:: 887 Branch description, can be edited with 888 `git branch --edit-description`. Branch description is 889 automatically added in the format-patch cover letter or 890 request-pull summary. 891 892browser.<tool>.cmd:: 893 Specify the command to invoke the specified browser. The 894 specified command is evaluated in shell with the URLs passed 895 as arguments. (See linkgit:git-web{litdd}browse[1].) 896 897browser.<tool>.path:: 898 Override the path for the given tool that may be used to 899 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 900 working repository in gitweb (see linkgit:git-instaweb[1]). 901 902clean.requireForce:: 903 A boolean to make git-clean do nothing unless given -f, 904 -i or -n. Defaults to true. 905 906color.branch:: 907 A boolean to enable/disable color in the output of 908 linkgit:git-branch[1]. May be set to `always`, 909 `false` (or `never`) or `auto` (or `true`), in which case colors are used 910 only when the output is to a terminal. Defaults to false. 911 912color.branch.<slot>:: 913 Use customized color for branch coloration. `<slot>` is one of 914 `current` (the current branch), `local` (a local branch), 915 `remote` (a remote-tracking branch in refs/remotes/), 916 `upstream` (upstream tracking branch), `plain` (other 917 refs). 918 919color.diff:: 920 Whether to use ANSI escape sequences to add color to patches. 921 If this is set to `always`, linkgit:git-diff[1], 922 linkgit:git-log[1], and linkgit:git-show[1] will use color 923 for all patches. If it is set to `true` or `auto`, those 924 commands will only use color when output is to the terminal. 925 Defaults to false. 926+ 927This does not affect linkgit:git-format-patch[1] or the 928'git-diff-{asterisk}' plumbing commands. Can be overridden on the 929command line with the `--color[=<when>]` option. 930 931color.diff.<slot>:: 932 Use customized color for diff colorization. `<slot>` specifies 933 which part of the patch to use the specified color, and is one 934 of `context` (context text - `plain` is a historical synonym), 935 `meta` (metainformation), `frag` 936 (hunk header), 'func' (function in hunk header), `old` (removed lines), 937 `new` (added lines), `commit` (commit headers), or `whitespace` 938 (highlighting whitespace errors). 939 940color.decorate.<slot>:: 941 Use customized color for 'git log --decorate' output. `<slot>` is one 942 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 943 branches, remote-tracking branches, tags, stash and HEAD, respectively. 944 945color.grep:: 946 When set to `always`, always highlight matches. When `false` (or 947 `never`), never. When set to `true` or `auto`, use color only 948 when the output is written to the terminal. Defaults to `false`. 949 950color.grep.<slot>:: 951 Use customized color for grep colorization. `<slot>` specifies which 952 part of the line to use the specified color, and is one of 953+ 954-- 955`context`;; 956 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 957`filename`;; 958 filename prefix (when not using `-h`) 959`function`;; 960 function name lines (when using `-p`) 961`linenumber`;; 962 line number prefix (when using `-n`) 963`match`;; 964 matching text (same as setting `matchContext` and `matchSelected`) 965`matchContext`;; 966 matching text in context lines 967`matchSelected`;; 968 matching text in selected lines 969`selected`;; 970 non-matching text in selected lines 971`separator`;; 972 separators between fields on a line (`:`, `-`, and `=`) 973 and between hunks (`--`) 974-- 975 976color.interactive:: 977 When set to `always`, always use colors for interactive prompts 978 and displays (such as those used by "git-add --interactive" and 979 "git-clean --interactive"). When false (or `never`), never. 980 When set to `true` or `auto`, use colors only when the output is 981 to the terminal. Defaults to false. 982 983color.interactive.<slot>:: 984 Use customized color for 'git add --interactive' and 'git clean 985 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 986 or `error`, for four distinct types of normal output from 987 interactive commands. 988 989color.pager:: 990 A boolean to enable/disable colored output when the pager is in 991 use (default is true). 992 993color.showBranch:: 994 A boolean to enable/disable color in the output of 995 linkgit:git-show-branch[1]. May be set to `always`, 996 `false` (or `never`) or `auto` (or `true`), in which case colors are used 997 only when the output is to a terminal. Defaults to false. 998 999color.status::1000 A boolean to enable/disable color in the output of1001 linkgit:git-status[1]. May be set to `always`,1002 `false` (or `never`) or `auto` (or `true`), in which case colors are used1003 only when the output is to a terminal. Defaults to false.10041005color.status.<slot>::1006 Use customized color for status colorization. `<slot>` is1007 one of `header` (the header text of the status message),1008 `added` or `updated` (files which are added but not committed),1009 `changed` (files which are changed but not added in the index),1010 `untracked` (files which are not tracked by Git),1011 `branch` (the current branch),1012 `nobranch` (the color the 'no branch' warning is shown in, defaulting1013 to red), or1014 `unmerged` (files which have unmerged changes).10151016color.ui::1017 This variable determines the default value for variables such1018 as `color.diff` and `color.grep` that control the use of color1019 per command family. Its scope will expand as more commands learn1020 configuration to set a default for the `--color` option. Set it1021 to `false` or `never` if you prefer Git commands not to use1022 color unless enabled explicitly with some other configuration1023 or the `--color` option. Set it to `always` if you want all1024 output not intended for machine consumption to use color, to1025 `true` or `auto` (this is the default since Git 1.8.4) if you1026 want such output to use color when written to the terminal.10271028column.ui::1029 Specify whether supported commands should output in columns.1030 This variable consists of a list of tokens separated by spaces1031 or commas:1032+1033These options control when the feature should be enabled1034(defaults to 'never'):1035+1036--1037`always`;;1038 always show in columns1039`never`;;1040 never show in columns1041`auto`;;1042 show in columns if the output is to the terminal1043--1044+1045These options control layout (defaults to 'column'). Setting any1046of these implies 'always' if none of 'always', 'never', or 'auto' are1047specified.1048+1049--1050`column`;;1051 fill columns before rows1052`row`;;1053 fill rows before columns1054`plain`;;1055 show in one column1056--1057+1058Finally, these options can be combined with a layout option (defaults1059to 'nodense'):1060+1061--1062`dense`;;1063 make unequal size columns to utilize more space1064`nodense`;;1065 make equal size columns1066--10671068column.branch::1069 Specify whether to output branch listing in `git branch` in columns.1070 See `column.ui` for details.10711072column.clean::1073 Specify the layout when list items in `git clean -i`, which always1074 shows files and directories in columns. See `column.ui` for details.10751076column.status::1077 Specify whether to output untracked files in `git status` in columns.1078 See `column.ui` for details.10791080column.tag::1081 Specify whether to output tag listing in `git tag` in columns.1082 See `column.ui` for details.10831084commit.cleanup::1085 This setting overrides the default of the `--cleanup` option in1086 `git commit`. See linkgit:git-commit[1] for details. Changing the1087 default can be useful when you always want to keep lines that begin1088 with comment character `#` in your log message, in which case you1089 would do `git config commit.cleanup whitespace` (note that you will1090 have to remove the help lines that begin with `#` in the commit log1091 template yourself, if you do this).10921093commit.gpgSign::10941095 A boolean to specify whether all commits should be GPG signed.1096 Use of this option when doing operations such as rebase can1097 result in a large number of commits being signed. It may be1098 convenient to use an agent to avoid typing your GPG passphrase1099 several times.11001101commit.status::1102 A boolean to enable/disable inclusion of status information in the1103 commit message template when using an editor to prepare the commit1104 message. Defaults to true.11051106commit.template::1107 Specify a file to use as the template for new commit messages.1108 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1109 specified user's home directory.11101111credential.helper::1112 Specify an external helper to be called when a username or1113 password credential is needed; the helper may consult external1114 storage to avoid prompting the user for the credentials. See1115 linkgit:gitcredentials[7] for details.11161117credential.useHttpPath::1118 When acquiring credentials, consider the "path" component of an http1119 or https URL to be important. Defaults to false. See1120 linkgit:gitcredentials[7] for more information.11211122credential.username::1123 If no username is set for a network authentication, use this username1124 by default. See credential.<context>.* below, and1125 linkgit:gitcredentials[7].11261127credential.<url>.*::1128 Any of the credential.* options above can be applied selectively to1129 some credentials. For example "credential.https://example.com.username"1130 would set the default username only for https connections to1131 example.com. See linkgit:gitcredentials[7] for details on how URLs are1132 matched.11331134credentialCache.ignoreSIGHUP::1135 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11361137include::diff-config.txt[]11381139difftool.<tool>.path::1140 Override the path for the given tool. This is useful in case1141 your tool is not in the PATH.11421143difftool.<tool>.cmd::1144 Specify the command to invoke the specified diff tool.1145 The specified command is evaluated in shell with the following1146 variables available: 'LOCAL' is set to the name of the temporary1147 file containing the contents of the diff pre-image and 'REMOTE'1148 is set to the name of the temporary file containing the contents1149 of the diff post-image.11501151difftool.prompt::1152 Prompt before each invocation of the diff tool.11531154fetch.recurseSubmodules::1155 This option can be either set to a boolean value or to 'on-demand'.1156 Setting it to a boolean changes the behavior of fetch and pull to1157 unconditionally recurse into submodules when set to true or to not1158 recurse at all when set to false. When set to 'on-demand' (the default1159 value), fetch and pull will only recurse into a populated submodule1160 when its superproject retrieves a commit that updates the submodule's1161 reference.11621163fetch.fsckObjects::1164 If it is set to true, git-fetch-pack will check all fetched1165 objects. It will abort in the case of a malformed object or a1166 broken link. The result of an abort are only dangling objects.1167 Defaults to false. If not set, the value of `transfer.fsckObjects`1168 is used instead.11691170fetch.unpackLimit::1171 If the number of objects fetched over the Git native1172 transfer is below this1173 limit, then the objects will be unpacked into loose object1174 files. However if the number of received objects equals or1175 exceeds this limit then the received pack will be stored as1176 a pack, after adding any missing delta bases. Storing the1177 pack from a push can make the push operation complete faster,1178 especially on slow filesystems. If not set, the value of1179 `transfer.unpackLimit` is used instead.11801181fetch.prune::1182 If true, fetch will automatically behave as if the `--prune`1183 option was given on the command line. See also `remote.<name>.prune`.11841185format.attach::1186 Enable multipart/mixed attachments as the default for1187 'format-patch'. The value can also be a double quoted string1188 which will enable attachments as the default and set the1189 value as the boundary. See the --attach option in1190 linkgit:git-format-patch[1].11911192format.numbered::1193 A boolean which can enable or disable sequence numbers in patch1194 subjects. It defaults to "auto" which enables it only if there1195 is more than one patch. It can be enabled or disabled for all1196 messages by setting it to "true" or "false". See --numbered1197 option in linkgit:git-format-patch[1].11981199format.headers::1200 Additional email headers to include in a patch to be submitted1201 by mail. See linkgit:git-format-patch[1].12021203format.to::1204format.cc::1205 Additional recipients to include in a patch to be submitted1206 by mail. See the --to and --cc options in1207 linkgit:git-format-patch[1].12081209format.subjectPrefix::1210 The default for format-patch is to output files with the '[PATCH]'1211 subject prefix. Use this variable to change that prefix.12121213format.signature::1214 The default for format-patch is to output a signature containing1215 the Git version number. Use this variable to change that default.1216 Set this variable to the empty string ("") to suppress1217 signature generation.12181219format.signatureFile::1220 Works just like format.signature except the contents of the1221 file specified by this variable will be used as the signature.12221223format.suffix::1224 The default for format-patch is to output files with the suffix1225 `.patch`. Use this variable to change that suffix (make sure to1226 include the dot if you want it).12271228format.pretty::1229 The default pretty format for log/show/whatchanged command,1230 See linkgit:git-log[1], linkgit:git-show[1],1231 linkgit:git-whatchanged[1].12321233format.thread::1234 The default threading style for 'git format-patch'. Can be1235 a boolean value, or `shallow` or `deep`. `shallow` threading1236 makes every mail a reply to the head of the series,1237 where the head is chosen from the cover letter, the1238 `--in-reply-to`, and the first patch mail, in this order.1239 `deep` threading makes every mail a reply to the previous one.1240 A true boolean value is the same as `shallow`, and a false1241 value disables threading.12421243format.signOff::1244 A boolean value which lets you enable the `-s/--signoff` option of1245 format-patch by default. *Note:* Adding the Signed-off-by: line to a1246 patch should be a conscious act and means that you certify you have1247 the rights to submit this work under the same open source license.1248 Please see the 'SubmittingPatches' document for further discussion.12491250format.coverLetter::1251 A boolean that controls whether to generate a cover-letter when1252 format-patch is invoked, but in addition can be set to "auto", to1253 generate a cover-letter only when there's more than one patch.12541255format.outputDirectory::1256 Set a custom directory to store the resulting files instead of the1257 current working directory.12581259filter.<driver>.clean::1260 The command which is used to convert the content of a worktree1261 file to a blob upon checkin. See linkgit:gitattributes[5] for1262 details.12631264filter.<driver>.smudge::1265 The command which is used to convert the content of a blob1266 object to a worktree file upon checkout. See1267 linkgit:gitattributes[5] for details.12681269fsck.<msg-id>::1270 Allows overriding the message type (error, warn or ignore) of a1271 specific message ID such as `missingEmail`.1272+1273For convenience, fsck prefixes the error/warning with the message ID,1274e.g. "missingEmail: invalid author/committer line - missing email" means1275that setting `fsck.missingEmail = ignore` will hide that issue.1276+1277This feature is intended to support working with legacy repositories1278which cannot be repaired without disruptive changes.12791280fsck.skipList::1281 The path to a sorted list of object names (i.e. one SHA-1 per1282 line) that are known to be broken in a non-fatal way and should1283 be ignored. This feature is useful when an established project1284 should be accepted despite early commits containing errors that1285 can be safely ignored such as invalid committer email addresses.1286 Note: corrupt objects cannot be skipped with this setting.12871288gc.aggressiveDepth::1289 The depth parameter used in the delta compression1290 algorithm used by 'git gc --aggressive'. This defaults1291 to 250.12921293gc.aggressiveWindow::1294 The window size parameter used in the delta compression1295 algorithm used by 'git gc --aggressive'. This defaults1296 to 250.12971298gc.auto::1299 When there are approximately more than this many loose1300 objects in the repository, `git gc --auto` will pack them.1301 Some Porcelain commands use this command to perform a1302 light-weight garbage collection from time to time. The1303 default value is 6700. Setting this to 0 disables it.13041305gc.autoPackLimit::1306 When there are more than this many packs that are not1307 marked with `*.keep` file in the repository, `git gc1308 --auto` consolidates them into one larger pack. The1309 default value is 50. Setting this to 0 disables it.13101311gc.autoDetach::1312 Make `git gc --auto` return immediately and run in background1313 if the system supports it. Default is true.13141315gc.packRefs::1316 Running `git pack-refs` in a repository renders it1317 unclonable by Git versions prior to 1.5.1.2 over dumb1318 transports such as HTTP. This variable determines whether1319 'git gc' runs `git pack-refs`. This can be set to `notbare`1320 to enable it within all non-bare repos or it can be set to a1321 boolean value. The default is `true`.13221323gc.pruneExpire::1324 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1325 Override the grace period with this config variable. The value1326 "now" may be used to disable this grace period and always prune1327 unreachable objects immediately, or "never" may be used to1328 suppress pruning.13291330gc.worktreePruneExpire::1331 When 'git gc' is run, it calls1332 'git worktree prune --expire 3.months.ago'.1333 This config variable can be used to set a different grace1334 period. The value "now" may be used to disable the grace1335 period and prune $GIT_DIR/worktrees immediately, or "never"1336 may be used to suppress pruning.13371338gc.reflogExpire::1339gc.<pattern>.reflogExpire::1340 'git reflog expire' removes reflog entries older than1341 this time; defaults to 90 days. The value "now" expires all1342 entries immediately, and "never" suppresses expiration1343 altogether. With "<pattern>" (e.g.1344 "refs/stash") in the middle the setting applies only to1345 the refs that match the <pattern>.13461347gc.reflogExpireUnreachable::1348gc.<pattern>.reflogExpireUnreachable::1349 'git reflog expire' removes reflog entries older than1350 this time and are not reachable from the current tip;1351 defaults to 30 days. The value "now" expires all entries1352 immediately, and "never" suppresses expiration altogether.1353 With "<pattern>" (e.g. "refs/stash")1354 in the middle, the setting applies only to the refs that1355 match the <pattern>.13561357gc.rerereResolved::1358 Records of conflicted merge you resolved earlier are1359 kept for this many days when 'git rerere gc' is run.1360 The default is 60 days. See linkgit:git-rerere[1].13611362gc.rerereUnresolved::1363 Records of conflicted merge you have not resolved are1364 kept for this many days when 'git rerere gc' is run.1365 The default is 15 days. See linkgit:git-rerere[1].13661367gitcvs.commitMsgAnnotation::1368 Append this string to each commit message. Set to empty string1369 to disable this feature. Defaults to "via git-CVS emulator".13701371gitcvs.enabled::1372 Whether the CVS server interface is enabled for this repository.1373 See linkgit:git-cvsserver[1].13741375gitcvs.logFile::1376 Path to a log file where the CVS server interface well... logs1377 various stuff. See linkgit:git-cvsserver[1].13781379gitcvs.usecrlfattr::1380 If true, the server will look up the end-of-line conversion1381 attributes for files to determine the '-k' modes to use. If1382 the attributes force Git to treat a file as text,1383 the '-k' mode will be left blank so CVS clients will1384 treat it as text. If they suppress text conversion, the file1385 will be set with '-kb' mode, which suppresses any newline munging1386 the client might otherwise do. If the attributes do not allow1387 the file type to be determined, then 'gitcvs.allBinary' is1388 used. See linkgit:gitattributes[5].13891390gitcvs.allBinary::1391 This is used if 'gitcvs.usecrlfattr' does not resolve1392 the correct '-kb' mode to use. If true, all1393 unresolved files are sent to the client in1394 mode '-kb'. This causes the client to treat them1395 as binary files, which suppresses any newline munging it1396 otherwise might do. Alternatively, if it is set to "guess",1397 then the contents of the file are examined to decide if1398 it is binary, similar to 'core.autocrlf'.13991400gitcvs.dbName::1401 Database used by git-cvsserver to cache revision information1402 derived from the Git repository. The exact meaning depends on the1403 used database driver, for SQLite (which is the default driver) this1404 is a filename. Supports variable substitution (see1405 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1406 Default: '%Ggitcvs.%m.sqlite'14071408gitcvs.dbDriver::1409 Used Perl DBI driver. You can specify any available driver1410 for this here, but it might not work. git-cvsserver is tested1411 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1412 reported *not* to work with 'DBD::mysql'. Experimental feature.1413 May not contain double colons (`:`). Default: 'SQLite'.1414 See linkgit:git-cvsserver[1].14151416gitcvs.dbUser, gitcvs.dbPass::1417 Database user and password. Only useful if setting 'gitcvs.dbDriver',1418 since SQLite has no concept of database users and/or passwords.1419 'gitcvs.dbUser' supports variable substitution (see1420 linkgit:git-cvsserver[1] for details).14211422gitcvs.dbTableNamePrefix::1423 Database table name prefix. Prepended to the names of any1424 database tables used, allowing a single database to be used1425 for several repositories. Supports variable substitution (see1426 linkgit:git-cvsserver[1] for details). Any non-alphabetic1427 characters will be replaced with underscores.14281429All gitcvs variables except for 'gitcvs.usecrlfattr' and1430'gitcvs.allBinary' can also be specified as1431'gitcvs.<access_method>.<varname>' (where 'access_method'1432is one of "ext" and "pserver") to make them apply only for the given1433access method.14341435gitweb.category::1436gitweb.description::1437gitweb.owner::1438gitweb.url::1439 See linkgit:gitweb[1] for description.14401441gitweb.avatar::1442gitweb.blame::1443gitweb.grep::1444gitweb.highlight::1445gitweb.patches::1446gitweb.pickaxe::1447gitweb.remote_heads::1448gitweb.showSizes::1449gitweb.snapshot::1450 See linkgit:gitweb.conf[5] for description.14511452grep.lineNumber::1453 If set to true, enable '-n' option by default.14541455grep.patternType::1456 Set the default matching behavior. Using a value of 'basic', 'extended',1457 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1458 '--fixed-strings', or '--perl-regexp' option accordingly, while the1459 value 'default' will return to the default matching behavior.14601461grep.extendedRegexp::1462 If set to true, enable '--extended-regexp' option by default. This1463 option is ignored when the 'grep.patternType' option is set to a value1464 other than 'default'.14651466grep.threads::1467 Number of grep worker threads to use.1468 See `grep.threads` in linkgit:git-grep[1] for more information.14691470grep.fallbackToNoIndex::1471 If set to true, fall back to git grep --no-index if git grep1472 is executed outside of a git repository. Defaults to false.14731474gpg.program::1475 Use this custom program instead of "gpg" found on $PATH when1476 making or verifying a PGP signature. The program must support the1477 same command-line interface as GPG, namely, to verify a detached1478 signature, "gpg --verify $file - <$signature" is run, and the1479 program is expected to signal a good signature by exiting with1480 code 0, and to generate an ASCII-armored detached signature, the1481 standard input of "gpg -bsau $key" is fed with the contents to be1482 signed, and the program is expected to send the result to its1483 standard output.14841485gui.commitMsgWidth::1486 Defines how wide the commit message window is in the1487 linkgit:git-gui[1]. "75" is the default.14881489gui.diffContext::1490 Specifies how many context lines should be used in calls to diff1491 made by the linkgit:git-gui[1]. The default is "5".14921493gui.displayUntracked::1494 Determines if linkgit::git-gui[1] shows untracked files1495 in the file list. The default is "true".14961497gui.encoding::1498 Specifies the default encoding to use for displaying of1499 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1500 It can be overridden by setting the 'encoding' attribute1501 for relevant files (see linkgit:gitattributes[5]).1502 If this option is not set, the tools default to the1503 locale encoding.15041505gui.matchTrackingBranch::1506 Determines if new branches created with linkgit:git-gui[1] should1507 default to tracking remote branches with matching names or1508 not. Default: "false".15091510gui.newBranchTemplate::1511 Is used as suggested name when creating new branches using the1512 linkgit:git-gui[1].15131514gui.pruneDuringFetch::1515 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1516 performing a fetch. The default value is "false".15171518gui.trustmtime::1519 Determines if linkgit:git-gui[1] should trust the file modification1520 timestamp or not. By default the timestamps are not trusted.15211522gui.spellingDictionary::1523 Specifies the dictionary used for spell checking commit messages in1524 the linkgit:git-gui[1]. When set to "none" spell checking is turned1525 off.15261527gui.fastCopyBlame::1528 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1529 location detection. It makes blame significantly faster on huge1530 repositories at the expense of less thorough copy detection.15311532gui.copyBlameThreshold::1533 Specifies the threshold to use in 'git gui blame' original location1534 detection, measured in alphanumeric characters. See the1535 linkgit:git-blame[1] manual for more information on copy detection.15361537gui.blamehistoryctx::1538 Specifies the radius of history context in days to show in1539 linkgit:gitk[1] for the selected commit, when the `Show History1540 Context` menu item is invoked from 'git gui blame'. If this1541 variable is set to zero, the whole history is shown.15421543guitool.<name>.cmd::1544 Specifies the shell command line to execute when the corresponding item1545 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1546 mandatory for every tool. The command is executed from the root of1547 the working directory, and in the environment it receives the name of1548 the tool as 'GIT_GUITOOL', the name of the currently selected file as1549 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1550 the head is detached, 'CUR_BRANCH' is empty).15511552guitool.<name>.needsFile::1553 Run the tool only if a diff is selected in the GUI. It guarantees1554 that 'FILENAME' is not empty.15551556guitool.<name>.noConsole::1557 Run the command silently, without creating a window to display its1558 output.15591560guitool.<name>.noRescan::1561 Don't rescan the working directory for changes after the tool1562 finishes execution.15631564guitool.<name>.confirm::1565 Show a confirmation dialog before actually running the tool.15661567guitool.<name>.argPrompt::1568 Request a string argument from the user, and pass it to the tool1569 through the 'ARGS' environment variable. Since requesting an1570 argument implies confirmation, the 'confirm' option has no effect1571 if this is enabled. If the option is set to 'true', 'yes', or '1',1572 the dialog uses a built-in generic prompt; otherwise the exact1573 value of the variable is used.15741575guitool.<name>.revPrompt::1576 Request a single valid revision from the user, and set the1577 'REVISION' environment variable. In other aspects this option1578 is similar to 'argPrompt', and can be used together with it.15791580guitool.<name>.revUnmerged::1581 Show only unmerged branches in the 'revPrompt' subdialog.1582 This is useful for tools similar to merge or rebase, but not1583 for things like checkout or reset.15841585guitool.<name>.title::1586 Specifies the title to use for the prompt dialog. The default1587 is the tool name.15881589guitool.<name>.prompt::1590 Specifies the general prompt string to display at the top of1591 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1592 The default value includes the actual command.15931594help.browser::1595 Specify the browser that will be used to display help in the1596 'web' format. See linkgit:git-help[1].15971598help.format::1599 Override the default help format used by linkgit:git-help[1].1600 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1601 the default. 'web' and 'html' are the same.16021603help.autoCorrect::1604 Automatically correct and execute mistyped commands after1605 waiting for the given number of deciseconds (0.1 sec). If more1606 than one command can be deduced from the entered text, nothing1607 will be executed. If the value of this option is negative,1608 the corrected command will be executed immediately. If the1609 value is 0 - the command will be just shown but not executed.1610 This is the default.16111612help.htmlPath::1613 Specify the path where the HTML documentation resides. File system paths1614 and URLs are supported. HTML pages will be prefixed with this path when1615 help is displayed in the 'web' format. This defaults to the documentation1616 path of your Git installation.16171618http.proxy::1619 Override the HTTP proxy, normally configured using the 'http_proxy',1620 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1621 addition to the syntax understood by curl, it is possible to specify a1622 proxy string with a user name but no password, in which case git will1623 attempt to acquire one in the same way it does for other credentials. See1624 linkgit:gitcredentials[7] for more information. The syntax thus is1625 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1626 on a per-remote basis; see remote.<name>.proxy16271628http.proxyAuthMethod::1629 Set the method with which to authenticate against the HTTP proxy. This1630 only takes effect if the configured proxy string contains a user name part1631 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1632 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1633 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment1634 variable. Possible values are:1635+1636--1637* `anyauth` - Automatically pick a suitable authentication method. It is1638 assumed that the proxy answers an unauthenticated request with a 4071639 status code and one or more Proxy-authenticate headers with supported1640 authentication methods. This is the default.1641* `basic` - HTTP Basic authentication1642* `digest` - HTTP Digest authentication; this prevents the password from being1643 transmitted to the proxy in clear text1644* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1645 of `curl(1)`)1646* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1647--16481649http.emptyAuth::1650 Attempt authentication without seeking a username or password. This1651 can be used to attempt GSS-Negotiate authentication without specifying1652 a username in the URL, as libcurl normally requires a username for1653 authentication.16541655http.cookieFile::1656 File containing previously stored cookie lines which should be used1657 in the Git http session, if they match the server. The file format1658 of the file to read cookies from should be plain HTTP headers or1659 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1660 NOTE that the file specified with http.cookieFile is only used as1661 input unless http.saveCookies is set.16621663http.saveCookies::1664 If set, store cookies received during requests to the file specified by1665 http.cookieFile. Has no effect if http.cookieFile is unset.16661667http.sslVersion::1668 The SSL version to use when negotiating an SSL connection, if you1669 want to force the default. The available and default version1670 depend on whether libcurl was built against NSS or OpenSSL and the1671 particular configuration of the crypto library in use. Internally1672 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1673 documentation for more details on the format of this option and1674 for the ssl version supported. Actually the possible values of1675 this option are:16761677 - sslv21678 - sslv31679 - tlsv11680 - tlsv1.01681 - tlsv1.11682 - tlsv1.216831684+1685Can be overridden by the 'GIT_SSL_VERSION' environment variable.1686To force git to use libcurl's default ssl version and ignore any1687explicit http.sslversion option, set 'GIT_SSL_VERSION' to the1688empty string.16891690http.sslCipherList::1691 A list of SSL ciphers to use when negotiating an SSL connection.1692 The available ciphers depend on whether libcurl was built against1693 NSS or OpenSSL and the particular configuration of the crypto1694 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1695 option; see the libcurl documentation for more details on the format1696 of this list.1697+1698Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.1699To force git to use libcurl's default cipher list and ignore any1700explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the1701empty string.17021703http.sslVerify::1704 Whether to verify the SSL certificate when fetching or pushing1705 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1706 variable.17071708http.sslCert::1709 File containing the SSL certificate when fetching or pushing1710 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1711 variable.17121713http.sslKey::1714 File containing the SSL private key when fetching or pushing1715 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1716 variable.17171718http.sslCertPasswordProtected::1719 Enable Git's password prompt for the SSL certificate. Otherwise1720 OpenSSL will prompt the user, possibly many times, if the1721 certificate or private key is encrypted. Can be overridden by the1722 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.17231724http.sslCAInfo::1725 File containing the certificates to verify the peer with when1726 fetching or pushing over HTTPS. Can be overridden by the1727 'GIT_SSL_CAINFO' environment variable.17281729http.sslCAPath::1730 Path containing files with the CA certificates to verify the peer1731 with when fetching or pushing over HTTPS. Can be overridden1732 by the 'GIT_SSL_CAPATH' environment variable.17331734http.pinnedpubkey::1735 Public key of the https service. It may either be the filename of1736 a PEM or DER encoded public key file or a string starting with1737 'sha256//' followed by the base64 encoded sha256 hash of the1738 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1739 exit with an error if this option is set but not supported by1740 cURL.17411742http.sslTry::1743 Attempt to use AUTH SSL/TLS and encrypted data transfers1744 when connecting via regular FTP protocol. This might be needed1745 if the FTP server requires it for security reasons or you wish1746 to connect securely whenever remote FTP server supports it.1747 Default is false since it might trigger certificate verification1748 errors on misconfigured servers.17491750http.maxRequests::1751 How many HTTP requests to launch in parallel. Can be overridden1752 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.17531754http.minSessions::1755 The number of curl sessions (counted across slots) to be kept across1756 requests. They will not be ended with curl_easy_cleanup() until1757 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1758 value will be capped at 1. Defaults to 1.17591760http.postBuffer::1761 Maximum size in bytes of the buffer used by smart HTTP1762 transports when POSTing data to the remote system.1763 For requests larger than this buffer size, HTTP/1.1 and1764 Transfer-Encoding: chunked is used to avoid creating a1765 massive pack file locally. Default is 1 MiB, which is1766 sufficient for most requests.17671768http.lowSpeedLimit, http.lowSpeedTime::1769 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1770 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1771 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1772 'GIT_HTTP_LOW_SPEED_TIME' environment variables.17731774http.noEPSV::1775 A boolean which disables using of EPSV ftp command by curl.1776 This can helpful with some "poor" ftp servers which don't1777 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1778 environment variable. Default is false (curl will use EPSV).17791780http.userAgent::1781 The HTTP USER_AGENT string presented to an HTTP server. The default1782 value represents the version of the client Git such as git/1.7.1.1783 This option allows you to override this value to a more common value1784 such as Mozilla/4.0. This may be necessary, for instance, if1785 connecting through a firewall that restricts HTTP connections to a set1786 of common USER_AGENT strings (but not including those like git/1.7.1).1787 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.17881789http.<url>.*::1790 Any of the http.* options above can be applied selectively to some URLs.1791 For a config key to match a URL, each element of the config key is1792 compared to that of the URL, in the following order:1793+1794--1795. Scheme (e.g., `https` in `https://example.com/`). This field1796 must match exactly between the config key and the URL.17971798. Host/domain name (e.g., `example.com` in `https://example.com/`).1799 This field must match exactly between the config key and the URL.18001801. Port number (e.g., `8080` in `http://example.com:8080/`).1802 This field must match exactly between the config key and the URL.1803 Omitted port numbers are automatically converted to the correct1804 default for the scheme before matching.18051806. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1807 path field of the config key must match the path field of the URL1808 either exactly or as a prefix of slash-delimited path elements. This means1809 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1810 match on a slash (`/`) boundary. Longer matches take precedence (so a config1811 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1812 key with just path `foo/`).18131814. User name (e.g., `user` in `https://user@example.com/repo.git`). If1815 the config key has a user name it must match the user name in the1816 URL exactly. If the config key does not have a user name, that1817 config key will match a URL with any user name (including none),1818 but at a lower precedence than a config key with a user name.1819--1820+1821The list above is ordered by decreasing precedence; a URL that matches1822a config key's path is preferred to one that matches its user name. For example,1823if the URL is `https://user@example.com/foo/bar` a config key match of1824`https://example.com/foo` will be preferred over a config key match of1825`https://user@example.com`.1826+1827All URLs are normalized before attempting any matching (the password part,1828if embedded in the URL, is always ignored for matching purposes) so that1829equivalent URLs that are simply spelled differently will match properly.1830Environment variable settings always override any matches. The URLs that are1831matched against are those given directly to Git commands. This means any URLs1832visited as a result of a redirection do not participate in matching.18331834i18n.commitEncoding::1835 Character encoding the commit messages are stored in; Git itself1836 does not care per se, but this information is necessary e.g. when1837 importing commits from emails or in the gitk graphical history1838 browser (and possibly at other places in the future or in other1839 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.18401841i18n.logOutputEncoding::1842 Character encoding the commit messages are converted to when1843 running 'git log' and friends.18441845imap::1846 The configuration variables in the 'imap' section are described1847 in linkgit:git-imap-send[1].18481849index.version::1850 Specify the version with which new index files should be1851 initialized. This does not affect existing repositories.18521853init.templateDir::1854 Specify the directory from which templates will be copied.1855 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)18561857instaweb.browser::1858 Specify the program that will be used to browse your working1859 repository in gitweb. See linkgit:git-instaweb[1].18601861instaweb.httpd::1862 The HTTP daemon command-line to start gitweb on your working1863 repository. See linkgit:git-instaweb[1].18641865instaweb.local::1866 If true the web server started by linkgit:git-instaweb[1] will1867 be bound to the local IP (127.0.0.1).18681869instaweb.modulePath::1870 The default module path for linkgit:git-instaweb[1] to use1871 instead of /usr/lib/apache2/modules. Only used if httpd1872 is Apache.18731874instaweb.port::1875 The port number to bind the gitweb httpd to. See1876 linkgit:git-instaweb[1].18771878interactive.singleKey::1879 In interactive commands, allow the user to provide one-letter1880 input with a single key (i.e., without hitting enter).1881 Currently this is used by the `--patch` mode of1882 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1883 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1884 setting is silently ignored if portable keystroke input1885 is not available; requires the Perl module Term::ReadKey.18861887log.abbrevCommit::1888 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1889 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1890 override this option with `--no-abbrev-commit`.18911892log.date::1893 Set the default date-time mode for the 'log' command.1894 Setting a value for log.date is similar to using 'git log''s1895 `--date` option. See linkgit:git-log[1] for details.18961897log.decorate::1898 Print out the ref names of any commits that are shown by the log1899 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1900 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1901 specified, the full ref name (including prefix) will be printed.1902 This is the same as the log commands '--decorate' option.19031904log.follow::1905 If `true`, `git log` will act as if the `--follow` option was used when1906 a single <path> is given. This has the same limitations as `--follow`,1907 i.e. it cannot be used to follow multiple files and does not work well1908 on non-linear history.19091910log.showRoot::1911 If true, the initial commit will be shown as a big creation event.1912 This is equivalent to a diff against an empty tree.1913 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1914 normally hide the root commit will now show it. True by default.19151916log.mailmap::1917 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1918 linkgit:git-whatchanged[1] assume `--use-mailmap`.19191920mailinfo.scissors::1921 If true, makes linkgit:git-mailinfo[1] (and therefore1922 linkgit:git-am[1]) act by default as if the --scissors option1923 was provided on the command-line. When active, this features1924 removes everything from the message body before a scissors1925 line (i.e. consisting mainly of ">8", "8<" and "-").19261927mailmap.file::1928 The location of an augmenting mailmap file. The default1929 mailmap, located in the root of the repository, is loaded1930 first, then the mailmap file pointed to by this variable.1931 The location of the mailmap file may be in a repository1932 subdirectory, or somewhere outside of the repository itself.1933 See linkgit:git-shortlog[1] and linkgit:git-blame[1].19341935mailmap.blob::1936 Like `mailmap.file`, but consider the value as a reference to a1937 blob in the repository. If both `mailmap.file` and1938 `mailmap.blob` are given, both are parsed, with entries from1939 `mailmap.file` taking precedence. In a bare repository, this1940 defaults to `HEAD:.mailmap`. In a non-bare repository, it1941 defaults to empty.19421943man.viewer::1944 Specify the programs that may be used to display help in the1945 'man' format. See linkgit:git-help[1].19461947man.<tool>.cmd::1948 Specify the command to invoke the specified man viewer. The1949 specified command is evaluated in shell with the man page1950 passed as argument. (See linkgit:git-help[1].)19511952man.<tool>.path::1953 Override the path for the given tool that may be used to1954 display help in the 'man' format. See linkgit:git-help[1].19551956include::merge-config.txt[]19571958mergetool.<tool>.path::1959 Override the path for the given tool. This is useful in case1960 your tool is not in the PATH.19611962mergetool.<tool>.cmd::1963 Specify the command to invoke the specified merge tool. The1964 specified command is evaluated in shell with the following1965 variables available: 'BASE' is the name of a temporary file1966 containing the common base of the files to be merged, if available;1967 'LOCAL' is the name of a temporary file containing the contents of1968 the file on the current branch; 'REMOTE' is the name of a temporary1969 file containing the contents of the file from the branch being1970 merged; 'MERGED' contains the name of the file to which the merge1971 tool should write the results of a successful merge.19721973mergetool.<tool>.trustExitCode::1974 For a custom merge command, specify whether the exit code of1975 the merge command can be used to determine whether the merge was1976 successful. If this is not set to true then the merge target file1977 timestamp is checked and the merge assumed to have been successful1978 if the file has been updated, otherwise the user is prompted to1979 indicate the success of the merge.19801981mergetool.meld.hasOutput::1982 Older versions of `meld` do not support the `--output` option.1983 Git will attempt to detect whether `meld` supports `--output`1984 by inspecting the output of `meld --help`. Configuring1985 `mergetool.meld.hasOutput` will make Git skip these checks and1986 use the configured value instead. Setting `mergetool.meld.hasOutput`1987 to `true` tells Git to unconditionally use the `--output` option,1988 and `false` avoids using `--output`.19891990mergetool.keepBackup::1991 After performing a merge, the original file with conflict markers1992 can be saved as a file with a `.orig` extension. If this variable1993 is set to `false` then this file is not preserved. Defaults to1994 `true` (i.e. keep the backup files).19951996mergetool.keepTemporaries::1997 When invoking a custom merge tool, Git uses a set of temporary1998 files to pass to the tool. If the tool returns an error and this1999 variable is set to `true`, then these temporary files will be2000 preserved, otherwise they will be removed after the tool has2001 exited. Defaults to `false`.20022003mergetool.writeToTemp::2004 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2005 conflicting files in the worktree by default. Git will attempt2006 to use a temporary directory for these files when set `true`.2007 Defaults to `false`.20082009mergetool.prompt::2010 Prompt before each invocation of the merge resolution program.20112012notes.mergeStrategy::2013 Which merge strategy to choose by default when resolving notes2014 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2015 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2016 section of linkgit:git-notes[1] for more information on each strategy.20172018notes.<name>.mergeStrategy::2019 Which merge strategy to choose when doing a notes merge into2020 refs/notes/<name>. This overrides the more general2021 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2022 linkgit:git-notes[1] for more information on the available strategies.20232024notes.displayRef::2025 The (fully qualified) refname from which to show notes when2026 showing commit messages. The value of this variable can be set2027 to a glob, in which case notes from all matching refs will be2028 shown. You may also specify this configuration variable2029 several times. A warning will be issued for refs that do not2030 exist, but a glob that does not match any refs is silently2031 ignored.2032+2033This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2034environment variable, which must be a colon separated list of refs or2035globs.2036+2037The effective value of "core.notesRef" (possibly overridden by2038GIT_NOTES_REF) is also implicitly added to the list of refs to be2039displayed.20402041notes.rewrite.<command>::2042 When rewriting commits with <command> (currently `amend` or2043 `rebase`) and this variable is set to `true`, Git2044 automatically copies your notes from the original to the2045 rewritten commit. Defaults to `true`, but see2046 "notes.rewriteRef" below.20472048notes.rewriteMode::2049 When copying notes during a rewrite (see the2050 "notes.rewrite.<command>" option), determines what to do if2051 the target commit already has a note. Must be one of2052 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2053 Defaults to `concatenate`.2054+2055This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2056environment variable.20572058notes.rewriteRef::2059 When copying notes during a rewrite, specifies the (fully2060 qualified) ref whose notes should be copied. The ref may be a2061 glob, in which case notes in all matching refs will be copied.2062 You may also specify this configuration several times.2063+2064Does not have a default value; you must configure this variable to2065enable note rewriting. Set it to `refs/notes/commits` to enable2066rewriting for the default commit notes.2067+2068This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2069environment variable, which must be a colon separated list of refs or2070globs.20712072pack.window::2073 The size of the window used by linkgit:git-pack-objects[1] when no2074 window size is given on the command line. Defaults to 10.20752076pack.depth::2077 The maximum delta depth used by linkgit:git-pack-objects[1] when no2078 maximum depth is given on the command line. Defaults to 50.20792080pack.windowMemory::2081 The maximum size of memory that is consumed by each thread2082 in linkgit:git-pack-objects[1] for pack window memory when2083 no limit is given on the command line. The value can be2084 suffixed with "k", "m", or "g". When left unconfigured (or2085 set explicitly to 0), there will be no limit.20862087pack.compression::2088 An integer -1..9, indicating the compression level for objects2089 in a pack file. -1 is the zlib default. 0 means no2090 compression, and 1..9 are various speed/size tradeoffs, 9 being2091 slowest. If not set, defaults to core.compression. If that is2092 not set, defaults to -1, the zlib default, which is "a default2093 compromise between speed and compression (currently equivalent2094 to level 6)."2095+2096Note that changing the compression level will not automatically recompress2097all existing objects. You can force recompression by passing the -F option2098to linkgit:git-repack[1].20992100pack.deltaCacheSize::2101 The maximum memory in bytes used for caching deltas in2102 linkgit:git-pack-objects[1] before writing them out to a pack.2103 This cache is used to speed up the writing object phase by not2104 having to recompute the final delta result once the best match2105 for all objects is found. Repacking large repositories on machines2106 which are tight with memory might be badly impacted by this though,2107 especially if this cache pushes the system into swapping.2108 A value of 0 means no limit. The smallest size of 1 byte may be2109 used to virtually disable this cache. Defaults to 256 MiB.21102111pack.deltaCacheLimit::2112 The maximum size of a delta, that is cached in2113 linkgit:git-pack-objects[1]. This cache is used to speed up the2114 writing object phase by not having to recompute the final delta2115 result once the best match for all objects is found. Defaults to 1000.21162117pack.threads::2118 Specifies the number of threads to spawn when searching for best2119 delta matches. This requires that linkgit:git-pack-objects[1]2120 be compiled with pthreads otherwise this option is ignored with a2121 warning. This is meant to reduce packing time on multiprocessor2122 machines. The required amount of memory for the delta search window2123 is however multiplied by the number of threads.2124 Specifying 0 will cause Git to auto-detect the number of CPU's2125 and set the number of threads accordingly.21262127pack.indexVersion::2128 Specify the default pack index version. Valid values are 1 for2129 legacy pack index used by Git versions prior to 1.5.2, and 2 for2130 the new pack index with capabilities for packs larger than 4 GB2131 as well as proper protection against the repacking of corrupted2132 packs. Version 2 is the default. Note that version 2 is enforced2133 and this config option ignored whenever the corresponding pack is2134 larger than 2 GB.2135+2136If you have an old Git that does not understand the version 2 `*.idx` file,2137cloning or fetching over a non native protocol (e.g. "http")2138that will copy both `*.pack` file and corresponding `*.idx` file from the2139other side may give you a repository that cannot be accessed with your2140older version of Git. If the `*.pack` file is smaller than 2 GB, however,2141you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2142the `*.idx` file.21432144pack.packSizeLimit::2145 The maximum size of a pack. This setting only affects2146 packing to a file when repacking, i.e. the git:// protocol2147 is unaffected. It can be overridden by the `--max-pack-size`2148 option of linkgit:git-repack[1]. The minimum size allowed is2149 limited to 1 MiB. The default is unlimited.2150 Common unit suffixes of 'k', 'm', or 'g' are2151 supported.21522153pack.useBitmaps::2154 When true, git will use pack bitmaps (if available) when packing2155 to stdout (e.g., during the server side of a fetch). Defaults to2156 true. You should not generally need to turn this off unless2157 you are debugging pack bitmaps.21582159pack.writeBitmaps (deprecated)::2160 This is a deprecated synonym for `repack.writeBitmaps`.21612162pack.writeBitmapHashCache::2163 When true, git will include a "hash cache" section in the bitmap2164 index (if one is written). This cache can be used to feed git's2165 delta heuristics, potentially leading to better deltas between2166 bitmapped and non-bitmapped objects (e.g., when serving a fetch2167 between an older, bitmapped pack and objects that have been2168 pushed since the last gc). The downside is that it consumes 42169 bytes per object of disk space, and that JGit's bitmap2170 implementation does not understand it, causing it to complain if2171 Git and JGit are used on the same repository. Defaults to false.21722173pager.<cmd>::2174 If the value is boolean, turns on or off pagination of the2175 output of a particular Git subcommand when writing to a tty.2176 Otherwise, turns on pagination for the subcommand using the2177 pager specified by the value of `pager.<cmd>`. If `--paginate`2178 or `--no-pager` is specified on the command line, it takes2179 precedence over this option. To disable pagination for all2180 commands, set `core.pager` or `GIT_PAGER` to `cat`.21812182pretty.<name>::2183 Alias for a --pretty= format string, as specified in2184 linkgit:git-log[1]. Any aliases defined here can be used just2185 as the built-in pretty formats could. For example,2186 running `git config pretty.changelog "format:* %H %s"`2187 would cause the invocation `git log --pretty=changelog`2188 to be equivalent to running `git log "--pretty=format:* %H %s"`.2189 Note that an alias with the same name as a built-in format2190 will be silently ignored.21912192pull.ff::2193 By default, Git does not create an extra merge commit when merging2194 a commit that is a descendant of the current commit. Instead, the2195 tip of the current branch is fast-forwarded. When set to `false`,2196 this variable tells Git to create an extra merge commit in such2197 a case (equivalent to giving the `--no-ff` option from the command2198 line). When set to `only`, only such fast-forward merges are2199 allowed (equivalent to giving the `--ff-only` option from the2200 command line). This setting overrides `merge.ff` when pulling.22012202pull.rebase::2203 When true, rebase branches on top of the fetched branch, instead2204 of merging the default branch from the default remote when "git2205 pull" is run. See "branch.<name>.rebase" for setting this on a2206 per-branch basis.2207+2208When preserve, also pass `--preserve-merges` along to 'git rebase'2209so that locally committed merge commits will not be flattened2210by running 'git pull'.2211+2212When the value is `interactive`, the rebase is run in interactive mode.2213+2214*NOTE*: this is a possibly dangerous operation; do *not* use2215it unless you understand the implications (see linkgit:git-rebase[1]2216for details).22172218pull.octopus::2219 The default merge strategy to use when pulling multiple branches2220 at once.22212222pull.twohead::2223 The default merge strategy to use when pulling a single branch.22242225push.default::2226 Defines the action `git push` should take if no refspec is2227 explicitly given. Different values are well-suited for2228 specific workflows; for instance, in a purely central workflow2229 (i.e. the fetch source is equal to the push destination),2230 `upstream` is probably what you want. Possible values are:2231+2232--22332234* `nothing` - do not push anything (error out) unless a refspec is2235 explicitly given. This is primarily meant for people who want to2236 avoid mistakes by always being explicit.22372238* `current` - push the current branch to update a branch with the same2239 name on the receiving end. Works in both central and non-central2240 workflows.22412242* `upstream` - push the current branch back to the branch whose2243 changes are usually integrated into the current branch (which is2244 called `@{upstream}`). This mode only makes sense if you are2245 pushing to the same repository you would normally pull from2246 (i.e. central workflow).22472248* `simple` - in centralized workflow, work like `upstream` with an2249 added safety to refuse to push if the upstream branch's name is2250 different from the local one.2251+2252When pushing to a remote that is different from the remote you normally2253pull from, work as `current`. This is the safest option and is suited2254for beginners.2255+2256This mode has become the default in Git 2.0.22572258* `matching` - push all branches having the same name on both ends.2259 This makes the repository you are pushing to remember the set of2260 branches that will be pushed out (e.g. if you always push 'maint'2261 and 'master' there and no other branches, the repository you push2262 to will have these two branches, and your local 'maint' and2263 'master' will be pushed there).2264+2265To use this mode effectively, you have to make sure _all_ the2266branches you would push out are ready to be pushed out before2267running 'git push', as the whole point of this mode is to allow you2268to push all of the branches in one go. If you usually finish work2269on only one branch and push out the result, while other branches are2270unfinished, this mode is not for you. Also this mode is not2271suitable for pushing into a shared central repository, as other2272people may add new branches there, or update the tip of existing2273branches outside your control.2274+2275This used to be the default, but not since Git 2.0 (`simple` is the2276new default).22772278--22792280push.followTags::2281 If set to true enable '--follow-tags' option by default. You2282 may override this configuration at time of push by specifying2283 '--no-follow-tags'.22842285push.gpgSign::2286 May be set to a boolean value, or the string 'if-asked'. A true2287 value causes all pushes to be GPG signed, as if '--signed' is2288 passed to linkgit:git-push[1]. The string 'if-asked' causes2289 pushes to be signed if the server supports it, as if2290 '--signed=if-asked' is passed to 'git push'. A false value may2291 override a value from a lower-priority config file. An explicit2292 command-line flag always overrides this config option.22932294push.recurseSubmodules::2295 Make sure all submodule commits used by the revisions to be pushed2296 are available on a remote-tracking branch. If the value is 'check'2297 then Git will verify that all submodule commits that changed in the2298 revisions to be pushed are available on at least one remote of the2299 submodule. If any commits are missing, the push will be aborted and2300 exit with non-zero status. If the value is 'on-demand' then all2301 submodules that changed in the revisions to be pushed will be2302 pushed. If on-demand was not able to push all necessary revisions2303 it will also be aborted and exit with non-zero status. If the value2304 is 'no' then default behavior of ignoring submodules when pushing2305 is retained. You may override this configuration at time of push by2306 specifying '--recurse-submodules=check|on-demand|no'.23072308rebase.stat::2309 Whether to show a diffstat of what changed upstream since the last2310 rebase. False by default.23112312rebase.autoSquash::2313 If set to true enable '--autosquash' option by default.23142315rebase.autoStash::2316 When set to true, automatically create a temporary stash2317 before the operation begins, and apply it after the operation2318 ends. This means that you can run rebase on a dirty worktree.2319 However, use with care: the final stash application after a2320 successful rebase might result in non-trivial conflicts.2321 Defaults to false.23222323rebase.missingCommitsCheck::2324 If set to "warn", git rebase -i will print a warning if some2325 commits are removed (e.g. a line was deleted), however the2326 rebase will still proceed. If set to "error", it will print2327 the previous warning and stop the rebase, 'git rebase2328 --edit-todo' can then be used to correct the error. If set to2329 "ignore", no checking is done.2330 To drop a commit without warning or error, use the `drop`2331 command in the todo-list.2332 Defaults to "ignore".23332334rebase.instructionFormat2335 A format string, as specified in linkgit:git-log[1], to be used for2336 the instruction list during an interactive rebase. The format will automatically2337 have the long commit hash prepended to the format.23382339receive.advertiseAtomic::2340 By default, git-receive-pack will advertise the atomic push2341 capability to its clients. If you don't want to this capability2342 to be advertised, set this variable to false.23432344receive.autogc::2345 By default, git-receive-pack will run "git-gc --auto" after2346 receiving data from git-push and updating refs. You can stop2347 it by setting this variable to false.23482349receive.certNonceSeed::2350 By setting this variable to a string, `git receive-pack`2351 will accept a `git push --signed` and verifies it by using2352 a "nonce" protected by HMAC using this string as a secret2353 key.23542355receive.certNonceSlop::2356 When a `git push --signed` sent a push certificate with a2357 "nonce" that was issued by a receive-pack serving the same2358 repository within this many seconds, export the "nonce"2359 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2360 hooks (instead of what the receive-pack asked the sending2361 side to include). This may allow writing checks in2362 `pre-receive` and `post-receive` a bit easier. Instead of2363 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2364 that records by how many seconds the nonce is stale to2365 decide if they want to accept the certificate, they only2366 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.23672368receive.fsckObjects::2369 If it is set to true, git-receive-pack will check all received2370 objects. It will abort in the case of a malformed object or a2371 broken link. The result of an abort are only dangling objects.2372 Defaults to false. If not set, the value of `transfer.fsckObjects`2373 is used instead.23742375receive.fsck.<msg-id>::2376 When `receive.fsckObjects` is set to true, errors can be switched2377 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2378 setting where the `<msg-id>` is the fsck message ID and the value2379 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2380 the error/warning with the message ID, e.g. "missingEmail: invalid2381 author/committer line - missing email" means that setting2382 `receive.fsck.missingEmail = ignore` will hide that issue.2383+2384This feature is intended to support working with legacy repositories2385which would not pass pushing when `receive.fsckObjects = true`, allowing2386the host to accept repositories with certain known issues but still catch2387other issues.23882389receive.fsck.skipList::2390 The path to a sorted list of object names (i.e. one SHA-1 per2391 line) that are known to be broken in a non-fatal way and should2392 be ignored. This feature is useful when an established project2393 should be accepted despite early commits containing errors that2394 can be safely ignored such as invalid committer email addresses.2395 Note: corrupt objects cannot be skipped with this setting.23962397receive.unpackLimit::2398 If the number of objects received in a push is below this2399 limit then the objects will be unpacked into loose object2400 files. However if the number of received objects equals or2401 exceeds this limit then the received pack will be stored as2402 a pack, after adding any missing delta bases. Storing the2403 pack from a push can make the push operation complete faster,2404 especially on slow filesystems. If not set, the value of2405 `transfer.unpackLimit` is used instead.24062407receive.denyDeletes::2408 If set to true, git-receive-pack will deny a ref update that deletes2409 the ref. Use this to prevent such a ref deletion via a push.24102411receive.denyDeleteCurrent::2412 If set to true, git-receive-pack will deny a ref update that2413 deletes the currently checked out branch of a non-bare repository.24142415receive.denyCurrentBranch::2416 If set to true or "refuse", git-receive-pack will deny a ref update2417 to the currently checked out branch of a non-bare repository.2418 Such a push is potentially dangerous because it brings the HEAD2419 out of sync with the index and working tree. If set to "warn",2420 print a warning of such a push to stderr, but allow the push to2421 proceed. If set to false or "ignore", allow such pushes with no2422 message. Defaults to "refuse".2423+2424Another option is "updateInstead" which will update the working2425tree if pushing into the current branch. This option is2426intended for synchronizing working directories when one side is not easily2427accessible via interactive ssh (e.g. a live web site, hence the requirement2428that the working directory be clean). This mode also comes in handy when2429developing inside a VM to test and fix code on different Operating Systems.2430+2431By default, "updateInstead" will refuse the push if the working tree or2432the index have any difference from the HEAD, but the `push-to-checkout`2433hook can be used to customize this. See linkgit:githooks[5].24342435receive.denyNonFastForwards::2436 If set to true, git-receive-pack will deny a ref update which is2437 not a fast-forward. Use this to prevent such an update via a push,2438 even if that push is forced. This configuration variable is2439 set when initializing a shared repository.24402441receive.hideRefs::2442 This variable is the same as `transfer.hideRefs`, but applies2443 only to `receive-pack` (and so affects pushes, but not fetches).2444 An attempt to update or delete a hidden ref by `git push` is2445 rejected.24462447receive.updateServerInfo::2448 If set to true, git-receive-pack will run git-update-server-info2449 after receiving data from git-push and updating refs.24502451receive.shallowUpdate::2452 If set to true, .git/shallow can be updated when new refs2453 require new shallow roots. Otherwise those refs are rejected.24542455remote.pushDefault::2456 The remote to push to by default. Overrides2457 `branch.<name>.remote` for all branches, and is overridden by2458 `branch.<name>.pushRemote` for specific branches.24592460remote.<name>.url::2461 The URL of a remote repository. See linkgit:git-fetch[1] or2462 linkgit:git-push[1].24632464remote.<name>.pushurl::2465 The push URL of a remote repository. See linkgit:git-push[1].24662467remote.<name>.proxy::2468 For remotes that require curl (http, https and ftp), the URL to2469 the proxy to use for that remote. Set to the empty string to2470 disable proxying for that remote.24712472remote.<name>.proxyAuthMethod::2473 For remotes that require curl (http, https and ftp), the method to use for2474 authenticating against the proxy in use (probably set in2475 `remote.<name>.proxy`). See `http.proxyAuthMethod`.24762477remote.<name>.fetch::2478 The default set of "refspec" for linkgit:git-fetch[1]. See2479 linkgit:git-fetch[1].24802481remote.<name>.push::2482 The default set of "refspec" for linkgit:git-push[1]. See2483 linkgit:git-push[1].24842485remote.<name>.mirror::2486 If true, pushing to this remote will automatically behave2487 as if the `--mirror` option was given on the command line.24882489remote.<name>.skipDefaultUpdate::2490 If true, this remote will be skipped by default when updating2491 using linkgit:git-fetch[1] or the `update` subcommand of2492 linkgit:git-remote[1].24932494remote.<name>.skipFetchAll::2495 If true, this remote will be skipped by default when updating2496 using linkgit:git-fetch[1] or the `update` subcommand of2497 linkgit:git-remote[1].24982499remote.<name>.receivepack::2500 The default program to execute on the remote side when pushing. See2501 option --receive-pack of linkgit:git-push[1].25022503remote.<name>.uploadpack::2504 The default program to execute on the remote side when fetching. See2505 option --upload-pack of linkgit:git-fetch-pack[1].25062507remote.<name>.tagOpt::2508 Setting this value to --no-tags disables automatic tag following when2509 fetching from remote <name>. Setting it to --tags will fetch every2510 tag from remote <name>, even if they are not reachable from remote2511 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2512 override this setting. See options --tags and --no-tags of2513 linkgit:git-fetch[1].25142515remote.<name>.vcs::2516 Setting this to a value <vcs> will cause Git to interact with2517 the remote with the git-remote-<vcs> helper.25182519remote.<name>.prune::2520 When set to true, fetching from this remote by default will also2521 remove any remote-tracking references that no longer exist on the2522 remote (as if the `--prune` option was given on the command line).2523 Overrides `fetch.prune` settings, if any.25242525remotes.<group>::2526 The list of remotes which are fetched by "git remote update2527 <group>". See linkgit:git-remote[1].25282529repack.useDeltaBaseOffset::2530 By default, linkgit:git-repack[1] creates packs that use2531 delta-base offset. If you need to share your repository with2532 Git older than version 1.4.4, either directly or via a dumb2533 protocol such as http, then you need to set this option to2534 "false" and repack. Access from old Git versions over the2535 native protocol are unaffected by this option.25362537repack.packKeptObjects::2538 If set to true, makes `git repack` act as if2539 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2540 details. Defaults to `false` normally, but `true` if a bitmap2541 index is being written (either via `--write-bitmap-index` or2542 `repack.writeBitmaps`).25432544repack.writeBitmaps::2545 When true, git will write a bitmap index when packing all2546 objects to disk (e.g., when `git repack -a` is run). This2547 index can speed up the "counting objects" phase of subsequent2548 packs created for clones and fetches, at the cost of some disk2549 space and extra time spent on the initial repack. Defaults to2550 false.25512552rerere.autoUpdate::2553 When set to true, `git-rerere` updates the index with the2554 resulting contents after it cleanly resolves conflicts using2555 previously recorded resolution. Defaults to false.25562557rerere.enabled::2558 Activate recording of resolved conflicts, so that identical2559 conflict hunks can be resolved automatically, should they be2560 encountered again. By default, linkgit:git-rerere[1] is2561 enabled if there is an `rr-cache` directory under the2562 `$GIT_DIR`, e.g. if "rerere" was previously used in the2563 repository.25642565sendemail.identity::2566 A configuration identity. When given, causes values in the2567 'sendemail.<identity>' subsection to take precedence over2568 values in the 'sendemail' section. The default identity is2569 the value of 'sendemail.identity'.25702571sendemail.smtpEncryption::2572 See linkgit:git-send-email[1] for description. Note that this2573 setting is not subject to the 'identity' mechanism.25742575sendemail.smtpssl (deprecated)::2576 Deprecated alias for 'sendemail.smtpEncryption = ssl'.25772578sendemail.smtpsslcertpath::2579 Path to ca-certificates (either a directory or a single file).2580 Set it to an empty string to disable certificate verification.25812582sendemail.<identity>.*::2583 Identity-specific versions of the 'sendemail.*' parameters2584 found below, taking precedence over those when the this2585 identity is selected, through command-line or2586 'sendemail.identity'.25872588sendemail.aliasesFile::2589sendemail.aliasFileType::2590sendemail.annotate::2591sendemail.bcc::2592sendemail.cc::2593sendemail.ccCmd::2594sendemail.chainReplyTo::2595sendemail.confirm::2596sendemail.envelopeSender::2597sendemail.from::2598sendemail.multiEdit::2599sendemail.signedoffbycc::2600sendemail.smtpPass::2601sendemail.suppresscc::2602sendemail.suppressFrom::2603sendemail.to::2604sendemail.smtpDomain::2605sendemail.smtpServer::2606sendemail.smtpServerPort::2607sendemail.smtpServerOption::2608sendemail.smtpUser::2609sendemail.thread::2610sendemail.transferEncoding::2611sendemail.validate::2612sendemail.xmailer::2613 See linkgit:git-send-email[1] for description.26142615sendemail.signedoffcc (deprecated)::2616 Deprecated alias for 'sendemail.signedoffbycc'.26172618showbranch.default::2619 The default set of branches for linkgit:git-show-branch[1].2620 See linkgit:git-show-branch[1].26212622status.relativePaths::2623 By default, linkgit:git-status[1] shows paths relative to the2624 current directory. Setting this variable to `false` shows paths2625 relative to the repository root (this was the default for Git2626 prior to v1.5.4).26272628status.short::2629 Set to true to enable --short by default in linkgit:git-status[1].2630 The option --no-short takes precedence over this variable.26312632status.branch::2633 Set to true to enable --branch by default in linkgit:git-status[1].2634 The option --no-branch takes precedence over this variable.26352636status.displayCommentPrefix::2637 If set to true, linkgit:git-status[1] will insert a comment2638 prefix before each output line (starting with2639 `core.commentChar`, i.e. `#` by default). This was the2640 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2641 Defaults to false.26422643status.showUntrackedFiles::2644 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2645 files which are not currently tracked by Git. Directories which2646 contain only untracked files, are shown with the directory name2647 only. Showing untracked files means that Git needs to lstat() all2648 the files in the whole repository, which might be slow on some2649 systems. So, this variable controls how the commands displays2650 the untracked files. Possible values are:2651+2652--2653* `no` - Show no untracked files.2654* `normal` - Show untracked files and directories.2655* `all` - Show also individual files in untracked directories.2656--2657+2658If this variable is not specified, it defaults to 'normal'.2659This variable can be overridden with the -u|--untracked-files option2660of linkgit:git-status[1] and linkgit:git-commit[1].26612662status.submoduleSummary::2663 Defaults to false.2664 If this is set to a non zero number or true (identical to -1 or an2665 unlimited number), the submodule summary will be enabled and a2666 summary of commits for modified submodules will be shown (see2667 --summary-limit option of linkgit:git-submodule[1]). Please note2668 that the summary output command will be suppressed for all2669 submodules when `diff.ignoreSubmodules` is set to 'all' or only2670 for those submodules where `submodule.<name>.ignore=all`. The only2671 exception to that rule is that status and commit will show staged2672 submodule changes. To2673 also view the summary for ignored submodules you can either use2674 the --ignore-submodules=dirty command-line option or the 'git2675 submodule summary' command, which shows a similar output but does2676 not honor these settings.26772678stash.showPatch::2679 If this is set to true, the `git stash show` command without an2680 option will show the stash in patch form. Defaults to false.2681 See description of 'show' command in linkgit:git-stash[1].26822683stash.showStat::2684 If this is set to true, the `git stash show` command without an2685 option will show diffstat of the stash. Defaults to true.2686 See description of 'show' command in linkgit:git-stash[1].26872688submodule.<name>.path::2689submodule.<name>.url::2690 The path within this project and URL for a submodule. These2691 variables are initially populated by 'git submodule init'. See2692 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2693 details.26942695submodule.<name>.update::2696 The default update procedure for a submodule. This variable2697 is populated by `git submodule init` from the2698 linkgit:gitmodules[5] file. See description of 'update'2699 command in linkgit:git-submodule[1].27002701submodule.<name>.branch::2702 The remote branch name for a submodule, used by `git submodule2703 update --remote`. Set this option to override the value found in2704 the `.gitmodules` file. See linkgit:git-submodule[1] and2705 linkgit:gitmodules[5] for details.27062707submodule.<name>.fetchRecurseSubmodules::2708 This option can be used to control recursive fetching of this2709 submodule. It can be overridden by using the --[no-]recurse-submodules2710 command-line option to "git fetch" and "git pull".2711 This setting will override that from in the linkgit:gitmodules[5]2712 file.27132714submodule.<name>.ignore::2715 Defines under what circumstances "git status" and the diff family show2716 a submodule as modified. When set to "all", it will never be considered2717 modified (but it will nonetheless show up in the output of status and2718 commit when it has been staged), "dirty" will ignore all changes2719 to the submodules work tree and2720 takes only differences between the HEAD of the submodule and the commit2721 recorded in the superproject into account. "untracked" will additionally2722 let submodules with modified tracked files in their work tree show up.2723 Using "none" (the default when this option is not set) also shows2724 submodules that have untracked files in their work tree as changed.2725 This setting overrides any setting made in .gitmodules for this submodule,2726 both settings can be overridden on the command line by using the2727 "--ignore-submodules" option. The 'git submodule' commands are not2728 affected by this setting.27292730tag.sort::2731 This variable controls the sort ordering of tags when displayed by2732 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2733 value of this variable will be used as the default.27342735tar.umask::2736 This variable can be used to restrict the permission bits of2737 tar archive entries. The default is 0002, which turns off the2738 world write bit. The special value "user" indicates that the2739 archiving user's umask will be used instead. See umask(2) and2740 linkgit:git-archive[1].27412742transfer.fsckObjects::2743 When `fetch.fsckObjects` or `receive.fsckObjects` are2744 not set, the value of this variable is used instead.2745 Defaults to false.27462747transfer.hideRefs::2748 String(s) `receive-pack` and `upload-pack` use to decide which2749 refs to omit from their initial advertisements. Use more than2750 one definition to specify multiple prefix strings. A ref that is2751 under the hierarchies listed in the value of this variable is2752 excluded, and is hidden when responding to `git push` or `git2753 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2754 program-specific versions of this config.2755+2756You may also include a `!` in front of the ref name to negate the entry,2757explicitly exposing it, even if an earlier entry marked it as hidden.2758If you have multiple hideRefs values, later entries override earlier ones2759(and entries in more-specific config files override less-specific ones).2760+2761If a namespace is in use, the namespace prefix is stripped from each2762reference before it is matched against `transfer.hiderefs` patterns.2763For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2764the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2765is omitted from the advertisements but `refs/heads/master` and2766`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2767"have" lines. In order to match refs before stripping, add a `^` in front of2768the ref name. If you combine `!` and `^`, `!` must be specified first.27692770transfer.unpackLimit::2771 When `fetch.unpackLimit` or `receive.unpackLimit` are2772 not set, the value of this variable is used instead.2773 The default value is 100.27742775uploadarchive.allowUnreachable::2776 If true, allow clients to use `git archive --remote` to request2777 any tree, whether reachable from the ref tips or not. See the2778 discussion in the `SECURITY` section of2779 linkgit:git-upload-archive[1] for more details. Defaults to2780 `false`.27812782uploadpack.hideRefs::2783 This variable is the same as `transfer.hideRefs`, but applies2784 only to `upload-pack` (and so affects only fetches, not pushes).2785 An attempt to fetch a hidden ref by `git fetch` will fail. See2786 also `uploadpack.allowTipSHA1InWant`.27872788uploadpack.allowTipSHA1InWant::2789 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2790 to accept a fetch request that asks for an object at the tip2791 of a hidden ref (by default, such a request is rejected).2792 see also `uploadpack.hideRefs`.27932794uploadpack.allowReachableSHA1InWant::2795 Allow `upload-pack` to accept a fetch request that asks for an2796 object that is reachable from any ref tip. However, note that2797 calculating object reachability is computationally expensive.2798 Defaults to `false`.27992800uploadpack.keepAlive::2801 When `upload-pack` has started `pack-objects`, there may be a2802 quiet period while `pack-objects` prepares the pack. Normally2803 it would output progress information, but if `--quiet` was used2804 for the fetch, `pack-objects` will output nothing at all until2805 the pack data begins. Some clients and networks may consider2806 the server to be hung and give up. Setting this option instructs2807 `upload-pack` to send an empty keepalive packet every2808 `uploadpack.keepAlive` seconds. Setting this option to 02809 disables keepalive packets entirely. The default is 5 seconds.28102811url.<base>.insteadOf::2812 Any URL that starts with this value will be rewritten to2813 start, instead, with <base>. In cases where some site serves a2814 large number of repositories, and serves them with multiple2815 access methods, and some users need to use different access2816 methods, this feature allows people to specify any of the2817 equivalent URLs and have Git automatically rewrite the URL to2818 the best alternative for the particular user, even for a2819 never-before-seen repository on the site. When more than one2820 insteadOf strings match a given URL, the longest match is used.28212822url.<base>.pushInsteadOf::2823 Any URL that starts with this value will not be pushed to;2824 instead, it will be rewritten to start with <base>, and the2825 resulting URL will be pushed to. In cases where some site serves2826 a large number of repositories, and serves them with multiple2827 access methods, some of which do not allow push, this feature2828 allows people to specify a pull-only URL and have Git2829 automatically use an appropriate URL to push, even for a2830 never-before-seen repository on the site. When more than one2831 pushInsteadOf strings match a given URL, the longest match is2832 used. If a remote has an explicit pushurl, Git will ignore this2833 setting for that remote.28342835user.email::2836 Your email address to be recorded in any newly created commits.2837 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2838 'EMAIL' environment variables. See linkgit:git-commit-tree[1].28392840user.name::2841 Your full name to be recorded in any newly created commits.2842 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2843 environment variables. See linkgit:git-commit-tree[1].28442845user.useConfigOnly::2846 Instruct Git to avoid trying to guess defaults for 'user.email'2847 and 'user.name', and instead retrieve the values only from the2848 configuration. For example, if you have multiple email addresses2849 and would like to use a different one for each repository, then2850 with this configuration option set to `true` in the global config2851 along with a name, Git will prompt you to set up an email before2852 making new commits in a newly cloned repository.2853 Defaults to `false`.28542855user.signingKey::2856 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2857 key you want it to automatically when creating a signed tag or2858 commit, you can override the default selection with this variable.2859 This option is passed unchanged to gpg's --local-user parameter,2860 so you may specify a key using any method that gpg supports.28612862versionsort.prereleaseSuffix::2863 When version sort is used in linkgit:git-tag[1], prerelease2864 tags (e.g. "1.0-rc1") may appear after the main release2865 "1.0". By specifying the suffix "-rc" in this variable,2866 "1.0-rc1" will appear before "1.0".2867+2868This variable can be specified multiple times, once per suffix. The2869order of suffixes in the config file determines the sorting order2870(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2871is sorted before 1.0-rcXX). The sorting order between different2872suffixes is undefined if they are in multiple config files.28732874web.browser::2875 Specify a web browser that may be used by some commands.2876 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2877 may use it.