Fix typos in the documentation
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
773002a7 5the git command's behavior. The `.git/config` file in each repository
66e35fcb
SB
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
773002a7 8fallback values for the `.git/config` file. The file `/etc/gitconfig`
66e35fcb 9can be used to store a system-wide default configuration.
5ea5621f 10
b7ee2266
SB
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
1ab661dd
PB
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
e136f33b
JN
18Syntax
19~~~~~~
20
1ab661dd 21The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
22ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
dcb11263 28characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
29must belong to some section, which means that there must be a section
30header before the first setting of a variable.
e136f33b
JN
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
773002a7 34in the section header, like in the example below:
e136f33b
JN
35
36--------
37 [section "subsection"]
38
39--------
40
b7ee2266
SB
41Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers cannot span multiple
e136f33b
JN
44lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
773002a7
SB
48There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
e136f33b 51
2ceb639f
NS
52All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
e136f33b
JN
54'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
dcb11263 57characters and `-` are allowed. There can be more than one value
e136f33b
JN
58for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
0cbcf7ad 650/1, true/false or on/off. Case is not significant in boolean values, when
e136f33b 66converting value to the canonical form using '--bool' type specifier;
0b444cdb 67'git config' will ensure that the output is "true" or "false".
e136f33b
JN
68
69String values may be entirely or partially enclosed in double quotes.
773002a7
SB
70You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
dcb11263 74be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 75
dcb11263
CJ
76The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
e136f33b
JN
79char sequences are valid.
80
773002a7 81Variable values ending in a `\` are continued on the next line in the
e136f33b
JN
82customary UNIX fashion.
83
773002a7 84Some variables may require a special value format.
1ab661dd
PB
85
86Example
87~~~~~~~
88
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
93
94 # Our diff algorithm
95 [diff]
6bb9e51b 96 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
97 renames = true
98
910c00c8
AK
99 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
102
e136f33b
JN
103 # Proxy settings
104 [core]
29093c28 105 gitProxy="ssh" for "kernel.org"
e136f33b 106 gitProxy=default-proxy ; for the rest
910c00c8 107
1ab661dd
PB
108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
114porcelain configuration variables in the respective porcelain documentation.
115
75194438
JK
116advice.*::
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
119 are:
120+
121--
122 pushNonFastForward::
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
edf563fb
JK
125 statusHints::
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
4c371f91
MM
129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 131 merge to avoid overwriting local changes.
4c371f91 132 Default: true.
d38a30df
MM
133 resolveConflict::
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
136 Default: true.
b706fcfe
JK
137 implicitIdentity::
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
13be3e31
JH
141
142 detachedHead::
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
75194438
JK
146--
147
1ab661dd
PB
148core.fileMode::
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
7b357240
MO
151 See linkgit:git-update-index[1].
152+
153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154will probe and set core.fileMode false if appropriate when the
155repository is created.
1ab661dd 156
adbc0b6b
DP
157core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
adbc0b6b 167
7b357240
MO
168core.ignorecase::
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
174 "Makefile".
175+
176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177will probe and set core.ignorecase true if appropriate when the repository
178is created.
179
1ce4790b
AR
180core.trustctime::
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
186
9378c161 187core.quotepath::
5833d730
JN
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
9378c161
JH
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
197 variable.
198
942e7747
EB
199core.eol::
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
205 conversion.
5cb71f82 206
21e5ad50 207core.safecrlf::
fd6cce9e
EB
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
217+
218CRLF conversion bears a slight chance of corrupting data.
942e7747 219When it is enabled, git will convert CRLF to LF during commit and LF to
21e5ad50
SP
220CRLF during checkout. A file that contains a mixture of LF and
221CRLF before the commit cannot be recreated by git. For text
222files this is the right thing to do: it corrects line endings
223such that we have only LF line endings in the repository.
224But for binary files that are accidentally classified as text the
225conversion can corrupt data.
226+
227If you recognize such corruption early you can easily fix it by
228setting the conversion type explicitly in .gitattributes. Right
229after committing you still have the original file in your work
230tree and this file is not yet corrupted. You can explicitly tell
231git that this file is binary and git will handle the file
232appropriately.
233+
234Unfortunately, the desired effect of cleaning up text files with
235mixed line endings and the undesired effect of corrupting binary
236files cannot be distinguished. In both cases CRLFs are removed
237in an irreversible way. For text files this is the right thing
238to do because CRLFs are line endings, while for binary files
239converting CRLFs corrupts data.
240+
241Note, this safety check does not mean that a checkout will generate a
242file identical to the original file for a different setting of
942e7747
EB
243`core.eol` and `core.autocrlf`, but only for the current one. For
244example, a text file with `LF` would be accepted with `core.eol=lf`
245and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
246resulting file would contain `CRLF`, although the original file
247contained `LF`. However, in both work trees the line endings would be
248consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249file with mixed line endings would be reported by the `core.safecrlf`
250mechanism.
251
942e7747
EB
252core.autocrlf::
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
261
78a8d641
JS
262core.symlinks::
263 If false, symbolic links are checked out as small plain files that
5162e697
DM
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 266 file. Useful on filesystems like FAT that do not support
7b357240
MO
267 symbolic links.
268+
269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270will probe and set core.symlinks false if appropriate when the repository
271is created.
78a8d641 272
1ab661dd
PB
273core.gitProxy::
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
b8936cf0
FD
281+
282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283(which always applies universally, without the special "for"
284handling).
642d0844
ES
285+
286The special string `none` can be used as the proxy command to
287specify that no proxy be used for a given domain pattern.
288This is useful for excluding servers inside a firewall from
289proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
290
291core.ignoreStat::
b7f685a7
MSO
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
1ab661dd
PB
299 False by default.
300
9f0bb90d
JH
301core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
1ab661dd 306
e4a15f40
SP
307core.bare::
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
5162e697 311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 312+
5162e697
DM
313This setting is automatically guessed by linkgit:git-clone[1] or
314linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
315repository that ends in "/.git" is assumed to be not bare (bare =
316false), while all other repositories are assumed to be bare (bare
317= true).
318
892c41b9 319core.worktree::
98acf759
NTND
320 Set the path to the working tree. The value will not be
321 used in combination with repositories found automatically in
322 a .git directory (i.e. $GIT_DIR is not set).
06ada152 323 This can be overridden by the GIT_WORK_TREE environment
302cc11a 324 variable and the '--work-tree' command line option. It can be
98acf759
NTND
325 an absolute path or relative path to the directory specified by
326 --git-dir or GIT_DIR.
327 Note: If --git-dir or GIT_DIR are specified but none of
302cc11a 328 --work-tree, GIT_WORK_TREE and core.worktree is specified,
98acf759
NTND
329 the current working directory is regarded as the top directory
330 of your working tree.
892c41b9 331
6de08ae6 332core.logAllRefUpdates::
14cd5607 333 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
334 "$GIT_DIR/logs/<ref>", by appending the new and old
335 SHA1, the date/time and the reason of the update, but
336 only when the file exists. If this configuration
337 variable is set to true, missing "$GIT_DIR/logs/<ref>"
338 file is automatically created for branch heads.
a862f97e
JH
339+
340This information can be used to determine what commit
341was the tip of a branch "2 days ago".
342+
343This value is true by default in a repository that has
344a working directory associated with it, and false by
345default in a bare repository.
6de08ae6 346
1ab661dd
PB
347core.repositoryFormatVersion::
348 Internal variable identifying the repository format and layout
349 version.
350
351core.sharedRepository::
d5dc6a76
JF
352 When 'group' (or 'true'), the repository is made shareable between
353 several users in a group (making sure all the files and objects are
354 group-writable). When 'all' (or 'world' or 'everybody'), the
355 repository will be readable by all users, additionally to being
356 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
357 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
358 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
359 user's umask value (whereas the other options will only override
360 requested parts of the user's umask value). Examples: '0660' will make
361 the repo read/write-able for the owner and group, but inaccessible to
362 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
363 repository that is group-readable but not group-writable.
364 See linkgit:git-init[1]. False by default.
1ab661dd
PB
365
366core.warnAmbiguousRefs::
367 If true, git will warn you if the ref name you passed it is ambiguous
368 and might match multiple refs in the .git/refs/ tree. True by default.
369
72a5b561
JH
370core.abbrevguard::
371 Even though git makes sure that it uses enough hexdigits to show
372 an abbreviated object name unambiguously, as more objects are
373 added to the repository over time, a short name that used to be
374 unique will stop being unique. Git uses this many extra hexdigits
375 that are more than necessary to make the object name currently
376 unique, in the hope that its output will stay unique a bit longer.
377 Defaults to 0.
378
3d3e95af 379core.compression::
960ccca6
DH
380 An integer -1..9, indicating a default compression level.
381 -1 is the zlib default. 0 means no compression,
382 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
383 If set, this provides a default to other compression variables,
384 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
385
386core.loosecompression::
12f6c308 387 An integer -1..9, indicating the compression level for objects that
960ccca6 388 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 389 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 390 slowest. If not set, defaults to core.compression. If that is
de1b2460 391 not set, defaults to 1 (best speed).
12f6c308 392
60bb8b14
SP
393core.packedGitWindowSize::
394 Number of bytes of a pack file to map into memory in a
395 single mapping operation. Larger window sizes may allow
396 your system to process a smaller number of large pack files
397 more quickly. Smaller window sizes will negatively affect
eb92242f 398 performance due to increased calls to the operating system's
60bb8b14 399 memory manager, but may improve performance when accessing
22bac0ea
SP
400 a large number of large pack files.
401+
402Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
403MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
404be reasonable for all users/operating systems. You probably do
405not need to adjust this value.
eb92242f
SP
406+
407Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 408
77ccc5bb
SP
409core.packedGitLimit::
410 Maximum number of bytes to map simultaneously into memory
411 from pack files. If Git needs to access more than this many
412 bytes at once to complete an operation it will unmap existing
413 regions to reclaim virtual address space within the process.
22bac0ea
SP
414+
415Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
416This should be reasonable for all users/operating systems, except on
417the largest projects. You probably do not need to adjust this value.
eb92242f
SP
418+
419Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 420
18bdec11
SP
421core.deltaBaseCacheLimit::
422 Maximum number of bytes to reserve for caching base objects
6b677a28 423 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
424 entire decompressed base objects in a cache Git is able
425 to avoid unpacking and decompressing frequently used base
426 objects multiple times.
427+
428Default is 16 MiB on all platforms. This should be reasonable
429for all users/operating systems, except on the largest projects.
430You probably do not need to adjust this value.
431+
432Common unit suffixes of 'k', 'm', or 'g' are supported.
433
5eef828b
SP
434core.bigFileThreshold::
435 Files larger than this size are stored deflated, without
436 attempting delta compression. Storing large files without
437 delta compression avoids excessive memory usage, at the
438 slight expense of increased disk usage.
439+
440Default is 512 MiB on all platforms. This should be reasonable
441for most projects as source code and other text files can still
442be delta compressed, but larger binary media files won't be.
443+
444Common unit suffixes of 'k', 'm', or 'g' are supported.
445+
446Currently only linkgit:git-fast-import[1] honors this setting.
447
e8964a5b 448core.excludesfile::
0ba956d3
JS
449 In addition to '.gitignore' (per-directory) and
450 '.git/info/exclude', git looks into this file for patterns
0f7fb21a
JH
451 of files which are not meant to be tracked. "{tilde}/" is expanded
452 to the value of `$HOME` and "{tilde}user/" to the specified user's
df2a79f4 453 home directory. See linkgit:gitignore[5].
0ba956d3 454
d3e7da89
AK
455core.askpass::
456 Some commands (e.g. svn and http interfaces) that interactively
457 ask for a password can be told to use an external program given
453842c9
KF
458 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
459 environment variable. If not set, fall back to the value of the
460 'SSH_ASKPASS' environment variable or, failing that, a simple password
461 prompt. The external program shall be given a suitable prompt as
462 command line argument and write the password on its STDOUT.
d3e7da89 463
6df42ab9
PO
464core.attributesfile::
465 In addition to '.gitattributes' (per-directory) and
466 '.git/info/attributes', git looks into this file for attributes
467 (see linkgit:gitattributes[5]). Path expansions are made the same
468 way as for `core.excludesfile`.
469
ef0c2abf
AR
470core.editor::
471 Commands such as `commit` and `tag` that lets you edit
02783075 472 messages by launching an editor uses the value of this
ef0c2abf 473 variable when it is set, and the environment variable
b4479f07 474 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 475
54adf370 476core.pager::
ab54cd6c
JN
477 The command that git will use to paginate output. Can
478 be overridden with the `GIT_PAGER` environment
479 variable. Note that git sets the `LESS` environment
480 variable to `FRSX` if it is unset when it runs the
481 pager. One can change these settings by setting the
fee75457
CF
482 `LESS` variable to some other value. Alternately,
483 these settings can be overridden on a project or
484 global basis by setting the `core.pager` option.
485 Setting `core.pager` has no affect on the `LESS`
486 environment variable behaviour above, so if you want
487 to override git's default settings this way, you need
488 to be explicit. For example, to disable the S option
489 in a backward compatible manner, set `core.pager`
dcb11263 490 to `less -+$LESS -FRX`. This will be passed to the
fee75457 491 shell by git, which will translate the final command to
dcb11263 492 `LESS=FRSX less -+FRSX -FRX`.
54adf370 493
91af7ae5
JH
494core.whitespace::
495 A comma separated list of common whitespace problems to
0b444cdb
TR
496 notice. 'git diff' will use `color.diff.whitespace` to
497 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
498 consider them as errors. You can prefix `-` to disable
499 any of them (e.g. `-trailing-space`):
91af7ae5 500+
aeb84b05 501* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
502 as an error (enabled by default).
503* `space-before-tab` treats a space character that appears immediately
504 before a tab character in the initial indent part of the line as an
505 error (enabled by default).
506* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 507 space characters as an error (not enabled by default).
3e3ec2ab
CW
508* `tab-in-indent` treats a tab character in the initial indent part of
509 the line as an error (not enabled by default).
77b15bbd
JH
510* `blank-at-eof` treats blank lines added at the end of file as an error
511 (enabled by default).
aeb84b05
JH
512* `trailing-space` is a short-hand to cover both `blank-at-eol` and
513 `blank-at-eof`.
b2979ff5
JH
514* `cr-at-eol` treats a carriage-return at the end of line as
515 part of the line terminator, i.e. with it, `trailing-space`
516 does not trigger if the character before such a carriage-return
517 is not a whitespace (not enabled by default).
f4b05a49
JS
518* `tabwidth=<n>` tells how many character positions a tab occupies; this
519 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
520 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 521
aafe9fba
LT
522core.fsyncobjectfiles::
523 This boolean will enable 'fsync()' when writing object files.
524+
525This is a total waste of time and effort on a filesystem that orders
526data writes properly, but can be useful for filesystems that do not use
527journalling (traditional UNIX filesystems) or that only journal metadata
528and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
529
671c9b7e
LT
530core.preloadindex::
531 Enable parallel index preload for operations like 'git diff'
532+
533This can speed up operations like 'git diff' and 'git status' especially
534on filesystems like NFS that have weak caching semantics and thus
535relatively high IO latencies. With this set to 'true', git will do the
536index comparison to the filesystem data in parallel, allowing
537overlapping IO's.
538
348df166
JS
539core.createObject::
540 You can set this to 'link', in which case a hardlink followed by
541 a delete of the source are used to make sure that object creation
542 will not overwrite existing objects.
543+
544On some file system/operating system combinations, this is unreliable.
545Set this config setting to 'rename' there; However, This will remove the
546check that makes sure that existing object files will not get overwritten.
be66a6c4 547
a97a7468
JS
548core.notesRef::
549 When showing commit messages, also show notes which are stored in
9eb3f816
JN
550 the given ref. The ref must be fully qualified. If the given
551 ref does not exist, it is not an error but means that no
552 notes should be printed.
a97a7468 553+
9eb3f816
JN
554This setting defaults to "refs/notes/commits", and it can be overridden by
555the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
a97a7468 556
08aefc9e
NTND
557core.sparseCheckout::
558 Enable "sparse checkout" feature. See section "Sparse checkout" in
559 linkgit:git-read-tree[1] for more information.
560
13bd2134 561add.ignore-errors::
6b3020a2 562add.ignoreErrors::
0b444cdb 563 Tells 'git add' to continue adding files when some files cannot be
13bd2134 564 added due to indexing errors. Equivalent to the '--ignore-errors'
6b3020a2
JN
565 option of linkgit:git-add[1]. Older versions of git accept only
566 `add.ignore-errors`, which does not follow the usual naming
567 convention for configuration variables. Newer versions of git
568 honor `add.ignoreErrors` as well.
13bd2134 569
4514ad4f 570alias.*::
5162e697 571 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
572 after defining "alias.last = cat-file commit HEAD", the invocation
573 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
574 confusion and troubles with script usage, aliases that
575 hide existing git commands are ignored. Arguments are split by
576 spaces, the usual shell quoting and escaping is supported.
577 quote pair and a backslash can be used to quote them.
f368f5a6
JH
578+
579If the alias expansion is prefixed with an exclamation point,
580it will be treated as a shell command. For example, defining
581"alias.new = !gitk --all --not ORIG_HEAD", the invocation
582"git new" is equivalent to running the shell command
595b8dbf
SC
583"gitk --all --not ORIG_HEAD". Note that shell commands will be
584executed from the top-level directory of a repository, which may
585not necessarily be the current directory.
dfd42a3c 586
e80d4cbe
SH
587am.keepcr::
588 If true, git-am will call git-mailsplit for patches in mbox format
589 with parameter '--keep-cr'. In this case git-mailsplit will
6b677a28 590 not remove `\r` from lines ending with `\r\n`. Can be overridden
e80d4cbe
SH
591 by giving '--no-keep-cr' from the command line.
592 See linkgit:git-am[1], linkgit:git-mailsplit[1].
593
86c91f91 594apply.ignorewhitespace::
0b444cdb 595 When set to 'change', tells 'git apply' to ignore changes in
86c91f91
GB
596 whitespace, in the same way as the '--ignore-space-change'
597 option.
0b444cdb 598 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
599 respect all whitespace differences.
600 See linkgit:git-apply[1].
601
1ab661dd 602apply.whitespace::
0b444cdb 603 Tells 'git apply' how to handle whitespaces, in the same way
5162e697 604 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 605
9902387d 606branch.autosetupmerge::
add0951a 607 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
608 so that linkgit:git-pull[1] will appropriately merge from the
609 starting point branch. Note that even if this option is not set,
9902387d 610 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
611 and `--no-track` options. The valid settings are: `false` -- no
612 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
613 starting point is a remote-tracking branch; `always` --
614 automatic setup is done when the starting point is either a
615 local branch or remote-tracking
572fc81d 616 branch. This option defaults to true.
9902387d 617
c998ae9b 618branch.autosetuprebase::
0b444cdb 619 When a new branch is created with 'git branch' or 'git checkout'
c998ae9b
DS
620 that tracks another branch, this variable tells git to set
621 up pull to rebase instead of merge (see "branch.<name>.rebase").
622 When `never`, rebase is never automatically set to true.
623 When `local`, rebase is set to true for tracked branches of
624 other local branches.
625 When `remote`, rebase is set to true for tracked branches of
29b9a66f 626 remote-tracking branches.
c998ae9b
DS
627 When `always`, rebase will be set to true for all tracking
628 branches.
629 See "branch.autosetupmerge" for details on how to set up a
630 branch to track another branch.
631 This option defaults to never.
632
648ad18f 633branch.<name>.remote::
0b444cdb 634 When in branch <name>, it tells 'git fetch' and 'git push' which
76d3cc50
SB
635 remote to fetch from/push to. It defaults to `origin` if no remote is
636 configured. `origin` is also used if you are not on any branch.
648ad18f 637
5372806a 638branch.<name>.merge::
76d3cc50 639 Defines, together with branch.<name>.remote, the upstream branch
0b444cdb
TR
640 for the given branch. It tells 'git fetch'/'git pull' which
641 branch to merge and can also affect 'git push' (see push.default).
642 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
643 refspec to be marked for merging in FETCH_HEAD. The value is
644 handled like the remote part of a refspec, and must match a
645 ref which is fetched from the remote given by
646 "branch.<name>.remote".
0b444cdb
TR
647 The merge information is used by 'git pull' (which at first calls
648 'git fetch') to lookup the default branch for merging. Without
649 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 650 Specify multiple values to get an octopus merge.
0b444cdb 651 If you wish to setup 'git pull' so that it merges into <name> from
9debc324
PB
652 another branch in the local repository, you can point
653 branch.<name>.merge to the desired branch, and use the special setting
654 `.` (a period) for branch.<name>.remote.
5372806a 655
aec7b362
LH
656branch.<name>.mergeoptions::
657 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 658 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
659 option values containing whitespace characters are currently not
660 supported.
661
cd67e4d4
JS
662branch.<name>.rebase::
663 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
664 instead of merging the default branch from the default remote when
665 "git pull" is run.
cd67e4d4 666 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 667 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
668 for details).
669
1658c614
CC
670browser.<tool>.cmd::
671 Specify the command to invoke the specified browser. The
672 specified command is evaluated in shell with the URLs passed
673 as arguments. (See linkgit:git-web--browse[1].)
674
584627b4
CC
675browser.<tool>.path::
676 Override the path for the given tool that may be used to
ab989adf
CC
677 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
678 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 679
2122591b 680clean.requireForce::
562ca192
JH
681 A boolean to make git-clean do nothing unless given -f
682 or -n. Defaults to true.
2122591b 683
f3673988
BG
684color.branch::
685 A boolean to enable/disable color in the output of
5162e697 686 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 687 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
688 only when the output is to a terminal. Defaults to false.
689
690color.branch.<slot>::
691 Use customized color for branch coloration. `<slot>` is one of
692 `current` (the current branch), `local` (a local branch),
8b3f3f84 693 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
694 refs).
695+
696The value for these configuration variables is a list of colors (at most
697two) and attributes (at most one), separated by spaces. The colors
698accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
699`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
700`blink` and `reverse`. The first color given is the foreground; the
701second is the background. The position of the attribute, if any,
702doesn't matter.
f3673988 703
a159ca0c 704color.diff::
cec99d8c
JH
705 When set to `always`, always use colors in patch.
706 When false (or `never`), never. When set to `true` or `auto`, use
707 colors only when the output is to the terminal. Defaults to false.
b5376648 708
a159ca0c 709color.diff.<slot>::
4f193f20
MW
710 Use customized color for diff colorization. `<slot>` specifies
711 which part of the patch to use the specified color, and is one
712 of `plain` (context text), `meta` (metainformation), `frag`
89cb73a1
BW
713 (hunk header), 'func' (function in hunk header), `old` (removed lines),
714 `new` (added lines), `commit` (commit headers), or `whitespace`
715 (highlighting whitespace errors). The values of these variables may be
716 specified as in color.branch.<slot>.
b5376648 717
5e11bee6
NR
718color.decorate.<slot>::
719 Use customized color for 'git log --decorate' output. `<slot>` is one
720 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 721 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 722
7e8f59d5
RS
723color.grep::
724 When set to `always`, always highlight matches. When `false` (or
725 `never`), never. When set to `true` or `auto`, use color only
726 when the output is written to the terminal. Defaults to `false`.
727
55f638bd
ML
728color.grep.<slot>::
729 Use customized color for grep colorization. `<slot>` specifies which
730 part of the line to use the specified color, and is one of
731+
732--
00588bb5
ML
733`context`;;
734 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
735`filename`;;
736 filename prefix (when not using `-h`)
00588bb5
ML
737`function`;;
738 function name lines (when using `-p`)
55f638bd
ML
739`linenumber`;;
740 line number prefix (when using `-n`)
741`match`;;
742 matching text
00588bb5
ML
743`selected`;;
744 non-matching text in selected lines
55f638bd
ML
745`separator`;;
746 separators between fields on a line (`:`, `-`, and `=`)
747 and between hunks (`--`)
748--
749+
750The values of these variables may be specified as in color.branch.<slot>.
7e8f59d5 751
b4c61ed6 752color.interactive::
47ee06f1 753 When set to `always`, always use colors for interactive prompts
467c0197 754 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
755 When false (or `never`), never. When set to `true` or `auto`, use
756 colors only when the output is to the terminal. Defaults to false.
757
758color.interactive.<slot>::
0b444cdb 759 Use customized color for 'git add --interactive'
a3019736
TR
760 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
761 four distinct types of normal output from interactive
57f6ec02 762 commands. The values of these variables may be specified as
b4c61ed6
JH
763 in color.branch.<slot>.
764
1d77043b
JH
765color.pager::
766 A boolean to enable/disable colored output when the pager is in
767 use (default is true).
768
ab07ba2a
MH
769color.showbranch::
770 A boolean to enable/disable color in the output of
771 linkgit:git-show-branch[1]. May be set to `always`,
772 `false` (or `never`) or `auto` (or `true`), in which case colors are used
773 only when the output is to a terminal. Defaults to false.
774
1d77043b
JH
775color.status::
776 A boolean to enable/disable color in the output of
5162e697 777 linkgit:git-status[1]. May be set to `always`,
cec99d8c 778 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
779 only when the output is to a terminal. Defaults to false.
780
781color.status.<slot>::
782 Use customized color for status colorization. `<slot>` is
783 one of `header` (the header text of the status message),
82dca848
SP
784 `added` or `updated` (files which are added but not committed),
785 `changed` (files which are changed but not added in the index),
1d282327
AA
786 `untracked` (files which are not tracked by git),
787 `branch` (the current branch), or
950ce2e2
CP
788 `nobranch` (the color the 'no branch' warning is shown in, defaulting
789 to red). The values of these variables may be specified as in
790 color.branch.<slot>.
1d77043b 791
6b2f2d98
MK
792color.ui::
793 When set to `always`, always use colors in all git commands which
794 are capable of colored output. When false (or `never`), never. When
795 set to `true` or `auto`, use colors only when the output is to the
796 terminal. When more specific variables of color.* are set, they always
797 take precedence over this setting. Defaults to false.
798
88955ed2 799commit.status::
bed575e4
JHI
800 A boolean to enable/disable inclusion of status information in the
801 commit message template when using an editor to prepare the commit
802 message. Defaults to true.
803
b0f34c3d
MM
804commit.template::
805 Specify a file to use as the template for new commit messages.
0f7fb21a 806 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
df2a79f4 807 specified user's home directory.
b0f34c3d 808
aecbf914 809diff.autorefreshindex::
0b444cdb 810 When using 'git diff' to compare with work tree
aecbf914
JH
811 files, do not consider stat-only change as changed.
812 Instead, silently run `git update-index --refresh` to
813 update the cached stat information for paths whose
814 contents in the work tree match the contents in the
815 index. This option defaults to true. Note that this
0b444cdb 816 affects only 'git diff' Porcelain, and not lower level
add0951a 817 'diff' commands such as 'git diff-files'.
aecbf914 818
77680caa
JS
819diff.external::
820 If this config variable is set, diff generation is not
821 performed using the internal diff machinery, but using the
6bb9e51b
AM
822 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
823 environment variable. The command is called with parameters
824 as described under "git Diffs" in linkgit:git[1]. Note: if
825 you want to use an external diff program only on a subset of
826 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 827
a5a818ee 828diff.mnemonicprefix::
0b444cdb 829 If set, 'git diff' uses a prefix pair that is different from the
a5a818ee
JH
830 standard "a/" and "b/" depending on what is being compared. When
831 this configuration is in effect, reverse diff output also swaps
832 the order of the prefixes:
ca768288 833`git diff`;;
a5a818ee 834 compares the (i)ndex and the (w)ork tree;
ca768288 835`git diff HEAD`;;
a5a818ee 836 compares a (c)ommit and the (w)ork tree;
ca768288 837`git diff --cached`;;
a5a818ee 838 compares a (c)ommit and the (i)ndex;
ca768288 839`git diff HEAD:file1 file2`;;
a5a818ee 840 compares an (o)bject and a (w)ork tree entity;
ca768288 841`git diff --no-index a b`;;
a5a818ee
JH
842 compares two non-git things (1) and (2).
843
9904fadf
ML
844diff.noprefix::
845 If set, 'git diff' does not show any source or destination prefix.
846
1ab661dd
PB
847diff.renameLimit::
848 The number of files to consider when performing the copy/rename
0b444cdb 849 detection; equivalent to the 'git diff' option '-l'.
1ab661dd 850
b68ea12e
EW
851diff.renames::
852 Tells git to detect renames. If set to any boolean value, it
853 will enable basic rename detection. If set to "copies" or
854 "copy", it will detect copies, as well.
855
be4f2b40
JS
856diff.ignoreSubmodules::
857 Sets the default value of --ignore-submodules. Note that this
858 affects only 'git diff' Porcelain, and not lower level 'diff'
62ed0096
JL
859 commands such as 'git diff-files'. 'git checkout' also honors
860 this setting when reporting uncommitted changes.
be4f2b40 861
950db879 862diff.suppressBlankEmpty::
5fdb7098
RH
863 A boolean to inhibit the standard behavior of printing a space
864 before each empty output line. Defaults to false.
865
afcbc8e7
DA
866diff.tool::
867 Controls which diff tool is used. `diff.tool` overrides
868 `merge.tool` when used by linkgit:git-difftool[1] and has
869 the same valid values as `merge.tool` minus "tortoisemerge"
870 and plus "kompare".
871
872difftool.<tool>.path::
873 Override the path for the given tool. This is useful in case
874 your tool is not in the PATH.
875
876difftool.<tool>.cmd::
877 Specify the command to invoke the specified diff tool.
878 The specified command is evaluated in shell with the following
879 variables available: 'LOCAL' is set to the name of the temporary
880 file containing the contents of the diff pre-image and 'REMOTE'
881 is set to the name of the temporary file containing the contents
882 of the diff post-image.
883
a904392e
DA
884difftool.prompt::
885 Prompt before each invocation of the diff tool.
886
ae3b970a 887diff.wordRegex::
98a4d87b
BSSJ
888 A POSIX Extended Regular Expression used to determine what is a "word"
889 when performing word-by-word difference calculations. Character
890 sequences that match the regular expression are "words", all other
891 characters are *ignorable* whitespace.
892
be254a0e
JL
893fetch.recurseSubmodules::
894 A boolean value which changes the behavior for fetch and pull, the
469bfc96 895 default is to not recursively fetch populated submodules unless
be254a0e
JL
896 configured otherwise.
897
af7cf268
JH
898fetch.unpackLimit::
899 If the number of objects fetched over the git native
900 transfer is below this
901 limit, then the objects will be unpacked into loose object
902 files. However if the number of received objects equals or
903 exceeds this limit then the received pack will be stored as
904 a pack, after adding any missing delta bases. Storing the
905 pack from a push can make the push operation complete faster,
80cd9cf9
MB
906 especially on slow filesystems. If not set, the value of
907 `transfer.unpackLimit` is used instead.
af7cf268 908
48d3448d
SB
909format.attach::
910 Enable multipart/mixed attachments as the default for
911 'format-patch'. The value can also be a double quoted string
912 which will enable attachments as the default and set the
913 value as the boundary. See the --attach option in
914 linkgit:git-format-patch[1].
915
49604a4d 916format.numbered::
a567fdcb
BG
917 A boolean which can enable or disable sequence numbers in patch
918 subjects. It defaults to "auto" which enables it only if there
919 is more than one patch. It can be enabled or disabled for all
920 messages by setting it to "true" or "false". See --numbered
921 option in linkgit:git-format-patch[1].
49604a4d 922
1ab661dd
PB
923format.headers::
924 Additional email headers to include in a patch to be submitted
5162e697 925 by mail. See linkgit:git-format-patch[1].
1ab661dd 926
312a30eb 927format.to::
48d3448d 928format.cc::
312a30eb
MV
929 Additional recipients to include in a patch to be submitted
930 by mail. See the --to and --cc options in
931 linkgit:git-format-patch[1].
48d3448d
SB
932
933format.subjectprefix::
934 The default for format-patch is to output files with the '[PATCH]'
935 subject prefix. Use this variable to change that prefix.
936
6622d9c7
SB
937format.signature::
938 The default for format-patch is to output a signature containing
939 the git version number. Use this variable to change that default.
940 Set this variable to the empty string ("") to suppress
941 signature generation.
942
78cb59c8
JS
943format.suffix::
944 The default for format-patch is to output files with the suffix
945 `.patch`. Use this variable to change that suffix (make sure to
946 include the dot if you want it).
1ab661dd 947
94c22a5e
CR
948format.pretty::
949 The default pretty format for log/show/whatchanged command,
950 See linkgit:git-log[1], linkgit:git-show[1],
951 linkgit:git-whatchanged[1].
952
30984ed2 953format.thread::
0b444cdb 954 The default threading style for 'git format-patch'. Can be
578b62bf
JN
955 a boolean value, or `shallow` or `deep`. `shallow` threading
956 makes every mail a reply to the head of the series,
30984ed2
TR
957 where the head is chosen from the cover letter, the
958 `\--in-reply-to`, and the first patch mail, in this order.
fd1ff306 959 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
960 A true boolean value is the same as `shallow`, and a false
961 value disables threading.
962
1d1876e9
HV
963format.signoff::
964 A boolean value which lets you enable the `-s/--signoff` option of
965 format-patch by default. *Note:* Adding the Signed-off-by: line to a
966 patch should be a conscious act and means that you certify you have
967 the rights to submit this work under the same open source license.
968 Please see the 'SubmittingPatches' document for further discussion.
969
0d7566a5
TT
970gc.aggressiveWindow::
971 The window size parameter used in the delta compression
0b444cdb 972 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 973 to 250.
0d7566a5 974
e9831e83
JH
975gc.auto::
976 When there are approximately more than this many loose
977 objects in the repository, `git gc --auto` will pack them.
978 Some Porcelain commands use this command to perform a
80cd9cf9
MB
979 light-weight garbage collection from time to time. The
980 default value is 6700. Setting this to 0 disables it.
e9831e83 981
17815501
JH
982gc.autopacklimit::
983 When there are more than this many packs that are not
984 marked with `*.keep` file in the repository, `git gc
80cd9cf9 985 --auto` consolidates them into one larger pack. The
97063974 986 default value is 50. Setting this to 0 disables it.
17815501 987
c2120e5e 988gc.packrefs::
efc266e8
JN
989 Running `git pack-refs` in a repository renders it
990 unclonable by Git versions prior to 1.5.1.2 over dumb
991 transports such as HTTP. This variable determines whether
4be0c352 992 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
993 to enable it within all non-bare repos or it can be set to a
994 boolean value. The default is `true`.
c2120e5e 995
25ee9731 996gc.pruneexpire::
0b444cdb 997 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
998 Override the grace period with this config variable. The value
999 "now" may be used to disable this grace period and always prune
1000 unreachable objects immediately.
25ee9731 1001
4aec56d1 1002gc.reflogexpire::
eb523a8d 1003gc.<pattern>.reflogexpire::
0b444cdb 1004 'git reflog expire' removes reflog entries older than
eb523a8d
JH
1005 this time; defaults to 90 days. With "<pattern>" (e.g.
1006 "refs/stash") in the middle the setting applies only to
1007 the refs that match the <pattern>.
4aec56d1
JH
1008
1009gc.reflogexpireunreachable::
eb523a8d 1010gc.<ref>.reflogexpireunreachable::
0b444cdb 1011 'git reflog expire' removes reflog entries older than
4aec56d1 1012 this time and are not reachable from the current tip;
eb523a8d
JH
1013 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1014 in the middle, the setting applies only to the refs that
1015 match the <pattern>.
4aec56d1 1016
48c32424
JH
1017gc.rerereresolved::
1018 Records of conflicted merge you resolved earlier are
0b444cdb 1019 kept for this many days when 'git rerere gc' is run.
5162e697 1020 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
1021
1022gc.rerereunresolved::
1023 Records of conflicted merge you have not resolved are
0b444cdb 1024 kept for this many days when 'git rerere gc' is run.
5162e697 1025 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1026
280514e1
FE
1027gitcvs.commitmsgannotation::
1028 Append this string to each commit message. Set to empty string
1029 to disable this feature. Defaults to "via git-CVS emulator".
1030
1ab661dd 1031gitcvs.enabled::
db218723 1032 Whether the CVS server interface is enabled for this repository.
5162e697 1033 See linkgit:git-cvsserver[1].
1ab661dd
PB
1034
1035gitcvs.logfile::
db218723 1036 Path to a log file where the CVS server interface well... logs
5162e697 1037 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1038
1707adb7 1039gitcvs.usecrlfattr::
5ec3e670
EB
1040 If true, the server will look up the end-of-line conversion
1041 attributes for files to determine the '-k' modes to use. If
1042 the attributes force git to treat a file as text,
6b677a28 1043 the '-k' mode will be left blank so CVS clients will
5ec3e670 1044 treat it as text. If they suppress text conversion, the file
1168d402 1045 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670
EB
1046 the client might otherwise do. If the attributes do not allow
1047 the file type to be determined, then 'gitcvs.allbinary' is
1048 used. See linkgit:gitattributes[5].
8a06a632 1049
eabb0bfd 1050gitcvs.allbinary::
90948a42
MO
1051 This is used if 'gitcvs.usecrlfattr' does not resolve
1052 the correct '-kb' mode to use. If true, all
1053 unresolved files are sent to the client in
1054 mode '-kb'. This causes the client to treat them
1055 as binary files, which suppresses any newline munging it
1056 otherwise might do. Alternatively, if it is set to "guess",
1057 then the contents of the file are examined to decide if
1058 it is binary, similar to 'core.autocrlf'.
abbf5947 1059
04752868
FL
1060gitcvs.dbname::
1061 Database used by git-cvsserver to cache revision information
1062 derived from the git repository. The exact meaning depends on the
1063 used database driver, for SQLite (which is the default driver) this
1064 is a filename. Supports variable substitution (see
5162e697 1065 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1066 Default: '%Ggitcvs.%m.sqlite'
1067
1068gitcvs.dbdriver::
1069 Used Perl DBI driver. You can specify any available driver
1070 for this here, but it might not work. git-cvsserver is tested
1071 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1072 reported *not* to work with 'DBD::mysql'. Experimental feature.
1073 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1074 See linkgit:git-cvsserver[1].
eabb0bfd 1075
04752868
FL
1076gitcvs.dbuser, gitcvs.dbpass::
1077 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1078 since SQLite has no concept of database users and/or passwords.
1079 'gitcvs.dbuser' supports variable substitution (see
5162e697 1080 linkgit:git-cvsserver[1] for details).
04752868 1081
6aeeffd1
JE
1082gitcvs.dbTableNamePrefix::
1083 Database table name prefix. Prepended to the names of any
1084 database tables used, allowing a single database to be used
1085 for several repositories. Supports variable substitution (see
1086 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1087 characters will be replaced with underscores.
1088
8a06a632
MO
1089All gitcvs variables except for 'gitcvs.usecrlfattr' and
1090'gitcvs.allbinary' can also be specified as
1091'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1092is one of "ext" and "pserver") to make them apply only for the given
1093access method.
04752868 1094
d84ae0db
GH
1095gui.commitmsgwidth::
1096 Defines how wide the commit message window is in the
1097 linkgit:git-gui[1]. "75" is the default.
1098
1099gui.diffcontext::
1100 Specifies how many context lines should be used in calls to diff
1101 made by the linkgit:git-gui[1]. The default is "5".
1102
a2df1fb2
AG
1103gui.encoding::
1104 Specifies the default encoding to use for displaying of
1105 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1106 It can be overridden by setting the 'encoding' attribute
1107 for relevant files (see linkgit:gitattributes[5]).
1108 If this option is not set, the tools default to the
1109 locale encoding.
1110
d84ae0db
GH
1111gui.matchtrackingbranch::
1112 Determines if new branches created with linkgit:git-gui[1] should
1113 default to tracking remote branches with matching names or
1114 not. Default: "false".
1115
1116gui.newbranchtemplate::
1117 Is used as suggested name when creating new branches using the
1118 linkgit:git-gui[1].
1119
1120gui.pruneduringfetch::
8b3f3f84 1121 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1122 performing a fetch. The default value is "false".
1123
1124gui.trustmtime::
1125 Determines if linkgit:git-gui[1] should trust the file modification
1126 timestamp or not. By default the timestamps are not trusted.
1127
1128gui.spellingdictionary::
1129 Specifies the dictionary used for spell checking commit messages in
1130 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1131 off.
1132
a2df1fb2 1133gui.fastcopyblame::
ca768288 1134 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1135 location detection. It makes blame significantly faster on huge
1136 repositories at the expense of less thorough copy detection.
1137
1138gui.copyblamethreshold::
76bac890 1139 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1140 detection, measured in alphanumeric characters. See the
1141 linkgit:git-blame[1] manual for more information on copy detection.
1142
1143gui.blamehistoryctx::
1144 Specifies the radius of history context in days to show in
1145 linkgit:gitk[1] for the selected commit, when the `Show History
1146 Context` menu item is invoked from 'git gui blame'. If this
1147 variable is set to zero, the whole history is shown.
1148
390c3480
AG
1149guitool.<name>.cmd::
1150 Specifies the shell command line to execute when the corresponding item
1151 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1152 mandatory for every tool. The command is executed from the root of
1153 the working directory, and in the environment it receives the name of
1154 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1155 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1156 the head is detached, 'CUR_BRANCH' is empty).
1157
1158guitool.<name>.needsfile::
1159 Run the tool only if a diff is selected in the GUI. It guarantees
1160 that 'FILENAME' is not empty.
1161
1162guitool.<name>.noconsole::
1163 Run the command silently, without creating a window to display its
1164 output.
1165
1166guitool.<name>.norescan::
1167 Don't rescan the working directory for changes after the tool
1168 finishes execution.
1169
1170guitool.<name>.confirm::
1171 Show a confirmation dialog before actually running the tool.
1172
1173guitool.<name>.argprompt::
1174 Request a string argument from the user, and pass it to the tool
1175 through the 'ARGS' environment variable. Since requesting an
1176 argument implies confirmation, the 'confirm' option has no effect
1177 if this is enabled. If the option is set to 'true', 'yes', or '1',
1178 the dialog uses a built-in generic prompt; otherwise the exact
1179 value of the variable is used.
1180
1181guitool.<name>.revprompt::
1182 Request a single valid revision from the user, and set the
1183 'REVISION' environment variable. In other aspects this option
1184 is similar to 'argprompt', and can be used together with it.
1185
1186guitool.<name>.revunmerged::
1187 Show only unmerged branches in the 'revprompt' subdialog.
1188 This is useful for tools similar to merge or rebase, but not
1189 for things like checkout or reset.
1190
1191guitool.<name>.title::
1192 Specifies the title to use for the prompt dialog. The default
1193 is the tool name.
1194
1195guitool.<name>.prompt::
1196 Specifies the general prompt string to display at the top of
1197 the dialog, before subsections for 'argprompt' and 'revprompt'.
1198 The default value includes the actual command.
1199
983a9eeb
CC
1200help.browser::
1201 Specify the browser that will be used to display help in the
1202 'web' format. See linkgit:git-help[1].
1203
1204help.format::
1205 Override the default help format used by linkgit:git-help[1].
1206 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1207 the default. 'web' and 'html' are the same.
1208
f0e90716
AR
1209help.autocorrect::
1210 Automatically correct and execute mistyped commands after
1211 waiting for the given number of deciseconds (0.1 sec). If more
1212 than one command can be deduced from the entered text, nothing
1213 will be executed. If the value of this option is negative,
1214 the corrected command will be executed immediately. If the
1215 value is 0 - the command will be just shown but not executed.
1216 This is the default.
1217
9c5665aa
SV
1218http.proxy::
1219 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 1220 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 1221 on a per-remote basis; see remote.<name>.proxy
9c5665aa 1222
1ab661dd
PB
1223http.sslVerify::
1224 Whether to verify the SSL certificate when fetching or pushing
37425065 1225 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1226 variable.
1227
1228http.sslCert::
1229 File containing the SSL certificate when fetching or pushing
37425065 1230 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1231 variable.
1232
1233http.sslKey::
1234 File containing the SSL private key when fetching or pushing
abda1ef5 1235 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1236 variable.
1237
754ae192
ML
1238http.sslCertPasswordProtected::
1239 Enable git's password prompt for the SSL certificate. Otherwise
1240 OpenSSL will prompt the user, possibly many times, if the
1241 certificate or private key is encrypted. Can be overridden by the
1242 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1243
1ab661dd
PB
1244http.sslCAInfo::
1245 File containing the certificates to verify the peer with when
abda1ef5 1246 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1247 'GIT_SSL_CAINFO' environment variable.
1248
1249http.sslCAPath::
1250 Path containing files with the CA certificates to verify the peer
37425065 1251 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1252 by the 'GIT_SSL_CAPATH' environment variable.
1253
1254http.maxRequests::
abda1ef5 1255 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1256 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1257
ad75ebe5
TRC
1258http.minSessions::
1259 The number of curl sessions (counted across slots) to be kept across
1260 requests. They will not be ended with curl_easy_cleanup() until
1261 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1262 value will be capped at 1. Defaults to 1.
1263
de1a2fdd
SP
1264http.postBuffer::
1265 Maximum size in bytes of the buffer used by smart HTTP
1266 transports when POSTing data to the remote system.
1267 For requests larger than this buffer size, HTTP/1.1 and
1268 Transfer-Encoding: chunked is used to avoid creating a
1269 massive pack file locally. Default is 1 MiB, which is
1270 sufficient for most requests.
1271
1ab661dd
PB
1272http.lowSpeedLimit, http.lowSpeedTime::
1273 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1274 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1275 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1276 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1277
3ea099d4
SK
1278http.noEPSV::
1279 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1280 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1281 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1282 environment variable. Default is false (curl will use EPSV).
1283
b1d1058c
SO
1284http.useragent::
1285 The HTTP USER_AGENT string presented to an HTTP server. The default
1286 value represents the version of the client git such as git/1.7.1.
1287 This option allows you to override this value to a more common value
1288 such as Mozilla/4.0. This may be necessary, for instance, if
1289 connecting through a firewall that restricts HTTP connections to a set
1290 of common USER_AGENT strings (but not including those like git/1.7.1).
1291 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1292
1ab661dd
PB
1293i18n.commitEncoding::
1294 Character encoding the commit messages are stored in; git itself
1295 does not care per se, but this information is necessary e.g. when
1296 importing commits from emails or in the gitk graphical history
1297 browser (and possibly at other places in the future or in other
5162e697 1298 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1299
d2c11a38
JH
1300i18n.logOutputEncoding::
1301 Character encoding the commit messages are converted to when
0b444cdb 1302 running 'git log' and friends.
d2c11a38 1303
b0f34c3d
MM
1304imap::
1305 The configuration variables in the 'imap' section are described
1306 in linkgit:git-imap-send[1].
1307
d8a8488d
SD
1308init.templatedir::
1309 Specify the directory from which templates will be copied.
1310 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1311
983a9eeb
CC
1312instaweb.browser::
1313 Specify the program that will be used to browse your working
1314 repository in gitweb. See linkgit:git-instaweb[1].
1315
1316instaweb.httpd::
1317 The HTTP daemon command-line to start gitweb on your working
1318 repository. See linkgit:git-instaweb[1].
1319
1320instaweb.local::
1321 If true the web server started by linkgit:git-instaweb[1] will
1322 be bound to the local IP (127.0.0.1).
1323
1324instaweb.modulepath::
6b677a28
VS
1325 The default module path for linkgit:git-instaweb[1] to use
1326 instead of /usr/lib/apache2/modules. Only used if httpd
1327 is Apache.
983a9eeb
CC
1328
1329instaweb.port::
1330 The port number to bind the gitweb httpd to. See
1331 linkgit:git-instaweb[1].
1332
ca6ac7f1 1333interactive.singlekey::
57f6ec02 1334 In interactive commands, allow the user to provide one-letter
ca6ac7f1
TR
1335 input with a single key (i.e., without hitting enter).
1336 Currently this is used only by the `\--patch` mode of
1337 linkgit:git-add[1]. Note that this setting is silently
1338 ignored if portable keystroke input is not available.
1339
dd0ffd5b 1340log.date::
e860795d
JN
1341 Set the default date-time mode for the 'log' command.
1342 Setting a value for log.date is similar to using 'git log''s
1343 `\--date` option. Possible values are `relative`, `local`,
1344 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1345 for details.
dd0ffd5b 1346
eb734454
SD
1347log.decorate::
1348 Print out the ref names of any commits that are shown by the log
1349 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1350 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1351 specified, the full ref name (including prefix) will be printed.
1352 This is the same as the log commands '--decorate' option.
1353
0f03ca94
PB
1354log.showroot::
1355 If true, the initial commit will be shown as a big creation event.
1356 This is equivalent to a diff against an empty tree.
5162e697 1357 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1358 normally hide the root commit will now show it. True by default.
1359
d551a488
MSO
1360mailmap.file::
1361 The location of an augmenting mailmap file. The default
1362 mailmap, located in the root of the repository, is loaded
1363 first, then the mailmap file pointed to by this variable.
1364 The location of the mailmap file may be in a repository
1365 subdirectory, or somewhere outside of the repository itself.
1366 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1367
b5578f33 1368man.viewer::
b8322ea8 1369 Specify the programs that may be used to display help in the
b5578f33
CC
1370 'man' format. See linkgit:git-help[1].
1371
0bb64009
CC
1372man.<tool>.cmd::
1373 Specify the command to invoke the specified man viewer. The
1374 specified command is evaluated in shell with the man page
1375 passed as argument. (See linkgit:git-help[1].)
1376
7e8114c0
CC
1377man.<tool>.path::
1378 Override the path for the given tool that may be used to
1379 display help in the 'man' format. See linkgit:git-help[1].
1380
b0f34c3d 1381include::merge-config.txt[]
b5412484 1382
77680caa
JS
1383mergetool.<tool>.path::
1384 Override the path for the given tool. This is useful in case
1385 your tool is not in the PATH.
1386
964473a0
CB
1387mergetool.<tool>.cmd::
1388 Specify the command to invoke the specified merge tool. The
1389 specified command is evaluated in shell with the following
1390 variables available: 'BASE' is the name of a temporary file
1391 containing the common base of the files to be merged, if available;
1392 'LOCAL' is the name of a temporary file containing the contents of
1393 the file on the current branch; 'REMOTE' is the name of a temporary
1394 file containing the contents of the file from the branch being
1395 merged; 'MERGED' contains the name of the file to which the merge
1396 tool should write the results of a successful merge.
1397
1398mergetool.<tool>.trustExitCode::
1399 For a custom merge command, specify whether the exit code of
1400 the merge command can be used to determine whether the merge was
1401 successful. If this is not set to true then the merge target file
1402 timestamp is checked and the merge assumed to have been successful
1403 if the file has been updated, otherwise the user is prompted to
1404 indicate the success of the merge.
1405
44c36d1c
CB
1406mergetool.keepBackup::
1407 After performing a merge, the original file with conflict markers
1408 can be saved as a file with a `.orig` extension. If this variable
1409 is set to `false` then this file is not preserved. Defaults to
1410 `true` (i.e. keep the backup files).
1411
162eba8b
CB
1412mergetool.keepTemporaries::
1413 When invoking a custom merge tool, git uses a set of temporary
1414 files to pass to the tool. If the tool returns an error and this
1415 variable is set to `true`, then these temporary files will be
1416 preserved, otherwise they will be removed after the tool has
1417 exited. Defaults to `false`.
1418
682b451f
CB
1419mergetool.prompt::
1420 Prompt before each invocation of the merge resolution program.
1421
894a9d33
TR
1422notes.displayRef::
1423 The (fully qualified) refname from which to show notes when
1424 showing commit messages. The value of this variable can be set
1425 to a glob, in which case notes from all matching refs will be
1426 shown. You may also specify this configuration variable
1427 several times. A warning will be issued for refs that do not
1428 exist, but a glob that does not match any refs is silently
1429 ignored.
1430+
1431This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1432environment variable, which must be a colon separated list of refs or
1433globs.
1434+
1435The effective value of "core.notesRef" (possibly overridden by
1436GIT_NOTES_REF) is also implicitly added to the list of refs to be
1437displayed.
1438
6956f858
TR
1439notes.rewrite.<command>::
1440 When rewriting commits with <command> (currently `amend` or
1441 `rebase`) and this variable is set to `true`, git
1442 automatically copies your notes from the original to the
1443 rewritten commit. Defaults to `true`, but see
1444 "notes.rewriteRef" below.
6956f858
TR
1445
1446notes.rewriteMode::
1447 When copying notes during a rewrite (see the
1448 "notes.rewrite.<command>" option), determines what to do if
1449 the target commit already has a note. Must be one of
1450 `overwrite`, `concatenate`, or `ignore`. Defaults to
1451 `concatenate`.
1452+
1453This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1454environment variable.
1455
1456notes.rewriteRef::
1457 When copying notes during a rewrite, specifies the (fully
1458 qualified) ref whose notes should be copied. The ref may be a
1459 glob, in which case notes in all matching refs will be copied.
1460 You may also specify this configuration several times.
1461+
1462Does not have a default value; you must configure this variable to
1463enable note rewriting.
cfb88e9a
LAS
1464+
1465This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1466environment variable, which must be a colon separated list of refs or
1467globs.
6956f858 1468
4812a93a 1469pack.window::
5162e697 1470 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1471 window size is given on the command line. Defaults to 10.
1472
842aaf93 1473pack.depth::
5162e697 1474 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1475 maximum depth is given on the command line. Defaults to 50.
842aaf93 1476
e93b15cd 1477pack.windowMemory::
5162e697 1478 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1479 when no limit is given on the command line. The value can be
1480 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1481 limit.
1482
960ccca6
DH
1483pack.compression::
1484 An integer -1..9, indicating the compression level for objects
1485 in a pack file. -1 is the zlib default. 0 means no
1486 compression, and 1..9 are various speed/size tradeoffs, 9 being
1487 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1488 not set, defaults to -1, the zlib default, which is "a default
1489 compromise between speed and compression (currently equivalent
1490 to level 6)."
89d71f75
JK
1491+
1492Note that changing the compression level will not automatically recompress
1493all existing objects. You can force recompression by passing the -F option
1494to linkgit:git-repack[1].
960ccca6 1495
074b2eea 1496pack.deltaCacheSize::
02783075 1497 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
1498 linkgit:git-pack-objects[1] before writing them out to a pack.
1499 This cache is used to speed up the writing object phase by not
1500 having to recompute the final delta result once the best match
1501 for all objects is found. Repacking large repositories on machines
1502 which are tight with memory might be badly impacted by this though,
1503 especially if this cache pushes the system into swapping.
1504 A value of 0 means no limit. The smallest size of 1 byte may be
1505 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 1506
e3dfddb3 1507pack.deltaCacheLimit::
693b86ff 1508 The maximum size of a delta, that is cached in
5749b0b2
NP
1509 linkgit:git-pack-objects[1]. This cache is used to speed up the
1510 writing object phase by not having to recompute the final delta
1511 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 1512
693b86ff
NP
1513pack.threads::
1514 Specifies the number of threads to spawn when searching for best
5162e697 1515 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1516 be compiled with pthreads otherwise this option is ignored with a
1517 warning. This is meant to reduce packing time on multiprocessor
1518 machines. The required amount of memory for the delta search window
1519 is however multiplied by the number of threads.
833e3df1
AE
1520 Specifying 0 will cause git to auto-detect the number of CPU's
1521 and set the number of threads accordingly.
693b86ff 1522
4d00bda2
NP
1523pack.indexVersion::
1524 Specify the default pack index version. Valid values are 1 for
1525 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1526 the new pack index with capabilities for packs larger than 4 GB
1527 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1528 packs. Version 2 is the default. Note that version 2 is enforced
1529 and this config option ignored whenever the corresponding pack is
1530 larger than 2 GB.
1531+
1532If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1533cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1534that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1535other side may give you a repository that cannot be accessed with your
1536older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1537you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1538the `{asterisk}.idx` file.
4d00bda2 1539
dbdbfec4 1540pack.packSizeLimit::
07cf0f24
NP
1541 The maximum size of a pack. This setting only affects
1542 packing to a file when repacking, i.e. the git:// protocol
1543 is unaffected. It can be overridden by the `\--max-pack-size`
1544 option of linkgit:git-repack[1]. The minimum size allowed is
1545 limited to 1 MiB. The default is unlimited.
1546 Common unit suffixes of 'k', 'm', or 'g' are
1547 supported.
2b84b5a8 1548
4370c2d6 1549pager.<cmd>::
9bad7233
JK
1550 If the value is boolean, turns on or off pagination of the
1551 output of a particular git subcommand when writing to a tty.
1552 Otherwise, turns on pagination for the subcommand using the
1553 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1554 or `\--no-pager` is specified on the command line, it takes
1555 precedence over this option. To disable pagination for all
1556 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1557
8028184e
WP
1558pretty.<name>::
1559 Alias for a --pretty= format string, as specified in
1560 linkgit:git-log[1]. Any aliases defined here can be used just
1561 as the built-in pretty formats could. For example,
1562 running `git config pretty.changelog "format:{asterisk} %H %s"`
1563 would cause the invocation `git log --pretty=changelog`
1564 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1565 Note that an alias with the same name as a built-in format
1566 will be silently ignored.
1567
1ab661dd
PB
1568pull.octopus::
1569 The default merge strategy to use when pulling multiple branches
1570 at once.
1571
1572pull.twohead::
1573 The default merge strategy to use when pulling a single branch.
1574
52153747
FAG
1575push.default::
1576 Defines the action git push should take if no refspec is given
1577 on the command line, no refspec is configured in the remote, and
1578 no refspec is implied by any of the options given on the command
01eadafc 1579 line. Possible values are:
52153747 1580+
9373bdc4
CF
1581* `nothing` - do not push anything.
1582* `matching` - push all matching branches.
52153747 1583 All branches having the same name in both ends are considered to be
01eadafc 1584 matching. This is the default.
9373bdc4
CF
1585* `tracking` - push the current branch to its upstream branch.
1586* `current` - push the current branch to a branch of the same name.
52153747 1587
a9c3821c
TAV
1588rebase.stat::
1589 Whether to show a diffstat of what changed upstream since the last
1590 rebase. False by default.
1591
dd1e5b31
HV
1592rebase.autosquash::
1593 If set to true enable '--autosquash' option by default.
1594
77e3efbf
JH
1595receive.autogc::
1596 By default, git-receive-pack will run "git-gc --auto" after
1597 receiving data from git-push and updating refs. You can stop
1598 it by setting this variable to false.
1599
b0f34c3d
MM
1600receive.fsckObjects::
1601 If it is set to true, git-receive-pack will check all received
1602 objects. It will abort in the case of a malformed object or a
1603 broken link. The result of an abort are only dangling objects.
1604 Defaults to false.
1605
1606receive.unpackLimit::
1607 If the number of objects received in a push is below this
1608 limit then the objects will be unpacked into loose object
1609 files. However if the number of received objects equals or
1610 exceeds this limit then the received pack will be stored as
1611 a pack, after adding any missing delta bases. Storing the
1612 pack from a push can make the push operation complete faster,
1613 especially on slow filesystems. If not set, the value of
1614 `transfer.unpackLimit` is used instead.
1615
42fc11c1
JH
1616receive.denyDeletes::
1617 If set to true, git-receive-pack will deny a ref update that deletes
1618 the ref. Use this to prevent such a ref deletion via a push.
1619
662c83ff
TR
1620receive.denyDeleteCurrent::
1621 If set to true, git-receive-pack will deny a ref update that
1622 deletes the currently checked out branch of a non-bare repository.
1623
42fc11c1 1624receive.denyCurrentBranch::
f3838ce1 1625 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
1626 to the currently checked out branch of a non-bare repository.
1627 Such a push is potentially dangerous because it brings the HEAD
1628 out of sync with the index and working tree. If set to "warn",
1629 print a warning of such a push to stderr, but allow the push to
1630 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 1631 message. Defaults to "refuse".
42fc11c1 1632
b0f34c3d
MM
1633receive.denyNonFastForwards::
1634 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 1635 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
1636 even if that push is forced. This configuration variable is
1637 set when initializing a shared repository.
1638
77e3efbf
JH
1639receive.updateserverinfo::
1640 If set to true, git-receive-pack will run git-update-server-info
1641 after receiving data from git-push and updating refs.
1642
0cc6d346 1643remote.<name>.url::
5162e697
DM
1644 The URL of a remote repository. See linkgit:git-fetch[1] or
1645 linkgit:git-push[1].
0cc6d346 1646
20346234
MG
1647remote.<name>.pushurl::
1648 The push URL of a remote repository. See linkgit:git-push[1].
1649
14c98218
SV
1650remote.<name>.proxy::
1651 For remotes that require curl (http, https and ftp), the URL to
1652 the proxy to use for that remote. Set to the empty string to
1653 disable proxying for that remote.
1654
0cc6d346 1655remote.<name>.fetch::
5162e697
DM
1656 The default set of "refspec" for linkgit:git-fetch[1]. See
1657 linkgit:git-fetch[1].
0cc6d346
SB
1658
1659remote.<name>.push::
5162e697
DM
1660 The default set of "refspec" for linkgit:git-push[1]. See
1661 linkgit:git-push[1].
0cc6d346 1662
84bb2dfd
PB
1663remote.<name>.mirror::
1664 If true, pushing to this remote will automatically behave
1665 as if the `\--mirror` option was given on the command line.
1666
1918278e
TT
1667remote.<name>.skipDefaultUpdate::
1668 If true, this remote will be skipped by default when updating
7cc91a2f
BG
1669 using linkgit:git-fetch[1] or the `update` subcommand of
1670 linkgit:git-remote[1].
1671
1672remote.<name>.skipFetchAll::
1673 If true, this remote will be skipped by default when updating
1674 using linkgit:git-fetch[1] or the `update` subcommand of
1675 linkgit:git-remote[1].
1918278e 1676
060aafc1 1677remote.<name>.receivepack::
5dee29ac 1678 The default program to execute on the remote side when pushing. See
79f43f3d 1679 option \--receive-pack of linkgit:git-push[1].
060aafc1 1680
5dee29ac
UKK
1681remote.<name>.uploadpack::
1682 The default program to execute on the remote side when fetching. See
79f43f3d 1683 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1684
047f636d 1685remote.<name>.tagopt::
79f43f3d 1686 Setting this value to \--no-tags disables automatic tag following when
944163a4
ST
1687 fetching from remote <name>. Setting it to \--tags will fetch every
1688 tag from remote <name>, even if they are not reachable from remote
ed368546
DJ
1689 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1690 override this setting. See options \--tags and \--no-tags of
1691 linkgit:git-fetch[1].
047f636d 1692
c578f51d
DB
1693remote.<name>.vcs::
1694 Setting this to a value <vcs> will cause git to interact with
1695 the remote with the git-remote-<vcs> helper.
1696
1918278e
TT
1697remotes.<group>::
1698 The list of remotes which are fetched by "git remote update
5162e697 1699 <group>". See linkgit:git-remote[1].
1918278e 1700
b6945f57 1701repack.usedeltabaseoffset::
22c79eab
NP
1702 By default, linkgit:git-repack[1] creates packs that use
1703 delta-base offset. If you need to share your repository with
1704 git older than version 1.4.4, either directly or via a dumb
1705 protocol such as http, then you need to set this option to
1706 "false" and repack. Access from old git versions over the
1707 native protocol are unaffected by this option.
b6945f57 1708
b0f34c3d
MM
1709rerere.autoupdate::
1710 When set to true, `git-rerere` updates the index with the
1711 resulting contents after it cleanly resolves conflicts using
1712 previously recorded resolution. Defaults to false.
1713
1714rerere.enabled::
1715 Activate recording of resolved conflicts, so that identical
1716 conflict hunks can be resolved automatically, should they
1717 be encountered again. linkgit:git-rerere[1] command is by
1718 default enabled if you create `rr-cache` directory under
1719 `$GIT_DIR`, but can be disabled by setting this option to false.
1720
65180c66
YD
1721sendemail.identity::
1722 A configuration identity. When given, causes values in the
1723 'sendemail.<identity>' subsection to take precedence over
1724 values in the 'sendemail' section. The default identity is
1725 the value of 'sendemail.identity'.
1726
1727sendemail.smtpencryption::
1728 See linkgit:git-send-email[1] for description. Note that this
1729 setting is not subject to the 'identity' mechanism.
1730
1731sendemail.smtpssl::
1732 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1733
1734sendemail.<identity>.*::
1735 Identity-specific versions of the 'sendemail.*' parameters
1736 found below, taking precedence over those when the this
1737 identity is selected, through command-line or
1738 'sendemail.identity'.
1739
1740sendemail.aliasesfile::
1741sendemail.aliasfiletype::
1742sendemail.bcc::
1743sendemail.cc::
1744sendemail.cccmd::
1745sendemail.chainreplyto::
1746sendemail.confirm::
1747sendemail.envelopesender::
1748sendemail.from::
1749sendemail.multiedit::
1750sendemail.signedoffbycc::
1751sendemail.smtppass::
1752sendemail.suppresscc::
1753sendemail.suppressfrom::
1754sendemail.to::
69cf7bfd 1755sendemail.smtpdomain::
65180c66
YD
1756sendemail.smtpserver::
1757sendemail.smtpserverport::
052fbea2 1758sendemail.smtpserveroption::
65180c66
YD
1759sendemail.smtpuser::
1760sendemail.thread::
1761sendemail.validate::
1762 See linkgit:git-send-email[1] for description.
1763
1764sendemail.signedoffcc::
1765 Deprecated alias for 'sendemail.signedoffbycc'.
1766
1ab661dd 1767showbranch.default::
5162e697
DM
1768 The default set of branches for linkgit:git-show-branch[1].
1769 See linkgit:git-show-branch[1].
1ab661dd 1770
46f721c8 1771status.relativePaths::
5162e697 1772 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1773 current directory. Setting this variable to `false` shows paths
1774 relative to the repository root (this was the default for git
1775 prior to v1.5.4).
1776
d6293d1f
MSO
1777status.showUntrackedFiles::
1778 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1779 files which are not currently tracked by Git. Directories which
1780 contain only untracked files, are shown with the directory name
1781 only. Showing untracked files means that Git needs to lstat() all
1782 all the files in the whole repository, which might be slow on some
1783 systems. So, this variable controls how the commands displays
1784 the untracked files. Possible values are:
1785+
1786--
9373bdc4
CF
1787* `no` - Show no untracked files.
1788* `normal` - Show untracked files and directories.
1789* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
1790--
1791+
1792If this variable is not specified, it defaults to 'normal'.
1793This variable can be overridden with the -u|--untracked-files option
1794of linkgit:git-status[1] and linkgit:git-commit[1].
1795
4b2343fa
MG
1796status.submodulesummary::
1797 Defaults to false.
1798 If this is set to a non zero number or true (identical to -1 or an
1799 unlimited number), the submodule summary will be enabled and a
1800 summary of commits for modified submodules will be shown (see
1801 --summary-limit option of linkgit:git-submodule[1]).
1802
0ad0a61f
JN
1803submodule.<name>.path::
1804submodule.<name>.url::
1805submodule.<name>.update::
1806 The path within this project, URL, and the updating strategy
1807 for a submodule. These variables are initially populated
1808 by 'git submodule init'; edit them to override the
1809 URL and other values found in the `.gitmodules` file. See
1810 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1811
c1a3c364
JL
1812submodule.<name>.fetchRecurseSubmodules::
1813 This option can be used to enable/disable recursive fetching of this
469bfc96 1814 submodule. It can be overridden by using the --[no-]recurse-submodules
c1a3c364
JL
1815 command line option to "git fetch" and "git pull".
1816 This setting will override that from in the linkgit:gitmodules[5]
1817 file.
1818
aee9c7d6
JL
1819submodule.<name>.ignore::
1820 Defines under what circumstances "git status" and the diff family show
1821 a submodule as modified. When set to "all", it will never be considered
1822 modified, "dirty" will ignore all changes to the submodules work tree and
1823 takes only differences between the HEAD of the submodule and the commit
1824 recorded in the superproject into account. "untracked" will additionally
1825 let submodules with modified tracked files in their work tree show up.
1826 Using "none" (the default when this option is not set) also shows
1827 submodules that have untracked files in their work tree as changed.
302ad7a9 1828 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 1829 both settings can be overridden on the command line by using the
be4f2b40 1830 "--ignore-submodules" option.
aee9c7d6 1831
ce1a79b6 1832tar.umask::
687157c7
RS
1833 This variable can be used to restrict the permission bits of
1834 tar archive entries. The default is 0002, which turns off the
1835 world write bit. The special value "user" indicates that the
1836 archiving user's umask will be used instead. See umask(2) and
5162e697 1837 linkgit:git-archive[1].
ce1a79b6 1838
b0f34c3d
MM
1839transfer.unpackLimit::
1840 When `fetch.unpackLimit` or `receive.unpackLimit` are
1841 not set, the value of this variable is used instead.
1842 The default value is 100.
1843
55029ae4
DB
1844url.<base>.insteadOf::
1845 Any URL that starts with this value will be rewritten to
1846 start, instead, with <base>. In cases where some site serves a
1847 large number of repositories, and serves them with multiple
1848 access methods, and some users need to use different access
1849 methods, this feature allows people to specify any of the
1850 equivalent URLs and have git automatically rewrite the URL to
1851 the best alternative for the particular user, even for a
844112ca
JH
1852 never-before-seen repository on the site. When more than one
1853 insteadOf strings match a given URL, the longest match is used.
55029ae4 1854
1c2eafb8
JT
1855url.<base>.pushInsteadOf::
1856 Any URL that starts with this value will not be pushed to;
1857 instead, it will be rewritten to start with <base>, and the
1858 resulting URL will be pushed to. In cases where some site serves
1859 a large number of repositories, and serves them with multiple
1860 access methods, some of which do not allow push, this feature
1861 allows people to specify a pull-only URL and have git
1862 automatically use an appropriate URL to push, even for a
1863 never-before-seen repository on the site. When more than one
1864 pushInsteadOf strings match a given URL, the longest match is
1865 used. If a remote has an explicit pushurl, git will ignore this
1866 setting for that remote.
1867
1ab661dd
PB
1868user.email::
1869 Your email address to be recorded in any newly created commits.
28a94f88 1870 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1871 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1872
1873user.name::
1874 Your full name to be recorded in any newly created commits.
abda1ef5 1875 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1876 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1877
d67778ec 1878user.signingkey::
5162e697 1879 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1880 automatically when creating a signed tag, you can override the
1881 default selection with this variable. This option is passed
1882 unchanged to gpg's --local-user parameter, so you may specify a key
1883 using any method that gpg supports.
1884
983a9eeb
CC
1885web.browser::
1886 Specify a web browser that may be used by some commands.
1887 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1888 may use it.