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'. If there is no equal sign on the line, the entire line 58is taken as 'name' and the variable is recognized as boolean "true". 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62Leading and trailing whitespace in a variable value is discarded. 63Internal whitespace within a variable value is retained verbatim. 64 65The values following the equals sign in variable assign are all either 66a string, an integer, or a boolean. Boolean values may be given as yes/no, 671/0, true/false or on/off. Case is not significant in boolean values, when 68converting value to the canonical form using '--bool' type specifier; 69'git config' will ensure that the output is "true" or "false". 70 71String values may be entirely or partially enclosed in double quotes. 72You need to enclose variable values in double quotes if you want to 73preserve leading or trailing whitespace, or if the variable value contains 74comment characters (i.e. it contains '#' or ';'). 75Double quote `"` and backslash `\` characters in variable values must 76be escaped: use `\"` for `"` and `\\` for `\`. 77 78The following escape sequences (beside `\"` and `\\`) are recognized: 79`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 80and `\b` for backspace (BS). No other char escape sequence, nor octal 81char sequences are valid. 82 83Variable values ending in a `\` are continued on the next line in the 84customary UNIX fashion. 85 86Some variables may require a special value format. 87 88Includes 89~~~~~~~~ 90 91You can include one config file from another by setting the special 92`include.path` variable to the name of the file to be included. The 93included file is expanded immediately, as if its contents had been 94found at the location of the include directive. If the value of the 95`include.path` variable is a relative path, the path is considered to be 96relative to the configuration file in which the include directive was 97found. The value of `include.path` is subject to tilde expansion: `~/` 98is expanded to the value of `$HOME`, and `~user/` to the specified 99user's home directory. See below for examples. 100 101Example 102~~~~~~~ 103 104 # Core variables 105 [core] 106 ; Don't trust file modes 107 filemode = false 108 109 # Our diff algorithm 110 [diff] 111 external = /usr/local/bin/diff-wrapper 112 renames = true 113 114 [branch "devel"] 115 remote = origin 116 merge = refs/heads/devel 117 118 # Proxy settings 119 [core] 120 gitProxy="ssh" for "kernel.org" 121 gitProxy=default-proxy ; for the rest 122 123 [include] 124 path = /path/to/foo.inc ; include by absolute path 125 path = foo ; expand "foo" relative to the current file 126 path = ~/foo ; expand "foo" in your $HOME directory 127 128Variables 129~~~~~~~~~ 130 131Note that this list is non-comprehensive and not necessarily complete. 132For command-specific variables, you will find a more detailed description 133in the appropriate manual page. You will find a description of non-core 134porcelain configuration variables in the respective porcelain documentation. 135 136advice.*:: 137 These variables control various optional help messages designed to 138 aid new users. All 'advice.*' variables default to 'true', and you 139 can tell Git that you do not need help by setting these to 'false': 140+ 141-- 142 pushUpdateRejected:: 143 Set this variable to 'false' if you want to disable 144 'pushNonFFCurrent', 'pushNonFFDefault', 145 'pushNonFFMatching', 'pushAlreadyExists', 146 'pushFetchFirst', and 'pushNeedsForce' 147 simultaneously. 148 pushNonFFCurrent:: 149 Advice shown when linkgit:git-push[1] fails due to a 150 non-fast-forward update to the current branch. 151 pushNonFFDefault:: 152 Advice to set 'push.default' to 'upstream' or 'current' 153 when you ran linkgit:git-push[1] and pushed 'matching 154 refs' by default (i.e. you did not provide an explicit 155 refspec, and no 'push.default' configuration was set) 156 and it resulted in a non-fast-forward error. 157 pushNonFFMatching:: 158 Advice shown when you ran linkgit:git-push[1] and pushed 159 'matching refs' explicitly (i.e. you used ':', or 160 specified a refspec that isn't your current branch) and 161 it resulted in a non-fast-forward error. 162 pushAlreadyExists:: 163 Shown when linkgit:git-push[1] rejects an update that 164 does not qualify for fast-forwarding (e.g., a tag.) 165 pushFetchFirst:: 166 Shown when linkgit:git-push[1] rejects an update that 167 tries to overwrite a remote ref that points at an 168 object we do not have. 169 pushNeedsForce:: 170 Shown when linkgit:git-push[1] rejects an update that 171 tries to overwrite a remote ref that points at an 172 object that is not a commit-ish, or make the remote 173 ref point at an object that is not a commit-ish. 174 statusHints:: 175 Show directions on how to proceed from the current 176 state in the output of linkgit:git-status[1], in 177 the template shown when writing commit messages in 178 linkgit:git-commit[1], and in the help message shown 179 by linkgit:git-checkout[1] when switching branch. 180 statusUoption:: 181 Advise to consider using the `-u` option to linkgit:git-status[1] 182 when the command takes more than 2 seconds to enumerate untracked 183 files. 184 commitBeforeMerge:: 185 Advice shown when linkgit:git-merge[1] refuses to 186 merge to avoid overwriting local changes. 187 resolveConflict:: 188 Advice shown by various commands when conflicts 189 prevent the operation from being performed. 190 implicitIdentity:: 191 Advice on how to set your identity configuration when 192 your information is guessed from the system username and 193 domain name. 194 detachedHead:: 195 Advice shown when you used linkgit:git-checkout[1] to 196 move to the detach HEAD state, to instruct how to create 197 a local branch after the fact. 198 amWorkDir:: 199 Advice that shows the location of the patch file when 200 linkgit:git-am[1] fails to apply it. 201 rmHints:: 202 In case of failure in the output of linkgit:git-rm[1], 203 show directions on how to proceed from the current state. 204-- 205 206core.fileMode:: 207 If false, the executable bit differences between the index and 208 the working tree are ignored; useful on broken filesystems like FAT. 209 See linkgit:git-update-index[1]. 210+ 211The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 212will probe and set core.fileMode false if appropriate when the 213repository is created. 214 215core.ignorecase:: 216 If true, this option enables various workarounds to enable 217 Git to work better on filesystems that are not case sensitive, 218 like FAT. For example, if a directory listing finds 219 "makefile" when Git expects "Makefile", Git will assume 220 it is really the same file, and continue to remember it as 221 "Makefile". 222+ 223The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 224will probe and set core.ignorecase true if appropriate when the repository 225is created. 226 227core.precomposeunicode:: 228 This option is only used by Mac OS implementation of Git. 229 When core.precomposeunicode=true, Git reverts the unicode decomposition 230 of filenames done by Mac OS. This is useful when sharing a repository 231 between Mac OS and Linux or Windows. 232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 233 When false, file names are handled fully transparent by Git, 234 which is backward compatible with older versions of Git. 235 236core.protectHFS:: 237 If set to true, do not allow checkout of paths that would 238 be considered equivalent to `.git` on an HFS+ filesystem. 239 Defaults to `true` on Mac OS, and `false` elsewhere. 240 241core.protectNTFS:: 242 If set to true, do not allow checkout of paths that would 243 cause problems with the NTFS filesystem, e.g. conflict with 244 8.3 "short" names. 245 Defaults to `true` on Windows, and `false` elsewhere. 246 247core.trustctime:: 248 If false, the ctime differences between the index and the 249 working tree are ignored; useful when the inode change time 250 is regularly modified by something outside Git (file system 251 crawlers and some backup systems). 252 See linkgit:git-update-index[1]. True by default. 253 254core.checkstat:: 255 Determines which stat fields to match between the index 256 and work tree. The user can set this to 'default' or 257 'minimal'. Default (or explicitly 'default'), is to check 258 all fields, including the sub-second part of mtime and ctime. 259 260core.quotepath:: 261 The commands that output paths (e.g. 'ls-files', 262 'diff'), when not given the `-z` option, will quote 263 "unusual" characters in the pathname by enclosing the 264 pathname in a double-quote pair and with backslashes the 265 same way strings in C source code are quoted. If this 266 variable is set to false, the bytes higher than 0x80 are 267 not quoted but output as verbatim. Note that double 268 quote, backslash and control characters are always 269 quoted without `-z` regardless of the setting of this 270 variable. 271 272core.eol:: 273 Sets the line ending type to use in the working directory for 274 files that have the `text` property set. Alternatives are 275 'lf', 'crlf' and 'native', which uses the platform's native 276 line ending. The default value is `native`. See 277 linkgit:gitattributes[5] for more information on end-of-line 278 conversion. 279 280core.safecrlf:: 281 If true, makes Git check if converting `CRLF` is reversible when 282 end-of-line conversion is active. Git will verify if a command 283 modifies a file in the work tree either directly or indirectly. 284 For example, committing a file followed by checking out the 285 same file should yield the original file in the work tree. If 286 this is not the case for the current setting of 287 `core.autocrlf`, Git will reject the file. The variable can 288 be set to "warn", in which case Git will only warn about an 289 irreversible conversion but continue the operation. 290+ 291CRLF conversion bears a slight chance of corrupting data. 292When it is enabled, Git will convert CRLF to LF during commit and LF to 293CRLF during checkout. A file that contains a mixture of LF and 294CRLF before the commit cannot be recreated by Git. For text 295files this is the right thing to do: it corrects line endings 296such that we have only LF line endings in the repository. 297But for binary files that are accidentally classified as text the 298conversion can corrupt data. 299+ 300If you recognize such corruption early you can easily fix it by 301setting the conversion type explicitly in .gitattributes. Right 302after committing you still have the original file in your work 303tree and this file is not yet corrupted. You can explicitly tell 304Git that this file is binary and Git will handle the file 305appropriately. 306+ 307Unfortunately, the desired effect of cleaning up text files with 308mixed line endings and the undesired effect of corrupting binary 309files cannot be distinguished. In both cases CRLFs are removed 310in an irreversible way. For text files this is the right thing 311to do because CRLFs are line endings, while for binary files 312converting CRLFs corrupts data. 313+ 314Note, this safety check does not mean that a checkout will generate a 315file identical to the original file for a different setting of 316`core.eol` and `core.autocrlf`, but only for the current one. For 317example, a text file with `LF` would be accepted with `core.eol=lf` 318and could later be checked out with `core.eol=crlf`, in which case the 319resulting file would contain `CRLF`, although the original file 320contained `LF`. However, in both work trees the line endings would be 321consistent, that is either all `LF` or all `CRLF`, but never mixed. A 322file with mixed line endings would be reported by the `core.safecrlf` 323mechanism. 324 325core.autocrlf:: 326 Setting this variable to "true" is almost the same as setting 327 the `text` attribute to "auto" on all files except that text 328 files are not guaranteed to be normalized: files that contain 329 `CRLF` in the repository will not be touched. Use this 330 setting if you want to have `CRLF` line endings in your 331 working directory even though the repository does not have 332 normalized line endings. This variable can be set to 'input', 333 in which case no output conversion is performed. 334 335core.symlinks:: 336 If false, symbolic links are checked out as small plain files that 337 contain the link text. linkgit:git-update-index[1] and 338 linkgit:git-add[1] will not change the recorded type to regular 339 file. Useful on filesystems like FAT that do not support 340 symbolic links. 341+ 342The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 343will probe and set core.symlinks false if appropriate when the repository 344is created. 345 346core.gitProxy:: 347 A "proxy command" to execute (as 'command host port') instead 348 of establishing direct connection to the remote server when 349 using the Git protocol for fetching. If the variable value is 350 in the "COMMAND for DOMAIN" format, the command is applied only 351 on hostnames ending with the specified domain string. This variable 352 may be set multiple times and is matched in the given order; 353 the first match wins. 354+ 355Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 356(which always applies universally, without the special "for" 357handling). 358+ 359The special string `none` can be used as the proxy command to 360specify that no proxy be used for a given domain pattern. 361This is useful for excluding servers inside a firewall from 362proxy use, while defaulting to a common proxy for external domains. 363 364core.ignoreStat:: 365 If true, commands which modify both the working tree and the index 366 will mark the updated paths with the "assume unchanged" bit in the 367 index. These marked files are then assumed to stay unchanged in the 368 working tree, until you mark them otherwise manually - Git will not 369 detect the file changes by lstat() calls. This is useful on systems 370 where those are very slow, such as Microsoft Windows. 371 See linkgit:git-update-index[1]. 372 False by default. 373 374core.preferSymlinkRefs:: 375 Instead of the default "symref" format for HEAD 376 and other symbolic reference files, use symbolic links. 377 This is sometimes needed to work with old scripts that 378 expect HEAD to be a symbolic link. 379 380core.bare:: 381 If true this repository is assumed to be 'bare' and has no 382 working directory associated with it. If this is the case a 383 number of commands that require a working directory will be 384 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 385+ 386This setting is automatically guessed by linkgit:git-clone[1] or 387linkgit:git-init[1] when the repository was created. By default a 388repository that ends in "/.git" is assumed to be not bare (bare = 389false), while all other repositories are assumed to be bare (bare 390= true). 391 392core.worktree:: 393 Set the path to the root of the working tree. 394 This can be overridden by the GIT_WORK_TREE environment 395 variable and the '--work-tree' command line option. 396 The value can be an absolute path or relative to the path to 397 the .git directory, which is either specified by --git-dir 398 or GIT_DIR, or automatically discovered. 399 If --git-dir or GIT_DIR is specified but none of 400 --work-tree, GIT_WORK_TREE and core.worktree is specified, 401 the current working directory is regarded as the top level 402 of your working tree. 403+ 404Note that this variable is honored even when set in a configuration 405file in a ".git" subdirectory of a directory and its value differs 406from the latter directory (e.g. "/path/to/.git/config" has 407core.worktree set to "/different/path"), which is most likely a 408misconfiguration. Running Git commands in the "/path/to" directory will 409still use "/different/path" as the root of the work tree and can cause 410confusion unless you know what you are doing (e.g. you are creating a 411read-only snapshot of the same index to a location different from the 412repository's usual working tree). 413 414core.logAllRefUpdates:: 415 Enable the reflog. Updates to a ref <ref> is logged to the file 416 "$GIT_DIR/logs/<ref>", by appending the new and old 417 SHA-1, the date/time and the reason of the update, but 418 only when the file exists. If this configuration 419 variable is set to true, missing "$GIT_DIR/logs/<ref>" 420 file is automatically created for branch heads (i.e. under 421 refs/heads/), remote refs (i.e. under refs/remotes/), 422 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 423+ 424This information can be used to determine what commit 425was the tip of a branch "2 days ago". 426+ 427This value is true by default in a repository that has 428a working directory associated with it, and false by 429default in a bare repository. 430 431core.repositoryFormatVersion:: 432 Internal variable identifying the repository format and layout 433 version. 434 435core.sharedRepository:: 436 When 'group' (or 'true'), the repository is made shareable between 437 several users in a group (making sure all the files and objects are 438 group-writable). When 'all' (or 'world' or 'everybody'), the 439 repository will be readable by all users, additionally to being 440 group-shareable. When 'umask' (or 'false'), Git will use permissions 441 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 442 files in the repository will have this mode value. '0xxx' will override 443 user's umask value (whereas the other options will only override 444 requested parts of the user's umask value). Examples: '0660' will make 445 the repo read/write-able for the owner and group, but inaccessible to 446 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 447 repository that is group-readable but not group-writable. 448 See linkgit:git-init[1]. False by default. 449 450core.warnAmbiguousRefs:: 451 If true, Git will warn you if the ref name you passed it is ambiguous 452 and might match multiple refs in the repository. True by default. 453 454core.compression:: 455 An integer -1..9, indicating a default compression level. 456 -1 is the zlib default. 0 means no compression, 457 and 1..9 are various speed/size tradeoffs, 9 being slowest. 458 If set, this provides a default to other compression variables, 459 such as 'core.loosecompression' and 'pack.compression'. 460 461core.loosecompression:: 462 An integer -1..9, indicating the compression level for objects that 463 are not in a pack file. -1 is the zlib default. 0 means no 464 compression, and 1..9 are various speed/size tradeoffs, 9 being 465 slowest. If not set, defaults to core.compression. If that is 466 not set, defaults to 1 (best speed). 467 468core.packedGitWindowSize:: 469 Number of bytes of a pack file to map into memory in a 470 single mapping operation. Larger window sizes may allow 471 your system to process a smaller number of large pack files 472 more quickly. Smaller window sizes will negatively affect 473 performance due to increased calls to the operating system's 474 memory manager, but may improve performance when accessing 475 a large number of large pack files. 476+ 477Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 478MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 479be reasonable for all users/operating systems. You probably do 480not need to adjust this value. 481+ 482Common unit suffixes of 'k', 'm', or 'g' are supported. 483 484core.packedGitLimit:: 485 Maximum number of bytes to map simultaneously into memory 486 from pack files. If Git needs to access more than this many 487 bytes at once to complete an operation it will unmap existing 488 regions to reclaim virtual address space within the process. 489+ 490Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 491This should be reasonable for all users/operating systems, except on 492the largest projects. You probably do not need to adjust this value. 493+ 494Common unit suffixes of 'k', 'm', or 'g' are supported. 495 496core.deltaBaseCacheLimit:: 497 Maximum number of bytes to reserve for caching base objects 498 that may be referenced by multiple deltified objects. By storing the 499 entire decompressed base objects in a cache Git is able 500 to avoid unpacking and decompressing frequently used base 501 objects multiple times. 502+ 503Default is 16 MiB on all platforms. This should be reasonable 504for all users/operating systems, except on the largest projects. 505You probably do not need to adjust this value. 506+ 507Common unit suffixes of 'k', 'm', or 'g' are supported. 508 509core.bigFileThreshold:: 510 Files larger than this size are stored deflated, without 511 attempting delta compression. Storing large files without 512 delta compression avoids excessive memory usage, at the 513 slight expense of increased disk usage. 514+ 515Default is 512 MiB on all platforms. This should be reasonable 516for most projects as source code and other text files can still 517be delta compressed, but larger binary media files won't be. 518+ 519Common unit suffixes of 'k', 'm', or 'g' are supported. 520 521core.excludesfile:: 522 In addition to '.gitignore' (per-directory) and 523 '.git/info/exclude', Git looks into this file for patterns 524 of files which are not meant to be tracked. "`~/`" is expanded 525 to the value of `$HOME` and "`~user/`" to the specified user's 526 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 527 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 528 is used instead. See linkgit:gitignore[5]. 529 530core.askpass:: 531 Some commands (e.g. svn and http interfaces) that interactively 532 ask for a password can be told to use an external program given 533 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 534 environment variable. If not set, fall back to the value of the 535 'SSH_ASKPASS' environment variable or, failing that, a simple password 536 prompt. The external program shall be given a suitable prompt as 537 command line argument and write the password on its STDOUT. 538 539core.attributesfile:: 540 In addition to '.gitattributes' (per-directory) and 541 '.git/info/attributes', Git looks into this file for attributes 542 (see linkgit:gitattributes[5]). Path expansions are made the same 543 way as for `core.excludesfile`. Its default value is 544 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 545 set or empty, $HOME/.config/git/attributes is used instead. 546 547core.editor:: 548 Commands such as `commit` and `tag` that lets you edit 549 messages by launching an editor uses the value of this 550 variable when it is set, and the environment variable 551 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 552 553core.commentchar:: 554 Commands such as `commit` and `tag` that lets you edit 555 messages consider a line that begins with this character 556 commented, and removes them after the editor returns 557 (default '#'). 558 559sequence.editor:: 560 Text editor used by `git rebase -i` for editing the rebase instruction file. 561 The value is meant to be interpreted by the shell when it is used. 562 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 563 When not configured the default commit message editor is used instead. 564 565core.pager:: 566 Text viewer for use by Git commands (e.g., 'less'). The value 567 is meant to be interpreted by the shell. The order of preference 568 is the `$GIT_PAGER` environment variable, then `core.pager` 569 configuration, then `$PAGER`, and then the default chosen at 570 compile time (usually 'less'). 571+ 572When the `LESS` environment variable is unset, Git sets it to `FRSX` 573(if `LESS` environment variable is set, Git does not change it at 574all). If you want to selectively override Git's default setting 575for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 576be passed to the shell by Git, which will translate the final 577command to `LESS=FRSX less -+S`. The environment tells the command 578to set the `S` option to chop long lines but the command line 579resets it to the default to fold long lines. 580 581core.whitespace:: 582 A comma separated list of common whitespace problems to 583 notice. 'git diff' will use `color.diff.whitespace` to 584 highlight them, and 'git apply --whitespace=error' will 585 consider them as errors. You can prefix `-` to disable 586 any of them (e.g. `-trailing-space`): 587+ 588* `blank-at-eol` treats trailing whitespaces at the end of the line 589 as an error (enabled by default). 590* `space-before-tab` treats a space character that appears immediately 591 before a tab character in the initial indent part of the line as an 592 error (enabled by default). 593* `indent-with-non-tab` treats a line that is indented with space 594 characters instead of the equivalent tabs as an error (not enabled by 595 default). 596* `tab-in-indent` treats a tab character in the initial indent part of 597 the line as an error (not enabled by default). 598* `blank-at-eof` treats blank lines added at the end of file as an error 599 (enabled by default). 600* `trailing-space` is a short-hand to cover both `blank-at-eol` and 601 `blank-at-eof`. 602* `cr-at-eol` treats a carriage-return at the end of line as 603 part of the line terminator, i.e. with it, `trailing-space` 604 does not trigger if the character before such a carriage-return 605 is not a whitespace (not enabled by default). 606* `tabwidth=<n>` tells how many character positions a tab occupies; this 607 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 608 errors. The default tab width is 8. Allowed values are 1 to 63. 609 610core.fsyncobjectfiles:: 611 This boolean will enable 'fsync()' when writing object files. 612+ 613This is a total waste of time and effort on a filesystem that orders 614data writes properly, but can be useful for filesystems that do not use 615journalling (traditional UNIX filesystems) or that only journal metadata 616and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 617 618core.preloadindex:: 619 Enable parallel index preload for operations like 'git diff' 620+ 621This can speed up operations like 'git diff' and 'git status' especially 622on filesystems like NFS that have weak caching semantics and thus 623relatively high IO latencies. With this set to 'true', Git will do the 624index comparison to the filesystem data in parallel, allowing 625overlapping IO's. 626 627core.createObject:: 628 You can set this to 'link', in which case a hardlink followed by 629 a delete of the source are used to make sure that object creation 630 will not overwrite existing objects. 631+ 632On some file system/operating system combinations, this is unreliable. 633Set this config setting to 'rename' there; However, This will remove the 634check that makes sure that existing object files will not get overwritten. 635 636core.notesRef:: 637 When showing commit messages, also show notes which are stored in 638 the given ref. The ref must be fully qualified. If the given 639 ref does not exist, it is not an error but means that no 640 notes should be printed. 641+ 642This setting defaults to "refs/notes/commits", and it can be overridden by 643the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 644 645core.sparseCheckout:: 646 Enable "sparse checkout" feature. See section "Sparse checkout" in 647 linkgit:git-read-tree[1] for more information. 648 649core.abbrev:: 650 Set the length object names are abbreviated to. If unspecified, 651 many commands abbreviate to 7 hexdigits, which may not be enough 652 for abbreviated object names to stay unique for sufficiently long 653 time. 654 655add.ignore-errors:: 656add.ignoreErrors:: 657 Tells 'git add' to continue adding files when some files cannot be 658 added due to indexing errors. Equivalent to the '--ignore-errors' 659 option of linkgit:git-add[1]. Older versions of Git accept only 660 `add.ignore-errors`, which does not follow the usual naming 661 convention for configuration variables. Newer versions of Git 662 honor `add.ignoreErrors` as well. 663 664alias.*:: 665 Command aliases for the linkgit:git[1] command wrapper - e.g. 666 after defining "alias.last = cat-file commit HEAD", the invocation 667 "git last" is equivalent to "git cat-file commit HEAD". To avoid 668 confusion and troubles with script usage, aliases that 669 hide existing Git commands are ignored. Arguments are split by 670 spaces, the usual shell quoting and escaping is supported. 671 quote pair and a backslash can be used to quote them. 672+ 673If the alias expansion is prefixed with an exclamation point, 674it will be treated as a shell command. For example, defining 675"alias.new = !gitk --all --not ORIG_HEAD", the invocation 676"git new" is equivalent to running the shell command 677"gitk --all --not ORIG_HEAD". Note that shell commands will be 678executed from the top-level directory of a repository, which may 679not necessarily be the current directory. 680'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 681from the original current directory. See linkgit:git-rev-parse[1]. 682 683am.keepcr:: 684 If true, git-am will call git-mailsplit for patches in mbox format 685 with parameter '--keep-cr'. In this case git-mailsplit will 686 not remove `\r` from lines ending with `\r\n`. Can be overridden 687 by giving '--no-keep-cr' from the command line. 688 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 689 690apply.ignorewhitespace:: 691 When set to 'change', tells 'git apply' to ignore changes in 692 whitespace, in the same way as the '--ignore-space-change' 693 option. 694 When set to one of: no, none, never, false tells 'git apply' to 695 respect all whitespace differences. 696 See linkgit:git-apply[1]. 697 698apply.whitespace:: 699 Tells 'git apply' how to handle whitespaces, in the same way 700 as the '--whitespace' option. See linkgit:git-apply[1]. 701 702branch.autosetupmerge:: 703 Tells 'git branch' and 'git checkout' to set up new branches 704 so that linkgit:git-pull[1] will appropriately merge from the 705 starting point branch. Note that even if this option is not set, 706 this behavior can be chosen per-branch using the `--track` 707 and `--no-track` options. The valid settings are: `false` -- no 708 automatic setup is done; `true` -- automatic setup is done when the 709 starting point is a remote-tracking branch; `always` -- 710 automatic setup is done when the starting point is either a 711 local branch or remote-tracking 712 branch. This option defaults to true. 713 714branch.autosetuprebase:: 715 When a new branch is created with 'git branch' or 'git checkout' 716 that tracks another branch, this variable tells Git to set 717 up pull to rebase instead of merge (see "branch.<name>.rebase"). 718 When `never`, rebase is never automatically set to true. 719 When `local`, rebase is set to true for tracked branches of 720 other local branches. 721 When `remote`, rebase is set to true for tracked branches of 722 remote-tracking branches. 723 When `always`, rebase will be set to true for all tracking 724 branches. 725 See "branch.autosetupmerge" for details on how to set up a 726 branch to track another branch. 727 This option defaults to never. 728 729branch.<name>.remote:: 730 When on branch <name>, it tells 'git fetch' and 'git push' 731 which remote to fetch from/push to. The remote to push to 732 may be overridden with `remote.pushdefault` (for all branches). 733 The remote to push to, for the current branch, may be further 734 overridden by `branch.<name>.pushremote`. If no remote is 735 configured, or if you are not on any branch, it defaults to 736 `origin` for fetching and `remote.pushdefault` for pushing. 737 Additionally, `.` (a period) is the current local repository 738 (a dot-repository), see `branch.<name>.merge`'s final note below. 739 740branch.<name>.pushremote:: 741 When on branch <name>, it overrides `branch.<name>.remote` for 742 pushing. It also overrides `remote.pushdefault` for pushing 743 from branch <name>. When you pull from one place (e.g. your 744 upstream) and push to another place (e.g. your own publishing 745 repository), you would want to set `remote.pushdefault` to 746 specify the remote to push to for all branches, and use this 747 option to override it for a specific branch. 748 749branch.<name>.merge:: 750 Defines, together with branch.<name>.remote, the upstream branch 751 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 752 branch to merge and can also affect 'git push' (see push.default). 753 When in branch <name>, it tells 'git fetch' the default 754 refspec to be marked for merging in FETCH_HEAD. The value is 755 handled like the remote part of a refspec, and must match a 756 ref which is fetched from the remote given by 757 "branch.<name>.remote". 758 The merge information is used by 'git pull' (which at first calls 759 'git fetch') to lookup the default branch for merging. Without 760 this option, 'git pull' defaults to merge the first refspec fetched. 761 Specify multiple values to get an octopus merge. 762 If you wish to setup 'git pull' so that it merges into <name> from 763 another branch in the local repository, you can point 764 branch.<name>.merge to the desired branch, and use the relative path 765 setting `.` (a period) for branch.<name>.remote. 766 767branch.<name>.mergeoptions:: 768 Sets default options for merging into branch <name>. The syntax and 769 supported options are the same as those of linkgit:git-merge[1], but 770 option values containing whitespace characters are currently not 771 supported. 772 773branch.<name>.rebase:: 774 When true, rebase the branch <name> on top of the fetched branch, 775 instead of merging the default branch from the default remote when 776 "git pull" is run. See "pull.rebase" for doing this in a non 777 branch-specific manner. 778+ 779 When preserve, also pass `--preserve-merges` along to 'git rebase' 780 so that locally committed merge commits will not be flattened 781 by running 'git pull'. 782+ 783*NOTE*: this is a possibly dangerous operation; do *not* use 784it unless you understand the implications (see linkgit:git-rebase[1] 785for details). 786 787branch.<name>.description:: 788 Branch description, can be edited with 789 `git branch --edit-description`. Branch description is 790 automatically added in the format-patch cover letter or 791 request-pull summary. 792 793browser.<tool>.cmd:: 794 Specify the command to invoke the specified browser. The 795 specified command is evaluated in shell with the URLs passed 796 as arguments. (See linkgit:git-web{litdd}browse[1].) 797 798browser.<tool>.path:: 799 Override the path for the given tool that may be used to 800 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 801 working repository in gitweb (see linkgit:git-instaweb[1]). 802 803clean.requireForce:: 804 A boolean to make git-clean do nothing unless given -f, 805 -i or -n. Defaults to true. 806 807color.branch:: 808 A boolean to enable/disable color in the output of 809 linkgit:git-branch[1]. May be set to `always`, 810 `false` (or `never`) or `auto` (or `true`), in which case colors are used 811 only when the output is to a terminal. Defaults to false. 812 813color.branch.<slot>:: 814 Use customized color for branch coloration. `<slot>` is one of 815 `current` (the current branch), `local` (a local branch), 816 `remote` (a remote-tracking branch in refs/remotes/), 817 `upstream` (upstream tracking branch), `plain` (other 818 refs). 819+ 820The value for these configuration variables is a list of colors (at most 821two) and attributes (at most one), separated by spaces. The colors 822accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 823`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 824`blink` and `reverse`. The first color given is the foreground; the 825second is the background. The position of the attribute, if any, 826doesn't matter. 827 828color.diff:: 829 Whether to use ANSI escape sequences to add color to patches. 830 If this is set to `always`, linkgit:git-diff[1], 831 linkgit:git-log[1], and linkgit:git-show[1] will use color 832 for all patches. If it is set to `true` or `auto`, those 833 commands will only use color when output is to the terminal. 834 Defaults to false. 835+ 836This does not affect linkgit:git-format-patch[1] nor the 837'git-diff-{asterisk}' plumbing commands. Can be overridden on the 838command line with the `--color[=<when>]` option. 839 840color.diff.<slot>:: 841 Use customized color for diff colorization. `<slot>` specifies 842 which part of the patch to use the specified color, and is one 843 of `plain` (context text), `meta` (metainformation), `frag` 844 (hunk header), 'func' (function in hunk header), `old` (removed lines), 845 `new` (added lines), `commit` (commit headers), or `whitespace` 846 (highlighting whitespace errors). The values of these variables may be 847 specified as in color.branch.<slot>. 848 849color.decorate.<slot>:: 850 Use customized color for 'git log --decorate' output. `<slot>` is one 851 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 852 branches, remote-tracking branches, tags, stash and HEAD, respectively. 853 854color.grep:: 855 When set to `always`, always highlight matches. When `false` (or 856 `never`), never. When set to `true` or `auto`, use color only 857 when the output is written to the terminal. Defaults to `false`. 858 859color.grep.<slot>:: 860 Use customized color for grep colorization. `<slot>` specifies which 861 part of the line to use the specified color, and is one of 862+ 863-- 864`context`;; 865 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 866`filename`;; 867 filename prefix (when not using `-h`) 868`function`;; 869 function name lines (when using `-p`) 870`linenumber`;; 871 line number prefix (when using `-n`) 872`match`;; 873 matching text 874`selected`;; 875 non-matching text in selected lines 876`separator`;; 877 separators between fields on a line (`:`, `-`, and `=`) 878 and between hunks (`--`) 879-- 880+ 881The values of these variables may be specified as in color.branch.<slot>. 882 883color.interactive:: 884 When set to `always`, always use colors for interactive prompts 885 and displays (such as those used by "git-add --interactive" and 886 "git-clean --interactive"). When false (or `never`), never. 887 When set to `true` or `auto`, use colors only when the output is 888 to the terminal. Defaults to false. 889 890color.interactive.<slot>:: 891 Use customized color for 'git add --interactive' and 'git clean 892 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 893 or `error`, for four distinct types of normal output from 894 interactive commands. The values of these variables may be 895 specified as in color.branch.<slot>. 896 897color.pager:: 898 A boolean to enable/disable colored output when the pager is in 899 use (default is true). 900 901color.showbranch:: 902 A boolean to enable/disable color in the output of 903 linkgit:git-show-branch[1]. May be set to `always`, 904 `false` (or `never`) or `auto` (or `true`), in which case colors are used 905 only when the output is to a terminal. Defaults to false. 906 907color.status:: 908 A boolean to enable/disable color in the output of 909 linkgit:git-status[1]. May be set to `always`, 910 `false` (or `never`) or `auto` (or `true`), in which case colors are used 911 only when the output is to a terminal. Defaults to false. 912 913color.status.<slot>:: 914 Use customized color for status colorization. `<slot>` is 915 one of `header` (the header text of the status message), 916 `added` or `updated` (files which are added but not committed), 917 `changed` (files which are changed but not added in the index), 918 `untracked` (files which are not tracked by Git), 919 `branch` (the current branch), or 920 `nobranch` (the color the 'no branch' warning is shown in, defaulting 921 to red). The values of these variables may be specified as in 922 color.branch.<slot>. 923 924color.ui:: 925 This variable determines the default value for variables such 926 as `color.diff` and `color.grep` that control the use of color 927 per command family. Its scope will expand as more commands learn 928 configuration to set a default for the `--color` option. Set it 929 to `false` or `never` if you prefer Git commands not to use 930 color unless enabled explicitly with some other configuration 931 or the `--color` option. Set it to `always` if you want all 932 output not intended for machine consumption to use color, to 933 `true` or `auto` (this is the default since Git 1.8.4) if you 934 want such output to use color when written to the terminal. 935 936column.ui:: 937 Specify whether supported commands should output in columns. 938 This variable consists of a list of tokens separated by spaces 939 or commas: 940+ 941These options control when the feature should be enabled 942(defaults to 'never'): 943+ 944-- 945`always`;; 946 always show in columns 947`never`;; 948 never show in columns 949`auto`;; 950 show in columns if the output is to the terminal 951-- 952+ 953These options control layout (defaults to 'column'). Setting any 954of these implies 'always' if none of 'always', 'never', or 'auto' are 955specified. 956+ 957-- 958`column`;; 959 fill columns before rows 960`row`;; 961 fill rows before columns 962`plain`;; 963 show in one column 964-- 965+ 966Finally, these options can be combined with a layout option (defaults 967to 'nodense'): 968+ 969-- 970`dense`;; 971 make unequal size columns to utilize more space 972`nodense`;; 973 make equal size columns 974-- 975 976column.branch:: 977 Specify whether to output branch listing in `git branch` in columns. 978 See `column.ui` for details. 979 980column.clean:: 981 Specify the layout when list items in `git clean -i`, which always 982 shows files and directories in columns. See `column.ui` for details. 983 984column.status:: 985 Specify whether to output untracked files in `git status` in columns. 986 See `column.ui` for details. 987 988column.tag:: 989 Specify whether to output tag listing in `git tag` in columns. 990 See `column.ui` for details. 991 992commit.cleanup:: 993 This setting overrides the default of the `--cleanup` option in 994 `git commit`. See linkgit:git-commit[1] for details. Changing the 995 default can be useful when you always want to keep lines that begin 996 with comment character `#` in your log message, in which case you 997 would do `git config commit.cleanup whitespace` (note that you will 998 have to remove the help lines that begin with `#` in the commit log 999 template yourself, if you do this).10001001commit.status::1002 A boolean to enable/disable inclusion of status information in the1003 commit message template when using an editor to prepare the commit1004 message. Defaults to true.10051006commit.template::1007 Specify a file to use as the template for new commit messages.1008 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1009 specified user's home directory.10101011credential.helper::1012 Specify an external helper to be called when a username or1013 password credential is needed; the helper may consult external1014 storage to avoid prompting the user for the credentials. See1015 linkgit:gitcredentials[7] for details.10161017credential.useHttpPath::1018 When acquiring credentials, consider the "path" component of an http1019 or https URL to be important. Defaults to false. See1020 linkgit:gitcredentials[7] for more information.10211022credential.username::1023 If no username is set for a network authentication, use this username1024 by default. See credential.<context>.* below, and1025 linkgit:gitcredentials[7].10261027credential.<url>.*::1028 Any of the credential.* options above can be applied selectively to1029 some credentials. For example "credential.https://example.com.username"1030 would set the default username only for https connections to1031 example.com. See linkgit:gitcredentials[7] for details on how URLs are1032 matched.10331034include::diff-config.txt[]10351036difftool.<tool>.path::1037 Override the path for the given tool. This is useful in case1038 your tool is not in the PATH.10391040difftool.<tool>.cmd::1041 Specify the command to invoke the specified diff tool.1042 The specified command is evaluated in shell with the following1043 variables available: 'LOCAL' is set to the name of the temporary1044 file containing the contents of the diff pre-image and 'REMOTE'1045 is set to the name of the temporary file containing the contents1046 of the diff post-image.10471048difftool.prompt::1049 Prompt before each invocation of the diff tool.10501051fetch.recurseSubmodules::1052 This option can be either set to a boolean value or to 'on-demand'.1053 Setting it to a boolean changes the behavior of fetch and pull to1054 unconditionally recurse into submodules when set to true or to not1055 recurse at all when set to false. When set to 'on-demand' (the default1056 value), fetch and pull will only recurse into a populated submodule1057 when its superproject retrieves a commit that updates the submodule's1058 reference.10591060fetch.fsckObjects::1061 If it is set to true, git-fetch-pack will check all fetched1062 objects. It will abort in the case of a malformed object or a1063 broken link. The result of an abort are only dangling objects.1064 Defaults to false. If not set, the value of `transfer.fsckObjects`1065 is used instead.10661067fetch.unpackLimit::1068 If the number of objects fetched over the Git native1069 transfer is below this1070 limit, then the objects will be unpacked into loose object1071 files. However if the number of received objects equals or1072 exceeds this limit then the received pack will be stored as1073 a pack, after adding any missing delta bases. Storing the1074 pack from a push can make the push operation complete faster,1075 especially on slow filesystems. If not set, the value of1076 `transfer.unpackLimit` is used instead.10771078fetch.prune::1079 If true, fetch will automatically behave as if the `--prune`1080 option was given on the command line. See also `remote.<name>.prune`.10811082format.attach::1083 Enable multipart/mixed attachments as the default for1084 'format-patch'. The value can also be a double quoted string1085 which will enable attachments as the default and set the1086 value as the boundary. See the --attach option in1087 linkgit:git-format-patch[1].10881089format.numbered::1090 A boolean which can enable or disable sequence numbers in patch1091 subjects. It defaults to "auto" which enables it only if there1092 is more than one patch. It can be enabled or disabled for all1093 messages by setting it to "true" or "false". See --numbered1094 option in linkgit:git-format-patch[1].10951096format.headers::1097 Additional email headers to include in a patch to be submitted1098 by mail. See linkgit:git-format-patch[1].10991100format.to::1101format.cc::1102 Additional recipients to include in a patch to be submitted1103 by mail. See the --to and --cc options in1104 linkgit:git-format-patch[1].11051106format.subjectprefix::1107 The default for format-patch is to output files with the '[PATCH]'1108 subject prefix. Use this variable to change that prefix.11091110format.signature::1111 The default for format-patch is to output a signature containing1112 the Git version number. Use this variable to change that default.1113 Set this variable to the empty string ("") to suppress1114 signature generation.11151116format.suffix::1117 The default for format-patch is to output files with the suffix1118 `.patch`. Use this variable to change that suffix (make sure to1119 include the dot if you want it).11201121format.pretty::1122 The default pretty format for log/show/whatchanged command,1123 See linkgit:git-log[1], linkgit:git-show[1],1124 linkgit:git-whatchanged[1].11251126format.thread::1127 The default threading style for 'git format-patch'. Can be1128 a boolean value, or `shallow` or `deep`. `shallow` threading1129 makes every mail a reply to the head of the series,1130 where the head is chosen from the cover letter, the1131 `--in-reply-to`, and the first patch mail, in this order.1132 `deep` threading makes every mail a reply to the previous one.1133 A true boolean value is the same as `shallow`, and a false1134 value disables threading.11351136format.signoff::1137 A boolean value which lets you enable the `-s/--signoff` option of1138 format-patch by default. *Note:* Adding the Signed-off-by: line to a1139 patch should be a conscious act and means that you certify you have1140 the rights to submit this work under the same open source license.1141 Please see the 'SubmittingPatches' document for further discussion.11421143format.coverLetter::1144 A boolean that controls whether to generate a cover-letter when1145 format-patch is invoked, but in addition can be set to "auto", to1146 generate a cover-letter only when there's more than one patch.11471148filter.<driver>.clean::1149 The command which is used to convert the content of a worktree1150 file to a blob upon checkin. See linkgit:gitattributes[5] for1151 details.11521153filter.<driver>.smudge::1154 The command which is used to convert the content of a blob1155 object to a worktree file upon checkout. See1156 linkgit:gitattributes[5] for details.11571158gc.aggressiveWindow::1159 The window size parameter used in the delta compression1160 algorithm used by 'git gc --aggressive'. This defaults1161 to 250.11621163gc.auto::1164 When there are approximately more than this many loose1165 objects in the repository, `git gc --auto` will pack them.1166 Some Porcelain commands use this command to perform a1167 light-weight garbage collection from time to time. The1168 default value is 6700. Setting this to 0 disables it.11691170gc.autopacklimit::1171 When there are more than this many packs that are not1172 marked with `*.keep` file in the repository, `git gc1173 --auto` consolidates them into one larger pack. The1174 default value is 50. Setting this to 0 disables it.11751176gc.packrefs::1177 Running `git pack-refs` in a repository renders it1178 unclonable by Git versions prior to 1.5.1.2 over dumb1179 transports such as HTTP. This variable determines whether1180 'git gc' runs `git pack-refs`. This can be set to `notbare`1181 to enable it within all non-bare repos or it can be set to a1182 boolean value. The default is `true`.11831184gc.pruneexpire::1185 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1186 Override the grace period with this config variable. The value1187 "now" may be used to disable this grace period and always prune1188 unreachable objects immediately.11891190gc.reflogexpire::1191gc.<pattern>.reflogexpire::1192 'git reflog expire' removes reflog entries older than1193 this time; defaults to 90 days. With "<pattern>" (e.g.1194 "refs/stash") in the middle the setting applies only to1195 the refs that match the <pattern>.11961197gc.reflogexpireunreachable::1198gc.<ref>.reflogexpireunreachable::1199 'git reflog expire' removes reflog entries older than1200 this time and are not reachable from the current tip;1201 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1202 in the middle, the setting applies only to the refs that1203 match the <pattern>.12041205gc.rerereresolved::1206 Records of conflicted merge you resolved earlier are1207 kept for this many days when 'git rerere gc' is run.1208 The default is 60 days. See linkgit:git-rerere[1].12091210gc.rerereunresolved::1211 Records of conflicted merge you have not resolved are1212 kept for this many days when 'git rerere gc' is run.1213 The default is 15 days. See linkgit:git-rerere[1].12141215gitcvs.commitmsgannotation::1216 Append this string to each commit message. Set to empty string1217 to disable this feature. Defaults to "via git-CVS emulator".12181219gitcvs.enabled::1220 Whether the CVS server interface is enabled for this repository.1221 See linkgit:git-cvsserver[1].12221223gitcvs.logfile::1224 Path to a log file where the CVS server interface well... logs1225 various stuff. See linkgit:git-cvsserver[1].12261227gitcvs.usecrlfattr::1228 If true, the server will look up the end-of-line conversion1229 attributes for files to determine the '-k' modes to use. If1230 the attributes force Git to treat a file as text,1231 the '-k' mode will be left blank so CVS clients will1232 treat it as text. If they suppress text conversion, the file1233 will be set with '-kb' mode, which suppresses any newline munging1234 the client might otherwise do. If the attributes do not allow1235 the file type to be determined, then 'gitcvs.allbinary' is1236 used. See linkgit:gitattributes[5].12371238gitcvs.allbinary::1239 This is used if 'gitcvs.usecrlfattr' does not resolve1240 the correct '-kb' mode to use. If true, all1241 unresolved files are sent to the client in1242 mode '-kb'. This causes the client to treat them1243 as binary files, which suppresses any newline munging it1244 otherwise might do. Alternatively, if it is set to "guess",1245 then the contents of the file are examined to decide if1246 it is binary, similar to 'core.autocrlf'.12471248gitcvs.dbname::1249 Database used by git-cvsserver to cache revision information1250 derived from the Git repository. The exact meaning depends on the1251 used database driver, for SQLite (which is the default driver) this1252 is a filename. Supports variable substitution (see1253 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1254 Default: '%Ggitcvs.%m.sqlite'12551256gitcvs.dbdriver::1257 Used Perl DBI driver. You can specify any available driver1258 for this here, but it might not work. git-cvsserver is tested1259 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1260 reported *not* to work with 'DBD::mysql'. Experimental feature.1261 May not contain double colons (`:`). Default: 'SQLite'.1262 See linkgit:git-cvsserver[1].12631264gitcvs.dbuser, gitcvs.dbpass::1265 Database user and password. Only useful if setting 'gitcvs.dbdriver',1266 since SQLite has no concept of database users and/or passwords.1267 'gitcvs.dbuser' supports variable substitution (see1268 linkgit:git-cvsserver[1] for details).12691270gitcvs.dbTableNamePrefix::1271 Database table name prefix. Prepended to the names of any1272 database tables used, allowing a single database to be used1273 for several repositories. Supports variable substitution (see1274 linkgit:git-cvsserver[1] for details). Any non-alphabetic1275 characters will be replaced with underscores.12761277All gitcvs variables except for 'gitcvs.usecrlfattr' and1278'gitcvs.allbinary' can also be specified as1279'gitcvs.<access_method>.<varname>' (where 'access_method'1280is one of "ext" and "pserver") to make them apply only for the given1281access method.12821283gitweb.category::1284gitweb.description::1285gitweb.owner::1286gitweb.url::1287 See linkgit:gitweb[1] for description.12881289gitweb.avatar::1290gitweb.blame::1291gitweb.grep::1292gitweb.highlight::1293gitweb.patches::1294gitweb.pickaxe::1295gitweb.remote_heads::1296gitweb.showsizes::1297gitweb.snapshot::1298 See linkgit:gitweb.conf[5] for description.12991300grep.lineNumber::1301 If set to true, enable '-n' option by default.13021303grep.patternType::1304 Set the default matching behavior. Using a value of 'basic', 'extended',1305 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1306 '--fixed-strings', or '--perl-regexp' option accordingly, while the1307 value 'default' will return to the default matching behavior.13081309grep.extendedRegexp::1310 If set to true, enable '--extended-regexp' option by default. This1311 option is ignored when the 'grep.patternType' option is set to a value1312 other than 'default'.13131314gpg.program::1315 Use this custom program instead of "gpg" found on $PATH when1316 making or verifying a PGP signature. The program must support the1317 same command line interface as GPG, namely, to verify a detached1318 signature, "gpg --verify $file - <$signature" is run, and the1319 program is expected to signal a good signature by exiting with1320 code 0, and to generate an ascii-armored detached signature, the1321 standard input of "gpg -bsau $key" is fed with the contents to be1322 signed, and the program is expected to send the result to its1323 standard output.13241325gui.commitmsgwidth::1326 Defines how wide the commit message window is in the1327 linkgit:git-gui[1]. "75" is the default.13281329gui.diffcontext::1330 Specifies how many context lines should be used in calls to diff1331 made by the linkgit:git-gui[1]. The default is "5".13321333gui.encoding::1334 Specifies the default encoding to use for displaying of1335 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1336 It can be overridden by setting the 'encoding' attribute1337 for relevant files (see linkgit:gitattributes[5]).1338 If this option is not set, the tools default to the1339 locale encoding.13401341gui.matchtrackingbranch::1342 Determines if new branches created with linkgit:git-gui[1] should1343 default to tracking remote branches with matching names or1344 not. Default: "false".13451346gui.newbranchtemplate::1347 Is used as suggested name when creating new branches using the1348 linkgit:git-gui[1].13491350gui.pruneduringfetch::1351 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1352 performing a fetch. The default value is "false".13531354gui.trustmtime::1355 Determines if linkgit:git-gui[1] should trust the file modification1356 timestamp or not. By default the timestamps are not trusted.13571358gui.spellingdictionary::1359 Specifies the dictionary used for spell checking commit messages in1360 the linkgit:git-gui[1]. When set to "none" spell checking is turned1361 off.13621363gui.fastcopyblame::1364 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1365 location detection. It makes blame significantly faster on huge1366 repositories at the expense of less thorough copy detection.13671368gui.copyblamethreshold::1369 Specifies the threshold to use in 'git gui blame' original location1370 detection, measured in alphanumeric characters. See the1371 linkgit:git-blame[1] manual for more information on copy detection.13721373gui.blamehistoryctx::1374 Specifies the radius of history context in days to show in1375 linkgit:gitk[1] for the selected commit, when the `Show History1376 Context` menu item is invoked from 'git gui blame'. If this1377 variable is set to zero, the whole history is shown.13781379guitool.<name>.cmd::1380 Specifies the shell command line to execute when the corresponding item1381 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1382 mandatory for every tool. The command is executed from the root of1383 the working directory, and in the environment it receives the name of1384 the tool as 'GIT_GUITOOL', the name of the currently selected file as1385 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1386 the head is detached, 'CUR_BRANCH' is empty).13871388guitool.<name>.needsfile::1389 Run the tool only if a diff is selected in the GUI. It guarantees1390 that 'FILENAME' is not empty.13911392guitool.<name>.noconsole::1393 Run the command silently, without creating a window to display its1394 output.13951396guitool.<name>.norescan::1397 Don't rescan the working directory for changes after the tool1398 finishes execution.13991400guitool.<name>.confirm::1401 Show a confirmation dialog before actually running the tool.14021403guitool.<name>.argprompt::1404 Request a string argument from the user, and pass it to the tool1405 through the 'ARGS' environment variable. Since requesting an1406 argument implies confirmation, the 'confirm' option has no effect1407 if this is enabled. If the option is set to 'true', 'yes', or '1',1408 the dialog uses a built-in generic prompt; otherwise the exact1409 value of the variable is used.14101411guitool.<name>.revprompt::1412 Request a single valid revision from the user, and set the1413 'REVISION' environment variable. In other aspects this option1414 is similar to 'argprompt', and can be used together with it.14151416guitool.<name>.revunmerged::1417 Show only unmerged branches in the 'revprompt' subdialog.1418 This is useful for tools similar to merge or rebase, but not1419 for things like checkout or reset.14201421guitool.<name>.title::1422 Specifies the title to use for the prompt dialog. The default1423 is the tool name.14241425guitool.<name>.prompt::1426 Specifies the general prompt string to display at the top of1427 the dialog, before subsections for 'argprompt' and 'revprompt'.1428 The default value includes the actual command.14291430help.browser::1431 Specify the browser that will be used to display help in the1432 'web' format. See linkgit:git-help[1].14331434help.format::1435 Override the default help format used by linkgit:git-help[1].1436 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1437 the default. 'web' and 'html' are the same.14381439help.autocorrect::1440 Automatically correct and execute mistyped commands after1441 waiting for the given number of deciseconds (0.1 sec). If more1442 than one command can be deduced from the entered text, nothing1443 will be executed. If the value of this option is negative,1444 the corrected command will be executed immediately. If the1445 value is 0 - the command will be just shown but not executed.1446 This is the default.14471448help.htmlpath::1449 Specify the path where the HTML documentation resides. File system paths1450 and URLs are supported. HTML pages will be prefixed with this path when1451 help is displayed in the 'web' format. This defaults to the documentation1452 path of your Git installation.14531454http.proxy::1455 Override the HTTP proxy, normally configured using the 'http_proxy',1456 'https_proxy', and 'all_proxy' environment variables (see1457 `curl(1)`). This can be overridden on a per-remote basis; see1458 remote.<name>.proxy14591460http.cookiefile::1461 File containing previously stored cookie lines which should be used1462 in the Git http session, if they match the server. The file format1463 of the file to read cookies from should be plain HTTP headers or1464 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1465 NOTE that the file specified with http.cookiefile is only used as1466 input unless http.saveCookies is set.14671468http.savecookies::1469 If set, store cookies received during requests to the file specified by1470 http.cookiefile. Has no effect if http.cookiefile is unset.14711472http.sslVerify::1473 Whether to verify the SSL certificate when fetching or pushing1474 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1475 variable.14761477http.sslCert::1478 File containing the SSL certificate when fetching or pushing1479 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1480 variable.14811482http.sslKey::1483 File containing the SSL private key when fetching or pushing1484 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1485 variable.14861487http.sslCertPasswordProtected::1488 Enable Git's password prompt for the SSL certificate. Otherwise1489 OpenSSL will prompt the user, possibly many times, if the1490 certificate or private key is encrypted. Can be overridden by the1491 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.14921493http.sslCAInfo::1494 File containing the certificates to verify the peer with when1495 fetching or pushing over HTTPS. Can be overridden by the1496 'GIT_SSL_CAINFO' environment variable.14971498http.sslCAPath::1499 Path containing files with the CA certificates to verify the peer1500 with when fetching or pushing over HTTPS. Can be overridden1501 by the 'GIT_SSL_CAPATH' environment variable.15021503http.sslTry::1504 Attempt to use AUTH SSL/TLS and encrypted data transfers1505 when connecting via regular FTP protocol. This might be needed1506 if the FTP server requires it for security reasons or you wish1507 to connect securely whenever remote FTP server supports it.1508 Default is false since it might trigger certificate verification1509 errors on misconfigured servers.15101511http.maxRequests::1512 How many HTTP requests to launch in parallel. Can be overridden1513 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15141515http.minSessions::1516 The number of curl sessions (counted across slots) to be kept across1517 requests. They will not be ended with curl_easy_cleanup() until1518 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1519 value will be capped at 1. Defaults to 1.15201521http.postBuffer::1522 Maximum size in bytes of the buffer used by smart HTTP1523 transports when POSTing data to the remote system.1524 For requests larger than this buffer size, HTTP/1.1 and1525 Transfer-Encoding: chunked is used to avoid creating a1526 massive pack file locally. Default is 1 MiB, which is1527 sufficient for most requests.15281529http.lowSpeedLimit, http.lowSpeedTime::1530 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1531 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1532 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1533 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15341535http.noEPSV::1536 A boolean which disables using of EPSV ftp command by curl.1537 This can helpful with some "poor" ftp servers which don't1538 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1539 environment variable. Default is false (curl will use EPSV).15401541http.useragent::1542 The HTTP USER_AGENT string presented to an HTTP server. The default1543 value represents the version of the client Git such as git/1.7.1.1544 This option allows you to override this value to a more common value1545 such as Mozilla/4.0. This may be necessary, for instance, if1546 connecting through a firewall that restricts HTTP connections to a set1547 of common USER_AGENT strings (but not including those like git/1.7.1).1548 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15491550http.<url>.*::1551 Any of the http.* options above can be applied selectively to some urls.1552 For a config key to match a URL, each element of the config key is1553 compared to that of the URL, in the following order:1554+1555--1556. Scheme (e.g., `https` in `https://example.com/`). This field1557 must match exactly between the config key and the URL.15581559. Host/domain name (e.g., `example.com` in `https://example.com/`).1560 This field must match exactly between the config key and the URL.15611562. Port number (e.g., `8080` in `http://example.com:8080/`).1563 This field must match exactly between the config key and the URL.1564 Omitted port numbers are automatically converted to the correct1565 default for the scheme before matching.15661567. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1568 path field of the config key must match the path field of the URL1569 either exactly or as a prefix of slash-delimited path elements. This means1570 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1571 match on a slash (`/`) boundary. Longer matches take precedence (so a config1572 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1573 key with just path `foo/`).15741575. User name (e.g., `user` in `https://user@example.com/repo.git`). If1576 the config key has a user name it must match the user name in the1577 URL exactly. If the config key does not have a user name, that1578 config key will match a URL with any user name (including none),1579 but at a lower precedence than a config key with a user name.1580--1581+1582The list above is ordered by decreasing precedence; a URL that matches1583a config key's path is preferred to one that matches its user name. For example,1584if the URL is `https://user@example.com/foo/bar` a config key match of1585`https://example.com/foo` will be preferred over a config key match of1586`https://user@example.com`.1587+1588All URLs are normalized before attempting any matching (the password part,1589if embedded in the URL, is always ignored for matching purposes) so that1590equivalent urls that are simply spelled differently will match properly.1591Environment variable settings always override any matches. The urls that are1592matched against are those given directly to Git commands. This means any URLs1593visited as a result of a redirection do not participate in matching.15941595i18n.commitEncoding::1596 Character encoding the commit messages are stored in; Git itself1597 does not care per se, but this information is necessary e.g. when1598 importing commits from emails or in the gitk graphical history1599 browser (and possibly at other places in the future or in other1600 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16011602i18n.logOutputEncoding::1603 Character encoding the commit messages are converted to when1604 running 'git log' and friends.16051606imap::1607 The configuration variables in the 'imap' section are described1608 in linkgit:git-imap-send[1].16091610init.templatedir::1611 Specify the directory from which templates will be copied.1612 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16131614instaweb.browser::1615 Specify the program that will be used to browse your working1616 repository in gitweb. See linkgit:git-instaweb[1].16171618instaweb.httpd::1619 The HTTP daemon command-line to start gitweb on your working1620 repository. See linkgit:git-instaweb[1].16211622instaweb.local::1623 If true the web server started by linkgit:git-instaweb[1] will1624 be bound to the local IP (127.0.0.1).16251626instaweb.modulepath::1627 The default module path for linkgit:git-instaweb[1] to use1628 instead of /usr/lib/apache2/modules. Only used if httpd1629 is Apache.16301631instaweb.port::1632 The port number to bind the gitweb httpd to. See1633 linkgit:git-instaweb[1].16341635interactive.singlekey::1636 In interactive commands, allow the user to provide one-letter1637 input with a single key (i.e., without hitting enter).1638 Currently this is used by the `--patch` mode of1639 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1640 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1641 setting is silently ignored if portable keystroke input1642 is not available.16431644log.abbrevCommit::1645 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1646 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1647 override this option with `--no-abbrev-commit`.16481649log.date::1650 Set the default date-time mode for the 'log' command.1651 Setting a value for log.date is similar to using 'git log''s1652 `--date` option. Possible values are `relative`, `local`,1653 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1654 for details.16551656log.decorate::1657 Print out the ref names of any commits that are shown by the log1658 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1659 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1660 specified, the full ref name (including prefix) will be printed.1661 This is the same as the log commands '--decorate' option.16621663log.showroot::1664 If true, the initial commit will be shown as a big creation event.1665 This is equivalent to a diff against an empty tree.1666 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1667 normally hide the root commit will now show it. True by default.16681669log.mailmap::1670 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1671 linkgit:git-whatchanged[1] assume `--use-mailmap`.16721673mailmap.file::1674 The location of an augmenting mailmap file. The default1675 mailmap, located in the root of the repository, is loaded1676 first, then the mailmap file pointed to by this variable.1677 The location of the mailmap file may be in a repository1678 subdirectory, or somewhere outside of the repository itself.1679 See linkgit:git-shortlog[1] and linkgit:git-blame[1].16801681mailmap.blob::1682 Like `mailmap.file`, but consider the value as a reference to a1683 blob in the repository. If both `mailmap.file` and1684 `mailmap.blob` are given, both are parsed, with entries from1685 `mailmap.file` taking precedence. In a bare repository, this1686 defaults to `HEAD:.mailmap`. In a non-bare repository, it1687 defaults to empty.16881689man.viewer::1690 Specify the programs that may be used to display help in the1691 'man' format. See linkgit:git-help[1].16921693man.<tool>.cmd::1694 Specify the command to invoke the specified man viewer. The1695 specified command is evaluated in shell with the man page1696 passed as argument. (See linkgit:git-help[1].)16971698man.<tool>.path::1699 Override the path for the given tool that may be used to1700 display help in the 'man' format. See linkgit:git-help[1].17011702include::merge-config.txt[]17031704mergetool.<tool>.path::1705 Override the path for the given tool. This is useful in case1706 your tool is not in the PATH.17071708mergetool.<tool>.cmd::1709 Specify the command to invoke the specified merge tool. The1710 specified command is evaluated in shell with the following1711 variables available: 'BASE' is the name of a temporary file1712 containing the common base of the files to be merged, if available;1713 'LOCAL' is the name of a temporary file containing the contents of1714 the file on the current branch; 'REMOTE' is the name of a temporary1715 file containing the contents of the file from the branch being1716 merged; 'MERGED' contains the name of the file to which the merge1717 tool should write the results of a successful merge.17181719mergetool.<tool>.trustExitCode::1720 For a custom merge command, specify whether the exit code of1721 the merge command can be used to determine whether the merge was1722 successful. If this is not set to true then the merge target file1723 timestamp is checked and the merge assumed to have been successful1724 if the file has been updated, otherwise the user is prompted to1725 indicate the success of the merge.17261727mergetool.keepBackup::1728 After performing a merge, the original file with conflict markers1729 can be saved as a file with a `.orig` extension. If this variable1730 is set to `false` then this file is not preserved. Defaults to1731 `true` (i.e. keep the backup files).17321733mergetool.keepTemporaries::1734 When invoking a custom merge tool, Git uses a set of temporary1735 files to pass to the tool. If the tool returns an error and this1736 variable is set to `true`, then these temporary files will be1737 preserved, otherwise they will be removed after the tool has1738 exited. Defaults to `false`.17391740mergetool.prompt::1741 Prompt before each invocation of the merge resolution program.17421743notes.displayRef::1744 The (fully qualified) refname from which to show notes when1745 showing commit messages. The value of this variable can be set1746 to a glob, in which case notes from all matching refs will be1747 shown. You may also specify this configuration variable1748 several times. A warning will be issued for refs that do not1749 exist, but a glob that does not match any refs is silently1750 ignored.1751+1752This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1753environment variable, which must be a colon separated list of refs or1754globs.1755+1756The effective value of "core.notesRef" (possibly overridden by1757GIT_NOTES_REF) is also implicitly added to the list of refs to be1758displayed.17591760notes.rewrite.<command>::1761 When rewriting commits with <command> (currently `amend` or1762 `rebase`) and this variable is set to `true`, Git1763 automatically copies your notes from the original to the1764 rewritten commit. Defaults to `true`, but see1765 "notes.rewriteRef" below.17661767notes.rewriteMode::1768 When copying notes during a rewrite (see the1769 "notes.rewrite.<command>" option), determines what to do if1770 the target commit already has a note. Must be one of1771 `overwrite`, `concatenate`, or `ignore`. Defaults to1772 `concatenate`.1773+1774This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1775environment variable.17761777notes.rewriteRef::1778 When copying notes during a rewrite, specifies the (fully1779 qualified) ref whose notes should be copied. The ref may be a1780 glob, in which case notes in all matching refs will be copied.1781 You may also specify this configuration several times.1782+1783Does not have a default value; you must configure this variable to1784enable note rewriting. Set it to `refs/notes/commits` to enable1785rewriting for the default commit notes.1786+1787This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1788environment variable, which must be a colon separated list of refs or1789globs.17901791pack.window::1792 The size of the window used by linkgit:git-pack-objects[1] when no1793 window size is given on the command line. Defaults to 10.17941795pack.depth::1796 The maximum delta depth used by linkgit:git-pack-objects[1] when no1797 maximum depth is given on the command line. Defaults to 50.17981799pack.windowMemory::1800 The window memory size limit used by linkgit:git-pack-objects[1]1801 when no limit is given on the command line. The value can be1802 suffixed with "k", "m", or "g". Defaults to 0, meaning no1803 limit.18041805pack.compression::1806 An integer -1..9, indicating the compression level for objects1807 in a pack file. -1 is the zlib default. 0 means no1808 compression, and 1..9 are various speed/size tradeoffs, 9 being1809 slowest. If not set, defaults to core.compression. If that is1810 not set, defaults to -1, the zlib default, which is "a default1811 compromise between speed and compression (currently equivalent1812 to level 6)."1813+1814Note that changing the compression level will not automatically recompress1815all existing objects. You can force recompression by passing the -F option1816to linkgit:git-repack[1].18171818pack.deltaCacheSize::1819 The maximum memory in bytes used for caching deltas in1820 linkgit:git-pack-objects[1] before writing them out to a pack.1821 This cache is used to speed up the writing object phase by not1822 having to recompute the final delta result once the best match1823 for all objects is found. Repacking large repositories on machines1824 which are tight with memory might be badly impacted by this though,1825 especially if this cache pushes the system into swapping.1826 A value of 0 means no limit. The smallest size of 1 byte may be1827 used to virtually disable this cache. Defaults to 256 MiB.18281829pack.deltaCacheLimit::1830 The maximum size of a delta, that is cached in1831 linkgit:git-pack-objects[1]. This cache is used to speed up the1832 writing object phase by not having to recompute the final delta1833 result once the best match for all objects is found. Defaults to 1000.18341835pack.threads::1836 Specifies the number of threads to spawn when searching for best1837 delta matches. This requires that linkgit:git-pack-objects[1]1838 be compiled with pthreads otherwise this option is ignored with a1839 warning. This is meant to reduce packing time on multiprocessor1840 machines. The required amount of memory for the delta search window1841 is however multiplied by the number of threads.1842 Specifying 0 will cause Git to auto-detect the number of CPU's1843 and set the number of threads accordingly.18441845pack.indexVersion::1846 Specify the default pack index version. Valid values are 1 for1847 legacy pack index used by Git versions prior to 1.5.2, and 2 for1848 the new pack index with capabilities for packs larger than 4 GB1849 as well as proper protection against the repacking of corrupted1850 packs. Version 2 is the default. Note that version 2 is enforced1851 and this config option ignored whenever the corresponding pack is1852 larger than 2 GB.1853+1854If you have an old Git that does not understand the version 2 `*.idx` file,1855cloning or fetching over a non native protocol (e.g. "http" and "rsync")1856that will copy both `*.pack` file and corresponding `*.idx` file from the1857other side may give you a repository that cannot be accessed with your1858older version of Git. If the `*.pack` file is smaller than 2 GB, however,1859you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1860the `*.idx` file.18611862pack.packSizeLimit::1863 The maximum size of a pack. This setting only affects1864 packing to a file when repacking, i.e. the git:// protocol1865 is unaffected. It can be overridden by the `--max-pack-size`1866 option of linkgit:git-repack[1]. The minimum size allowed is1867 limited to 1 MiB. The default is unlimited.1868 Common unit suffixes of 'k', 'm', or 'g' are1869 supported.18701871pager.<cmd>::1872 If the value is boolean, turns on or off pagination of the1873 output of a particular Git subcommand when writing to a tty.1874 Otherwise, turns on pagination for the subcommand using the1875 pager specified by the value of `pager.<cmd>`. If `--paginate`1876 or `--no-pager` is specified on the command line, it takes1877 precedence over this option. To disable pagination for all1878 commands, set `core.pager` or `GIT_PAGER` to `cat`.18791880pretty.<name>::1881 Alias for a --pretty= format string, as specified in1882 linkgit:git-log[1]. Any aliases defined here can be used just1883 as the built-in pretty formats could. For example,1884 running `git config pretty.changelog "format:* %H %s"`1885 would cause the invocation `git log --pretty=changelog`1886 to be equivalent to running `git log "--pretty=format:* %H %s"`.1887 Note that an alias with the same name as a built-in format1888 will be silently ignored.18891890pull.rebase::1891 When true, rebase branches on top of the fetched branch, instead1892 of merging the default branch from the default remote when "git1893 pull" is run. See "branch.<name>.rebase" for setting this on a1894 per-branch basis.1895+1896 When preserve, also pass `--preserve-merges` along to 'git rebase'1897 so that locally committed merge commits will not be flattened1898 by running 'git pull'.1899+1900*NOTE*: this is a possibly dangerous operation; do *not* use1901it unless you understand the implications (see linkgit:git-rebase[1]1902for details).19031904pull.octopus::1905 The default merge strategy to use when pulling multiple branches1906 at once.19071908pull.twohead::1909 The default merge strategy to use when pulling a single branch.19101911push.default::1912 Defines the action `git push` should take if no refspec is1913 explicitly given. Different values are well-suited for1914 specific workflows; for instance, in a purely central workflow1915 (i.e. the fetch source is equal to the push destination),1916 `upstream` is probably what you want. Possible values are:1917+1918--19191920* `nothing` - do not push anything (error out) unless a refspec is1921 explicitly given. This is primarily meant for people who want to1922 avoid mistakes by always being explicit.19231924* `current` - push the current branch to update a branch with the same1925 name on the receiving end. Works in both central and non-central1926 workflows.19271928* `upstream` - push the current branch back to the branch whose1929 changes are usually integrated into the current branch (which is1930 called `@{upstream}`). This mode only makes sense if you are1931 pushing to the same repository you would normally pull from1932 (i.e. central workflow).19331934* `simple` - in centralized workflow, work like `upstream` with an1935 added safety to refuse to push if the upstream branch's name is1936 different from the local one.1937+1938When pushing to a remote that is different from the remote you normally1939pull from, work as `current`. This is the safest option and is suited1940for beginners.1941+1942This mode will become the default in Git 2.0.19431944* `matching` - push all branches having the same name on both ends.1945 This makes the repository you are pushing to remember the set of1946 branches that will be pushed out (e.g. if you always push 'maint'1947 and 'master' there and no other branches, the repository you push1948 to will have these two branches, and your local 'maint' and1949 'master' will be pushed there).1950+1951To use this mode effectively, you have to make sure _all_ the1952branches you would push out are ready to be pushed out before1953running 'git push', as the whole point of this mode is to allow you1954to push all of the branches in one go. If you usually finish work1955on only one branch and push out the result, while other branches are1956unfinished, this mode is not for you. Also this mode is not1957suitable for pushing into a shared central repository, as other1958people may add new branches there, or update the tip of existing1959branches outside your control.1960+1961This is currently the default, but Git 2.0 will change the default1962to `simple`.19631964--19651966rebase.stat::1967 Whether to show a diffstat of what changed upstream since the last1968 rebase. False by default.19691970rebase.autosquash::1971 If set to true enable '--autosquash' option by default.19721973rebase.autostash::1974 When set to true, automatically create a temporary stash1975 before the operation begins, and apply it after the operation1976 ends. This means that you can run rebase on a dirty worktree.1977 However, use with care: the final stash application after a1978 successful rebase might result in non-trivial conflicts.1979 Defaults to false.19801981receive.autogc::1982 By default, git-receive-pack will run "git-gc --auto" after1983 receiving data from git-push and updating refs. You can stop1984 it by setting this variable to false.19851986receive.fsckObjects::1987 If it is set to true, git-receive-pack will check all received1988 objects. It will abort in the case of a malformed object or a1989 broken link. The result of an abort are only dangling objects.1990 Defaults to false. If not set, the value of `transfer.fsckObjects`1991 is used instead.19921993receive.unpackLimit::1994 If the number of objects received in a push is below this1995 limit then the objects will be unpacked into loose object1996 files. However if the number of received objects equals or1997 exceeds this limit then the received pack will be stored as1998 a pack, after adding any missing delta bases. Storing the1999 pack from a push can make the push operation complete faster,2000 especially on slow filesystems. If not set, the value of2001 `transfer.unpackLimit` is used instead.20022003receive.denyDeletes::2004 If set to true, git-receive-pack will deny a ref update that deletes2005 the ref. Use this to prevent such a ref deletion via a push.20062007receive.denyDeleteCurrent::2008 If set to true, git-receive-pack will deny a ref update that2009 deletes the currently checked out branch of a non-bare repository.20102011receive.denyCurrentBranch::2012 If set to true or "refuse", git-receive-pack will deny a ref update2013 to the currently checked out branch of a non-bare repository.2014 Such a push is potentially dangerous because it brings the HEAD2015 out of sync with the index and working tree. If set to "warn",2016 print a warning of such a push to stderr, but allow the push to2017 proceed. If set to false or "ignore", allow such pushes with no2018 message. Defaults to "refuse".20192020receive.denyNonFastForwards::2021 If set to true, git-receive-pack will deny a ref update which is2022 not a fast-forward. Use this to prevent such an update via a push,2023 even if that push is forced. This configuration variable is2024 set when initializing a shared repository.20252026receive.hiderefs::2027 String(s) `receive-pack` uses to decide which refs to omit2028 from its initial advertisement. Use more than one2029 definitions to specify multiple prefix strings. A ref that2030 are under the hierarchies listed on the value of this2031 variable is excluded, and is hidden when responding to `git2032 push`, and an attempt to update or delete a hidden ref by2033 `git push` is rejected.20342035receive.updateserverinfo::2036 If set to true, git-receive-pack will run git-update-server-info2037 after receiving data from git-push and updating refs.20382039remote.pushdefault::2040 The remote to push to by default. Overrides2041 `branch.<name>.remote` for all branches, and is overridden by2042 `branch.<name>.pushremote` for specific branches.20432044remote.<name>.url::2045 The URL of a remote repository. See linkgit:git-fetch[1] or2046 linkgit:git-push[1].20472048remote.<name>.pushurl::2049 The push URL of a remote repository. See linkgit:git-push[1].20502051remote.<name>.proxy::2052 For remotes that require curl (http, https and ftp), the URL to2053 the proxy to use for that remote. Set to the empty string to2054 disable proxying for that remote.20552056remote.<name>.fetch::2057 The default set of "refspec" for linkgit:git-fetch[1]. See2058 linkgit:git-fetch[1].20592060remote.<name>.push::2061 The default set of "refspec" for linkgit:git-push[1]. See2062 linkgit:git-push[1].20632064remote.<name>.mirror::2065 If true, pushing to this remote will automatically behave2066 as if the `--mirror` option was given on the command line.20672068remote.<name>.skipDefaultUpdate::2069 If true, this remote will be skipped by default when updating2070 using linkgit:git-fetch[1] or the `update` subcommand of2071 linkgit:git-remote[1].20722073remote.<name>.skipFetchAll::2074 If true, this remote will be skipped by default when updating2075 using linkgit:git-fetch[1] or the `update` subcommand of2076 linkgit:git-remote[1].20772078remote.<name>.receivepack::2079 The default program to execute on the remote side when pushing. See2080 option \--receive-pack of linkgit:git-push[1].20812082remote.<name>.uploadpack::2083 The default program to execute on the remote side when fetching. See2084 option \--upload-pack of linkgit:git-fetch-pack[1].20852086remote.<name>.tagopt::2087 Setting this value to \--no-tags disables automatic tag following when2088 fetching from remote <name>. Setting it to \--tags will fetch every2089 tag from remote <name>, even if they are not reachable from remote2090 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2091 override this setting. See options \--tags and \--no-tags of2092 linkgit:git-fetch[1].20932094remote.<name>.vcs::2095 Setting this to a value <vcs> will cause Git to interact with2096 the remote with the git-remote-<vcs> helper.20972098remote.<name>.prune::2099 When set to true, fetching from this remote by default will also2100 remove any remote-tracking branches which no longer exist on the2101 remote (as if the `--prune` option was give on the command line).2102 Overrides `fetch.prune` settings, if any.21032104remotes.<group>::2105 The list of remotes which are fetched by "git remote update2106 <group>". See linkgit:git-remote[1].21072108repack.usedeltabaseoffset::2109 By default, linkgit:git-repack[1] creates packs that use2110 delta-base offset. If you need to share your repository with2111 Git older than version 1.4.4, either directly or via a dumb2112 protocol such as http, then you need to set this option to2113 "false" and repack. Access from old Git versions over the2114 native protocol are unaffected by this option.21152116rerere.autoupdate::2117 When set to true, `git-rerere` updates the index with the2118 resulting contents after it cleanly resolves conflicts using2119 previously recorded resolution. Defaults to false.21202121rerere.enabled::2122 Activate recording of resolved conflicts, so that identical2123 conflict hunks can be resolved automatically, should they be2124 encountered again. By default, linkgit:git-rerere[1] is2125 enabled if there is an `rr-cache` directory under the2126 `$GIT_DIR`, e.g. if "rerere" was previously used in the2127 repository.21282129sendemail.identity::2130 A configuration identity. When given, causes values in the2131 'sendemail.<identity>' subsection to take precedence over2132 values in the 'sendemail' section. The default identity is2133 the value of 'sendemail.identity'.21342135sendemail.smtpencryption::2136 See linkgit:git-send-email[1] for description. Note that this2137 setting is not subject to the 'identity' mechanism.21382139sendemail.smtpssl::2140 Deprecated alias for 'sendemail.smtpencryption = ssl'.21412142sendemail.smtpsslcertpath::2143 Path to ca-certificates (either a directory or a single file).2144 Set it to an empty string to disable certificate verification.21452146sendemail.<identity>.*::2147 Identity-specific versions of the 'sendemail.*' parameters2148 found below, taking precedence over those when the this2149 identity is selected, through command-line or2150 'sendemail.identity'.21512152sendemail.aliasesfile::2153sendemail.aliasfiletype::2154sendemail.annotate::2155sendemail.bcc::2156sendemail.cc::2157sendemail.cccmd::2158sendemail.chainreplyto::2159sendemail.confirm::2160sendemail.envelopesender::2161sendemail.from::2162sendemail.multiedit::2163sendemail.signedoffbycc::2164sendemail.smtppass::2165sendemail.suppresscc::2166sendemail.suppressfrom::2167sendemail.to::2168sendemail.smtpdomain::2169sendemail.smtpserver::2170sendemail.smtpserverport::2171sendemail.smtpserveroption::2172sendemail.smtpuser::2173sendemail.thread::2174sendemail.validate::2175 See linkgit:git-send-email[1] for description.21762177sendemail.signedoffcc::2178 Deprecated alias for 'sendemail.signedoffbycc'.21792180showbranch.default::2181 The default set of branches for linkgit:git-show-branch[1].2182 See linkgit:git-show-branch[1].21832184status.relativePaths::2185 By default, linkgit:git-status[1] shows paths relative to the2186 current directory. Setting this variable to `false` shows paths2187 relative to the repository root (this was the default for Git2188 prior to v1.5.4).21892190status.short::2191 Set to true to enable --short by default in linkgit:git-status[1].2192 The option --no-short takes precedence over this variable.21932194status.branch::2195 Set to true to enable --branch by default in linkgit:git-status[1].2196 The option --no-branch takes precedence over this variable.21972198status.displayCommentPrefix::2199 If set to true, linkgit:git-status[1] will insert a comment2200 prefix before each output line (starting with2201 `core.commentChar`, i.e. `#` by default). This was the2202 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2203 Defaults to false.22042205status.showUntrackedFiles::2206 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2207 files which are not currently tracked by Git. Directories which2208 contain only untracked files, are shown with the directory name2209 only. Showing untracked files means that Git needs to lstat() all2210 all the files in the whole repository, which might be slow on some2211 systems. So, this variable controls how the commands displays2212 the untracked files. Possible values are:2213+2214--2215* `no` - Show no untracked files.2216* `normal` - Show untracked files and directories.2217* `all` - Show also individual files in untracked directories.2218--2219+2220If this variable is not specified, it defaults to 'normal'.2221This variable can be overridden with the -u|--untracked-files option2222of linkgit:git-status[1] and linkgit:git-commit[1].22232224status.submodulesummary::2225 Defaults to false.2226 If this is set to a non zero number or true (identical to -1 or an2227 unlimited number), the submodule summary will be enabled and a2228 summary of commits for modified submodules will be shown (see2229 --summary-limit option of linkgit:git-submodule[1]). Please note2230 that the summary output command will be suppressed for all2231 submodules when `diff.ignoreSubmodules` is set to 'all' or only2232 for those submodules where `submodule.<name>.ignore=all`. To2233 also view the summary for ignored submodules you can either use2234 the --ignore-submodules=dirty command line option or the 'git2235 submodule summary' command, which shows a similar output but does2236 not honor these settings.22372238submodule.<name>.path::2239submodule.<name>.url::2240submodule.<name>.update::2241 The path within this project, URL, and the updating strategy2242 for a submodule. These variables are initially populated2243 by 'git submodule init'; edit them to override the2244 URL and other values found in the `.gitmodules` file. See2245 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.22462247submodule.<name>.branch::2248 The remote branch name for a submodule, used by `git submodule2249 update --remote`. Set this option to override the value found in2250 the `.gitmodules` file. See linkgit:git-submodule[1] and2251 linkgit:gitmodules[5] for details.22522253submodule.<name>.fetchRecurseSubmodules::2254 This option can be used to control recursive fetching of this2255 submodule. It can be overridden by using the --[no-]recurse-submodules2256 command line option to "git fetch" and "git pull".2257 This setting will override that from in the linkgit:gitmodules[5]2258 file.22592260submodule.<name>.ignore::2261 Defines under what circumstances "git status" and the diff family show2262 a submodule as modified. When set to "all", it will never be considered2263 modified, "dirty" will ignore all changes to the submodules work tree and2264 takes only differences between the HEAD of the submodule and the commit2265 recorded in the superproject into account. "untracked" will additionally2266 let submodules with modified tracked files in their work tree show up.2267 Using "none" (the default when this option is not set) also shows2268 submodules that have untracked files in their work tree as changed.2269 This setting overrides any setting made in .gitmodules for this submodule,2270 both settings can be overridden on the command line by using the2271 "--ignore-submodules" option. The 'git submodule' commands are not2272 affected by this setting.22732274tar.umask::2275 This variable can be used to restrict the permission bits of2276 tar archive entries. The default is 0002, which turns off the2277 world write bit. The special value "user" indicates that the2278 archiving user's umask will be used instead. See umask(2) and2279 linkgit:git-archive[1].22802281transfer.fsckObjects::2282 When `fetch.fsckObjects` or `receive.fsckObjects` are2283 not set, the value of this variable is used instead.2284 Defaults to false.22852286transfer.hiderefs::2287 This variable can be used to set both `receive.hiderefs`2288 and `uploadpack.hiderefs` at the same time to the same2289 values. See entries for these other variables.22902291transfer.unpackLimit::2292 When `fetch.unpackLimit` or `receive.unpackLimit` are2293 not set, the value of this variable is used instead.2294 The default value is 100.22952296uploadpack.hiderefs::2297 String(s) `upload-pack` uses to decide which refs to omit2298 from its initial advertisement. Use more than one2299 definitions to specify multiple prefix strings. A ref that2300 are under the hierarchies listed on the value of this2301 variable is excluded, and is hidden from `git ls-remote`,2302 `git fetch`, etc. An attempt to fetch a hidden ref by `git2303 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.23042305uploadpack.allowtipsha1inwant::2306 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2307 to accept a fetch request that asks for an object at the tip2308 of a hidden ref (by default, such a request is rejected).2309 see also `uploadpack.hiderefs`.23102311uploadpack.keepalive::2312 When `upload-pack` has started `pack-objects`, there may be a2313 quiet period while `pack-objects` prepares the pack. Normally2314 it would output progress information, but if `--quiet` was used2315 for the fetch, `pack-objects` will output nothing at all until2316 the pack data begins. Some clients and networks may consider2317 the server to be hung and give up. Setting this option instructs2318 `upload-pack` to send an empty keepalive packet every2319 `uploadpack.keepalive` seconds. Setting this option to 02320 disables keepalive packets entirely. The default is 5 seconds.23212322url.<base>.insteadOf::2323 Any URL that starts with this value will be rewritten to2324 start, instead, with <base>. In cases where some site serves a2325 large number of repositories, and serves them with multiple2326 access methods, and some users need to use different access2327 methods, this feature allows people to specify any of the2328 equivalent URLs and have Git automatically rewrite the URL to2329 the best alternative for the particular user, even for a2330 never-before-seen repository on the site. When more than one2331 insteadOf strings match a given URL, the longest match is used.23322333url.<base>.pushInsteadOf::2334 Any URL that starts with this value will not be pushed to;2335 instead, it will be rewritten to start with <base>, and the2336 resulting URL will be pushed to. In cases where some site serves2337 a large number of repositories, and serves them with multiple2338 access methods, some of which do not allow push, this feature2339 allows people to specify a pull-only URL and have Git2340 automatically use an appropriate URL to push, even for a2341 never-before-seen repository on the site. When more than one2342 pushInsteadOf strings match a given URL, the longest match is2343 used. If a remote has an explicit pushurl, Git will ignore this2344 setting for that remote.23452346user.email::2347 Your email address to be recorded in any newly created commits.2348 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2349 'EMAIL' environment variables. See linkgit:git-commit-tree[1].23502351user.name::2352 Your full name to be recorded in any newly created commits.2353 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2354 environment variables. See linkgit:git-commit-tree[1].23552356user.signingkey::2357 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2358 key you want it to automatically when creating a signed tag or2359 commit, you can override the default selection with this variable.2360 This option is passed unchanged to gpg's --local-user parameter,2361 so you may specify a key using any method that gpg supports.23622363web.browser::2364 Specify a web browser that may be used by some commands.2365 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2366 may use it.