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.protectHFS:: 237 If set to true, do not allow checkout of paths that would 238 be considered equivalent to `.git` on an HFS+ filesystem. 239 Defaults to `true` on Mac OS, and `false` elsewhere. 240 241core.protectNTFS:: 242 If set to true, do not allow checkout of paths that would 243 cause problems with the NTFS filesystem, e.g. conflict with 244 8.3 "short" names. 245 Defaults to `true` on Windows, and `false` elsewhere. 246 247core.trustctime:: 248 If false, the ctime differences between the index and the 249 working tree are ignored; useful when the inode change time 250 is regularly modified by something outside Git (file system 251 crawlers and some backup systems). 252 See linkgit:git-update-index[1]. True by default. 253 254core.checkstat:: 255 Determines which stat fields to match between the index 256 and work tree. The user can set this to 'default' or 257 'minimal'. Default (or explicitly 'default'), is to check 258 all fields, including the sub-second part of mtime and ctime. 259 260core.quotepath:: 261 The commands that output paths (e.g. 'ls-files', 262 'diff'), when not given the `-z` option, will quote 263 "unusual" characters in the pathname by enclosing the 264 pathname in a double-quote pair and with backslashes the 265 same way strings in C source code are quoted. If this 266 variable is set to false, the bytes higher than 0x80 are 267 not quoted but output as verbatim. Note that double 268 quote, backslash and control characters are always 269 quoted without `-z` regardless of the setting of this 270 variable. 271 272core.eol:: 273 Sets the line ending type to use in the working directory for 274 files that have the `text` property set. Alternatives are 275 'lf', 'crlf' and 'native', which uses the platform's native 276 line ending. The default value is `native`. See 277 linkgit:gitattributes[5] for more information on end-of-line 278 conversion. 279 280core.safecrlf:: 281 If true, makes Git check if converting `CRLF` is reversible when 282 end-of-line conversion is active. Git will verify if a command 283 modifies a file in the work tree either directly or indirectly. 284 For example, committing a file followed by checking out the 285 same file should yield the original file in the work tree. If 286 this is not the case for the current setting of 287 `core.autocrlf`, Git will reject the file. The variable can 288 be set to "warn", in which case Git will only warn about an 289 irreversible conversion but continue the operation. 290+ 291CRLF conversion bears a slight chance of corrupting data. 292When it is enabled, Git will convert CRLF to LF during commit and LF to 293CRLF during checkout. A file that contains a mixture of LF and 294CRLF before the commit cannot be recreated by Git. For text 295files this is the right thing to do: it corrects line endings 296such that we have only LF line endings in the repository. 297But for binary files that are accidentally classified as text the 298conversion can corrupt data. 299+ 300If you recognize such corruption early you can easily fix it by 301setting the conversion type explicitly in .gitattributes. Right 302after committing you still have the original file in your work 303tree and this file is not yet corrupted. You can explicitly tell 304Git that this file is binary and Git will handle the file 305appropriately. 306+ 307Unfortunately, the desired effect of cleaning up text files with 308mixed line endings and the undesired effect of corrupting binary 309files cannot be distinguished. In both cases CRLFs are removed 310in an irreversible way. For text files this is the right thing 311to do because CRLFs are line endings, while for binary files 312converting CRLFs corrupts data. 313+ 314Note, this safety check does not mean that a checkout will generate a 315file identical to the original file for a different setting of 316`core.eol` and `core.autocrlf`, but only for the current one. For 317example, a text file with `LF` would be accepted with `core.eol=lf` 318and could later be checked out with `core.eol=crlf`, in which case the 319resulting file would contain `CRLF`, although the original file 320contained `LF`. However, in both work trees the line endings would be 321consistent, that is either all `LF` or all `CRLF`, but never mixed. A 322file with mixed line endings would be reported by the `core.safecrlf` 323mechanism. 324 325core.autocrlf:: 326 Setting this variable to "true" is almost the same as setting 327 the `text` attribute to "auto" on all files except that text 328 files are not guaranteed to be normalized: files that contain 329 `CRLF` in the repository will not be touched. Use this 330 setting if you want to have `CRLF` line endings in your 331 working directory even though the repository does not have 332 normalized line endings. This variable can be set to 'input', 333 in which case no output conversion is performed. 334 335core.symlinks:: 336 If false, symbolic links are checked out as small plain files that 337 contain the link text. linkgit:git-update-index[1] and 338 linkgit:git-add[1] will not change the recorded type to regular 339 file. Useful on filesystems like FAT that do not support 340 symbolic links. 341+ 342The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 343will probe and set core.symlinks false if appropriate when the repository 344is created. 345 346core.gitProxy:: 347 A "proxy command" to execute (as 'command host port') instead 348 of establishing direct connection to the remote server when 349 using the Git protocol for fetching. If the variable value is 350 in the "COMMAND for DOMAIN" format, the command is applied only 351 on hostnames ending with the specified domain string. This variable 352 may be set multiple times and is matched in the given order; 353 the first match wins. 354+ 355Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 356(which always applies universally, without the special "for" 357handling). 358+ 359The special string `none` can be used as the proxy command to 360specify that no proxy be used for a given domain pattern. 361This is useful for excluding servers inside a firewall from 362proxy use, while defaulting to a common proxy for external domains. 363 364core.ignoreStat:: 365 If true, commands which modify both the working tree and the index 366 will mark the updated paths with the "assume unchanged" bit in the 367 index. These marked files are then assumed to stay unchanged in the 368 working tree, until you mark them otherwise manually - Git will not 369 detect the file changes by lstat() calls. This is useful on systems 370 where those are very slow, such as Microsoft Windows. 371 See linkgit:git-update-index[1]. 372 False by default. 373 374core.preferSymlinkRefs:: 375 Instead of the default "symref" format for HEAD 376 and other symbolic reference files, use symbolic links. 377 This is sometimes needed to work with old scripts that 378 expect HEAD to be a symbolic link. 379 380core.bare:: 381 If true this repository is assumed to be 'bare' and has no 382 working directory associated with it. If this is the case a 383 number of commands that require a working directory will be 384 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 385+ 386This setting is automatically guessed by linkgit:git-clone[1] or 387linkgit:git-init[1] when the repository was created. By default a 388repository that ends in "/.git" is assumed to be not bare (bare = 389false), while all other repositories are assumed to be bare (bare 390= true). 391 392core.worktree:: 393 Set the path to the root of the working tree. 394 This can be overridden by the GIT_WORK_TREE environment 395 variable and the '--work-tree' command-line option. 396 The value can be an absolute path or relative to the path to 397 the .git directory, which is either specified by --git-dir 398 or GIT_DIR, or automatically discovered. 399 If --git-dir or GIT_DIR is specified but none of 400 --work-tree, GIT_WORK_TREE and core.worktree is specified, 401 the current working directory is regarded as the top level 402 of your working tree. 403+ 404Note that this variable is honored even when set in a configuration 405file in a ".git" subdirectory of a directory and its value differs 406from the latter directory (e.g. "/path/to/.git/config" has 407core.worktree set to "/different/path"), which is most likely a 408misconfiguration. Running Git commands in the "/path/to" directory will 409still use "/different/path" as the root of the work tree and can cause 410confusion unless you know what you are doing (e.g. you are creating a 411read-only snapshot of the same index to a location different from the 412repository's usual working tree). 413 414core.logAllRefUpdates:: 415 Enable the reflog. Updates to a ref <ref> is logged to the file 416 "$GIT_DIR/logs/<ref>", by appending the new and old 417 SHA-1, the date/time and the reason of the update, but 418 only when the file exists. If this configuration 419 variable is set to true, missing "$GIT_DIR/logs/<ref>" 420 file is automatically created for branch heads (i.e. under 421 refs/heads/), remote refs (i.e. under refs/remotes/), 422 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 423+ 424This information can be used to determine what commit 425was the tip of a branch "2 days ago". 426+ 427This value is true by default in a repository that has 428a working directory associated with it, and false by 429default in a bare repository. 430 431core.repositoryFormatVersion:: 432 Internal variable identifying the repository format and layout 433 version. 434 435core.sharedRepository:: 436 When 'group' (or 'true'), the repository is made shareable between 437 several users in a group (making sure all the files and objects are 438 group-writable). When 'all' (or 'world' or 'everybody'), the 439 repository will be readable by all users, additionally to being 440 group-shareable. When 'umask' (or 'false'), Git will use permissions 441 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 442 files in the repository will have this mode value. '0xxx' will override 443 user's umask value (whereas the other options will only override 444 requested parts of the user's umask value). Examples: '0660' will make 445 the repo read/write-able for the owner and group, but inaccessible to 446 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 447 repository that is group-readable but not group-writable. 448 See linkgit:git-init[1]. False by default. 449 450core.warnAmbiguousRefs:: 451 If true, Git will warn you if the ref name you passed it is ambiguous 452 and might match multiple refs in the repository. True by default. 453 454core.compression:: 455 An integer -1..9, indicating a default compression level. 456 -1 is the zlib default. 0 means no compression, 457 and 1..9 are various speed/size tradeoffs, 9 being slowest. 458 If set, this provides a default to other compression variables, 459 such as 'core.loosecompression' and 'pack.compression'. 460 461core.loosecompression:: 462 An integer -1..9, indicating the compression level for objects that 463 are not in a pack file. -1 is the zlib default. 0 means no 464 compression, and 1..9 are various speed/size tradeoffs, 9 being 465 slowest. If not set, defaults to core.compression. If that is 466 not set, defaults to 1 (best speed). 467 468core.packedGitWindowSize:: 469 Number of bytes of a pack file to map into memory in a 470 single mapping operation. Larger window sizes may allow 471 your system to process a smaller number of large pack files 472 more quickly. Smaller window sizes will negatively affect 473 performance due to increased calls to the operating system's 474 memory manager, but may improve performance when accessing 475 a large number of large pack files. 476+ 477Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 478MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 479be reasonable for all users/operating systems. You probably do 480not need to adjust this value. 481+ 482Common unit suffixes of 'k', 'm', or 'g' are supported. 483 484core.packedGitLimit:: 485 Maximum number of bytes to map simultaneously into memory 486 from pack files. If Git needs to access more than this many 487 bytes at once to complete an operation it will unmap existing 488 regions to reclaim virtual address space within the process. 489+ 490Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 491This should be reasonable for all users/operating systems, except on 492the largest projects. You probably do not need to adjust this value. 493+ 494Common unit suffixes of 'k', 'm', or 'g' are supported. 495 496core.deltaBaseCacheLimit:: 497 Maximum number of bytes to reserve for caching base objects 498 that may be referenced by multiple deltified objects. By storing the 499 entire decompressed base objects in a cache Git is able 500 to avoid unpacking and decompressing frequently used base 501 objects multiple times. 502+ 503Default is 96 MiB on all platforms. This should be reasonable 504for all users/operating systems, except on the largest projects. 505You probably do not need to adjust this value. 506+ 507Common unit suffixes of 'k', 'm', or 'g' are supported. 508 509core.bigFileThreshold:: 510 Files larger than this size are stored deflated, without 511 attempting delta compression. Storing large files without 512 delta compression avoids excessive memory usage, at the 513 slight expense of increased disk usage. 514+ 515Default is 512 MiB on all platforms. This should be reasonable 516for most projects as source code and other text files can still 517be delta compressed, but larger binary media files won't be. 518+ 519Common unit suffixes of 'k', 'm', or 'g' are supported. 520 521core.excludesfile:: 522 In addition to '.gitignore' (per-directory) and 523 '.git/info/exclude', Git looks into this file for patterns 524 of files which are not meant to be tracked. "`~/`" is expanded 525 to the value of `$HOME` and "`~user/`" to the specified user's 526 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 527 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 528 is used instead. See linkgit:gitignore[5]. 529 530core.askpass:: 531 Some commands (e.g. svn and http interfaces) that interactively 532 ask for a password can be told to use an external program given 533 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 534 environment variable. If not set, fall back to the value of the 535 'SSH_ASKPASS' environment variable or, failing that, a simple password 536 prompt. The external program shall be given a suitable prompt as 537 command-line argument and write the password on its STDOUT. 538 539core.attributesfile:: 540 In addition to '.gitattributes' (per-directory) and 541 '.git/info/attributes', Git looks into this file for attributes 542 (see linkgit:gitattributes[5]). Path expansions are made the same 543 way as for `core.excludesfile`. Its default value is 544 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 545 set or empty, $HOME/.config/git/attributes is used instead. 546 547core.editor:: 548 Commands such as `commit` and `tag` that lets you edit 549 messages by launching an editor uses the value of this 550 variable when it is set, and the environment variable 551 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 552 553core.commentchar:: 554 Commands such as `commit` and `tag` that lets you edit 555 messages consider a line that begins with this character 556 commented, and removes them after the editor returns 557 (default '#'). 558+ 559If set to "auto", `git-commit` would select a character that is not 560the beginning character of any line in existing commit messages. 561 562sequence.editor:: 563 Text editor used by `git rebase -i` for editing the rebase instruction file. 564 The value is meant to be interpreted by the shell when it is used. 565 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 566 When not configured the default commit message editor is used instead. 567 568core.pager:: 569 Text viewer for use by Git commands (e.g., 'less'). The value 570 is meant to be interpreted by the shell. The order of preference 571 is the `$GIT_PAGER` environment variable, then `core.pager` 572 configuration, then `$PAGER`, and then the default chosen at 573 compile time (usually 'less'). 574+ 575When the `LESS` environment variable is unset, Git sets it to `FRX` 576(if `LESS` environment variable is set, Git does not change it at 577all). If you want to selectively override Git's default setting 578for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 579be passed to the shell by Git, which will translate the final 580command to `LESS=FRX less -S`. The environment does not set the 581`S` option but the command line does, instructing less to truncate 582long lines. Similarly, setting `core.pager` to `less -+F` will 583deactivate the `F` option specified by the environment from the 584command-line, deactivating the "quit if one screen" behavior of 585`less`. One can specifically activate some flags for particular 586commands: for example, setting `pager.blame` to `less -S` enables 587line truncation only for `git blame`. 588+ 589Likewise, when the `LV` environment variable is unset, Git sets it 590to `-c`. You can override this setting by exporting `LV` with 591another value or setting `core.pager` to `lv +c`. 592 593core.whitespace:: 594 A comma separated list of common whitespace problems to 595 notice. 'git diff' will use `color.diff.whitespace` to 596 highlight them, and 'git apply --whitespace=error' will 597 consider them as errors. You can prefix `-` to disable 598 any of them (e.g. `-trailing-space`): 599+ 600* `blank-at-eol` treats trailing whitespaces at the end of the line 601 as an error (enabled by default). 602* `space-before-tab` treats a space character that appears immediately 603 before a tab character in the initial indent part of the line as an 604 error (enabled by default). 605* `indent-with-non-tab` treats a line that is indented with space 606 characters instead of the equivalent tabs as an error (not enabled by 607 default). 608* `tab-in-indent` treats a tab character in the initial indent part of 609 the line as an error (not enabled by default). 610* `blank-at-eof` treats blank lines added at the end of file as an error 611 (enabled by default). 612* `trailing-space` is a short-hand to cover both `blank-at-eol` and 613 `blank-at-eof`. 614* `cr-at-eol` treats a carriage-return at the end of line as 615 part of the line terminator, i.e. with it, `trailing-space` 616 does not trigger if the character before such a carriage-return 617 is not a whitespace (not enabled by default). 618* `tabwidth=<n>` tells how many character positions a tab occupies; this 619 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 620 errors. The default tab width is 8. Allowed values are 1 to 63. 621 622core.fsyncobjectfiles:: 623 This boolean will enable 'fsync()' when writing object files. 624+ 625This is a total waste of time and effort on a filesystem that orders 626data writes properly, but can be useful for filesystems that do not use 627journalling (traditional UNIX filesystems) or that only journal metadata 628and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 629 630core.preloadindex:: 631 Enable parallel index preload for operations like 'git diff' 632+ 633This can speed up operations like 'git diff' and 'git status' especially 634on filesystems like NFS that have weak caching semantics and thus 635relatively high IO latencies. When enabled, Git will do the 636index comparison to the filesystem data in parallel, allowing 637overlapping IO's. Defaults to true. 638 639core.createObject:: 640 You can set this to 'link', in which case a hardlink followed by 641 a delete of the source are used to make sure that object creation 642 will not overwrite existing objects. 643+ 644On some file system/operating system combinations, this is unreliable. 645Set this config setting to 'rename' there; However, This will remove the 646check that makes sure that existing object files will not get overwritten. 647 648core.notesRef:: 649 When showing commit messages, also show notes which are stored in 650 the given ref. The ref must be fully qualified. If the given 651 ref does not exist, it is not an error but means that no 652 notes should be printed. 653+ 654This setting defaults to "refs/notes/commits", and it can be overridden by 655the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 656 657core.sparseCheckout:: 658 Enable "sparse checkout" feature. See section "Sparse checkout" in 659 linkgit:git-read-tree[1] for more information. 660 661core.abbrev:: 662 Set the length object names are abbreviated to. If unspecified, 663 many commands abbreviate to 7 hexdigits, which may not be enough 664 for abbreviated object names to stay unique for sufficiently long 665 time. 666 667add.ignoreErrors:: 668add.ignore-errors:: 669 Tells 'git add' to continue adding files when some files cannot be 670 added due to indexing errors. Equivalent to the '--ignore-errors' 671 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 672 as it does not follow the usual naming convention for configuration 673 variables. 674 675alias.*:: 676 Command aliases for the linkgit:git[1] command wrapper - e.g. 677 after defining "alias.last = cat-file commit HEAD", the invocation 678 "git last" is equivalent to "git cat-file commit HEAD". To avoid 679 confusion and troubles with script usage, aliases that 680 hide existing Git commands are ignored. Arguments are split by 681 spaces, the usual shell quoting and escaping is supported. 682 A quote pair or a backslash can be used to quote them. 683+ 684If the alias expansion is prefixed with an exclamation point, 685it will be treated as a shell command. For example, defining 686"alias.new = !gitk --all --not ORIG_HEAD", the invocation 687"git new" is equivalent to running the shell command 688"gitk --all --not ORIG_HEAD". Note that shell commands will be 689executed from the top-level directory of a repository, which may 690not necessarily be the current directory. 691'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 692from the original current directory. See linkgit:git-rev-parse[1]. 693 694am.keepcr:: 695 If true, git-am will call git-mailsplit for patches in mbox format 696 with parameter '--keep-cr'. In this case git-mailsplit will 697 not remove `\r` from lines ending with `\r\n`. Can be overridden 698 by giving '--no-keep-cr' from the command line. 699 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 700 701apply.ignorewhitespace:: 702 When set to 'change', tells 'git apply' to ignore changes in 703 whitespace, in the same way as the '--ignore-space-change' 704 option. 705 When set to one of: no, none, never, false tells 'git apply' to 706 respect all whitespace differences. 707 See linkgit:git-apply[1]. 708 709apply.whitespace:: 710 Tells 'git apply' how to handle whitespaces, in the same way 711 as the '--whitespace' option. See linkgit:git-apply[1]. 712 713branch.autosetupmerge:: 714 Tells 'git branch' and 'git checkout' to set up new branches 715 so that linkgit:git-pull[1] will appropriately merge from the 716 starting point branch. Note that even if this option is not set, 717 this behavior can be chosen per-branch using the `--track` 718 and `--no-track` options. The valid settings are: `false` -- no 719 automatic setup is done; `true` -- automatic setup is done when the 720 starting point is a remote-tracking branch; `always` -- 721 automatic setup is done when the starting point is either a 722 local branch or remote-tracking 723 branch. This option defaults to true. 724 725branch.autosetuprebase:: 726 When a new branch is created with 'git branch' or 'git checkout' 727 that tracks another branch, this variable tells Git to set 728 up pull to rebase instead of merge (see "branch.<name>.rebase"). 729 When `never`, rebase is never automatically set to true. 730 When `local`, rebase is set to true for tracked branches of 731 other local branches. 732 When `remote`, rebase is set to true for tracked branches of 733 remote-tracking branches. 734 When `always`, rebase will be set to true for all tracking 735 branches. 736 See "branch.autosetupmerge" for details on how to set up a 737 branch to track another branch. 738 This option defaults to never. 739 740branch.<name>.remote:: 741 When on branch <name>, it tells 'git fetch' and 'git push' 742 which remote to fetch from/push to. The remote to push to 743 may be overridden with `remote.pushdefault` (for all branches). 744 The remote to push to, for the current branch, may be further 745 overridden by `branch.<name>.pushremote`. If no remote is 746 configured, or if you are not on any branch, it defaults to 747 `origin` for fetching and `remote.pushdefault` for pushing. 748 Additionally, `.` (a period) is the current local repository 749 (a dot-repository), see `branch.<name>.merge`'s final note below. 750 751branch.<name>.pushremote:: 752 When on branch <name>, it overrides `branch.<name>.remote` for 753 pushing. It also overrides `remote.pushdefault` for pushing 754 from branch <name>. When you pull from one place (e.g. your 755 upstream) and push to another place (e.g. your own publishing 756 repository), you would want to set `remote.pushdefault` to 757 specify the remote to push to for all branches, and use this 758 option to override it for a specific branch. 759 760branch.<name>.merge:: 761 Defines, together with branch.<name>.remote, the upstream branch 762 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 763 branch to merge and can also affect 'git push' (see push.default). 764 When in branch <name>, it tells 'git fetch' the default 765 refspec to be marked for merging in FETCH_HEAD. The value is 766 handled like the remote part of a refspec, and must match a 767 ref which is fetched from the remote given by 768 "branch.<name>.remote". 769 The merge information is used by 'git pull' (which at first calls 770 'git fetch') to lookup the default branch for merging. Without 771 this option, 'git pull' defaults to merge the first refspec fetched. 772 Specify multiple values to get an octopus merge. 773 If you wish to setup 'git pull' so that it merges into <name> from 774 another branch in the local repository, you can point 775 branch.<name>.merge to the desired branch, and use the relative path 776 setting `.` (a period) for branch.<name>.remote. 777 778branch.<name>.mergeoptions:: 779 Sets default options for merging into branch <name>. The syntax and 780 supported options are the same as those of linkgit:git-merge[1], but 781 option values containing whitespace characters are currently not 782 supported. 783 784branch.<name>.rebase:: 785 When true, rebase the branch <name> on top of the fetched branch, 786 instead of merging the default branch from the default remote when 787 "git pull" is run. See "pull.rebase" for doing this in a non 788 branch-specific manner. 789+ 790 When preserve, also pass `--preserve-merges` along to 'git rebase' 791 so that locally committed merge commits will not be flattened 792 by running 'git pull'. 793+ 794*NOTE*: this is a possibly dangerous operation; do *not* use 795it unless you understand the implications (see linkgit:git-rebase[1] 796for details). 797 798branch.<name>.description:: 799 Branch description, can be edited with 800 `git branch --edit-description`. Branch description is 801 automatically added in the format-patch cover letter or 802 request-pull summary. 803 804browser.<tool>.cmd:: 805 Specify the command to invoke the specified browser. The 806 specified command is evaluated in shell with the URLs passed 807 as arguments. (See linkgit:git-web{litdd}browse[1].) 808 809browser.<tool>.path:: 810 Override the path for the given tool that may be used to 811 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 812 working repository in gitweb (see linkgit:git-instaweb[1]). 813 814clean.requireForce:: 815 A boolean to make git-clean do nothing unless given -f, 816 -i or -n. Defaults to true. 817 818color.branch:: 819 A boolean to enable/disable color in the output of 820 linkgit:git-branch[1]. May be set to `always`, 821 `false` (or `never`) or `auto` (or `true`), in which case colors are used 822 only when the output is to a terminal. Defaults to false. 823 824color.branch.<slot>:: 825 Use customized color for branch coloration. `<slot>` is one of 826 `current` (the current branch), `local` (a local branch), 827 `remote` (a remote-tracking branch in refs/remotes/), 828 `upstream` (upstream tracking branch), `plain` (other 829 refs). 830+ 831The value for these configuration variables is a list of colors (at most 832two) and attributes (at most one), separated by spaces. The colors 833accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 834`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 835`blink` and `reverse`. The first color given is the foreground; the 836second is the background. The position of the attribute, if any, 837doesn't matter. 838 839color.diff:: 840 Whether to use ANSI escape sequences to add color to patches. 841 If this is set to `always`, linkgit:git-diff[1], 842 linkgit:git-log[1], and linkgit:git-show[1] will use color 843 for all patches. If it is set to `true` or `auto`, those 844 commands will only use color when output is to the terminal. 845 Defaults to false. 846+ 847This does not affect linkgit:git-format-patch[1] or the 848'git-diff-{asterisk}' plumbing commands. Can be overridden on the 849command line with the `--color[=<when>]` option. 850 851color.diff.<slot>:: 852 Use customized color for diff colorization. `<slot>` specifies 853 which part of the patch to use the specified color, and is one 854 of `plain` (context text), `meta` (metainformation), `frag` 855 (hunk header), 'func' (function in hunk header), `old` (removed lines), 856 `new` (added lines), `commit` (commit headers), or `whitespace` 857 (highlighting whitespace errors). The values of these variables may be 858 specified as in color.branch.<slot>. 859 860color.decorate.<slot>:: 861 Use customized color for 'git log --decorate' output. `<slot>` is one 862 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 863 branches, remote-tracking branches, tags, stash and HEAD, respectively. 864 865color.grep:: 866 When set to `always`, always highlight matches. When `false` (or 867 `never`), never. When set to `true` or `auto`, use color only 868 when the output is written to the terminal. Defaults to `false`. 869 870color.grep.<slot>:: 871 Use customized color for grep colorization. `<slot>` specifies which 872 part of the line to use the specified color, and is one of 873+ 874-- 875`context`;; 876 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 877`filename`;; 878 filename prefix (when not using `-h`) 879`function`;; 880 function name lines (when using `-p`) 881`linenumber`;; 882 line number prefix (when using `-n`) 883`match`;; 884 matching text 885`selected`;; 886 non-matching text in selected lines 887`separator`;; 888 separators between fields on a line (`:`, `-`, and `=`) 889 and between hunks (`--`) 890-- 891+ 892The values of these variables may be specified as in color.branch.<slot>. 893 894color.interactive:: 895 When set to `always`, always use colors for interactive prompts 896 and displays (such as those used by "git-add --interactive" and 897 "git-clean --interactive"). When false (or `never`), never. 898 When set to `true` or `auto`, use colors only when the output is 899 to the terminal. Defaults to false. 900 901color.interactive.<slot>:: 902 Use customized color for 'git add --interactive' and 'git clean 903 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 904 or `error`, for four distinct types of normal output from 905 interactive commands. The values of these variables may be 906 specified as in color.branch.<slot>. 907 908color.pager:: 909 A boolean to enable/disable colored output when the pager is in 910 use (default is true). 911 912color.showbranch:: 913 A boolean to enable/disable color in the output of 914 linkgit:git-show-branch[1]. May be set to `always`, 915 `false` (or `never`) or `auto` (or `true`), in which case colors are used 916 only when the output is to a terminal. Defaults to false. 917 918color.status:: 919 A boolean to enable/disable color in the output of 920 linkgit:git-status[1]. May be set to `always`, 921 `false` (or `never`) or `auto` (or `true`), in which case colors are used 922 only when the output is to a terminal. Defaults to false. 923 924color.status.<slot>:: 925 Use customized color for status colorization. `<slot>` is 926 one of `header` (the header text of the status message), 927 `added` or `updated` (files which are added but not committed), 928 `changed` (files which are changed but not added in the index), 929 `untracked` (files which are not tracked by Git), 930 `branch` (the current branch), or 931 `nobranch` (the color the 'no branch' warning is shown in, defaulting 932 to red). The values of these variables may be specified as in 933 color.branch.<slot>. 934 935color.ui:: 936 This variable determines the default value for variables such 937 as `color.diff` and `color.grep` that control the use of color 938 per command family. Its scope will expand as more commands learn 939 configuration to set a default for the `--color` option. Set it 940 to `false` or `never` if you prefer Git commands not to use 941 color unless enabled explicitly with some other configuration 942 or the `--color` option. Set it to `always` if you want all 943 output not intended for machine consumption to use color, to 944 `true` or `auto` (this is the default since Git 1.8.4) if you 945 want such output to use color when written to the terminal. 946 947column.ui:: 948 Specify whether supported commands should output in columns. 949 This variable consists of a list of tokens separated by spaces 950 or commas: 951+ 952These options control when the feature should be enabled 953(defaults to 'never'): 954+ 955-- 956`always`;; 957 always show in columns 958`never`;; 959 never show in columns 960`auto`;; 961 show in columns if the output is to the terminal 962-- 963+ 964These options control layout (defaults to 'column'). Setting any 965of these implies 'always' if none of 'always', 'never', or 'auto' are 966specified. 967+ 968-- 969`column`;; 970 fill columns before rows 971`row`;; 972 fill rows before columns 973`plain`;; 974 show in one column 975-- 976+ 977Finally, these options can be combined with a layout option (defaults 978to 'nodense'): 979+ 980-- 981`dense`;; 982 make unequal size columns to utilize more space 983`nodense`;; 984 make equal size columns 985-- 986 987column.branch:: 988 Specify whether to output branch listing in `git branch` in columns. 989 See `column.ui` for details. 990 991column.clean:: 992 Specify the layout when list items in `git clean -i`, which always 993 shows files and directories in columns. See `column.ui` for details. 994 995column.status:: 996 Specify whether to output untracked files in `git status` in columns. 997 See `column.ui` for details. 998 999column.tag::1000 Specify whether to output tag listing in `git tag` in columns.1001 See `column.ui` for details.10021003commit.cleanup::1004 This setting overrides the default of the `--cleanup` option in1005 `git commit`. See linkgit:git-commit[1] for details. Changing the1006 default can be useful when you always want to keep lines that begin1007 with comment character `#` in your log message, in which case you1008 would do `git config commit.cleanup whitespace` (note that you will1009 have to remove the help lines that begin with `#` in the commit log1010 template yourself, if you do this).10111012commit.gpgsign::10131014 A boolean to specify whether all commits should be GPG signed.1015 Use of this option when doing operations such as rebase can1016 result in a large number of commits being signed. It may be1017 convenient to use an agent to avoid typing your GPG passphrase1018 several times.10191020commit.status::1021 A boolean to enable/disable inclusion of status information in the1022 commit message template when using an editor to prepare the commit1023 message. Defaults to true.10241025commit.template::1026 Specify a file to use as the template for new commit messages.1027 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1028 specified user's home directory.10291030credential.helper::1031 Specify an external helper to be called when a username or1032 password credential is needed; the helper may consult external1033 storage to avoid prompting the user for the credentials. See1034 linkgit:gitcredentials[7] for details.10351036credential.useHttpPath::1037 When acquiring credentials, consider the "path" component of an http1038 or https URL to be important. Defaults to false. See1039 linkgit:gitcredentials[7] for more information.10401041credential.username::1042 If no username is set for a network authentication, use this username1043 by default. See credential.<context>.* below, and1044 linkgit:gitcredentials[7].10451046credential.<url>.*::1047 Any of the credential.* options above can be applied selectively to1048 some credentials. For example "credential.https://example.com.username"1049 would set the default username only for https connections to1050 example.com. See linkgit:gitcredentials[7] for details on how URLs are1051 matched.10521053include::diff-config.txt[]10541055difftool.<tool>.path::1056 Override the path for the given tool. This is useful in case1057 your tool is not in the PATH.10581059difftool.<tool>.cmd::1060 Specify the command to invoke the specified diff tool.1061 The specified command is evaluated in shell with the following1062 variables available: 'LOCAL' is set to the name of the temporary1063 file containing the contents of the diff pre-image and 'REMOTE'1064 is set to the name of the temporary file containing the contents1065 of the diff post-image.10661067difftool.prompt::1068 Prompt before each invocation of the diff tool.10691070fetch.recurseSubmodules::1071 This option can be either set to a boolean value or to 'on-demand'.1072 Setting it to a boolean changes the behavior of fetch and pull to1073 unconditionally recurse into submodules when set to true or to not1074 recurse at all when set to false. When set to 'on-demand' (the default1075 value), fetch and pull will only recurse into a populated submodule1076 when its superproject retrieves a commit that updates the submodule's1077 reference.10781079fetch.fsckObjects::1080 If it is set to true, git-fetch-pack will check all fetched1081 objects. It will abort in the case of a malformed object or a1082 broken link. The result of an abort are only dangling objects.1083 Defaults to false. If not set, the value of `transfer.fsckObjects`1084 is used instead.10851086fetch.unpackLimit::1087 If the number of objects fetched over the Git native1088 transfer is below this1089 limit, then the objects will be unpacked into loose object1090 files. However if the number of received objects equals or1091 exceeds this limit then the received pack will be stored as1092 a pack, after adding any missing delta bases. Storing the1093 pack from a push can make the push operation complete faster,1094 especially on slow filesystems. If not set, the value of1095 `transfer.unpackLimit` is used instead.10961097fetch.prune::1098 If true, fetch will automatically behave as if the `--prune`1099 option was given on the command line. See also `remote.<name>.prune`.11001101format.attach::1102 Enable multipart/mixed attachments as the default for1103 'format-patch'. The value can also be a double quoted string1104 which will enable attachments as the default and set the1105 value as the boundary. See the --attach option in1106 linkgit:git-format-patch[1].11071108format.numbered::1109 A boolean which can enable or disable sequence numbers in patch1110 subjects. It defaults to "auto" which enables it only if there1111 is more than one patch. It can be enabled or disabled for all1112 messages by setting it to "true" or "false". See --numbered1113 option in linkgit:git-format-patch[1].11141115format.headers::1116 Additional email headers to include in a patch to be submitted1117 by mail. See linkgit:git-format-patch[1].11181119format.to::1120format.cc::1121 Additional recipients to include in a patch to be submitted1122 by mail. See the --to and --cc options in1123 linkgit:git-format-patch[1].11241125format.subjectprefix::1126 The default for format-patch is to output files with the '[PATCH]'1127 subject prefix. Use this variable to change that prefix.11281129format.signature::1130 The default for format-patch is to output a signature containing1131 the Git version number. Use this variable to change that default.1132 Set this variable to the empty string ("") to suppress1133 signature generation.11341135format.signaturefile::1136 Works just like format.signature except the contents of the1137 file specified by this variable will be used as the signature.11381139format.suffix::1140 The default for format-patch is to output files with the suffix1141 `.patch`. Use this variable to change that suffix (make sure to1142 include the dot if you want it).11431144format.pretty::1145 The default pretty format for log/show/whatchanged command,1146 See linkgit:git-log[1], linkgit:git-show[1],1147 linkgit:git-whatchanged[1].11481149format.thread::1150 The default threading style for 'git format-patch'. Can be1151 a boolean value, or `shallow` or `deep`. `shallow` threading1152 makes every mail a reply to the head of the series,1153 where the head is chosen from the cover letter, the1154 `--in-reply-to`, and the first patch mail, in this order.1155 `deep` threading makes every mail a reply to the previous one.1156 A true boolean value is the same as `shallow`, and a false1157 value disables threading.11581159format.signoff::1160 A boolean value which lets you enable the `-s/--signoff` option of1161 format-patch by default. *Note:* Adding the Signed-off-by: line to a1162 patch should be a conscious act and means that you certify you have1163 the rights to submit this work under the same open source license.1164 Please see the 'SubmittingPatches' document for further discussion.11651166format.coverLetter::1167 A boolean that controls whether to generate a cover-letter when1168 format-patch is invoked, but in addition can be set to "auto", to1169 generate a cover-letter only when there's more than one patch.11701171filter.<driver>.clean::1172 The command which is used to convert the content of a worktree1173 file to a blob upon checkin. See linkgit:gitattributes[5] for1174 details.11751176filter.<driver>.smudge::1177 The command which is used to convert the content of a blob1178 object to a worktree file upon checkout. See1179 linkgit:gitattributes[5] for details.11801181gc.aggressiveDepth::1182 The depth parameter used in the delta compression1183 algorithm used by 'git gc --aggressive'. This defaults1184 to 250.11851186gc.aggressiveWindow::1187 The window size parameter used in the delta compression1188 algorithm used by 'git gc --aggressive'. This defaults1189 to 250.11901191gc.auto::1192 When there are approximately more than this many loose1193 objects in the repository, `git gc --auto` will pack them.1194 Some Porcelain commands use this command to perform a1195 light-weight garbage collection from time to time. The1196 default value is 6700. Setting this to 0 disables it.11971198gc.autopacklimit::1199 When there are more than this many packs that are not1200 marked with `*.keep` file in the repository, `git gc1201 --auto` consolidates them into one larger pack. The1202 default value is 50. Setting this to 0 disables it.12031204gc.autodetach::1205 Make `git gc --auto` return immediately andrun in background1206 if the system supports it. Default is true.12071208gc.packrefs::1209 Running `git pack-refs` in a repository renders it1210 unclonable by Git versions prior to 1.5.1.2 over dumb1211 transports such as HTTP. This variable determines whether1212 'git gc' runs `git pack-refs`. This can be set to `notbare`1213 to enable it within all non-bare repos or it can be set to a1214 boolean value. The default is `true`.12151216gc.pruneexpire::1217 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1218 Override the grace period with this config variable. The value1219 "now" may be used to disable this grace period and always prune1220 unreachable objects immediately.12211222gc.reflogexpire::1223gc.<pattern>.reflogexpire::1224 'git reflog expire' removes reflog entries older than1225 this time; defaults to 90 days. With "<pattern>" (e.g.1226 "refs/stash") in the middle the setting applies only to1227 the refs that match the <pattern>.12281229gc.reflogexpireunreachable::1230gc.<ref>.reflogexpireunreachable::1231 'git reflog expire' removes reflog entries older than1232 this time and are not reachable from the current tip;1233 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1234 in the middle, the setting applies only to the refs that1235 match the <pattern>.12361237gc.rerereresolved::1238 Records of conflicted merge you resolved earlier are1239 kept for this many days when 'git rerere gc' is run.1240 The default is 60 days. See linkgit:git-rerere[1].12411242gc.rerereunresolved::1243 Records of conflicted merge you have not resolved are1244 kept for this many days when 'git rerere gc' is run.1245 The default is 15 days. See linkgit:git-rerere[1].12461247gitcvs.commitmsgannotation::1248 Append this string to each commit message. Set to empty string1249 to disable this feature. Defaults to "via git-CVS emulator".12501251gitcvs.enabled::1252 Whether the CVS server interface is enabled for this repository.1253 See linkgit:git-cvsserver[1].12541255gitcvs.logfile::1256 Path to a log file where the CVS server interface well... logs1257 various stuff. See linkgit:git-cvsserver[1].12581259gitcvs.usecrlfattr::1260 If true, the server will look up the end-of-line conversion1261 attributes for files to determine the '-k' modes to use. If1262 the attributes force Git to treat a file as text,1263 the '-k' mode will be left blank so CVS clients will1264 treat it as text. If they suppress text conversion, the file1265 will be set with '-kb' mode, which suppresses any newline munging1266 the client might otherwise do. If the attributes do not allow1267 the file type to be determined, then 'gitcvs.allbinary' is1268 used. See linkgit:gitattributes[5].12691270gitcvs.allbinary::1271 This is used if 'gitcvs.usecrlfattr' does not resolve1272 the correct '-kb' mode to use. If true, all1273 unresolved files are sent to the client in1274 mode '-kb'. This causes the client to treat them1275 as binary files, which suppresses any newline munging it1276 otherwise might do. Alternatively, if it is set to "guess",1277 then the contents of the file are examined to decide if1278 it is binary, similar to 'core.autocrlf'.12791280gitcvs.dbname::1281 Database used by git-cvsserver to cache revision information1282 derived from the Git repository. The exact meaning depends on the1283 used database driver, for SQLite (which is the default driver) this1284 is a filename. Supports variable substitution (see1285 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1286 Default: '%Ggitcvs.%m.sqlite'12871288gitcvs.dbdriver::1289 Used Perl DBI driver. You can specify any available driver1290 for this here, but it might not work. git-cvsserver is tested1291 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1292 reported *not* to work with 'DBD::mysql'. Experimental feature.1293 May not contain double colons (`:`). Default: 'SQLite'.1294 See linkgit:git-cvsserver[1].12951296gitcvs.dbuser, gitcvs.dbpass::1297 Database user and password. Only useful if setting 'gitcvs.dbdriver',1298 since SQLite has no concept of database users and/or passwords.1299 'gitcvs.dbuser' supports variable substitution (see1300 linkgit:git-cvsserver[1] for details).13011302gitcvs.dbTableNamePrefix::1303 Database table name prefix. Prepended to the names of any1304 database tables used, allowing a single database to be used1305 for several repositories. Supports variable substitution (see1306 linkgit:git-cvsserver[1] for details). Any non-alphabetic1307 characters will be replaced with underscores.13081309All gitcvs variables except for 'gitcvs.usecrlfattr' and1310'gitcvs.allbinary' can also be specified as1311'gitcvs.<access_method>.<varname>' (where 'access_method'1312is one of "ext" and "pserver") to make them apply only for the given1313access method.13141315gitweb.category::1316gitweb.description::1317gitweb.owner::1318gitweb.url::1319 See linkgit:gitweb[1] for description.13201321gitweb.avatar::1322gitweb.blame::1323gitweb.grep::1324gitweb.highlight::1325gitweb.patches::1326gitweb.pickaxe::1327gitweb.remote_heads::1328gitweb.showsizes::1329gitweb.snapshot::1330 See linkgit:gitweb.conf[5] for description.13311332grep.lineNumber::1333 If set to true, enable '-n' option by default.13341335grep.patternType::1336 Set the default matching behavior. Using a value of 'basic', 'extended',1337 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1338 '--fixed-strings', or '--perl-regexp' option accordingly, while the1339 value 'default' will return to the default matching behavior.13401341grep.extendedRegexp::1342 If set to true, enable '--extended-regexp' option by default. This1343 option is ignored when the 'grep.patternType' option is set to a value1344 other than 'default'.13451346gpg.program::1347 Use this custom program instead of "gpg" found on $PATH when1348 making or verifying a PGP signature. The program must support the1349 same command-line interface as GPG, namely, to verify a detached1350 signature, "gpg --verify $file - <$signature" is run, and the1351 program is expected to signal a good signature by exiting with1352 code 0, and to generate an ascii-armored detached signature, the1353 standard input of "gpg -bsau $key" is fed with the contents to be1354 signed, and the program is expected to send the result to its1355 standard output.13561357gui.commitmsgwidth::1358 Defines how wide the commit message window is in the1359 linkgit:git-gui[1]. "75" is the default.13601361gui.diffcontext::1362 Specifies how many context lines should be used in calls to diff1363 made by the linkgit:git-gui[1]. The default is "5".13641365gui.displayuntracked::1366 Determines if linkgit::git-gui[1] shows untracked files1367 in the file list. The default is "true".13681369gui.encoding::1370 Specifies the default encoding to use for displaying of1371 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1372 It can be overridden by setting the 'encoding' attribute1373 for relevant files (see linkgit:gitattributes[5]).1374 If this option is not set, the tools default to the1375 locale encoding.13761377gui.matchtrackingbranch::1378 Determines if new branches created with linkgit:git-gui[1] should1379 default to tracking remote branches with matching names or1380 not. Default: "false".13811382gui.newbranchtemplate::1383 Is used as suggested name when creating new branches using the1384 linkgit:git-gui[1].13851386gui.pruneduringfetch::1387 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1388 performing a fetch. The default value is "false".13891390gui.trustmtime::1391 Determines if linkgit:git-gui[1] should trust the file modification1392 timestamp or not. By default the timestamps are not trusted.13931394gui.spellingdictionary::1395 Specifies the dictionary used for spell checking commit messages in1396 the linkgit:git-gui[1]. When set to "none" spell checking is turned1397 off.13981399gui.fastcopyblame::1400 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1401 location detection. It makes blame significantly faster on huge1402 repositories at the expense of less thorough copy detection.14031404gui.copyblamethreshold::1405 Specifies the threshold to use in 'git gui blame' original location1406 detection, measured in alphanumeric characters. See the1407 linkgit:git-blame[1] manual for more information on copy detection.14081409gui.blamehistoryctx::1410 Specifies the radius of history context in days to show in1411 linkgit:gitk[1] for the selected commit, when the `Show History1412 Context` menu item is invoked from 'git gui blame'. If this1413 variable is set to zero, the whole history is shown.14141415guitool.<name>.cmd::1416 Specifies the shell command line to execute when the corresponding item1417 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1418 mandatory for every tool. The command is executed from the root of1419 the working directory, and in the environment it receives the name of1420 the tool as 'GIT_GUITOOL', the name of the currently selected file as1421 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1422 the head is detached, 'CUR_BRANCH' is empty).14231424guitool.<name>.needsfile::1425 Run the tool only if a diff is selected in the GUI. It guarantees1426 that 'FILENAME' is not empty.14271428guitool.<name>.noconsole::1429 Run the command silently, without creating a window to display its1430 output.14311432guitool.<name>.norescan::1433 Don't rescan the working directory for changes after the tool1434 finishes execution.14351436guitool.<name>.confirm::1437 Show a confirmation dialog before actually running the tool.14381439guitool.<name>.argprompt::1440 Request a string argument from the user, and pass it to the tool1441 through the 'ARGS' environment variable. Since requesting an1442 argument implies confirmation, the 'confirm' option has no effect1443 if this is enabled. If the option is set to 'true', 'yes', or '1',1444 the dialog uses a built-in generic prompt; otherwise the exact1445 value of the variable is used.14461447guitool.<name>.revprompt::1448 Request a single valid revision from the user, and set the1449 'REVISION' environment variable. In other aspects this option1450 is similar to 'argprompt', and can be used together with it.14511452guitool.<name>.revunmerged::1453 Show only unmerged branches in the 'revprompt' subdialog.1454 This is useful for tools similar to merge or rebase, but not1455 for things like checkout or reset.14561457guitool.<name>.title::1458 Specifies the title to use for the prompt dialog. The default1459 is the tool name.14601461guitool.<name>.prompt::1462 Specifies the general prompt string to display at the top of1463 the dialog, before subsections for 'argprompt' and 'revprompt'.1464 The default value includes the actual command.14651466help.browser::1467 Specify the browser that will be used to display help in the1468 'web' format. See linkgit:git-help[1].14691470help.format::1471 Override the default help format used by linkgit:git-help[1].1472 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1473 the default. 'web' and 'html' are the same.14741475help.autocorrect::1476 Automatically correct and execute mistyped commands after1477 waiting for the given number of deciseconds (0.1 sec). If more1478 than one command can be deduced from the entered text, nothing1479 will be executed. If the value of this option is negative,1480 the corrected command will be executed immediately. If the1481 value is 0 - the command will be just shown but not executed.1482 This is the default.14831484help.htmlpath::1485 Specify the path where the HTML documentation resides. File system paths1486 and URLs are supported. HTML pages will be prefixed with this path when1487 help is displayed in the 'web' format. This defaults to the documentation1488 path of your Git installation.14891490http.proxy::1491 Override the HTTP proxy, normally configured using the 'http_proxy',1492 'https_proxy', and 'all_proxy' environment variables (see1493 `curl(1)`). This can be overridden on a per-remote basis; see1494 remote.<name>.proxy14951496http.cookiefile::1497 File containing previously stored cookie lines which should be used1498 in the Git http session, if they match the server. The file format1499 of the file to read cookies from should be plain HTTP headers or1500 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1501 NOTE that the file specified with http.cookiefile is only used as1502 input unless http.saveCookies is set.15031504http.savecookies::1505 If set, store cookies received during requests to the file specified by1506 http.cookiefile. Has no effect if http.cookiefile is unset.15071508http.sslVerify::1509 Whether to verify the SSL certificate when fetching or pushing1510 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1511 variable.15121513http.sslCert::1514 File containing the SSL certificate when fetching or pushing1515 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1516 variable.15171518http.sslKey::1519 File containing the SSL private key when fetching or pushing1520 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1521 variable.15221523http.sslCertPasswordProtected::1524 Enable Git's password prompt for the SSL certificate. Otherwise1525 OpenSSL will prompt the user, possibly many times, if the1526 certificate or private key is encrypted. Can be overridden by the1527 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15281529http.sslCAInfo::1530 File containing the certificates to verify the peer with when1531 fetching or pushing over HTTPS. Can be overridden by the1532 'GIT_SSL_CAINFO' environment variable.15331534http.sslCAPath::1535 Path containing files with the CA certificates to verify the peer1536 with when fetching or pushing over HTTPS. Can be overridden1537 by the 'GIT_SSL_CAPATH' environment variable.15381539http.sslTry::1540 Attempt to use AUTH SSL/TLS and encrypted data transfers1541 when connecting via regular FTP protocol. This might be needed1542 if the FTP server requires it for security reasons or you wish1543 to connect securely whenever remote FTP server supports it.1544 Default is false since it might trigger certificate verification1545 errors on misconfigured servers.15461547http.maxRequests::1548 How many HTTP requests to launch in parallel. Can be overridden1549 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15501551http.minSessions::1552 The number of curl sessions (counted across slots) to be kept across1553 requests. They will not be ended with curl_easy_cleanup() until1554 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1555 value will be capped at 1. Defaults to 1.15561557http.postBuffer::1558 Maximum size in bytes of the buffer used by smart HTTP1559 transports when POSTing data to the remote system.1560 For requests larger than this buffer size, HTTP/1.1 and1561 Transfer-Encoding: chunked is used to avoid creating a1562 massive pack file locally. Default is 1 MiB, which is1563 sufficient for most requests.15641565http.lowSpeedLimit, http.lowSpeedTime::1566 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1567 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1568 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1569 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15701571http.noEPSV::1572 A boolean which disables using of EPSV ftp command by curl.1573 This can helpful with some "poor" ftp servers which don't1574 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1575 environment variable. Default is false (curl will use EPSV).15761577http.useragent::1578 The HTTP USER_AGENT string presented to an HTTP server. The default1579 value represents the version of the client Git such as git/1.7.1.1580 This option allows you to override this value to a more common value1581 such as Mozilla/4.0. This may be necessary, for instance, if1582 connecting through a firewall that restricts HTTP connections to a set1583 of common USER_AGENT strings (but not including those like git/1.7.1).1584 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15851586http.<url>.*::1587 Any of the http.* options above can be applied selectively to some urls.1588 For a config key to match a URL, each element of the config key is1589 compared to that of the URL, in the following order:1590+1591--1592. Scheme (e.g., `https` in `https://example.com/`). This field1593 must match exactly between the config key and the URL.15941595. Host/domain name (e.g., `example.com` in `https://example.com/`).1596 This field must match exactly between the config key and the URL.15971598. Port number (e.g., `8080` in `http://example.com:8080/`).1599 This field must match exactly between the config key and the URL.1600 Omitted port numbers are automatically converted to the correct1601 default for the scheme before matching.16021603. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1604 path field of the config key must match the path field of the URL1605 either exactly or as a prefix of slash-delimited path elements. This means1606 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1607 match on a slash (`/`) boundary. Longer matches take precedence (so a config1608 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1609 key with just path `foo/`).16101611. User name (e.g., `user` in `https://user@example.com/repo.git`). If1612 the config key has a user name it must match the user name in the1613 URL exactly. If the config key does not have a user name, that1614 config key will match a URL with any user name (including none),1615 but at a lower precedence than a config key with a user name.1616--1617+1618The list above is ordered by decreasing precedence; a URL that matches1619a config key's path is preferred to one that matches its user name. For example,1620if the URL is `https://user@example.com/foo/bar` a config key match of1621`https://example.com/foo` will be preferred over a config key match of1622`https://user@example.com`.1623+1624All URLs are normalized before attempting any matching (the password part,1625if embedded in the URL, is always ignored for matching purposes) so that1626equivalent urls that are simply spelled differently will match properly.1627Environment variable settings always override any matches. The urls that are1628matched against are those given directly to Git commands. This means any URLs1629visited as a result of a redirection do not participate in matching.16301631i18n.commitEncoding::1632 Character encoding the commit messages are stored in; Git itself1633 does not care per se, but this information is necessary e.g. when1634 importing commits from emails or in the gitk graphical history1635 browser (and possibly at other places in the future or in other1636 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16371638i18n.logOutputEncoding::1639 Character encoding the commit messages are converted to when1640 running 'git log' and friends.16411642imap::1643 The configuration variables in the 'imap' section are described1644 in linkgit:git-imap-send[1].16451646index.version::1647 Specify the version with which new index files should be1648 initialized. This does not affect existing repositories.16491650init.templatedir::1651 Specify the directory from which templates will be copied.1652 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16531654instaweb.browser::1655 Specify the program that will be used to browse your working1656 repository in gitweb. See linkgit:git-instaweb[1].16571658instaweb.httpd::1659 The HTTP daemon command-line to start gitweb on your working1660 repository. See linkgit:git-instaweb[1].16611662instaweb.local::1663 If true the web server started by linkgit:git-instaweb[1] will1664 be bound to the local IP (127.0.0.1).16651666instaweb.modulepath::1667 The default module path for linkgit:git-instaweb[1] to use1668 instead of /usr/lib/apache2/modules. Only used if httpd1669 is Apache.16701671instaweb.port::1672 The port number to bind the gitweb httpd to. See1673 linkgit:git-instaweb[1].16741675interactive.singlekey::1676 In interactive commands, allow the user to provide one-letter1677 input with a single key (i.e., without hitting enter).1678 Currently this is used by the `--patch` mode of1679 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1680 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1681 setting is silently ignored if portable keystroke input1682 is not available; requires the Perl module Term::ReadKey.16831684log.abbrevCommit::1685 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1686 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1687 override this option with `--no-abbrev-commit`.16881689log.date::1690 Set the default date-time mode for the 'log' command.1691 Setting a value for log.date is similar to using 'git log''s1692 `--date` option. Possible values are `relative`, `local`,1693 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1694 for details.16951696log.decorate::1697 Print out the ref names of any commits that are shown by the log1698 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1699 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1700 specified, the full ref name (including prefix) will be printed.1701 This is the same as the log commands '--decorate' option.17021703log.showroot::1704 If true, the initial commit will be shown as a big creation event.1705 This is equivalent to a diff against an empty tree.1706 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1707 normally hide the root commit will now show it. True by default.17081709log.mailmap::1710 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1711 linkgit:git-whatchanged[1] assume `--use-mailmap`.17121713mailmap.file::1714 The location of an augmenting mailmap file. The default1715 mailmap, located in the root of the repository, is loaded1716 first, then the mailmap file pointed to by this variable.1717 The location of the mailmap file may be in a repository1718 subdirectory, or somewhere outside of the repository itself.1719 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17201721mailmap.blob::1722 Like `mailmap.file`, but consider the value as a reference to a1723 blob in the repository. If both `mailmap.file` and1724 `mailmap.blob` are given, both are parsed, with entries from1725 `mailmap.file` taking precedence. In a bare repository, this1726 defaults to `HEAD:.mailmap`. In a non-bare repository, it1727 defaults to empty.17281729man.viewer::1730 Specify the programs that may be used to display help in the1731 'man' format. See linkgit:git-help[1].17321733man.<tool>.cmd::1734 Specify the command to invoke the specified man viewer. The1735 specified command is evaluated in shell with the man page1736 passed as argument. (See linkgit:git-help[1].)17371738man.<tool>.path::1739 Override the path for the given tool that may be used to1740 display help in the 'man' format. See linkgit:git-help[1].17411742include::merge-config.txt[]17431744mergetool.<tool>.path::1745 Override the path for the given tool. This is useful in case1746 your tool is not in the PATH.17471748mergetool.<tool>.cmd::1749 Specify the command to invoke the specified merge tool. The1750 specified command is evaluated in shell with the following1751 variables available: 'BASE' is the name of a temporary file1752 containing the common base of the files to be merged, if available;1753 'LOCAL' is the name of a temporary file containing the contents of1754 the file on the current branch; 'REMOTE' is the name of a temporary1755 file containing the contents of the file from the branch being1756 merged; 'MERGED' contains the name of the file to which the merge1757 tool should write the results of a successful merge.17581759mergetool.<tool>.trustExitCode::1760 For a custom merge command, specify whether the exit code of1761 the merge command can be used to determine whether the merge was1762 successful. If this is not set to true then the merge target file1763 timestamp is checked and the merge assumed to have been successful1764 if the file has been updated, otherwise the user is prompted to1765 indicate the success of the merge.17661767mergetool.meld.hasOutput::1768 Older versions of `meld` do not support the `--output` option.1769 Git will attempt to detect whether `meld` supports `--output`1770 by inspecting the output of `meld --help`. Configuring1771 `mergetool.meld.hasOutput` will make Git skip these checks and1772 use the configured value instead. Setting `mergetool.meld.hasOutput`1773 to `true` tells Git to unconditionally use the `--output` option,1774 and `false` avoids using `--output`.17751776mergetool.keepBackup::1777 After performing a merge, the original file with conflict markers1778 can be saved as a file with a `.orig` extension. If this variable1779 is set to `false` then this file is not preserved. Defaults to1780 `true` (i.e. keep the backup files).17811782mergetool.keepTemporaries::1783 When invoking a custom merge tool, Git uses a set of temporary1784 files to pass to the tool. If the tool returns an error and this1785 variable is set to `true`, then these temporary files will be1786 preserved, otherwise they will be removed after the tool has1787 exited. Defaults to `false`.17881789mergetool.prompt::1790 Prompt before each invocation of the merge resolution program.17911792notes.displayRef::1793 The (fully qualified) refname from which to show notes when1794 showing commit messages. The value of this variable can be set1795 to a glob, in which case notes from all matching refs will be1796 shown. You may also specify this configuration variable1797 several times. A warning will be issued for refs that do not1798 exist, but a glob that does not match any refs is silently1799 ignored.1800+1801This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1802environment variable, which must be a colon separated list of refs or1803globs.1804+1805The effective value of "core.notesRef" (possibly overridden by1806GIT_NOTES_REF) is also implicitly added to the list of refs to be1807displayed.18081809notes.rewrite.<command>::1810 When rewriting commits with <command> (currently `amend` or1811 `rebase`) and this variable is set to `true`, Git1812 automatically copies your notes from the original to the1813 rewritten commit. Defaults to `true`, but see1814 "notes.rewriteRef" below.18151816notes.rewriteMode::1817 When copying notes during a rewrite (see the1818 "notes.rewrite.<command>" option), determines what to do if1819 the target commit already has a note. Must be one of1820 `overwrite`, `concatenate`, or `ignore`. Defaults to1821 `concatenate`.1822+1823This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1824environment variable.18251826notes.rewriteRef::1827 When copying notes during a rewrite, specifies the (fully1828 qualified) ref whose notes should be copied. The ref may be a1829 glob, in which case notes in all matching refs will be copied.1830 You may also specify this configuration several times.1831+1832Does not have a default value; you must configure this variable to1833enable note rewriting. Set it to `refs/notes/commits` to enable1834rewriting for the default commit notes.1835+1836This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1837environment variable, which must be a colon separated list of refs or1838globs.18391840pack.window::1841 The size of the window used by linkgit:git-pack-objects[1] when no1842 window size is given on the command line. Defaults to 10.18431844pack.depth::1845 The maximum delta depth used by linkgit:git-pack-objects[1] when no1846 maximum depth is given on the command line. Defaults to 50.18471848pack.windowMemory::1849 The window memory size limit used by linkgit:git-pack-objects[1]1850 when no limit is given on the command line. The value can be1851 suffixed with "k", "m", or "g". Defaults to 0, meaning no1852 limit.18531854pack.compression::1855 An integer -1..9, indicating the compression level for objects1856 in a pack file. -1 is the zlib default. 0 means no1857 compression, and 1..9 are various speed/size tradeoffs, 9 being1858 slowest. If not set, defaults to core.compression. If that is1859 not set, defaults to -1, the zlib default, which is "a default1860 compromise between speed and compression (currently equivalent1861 to level 6)."1862+1863Note that changing the compression level will not automatically recompress1864all existing objects. You can force recompression by passing the -F option1865to linkgit:git-repack[1].18661867pack.deltaCacheSize::1868 The maximum memory in bytes used for caching deltas in1869 linkgit:git-pack-objects[1] before writing them out to a pack.1870 This cache is used to speed up the writing object phase by not1871 having to recompute the final delta result once the best match1872 for all objects is found. Repacking large repositories on machines1873 which are tight with memory might be badly impacted by this though,1874 especially if this cache pushes the system into swapping.1875 A value of 0 means no limit. The smallest size of 1 byte may be1876 used to virtually disable this cache. Defaults to 256 MiB.18771878pack.deltaCacheLimit::1879 The maximum size of a delta, that is cached in1880 linkgit:git-pack-objects[1]. This cache is used to speed up the1881 writing object phase by not having to recompute the final delta1882 result once the best match for all objects is found. Defaults to 1000.18831884pack.threads::1885 Specifies the number of threads to spawn when searching for best1886 delta matches. This requires that linkgit:git-pack-objects[1]1887 be compiled with pthreads otherwise this option is ignored with a1888 warning. This is meant to reduce packing time on multiprocessor1889 machines. The required amount of memory for the delta search window1890 is however multiplied by the number of threads.1891 Specifying 0 will cause Git to auto-detect the number of CPU's1892 and set the number of threads accordingly.18931894pack.indexVersion::1895 Specify the default pack index version. Valid values are 1 for1896 legacy pack index used by Git versions prior to 1.5.2, and 2 for1897 the new pack index with capabilities for packs larger than 4 GB1898 as well as proper protection against the repacking of corrupted1899 packs. Version 2 is the default. Note that version 2 is enforced1900 and this config option ignored whenever the corresponding pack is1901 larger than 2 GB.1902+1903If you have an old Git that does not understand the version 2 `*.idx` file,1904cloning or fetching over a non native protocol (e.g. "http" and "rsync")1905that will copy both `*.pack` file and corresponding `*.idx` file from the1906other side may give you a repository that cannot be accessed with your1907older version of Git. If the `*.pack` file is smaller than 2 GB, however,1908you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1909the `*.idx` file.19101911pack.packSizeLimit::1912 The maximum size of a pack. This setting only affects1913 packing to a file when repacking, i.e. the git:// protocol1914 is unaffected. It can be overridden by the `--max-pack-size`1915 option of linkgit:git-repack[1]. The minimum size allowed is1916 limited to 1 MiB. The default is unlimited.1917 Common unit suffixes of 'k', 'm', or 'g' are1918 supported.19191920pack.useBitmaps::1921 When true, git will use pack bitmaps (if available) when packing1922 to stdout (e.g., during the server side of a fetch). Defaults to1923 true. You should not generally need to turn this off unless1924 you are debugging pack bitmaps.19251926pack.writebitmaps::1927 This is a deprecated synonym for `repack.writeBitmaps`.19281929pack.writeBitmapHashCache::1930 When true, git will include a "hash cache" section in the bitmap1931 index (if one is written). This cache can be used to feed git's1932 delta heuristics, potentially leading to better deltas between1933 bitmapped and non-bitmapped objects (e.g., when serving a fetch1934 between an older, bitmapped pack and objects that have been1935 pushed since the last gc). The downside is that it consumes 41936 bytes per object of disk space, and that JGit's bitmap1937 implementation does not understand it, causing it to complain if1938 Git and JGit are used on the same repository. Defaults to false.19391940pager.<cmd>::1941 If the value is boolean, turns on or off pagination of the1942 output of a particular Git subcommand when writing to a tty.1943 Otherwise, turns on pagination for the subcommand using the1944 pager specified by the value of `pager.<cmd>`. If `--paginate`1945 or `--no-pager` is specified on the command line, it takes1946 precedence over this option. To disable pagination for all1947 commands, set `core.pager` or `GIT_PAGER` to `cat`.19481949pretty.<name>::1950 Alias for a --pretty= format string, as specified in1951 linkgit:git-log[1]. Any aliases defined here can be used just1952 as the built-in pretty formats could. For example,1953 running `git config pretty.changelog "format:* %H %s"`1954 would cause the invocation `git log --pretty=changelog`1955 to be equivalent to running `git log "--pretty=format:* %H %s"`.1956 Note that an alias with the same name as a built-in format1957 will be silently ignored.19581959pull.ff::1960 By default, Git does not create an extra merge commit when merging1961 a commit that is a descendant of the current commit. Instead, the1962 tip of the current branch is fast-forwarded. When set to `false`,1963 this variable tells Git to create an extra merge commit in such1964 a case (equivalent to giving the `--no-ff` option from the command1965 line). When set to `only`, only such fast-forward merges are1966 allowed (equivalent to giving the `--ff-only` option from the1967 command line).19681969pull.rebase::1970 When true, rebase branches on top of the fetched branch, instead1971 of merging the default branch from the default remote when "git1972 pull" is run. See "branch.<name>.rebase" for setting this on a1973 per-branch basis.1974+1975 When preserve, also pass `--preserve-merges` along to 'git rebase'1976 so that locally committed merge commits will not be flattened1977 by running 'git pull'.1978+1979*NOTE*: this is a possibly dangerous operation; do *not* use1980it unless you understand the implications (see linkgit:git-rebase[1]1981for details).19821983pull.octopus::1984 The default merge strategy to use when pulling multiple branches1985 at once.19861987pull.twohead::1988 The default merge strategy to use when pulling a single branch.19891990push.default::1991 Defines the action `git push` should take if no refspec is1992 explicitly given. Different values are well-suited for1993 specific workflows; for instance, in a purely central workflow1994 (i.e. the fetch source is equal to the push destination),1995 `upstream` is probably what you want. Possible values are:1996+1997--19981999* `nothing` - do not push anything (error out) unless a refspec is2000 explicitly given. This is primarily meant for people who want to2001 avoid mistakes by always being explicit.20022003* `current` - push the current branch to update a branch with the same2004 name on the receiving end. Works in both central and non-central2005 workflows.20062007* `upstream` - push the current branch back to the branch whose2008 changes are usually integrated into the current branch (which is2009 called `@{upstream}`). This mode only makes sense if you are2010 pushing to the same repository you would normally pull from2011 (i.e. central workflow).20122013* `simple` - in centralized workflow, work like `upstream` with an2014 added safety to refuse to push if the upstream branch's name is2015 different from the local one.2016+2017When pushing to a remote that is different from the remote you normally2018pull from, work as `current`. This is the safest option and is suited2019for beginners.2020+2021This mode has become the default in Git 2.0.20222023* `matching` - push all branches having the same name on both ends.2024 This makes the repository you are pushing to remember the set of2025 branches that will be pushed out (e.g. if you always push 'maint'2026 and 'master' there and no other branches, the repository you push2027 to will have these two branches, and your local 'maint' and2028 'master' will be pushed there).2029+2030To use this mode effectively, you have to make sure _all_ the2031branches you would push out are ready to be pushed out before2032running 'git push', as the whole point of this mode is to allow you2033to push all of the branches in one go. If you usually finish work2034on only one branch and push out the result, while other branches are2035unfinished, this mode is not for you. Also this mode is not2036suitable for pushing into a shared central repository, as other2037people may add new branches there, or update the tip of existing2038branches outside your control.2039+2040This used to be the default, but not since Git 2.0 (`simple` is the2041new default).20422043--20442045rebase.stat::2046 Whether to show a diffstat of what changed upstream since the last2047 rebase. False by default.20482049rebase.autosquash::2050 If set to true enable '--autosquash' option by default.20512052rebase.autostash::2053 When set to true, automatically create a temporary stash2054 before the operation begins, and apply it after the operation2055 ends. This means that you can run rebase on a dirty worktree.2056 However, use with care: the final stash application after a2057 successful rebase might result in non-trivial conflicts.2058 Defaults to false.20592060receive.autogc::2061 By default, git-receive-pack will run "git-gc --auto" after2062 receiving data from git-push and updating refs. You can stop2063 it by setting this variable to false.20642065receive.fsckObjects::2066 If it is set to true, git-receive-pack will check all received2067 objects. It will abort in the case of a malformed object or a2068 broken link. The result of an abort are only dangling objects.2069 Defaults to false. If not set, the value of `transfer.fsckObjects`2070 is used instead.20712072receive.unpackLimit::2073 If the number of objects received in a push is below this2074 limit then the objects will be unpacked into loose object2075 files. However if the number of received objects equals or2076 exceeds this limit then the received pack will be stored as2077 a pack, after adding any missing delta bases. Storing the2078 pack from a push can make the push operation complete faster,2079 especially on slow filesystems. If not set, the value of2080 `transfer.unpackLimit` is used instead.20812082receive.denyDeletes::2083 If set to true, git-receive-pack will deny a ref update that deletes2084 the ref. Use this to prevent such a ref deletion via a push.20852086receive.denyDeleteCurrent::2087 If set to true, git-receive-pack will deny a ref update that2088 deletes the currently checked out branch of a non-bare repository.20892090receive.denyCurrentBranch::2091 If set to true or "refuse", git-receive-pack will deny a ref update2092 to the currently checked out branch of a non-bare repository.2093 Such a push is potentially dangerous because it brings the HEAD2094 out of sync with the index and working tree. If set to "warn",2095 print a warning of such a push to stderr, but allow the push to2096 proceed. If set to false or "ignore", allow such pushes with no2097 message. Defaults to "refuse".20982099receive.denyNonFastForwards::2100 If set to true, git-receive-pack will deny a ref update which is2101 not a fast-forward. Use this to prevent such an update via a push,2102 even if that push is forced. This configuration variable is2103 set when initializing a shared repository.21042105receive.hiderefs::2106 String(s) `receive-pack` uses to decide which refs to omit2107 from its initial advertisement. Use more than one2108 definitions to specify multiple prefix strings. A ref that2109 are under the hierarchies listed on the value of this2110 variable is excluded, and is hidden when responding to `git2111 push`, and an attempt to update or delete a hidden ref by2112 `git push` is rejected.21132114receive.updateserverinfo::2115 If set to true, git-receive-pack will run git-update-server-info2116 after receiving data from git-push and updating refs.21172118receive.shallowupdate::2119 If set to true, .git/shallow can be updated when new refs2120 require new shallow roots. Otherwise those refs are rejected.21212122remote.pushdefault::2123 The remote to push to by default. Overrides2124 `branch.<name>.remote` for all branches, and is overridden by2125 `branch.<name>.pushremote` for specific branches.21262127remote.<name>.url::2128 The URL of a remote repository. See linkgit:git-fetch[1] or2129 linkgit:git-push[1].21302131remote.<name>.pushurl::2132 The push URL of a remote repository. See linkgit:git-push[1].21332134remote.<name>.proxy::2135 For remotes that require curl (http, https and ftp), the URL to2136 the proxy to use for that remote. Set to the empty string to2137 disable proxying for that remote.21382139remote.<name>.fetch::2140 The default set of "refspec" for linkgit:git-fetch[1]. See2141 linkgit:git-fetch[1].21422143remote.<name>.push::2144 The default set of "refspec" for linkgit:git-push[1]. See2145 linkgit:git-push[1].21462147remote.<name>.mirror::2148 If true, pushing to this remote will automatically behave2149 as if the `--mirror` option was given on the command line.21502151remote.<name>.skipDefaultUpdate::2152 If true, this remote will be skipped by default when updating2153 using linkgit:git-fetch[1] or the `update` subcommand of2154 linkgit:git-remote[1].21552156remote.<name>.skipFetchAll::2157 If true, this remote will be skipped by default when updating2158 using linkgit:git-fetch[1] or the `update` subcommand of2159 linkgit:git-remote[1].21602161remote.<name>.receivepack::2162 The default program to execute on the remote side when pushing. See2163 option \--receive-pack of linkgit:git-push[1].21642165remote.<name>.uploadpack::2166 The default program to execute on the remote side when fetching. See2167 option \--upload-pack of linkgit:git-fetch-pack[1].21682169remote.<name>.tagopt::2170 Setting this value to \--no-tags disables automatic tag following when2171 fetching from remote <name>. Setting it to \--tags will fetch every2172 tag from remote <name>, even if they are not reachable from remote2173 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2174 override this setting. See options \--tags and \--no-tags of2175 linkgit:git-fetch[1].21762177remote.<name>.vcs::2178 Setting this to a value <vcs> will cause Git to interact with2179 the remote with the git-remote-<vcs> helper.21802181remote.<name>.prune::2182 When set to true, fetching from this remote by default will also2183 remove any remote-tracking references that no longer exist on the2184 remote (as if the `--prune` option was given on the command line).2185 Overrides `fetch.prune` settings, if any.21862187remotes.<group>::2188 The list of remotes which are fetched by "git remote update2189 <group>". See linkgit:git-remote[1].21902191repack.usedeltabaseoffset::2192 By default, linkgit:git-repack[1] creates packs that use2193 delta-base offset. If you need to share your repository with2194 Git older than version 1.4.4, either directly or via a dumb2195 protocol such as http, then you need to set this option to2196 "false" and repack. Access from old Git versions over the2197 native protocol are unaffected by this option.21982199repack.packKeptObjects::2200 If set to true, makes `git repack` act as if2201 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2202 details. Defaults to `false` normally, but `true` if a bitmap2203 index is being written (either via `--write-bitmap-index` or2204 `repack.writeBitmaps`).22052206repack.writeBitmaps::2207 When true, git will write a bitmap index when packing all2208 objects to disk (e.g., when `git repack -a` is run). This2209 index can speed up the "counting objects" phase of subsequent2210 packs created for clones and fetches, at the cost of some disk2211 space and extra time spent on the initial repack. Defaults to2212 false.22132214rerere.autoupdate::2215 When set to true, `git-rerere` updates the index with the2216 resulting contents after it cleanly resolves conflicts using2217 previously recorded resolution. Defaults to false.22182219rerere.enabled::2220 Activate recording of resolved conflicts, so that identical2221 conflict hunks can be resolved automatically, should they be2222 encountered again. By default, linkgit:git-rerere[1] is2223 enabled if there is an `rr-cache` directory under the2224 `$GIT_DIR`, e.g. if "rerere" was previously used in the2225 repository.22262227sendemail.identity::2228 A configuration identity. When given, causes values in the2229 'sendemail.<identity>' subsection to take precedence over2230 values in the 'sendemail' section. The default identity is2231 the value of 'sendemail.identity'.22322233sendemail.smtpencryption::2234 See linkgit:git-send-email[1] for description. Note that this2235 setting is not subject to the 'identity' mechanism.22362237sendemail.smtpssl::2238 Deprecated alias for 'sendemail.smtpencryption = ssl'.22392240sendemail.smtpsslcertpath::2241 Path to ca-certificates (either a directory or a single file).2242 Set it to an empty string to disable certificate verification.22432244sendemail.<identity>.*::2245 Identity-specific versions of the 'sendemail.*' parameters2246 found below, taking precedence over those when the this2247 identity is selected, through command-line or2248 'sendemail.identity'.22492250sendemail.aliasesfile::2251sendemail.aliasfiletype::2252sendemail.annotate::2253sendemail.bcc::2254sendemail.cc::2255sendemail.cccmd::2256sendemail.chainreplyto::2257sendemail.confirm::2258sendemail.envelopesender::2259sendemail.from::2260sendemail.multiedit::2261sendemail.signedoffbycc::2262sendemail.smtppass::2263sendemail.suppresscc::2264sendemail.suppressfrom::2265sendemail.to::2266sendemail.smtpdomain::2267sendemail.smtpserver::2268sendemail.smtpserverport::2269sendemail.smtpserveroption::2270sendemail.smtpuser::2271sendemail.thread::2272sendemail.validate::2273 See linkgit:git-send-email[1] for description.22742275sendemail.signedoffcc::2276 Deprecated alias for 'sendemail.signedoffbycc'.22772278showbranch.default::2279 The default set of branches for linkgit:git-show-branch[1].2280 See linkgit:git-show-branch[1].22812282status.relativePaths::2283 By default, linkgit:git-status[1] shows paths relative to the2284 current directory. Setting this variable to `false` shows paths2285 relative to the repository root (this was the default for Git2286 prior to v1.5.4).22872288status.short::2289 Set to true to enable --short by default in linkgit:git-status[1].2290 The option --no-short takes precedence over this variable.22912292status.branch::2293 Set to true to enable --branch by default in linkgit:git-status[1].2294 The option --no-branch takes precedence over this variable.22952296status.displayCommentPrefix::2297 If set to true, linkgit:git-status[1] will insert a comment2298 prefix before each output line (starting with2299 `core.commentChar`, i.e. `#` by default). This was the2300 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2301 Defaults to false.23022303status.showUntrackedFiles::2304 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2305 files which are not currently tracked by Git. Directories which2306 contain only untracked files, are shown with the directory name2307 only. Showing untracked files means that Git needs to lstat() all2308 the files in the whole repository, which might be slow on some2309 systems. So, this variable controls how the commands displays2310 the untracked files. Possible values are:2311+2312--2313* `no` - Show no untracked files.2314* `normal` - Show untracked files and directories.2315* `all` - Show also individual files in untracked directories.2316--2317+2318If this variable is not specified, it defaults to 'normal'.2319This variable can be overridden with the -u|--untracked-files option2320of linkgit:git-status[1] and linkgit:git-commit[1].23212322status.submodulesummary::2323 Defaults to false.2324 If this is set to a non zero number or true (identical to -1 or an2325 unlimited number), the submodule summary will be enabled and a2326 summary of commits for modified submodules will be shown (see2327 --summary-limit option of linkgit:git-submodule[1]). Please note2328 that the summary output command will be suppressed for all2329 submodules when `diff.ignoreSubmodules` is set to 'all' or only2330 for those submodules where `submodule.<name>.ignore=all`. The only2331 exception to that rule is that status and commit will show staged2332 submodule changes. To2333 also view the summary for ignored submodules you can either use2334 the --ignore-submodules=dirty command-line option or the 'git2335 submodule summary' command, which shows a similar output but does2336 not honor these settings.23372338submodule.<name>.path::2339submodule.<name>.url::2340submodule.<name>.update::2341 The path within this project, URL, and the updating strategy2342 for a submodule. These variables are initially populated2343 by 'git submodule init'; edit them to override the2344 URL and other values found in the `.gitmodules` file. See2345 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.23462347submodule.<name>.branch::2348 The remote branch name for a submodule, used by `git submodule2349 update --remote`. Set this option to override the value found in2350 the `.gitmodules` file. See linkgit:git-submodule[1] and2351 linkgit:gitmodules[5] for details.23522353submodule.<name>.fetchRecurseSubmodules::2354 This option can be used to control recursive fetching of this2355 submodule. It can be overridden by using the --[no-]recurse-submodules2356 command-line option to "git fetch" and "git pull".2357 This setting will override that from in the linkgit:gitmodules[5]2358 file.23592360submodule.<name>.ignore::2361 Defines under what circumstances "git status" and the diff family show2362 a submodule as modified. When set to "all", it will never be considered2363 modified (but it will nonetheless show up in the output of status and2364 commit when it has been staged), "dirty" will ignore all changes2365 to the submodules work tree and2366 takes only differences between the HEAD of the submodule and the commit2367 recorded in the superproject into account. "untracked" will additionally2368 let submodules with modified tracked files in their work tree show up.2369 Using "none" (the default when this option is not set) also shows2370 submodules that have untracked files in their work tree as changed.2371 This setting overrides any setting made in .gitmodules for this submodule,2372 both settings can be overridden on the command line by using the2373 "--ignore-submodules" option. The 'git submodule' commands are not2374 affected by this setting.23752376tag.sort::2377 This variable controls the sort ordering of tags when displayed by2378 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2379 value of this variable will be used as the default.23802381tar.umask::2382 This variable can be used to restrict the permission bits of2383 tar archive entries. The default is 0002, which turns off the2384 world write bit. The special value "user" indicates that the2385 archiving user's umask will be used instead. See umask(2) and2386 linkgit:git-archive[1].23872388transfer.fsckObjects::2389 When `fetch.fsckObjects` or `receive.fsckObjects` are2390 not set, the value of this variable is used instead.2391 Defaults to false.23922393transfer.hiderefs::2394 This variable can be used to set both `receive.hiderefs`2395 and `uploadpack.hiderefs` at the same time to the same2396 values. See entries for these other variables.23972398transfer.unpackLimit::2399 When `fetch.unpackLimit` or `receive.unpackLimit` are2400 not set, the value of this variable is used instead.2401 The default value is 100.24022403uploadarchive.allowUnreachable::2404 If true, allow clients to use `git archive --remote` to request2405 any tree, whether reachable from the ref tips or not. See the2406 discussion in the `SECURITY` section of2407 linkgit:git-upload-archive[1] for more details. Defaults to2408 `false`.24092410uploadpack.hiderefs::2411 String(s) `upload-pack` uses to decide which refs to omit2412 from its initial advertisement. Use more than one2413 definitions to specify multiple prefix strings. A ref that2414 are under the hierarchies listed on the value of this2415 variable is excluded, and is hidden from `git ls-remote`,2416 `git fetch`, etc. An attempt to fetch a hidden ref by `git2417 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.24182419uploadpack.allowtipsha1inwant::2420 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2421 to accept a fetch request that asks for an object at the tip2422 of a hidden ref (by default, such a request is rejected).2423 see also `uploadpack.hiderefs`.24242425uploadpack.keepalive::2426 When `upload-pack` has started `pack-objects`, there may be a2427 quiet period while `pack-objects` prepares the pack. Normally2428 it would output progress information, but if `--quiet` was used2429 for the fetch, `pack-objects` will output nothing at all until2430 the pack data begins. Some clients and networks may consider2431 the server to be hung and give up. Setting this option instructs2432 `upload-pack` to send an empty keepalive packet every2433 `uploadpack.keepalive` seconds. Setting this option to 02434 disables keepalive packets entirely. The default is 5 seconds.24352436url.<base>.insteadOf::2437 Any URL that starts with this value will be rewritten to2438 start, instead, with <base>. In cases where some site serves a2439 large number of repositories, and serves them with multiple2440 access methods, and some users need to use different access2441 methods, this feature allows people to specify any of the2442 equivalent URLs and have Git automatically rewrite the URL to2443 the best alternative for the particular user, even for a2444 never-before-seen repository on the site. When more than one2445 insteadOf strings match a given URL, the longest match is used.24462447url.<base>.pushInsteadOf::2448 Any URL that starts with this value will not be pushed to;2449 instead, it will be rewritten to start with <base>, and the2450 resulting URL will be pushed to. In cases where some site serves2451 a large number of repositories, and serves them with multiple2452 access methods, some of which do not allow push, this feature2453 allows people to specify a pull-only URL and have Git2454 automatically use an appropriate URL to push, even for a2455 never-before-seen repository on the site. When more than one2456 pushInsteadOf strings match a given URL, the longest match is2457 used. If a remote has an explicit pushurl, Git will ignore this2458 setting for that remote.24592460user.email::2461 Your email address to be recorded in any newly created commits.2462 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2463 'EMAIL' environment variables. See linkgit:git-commit-tree[1].24642465user.name::2466 Your full name to be recorded in any newly created commits.2467 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2468 environment variables. See linkgit:git-commit-tree[1].24692470user.signingkey::2471 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2472 key you want it to automatically when creating a signed tag or2473 commit, you can override the default selection with this variable.2474 This option is passed unchanged to gpg's --local-user parameter,2475 so you may specify a key using any method that gpg supports.24762477web.browser::2478 Specify a web browser that may be used by some commands.2479 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2480 may use it.