1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82You can include one config file from another by setting the special 83`include.path` variable to the name of the file to be included. The 84variable takes a pathname as its value, and is subject to tilde 85expansion. 86 87The 88included file is expanded immediately, as if its contents had been 89found at the location of the include directive. If the value of the 90`include.path` variable is a relative path, the path is considered to be 91relative to the configuration file in which the include directive was 92found. See below for examples. 93 94 95Example 96~~~~~~~ 97 98 # Core variables 99 [core] 100 ; Don't trust file modes 101 filemode = false 102 103 # Our diff algorithm 104 [diff] 105 external = /usr/local/bin/diff-wrapper 106 renames = true 107 108 [branch "devel"] 109 remote = origin 110 merge = refs/heads/devel 111 112 # Proxy settings 113 [core] 114 gitProxy="ssh" for "kernel.org" 115 gitProxy=default-proxy ; for the rest 116 117 [include] 118 path = /path/to/foo.inc ; include by absolute path 119 path = foo ; expand "foo" relative to the current file 120 path = ~/foo ; expand "foo" in your `$HOME` directory 121 122 123Values 124~~~~~~ 125 126Values of many variables are treated as a simple string, but there 127are variables that take values of specific types and there are rules 128as to how to spell them. 129 130boolean:: 131 132 When a variable is said to take a boolean value, many 133 synonyms are accepted for 'true' and 'false'; these are all 134 case-insensitive. 135 136 true;; Boolean true can be spelled as `yes`, `on`, `true`, 137 or `1`. Also, a variable defined without `= <value>` 138 is taken as true. 139 140 false;; Boolean false can be spelled as `no`, `off`, 141 `false`, or `0`. 142+ 143When converting value to the canonical form using '--bool' type 144specifier; 'git config' will ensure that the output is "true" or 145"false" (spelled in lowercase). 146 147integer:: 148 The value for many variables that specify various sizes can 149 be suffixed with `k`, `M`,... to mean "scale the number by 150 1024", "by 1024x1024", etc. 151 152color:: 153 The value for a variables that takes a color is a list of 154 colors (at most two) and attributes (at most one), separated 155 by spaces. The colors accepted are `normal`, `black`, 156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and 157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and 158 `reverse`. The first color given is the foreground; the 159 second is the background. The position of the attribute, if 160 any, doesn't matter. Attributes may be turned off specifically 161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc). 162+ 163Colors (foreground and background) may also be given as numbers between 1640 and 255; these use ANSI 256-color mode (but note that not all 165terminals may support this). If your terminal supports it, you may also 166specify 24-bit RGB values as hex, like `#ff0ab3`. 167+ 168The attributes are meant to be reset at the beginning of each item 169in the colored output, so setting color.decorate.branch to `black` 170will paint that branch name in a plain `black`, even if the previous 171thing on the same output line (e.g. opening parenthesis before the 172list of branch names in `log --decorate` output) is set to be 173painted with `bold` or some other attribute. 174 175pathname:: 176 A variable that takes a pathname value can be given a 177 string that begins with "`~/`" or "`~user/`", and the usual 178 tilde expansion happens to such a string: `~/` 179 is expanded to the value of `$HOME`, and `~user/` to the 180 specified user's home directory. 181 182 183Variables 184~~~~~~~~~ 185 186Note that this list is non-comprehensive and not necessarily complete. 187For command-specific variables, you will find a more detailed description 188in the appropriate manual page. 189 190Other git-related tools may and do use their own variables. When 191inventing new variables for use in your own tool, make sure their 192names do not conflict with those that are used by Git itself and 193other popular tools, and describe them in your documentation. 194 195 196advice.*:: 197 These variables control various optional help messages designed to 198 aid new users. All 'advice.*' variables default to 'true', and you 199 can tell Git that you do not need help by setting these to 'false': 200+ 201-- 202 pushUpdateRejected:: 203 Set this variable to 'false' if you want to disable 204 'pushNonFFCurrent', 205 'pushNonFFMatching', 'pushAlreadyExists', 206 'pushFetchFirst', and 'pushNeedsForce' 207 simultaneously. 208 pushNonFFCurrent:: 209 Advice shown when linkgit:git-push[1] fails due to a 210 non-fast-forward update to the current branch. 211 pushNonFFMatching:: 212 Advice shown when you ran linkgit:git-push[1] and pushed 213 'matching refs' explicitly (i.e. you used ':', or 214 specified a refspec that isn't your current branch) and 215 it resulted in a non-fast-forward error. 216 pushAlreadyExists:: 217 Shown when linkgit:git-push[1] rejects an update that 218 does not qualify for fast-forwarding (e.g., a tag.) 219 pushFetchFirst:: 220 Shown when linkgit:git-push[1] rejects an update that 221 tries to overwrite a remote ref that points at an 222 object we do not have. 223 pushNeedsForce:: 224 Shown when linkgit:git-push[1] rejects an update that 225 tries to overwrite a remote ref that points at an 226 object that is not a commit-ish, or make the remote 227 ref point at an object that is not a commit-ish. 228 statusHints:: 229 Show directions on how to proceed from the current 230 state in the output of linkgit:git-status[1], in 231 the template shown when writing commit messages in 232 linkgit:git-commit[1], and in the help message shown 233 by linkgit:git-checkout[1] when switching branch. 234 statusUoption:: 235 Advise to consider using the `-u` option to linkgit:git-status[1] 236 when the command takes more than 2 seconds to enumerate untracked 237 files. 238 commitBeforeMerge:: 239 Advice shown when linkgit:git-merge[1] refuses to 240 merge to avoid overwriting local changes. 241 resolveConflict:: 242 Advice shown by various commands when conflicts 243 prevent the operation from being performed. 244 implicitIdentity:: 245 Advice on how to set your identity configuration when 246 your information is guessed from the system username and 247 domain name. 248 detachedHead:: 249 Advice shown when you used linkgit:git-checkout[1] to 250 move to the detach HEAD state, to instruct how to create 251 a local branch after the fact. 252 amWorkDir:: 253 Advice that shows the location of the patch file when 254 linkgit:git-am[1] fails to apply it. 255 rmHints:: 256 In case of failure in the output of linkgit:git-rm[1], 257 show directions on how to proceed from the current state. 258-- 259 260core.fileMode:: 261 Tells Git if the executable bit of files in the working tree 262 is to be honored. 263+ 264Some filesystems lose the executable bit when a file that is 265marked as executable is checked out, or checks out an 266non-executable file with executable bit on. 267linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 268to see if it handles the executable bit correctly 269and this variable is automatically set as necessary. 270+ 271A repository, however, may be on a filesystem that handles 272the filemode correctly, and this variable is set to 'true' 273when created, but later may be made accessible from another 274environment that loses the filemode (e.g. exporting ext4 via 275CIFS mount, visiting a Cygwin created repository with 276Git for Windows or Eclipse). 277In such a case it may be necessary to set this variable to 'false'. 278See linkgit:git-update-index[1]. 279+ 280The default is true (when core.filemode is not specified in the config file). 281 282core.hideDotFiles:: 283 (Windows-only) If true, mark newly-created directories and files whose 284 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 285 directory is hidden, but no other files starting with a dot. The 286 default mode is 'dotGitOnly'. 287 288core.ignoreCase:: 289 If true, this option enables various workarounds to enable 290 Git to work better on filesystems that are not case sensitive, 291 like FAT. For example, if a directory listing finds 292 "makefile" when Git expects "Makefile", Git will assume 293 it is really the same file, and continue to remember it as 294 "Makefile". 295+ 296The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 297will probe and set core.ignoreCase true if appropriate when the repository 298is created. 299 300core.precomposeUnicode:: 301 This option is only used by Mac OS implementation of Git. 302 When core.precomposeUnicode=true, Git reverts the unicode decomposition 303 of filenames done by Mac OS. This is useful when sharing a repository 304 between Mac OS and Linux or Windows. 305 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 306 When false, file names are handled fully transparent by Git, 307 which is backward compatible with older versions of Git. 308 309core.protectHFS:: 310 If set to true, do not allow checkout of paths that would 311 be considered equivalent to `.git` on an HFS+ filesystem. 312 Defaults to `true` on Mac OS, and `false` elsewhere. 313 314core.protectNTFS:: 315 If set to true, do not allow checkout of paths that would 316 cause problems with the NTFS filesystem, e.g. conflict with 317 8.3 "short" names. 318 Defaults to `true` on Windows, and `false` elsewhere. 319 320core.trustctime:: 321 If false, the ctime differences between the index and the 322 working tree are ignored; useful when the inode change time 323 is regularly modified by something outside Git (file system 324 crawlers and some backup systems). 325 See linkgit:git-update-index[1]. True by default. 326 327core.untrackedCache:: 328 Determines what to do about the untracked cache feature of the 329 index. It will be kept, if this variable is unset or set to 330 `keep`. It will automatically be added if set to `true`. And 331 it will automatically be removed, if set to `false`. Before 332 setting it to `true`, you should check that mtime is working 333 properly on your system. 334 See linkgit:git-update-index[1]. `keep` by default. 335 336core.checkStat:: 337 Determines which stat fields to match between the index 338 and work tree. The user can set this to 'default' or 339 'minimal'. Default (or explicitly 'default'), is to check 340 all fields, including the sub-second part of mtime and ctime. 341 342core.quotePath:: 343 The commands that output paths (e.g. 'ls-files', 344 'diff'), when not given the `-z` option, will quote 345 "unusual" characters in the pathname by enclosing the 346 pathname in a double-quote pair and with backslashes the 347 same way strings in C source code are quoted. If this 348 variable is set to false, the bytes higher than 0x80 are 349 not quoted but output as verbatim. Note that double 350 quote, backslash and control characters are always 351 quoted without `-z` regardless of the setting of this 352 variable. 353 354core.eol:: 355 Sets the line ending type to use in the working directory for 356 files that have the `text` property set when core.autocrlf is false. 357 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 358 native line ending. The default value is `native`. See 359 linkgit:gitattributes[5] for more information on end-of-line 360 conversion. 361 362core.safecrlf:: 363 If true, makes Git check if converting `CRLF` is reversible when 364 end-of-line conversion is active. Git will verify if a command 365 modifies a file in the work tree either directly or indirectly. 366 For example, committing a file followed by checking out the 367 same file should yield the original file in the work tree. If 368 this is not the case for the current setting of 369 `core.autocrlf`, Git will reject the file. The variable can 370 be set to "warn", in which case Git will only warn about an 371 irreversible conversion but continue the operation. 372+ 373CRLF conversion bears a slight chance of corrupting data. 374When it is enabled, Git will convert CRLF to LF during commit and LF to 375CRLF during checkout. A file that contains a mixture of LF and 376CRLF before the commit cannot be recreated by Git. For text 377files this is the right thing to do: it corrects line endings 378such that we have only LF line endings in the repository. 379But for binary files that are accidentally classified as text the 380conversion can corrupt data. 381+ 382If you recognize such corruption early you can easily fix it by 383setting the conversion type explicitly in .gitattributes. Right 384after committing you still have the original file in your work 385tree and this file is not yet corrupted. You can explicitly tell 386Git that this file is binary and Git will handle the file 387appropriately. 388+ 389Unfortunately, the desired effect of cleaning up text files with 390mixed line endings and the undesired effect of corrupting binary 391files cannot be distinguished. In both cases CRLFs are removed 392in an irreversible way. For text files this is the right thing 393to do because CRLFs are line endings, while for binary files 394converting CRLFs corrupts data. 395+ 396Note, this safety check does not mean that a checkout will generate a 397file identical to the original file for a different setting of 398`core.eol` and `core.autocrlf`, but only for the current one. For 399example, a text file with `LF` would be accepted with `core.eol=lf` 400and could later be checked out with `core.eol=crlf`, in which case the 401resulting file would contain `CRLF`, although the original file 402contained `LF`. However, in both work trees the line endings would be 403consistent, that is either all `LF` or all `CRLF`, but never mixed. A 404file with mixed line endings would be reported by the `core.safecrlf` 405mechanism. 406 407core.autocrlf:: 408 Setting this variable to "true" is almost the same as setting 409 the `text` attribute to "auto" on all files except that text 410 files are not guaranteed to be normalized: files that contain 411 `CRLF` in the repository will not be touched. Use this 412 setting if you want to have `CRLF` line endings in your 413 working directory even though the repository does not have 414 normalized line endings. This variable can be set to 'input', 415 in which case no output conversion is performed. 416 417core.symlinks:: 418 If false, symbolic links are checked out as small plain files that 419 contain the link text. linkgit:git-update-index[1] and 420 linkgit:git-add[1] will not change the recorded type to regular 421 file. Useful on filesystems like FAT that do not support 422 symbolic links. 423+ 424The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 425will probe and set core.symlinks false if appropriate when the repository 426is created. 427 428core.gitProxy:: 429 A "proxy command" to execute (as 'command host port') instead 430 of establishing direct connection to the remote server when 431 using the Git protocol for fetching. If the variable value is 432 in the "COMMAND for DOMAIN" format, the command is applied only 433 on hostnames ending with the specified domain string. This variable 434 may be set multiple times and is matched in the given order; 435 the first match wins. 436+ 437Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 438(which always applies universally, without the special "for" 439handling). 440+ 441The special string `none` can be used as the proxy command to 442specify that no proxy be used for a given domain pattern. 443This is useful for excluding servers inside a firewall from 444proxy use, while defaulting to a common proxy for external domains. 445 446core.ignoreStat:: 447 If true, Git will avoid using lstat() calls to detect if files have 448 changed by setting the "assume-unchanged" bit for those tracked files 449 which it has updated identically in both the index and working tree. 450+ 451When files are modified outside of Git, the user will need to stage 452the modified files explicitly (e.g. see 'Examples' section in 453linkgit:git-update-index[1]). 454Git will not normally detect changes to those files. 455+ 456This is useful on systems where lstat() calls are very slow, such as 457CIFS/Microsoft Windows. 458+ 459False by default. 460 461core.preferSymlinkRefs:: 462 Instead of the default "symref" format for HEAD 463 and other symbolic reference files, use symbolic links. 464 This is sometimes needed to work with old scripts that 465 expect HEAD to be a symbolic link. 466 467core.bare:: 468 If true this repository is assumed to be 'bare' and has no 469 working directory associated with it. If this is the case a 470 number of commands that require a working directory will be 471 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 472+ 473This setting is automatically guessed by linkgit:git-clone[1] or 474linkgit:git-init[1] when the repository was created. By default a 475repository that ends in "/.git" is assumed to be not bare (bare = 476false), while all other repositories are assumed to be bare (bare 477= true). 478 479core.worktree:: 480 Set the path to the root of the working tree. 481 If GIT_COMMON_DIR environment variable is set, core.worktree 482 is ignored and not used for determining the root of working tree. 483 This can be overridden by the GIT_WORK_TREE environment 484 variable and the '--work-tree' command-line option. 485 The value can be an absolute path or relative to the path to 486 the .git directory, which is either specified by --git-dir 487 or GIT_DIR, or automatically discovered. 488 If --git-dir or GIT_DIR is specified but none of 489 --work-tree, GIT_WORK_TREE and core.worktree is specified, 490 the current working directory is regarded as the top level 491 of your working tree. 492+ 493Note that this variable is honored even when set in a configuration 494file in a ".git" subdirectory of a directory and its value differs 495from the latter directory (e.g. "/path/to/.git/config" has 496core.worktree set to "/different/path"), which is most likely a 497misconfiguration. Running Git commands in the "/path/to" directory will 498still use "/different/path" as the root of the work tree and can cause 499confusion unless you know what you are doing (e.g. you are creating a 500read-only snapshot of the same index to a location different from the 501repository's usual working tree). 502 503core.logAllRefUpdates:: 504 Enable the reflog. Updates to a ref <ref> is logged to the file 505 "`$GIT_DIR/logs/<ref>`", by appending the new and old 506 SHA-1, the date/time and the reason of the update, but 507 only when the file exists. If this configuration 508 variable is set to true, missing "`$GIT_DIR/logs/<ref>`" 509 file is automatically created for branch heads (i.e. under 510 refs/heads/), remote refs (i.e. under refs/remotes/), 511 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 512+ 513This information can be used to determine what commit 514was the tip of a branch "2 days ago". 515+ 516This value is true by default in a repository that has 517a working directory associated with it, and false by 518default in a bare repository. 519 520core.repositoryFormatVersion:: 521 Internal variable identifying the repository format and layout 522 version. 523 524core.sharedRepository:: 525 When 'group' (or 'true'), the repository is made shareable between 526 several users in a group (making sure all the files and objects are 527 group-writable). When 'all' (or 'world' or 'everybody'), the 528 repository will be readable by all users, additionally to being 529 group-shareable. When 'umask' (or 'false'), Git will use permissions 530 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 531 files in the repository will have this mode value. '0xxx' will override 532 user's umask value (whereas the other options will only override 533 requested parts of the user's umask value). Examples: '0660' will make 534 the repo read/write-able for the owner and group, but inaccessible to 535 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 536 repository that is group-readable but not group-writable. 537 See linkgit:git-init[1]. False by default. 538 539core.warnAmbiguousRefs:: 540 If true, Git will warn you if the ref name you passed it is ambiguous 541 and might match multiple refs in the repository. True by default. 542 543core.compression:: 544 An integer -1..9, indicating a default compression level. 545 -1 is the zlib default. 0 means no compression, 546 and 1..9 are various speed/size tradeoffs, 9 being slowest. 547 If set, this provides a default to other compression variables, 548 such as 'core.looseCompression' and 'pack.compression'. 549 550core.looseCompression:: 551 An integer -1..9, indicating the compression level for objects that 552 are not in a pack file. -1 is the zlib default. 0 means no 553 compression, and 1..9 are various speed/size tradeoffs, 9 being 554 slowest. If not set, defaults to core.compression. If that is 555 not set, defaults to 1 (best speed). 556 557core.packedGitWindowSize:: 558 Number of bytes of a pack file to map into memory in a 559 single mapping operation. Larger window sizes may allow 560 your system to process a smaller number of large pack files 561 more quickly. Smaller window sizes will negatively affect 562 performance due to increased calls to the operating system's 563 memory manager, but may improve performance when accessing 564 a large number of large pack files. 565+ 566Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 567MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 568be reasonable for all users/operating systems. You probably do 569not need to adjust this value. 570+ 571Common unit suffixes of 'k', 'm', or 'g' are supported. 572 573core.packedGitLimit:: 574 Maximum number of bytes to map simultaneously into memory 575 from pack files. If Git needs to access more than this many 576 bytes at once to complete an operation it will unmap existing 577 regions to reclaim virtual address space within the process. 578+ 579Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 580This should be reasonable for all users/operating systems, except on 581the largest projects. You probably do not need to adjust this value. 582+ 583Common unit suffixes of 'k', 'm', or 'g' are supported. 584 585core.deltaBaseCacheLimit:: 586 Maximum number of bytes to reserve for caching base objects 587 that may be referenced by multiple deltified objects. By storing the 588 entire decompressed base objects in a cache Git is able 589 to avoid unpacking and decompressing frequently used base 590 objects multiple times. 591+ 592Default is 96 MiB on all platforms. This should be reasonable 593for all users/operating systems, except on the largest projects. 594You probably do not need to adjust this value. 595+ 596Common unit suffixes of 'k', 'm', or 'g' are supported. 597 598core.bigFileThreshold:: 599 Files larger than this size are stored deflated, without 600 attempting delta compression. Storing large files without 601 delta compression avoids excessive memory usage, at the 602 slight expense of increased disk usage. Additionally files 603 larger than this size are always treated as binary. 604+ 605Default is 512 MiB on all platforms. This should be reasonable 606for most projects as source code and other text files can still 607be delta compressed, but larger binary media files won't be. 608+ 609Common unit suffixes of 'k', 'm', or 'g' are supported. 610 611core.excludesFile:: 612 Specifies the pathname to the file that contains patterns to 613 describe paths that are not meant to be tracked, in addition 614 to '.gitignore' (per-directory) and '.git/info/exclude'. 615 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 616 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 617 is used instead. See linkgit:gitignore[5]. 618 619core.askPass:: 620 Some commands (e.g. svn and http interfaces) that interactively 621 ask for a password can be told to use an external program given 622 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 623 environment variable. If not set, fall back to the value of the 624 'SSH_ASKPASS' environment variable or, failing that, a simple password 625 prompt. The external program shall be given a suitable prompt as 626 command-line argument and write the password on its STDOUT. 627 628core.attributesFile:: 629 In addition to '.gitattributes' (per-directory) and 630 '.git/info/attributes', Git looks into this file for attributes 631 (see linkgit:gitattributes[5]). Path expansions are made the same 632 way as for `core.excludesFile`. Its default value is 633 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 634 set or empty, `$HOME/.config/git/attributes` is used instead. 635 636core.hooksPath:: 637 By default Git will look for your hooks in the 638 '$GIT_DIR/hooks' directory. Set this to different path, 639 e.g. '/etc/git/hooks', and Git will try to find your hooks in 640 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 641 in '$GIT_DIR/hooks/pre-receive'. 642+ 643The path can be either absolute or relative. A relative path is 644taken as relative to the directory where the hooks are run (see 645the "DESCRIPTION" section of linkgit:githooks[5]). 646+ 647This configuration variable is useful in cases where you'd like to 648centrally configure your Git hooks instead of configuring them on a 649per-repository basis, or as a more flexible and centralized 650alternative to having an `init.templateDir` where you've changed 651default hooks. 652 653core.editor:: 654 Commands such as `commit` and `tag` that lets you edit 655 messages by launching an editor uses the value of this 656 variable when it is set, and the environment variable 657 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 658 659core.commentChar:: 660 Commands such as `commit` and `tag` that lets you edit 661 messages consider a line that begins with this character 662 commented, and removes them after the editor returns 663 (default '#'). 664+ 665If set to "auto", `git-commit` would select a character that is not 666the beginning character of any line in existing commit messages. 667 668core.packedRefsTimeout:: 669 The length of time, in milliseconds, to retry when trying to 670 lock the `packed-refs` file. Value 0 means not to retry at 671 all; -1 means to try indefinitely. Default is 1000 (i.e., 672 retry for 1 second). 673 674sequence.editor:: 675 Text editor used by `git rebase -i` for editing the rebase instruction file. 676 The value is meant to be interpreted by the shell when it is used. 677 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 678 When not configured the default commit message editor is used instead. 679 680core.pager:: 681 Text viewer for use by Git commands (e.g., 'less'). The value 682 is meant to be interpreted by the shell. The order of preference 683 is the `$GIT_PAGER` environment variable, then `core.pager` 684 configuration, then `$PAGER`, and then the default chosen at 685 compile time (usually 'less'). 686+ 687When the `LESS` environment variable is unset, Git sets it to `FRX` 688(if `LESS` environment variable is set, Git does not change it at 689all). If you want to selectively override Git's default setting 690for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 691be passed to the shell by Git, which will translate the final 692command to `LESS=FRX less -S`. The environment does not set the 693`S` option but the command line does, instructing less to truncate 694long lines. Similarly, setting `core.pager` to `less -+F` will 695deactivate the `F` option specified by the environment from the 696command-line, deactivating the "quit if one screen" behavior of 697`less`. One can specifically activate some flags for particular 698commands: for example, setting `pager.blame` to `less -S` enables 699line truncation only for `git blame`. 700+ 701Likewise, when the `LV` environment variable is unset, Git sets it 702to `-c`. You can override this setting by exporting `LV` with 703another value or setting `core.pager` to `lv +c`. 704 705core.whitespace:: 706 A comma separated list of common whitespace problems to 707 notice. 'git diff' will use `color.diff.whitespace` to 708 highlight them, and 'git apply --whitespace=error' will 709 consider them as errors. You can prefix `-` to disable 710 any of them (e.g. `-trailing-space`): 711+ 712* `blank-at-eol` treats trailing whitespaces at the end of the line 713 as an error (enabled by default). 714* `space-before-tab` treats a space character that appears immediately 715 before a tab character in the initial indent part of the line as an 716 error (enabled by default). 717* `indent-with-non-tab` treats a line that is indented with space 718 characters instead of the equivalent tabs as an error (not enabled by 719 default). 720* `tab-in-indent` treats a tab character in the initial indent part of 721 the line as an error (not enabled by default). 722* `blank-at-eof` treats blank lines added at the end of file as an error 723 (enabled by default). 724* `trailing-space` is a short-hand to cover both `blank-at-eol` and 725 `blank-at-eof`. 726* `cr-at-eol` treats a carriage-return at the end of line as 727 part of the line terminator, i.e. with it, `trailing-space` 728 does not trigger if the character before such a carriage-return 729 is not a whitespace (not enabled by default). 730* `tabwidth=<n>` tells how many character positions a tab occupies; this 731 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 732 errors. The default tab width is 8. Allowed values are 1 to 63. 733 734core.fsyncObjectFiles:: 735 This boolean will enable 'fsync()' when writing object files. 736+ 737This is a total waste of time and effort on a filesystem that orders 738data writes properly, but can be useful for filesystems that do not use 739journalling (traditional UNIX filesystems) or that only journal metadata 740and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 741 742core.preloadIndex:: 743 Enable parallel index preload for operations like 'git diff' 744+ 745This can speed up operations like 'git diff' and 'git status' especially 746on filesystems like NFS that have weak caching semantics and thus 747relatively high IO latencies. When enabled, Git will do the 748index comparison to the filesystem data in parallel, allowing 749overlapping IO's. Defaults to true. 750 751core.createObject:: 752 You can set this to 'link', in which case a hardlink followed by 753 a delete of the source are used to make sure that object creation 754 will not overwrite existing objects. 755+ 756On some file system/operating system combinations, this is unreliable. 757Set this config setting to 'rename' there; However, This will remove the 758check that makes sure that existing object files will not get overwritten. 759 760core.notesRef:: 761 When showing commit messages, also show notes which are stored in 762 the given ref. The ref must be fully qualified. If the given 763 ref does not exist, it is not an error but means that no 764 notes should be printed. 765+ 766This setting defaults to "refs/notes/commits", and it can be overridden by 767the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 768 769core.sparseCheckout:: 770 Enable "sparse checkout" feature. See section "Sparse checkout" in 771 linkgit:git-read-tree[1] for more information. 772 773core.abbrev:: 774 Set the length object names are abbreviated to. If unspecified, 775 many commands abbreviate to 7 hexdigits, which may not be enough 776 for abbreviated object names to stay unique for sufficiently long 777 time. 778 779add.ignoreErrors:: 780add.ignore-errors (deprecated):: 781 Tells 'git add' to continue adding files when some files cannot be 782 added due to indexing errors. Equivalent to the '--ignore-errors' 783 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 784 as it does not follow the usual naming convention for configuration 785 variables. 786 787alias.*:: 788 Command aliases for the linkgit:git[1] command wrapper - e.g. 789 after defining "alias.last = cat-file commit HEAD", the invocation 790 "git last" is equivalent to "git cat-file commit HEAD". To avoid 791 confusion and troubles with script usage, aliases that 792 hide existing Git commands are ignored. Arguments are split by 793 spaces, the usual shell quoting and escaping is supported. 794 A quote pair or a backslash can be used to quote them. 795+ 796If the alias expansion is prefixed with an exclamation point, 797it will be treated as a shell command. For example, defining 798"alias.new = !gitk --all --not ORIG_HEAD", the invocation 799"git new" is equivalent to running the shell command 800"gitk --all --not ORIG_HEAD". Note that shell commands will be 801executed from the top-level directory of a repository, which may 802not necessarily be the current directory. 803'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 804from the original current directory. See linkgit:git-rev-parse[1]. 805 806am.keepcr:: 807 If true, git-am will call git-mailsplit for patches in mbox format 808 with parameter '--keep-cr'. In this case git-mailsplit will 809 not remove `\r` from lines ending with `\r\n`. Can be overridden 810 by giving '--no-keep-cr' from the command line. 811 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 812 813am.threeWay:: 814 By default, `git am` will fail if the patch does not apply cleanly. When 815 set to true, this setting tells `git am` to fall back on 3-way merge if 816 the patch records the identity of blobs it is supposed to apply to and 817 we have those blobs available locally (equivalent to giving the `--3way` 818 option from the command line). Defaults to `false`. 819 See linkgit:git-am[1]. 820 821apply.ignoreWhitespace:: 822 When set to 'change', tells 'git apply' to ignore changes in 823 whitespace, in the same way as the '--ignore-space-change' 824 option. 825 When set to one of: no, none, never, false tells 'git apply' to 826 respect all whitespace differences. 827 See linkgit:git-apply[1]. 828 829apply.whitespace:: 830 Tells 'git apply' how to handle whitespaces, in the same way 831 as the '--whitespace' option. See linkgit:git-apply[1]. 832 833branch.autoSetupMerge:: 834 Tells 'git branch' and 'git checkout' to set up new branches 835 so that linkgit:git-pull[1] will appropriately merge from the 836 starting point branch. Note that even if this option is not set, 837 this behavior can be chosen per-branch using the `--track` 838 and `--no-track` options. The valid settings are: `false` -- no 839 automatic setup is done; `true` -- automatic setup is done when the 840 starting point is a remote-tracking branch; `always` -- 841 automatic setup is done when the starting point is either a 842 local branch or remote-tracking 843 branch. This option defaults to true. 844 845branch.autoSetupRebase:: 846 When a new branch is created with 'git branch' or 'git checkout' 847 that tracks another branch, this variable tells Git to set 848 up pull to rebase instead of merge (see "branch.<name>.rebase"). 849 When `never`, rebase is never automatically set to true. 850 When `local`, rebase is set to true for tracked branches of 851 other local branches. 852 When `remote`, rebase is set to true for tracked branches of 853 remote-tracking branches. 854 When `always`, rebase will be set to true for all tracking 855 branches. 856 See "branch.autoSetupMerge" for details on how to set up a 857 branch to track another branch. 858 This option defaults to never. 859 860branch.<name>.remote:: 861 When on branch <name>, it tells 'git fetch' and 'git push' 862 which remote to fetch from/push to. The remote to push to 863 may be overridden with `remote.pushDefault` (for all branches). 864 The remote to push to, for the current branch, may be further 865 overridden by `branch.<name>.pushRemote`. If no remote is 866 configured, or if you are not on any branch, it defaults to 867 `origin` for fetching and `remote.pushDefault` for pushing. 868 Additionally, `.` (a period) is the current local repository 869 (a dot-repository), see `branch.<name>.merge`'s final note below. 870 871branch.<name>.pushRemote:: 872 When on branch <name>, it overrides `branch.<name>.remote` for 873 pushing. It also overrides `remote.pushDefault` for pushing 874 from branch <name>. When you pull from one place (e.g. your 875 upstream) and push to another place (e.g. your own publishing 876 repository), you would want to set `remote.pushDefault` to 877 specify the remote to push to for all branches, and use this 878 option to override it for a specific branch. 879 880branch.<name>.merge:: 881 Defines, together with branch.<name>.remote, the upstream branch 882 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 883 branch to merge and can also affect 'git push' (see push.default). 884 When in branch <name>, it tells 'git fetch' the default 885 refspec to be marked for merging in FETCH_HEAD. The value is 886 handled like the remote part of a refspec, and must match a 887 ref which is fetched from the remote given by 888 "branch.<name>.remote". 889 The merge information is used by 'git pull' (which at first calls 890 'git fetch') to lookup the default branch for merging. Without 891 this option, 'git pull' defaults to merge the first refspec fetched. 892 Specify multiple values to get an octopus merge. 893 If you wish to setup 'git pull' so that it merges into <name> from 894 another branch in the local repository, you can point 895 branch.<name>.merge to the desired branch, and use the relative path 896 setting `.` (a period) for branch.<name>.remote. 897 898branch.<name>.mergeOptions:: 899 Sets default options for merging into branch <name>. The syntax and 900 supported options are the same as those of linkgit:git-merge[1], but 901 option values containing whitespace characters are currently not 902 supported. 903 904branch.<name>.rebase:: 905 When true, rebase the branch <name> on top of the fetched branch, 906 instead of merging the default branch from the default remote when 907 "git pull" is run. See "pull.rebase" for doing this in a non 908 branch-specific manner. 909+ 910When preserve, also pass `--preserve-merges` along to 'git rebase' 911so that locally committed merge commits will not be flattened 912by running 'git pull'. 913+ 914When the value is `interactive`, the rebase is run in interactive mode. 915+ 916*NOTE*: this is a possibly dangerous operation; do *not* use 917it unless you understand the implications (see linkgit:git-rebase[1] 918for details). 919 920branch.<name>.description:: 921 Branch description, can be edited with 922 `git branch --edit-description`. Branch description is 923 automatically added in the format-patch cover letter or 924 request-pull summary. 925 926browser.<tool>.cmd:: 927 Specify the command to invoke the specified browser. The 928 specified command is evaluated in shell with the URLs passed 929 as arguments. (See linkgit:git-web{litdd}browse[1].) 930 931browser.<tool>.path:: 932 Override the path for the given tool that may be used to 933 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 934 working repository in gitweb (see linkgit:git-instaweb[1]). 935 936clean.requireForce:: 937 A boolean to make git-clean do nothing unless given -f, 938 -i or -n. Defaults to true. 939 940color.branch:: 941 A boolean to enable/disable color in the output of 942 linkgit:git-branch[1]. May be set to `always`, 943 `false` (or `never`) or `auto` (or `true`), in which case colors are used 944 only when the output is to a terminal. Defaults to false. 945 946color.branch.<slot>:: 947 Use customized color for branch coloration. `<slot>` is one of 948 `current` (the current branch), `local` (a local branch), 949 `remote` (a remote-tracking branch in refs/remotes/), 950 `upstream` (upstream tracking branch), `plain` (other 951 refs). 952 953color.diff:: 954 Whether to use ANSI escape sequences to add color to patches. 955 If this is set to `always`, linkgit:git-diff[1], 956 linkgit:git-log[1], and linkgit:git-show[1] will use color 957 for all patches. If it is set to `true` or `auto`, those 958 commands will only use color when output is to the terminal. 959 Defaults to false. 960+ 961This does not affect linkgit:git-format-patch[1] or the 962'git-diff-{asterisk}' plumbing commands. Can be overridden on the 963command line with the `--color[=<when>]` option. 964 965color.diff.<slot>:: 966 Use customized color for diff colorization. `<slot>` specifies 967 which part of the patch to use the specified color, and is one 968 of `context` (context text - `plain` is a historical synonym), 969 `meta` (metainformation), `frag` 970 (hunk header), 'func' (function in hunk header), `old` (removed lines), 971 `new` (added lines), `commit` (commit headers), or `whitespace` 972 (highlighting whitespace errors). 973 974color.decorate.<slot>:: 975 Use customized color for 'git log --decorate' output. `<slot>` is one 976 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 977 branches, remote-tracking branches, tags, stash and HEAD, respectively. 978 979color.grep:: 980 When set to `always`, always highlight matches. When `false` (or 981 `never`), never. When set to `true` or `auto`, use color only 982 when the output is written to the terminal. Defaults to `false`. 983 984color.grep.<slot>:: 985 Use customized color for grep colorization. `<slot>` specifies which 986 part of the line to use the specified color, and is one of 987+ 988-- 989`context`;; 990 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 991`filename`;; 992 filename prefix (when not using `-h`) 993`function`;; 994 function name lines (when using `-p`) 995`linenumber`;; 996 line number prefix (when using `-n`) 997`match`;; 998 matching text (same as setting `matchContext` and `matchSelected`) 999`matchContext`;;1000 matching text in context lines1001`matchSelected`;;1002 matching text in selected lines1003`selected`;;1004 non-matching text in selected lines1005`separator`;;1006 separators between fields on a line (`:`, `-`, and `=`)1007 and between hunks (`--`)1008--10091010color.interactive::1011 When set to `always`, always use colors for interactive prompts1012 and displays (such as those used by "git-add --interactive" and1013 "git-clean --interactive"). When false (or `never`), never.1014 When set to `true` or `auto`, use colors only when the output is1015 to the terminal. Defaults to false.10161017color.interactive.<slot>::1018 Use customized color for 'git add --interactive' and 'git clean1019 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1020 or `error`, for four distinct types of normal output from1021 interactive commands.10221023color.pager::1024 A boolean to enable/disable colored output when the pager is in1025 use (default is true).10261027color.showBranch::1028 A boolean to enable/disable color in the output of1029 linkgit:git-show-branch[1]. May be set to `always`,1030 `false` (or `never`) or `auto` (or `true`), in which case colors are used1031 only when the output is to a terminal. Defaults to false.10321033color.status::1034 A boolean to enable/disable color in the output of1035 linkgit:git-status[1]. May be set to `always`,1036 `false` (or `never`) or `auto` (or `true`), in which case colors are used1037 only when the output is to a terminal. Defaults to false.10381039color.status.<slot>::1040 Use customized color for status colorization. `<slot>` is1041 one of `header` (the header text of the status message),1042 `added` or `updated` (files which are added but not committed),1043 `changed` (files which are changed but not added in the index),1044 `untracked` (files which are not tracked by Git),1045 `branch` (the current branch),1046 `nobranch` (the color the 'no branch' warning is shown in, defaulting1047 to red), or1048 `unmerged` (files which have unmerged changes).10491050color.ui::1051 This variable determines the default value for variables such1052 as `color.diff` and `color.grep` that control the use of color1053 per command family. Its scope will expand as more commands learn1054 configuration to set a default for the `--color` option. Set it1055 to `false` or `never` if you prefer Git commands not to use1056 color unless enabled explicitly with some other configuration1057 or the `--color` option. Set it to `always` if you want all1058 output not intended for machine consumption to use color, to1059 `true` or `auto` (this is the default since Git 1.8.4) if you1060 want such output to use color when written to the terminal.10611062column.ui::1063 Specify whether supported commands should output in columns.1064 This variable consists of a list of tokens separated by spaces1065 or commas:1066+1067These options control when the feature should be enabled1068(defaults to 'never'):1069+1070--1071`always`;;1072 always show in columns1073`never`;;1074 never show in columns1075`auto`;;1076 show in columns if the output is to the terminal1077--1078+1079These options control layout (defaults to 'column'). Setting any1080of these implies 'always' if none of 'always', 'never', or 'auto' are1081specified.1082+1083--1084`column`;;1085 fill columns before rows1086`row`;;1087 fill rows before columns1088`plain`;;1089 show in one column1090--1091+1092Finally, these options can be combined with a layout option (defaults1093to 'nodense'):1094+1095--1096`dense`;;1097 make unequal size columns to utilize more space1098`nodense`;;1099 make equal size columns1100--11011102column.branch::1103 Specify whether to output branch listing in `git branch` in columns.1104 See `column.ui` for details.11051106column.clean::1107 Specify the layout when list items in `git clean -i`, which always1108 shows files and directories in columns. See `column.ui` for details.11091110column.status::1111 Specify whether to output untracked files in `git status` in columns.1112 See `column.ui` for details.11131114column.tag::1115 Specify whether to output tag listing in `git tag` in columns.1116 See `column.ui` for details.11171118commit.cleanup::1119 This setting overrides the default of the `--cleanup` option in1120 `git commit`. See linkgit:git-commit[1] for details. Changing the1121 default can be useful when you always want to keep lines that begin1122 with comment character `#` in your log message, in which case you1123 would do `git config commit.cleanup whitespace` (note that you will1124 have to remove the help lines that begin with `#` in the commit log1125 template yourself, if you do this).11261127commit.gpgSign::11281129 A boolean to specify whether all commits should be GPG signed.1130 Use of this option when doing operations such as rebase can1131 result in a large number of commits being signed. It may be1132 convenient to use an agent to avoid typing your GPG passphrase1133 several times.11341135commit.status::1136 A boolean to enable/disable inclusion of status information in the1137 commit message template when using an editor to prepare the commit1138 message. Defaults to true.11391140commit.template::1141 Specify the pathname of a file to use as the template for1142 new commit messages.11431144credential.helper::1145 Specify an external helper to be called when a username or1146 password credential is needed; the helper may consult external1147 storage to avoid prompting the user for the credentials. Note1148 that multiple helpers may be defined. See linkgit:gitcredentials[7]1149 for details.11501151credential.useHttpPath::1152 When acquiring credentials, consider the "path" component of an http1153 or https URL to be important. Defaults to false. See1154 linkgit:gitcredentials[7] for more information.11551156credential.username::1157 If no username is set for a network authentication, use this username1158 by default. See credential.<context>.* below, and1159 linkgit:gitcredentials[7].11601161credential.<url>.*::1162 Any of the credential.* options above can be applied selectively to1163 some credentials. For example "credential.https://example.com.username"1164 would set the default username only for https connections to1165 example.com. See linkgit:gitcredentials[7] for details on how URLs are1166 matched.11671168credentialCache.ignoreSIGHUP::1169 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11701171include::diff-config.txt[]11721173difftool.<tool>.path::1174 Override the path for the given tool. This is useful in case1175 your tool is not in the PATH.11761177difftool.<tool>.cmd::1178 Specify the command to invoke the specified diff tool.1179 The specified command is evaluated in shell with the following1180 variables available: 'LOCAL' is set to the name of the temporary1181 file containing the contents of the diff pre-image and 'REMOTE'1182 is set to the name of the temporary file containing the contents1183 of the diff post-image.11841185difftool.prompt::1186 Prompt before each invocation of the diff tool.11871188fetch.recurseSubmodules::1189 This option can be either set to a boolean value or to 'on-demand'.1190 Setting it to a boolean changes the behavior of fetch and pull to1191 unconditionally recurse into submodules when set to true or to not1192 recurse at all when set to false. When set to 'on-demand' (the default1193 value), fetch and pull will only recurse into a populated submodule1194 when its superproject retrieves a commit that updates the submodule's1195 reference.11961197fetch.fsckObjects::1198 If it is set to true, git-fetch-pack will check all fetched1199 objects. It will abort in the case of a malformed object or a1200 broken link. The result of an abort are only dangling objects.1201 Defaults to false. If not set, the value of `transfer.fsckObjects`1202 is used instead.12031204fetch.unpackLimit::1205 If the number of objects fetched over the Git native1206 transfer is below this1207 limit, then the objects will be unpacked into loose object1208 files. However if the number of received objects equals or1209 exceeds this limit then the received pack will be stored as1210 a pack, after adding any missing delta bases. Storing the1211 pack from a push can make the push operation complete faster,1212 especially on slow filesystems. If not set, the value of1213 `transfer.unpackLimit` is used instead.12141215fetch.prune::1216 If true, fetch will automatically behave as if the `--prune`1217 option was given on the command line. See also `remote.<name>.prune`.12181219format.attach::1220 Enable multipart/mixed attachments as the default for1221 'format-patch'. The value can also be a double quoted string1222 which will enable attachments as the default and set the1223 value as the boundary. See the --attach option in1224 linkgit:git-format-patch[1].12251226format.numbered::1227 A boolean which can enable or disable sequence numbers in patch1228 subjects. It defaults to "auto" which enables it only if there1229 is more than one patch. It can be enabled or disabled for all1230 messages by setting it to "true" or "false". See --numbered1231 option in linkgit:git-format-patch[1].12321233format.headers::1234 Additional email headers to include in a patch to be submitted1235 by mail. See linkgit:git-format-patch[1].12361237format.to::1238format.cc::1239 Additional recipients to include in a patch to be submitted1240 by mail. See the --to and --cc options in1241 linkgit:git-format-patch[1].12421243format.subjectPrefix::1244 The default for format-patch is to output files with the '[PATCH]'1245 subject prefix. Use this variable to change that prefix.12461247format.signature::1248 The default for format-patch is to output a signature containing1249 the Git version number. Use this variable to change that default.1250 Set this variable to the empty string ("") to suppress1251 signature generation.12521253format.signatureFile::1254 Works just like format.signature except the contents of the1255 file specified by this variable will be used as the signature.12561257format.suffix::1258 The default for format-patch is to output files with the suffix1259 `.patch`. Use this variable to change that suffix (make sure to1260 include the dot if you want it).12611262format.pretty::1263 The default pretty format for log/show/whatchanged command,1264 See linkgit:git-log[1], linkgit:git-show[1],1265 linkgit:git-whatchanged[1].12661267format.thread::1268 The default threading style for 'git format-patch'. Can be1269 a boolean value, or `shallow` or `deep`. `shallow` threading1270 makes every mail a reply to the head of the series,1271 where the head is chosen from the cover letter, the1272 `--in-reply-to`, and the first patch mail, in this order.1273 `deep` threading makes every mail a reply to the previous one.1274 A true boolean value is the same as `shallow`, and a false1275 value disables threading.12761277format.signOff::1278 A boolean value which lets you enable the `-s/--signoff` option of1279 format-patch by default. *Note:* Adding the Signed-off-by: line to a1280 patch should be a conscious act and means that you certify you have1281 the rights to submit this work under the same open source license.1282 Please see the 'SubmittingPatches' document for further discussion.12831284format.coverLetter::1285 A boolean that controls whether to generate a cover-letter when1286 format-patch is invoked, but in addition can be set to "auto", to1287 generate a cover-letter only when there's more than one patch.12881289format.outputDirectory::1290 Set a custom directory to store the resulting files instead of the1291 current working directory.12921293format.useAutoBase::1294 A boolean value which lets you enable the `--base=auto` option of1295 format-patch by default.12961297filter.<driver>.clean::1298 The command which is used to convert the content of a worktree1299 file to a blob upon checkin. See linkgit:gitattributes[5] for1300 details.13011302filter.<driver>.smudge::1303 The command which is used to convert the content of a blob1304 object to a worktree file upon checkout. See1305 linkgit:gitattributes[5] for details.13061307fsck.<msg-id>::1308 Allows overriding the message type (error, warn or ignore) of a1309 specific message ID such as `missingEmail`.1310+1311For convenience, fsck prefixes the error/warning with the message ID,1312e.g. "missingEmail: invalid author/committer line - missing email" means1313that setting `fsck.missingEmail = ignore` will hide that issue.1314+1315This feature is intended to support working with legacy repositories1316which cannot be repaired without disruptive changes.13171318fsck.skipList::1319 The path to a sorted list of object names (i.e. one SHA-1 per1320 line) that are known to be broken in a non-fatal way and should1321 be ignored. This feature is useful when an established project1322 should be accepted despite early commits containing errors that1323 can be safely ignored such as invalid committer email addresses.1324 Note: corrupt objects cannot be skipped with this setting.13251326gc.aggressiveDepth::1327 The depth parameter used in the delta compression1328 algorithm used by 'git gc --aggressive'. This defaults1329 to 250.13301331gc.aggressiveWindow::1332 The window size parameter used in the delta compression1333 algorithm used by 'git gc --aggressive'. This defaults1334 to 250.13351336gc.auto::1337 When there are approximately more than this many loose1338 objects in the repository, `git gc --auto` will pack them.1339 Some Porcelain commands use this command to perform a1340 light-weight garbage collection from time to time. The1341 default value is 6700. Setting this to 0 disables it.13421343gc.autoPackLimit::1344 When there are more than this many packs that are not1345 marked with `*.keep` file in the repository, `git gc1346 --auto` consolidates them into one larger pack. The1347 default value is 50. Setting this to 0 disables it.13481349gc.autoDetach::1350 Make `git gc --auto` return immediately and run in background1351 if the system supports it. Default is true.13521353gc.packRefs::1354 Running `git pack-refs` in a repository renders it1355 unclonable by Git versions prior to 1.5.1.2 over dumb1356 transports such as HTTP. This variable determines whether1357 'git gc' runs `git pack-refs`. This can be set to `notbare`1358 to enable it within all non-bare repos or it can be set to a1359 boolean value. The default is `true`.13601361gc.pruneExpire::1362 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1363 Override the grace period with this config variable. The value1364 "now" may be used to disable this grace period and always prune1365 unreachable objects immediately, or "never" may be used to1366 suppress pruning.13671368gc.worktreePruneExpire::1369 When 'git gc' is run, it calls1370 'git worktree prune --expire 3.months.ago'.1371 This config variable can be used to set a different grace1372 period. The value "now" may be used to disable the grace1373 period and prune `$GIT_DIR/worktrees` immediately, or "never"1374 may be used to suppress pruning.13751376gc.reflogExpire::1377gc.<pattern>.reflogExpire::1378 'git reflog expire' removes reflog entries older than1379 this time; defaults to 90 days. The value "now" expires all1380 entries immediately, and "never" suppresses expiration1381 altogether. With "<pattern>" (e.g.1382 "refs/stash") in the middle the setting applies only to1383 the refs that match the <pattern>.13841385gc.reflogExpireUnreachable::1386gc.<pattern>.reflogExpireUnreachable::1387 'git reflog expire' removes reflog entries older than1388 this time and are not reachable from the current tip;1389 defaults to 30 days. The value "now" expires all entries1390 immediately, and "never" suppresses expiration altogether.1391 With "<pattern>" (e.g. "refs/stash")1392 in the middle, the setting applies only to the refs that1393 match the <pattern>.13941395gc.rerereResolved::1396 Records of conflicted merge you resolved earlier are1397 kept for this many days when 'git rerere gc' is run.1398 The default is 60 days. See linkgit:git-rerere[1].13991400gc.rerereUnresolved::1401 Records of conflicted merge you have not resolved are1402 kept for this many days when 'git rerere gc' is run.1403 The default is 15 days. See linkgit:git-rerere[1].14041405gitcvs.commitMsgAnnotation::1406 Append this string to each commit message. Set to empty string1407 to disable this feature. Defaults to "via git-CVS emulator".14081409gitcvs.enabled::1410 Whether the CVS server interface is enabled for this repository.1411 See linkgit:git-cvsserver[1].14121413gitcvs.logFile::1414 Path to a log file where the CVS server interface well... logs1415 various stuff. See linkgit:git-cvsserver[1].14161417gitcvs.usecrlfattr::1418 If true, the server will look up the end-of-line conversion1419 attributes for files to determine the '-k' modes to use. If1420 the attributes force Git to treat a file as text,1421 the '-k' mode will be left blank so CVS clients will1422 treat it as text. If they suppress text conversion, the file1423 will be set with '-kb' mode, which suppresses any newline munging1424 the client might otherwise do. If the attributes do not allow1425 the file type to be determined, then 'gitcvs.allBinary' is1426 used. See linkgit:gitattributes[5].14271428gitcvs.allBinary::1429 This is used if 'gitcvs.usecrlfattr' does not resolve1430 the correct '-kb' mode to use. If true, all1431 unresolved files are sent to the client in1432 mode '-kb'. This causes the client to treat them1433 as binary files, which suppresses any newline munging it1434 otherwise might do. Alternatively, if it is set to "guess",1435 then the contents of the file are examined to decide if1436 it is binary, similar to 'core.autocrlf'.14371438gitcvs.dbName::1439 Database used by git-cvsserver to cache revision information1440 derived from the Git repository. The exact meaning depends on the1441 used database driver, for SQLite (which is the default driver) this1442 is a filename. Supports variable substitution (see1443 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1444 Default: '%Ggitcvs.%m.sqlite'14451446gitcvs.dbDriver::1447 Used Perl DBI driver. You can specify any available driver1448 for this here, but it might not work. git-cvsserver is tested1449 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1450 reported *not* to work with 'DBD::mysql'. Experimental feature.1451 May not contain double colons (`:`). Default: 'SQLite'.1452 See linkgit:git-cvsserver[1].14531454gitcvs.dbUser, gitcvs.dbPass::1455 Database user and password. Only useful if setting 'gitcvs.dbDriver',1456 since SQLite has no concept of database users and/or passwords.1457 'gitcvs.dbUser' supports variable substitution (see1458 linkgit:git-cvsserver[1] for details).14591460gitcvs.dbTableNamePrefix::1461 Database table name prefix. Prepended to the names of any1462 database tables used, allowing a single database to be used1463 for several repositories. Supports variable substitution (see1464 linkgit:git-cvsserver[1] for details). Any non-alphabetic1465 characters will be replaced with underscores.14661467All gitcvs variables except for 'gitcvs.usecrlfattr' and1468'gitcvs.allBinary' can also be specified as1469'gitcvs.<access_method>.<varname>' (where 'access_method'1470is one of "ext" and "pserver") to make them apply only for the given1471access method.14721473gitweb.category::1474gitweb.description::1475gitweb.owner::1476gitweb.url::1477 See linkgit:gitweb[1] for description.14781479gitweb.avatar::1480gitweb.blame::1481gitweb.grep::1482gitweb.highlight::1483gitweb.patches::1484gitweb.pickaxe::1485gitweb.remote_heads::1486gitweb.showSizes::1487gitweb.snapshot::1488 See linkgit:gitweb.conf[5] for description.14891490grep.lineNumber::1491 If set to true, enable '-n' option by default.14921493grep.patternType::1494 Set the default matching behavior. Using a value of 'basic', 'extended',1495 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1496 '--fixed-strings', or '--perl-regexp' option accordingly, while the1497 value 'default' will return to the default matching behavior.14981499grep.extendedRegexp::1500 If set to true, enable '--extended-regexp' option by default. This1501 option is ignored when the 'grep.patternType' option is set to a value1502 other than 'default'.15031504grep.threads::1505 Number of grep worker threads to use.1506 See `grep.threads` in linkgit:git-grep[1] for more information.15071508grep.fallbackToNoIndex::1509 If set to true, fall back to git grep --no-index if git grep1510 is executed outside of a git repository. Defaults to false.15111512gpg.program::1513 Use this custom program instead of "`gpg`" found on `$PATH` when1514 making or verifying a PGP signature. The program must support the1515 same command-line interface as GPG, namely, to verify a detached1516 signature, "`gpg --verify $file - <$signature`" is run, and the1517 program is expected to signal a good signature by exiting with1518 code 0, and to generate an ASCII-armored detached signature, the1519 standard input of "`gpg -bsau $key`" is fed with the contents to be1520 signed, and the program is expected to send the result to its1521 standard output.15221523gui.commitMsgWidth::1524 Defines how wide the commit message window is in the1525 linkgit:git-gui[1]. "75" is the default.15261527gui.diffContext::1528 Specifies how many context lines should be used in calls to diff1529 made by the linkgit:git-gui[1]. The default is "5".15301531gui.displayUntracked::1532 Determines if linkgit:git-gui[1] shows untracked files1533 in the file list. The default is "true".15341535gui.encoding::1536 Specifies the default encoding to use for displaying of1537 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1538 It can be overridden by setting the 'encoding' attribute1539 for relevant files (see linkgit:gitattributes[5]).1540 If this option is not set, the tools default to the1541 locale encoding.15421543gui.matchTrackingBranch::1544 Determines if new branches created with linkgit:git-gui[1] should1545 default to tracking remote branches with matching names or1546 not. Default: "false".15471548gui.newBranchTemplate::1549 Is used as suggested name when creating new branches using the1550 linkgit:git-gui[1].15511552gui.pruneDuringFetch::1553 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1554 performing a fetch. The default value is "false".15551556gui.trustmtime::1557 Determines if linkgit:git-gui[1] should trust the file modification1558 timestamp or not. By default the timestamps are not trusted.15591560gui.spellingDictionary::1561 Specifies the dictionary used for spell checking commit messages in1562 the linkgit:git-gui[1]. When set to "none" spell checking is turned1563 off.15641565gui.fastCopyBlame::1566 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1567 location detection. It makes blame significantly faster on huge1568 repositories at the expense of less thorough copy detection.15691570gui.copyBlameThreshold::1571 Specifies the threshold to use in 'git gui blame' original location1572 detection, measured in alphanumeric characters. See the1573 linkgit:git-blame[1] manual for more information on copy detection.15741575gui.blamehistoryctx::1576 Specifies the radius of history context in days to show in1577 linkgit:gitk[1] for the selected commit, when the `Show History1578 Context` menu item is invoked from 'git gui blame'. If this1579 variable is set to zero, the whole history is shown.15801581guitool.<name>.cmd::1582 Specifies the shell command line to execute when the corresponding item1583 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1584 mandatory for every tool. The command is executed from the root of1585 the working directory, and in the environment it receives the name of1586 the tool as 'GIT_GUITOOL', the name of the currently selected file as1587 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1588 the head is detached, 'CUR_BRANCH' is empty).15891590guitool.<name>.needsFile::1591 Run the tool only if a diff is selected in the GUI. It guarantees1592 that 'FILENAME' is not empty.15931594guitool.<name>.noConsole::1595 Run the command silently, without creating a window to display its1596 output.15971598guitool.<name>.noRescan::1599 Don't rescan the working directory for changes after the tool1600 finishes execution.16011602guitool.<name>.confirm::1603 Show a confirmation dialog before actually running the tool.16041605guitool.<name>.argPrompt::1606 Request a string argument from the user, and pass it to the tool1607 through the 'ARGS' environment variable. Since requesting an1608 argument implies confirmation, the 'confirm' option has no effect1609 if this is enabled. If the option is set to 'true', 'yes', or '1',1610 the dialog uses a built-in generic prompt; otherwise the exact1611 value of the variable is used.16121613guitool.<name>.revPrompt::1614 Request a single valid revision from the user, and set the1615 'REVISION' environment variable. In other aspects this option1616 is similar to 'argPrompt', and can be used together with it.16171618guitool.<name>.revUnmerged::1619 Show only unmerged branches in the 'revPrompt' subdialog.1620 This is useful for tools similar to merge or rebase, but not1621 for things like checkout or reset.16221623guitool.<name>.title::1624 Specifies the title to use for the prompt dialog. The default1625 is the tool name.16261627guitool.<name>.prompt::1628 Specifies the general prompt string to display at the top of1629 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1630 The default value includes the actual command.16311632help.browser::1633 Specify the browser that will be used to display help in the1634 'web' format. See linkgit:git-help[1].16351636help.format::1637 Override the default help format used by linkgit:git-help[1].1638 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1639 the default. 'web' and 'html' are the same.16401641help.autoCorrect::1642 Automatically correct and execute mistyped commands after1643 waiting for the given number of deciseconds (0.1 sec). If more1644 than one command can be deduced from the entered text, nothing1645 will be executed. If the value of this option is negative,1646 the corrected command will be executed immediately. If the1647 value is 0 - the command will be just shown but not executed.1648 This is the default.16491650help.htmlPath::1651 Specify the path where the HTML documentation resides. File system paths1652 and URLs are supported. HTML pages will be prefixed with this path when1653 help is displayed in the 'web' format. This defaults to the documentation1654 path of your Git installation.16551656http.proxy::1657 Override the HTTP proxy, normally configured using the 'http_proxy',1658 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1659 addition to the syntax understood by curl, it is possible to specify a1660 proxy string with a user name but no password, in which case git will1661 attempt to acquire one in the same way it does for other credentials. See1662 linkgit:gitcredentials[7] for more information. The syntax thus is1663 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1664 on a per-remote basis; see remote.<name>.proxy16651666http.proxyAuthMethod::1667 Set the method with which to authenticate against the HTTP proxy. This1668 only takes effect if the configured proxy string contains a user name part1669 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1670 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1671 Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment1672 variable. Possible values are:1673+1674--1675* `anyauth` - Automatically pick a suitable authentication method. It is1676 assumed that the proxy answers an unauthenticated request with a 4071677 status code and one or more Proxy-authenticate headers with supported1678 authentication methods. This is the default.1679* `basic` - HTTP Basic authentication1680* `digest` - HTTP Digest authentication; this prevents the password from being1681 transmitted to the proxy in clear text1682* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1683 of `curl(1)`)1684* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1685--16861687http.emptyAuth::1688 Attempt authentication without seeking a username or password. This1689 can be used to attempt GSS-Negotiate authentication without specifying1690 a username in the URL, as libcurl normally requires a username for1691 authentication.16921693http.extraHeader::1694 Pass an additional HTTP header when communicating with a server. If1695 more than one such entry exists, all of them are added as extra1696 headers. To allow overriding the settings inherited from the system1697 config, an empty value will reset the extra headers to the empty list.16981699http.cookieFile::1700 The pathname of a file containing previously stored cookie lines,1701 which should be used1702 in the Git http session, if they match the server. The file format1703 of the file to read cookies from should be plain HTTP headers or1704 the Netscape/Mozilla cookie file format (see `curl(1)`).1705 NOTE that the file specified with http.cookieFile is used only as1706 input unless http.saveCookies is set.17071708http.saveCookies::1709 If set, store cookies received during requests to the file specified by1710 http.cookieFile. Has no effect if http.cookieFile is unset.17111712http.sslVersion::1713 The SSL version to use when negotiating an SSL connection, if you1714 want to force the default. The available and default version1715 depend on whether libcurl was built against NSS or OpenSSL and the1716 particular configuration of the crypto library in use. Internally1717 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1718 documentation for more details on the format of this option and1719 for the ssl version supported. Actually the possible values of1720 this option are:17211722 - sslv21723 - sslv31724 - tlsv11725 - tlsv1.01726 - tlsv1.11727 - tlsv1.217281729+1730Can be overridden by the 'GIT_SSL_VERSION' environment variable.1731To force git to use libcurl's default ssl version and ignore any1732explicit http.sslversion option, set 'GIT_SSL_VERSION' to the1733empty string.17341735http.sslCipherList::1736 A list of SSL ciphers to use when negotiating an SSL connection.1737 The available ciphers depend on whether libcurl was built against1738 NSS or OpenSSL and the particular configuration of the crypto1739 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1740 option; see the libcurl documentation for more details on the format1741 of this list.1742+1743Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.1744To force git to use libcurl's default cipher list and ignore any1745explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the1746empty string.17471748http.sslVerify::1749 Whether to verify the SSL certificate when fetching or pushing1750 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1751 variable.17521753http.sslCert::1754 File containing the SSL certificate when fetching or pushing1755 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1756 variable.17571758http.sslKey::1759 File containing the SSL private key when fetching or pushing1760 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1761 variable.17621763http.sslCertPasswordProtected::1764 Enable Git's password prompt for the SSL certificate. Otherwise1765 OpenSSL will prompt the user, possibly many times, if the1766 certificate or private key is encrypted. Can be overridden by the1767 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.17681769http.sslCAInfo::1770 File containing the certificates to verify the peer with when1771 fetching or pushing over HTTPS. Can be overridden by the1772 'GIT_SSL_CAINFO' environment variable.17731774http.sslCAPath::1775 Path containing files with the CA certificates to verify the peer1776 with when fetching or pushing over HTTPS. Can be overridden1777 by the 'GIT_SSL_CAPATH' environment variable.17781779http.pinnedpubkey::1780 Public key of the https service. It may either be the filename of1781 a PEM or DER encoded public key file or a string starting with1782 'sha256//' followed by the base64 encoded sha256 hash of the1783 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1784 exit with an error if this option is set but not supported by1785 cURL.17861787http.sslTry::1788 Attempt to use AUTH SSL/TLS and encrypted data transfers1789 when connecting via regular FTP protocol. This might be needed1790 if the FTP server requires it for security reasons or you wish1791 to connect securely whenever remote FTP server supports it.1792 Default is false since it might trigger certificate verification1793 errors on misconfigured servers.17941795http.maxRequests::1796 How many HTTP requests to launch in parallel. Can be overridden1797 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.17981799http.minSessions::1800 The number of curl sessions (counted across slots) to be kept across1801 requests. They will not be ended with curl_easy_cleanup() until1802 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1803 value will be capped at 1. Defaults to 1.18041805http.postBuffer::1806 Maximum size in bytes of the buffer used by smart HTTP1807 transports when POSTing data to the remote system.1808 For requests larger than this buffer size, HTTP/1.1 and1809 Transfer-Encoding: chunked is used to avoid creating a1810 massive pack file locally. Default is 1 MiB, which is1811 sufficient for most requests.18121813http.lowSpeedLimit, http.lowSpeedTime::1814 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1815 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1816 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1817 'GIT_HTTP_LOW_SPEED_TIME' environment variables.18181819http.noEPSV::1820 A boolean which disables using of EPSV ftp command by curl.1821 This can helpful with some "poor" ftp servers which don't1822 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1823 environment variable. Default is false (curl will use EPSV).18241825http.userAgent::1826 The HTTP USER_AGENT string presented to an HTTP server. The default1827 value represents the version of the client Git such as git/1.7.1.1828 This option allows you to override this value to a more common value1829 such as Mozilla/4.0. This may be necessary, for instance, if1830 connecting through a firewall that restricts HTTP connections to a set1831 of common USER_AGENT strings (but not including those like git/1.7.1).1832 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.18331834http.<url>.*::1835 Any of the http.* options above can be applied selectively to some URLs.1836 For a config key to match a URL, each element of the config key is1837 compared to that of the URL, in the following order:1838+1839--1840. Scheme (e.g., `https` in `https://example.com/`). This field1841 must match exactly between the config key and the URL.18421843. Host/domain name (e.g., `example.com` in `https://example.com/`).1844 This field must match exactly between the config key and the URL.18451846. Port number (e.g., `8080` in `http://example.com:8080/`).1847 This field must match exactly between the config key and the URL.1848 Omitted port numbers are automatically converted to the correct1849 default for the scheme before matching.18501851. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1852 path field of the config key must match the path field of the URL1853 either exactly or as a prefix of slash-delimited path elements. This means1854 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1855 match on a slash (`/`) boundary. Longer matches take precedence (so a config1856 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1857 key with just path `foo/`).18581859. User name (e.g., `user` in `https://user@example.com/repo.git`). If1860 the config key has a user name it must match the user name in the1861 URL exactly. If the config key does not have a user name, that1862 config key will match a URL with any user name (including none),1863 but at a lower precedence than a config key with a user name.1864--1865+1866The list above is ordered by decreasing precedence; a URL that matches1867a config key's path is preferred to one that matches its user name. For example,1868if the URL is `https://user@example.com/foo/bar` a config key match of1869`https://example.com/foo` will be preferred over a config key match of1870`https://user@example.com`.1871+1872All URLs are normalized before attempting any matching (the password part,1873if embedded in the URL, is always ignored for matching purposes) so that1874equivalent URLs that are simply spelled differently will match properly.1875Environment variable settings always override any matches. The URLs that are1876matched against are those given directly to Git commands. This means any URLs1877visited as a result of a redirection do not participate in matching.18781879i18n.commitEncoding::1880 Character encoding the commit messages are stored in; Git itself1881 does not care per se, but this information is necessary e.g. when1882 importing commits from emails or in the gitk graphical history1883 browser (and possibly at other places in the future or in other1884 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.18851886i18n.logOutputEncoding::1887 Character encoding the commit messages are converted to when1888 running 'git log' and friends.18891890imap::1891 The configuration variables in the 'imap' section are described1892 in linkgit:git-imap-send[1].18931894index.version::1895 Specify the version with which new index files should be1896 initialized. This does not affect existing repositories.18971898init.templateDir::1899 Specify the directory from which templates will be copied.1900 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)19011902instaweb.browser::1903 Specify the program that will be used to browse your working1904 repository in gitweb. See linkgit:git-instaweb[1].19051906instaweb.httpd::1907 The HTTP daemon command-line to start gitweb on your working1908 repository. See linkgit:git-instaweb[1].19091910instaweb.local::1911 If true the web server started by linkgit:git-instaweb[1] will1912 be bound to the local IP (127.0.0.1).19131914instaweb.modulePath::1915 The default module path for linkgit:git-instaweb[1] to use1916 instead of /usr/lib/apache2/modules. Only used if httpd1917 is Apache.19181919instaweb.port::1920 The port number to bind the gitweb httpd to. See1921 linkgit:git-instaweb[1].19221923interactive.singleKey::1924 In interactive commands, allow the user to provide one-letter1925 input with a single key (i.e., without hitting enter).1926 Currently this is used by the `--patch` mode of1927 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1928 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1929 setting is silently ignored if portable keystroke input1930 is not available; requires the Perl module Term::ReadKey.19311932interactive.diffFilter::1933 When an interactive command (such as `git add --patch`) shows1934 a colorized diff, git will pipe the diff through the shell1935 command defined by this configuration variable. The command may1936 mark up the diff further for human consumption, provided that it1937 retains a one-to-one correspondence with the lines in the1938 original diff. Defaults to disabled (no filtering).19391940log.abbrevCommit::1941 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1942 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1943 override this option with `--no-abbrev-commit`.19441945log.date::1946 Set the default date-time mode for the 'log' command.1947 Setting a value for log.date is similar to using 'git log''s1948 `--date` option. See linkgit:git-log[1] for details.19491950log.decorate::1951 Print out the ref names of any commits that are shown by the log1952 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1953 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1954 specified, the full ref name (including prefix) will be printed.1955 This is the same as the log commands '--decorate' option.19561957log.follow::1958 If `true`, `git log` will act as if the `--follow` option was used when1959 a single <path> is given. This has the same limitations as `--follow`,1960 i.e. it cannot be used to follow multiple files and does not work well1961 on non-linear history.19621963log.showRoot::1964 If true, the initial commit will be shown as a big creation event.1965 This is equivalent to a diff against an empty tree.1966 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1967 normally hide the root commit will now show it. True by default.19681969log.mailmap::1970 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1971 linkgit:git-whatchanged[1] assume `--use-mailmap`.19721973mailinfo.scissors::1974 If true, makes linkgit:git-mailinfo[1] (and therefore1975 linkgit:git-am[1]) act by default as if the --scissors option1976 was provided on the command-line. When active, this features1977 removes everything from the message body before a scissors1978 line (i.e. consisting mainly of ">8", "8<" and "-").19791980mailmap.file::1981 The location of an augmenting mailmap file. The default1982 mailmap, located in the root of the repository, is loaded1983 first, then the mailmap file pointed to by this variable.1984 The location of the mailmap file may be in a repository1985 subdirectory, or somewhere outside of the repository itself.1986 See linkgit:git-shortlog[1] and linkgit:git-blame[1].19871988mailmap.blob::1989 Like `mailmap.file`, but consider the value as a reference to a1990 blob in the repository. If both `mailmap.file` and1991 `mailmap.blob` are given, both are parsed, with entries from1992 `mailmap.file` taking precedence. In a bare repository, this1993 defaults to `HEAD:.mailmap`. In a non-bare repository, it1994 defaults to empty.19951996man.viewer::1997 Specify the programs that may be used to display help in the1998 'man' format. See linkgit:git-help[1].19992000man.<tool>.cmd::2001 Specify the command to invoke the specified man viewer. The2002 specified command is evaluated in shell with the man page2003 passed as argument. (See linkgit:git-help[1].)20042005man.<tool>.path::2006 Override the path for the given tool that may be used to2007 display help in the 'man' format. See linkgit:git-help[1].20082009include::merge-config.txt[]20102011mergetool.<tool>.path::2012 Override the path for the given tool. This is useful in case2013 your tool is not in the PATH.20142015mergetool.<tool>.cmd::2016 Specify the command to invoke the specified merge tool. The2017 specified command is evaluated in shell with the following2018 variables available: 'BASE' is the name of a temporary file2019 containing the common base of the files to be merged, if available;2020 'LOCAL' is the name of a temporary file containing the contents of2021 the file on the current branch; 'REMOTE' is the name of a temporary2022 file containing the contents of the file from the branch being2023 merged; 'MERGED' contains the name of the file to which the merge2024 tool should write the results of a successful merge.20252026mergetool.<tool>.trustExitCode::2027 For a custom merge command, specify whether the exit code of2028 the merge command can be used to determine whether the merge was2029 successful. If this is not set to true then the merge target file2030 timestamp is checked and the merge assumed to have been successful2031 if the file has been updated, otherwise the user is prompted to2032 indicate the success of the merge.20332034mergetool.meld.hasOutput::2035 Older versions of `meld` do not support the `--output` option.2036 Git will attempt to detect whether `meld` supports `--output`2037 by inspecting the output of `meld --help`. Configuring2038 `mergetool.meld.hasOutput` will make Git skip these checks and2039 use the configured value instead. Setting `mergetool.meld.hasOutput`2040 to `true` tells Git to unconditionally use the `--output` option,2041 and `false` avoids using `--output`.20422043mergetool.keepBackup::2044 After performing a merge, the original file with conflict markers2045 can be saved as a file with a `.orig` extension. If this variable2046 is set to `false` then this file is not preserved. Defaults to2047 `true` (i.e. keep the backup files).20482049mergetool.keepTemporaries::2050 When invoking a custom merge tool, Git uses a set of temporary2051 files to pass to the tool. If the tool returns an error and this2052 variable is set to `true`, then these temporary files will be2053 preserved, otherwise they will be removed after the tool has2054 exited. Defaults to `false`.20552056mergetool.writeToTemp::2057 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2058 conflicting files in the worktree by default. Git will attempt2059 to use a temporary directory for these files when set `true`.2060 Defaults to `false`.20612062mergetool.prompt::2063 Prompt before each invocation of the merge resolution program.20642065notes.mergeStrategy::2066 Which merge strategy to choose by default when resolving notes2067 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2068 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2069 section of linkgit:git-notes[1] for more information on each strategy.20702071notes.<name>.mergeStrategy::2072 Which merge strategy to choose when doing a notes merge into2073 refs/notes/<name>. This overrides the more general2074 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2075 linkgit:git-notes[1] for more information on the available strategies.20762077notes.displayRef::2078 The (fully qualified) refname from which to show notes when2079 showing commit messages. The value of this variable can be set2080 to a glob, in which case notes from all matching refs will be2081 shown. You may also specify this configuration variable2082 several times. A warning will be issued for refs that do not2083 exist, but a glob that does not match any refs is silently2084 ignored.2085+2086This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2087environment variable, which must be a colon separated list of refs or2088globs.2089+2090The effective value of "core.notesRef" (possibly overridden by2091GIT_NOTES_REF) is also implicitly added to the list of refs to be2092displayed.20932094notes.rewrite.<command>::2095 When rewriting commits with <command> (currently `amend` or2096 `rebase`) and this variable is set to `true`, Git2097 automatically copies your notes from the original to the2098 rewritten commit. Defaults to `true`, but see2099 "notes.rewriteRef" below.21002101notes.rewriteMode::2102 When copying notes during a rewrite (see the2103 "notes.rewrite.<command>" option), determines what to do if2104 the target commit already has a note. Must be one of2105 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2106 Defaults to `concatenate`.2107+2108This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2109environment variable.21102111notes.rewriteRef::2112 When copying notes during a rewrite, specifies the (fully2113 qualified) ref whose notes should be copied. The ref may be a2114 glob, in which case notes in all matching refs will be copied.2115 You may also specify this configuration several times.2116+2117Does not have a default value; you must configure this variable to2118enable note rewriting. Set it to `refs/notes/commits` to enable2119rewriting for the default commit notes.2120+2121This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2122environment variable, which must be a colon separated list of refs or2123globs.21242125pack.window::2126 The size of the window used by linkgit:git-pack-objects[1] when no2127 window size is given on the command line. Defaults to 10.21282129pack.depth::2130 The maximum delta depth used by linkgit:git-pack-objects[1] when no2131 maximum depth is given on the command line. Defaults to 50.21322133pack.windowMemory::2134 The maximum size of memory that is consumed by each thread2135 in linkgit:git-pack-objects[1] for pack window memory when2136 no limit is given on the command line. The value can be2137 suffixed with "k", "m", or "g". When left unconfigured (or2138 set explicitly to 0), there will be no limit.21392140pack.compression::2141 An integer -1..9, indicating the compression level for objects2142 in a pack file. -1 is the zlib default. 0 means no2143 compression, and 1..9 are various speed/size tradeoffs, 9 being2144 slowest. If not set, defaults to core.compression. If that is2145 not set, defaults to -1, the zlib default, which is "a default2146 compromise between speed and compression (currently equivalent2147 to level 6)."2148+2149Note that changing the compression level will not automatically recompress2150all existing objects. You can force recompression by passing the -F option2151to linkgit:git-repack[1].21522153pack.deltaCacheSize::2154 The maximum memory in bytes used for caching deltas in2155 linkgit:git-pack-objects[1] before writing them out to a pack.2156 This cache is used to speed up the writing object phase by not2157 having to recompute the final delta result once the best match2158 for all objects is found. Repacking large repositories on machines2159 which are tight with memory might be badly impacted by this though,2160 especially if this cache pushes the system into swapping.2161 A value of 0 means no limit. The smallest size of 1 byte may be2162 used to virtually disable this cache. Defaults to 256 MiB.21632164pack.deltaCacheLimit::2165 The maximum size of a delta, that is cached in2166 linkgit:git-pack-objects[1]. This cache is used to speed up the2167 writing object phase by not having to recompute the final delta2168 result once the best match for all objects is found. Defaults to 1000.21692170pack.threads::2171 Specifies the number of threads to spawn when searching for best2172 delta matches. This requires that linkgit:git-pack-objects[1]2173 be compiled with pthreads otherwise this option is ignored with a2174 warning. This is meant to reduce packing time on multiprocessor2175 machines. The required amount of memory for the delta search window2176 is however multiplied by the number of threads.2177 Specifying 0 will cause Git to auto-detect the number of CPU's2178 and set the number of threads accordingly.21792180pack.indexVersion::2181 Specify the default pack index version. Valid values are 1 for2182 legacy pack index used by Git versions prior to 1.5.2, and 2 for2183 the new pack index with capabilities for packs larger than 4 GB2184 as well as proper protection against the repacking of corrupted2185 packs. Version 2 is the default. Note that version 2 is enforced2186 and this config option ignored whenever the corresponding pack is2187 larger than 2 GB.2188+2189If you have an old Git that does not understand the version 2 `*.idx` file,2190cloning or fetching over a non native protocol (e.g. "http")2191that will copy both `*.pack` file and corresponding `*.idx` file from the2192other side may give you a repository that cannot be accessed with your2193older version of Git. If the `*.pack` file is smaller than 2 GB, however,2194you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2195the `*.idx` file.21962197pack.packSizeLimit::2198 The maximum size of a pack. This setting only affects2199 packing to a file when repacking, i.e. the git:// protocol2200 is unaffected. It can be overridden by the `--max-pack-size`2201 option of linkgit:git-repack[1]. Reaching this limit results2202 in the creation of multiple packfiles; which in turn prevents2203 bitmaps from being created.2204 The minimum size allowed is limited to 1 MiB.2205 The default is unlimited.2206 Common unit suffixes of 'k', 'm', or 'g' are2207 supported.22082209pack.useBitmaps::2210 When true, git will use pack bitmaps (if available) when packing2211 to stdout (e.g., during the server side of a fetch). Defaults to2212 true. You should not generally need to turn this off unless2213 you are debugging pack bitmaps.22142215pack.writeBitmaps (deprecated)::2216 This is a deprecated synonym for `repack.writeBitmaps`.22172218pack.writeBitmapHashCache::2219 When true, git will include a "hash cache" section in the bitmap2220 index (if one is written). This cache can be used to feed git's2221 delta heuristics, potentially leading to better deltas between2222 bitmapped and non-bitmapped objects (e.g., when serving a fetch2223 between an older, bitmapped pack and objects that have been2224 pushed since the last gc). The downside is that it consumes 42225 bytes per object of disk space, and that JGit's bitmap2226 implementation does not understand it, causing it to complain if2227 Git and JGit are used on the same repository. Defaults to false.22282229pager.<cmd>::2230 If the value is boolean, turns on or off pagination of the2231 output of a particular Git subcommand when writing to a tty.2232 Otherwise, turns on pagination for the subcommand using the2233 pager specified by the value of `pager.<cmd>`. If `--paginate`2234 or `--no-pager` is specified on the command line, it takes2235 precedence over this option. To disable pagination for all2236 commands, set `core.pager` or `GIT_PAGER` to `cat`.22372238pretty.<name>::2239 Alias for a --pretty= format string, as specified in2240 linkgit:git-log[1]. Any aliases defined here can be used just2241 as the built-in pretty formats could. For example,2242 running `git config pretty.changelog "format:* %H %s"`2243 would cause the invocation `git log --pretty=changelog`2244 to be equivalent to running `git log "--pretty=format:* %H %s"`.2245 Note that an alias with the same name as a built-in format2246 will be silently ignored.22472248pull.ff::2249 By default, Git does not create an extra merge commit when merging2250 a commit that is a descendant of the current commit. Instead, the2251 tip of the current branch is fast-forwarded. When set to `false`,2252 this variable tells Git to create an extra merge commit in such2253 a case (equivalent to giving the `--no-ff` option from the command2254 line). When set to `only`, only such fast-forward merges are2255 allowed (equivalent to giving the `--ff-only` option from the2256 command line). This setting overrides `merge.ff` when pulling.22572258pull.rebase::2259 When true, rebase branches on top of the fetched branch, instead2260 of merging the default branch from the default remote when "git2261 pull" is run. See "branch.<name>.rebase" for setting this on a2262 per-branch basis.2263+2264When preserve, also pass `--preserve-merges` along to 'git rebase'2265so that locally committed merge commits will not be flattened2266by running 'git pull'.2267+2268When the value is `interactive`, the rebase is run in interactive mode.2269+2270*NOTE*: this is a possibly dangerous operation; do *not* use2271it unless you understand the implications (see linkgit:git-rebase[1]2272for details).22732274pull.octopus::2275 The default merge strategy to use when pulling multiple branches2276 at once.22772278pull.twohead::2279 The default merge strategy to use when pulling a single branch.22802281push.default::2282 Defines the action `git push` should take if no refspec is2283 explicitly given. Different values are well-suited for2284 specific workflows; for instance, in a purely central workflow2285 (i.e. the fetch source is equal to the push destination),2286 `upstream` is probably what you want. Possible values are:2287+2288--22892290* `nothing` - do not push anything (error out) unless a refspec is2291 explicitly given. This is primarily meant for people who want to2292 avoid mistakes by always being explicit.22932294* `current` - push the current branch to update a branch with the same2295 name on the receiving end. Works in both central and non-central2296 workflows.22972298* `upstream` - push the current branch back to the branch whose2299 changes are usually integrated into the current branch (which is2300 called `@{upstream}`). This mode only makes sense if you are2301 pushing to the same repository you would normally pull from2302 (i.e. central workflow).23032304* `simple` - in centralized workflow, work like `upstream` with an2305 added safety to refuse to push if the upstream branch's name is2306 different from the local one.2307+2308When pushing to a remote that is different from the remote you normally2309pull from, work as `current`. This is the safest option and is suited2310for beginners.2311+2312This mode has become the default in Git 2.0.23132314* `matching` - push all branches having the same name on both ends.2315 This makes the repository you are pushing to remember the set of2316 branches that will be pushed out (e.g. if you always push 'maint'2317 and 'master' there and no other branches, the repository you push2318 to will have these two branches, and your local 'maint' and2319 'master' will be pushed there).2320+2321To use this mode effectively, you have to make sure _all_ the2322branches you would push out are ready to be pushed out before2323running 'git push', as the whole point of this mode is to allow you2324to push all of the branches in one go. If you usually finish work2325on only one branch and push out the result, while other branches are2326unfinished, this mode is not for you. Also this mode is not2327suitable for pushing into a shared central repository, as other2328people may add new branches there, or update the tip of existing2329branches outside your control.2330+2331This used to be the default, but not since Git 2.0 (`simple` is the2332new default).23332334--23352336push.followTags::2337 If set to true enable '--follow-tags' option by default. You2338 may override this configuration at time of push by specifying2339 '--no-follow-tags'.23402341push.gpgSign::2342 May be set to a boolean value, or the string 'if-asked'. A true2343 value causes all pushes to be GPG signed, as if '--signed' is2344 passed to linkgit:git-push[1]. The string 'if-asked' causes2345 pushes to be signed if the server supports it, as if2346 '--signed=if-asked' is passed to 'git push'. A false value may2347 override a value from a lower-priority config file. An explicit2348 command-line flag always overrides this config option.23492350push.recurseSubmodules::2351 Make sure all submodule commits used by the revisions to be pushed2352 are available on a remote-tracking branch. If the value is 'check'2353 then Git will verify that all submodule commits that changed in the2354 revisions to be pushed are available on at least one remote of the2355 submodule. If any commits are missing, the push will be aborted and2356 exit with non-zero status. If the value is 'on-demand' then all2357 submodules that changed in the revisions to be pushed will be2358 pushed. If on-demand was not able to push all necessary revisions2359 it will also be aborted and exit with non-zero status. If the value2360 is 'no' then default behavior of ignoring submodules when pushing2361 is retained. You may override this configuration at time of push by2362 specifying '--recurse-submodules=check|on-demand|no'.23632364rebase.stat::2365 Whether to show a diffstat of what changed upstream since the last2366 rebase. False by default.23672368rebase.autoSquash::2369 If set to true enable '--autosquash' option by default.23702371rebase.autoStash::2372 When set to true, automatically create a temporary stash2373 before the operation begins, and apply it after the operation2374 ends. This means that you can run rebase on a dirty worktree.2375 However, use with care: the final stash application after a2376 successful rebase might result in non-trivial conflicts.2377 Defaults to false.23782379rebase.missingCommitsCheck::2380 If set to "warn", git rebase -i will print a warning if some2381 commits are removed (e.g. a line was deleted), however the2382 rebase will still proceed. If set to "error", it will print2383 the previous warning and stop the rebase, 'git rebase2384 --edit-todo' can then be used to correct the error. If set to2385 "ignore", no checking is done.2386 To drop a commit without warning or error, use the `drop`2387 command in the todo-list.2388 Defaults to "ignore".23892390rebase.instructionFormat2391 A format string, as specified in linkgit:git-log[1], to be used for2392 the instruction list during an interactive rebase. The format will automatically2393 have the long commit hash prepended to the format.23942395receive.advertiseAtomic::2396 By default, git-receive-pack will advertise the atomic push2397 capability to its clients. If you don't want to this capability2398 to be advertised, set this variable to false.23992400receive.autogc::2401 By default, git-receive-pack will run "git-gc --auto" after2402 receiving data from git-push and updating refs. You can stop2403 it by setting this variable to false.24042405receive.certNonceSeed::2406 By setting this variable to a string, `git receive-pack`2407 will accept a `git push --signed` and verifies it by using2408 a "nonce" protected by HMAC using this string as a secret2409 key.24102411receive.certNonceSlop::2412 When a `git push --signed` sent a push certificate with a2413 "nonce" that was issued by a receive-pack serving the same2414 repository within this many seconds, export the "nonce"2415 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2416 hooks (instead of what the receive-pack asked the sending2417 side to include). This may allow writing checks in2418 `pre-receive` and `post-receive` a bit easier. Instead of2419 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2420 that records by how many seconds the nonce is stale to2421 decide if they want to accept the certificate, they only2422 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.24232424receive.fsckObjects::2425 If it is set to true, git-receive-pack will check all received2426 objects. It will abort in the case of a malformed object or a2427 broken link. The result of an abort are only dangling objects.2428 Defaults to false. If not set, the value of `transfer.fsckObjects`2429 is used instead.24302431receive.fsck.<msg-id>::2432 When `receive.fsckObjects` is set to true, errors can be switched2433 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2434 setting where the `<msg-id>` is the fsck message ID and the value2435 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2436 the error/warning with the message ID, e.g. "missingEmail: invalid2437 author/committer line - missing email" means that setting2438 `receive.fsck.missingEmail = ignore` will hide that issue.2439+2440This feature is intended to support working with legacy repositories2441which would not pass pushing when `receive.fsckObjects = true`, allowing2442the host to accept repositories with certain known issues but still catch2443other issues.24442445receive.fsck.skipList::2446 The path to a sorted list of object names (i.e. one SHA-1 per2447 line) that are known to be broken in a non-fatal way and should2448 be ignored. This feature is useful when an established project2449 should be accepted despite early commits containing errors that2450 can be safely ignored such as invalid committer email addresses.2451 Note: corrupt objects cannot be skipped with this setting.24522453receive.unpackLimit::2454 If the number of objects received in a push is below this2455 limit then the objects will be unpacked into loose object2456 files. However if the number of received objects equals or2457 exceeds this limit then the received pack will be stored as2458 a pack, after adding any missing delta bases. Storing the2459 pack from a push can make the push operation complete faster,2460 especially on slow filesystems. If not set, the value of2461 `transfer.unpackLimit` is used instead.24622463receive.denyDeletes::2464 If set to true, git-receive-pack will deny a ref update that deletes2465 the ref. Use this to prevent such a ref deletion via a push.24662467receive.denyDeleteCurrent::2468 If set to true, git-receive-pack will deny a ref update that2469 deletes the currently checked out branch of a non-bare repository.24702471receive.denyCurrentBranch::2472 If set to true or "refuse", git-receive-pack will deny a ref update2473 to the currently checked out branch of a non-bare repository.2474 Such a push is potentially dangerous because it brings the HEAD2475 out of sync with the index and working tree. If set to "warn",2476 print a warning of such a push to stderr, but allow the push to2477 proceed. If set to false or "ignore", allow such pushes with no2478 message. Defaults to "refuse".2479+2480Another option is "updateInstead" which will update the working2481tree if pushing into the current branch. This option is2482intended for synchronizing working directories when one side is not easily2483accessible via interactive ssh (e.g. a live web site, hence the requirement2484that the working directory be clean). This mode also comes in handy when2485developing inside a VM to test and fix code on different Operating Systems.2486+2487By default, "updateInstead" will refuse the push if the working tree or2488the index have any difference from the HEAD, but the `push-to-checkout`2489hook can be used to customize this. See linkgit:githooks[5].24902491receive.denyNonFastForwards::2492 If set to true, git-receive-pack will deny a ref update which is2493 not a fast-forward. Use this to prevent such an update via a push,2494 even if that push is forced. This configuration variable is2495 set when initializing a shared repository.24962497receive.hideRefs::2498 This variable is the same as `transfer.hideRefs`, but applies2499 only to `receive-pack` (and so affects pushes, but not fetches).2500 An attempt to update or delete a hidden ref by `git push` is2501 rejected.25022503receive.updateServerInfo::2504 If set to true, git-receive-pack will run git-update-server-info2505 after receiving data from git-push and updating refs.25062507receive.shallowUpdate::2508 If set to true, .git/shallow can be updated when new refs2509 require new shallow roots. Otherwise those refs are rejected.25102511remote.pushDefault::2512 The remote to push to by default. Overrides2513 `branch.<name>.remote` for all branches, and is overridden by2514 `branch.<name>.pushRemote` for specific branches.25152516remote.<name>.url::2517 The URL of a remote repository. See linkgit:git-fetch[1] or2518 linkgit:git-push[1].25192520remote.<name>.pushurl::2521 The push URL of a remote repository. See linkgit:git-push[1].25222523remote.<name>.proxy::2524 For remotes that require curl (http, https and ftp), the URL to2525 the proxy to use for that remote. Set to the empty string to2526 disable proxying for that remote.25272528remote.<name>.proxyAuthMethod::2529 For remotes that require curl (http, https and ftp), the method to use for2530 authenticating against the proxy in use (probably set in2531 `remote.<name>.proxy`). See `http.proxyAuthMethod`.25322533remote.<name>.fetch::2534 The default set of "refspec" for linkgit:git-fetch[1]. See2535 linkgit:git-fetch[1].25362537remote.<name>.push::2538 The default set of "refspec" for linkgit:git-push[1]. See2539 linkgit:git-push[1].25402541remote.<name>.mirror::2542 If true, pushing to this remote will automatically behave2543 as if the `--mirror` option was given on the command line.25442545remote.<name>.skipDefaultUpdate::2546 If true, this remote will be skipped by default when updating2547 using linkgit:git-fetch[1] or the `update` subcommand of2548 linkgit:git-remote[1].25492550remote.<name>.skipFetchAll::2551 If true, this remote will be skipped by default when updating2552 using linkgit:git-fetch[1] or the `update` subcommand of2553 linkgit:git-remote[1].25542555remote.<name>.receivepack::2556 The default program to execute on the remote side when pushing. See2557 option --receive-pack of linkgit:git-push[1].25582559remote.<name>.uploadpack::2560 The default program to execute on the remote side when fetching. See2561 option --upload-pack of linkgit:git-fetch-pack[1].25622563remote.<name>.tagOpt::2564 Setting this value to --no-tags disables automatic tag following when2565 fetching from remote <name>. Setting it to --tags will fetch every2566 tag from remote <name>, even if they are not reachable from remote2567 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2568 override this setting. See options --tags and --no-tags of2569 linkgit:git-fetch[1].25702571remote.<name>.vcs::2572 Setting this to a value <vcs> will cause Git to interact with2573 the remote with the git-remote-<vcs> helper.25742575remote.<name>.prune::2576 When set to true, fetching from this remote by default will also2577 remove any remote-tracking references that no longer exist on the2578 remote (as if the `--prune` option was given on the command line).2579 Overrides `fetch.prune` settings, if any.25802581remotes.<group>::2582 The list of remotes which are fetched by "git remote update2583 <group>". See linkgit:git-remote[1].25842585repack.useDeltaBaseOffset::2586 By default, linkgit:git-repack[1] creates packs that use2587 delta-base offset. If you need to share your repository with2588 Git older than version 1.4.4, either directly or via a dumb2589 protocol such as http, then you need to set this option to2590 "false" and repack. Access from old Git versions over the2591 native protocol are unaffected by this option.25922593repack.packKeptObjects::2594 If set to true, makes `git repack` act as if2595 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2596 details. Defaults to `false` normally, but `true` if a bitmap2597 index is being written (either via `--write-bitmap-index` or2598 `repack.writeBitmaps`).25992600repack.writeBitmaps::2601 When true, git will write a bitmap index when packing all2602 objects to disk (e.g., when `git repack -a` is run). This2603 index can speed up the "counting objects" phase of subsequent2604 packs created for clones and fetches, at the cost of some disk2605 space and extra time spent on the initial repack. This has2606 no effect if multiple packfiles are created.2607 Defaults to false.26082609rerere.autoUpdate::2610 When set to true, `git-rerere` updates the index with the2611 resulting contents after it cleanly resolves conflicts using2612 previously recorded resolution. Defaults to false.26132614rerere.enabled::2615 Activate recording of resolved conflicts, so that identical2616 conflict hunks can be resolved automatically, should they be2617 encountered again. By default, linkgit:git-rerere[1] is2618 enabled if there is an `rr-cache` directory under the2619 `$GIT_DIR`, e.g. if "rerere" was previously used in the2620 repository.26212622sendemail.identity::2623 A configuration identity. When given, causes values in the2624 'sendemail.<identity>' subsection to take precedence over2625 values in the 'sendemail' section. The default identity is2626 the value of 'sendemail.identity'.26272628sendemail.smtpEncryption::2629 See linkgit:git-send-email[1] for description. Note that this2630 setting is not subject to the 'identity' mechanism.26312632sendemail.smtpssl (deprecated)::2633 Deprecated alias for 'sendemail.smtpEncryption = ssl'.26342635sendemail.smtpsslcertpath::2636 Path to ca-certificates (either a directory or a single file).2637 Set it to an empty string to disable certificate verification.26382639sendemail.<identity>.*::2640 Identity-specific versions of the 'sendemail.*' parameters2641 found below, taking precedence over those when the this2642 identity is selected, through command-line or2643 'sendemail.identity'.26442645sendemail.aliasesFile::2646sendemail.aliasFileType::2647sendemail.annotate::2648sendemail.bcc::2649sendemail.cc::2650sendemail.ccCmd::2651sendemail.chainReplyTo::2652sendemail.confirm::2653sendemail.envelopeSender::2654sendemail.from::2655sendemail.multiEdit::2656sendemail.signedoffbycc::2657sendemail.smtpPass::2658sendemail.suppresscc::2659sendemail.suppressFrom::2660sendemail.to::2661sendemail.smtpDomain::2662sendemail.smtpServer::2663sendemail.smtpServerPort::2664sendemail.smtpServerOption::2665sendemail.smtpUser::2666sendemail.thread::2667sendemail.transferEncoding::2668sendemail.validate::2669sendemail.xmailer::2670 See linkgit:git-send-email[1] for description.26712672sendemail.signedoffcc (deprecated)::2673 Deprecated alias for 'sendemail.signedoffbycc'.26742675showbranch.default::2676 The default set of branches for linkgit:git-show-branch[1].2677 See linkgit:git-show-branch[1].26782679status.relativePaths::2680 By default, linkgit:git-status[1] shows paths relative to the2681 current directory. Setting this variable to `false` shows paths2682 relative to the repository root (this was the default for Git2683 prior to v1.5.4).26842685status.short::2686 Set to true to enable --short by default in linkgit:git-status[1].2687 The option --no-short takes precedence over this variable.26882689status.branch::2690 Set to true to enable --branch by default in linkgit:git-status[1].2691 The option --no-branch takes precedence over this variable.26922693status.displayCommentPrefix::2694 If set to true, linkgit:git-status[1] will insert a comment2695 prefix before each output line (starting with2696 `core.commentChar`, i.e. `#` by default). This was the2697 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2698 Defaults to false.26992700status.showUntrackedFiles::2701 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2702 files which are not currently tracked by Git. Directories which2703 contain only untracked files, are shown with the directory name2704 only. Showing untracked files means that Git needs to lstat() all2705 the files in the whole repository, which might be slow on some2706 systems. So, this variable controls how the commands displays2707 the untracked files. Possible values are:2708+2709--2710* `no` - Show no untracked files.2711* `normal` - Show untracked files and directories.2712* `all` - Show also individual files in untracked directories.2713--2714+2715If this variable is not specified, it defaults to 'normal'.2716This variable can be overridden with the -u|--untracked-files option2717of linkgit:git-status[1] and linkgit:git-commit[1].27182719status.submoduleSummary::2720 Defaults to false.2721 If this is set to a non zero number or true (identical to -1 or an2722 unlimited number), the submodule summary will be enabled and a2723 summary of commits for modified submodules will be shown (see2724 --summary-limit option of linkgit:git-submodule[1]). Please note2725 that the summary output command will be suppressed for all2726 submodules when `diff.ignoreSubmodules` is set to 'all' or only2727 for those submodules where `submodule.<name>.ignore=all`. The only2728 exception to that rule is that status and commit will show staged2729 submodule changes. To2730 also view the summary for ignored submodules you can either use2731 the --ignore-submodules=dirty command-line option or the 'git2732 submodule summary' command, which shows a similar output but does2733 not honor these settings.27342735stash.showPatch::2736 If this is set to true, the `git stash show` command without an2737 option will show the stash in patch form. Defaults to false.2738 See description of 'show' command in linkgit:git-stash[1].27392740stash.showStat::2741 If this is set to true, the `git stash show` command without an2742 option will show diffstat of the stash. Defaults to true.2743 See description of 'show' command in linkgit:git-stash[1].27442745submodule.<name>.path::2746submodule.<name>.url::2747 The path within this project and URL for a submodule. These2748 variables are initially populated by 'git submodule init'. See2749 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2750 details.27512752submodule.<name>.update::2753 The default update procedure for a submodule. This variable2754 is populated by `git submodule init` from the2755 linkgit:gitmodules[5] file. See description of 'update'2756 command in linkgit:git-submodule[1].27572758submodule.<name>.branch::2759 The remote branch name for a submodule, used by `git submodule2760 update --remote`. Set this option to override the value found in2761 the `.gitmodules` file. See linkgit:git-submodule[1] and2762 linkgit:gitmodules[5] for details.27632764submodule.<name>.fetchRecurseSubmodules::2765 This option can be used to control recursive fetching of this2766 submodule. It can be overridden by using the --[no-]recurse-submodules2767 command-line option to "git fetch" and "git pull".2768 This setting will override that from in the linkgit:gitmodules[5]2769 file.27702771submodule.<name>.ignore::2772 Defines under what circumstances "git status" and the diff family show2773 a submodule as modified. When set to "all", it will never be considered2774 modified (but it will nonetheless show up in the output of status and2775 commit when it has been staged), "dirty" will ignore all changes2776 to the submodules work tree and2777 takes only differences between the HEAD of the submodule and the commit2778 recorded in the superproject into account. "untracked" will additionally2779 let submodules with modified tracked files in their work tree show up.2780 Using "none" (the default when this option is not set) also shows2781 submodules that have untracked files in their work tree as changed.2782 This setting overrides any setting made in .gitmodules for this submodule,2783 both settings can be overridden on the command line by using the2784 "--ignore-submodules" option. The 'git submodule' commands are not2785 affected by this setting.27862787submodule.fetchJobs::2788 Specifies how many submodules are fetched/cloned at the same time.2789 A positive integer allows up to that number of submodules fetched2790 in parallel. A value of 0 will give some reasonable default.2791 If unset, it defaults to 1.27922793tag.forceSignAnnotated::2794 A boolean to specify whether annotated tags created should be GPG signed.2795 If `--annotate` is specified on the command line, it takes2796 precedence over this option.27972798tag.sort::2799 This variable controls the sort ordering of tags when displayed by2800 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2801 value of this variable will be used as the default.28022803tar.umask::2804 This variable can be used to restrict the permission bits of2805 tar archive entries. The default is 0002, which turns off the2806 world write bit. The special value "user" indicates that the2807 archiving user's umask will be used instead. See umask(2) and2808 linkgit:git-archive[1].28092810transfer.fsckObjects::2811 When `fetch.fsckObjects` or `receive.fsckObjects` are2812 not set, the value of this variable is used instead.2813 Defaults to false.28142815transfer.hideRefs::2816 String(s) `receive-pack` and `upload-pack` use to decide which2817 refs to omit from their initial advertisements. Use more than2818 one definition to specify multiple prefix strings. A ref that is2819 under the hierarchies listed in the value of this variable is2820 excluded, and is hidden when responding to `git push` or `git2821 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2822 program-specific versions of this config.2823+2824You may also include a `!` in front of the ref name to negate the entry,2825explicitly exposing it, even if an earlier entry marked it as hidden.2826If you have multiple hideRefs values, later entries override earlier ones2827(and entries in more-specific config files override less-specific ones).2828+2829If a namespace is in use, the namespace prefix is stripped from each2830reference before it is matched against `transfer.hiderefs` patterns.2831For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2832the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2833is omitted from the advertisements but `refs/heads/master` and2834`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2835"have" lines. In order to match refs before stripping, add a `^` in front of2836the ref name. If you combine `!` and `^`, `!` must be specified first.28372838transfer.unpackLimit::2839 When `fetch.unpackLimit` or `receive.unpackLimit` are2840 not set, the value of this variable is used instead.2841 The default value is 100.28422843uploadarchive.allowUnreachable::2844 If true, allow clients to use `git archive --remote` to request2845 any tree, whether reachable from the ref tips or not. See the2846 discussion in the `SECURITY` section of2847 linkgit:git-upload-archive[1] for more details. Defaults to2848 `false`.28492850uploadpack.hideRefs::2851 This variable is the same as `transfer.hideRefs`, but applies2852 only to `upload-pack` (and so affects only fetches, not pushes).2853 An attempt to fetch a hidden ref by `git fetch` will fail. See2854 also `uploadpack.allowTipSHA1InWant`.28552856uploadpack.allowTipSHA1InWant::2857 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2858 to accept a fetch request that asks for an object at the tip2859 of a hidden ref (by default, such a request is rejected).2860 see also `uploadpack.hideRefs`.28612862uploadpack.allowReachableSHA1InWant::2863 Allow `upload-pack` to accept a fetch request that asks for an2864 object that is reachable from any ref tip. However, note that2865 calculating object reachability is computationally expensive.2866 Defaults to `false`.28672868uploadpack.keepAlive::2869 When `upload-pack` has started `pack-objects`, there may be a2870 quiet period while `pack-objects` prepares the pack. Normally2871 it would output progress information, but if `--quiet` was used2872 for the fetch, `pack-objects` will output nothing at all until2873 the pack data begins. Some clients and networks may consider2874 the server to be hung and give up. Setting this option instructs2875 `upload-pack` to send an empty keepalive packet every2876 `uploadpack.keepAlive` seconds. Setting this option to 02877 disables keepalive packets entirely. The default is 5 seconds.28782879url.<base>.insteadOf::2880 Any URL that starts with this value will be rewritten to2881 start, instead, with <base>. In cases where some site serves a2882 large number of repositories, and serves them with multiple2883 access methods, and some users need to use different access2884 methods, this feature allows people to specify any of the2885 equivalent URLs and have Git automatically rewrite the URL to2886 the best alternative for the particular user, even for a2887 never-before-seen repository on the site. When more than one2888 insteadOf strings match a given URL, the longest match is used.28892890url.<base>.pushInsteadOf::2891 Any URL that starts with this value will not be pushed to;2892 instead, it will be rewritten to start with <base>, and the2893 resulting URL will be pushed to. In cases where some site serves2894 a large number of repositories, and serves them with multiple2895 access methods, some of which do not allow push, this feature2896 allows people to specify a pull-only URL and have Git2897 automatically use an appropriate URL to push, even for a2898 never-before-seen repository on the site. When more than one2899 pushInsteadOf strings match a given URL, the longest match is2900 used. If a remote has an explicit pushurl, Git will ignore this2901 setting for that remote.29022903user.email::2904 Your email address to be recorded in any newly created commits.2905 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2906 'EMAIL' environment variables. See linkgit:git-commit-tree[1].29072908user.name::2909 Your full name to be recorded in any newly created commits.2910 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2911 environment variables. See linkgit:git-commit-tree[1].29122913user.useConfigOnly::2914 Instruct Git to avoid trying to guess defaults for 'user.email'2915 and 'user.name', and instead retrieve the values only from the2916 configuration. For example, if you have multiple email addresses2917 and would like to use a different one for each repository, then2918 with this configuration option set to `true` in the global config2919 along with a name, Git will prompt you to set up an email before2920 making new commits in a newly cloned repository.2921 Defaults to `false`.29222923user.signingKey::2924 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2925 key you want it to automatically when creating a signed tag or2926 commit, you can override the default selection with this variable.2927 This option is passed unchanged to gpg's --local-user parameter,2928 so you may specify a key using any method that gpg supports.29292930versionsort.prereleaseSuffix::2931 When version sort is used in linkgit:git-tag[1], prerelease2932 tags (e.g. "1.0-rc1") may appear after the main release2933 "1.0". By specifying the suffix "-rc" in this variable,2934 "1.0-rc1" will appear before "1.0".2935+2936This variable can be specified multiple times, once per suffix. The2937order of suffixes in the config file determines the sorting order2938(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2939is sorted before 1.0-rcXX). The sorting order between different2940suffixes is undefined if they are in multiple config files.29412942web.browser::2943 Specify a web browser that may be used by some commands.2944 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2945 may use it.