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). No other char escape sequence, nor octal 82char sequences are valid. 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. You will find a description of non-core 135porcelain configuration variables in the respective porcelain documentation. 136 137advice.*:: 138 These variables control various optional help messages designed to 139 aid new users. All 'advice.*' variables default to 'true', and you 140 can tell Git that you do not need help by setting these to 'false': 141+ 142-- 143 pushUpdateRejected:: 144 Set this variable to 'false' if you want to disable 145 'pushNonFFCurrent', 'pushNonFFDefault', 146 'pushNonFFMatching', 'pushAlreadyExists', 147 'pushFetchFirst', and 'pushNeedsForce' 148 simultaneously. 149 pushNonFFCurrent:: 150 Advice shown when linkgit:git-push[1] fails due to a 151 non-fast-forward update to the current branch. 152 pushNonFFDefault:: 153 Advice to set 'push.default' to 'upstream' or 'current' 154 when you ran linkgit:git-push[1] and pushed 'matching 155 refs' by default (i.e. you did not provide an explicit 156 refspec, and no 'push.default' configuration was set) 157 and it resulted in a non-fast-forward error. 158 pushNonFFMatching:: 159 Advice shown when you ran linkgit:git-push[1] and pushed 160 'matching refs' explicitly (i.e. you used ':', or 161 specified a refspec that isn't your current branch) and 162 it resulted in a non-fast-forward error. 163 pushAlreadyExists:: 164 Shown when linkgit:git-push[1] rejects an update that 165 does not qualify for fast-forwarding (e.g., a tag.) 166 pushFetchFirst:: 167 Shown when linkgit:git-push[1] rejects an update that 168 tries to overwrite a remote ref that points at an 169 object we do not have. 170 pushNeedsForce:: 171 Shown when linkgit:git-push[1] rejects an update that 172 tries to overwrite a remote ref that points at an 173 object that is not a commit-ish, or make the remote 174 ref point at an object that is not a commit-ish. 175 statusHints:: 176 Show directions on how to proceed from the current 177 state in the output of linkgit:git-status[1], in 178 the template shown when writing commit messages in 179 linkgit:git-commit[1], and in the help message shown 180 by linkgit:git-checkout[1] when switching branch. 181 statusUoption:: 182 Advise to consider using the `-u` option to linkgit:git-status[1] 183 when the command takes more than 2 seconds to enumerate untracked 184 files. 185 commitBeforeMerge:: 186 Advice shown when linkgit:git-merge[1] refuses to 187 merge to avoid overwriting local changes. 188 resolveConflict:: 189 Advice shown by various commands when conflicts 190 prevent the operation from being performed. 191 implicitIdentity:: 192 Advice on how to set your identity configuration when 193 your information is guessed from the system username and 194 domain name. 195 detachedHead:: 196 Advice shown when you used linkgit:git-checkout[1] to 197 move to the detach HEAD state, to instruct how to create 198 a local branch after the fact. 199 amWorkDir:: 200 Advice that shows the location of the patch file when 201 linkgit:git-am[1] fails to apply it. 202 rmHints:: 203 In case of failure in the output of linkgit:git-rm[1], 204 show directions on how to proceed from the current state. 205-- 206 207core.fileMode:: 208 If false, the executable bit differences between the index and 209 the working tree are ignored; useful on broken filesystems like FAT. 210 See linkgit:git-update-index[1]. 211+ 212The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 213will probe and set core.fileMode false if appropriate when the 214repository is created. 215 216core.ignorecase:: 217 If true, this option enables various workarounds to enable 218 Git to work better on filesystems that are not case sensitive, 219 like FAT. For example, if a directory listing finds 220 "makefile" when Git expects "Makefile", Git will assume 221 it is really the same file, and continue to remember it as 222 "Makefile". 223+ 224The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 225will probe and set core.ignorecase true if appropriate when the repository 226is created. 227 228core.precomposeunicode:: 229 This option is only used by Mac OS implementation of Git. 230 When core.precomposeunicode=true, Git reverts the unicode decomposition 231 of filenames done by Mac OS. This is useful when sharing a repository 232 between Mac OS and Linux or Windows. 233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 234 When false, file names are handled fully transparent by Git, 235 which is backward compatible with older versions of Git. 236 237core.trustctime:: 238 If false, the ctime differences between the index and the 239 working tree are ignored; useful when the inode change time 240 is regularly modified by something outside Git (file system 241 crawlers and some backup systems). 242 See linkgit:git-update-index[1]. True by default. 243 244core.checkstat:: 245 Determines which stat fields to match between the index 246 and work tree. The user can set this to 'default' or 247 'minimal'. Default (or explicitly 'default'), is to check 248 all fields, including the sub-second part of mtime and ctime. 249 250core.quotepath:: 251 The commands that output paths (e.g. 'ls-files', 252 'diff'), when not given the `-z` option, will quote 253 "unusual" characters in the pathname by enclosing the 254 pathname in a double-quote pair and with backslashes the 255 same way strings in C source code are quoted. If this 256 variable is set to false, the bytes higher than 0x80 are 257 not quoted but output as verbatim. Note that double 258 quote, backslash and control characters are always 259 quoted without `-z` regardless of the setting of this 260 variable. 261 262core.eol:: 263 Sets the line ending type to use in the working directory for 264 files that have the `text` property set. Alternatives are 265 'lf', 'crlf' and 'native', which uses the platform's native 266 line ending. The default value is `native`. See 267 linkgit:gitattributes[5] for more information on end-of-line 268 conversion. 269 270core.safecrlf:: 271 If true, makes Git check if converting `CRLF` is reversible when 272 end-of-line conversion is active. Git will verify if a command 273 modifies a file in the work tree either directly or indirectly. 274 For example, committing a file followed by checking out the 275 same file should yield the original file in the work tree. If 276 this is not the case for the current setting of 277 `core.autocrlf`, Git will reject the file. The variable can 278 be set to "warn", in which case Git will only warn about an 279 irreversible conversion but continue the operation. 280+ 281CRLF conversion bears a slight chance of corrupting data. 282When it is enabled, Git will convert CRLF to LF during commit and LF to 283CRLF during checkout. A file that contains a mixture of LF and 284CRLF before the commit cannot be recreated by Git. For text 285files this is the right thing to do: it corrects line endings 286such that we have only LF line endings in the repository. 287But for binary files that are accidentally classified as text the 288conversion can corrupt data. 289+ 290If you recognize such corruption early you can easily fix it by 291setting the conversion type explicitly in .gitattributes. Right 292after committing you still have the original file in your work 293tree and this file is not yet corrupted. You can explicitly tell 294Git that this file is binary and Git will handle the file 295appropriately. 296+ 297Unfortunately, the desired effect of cleaning up text files with 298mixed line endings and the undesired effect of corrupting binary 299files cannot be distinguished. In both cases CRLFs are removed 300in an irreversible way. For text files this is the right thing 301to do because CRLFs are line endings, while for binary files 302converting CRLFs corrupts data. 303+ 304Note, this safety check does not mean that a checkout will generate a 305file identical to the original file for a different setting of 306`core.eol` and `core.autocrlf`, but only for the current one. For 307example, a text file with `LF` would be accepted with `core.eol=lf` 308and could later be checked out with `core.eol=crlf`, in which case the 309resulting file would contain `CRLF`, although the original file 310contained `LF`. However, in both work trees the line endings would be 311consistent, that is either all `LF` or all `CRLF`, but never mixed. A 312file with mixed line endings would be reported by the `core.safecrlf` 313mechanism. 314 315core.autocrlf:: 316 Setting this variable to "true" is almost the same as setting 317 the `text` attribute to "auto" on all files except that text 318 files are not guaranteed to be normalized: files that contain 319 `CRLF` in the repository will not be touched. Use this 320 setting if you want to have `CRLF` line endings in your 321 working directory even though the repository does not have 322 normalized line endings. This variable can be set to 'input', 323 in which case no output conversion is performed. 324 325core.symlinks:: 326 If false, symbolic links are checked out as small plain files that 327 contain the link text. linkgit:git-update-index[1] and 328 linkgit:git-add[1] will not change the recorded type to regular 329 file. Useful on filesystems like FAT that do not support 330 symbolic links. 331+ 332The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 333will probe and set core.symlinks false if appropriate when the repository 334is created. 335 336core.gitProxy:: 337 A "proxy command" to execute (as 'command host port') instead 338 of establishing direct connection to the remote server when 339 using the Git protocol for fetching. If the variable value is 340 in the "COMMAND for DOMAIN" format, the command is applied only 341 on hostnames ending with the specified domain string. This variable 342 may be set multiple times and is matched in the given order; 343 the first match wins. 344+ 345Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 346(which always applies universally, without the special "for" 347handling). 348+ 349The special string `none` can be used as the proxy command to 350specify that no proxy be used for a given domain pattern. 351This is useful for excluding servers inside a firewall from 352proxy use, while defaulting to a common proxy for external domains. 353 354core.ignoreStat:: 355 If true, commands which modify both the working tree and the index 356 will mark the updated paths with the "assume unchanged" bit in the 357 index. These marked files are then assumed to stay unchanged in the 358 working tree, until you mark them otherwise manually - Git will not 359 detect the file changes by lstat() calls. This is useful on systems 360 where those are very slow, such as Microsoft Windows. 361 See linkgit:git-update-index[1]. 362 False by default. 363 364core.preferSymlinkRefs:: 365 Instead of the default "symref" format for HEAD 366 and other symbolic reference files, use symbolic links. 367 This is sometimes needed to work with old scripts that 368 expect HEAD to be a symbolic link. 369 370core.bare:: 371 If true this repository is assumed to be 'bare' and has no 372 working directory associated with it. If this is the case a 373 number of commands that require a working directory will be 374 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 375+ 376This setting is automatically guessed by linkgit:git-clone[1] or 377linkgit:git-init[1] when the repository was created. By default a 378repository that ends in "/.git" is assumed to be not bare (bare = 379false), while all other repositories are assumed to be bare (bare 380= true). 381 382core.worktree:: 383 Set the path to the root of the working tree. 384 This can be overridden by the GIT_WORK_TREE environment 385 variable and the '--work-tree' command line option. 386 The value can be an absolute path or relative to the path to 387 the .git directory, which is either specified by --git-dir 388 or GIT_DIR, or automatically discovered. 389 If --git-dir or GIT_DIR is specified but none of 390 --work-tree, GIT_WORK_TREE and core.worktree is specified, 391 the current working directory is regarded as the top level 392 of your working tree. 393+ 394Note that this variable is honored even when set in a configuration 395file in a ".git" subdirectory of a directory and its value differs 396from the latter directory (e.g. "/path/to/.git/config" has 397core.worktree set to "/different/path"), which is most likely a 398misconfiguration. Running Git commands in the "/path/to" directory will 399still use "/different/path" as the root of the work tree and can cause 400confusion unless you know what you are doing (e.g. you are creating a 401read-only snapshot of the same index to a location different from the 402repository's usual working tree). 403 404core.logAllRefUpdates:: 405 Enable the reflog. Updates to a ref <ref> is logged to the file 406 "$GIT_DIR/logs/<ref>", by appending the new and old 407 SHA-1, the date/time and the reason of the update, but 408 only when the file exists. If this configuration 409 variable is set to true, missing "$GIT_DIR/logs/<ref>" 410 file is automatically created for branch heads (i.e. under 411 refs/heads/), remote refs (i.e. under refs/remotes/), 412 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 413+ 414This information can be used to determine what commit 415was the tip of a branch "2 days ago". 416+ 417This value is true by default in a repository that has 418a working directory associated with it, and false by 419default in a bare repository. 420 421core.repositoryFormatVersion:: 422 Internal variable identifying the repository format and layout 423 version. 424 425core.sharedRepository:: 426 When 'group' (or 'true'), the repository is made shareable between 427 several users in a group (making sure all the files and objects are 428 group-writable). When 'all' (or 'world' or 'everybody'), the 429 repository will be readable by all users, additionally to being 430 group-shareable. When 'umask' (or 'false'), Git will use permissions 431 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 432 files in the repository will have this mode value. '0xxx' will override 433 user's umask value (whereas the other options will only override 434 requested parts of the user's umask value). Examples: '0660' will make 435 the repo read/write-able for the owner and group, but inaccessible to 436 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 437 repository that is group-readable but not group-writable. 438 See linkgit:git-init[1]. False by default. 439 440core.warnAmbiguousRefs:: 441 If true, Git will warn you if the ref name you passed it is ambiguous 442 and might match multiple refs in the repository. True by default. 443 444core.compression:: 445 An integer -1..9, indicating a default compression level. 446 -1 is the zlib default. 0 means no compression, 447 and 1..9 are various speed/size tradeoffs, 9 being slowest. 448 If set, this provides a default to other compression variables, 449 such as 'core.loosecompression' and 'pack.compression'. 450 451core.loosecompression:: 452 An integer -1..9, indicating the compression level for objects that 453 are not in a pack file. -1 is the zlib default. 0 means no 454 compression, and 1..9 are various speed/size tradeoffs, 9 being 455 slowest. If not set, defaults to core.compression. If that is 456 not set, defaults to 1 (best speed). 457 458core.packedGitWindowSize:: 459 Number of bytes of a pack file to map into memory in a 460 single mapping operation. Larger window sizes may allow 461 your system to process a smaller number of large pack files 462 more quickly. Smaller window sizes will negatively affect 463 performance due to increased calls to the operating system's 464 memory manager, but may improve performance when accessing 465 a large number of large pack files. 466+ 467Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 468MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 469be reasonable for all users/operating systems. You probably do 470not need to adjust this value. 471+ 472Common unit suffixes of 'k', 'm', or 'g' are supported. 473 474core.packedGitLimit:: 475 Maximum number of bytes to map simultaneously into memory 476 from pack files. If Git needs to access more than this many 477 bytes at once to complete an operation it will unmap existing 478 regions to reclaim virtual address space within the process. 479+ 480Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 481This should be reasonable for all users/operating systems, except on 482the largest projects. You probably do not need to adjust this value. 483+ 484Common unit suffixes of 'k', 'm', or 'g' are supported. 485 486core.deltaBaseCacheLimit:: 487 Maximum number of bytes to reserve for caching base objects 488 that may be referenced by multiple deltified objects. By storing the 489 entire decompressed base objects in a cache Git is able 490 to avoid unpacking and decompressing frequently used base 491 objects multiple times. 492+ 493Default is 16 MiB on all platforms. This should be reasonable 494for all users/operating systems, except on the largest projects. 495You probably do not need to adjust this value. 496+ 497Common unit suffixes of 'k', 'm', or 'g' are supported. 498 499core.bigFileThreshold:: 500 Files larger than this size are stored deflated, without 501 attempting delta compression. Storing large files without 502 delta compression avoids excessive memory usage, at the 503 slight expense of increased disk usage. 504+ 505Default is 512 MiB on all platforms. This should be reasonable 506for most projects as source code and other text files can still 507be delta compressed, but larger binary media files won't be. 508+ 509Common unit suffixes of 'k', 'm', or 'g' are supported. 510 511core.excludesfile:: 512 In addition to '.gitignore' (per-directory) and 513 '.git/info/exclude', Git looks into this file for patterns 514 of files which are not meant to be tracked. "`~/`" is expanded 515 to the value of `$HOME` and "`~user/`" to the specified user's 516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 518 is used instead. See linkgit:gitignore[5]. 519 520core.askpass:: 521 Some commands (e.g. svn and http interfaces) that interactively 522 ask for a password can be told to use an external program given 523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 524 environment variable. If not set, fall back to the value of the 525 'SSH_ASKPASS' environment variable or, failing that, a simple password 526 prompt. The external program shall be given a suitable prompt as 527 command line argument and write the password on its STDOUT. 528 529core.attributesfile:: 530 In addition to '.gitattributes' (per-directory) and 531 '.git/info/attributes', Git looks into this file for attributes 532 (see linkgit:gitattributes[5]). Path expansions are made the same 533 way as for `core.excludesfile`. Its default value is 534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 535 set or empty, $HOME/.config/git/attributes is used instead. 536 537core.editor:: 538 Commands such as `commit` and `tag` that lets you edit 539 messages by launching an editor uses the value of this 540 variable when it is set, and the environment variable 541 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 542 543core.commentchar:: 544 Commands such as `commit` and `tag` that lets you edit 545 messages consider a line that begins with this character 546 commented, and removes them after the editor returns 547 (default '#'). 548 549sequence.editor:: 550 Text editor used by `git rebase -i` for editing the rebase instruction file. 551 The value is meant to be interpreted by the shell when it is used. 552 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 553 When not configured the default commit message editor is used instead. 554 555core.pager:: 556 Text viewer for use by Git commands (e.g., 'less'). The value 557 is meant to be interpreted by the shell. The order of preference 558 is the `$GIT_PAGER` environment variable, then `core.pager` 559 configuration, then `$PAGER`, and then the default chosen at 560 compile time (usually 'less'). 561+ 562When the `LESS` environment variable is unset, Git sets it to `FRSX` 563(if `LESS` environment variable is set, Git does not change it at 564all). If you want to selectively override Git's default setting 565for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will 566be passed to the shell by Git, which will translate the final 567command to `LESS=FRSX less -+S`. The environment tells the command 568to set the `S` option to chop long lines but the command line 569resets it to the default to fold long lines. 570 571core.whitespace:: 572 A comma separated list of common whitespace problems to 573 notice. 'git diff' will use `color.diff.whitespace` to 574 highlight them, and 'git apply --whitespace=error' will 575 consider them as errors. You can prefix `-` to disable 576 any of them (e.g. `-trailing-space`): 577+ 578* `blank-at-eol` treats trailing whitespaces at the end of the line 579 as an error (enabled by default). 580* `space-before-tab` treats a space character that appears immediately 581 before a tab character in the initial indent part of the line as an 582 error (enabled by default). 583* `indent-with-non-tab` treats a line that is indented with space 584 characters instead of the equivalent tabs as an error (not enabled by 585 default). 586* `tab-in-indent` treats a tab character in the initial indent part of 587 the line as an error (not enabled by default). 588* `blank-at-eof` treats blank lines added at the end of file as an error 589 (enabled by default). 590* `trailing-space` is a short-hand to cover both `blank-at-eol` and 591 `blank-at-eof`. 592* `cr-at-eol` treats a carriage-return at the end of line as 593 part of the line terminator, i.e. with it, `trailing-space` 594 does not trigger if the character before such a carriage-return 595 is not a whitespace (not enabled by default). 596* `tabwidth=<n>` tells how many character positions a tab occupies; this 597 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 598 errors. The default tab width is 8. Allowed values are 1 to 63. 599 600core.fsyncobjectfiles:: 601 This boolean will enable 'fsync()' when writing object files. 602+ 603This is a total waste of time and effort on a filesystem that orders 604data writes properly, but can be useful for filesystems that do not use 605journalling (traditional UNIX filesystems) or that only journal metadata 606and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 607 608core.preloadindex:: 609 Enable parallel index preload for operations like 'git diff' 610+ 611This can speed up operations like 'git diff' and 'git status' especially 612on filesystems like NFS that have weak caching semantics and thus 613relatively high IO latencies. With this set to 'true', Git will do the 614index comparison to the filesystem data in parallel, allowing 615overlapping IO's. 616 617core.createObject:: 618 You can set this to 'link', in which case a hardlink followed by 619 a delete of the source are used to make sure that object creation 620 will not overwrite existing objects. 621+ 622On some file system/operating system combinations, this is unreliable. 623Set this config setting to 'rename' there; However, This will remove the 624check that makes sure that existing object files will not get overwritten. 625 626core.notesRef:: 627 When showing commit messages, also show notes which are stored in 628 the given ref. The ref must be fully qualified. If the given 629 ref does not exist, it is not an error but means that no 630 notes should be printed. 631+ 632This setting defaults to "refs/notes/commits", and it can be overridden by 633the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 634 635core.sparseCheckout:: 636 Enable "sparse checkout" feature. See section "Sparse checkout" in 637 linkgit:git-read-tree[1] for more information. 638 639core.abbrev:: 640 Set the length object names are abbreviated to. If unspecified, 641 many commands abbreviate to 7 hexdigits, which may not be enough 642 for abbreviated object names to stay unique for sufficiently long 643 time. 644 645add.ignore-errors:: 646add.ignoreErrors:: 647 Tells 'git add' to continue adding files when some files cannot be 648 added due to indexing errors. Equivalent to the '--ignore-errors' 649 option of linkgit:git-add[1]. Older versions of Git accept only 650 `add.ignore-errors`, which does not follow the usual naming 651 convention for configuration variables. Newer versions of Git 652 honor `add.ignoreErrors` as well. 653 654alias.*:: 655 Command aliases for the linkgit:git[1] command wrapper - e.g. 656 after defining "alias.last = cat-file commit HEAD", the invocation 657 "git last" is equivalent to "git cat-file commit HEAD". To avoid 658 confusion and troubles with script usage, aliases that 659 hide existing Git commands are ignored. Arguments are split by 660 spaces, the usual shell quoting and escaping is supported. 661 quote pair and a backslash can be used to quote them. 662+ 663If the alias expansion is prefixed with an exclamation point, 664it will be treated as a shell command. For example, defining 665"alias.new = !gitk --all --not ORIG_HEAD", the invocation 666"git new" is equivalent to running the shell command 667"gitk --all --not ORIG_HEAD". Note that shell commands will be 668executed from the top-level directory of a repository, which may 669not necessarily be the current directory. 670'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 671from the original current directory. See linkgit:git-rev-parse[1]. 672 673am.keepcr:: 674 If true, git-am will call git-mailsplit for patches in mbox format 675 with parameter '--keep-cr'. In this case git-mailsplit will 676 not remove `\r` from lines ending with `\r\n`. Can be overridden 677 by giving '--no-keep-cr' from the command line. 678 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 679 680apply.ignorewhitespace:: 681 When set to 'change', tells 'git apply' to ignore changes in 682 whitespace, in the same way as the '--ignore-space-change' 683 option. 684 When set to one of: no, none, never, false tells 'git apply' to 685 respect all whitespace differences. 686 See linkgit:git-apply[1]. 687 688apply.whitespace:: 689 Tells 'git apply' how to handle whitespaces, in the same way 690 as the '--whitespace' option. See linkgit:git-apply[1]. 691 692branch.autosetupmerge:: 693 Tells 'git branch' and 'git checkout' to set up new branches 694 so that linkgit:git-pull[1] will appropriately merge from the 695 starting point branch. Note that even if this option is not set, 696 this behavior can be chosen per-branch using the `--track` 697 and `--no-track` options. The valid settings are: `false` -- no 698 automatic setup is done; `true` -- automatic setup is done when the 699 starting point is a remote-tracking branch; `always` -- 700 automatic setup is done when the starting point is either a 701 local branch or remote-tracking 702 branch. This option defaults to true. 703 704branch.autosetuprebase:: 705 When a new branch is created with 'git branch' or 'git checkout' 706 that tracks another branch, this variable tells Git to set 707 up pull to rebase instead of merge (see "branch.<name>.rebase"). 708 When `never`, rebase is never automatically set to true. 709 When `local`, rebase is set to true for tracked branches of 710 other local branches. 711 When `remote`, rebase is set to true for tracked branches of 712 remote-tracking branches. 713 When `always`, rebase will be set to true for all tracking 714 branches. 715 See "branch.autosetupmerge" for details on how to set up a 716 branch to track another branch. 717 This option defaults to never. 718 719branch.<name>.remote:: 720 When on branch <name>, it tells 'git fetch' and 'git push' 721 which remote to fetch from/push to. The remote to push to 722 may be overridden with `remote.pushdefault` (for all branches). 723 The remote to push to, for the current branch, may be further 724 overridden by `branch.<name>.pushremote`. If no remote is 725 configured, or if you are not on any branch, it defaults to 726 `origin` for fetching and `remote.pushdefault` for pushing. 727 Additionally, `.` (a period) is the current local repository 728 (a dot-repository), see `branch.<name>.merge`'s final note below. 729 730branch.<name>.pushremote:: 731 When on branch <name>, it overrides `branch.<name>.remote` for 732 pushing. It also overrides `remote.pushdefault` for pushing 733 from branch <name>. When you pull from one place (e.g. your 734 upstream) and push to another place (e.g. your own publishing 735 repository), you would want to set `remote.pushdefault` to 736 specify the remote to push to for all branches, and use this 737 option to override it for a specific branch. 738 739branch.<name>.merge:: 740 Defines, together with branch.<name>.remote, the upstream branch 741 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 742 branch to merge and can also affect 'git push' (see push.default). 743 When in branch <name>, it tells 'git fetch' the default 744 refspec to be marked for merging in FETCH_HEAD. The value is 745 handled like the remote part of a refspec, and must match a 746 ref which is fetched from the remote given by 747 "branch.<name>.remote". 748 The merge information is used by 'git pull' (which at first calls 749 'git fetch') to lookup the default branch for merging. Without 750 this option, 'git pull' defaults to merge the first refspec fetched. 751 Specify multiple values to get an octopus merge. 752 If you wish to setup 'git pull' so that it merges into <name> from 753 another branch in the local repository, you can point 754 branch.<name>.merge to the desired branch, and use the relative path 755 setting `.` (a period) for branch.<name>.remote. 756 757branch.<name>.mergeoptions:: 758 Sets default options for merging into branch <name>. The syntax and 759 supported options are the same as those of linkgit:git-merge[1], but 760 option values containing whitespace characters are currently not 761 supported. 762 763branch.<name>.rebase:: 764 When true, rebase the branch <name> on top of the fetched branch, 765 instead of merging the default branch from the default remote when 766 "git pull" is run. See "pull.rebase" for doing this in a non 767 branch-specific manner. 768+ 769 When preserve, also pass `--preserve-merges` along to 'git rebase' 770 so that locally committed merge commits will not be flattened 771 by running 'git pull'. 772+ 773*NOTE*: this is a possibly dangerous operation; do *not* use 774it unless you understand the implications (see linkgit:git-rebase[1] 775for details). 776 777branch.<name>.description:: 778 Branch description, can be edited with 779 `git branch --edit-description`. Branch description is 780 automatically added in the format-patch cover letter or 781 request-pull summary. 782 783browser.<tool>.cmd:: 784 Specify the command to invoke the specified browser. The 785 specified command is evaluated in shell with the URLs passed 786 as arguments. (See linkgit:git-web{litdd}browse[1].) 787 788browser.<tool>.path:: 789 Override the path for the given tool that may be used to 790 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 791 working repository in gitweb (see linkgit:git-instaweb[1]). 792 793clean.requireForce:: 794 A boolean to make git-clean do nothing unless given -f, 795 -i or -n. Defaults to true. 796 797color.branch:: 798 A boolean to enable/disable color in the output of 799 linkgit:git-branch[1]. May be set to `always`, 800 `false` (or `never`) or `auto` (or `true`), in which case colors are used 801 only when the output is to a terminal. Defaults to false. 802 803color.branch.<slot>:: 804 Use customized color for branch coloration. `<slot>` is one of 805 `current` (the current branch), `local` (a local branch), 806 `remote` (a remote-tracking branch in refs/remotes/), 807 `upstream` (upstream tracking branch), `plain` (other 808 refs). 809+ 810The value for these configuration variables is a list of colors (at most 811two) and attributes (at most one), separated by spaces. The colors 812accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 813`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 814`blink` and `reverse`. The first color given is the foreground; the 815second is the background. The position of the attribute, if any, 816doesn't matter. 817 818color.diff:: 819 Whether to use ANSI escape sequences to add color to patches. 820 If this is set to `always`, linkgit:git-diff[1], 821 linkgit:git-log[1], and linkgit:git-show[1] will use color 822 for all patches. If it is set to `true` or `auto`, those 823 commands will only use color when output is to the terminal. 824 Defaults to false. 825+ 826This does not affect linkgit:git-format-patch[1] nor the 827'git-diff-{asterisk}' plumbing commands. Can be overridden on the 828command line with the `--color[=<when>]` option. 829 830color.diff.<slot>:: 831 Use customized color for diff colorization. `<slot>` specifies 832 which part of the patch to use the specified color, and is one 833 of `plain` (context text), `meta` (metainformation), `frag` 834 (hunk header), 'func' (function in hunk header), `old` (removed lines), 835 `new` (added lines), `commit` (commit headers), or `whitespace` 836 (highlighting whitespace errors). The values of these variables may be 837 specified as in color.branch.<slot>. 838 839color.decorate.<slot>:: 840 Use customized color for 'git log --decorate' output. `<slot>` is one 841 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 842 branches, remote-tracking branches, tags, stash and HEAD, respectively. 843 844color.grep:: 845 When set to `always`, always highlight matches. When `false` (or 846 `never`), never. When set to `true` or `auto`, use color only 847 when the output is written to the terminal. Defaults to `false`. 848 849color.grep.<slot>:: 850 Use customized color for grep colorization. `<slot>` specifies which 851 part of the line to use the specified color, and is one of 852+ 853-- 854`context`;; 855 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 856`filename`;; 857 filename prefix (when not using `-h`) 858`function`;; 859 function name lines (when using `-p`) 860`linenumber`;; 861 line number prefix (when using `-n`) 862`match`;; 863 matching text 864`selected`;; 865 non-matching text in selected lines 866`separator`;; 867 separators between fields on a line (`:`, `-`, and `=`) 868 and between hunks (`--`) 869-- 870+ 871The values of these variables may be specified as in color.branch.<slot>. 872 873color.interactive:: 874 When set to `always`, always use colors for interactive prompts 875 and displays (such as those used by "git-add --interactive" and 876 "git-clean --interactive"). When false (or `never`), never. 877 When set to `true` or `auto`, use colors only when the output is 878 to the terminal. Defaults to false. 879 880color.interactive.<slot>:: 881 Use customized color for 'git add --interactive' and 'git clean 882 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 883 or `error`, for four distinct types of normal output from 884 interactive commands. The values of these variables may be 885 specified as in color.branch.<slot>. 886 887color.pager:: 888 A boolean to enable/disable colored output when the pager is in 889 use (default is true). 890 891color.showbranch:: 892 A boolean to enable/disable color in the output of 893 linkgit:git-show-branch[1]. May be set to `always`, 894 `false` (or `never`) or `auto` (or `true`), in which case colors are used 895 only when the output is to a terminal. Defaults to false. 896 897color.status:: 898 A boolean to enable/disable color in the output of 899 linkgit:git-status[1]. May be set to `always`, 900 `false` (or `never`) or `auto` (or `true`), in which case colors are used 901 only when the output is to a terminal. Defaults to false. 902 903color.status.<slot>:: 904 Use customized color for status colorization. `<slot>` is 905 one of `header` (the header text of the status message), 906 `added` or `updated` (files which are added but not committed), 907 `changed` (files which are changed but not added in the index), 908 `untracked` (files which are not tracked by Git), 909 `branch` (the current branch), or 910 `nobranch` (the color the 'no branch' warning is shown in, defaulting 911 to red). The values of these variables may be specified as in 912 color.branch.<slot>. 913 914color.ui:: 915 This variable determines the default value for variables such 916 as `color.diff` and `color.grep` that control the use of color 917 per command family. Its scope will expand as more commands learn 918 configuration to set a default for the `--color` option. Set it 919 to `false` or `never` if you prefer Git commands not to use 920 color unless enabled explicitly with some other configuration 921 or the `--color` option. Set it to `always` if you want all 922 output not intended for machine consumption to use color, to 923 `true` or `auto` (this is the default since Git 1.8.4) if you 924 want such output to use color when written to the terminal. 925 926column.ui:: 927 Specify whether supported commands should output in columns. 928 This variable consists of a list of tokens separated by spaces 929 or commas: 930+ 931These options control when the feature should be enabled 932(defaults to 'never'): 933+ 934-- 935`always`;; 936 always show in columns 937`never`;; 938 never show in columns 939`auto`;; 940 show in columns if the output is to the terminal 941-- 942+ 943These options control layout (defaults to 'column'). Setting any 944of these implies 'always' if none of 'always', 'never', or 'auto' are 945specified. 946+ 947-- 948`column`;; 949 fill columns before rows 950`row`;; 951 fill rows before columns 952`plain`;; 953 show in one column 954-- 955+ 956Finally, these options can be combined with a layout option (defaults 957to 'nodense'): 958+ 959-- 960`dense`;; 961 make unequal size columns to utilize more space 962`nodense`;; 963 make equal size columns 964-- 965 966column.branch:: 967 Specify whether to output branch listing in `git branch` in columns. 968 See `column.ui` for details. 969 970column.clean:: 971 Specify the layout when list items in `git clean -i`, which always 972 shows files and directories in columns. See `column.ui` for details. 973 974column.status:: 975 Specify whether to output untracked files in `git status` in columns. 976 See `column.ui` for details. 977 978column.tag:: 979 Specify whether to output tag listing in `git tag` in columns. 980 See `column.ui` for details. 981 982commit.cleanup:: 983 This setting overrides the default of the `--cleanup` option in 984 `git commit`. See linkgit:git-commit[1] for details. Changing the 985 default can be useful when you always want to keep lines that begin 986 with comment character `#` in your log message, in which case you 987 would do `git config commit.cleanup whitespace` (note that you will 988 have to remove the help lines that begin with `#` in the commit log 989 template yourself, if you do this). 990 991commit.status:: 992 A boolean to enable/disable inclusion of status information in the 993 commit message template when using an editor to prepare the commit 994 message. Defaults to true. 995 996commit.template:: 997 Specify a file to use as the template for new commit messages. 998 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the 999 specified user's home directory.10001001credential.helper::1002 Specify an external helper to be called when a username or1003 password credential is needed; the helper may consult external1004 storage to avoid prompting the user for the credentials. See1005 linkgit:gitcredentials[7] for details.10061007credential.useHttpPath::1008 When acquiring credentials, consider the "path" component of an http1009 or https URL to be important. Defaults to false. See1010 linkgit:gitcredentials[7] for more information.10111012credential.username::1013 If no username is set for a network authentication, use this username1014 by default. See credential.<context>.* below, and1015 linkgit:gitcredentials[7].10161017credential.<url>.*::1018 Any of the credential.* options above can be applied selectively to1019 some credentials. For example "credential.https://example.com.username"1020 would set the default username only for https connections to1021 example.com. See linkgit:gitcredentials[7] for details on how URLs are1022 matched.10231024include::diff-config.txt[]10251026difftool.<tool>.path::1027 Override the path for the given tool. This is useful in case1028 your tool is not in the PATH.10291030difftool.<tool>.cmd::1031 Specify the command to invoke the specified diff tool.1032 The specified command is evaluated in shell with the following1033 variables available: 'LOCAL' is set to the name of the temporary1034 file containing the contents of the diff pre-image and 'REMOTE'1035 is set to the name of the temporary file containing the contents1036 of the diff post-image.10371038difftool.prompt::1039 Prompt before each invocation of the diff tool.10401041fetch.recurseSubmodules::1042 This option can be either set to a boolean value or to 'on-demand'.1043 Setting it to a boolean changes the behavior of fetch and pull to1044 unconditionally recurse into submodules when set to true or to not1045 recurse at all when set to false. When set to 'on-demand' (the default1046 value), fetch and pull will only recurse into a populated submodule1047 when its superproject retrieves a commit that updates the submodule's1048 reference.10491050fetch.fsckObjects::1051 If it is set to true, git-fetch-pack will check all fetched1052 objects. It will abort in the case of a malformed object or a1053 broken link. The result of an abort are only dangling objects.1054 Defaults to false. If not set, the value of `transfer.fsckObjects`1055 is used instead.10561057fetch.unpackLimit::1058 If the number of objects fetched over the Git native1059 transfer is below this1060 limit, then the objects will be unpacked into loose object1061 files. However if the number of received objects equals or1062 exceeds this limit then the received pack will be stored as1063 a pack, after adding any missing delta bases. Storing the1064 pack from a push can make the push operation complete faster,1065 especially on slow filesystems. If not set, the value of1066 `transfer.unpackLimit` is used instead.10671068fetch.prune::1069 If true, fetch will automatically behave as if the `--prune`1070 option was given on the command line. See also `remote.<name>.prune`.10711072format.attach::1073 Enable multipart/mixed attachments as the default for1074 'format-patch'. The value can also be a double quoted string1075 which will enable attachments as the default and set the1076 value as the boundary. See the --attach option in1077 linkgit:git-format-patch[1].10781079format.numbered::1080 A boolean which can enable or disable sequence numbers in patch1081 subjects. It defaults to "auto" which enables it only if there1082 is more than one patch. It can be enabled or disabled for all1083 messages by setting it to "true" or "false". See --numbered1084 option in linkgit:git-format-patch[1].10851086format.headers::1087 Additional email headers to include in a patch to be submitted1088 by mail. See linkgit:git-format-patch[1].10891090format.to::1091format.cc::1092 Additional recipients to include in a patch to be submitted1093 by mail. See the --to and --cc options in1094 linkgit:git-format-patch[1].10951096format.subjectprefix::1097 The default for format-patch is to output files with the '[PATCH]'1098 subject prefix. Use this variable to change that prefix.10991100format.signature::1101 The default for format-patch is to output a signature containing1102 the Git version number. Use this variable to change that default.1103 Set this variable to the empty string ("") to suppress1104 signature generation.11051106format.suffix::1107 The default for format-patch is to output files with the suffix1108 `.patch`. Use this variable to change that suffix (make sure to1109 include the dot if you want it).11101111format.pretty::1112 The default pretty format for log/show/whatchanged command,1113 See linkgit:git-log[1], linkgit:git-show[1],1114 linkgit:git-whatchanged[1].11151116format.thread::1117 The default threading style for 'git format-patch'. Can be1118 a boolean value, or `shallow` or `deep`. `shallow` threading1119 makes every mail a reply to the head of the series,1120 where the head is chosen from the cover letter, the1121 `--in-reply-to`, and the first patch mail, in this order.1122 `deep` threading makes every mail a reply to the previous one.1123 A true boolean value is the same as `shallow`, and a false1124 value disables threading.11251126format.signoff::1127 A boolean value which lets you enable the `-s/--signoff` option of1128 format-patch by default. *Note:* Adding the Signed-off-by: line to a1129 patch should be a conscious act and means that you certify you have1130 the rights to submit this work under the same open source license.1131 Please see the 'SubmittingPatches' document for further discussion.11321133format.coverLetter::1134 A boolean that controls whether to generate a cover-letter when1135 format-patch is invoked, but in addition can be set to "auto", to1136 generate a cover-letter only when there's more than one patch.11371138filter.<driver>.clean::1139 The command which is used to convert the content of a worktree1140 file to a blob upon checkin. See linkgit:gitattributes[5] for1141 details.11421143filter.<driver>.smudge::1144 The command which is used to convert the content of a blob1145 object to a worktree file upon checkout. See1146 linkgit:gitattributes[5] for details.11471148gc.aggressiveWindow::1149 The window size parameter used in the delta compression1150 algorithm used by 'git gc --aggressive'. This defaults1151 to 250.11521153gc.auto::1154 When there are approximately more than this many loose1155 objects in the repository, `git gc --auto` will pack them.1156 Some Porcelain commands use this command to perform a1157 light-weight garbage collection from time to time. The1158 default value is 6700. Setting this to 0 disables it.11591160gc.autopacklimit::1161 When there are more than this many packs that are not1162 marked with `*.keep` file in the repository, `git gc1163 --auto` consolidates them into one larger pack. The1164 default value is 50. Setting this to 0 disables it.11651166gc.packrefs::1167 Running `git pack-refs` in a repository renders it1168 unclonable by Git versions prior to 1.5.1.2 over dumb1169 transports such as HTTP. This variable determines whether1170 'git gc' runs `git pack-refs`. This can be set to `notbare`1171 to enable it within all non-bare repos or it can be set to a1172 boolean value. The default is `true`.11731174gc.pruneexpire::1175 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1176 Override the grace period with this config variable. The value1177 "now" may be used to disable this grace period and always prune1178 unreachable objects immediately.11791180gc.reflogexpire::1181gc.<pattern>.reflogexpire::1182 'git reflog expire' removes reflog entries older than1183 this time; defaults to 90 days. With "<pattern>" (e.g.1184 "refs/stash") in the middle the setting applies only to1185 the refs that match the <pattern>.11861187gc.reflogexpireunreachable::1188gc.<ref>.reflogexpireunreachable::1189 'git reflog expire' removes reflog entries older than1190 this time and are not reachable from the current tip;1191 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1192 in the middle, the setting applies only to the refs that1193 match the <pattern>.11941195gc.rerereresolved::1196 Records of conflicted merge you resolved earlier are1197 kept for this many days when 'git rerere gc' is run.1198 The default is 60 days. See linkgit:git-rerere[1].11991200gc.rerereunresolved::1201 Records of conflicted merge you have not resolved are1202 kept for this many days when 'git rerere gc' is run.1203 The default is 15 days. See linkgit:git-rerere[1].12041205gitcvs.commitmsgannotation::1206 Append this string to each commit message. Set to empty string1207 to disable this feature. Defaults to "via git-CVS emulator".12081209gitcvs.enabled::1210 Whether the CVS server interface is enabled for this repository.1211 See linkgit:git-cvsserver[1].12121213gitcvs.logfile::1214 Path to a log file where the CVS server interface well... logs1215 various stuff. See linkgit:git-cvsserver[1].12161217gitcvs.usecrlfattr::1218 If true, the server will look up the end-of-line conversion1219 attributes for files to determine the '-k' modes to use. If1220 the attributes force Git to treat a file as text,1221 the '-k' mode will be left blank so CVS clients will1222 treat it as text. If they suppress text conversion, the file1223 will be set with '-kb' mode, which suppresses any newline munging1224 the client might otherwise do. If the attributes do not allow1225 the file type to be determined, then 'gitcvs.allbinary' is1226 used. See linkgit:gitattributes[5].12271228gitcvs.allbinary::1229 This is used if 'gitcvs.usecrlfattr' does not resolve1230 the correct '-kb' mode to use. If true, all1231 unresolved files are sent to the client in1232 mode '-kb'. This causes the client to treat them1233 as binary files, which suppresses any newline munging it1234 otherwise might do. Alternatively, if it is set to "guess",1235 then the contents of the file are examined to decide if1236 it is binary, similar to 'core.autocrlf'.12371238gitcvs.dbname::1239 Database used by git-cvsserver to cache revision information1240 derived from the Git repository. The exact meaning depends on the1241 used database driver, for SQLite (which is the default driver) this1242 is a filename. Supports variable substitution (see1243 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1244 Default: '%Ggitcvs.%m.sqlite'12451246gitcvs.dbdriver::1247 Used Perl DBI driver. You can specify any available driver1248 for this here, but it might not work. git-cvsserver is tested1249 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1250 reported *not* to work with 'DBD::mysql'. Experimental feature.1251 May not contain double colons (`:`). Default: 'SQLite'.1252 See linkgit:git-cvsserver[1].12531254gitcvs.dbuser, gitcvs.dbpass::1255 Database user and password. Only useful if setting 'gitcvs.dbdriver',1256 since SQLite has no concept of database users and/or passwords.1257 'gitcvs.dbuser' supports variable substitution (see1258 linkgit:git-cvsserver[1] for details).12591260gitcvs.dbTableNamePrefix::1261 Database table name prefix. Prepended to the names of any1262 database tables used, allowing a single database to be used1263 for several repositories. Supports variable substitution (see1264 linkgit:git-cvsserver[1] for details). Any non-alphabetic1265 characters will be replaced with underscores.12661267All gitcvs variables except for 'gitcvs.usecrlfattr' and1268'gitcvs.allbinary' can also be specified as1269'gitcvs.<access_method>.<varname>' (where 'access_method'1270is one of "ext" and "pserver") to make them apply only for the given1271access method.12721273gitweb.category::1274gitweb.description::1275gitweb.owner::1276gitweb.url::1277 See linkgit:gitweb[1] for description.12781279gitweb.avatar::1280gitweb.blame::1281gitweb.grep::1282gitweb.highlight::1283gitweb.patches::1284gitweb.pickaxe::1285gitweb.remote_heads::1286gitweb.showsizes::1287gitweb.snapshot::1288 See linkgit:gitweb.conf[5] for description.12891290grep.lineNumber::1291 If set to true, enable '-n' option by default.12921293grep.patternType::1294 Set the default matching behavior. Using a value of 'basic', 'extended',1295 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1296 '--fixed-strings', or '--perl-regexp' option accordingly, while the1297 value 'default' will return to the default matching behavior.12981299grep.extendedRegexp::1300 If set to true, enable '--extended-regexp' option by default. This1301 option is ignored when the 'grep.patternType' option is set to a value1302 other than 'default'.13031304gpg.program::1305 Use this custom program instead of "gpg" found on $PATH when1306 making or verifying a PGP signature. The program must support the1307 same command line interface as GPG, namely, to verify a detached1308 signature, "gpg --verify $file - <$signature" is run, and the1309 program is expected to signal a good signature by exiting with1310 code 0, and to generate an ascii-armored detached signature, the1311 standard input of "gpg -bsau $key" is fed with the contents to be1312 signed, and the program is expected to send the result to its1313 standard output.13141315gui.commitmsgwidth::1316 Defines how wide the commit message window is in the1317 linkgit:git-gui[1]. "75" is the default.13181319gui.diffcontext::1320 Specifies how many context lines should be used in calls to diff1321 made by the linkgit:git-gui[1]. The default is "5".13221323gui.encoding::1324 Specifies the default encoding to use for displaying of1325 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1326 It can be overridden by setting the 'encoding' attribute1327 for relevant files (see linkgit:gitattributes[5]).1328 If this option is not set, the tools default to the1329 locale encoding.13301331gui.matchtrackingbranch::1332 Determines if new branches created with linkgit:git-gui[1] should1333 default to tracking remote branches with matching names or1334 not. Default: "false".13351336gui.newbranchtemplate::1337 Is used as suggested name when creating new branches using the1338 linkgit:git-gui[1].13391340gui.pruneduringfetch::1341 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1342 performing a fetch. The default value is "false".13431344gui.trustmtime::1345 Determines if linkgit:git-gui[1] should trust the file modification1346 timestamp or not. By default the timestamps are not trusted.13471348gui.spellingdictionary::1349 Specifies the dictionary used for spell checking commit messages in1350 the linkgit:git-gui[1]. When set to "none" spell checking is turned1351 off.13521353gui.fastcopyblame::1354 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1355 location detection. It makes blame significantly faster on huge1356 repositories at the expense of less thorough copy detection.13571358gui.copyblamethreshold::1359 Specifies the threshold to use in 'git gui blame' original location1360 detection, measured in alphanumeric characters. See the1361 linkgit:git-blame[1] manual for more information on copy detection.13621363gui.blamehistoryctx::1364 Specifies the radius of history context in days to show in1365 linkgit:gitk[1] for the selected commit, when the `Show History1366 Context` menu item is invoked from 'git gui blame'. If this1367 variable is set to zero, the whole history is shown.13681369guitool.<name>.cmd::1370 Specifies the shell command line to execute when the corresponding item1371 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1372 mandatory for every tool. The command is executed from the root of1373 the working directory, and in the environment it receives the name of1374 the tool as 'GIT_GUITOOL', the name of the currently selected file as1375 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1376 the head is detached, 'CUR_BRANCH' is empty).13771378guitool.<name>.needsfile::1379 Run the tool only if a diff is selected in the GUI. It guarantees1380 that 'FILENAME' is not empty.13811382guitool.<name>.noconsole::1383 Run the command silently, without creating a window to display its1384 output.13851386guitool.<name>.norescan::1387 Don't rescan the working directory for changes after the tool1388 finishes execution.13891390guitool.<name>.confirm::1391 Show a confirmation dialog before actually running the tool.13921393guitool.<name>.argprompt::1394 Request a string argument from the user, and pass it to the tool1395 through the 'ARGS' environment variable. Since requesting an1396 argument implies confirmation, the 'confirm' option has no effect1397 if this is enabled. If the option is set to 'true', 'yes', or '1',1398 the dialog uses a built-in generic prompt; otherwise the exact1399 value of the variable is used.14001401guitool.<name>.revprompt::1402 Request a single valid revision from the user, and set the1403 'REVISION' environment variable. In other aspects this option1404 is similar to 'argprompt', and can be used together with it.14051406guitool.<name>.revunmerged::1407 Show only unmerged branches in the 'revprompt' subdialog.1408 This is useful for tools similar to merge or rebase, but not1409 for things like checkout or reset.14101411guitool.<name>.title::1412 Specifies the title to use for the prompt dialog. The default1413 is the tool name.14141415guitool.<name>.prompt::1416 Specifies the general prompt string to display at the top of1417 the dialog, before subsections for 'argprompt' and 'revprompt'.1418 The default value includes the actual command.14191420help.browser::1421 Specify the browser that will be used to display help in the1422 'web' format. See linkgit:git-help[1].14231424help.format::1425 Override the default help format used by linkgit:git-help[1].1426 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1427 the default. 'web' and 'html' are the same.14281429help.autocorrect::1430 Automatically correct and execute mistyped commands after1431 waiting for the given number of deciseconds (0.1 sec). If more1432 than one command can be deduced from the entered text, nothing1433 will be executed. If the value of this option is negative,1434 the corrected command will be executed immediately. If the1435 value is 0 - the command will be just shown but not executed.1436 This is the default.14371438help.htmlpath::1439 Specify the path where the HTML documentation resides. File system paths1440 and URLs are supported. HTML pages will be prefixed with this path when1441 help is displayed in the 'web' format. This defaults to the documentation1442 path of your Git installation.14431444http.proxy::1445 Override the HTTP proxy, normally configured using the 'http_proxy',1446 'https_proxy', and 'all_proxy' environment variables (see1447 `curl(1)`). This can be overridden on a per-remote basis; see1448 remote.<name>.proxy14491450http.cookiefile::1451 File containing previously stored cookie lines which should be used1452 in the Git http session, if they match the server. The file format1453 of the file to read cookies from should be plain HTTP headers or1454 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1455 NOTE that the file specified with http.cookiefile is only used as1456 input unless http.saveCookies is set.14571458http.savecookies::1459 If set, store cookies received during requests to the file specified by1460 http.cookiefile. Has no effect if http.cookiefile is unset.14611462http.sslVerify::1463 Whether to verify the SSL certificate when fetching or pushing1464 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1465 variable.14661467http.sslCert::1468 File containing the SSL certificate when fetching or pushing1469 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1470 variable.14711472http.sslKey::1473 File containing the SSL private key when fetching or pushing1474 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1475 variable.14761477http.sslCertPasswordProtected::1478 Enable Git's password prompt for the SSL certificate. Otherwise1479 OpenSSL will prompt the user, possibly many times, if the1480 certificate or private key is encrypted. Can be overridden by the1481 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.14821483http.sslCAInfo::1484 File containing the certificates to verify the peer with when1485 fetching or pushing over HTTPS. Can be overridden by the1486 'GIT_SSL_CAINFO' environment variable.14871488http.sslCAPath::1489 Path containing files with the CA certificates to verify the peer1490 with when fetching or pushing over HTTPS. Can be overridden1491 by the 'GIT_SSL_CAPATH' environment variable.14921493http.sslTry::1494 Attempt to use AUTH SSL/TLS and encrypted data transfers1495 when connecting via regular FTP protocol. This might be needed1496 if the FTP server requires it for security reasons or you wish1497 to connect securely whenever remote FTP server supports it.1498 Default is false since it might trigger certificate verification1499 errors on misconfigured servers.15001501http.maxRequests::1502 How many HTTP requests to launch in parallel. Can be overridden1503 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15041505http.minSessions::1506 The number of curl sessions (counted across slots) to be kept across1507 requests. They will not be ended with curl_easy_cleanup() until1508 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1509 value will be capped at 1. Defaults to 1.15101511http.postBuffer::1512 Maximum size in bytes of the buffer used by smart HTTP1513 transports when POSTing data to the remote system.1514 For requests larger than this buffer size, HTTP/1.1 and1515 Transfer-Encoding: chunked is used to avoid creating a1516 massive pack file locally. Default is 1 MiB, which is1517 sufficient for most requests.15181519http.lowSpeedLimit, http.lowSpeedTime::1520 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1521 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1522 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1523 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15241525http.noEPSV::1526 A boolean which disables using of EPSV ftp command by curl.1527 This can helpful with some "poor" ftp servers which don't1528 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1529 environment variable. Default is false (curl will use EPSV).15301531http.useragent::1532 The HTTP USER_AGENT string presented to an HTTP server. The default1533 value represents the version of the client Git such as git/1.7.1.1534 This option allows you to override this value to a more common value1535 such as Mozilla/4.0. This may be necessary, for instance, if1536 connecting through a firewall that restricts HTTP connections to a set1537 of common USER_AGENT strings (but not including those like git/1.7.1).1538 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15391540http.<url>.*::1541 Any of the http.* options above can be applied selectively to some urls.1542 For a config key to match a URL, each element of the config key is1543 compared to that of the URL, in the following order:1544+1545--1546. Scheme (e.g., `https` in `https://example.com/`). This field1547 must match exactly between the config key and the URL.15481549. Host/domain name (e.g., `example.com` in `https://example.com/`).1550 This field must match exactly between the config key and the URL.15511552. Port number (e.g., `8080` in `http://example.com:8080/`).1553 This field must match exactly between the config key and the URL.1554 Omitted port numbers are automatically converted to the correct1555 default for the scheme before matching.15561557. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1558 path field of the config key must match the path field of the URL1559 either exactly or as a prefix of slash-delimited path elements. This means1560 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1561 match on a slash (`/`) boundary. Longer matches take precedence (so a config1562 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1563 key with just path `foo/`).15641565. User name (e.g., `user` in `https://user@example.com/repo.git`). If1566 the config key has a user name it must match the user name in the1567 URL exactly. If the config key does not have a user name, that1568 config key will match a URL with any user name (including none),1569 but at a lower precedence than a config key with a user name.1570--1571+1572The list above is ordered by decreasing precedence; a URL that matches1573a config key's path is preferred to one that matches its user name. For example,1574if the URL is `https://user@example.com/foo/bar` a config key match of1575`https://example.com/foo` will be preferred over a config key match of1576`https://user@example.com`.1577+1578All URLs are normalized before attempting any matching (the password part,1579if embedded in the URL, is always ignored for matching purposes) so that1580equivalent urls that are simply spelled differently will match properly.1581Environment variable settings always override any matches. The urls that are1582matched against are those given directly to Git commands. This means any URLs1583visited as a result of a redirection do not participate in matching.15841585i18n.commitEncoding::1586 Character encoding the commit messages are stored in; Git itself1587 does not care per se, but this information is necessary e.g. when1588 importing commits from emails or in the gitk graphical history1589 browser (and possibly at other places in the future or in other1590 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.15911592i18n.logOutputEncoding::1593 Character encoding the commit messages are converted to when1594 running 'git log' and friends.15951596imap::1597 The configuration variables in the 'imap' section are described1598 in linkgit:git-imap-send[1].15991600init.templatedir::1601 Specify the directory from which templates will be copied.1602 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16031604instaweb.browser::1605 Specify the program that will be used to browse your working1606 repository in gitweb. See linkgit:git-instaweb[1].16071608instaweb.httpd::1609 The HTTP daemon command-line to start gitweb on your working1610 repository. See linkgit:git-instaweb[1].16111612instaweb.local::1613 If true the web server started by linkgit:git-instaweb[1] will1614 be bound to the local IP (127.0.0.1).16151616instaweb.modulepath::1617 The default module path for linkgit:git-instaweb[1] to use1618 instead of /usr/lib/apache2/modules. Only used if httpd1619 is Apache.16201621instaweb.port::1622 The port number to bind the gitweb httpd to. See1623 linkgit:git-instaweb[1].16241625interactive.singlekey::1626 In interactive commands, allow the user to provide one-letter1627 input with a single key (i.e., without hitting enter).1628 Currently this is used by the `--patch` mode of1629 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1630 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1631 setting is silently ignored if portable keystroke input1632 is not available.16331634log.abbrevCommit::1635 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1636 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1637 override this option with `--no-abbrev-commit`.16381639log.date::1640 Set the default date-time mode for the 'log' command.1641 Setting a value for log.date is similar to using 'git log''s1642 `--date` option. Possible values are `relative`, `local`,1643 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1644 for details.16451646log.decorate::1647 Print out the ref names of any commits that are shown by the log1648 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1649 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1650 specified, the full ref name (including prefix) will be printed.1651 This is the same as the log commands '--decorate' option.16521653log.showroot::1654 If true, the initial commit will be shown as a big creation event.1655 This is equivalent to a diff against an empty tree.1656 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1657 normally hide the root commit will now show it. True by default.16581659log.mailmap::1660 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1661 linkgit:git-whatchanged[1] assume `--use-mailmap`.16621663mailmap.file::1664 The location of an augmenting mailmap file. The default1665 mailmap, located in the root of the repository, is loaded1666 first, then the mailmap file pointed to by this variable.1667 The location of the mailmap file may be in a repository1668 subdirectory, or somewhere outside of the repository itself.1669 See linkgit:git-shortlog[1] and linkgit:git-blame[1].16701671mailmap.blob::1672 Like `mailmap.file`, but consider the value as a reference to a1673 blob in the repository. If both `mailmap.file` and1674 `mailmap.blob` are given, both are parsed, with entries from1675 `mailmap.file` taking precedence. In a bare repository, this1676 defaults to `HEAD:.mailmap`. In a non-bare repository, it1677 defaults to empty.16781679man.viewer::1680 Specify the programs that may be used to display help in the1681 'man' format. See linkgit:git-help[1].16821683man.<tool>.cmd::1684 Specify the command to invoke the specified man viewer. The1685 specified command is evaluated in shell with the man page1686 passed as argument. (See linkgit:git-help[1].)16871688man.<tool>.path::1689 Override the path for the given tool that may be used to1690 display help in the 'man' format. See linkgit:git-help[1].16911692include::merge-config.txt[]16931694mergetool.<tool>.path::1695 Override the path for the given tool. This is useful in case1696 your tool is not in the PATH.16971698mergetool.<tool>.cmd::1699 Specify the command to invoke the specified merge tool. The1700 specified command is evaluated in shell with the following1701 variables available: 'BASE' is the name of a temporary file1702 containing the common base of the files to be merged, if available;1703 'LOCAL' is the name of a temporary file containing the contents of1704 the file on the current branch; 'REMOTE' is the name of a temporary1705 file containing the contents of the file from the branch being1706 merged; 'MERGED' contains the name of the file to which the merge1707 tool should write the results of a successful merge.17081709mergetool.<tool>.trustExitCode::1710 For a custom merge command, specify whether the exit code of1711 the merge command can be used to determine whether the merge was1712 successful. If this is not set to true then the merge target file1713 timestamp is checked and the merge assumed to have been successful1714 if the file has been updated, otherwise the user is prompted to1715 indicate the success of the merge.17161717mergetool.keepBackup::1718 After performing a merge, the original file with conflict markers1719 can be saved as a file with a `.orig` extension. If this variable1720 is set to `false` then this file is not preserved. Defaults to1721 `true` (i.e. keep the backup files).17221723mergetool.keepTemporaries::1724 When invoking a custom merge tool, Git uses a set of temporary1725 files to pass to the tool. If the tool returns an error and this1726 variable is set to `true`, then these temporary files will be1727 preserved, otherwise they will be removed after the tool has1728 exited. Defaults to `false`.17291730mergetool.prompt::1731 Prompt before each invocation of the merge resolution program.17321733notes.displayRef::1734 The (fully qualified) refname from which to show notes when1735 showing commit messages. The value of this variable can be set1736 to a glob, in which case notes from all matching refs will be1737 shown. You may also specify this configuration variable1738 several times. A warning will be issued for refs that do not1739 exist, but a glob that does not match any refs is silently1740 ignored.1741+1742This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1743environment variable, which must be a colon separated list of refs or1744globs.1745+1746The effective value of "core.notesRef" (possibly overridden by1747GIT_NOTES_REF) is also implicitly added to the list of refs to be1748displayed.17491750notes.rewrite.<command>::1751 When rewriting commits with <command> (currently `amend` or1752 `rebase`) and this variable is set to `true`, Git1753 automatically copies your notes from the original to the1754 rewritten commit. Defaults to `true`, but see1755 "notes.rewriteRef" below.17561757notes.rewriteMode::1758 When copying notes during a rewrite (see the1759 "notes.rewrite.<command>" option), determines what to do if1760 the target commit already has a note. Must be one of1761 `overwrite`, `concatenate`, or `ignore`. Defaults to1762 `concatenate`.1763+1764This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1765environment variable.17661767notes.rewriteRef::1768 When copying notes during a rewrite, specifies the (fully1769 qualified) ref whose notes should be copied. The ref may be a1770 glob, in which case notes in all matching refs will be copied.1771 You may also specify this configuration several times.1772+1773Does not have a default value; you must configure this variable to1774enable note rewriting. Set it to `refs/notes/commits` to enable1775rewriting for the default commit notes.1776+1777This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1778environment variable, which must be a colon separated list of refs or1779globs.17801781pack.window::1782 The size of the window used by linkgit:git-pack-objects[1] when no1783 window size is given on the command line. Defaults to 10.17841785pack.depth::1786 The maximum delta depth used by linkgit:git-pack-objects[1] when no1787 maximum depth is given on the command line. Defaults to 50.17881789pack.windowMemory::1790 The window memory size limit used by linkgit:git-pack-objects[1]1791 when no limit is given on the command line. The value can be1792 suffixed with "k", "m", or "g". Defaults to 0, meaning no1793 limit.17941795pack.compression::1796 An integer -1..9, indicating the compression level for objects1797 in a pack file. -1 is the zlib default. 0 means no1798 compression, and 1..9 are various speed/size tradeoffs, 9 being1799 slowest. If not set, defaults to core.compression. If that is1800 not set, defaults to -1, the zlib default, which is "a default1801 compromise between speed and compression (currently equivalent1802 to level 6)."1803+1804Note that changing the compression level will not automatically recompress1805all existing objects. You can force recompression by passing the -F option1806to linkgit:git-repack[1].18071808pack.deltaCacheSize::1809 The maximum memory in bytes used for caching deltas in1810 linkgit:git-pack-objects[1] before writing them out to a pack.1811 This cache is used to speed up the writing object phase by not1812 having to recompute the final delta result once the best match1813 for all objects is found. Repacking large repositories on machines1814 which are tight with memory might be badly impacted by this though,1815 especially if this cache pushes the system into swapping.1816 A value of 0 means no limit. The smallest size of 1 byte may be1817 used to virtually disable this cache. Defaults to 256 MiB.18181819pack.deltaCacheLimit::1820 The maximum size of a delta, that is cached in1821 linkgit:git-pack-objects[1]. This cache is used to speed up the1822 writing object phase by not having to recompute the final delta1823 result once the best match for all objects is found. Defaults to 1000.18241825pack.threads::1826 Specifies the number of threads to spawn when searching for best1827 delta matches. This requires that linkgit:git-pack-objects[1]1828 be compiled with pthreads otherwise this option is ignored with a1829 warning. This is meant to reduce packing time on multiprocessor1830 machines. The required amount of memory for the delta search window1831 is however multiplied by the number of threads.1832 Specifying 0 will cause Git to auto-detect the number of CPU's1833 and set the number of threads accordingly.18341835pack.indexVersion::1836 Specify the default pack index version. Valid values are 1 for1837 legacy pack index used by Git versions prior to 1.5.2, and 2 for1838 the new pack index with capabilities for packs larger than 4 GB1839 as well as proper protection against the repacking of corrupted1840 packs. Version 2 is the default. Note that version 2 is enforced1841 and this config option ignored whenever the corresponding pack is1842 larger than 2 GB.1843+1844If you have an old Git that does not understand the version 2 `*.idx` file,1845cloning or fetching over a non native protocol (e.g. "http" and "rsync")1846that will copy both `*.pack` file and corresponding `*.idx` file from the1847other side may give you a repository that cannot be accessed with your1848older version of Git. If the `*.pack` file is smaller than 2 GB, however,1849you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1850the `*.idx` file.18511852pack.packSizeLimit::1853 The maximum size of a pack. This setting only affects1854 packing to a file when repacking, i.e. the git:// protocol1855 is unaffected. It can be overridden by the `--max-pack-size`1856 option of linkgit:git-repack[1]. The minimum size allowed is1857 limited to 1 MiB. The default is unlimited.1858 Common unit suffixes of 'k', 'm', or 'g' are1859 supported.18601861pager.<cmd>::1862 If the value is boolean, turns on or off pagination of the1863 output of a particular Git subcommand when writing to a tty.1864 Otherwise, turns on pagination for the subcommand using the1865 pager specified by the value of `pager.<cmd>`. If `--paginate`1866 or `--no-pager` is specified on the command line, it takes1867 precedence over this option. To disable pagination for all1868 commands, set `core.pager` or `GIT_PAGER` to `cat`.18691870pretty.<name>::1871 Alias for a --pretty= format string, as specified in1872 linkgit:git-log[1]. Any aliases defined here can be used just1873 as the built-in pretty formats could. For example,1874 running `git config pretty.changelog "format:* %H %s"`1875 would cause the invocation `git log --pretty=changelog`1876 to be equivalent to running `git log "--pretty=format:* %H %s"`.1877 Note that an alias with the same name as a built-in format1878 will be silently ignored.18791880pull.rebase::1881 When true, rebase branches on top of the fetched branch, instead1882 of merging the default branch from the default remote when "git1883 pull" is run. See "branch.<name>.rebase" for setting this on a1884 per-branch basis.1885+1886 When preserve, also pass `--preserve-merges` along to 'git rebase'1887 so that locally committed merge commits will not be flattened1888 by running 'git pull'.1889+1890*NOTE*: this is a possibly dangerous operation; do *not* use1891it unless you understand the implications (see linkgit:git-rebase[1]1892for details).18931894pull.octopus::1895 The default merge strategy to use when pulling multiple branches1896 at once.18971898pull.twohead::1899 The default merge strategy to use when pulling a single branch.19001901push.default::1902 Defines the action `git push` should take if no refspec is1903 explicitly given. Different values are well-suited for1904 specific workflows; for instance, in a purely central workflow1905 (i.e. the fetch source is equal to the push destination),1906 `upstream` is probably what you want. Possible values are:1907+1908--19091910* `nothing` - do not push anything (error out) unless a refspec is1911 explicitly given. This is primarily meant for people who want to1912 avoid mistakes by always being explicit.19131914* `current` - push the current branch to update a branch with the same1915 name on the receiving end. Works in both central and non-central1916 workflows.19171918* `upstream` - push the current branch back to the branch whose1919 changes are usually integrated into the current branch (which is1920 called `@{upstream}`). This mode only makes sense if you are1921 pushing to the same repository you would normally pull from1922 (i.e. central workflow).19231924* `simple` - in centralized workflow, work like `upstream` with an1925 added safety to refuse to push if the upstream branch's name is1926 different from the local one.1927+1928When pushing to a remote that is different from the remote you normally1929pull from, work as `current`. This is the safest option and is suited1930for beginners.1931+1932This mode will become the default in Git 2.0.19331934* `matching` - push all branches having the same name on both ends.1935 This makes the repository you are pushing to remember the set of1936 branches that will be pushed out (e.g. if you always push 'maint'1937 and 'master' there and no other branches, the repository you push1938 to will have these two branches, and your local 'maint' and1939 'master' will be pushed there).1940+1941To use this mode effectively, you have to make sure _all_ the1942branches you would push out are ready to be pushed out before1943running 'git push', as the whole point of this mode is to allow you1944to push all of the branches in one go. If you usually finish work1945on only one branch and push out the result, while other branches are1946unfinished, this mode is not for you. Also this mode is not1947suitable for pushing into a shared central repository, as other1948people may add new branches there, or update the tip of existing1949branches outside your control.1950+1951This is currently the default, but Git 2.0 will change the default1952to `simple`.19531954--19551956rebase.stat::1957 Whether to show a diffstat of what changed upstream since the last1958 rebase. False by default.19591960rebase.autosquash::1961 If set to true enable '--autosquash' option by default.19621963rebase.autostash::1964 When set to true, automatically create a temporary stash1965 before the operation begins, and apply it after the operation1966 ends. This means that you can run rebase on a dirty worktree.1967 However, use with care: the final stash application after a1968 successful rebase might result in non-trivial conflicts.1969 Defaults to false.19701971receive.autogc::1972 By default, git-receive-pack will run "git-gc --auto" after1973 receiving data from git-push and updating refs. You can stop1974 it by setting this variable to false.19751976receive.fsckObjects::1977 If it is set to true, git-receive-pack will check all received1978 objects. It will abort in the case of a malformed object or a1979 broken link. The result of an abort are only dangling objects.1980 Defaults to false. If not set, the value of `transfer.fsckObjects`1981 is used instead.19821983receive.unpackLimit::1984 If the number of objects received in a push is below this1985 limit then the objects will be unpacked into loose object1986 files. However if the number of received objects equals or1987 exceeds this limit then the received pack will be stored as1988 a pack, after adding any missing delta bases. Storing the1989 pack from a push can make the push operation complete faster,1990 especially on slow filesystems. If not set, the value of1991 `transfer.unpackLimit` is used instead.19921993receive.denyDeletes::1994 If set to true, git-receive-pack will deny a ref update that deletes1995 the ref. Use this to prevent such a ref deletion via a push.19961997receive.denyDeleteCurrent::1998 If set to true, git-receive-pack will deny a ref update that1999 deletes the currently checked out branch of a non-bare repository.20002001receive.denyCurrentBranch::2002 If set to true or "refuse", git-receive-pack will deny a ref update2003 to the currently checked out branch of a non-bare repository.2004 Such a push is potentially dangerous because it brings the HEAD2005 out of sync with the index and working tree. If set to "warn",2006 print a warning of such a push to stderr, but allow the push to2007 proceed. If set to false or "ignore", allow such pushes with no2008 message. Defaults to "refuse".20092010receive.denyNonFastForwards::2011 If set to true, git-receive-pack will deny a ref update which is2012 not a fast-forward. Use this to prevent such an update via a push,2013 even if that push is forced. This configuration variable is2014 set when initializing a shared repository.20152016receive.hiderefs::2017 String(s) `receive-pack` uses to decide which refs to omit2018 from its initial advertisement. Use more than one2019 definitions to specify multiple prefix strings. A ref that2020 are under the hierarchies listed on the value of this2021 variable is excluded, and is hidden when responding to `git2022 push`, and an attempt to update or delete a hidden ref by2023 `git push` is rejected.20242025receive.updateserverinfo::2026 If set to true, git-receive-pack will run git-update-server-info2027 after receiving data from git-push and updating refs.20282029remote.pushdefault::2030 The remote to push to by default. Overrides2031 `branch.<name>.remote` for all branches, and is overridden by2032 `branch.<name>.pushremote` for specific branches.20332034remote.<name>.url::2035 The URL of a remote repository. See linkgit:git-fetch[1] or2036 linkgit:git-push[1].20372038remote.<name>.pushurl::2039 The push URL of a remote repository. See linkgit:git-push[1].20402041remote.<name>.proxy::2042 For remotes that require curl (http, https and ftp), the URL to2043 the proxy to use for that remote. Set to the empty string to2044 disable proxying for that remote.20452046remote.<name>.fetch::2047 The default set of "refspec" for linkgit:git-fetch[1]. See2048 linkgit:git-fetch[1].20492050remote.<name>.push::2051 The default set of "refspec" for linkgit:git-push[1]. See2052 linkgit:git-push[1].20532054remote.<name>.mirror::2055 If true, pushing to this remote will automatically behave2056 as if the `--mirror` option was given on the command line.20572058remote.<name>.skipDefaultUpdate::2059 If true, this remote will be skipped by default when updating2060 using linkgit:git-fetch[1] or the `update` subcommand of2061 linkgit:git-remote[1].20622063remote.<name>.skipFetchAll::2064 If true, this remote will be skipped by default when updating2065 using linkgit:git-fetch[1] or the `update` subcommand of2066 linkgit:git-remote[1].20672068remote.<name>.receivepack::2069 The default program to execute on the remote side when pushing. See2070 option \--receive-pack of linkgit:git-push[1].20712072remote.<name>.uploadpack::2073 The default program to execute on the remote side when fetching. See2074 option \--upload-pack of linkgit:git-fetch-pack[1].20752076remote.<name>.tagopt::2077 Setting this value to \--no-tags disables automatic tag following when2078 fetching from remote <name>. Setting it to \--tags will fetch every2079 tag from remote <name>, even if they are not reachable from remote2080 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2081 override this setting. See options \--tags and \--no-tags of2082 linkgit:git-fetch[1].20832084remote.<name>.vcs::2085 Setting this to a value <vcs> will cause Git to interact with2086 the remote with the git-remote-<vcs> helper.20872088remote.<name>.prune::2089 When set to true, fetching from this remote by default will also2090 remove any remote-tracking branches which no longer exist on the2091 remote (as if the `--prune` option was give on the command line).2092 Overrides `fetch.prune` settings, if any.20932094remotes.<group>::2095 The list of remotes which are fetched by "git remote update2096 <group>". See linkgit:git-remote[1].20972098repack.usedeltabaseoffset::2099 By default, linkgit:git-repack[1] creates packs that use2100 delta-base offset. If you need to share your repository with2101 Git older than version 1.4.4, either directly or via a dumb2102 protocol such as http, then you need to set this option to2103 "false" and repack. Access from old Git versions over the2104 native protocol are unaffected by this option.21052106rerere.autoupdate::2107 When set to true, `git-rerere` updates the index with the2108 resulting contents after it cleanly resolves conflicts using2109 previously recorded resolution. Defaults to false.21102111rerere.enabled::2112 Activate recording of resolved conflicts, so that identical2113 conflict hunks can be resolved automatically, should they be2114 encountered again. By default, linkgit:git-rerere[1] is2115 enabled if there is an `rr-cache` directory under the2116 `$GIT_DIR`, e.g. if "rerere" was previously used in the2117 repository.21182119sendemail.identity::2120 A configuration identity. When given, causes values in the2121 'sendemail.<identity>' subsection to take precedence over2122 values in the 'sendemail' section. The default identity is2123 the value of 'sendemail.identity'.21242125sendemail.smtpencryption::2126 See linkgit:git-send-email[1] for description. Note that this2127 setting is not subject to the 'identity' mechanism.21282129sendemail.smtpssl::2130 Deprecated alias for 'sendemail.smtpencryption = ssl'.21312132sendemail.smtpsslcertpath::2133 Path to ca-certificates (either a directory or a single file).2134 Set it to an empty string to disable certificate verification.21352136sendemail.<identity>.*::2137 Identity-specific versions of the 'sendemail.*' parameters2138 found below, taking precedence over those when the this2139 identity is selected, through command-line or2140 'sendemail.identity'.21412142sendemail.aliasesfile::2143sendemail.aliasfiletype::2144sendemail.annotate::2145sendemail.bcc::2146sendemail.cc::2147sendemail.cccmd::2148sendemail.chainreplyto::2149sendemail.confirm::2150sendemail.envelopesender::2151sendemail.from::2152sendemail.multiedit::2153sendemail.signedoffbycc::2154sendemail.smtppass::2155sendemail.suppresscc::2156sendemail.suppressfrom::2157sendemail.to::2158sendemail.smtpdomain::2159sendemail.smtpserver::2160sendemail.smtpserverport::2161sendemail.smtpserveroption::2162sendemail.smtpuser::2163sendemail.thread::2164sendemail.validate::2165 See linkgit:git-send-email[1] for description.21662167sendemail.signedoffcc::2168 Deprecated alias for 'sendemail.signedoffbycc'.21692170showbranch.default::2171 The default set of branches for linkgit:git-show-branch[1].2172 See linkgit:git-show-branch[1].21732174status.relativePaths::2175 By default, linkgit:git-status[1] shows paths relative to the2176 current directory. Setting this variable to `false` shows paths2177 relative to the repository root (this was the default for Git2178 prior to v1.5.4).21792180status.short::2181 Set to true to enable --short by default in linkgit:git-status[1].2182 The option --no-short takes precedence over this variable.21832184status.branch::2185 Set to true to enable --branch by default in linkgit:git-status[1].2186 The option --no-branch takes precedence over this variable.21872188status.displayCommentPrefix::2189 If set to true, linkgit:git-status[1] will insert a comment2190 prefix before each output line (starting with2191 `core.commentChar`, i.e. `#` by default). This was the2192 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2193 Defaults to false.21942195status.showUntrackedFiles::2196 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2197 files which are not currently tracked by Git. Directories which2198 contain only untracked files, are shown with the directory name2199 only. Showing untracked files means that Git needs to lstat() all2200 all the files in the whole repository, which might be slow on some2201 systems. So, this variable controls how the commands displays2202 the untracked files. Possible values are:2203+2204--2205* `no` - Show no untracked files.2206* `normal` - Show untracked files and directories.2207* `all` - Show also individual files in untracked directories.2208--2209+2210If this variable is not specified, it defaults to 'normal'.2211This variable can be overridden with the -u|--untracked-files option2212of linkgit:git-status[1] and linkgit:git-commit[1].22132214status.submodulesummary::2215 Defaults to false.2216 If this is set to a non zero number or true (identical to -1 or an2217 unlimited number), the submodule summary will be enabled and a2218 summary of commits for modified submodules will be shown (see2219 --summary-limit option of linkgit:git-submodule[1]). Please note2220 that the summary output command will be suppressed for all2221 submodules when `diff.ignoreSubmodules` is set to 'all' or only2222 for those submodules where `submodule.<name>.ignore=all`. To2223 also view the summary for ignored submodules you can either use2224 the --ignore-submodules=dirty command line option or the 'git2225 submodule summary' command, which shows a similar output but does2226 not honor these settings.22272228submodule.<name>.path::2229submodule.<name>.url::2230submodule.<name>.update::2231 The path within this project, URL, and the updating strategy2232 for a submodule. These variables are initially populated2233 by 'git submodule init'; edit them to override the2234 URL and other values found in the `.gitmodules` file. See2235 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.22362237submodule.<name>.branch::2238 The remote branch name for a submodule, used by `git submodule2239 update --remote`. Set this option to override the value found in2240 the `.gitmodules` file. See linkgit:git-submodule[1] and2241 linkgit:gitmodules[5] for details.22422243submodule.<name>.fetchRecurseSubmodules::2244 This option can be used to control recursive fetching of this2245 submodule. It can be overridden by using the --[no-]recurse-submodules2246 command line option to "git fetch" and "git pull".2247 This setting will override that from in the linkgit:gitmodules[5]2248 file.22492250submodule.<name>.ignore::2251 Defines under what circumstances "git status" and the diff family show2252 a submodule as modified. When set to "all", it will never be considered2253 modified, "dirty" will ignore all changes to the submodules work tree and2254 takes only differences between the HEAD of the submodule and the commit2255 recorded in the superproject into account. "untracked" will additionally2256 let submodules with modified tracked files in their work tree show up.2257 Using "none" (the default when this option is not set) also shows2258 submodules that have untracked files in their work tree as changed.2259 This setting overrides any setting made in .gitmodules for this submodule,2260 both settings can be overridden on the command line by using the2261 "--ignore-submodules" option. The 'git submodule' commands are not2262 affected by this setting.22632264tar.umask::2265 This variable can be used to restrict the permission bits of2266 tar archive entries. The default is 0002, which turns off the2267 world write bit. The special value "user" indicates that the2268 archiving user's umask will be used instead. See umask(2) and2269 linkgit:git-archive[1].22702271transfer.fsckObjects::2272 When `fetch.fsckObjects` or `receive.fsckObjects` are2273 not set, the value of this variable is used instead.2274 Defaults to false.22752276transfer.hiderefs::2277 This variable can be used to set both `receive.hiderefs`2278 and `uploadpack.hiderefs` at the same time to the same2279 values. See entries for these other variables.22802281transfer.unpackLimit::2282 When `fetch.unpackLimit` or `receive.unpackLimit` are2283 not set, the value of this variable is used instead.2284 The default value is 100.22852286uploadpack.hiderefs::2287 String(s) `upload-pack` uses to decide which refs to omit2288 from its initial advertisement. Use more than one2289 definitions to specify multiple prefix strings. A ref that2290 are under the hierarchies listed on the value of this2291 variable is excluded, and is hidden from `git ls-remote`,2292 `git fetch`, etc. An attempt to fetch a hidden ref by `git2293 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.22942295uploadpack.allowtipsha1inwant::2296 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2297 to accept a fetch request that asks for an object at the tip2298 of a hidden ref (by default, such a request is rejected).2299 see also `uploadpack.hiderefs`.23002301uploadpack.keepalive::2302 When `upload-pack` has started `pack-objects`, there may be a2303 quiet period while `pack-objects` prepares the pack. Normally2304 it would output progress information, but if `--quiet` was used2305 for the fetch, `pack-objects` will output nothing at all until2306 the pack data begins. Some clients and networks may consider2307 the server to be hung and give up. Setting this option instructs2308 `upload-pack` to send an empty keepalive packet every2309 `uploadpack.keepalive` seconds. Setting this option to 02310 disables keepalive packets entirely. The default is 5 seconds.23112312url.<base>.insteadOf::2313 Any URL that starts with this value will be rewritten to2314 start, instead, with <base>. In cases where some site serves a2315 large number of repositories, and serves them with multiple2316 access methods, and some users need to use different access2317 methods, this feature allows people to specify any of the2318 equivalent URLs and have Git automatically rewrite the URL to2319 the best alternative for the particular user, even for a2320 never-before-seen repository on the site. When more than one2321 insteadOf strings match a given URL, the longest match is used.23222323url.<base>.pushInsteadOf::2324 Any URL that starts with this value will not be pushed to;2325 instead, it will be rewritten to start with <base>, and the2326 resulting URL will be pushed to. In cases where some site serves2327 a large number of repositories, and serves them with multiple2328 access methods, some of which do not allow push, this feature2329 allows people to specify a pull-only URL and have Git2330 automatically use an appropriate URL to push, even for a2331 never-before-seen repository on the site. When more than one2332 pushInsteadOf strings match a given URL, the longest match is2333 used. If a remote has an explicit pushurl, Git will ignore this2334 setting for that remote.23352336user.email::2337 Your email address to be recorded in any newly created commits.2338 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2339 'EMAIL' environment variables. See linkgit:git-commit-tree[1].23402341user.name::2342 Your full name to be recorded in any newly created commits.2343 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2344 environment variables. See linkgit:git-commit-tree[1].23452346user.signingkey::2347 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2348 key you want it to automatically when creating a signed tag or2349 commit, you can override the default selection with this variable.2350 This option is passed unchanged to gpg's --local-user parameter,2351 so you may specify a key using any method that gpg supports.23522353web.browser::2354 Specify a web browser that may be used by some commands.2355 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2356 may use it.