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. 18 19Syntax 20~~~~~~ 21 22The syntax is fairly flexible and permissive; whitespaces are mostly 23ignored. The '#' and ';' characters begin comments to the end of line, 24blank lines are ignored. 25 26The file consists of sections and variables. A section begins with 27the name of the section in square brackets and continues until the next 28section begins. Section names are not case sensitive. Only alphanumeric 29characters, `-` and `.` are allowed in section names. Each variable 30must belong to some section, which means that there must be a section 31header before the first setting of a variable. 32 33Sections can be further divided into subsections. To begin a subsection 34put its name in double quotes, separated by space from the section name, 35in the section header, like in the example below: 36 37-------- 38 [section "subsection"] 39 40-------- 41 42Subsection names are case sensitive and can contain any characters except 43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 44respectively). Section headers cannot span multiple 45lines. Variables may belong directly to a section or to a given subsection. 46You can have `[section]` if you have `[section "subsection"]`, but you 47don't need to. 48 49There is also a deprecated `[section.subsection]` syntax. With this 50syntax, the subsection name is converted to lower-case and is also 51compared case sensitively. These subsection names follow the same 52restrictions as section names. 53 54All the other lines (and the remainder of the line after the section 55header) are recognized as setting variables, in the form 56'name = value'. If there is no equal sign on the line, the entire line 57is taken as 'name' and the variable is recognized as boolean "true". 58The variable names are case-insensitive, allow only alphanumeric characters 59and `-`, and must start with an alphabetic character. There can be more 60than one value for a given variable; we say then that the variable is 61multivalued. 62 63Leading and trailing whitespace in a variable value is discarded. 64Internal whitespace within a variable value is retained verbatim. 65 66The values following the equals sign in variable assign are all either 67a string, an integer, or a boolean. Boolean values may be given as yes/no, 681/0, true/false or on/off. Case is not significant in boolean values, when 69converting value to the canonical form using '--bool' type specifier; 70'git config' will ensure that the output is "true" or "false". 71 72String values may be entirely or partially enclosed in double quotes. 73You need to enclose variable values in double quotes if you want to 74preserve leading or trailing whitespace, or if the variable value contains 75comment characters (i.e. it contains '#' or ';'). 76Double quote `"` and backslash `\` characters in variable values must 77be escaped: use `\"` for `"` and `\\` for `\`. 78 79The following escape sequences (beside `\"` and `\\`) are recognized: 80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 81and `\b` for backspace (BS). Other char escape sequences (including octal 82escape sequences) are invalid. 83 84Variable values ending in a `\` are continued on the next line in the 85customary UNIX fashion. 86 87Some variables may require a special value format. 88 89Includes 90~~~~~~~~ 91 92You can include one config file from another by setting the special 93`include.path` variable to the name of the file to be included. The 94included file is expanded immediately, as if its contents had been 95found at the location of the include directive. If the value of the 96`include.path` variable is a relative path, the path is considered to be 97relative to the configuration file in which the include directive was 98found. The value of `include.path` is subject to tilde expansion: `~/` 99is expanded to the value of `$HOME`, and `~user/` to the specified 100user's home directory. See below for examples. 101 102Example 103~~~~~~~ 104 105 # Core variables 106 [core] 107 ; Don't trust file modes 108 filemode = false 109 110 # Our diff algorithm 111 [diff] 112 external = /usr/local/bin/diff-wrapper 113 renames = true 114 115 [branch "devel"] 116 remote = origin 117 merge = refs/heads/devel 118 119 # Proxy settings 120 [core] 121 gitProxy="ssh" for "kernel.org" 122 gitProxy=default-proxy ; for the rest 123 124 [include] 125 path = /path/to/foo.inc ; include by absolute path 126 path = foo ; expand "foo" relative to the current file 127 path = ~/foo ; expand "foo" in your $HOME directory 128 129Variables 130~~~~~~~~~ 131 132Note that this list is non-comprehensive and not necessarily complete. 133For command-specific variables, you will find a more detailed description 134in the appropriate manual page. 135 136Other git-related tools may and do use their own variables. When 137inventing new variables for use in your own tool, make sure their 138names do not conflict with those that are used by Git itself and 139other popular tools, and describe them in your documentation. 140 141 142advice.*:: 143 These variables control various optional help messages designed to 144 aid new users. All 'advice.*' variables default to 'true', and you 145 can tell Git that you do not need help by setting these to 'false': 146+ 147-- 148 pushUpdateRejected:: 149 Set this variable to 'false' if you want to disable 150 'pushNonFFCurrent', 151 'pushNonFFMatching', 'pushAlreadyExists', 152 'pushFetchFirst', and 'pushNeedsForce' 153 simultaneously. 154 pushNonFFCurrent:: 155 Advice shown when linkgit:git-push[1] fails due to a 156 non-fast-forward update to the current branch. 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.trustctime:: 237 If false, the ctime differences between the index and the 238 working tree are ignored; useful when the inode change time 239 is regularly modified by something outside Git (file system 240 crawlers and some backup systems). 241 See linkgit:git-update-index[1]. True by default. 242 243core.checkstat:: 244 Determines which stat fields to match between the index 245 and work tree. The user can set this to 'default' or 246 'minimal'. Default (or explicitly 'default'), is to check 247 all fields, including the sub-second part of mtime and ctime. 248 249core.quotepath:: 250 The commands that output paths (e.g. 'ls-files', 251 'diff'), when not given the `-z` option, will quote 252 "unusual" characters in the pathname by enclosing the 253 pathname in a double-quote pair and with backslashes the 254 same way strings in C source code are quoted. If this 255 variable is set to false, the bytes higher than 0x80 are 256 not quoted but output as verbatim. Note that double 257 quote, backslash and control characters are always 258 quoted without `-z` regardless of the setting of this 259 variable. 260 261core.eol:: 262 Sets the line ending type to use in the working directory for 263 files that have the `text` property set. Alternatives are 264 'lf', 'crlf' and 'native', which uses the platform's native 265 line ending. The default value is `native`. See 266 linkgit:gitattributes[5] for more information on end-of-line 267 conversion. 268 269core.safecrlf:: 270 If true, makes Git check if converting `CRLF` is reversible when 271 end-of-line conversion is active. Git will verify if a command 272 modifies a file in the work tree either directly or indirectly. 273 For example, committing a file followed by checking out the 274 same file should yield the original file in the work tree. If 275 this is not the case for the current setting of 276 `core.autocrlf`, Git will reject the file. The variable can 277 be set to "warn", in which case Git will only warn about an 278 irreversible conversion but continue the operation. 279+ 280CRLF conversion bears a slight chance of corrupting data. 281When it is enabled, Git will convert CRLF to LF during commit and LF to 282CRLF during checkout. A file that contains a mixture of LF and 283CRLF before the commit cannot be recreated by Git. For text 284files this is the right thing to do: it corrects line endings 285such that we have only LF line endings in the repository. 286But for binary files that are accidentally classified as text the 287conversion can corrupt data. 288+ 289If you recognize such corruption early you can easily fix it by 290setting the conversion type explicitly in .gitattributes. Right 291after committing you still have the original file in your work 292tree and this file is not yet corrupted. You can explicitly tell 293Git that this file is binary and Git will handle the file 294appropriately. 295+ 296Unfortunately, the desired effect of cleaning up text files with 297mixed line endings and the undesired effect of corrupting binary 298files cannot be distinguished. In both cases CRLFs are removed 299in an irreversible way. For text files this is the right thing 300to do because CRLFs are line endings, while for binary files 301converting CRLFs corrupts data. 302+ 303Note, this safety check does not mean that a checkout will generate a 304file identical to the original file for a different setting of 305`core.eol` and `core.autocrlf`, but only for the current one. For 306example, a text file with `LF` would be accepted with `core.eol=lf` 307and could later be checked out with `core.eol=crlf`, in which case the 308resulting file would contain `CRLF`, although the original file 309contained `LF`. However, in both work trees the line endings would be 310consistent, that is either all `LF` or all `CRLF`, but never mixed. A 311file with mixed line endings would be reported by the `core.safecrlf` 312mechanism. 313 314core.autocrlf:: 315 Setting this variable to "true" is almost the same as setting 316 the `text` attribute to "auto" on all files except that text 317 files are not guaranteed to be normalized: files that contain 318 `CRLF` in the repository will not be touched. Use this 319 setting if you want to have `CRLF` line endings in your 320 working directory even though the repository does not have 321 normalized line endings. This variable can be set to 'input', 322 in which case no output conversion is performed. 323 324core.symlinks:: 325 If false, symbolic links are checked out as small plain files that 326 contain the link text. linkgit:git-update-index[1] and 327 linkgit:git-add[1] will not change the recorded type to regular 328 file. Useful on filesystems like FAT that do not support 329 symbolic links. 330+ 331The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 332will probe and set core.symlinks false if appropriate when the repository 333is created. 334 335core.gitProxy:: 336 A "proxy command" to execute (as 'command host port') instead 337 of establishing direct connection to the remote server when 338 using the Git protocol for fetching. If the variable value is 339 in the "COMMAND for DOMAIN" format, the command is applied only 340 on hostnames ending with the specified domain string. This variable 341 may be set multiple times and is matched in the given order; 342 the first match wins. 343+ 344Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 345(which always applies universally, without the special "for" 346handling). 347+ 348The special string `none` can be used as the proxy command to 349specify that no proxy be used for a given domain pattern. 350This is useful for excluding servers inside a firewall from 351proxy use, while defaulting to a common proxy for external domains. 352 353core.ignoreStat:: 354 If true, commands which modify both the working tree and the index 355 will mark the updated paths with the "assume unchanged" bit in the 356 index. These marked files are then assumed to stay unchanged in the 357 working tree, until you mark them otherwise manually - Git will not 358 detect the file changes by lstat() calls. This is useful on systems 359 where those are very slow, such as Microsoft Windows. 360 See linkgit:git-update-index[1]. 361 False by default. 362 363core.preferSymlinkRefs:: 364 Instead of the default "symref" format for HEAD 365 and other symbolic reference files, use symbolic links. 366 This is sometimes needed to work with old scripts that 367 expect HEAD to be a symbolic link. 368 369core.bare:: 370 If true this repository is assumed to be 'bare' and has no 371 working directory associated with it. If this is the case a 372 number of commands that require a working directory will be 373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 374+ 375This setting is automatically guessed by linkgit:git-clone[1] or 376linkgit:git-init[1] when the repository was created. By default a 377repository that ends in "/.git" is assumed to be not bare (bare = 378false), while all other repositories are assumed to be bare (bare 379= true). 380 381core.worktree:: 382 Set the path to the root of the working tree. 383 This can be overridden by the GIT_WORK_TREE environment 384 variable and the '--work-tree' command-line option. 385 The value can be an absolute path or relative to the path to 386 the .git directory, which is either specified by --git-dir 387 or GIT_DIR, or automatically discovered. 388 If --git-dir or GIT_DIR is specified but none of 389 --work-tree, GIT_WORK_TREE and core.worktree is specified, 390 the current working directory is regarded as the top level 391 of your working tree. 392+ 393Note that this variable is honored even when set in a configuration 394file in a ".git" subdirectory of a directory and its value differs 395from the latter directory (e.g. "/path/to/.git/config" has 396core.worktree set to "/different/path"), which is most likely a 397misconfiguration. Running Git commands in the "/path/to" directory will 398still use "/different/path" as the root of the work tree and can cause 399confusion unless you know what you are doing (e.g. you are creating a 400read-only snapshot of the same index to a location different from the 401repository's usual working tree). 402 403core.logAllRefUpdates:: 404 Enable the reflog. Updates to a ref <ref> is logged to the file 405 "$GIT_DIR/logs/<ref>", by appending the new and old 406 SHA-1, the date/time and the reason of the update, but 407 only when the file exists. If this configuration 408 variable is set to true, missing "$GIT_DIR/logs/<ref>" 409 file is automatically created for branch heads (i.e. under 410 refs/heads/), remote refs (i.e. under refs/remotes/), 411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 412+ 413This information can be used to determine what commit 414was the tip of a branch "2 days ago". 415+ 416This value is true by default in a repository that has 417a working directory associated with it, and false by 418default in a bare repository. 419 420core.repositoryFormatVersion:: 421 Internal variable identifying the repository format and layout 422 version. 423 424core.sharedRepository:: 425 When 'group' (or 'true'), the repository is made shareable between 426 several users in a group (making sure all the files and objects are 427 group-writable). When 'all' (or 'world' or 'everybody'), the 428 repository will be readable by all users, additionally to being 429 group-shareable. When 'umask' (or 'false'), Git will use permissions 430 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 431 files in the repository will have this mode value. '0xxx' will override 432 user's umask value (whereas the other options will only override 433 requested parts of the user's umask value). Examples: '0660' will make 434 the repo read/write-able for the owner and group, but inaccessible to 435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 436 repository that is group-readable but not group-writable. 437 See linkgit:git-init[1]. False by default. 438 439core.warnAmbiguousRefs:: 440 If true, Git will warn you if the ref name you passed it is ambiguous 441 and might match multiple refs in the repository. True by default. 442 443core.compression:: 444 An integer -1..9, indicating a default compression level. 445 -1 is the zlib default. 0 means no compression, 446 and 1..9 are various speed/size tradeoffs, 9 being slowest. 447 If set, this provides a default to other compression variables, 448 such as 'core.loosecompression' and 'pack.compression'. 449 450core.loosecompression:: 451 An integer -1..9, indicating the compression level for objects that 452 are not in a pack file. -1 is the zlib default. 0 means no 453 compression, and 1..9 are various speed/size tradeoffs, 9 being 454 slowest. If not set, defaults to core.compression. If that is 455 not set, defaults to 1 (best speed). 456 457core.packedGitWindowSize:: 458 Number of bytes of a pack file to map into memory in a 459 single mapping operation. Larger window sizes may allow 460 your system to process a smaller number of large pack files 461 more quickly. Smaller window sizes will negatively affect 462 performance due to increased calls to the operating system's 463 memory manager, but may improve performance when accessing 464 a large number of large pack files. 465+ 466Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 467MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 468be reasonable for all users/operating systems. You probably do 469not need to adjust this value. 470+ 471Common unit suffixes of 'k', 'm', or 'g' are supported. 472 473core.packedGitLimit:: 474 Maximum number of bytes to map simultaneously into memory 475 from pack files. If Git needs to access more than this many 476 bytes at once to complete an operation it will unmap existing 477 regions to reclaim virtual address space within the process. 478+ 479Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 480This should be reasonable for all users/operating systems, except on 481the largest projects. You probably do not need to adjust this value. 482+ 483Common unit suffixes of 'k', 'm', or 'g' are supported. 484 485core.deltaBaseCacheLimit:: 486 Maximum number of bytes to reserve for caching base objects 487 that may be referenced by multiple deltified objects. By storing the 488 entire decompressed base objects in a cache Git is able 489 to avoid unpacking and decompressing frequently used base 490 objects multiple times. 491+ 492Default is 96 MiB on all platforms. This should be reasonable 493for all users/operating systems, except on the largest projects. 494You probably do not need to adjust this value. 495+ 496Common unit suffixes of 'k', 'm', or 'g' are supported. 497 498core.bigFileThreshold:: 499 Files larger than this size are stored deflated, without 500 attempting delta compression. Storing large files without 501 delta compression avoids excessive memory usage, at the 502 slight expense of increased disk usage. 503+ 504Default is 512 MiB on all platforms. This should be reasonable 505for most projects as source code and other text files can still 506be delta compressed, but larger binary media files won't be. 507+ 508Common unit suffixes of 'k', 'm', or 'g' are supported. 509 510core.excludesfile:: 511 In addition to '.gitignore' (per-directory) and 512 '.git/info/exclude', Git looks into this file for patterns 513 of files which are not meant to be tracked. "`~/`" is expanded 514 to the value of `$HOME` and "`~user/`" to the specified user's 515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 517 is used instead. See linkgit:gitignore[5]. 518 519core.askpass:: 520 Some commands (e.g. svn and http interfaces) that interactively 521 ask for a password can be told to use an external program given 522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 523 environment variable. If not set, fall back to the value of the 524 'SSH_ASKPASS' environment variable or, failing that, a simple password 525 prompt. The external program shall be given a suitable prompt as 526 command-line argument and write the password on its STDOUT. 527 528core.attributesfile:: 529 In addition to '.gitattributes' (per-directory) and 530 '.git/info/attributes', Git looks into this file for attributes 531 (see linkgit:gitattributes[5]). Path expansions are made the same 532 way as for `core.excludesfile`. Its default value is 533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 534 set or empty, $HOME/.config/git/attributes is used instead. 535 536core.editor:: 537 Commands such as `commit` and `tag` that lets you edit 538 messages by launching an editor uses the value of this 539 variable when it is set, and the environment variable 540 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 541 542core.commentchar:: 543 Commands such as `commit` and `tag` that lets you edit 544 messages consider a line that begins with this character 545 commented, and removes them after the editor returns 546 (default '#'). 547+ 548If set to "auto", `git-commit` would select a character that is not 549the beginning character of any line in existing commit messages. 550 551sequence.editor:: 552 Text editor used by `git rebase -i` for editing the rebase instruction file. 553 The value is meant to be interpreted by the shell when it is used. 554 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 555 When not configured the default commit message editor is used instead. 556 557core.pager:: 558 Text viewer for use by Git commands (e.g., 'less'). The value 559 is meant to be interpreted by the shell. The order of preference 560 is the `$GIT_PAGER` environment variable, then `core.pager` 561 configuration, then `$PAGER`, and then the default chosen at 562 compile time (usually 'less'). 563+ 564When the `LESS` environment variable is unset, Git sets it to `FRX` 565(if `LESS` environment variable is set, Git does not change it at 566all). If you want to selectively override Git's default setting 567for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 568be passed to the shell by Git, which will translate the final 569command to `LESS=FRX less -S`. The environment does not set the 570`S` option but the command line does, instructing less to truncate 571long lines. Similarly, setting `core.pager` to `less -+F` will 572deactivate the `F` option specified by the environment from the 573command-line, deactivating the "quit if one screen" behavior of 574`less`. One can specifically activate some flags for particular 575commands: for example, setting `pager.blame` to `less -S` enables 576line truncation only for `git blame`. 577+ 578Likewise, when the `LV` environment variable is unset, Git sets it 579to `-c`. You can override this setting by exporting `LV` with 580another value or setting `core.pager` to `lv +c`. 581 582core.whitespace:: 583 A comma separated list of common whitespace problems to 584 notice. 'git diff' will use `color.diff.whitespace` to 585 highlight them, and 'git apply --whitespace=error' will 586 consider them as errors. You can prefix `-` to disable 587 any of them (e.g. `-trailing-space`): 588+ 589* `blank-at-eol` treats trailing whitespaces at the end of the line 590 as an error (enabled by default). 591* `space-before-tab` treats a space character that appears immediately 592 before a tab character in the initial indent part of the line as an 593 error (enabled by default). 594* `indent-with-non-tab` treats a line that is indented with space 595 characters instead of the equivalent tabs as an error (not enabled by 596 default). 597* `tab-in-indent` treats a tab character in the initial indent part of 598 the line as an error (not enabled by default). 599* `blank-at-eof` treats blank lines added at the end of file as an error 600 (enabled by default). 601* `trailing-space` is a short-hand to cover both `blank-at-eol` and 602 `blank-at-eof`. 603* `cr-at-eol` treats a carriage-return at the end of line as 604 part of the line terminator, i.e. with it, `trailing-space` 605 does not trigger if the character before such a carriage-return 606 is not a whitespace (not enabled by default). 607* `tabwidth=<n>` tells how many character positions a tab occupies; this 608 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 609 errors. The default tab width is 8. Allowed values are 1 to 63. 610 611core.fsyncobjectfiles:: 612 This boolean will enable 'fsync()' when writing object files. 613+ 614This is a total waste of time and effort on a filesystem that orders 615data writes properly, but can be useful for filesystems that do not use 616journalling (traditional UNIX filesystems) or that only journal metadata 617and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 618 619core.preloadindex:: 620 Enable parallel index preload for operations like 'git diff' 621+ 622This can speed up operations like 'git diff' and 'git status' especially 623on filesystems like NFS that have weak caching semantics and thus 624relatively high IO latencies. When enabled, Git will do the 625index comparison to the filesystem data in parallel, allowing 626overlapping IO's. Defaults to true. 627 628core.createObject:: 629 You can set this to 'link', in which case a hardlink followed by 630 a delete of the source are used to make sure that object creation 631 will not overwrite existing objects. 632+ 633On some file system/operating system combinations, this is unreliable. 634Set this config setting to 'rename' there; However, This will remove the 635check that makes sure that existing object files will not get overwritten. 636 637core.notesRef:: 638 When showing commit messages, also show notes which are stored in 639 the given ref. The ref must be fully qualified. If the given 640 ref does not exist, it is not an error but means that no 641 notes should be printed. 642+ 643This setting defaults to "refs/notes/commits", and it can be overridden by 644the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 645 646core.sparseCheckout:: 647 Enable "sparse checkout" feature. See section "Sparse checkout" in 648 linkgit:git-read-tree[1] for more information. 649 650core.abbrev:: 651 Set the length object names are abbreviated to. If unspecified, 652 many commands abbreviate to 7 hexdigits, which may not be enough 653 for abbreviated object names to stay unique for sufficiently long 654 time. 655 656add.ignore-errors:: 657add.ignoreErrors:: 658 Tells 'git add' to continue adding files when some files cannot be 659 added due to indexing errors. Equivalent to the '--ignore-errors' 660 option of linkgit:git-add[1]. Older versions of Git accept only 661 `add.ignore-errors`, which does not follow the usual naming 662 convention for configuration variables. Newer versions of Git 663 honor `add.ignoreErrors` as well. 664 665alias.*:: 666 Command aliases for the linkgit:git[1] command wrapper - e.g. 667 after defining "alias.last = cat-file commit HEAD", the invocation 668 "git last" is equivalent to "git cat-file commit HEAD". To avoid 669 confusion and troubles with script usage, aliases that 670 hide existing Git commands are ignored. Arguments are split by 671 spaces, the usual shell quoting and escaping is supported. 672 quote pair and a backslash can be used to quote them. 673+ 674If the alias expansion is prefixed with an exclamation point, 675it will be treated as a shell command. For example, defining 676"alias.new = !gitk --all --not ORIG_HEAD", the invocation 677"git new" is equivalent to running the shell command 678"gitk --all --not ORIG_HEAD". Note that shell commands will be 679executed from the top-level directory of a repository, which may 680not necessarily be the current directory. 681'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 682from the original current directory. See linkgit:git-rev-parse[1]. 683 684am.keepcr:: 685 If true, git-am will call git-mailsplit for patches in mbox format 686 with parameter '--keep-cr'. In this case git-mailsplit will 687 not remove `\r` from lines ending with `\r\n`. Can be overridden 688 by giving '--no-keep-cr' from the command line. 689 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 690 691apply.ignorewhitespace:: 692 When set to 'change', tells 'git apply' to ignore changes in 693 whitespace, in the same way as the '--ignore-space-change' 694 option. 695 When set to one of: no, none, never, false tells 'git apply' to 696 respect all whitespace differences. 697 See linkgit:git-apply[1]. 698 699apply.whitespace:: 700 Tells 'git apply' how to handle whitespaces, in the same way 701 as the '--whitespace' option. See linkgit:git-apply[1]. 702 703branch.autosetupmerge:: 704 Tells 'git branch' and 'git checkout' to set up new branches 705 so that linkgit:git-pull[1] will appropriately merge from the 706 starting point branch. Note that even if this option is not set, 707 this behavior can be chosen per-branch using the `--track` 708 and `--no-track` options. The valid settings are: `false` -- no 709 automatic setup is done; `true` -- automatic setup is done when the 710 starting point is a remote-tracking branch; `always` -- 711 automatic setup is done when the starting point is either a 712 local branch or remote-tracking 713 branch. This option defaults to true. 714 715branch.autosetuprebase:: 716 When a new branch is created with 'git branch' or 'git checkout' 717 that tracks another branch, this variable tells Git to set 718 up pull to rebase instead of merge (see "branch.<name>.rebase"). 719 When `never`, rebase is never automatically set to true. 720 When `local`, rebase is set to true for tracked branches of 721 other local branches. 722 When `remote`, rebase is set to true for tracked branches of 723 remote-tracking branches. 724 When `always`, rebase will be set to true for all tracking 725 branches. 726 See "branch.autosetupmerge" for details on how to set up a 727 branch to track another branch. 728 This option defaults to never. 729 730branch.<name>.remote:: 731 When on branch <name>, it tells 'git fetch' and 'git push' 732 which remote to fetch from/push to. The remote to push to 733 may be overridden with `remote.pushdefault` (for all branches). 734 The remote to push to, for the current branch, may be further 735 overridden by `branch.<name>.pushremote`. If no remote is 736 configured, or if you are not on any branch, it defaults to 737 `origin` for fetching and `remote.pushdefault` for pushing. 738 Additionally, `.` (a period) is the current local repository 739 (a dot-repository), see `branch.<name>.merge`'s final note below. 740 741branch.<name>.pushremote:: 742 When on branch <name>, it overrides `branch.<name>.remote` for 743 pushing. It also overrides `remote.pushdefault` for pushing 744 from branch <name>. When you pull from one place (e.g. your 745 upstream) and push to another place (e.g. your own publishing 746 repository), you would want to set `remote.pushdefault` to 747 specify the remote to push to for all branches, and use this 748 option to override it for a specific branch. 749 750branch.<name>.merge:: 751 Defines, together with branch.<name>.remote, the upstream branch 752 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 753 branch to merge and can also affect 'git push' (see push.default). 754 When in branch <name>, it tells 'git fetch' the default 755 refspec to be marked for merging in FETCH_HEAD. The value is 756 handled like the remote part of a refspec, and must match a 757 ref which is fetched from the remote given by 758 "branch.<name>.remote". 759 The merge information is used by 'git pull' (which at first calls 760 'git fetch') to lookup the default branch for merging. Without 761 this option, 'git pull' defaults to merge the first refspec fetched. 762 Specify multiple values to get an octopus merge. 763 If you wish to setup 'git pull' so that it merges into <name> from 764 another branch in the local repository, you can point 765 branch.<name>.merge to the desired branch, and use the relative path 766 setting `.` (a period) for branch.<name>.remote. 767 768branch.<name>.mergeoptions:: 769 Sets default options for merging into branch <name>. The syntax and 770 supported options are the same as those of linkgit:git-merge[1], but 771 option values containing whitespace characters are currently not 772 supported. 773 774branch.<name>.rebase:: 775 When true, rebase the branch <name> on top of the fetched branch, 776 instead of merging the default branch from the default remote when 777 "git pull" is run. See "pull.rebase" for doing this in a non 778 branch-specific manner. 779+ 780 When preserve, also pass `--preserve-merges` along to 'git rebase' 781 so that locally committed merge commits will not be flattened 782 by running 'git pull'. 783+ 784*NOTE*: this is a possibly dangerous operation; do *not* use 785it unless you understand the implications (see linkgit:git-rebase[1] 786for details). 787 788branch.<name>.description:: 789 Branch description, can be edited with 790 `git branch --edit-description`. Branch description is 791 automatically added in the format-patch cover letter or 792 request-pull summary. 793 794browser.<tool>.cmd:: 795 Specify the command to invoke the specified browser. The 796 specified command is evaluated in shell with the URLs passed 797 as arguments. (See linkgit:git-web{litdd}browse[1].) 798 799browser.<tool>.path:: 800 Override the path for the given tool that may be used to 801 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 802 working repository in gitweb (see linkgit:git-instaweb[1]). 803 804clean.requireForce:: 805 A boolean to make git-clean do nothing unless given -f, 806 -i or -n. Defaults to true. 807 808color.branch:: 809 A boolean to enable/disable color in the output of 810 linkgit:git-branch[1]. May be set to `always`, 811 `false` (or `never`) or `auto` (or `true`), in which case colors are used 812 only when the output is to a terminal. Defaults to false. 813 814color.branch.<slot>:: 815 Use customized color for branch coloration. `<slot>` is one of 816 `current` (the current branch), `local` (a local branch), 817 `remote` (a remote-tracking branch in refs/remotes/), 818 `upstream` (upstream tracking branch), `plain` (other 819 refs). 820+ 821The value for these configuration variables is a list of colors (at most 822two) and attributes (at most one), separated by spaces. The colors 823accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 824`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 825`blink` and `reverse`. The first color given is the foreground; the 826second is the background. The position of the attribute, if any, 827doesn't matter. 828 829color.diff:: 830 Whether to use ANSI escape sequences to add color to patches. 831 If this is set to `always`, linkgit:git-diff[1], 832 linkgit:git-log[1], and linkgit:git-show[1] will use color 833 for all patches. If it is set to `true` or `auto`, those 834 commands will only use color when output is to the terminal. 835 Defaults to false. 836+ 837This does not affect linkgit:git-format-patch[1] or the 838'git-diff-{asterisk}' plumbing commands. Can be overridden on the 839command line with the `--color[=<when>]` option. 840 841color.diff.<slot>:: 842 Use customized color for diff colorization. `<slot>` specifies 843 which part of the patch to use the specified color, and is one 844 of `plain` (context text), `meta` (metainformation), `frag` 845 (hunk header), 'func' (function in hunk header), `old` (removed lines), 846 `new` (added lines), `commit` (commit headers), or `whitespace` 847 (highlighting whitespace errors). The values of these variables may be 848 specified as in color.branch.<slot>. 849 850color.decorate.<slot>:: 851 Use customized color for 'git log --decorate' output. `<slot>` is one 852 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 853 branches, remote-tracking branches, tags, stash and HEAD, respectively. 854 855color.grep:: 856 When set to `always`, always highlight matches. When `false` (or 857 `never`), never. When set to `true` or `auto`, use color only 858 when the output is written to the terminal. Defaults to `false`. 859 860color.grep.<slot>:: 861 Use customized color for grep colorization. `<slot>` specifies which 862 part of the line to use the specified color, and is one of 863+ 864-- 865`context`;; 866 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 867`filename`;; 868 filename prefix (when not using `-h`) 869`function`;; 870 function name lines (when using `-p`) 871`linenumber`;; 872 line number prefix (when using `-n`) 873`match`;; 874 matching text 875`selected`;; 876 non-matching text in selected lines 877`separator`;; 878 separators between fields on a line (`:`, `-`, and `=`) 879 and between hunks (`--`) 880-- 881+ 882The values of these variables may be specified as in color.branch.<slot>. 883 884color.interactive:: 885 When set to `always`, always use colors for interactive prompts 886 and displays (such as those used by "git-add --interactive" and 887 "git-clean --interactive"). When false (or `never`), never. 888 When set to `true` or `auto`, use colors only when the output is 889 to the terminal. Defaults to false. 890 891color.interactive.<slot>:: 892 Use customized color for 'git add --interactive' and 'git clean 893 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 894 or `error`, for four distinct types of normal output from 895 interactive commands. The values of these variables may be 896 specified as in color.branch.<slot>. 897 898color.pager:: 899 A boolean to enable/disable colored output when the pager is in 900 use (default is true). 901 902color.showbranch:: 903 A boolean to enable/disable color in the output of 904 linkgit:git-show-branch[1]. May be set to `always`, 905 `false` (or `never`) or `auto` (or `true`), in which case colors are used 906 only when the output is to a terminal. Defaults to false. 907 908color.status:: 909 A boolean to enable/disable color in the output of 910 linkgit:git-status[1]. May be set to `always`, 911 `false` (or `never`) or `auto` (or `true`), in which case colors are used 912 only when the output is to a terminal. Defaults to false. 913 914color.status.<slot>:: 915 Use customized color for status colorization. `<slot>` is 916 one of `header` (the header text of the status message), 917 `added` or `updated` (files which are added but not committed), 918 `changed` (files which are changed but not added in the index), 919 `untracked` (files which are not tracked by Git), 920 `branch` (the current branch), or 921 `nobranch` (the color the 'no branch' warning is shown in, defaulting 922 to red). The values of these variables may be specified as in 923 color.branch.<slot>. 924 925color.ui:: 926 This variable determines the default value for variables such 927 as `color.diff` and `color.grep` that control the use of color 928 per command family. Its scope will expand as more commands learn 929 configuration to set a default for the `--color` option. Set it 930 to `false` or `never` if you prefer Git commands not to use 931 color unless enabled explicitly with some other configuration 932 or the `--color` option. Set it to `always` if you want all 933 output not intended for machine consumption to use color, to 934 `true` or `auto` (this is the default since Git 1.8.4) if you 935 want such output to use color when written to the terminal. 936 937column.ui:: 938 Specify whether supported commands should output in columns. 939 This variable consists of a list of tokens separated by spaces 940 or commas: 941+ 942These options control when the feature should be enabled 943(defaults to 'never'): 944+ 945-- 946`always`;; 947 always show in columns 948`never`;; 949 never show in columns 950`auto`;; 951 show in columns if the output is to the terminal 952-- 953+ 954These options control layout (defaults to 'column'). Setting any 955of these implies 'always' if none of 'always', 'never', or 'auto' are 956specified. 957+ 958-- 959`column`;; 960 fill columns before rows 961`row`;; 962 fill rows before columns 963`plain`;; 964 show in one column 965-- 966+ 967Finally, these options can be combined with a layout option (defaults 968to 'nodense'): 969+ 970-- 971`dense`;; 972 make unequal size columns to utilize more space 973`nodense`;; 974 make equal size columns 975-- 976 977column.branch:: 978 Specify whether to output branch listing in `git branch` in columns. 979 See `column.ui` for details. 980 981column.clean:: 982 Specify the layout when list items in `git clean -i`, which always 983 shows files and directories in columns. See `column.ui` for details. 984 985column.status:: 986 Specify whether to output untracked files in `git status` in columns. 987 See `column.ui` for details. 988 989column.tag:: 990 Specify whether to output tag listing in `git tag` in columns. 991 See `column.ui` for details. 992 993commit.cleanup:: 994 This setting overrides the default of the `--cleanup` option in 995 `git commit`. See linkgit:git-commit[1] for details. Changing the 996 default can be useful when you always want to keep lines that begin 997 with comment character `#` in your log message, in which case you 998 would do `git config commit.cleanup whitespace` (note that you will 999 have to remove the help lines that begin with `#` in the commit log1000 template yourself, if you do this).10011002commit.gpgsign::10031004 A boolean to specify whether all commits should be GPG signed.1005 Use of this option when doing operations such as rebase can1006 result in a large number of commits being signed. It may be1007 convenient to use an agent to avoid typing your GPG passphrase1008 several times.10091010commit.status::1011 A boolean to enable/disable inclusion of status information in the1012 commit message template when using an editor to prepare the commit1013 message. Defaults to true.10141015commit.template::1016 Specify a file to use as the template for new commit messages.1017 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1018 specified user's home directory.10191020credential.helper::1021 Specify an external helper to be called when a username or1022 password credential is needed; the helper may consult external1023 storage to avoid prompting the user for the credentials. See1024 linkgit:gitcredentials[7] for details.10251026credential.useHttpPath::1027 When acquiring credentials, consider the "path" component of an http1028 or https URL to be important. Defaults to false. See1029 linkgit:gitcredentials[7] for more information.10301031credential.username::1032 If no username is set for a network authentication, use this username1033 by default. See credential.<context>.* below, and1034 linkgit:gitcredentials[7].10351036credential.<url>.*::1037 Any of the credential.* options above can be applied selectively to1038 some credentials. For example "credential.https://example.com.username"1039 would set the default username only for https connections to1040 example.com. See linkgit:gitcredentials[7] for details on how URLs are1041 matched.10421043include::diff-config.txt[]10441045difftool.<tool>.path::1046 Override the path for the given tool. This is useful in case1047 your tool is not in the PATH.10481049difftool.<tool>.cmd::1050 Specify the command to invoke the specified diff tool.1051 The specified command is evaluated in shell with the following1052 variables available: 'LOCAL' is set to the name of the temporary1053 file containing the contents of the diff pre-image and 'REMOTE'1054 is set to the name of the temporary file containing the contents1055 of the diff post-image.10561057difftool.prompt::1058 Prompt before each invocation of the diff tool.10591060fetch.recurseSubmodules::1061 This option can be either set to a boolean value or to 'on-demand'.1062 Setting it to a boolean changes the behavior of fetch and pull to1063 unconditionally recurse into submodules when set to true or to not1064 recurse at all when set to false. When set to 'on-demand' (the default1065 value), fetch and pull will only recurse into a populated submodule1066 when its superproject retrieves a commit that updates the submodule's1067 reference.10681069fetch.fsckObjects::1070 If it is set to true, git-fetch-pack will check all fetched1071 objects. It will abort in the case of a malformed object or a1072 broken link. The result of an abort are only dangling objects.1073 Defaults to false. If not set, the value of `transfer.fsckObjects`1074 is used instead.10751076fetch.unpackLimit::1077 If the number of objects fetched over the Git native1078 transfer is below this1079 limit, then the objects will be unpacked into loose object1080 files. However if the number of received objects equals or1081 exceeds this limit then the received pack will be stored as1082 a pack, after adding any missing delta bases. Storing the1083 pack from a push can make the push operation complete faster,1084 especially on slow filesystems. If not set, the value of1085 `transfer.unpackLimit` is used instead.10861087fetch.prune::1088 If true, fetch will automatically behave as if the `--prune`1089 option was given on the command line. See also `remote.<name>.prune`.10901091format.attach::1092 Enable multipart/mixed attachments as the default for1093 'format-patch'. The value can also be a double quoted string1094 which will enable attachments as the default and set the1095 value as the boundary. See the --attach option in1096 linkgit:git-format-patch[1].10971098format.numbered::1099 A boolean which can enable or disable sequence numbers in patch1100 subjects. It defaults to "auto" which enables it only if there1101 is more than one patch. It can be enabled or disabled for all1102 messages by setting it to "true" or "false". See --numbered1103 option in linkgit:git-format-patch[1].11041105format.headers::1106 Additional email headers to include in a patch to be submitted1107 by mail. See linkgit:git-format-patch[1].11081109format.to::1110format.cc::1111 Additional recipients to include in a patch to be submitted1112 by mail. See the --to and --cc options in1113 linkgit:git-format-patch[1].11141115format.subjectprefix::1116 The default for format-patch is to output files with the '[PATCH]'1117 subject prefix. Use this variable to change that prefix.11181119format.signature::1120 The default for format-patch is to output a signature containing1121 the Git version number. Use this variable to change that default.1122 Set this variable to the empty string ("") to suppress1123 signature generation.11241125format.signaturefile::1126 Works just like format.signature except the contents of the1127 file specified by this variable will be used as the signature.11281129format.suffix::1130 The default for format-patch is to output files with the suffix1131 `.patch`. Use this variable to change that suffix (make sure to1132 include the dot if you want it).11331134format.pretty::1135 The default pretty format for log/show/whatchanged command,1136 See linkgit:git-log[1], linkgit:git-show[1],1137 linkgit:git-whatchanged[1].11381139format.thread::1140 The default threading style for 'git format-patch'. Can be1141 a boolean value, or `shallow` or `deep`. `shallow` threading1142 makes every mail a reply to the head of the series,1143 where the head is chosen from the cover letter, the1144 `--in-reply-to`, and the first patch mail, in this order.1145 `deep` threading makes every mail a reply to the previous one.1146 A true boolean value is the same as `shallow`, and a false1147 value disables threading.11481149format.signoff::1150 A boolean value which lets you enable the `-s/--signoff` option of1151 format-patch by default. *Note:* Adding the Signed-off-by: line to a1152 patch should be a conscious act and means that you certify you have1153 the rights to submit this work under the same open source license.1154 Please see the 'SubmittingPatches' document for further discussion.11551156format.coverLetter::1157 A boolean that controls whether to generate a cover-letter when1158 format-patch is invoked, but in addition can be set to "auto", to1159 generate a cover-letter only when there's more than one patch.11601161filter.<driver>.clean::1162 The command which is used to convert the content of a worktree1163 file to a blob upon checkin. See linkgit:gitattributes[5] for1164 details.11651166filter.<driver>.smudge::1167 The command which is used to convert the content of a blob1168 object to a worktree file upon checkout. See1169 linkgit:gitattributes[5] for details.11701171gc.aggressiveDepth::1172 The depth parameter used in the delta compression1173 algorithm used by 'git gc --aggressive'. This defaults1174 to 250.11751176gc.aggressiveWindow::1177 The window size parameter used in the delta compression1178 algorithm used by 'git gc --aggressive'. This defaults1179 to 250.11801181gc.auto::1182 When there are approximately more than this many loose1183 objects in the repository, `git gc --auto` will pack them.1184 Some Porcelain commands use this command to perform a1185 light-weight garbage collection from time to time. The1186 default value is 6700. Setting this to 0 disables it.11871188gc.autopacklimit::1189 When there are more than this many packs that are not1190 marked with `*.keep` file in the repository, `git gc1191 --auto` consolidates them into one larger pack. The1192 default value is 50. Setting this to 0 disables it.11931194gc.autodetach::1195 Make `git gc --auto` return immediately andrun in background1196 if the system supports it. Default is true.11971198gc.packrefs::1199 Running `git pack-refs` in a repository renders it1200 unclonable by Git versions prior to 1.5.1.2 over dumb1201 transports such as HTTP. This variable determines whether1202 'git gc' runs `git pack-refs`. This can be set to `notbare`1203 to enable it within all non-bare repos or it can be set to a1204 boolean value. The default is `true`.12051206gc.pruneexpire::1207 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1208 Override the grace period with this config variable. The value1209 "now" may be used to disable this grace period and always prune1210 unreachable objects immediately.12111212gc.reflogexpire::1213gc.<pattern>.reflogexpire::1214 'git reflog expire' removes reflog entries older than1215 this time; defaults to 90 days. With "<pattern>" (e.g.1216 "refs/stash") in the middle the setting applies only to1217 the refs that match the <pattern>.12181219gc.reflogexpireunreachable::1220gc.<ref>.reflogexpireunreachable::1221 'git reflog expire' removes reflog entries older than1222 this time and are not reachable from the current tip;1223 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1224 in the middle, the setting applies only to the refs that1225 match the <pattern>.12261227gc.rerereresolved::1228 Records of conflicted merge you resolved earlier are1229 kept for this many days when 'git rerere gc' is run.1230 The default is 60 days. See linkgit:git-rerere[1].12311232gc.rerereunresolved::1233 Records of conflicted merge you have not resolved are1234 kept for this many days when 'git rerere gc' is run.1235 The default is 15 days. See linkgit:git-rerere[1].12361237gitcvs.commitmsgannotation::1238 Append this string to each commit message. Set to empty string1239 to disable this feature. Defaults to "via git-CVS emulator".12401241gitcvs.enabled::1242 Whether the CVS server interface is enabled for this repository.1243 See linkgit:git-cvsserver[1].12441245gitcvs.logfile::1246 Path to a log file where the CVS server interface well... logs1247 various stuff. See linkgit:git-cvsserver[1].12481249gitcvs.usecrlfattr::1250 If true, the server will look up the end-of-line conversion1251 attributes for files to determine the '-k' modes to use. If1252 the attributes force Git to treat a file as text,1253 the '-k' mode will be left blank so CVS clients will1254 treat it as text. If they suppress text conversion, the file1255 will be set with '-kb' mode, which suppresses any newline munging1256 the client might otherwise do. If the attributes do not allow1257 the file type to be determined, then 'gitcvs.allbinary' is1258 used. See linkgit:gitattributes[5].12591260gitcvs.allbinary::1261 This is used if 'gitcvs.usecrlfattr' does not resolve1262 the correct '-kb' mode to use. If true, all1263 unresolved files are sent to the client in1264 mode '-kb'. This causes the client to treat them1265 as binary files, which suppresses any newline munging it1266 otherwise might do. Alternatively, if it is set to "guess",1267 then the contents of the file are examined to decide if1268 it is binary, similar to 'core.autocrlf'.12691270gitcvs.dbname::1271 Database used by git-cvsserver to cache revision information1272 derived from the Git repository. The exact meaning depends on the1273 used database driver, for SQLite (which is the default driver) this1274 is a filename. Supports variable substitution (see1275 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1276 Default: '%Ggitcvs.%m.sqlite'12771278gitcvs.dbdriver::1279 Used Perl DBI driver. You can specify any available driver1280 for this here, but it might not work. git-cvsserver is tested1281 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1282 reported *not* to work with 'DBD::mysql'. Experimental feature.1283 May not contain double colons (`:`). Default: 'SQLite'.1284 See linkgit:git-cvsserver[1].12851286gitcvs.dbuser, gitcvs.dbpass::1287 Database user and password. Only useful if setting 'gitcvs.dbdriver',1288 since SQLite has no concept of database users and/or passwords.1289 'gitcvs.dbuser' supports variable substitution (see1290 linkgit:git-cvsserver[1] for details).12911292gitcvs.dbTableNamePrefix::1293 Database table name prefix. Prepended to the names of any1294 database tables used, allowing a single database to be used1295 for several repositories. Supports variable substitution (see1296 linkgit:git-cvsserver[1] for details). Any non-alphabetic1297 characters will be replaced with underscores.12981299All gitcvs variables except for 'gitcvs.usecrlfattr' and1300'gitcvs.allbinary' can also be specified as1301'gitcvs.<access_method>.<varname>' (where 'access_method'1302is one of "ext" and "pserver") to make them apply only for the given1303access method.13041305gitweb.category::1306gitweb.description::1307gitweb.owner::1308gitweb.url::1309 See linkgit:gitweb[1] for description.13101311gitweb.avatar::1312gitweb.blame::1313gitweb.grep::1314gitweb.highlight::1315gitweb.patches::1316gitweb.pickaxe::1317gitweb.remote_heads::1318gitweb.showsizes::1319gitweb.snapshot::1320 See linkgit:gitweb.conf[5] for description.13211322grep.lineNumber::1323 If set to true, enable '-n' option by default.13241325grep.patternType::1326 Set the default matching behavior. Using a value of 'basic', 'extended',1327 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1328 '--fixed-strings', or '--perl-regexp' option accordingly, while the1329 value 'default' will return to the default matching behavior.13301331grep.extendedRegexp::1332 If set to true, enable '--extended-regexp' option by default. This1333 option is ignored when the 'grep.patternType' option is set to a value1334 other than 'default'.13351336gpg.program::1337 Use this custom program instead of "gpg" found on $PATH when1338 making or verifying a PGP signature. The program must support the1339 same command-line interface as GPG, namely, to verify a detached1340 signature, "gpg --verify $file - <$signature" is run, and the1341 program is expected to signal a good signature by exiting with1342 code 0, and to generate an ascii-armored detached signature, the1343 standard input of "gpg -bsau $key" is fed with the contents to be1344 signed, and the program is expected to send the result to its1345 standard output.13461347gui.commitmsgwidth::1348 Defines how wide the commit message window is in the1349 linkgit:git-gui[1]. "75" is the default.13501351gui.diffcontext::1352 Specifies how many context lines should be used in calls to diff1353 made by the linkgit:git-gui[1]. The default is "5".13541355gui.displayuntracked::1356 Determines if linkgit::git-gui[1] shows untracked files1357 in the file list. The default is "true".13581359gui.encoding::1360 Specifies the default encoding to use for displaying of1361 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1362 It can be overridden by setting the 'encoding' attribute1363 for relevant files (see linkgit:gitattributes[5]).1364 If this option is not set, the tools default to the1365 locale encoding.13661367gui.matchtrackingbranch::1368 Determines if new branches created with linkgit:git-gui[1] should1369 default to tracking remote branches with matching names or1370 not. Default: "false".13711372gui.newbranchtemplate::1373 Is used as suggested name when creating new branches using the1374 linkgit:git-gui[1].13751376gui.pruneduringfetch::1377 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1378 performing a fetch. The default value is "false".13791380gui.trustmtime::1381 Determines if linkgit:git-gui[1] should trust the file modification1382 timestamp or not. By default the timestamps are not trusted.13831384gui.spellingdictionary::1385 Specifies the dictionary used for spell checking commit messages in1386 the linkgit:git-gui[1]. When set to "none" spell checking is turned1387 off.13881389gui.fastcopyblame::1390 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1391 location detection. It makes blame significantly faster on huge1392 repositories at the expense of less thorough copy detection.13931394gui.copyblamethreshold::1395 Specifies the threshold to use in 'git gui blame' original location1396 detection, measured in alphanumeric characters. See the1397 linkgit:git-blame[1] manual for more information on copy detection.13981399gui.blamehistoryctx::1400 Specifies the radius of history context in days to show in1401 linkgit:gitk[1] for the selected commit, when the `Show History1402 Context` menu item is invoked from 'git gui blame'. If this1403 variable is set to zero, the whole history is shown.14041405guitool.<name>.cmd::1406 Specifies the shell command line to execute when the corresponding item1407 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1408 mandatory for every tool. The command is executed from the root of1409 the working directory, and in the environment it receives the name of1410 the tool as 'GIT_GUITOOL', the name of the currently selected file as1411 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1412 the head is detached, 'CUR_BRANCH' is empty).14131414guitool.<name>.needsfile::1415 Run the tool only if a diff is selected in the GUI. It guarantees1416 that 'FILENAME' is not empty.14171418guitool.<name>.noconsole::1419 Run the command silently, without creating a window to display its1420 output.14211422guitool.<name>.norescan::1423 Don't rescan the working directory for changes after the tool1424 finishes execution.14251426guitool.<name>.confirm::1427 Show a confirmation dialog before actually running the tool.14281429guitool.<name>.argprompt::1430 Request a string argument from the user, and pass it to the tool1431 through the 'ARGS' environment variable. Since requesting an1432 argument implies confirmation, the 'confirm' option has no effect1433 if this is enabled. If the option is set to 'true', 'yes', or '1',1434 the dialog uses a built-in generic prompt; otherwise the exact1435 value of the variable is used.14361437guitool.<name>.revprompt::1438 Request a single valid revision from the user, and set the1439 'REVISION' environment variable. In other aspects this option1440 is similar to 'argprompt', and can be used together with it.14411442guitool.<name>.revunmerged::1443 Show only unmerged branches in the 'revprompt' subdialog.1444 This is useful for tools similar to merge or rebase, but not1445 for things like checkout or reset.14461447guitool.<name>.title::1448 Specifies the title to use for the prompt dialog. The default1449 is the tool name.14501451guitool.<name>.prompt::1452 Specifies the general prompt string to display at the top of1453 the dialog, before subsections for 'argprompt' and 'revprompt'.1454 The default value includes the actual command.14551456help.browser::1457 Specify the browser that will be used to display help in the1458 'web' format. See linkgit:git-help[1].14591460help.format::1461 Override the default help format used by linkgit:git-help[1].1462 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1463 the default. 'web' and 'html' are the same.14641465help.autocorrect::1466 Automatically correct and execute mistyped commands after1467 waiting for the given number of deciseconds (0.1 sec). If more1468 than one command can be deduced from the entered text, nothing1469 will be executed. If the value of this option is negative,1470 the corrected command will be executed immediately. If the1471 value is 0 - the command will be just shown but not executed.1472 This is the default.14731474help.htmlpath::1475 Specify the path where the HTML documentation resides. File system paths1476 and URLs are supported. HTML pages will be prefixed with this path when1477 help is displayed in the 'web' format. This defaults to the documentation1478 path of your Git installation.14791480http.proxy::1481 Override the HTTP proxy, normally configured using the 'http_proxy',1482 'https_proxy', and 'all_proxy' environment variables (see1483 `curl(1)`). This can be overridden on a per-remote basis; see1484 remote.<name>.proxy14851486http.cookiefile::1487 File containing previously stored cookie lines which should be used1488 in the Git http session, if they match the server. The file format1489 of the file to read cookies from should be plain HTTP headers or1490 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1491 NOTE that the file specified with http.cookiefile is only used as1492 input unless http.saveCookies is set.14931494http.savecookies::1495 If set, store cookies received during requests to the file specified by1496 http.cookiefile. Has no effect if http.cookiefile is unset.14971498http.sslVerify::1499 Whether to verify the SSL certificate when fetching or pushing1500 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1501 variable.15021503http.sslCert::1504 File containing the SSL certificate when fetching or pushing1505 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1506 variable.15071508http.sslKey::1509 File containing the SSL private key when fetching or pushing1510 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1511 variable.15121513http.sslCertPasswordProtected::1514 Enable Git's password prompt for the SSL certificate. Otherwise1515 OpenSSL will prompt the user, possibly many times, if the1516 certificate or private key is encrypted. Can be overridden by the1517 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15181519http.sslCAInfo::1520 File containing the certificates to verify the peer with when1521 fetching or pushing over HTTPS. Can be overridden by the1522 'GIT_SSL_CAINFO' environment variable.15231524http.sslCAPath::1525 Path containing files with the CA certificates to verify the peer1526 with when fetching or pushing over HTTPS. Can be overridden1527 by the 'GIT_SSL_CAPATH' environment variable.15281529http.sslTry::1530 Attempt to use AUTH SSL/TLS and encrypted data transfers1531 when connecting via regular FTP protocol. This might be needed1532 if the FTP server requires it for security reasons or you wish1533 to connect securely whenever remote FTP server supports it.1534 Default is false since it might trigger certificate verification1535 errors on misconfigured servers.15361537http.maxRequests::1538 How many HTTP requests to launch in parallel. Can be overridden1539 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15401541http.minSessions::1542 The number of curl sessions (counted across slots) to be kept across1543 requests. They will not be ended with curl_easy_cleanup() until1544 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1545 value will be capped at 1. Defaults to 1.15461547http.postBuffer::1548 Maximum size in bytes of the buffer used by smart HTTP1549 transports when POSTing data to the remote system.1550 For requests larger than this buffer size, HTTP/1.1 and1551 Transfer-Encoding: chunked is used to avoid creating a1552 massive pack file locally. Default is 1 MiB, which is1553 sufficient for most requests.15541555http.lowSpeedLimit, http.lowSpeedTime::1556 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1557 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1558 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1559 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15601561http.noEPSV::1562 A boolean which disables using of EPSV ftp command by curl.1563 This can helpful with some "poor" ftp servers which don't1564 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1565 environment variable. Default is false (curl will use EPSV).15661567http.useragent::1568 The HTTP USER_AGENT string presented to an HTTP server. The default1569 value represents the version of the client Git such as git/1.7.1.1570 This option allows you to override this value to a more common value1571 such as Mozilla/4.0. This may be necessary, for instance, if1572 connecting through a firewall that restricts HTTP connections to a set1573 of common USER_AGENT strings (but not including those like git/1.7.1).1574 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15751576http.<url>.*::1577 Any of the http.* options above can be applied selectively to some urls.1578 For a config key to match a URL, each element of the config key is1579 compared to that of the URL, in the following order:1580+1581--1582. Scheme (e.g., `https` in `https://example.com/`). This field1583 must match exactly between the config key and the URL.15841585. Host/domain name (e.g., `example.com` in `https://example.com/`).1586 This field must match exactly between the config key and the URL.15871588. Port number (e.g., `8080` in `http://example.com:8080/`).1589 This field must match exactly between the config key and the URL.1590 Omitted port numbers are automatically converted to the correct1591 default for the scheme before matching.15921593. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1594 path field of the config key must match the path field of the URL1595 either exactly or as a prefix of slash-delimited path elements. This means1596 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1597 match on a slash (`/`) boundary. Longer matches take precedence (so a config1598 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1599 key with just path `foo/`).16001601. User name (e.g., `user` in `https://user@example.com/repo.git`). If1602 the config key has a user name it must match the user name in the1603 URL exactly. If the config key does not have a user name, that1604 config key will match a URL with any user name (including none),1605 but at a lower precedence than a config key with a user name.1606--1607+1608The list above is ordered by decreasing precedence; a URL that matches1609a config key's path is preferred to one that matches its user name. For example,1610if the URL is `https://user@example.com/foo/bar` a config key match of1611`https://example.com/foo` will be preferred over a config key match of1612`https://user@example.com`.1613+1614All URLs are normalized before attempting any matching (the password part,1615if embedded in the URL, is always ignored for matching purposes) so that1616equivalent urls that are simply spelled differently will match properly.1617Environment variable settings always override any matches. The urls that are1618matched against are those given directly to Git commands. This means any URLs1619visited as a result of a redirection do not participate in matching.16201621i18n.commitEncoding::1622 Character encoding the commit messages are stored in; Git itself1623 does not care per se, but this information is necessary e.g. when1624 importing commits from emails or in the gitk graphical history1625 browser (and possibly at other places in the future or in other1626 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16271628i18n.logOutputEncoding::1629 Character encoding the commit messages are converted to when1630 running 'git log' and friends.16311632imap::1633 The configuration variables in the 'imap' section are described1634 in linkgit:git-imap-send[1].16351636index.version::1637 Specify the version with which new index files should be1638 initialized. This does not affect existing repositories.16391640init.templatedir::1641 Specify the directory from which templates will be copied.1642 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16431644instaweb.browser::1645 Specify the program that will be used to browse your working1646 repository in gitweb. See linkgit:git-instaweb[1].16471648instaweb.httpd::1649 The HTTP daemon command-line to start gitweb on your working1650 repository. See linkgit:git-instaweb[1].16511652instaweb.local::1653 If true the web server started by linkgit:git-instaweb[1] will1654 be bound to the local IP (127.0.0.1).16551656instaweb.modulepath::1657 The default module path for linkgit:git-instaweb[1] to use1658 instead of /usr/lib/apache2/modules. Only used if httpd1659 is Apache.16601661instaweb.port::1662 The port number to bind the gitweb httpd to. See1663 linkgit:git-instaweb[1].16641665interactive.singlekey::1666 In interactive commands, allow the user to provide one-letter1667 input with a single key (i.e., without hitting enter).1668 Currently this is used by the `--patch` mode of1669 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1670 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1671 setting is silently ignored if portable keystroke input1672 is not available; requires the Perl module Term::ReadKey.16731674log.abbrevCommit::1675 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1676 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1677 override this option with `--no-abbrev-commit`.16781679log.date::1680 Set the default date-time mode for the 'log' command.1681 Setting a value for log.date is similar to using 'git log''s1682 `--date` option. Possible values are `relative`, `local`,1683 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1684 for details.16851686log.decorate::1687 Print out the ref names of any commits that are shown by the log1688 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1689 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1690 specified, the full ref name (including prefix) will be printed.1691 This is the same as the log commands '--decorate' option.16921693log.showroot::1694 If true, the initial commit will be shown as a big creation event.1695 This is equivalent to a diff against an empty tree.1696 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1697 normally hide the root commit will now show it. True by default.16981699log.mailmap::1700 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1701 linkgit:git-whatchanged[1] assume `--use-mailmap`.17021703mailmap.file::1704 The location of an augmenting mailmap file. The default1705 mailmap, located in the root of the repository, is loaded1706 first, then the mailmap file pointed to by this variable.1707 The location of the mailmap file may be in a repository1708 subdirectory, or somewhere outside of the repository itself.1709 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17101711mailmap.blob::1712 Like `mailmap.file`, but consider the value as a reference to a1713 blob in the repository. If both `mailmap.file` and1714 `mailmap.blob` are given, both are parsed, with entries from1715 `mailmap.file` taking precedence. In a bare repository, this1716 defaults to `HEAD:.mailmap`. In a non-bare repository, it1717 defaults to empty.17181719man.viewer::1720 Specify the programs that may be used to display help in the1721 'man' format. See linkgit:git-help[1].17221723man.<tool>.cmd::1724 Specify the command to invoke the specified man viewer. The1725 specified command is evaluated in shell with the man page1726 passed as argument. (See linkgit:git-help[1].)17271728man.<tool>.path::1729 Override the path for the given tool that may be used to1730 display help in the 'man' format. See linkgit:git-help[1].17311732include::merge-config.txt[]17331734mergetool.<tool>.path::1735 Override the path for the given tool. This is useful in case1736 your tool is not in the PATH.17371738mergetool.<tool>.cmd::1739 Specify the command to invoke the specified merge tool. The1740 specified command is evaluated in shell with the following1741 variables available: 'BASE' is the name of a temporary file1742 containing the common base of the files to be merged, if available;1743 'LOCAL' is the name of a temporary file containing the contents of1744 the file on the current branch; 'REMOTE' is the name of a temporary1745 file containing the contents of the file from the branch being1746 merged; 'MERGED' contains the name of the file to which the merge1747 tool should write the results of a successful merge.17481749mergetool.<tool>.trustExitCode::1750 For a custom merge command, specify whether the exit code of1751 the merge command can be used to determine whether the merge was1752 successful. If this is not set to true then the merge target file1753 timestamp is checked and the merge assumed to have been successful1754 if the file has been updated, otherwise the user is prompted to1755 indicate the success of the merge.17561757mergetool.keepBackup::1758 After performing a merge, the original file with conflict markers1759 can be saved as a file with a `.orig` extension. If this variable1760 is set to `false` then this file is not preserved. Defaults to1761 `true` (i.e. keep the backup files).17621763mergetool.keepTemporaries::1764 When invoking a custom merge tool, Git uses a set of temporary1765 files to pass to the tool. If the tool returns an error and this1766 variable is set to `true`, then these temporary files will be1767 preserved, otherwise they will be removed after the tool has1768 exited. Defaults to `false`.17691770mergetool.prompt::1771 Prompt before each invocation of the merge resolution program.17721773notes.displayRef::1774 The (fully qualified) refname from which to show notes when1775 showing commit messages. The value of this variable can be set1776 to a glob, in which case notes from all matching refs will be1777 shown. You may also specify this configuration variable1778 several times. A warning will be issued for refs that do not1779 exist, but a glob that does not match any refs is silently1780 ignored.1781+1782This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1783environment variable, which must be a colon separated list of refs or1784globs.1785+1786The effective value of "core.notesRef" (possibly overridden by1787GIT_NOTES_REF) is also implicitly added to the list of refs to be1788displayed.17891790notes.rewrite.<command>::1791 When rewriting commits with <command> (currently `amend` or1792 `rebase`) and this variable is set to `true`, Git1793 automatically copies your notes from the original to the1794 rewritten commit. Defaults to `true`, but see1795 "notes.rewriteRef" below.17961797notes.rewriteMode::1798 When copying notes during a rewrite (see the1799 "notes.rewrite.<command>" option), determines what to do if1800 the target commit already has a note. Must be one of1801 `overwrite`, `concatenate`, or `ignore`. Defaults to1802 `concatenate`.1803+1804This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1805environment variable.18061807notes.rewriteRef::1808 When copying notes during a rewrite, specifies the (fully1809 qualified) ref whose notes should be copied. The ref may be a1810 glob, in which case notes in all matching refs will be copied.1811 You may also specify this configuration several times.1812+1813Does not have a default value; you must configure this variable to1814enable note rewriting. Set it to `refs/notes/commits` to enable1815rewriting for the default commit notes.1816+1817This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1818environment variable, which must be a colon separated list of refs or1819globs.18201821pack.window::1822 The size of the window used by linkgit:git-pack-objects[1] when no1823 window size is given on the command line. Defaults to 10.18241825pack.depth::1826 The maximum delta depth used by linkgit:git-pack-objects[1] when no1827 maximum depth is given on the command line. Defaults to 50.18281829pack.windowMemory::1830 The window memory size limit used by linkgit:git-pack-objects[1]1831 when no limit is given on the command line. The value can be1832 suffixed with "k", "m", or "g". Defaults to 0, meaning no1833 limit.18341835pack.compression::1836 An integer -1..9, indicating the compression level for objects1837 in a pack file. -1 is the zlib default. 0 means no1838 compression, and 1..9 are various speed/size tradeoffs, 9 being1839 slowest. If not set, defaults to core.compression. If that is1840 not set, defaults to -1, the zlib default, which is "a default1841 compromise between speed and compression (currently equivalent1842 to level 6)."1843+1844Note that changing the compression level will not automatically recompress1845all existing objects. You can force recompression by passing the -F option1846to linkgit:git-repack[1].18471848pack.deltaCacheSize::1849 The maximum memory in bytes used for caching deltas in1850 linkgit:git-pack-objects[1] before writing them out to a pack.1851 This cache is used to speed up the writing object phase by not1852 having to recompute the final delta result once the best match1853 for all objects is found. Repacking large repositories on machines1854 which are tight with memory might be badly impacted by this though,1855 especially if this cache pushes the system into swapping.1856 A value of 0 means no limit. The smallest size of 1 byte may be1857 used to virtually disable this cache. Defaults to 256 MiB.18581859pack.deltaCacheLimit::1860 The maximum size of a delta, that is cached in1861 linkgit:git-pack-objects[1]. This cache is used to speed up the1862 writing object phase by not having to recompute the final delta1863 result once the best match for all objects is found. Defaults to 1000.18641865pack.threads::1866 Specifies the number of threads to spawn when searching for best1867 delta matches. This requires that linkgit:git-pack-objects[1]1868 be compiled with pthreads otherwise this option is ignored with a1869 warning. This is meant to reduce packing time on multiprocessor1870 machines. The required amount of memory for the delta search window1871 is however multiplied by the number of threads.1872 Specifying 0 will cause Git to auto-detect the number of CPU's1873 and set the number of threads accordingly.18741875pack.indexVersion::1876 Specify the default pack index version. Valid values are 1 for1877 legacy pack index used by Git versions prior to 1.5.2, and 2 for1878 the new pack index with capabilities for packs larger than 4 GB1879 as well as proper protection against the repacking of corrupted1880 packs. Version 2 is the default. Note that version 2 is enforced1881 and this config option ignored whenever the corresponding pack is1882 larger than 2 GB.1883+1884If you have an old Git that does not understand the version 2 `*.idx` file,1885cloning or fetching over a non native protocol (e.g. "http" and "rsync")1886that will copy both `*.pack` file and corresponding `*.idx` file from the1887other side may give you a repository that cannot be accessed with your1888older version of Git. If the `*.pack` file is smaller than 2 GB, however,1889you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1890the `*.idx` file.18911892pack.packSizeLimit::1893 The maximum size of a pack. This setting only affects1894 packing to a file when repacking, i.e. the git:// protocol1895 is unaffected. It can be overridden by the `--max-pack-size`1896 option of linkgit:git-repack[1]. The minimum size allowed is1897 limited to 1 MiB. The default is unlimited.1898 Common unit suffixes of 'k', 'm', or 'g' are1899 supported.19001901pack.useBitmaps::1902 When true, git will use pack bitmaps (if available) when packing1903 to stdout (e.g., during the server side of a fetch). Defaults to1904 true. You should not generally need to turn this off unless1905 you are debugging pack bitmaps.19061907pack.writebitmaps::1908 This is a deprecated synonym for `repack.writeBitmaps`.19091910pack.writeBitmapHashCache::1911 When true, git will include a "hash cache" section in the bitmap1912 index (if one is written). This cache can be used to feed git's1913 delta heuristics, potentially leading to better deltas between1914 bitmapped and non-bitmapped objects (e.g., when serving a fetch1915 between an older, bitmapped pack and objects that have been1916 pushed since the last gc). The downside is that it consumes 41917 bytes per object of disk space, and that JGit's bitmap1918 implementation does not understand it, causing it to complain if1919 Git and JGit are used on the same repository. Defaults to false.19201921pager.<cmd>::1922 If the value is boolean, turns on or off pagination of the1923 output of a particular Git subcommand when writing to a tty.1924 Otherwise, turns on pagination for the subcommand using the1925 pager specified by the value of `pager.<cmd>`. If `--paginate`1926 or `--no-pager` is specified on the command line, it takes1927 precedence over this option. To disable pagination for all1928 commands, set `core.pager` or `GIT_PAGER` to `cat`.19291930pretty.<name>::1931 Alias for a --pretty= format string, as specified in1932 linkgit:git-log[1]. Any aliases defined here can be used just1933 as the built-in pretty formats could. For example,1934 running `git config pretty.changelog "format:* %H %s"`1935 would cause the invocation `git log --pretty=changelog`1936 to be equivalent to running `git log "--pretty=format:* %H %s"`.1937 Note that an alias with the same name as a built-in format1938 will be silently ignored.19391940pull.ff::1941 By default, Git does not create an extra merge commit when merging1942 a commit that is a descendant of the current commit. Instead, the1943 tip of the current branch is fast-forwarded. When set to `false`,1944 this variable tells Git to create an extra merge commit in such1945 a case (equivalent to giving the `--no-ff` option from the command1946 line). When set to `only`, only such fast-forward merges are1947 allowed (equivalent to giving the `--ff-only` option from the1948 command line).19491950pull.rebase::1951 When true, rebase branches on top of the fetched branch, instead1952 of merging the default branch from the default remote when "git1953 pull" is run. See "branch.<name>.rebase" for setting this on a1954 per-branch basis.1955+1956 When preserve, also pass `--preserve-merges` along to 'git rebase'1957 so that locally committed merge commits will not be flattened1958 by running 'git pull'.1959+1960*NOTE*: this is a possibly dangerous operation; do *not* use1961it unless you understand the implications (see linkgit:git-rebase[1]1962for details).19631964pull.octopus::1965 The default merge strategy to use when pulling multiple branches1966 at once.19671968pull.twohead::1969 The default merge strategy to use when pulling a single branch.19701971push.default::1972 Defines the action `git push` should take if no refspec is1973 explicitly given. Different values are well-suited for1974 specific workflows; for instance, in a purely central workflow1975 (i.e. the fetch source is equal to the push destination),1976 `upstream` is probably what you want. Possible values are:1977+1978--19791980* `nothing` - do not push anything (error out) unless a refspec is1981 explicitly given. This is primarily meant for people who want to1982 avoid mistakes by always being explicit.19831984* `current` - push the current branch to update a branch with the same1985 name on the receiving end. Works in both central and non-central1986 workflows.19871988* `upstream` - push the current branch back to the branch whose1989 changes are usually integrated into the current branch (which is1990 called `@{upstream}`). This mode only makes sense if you are1991 pushing to the same repository you would normally pull from1992 (i.e. central workflow).19931994* `simple` - in centralized workflow, work like `upstream` with an1995 added safety to refuse to push if the upstream branch's name is1996 different from the local one.1997+1998When pushing to a remote that is different from the remote you normally1999pull from, work as `current`. This is the safest option and is suited2000for beginners.2001+2002This mode has become the default in Git 2.0.20032004* `matching` - push all branches having the same name on both ends.2005 This makes the repository you are pushing to remember the set of2006 branches that will be pushed out (e.g. if you always push 'maint'2007 and 'master' there and no other branches, the repository you push2008 to will have these two branches, and your local 'maint' and2009 'master' will be pushed there).2010+2011To use this mode effectively, you have to make sure _all_ the2012branches you would push out are ready to be pushed out before2013running 'git push', as the whole point of this mode is to allow you2014to push all of the branches in one go. If you usually finish work2015on only one branch and push out the result, while other branches are2016unfinished, this mode is not for you. Also this mode is not2017suitable for pushing into a shared central repository, as other2018people may add new branches there, or update the tip of existing2019branches outside your control.2020+2021This used to be the default, but not since Git 2.0 (`simple` is the2022new default).20232024--20252026rebase.stat::2027 Whether to show a diffstat of what changed upstream since the last2028 rebase. False by default.20292030rebase.autosquash::2031 If set to true enable '--autosquash' option by default.20322033rebase.autostash::2034 When set to true, automatically create a temporary stash2035 before the operation begins, and apply it after the operation2036 ends. This means that you can run rebase on a dirty worktree.2037 However, use with care: the final stash application after a2038 successful rebase might result in non-trivial conflicts.2039 Defaults to false.20402041receive.autogc::2042 By default, git-receive-pack will run "git-gc --auto" after2043 receiving data from git-push and updating refs. You can stop2044 it by setting this variable to false.20452046receive.fsckObjects::2047 If it is set to true, git-receive-pack will check all received2048 objects. It will abort in the case of a malformed object or a2049 broken link. The result of an abort are only dangling objects.2050 Defaults to false. If not set, the value of `transfer.fsckObjects`2051 is used instead.20522053receive.unpackLimit::2054 If the number of objects received in a push is below this2055 limit then the objects will be unpacked into loose object2056 files. However if the number of received objects equals or2057 exceeds this limit then the received pack will be stored as2058 a pack, after adding any missing delta bases. Storing the2059 pack from a push can make the push operation complete faster,2060 especially on slow filesystems. If not set, the value of2061 `transfer.unpackLimit` is used instead.20622063receive.denyDeletes::2064 If set to true, git-receive-pack will deny a ref update that deletes2065 the ref. Use this to prevent such a ref deletion via a push.20662067receive.denyDeleteCurrent::2068 If set to true, git-receive-pack will deny a ref update that2069 deletes the currently checked out branch of a non-bare repository.20702071receive.denyCurrentBranch::2072 If set to true or "refuse", git-receive-pack will deny a ref update2073 to the currently checked out branch of a non-bare repository.2074 Such a push is potentially dangerous because it brings the HEAD2075 out of sync with the index and working tree. If set to "warn",2076 print a warning of such a push to stderr, but allow the push to2077 proceed. If set to false or "ignore", allow such pushes with no2078 message. Defaults to "refuse".20792080receive.denyNonFastForwards::2081 If set to true, git-receive-pack will deny a ref update which is2082 not a fast-forward. Use this to prevent such an update via a push,2083 even if that push is forced. This configuration variable is2084 set when initializing a shared repository.20852086receive.hiderefs::2087 String(s) `receive-pack` uses to decide which refs to omit2088 from its initial advertisement. Use more than one2089 definitions to specify multiple prefix strings. A ref that2090 are under the hierarchies listed on the value of this2091 variable is excluded, and is hidden when responding to `git2092 push`, and an attempt to update or delete a hidden ref by2093 `git push` is rejected.20942095receive.updateserverinfo::2096 If set to true, git-receive-pack will run git-update-server-info2097 after receiving data from git-push and updating refs.20982099receive.shallowupdate::2100 If set to true, .git/shallow can be updated when new refs2101 require new shallow roots. Otherwise those refs are rejected.21022103remote.pushdefault::2104 The remote to push to by default. Overrides2105 `branch.<name>.remote` for all branches, and is overridden by2106 `branch.<name>.pushremote` for specific branches.21072108remote.<name>.url::2109 The URL of a remote repository. See linkgit:git-fetch[1] or2110 linkgit:git-push[1].21112112remote.<name>.pushurl::2113 The push URL of a remote repository. See linkgit:git-push[1].21142115remote.<name>.proxy::2116 For remotes that require curl (http, https and ftp), the URL to2117 the proxy to use for that remote. Set to the empty string to2118 disable proxying for that remote.21192120remote.<name>.fetch::2121 The default set of "refspec" for linkgit:git-fetch[1]. See2122 linkgit:git-fetch[1].21232124remote.<name>.push::2125 The default set of "refspec" for linkgit:git-push[1]. See2126 linkgit:git-push[1].21272128remote.<name>.mirror::2129 If true, pushing to this remote will automatically behave2130 as if the `--mirror` option was given on the command line.21312132remote.<name>.skipDefaultUpdate::2133 If true, this remote will be skipped by default when updating2134 using linkgit:git-fetch[1] or the `update` subcommand of2135 linkgit:git-remote[1].21362137remote.<name>.skipFetchAll::2138 If true, this remote will be skipped by default when updating2139 using linkgit:git-fetch[1] or the `update` subcommand of2140 linkgit:git-remote[1].21412142remote.<name>.receivepack::2143 The default program to execute on the remote side when pushing. See2144 option \--receive-pack of linkgit:git-push[1].21452146remote.<name>.uploadpack::2147 The default program to execute on the remote side when fetching. See2148 option \--upload-pack of linkgit:git-fetch-pack[1].21492150remote.<name>.tagopt::2151 Setting this value to \--no-tags disables automatic tag following when2152 fetching from remote <name>. Setting it to \--tags will fetch every2153 tag from remote <name>, even if they are not reachable from remote2154 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2155 override this setting. See options \--tags and \--no-tags of2156 linkgit:git-fetch[1].21572158remote.<name>.vcs::2159 Setting this to a value <vcs> will cause Git to interact with2160 the remote with the git-remote-<vcs> helper.21612162remote.<name>.prune::2163 When set to true, fetching from this remote by default will also2164 remove any remote-tracking references that no longer exist on the2165 remote (as if the `--prune` option was given on the command line).2166 Overrides `fetch.prune` settings, if any.21672168remotes.<group>::2169 The list of remotes which are fetched by "git remote update2170 <group>". See linkgit:git-remote[1].21712172repack.usedeltabaseoffset::2173 By default, linkgit:git-repack[1] creates packs that use2174 delta-base offset. If you need to share your repository with2175 Git older than version 1.4.4, either directly or via a dumb2176 protocol such as http, then you need to set this option to2177 "false" and repack. Access from old Git versions over the2178 native protocol are unaffected by this option.21792180repack.packKeptObjects::2181 If set to true, makes `git repack` act as if2182 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2183 details. Defaults to `false` normally, but `true` if a bitmap2184 index is being written (either via `--write-bitmap-index` or2185 `repack.writeBitmaps`).21862187repack.writeBitmaps::2188 When true, git will write a bitmap index when packing all2189 objects to disk (e.g., when `git repack -a` is run). This2190 index can speed up the "counting objects" phase of subsequent2191 packs created for clones and fetches, at the cost of some disk2192 space and extra time spent on the initial repack. Defaults to2193 false.21942195rerere.autoupdate::2196 When set to true, `git-rerere` updates the index with the2197 resulting contents after it cleanly resolves conflicts using2198 previously recorded resolution. Defaults to false.21992200rerere.enabled::2201 Activate recording of resolved conflicts, so that identical2202 conflict hunks can be resolved automatically, should they be2203 encountered again. By default, linkgit:git-rerere[1] is2204 enabled if there is an `rr-cache` directory under the2205 `$GIT_DIR`, e.g. if "rerere" was previously used in the2206 repository.22072208sendemail.identity::2209 A configuration identity. When given, causes values in the2210 'sendemail.<identity>' subsection to take precedence over2211 values in the 'sendemail' section. The default identity is2212 the value of 'sendemail.identity'.22132214sendemail.smtpencryption::2215 See linkgit:git-send-email[1] for description. Note that this2216 setting is not subject to the 'identity' mechanism.22172218sendemail.smtpssl::2219 Deprecated alias for 'sendemail.smtpencryption = ssl'.22202221sendemail.smtpsslcertpath::2222 Path to ca-certificates (either a directory or a single file).2223 Set it to an empty string to disable certificate verification.22242225sendemail.<identity>.*::2226 Identity-specific versions of the 'sendemail.*' parameters2227 found below, taking precedence over those when the this2228 identity is selected, through command-line or2229 'sendemail.identity'.22302231sendemail.aliasesfile::2232sendemail.aliasfiletype::2233sendemail.annotate::2234sendemail.bcc::2235sendemail.cc::2236sendemail.cccmd::2237sendemail.chainreplyto::2238sendemail.confirm::2239sendemail.envelopesender::2240sendemail.from::2241sendemail.multiedit::2242sendemail.signedoffbycc::2243sendemail.smtppass::2244sendemail.suppresscc::2245sendemail.suppressfrom::2246sendemail.to::2247sendemail.smtpdomain::2248sendemail.smtpserver::2249sendemail.smtpserverport::2250sendemail.smtpserveroption::2251sendemail.smtpuser::2252sendemail.thread::2253sendemail.validate::2254 See linkgit:git-send-email[1] for description.22552256sendemail.signedoffcc::2257 Deprecated alias for 'sendemail.signedoffbycc'.22582259showbranch.default::2260 The default set of branches for linkgit:git-show-branch[1].2261 See linkgit:git-show-branch[1].22622263status.relativePaths::2264 By default, linkgit:git-status[1] shows paths relative to the2265 current directory. Setting this variable to `false` shows paths2266 relative to the repository root (this was the default for Git2267 prior to v1.5.4).22682269status.short::2270 Set to true to enable --short by default in linkgit:git-status[1].2271 The option --no-short takes precedence over this variable.22722273status.branch::2274 Set to true to enable --branch by default in linkgit:git-status[1].2275 The option --no-branch takes precedence over this variable.22762277status.displayCommentPrefix::2278 If set to true, linkgit:git-status[1] will insert a comment2279 prefix before each output line (starting with2280 `core.commentChar`, i.e. `#` by default). This was the2281 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2282 Defaults to false.22832284status.showUntrackedFiles::2285 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2286 files which are not currently tracked by Git. Directories which2287 contain only untracked files, are shown with the directory name2288 only. Showing untracked files means that Git needs to lstat() all2289 all the files in the whole repository, which might be slow on some2290 systems. So, this variable controls how the commands displays2291 the untracked files. Possible values are:2292+2293--2294* `no` - Show no untracked files.2295* `normal` - Show untracked files and directories.2296* `all` - Show also individual files in untracked directories.2297--2298+2299If this variable is not specified, it defaults to 'normal'.2300This variable can be overridden with the -u|--untracked-files option2301of linkgit:git-status[1] and linkgit:git-commit[1].23022303status.submodulesummary::2304 Defaults to false.2305 If this is set to a non zero number or true (identical to -1 or an2306 unlimited number), the submodule summary will be enabled and a2307 summary of commits for modified submodules will be shown (see2308 --summary-limit option of linkgit:git-submodule[1]). Please note2309 that the summary output command will be suppressed for all2310 submodules when `diff.ignoreSubmodules` is set to 'all' or only2311 for those submodules where `submodule.<name>.ignore=all`. The only2312 exception to that rule is that status and commit will show staged2313 submodule changes. To2314 also view the summary for ignored submodules you can either use2315 the --ignore-submodules=dirty command-line option or the 'git2316 submodule summary' command, which shows a similar output but does2317 not honor these settings.23182319submodule.<name>.path::2320submodule.<name>.url::2321submodule.<name>.update::2322 The path within this project, URL, and the updating strategy2323 for a submodule. These variables are initially populated2324 by 'git submodule init'; edit them to override the2325 URL and other values found in the `.gitmodules` file. See2326 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.23272328submodule.<name>.branch::2329 The remote branch name for a submodule, used by `git submodule2330 update --remote`. Set this option to override the value found in2331 the `.gitmodules` file. See linkgit:git-submodule[1] and2332 linkgit:gitmodules[5] for details.23332334submodule.<name>.fetchRecurseSubmodules::2335 This option can be used to control recursive fetching of this2336 submodule. It can be overridden by using the --[no-]recurse-submodules2337 command-line option to "git fetch" and "git pull".2338 This setting will override that from in the linkgit:gitmodules[5]2339 file.23402341submodule.<name>.ignore::2342 Defines under what circumstances "git status" and the diff family show2343 a submodule as modified. When set to "all", it will never be considered2344 modified (but it will nonetheless show up in the output of status and2345 commit when it has been staged), "dirty" will ignore all changes2346 to the submodules work tree and2347 takes only differences between the HEAD of the submodule and the commit2348 recorded in the superproject into account. "untracked" will additionally2349 let submodules with modified tracked files in their work tree show up.2350 Using "none" (the default when this option is not set) also shows2351 submodules that have untracked files in their work tree as changed.2352 This setting overrides any setting made in .gitmodules for this submodule,2353 both settings can be overridden on the command line by using the2354 "--ignore-submodules" option. The 'git submodule' commands are not2355 affected by this setting.23562357tag.sort::2358 This variable controls the sort ordering of tags when displayed by2359 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2360 value of this variable will be used as the default.23612362tar.umask::2363 This variable can be used to restrict the permission bits of2364 tar archive entries. The default is 0002, which turns off the2365 world write bit. The special value "user" indicates that the2366 archiving user's umask will be used instead. See umask(2) and2367 linkgit:git-archive[1].23682369transfer.fsckObjects::2370 When `fetch.fsckObjects` or `receive.fsckObjects` are2371 not set, the value of this variable is used instead.2372 Defaults to false.23732374transfer.hiderefs::2375 This variable can be used to set both `receive.hiderefs`2376 and `uploadpack.hiderefs` at the same time to the same2377 values. See entries for these other variables.23782379transfer.unpackLimit::2380 When `fetch.unpackLimit` or `receive.unpackLimit` are2381 not set, the value of this variable is used instead.2382 The default value is 100.23832384uploadarchive.allowUnreachable::2385 If true, allow clients to use `git archive --remote` to request2386 any tree, whether reachable from the ref tips or not. See the2387 discussion in the `SECURITY` section of2388 linkgit:git-upload-archive[1] for more details. Defaults to2389 `false`.23902391uploadpack.hiderefs::2392 String(s) `upload-pack` uses to decide which refs to omit2393 from its initial advertisement. Use more than one2394 definitions to specify multiple prefix strings. A ref that2395 are under the hierarchies listed on the value of this2396 variable is excluded, and is hidden from `git ls-remote`,2397 `git fetch`, etc. An attempt to fetch a hidden ref by `git2398 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.23992400uploadpack.allowtipsha1inwant::2401 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2402 to accept a fetch request that asks for an object at the tip2403 of a hidden ref (by default, such a request is rejected).2404 see also `uploadpack.hiderefs`.24052406uploadpack.keepalive::2407 When `upload-pack` has started `pack-objects`, there may be a2408 quiet period while `pack-objects` prepares the pack. Normally2409 it would output progress information, but if `--quiet` was used2410 for the fetch, `pack-objects` will output nothing at all until2411 the pack data begins. Some clients and networks may consider2412 the server to be hung and give up. Setting this option instructs2413 `upload-pack` to send an empty keepalive packet every2414 `uploadpack.keepalive` seconds. Setting this option to 02415 disables keepalive packets entirely. The default is 5 seconds.24162417url.<base>.insteadOf::2418 Any URL that starts with this value will be rewritten to2419 start, instead, with <base>. In cases where some site serves a2420 large number of repositories, and serves them with multiple2421 access methods, and some users need to use different access2422 methods, this feature allows people to specify any of the2423 equivalent URLs and have Git automatically rewrite the URL to2424 the best alternative for the particular user, even for a2425 never-before-seen repository on the site. When more than one2426 insteadOf strings match a given URL, the longest match is used.24272428url.<base>.pushInsteadOf::2429 Any URL that starts with this value will not be pushed to;2430 instead, it will be rewritten to start with <base>, and the2431 resulting URL will be pushed to. In cases where some site serves2432 a large number of repositories, and serves them with multiple2433 access methods, some of which do not allow push, this feature2434 allows people to specify a pull-only URL and have Git2435 automatically use an appropriate URL to push, even for a2436 never-before-seen repository on the site. When more than one2437 pushInsteadOf strings match a given URL, the longest match is2438 used. If a remote has an explicit pushurl, Git will ignore this2439 setting for that remote.24402441user.email::2442 Your email address to be recorded in any newly created commits.2443 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2444 'EMAIL' environment variables. See linkgit:git-commit-tree[1].24452446user.name::2447 Your full name to be recorded in any newly created commits.2448 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2449 environment variables. See linkgit:git-commit-tree[1].24502451user.signingkey::2452 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2453 key you want it to automatically when creating a signed tag or2454 commit, you can override the default selection with this variable.2455 This option is passed unchanged to gpg's --local-user parameter,2456 so you may specify a key using any method that gpg supports.24572458web.browser::2459 Specify a web browser that may be used by some commands.2460 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2461 may use it.