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 84variable takes a pathname as its value, and is subject to tilde 85expansion. 86 87The 88included file is expanded immediately, as if its contents had been 89found at the location of the include directive. If the value of the 90`include.path` variable is a relative path, the path is considered to be 91relative to the configuration file in which the include directive was 92found. See below for examples. 93 94 95Example 96~~~~~~~ 97 98 # Core variables 99 [core] 100 ; Don't trust file modes 101 filemode = false 102 103 # Our diff algorithm 104 [diff] 105 external = /usr/local/bin/diff-wrapper 106 renames = true 107 108 [branch "devel"] 109 remote = origin 110 merge = refs/heads/devel 111 112 # Proxy settings 113 [core] 114 gitProxy="ssh" for "kernel.org" 115 gitProxy=default-proxy ; for the rest 116 117 [include] 118 path = /path/to/foo.inc ; include by absolute path 119 path = foo ; expand "foo" relative to the current file 120 path = ~/foo ; expand "foo" in your `$HOME` directory 121 122 123Values 124~~~~~~ 125 126Values of many variables are treated as a simple string, but there 127are variables that take values of specific types and there are rules 128as to how to spell them. 129 130boolean:: 131 132 When a variable is said to take a boolean value, many 133 synonyms are accepted for 'true' and 'false'; these are all 134 case-insensitive. 135 136 true;; Boolean true can be spelled as `yes`, `on`, `true`, 137 or `1`. Also, a variable defined without `= <value>` 138 is taken as true. 139 140 false;; Boolean false can be spelled as `no`, `off`, 141 `false`, or `0`. 142+ 143When converting value to the canonical form using '--bool' type 144specifier; 'git config' will ensure that the output is "true" or 145"false" (spelled in lowercase). 146 147integer:: 148 The value for many variables that specify various sizes can 149 be suffixed with `k`, `M`,... to mean "scale the number by 150 1024", "by 1024x1024", etc. 151 152color:: 153 The value for a variables that takes a color is a list of 154 colors (at most two) and attributes (at most one), separated 155 by spaces. The colors accepted are `normal`, `black`, 156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and 157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and 158 `reverse`. The first color given is the foreground; the 159 second is the background. The position of the attribute, if 160 any, doesn't matter. Attributes may be turned off specifically 161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc). 162+ 163Colors (foreground and background) may also be given as numbers between 1640 and 255; these use ANSI 256-color mode (but note that not all 165terminals may support this). If your terminal supports it, you may also 166specify 24-bit RGB values as hex, like `#ff0ab3`. 167+ 168The attributes are meant to be reset at the beginning of each item 169in the colored output, so setting color.decorate.branch to `black` 170will paint that branch name in a plain `black`, even if the previous 171thing on the same output line (e.g. opening parenthesis before the 172list of branch names in `log --decorate` output) is set to be 173painted with `bold` or some other attribute. 174 175pathname:: 176 A variable that takes a pathname value can be given a 177 string that begins with "`~/`" or "`~user/`", and the usual 178 tilde expansion happens to such a string: `~/` 179 is expanded to the value of `$HOME`, and `~user/` to the 180 specified user's home directory. 181 182 183Variables 184~~~~~~~~~ 185 186Note that this list is non-comprehensive and not necessarily complete. 187For command-specific variables, you will find a more detailed description 188in the appropriate manual page. 189 190Other git-related tools may and do use their own variables. When 191inventing new variables for use in your own tool, make sure their 192names do not conflict with those that are used by Git itself and 193other popular tools, and describe them in your documentation. 194 195 196advice.*:: 197 These variables control various optional help messages designed to 198 aid new users. All 'advice.*' variables default to 'true', and you 199 can tell Git that you do not need help by setting these to 'false': 200+ 201-- 202 pushUpdateRejected:: 203 Set this variable to 'false' if you want to disable 204 'pushNonFFCurrent', 205 'pushNonFFMatching', 'pushAlreadyExists', 206 'pushFetchFirst', and 'pushNeedsForce' 207 simultaneously. 208 pushNonFFCurrent:: 209 Advice shown when linkgit:git-push[1] fails due to a 210 non-fast-forward update to the current branch. 211 pushNonFFMatching:: 212 Advice shown when you ran linkgit:git-push[1] and pushed 213 'matching refs' explicitly (i.e. you used ':', or 214 specified a refspec that isn't your current branch) and 215 it resulted in a non-fast-forward error. 216 pushAlreadyExists:: 217 Shown when linkgit:git-push[1] rejects an update that 218 does not qualify for fast-forwarding (e.g., a tag.) 219 pushFetchFirst:: 220 Shown when linkgit:git-push[1] rejects an update that 221 tries to overwrite a remote ref that points at an 222 object we do not have. 223 pushNeedsForce:: 224 Shown when linkgit:git-push[1] rejects an update that 225 tries to overwrite a remote ref that points at an 226 object that is not a commit-ish, or make the remote 227 ref point at an object that is not a commit-ish. 228 statusHints:: 229 Show directions on how to proceed from the current 230 state in the output of linkgit:git-status[1], in 231 the template shown when writing commit messages in 232 linkgit:git-commit[1], and in the help message shown 233 by linkgit:git-checkout[1] when switching branch. 234 statusUoption:: 235 Advise to consider using the `-u` option to linkgit:git-status[1] 236 when the command takes more than 2 seconds to enumerate untracked 237 files. 238 commitBeforeMerge:: 239 Advice shown when linkgit:git-merge[1] refuses to 240 merge to avoid overwriting local changes. 241 resolveConflict:: 242 Advice shown by various commands when conflicts 243 prevent the operation from being performed. 244 implicitIdentity:: 245 Advice on how to set your identity configuration when 246 your information is guessed from the system username and 247 domain name. 248 detachedHead:: 249 Advice shown when you used linkgit:git-checkout[1] to 250 move to the detach HEAD state, to instruct how to create 251 a local branch after the fact. 252 amWorkDir:: 253 Advice that shows the location of the patch file when 254 linkgit:git-am[1] fails to apply it. 255 rmHints:: 256 In case of failure in the output of linkgit:git-rm[1], 257 show directions on how to proceed from the current state. 258-- 259 260core.fileMode:: 261 Tells Git if the executable bit of files in the working tree 262 is to be honored. 263+ 264Some filesystems lose the executable bit when a file that is 265marked as executable is checked out, or checks out an 266non-executable file with executable bit on. 267linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 268to see if it handles the executable bit correctly 269and this variable is automatically set as necessary. 270+ 271A repository, however, may be on a filesystem that handles 272the filemode correctly, and this variable is set to 'true' 273when created, but later may be made accessible from another 274environment that loses the filemode (e.g. exporting ext4 via 275CIFS mount, visiting a Cygwin created repository with 276Git for Windows or Eclipse). 277In such a case it may be necessary to set this variable to 'false'. 278See linkgit:git-update-index[1]. 279+ 280The default is true (when core.filemode is not specified in the config file). 281 282core.ignoreCase:: 283 If true, this option enables various workarounds to enable 284 Git to work better on filesystems that are not case sensitive, 285 like FAT. For example, if a directory listing finds 286 "makefile" when Git expects "Makefile", Git will assume 287 it is really the same file, and continue to remember it as 288 "Makefile". 289+ 290The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 291will probe and set core.ignoreCase true if appropriate when the repository 292is created. 293 294core.precomposeUnicode:: 295 This option is only used by Mac OS implementation of Git. 296 When core.precomposeUnicode=true, Git reverts the unicode decomposition 297 of filenames done by Mac OS. This is useful when sharing a repository 298 between Mac OS and Linux or Windows. 299 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 300 When false, file names are handled fully transparent by Git, 301 which is backward compatible with older versions of Git. 302 303core.protectHFS:: 304 If set to true, do not allow checkout of paths that would 305 be considered equivalent to `.git` on an HFS+ filesystem. 306 Defaults to `true` on Mac OS, and `false` elsewhere. 307 308core.protectNTFS:: 309 If set to true, do not allow checkout of paths that would 310 cause problems with the NTFS filesystem, e.g. conflict with 311 8.3 "short" names. 312 Defaults to `true` on Windows, and `false` elsewhere. 313 314core.trustctime:: 315 If false, the ctime differences between the index and the 316 working tree are ignored; useful when the inode change time 317 is regularly modified by something outside Git (file system 318 crawlers and some backup systems). 319 See linkgit:git-update-index[1]. True by default. 320 321core.untrackedCache:: 322 Determines what to do about the untracked cache feature of the 323 index. It will be kept, if this variable is unset or set to 324 `keep`. It will automatically be added if set to `true`. And 325 it will automatically be removed, if set to `false`. Before 326 setting it to `true`, you should check that mtime is working 327 properly on your system. 328 See linkgit:git-update-index[1]. `keep` by default. 329 330core.checkStat:: 331 Determines which stat fields to match between the index 332 and work tree. The user can set this to 'default' or 333 'minimal'. Default (or explicitly 'default'), is to check 334 all fields, including the sub-second part of mtime and ctime. 335 336core.quotePath:: 337 The commands that output paths (e.g. 'ls-files', 338 'diff'), when not given the `-z` option, will quote 339 "unusual" characters in the pathname by enclosing the 340 pathname in a double-quote pair and with backslashes the 341 same way strings in C source code are quoted. If this 342 variable is set to false, the bytes higher than 0x80 are 343 not quoted but output as verbatim. Note that double 344 quote, backslash and control characters are always 345 quoted without `-z` regardless of the setting of this 346 variable. 347 348core.eol:: 349 Sets the line ending type to use in the working directory for 350 files that have the `text` property set. Alternatives are 351 'lf', 'crlf' and 'native', which uses the platform's native 352 line ending. The default value is `native`. See 353 linkgit:gitattributes[5] for more information on end-of-line 354 conversion. 355 356core.safecrlf:: 357 If true, makes Git check if converting `CRLF` is reversible when 358 end-of-line conversion is active. Git will verify if a command 359 modifies a file in the work tree either directly or indirectly. 360 For example, committing a file followed by checking out the 361 same file should yield the original file in the work tree. If 362 this is not the case for the current setting of 363 `core.autocrlf`, Git will reject the file. The variable can 364 be set to "warn", in which case Git will only warn about an 365 irreversible conversion but continue the operation. 366+ 367CRLF conversion bears a slight chance of corrupting data. 368When it is enabled, Git will convert CRLF to LF during commit and LF to 369CRLF during checkout. A file that contains a mixture of LF and 370CRLF before the commit cannot be recreated by Git. For text 371files this is the right thing to do: it corrects line endings 372such that we have only LF line endings in the repository. 373But for binary files that are accidentally classified as text the 374conversion can corrupt data. 375+ 376If you recognize such corruption early you can easily fix it by 377setting the conversion type explicitly in .gitattributes. Right 378after committing you still have the original file in your work 379tree and this file is not yet corrupted. You can explicitly tell 380Git that this file is binary and Git will handle the file 381appropriately. 382+ 383Unfortunately, the desired effect of cleaning up text files with 384mixed line endings and the undesired effect of corrupting binary 385files cannot be distinguished. In both cases CRLFs are removed 386in an irreversible way. For text files this is the right thing 387to do because CRLFs are line endings, while for binary files 388converting CRLFs corrupts data. 389+ 390Note, this safety check does not mean that a checkout will generate a 391file identical to the original file for a different setting of 392`core.eol` and `core.autocrlf`, but only for the current one. For 393example, a text file with `LF` would be accepted with `core.eol=lf` 394and could later be checked out with `core.eol=crlf`, in which case the 395resulting file would contain `CRLF`, although the original file 396contained `LF`. However, in both work trees the line endings would be 397consistent, that is either all `LF` or all `CRLF`, but never mixed. A 398file with mixed line endings would be reported by the `core.safecrlf` 399mechanism. 400 401core.autocrlf:: 402 Setting this variable to "true" is almost the same as setting 403 the `text` attribute to "auto" on all files except that text 404 files are not guaranteed to be normalized: files that contain 405 `CRLF` in the repository will not be touched. Use this 406 setting if you want to have `CRLF` line endings in your 407 working directory even though the repository does not have 408 normalized line endings. This variable can be set to 'input', 409 in which case no output conversion is performed. 410 411core.symlinks:: 412 If false, symbolic links are checked out as small plain files that 413 contain the link text. linkgit:git-update-index[1] and 414 linkgit:git-add[1] will not change the recorded type to regular 415 file. Useful on filesystems like FAT that do not support 416 symbolic links. 417+ 418The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 419will probe and set core.symlinks false if appropriate when the repository 420is created. 421 422core.gitProxy:: 423 A "proxy command" to execute (as 'command host port') instead 424 of establishing direct connection to the remote server when 425 using the Git protocol for fetching. If the variable value is 426 in the "COMMAND for DOMAIN" format, the command is applied only 427 on hostnames ending with the specified domain string. This variable 428 may be set multiple times and is matched in the given order; 429 the first match wins. 430+ 431Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 432(which always applies universally, without the special "for" 433handling). 434+ 435The special string `none` can be used as the proxy command to 436specify that no proxy be used for a given domain pattern. 437This is useful for excluding servers inside a firewall from 438proxy use, while defaulting to a common proxy for external domains. 439 440core.ignoreStat:: 441 If true, Git will avoid using lstat() calls to detect if files have 442 changed by setting the "assume-unchanged" bit for those tracked files 443 which it has updated identically in both the index and working tree. 444+ 445When files are modified outside of Git, the user will need to stage 446the modified files explicitly (e.g. see 'Examples' section in 447linkgit:git-update-index[1]). 448Git will not normally detect changes to those files. 449+ 450This is useful on systems where lstat() calls are very slow, such as 451CIFS/Microsoft Windows. 452+ 453False by default. 454 455core.preferSymlinkRefs:: 456 Instead of the default "symref" format for HEAD 457 and other symbolic reference files, use symbolic links. 458 This is sometimes needed to work with old scripts that 459 expect HEAD to be a symbolic link. 460 461core.bare:: 462 If true this repository is assumed to be 'bare' and has no 463 working directory associated with it. If this is the case a 464 number of commands that require a working directory will be 465 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 466+ 467This setting is automatically guessed by linkgit:git-clone[1] or 468linkgit:git-init[1] when the repository was created. By default a 469repository that ends in "/.git" is assumed to be not bare (bare = 470false), while all other repositories are assumed to be bare (bare 471= true). 472 473core.worktree:: 474 Set the path to the root of the working tree. 475 If GIT_COMMON_DIR environment variable is set, core.worktree 476 is ignored and not used for determining the root of working tree. 477 This can be overridden by the GIT_WORK_TREE environment 478 variable and the '--work-tree' command-line option. 479 The value can be an absolute path or relative to the path to 480 the .git directory, which is either specified by --git-dir 481 or GIT_DIR, or automatically discovered. 482 If --git-dir or GIT_DIR is specified but none of 483 --work-tree, GIT_WORK_TREE and core.worktree is specified, 484 the current working directory is regarded as the top level 485 of your working tree. 486+ 487Note that this variable is honored even when set in a configuration 488file in a ".git" subdirectory of a directory and its value differs 489from the latter directory (e.g. "/path/to/.git/config" has 490core.worktree set to "/different/path"), which is most likely a 491misconfiguration. Running Git commands in the "/path/to" directory will 492still use "/different/path" as the root of the work tree and can cause 493confusion unless you know what you are doing (e.g. you are creating a 494read-only snapshot of the same index to a location different from the 495repository's usual working tree). 496 497core.logAllRefUpdates:: 498 Enable the reflog. Updates to a ref <ref> is logged to the file 499 "`$GIT_DIR/logs/<ref>`", by appending the new and old 500 SHA-1, the date/time and the reason of the update, but 501 only when the file exists. If this configuration 502 variable is set to true, missing "`$GIT_DIR/logs/<ref>`" 503 file is automatically created for branch heads (i.e. under 504 refs/heads/), remote refs (i.e. under refs/remotes/), 505 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 506+ 507This information can be used to determine what commit 508was the tip of a branch "2 days ago". 509+ 510This value is true by default in a repository that has 511a working directory associated with it, and false by 512default in a bare repository. 513 514core.repositoryFormatVersion:: 515 Internal variable identifying the repository format and layout 516 version. 517 518core.sharedRepository:: 519 When 'group' (or 'true'), the repository is made shareable between 520 several users in a group (making sure all the files and objects are 521 group-writable). When 'all' (or 'world' or 'everybody'), the 522 repository will be readable by all users, additionally to being 523 group-shareable. When 'umask' (or 'false'), Git will use permissions 524 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 525 files in the repository will have this mode value. '0xxx' will override 526 user's umask value (whereas the other options will only override 527 requested parts of the user's umask value). Examples: '0660' will make 528 the repo read/write-able for the owner and group, but inaccessible to 529 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 530 repository that is group-readable but not group-writable. 531 See linkgit:git-init[1]. False by default. 532 533core.warnAmbiguousRefs:: 534 If true, Git will warn you if the ref name you passed it is ambiguous 535 and might match multiple refs in the repository. True by default. 536 537core.compression:: 538 An integer -1..9, indicating a default compression level. 539 -1 is the zlib default. 0 means no compression, 540 and 1..9 are various speed/size tradeoffs, 9 being slowest. 541 If set, this provides a default to other compression variables, 542 such as 'core.looseCompression' and 'pack.compression'. 543 544core.looseCompression:: 545 An integer -1..9, indicating the compression level for objects that 546 are not in a pack file. -1 is the zlib default. 0 means no 547 compression, and 1..9 are various speed/size tradeoffs, 9 being 548 slowest. If not set, defaults to core.compression. If that is 549 not set, defaults to 1 (best speed). 550 551core.packedGitWindowSize:: 552 Number of bytes of a pack file to map into memory in a 553 single mapping operation. Larger window sizes may allow 554 your system to process a smaller number of large pack files 555 more quickly. Smaller window sizes will negatively affect 556 performance due to increased calls to the operating system's 557 memory manager, but may improve performance when accessing 558 a large number of large pack files. 559+ 560Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 561MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 562be reasonable for all users/operating systems. You probably do 563not need to adjust this value. 564+ 565Common unit suffixes of 'k', 'm', or 'g' are supported. 566 567core.packedGitLimit:: 568 Maximum number of bytes to map simultaneously into memory 569 from pack files. If Git needs to access more than this many 570 bytes at once to complete an operation it will unmap existing 571 regions to reclaim virtual address space within the process. 572+ 573Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 574This should be reasonable for all users/operating systems, except on 575the largest projects. You probably do not need to adjust this value. 576+ 577Common unit suffixes of 'k', 'm', or 'g' are supported. 578 579core.deltaBaseCacheLimit:: 580 Maximum number of bytes to reserve for caching base objects 581 that may be referenced by multiple deltified objects. By storing the 582 entire decompressed base objects in a cache Git is able 583 to avoid unpacking and decompressing frequently used base 584 objects multiple times. 585+ 586Default is 96 MiB on all platforms. This should be reasonable 587for all users/operating systems, except on the largest projects. 588You probably do not need to adjust this value. 589+ 590Common unit suffixes of 'k', 'm', or 'g' are supported. 591 592core.bigFileThreshold:: 593 Files larger than this size are stored deflated, without 594 attempting delta compression. Storing large files without 595 delta compression avoids excessive memory usage, at the 596 slight expense of increased disk usage. Additionally files 597 larger than this size are always treated as binary. 598+ 599Default is 512 MiB on all platforms. This should be reasonable 600for most projects as source code and other text files can still 601be delta compressed, but larger binary media files won't be. 602+ 603Common unit suffixes of 'k', 'm', or 'g' are supported. 604 605core.excludesFile:: 606 Specifies the pathname to the file that contains patterns to 607 describe paths that are not meant to be tracked, in addition 608 to '.gitignore' (per-directory) and '.git/info/exclude'. 609 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 610 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 611 is used instead. See linkgit:gitignore[5]. 612 613core.askPass:: 614 Some commands (e.g. svn and http interfaces) that interactively 615 ask for a password can be told to use an external program given 616 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 617 environment variable. If not set, fall back to the value of the 618 'SSH_ASKPASS' environment variable or, failing that, a simple password 619 prompt. The external program shall be given a suitable prompt as 620 command-line argument and write the password on its STDOUT. 621 622core.attributesFile:: 623 In addition to '.gitattributes' (per-directory) and 624 '.git/info/attributes', Git looks into this file for attributes 625 (see linkgit:gitattributes[5]). Path expansions are made the same 626 way as for `core.excludesFile`. Its default value is 627 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 628 set or empty, `$HOME/.config/git/attributes` is used instead. 629 630core.editor:: 631 Commands such as `commit` and `tag` that lets you edit 632 messages by launching an editor uses the value of this 633 variable when it is set, and the environment variable 634 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 635 636core.commentChar:: 637 Commands such as `commit` and `tag` that lets you edit 638 messages consider a line that begins with this character 639 commented, and removes them after the editor returns 640 (default '#'). 641+ 642If set to "auto", `git-commit` would select a character that is not 643the beginning character of any line in existing commit messages. 644 645core.packedRefsTimeout:: 646 The length of time, in milliseconds, to retry when trying to 647 lock the `packed-refs` file. Value 0 means not to retry at 648 all; -1 means to try indefinitely. Default is 1000 (i.e., 649 retry for 1 second). 650 651sequence.editor:: 652 Text editor used by `git rebase -i` for editing the rebase instruction file. 653 The value is meant to be interpreted by the shell when it is used. 654 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 655 When not configured the default commit message editor is used instead. 656 657core.pager:: 658 Text viewer for use by Git commands (e.g., 'less'). The value 659 is meant to be interpreted by the shell. The order of preference 660 is the `$GIT_PAGER` environment variable, then `core.pager` 661 configuration, then `$PAGER`, and then the default chosen at 662 compile time (usually 'less'). 663+ 664When the `LESS` environment variable is unset, Git sets it to `FRX` 665(if `LESS` environment variable is set, Git does not change it at 666all). If you want to selectively override Git's default setting 667for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 668be passed to the shell by Git, which will translate the final 669command to `LESS=FRX less -S`. The environment does not set the 670`S` option but the command line does, instructing less to truncate 671long lines. Similarly, setting `core.pager` to `less -+F` will 672deactivate the `F` option specified by the environment from the 673command-line, deactivating the "quit if one screen" behavior of 674`less`. One can specifically activate some flags for particular 675commands: for example, setting `pager.blame` to `less -S` enables 676line truncation only for `git blame`. 677+ 678Likewise, when the `LV` environment variable is unset, Git sets it 679to `-c`. You can override this setting by exporting `LV` with 680another value or setting `core.pager` to `lv +c`. 681 682core.whitespace:: 683 A comma separated list of common whitespace problems to 684 notice. 'git diff' will use `color.diff.whitespace` to 685 highlight them, and 'git apply --whitespace=error' will 686 consider them as errors. You can prefix `-` to disable 687 any of them (e.g. `-trailing-space`): 688+ 689* `blank-at-eol` treats trailing whitespaces at the end of the line 690 as an error (enabled by default). 691* `space-before-tab` treats a space character that appears immediately 692 before a tab character in the initial indent part of the line as an 693 error (enabled by default). 694* `indent-with-non-tab` treats a line that is indented with space 695 characters instead of the equivalent tabs as an error (not enabled by 696 default). 697* `tab-in-indent` treats a tab character in the initial indent part of 698 the line as an error (not enabled by default). 699* `blank-at-eof` treats blank lines added at the end of file as an error 700 (enabled by default). 701* `trailing-space` is a short-hand to cover both `blank-at-eol` and 702 `blank-at-eof`. 703* `cr-at-eol` treats a carriage-return at the end of line as 704 part of the line terminator, i.e. with it, `trailing-space` 705 does not trigger if the character before such a carriage-return 706 is not a whitespace (not enabled by default). 707* `tabwidth=<n>` tells how many character positions a tab occupies; this 708 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 709 errors. The default tab width is 8. Allowed values are 1 to 63. 710 711core.fsyncObjectFiles:: 712 This boolean will enable 'fsync()' when writing object files. 713+ 714This is a total waste of time and effort on a filesystem that orders 715data writes properly, but can be useful for filesystems that do not use 716journalling (traditional UNIX filesystems) or that only journal metadata 717and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 718 719core.preloadIndex:: 720 Enable parallel index preload for operations like 'git diff' 721+ 722This can speed up operations like 'git diff' and 'git status' especially 723on filesystems like NFS that have weak caching semantics and thus 724relatively high IO latencies. When enabled, Git will do the 725index comparison to the filesystem data in parallel, allowing 726overlapping IO's. Defaults to true. 727 728core.createObject:: 729 You can set this to 'link', in which case a hardlink followed by 730 a delete of the source are used to make sure that object creation 731 will not overwrite existing objects. 732+ 733On some file system/operating system combinations, this is unreliable. 734Set this config setting to 'rename' there; However, This will remove the 735check that makes sure that existing object files will not get overwritten. 736 737core.notesRef:: 738 When showing commit messages, also show notes which are stored in 739 the given ref. The ref must be fully qualified. If the given 740 ref does not exist, it is not an error but means that no 741 notes should be printed. 742+ 743This setting defaults to "refs/notes/commits", and it can be overridden by 744the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 745 746core.sparseCheckout:: 747 Enable "sparse checkout" feature. See section "Sparse checkout" in 748 linkgit:git-read-tree[1] for more information. 749 750core.abbrev:: 751 Set the length object names are abbreviated to. If unspecified, 752 many commands abbreviate to 7 hexdigits, which may not be enough 753 for abbreviated object names to stay unique for sufficiently long 754 time. 755 756add.ignoreErrors:: 757add.ignore-errors (deprecated):: 758 Tells 'git add' to continue adding files when some files cannot be 759 added due to indexing errors. Equivalent to the '--ignore-errors' 760 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 761 as it does not follow the usual naming convention for configuration 762 variables. 763 764alias.*:: 765 Command aliases for the linkgit:git[1] command wrapper - e.g. 766 after defining "alias.last = cat-file commit HEAD", the invocation 767 "git last" is equivalent to "git cat-file commit HEAD". To avoid 768 confusion and troubles with script usage, aliases that 769 hide existing Git commands are ignored. Arguments are split by 770 spaces, the usual shell quoting and escaping is supported. 771 A quote pair or a backslash can be used to quote them. 772+ 773If the alias expansion is prefixed with an exclamation point, 774it will be treated as a shell command. For example, defining 775"alias.new = !gitk --all --not ORIG_HEAD", the invocation 776"git new" is equivalent to running the shell command 777"gitk --all --not ORIG_HEAD". Note that shell commands will be 778executed from the top-level directory of a repository, which may 779not necessarily be the current directory. 780'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 781from the original current directory. See linkgit:git-rev-parse[1]. 782 783am.keepcr:: 784 If true, git-am will call git-mailsplit for patches in mbox format 785 with parameter '--keep-cr'. In this case git-mailsplit will 786 not remove `\r` from lines ending with `\r\n`. Can be overridden 787 by giving '--no-keep-cr' from the command line. 788 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 789 790am.threeWay:: 791 By default, `git am` will fail if the patch does not apply cleanly. When 792 set to true, this setting tells `git am` to fall back on 3-way merge if 793 the patch records the identity of blobs it is supposed to apply to and 794 we have those blobs available locally (equivalent to giving the `--3way` 795 option from the command line). Defaults to `false`. 796 See linkgit:git-am[1]. 797 798apply.ignoreWhitespace:: 799 When set to 'change', tells 'git apply' to ignore changes in 800 whitespace, in the same way as the '--ignore-space-change' 801 option. 802 When set to one of: no, none, never, false tells 'git apply' to 803 respect all whitespace differences. 804 See linkgit:git-apply[1]. 805 806apply.whitespace:: 807 Tells 'git apply' how to handle whitespaces, in the same way 808 as the '--whitespace' option. See linkgit:git-apply[1]. 809 810branch.autoSetupMerge:: 811 Tells 'git branch' and 'git checkout' to set up new branches 812 so that linkgit:git-pull[1] will appropriately merge from the 813 starting point branch. Note that even if this option is not set, 814 this behavior can be chosen per-branch using the `--track` 815 and `--no-track` options. The valid settings are: `false` -- no 816 automatic setup is done; `true` -- automatic setup is done when the 817 starting point is a remote-tracking branch; `always` -- 818 automatic setup is done when the starting point is either a 819 local branch or remote-tracking 820 branch. This option defaults to true. 821 822branch.autoSetupRebase:: 823 When a new branch is created with 'git branch' or 'git checkout' 824 that tracks another branch, this variable tells Git to set 825 up pull to rebase instead of merge (see "branch.<name>.rebase"). 826 When `never`, rebase is never automatically set to true. 827 When `local`, rebase is set to true for tracked branches of 828 other local branches. 829 When `remote`, rebase is set to true for tracked branches of 830 remote-tracking branches. 831 When `always`, rebase will be set to true for all tracking 832 branches. 833 See "branch.autoSetupMerge" for details on how to set up a 834 branch to track another branch. 835 This option defaults to never. 836 837branch.<name>.remote:: 838 When on branch <name>, it tells 'git fetch' and 'git push' 839 which remote to fetch from/push to. The remote to push to 840 may be overridden with `remote.pushDefault` (for all branches). 841 The remote to push to, for the current branch, may be further 842 overridden by `branch.<name>.pushRemote`. If no remote is 843 configured, or if you are not on any branch, it defaults to 844 `origin` for fetching and `remote.pushDefault` for pushing. 845 Additionally, `.` (a period) is the current local repository 846 (a dot-repository), see `branch.<name>.merge`'s final note below. 847 848branch.<name>.pushRemote:: 849 When on branch <name>, it overrides `branch.<name>.remote` for 850 pushing. It also overrides `remote.pushDefault` for pushing 851 from branch <name>. When you pull from one place (e.g. your 852 upstream) and push to another place (e.g. your own publishing 853 repository), you would want to set `remote.pushDefault` to 854 specify the remote to push to for all branches, and use this 855 option to override it for a specific branch. 856 857branch.<name>.merge:: 858 Defines, together with branch.<name>.remote, the upstream branch 859 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 860 branch to merge and can also affect 'git push' (see push.default). 861 When in branch <name>, it tells 'git fetch' the default 862 refspec to be marked for merging in FETCH_HEAD. The value is 863 handled like the remote part of a refspec, and must match a 864 ref which is fetched from the remote given by 865 "branch.<name>.remote". 866 The merge information is used by 'git pull' (which at first calls 867 'git fetch') to lookup the default branch for merging. Without 868 this option, 'git pull' defaults to merge the first refspec fetched. 869 Specify multiple values to get an octopus merge. 870 If you wish to setup 'git pull' so that it merges into <name> from 871 another branch in the local repository, you can point 872 branch.<name>.merge to the desired branch, and use the relative path 873 setting `.` (a period) for branch.<name>.remote. 874 875branch.<name>.mergeOptions:: 876 Sets default options for merging into branch <name>. The syntax and 877 supported options are the same as those of linkgit:git-merge[1], but 878 option values containing whitespace characters are currently not 879 supported. 880 881branch.<name>.rebase:: 882 When true, rebase the branch <name> on top of the fetched branch, 883 instead of merging the default branch from the default remote when 884 "git pull" is run. See "pull.rebase" for doing this in a non 885 branch-specific manner. 886+ 887When preserve, also pass `--preserve-merges` along to 'git rebase' 888so that locally committed merge commits will not be flattened 889by running 'git pull'. 890+ 891When the value is `interactive`, the rebase is run in interactive mode. 892+ 893*NOTE*: this is a possibly dangerous operation; do *not* use 894it unless you understand the implications (see linkgit:git-rebase[1] 895for details). 896 897branch.<name>.description:: 898 Branch description, can be edited with 899 `git branch --edit-description`. Branch description is 900 automatically added in the format-patch cover letter or 901 request-pull summary. 902 903browser.<tool>.cmd:: 904 Specify the command to invoke the specified browser. The 905 specified command is evaluated in shell with the URLs passed 906 as arguments. (See linkgit:git-web{litdd}browse[1].) 907 908browser.<tool>.path:: 909 Override the path for the given tool that may be used to 910 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 911 working repository in gitweb (see linkgit:git-instaweb[1]). 912 913clean.requireForce:: 914 A boolean to make git-clean do nothing unless given -f, 915 -i or -n. Defaults to true. 916 917color.branch:: 918 A boolean to enable/disable color in the output of 919 linkgit:git-branch[1]. May be set to `always`, 920 `false` (or `never`) or `auto` (or `true`), in which case colors are used 921 only when the output is to a terminal. Defaults to false. 922 923color.branch.<slot>:: 924 Use customized color for branch coloration. `<slot>` is one of 925 `current` (the current branch), `local` (a local branch), 926 `remote` (a remote-tracking branch in refs/remotes/), 927 `upstream` (upstream tracking branch), `plain` (other 928 refs). 929 930color.diff:: 931 Whether to use ANSI escape sequences to add color to patches. 932 If this is set to `always`, linkgit:git-diff[1], 933 linkgit:git-log[1], and linkgit:git-show[1] will use color 934 for all patches. If it is set to `true` or `auto`, those 935 commands will only use color when output is to the terminal. 936 Defaults to false. 937+ 938This does not affect linkgit:git-format-patch[1] or the 939'git-diff-{asterisk}' plumbing commands. Can be overridden on the 940command line with the `--color[=<when>]` option. 941 942color.diff.<slot>:: 943 Use customized color for diff colorization. `<slot>` specifies 944 which part of the patch to use the specified color, and is one 945 of `context` (context text - `plain` is a historical synonym), 946 `meta` (metainformation), `frag` 947 (hunk header), 'func' (function in hunk header), `old` (removed lines), 948 `new` (added lines), `commit` (commit headers), or `whitespace` 949 (highlighting whitespace errors). 950 951color.decorate.<slot>:: 952 Use customized color for 'git log --decorate' output. `<slot>` is one 953 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 954 branches, remote-tracking branches, tags, stash and HEAD, respectively. 955 956color.grep:: 957 When set to `always`, always highlight matches. When `false` (or 958 `never`), never. When set to `true` or `auto`, use color only 959 when the output is written to the terminal. Defaults to `false`. 960 961color.grep.<slot>:: 962 Use customized color for grep colorization. `<slot>` specifies which 963 part of the line to use the specified color, and is one of 964+ 965-- 966`context`;; 967 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 968`filename`;; 969 filename prefix (when not using `-h`) 970`function`;; 971 function name lines (when using `-p`) 972`linenumber`;; 973 line number prefix (when using `-n`) 974`match`;; 975 matching text (same as setting `matchContext` and `matchSelected`) 976`matchContext`;; 977 matching text in context lines 978`matchSelected`;; 979 matching text in selected lines 980`selected`;; 981 non-matching text in selected lines 982`separator`;; 983 separators between fields on a line (`:`, `-`, and `=`) 984 and between hunks (`--`) 985-- 986 987color.interactive:: 988 When set to `always`, always use colors for interactive prompts 989 and displays (such as those used by "git-add --interactive" and 990 "git-clean --interactive"). When false (or `never`), never. 991 When set to `true` or `auto`, use colors only when the output is 992 to the terminal. Defaults to false. 993 994color.interactive.<slot>:: 995 Use customized color for 'git add --interactive' and 'git clean 996 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 997 or `error`, for four distinct types of normal output from 998 interactive commands. 9991000color.pager::1001 A boolean to enable/disable colored output when the pager is in1002 use (default is true).10031004color.showBranch::1005 A boolean to enable/disable color in the output of1006 linkgit:git-show-branch[1]. May be set to `always`,1007 `false` (or `never`) or `auto` (or `true`), in which case colors are used1008 only when the output is to a terminal. Defaults to false.10091010color.status::1011 A boolean to enable/disable color in the output of1012 linkgit:git-status[1]. May be set to `always`,1013 `false` (or `never`) or `auto` (or `true`), in which case colors are used1014 only when the output is to a terminal. Defaults to false.10151016color.status.<slot>::1017 Use customized color for status colorization. `<slot>` is1018 one of `header` (the header text of the status message),1019 `added` or `updated` (files which are added but not committed),1020 `changed` (files which are changed but not added in the index),1021 `untracked` (files which are not tracked by Git),1022 `branch` (the current branch),1023 `nobranch` (the color the 'no branch' warning is shown in, defaulting1024 to red), or1025 `unmerged` (files which have unmerged changes).10261027color.ui::1028 This variable determines the default value for variables such1029 as `color.diff` and `color.grep` that control the use of color1030 per command family. Its scope will expand as more commands learn1031 configuration to set a default for the `--color` option. Set it1032 to `false` or `never` if you prefer Git commands not to use1033 color unless enabled explicitly with some other configuration1034 or the `--color` option. Set it to `always` if you want all1035 output not intended for machine consumption to use color, to1036 `true` or `auto` (this is the default since Git 1.8.4) if you1037 want such output to use color when written to the terminal.10381039column.ui::1040 Specify whether supported commands should output in columns.1041 This variable consists of a list of tokens separated by spaces1042 or commas:1043+1044These options control when the feature should be enabled1045(defaults to 'never'):1046+1047--1048`always`;;1049 always show in columns1050`never`;;1051 never show in columns1052`auto`;;1053 show in columns if the output is to the terminal1054--1055+1056These options control layout (defaults to 'column'). Setting any1057of these implies 'always' if none of 'always', 'never', or 'auto' are1058specified.1059+1060--1061`column`;;1062 fill columns before rows1063`row`;;1064 fill rows before columns1065`plain`;;1066 show in one column1067--1068+1069Finally, these options can be combined with a layout option (defaults1070to 'nodense'):1071+1072--1073`dense`;;1074 make unequal size columns to utilize more space1075`nodense`;;1076 make equal size columns1077--10781079column.branch::1080 Specify whether to output branch listing in `git branch` in columns.1081 See `column.ui` for details.10821083column.clean::1084 Specify the layout when list items in `git clean -i`, which always1085 shows files and directories in columns. See `column.ui` for details.10861087column.status::1088 Specify whether to output untracked files in `git status` in columns.1089 See `column.ui` for details.10901091column.tag::1092 Specify whether to output tag listing in `git tag` in columns.1093 See `column.ui` for details.10941095commit.cleanup::1096 This setting overrides the default of the `--cleanup` option in1097 `git commit`. See linkgit:git-commit[1] for details. Changing the1098 default can be useful when you always want to keep lines that begin1099 with comment character `#` in your log message, in which case you1100 would do `git config commit.cleanup whitespace` (note that you will1101 have to remove the help lines that begin with `#` in the commit log1102 template yourself, if you do this).11031104commit.gpgSign::11051106 A boolean to specify whether all commits should be GPG signed.1107 Use of this option when doing operations such as rebase can1108 result in a large number of commits being signed. It may be1109 convenient to use an agent to avoid typing your GPG passphrase1110 several times.11111112commit.status::1113 A boolean to enable/disable inclusion of status information in the1114 commit message template when using an editor to prepare the commit1115 message. Defaults to true.11161117commit.template::1118 Specify the pathname of a file to use as the template for1119 new commit messages.11201121credential.helper::1122 Specify an external helper to be called when a username or1123 password credential is needed; the helper may consult external1124 storage to avoid prompting the user for the credentials. See1125 linkgit:gitcredentials[7] for details.11261127credential.useHttpPath::1128 When acquiring credentials, consider the "path" component of an http1129 or https URL to be important. Defaults to false. See1130 linkgit:gitcredentials[7] for more information.11311132credential.username::1133 If no username is set for a network authentication, use this username1134 by default. See credential.<context>.* below, and1135 linkgit:gitcredentials[7].11361137credential.<url>.*::1138 Any of the credential.* options above can be applied selectively to1139 some credentials. For example "credential.https://example.com.username"1140 would set the default username only for https connections to1141 example.com. See linkgit:gitcredentials[7] for details on how URLs are1142 matched.11431144credentialCache.ignoreSIGHUP::1145 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11461147include::diff-config.txt[]11481149difftool.<tool>.path::1150 Override the path for the given tool. This is useful in case1151 your tool is not in the PATH.11521153difftool.<tool>.cmd::1154 Specify the command to invoke the specified diff tool.1155 The specified command is evaluated in shell with the following1156 variables available: 'LOCAL' is set to the name of the temporary1157 file containing the contents of the diff pre-image and 'REMOTE'1158 is set to the name of the temporary file containing the contents1159 of the diff post-image.11601161difftool.prompt::1162 Prompt before each invocation of the diff tool.11631164fetch.recurseSubmodules::1165 This option can be either set to a boolean value or to 'on-demand'.1166 Setting it to a boolean changes the behavior of fetch and pull to1167 unconditionally recurse into submodules when set to true or to not1168 recurse at all when set to false. When set to 'on-demand' (the default1169 value), fetch and pull will only recurse into a populated submodule1170 when its superproject retrieves a commit that updates the submodule's1171 reference.11721173fetch.fsckObjects::1174 If it is set to true, git-fetch-pack will check all fetched1175 objects. It will abort in the case of a malformed object or a1176 broken link. The result of an abort are only dangling objects.1177 Defaults to false. If not set, the value of `transfer.fsckObjects`1178 is used instead.11791180fetch.unpackLimit::1181 If the number of objects fetched over the Git native1182 transfer is below this1183 limit, then the objects will be unpacked into loose object1184 files. However if the number of received objects equals or1185 exceeds this limit then the received pack will be stored as1186 a pack, after adding any missing delta bases. Storing the1187 pack from a push can make the push operation complete faster,1188 especially on slow filesystems. If not set, the value of1189 `transfer.unpackLimit` is used instead.11901191fetch.prune::1192 If true, fetch will automatically behave as if the `--prune`1193 option was given on the command line. See also `remote.<name>.prune`.11941195format.attach::1196 Enable multipart/mixed attachments as the default for1197 'format-patch'. The value can also be a double quoted string1198 which will enable attachments as the default and set the1199 value as the boundary. See the --attach option in1200 linkgit:git-format-patch[1].12011202format.numbered::1203 A boolean which can enable or disable sequence numbers in patch1204 subjects. It defaults to "auto" which enables it only if there1205 is more than one patch. It can be enabled or disabled for all1206 messages by setting it to "true" or "false". See --numbered1207 option in linkgit:git-format-patch[1].12081209format.headers::1210 Additional email headers to include in a patch to be submitted1211 by mail. See linkgit:git-format-patch[1].12121213format.to::1214format.cc::1215 Additional recipients to include in a patch to be submitted1216 by mail. See the --to and --cc options in1217 linkgit:git-format-patch[1].12181219format.subjectPrefix::1220 The default for format-patch is to output files with the '[PATCH]'1221 subject prefix. Use this variable to change that prefix.12221223format.signature::1224 The default for format-patch is to output a signature containing1225 the Git version number. Use this variable to change that default.1226 Set this variable to the empty string ("") to suppress1227 signature generation.12281229format.signatureFile::1230 Works just like format.signature except the contents of the1231 file specified by this variable will be used as the signature.12321233format.suffix::1234 The default for format-patch is to output files with the suffix1235 `.patch`. Use this variable to change that suffix (make sure to1236 include the dot if you want it).12371238format.pretty::1239 The default pretty format for log/show/whatchanged command,1240 See linkgit:git-log[1], linkgit:git-show[1],1241 linkgit:git-whatchanged[1].12421243format.thread::1244 The default threading style for 'git format-patch'. Can be1245 a boolean value, or `shallow` or `deep`. `shallow` threading1246 makes every mail a reply to the head of the series,1247 where the head is chosen from the cover letter, the1248 `--in-reply-to`, and the first patch mail, in this order.1249 `deep` threading makes every mail a reply to the previous one.1250 A true boolean value is the same as `shallow`, and a false1251 value disables threading.12521253format.signOff::1254 A boolean value which lets you enable the `-s/--signoff` option of1255 format-patch by default. *Note:* Adding the Signed-off-by: line to a1256 patch should be a conscious act and means that you certify you have1257 the rights to submit this work under the same open source license.1258 Please see the 'SubmittingPatches' document for further discussion.12591260format.coverLetter::1261 A boolean that controls whether to generate a cover-letter when1262 format-patch is invoked, but in addition can be set to "auto", to1263 generate a cover-letter only when there's more than one patch.12641265format.outputDirectory::1266 Set a custom directory to store the resulting files instead of the1267 current working directory.12681269filter.<driver>.clean::1270 The command which is used to convert the content of a worktree1271 file to a blob upon checkin. See linkgit:gitattributes[5] for1272 details.12731274filter.<driver>.smudge::1275 The command which is used to convert the content of a blob1276 object to a worktree file upon checkout. See1277 linkgit:gitattributes[5] for details.12781279fsck.<msg-id>::1280 Allows overriding the message type (error, warn or ignore) of a1281 specific message ID such as `missingEmail`.1282+1283For convenience, fsck prefixes the error/warning with the message ID,1284e.g. "missingEmail: invalid author/committer line - missing email" means1285that setting `fsck.missingEmail = ignore` will hide that issue.1286+1287This feature is intended to support working with legacy repositories1288which cannot be repaired without disruptive changes.12891290fsck.skipList::1291 The path to a sorted list of object names (i.e. one SHA-1 per1292 line) that are known to be broken in a non-fatal way and should1293 be ignored. This feature is useful when an established project1294 should be accepted despite early commits containing errors that1295 can be safely ignored such as invalid committer email addresses.1296 Note: corrupt objects cannot be skipped with this setting.12971298gc.aggressiveDepth::1299 The depth parameter used in the delta compression1300 algorithm used by 'git gc --aggressive'. This defaults1301 to 250.13021303gc.aggressiveWindow::1304 The window size parameter used in the delta compression1305 algorithm used by 'git gc --aggressive'. This defaults1306 to 250.13071308gc.auto::1309 When there are approximately more than this many loose1310 objects in the repository, `git gc --auto` will pack them.1311 Some Porcelain commands use this command to perform a1312 light-weight garbage collection from time to time. The1313 default value is 6700. Setting this to 0 disables it.13141315gc.autoPackLimit::1316 When there are more than this many packs that are not1317 marked with `*.keep` file in the repository, `git gc1318 --auto` consolidates them into one larger pack. The1319 default value is 50. Setting this to 0 disables it.13201321gc.autoDetach::1322 Make `git gc --auto` return immediately and run in background1323 if the system supports it. Default is true.13241325gc.packRefs::1326 Running `git pack-refs` in a repository renders it1327 unclonable by Git versions prior to 1.5.1.2 over dumb1328 transports such as HTTP. This variable determines whether1329 'git gc' runs `git pack-refs`. This can be set to `notbare`1330 to enable it within all non-bare repos or it can be set to a1331 boolean value. The default is `true`.13321333gc.pruneExpire::1334 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1335 Override the grace period with this config variable. The value1336 "now" may be used to disable this grace period and always prune1337 unreachable objects immediately, or "never" may be used to1338 suppress pruning.13391340gc.worktreePruneExpire::1341 When 'git gc' is run, it calls1342 'git worktree prune --expire 3.months.ago'.1343 This config variable can be used to set a different grace1344 period. The value "now" may be used to disable the grace1345 period and prune `$GIT_DIR/worktrees` immediately, or "never"1346 may be used to suppress pruning.13471348gc.reflogExpire::1349gc.<pattern>.reflogExpire::1350 'git reflog expire' removes reflog entries older than1351 this time; defaults to 90 days. The value "now" expires all1352 entries immediately, and "never" suppresses expiration1353 altogether. With "<pattern>" (e.g.1354 "refs/stash") in the middle the setting applies only to1355 the refs that match the <pattern>.13561357gc.reflogExpireUnreachable::1358gc.<pattern>.reflogExpireUnreachable::1359 'git reflog expire' removes reflog entries older than1360 this time and are not reachable from the current tip;1361 defaults to 30 days. The value "now" expires all entries1362 immediately, and "never" suppresses expiration altogether.1363 With "<pattern>" (e.g. "refs/stash")1364 in the middle, the setting applies only to the refs that1365 match the <pattern>.13661367gc.rerereResolved::1368 Records of conflicted merge you resolved earlier are1369 kept for this many days when 'git rerere gc' is run.1370 The default is 60 days. See linkgit:git-rerere[1].13711372gc.rerereUnresolved::1373 Records of conflicted merge you have not resolved are1374 kept for this many days when 'git rerere gc' is run.1375 The default is 15 days. See linkgit:git-rerere[1].13761377gitcvs.commitMsgAnnotation::1378 Append this string to each commit message. Set to empty string1379 to disable this feature. Defaults to "via git-CVS emulator".13801381gitcvs.enabled::1382 Whether the CVS server interface is enabled for this repository.1383 See linkgit:git-cvsserver[1].13841385gitcvs.logFile::1386 Path to a log file where the CVS server interface well... logs1387 various stuff. See linkgit:git-cvsserver[1].13881389gitcvs.usecrlfattr::1390 If true, the server will look up the end-of-line conversion1391 attributes for files to determine the '-k' modes to use. If1392 the attributes force Git to treat a file as text,1393 the '-k' mode will be left blank so CVS clients will1394 treat it as text. If they suppress text conversion, the file1395 will be set with '-kb' mode, which suppresses any newline munging1396 the client might otherwise do. If the attributes do not allow1397 the file type to be determined, then 'gitcvs.allBinary' is1398 used. See linkgit:gitattributes[5].13991400gitcvs.allBinary::1401 This is used if 'gitcvs.usecrlfattr' does not resolve1402 the correct '-kb' mode to use. If true, all1403 unresolved files are sent to the client in1404 mode '-kb'. This causes the client to treat them1405 as binary files, which suppresses any newline munging it1406 otherwise might do. Alternatively, if it is set to "guess",1407 then the contents of the file are examined to decide if1408 it is binary, similar to 'core.autocrlf'.14091410gitcvs.dbName::1411 Database used by git-cvsserver to cache revision information1412 derived from the Git repository. The exact meaning depends on the1413 used database driver, for SQLite (which is the default driver) this1414 is a filename. Supports variable substitution (see1415 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1416 Default: '%Ggitcvs.%m.sqlite'14171418gitcvs.dbDriver::1419 Used Perl DBI driver. You can specify any available driver1420 for this here, but it might not work. git-cvsserver is tested1421 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1422 reported *not* to work with 'DBD::mysql'. Experimental feature.1423 May not contain double colons (`:`). Default: 'SQLite'.1424 See linkgit:git-cvsserver[1].14251426gitcvs.dbUser, gitcvs.dbPass::1427 Database user and password. Only useful if setting 'gitcvs.dbDriver',1428 since SQLite has no concept of database users and/or passwords.1429 'gitcvs.dbUser' supports variable substitution (see1430 linkgit:git-cvsserver[1] for details).14311432gitcvs.dbTableNamePrefix::1433 Database table name prefix. Prepended to the names of any1434 database tables used, allowing a single database to be used1435 for several repositories. Supports variable substitution (see1436 linkgit:git-cvsserver[1] for details). Any non-alphabetic1437 characters will be replaced with underscores.14381439All gitcvs variables except for 'gitcvs.usecrlfattr' and1440'gitcvs.allBinary' can also be specified as1441'gitcvs.<access_method>.<varname>' (where 'access_method'1442is one of "ext" and "pserver") to make them apply only for the given1443access method.14441445gitweb.category::1446gitweb.description::1447gitweb.owner::1448gitweb.url::1449 See linkgit:gitweb[1] for description.14501451gitweb.avatar::1452gitweb.blame::1453gitweb.grep::1454gitweb.highlight::1455gitweb.patches::1456gitweb.pickaxe::1457gitweb.remote_heads::1458gitweb.showSizes::1459gitweb.snapshot::1460 See linkgit:gitweb.conf[5] for description.14611462grep.lineNumber::1463 If set to true, enable '-n' option by default.14641465grep.patternType::1466 Set the default matching behavior. Using a value of 'basic', 'extended',1467 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1468 '--fixed-strings', or '--perl-regexp' option accordingly, while the1469 value 'default' will return to the default matching behavior.14701471grep.extendedRegexp::1472 If set to true, enable '--extended-regexp' option by default. This1473 option is ignored when the 'grep.patternType' option is set to a value1474 other than 'default'.14751476grep.threads::1477 Number of grep worker threads to use.1478 See `grep.threads` in linkgit:git-grep[1] for more information.14791480grep.fallbackToNoIndex::1481 If set to true, fall back to git grep --no-index if git grep1482 is executed outside of a git repository. Defaults to false.14831484gpg.program::1485 Use this custom program instead of "`gpg`" found on `$PATH` when1486 making or verifying a PGP signature. The program must support the1487 same command-line interface as GPG, namely, to verify a detached1488 signature, "`gpg --verify $file - <$signature`" is run, and the1489 program is expected to signal a good signature by exiting with1490 code 0, and to generate an ASCII-armored detached signature, the1491 standard input of "`gpg -bsau $key`" is fed with the contents to be1492 signed, and the program is expected to send the result to its1493 standard output.14941495gui.commitMsgWidth::1496 Defines how wide the commit message window is in the1497 linkgit:git-gui[1]. "75" is the default.14981499gui.diffContext::1500 Specifies how many context lines should be used in calls to diff1501 made by the linkgit:git-gui[1]. The default is "5".15021503gui.displayUntracked::1504 Determines if linkgit::git-gui[1] shows untracked files1505 in the file list. The default is "true".15061507gui.encoding::1508 Specifies the default encoding to use for displaying of1509 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1510 It can be overridden by setting the 'encoding' attribute1511 for relevant files (see linkgit:gitattributes[5]).1512 If this option is not set, the tools default to the1513 locale encoding.15141515gui.matchTrackingBranch::1516 Determines if new branches created with linkgit:git-gui[1] should1517 default to tracking remote branches with matching names or1518 not. Default: "false".15191520gui.newBranchTemplate::1521 Is used as suggested name when creating new branches using the1522 linkgit:git-gui[1].15231524gui.pruneDuringFetch::1525 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1526 performing a fetch. The default value is "false".15271528gui.trustmtime::1529 Determines if linkgit:git-gui[1] should trust the file modification1530 timestamp or not. By default the timestamps are not trusted.15311532gui.spellingDictionary::1533 Specifies the dictionary used for spell checking commit messages in1534 the linkgit:git-gui[1]. When set to "none" spell checking is turned1535 off.15361537gui.fastCopyBlame::1538 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1539 location detection. It makes blame significantly faster on huge1540 repositories at the expense of less thorough copy detection.15411542gui.copyBlameThreshold::1543 Specifies the threshold to use in 'git gui blame' original location1544 detection, measured in alphanumeric characters. See the1545 linkgit:git-blame[1] manual for more information on copy detection.15461547gui.blamehistoryctx::1548 Specifies the radius of history context in days to show in1549 linkgit:gitk[1] for the selected commit, when the `Show History1550 Context` menu item is invoked from 'git gui blame'. If this1551 variable is set to zero, the whole history is shown.15521553guitool.<name>.cmd::1554 Specifies the shell command line to execute when the corresponding item1555 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1556 mandatory for every tool. The command is executed from the root of1557 the working directory, and in the environment it receives the name of1558 the tool as 'GIT_GUITOOL', the name of the currently selected file as1559 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1560 the head is detached, 'CUR_BRANCH' is empty).15611562guitool.<name>.needsFile::1563 Run the tool only if a diff is selected in the GUI. It guarantees1564 that 'FILENAME' is not empty.15651566guitool.<name>.noConsole::1567 Run the command silently, without creating a window to display its1568 output.15691570guitool.<name>.noRescan::1571 Don't rescan the working directory for changes after the tool1572 finishes execution.15731574guitool.<name>.confirm::1575 Show a confirmation dialog before actually running the tool.15761577guitool.<name>.argPrompt::1578 Request a string argument from the user, and pass it to the tool1579 through the 'ARGS' environment variable. Since requesting an1580 argument implies confirmation, the 'confirm' option has no effect1581 if this is enabled. If the option is set to 'true', 'yes', or '1',1582 the dialog uses a built-in generic prompt; otherwise the exact1583 value of the variable is used.15841585guitool.<name>.revPrompt::1586 Request a single valid revision from the user, and set the1587 'REVISION' environment variable. In other aspects this option1588 is similar to 'argPrompt', and can be used together with it.15891590guitool.<name>.revUnmerged::1591 Show only unmerged branches in the 'revPrompt' subdialog.1592 This is useful for tools similar to merge or rebase, but not1593 for things like checkout or reset.15941595guitool.<name>.title::1596 Specifies the title to use for the prompt dialog. The default1597 is the tool name.15981599guitool.<name>.prompt::1600 Specifies the general prompt string to display at the top of1601 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1602 The default value includes the actual command.16031604help.browser::1605 Specify the browser that will be used to display help in the1606 'web' format. See linkgit:git-help[1].16071608help.format::1609 Override the default help format used by linkgit:git-help[1].1610 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1611 the default. 'web' and 'html' are the same.16121613help.autoCorrect::1614 Automatically correct and execute mistyped commands after1615 waiting for the given number of deciseconds (0.1 sec). If more1616 than one command can be deduced from the entered text, nothing1617 will be executed. If the value of this option is negative,1618 the corrected command will be executed immediately. If the1619 value is 0 - the command will be just shown but not executed.1620 This is the default.16211622help.htmlPath::1623 Specify the path where the HTML documentation resides. File system paths1624 and URLs are supported. HTML pages will be prefixed with this path when1625 help is displayed in the 'web' format. This defaults to the documentation1626 path of your Git installation.16271628http.proxy::1629 Override the HTTP proxy, normally configured using the 'http_proxy',1630 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1631 addition to the syntax understood by curl, it is possible to specify a1632 proxy string with a user name but no password, in which case git will1633 attempt to acquire one in the same way it does for other credentials. See1634 linkgit:gitcredentials[7] for more information. The syntax thus is1635 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1636 on a per-remote basis; see remote.<name>.proxy16371638http.proxyAuthMethod::1639 Set the method with which to authenticate against the HTTP proxy. This1640 only takes effect if the configured proxy string contains a user name part1641 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1642 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1643 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment1644 variable. Possible values are:1645+1646--1647* `anyauth` - Automatically pick a suitable authentication method. It is1648 assumed that the proxy answers an unauthenticated request with a 4071649 status code and one or more Proxy-authenticate headers with supported1650 authentication methods. This is the default.1651* `basic` - HTTP Basic authentication1652* `digest` - HTTP Digest authentication; this prevents the password from being1653 transmitted to the proxy in clear text1654* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1655 of `curl(1)`)1656* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1657--16581659http.emptyAuth::1660 Attempt authentication without seeking a username or password. This1661 can be used to attempt GSS-Negotiate authentication without specifying1662 a username in the URL, as libcurl normally requires a username for1663 authentication.16641665http.cookieFile::1666 File containing previously stored cookie lines which should be used1667 in the Git http session, if they match the server. The file format1668 of the file to read cookies from should be plain HTTP headers or1669 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1670 NOTE that the file specified with http.cookieFile is only used as1671 input unless http.saveCookies is set.16721673http.saveCookies::1674 If set, store cookies received during requests to the file specified by1675 http.cookieFile. Has no effect if http.cookieFile is unset.16761677http.sslVersion::1678 The SSL version to use when negotiating an SSL connection, if you1679 want to force the default. The available and default version1680 depend on whether libcurl was built against NSS or OpenSSL and the1681 particular configuration of the crypto library in use. Internally1682 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1683 documentation for more details on the format of this option and1684 for the ssl version supported. Actually the possible values of1685 this option are:16861687 - sslv21688 - sslv31689 - tlsv11690 - tlsv1.01691 - tlsv1.11692 - tlsv1.216931694+1695Can be overridden by the 'GIT_SSL_VERSION' environment variable.1696To force git to use libcurl's default ssl version and ignore any1697explicit http.sslversion option, set 'GIT_SSL_VERSION' to the1698empty string.16991700http.sslCipherList::1701 A list of SSL ciphers to use when negotiating an SSL connection.1702 The available ciphers depend on whether libcurl was built against1703 NSS or OpenSSL and the particular configuration of the crypto1704 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1705 option; see the libcurl documentation for more details on the format1706 of this list.1707+1708Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.1709To force git to use libcurl's default cipher list and ignore any1710explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the1711empty string.17121713http.sslVerify::1714 Whether to verify the SSL certificate when fetching or pushing1715 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1716 variable.17171718http.sslCert::1719 File containing the SSL certificate when fetching or pushing1720 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1721 variable.17221723http.sslKey::1724 File containing the SSL private key when fetching or pushing1725 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1726 variable.17271728http.sslCertPasswordProtected::1729 Enable Git's password prompt for the SSL certificate. Otherwise1730 OpenSSL will prompt the user, possibly many times, if the1731 certificate or private key is encrypted. Can be overridden by the1732 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.17331734http.sslCAInfo::1735 File containing the certificates to verify the peer with when1736 fetching or pushing over HTTPS. Can be overridden by the1737 'GIT_SSL_CAINFO' environment variable.17381739http.sslCAPath::1740 Path containing files with the CA certificates to verify the peer1741 with when fetching or pushing over HTTPS. Can be overridden1742 by the 'GIT_SSL_CAPATH' environment variable.17431744http.pinnedpubkey::1745 Public key of the https service. It may either be the filename of1746 a PEM or DER encoded public key file or a string starting with1747 'sha256//' followed by the base64 encoded sha256 hash of the1748 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1749 exit with an error if this option is set but not supported by1750 cURL.17511752http.sslTry::1753 Attempt to use AUTH SSL/TLS and encrypted data transfers1754 when connecting via regular FTP protocol. This might be needed1755 if the FTP server requires it for security reasons or you wish1756 to connect securely whenever remote FTP server supports it.1757 Default is false since it might trigger certificate verification1758 errors on misconfigured servers.17591760http.maxRequests::1761 How many HTTP requests to launch in parallel. Can be overridden1762 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.17631764http.minSessions::1765 The number of curl sessions (counted across slots) to be kept across1766 requests. They will not be ended with curl_easy_cleanup() until1767 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1768 value will be capped at 1. Defaults to 1.17691770http.postBuffer::1771 Maximum size in bytes of the buffer used by smart HTTP1772 transports when POSTing data to the remote system.1773 For requests larger than this buffer size, HTTP/1.1 and1774 Transfer-Encoding: chunked is used to avoid creating a1775 massive pack file locally. Default is 1 MiB, which is1776 sufficient for most requests.17771778http.lowSpeedLimit, http.lowSpeedTime::1779 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1780 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1781 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1782 'GIT_HTTP_LOW_SPEED_TIME' environment variables.17831784http.noEPSV::1785 A boolean which disables using of EPSV ftp command by curl.1786 This can helpful with some "poor" ftp servers which don't1787 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1788 environment variable. Default is false (curl will use EPSV).17891790http.userAgent::1791 The HTTP USER_AGENT string presented to an HTTP server. The default1792 value represents the version of the client Git such as git/1.7.1.1793 This option allows you to override this value to a more common value1794 such as Mozilla/4.0. This may be necessary, for instance, if1795 connecting through a firewall that restricts HTTP connections to a set1796 of common USER_AGENT strings (but not including those like git/1.7.1).1797 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.17981799http.<url>.*::1800 Any of the http.* options above can be applied selectively to some URLs.1801 For a config key to match a URL, each element of the config key is1802 compared to that of the URL, in the following order:1803+1804--1805. Scheme (e.g., `https` in `https://example.com/`). This field1806 must match exactly between the config key and the URL.18071808. Host/domain name (e.g., `example.com` in `https://example.com/`).1809 This field must match exactly between the config key and the URL.18101811. Port number (e.g., `8080` in `http://example.com:8080/`).1812 This field must match exactly between the config key and the URL.1813 Omitted port numbers are automatically converted to the correct1814 default for the scheme before matching.18151816. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1817 path field of the config key must match the path field of the URL1818 either exactly or as a prefix of slash-delimited path elements. This means1819 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1820 match on a slash (`/`) boundary. Longer matches take precedence (so a config1821 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1822 key with just path `foo/`).18231824. User name (e.g., `user` in `https://user@example.com/repo.git`). If1825 the config key has a user name it must match the user name in the1826 URL exactly. If the config key does not have a user name, that1827 config key will match a URL with any user name (including none),1828 but at a lower precedence than a config key with a user name.1829--1830+1831The list above is ordered by decreasing precedence; a URL that matches1832a config key's path is preferred to one that matches its user name. For example,1833if the URL is `https://user@example.com/foo/bar` a config key match of1834`https://example.com/foo` will be preferred over a config key match of1835`https://user@example.com`.1836+1837All URLs are normalized before attempting any matching (the password part,1838if embedded in the URL, is always ignored for matching purposes) so that1839equivalent URLs that are simply spelled differently will match properly.1840Environment variable settings always override any matches. The URLs that are1841matched against are those given directly to Git commands. This means any URLs1842visited as a result of a redirection do not participate in matching.18431844i18n.commitEncoding::1845 Character encoding the commit messages are stored in; Git itself1846 does not care per se, but this information is necessary e.g. when1847 importing commits from emails or in the gitk graphical history1848 browser (and possibly at other places in the future or in other1849 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.18501851i18n.logOutputEncoding::1852 Character encoding the commit messages are converted to when1853 running 'git log' and friends.18541855imap::1856 The configuration variables in the 'imap' section are described1857 in linkgit:git-imap-send[1].18581859index.version::1860 Specify the version with which new index files should be1861 initialized. This does not affect existing repositories.18621863init.templateDir::1864 Specify the directory from which templates will be copied.1865 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)18661867instaweb.browser::1868 Specify the program that will be used to browse your working1869 repository in gitweb. See linkgit:git-instaweb[1].18701871instaweb.httpd::1872 The HTTP daemon command-line to start gitweb on your working1873 repository. See linkgit:git-instaweb[1].18741875instaweb.local::1876 If true the web server started by linkgit:git-instaweb[1] will1877 be bound to the local IP (127.0.0.1).18781879instaweb.modulePath::1880 The default module path for linkgit:git-instaweb[1] to use1881 instead of /usr/lib/apache2/modules. Only used if httpd1882 is Apache.18831884instaweb.port::1885 The port number to bind the gitweb httpd to. See1886 linkgit:git-instaweb[1].18871888interactive.singleKey::1889 In interactive commands, allow the user to provide one-letter1890 input with a single key (i.e., without hitting enter).1891 Currently this is used by the `--patch` mode of1892 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1893 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1894 setting is silently ignored if portable keystroke input1895 is not available; requires the Perl module Term::ReadKey.18961897log.abbrevCommit::1898 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1899 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1900 override this option with `--no-abbrev-commit`.19011902log.date::1903 Set the default date-time mode for the 'log' command.1904 Setting a value for log.date is similar to using 'git log''s1905 `--date` option. See linkgit:git-log[1] for details.19061907log.decorate::1908 Print out the ref names of any commits that are shown by the log1909 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1910 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1911 specified, the full ref name (including prefix) will be printed.1912 This is the same as the log commands '--decorate' option.19131914log.follow::1915 If `true`, `git log` will act as if the `--follow` option was used when1916 a single <path> is given. This has the same limitations as `--follow`,1917 i.e. it cannot be used to follow multiple files and does not work well1918 on non-linear history.19191920log.showRoot::1921 If true, the initial commit will be shown as a big creation event.1922 This is equivalent to a diff against an empty tree.1923 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1924 normally hide the root commit will now show it. True by default.19251926log.mailmap::1927 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1928 linkgit:git-whatchanged[1] assume `--use-mailmap`.19291930mailinfo.scissors::1931 If true, makes linkgit:git-mailinfo[1] (and therefore1932 linkgit:git-am[1]) act by default as if the --scissors option1933 was provided on the command-line. When active, this features1934 removes everything from the message body before a scissors1935 line (i.e. consisting mainly of ">8", "8<" and "-").19361937mailmap.file::1938 The location of an augmenting mailmap file. The default1939 mailmap, located in the root of the repository, is loaded1940 first, then the mailmap file pointed to by this variable.1941 The location of the mailmap file may be in a repository1942 subdirectory, or somewhere outside of the repository itself.1943 See linkgit:git-shortlog[1] and linkgit:git-blame[1].19441945mailmap.blob::1946 Like `mailmap.file`, but consider the value as a reference to a1947 blob in the repository. If both `mailmap.file` and1948 `mailmap.blob` are given, both are parsed, with entries from1949 `mailmap.file` taking precedence. In a bare repository, this1950 defaults to `HEAD:.mailmap`. In a non-bare repository, it1951 defaults to empty.19521953man.viewer::1954 Specify the programs that may be used to display help in the1955 'man' format. See linkgit:git-help[1].19561957man.<tool>.cmd::1958 Specify the command to invoke the specified man viewer. The1959 specified command is evaluated in shell with the man page1960 passed as argument. (See linkgit:git-help[1].)19611962man.<tool>.path::1963 Override the path for the given tool that may be used to1964 display help in the 'man' format. See linkgit:git-help[1].19651966include::merge-config.txt[]19671968mergetool.<tool>.path::1969 Override the path for the given tool. This is useful in case1970 your tool is not in the PATH.19711972mergetool.<tool>.cmd::1973 Specify the command to invoke the specified merge tool. The1974 specified command is evaluated in shell with the following1975 variables available: 'BASE' is the name of a temporary file1976 containing the common base of the files to be merged, if available;1977 'LOCAL' is the name of a temporary file containing the contents of1978 the file on the current branch; 'REMOTE' is the name of a temporary1979 file containing the contents of the file from the branch being1980 merged; 'MERGED' contains the name of the file to which the merge1981 tool should write the results of a successful merge.19821983mergetool.<tool>.trustExitCode::1984 For a custom merge command, specify whether the exit code of1985 the merge command can be used to determine whether the merge was1986 successful. If this is not set to true then the merge target file1987 timestamp is checked and the merge assumed to have been successful1988 if the file has been updated, otherwise the user is prompted to1989 indicate the success of the merge.19901991mergetool.meld.hasOutput::1992 Older versions of `meld` do not support the `--output` option.1993 Git will attempt to detect whether `meld` supports `--output`1994 by inspecting the output of `meld --help`. Configuring1995 `mergetool.meld.hasOutput` will make Git skip these checks and1996 use the configured value instead. Setting `mergetool.meld.hasOutput`1997 to `true` tells Git to unconditionally use the `--output` option,1998 and `false` avoids using `--output`.19992000mergetool.keepBackup::2001 After performing a merge, the original file with conflict markers2002 can be saved as a file with a `.orig` extension. If this variable2003 is set to `false` then this file is not preserved. Defaults to2004 `true` (i.e. keep the backup files).20052006mergetool.keepTemporaries::2007 When invoking a custom merge tool, Git uses a set of temporary2008 files to pass to the tool. If the tool returns an error and this2009 variable is set to `true`, then these temporary files will be2010 preserved, otherwise they will be removed after the tool has2011 exited. Defaults to `false`.20122013mergetool.writeToTemp::2014 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2015 conflicting files in the worktree by default. Git will attempt2016 to use a temporary directory for these files when set `true`.2017 Defaults to `false`.20182019mergetool.prompt::2020 Prompt before each invocation of the merge resolution program.20212022notes.mergeStrategy::2023 Which merge strategy to choose by default when resolving notes2024 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2025 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2026 section of linkgit:git-notes[1] for more information on each strategy.20272028notes.<name>.mergeStrategy::2029 Which merge strategy to choose when doing a notes merge into2030 refs/notes/<name>. This overrides the more general2031 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2032 linkgit:git-notes[1] for more information on the available strategies.20332034notes.displayRef::2035 The (fully qualified) refname from which to show notes when2036 showing commit messages. The value of this variable can be set2037 to a glob, in which case notes from all matching refs will be2038 shown. You may also specify this configuration variable2039 several times. A warning will be issued for refs that do not2040 exist, but a glob that does not match any refs is silently2041 ignored.2042+2043This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2044environment variable, which must be a colon separated list of refs or2045globs.2046+2047The effective value of "core.notesRef" (possibly overridden by2048GIT_NOTES_REF) is also implicitly added to the list of refs to be2049displayed.20502051notes.rewrite.<command>::2052 When rewriting commits with <command> (currently `amend` or2053 `rebase`) and this variable is set to `true`, Git2054 automatically copies your notes from the original to the2055 rewritten commit. Defaults to `true`, but see2056 "notes.rewriteRef" below.20572058notes.rewriteMode::2059 When copying notes during a rewrite (see the2060 "notes.rewrite.<command>" option), determines what to do if2061 the target commit already has a note. Must be one of2062 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2063 Defaults to `concatenate`.2064+2065This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2066environment variable.20672068notes.rewriteRef::2069 When copying notes during a rewrite, specifies the (fully2070 qualified) ref whose notes should be copied. The ref may be a2071 glob, in which case notes in all matching refs will be copied.2072 You may also specify this configuration several times.2073+2074Does not have a default value; you must configure this variable to2075enable note rewriting. Set it to `refs/notes/commits` to enable2076rewriting for the default commit notes.2077+2078This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2079environment variable, which must be a colon separated list of refs or2080globs.20812082pack.window::2083 The size of the window used by linkgit:git-pack-objects[1] when no2084 window size is given on the command line. Defaults to 10.20852086pack.depth::2087 The maximum delta depth used by linkgit:git-pack-objects[1] when no2088 maximum depth is given on the command line. Defaults to 50.20892090pack.windowMemory::2091 The maximum size of memory that is consumed by each thread2092 in linkgit:git-pack-objects[1] for pack window memory when2093 no limit is given on the command line. The value can be2094 suffixed with "k", "m", or "g". When left unconfigured (or2095 set explicitly to 0), there will be no limit.20962097pack.compression::2098 An integer -1..9, indicating the compression level for objects2099 in a pack file. -1 is the zlib default. 0 means no2100 compression, and 1..9 are various speed/size tradeoffs, 9 being2101 slowest. If not set, defaults to core.compression. If that is2102 not set, defaults to -1, the zlib default, which is "a default2103 compromise between speed and compression (currently equivalent2104 to level 6)."2105+2106Note that changing the compression level will not automatically recompress2107all existing objects. You can force recompression by passing the -F option2108to linkgit:git-repack[1].21092110pack.deltaCacheSize::2111 The maximum memory in bytes used for caching deltas in2112 linkgit:git-pack-objects[1] before writing them out to a pack.2113 This cache is used to speed up the writing object phase by not2114 having to recompute the final delta result once the best match2115 for all objects is found. Repacking large repositories on machines2116 which are tight with memory might be badly impacted by this though,2117 especially if this cache pushes the system into swapping.2118 A value of 0 means no limit. The smallest size of 1 byte may be2119 used to virtually disable this cache. Defaults to 256 MiB.21202121pack.deltaCacheLimit::2122 The maximum size of a delta, that is cached in2123 linkgit:git-pack-objects[1]. This cache is used to speed up the2124 writing object phase by not having to recompute the final delta2125 result once the best match for all objects is found. Defaults to 1000.21262127pack.threads::2128 Specifies the number of threads to spawn when searching for best2129 delta matches. This requires that linkgit:git-pack-objects[1]2130 be compiled with pthreads otherwise this option is ignored with a2131 warning. This is meant to reduce packing time on multiprocessor2132 machines. The required amount of memory for the delta search window2133 is however multiplied by the number of threads.2134 Specifying 0 will cause Git to auto-detect the number of CPU's2135 and set the number of threads accordingly.21362137pack.indexVersion::2138 Specify the default pack index version. Valid values are 1 for2139 legacy pack index used by Git versions prior to 1.5.2, and 2 for2140 the new pack index with capabilities for packs larger than 4 GB2141 as well as proper protection against the repacking of corrupted2142 packs. Version 2 is the default. Note that version 2 is enforced2143 and this config option ignored whenever the corresponding pack is2144 larger than 2 GB.2145+2146If you have an old Git that does not understand the version 2 `*.idx` file,2147cloning or fetching over a non native protocol (e.g. "http")2148that will copy both `*.pack` file and corresponding `*.idx` file from the2149other side may give you a repository that cannot be accessed with your2150older version of Git. If the `*.pack` file is smaller than 2 GB, however,2151you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2152the `*.idx` file.21532154pack.packSizeLimit::2155 The maximum size of a pack. This setting only affects2156 packing to a file when repacking, i.e. the git:// protocol2157 is unaffected. It can be overridden by the `--max-pack-size`2158 option of linkgit:git-repack[1]. Reaching this limit results2159 in the creation of multiple packfiles; which in turn prevents2160 bitmaps from being created.2161 The minimum size allowed is limited to 1 MiB.2162 The default is unlimited.2163 Common unit suffixes of 'k', 'm', or 'g' are2164 supported.21652166pack.useBitmaps::2167 When true, git will use pack bitmaps (if available) when packing2168 to stdout (e.g., during the server side of a fetch). Defaults to2169 true. You should not generally need to turn this off unless2170 you are debugging pack bitmaps.21712172pack.writeBitmaps (deprecated)::2173 This is a deprecated synonym for `repack.writeBitmaps`.21742175pack.writeBitmapHashCache::2176 When true, git will include a "hash cache" section in the bitmap2177 index (if one is written). This cache can be used to feed git's2178 delta heuristics, potentially leading to better deltas between2179 bitmapped and non-bitmapped objects (e.g., when serving a fetch2180 between an older, bitmapped pack and objects that have been2181 pushed since the last gc). The downside is that it consumes 42182 bytes per object of disk space, and that JGit's bitmap2183 implementation does not understand it, causing it to complain if2184 Git and JGit are used on the same repository. Defaults to false.21852186pager.<cmd>::2187 If the value is boolean, turns on or off pagination of the2188 output of a particular Git subcommand when writing to a tty.2189 Otherwise, turns on pagination for the subcommand using the2190 pager specified by the value of `pager.<cmd>`. If `--paginate`2191 or `--no-pager` is specified on the command line, it takes2192 precedence over this option. To disable pagination for all2193 commands, set `core.pager` or `GIT_PAGER` to `cat`.21942195pretty.<name>::2196 Alias for a --pretty= format string, as specified in2197 linkgit:git-log[1]. Any aliases defined here can be used just2198 as the built-in pretty formats could. For example,2199 running `git config pretty.changelog "format:* %H %s"`2200 would cause the invocation `git log --pretty=changelog`2201 to be equivalent to running `git log "--pretty=format:* %H %s"`.2202 Note that an alias with the same name as a built-in format2203 will be silently ignored.22042205pull.ff::2206 By default, Git does not create an extra merge commit when merging2207 a commit that is a descendant of the current commit. Instead, the2208 tip of the current branch is fast-forwarded. When set to `false`,2209 this variable tells Git to create an extra merge commit in such2210 a case (equivalent to giving the `--no-ff` option from the command2211 line). When set to `only`, only such fast-forward merges are2212 allowed (equivalent to giving the `--ff-only` option from the2213 command line). This setting overrides `merge.ff` when pulling.22142215pull.rebase::2216 When true, rebase branches on top of the fetched branch, instead2217 of merging the default branch from the default remote when "git2218 pull" is run. See "branch.<name>.rebase" for setting this on a2219 per-branch basis.2220+2221When preserve, also pass `--preserve-merges` along to 'git rebase'2222so that locally committed merge commits will not be flattened2223by running 'git pull'.2224+2225When the value is `interactive`, the rebase is run in interactive mode.2226+2227*NOTE*: this is a possibly dangerous operation; do *not* use2228it unless you understand the implications (see linkgit:git-rebase[1]2229for details).22302231pull.octopus::2232 The default merge strategy to use when pulling multiple branches2233 at once.22342235pull.twohead::2236 The default merge strategy to use when pulling a single branch.22372238push.default::2239 Defines the action `git push` should take if no refspec is2240 explicitly given. Different values are well-suited for2241 specific workflows; for instance, in a purely central workflow2242 (i.e. the fetch source is equal to the push destination),2243 `upstream` is probably what you want. Possible values are:2244+2245--22462247* `nothing` - do not push anything (error out) unless a refspec is2248 explicitly given. This is primarily meant for people who want to2249 avoid mistakes by always being explicit.22502251* `current` - push the current branch to update a branch with the same2252 name on the receiving end. Works in both central and non-central2253 workflows.22542255* `upstream` - push the current branch back to the branch whose2256 changes are usually integrated into the current branch (which is2257 called `@{upstream}`). This mode only makes sense if you are2258 pushing to the same repository you would normally pull from2259 (i.e. central workflow).22602261* `simple` - in centralized workflow, work like `upstream` with an2262 added safety to refuse to push if the upstream branch's name is2263 different from the local one.2264+2265When pushing to a remote that is different from the remote you normally2266pull from, work as `current`. This is the safest option and is suited2267for beginners.2268+2269This mode has become the default in Git 2.0.22702271* `matching` - push all branches having the same name on both ends.2272 This makes the repository you are pushing to remember the set of2273 branches that will be pushed out (e.g. if you always push 'maint'2274 and 'master' there and no other branches, the repository you push2275 to will have these two branches, and your local 'maint' and2276 'master' will be pushed there).2277+2278To use this mode effectively, you have to make sure _all_ the2279branches you would push out are ready to be pushed out before2280running 'git push', as the whole point of this mode is to allow you2281to push all of the branches in one go. If you usually finish work2282on only one branch and push out the result, while other branches are2283unfinished, this mode is not for you. Also this mode is not2284suitable for pushing into a shared central repository, as other2285people may add new branches there, or update the tip of existing2286branches outside your control.2287+2288This used to be the default, but not since Git 2.0 (`simple` is the2289new default).22902291--22922293push.followTags::2294 If set to true enable '--follow-tags' option by default. You2295 may override this configuration at time of push by specifying2296 '--no-follow-tags'.22972298push.gpgSign::2299 May be set to a boolean value, or the string 'if-asked'. A true2300 value causes all pushes to be GPG signed, as if '--signed' is2301 passed to linkgit:git-push[1]. The string 'if-asked' causes2302 pushes to be signed if the server supports it, as if2303 '--signed=if-asked' is passed to 'git push'. A false value may2304 override a value from a lower-priority config file. An explicit2305 command-line flag always overrides this config option.23062307push.recurseSubmodules::2308 Make sure all submodule commits used by the revisions to be pushed2309 are available on a remote-tracking branch. If the value is 'check'2310 then Git will verify that all submodule commits that changed in the2311 revisions to be pushed are available on at least one remote of the2312 submodule. If any commits are missing, the push will be aborted and2313 exit with non-zero status. If the value is 'on-demand' then all2314 submodules that changed in the revisions to be pushed will be2315 pushed. If on-demand was not able to push all necessary revisions2316 it will also be aborted and exit with non-zero status. If the value2317 is 'no' then default behavior of ignoring submodules when pushing2318 is retained. You may override this configuration at time of push by2319 specifying '--recurse-submodules=check|on-demand|no'.23202321rebase.stat::2322 Whether to show a diffstat of what changed upstream since the last2323 rebase. False by default.23242325rebase.autoSquash::2326 If set to true enable '--autosquash' option by default.23272328rebase.autoStash::2329 When set to true, automatically create a temporary stash2330 before the operation begins, and apply it after the operation2331 ends. This means that you can run rebase on a dirty worktree.2332 However, use with care: the final stash application after a2333 successful rebase might result in non-trivial conflicts.2334 Defaults to false.23352336rebase.missingCommitsCheck::2337 If set to "warn", git rebase -i will print a warning if some2338 commits are removed (e.g. a line was deleted), however the2339 rebase will still proceed. If set to "error", it will print2340 the previous warning and stop the rebase, 'git rebase2341 --edit-todo' can then be used to correct the error. If set to2342 "ignore", no checking is done.2343 To drop a commit without warning or error, use the `drop`2344 command in the todo-list.2345 Defaults to "ignore".23462347rebase.instructionFormat2348 A format string, as specified in linkgit:git-log[1], to be used for2349 the instruction list during an interactive rebase. The format will automatically2350 have the long commit hash prepended to the format.23512352receive.advertiseAtomic::2353 By default, git-receive-pack will advertise the atomic push2354 capability to its clients. If you don't want to this capability2355 to be advertised, set this variable to false.23562357receive.autogc::2358 By default, git-receive-pack will run "git-gc --auto" after2359 receiving data from git-push and updating refs. You can stop2360 it by setting this variable to false.23612362receive.certNonceSeed::2363 By setting this variable to a string, `git receive-pack`2364 will accept a `git push --signed` and verifies it by using2365 a "nonce" protected by HMAC using this string as a secret2366 key.23672368receive.certNonceSlop::2369 When a `git push --signed` sent a push certificate with a2370 "nonce" that was issued by a receive-pack serving the same2371 repository within this many seconds, export the "nonce"2372 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2373 hooks (instead of what the receive-pack asked the sending2374 side to include). This may allow writing checks in2375 `pre-receive` and `post-receive` a bit easier. Instead of2376 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2377 that records by how many seconds the nonce is stale to2378 decide if they want to accept the certificate, they only2379 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.23802381receive.fsckObjects::2382 If it is set to true, git-receive-pack will check all received2383 objects. It will abort in the case of a malformed object or a2384 broken link. The result of an abort are only dangling objects.2385 Defaults to false. If not set, the value of `transfer.fsckObjects`2386 is used instead.23872388receive.fsck.<msg-id>::2389 When `receive.fsckObjects` is set to true, errors can be switched2390 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2391 setting where the `<msg-id>` is the fsck message ID and the value2392 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2393 the error/warning with the message ID, e.g. "missingEmail: invalid2394 author/committer line - missing email" means that setting2395 `receive.fsck.missingEmail = ignore` will hide that issue.2396+2397This feature is intended to support working with legacy repositories2398which would not pass pushing when `receive.fsckObjects = true`, allowing2399the host to accept repositories with certain known issues but still catch2400other issues.24012402receive.fsck.skipList::2403 The path to a sorted list of object names (i.e. one SHA-1 per2404 line) that are known to be broken in a non-fatal way and should2405 be ignored. This feature is useful when an established project2406 should be accepted despite early commits containing errors that2407 can be safely ignored such as invalid committer email addresses.2408 Note: corrupt objects cannot be skipped with this setting.24092410receive.unpackLimit::2411 If the number of objects received in a push is below this2412 limit then the objects will be unpacked into loose object2413 files. However if the number of received objects equals or2414 exceeds this limit then the received pack will be stored as2415 a pack, after adding any missing delta bases. Storing the2416 pack from a push can make the push operation complete faster,2417 especially on slow filesystems. If not set, the value of2418 `transfer.unpackLimit` is used instead.24192420receive.denyDeletes::2421 If set to true, git-receive-pack will deny a ref update that deletes2422 the ref. Use this to prevent such a ref deletion via a push.24232424receive.denyDeleteCurrent::2425 If set to true, git-receive-pack will deny a ref update that2426 deletes the currently checked out branch of a non-bare repository.24272428receive.denyCurrentBranch::2429 If set to true or "refuse", git-receive-pack will deny a ref update2430 to the currently checked out branch of a non-bare repository.2431 Such a push is potentially dangerous because it brings the HEAD2432 out of sync with the index and working tree. If set to "warn",2433 print a warning of such a push to stderr, but allow the push to2434 proceed. If set to false or "ignore", allow such pushes with no2435 message. Defaults to "refuse".2436+2437Another option is "updateInstead" which will update the working2438tree if pushing into the current branch. This option is2439intended for synchronizing working directories when one side is not easily2440accessible via interactive ssh (e.g. a live web site, hence the requirement2441that the working directory be clean). This mode also comes in handy when2442developing inside a VM to test and fix code on different Operating Systems.2443+2444By default, "updateInstead" will refuse the push if the working tree or2445the index have any difference from the HEAD, but the `push-to-checkout`2446hook can be used to customize this. See linkgit:githooks[5].24472448receive.denyNonFastForwards::2449 If set to true, git-receive-pack will deny a ref update which is2450 not a fast-forward. Use this to prevent such an update via a push,2451 even if that push is forced. This configuration variable is2452 set when initializing a shared repository.24532454receive.hideRefs::2455 This variable is the same as `transfer.hideRefs`, but applies2456 only to `receive-pack` (and so affects pushes, but not fetches).2457 An attempt to update or delete a hidden ref by `git push` is2458 rejected.24592460receive.updateServerInfo::2461 If set to true, git-receive-pack will run git-update-server-info2462 after receiving data from git-push and updating refs.24632464receive.shallowUpdate::2465 If set to true, .git/shallow can be updated when new refs2466 require new shallow roots. Otherwise those refs are rejected.24672468remote.pushDefault::2469 The remote to push to by default. Overrides2470 `branch.<name>.remote` for all branches, and is overridden by2471 `branch.<name>.pushRemote` for specific branches.24722473remote.<name>.url::2474 The URL of a remote repository. See linkgit:git-fetch[1] or2475 linkgit:git-push[1].24762477remote.<name>.pushurl::2478 The push URL of a remote repository. See linkgit:git-push[1].24792480remote.<name>.proxy::2481 For remotes that require curl (http, https and ftp), the URL to2482 the proxy to use for that remote. Set to the empty string to2483 disable proxying for that remote.24842485remote.<name>.proxyAuthMethod::2486 For remotes that require curl (http, https and ftp), the method to use for2487 authenticating against the proxy in use (probably set in2488 `remote.<name>.proxy`). See `http.proxyAuthMethod`.24892490remote.<name>.fetch::2491 The default set of "refspec" for linkgit:git-fetch[1]. See2492 linkgit:git-fetch[1].24932494remote.<name>.push::2495 The default set of "refspec" for linkgit:git-push[1]. See2496 linkgit:git-push[1].24972498remote.<name>.mirror::2499 If true, pushing to this remote will automatically behave2500 as if the `--mirror` option was given on the command line.25012502remote.<name>.skipDefaultUpdate::2503 If true, this remote will be skipped by default when updating2504 using linkgit:git-fetch[1] or the `update` subcommand of2505 linkgit:git-remote[1].25062507remote.<name>.skipFetchAll::2508 If true, this remote will be skipped by default when updating2509 using linkgit:git-fetch[1] or the `update` subcommand of2510 linkgit:git-remote[1].25112512remote.<name>.receivepack::2513 The default program to execute on the remote side when pushing. See2514 option --receive-pack of linkgit:git-push[1].25152516remote.<name>.uploadpack::2517 The default program to execute on the remote side when fetching. See2518 option --upload-pack of linkgit:git-fetch-pack[1].25192520remote.<name>.tagOpt::2521 Setting this value to --no-tags disables automatic tag following when2522 fetching from remote <name>. Setting it to --tags will fetch every2523 tag from remote <name>, even if they are not reachable from remote2524 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2525 override this setting. See options --tags and --no-tags of2526 linkgit:git-fetch[1].25272528remote.<name>.vcs::2529 Setting this to a value <vcs> will cause Git to interact with2530 the remote with the git-remote-<vcs> helper.25312532remote.<name>.prune::2533 When set to true, fetching from this remote by default will also2534 remove any remote-tracking references that no longer exist on the2535 remote (as if the `--prune` option was given on the command line).2536 Overrides `fetch.prune` settings, if any.25372538remotes.<group>::2539 The list of remotes which are fetched by "git remote update2540 <group>". See linkgit:git-remote[1].25412542repack.useDeltaBaseOffset::2543 By default, linkgit:git-repack[1] creates packs that use2544 delta-base offset. If you need to share your repository with2545 Git older than version 1.4.4, either directly or via a dumb2546 protocol such as http, then you need to set this option to2547 "false" and repack. Access from old Git versions over the2548 native protocol are unaffected by this option.25492550repack.packKeptObjects::2551 If set to true, makes `git repack` act as if2552 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2553 details. Defaults to `false` normally, but `true` if a bitmap2554 index is being written (either via `--write-bitmap-index` or2555 `repack.writeBitmaps`).25562557repack.writeBitmaps::2558 When true, git will write a bitmap index when packing all2559 objects to disk (e.g., when `git repack -a` is run). This2560 index can speed up the "counting objects" phase of subsequent2561 packs created for clones and fetches, at the cost of some disk2562 space and extra time spent on the initial repack. This has2563 no effect if multiple packfiles are created.2564 Defaults to false.25652566rerere.autoUpdate::2567 When set to true, `git-rerere` updates the index with the2568 resulting contents after it cleanly resolves conflicts using2569 previously recorded resolution. Defaults to false.25702571rerere.enabled::2572 Activate recording of resolved conflicts, so that identical2573 conflict hunks can be resolved automatically, should they be2574 encountered again. By default, linkgit:git-rerere[1] is2575 enabled if there is an `rr-cache` directory under the2576 `$GIT_DIR`, e.g. if "rerere" was previously used in the2577 repository.25782579sendemail.identity::2580 A configuration identity. When given, causes values in the2581 'sendemail.<identity>' subsection to take precedence over2582 values in the 'sendemail' section. The default identity is2583 the value of 'sendemail.identity'.25842585sendemail.smtpEncryption::2586 See linkgit:git-send-email[1] for description. Note that this2587 setting is not subject to the 'identity' mechanism.25882589sendemail.smtpssl (deprecated)::2590 Deprecated alias for 'sendemail.smtpEncryption = ssl'.25912592sendemail.smtpsslcertpath::2593 Path to ca-certificates (either a directory or a single file).2594 Set it to an empty string to disable certificate verification.25952596sendemail.<identity>.*::2597 Identity-specific versions of the 'sendemail.*' parameters2598 found below, taking precedence over those when the this2599 identity is selected, through command-line or2600 'sendemail.identity'.26012602sendemail.aliasesFile::2603sendemail.aliasFileType::2604sendemail.annotate::2605sendemail.bcc::2606sendemail.cc::2607sendemail.ccCmd::2608sendemail.chainReplyTo::2609sendemail.confirm::2610sendemail.envelopeSender::2611sendemail.from::2612sendemail.multiEdit::2613sendemail.signedoffbycc::2614sendemail.smtpPass::2615sendemail.suppresscc::2616sendemail.suppressFrom::2617sendemail.to::2618sendemail.smtpDomain::2619sendemail.smtpServer::2620sendemail.smtpServerPort::2621sendemail.smtpServerOption::2622sendemail.smtpUser::2623sendemail.thread::2624sendemail.transferEncoding::2625sendemail.validate::2626sendemail.xmailer::2627 See linkgit:git-send-email[1] for description.26282629sendemail.signedoffcc (deprecated)::2630 Deprecated alias for 'sendemail.signedoffbycc'.26312632showbranch.default::2633 The default set of branches for linkgit:git-show-branch[1].2634 See linkgit:git-show-branch[1].26352636status.relativePaths::2637 By default, linkgit:git-status[1] shows paths relative to the2638 current directory. Setting this variable to `false` shows paths2639 relative to the repository root (this was the default for Git2640 prior to v1.5.4).26412642status.short::2643 Set to true to enable --short by default in linkgit:git-status[1].2644 The option --no-short takes precedence over this variable.26452646status.branch::2647 Set to true to enable --branch by default in linkgit:git-status[1].2648 The option --no-branch takes precedence over this variable.26492650status.displayCommentPrefix::2651 If set to true, linkgit:git-status[1] will insert a comment2652 prefix before each output line (starting with2653 `core.commentChar`, i.e. `#` by default). This was the2654 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2655 Defaults to false.26562657status.showUntrackedFiles::2658 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2659 files which are not currently tracked by Git. Directories which2660 contain only untracked files, are shown with the directory name2661 only. Showing untracked files means that Git needs to lstat() all2662 the files in the whole repository, which might be slow on some2663 systems. So, this variable controls how the commands displays2664 the untracked files. Possible values are:2665+2666--2667* `no` - Show no untracked files.2668* `normal` - Show untracked files and directories.2669* `all` - Show also individual files in untracked directories.2670--2671+2672If this variable is not specified, it defaults to 'normal'.2673This variable can be overridden with the -u|--untracked-files option2674of linkgit:git-status[1] and linkgit:git-commit[1].26752676status.submoduleSummary::2677 Defaults to false.2678 If this is set to a non zero number or true (identical to -1 or an2679 unlimited number), the submodule summary will be enabled and a2680 summary of commits for modified submodules will be shown (see2681 --summary-limit option of linkgit:git-submodule[1]). Please note2682 that the summary output command will be suppressed for all2683 submodules when `diff.ignoreSubmodules` is set to 'all' or only2684 for those submodules where `submodule.<name>.ignore=all`. The only2685 exception to that rule is that status and commit will show staged2686 submodule changes. To2687 also view the summary for ignored submodules you can either use2688 the --ignore-submodules=dirty command-line option or the 'git2689 submodule summary' command, which shows a similar output but does2690 not honor these settings.26912692stash.showPatch::2693 If this is set to true, the `git stash show` command without an2694 option will show the stash in patch form. Defaults to false.2695 See description of 'show' command in linkgit:git-stash[1].26962697stash.showStat::2698 If this is set to true, the `git stash show` command without an2699 option will show diffstat of the stash. Defaults to true.2700 See description of 'show' command in linkgit:git-stash[1].27012702submodule.<name>.path::2703submodule.<name>.url::2704 The path within this project and URL for a submodule. These2705 variables are initially populated by 'git submodule init'. See2706 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2707 details.27082709submodule.<name>.update::2710 The default update procedure for a submodule. This variable2711 is populated by `git submodule init` from the2712 linkgit:gitmodules[5] file. See description of 'update'2713 command in linkgit:git-submodule[1].27142715submodule.<name>.branch::2716 The remote branch name for a submodule, used by `git submodule2717 update --remote`. Set this option to override the value found in2718 the `.gitmodules` file. See linkgit:git-submodule[1] and2719 linkgit:gitmodules[5] for details.27202721submodule.<name>.fetchRecurseSubmodules::2722 This option can be used to control recursive fetching of this2723 submodule. It can be overridden by using the --[no-]recurse-submodules2724 command-line option to "git fetch" and "git pull".2725 This setting will override that from in the linkgit:gitmodules[5]2726 file.27272728submodule.<name>.ignore::2729 Defines under what circumstances "git status" and the diff family show2730 a submodule as modified. When set to "all", it will never be considered2731 modified (but it will nonetheless show up in the output of status and2732 commit when it has been staged), "dirty" will ignore all changes2733 to the submodules work tree and2734 takes only differences between the HEAD of the submodule and the commit2735 recorded in the superproject into account. "untracked" will additionally2736 let submodules with modified tracked files in their work tree show up.2737 Using "none" (the default when this option is not set) also shows2738 submodules that have untracked files in their work tree as changed.2739 This setting overrides any setting made in .gitmodules for this submodule,2740 both settings can be overridden on the command line by using the2741 "--ignore-submodules" option. The 'git submodule' commands are not2742 affected by this setting.27432744tag.sort::2745 This variable controls the sort ordering of tags when displayed by2746 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2747 value of this variable will be used as the default.27482749tar.umask::2750 This variable can be used to restrict the permission bits of2751 tar archive entries. The default is 0002, which turns off the2752 world write bit. The special value "user" indicates that the2753 archiving user's umask will be used instead. See umask(2) and2754 linkgit:git-archive[1].27552756transfer.fsckObjects::2757 When `fetch.fsckObjects` or `receive.fsckObjects` are2758 not set, the value of this variable is used instead.2759 Defaults to false.27602761transfer.hideRefs::2762 String(s) `receive-pack` and `upload-pack` use to decide which2763 refs to omit from their initial advertisements. Use more than2764 one definition to specify multiple prefix strings. A ref that is2765 under the hierarchies listed in the value of this variable is2766 excluded, and is hidden when responding to `git push` or `git2767 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2768 program-specific versions of this config.2769+2770You may also include a `!` in front of the ref name to negate the entry,2771explicitly exposing it, even if an earlier entry marked it as hidden.2772If you have multiple hideRefs values, later entries override earlier ones2773(and entries in more-specific config files override less-specific ones).2774+2775If a namespace is in use, the namespace prefix is stripped from each2776reference before it is matched against `transfer.hiderefs` patterns.2777For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2778the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2779is omitted from the advertisements but `refs/heads/master` and2780`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2781"have" lines. In order to match refs before stripping, add a `^` in front of2782the ref name. If you combine `!` and `^`, `!` must be specified first.27832784transfer.unpackLimit::2785 When `fetch.unpackLimit` or `receive.unpackLimit` are2786 not set, the value of this variable is used instead.2787 The default value is 100.27882789uploadarchive.allowUnreachable::2790 If true, allow clients to use `git archive --remote` to request2791 any tree, whether reachable from the ref tips or not. See the2792 discussion in the `SECURITY` section of2793 linkgit:git-upload-archive[1] for more details. Defaults to2794 `false`.27952796uploadpack.hideRefs::2797 This variable is the same as `transfer.hideRefs`, but applies2798 only to `upload-pack` (and so affects only fetches, not pushes).2799 An attempt to fetch a hidden ref by `git fetch` will fail. See2800 also `uploadpack.allowTipSHA1InWant`.28012802uploadpack.allowTipSHA1InWant::2803 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2804 to accept a fetch request that asks for an object at the tip2805 of a hidden ref (by default, such a request is rejected).2806 see also `uploadpack.hideRefs`.28072808uploadpack.allowReachableSHA1InWant::2809 Allow `upload-pack` to accept a fetch request that asks for an2810 object that is reachable from any ref tip. However, note that2811 calculating object reachability is computationally expensive.2812 Defaults to `false`.28132814uploadpack.keepAlive::2815 When `upload-pack` has started `pack-objects`, there may be a2816 quiet period while `pack-objects` prepares the pack. Normally2817 it would output progress information, but if `--quiet` was used2818 for the fetch, `pack-objects` will output nothing at all until2819 the pack data begins. Some clients and networks may consider2820 the server to be hung and give up. Setting this option instructs2821 `upload-pack` to send an empty keepalive packet every2822 `uploadpack.keepAlive` seconds. Setting this option to 02823 disables keepalive packets entirely. The default is 5 seconds.28242825url.<base>.insteadOf::2826 Any URL that starts with this value will be rewritten to2827 start, instead, with <base>. In cases where some site serves a2828 large number of repositories, and serves them with multiple2829 access methods, and some users need to use different access2830 methods, this feature allows people to specify any of the2831 equivalent URLs and have Git automatically rewrite the URL to2832 the best alternative for the particular user, even for a2833 never-before-seen repository on the site. When more than one2834 insteadOf strings match a given URL, the longest match is used.28352836url.<base>.pushInsteadOf::2837 Any URL that starts with this value will not be pushed to;2838 instead, it will be rewritten to start with <base>, and the2839 resulting URL will be pushed to. In cases where some site serves2840 a large number of repositories, and serves them with multiple2841 access methods, some of which do not allow push, this feature2842 allows people to specify a pull-only URL and have Git2843 automatically use an appropriate URL to push, even for a2844 never-before-seen repository on the site. When more than one2845 pushInsteadOf strings match a given URL, the longest match is2846 used. If a remote has an explicit pushurl, Git will ignore this2847 setting for that remote.28482849user.email::2850 Your email address to be recorded in any newly created commits.2851 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2852 'EMAIL' environment variables. See linkgit:git-commit-tree[1].28532854user.name::2855 Your full name to be recorded in any newly created commits.2856 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2857 environment variables. See linkgit:git-commit-tree[1].28582859user.useConfigOnly::2860 Instruct Git to avoid trying to guess defaults for 'user.email'2861 and 'user.name', and instead retrieve the values only from the2862 configuration. For example, if you have multiple email addresses2863 and would like to use a different one for each repository, then2864 with this configuration option set to `true` in the global config2865 along with a name, Git will prompt you to set up an email before2866 making new commits in a newly cloned repository.2867 Defaults to `false`.28682869user.signingKey::2870 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2871 key you want it to automatically when creating a signed tag or2872 commit, you can override the default selection with this variable.2873 This option is passed unchanged to gpg's --local-user parameter,2874 so you may specify a key using any method that gpg supports.28752876versionsort.prereleaseSuffix::2877 When version sort is used in linkgit:git-tag[1], prerelease2878 tags (e.g. "1.0-rc1") may appear after the main release2879 "1.0". By specifying the suffix "-rc" in this variable,2880 "1.0-rc1" will appear before "1.0".2881+2882This variable can be specified multiple times, once per suffix. The2883order of suffixes in the config file determines the sorting order2884(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2885is sorted before 1.0-rcXX). The sorting order between different2886suffixes is undefined if they are in multiple config files.28872888web.browser::2889 Specify a web browser that may be used by some commands.2890 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2891 may use it.