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