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. Alternatives are 341 'lf', 'crlf' and 'native', which uses the platform's native 342 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 almost the same as setting 393 the `text` attribute to "auto" on all files except that text 394 files are not guaranteed to be normalized: files that contain 395 `CRLF` in the repository will not be touched. Use this 396 setting if you want to have `CRLF` line endings in your 397 working directory even though the repository does not have 398 normalized line endings. This variable can be set to 'input', 399 in which case no output conversion is performed. 400 401core.symlinks:: 402 If false, symbolic links are checked out as small plain files that 403 contain the link text. linkgit:git-update-index[1] and 404 linkgit:git-add[1] will not change the recorded type to regular 405 file. Useful on filesystems like FAT that do not support 406 symbolic links. 407+ 408The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 409will probe and set core.symlinks false if appropriate when the repository 410is created. 411 412core.gitProxy:: 413 A "proxy command" to execute (as 'command host port') instead 414 of establishing direct connection to the remote server when 415 using the Git protocol for fetching. If the variable value is 416 in the "COMMAND for DOMAIN" format, the command is applied only 417 on hostnames ending with the specified domain string. This variable 418 may be set multiple times and is matched in the given order; 419 the first match wins. 420+ 421Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 422(which always applies universally, without the special "for" 423handling). 424+ 425The special string `none` can be used as the proxy command to 426specify that no proxy be used for a given domain pattern. 427This is useful for excluding servers inside a firewall from 428proxy use, while defaulting to a common proxy for external domains. 429 430core.ignoreStat:: 431 If true, Git will avoid using lstat() calls to detect if files have 432 changed by setting the "assume-unchanged" bit for those tracked files 433 which it has updated identically in both the index and working tree. 434+ 435When files are modified outside of Git, the user will need to stage 436the modified files explicitly (e.g. see 'Examples' section in 437linkgit:git-update-index[1]). 438Git will not normally detect changes to those files. 439+ 440This is useful on systems where lstat() calls are very slow, such as 441CIFS/Microsoft Windows. 442+ 443False by default. 444 445core.preferSymlinkRefs:: 446 Instead of the default "symref" format for HEAD 447 and other symbolic reference files, use symbolic links. 448 This is sometimes needed to work with old scripts that 449 expect HEAD to be a symbolic link. 450 451core.bare:: 452 If true this repository is assumed to be 'bare' and has no 453 working directory associated with it. If this is the case a 454 number of commands that require a working directory will be 455 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 456+ 457This setting is automatically guessed by linkgit:git-clone[1] or 458linkgit:git-init[1] when the repository was created. By default a 459repository that ends in "/.git" is assumed to be not bare (bare = 460false), while all other repositories are assumed to be bare (bare 461= true). 462 463core.worktree:: 464 Set the path to the root of the working tree. 465 If GIT_COMMON_DIR environment variable is set, core.worktree 466 is ignored and not used for determining the root of working tree. 467 This can be overridden by the GIT_WORK_TREE environment 468 variable and the '--work-tree' command-line option. 469 The value can be an absolute path or relative to the path to 470 the .git directory, which is either specified by --git-dir 471 or GIT_DIR, or automatically discovered. 472 If --git-dir or GIT_DIR is specified but none of 473 --work-tree, GIT_WORK_TREE and core.worktree is specified, 474 the current working directory is regarded as the top level 475 of your working tree. 476+ 477Note that this variable is honored even when set in a configuration 478file in a ".git" subdirectory of a directory and its value differs 479from the latter directory (e.g. "/path/to/.git/config" has 480core.worktree set to "/different/path"), which is most likely a 481misconfiguration. Running Git commands in the "/path/to" directory will 482still use "/different/path" as the root of the work tree and can cause 483confusion unless you know what you are doing (e.g. you are creating a 484read-only snapshot of the same index to a location different from the 485repository's usual working tree). 486 487core.logAllRefUpdates:: 488 Enable the reflog. Updates to a ref <ref> is logged to the file 489 "$GIT_DIR/logs/<ref>", by appending the new and old 490 SHA-1, the date/time and the reason of the update, but 491 only when the file exists. If this configuration 492 variable is set to true, missing "$GIT_DIR/logs/<ref>" 493 file is automatically created for branch heads (i.e. under 494 refs/heads/), remote refs (i.e. under refs/remotes/), 495 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 496+ 497This information can be used to determine what commit 498was the tip of a branch "2 days ago". 499+ 500This value is true by default in a repository that has 501a working directory associated with it, and false by 502default in a bare repository. 503 504core.repositoryFormatVersion:: 505 Internal variable identifying the repository format and layout 506 version. 507 508core.sharedRepository:: 509 When 'group' (or 'true'), the repository is made shareable between 510 several users in a group (making sure all the files and objects are 511 group-writable). When 'all' (or 'world' or 'everybody'), the 512 repository will be readable by all users, additionally to being 513 group-shareable. When 'umask' (or 'false'), Git will use permissions 514 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 515 files in the repository will have this mode value. '0xxx' will override 516 user's umask value (whereas the other options will only override 517 requested parts of the user's umask value). Examples: '0660' will make 518 the repo read/write-able for the owner and group, but inaccessible to 519 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 520 repository that is group-readable but not group-writable. 521 See linkgit:git-init[1]. False by default. 522 523core.warnAmbiguousRefs:: 524 If true, Git will warn you if the ref name you passed it is ambiguous 525 and might match multiple refs in the repository. True by default. 526 527core.compression:: 528 An integer -1..9, indicating a default compression level. 529 -1 is the zlib default. 0 means no compression, 530 and 1..9 are various speed/size tradeoffs, 9 being slowest. 531 If set, this provides a default to other compression variables, 532 such as 'core.looseCompression' and 'pack.compression'. 533 534core.looseCompression:: 535 An integer -1..9, indicating the compression level for objects that 536 are not in a pack file. -1 is the zlib default. 0 means no 537 compression, and 1..9 are various speed/size tradeoffs, 9 being 538 slowest. If not set, defaults to core.compression. If that is 539 not set, defaults to 1 (best speed). 540 541core.packedGitWindowSize:: 542 Number of bytes of a pack file to map into memory in a 543 single mapping operation. Larger window sizes may allow 544 your system to process a smaller number of large pack files 545 more quickly. Smaller window sizes will negatively affect 546 performance due to increased calls to the operating system's 547 memory manager, but may improve performance when accessing 548 a large number of large pack files. 549+ 550Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 551MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 552be reasonable for all users/operating systems. You probably do 553not need to adjust this value. 554+ 555Common unit suffixes of 'k', 'm', or 'g' are supported. 556 557core.packedGitLimit:: 558 Maximum number of bytes to map simultaneously into memory 559 from pack files. If Git needs to access more than this many 560 bytes at once to complete an operation it will unmap existing 561 regions to reclaim virtual address space within the process. 562+ 563Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 564This should be reasonable for all users/operating systems, except on 565the largest projects. You probably do not need to adjust this value. 566+ 567Common unit suffixes of 'k', 'm', or 'g' are supported. 568 569core.deltaBaseCacheLimit:: 570 Maximum number of bytes to reserve for caching base objects 571 that may be referenced by multiple deltified objects. By storing the 572 entire decompressed base objects in a cache Git is able 573 to avoid unpacking and decompressing frequently used base 574 objects multiple times. 575+ 576Default is 96 MiB on all platforms. This should be reasonable 577for all users/operating systems, except on the largest projects. 578You probably do not need to adjust this value. 579+ 580Common unit suffixes of 'k', 'm', or 'g' are supported. 581 582core.bigFileThreshold:: 583 Files larger than this size are stored deflated, without 584 attempting delta compression. Storing large files without 585 delta compression avoids excessive memory usage, at the 586 slight expense of increased disk usage. Additionally files 587 larger than this size are always treated as binary. 588+ 589Default is 512 MiB on all platforms. This should be reasonable 590for most projects as source code and other text files can still 591be delta compressed, but larger binary media files won't be. 592+ 593Common unit suffixes of 'k', 'm', or 'g' are supported. 594 595core.excludesFile:: 596 In addition to '.gitignore' (per-directory) and 597 '.git/info/exclude', Git looks into this file for patterns 598 of files which are not meant to be tracked. "`~/`" is expanded 599 to the value of `$HOME` and "`~user/`" to the specified user's 600 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 601 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 602 is used instead. See linkgit:gitignore[5]. 603 604core.askPass:: 605 Some commands (e.g. svn and http interfaces) that interactively 606 ask for a password can be told to use an external program given 607 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 608 environment variable. If not set, fall back to the value of the 609 'SSH_ASKPASS' environment variable or, failing that, a simple password 610 prompt. The external program shall be given a suitable prompt as 611 command-line argument and write the password on its STDOUT. 612 613core.attributesFile:: 614 In addition to '.gitattributes' (per-directory) and 615 '.git/info/attributes', Git looks into this file for attributes 616 (see linkgit:gitattributes[5]). Path expansions are made the same 617 way as for `core.excludesFile`. Its default value is 618 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 619 set or empty, $HOME/.config/git/attributes is used instead. 620 621core.editor:: 622 Commands such as `commit` and `tag` that lets you edit 623 messages by launching an editor uses the value of this 624 variable when it is set, and the environment variable 625 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 626 627core.commentChar:: 628 Commands such as `commit` and `tag` that lets you edit 629 messages consider a line that begins with this character 630 commented, and removes them after the editor returns 631 (default '#'). 632+ 633If set to "auto", `git-commit` would select a character that is not 634the beginning character of any line in existing commit messages. 635 636core.packedRefsTimeout:: 637 The length of time, in milliseconds, to retry when trying to 638 lock the `packed-refs` file. Value 0 means not to retry at 639 all; -1 means to try indefinitely. Default is 1000 (i.e., 640 retry for 1 second). 641 642sequence.editor:: 643 Text editor used by `git rebase -i` for editing the rebase instruction file. 644 The value is meant to be interpreted by the shell when it is used. 645 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 646 When not configured the default commit message editor is used instead. 647 648core.pager:: 649 Text viewer for use by Git commands (e.g., 'less'). The value 650 is meant to be interpreted by the shell. The order of preference 651 is the `$GIT_PAGER` environment variable, then `core.pager` 652 configuration, then `$PAGER`, and then the default chosen at 653 compile time (usually 'less'). 654+ 655When the `LESS` environment variable is unset, Git sets it to `FRX` 656(if `LESS` environment variable is set, Git does not change it at 657all). If you want to selectively override Git's default setting 658for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 659be passed to the shell by Git, which will translate the final 660command to `LESS=FRX less -S`. The environment does not set the 661`S` option but the command line does, instructing less to truncate 662long lines. Similarly, setting `core.pager` to `less -+F` will 663deactivate the `F` option specified by the environment from the 664command-line, deactivating the "quit if one screen" behavior of 665`less`. One can specifically activate some flags for particular 666commands: for example, setting `pager.blame` to `less -S` enables 667line truncation only for `git blame`. 668+ 669Likewise, when the `LV` environment variable is unset, Git sets it 670to `-c`. You can override this setting by exporting `LV` with 671another value or setting `core.pager` to `lv +c`. 672 673core.whitespace:: 674 A comma separated list of common whitespace problems to 675 notice. 'git diff' will use `color.diff.whitespace` to 676 highlight them, and 'git apply --whitespace=error' will 677 consider them as errors. You can prefix `-` to disable 678 any of them (e.g. `-trailing-space`): 679+ 680* `blank-at-eol` treats trailing whitespaces at the end of the line 681 as an error (enabled by default). 682* `space-before-tab` treats a space character that appears immediately 683 before a tab character in the initial indent part of the line as an 684 error (enabled by default). 685* `indent-with-non-tab` treats a line that is indented with space 686 characters instead of the equivalent tabs as an error (not enabled by 687 default). 688* `tab-in-indent` treats a tab character in the initial indent part of 689 the line as an error (not enabled by default). 690* `blank-at-eof` treats blank lines added at the end of file as an error 691 (enabled by default). 692* `trailing-space` is a short-hand to cover both `blank-at-eol` and 693 `blank-at-eof`. 694* `cr-at-eol` treats a carriage-return at the end of line as 695 part of the line terminator, i.e. with it, `trailing-space` 696 does not trigger if the character before such a carriage-return 697 is not a whitespace (not enabled by default). 698* `tabwidth=<n>` tells how many character positions a tab occupies; this 699 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 700 errors. The default tab width is 8. Allowed values are 1 to 63. 701 702core.fsyncObjectFiles:: 703 This boolean will enable 'fsync()' when writing object files. 704+ 705This is a total waste of time and effort on a filesystem that orders 706data writes properly, but can be useful for filesystems that do not use 707journalling (traditional UNIX filesystems) or that only journal metadata 708and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 709 710core.preloadIndex:: 711 Enable parallel index preload for operations like 'git diff' 712+ 713This can speed up operations like 'git diff' and 'git status' especially 714on filesystems like NFS that have weak caching semantics and thus 715relatively high IO latencies. When enabled, Git will do the 716index comparison to the filesystem data in parallel, allowing 717overlapping IO's. Defaults to true. 718 719core.createObject:: 720 You can set this to 'link', in which case a hardlink followed by 721 a delete of the source are used to make sure that object creation 722 will not overwrite existing objects. 723+ 724On some file system/operating system combinations, this is unreliable. 725Set this config setting to 'rename' there; However, This will remove the 726check that makes sure that existing object files will not get overwritten. 727 728core.notesRef:: 729 When showing commit messages, also show notes which are stored in 730 the given ref. The ref must be fully qualified. If the given 731 ref does not exist, it is not an error but means that no 732 notes should be printed. 733+ 734This setting defaults to "refs/notes/commits", and it can be overridden by 735the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 736 737core.sparseCheckout:: 738 Enable "sparse checkout" feature. See section "Sparse checkout" in 739 linkgit:git-read-tree[1] for more information. 740 741core.abbrev:: 742 Set the length object names are abbreviated to. If unspecified, 743 many commands abbreviate to 7 hexdigits, which may not be enough 744 for abbreviated object names to stay unique for sufficiently long 745 time. 746 747add.ignoreErrors:: 748add.ignore-errors (deprecated):: 749 Tells 'git add' to continue adding files when some files cannot be 750 added due to indexing errors. Equivalent to the '--ignore-errors' 751 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 752 as it does not follow the usual naming convention for configuration 753 variables. 754 755alias.*:: 756 Command aliases for the linkgit:git[1] command wrapper - e.g. 757 after defining "alias.last = cat-file commit HEAD", the invocation 758 "git last" is equivalent to "git cat-file commit HEAD". To avoid 759 confusion and troubles with script usage, aliases that 760 hide existing Git commands are ignored. Arguments are split by 761 spaces, the usual shell quoting and escaping is supported. 762 A quote pair or a backslash can be used to quote them. 763+ 764If the alias expansion is prefixed with an exclamation point, 765it will be treated as a shell command. For example, defining 766"alias.new = !gitk --all --not ORIG_HEAD", the invocation 767"git new" is equivalent to running the shell command 768"gitk --all --not ORIG_HEAD". Note that shell commands will be 769executed from the top-level directory of a repository, which may 770not necessarily be the current directory. 771'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 772from the original current directory. See linkgit:git-rev-parse[1]. 773 774am.keepcr:: 775 If true, git-am will call git-mailsplit for patches in mbox format 776 with parameter '--keep-cr'. In this case git-mailsplit will 777 not remove `\r` from lines ending with `\r\n`. Can be overridden 778 by giving '--no-keep-cr' from the command line. 779 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 780 781am.threeWay:: 782 By default, `git am` will fail if the patch does not apply cleanly. When 783 set to true, this setting tells `git am` to fall back on 3-way merge if 784 the patch records the identity of blobs it is supposed to apply to and 785 we have those blobs available locally (equivalent to giving the `--3way` 786 option from the command line). Defaults to `false`. 787 See linkgit:git-am[1]. 788 789apply.ignoreWhitespace:: 790 When set to 'change', tells 'git apply' to ignore changes in 791 whitespace, in the same way as the '--ignore-space-change' 792 option. 793 When set to one of: no, none, never, false tells 'git apply' to 794 respect all whitespace differences. 795 See linkgit:git-apply[1]. 796 797apply.whitespace:: 798 Tells 'git apply' how to handle whitespaces, in the same way 799 as the '--whitespace' option. See linkgit:git-apply[1]. 800 801branch.autoSetupMerge:: 802 Tells 'git branch' and 'git checkout' to set up new branches 803 so that linkgit:git-pull[1] will appropriately merge from the 804 starting point branch. Note that even if this option is not set, 805 this behavior can be chosen per-branch using the `--track` 806 and `--no-track` options. The valid settings are: `false` -- no 807 automatic setup is done; `true` -- automatic setup is done when the 808 starting point is a remote-tracking branch; `always` -- 809 automatic setup is done when the starting point is either a 810 local branch or remote-tracking 811 branch. This option defaults to true. 812 813branch.autoSetupRebase:: 814 When a new branch is created with 'git branch' or 'git checkout' 815 that tracks another branch, this variable tells Git to set 816 up pull to rebase instead of merge (see "branch.<name>.rebase"). 817 When `never`, rebase is never automatically set to true. 818 When `local`, rebase is set to true for tracked branches of 819 other local branches. 820 When `remote`, rebase is set to true for tracked branches of 821 remote-tracking branches. 822 When `always`, rebase will be set to true for all tracking 823 branches. 824 See "branch.autoSetupMerge" for details on how to set up a 825 branch to track another branch. 826 This option defaults to never. 827 828branch.<name>.remote:: 829 When on branch <name>, it tells 'git fetch' and 'git push' 830 which remote to fetch from/push to. The remote to push to 831 may be overridden with `remote.pushDefault` (for all branches). 832 The remote to push to, for the current branch, may be further 833 overridden by `branch.<name>.pushRemote`. If no remote is 834 configured, or if you are not on any branch, it defaults to 835 `origin` for fetching and `remote.pushDefault` for pushing. 836 Additionally, `.` (a period) is the current local repository 837 (a dot-repository), see `branch.<name>.merge`'s final note below. 838 839branch.<name>.pushRemote:: 840 When on branch <name>, it overrides `branch.<name>.remote` for 841 pushing. It also overrides `remote.pushDefault` for pushing 842 from branch <name>. When you pull from one place (e.g. your 843 upstream) and push to another place (e.g. your own publishing 844 repository), you would want to set `remote.pushDefault` to 845 specify the remote to push to for all branches, and use this 846 option to override it for a specific branch. 847 848branch.<name>.merge:: 849 Defines, together with branch.<name>.remote, the upstream branch 850 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 851 branch to merge and can also affect 'git push' (see push.default). 852 When in branch <name>, it tells 'git fetch' the default 853 refspec to be marked for merging in FETCH_HEAD. The value is 854 handled like the remote part of a refspec, and must match a 855 ref which is fetched from the remote given by 856 "branch.<name>.remote". 857 The merge information is used by 'git pull' (which at first calls 858 'git fetch') to lookup the default branch for merging. Without 859 this option, 'git pull' defaults to merge the first refspec fetched. 860 Specify multiple values to get an octopus merge. 861 If you wish to setup 'git pull' so that it merges into <name> from 862 another branch in the local repository, you can point 863 branch.<name>.merge to the desired branch, and use the relative path 864 setting `.` (a period) for branch.<name>.remote. 865 866branch.<name>.mergeOptions:: 867 Sets default options for merging into branch <name>. The syntax and 868 supported options are the same as those of linkgit:git-merge[1], but 869 option values containing whitespace characters are currently not 870 supported. 871 872branch.<name>.rebase:: 873 When true, rebase the branch <name> on top of the fetched branch, 874 instead of merging the default branch from the default remote when 875 "git pull" is run. See "pull.rebase" for doing this in a non 876 branch-specific manner. 877+ 878When preserve, also pass `--preserve-merges` along to 'git rebase' 879so that locally committed merge commits will not be flattened 880by running 'git pull'. 881+ 882When the value is `interactive`, the rebase is run in interactive mode. 883+ 884*NOTE*: this is a possibly dangerous operation; do *not* use 885it unless you understand the implications (see linkgit:git-rebase[1] 886for details). 887 888branch.<name>.description:: 889 Branch description, can be edited with 890 `git branch --edit-description`. Branch description is 891 automatically added in the format-patch cover letter or 892 request-pull summary. 893 894browser.<tool>.cmd:: 895 Specify the command to invoke the specified browser. The 896 specified command is evaluated in shell with the URLs passed 897 as arguments. (See linkgit:git-web{litdd}browse[1].) 898 899browser.<tool>.path:: 900 Override the path for the given tool that may be used to 901 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 902 working repository in gitweb (see linkgit:git-instaweb[1]). 903 904clean.requireForce:: 905 A boolean to make git-clean do nothing unless given -f, 906 -i or -n. Defaults to true. 907 908color.branch:: 909 A boolean to enable/disable color in the output of 910 linkgit:git-branch[1]. May be set to `always`, 911 `false` (or `never`) or `auto` (or `true`), in which case colors are used 912 only when the output is to a terminal. Defaults to false. 913 914color.branch.<slot>:: 915 Use customized color for branch coloration. `<slot>` is one of 916 `current` (the current branch), `local` (a local branch), 917 `remote` (a remote-tracking branch in refs/remotes/), 918 `upstream` (upstream tracking branch), `plain` (other 919 refs). 920 921color.diff:: 922 Whether to use ANSI escape sequences to add color to patches. 923 If this is set to `always`, linkgit:git-diff[1], 924 linkgit:git-log[1], and linkgit:git-show[1] will use color 925 for all patches. If it is set to `true` or `auto`, those 926 commands will only use color when output is to the terminal. 927 Defaults to false. 928+ 929This does not affect linkgit:git-format-patch[1] or the 930'git-diff-{asterisk}' plumbing commands. Can be overridden on the 931command line with the `--color[=<when>]` option. 932 933color.diff.<slot>:: 934 Use customized color for diff colorization. `<slot>` specifies 935 which part of the patch to use the specified color, and is one 936 of `context` (context text - `plain` is a historical synonym), 937 `meta` (metainformation), `frag` 938 (hunk header), 'func' (function in hunk header), `old` (removed lines), 939 `new` (added lines), `commit` (commit headers), or `whitespace` 940 (highlighting whitespace errors). 941 942color.decorate.<slot>:: 943 Use customized color for 'git log --decorate' output. `<slot>` is one 944 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 945 branches, remote-tracking branches, tags, stash and HEAD, respectively. 946 947color.grep:: 948 When set to `always`, always highlight matches. When `false` (or 949 `never`), never. When set to `true` or `auto`, use color only 950 when the output is written to the terminal. Defaults to `false`. 951 952color.grep.<slot>:: 953 Use customized color for grep colorization. `<slot>` specifies which 954 part of the line to use the specified color, and is one of 955+ 956-- 957`context`;; 958 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 959`filename`;; 960 filename prefix (when not using `-h`) 961`function`;; 962 function name lines (when using `-p`) 963`linenumber`;; 964 line number prefix (when using `-n`) 965`match`;; 966 matching text (same as setting `matchContext` and `matchSelected`) 967`matchContext`;; 968 matching text in context lines 969`matchSelected`;; 970 matching text in selected lines 971`selected`;; 972 non-matching text in selected lines 973`separator`;; 974 separators between fields on a line (`:`, `-`, and `=`) 975 and between hunks (`--`) 976-- 977 978color.interactive:: 979 When set to `always`, always use colors for interactive prompts 980 and displays (such as those used by "git-add --interactive" and 981 "git-clean --interactive"). When false (or `never`), never. 982 When set to `true` or `auto`, use colors only when the output is 983 to the terminal. Defaults to false. 984 985color.interactive.<slot>:: 986 Use customized color for 'git add --interactive' and 'git clean 987 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 988 or `error`, for four distinct types of normal output from 989 interactive commands. 990 991color.pager:: 992 A boolean to enable/disable colored output when the pager is in 993 use (default is true). 994 995color.showBranch:: 996 A boolean to enable/disable color in the output of 997 linkgit:git-show-branch[1]. May be set to `always`, 998 `false` (or `never`) or `auto` (or `true`), in which case colors are used 999 only when the output is to a terminal. Defaults to false.10001001color.status::1002 A boolean to enable/disable color in the output of1003 linkgit:git-status[1]. May be set to `always`,1004 `false` (or `never`) or `auto` (or `true`), in which case colors are used1005 only when the output is to a terminal. Defaults to false.10061007color.status.<slot>::1008 Use customized color for status colorization. `<slot>` is1009 one of `header` (the header text of the status message),1010 `added` or `updated` (files which are added but not committed),1011 `changed` (files which are changed but not added in the index),1012 `untracked` (files which are not tracked by Git),1013 `branch` (the current branch),1014 `nobranch` (the color the 'no branch' warning is shown in, defaulting1015 to red), or1016 `unmerged` (files which have unmerged changes).10171018color.ui::1019 This variable determines the default value for variables such1020 as `color.diff` and `color.grep` that control the use of color1021 per command family. Its scope will expand as more commands learn1022 configuration to set a default for the `--color` option. Set it1023 to `false` or `never` if you prefer Git commands not to use1024 color unless enabled explicitly with some other configuration1025 or the `--color` option. Set it to `always` if you want all1026 output not intended for machine consumption to use color, to1027 `true` or `auto` (this is the default since Git 1.8.4) if you1028 want such output to use color when written to the terminal.10291030column.ui::1031 Specify whether supported commands should output in columns.1032 This variable consists of a list of tokens separated by spaces1033 or commas:1034+1035These options control when the feature should be enabled1036(defaults to 'never'):1037+1038--1039`always`;;1040 always show in columns1041`never`;;1042 never show in columns1043`auto`;;1044 show in columns if the output is to the terminal1045--1046+1047These options control layout (defaults to 'column'). Setting any1048of these implies 'always' if none of 'always', 'never', or 'auto' are1049specified.1050+1051--1052`column`;;1053 fill columns before rows1054`row`;;1055 fill rows before columns1056`plain`;;1057 show in one column1058--1059+1060Finally, these options can be combined with a layout option (defaults1061to 'nodense'):1062+1063--1064`dense`;;1065 make unequal size columns to utilize more space1066`nodense`;;1067 make equal size columns1068--10691070column.branch::1071 Specify whether to output branch listing in `git branch` in columns.1072 See `column.ui` for details.10731074column.clean::1075 Specify the layout when list items in `git clean -i`, which always1076 shows files and directories in columns. See `column.ui` for details.10771078column.status::1079 Specify whether to output untracked files in `git status` in columns.1080 See `column.ui` for details.10811082column.tag::1083 Specify whether to output tag listing in `git tag` in columns.1084 See `column.ui` for details.10851086commit.cleanup::1087 This setting overrides the default of the `--cleanup` option in1088 `git commit`. See linkgit:git-commit[1] for details. Changing the1089 default can be useful when you always want to keep lines that begin1090 with comment character `#` in your log message, in which case you1091 would do `git config commit.cleanup whitespace` (note that you will1092 have to remove the help lines that begin with `#` in the commit log1093 template yourself, if you do this).10941095commit.gpgSign::10961097 A boolean to specify whether all commits should be GPG signed.1098 Use of this option when doing operations such as rebase can1099 result in a large number of commits being signed. It may be1100 convenient to use an agent to avoid typing your GPG passphrase1101 several times.11021103commit.status::1104 A boolean to enable/disable inclusion of status information in the1105 commit message template when using an editor to prepare the commit1106 message. Defaults to true.11071108commit.template::1109 Specify a file to use as the template for new commit messages.1110 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1111 specified user's home directory.11121113credential.helper::1114 Specify an external helper to be called when a username or1115 password credential is needed; the helper may consult external1116 storage to avoid prompting the user for the credentials. See1117 linkgit:gitcredentials[7] for details.11181119credential.useHttpPath::1120 When acquiring credentials, consider the "path" component of an http1121 or https URL to be important. Defaults to false. See1122 linkgit:gitcredentials[7] for more information.11231124credential.username::1125 If no username is set for a network authentication, use this username1126 by default. See credential.<context>.* below, and1127 linkgit:gitcredentials[7].11281129credential.<url>.*::1130 Any of the credential.* options above can be applied selectively to1131 some credentials. For example "credential.https://example.com.username"1132 would set the default username only for https connections to1133 example.com. See linkgit:gitcredentials[7] for details on how URLs are1134 matched.11351136credentialCache.ignoreSIGHUP::1137 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11381139include::diff-config.txt[]11401141difftool.<tool>.path::1142 Override the path for the given tool. This is useful in case1143 your tool is not in the PATH.11441145difftool.<tool>.cmd::1146 Specify the command to invoke the specified diff tool.1147 The specified command is evaluated in shell with the following1148 variables available: 'LOCAL' is set to the name of the temporary1149 file containing the contents of the diff pre-image and 'REMOTE'1150 is set to the name of the temporary file containing the contents1151 of the diff post-image.11521153difftool.prompt::1154 Prompt before each invocation of the diff tool.11551156fetch.recurseSubmodules::1157 This option can be either set to a boolean value or to 'on-demand'.1158 Setting it to a boolean changes the behavior of fetch and pull to1159 unconditionally recurse into submodules when set to true or to not1160 recurse at all when set to false. When set to 'on-demand' (the default1161 value), fetch and pull will only recurse into a populated submodule1162 when its superproject retrieves a commit that updates the submodule's1163 reference.11641165fetch.fsckObjects::1166 If it is set to true, git-fetch-pack will check all fetched1167 objects. It will abort in the case of a malformed object or a1168 broken link. The result of an abort are only dangling objects.1169 Defaults to false. If not set, the value of `transfer.fsckObjects`1170 is used instead.11711172fetch.unpackLimit::1173 If the number of objects fetched over the Git native1174 transfer is below this1175 limit, then the objects will be unpacked into loose object1176 files. However if the number of received objects equals or1177 exceeds this limit then the received pack will be stored as1178 a pack, after adding any missing delta bases. Storing the1179 pack from a push can make the push operation complete faster,1180 especially on slow filesystems. If not set, the value of1181 `transfer.unpackLimit` is used instead.11821183fetch.prune::1184 If true, fetch will automatically behave as if the `--prune`1185 option was given on the command line. See also `remote.<name>.prune`.11861187format.attach::1188 Enable multipart/mixed attachments as the default for1189 'format-patch'. The value can also be a double quoted string1190 which will enable attachments as the default and set the1191 value as the boundary. See the --attach option in1192 linkgit:git-format-patch[1].11931194format.numbered::1195 A boolean which can enable or disable sequence numbers in patch1196 subjects. It defaults to "auto" which enables it only if there1197 is more than one patch. It can be enabled or disabled for all1198 messages by setting it to "true" or "false". See --numbered1199 option in linkgit:git-format-patch[1].12001201format.headers::1202 Additional email headers to include in a patch to be submitted1203 by mail. See linkgit:git-format-patch[1].12041205format.to::1206format.cc::1207 Additional recipients to include in a patch to be submitted1208 by mail. See the --to and --cc options in1209 linkgit:git-format-patch[1].12101211format.subjectPrefix::1212 The default for format-patch is to output files with the '[PATCH]'1213 subject prefix. Use this variable to change that prefix.12141215format.signature::1216 The default for format-patch is to output a signature containing1217 the Git version number. Use this variable to change that default.1218 Set this variable to the empty string ("") to suppress1219 signature generation.12201221format.signatureFile::1222 Works just like format.signature except the contents of the1223 file specified by this variable will be used as the signature.12241225format.suffix::1226 The default for format-patch is to output files with the suffix1227 `.patch`. Use this variable to change that suffix (make sure to1228 include the dot if you want it).12291230format.pretty::1231 The default pretty format for log/show/whatchanged command,1232 See linkgit:git-log[1], linkgit:git-show[1],1233 linkgit:git-whatchanged[1].12341235format.thread::1236 The default threading style for 'git format-patch'. Can be1237 a boolean value, or `shallow` or `deep`. `shallow` threading1238 makes every mail a reply to the head of the series,1239 where the head is chosen from the cover letter, the1240 `--in-reply-to`, and the first patch mail, in this order.1241 `deep` threading makes every mail a reply to the previous one.1242 A true boolean value is the same as `shallow`, and a false1243 value disables threading.12441245format.signOff::1246 A boolean value which lets you enable the `-s/--signoff` option of1247 format-patch by default. *Note:* Adding the Signed-off-by: line to a1248 patch should be a conscious act and means that you certify you have1249 the rights to submit this work under the same open source license.1250 Please see the 'SubmittingPatches' document for further discussion.12511252format.coverLetter::1253 A boolean that controls whether to generate a cover-letter when1254 format-patch is invoked, but in addition can be set to "auto", to1255 generate a cover-letter only when there's more than one patch.12561257format.outputDirectory::1258 Set a custom directory to store the resulting files instead of the1259 current working directory.12601261filter.<driver>.clean::1262 The command which is used to convert the content of a worktree1263 file to a blob upon checkin. See linkgit:gitattributes[5] for1264 details.12651266filter.<driver>.smudge::1267 The command which is used to convert the content of a blob1268 object to a worktree file upon checkout. See1269 linkgit:gitattributes[5] for details.12701271fsck.<msg-id>::1272 Allows overriding the message type (error, warn or ignore) of a1273 specific message ID such as `missingEmail`.1274+1275For convenience, fsck prefixes the error/warning with the message ID,1276e.g. "missingEmail: invalid author/committer line - missing email" means1277that setting `fsck.missingEmail = ignore` will hide that issue.1278+1279This feature is intended to support working with legacy repositories1280which cannot be repaired without disruptive changes.12811282fsck.skipList::1283 The path to a sorted list of object names (i.e. one SHA-1 per1284 line) that are known to be broken in a non-fatal way and should1285 be ignored. This feature is useful when an established project1286 should be accepted despite early commits containing errors that1287 can be safely ignored such as invalid committer email addresses.1288 Note: corrupt objects cannot be skipped with this setting.12891290gc.aggressiveDepth::1291 The depth parameter used in the delta compression1292 algorithm used by 'git gc --aggressive'. This defaults1293 to 250.12941295gc.aggressiveWindow::1296 The window size parameter used in the delta compression1297 algorithm used by 'git gc --aggressive'. This defaults1298 to 250.12991300gc.auto::1301 When there are approximately more than this many loose1302 objects in the repository, `git gc --auto` will pack them.1303 Some Porcelain commands use this command to perform a1304 light-weight garbage collection from time to time. The1305 default value is 6700. Setting this to 0 disables it.13061307gc.autoPackLimit::1308 When there are more than this many packs that are not1309 marked with `*.keep` file in the repository, `git gc1310 --auto` consolidates them into one larger pack. The1311 default value is 50. Setting this to 0 disables it.13121313gc.autoDetach::1314 Make `git gc --auto` return immediately and run in background1315 if the system supports it. Default is true.13161317gc.packRefs::1318 Running `git pack-refs` in a repository renders it1319 unclonable by Git versions prior to 1.5.1.2 over dumb1320 transports such as HTTP. This variable determines whether1321 'git gc' runs `git pack-refs`. This can be set to `notbare`1322 to enable it within all non-bare repos or it can be set to a1323 boolean value. The default is `true`.13241325gc.pruneExpire::1326 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1327 Override the grace period with this config variable. The value1328 "now" may be used to disable this grace period and always prune1329 unreachable objects immediately, or "never" may be used to1330 suppress pruning.13311332gc.worktreePruneExpire::1333 When 'git gc' is run, it calls1334 'git worktree prune --expire 3.months.ago'.1335 This config variable can be used to set a different grace1336 period. The value "now" may be used to disable the grace1337 period and prune $GIT_DIR/worktrees immediately, or "never"1338 may be used to suppress pruning.13391340gc.reflogExpire::1341gc.<pattern>.reflogExpire::1342 'git reflog expire' removes reflog entries older than1343 this time; defaults to 90 days. The value "now" expires all1344 entries immediately, and "never" suppresses expiration1345 altogether. With "<pattern>" (e.g.1346 "refs/stash") in the middle the setting applies only to1347 the refs that match the <pattern>.13481349gc.reflogExpireUnreachable::1350gc.<pattern>.reflogExpireUnreachable::1351 'git reflog expire' removes reflog entries older than1352 this time and are not reachable from the current tip;1353 defaults to 30 days. The value "now" expires all entries1354 immediately, and "never" suppresses expiration altogether.1355 With "<pattern>" (e.g. "refs/stash")1356 in the middle, the setting applies only to the refs that1357 match the <pattern>.13581359gc.rerereResolved::1360 Records of conflicted merge you resolved earlier are1361 kept for this many days when 'git rerere gc' is run.1362 The default is 60 days. See linkgit:git-rerere[1].13631364gc.rerereUnresolved::1365 Records of conflicted merge you have not resolved are1366 kept for this many days when 'git rerere gc' is run.1367 The default is 15 days. See linkgit:git-rerere[1].13681369gitcvs.commitMsgAnnotation::1370 Append this string to each commit message. Set to empty string1371 to disable this feature. Defaults to "via git-CVS emulator".13721373gitcvs.enabled::1374 Whether the CVS server interface is enabled for this repository.1375 See linkgit:git-cvsserver[1].13761377gitcvs.logFile::1378 Path to a log file where the CVS server interface well... logs1379 various stuff. See linkgit:git-cvsserver[1].13801381gitcvs.usecrlfattr::1382 If true, the server will look up the end-of-line conversion1383 attributes for files to determine the '-k' modes to use. If1384 the attributes force Git to treat a file as text,1385 the '-k' mode will be left blank so CVS clients will1386 treat it as text. If they suppress text conversion, the file1387 will be set with '-kb' mode, which suppresses any newline munging1388 the client might otherwise do. If the attributes do not allow1389 the file type to be determined, then 'gitcvs.allBinary' is1390 used. See linkgit:gitattributes[5].13911392gitcvs.allBinary::1393 This is used if 'gitcvs.usecrlfattr' does not resolve1394 the correct '-kb' mode to use. If true, all1395 unresolved files are sent to the client in1396 mode '-kb'. This causes the client to treat them1397 as binary files, which suppresses any newline munging it1398 otherwise might do. Alternatively, if it is set to "guess",1399 then the contents of the file are examined to decide if1400 it is binary, similar to 'core.autocrlf'.14011402gitcvs.dbName::1403 Database used by git-cvsserver to cache revision information1404 derived from the Git repository. The exact meaning depends on the1405 used database driver, for SQLite (which is the default driver) this1406 is a filename. Supports variable substitution (see1407 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1408 Default: '%Ggitcvs.%m.sqlite'14091410gitcvs.dbDriver::1411 Used Perl DBI driver. You can specify any available driver1412 for this here, but it might not work. git-cvsserver is tested1413 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1414 reported *not* to work with 'DBD::mysql'. Experimental feature.1415 May not contain double colons (`:`). Default: 'SQLite'.1416 See linkgit:git-cvsserver[1].14171418gitcvs.dbUser, gitcvs.dbPass::1419 Database user and password. Only useful if setting 'gitcvs.dbDriver',1420 since SQLite has no concept of database users and/or passwords.1421 'gitcvs.dbUser' supports variable substitution (see1422 linkgit:git-cvsserver[1] for details).14231424gitcvs.dbTableNamePrefix::1425 Database table name prefix. Prepended to the names of any1426 database tables used, allowing a single database to be used1427 for several repositories. Supports variable substitution (see1428 linkgit:git-cvsserver[1] for details). Any non-alphabetic1429 characters will be replaced with underscores.14301431All gitcvs variables except for 'gitcvs.usecrlfattr' and1432'gitcvs.allBinary' can also be specified as1433'gitcvs.<access_method>.<varname>' (where 'access_method'1434is one of "ext" and "pserver") to make them apply only for the given1435access method.14361437gitweb.category::1438gitweb.description::1439gitweb.owner::1440gitweb.url::1441 See linkgit:gitweb[1] for description.14421443gitweb.avatar::1444gitweb.blame::1445gitweb.grep::1446gitweb.highlight::1447gitweb.patches::1448gitweb.pickaxe::1449gitweb.remote_heads::1450gitweb.showSizes::1451gitweb.snapshot::1452 See linkgit:gitweb.conf[5] for description.14531454grep.lineNumber::1455 If set to true, enable '-n' option by default.14561457grep.patternType::1458 Set the default matching behavior. Using a value of 'basic', 'extended',1459 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1460 '--fixed-strings', or '--perl-regexp' option accordingly, while the1461 value 'default' will return to the default matching behavior.14621463grep.extendedRegexp::1464 If set to true, enable '--extended-regexp' option by default. This1465 option is ignored when the 'grep.patternType' option is set to a value1466 other than 'default'.14671468grep.threads::1469 Number of grep worker threads to use.1470 See `grep.threads` in linkgit:git-grep[1] for more information.14711472grep.fallbackToNoIndex::1473 If set to true, fall back to git grep --no-index if git grep1474 is executed outside of a git repository. Defaults to false.14751476gpg.program::1477 Use this custom program instead of "gpg" found on $PATH when1478 making or verifying a PGP signature. The program must support the1479 same command-line interface as GPG, namely, to verify a detached1480 signature, "gpg --verify $file - <$signature" is run, and the1481 program is expected to signal a good signature by exiting with1482 code 0, and to generate an ASCII-armored detached signature, the1483 standard input of "gpg -bsau $key" is fed with the contents to be1484 signed, and the program is expected to send the result to its1485 standard output.14861487gui.commitMsgWidth::1488 Defines how wide the commit message window is in the1489 linkgit:git-gui[1]. "75" is the default.14901491gui.diffContext::1492 Specifies how many context lines should be used in calls to diff1493 made by the linkgit:git-gui[1]. The default is "5".14941495gui.displayUntracked::1496 Determines if linkgit::git-gui[1] shows untracked files1497 in the file list. The default is "true".14981499gui.encoding::1500 Specifies the default encoding to use for displaying of1501 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1502 It can be overridden by setting the 'encoding' attribute1503 for relevant files (see linkgit:gitattributes[5]).1504 If this option is not set, the tools default to the1505 locale encoding.15061507gui.matchTrackingBranch::1508 Determines if new branches created with linkgit:git-gui[1] should1509 default to tracking remote branches with matching names or1510 not. Default: "false".15111512gui.newBranchTemplate::1513 Is used as suggested name when creating new branches using the1514 linkgit:git-gui[1].15151516gui.pruneDuringFetch::1517 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1518 performing a fetch. The default value is "false".15191520gui.trustmtime::1521 Determines if linkgit:git-gui[1] should trust the file modification1522 timestamp or not. By default the timestamps are not trusted.15231524gui.spellingDictionary::1525 Specifies the dictionary used for spell checking commit messages in1526 the linkgit:git-gui[1]. When set to "none" spell checking is turned1527 off.15281529gui.fastCopyBlame::1530 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1531 location detection. It makes blame significantly faster on huge1532 repositories at the expense of less thorough copy detection.15331534gui.copyBlameThreshold::1535 Specifies the threshold to use in 'git gui blame' original location1536 detection, measured in alphanumeric characters. See the1537 linkgit:git-blame[1] manual for more information on copy detection.15381539gui.blamehistoryctx::1540 Specifies the radius of history context in days to show in1541 linkgit:gitk[1] for the selected commit, when the `Show History1542 Context` menu item is invoked from 'git gui blame'. If this1543 variable is set to zero, the whole history is shown.15441545guitool.<name>.cmd::1546 Specifies the shell command line to execute when the corresponding item1547 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1548 mandatory for every tool. The command is executed from the root of1549 the working directory, and in the environment it receives the name of1550 the tool as 'GIT_GUITOOL', the name of the currently selected file as1551 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1552 the head is detached, 'CUR_BRANCH' is empty).15531554guitool.<name>.needsFile::1555 Run the tool only if a diff is selected in the GUI. It guarantees1556 that 'FILENAME' is not empty.15571558guitool.<name>.noConsole::1559 Run the command silently, without creating a window to display its1560 output.15611562guitool.<name>.noRescan::1563 Don't rescan the working directory for changes after the tool1564 finishes execution.15651566guitool.<name>.confirm::1567 Show a confirmation dialog before actually running the tool.15681569guitool.<name>.argPrompt::1570 Request a string argument from the user, and pass it to the tool1571 through the 'ARGS' environment variable. Since requesting an1572 argument implies confirmation, the 'confirm' option has no effect1573 if this is enabled. If the option is set to 'true', 'yes', or '1',1574 the dialog uses a built-in generic prompt; otherwise the exact1575 value of the variable is used.15761577guitool.<name>.revPrompt::1578 Request a single valid revision from the user, and set the1579 'REVISION' environment variable. In other aspects this option1580 is similar to 'argPrompt', and can be used together with it.15811582guitool.<name>.revUnmerged::1583 Show only unmerged branches in the 'revPrompt' subdialog.1584 This is useful for tools similar to merge or rebase, but not1585 for things like checkout or reset.15861587guitool.<name>.title::1588 Specifies the title to use for the prompt dialog. The default1589 is the tool name.15901591guitool.<name>.prompt::1592 Specifies the general prompt string to display at the top of1593 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1594 The default value includes the actual command.15951596help.browser::1597 Specify the browser that will be used to display help in the1598 'web' format. See linkgit:git-help[1].15991600help.format::1601 Override the default help format used by linkgit:git-help[1].1602 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1603 the default. 'web' and 'html' are the same.16041605help.autoCorrect::1606 Automatically correct and execute mistyped commands after1607 waiting for the given number of deciseconds (0.1 sec). If more1608 than one command can be deduced from the entered text, nothing1609 will be executed. If the value of this option is negative,1610 the corrected command will be executed immediately. If the1611 value is 0 - the command will be just shown but not executed.1612 This is the default.16131614help.htmlPath::1615 Specify the path where the HTML documentation resides. File system paths1616 and URLs are supported. HTML pages will be prefixed with this path when1617 help is displayed in the 'web' format. This defaults to the documentation1618 path of your Git installation.16191620http.proxy::1621 Override the HTTP proxy, normally configured using the 'http_proxy',1622 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1623 addition to the syntax understood by curl, it is possible to specify a1624 proxy string with a user name but no password, in which case git will1625 attempt to acquire one in the same way it does for other credentials. See1626 linkgit:gitcredentials[7] for more information. The syntax thus is1627 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1628 on a per-remote basis; see remote.<name>.proxy16291630http.proxyAuthMethod::1631 Set the method with which to authenticate against the HTTP proxy. This1632 only takes effect if the configured proxy string contains a user name part1633 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1634 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1635 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment1636 variable. Possible values are:1637+1638--1639* `anyauth` - Automatically pick a suitable authentication method. It is1640 assumed that the proxy answers an unauthenticated request with a 4071641 status code and one or more Proxy-authenticate headers with supported1642 authentication methods. This is the default.1643* `basic` - HTTP Basic authentication1644* `digest` - HTTP Digest authentication; this prevents the password from being1645 transmitted to the proxy in clear text1646* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1647 of `curl(1)`)1648* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1649--16501651http.emptyAuth::1652 Attempt authentication without seeking a username or password. This1653 can be used to attempt GSS-Negotiate authentication without specifying1654 a username in the URL, as libcurl normally requires a username for1655 authentication.16561657http.cookieFile::1658 File containing previously stored cookie lines which should be used1659 in the Git http session, if they match the server. The file format1660 of the file to read cookies from should be plain HTTP headers or1661 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1662 NOTE that the file specified with http.cookieFile is only used as1663 input unless http.saveCookies is set.16641665http.saveCookies::1666 If set, store cookies received during requests to the file specified by1667 http.cookieFile. Has no effect if http.cookieFile is unset.16681669http.sslVersion::1670 The SSL version to use when negotiating an SSL connection, if you1671 want to force the default. The available and default version1672 depend on whether libcurl was built against NSS or OpenSSL and the1673 particular configuration of the crypto library in use. Internally1674 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1675 documentation for more details on the format of this option and1676 for the ssl version supported. Actually the possible values of1677 this option are:16781679 - sslv21680 - sslv31681 - tlsv11682 - tlsv1.01683 - tlsv1.11684 - tlsv1.216851686+1687Can be overridden by the 'GIT_SSL_VERSION' environment variable.1688To force git to use libcurl's default ssl version and ignore any1689explicit http.sslversion option, set 'GIT_SSL_VERSION' to the1690empty string.16911692http.sslCipherList::1693 A list of SSL ciphers to use when negotiating an SSL connection.1694 The available ciphers depend on whether libcurl was built against1695 NSS or OpenSSL and the particular configuration of the crypto1696 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1697 option; see the libcurl documentation for more details on the format1698 of this list.1699+1700Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.1701To force git to use libcurl's default cipher list and ignore any1702explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the1703empty string.17041705http.sslVerify::1706 Whether to verify the SSL certificate when fetching or pushing1707 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1708 variable.17091710http.sslCert::1711 File containing the SSL certificate when fetching or pushing1712 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1713 variable.17141715http.sslKey::1716 File containing the SSL private key when fetching or pushing1717 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1718 variable.17191720http.sslCertPasswordProtected::1721 Enable Git's password prompt for the SSL certificate. Otherwise1722 OpenSSL will prompt the user, possibly many times, if the1723 certificate or private key is encrypted. Can be overridden by the1724 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.17251726http.sslCAInfo::1727 File containing the certificates to verify the peer with when1728 fetching or pushing over HTTPS. Can be overridden by the1729 'GIT_SSL_CAINFO' environment variable.17301731http.sslCAPath::1732 Path containing files with the CA certificates to verify the peer1733 with when fetching or pushing over HTTPS. Can be overridden1734 by the 'GIT_SSL_CAPATH' environment variable.17351736http.pinnedpubkey::1737 Public key of the https service. It may either be the filename of1738 a PEM or DER encoded public key file or a string starting with1739 'sha256//' followed by the base64 encoded sha256 hash of the1740 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1741 exit with an error if this option is set but not supported by1742 cURL.17431744http.sslTry::1745 Attempt to use AUTH SSL/TLS and encrypted data transfers1746 when connecting via regular FTP protocol. This might be needed1747 if the FTP server requires it for security reasons or you wish1748 to connect securely whenever remote FTP server supports it.1749 Default is false since it might trigger certificate verification1750 errors on misconfigured servers.17511752http.maxRequests::1753 How many HTTP requests to launch in parallel. Can be overridden1754 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.17551756http.minSessions::1757 The number of curl sessions (counted across slots) to be kept across1758 requests. They will not be ended with curl_easy_cleanup() until1759 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1760 value will be capped at 1. Defaults to 1.17611762http.postBuffer::1763 Maximum size in bytes of the buffer used by smart HTTP1764 transports when POSTing data to the remote system.1765 For requests larger than this buffer size, HTTP/1.1 and1766 Transfer-Encoding: chunked is used to avoid creating a1767 massive pack file locally. Default is 1 MiB, which is1768 sufficient for most requests.17691770http.lowSpeedLimit, http.lowSpeedTime::1771 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1772 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1773 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1774 'GIT_HTTP_LOW_SPEED_TIME' environment variables.17751776http.noEPSV::1777 A boolean which disables using of EPSV ftp command by curl.1778 This can helpful with some "poor" ftp servers which don't1779 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1780 environment variable. Default is false (curl will use EPSV).17811782http.userAgent::1783 The HTTP USER_AGENT string presented to an HTTP server. The default1784 value represents the version of the client Git such as git/1.7.1.1785 This option allows you to override this value to a more common value1786 such as Mozilla/4.0. This may be necessary, for instance, if1787 connecting through a firewall that restricts HTTP connections to a set1788 of common USER_AGENT strings (but not including those like git/1.7.1).1789 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.17901791http.<url>.*::1792 Any of the http.* options above can be applied selectively to some URLs.1793 For a config key to match a URL, each element of the config key is1794 compared to that of the URL, in the following order:1795+1796--1797. Scheme (e.g., `https` in `https://example.com/`). This field1798 must match exactly between the config key and the URL.17991800. Host/domain name (e.g., `example.com` in `https://example.com/`).1801 This field must match exactly between the config key and the URL.18021803. Port number (e.g., `8080` in `http://example.com:8080/`).1804 This field must match exactly between the config key and the URL.1805 Omitted port numbers are automatically converted to the correct1806 default for the scheme before matching.18071808. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1809 path field of the config key must match the path field of the URL1810 either exactly or as a prefix of slash-delimited path elements. This means1811 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1812 match on a slash (`/`) boundary. Longer matches take precedence (so a config1813 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1814 key with just path `foo/`).18151816. User name (e.g., `user` in `https://user@example.com/repo.git`). If1817 the config key has a user name it must match the user name in the1818 URL exactly. If the config key does not have a user name, that1819 config key will match a URL with any user name (including none),1820 but at a lower precedence than a config key with a user name.1821--1822+1823The list above is ordered by decreasing precedence; a URL that matches1824a config key's path is preferred to one that matches its user name. For example,1825if the URL is `https://user@example.com/foo/bar` a config key match of1826`https://example.com/foo` will be preferred over a config key match of1827`https://user@example.com`.1828+1829All URLs are normalized before attempting any matching (the password part,1830if embedded in the URL, is always ignored for matching purposes) so that1831equivalent URLs that are simply spelled differently will match properly.1832Environment variable settings always override any matches. The URLs that are1833matched against are those given directly to Git commands. This means any URLs1834visited as a result of a redirection do not participate in matching.18351836i18n.commitEncoding::1837 Character encoding the commit messages are stored in; Git itself1838 does not care per se, but this information is necessary e.g. when1839 importing commits from emails or in the gitk graphical history1840 browser (and possibly at other places in the future or in other1841 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.18421843i18n.logOutputEncoding::1844 Character encoding the commit messages are converted to when1845 running 'git log' and friends.18461847imap::1848 The configuration variables in the 'imap' section are described1849 in linkgit:git-imap-send[1].18501851index.version::1852 Specify the version with which new index files should be1853 initialized. This does not affect existing repositories.18541855init.templateDir::1856 Specify the directory from which templates will be copied.1857 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)18581859instaweb.browser::1860 Specify the program that will be used to browse your working1861 repository in gitweb. See linkgit:git-instaweb[1].18621863instaweb.httpd::1864 The HTTP daemon command-line to start gitweb on your working1865 repository. See linkgit:git-instaweb[1].18661867instaweb.local::1868 If true the web server started by linkgit:git-instaweb[1] will1869 be bound to the local IP (127.0.0.1).18701871instaweb.modulePath::1872 The default module path for linkgit:git-instaweb[1] to use1873 instead of /usr/lib/apache2/modules. Only used if httpd1874 is Apache.18751876instaweb.port::1877 The port number to bind the gitweb httpd to. See1878 linkgit:git-instaweb[1].18791880interactive.singleKey::1881 In interactive commands, allow the user to provide one-letter1882 input with a single key (i.e., without hitting enter).1883 Currently this is used by the `--patch` mode of1884 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1885 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1886 setting is silently ignored if portable keystroke input1887 is not available; requires the Perl module Term::ReadKey.18881889log.abbrevCommit::1890 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1891 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1892 override this option with `--no-abbrev-commit`.18931894log.date::1895 Set the default date-time mode for the 'log' command.1896 Setting a value for log.date is similar to using 'git log''s1897 `--date` option. See linkgit:git-log[1] for details.18981899log.decorate::1900 Print out the ref names of any commits that are shown by the log1901 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1902 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1903 specified, the full ref name (including prefix) will be printed.1904 This is the same as the log commands '--decorate' option.19051906log.follow::1907 If `true`, `git log` will act as if the `--follow` option was used when1908 a single <path> is given. This has the same limitations as `--follow`,1909 i.e. it cannot be used to follow multiple files and does not work well1910 on non-linear history.19111912log.showRoot::1913 If true, the initial commit will be shown as a big creation event.1914 This is equivalent to a diff against an empty tree.1915 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1916 normally hide the root commit will now show it. True by default.19171918log.mailmap::1919 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1920 linkgit:git-whatchanged[1] assume `--use-mailmap`.19211922mailinfo.scissors::1923 If true, makes linkgit:git-mailinfo[1] (and therefore1924 linkgit:git-am[1]) act by default as if the --scissors option1925 was provided on the command-line. When active, this features1926 removes everything from the message body before a scissors1927 line (i.e. consisting mainly of ">8", "8<" and "-").19281929mailmap.file::1930 The location of an augmenting mailmap file. The default1931 mailmap, located in the root of the repository, is loaded1932 first, then the mailmap file pointed to by this variable.1933 The location of the mailmap file may be in a repository1934 subdirectory, or somewhere outside of the repository itself.1935 See linkgit:git-shortlog[1] and linkgit:git-blame[1].19361937mailmap.blob::1938 Like `mailmap.file`, but consider the value as a reference to a1939 blob in the repository. If both `mailmap.file` and1940 `mailmap.blob` are given, both are parsed, with entries from1941 `mailmap.file` taking precedence. In a bare repository, this1942 defaults to `HEAD:.mailmap`. In a non-bare repository, it1943 defaults to empty.19441945man.viewer::1946 Specify the programs that may be used to display help in the1947 'man' format. See linkgit:git-help[1].19481949man.<tool>.cmd::1950 Specify the command to invoke the specified man viewer. The1951 specified command is evaluated in shell with the man page1952 passed as argument. (See linkgit:git-help[1].)19531954man.<tool>.path::1955 Override the path for the given tool that may be used to1956 display help in the 'man' format. See linkgit:git-help[1].19571958include::merge-config.txt[]19591960mergetool.<tool>.path::1961 Override the path for the given tool. This is useful in case1962 your tool is not in the PATH.19631964mergetool.<tool>.cmd::1965 Specify the command to invoke the specified merge tool. The1966 specified command is evaluated in shell with the following1967 variables available: 'BASE' is the name of a temporary file1968 containing the common base of the files to be merged, if available;1969 'LOCAL' is the name of a temporary file containing the contents of1970 the file on the current branch; 'REMOTE' is the name of a temporary1971 file containing the contents of the file from the branch being1972 merged; 'MERGED' contains the name of the file to which the merge1973 tool should write the results of a successful merge.19741975mergetool.<tool>.trustExitCode::1976 For a custom merge command, specify whether the exit code of1977 the merge command can be used to determine whether the merge was1978 successful. If this is not set to true then the merge target file1979 timestamp is checked and the merge assumed to have been successful1980 if the file has been updated, otherwise the user is prompted to1981 indicate the success of the merge.19821983mergetool.meld.hasOutput::1984 Older versions of `meld` do not support the `--output` option.1985 Git will attempt to detect whether `meld` supports `--output`1986 by inspecting the output of `meld --help`. Configuring1987 `mergetool.meld.hasOutput` will make Git skip these checks and1988 use the configured value instead. Setting `mergetool.meld.hasOutput`1989 to `true` tells Git to unconditionally use the `--output` option,1990 and `false` avoids using `--output`.19911992mergetool.keepBackup::1993 After performing a merge, the original file with conflict markers1994 can be saved as a file with a `.orig` extension. If this variable1995 is set to `false` then this file is not preserved. Defaults to1996 `true` (i.e. keep the backup files).19971998mergetool.keepTemporaries::1999 When invoking a custom merge tool, Git uses a set of temporary2000 files to pass to the tool. If the tool returns an error and this2001 variable is set to `true`, then these temporary files will be2002 preserved, otherwise they will be removed after the tool has2003 exited. Defaults to `false`.20042005mergetool.writeToTemp::2006 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2007 conflicting files in the worktree by default. Git will attempt2008 to use a temporary directory for these files when set `true`.2009 Defaults to `false`.20102011mergetool.prompt::2012 Prompt before each invocation of the merge resolution program.20132014notes.mergeStrategy::2015 Which merge strategy to choose by default when resolving notes2016 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2017 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2018 section of linkgit:git-notes[1] for more information on each strategy.20192020notes.<name>.mergeStrategy::2021 Which merge strategy to choose when doing a notes merge into2022 refs/notes/<name>. This overrides the more general2023 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2024 linkgit:git-notes[1] for more information on the available strategies.20252026notes.displayRef::2027 The (fully qualified) refname from which to show notes when2028 showing commit messages. The value of this variable can be set2029 to a glob, in which case notes from all matching refs will be2030 shown. You may also specify this configuration variable2031 several times. A warning will be issued for refs that do not2032 exist, but a glob that does not match any refs is silently2033 ignored.2034+2035This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2036environment variable, which must be a colon separated list of refs or2037globs.2038+2039The effective value of "core.notesRef" (possibly overridden by2040GIT_NOTES_REF) is also implicitly added to the list of refs to be2041displayed.20422043notes.rewrite.<command>::2044 When rewriting commits with <command> (currently `amend` or2045 `rebase`) and this variable is set to `true`, Git2046 automatically copies your notes from the original to the2047 rewritten commit. Defaults to `true`, but see2048 "notes.rewriteRef" below.20492050notes.rewriteMode::2051 When copying notes during a rewrite (see the2052 "notes.rewrite.<command>" option), determines what to do if2053 the target commit already has a note. Must be one of2054 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2055 Defaults to `concatenate`.2056+2057This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2058environment variable.20592060notes.rewriteRef::2061 When copying notes during a rewrite, specifies the (fully2062 qualified) ref whose notes should be copied. The ref may be a2063 glob, in which case notes in all matching refs will be copied.2064 You may also specify this configuration several times.2065+2066Does not have a default value; you must configure this variable to2067enable note rewriting. Set it to `refs/notes/commits` to enable2068rewriting for the default commit notes.2069+2070This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2071environment variable, which must be a colon separated list of refs or2072globs.20732074pack.window::2075 The size of the window used by linkgit:git-pack-objects[1] when no2076 window size is given on the command line. Defaults to 10.20772078pack.depth::2079 The maximum delta depth used by linkgit:git-pack-objects[1] when no2080 maximum depth is given on the command line. Defaults to 50.20812082pack.windowMemory::2083 The maximum size of memory that is consumed by each thread2084 in linkgit:git-pack-objects[1] for pack window memory when2085 no limit is given on the command line. The value can be2086 suffixed with "k", "m", or "g". When left unconfigured (or2087 set explicitly to 0), there will be no limit.20882089pack.compression::2090 An integer -1..9, indicating the compression level for objects2091 in a pack file. -1 is the zlib default. 0 means no2092 compression, and 1..9 are various speed/size tradeoffs, 9 being2093 slowest. If not set, defaults to core.compression. If that is2094 not set, defaults to -1, the zlib default, which is "a default2095 compromise between speed and compression (currently equivalent2096 to level 6)."2097+2098Note that changing the compression level will not automatically recompress2099all existing objects. You can force recompression by passing the -F option2100to linkgit:git-repack[1].21012102pack.deltaCacheSize::2103 The maximum memory in bytes used for caching deltas in2104 linkgit:git-pack-objects[1] before writing them out to a pack.2105 This cache is used to speed up the writing object phase by not2106 having to recompute the final delta result once the best match2107 for all objects is found. Repacking large repositories on machines2108 which are tight with memory might be badly impacted by this though,2109 especially if this cache pushes the system into swapping.2110 A value of 0 means no limit. The smallest size of 1 byte may be2111 used to virtually disable this cache. Defaults to 256 MiB.21122113pack.deltaCacheLimit::2114 The maximum size of a delta, that is cached in2115 linkgit:git-pack-objects[1]. This cache is used to speed up the2116 writing object phase by not having to recompute the final delta2117 result once the best match for all objects is found. Defaults to 1000.21182119pack.threads::2120 Specifies the number of threads to spawn when searching for best2121 delta matches. This requires that linkgit:git-pack-objects[1]2122 be compiled with pthreads otherwise this option is ignored with a2123 warning. This is meant to reduce packing time on multiprocessor2124 machines. The required amount of memory for the delta search window2125 is however multiplied by the number of threads.2126 Specifying 0 will cause Git to auto-detect the number of CPU's2127 and set the number of threads accordingly.21282129pack.indexVersion::2130 Specify the default pack index version. Valid values are 1 for2131 legacy pack index used by Git versions prior to 1.5.2, and 2 for2132 the new pack index with capabilities for packs larger than 4 GB2133 as well as proper protection against the repacking of corrupted2134 packs. Version 2 is the default. Note that version 2 is enforced2135 and this config option ignored whenever the corresponding pack is2136 larger than 2 GB.2137+2138If you have an old Git that does not understand the version 2 `*.idx` file,2139cloning or fetching over a non native protocol (e.g. "http")2140that will copy both `*.pack` file and corresponding `*.idx` file from the2141other side may give you a repository that cannot be accessed with your2142older version of Git. If the `*.pack` file is smaller than 2 GB, however,2143you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2144the `*.idx` file.21452146pack.packSizeLimit::2147 The maximum size of a pack. This setting only affects2148 packing to a file when repacking, i.e. the git:// protocol2149 is unaffected. It can be overridden by the `--max-pack-size`2150 option of linkgit:git-repack[1]. The minimum size allowed is2151 limited to 1 MiB. The default is unlimited.2152 Common unit suffixes of 'k', 'm', or 'g' are2153 supported.21542155pack.useBitmaps::2156 When true, git will use pack bitmaps (if available) when packing2157 to stdout (e.g., during the server side of a fetch). Defaults to2158 true. You should not generally need to turn this off unless2159 you are debugging pack bitmaps.21602161pack.writeBitmaps (deprecated)::2162 This is a deprecated synonym for `repack.writeBitmaps`.21632164pack.writeBitmapHashCache::2165 When true, git will include a "hash cache" section in the bitmap2166 index (if one is written). This cache can be used to feed git's2167 delta heuristics, potentially leading to better deltas between2168 bitmapped and non-bitmapped objects (e.g., when serving a fetch2169 between an older, bitmapped pack and objects that have been2170 pushed since the last gc). The downside is that it consumes 42171 bytes per object of disk space, and that JGit's bitmap2172 implementation does not understand it, causing it to complain if2173 Git and JGit are used on the same repository. Defaults to false.21742175pager.<cmd>::2176 If the value is boolean, turns on or off pagination of the2177 output of a particular Git subcommand when writing to a tty.2178 Otherwise, turns on pagination for the subcommand using the2179 pager specified by the value of `pager.<cmd>`. If `--paginate`2180 or `--no-pager` is specified on the command line, it takes2181 precedence over this option. To disable pagination for all2182 commands, set `core.pager` or `GIT_PAGER` to `cat`.21832184pretty.<name>::2185 Alias for a --pretty= format string, as specified in2186 linkgit:git-log[1]. Any aliases defined here can be used just2187 as the built-in pretty formats could. For example,2188 running `git config pretty.changelog "format:* %H %s"`2189 would cause the invocation `git log --pretty=changelog`2190 to be equivalent to running `git log "--pretty=format:* %H %s"`.2191 Note that an alias with the same name as a built-in format2192 will be silently ignored.21932194pull.ff::2195 By default, Git does not create an extra merge commit when merging2196 a commit that is a descendant of the current commit. Instead, the2197 tip of the current branch is fast-forwarded. When set to `false`,2198 this variable tells Git to create an extra merge commit in such2199 a case (equivalent to giving the `--no-ff` option from the command2200 line). When set to `only`, only such fast-forward merges are2201 allowed (equivalent to giving the `--ff-only` option from the2202 command line). This setting overrides `merge.ff` when pulling.22032204pull.rebase::2205 When true, rebase branches on top of the fetched branch, instead2206 of merging the default branch from the default remote when "git2207 pull" is run. See "branch.<name>.rebase" for setting this on a2208 per-branch basis.2209+2210When preserve, also pass `--preserve-merges` along to 'git rebase'2211so that locally committed merge commits will not be flattened2212by running 'git pull'.2213+2214When the value is `interactive`, the rebase is run in interactive mode.2215+2216*NOTE*: this is a possibly dangerous operation; do *not* use2217it unless you understand the implications (see linkgit:git-rebase[1]2218for details).22192220pull.octopus::2221 The default merge strategy to use when pulling multiple branches2222 at once.22232224pull.twohead::2225 The default merge strategy to use when pulling a single branch.22262227push.default::2228 Defines the action `git push` should take if no refspec is2229 explicitly given. Different values are well-suited for2230 specific workflows; for instance, in a purely central workflow2231 (i.e. the fetch source is equal to the push destination),2232 `upstream` is probably what you want. Possible values are:2233+2234--22352236* `nothing` - do not push anything (error out) unless a refspec is2237 explicitly given. This is primarily meant for people who want to2238 avoid mistakes by always being explicit.22392240* `current` - push the current branch to update a branch with the same2241 name on the receiving end. Works in both central and non-central2242 workflows.22432244* `upstream` - push the current branch back to the branch whose2245 changes are usually integrated into the current branch (which is2246 called `@{upstream}`). This mode only makes sense if you are2247 pushing to the same repository you would normally pull from2248 (i.e. central workflow).22492250* `simple` - in centralized workflow, work like `upstream` with an2251 added safety to refuse to push if the upstream branch's name is2252 different from the local one.2253+2254When pushing to a remote that is different from the remote you normally2255pull from, work as `current`. This is the safest option and is suited2256for beginners.2257+2258This mode has become the default in Git 2.0.22592260* `matching` - push all branches having the same name on both ends.2261 This makes the repository you are pushing to remember the set of2262 branches that will be pushed out (e.g. if you always push 'maint'2263 and 'master' there and no other branches, the repository you push2264 to will have these two branches, and your local 'maint' and2265 'master' will be pushed there).2266+2267To use this mode effectively, you have to make sure _all_ the2268branches you would push out are ready to be pushed out before2269running 'git push', as the whole point of this mode is to allow you2270to push all of the branches in one go. If you usually finish work2271on only one branch and push out the result, while other branches are2272unfinished, this mode is not for you. Also this mode is not2273suitable for pushing into a shared central repository, as other2274people may add new branches there, or update the tip of existing2275branches outside your control.2276+2277This used to be the default, but not since Git 2.0 (`simple` is the2278new default).22792280--22812282push.followTags::2283 If set to true enable '--follow-tags' option by default. You2284 may override this configuration at time of push by specifying2285 '--no-follow-tags'.22862287push.gpgSign::2288 May be set to a boolean value, or the string 'if-asked'. A true2289 value causes all pushes to be GPG signed, as if '--signed' is2290 passed to linkgit:git-push[1]. The string 'if-asked' causes2291 pushes to be signed if the server supports it, as if2292 '--signed=if-asked' is passed to 'git push'. A false value may2293 override a value from a lower-priority config file. An explicit2294 command-line flag always overrides this config option.22952296push.recurseSubmodules::2297 Make sure all submodule commits used by the revisions to be pushed2298 are available on a remote-tracking branch. If the value is 'check'2299 then Git will verify that all submodule commits that changed in the2300 revisions to be pushed are available on at least one remote of the2301 submodule. If any commits are missing, the push will be aborted and2302 exit with non-zero status. If the value is 'on-demand' then all2303 submodules that changed in the revisions to be pushed will be2304 pushed. If on-demand was not able to push all necessary revisions2305 it will also be aborted and exit with non-zero status. If the value2306 is 'no' then default behavior of ignoring submodules when pushing2307 is retained. You may override this configuration at time of push by2308 specifying '--recurse-submodules=check|on-demand|no'.23092310rebase.stat::2311 Whether to show a diffstat of what changed upstream since the last2312 rebase. False by default.23132314rebase.autoSquash::2315 If set to true enable '--autosquash' option by default.23162317rebase.autoStash::2318 When set to true, automatically create a temporary stash2319 before the operation begins, and apply it after the operation2320 ends. This means that you can run rebase on a dirty worktree.2321 However, use with care: the final stash application after a2322 successful rebase might result in non-trivial conflicts.2323 Defaults to false.23242325rebase.missingCommitsCheck::2326 If set to "warn", git rebase -i will print a warning if some2327 commits are removed (e.g. a line was deleted), however the2328 rebase will still proceed. If set to "error", it will print2329 the previous warning and stop the rebase, 'git rebase2330 --edit-todo' can then be used to correct the error. If set to2331 "ignore", no checking is done.2332 To drop a commit without warning or error, use the `drop`2333 command in the todo-list.2334 Defaults to "ignore".23352336rebase.instructionFormat2337 A format string, as specified in linkgit:git-log[1], to be used for2338 the instruction list during an interactive rebase. The format will automatically2339 have the long commit hash prepended to the format.23402341receive.advertiseAtomic::2342 By default, git-receive-pack will advertise the atomic push2343 capability to its clients. If you don't want to this capability2344 to be advertised, set this variable to false.23452346receive.autogc::2347 By default, git-receive-pack will run "git-gc --auto" after2348 receiving data from git-push and updating refs. You can stop2349 it by setting this variable to false.23502351receive.certNonceSeed::2352 By setting this variable to a string, `git receive-pack`2353 will accept a `git push --signed` and verifies it by using2354 a "nonce" protected by HMAC using this string as a secret2355 key.23562357receive.certNonceSlop::2358 When a `git push --signed` sent a push certificate with a2359 "nonce" that was issued by a receive-pack serving the same2360 repository within this many seconds, export the "nonce"2361 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2362 hooks (instead of what the receive-pack asked the sending2363 side to include). This may allow writing checks in2364 `pre-receive` and `post-receive` a bit easier. Instead of2365 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2366 that records by how many seconds the nonce is stale to2367 decide if they want to accept the certificate, they only2368 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.23692370receive.fsckObjects::2371 If it is set to true, git-receive-pack will check all received2372 objects. It will abort in the case of a malformed object or a2373 broken link. The result of an abort are only dangling objects.2374 Defaults to false. If not set, the value of `transfer.fsckObjects`2375 is used instead.23762377receive.fsck.<msg-id>::2378 When `receive.fsckObjects` is set to true, errors can be switched2379 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2380 setting where the `<msg-id>` is the fsck message ID and the value2381 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2382 the error/warning with the message ID, e.g. "missingEmail: invalid2383 author/committer line - missing email" means that setting2384 `receive.fsck.missingEmail = ignore` will hide that issue.2385+2386This feature is intended to support working with legacy repositories2387which would not pass pushing when `receive.fsckObjects = true`, allowing2388the host to accept repositories with certain known issues but still catch2389other issues.23902391receive.fsck.skipList::2392 The path to a sorted list of object names (i.e. one SHA-1 per2393 line) that are known to be broken in a non-fatal way and should2394 be ignored. This feature is useful when an established project2395 should be accepted despite early commits containing errors that2396 can be safely ignored such as invalid committer email addresses.2397 Note: corrupt objects cannot be skipped with this setting.23982399receive.unpackLimit::2400 If the number of objects received in a push is below this2401 limit then the objects will be unpacked into loose object2402 files. However if the number of received objects equals or2403 exceeds this limit then the received pack will be stored as2404 a pack, after adding any missing delta bases. Storing the2405 pack from a push can make the push operation complete faster,2406 especially on slow filesystems. If not set, the value of2407 `transfer.unpackLimit` is used instead.24082409receive.denyDeletes::2410 If set to true, git-receive-pack will deny a ref update that deletes2411 the ref. Use this to prevent such a ref deletion via a push.24122413receive.denyDeleteCurrent::2414 If set to true, git-receive-pack will deny a ref update that2415 deletes the currently checked out branch of a non-bare repository.24162417receive.denyCurrentBranch::2418 If set to true or "refuse", git-receive-pack will deny a ref update2419 to the currently checked out branch of a non-bare repository.2420 Such a push is potentially dangerous because it brings the HEAD2421 out of sync with the index and working tree. If set to "warn",2422 print a warning of such a push to stderr, but allow the push to2423 proceed. If set to false or "ignore", allow such pushes with no2424 message. Defaults to "refuse".2425+2426Another option is "updateInstead" which will update the working2427tree if pushing into the current branch. This option is2428intended for synchronizing working directories when one side is not easily2429accessible via interactive ssh (e.g. a live web site, hence the requirement2430that the working directory be clean). This mode also comes in handy when2431developing inside a VM to test and fix code on different Operating Systems.2432+2433By default, "updateInstead" will refuse the push if the working tree or2434the index have any difference from the HEAD, but the `push-to-checkout`2435hook can be used to customize this. See linkgit:githooks[5].24362437receive.denyNonFastForwards::2438 If set to true, git-receive-pack will deny a ref update which is2439 not a fast-forward. Use this to prevent such an update via a push,2440 even if that push is forced. This configuration variable is2441 set when initializing a shared repository.24422443receive.hideRefs::2444 This variable is the same as `transfer.hideRefs`, but applies2445 only to `receive-pack` (and so affects pushes, but not fetches).2446 An attempt to update or delete a hidden ref by `git push` is2447 rejected.24482449receive.updateServerInfo::2450 If set to true, git-receive-pack will run git-update-server-info2451 after receiving data from git-push and updating refs.24522453receive.shallowUpdate::2454 If set to true, .git/shallow can be updated when new refs2455 require new shallow roots. Otherwise those refs are rejected.24562457remote.pushDefault::2458 The remote to push to by default. Overrides2459 `branch.<name>.remote` for all branches, and is overridden by2460 `branch.<name>.pushRemote` for specific branches.24612462remote.<name>.url::2463 The URL of a remote repository. See linkgit:git-fetch[1] or2464 linkgit:git-push[1].24652466remote.<name>.pushurl::2467 The push URL of a remote repository. See linkgit:git-push[1].24682469remote.<name>.proxy::2470 For remotes that require curl (http, https and ftp), the URL to2471 the proxy to use for that remote. Set to the empty string to2472 disable proxying for that remote.24732474remote.<name>.proxyAuthMethod::2475 For remotes that require curl (http, https and ftp), the method to use for2476 authenticating against the proxy in use (probably set in2477 `remote.<name>.proxy`). See `http.proxyAuthMethod`.24782479remote.<name>.fetch::2480 The default set of "refspec" for linkgit:git-fetch[1]. See2481 linkgit:git-fetch[1].24822483remote.<name>.push::2484 The default set of "refspec" for linkgit:git-push[1]. See2485 linkgit:git-push[1].24862487remote.<name>.mirror::2488 If true, pushing to this remote will automatically behave2489 as if the `--mirror` option was given on the command line.24902491remote.<name>.skipDefaultUpdate::2492 If true, this remote will be skipped by default when updating2493 using linkgit:git-fetch[1] or the `update` subcommand of2494 linkgit:git-remote[1].24952496remote.<name>.skipFetchAll::2497 If true, this remote will be skipped by default when updating2498 using linkgit:git-fetch[1] or the `update` subcommand of2499 linkgit:git-remote[1].25002501remote.<name>.receivepack::2502 The default program to execute on the remote side when pushing. See2503 option --receive-pack of linkgit:git-push[1].25042505remote.<name>.uploadpack::2506 The default program to execute on the remote side when fetching. See2507 option --upload-pack of linkgit:git-fetch-pack[1].25082509remote.<name>.tagOpt::2510 Setting this value to --no-tags disables automatic tag following when2511 fetching from remote <name>. Setting it to --tags will fetch every2512 tag from remote <name>, even if they are not reachable from remote2513 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2514 override this setting. See options --tags and --no-tags of2515 linkgit:git-fetch[1].25162517remote.<name>.vcs::2518 Setting this to a value <vcs> will cause Git to interact with2519 the remote with the git-remote-<vcs> helper.25202521remote.<name>.prune::2522 When set to true, fetching from this remote by default will also2523 remove any remote-tracking references that no longer exist on the2524 remote (as if the `--prune` option was given on the command line).2525 Overrides `fetch.prune` settings, if any.25262527remotes.<group>::2528 The list of remotes which are fetched by "git remote update2529 <group>". See linkgit:git-remote[1].25302531repack.useDeltaBaseOffset::2532 By default, linkgit:git-repack[1] creates packs that use2533 delta-base offset. If you need to share your repository with2534 Git older than version 1.4.4, either directly or via a dumb2535 protocol such as http, then you need to set this option to2536 "false" and repack. Access from old Git versions over the2537 native protocol are unaffected by this option.25382539repack.packKeptObjects::2540 If set to true, makes `git repack` act as if2541 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2542 details. Defaults to `false` normally, but `true` if a bitmap2543 index is being written (either via `--write-bitmap-index` or2544 `repack.writeBitmaps`).25452546repack.writeBitmaps::2547 When true, git will write a bitmap index when packing all2548 objects to disk (e.g., when `git repack -a` is run). This2549 index can speed up the "counting objects" phase of subsequent2550 packs created for clones and fetches, at the cost of some disk2551 space and extra time spent on the initial repack. Defaults to2552 false.25532554rerere.autoUpdate::2555 When set to true, `git-rerere` updates the index with the2556 resulting contents after it cleanly resolves conflicts using2557 previously recorded resolution. Defaults to false.25582559rerere.enabled::2560 Activate recording of resolved conflicts, so that identical2561 conflict hunks can be resolved automatically, should they be2562 encountered again. By default, linkgit:git-rerere[1] is2563 enabled if there is an `rr-cache` directory under the2564 `$GIT_DIR`, e.g. if "rerere" was previously used in the2565 repository.25662567sendemail.identity::2568 A configuration identity. When given, causes values in the2569 'sendemail.<identity>' subsection to take precedence over2570 values in the 'sendemail' section. The default identity is2571 the value of 'sendemail.identity'.25722573sendemail.smtpEncryption::2574 See linkgit:git-send-email[1] for description. Note that this2575 setting is not subject to the 'identity' mechanism.25762577sendemail.smtpssl (deprecated)::2578 Deprecated alias for 'sendemail.smtpEncryption = ssl'.25792580sendemail.smtpsslcertpath::2581 Path to ca-certificates (either a directory or a single file).2582 Set it to an empty string to disable certificate verification.25832584sendemail.<identity>.*::2585 Identity-specific versions of the 'sendemail.*' parameters2586 found below, taking precedence over those when the this2587 identity is selected, through command-line or2588 'sendemail.identity'.25892590sendemail.aliasesFile::2591sendemail.aliasFileType::2592sendemail.annotate::2593sendemail.bcc::2594sendemail.cc::2595sendemail.ccCmd::2596sendemail.chainReplyTo::2597sendemail.confirm::2598sendemail.envelopeSender::2599sendemail.from::2600sendemail.multiEdit::2601sendemail.signedoffbycc::2602sendemail.smtpPass::2603sendemail.suppresscc::2604sendemail.suppressFrom::2605sendemail.to::2606sendemail.smtpDomain::2607sendemail.smtpServer::2608sendemail.smtpServerPort::2609sendemail.smtpServerOption::2610sendemail.smtpUser::2611sendemail.thread::2612sendemail.transferEncoding::2613sendemail.validate::2614sendemail.xmailer::2615 See linkgit:git-send-email[1] for description.26162617sendemail.signedoffcc (deprecated)::2618 Deprecated alias for 'sendemail.signedoffbycc'.26192620showbranch.default::2621 The default set of branches for linkgit:git-show-branch[1].2622 See linkgit:git-show-branch[1].26232624status.relativePaths::2625 By default, linkgit:git-status[1] shows paths relative to the2626 current directory. Setting this variable to `false` shows paths2627 relative to the repository root (this was the default for Git2628 prior to v1.5.4).26292630status.short::2631 Set to true to enable --short by default in linkgit:git-status[1].2632 The option --no-short takes precedence over this variable.26332634status.branch::2635 Set to true to enable --branch by default in linkgit:git-status[1].2636 The option --no-branch takes precedence over this variable.26372638status.displayCommentPrefix::2639 If set to true, linkgit:git-status[1] will insert a comment2640 prefix before each output line (starting with2641 `core.commentChar`, i.e. `#` by default). This was the2642 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2643 Defaults to false.26442645status.showUntrackedFiles::2646 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2647 files which are not currently tracked by Git. Directories which2648 contain only untracked files, are shown with the directory name2649 only. Showing untracked files means that Git needs to lstat() all2650 the files in the whole repository, which might be slow on some2651 systems. So, this variable controls how the commands displays2652 the untracked files. Possible values are:2653+2654--2655* `no` - Show no untracked files.2656* `normal` - Show untracked files and directories.2657* `all` - Show also individual files in untracked directories.2658--2659+2660If this variable is not specified, it defaults to 'normal'.2661This variable can be overridden with the -u|--untracked-files option2662of linkgit:git-status[1] and linkgit:git-commit[1].26632664status.submoduleSummary::2665 Defaults to false.2666 If this is set to a non zero number or true (identical to -1 or an2667 unlimited number), the submodule summary will be enabled and a2668 summary of commits for modified submodules will be shown (see2669 --summary-limit option of linkgit:git-submodule[1]). Please note2670 that the summary output command will be suppressed for all2671 submodules when `diff.ignoreSubmodules` is set to 'all' or only2672 for those submodules where `submodule.<name>.ignore=all`. The only2673 exception to that rule is that status and commit will show staged2674 submodule changes. To2675 also view the summary for ignored submodules you can either use2676 the --ignore-submodules=dirty command-line option or the 'git2677 submodule summary' command, which shows a similar output but does2678 not honor these settings.26792680stash.showPatch::2681 If this is set to true, the `git stash show` command without an2682 option will show the stash in patch form. Defaults to false.2683 See description of 'show' command in linkgit:git-stash[1].26842685stash.showStat::2686 If this is set to true, the `git stash show` command without an2687 option will show diffstat of the stash. Defaults to true.2688 See description of 'show' command in linkgit:git-stash[1].26892690submodule.<name>.path::2691submodule.<name>.url::2692 The path within this project and URL for a submodule. These2693 variables are initially populated by 'git submodule init'. See2694 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2695 details.26962697submodule.<name>.update::2698 The default update procedure for a submodule. This variable2699 is populated by `git submodule init` from the2700 linkgit:gitmodules[5] file. See description of 'update'2701 command in linkgit:git-submodule[1].27022703submodule.<name>.branch::2704 The remote branch name for a submodule, used by `git submodule2705 update --remote`. Set this option to override the value found in2706 the `.gitmodules` file. See linkgit:git-submodule[1] and2707 linkgit:gitmodules[5] for details.27082709submodule.<name>.fetchRecurseSubmodules::2710 This option can be used to control recursive fetching of this2711 submodule. It can be overridden by using the --[no-]recurse-submodules2712 command-line option to "git fetch" and "git pull".2713 This setting will override that from in the linkgit:gitmodules[5]2714 file.27152716submodule.<name>.ignore::2717 Defines under what circumstances "git status" and the diff family show2718 a submodule as modified. When set to "all", it will never be considered2719 modified (but it will nonetheless show up in the output of status and2720 commit when it has been staged), "dirty" will ignore all changes2721 to the submodules work tree and2722 takes only differences between the HEAD of the submodule and the commit2723 recorded in the superproject into account. "untracked" will additionally2724 let submodules with modified tracked files in their work tree show up.2725 Using "none" (the default when this option is not set) also shows2726 submodules that have untracked files in their work tree as changed.2727 This setting overrides any setting made in .gitmodules for this submodule,2728 both settings can be overridden on the command line by using the2729 "--ignore-submodules" option. The 'git submodule' commands are not2730 affected by this setting.27312732tag.sort::2733 This variable controls the sort ordering of tags when displayed by2734 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2735 value of this variable will be used as the default.27362737tar.umask::2738 This variable can be used to restrict the permission bits of2739 tar archive entries. The default is 0002, which turns off the2740 world write bit. The special value "user" indicates that the2741 archiving user's umask will be used instead. See umask(2) and2742 linkgit:git-archive[1].27432744transfer.fsckObjects::2745 When `fetch.fsckObjects` or `receive.fsckObjects` are2746 not set, the value of this variable is used instead.2747 Defaults to false.27482749transfer.hideRefs::2750 String(s) `receive-pack` and `upload-pack` use to decide which2751 refs to omit from their initial advertisements. Use more than2752 one definition to specify multiple prefix strings. A ref that is2753 under the hierarchies listed in the value of this variable is2754 excluded, and is hidden when responding to `git push` or `git2755 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2756 program-specific versions of this config.2757+2758You may also include a `!` in front of the ref name to negate the entry,2759explicitly exposing it, even if an earlier entry marked it as hidden.2760If you have multiple hideRefs values, later entries override earlier ones2761(and entries in more-specific config files override less-specific ones).2762+2763If a namespace is in use, the namespace prefix is stripped from each2764reference before it is matched against `transfer.hiderefs` patterns.2765For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2766the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2767is omitted from the advertisements but `refs/heads/master` and2768`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2769"have" lines. In order to match refs before stripping, add a `^` in front of2770the ref name. If you combine `!` and `^`, `!` must be specified first.27712772transfer.unpackLimit::2773 When `fetch.unpackLimit` or `receive.unpackLimit` are2774 not set, the value of this variable is used instead.2775 The default value is 100.27762777uploadarchive.allowUnreachable::2778 If true, allow clients to use `git archive --remote` to request2779 any tree, whether reachable from the ref tips or not. See the2780 discussion in the `SECURITY` section of2781 linkgit:git-upload-archive[1] for more details. Defaults to2782 `false`.27832784uploadpack.hideRefs::2785 This variable is the same as `transfer.hideRefs`, but applies2786 only to `upload-pack` (and so affects only fetches, not pushes).2787 An attempt to fetch a hidden ref by `git fetch` will fail. See2788 also `uploadpack.allowTipSHA1InWant`.27892790uploadpack.allowTipSHA1InWant::2791 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2792 to accept a fetch request that asks for an object at the tip2793 of a hidden ref (by default, such a request is rejected).2794 see also `uploadpack.hideRefs`.27952796uploadpack.allowReachableSHA1InWant::2797 Allow `upload-pack` to accept a fetch request that asks for an2798 object that is reachable from any ref tip. However, note that2799 calculating object reachability is computationally expensive.2800 Defaults to `false`.28012802uploadpack.keepAlive::2803 When `upload-pack` has started `pack-objects`, there may be a2804 quiet period while `pack-objects` prepares the pack. Normally2805 it would output progress information, but if `--quiet` was used2806 for the fetch, `pack-objects` will output nothing at all until2807 the pack data begins. Some clients and networks may consider2808 the server to be hung and give up. Setting this option instructs2809 `upload-pack` to send an empty keepalive packet every2810 `uploadpack.keepAlive` seconds. Setting this option to 02811 disables keepalive packets entirely. The default is 5 seconds.28122813url.<base>.insteadOf::2814 Any URL that starts with this value will be rewritten to2815 start, instead, with <base>. In cases where some site serves a2816 large number of repositories, and serves them with multiple2817 access methods, and some users need to use different access2818 methods, this feature allows people to specify any of the2819 equivalent URLs and have Git automatically rewrite the URL to2820 the best alternative for the particular user, even for a2821 never-before-seen repository on the site. When more than one2822 insteadOf strings match a given URL, the longest match is used.28232824url.<base>.pushInsteadOf::2825 Any URL that starts with this value will not be pushed to;2826 instead, it will be rewritten to start with <base>, and the2827 resulting URL will be pushed to. In cases where some site serves2828 a large number of repositories, and serves them with multiple2829 access methods, some of which do not allow push, this feature2830 allows people to specify a pull-only URL and have Git2831 automatically use an appropriate URL to push, even for a2832 never-before-seen repository on the site. When more than one2833 pushInsteadOf strings match a given URL, the longest match is2834 used. If a remote has an explicit pushurl, Git will ignore this2835 setting for that remote.28362837user.email::2838 Your email address to be recorded in any newly created commits.2839 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2840 'EMAIL' environment variables. See linkgit:git-commit-tree[1].28412842user.name::2843 Your full name to be recorded in any newly created commits.2844 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2845 environment variables. See linkgit:git-commit-tree[1].28462847user.useConfigOnly::2848 Instruct Git to avoid trying to guess defaults for 'user.email'2849 and 'user.name', and instead retrieve the values only from the2850 configuration. For example, if you have multiple email addresses2851 and would like to use a different one for each repository, then2852 with this configuration option set to `true` in the global config2853 along with a name, Git will prompt you to set up an email before2854 making new commits in a newly cloned repository.2855 Defaults to `false`.28562857user.signingKey::2858 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2859 key you want it to automatically when creating a signed tag or2860 commit, you can override the default selection with this variable.2861 This option is passed unchanged to gpg's --local-user parameter,2862 so you may specify a key using any method that gpg supports.28632864versionsort.prereleaseSuffix::2865 When version sort is used in linkgit:git-tag[1], prerelease2866 tags (e.g. "1.0-rc1") may appear after the main release2867 "1.0". By specifying the suffix "-rc" in this variable,2868 "1.0-rc1" will appear before "1.0".2869+2870This variable can be specified multiple times, once per suffix. The2871order of suffixes in the config file determines the sorting order2872(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2873is sorted before 1.0-rcXX). The sorting order between different2874suffixes is undefined if they are in multiple config files.28752876web.browser::2877 Specify a web browser that may be used by some commands.2878 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2879 may use it.