pack-objects: implement bitmap writing
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
2de9b711
TA
4The Git configuration file contains a number of variables that affect
5the Git commands' 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
2de9b711 11The configuration variables are used by both the Git plumbing
b7ee2266
SB
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
1ab661dd 14dot-separated segment and the section name is everything before the last
e0a4aae8
LP
15dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
1ab661dd 18
e136f33b
JN
19Syntax
20~~~~~~
21
1ab661dd 22The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
23ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
dcb11263 29characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
30must belong to some section, which means that there must be a section
31header before the first setting of a variable.
e136f33b
JN
32
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
773002a7 35in the section header, like in the example below:
e136f33b
JN
36
37--------
38 [section "subsection"]
39
40--------
41
b7ee2266
SB
42Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
e136f33b
JN
45lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
f7376329
CMN
49There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
e136f33b 53
2ceb639f
NS
54All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
e136f33b
JN
56'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
e0a4aae8
LP
58The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
e136f33b
JN
62
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
18b19e44 681/0, true/false or on/off. Case is not significant in boolean values, when
e136f33b 69converting value to the canonical form using '--bool' type specifier;
0b444cdb 70'git config' will ensure that the output is "true" or "false".
e136f33b
JN
71
72String values may be entirely or partially enclosed in double quotes.
773002a7
SB
73You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
dcb11263 77be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 78
dcb11263
CJ
79The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
e136f33b
JN
82char sequences are valid.
83
773002a7 84Variable values ending in a `\` are continued on the next line in the
e136f33b
JN
85customary UNIX fashion.
86
773002a7 87Some variables may require a special value format.
1ab661dd 88
9b25a0b5
JK
89Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
9a7b0bca
JK
98found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
4c0a89fc 100user's home directory. See below for examples.
9b25a0b5 101
1ab661dd
PB
102Example
103~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
6bb9e51b 112 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
113 renames = true
114
910c00c8
AK
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
e136f33b
JN
119 # Proxy settings
120 [core]
29093c28 121 gitProxy="ssh" for "kernel.org"
e136f33b 122 gitProxy=default-proxy ; for the rest
910c00c8 123
9b25a0b5
JK
124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
4c0a89fc 127 path = ~/foo ; expand "foo" in your $HOME directory
9b25a0b5 128
1ab661dd
PB
129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
133For command-specific variables, you will find a more detailed description
134in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
135porcelain configuration variables in the respective porcelain documentation.
136
75194438 137advice.*::
26e94af0
JH
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
75194438
JK
141+
142--
1184564e 143 pushUpdateRejected::
f25950f3 144 Set this variable to 'false' if you want to disable
b4505682 145 'pushNonFFCurrent', 'pushNonFFDefault',
75e5c0dc
JH
146 'pushNonFFMatching', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
b4505682 148 simultaneously.
f25950f3
CT
149 pushNonFFCurrent::
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
152 pushNonFFDefault::
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
158 pushNonFFMatching::
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
b4505682
CR
163 pushAlreadyExists::
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
75e5c0dc
JH
166 pushFetchFirst::
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
170 pushNeedsForce::
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
a8a5406a
RH
173 object that is not a commit-ish, or make the remote
174 ref point at an object that is not a commit-ish.
edf563fb 175 statusHints::
83c750ac 176 Show directions on how to proceed from the current
552755a8 177 state in the output of linkgit:git-status[1], in
83c750ac 178 the template shown when writing commit messages in
552755a8
MM
179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
6a38ef2c
NTND
181 statusUoption::
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
184 files.
4c371f91
MM
185 commitBeforeMerge::
186 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 187 merge to avoid overwriting local changes.
d38a30df 188 resolveConflict::
4f021b34 189 Advice shown by various commands when conflicts
d38a30df 190 prevent the operation from being performed.
b706fcfe
JK
191 implicitIdentity::
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
26e94af0 194 domain name.
13be3e31 195 detachedHead::
26e94af0 196 Advice shown when you used linkgit:git-checkout[1] to
13be3e31 197 move to the detach HEAD state, to instruct how to create
26e94af0 198 a local branch after the fact.
14bf2d58
PG
199 amWorkDir::
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
7e309446
MLM
202 rmHints::
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
75194438
JK
205--
206
1ab661dd
PB
207core.fileMode::
208 If false, the executable bit differences between the index and
f7d650c0 209 the working tree are ignored; useful on broken filesystems like FAT.
7b357240
MO
210 See linkgit:git-update-index[1].
211+
212The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213will probe and set core.fileMode false if appropriate when the
214repository is created.
1ab661dd 215
7b357240
MO
216core.ignorecase::
217 If true, this option enables various workarounds to enable
2de9b711 218 Git to work better on filesystems that are not case sensitive,
7b357240 219 like FAT. For example, if a directory listing finds
2de9b711 220 "makefile" when Git expects "Makefile", Git will assume
7b357240
MO
221 it is really the same file, and continue to remember it as
222 "Makefile".
223+
224The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
225will probe and set core.ignorecase true if appropriate when the repository
226is created.
227
76759c7d 228core.precomposeunicode::
2de9b711
TA
229 This option is only used by Mac OS implementation of Git.
230 When core.precomposeunicode=true, Git reverts the unicode decomposition
76759c7d
TB
231 of filenames done by Mac OS. This is useful when sharing a repository
232 between Mac OS and Linux or Windows.
2de9b711
TA
233 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
234 When false, file names are handled fully transparent by Git,
235 which is backward compatible with older versions of Git.
76759c7d 236
1ce4790b
AR
237core.trustctime::
238 If false, the ctime differences between the index and the
f7d650c0 239 working tree are ignored; useful when the inode change time
1ce4790b
AR
240 is regularly modified by something outside Git (file system
241 crawlers and some backup systems).
242 See linkgit:git-update-index[1]. True by default.
243
c08e4d5b
RR
244core.checkstat::
245 Determines which stat fields to match between the index
246 and work tree. The user can set this to 'default' or
247 'minimal'. Default (or explicitly 'default'), is to check
248 all fields, including the sub-second part of mtime and ctime.
249
9378c161 250core.quotepath::
5833d730
JN
251 The commands that output paths (e.g. 'ls-files',
252 'diff'), when not given the `-z` option, will quote
9378c161
JH
253 "unusual" characters in the pathname by enclosing the
254 pathname in a double-quote pair and with backslashes the
255 same way strings in C source code are quoted. If this
256 variable is set to false, the bytes higher than 0x80 are
257 not quoted but output as verbatim. Note that double
258 quote, backslash and control characters are always
259 quoted without `-z` regardless of the setting of this
260 variable.
261
942e7747
EB
262core.eol::
263 Sets the line ending type to use in the working directory for
264 files that have the `text` property set. Alternatives are
265 'lf', 'crlf' and 'native', which uses the platform's native
266 line ending. The default value is `native`. See
267 linkgit:gitattributes[5] for more information on end-of-line
268 conversion.
5cb71f82 269
21e5ad50 270core.safecrlf::
2de9b711 271 If true, makes Git check if converting `CRLF` is reversible when
fd6cce9e 272 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
273 modifies a file in the work tree either directly or indirectly.
274 For example, committing a file followed by checking out the
275 same file should yield the original file in the work tree. If
276 this is not the case for the current setting of
2de9b711
TA
277 `core.autocrlf`, Git will reject the file. The variable can
278 be set to "warn", in which case Git will only warn about an
21e5ad50
SP
279 irreversible conversion but continue the operation.
280+
281CRLF conversion bears a slight chance of corrupting data.
2de9b711 282When it is enabled, Git will convert CRLF to LF during commit and LF to
21e5ad50 283CRLF during checkout. A file that contains a mixture of LF and
2de9b711 284CRLF before the commit cannot be recreated by Git. For text
21e5ad50
SP
285files this is the right thing to do: it corrects line endings
286such that we have only LF line endings in the repository.
287But for binary files that are accidentally classified as text the
288conversion can corrupt data.
289+
290If you recognize such corruption early you can easily fix it by
291setting the conversion type explicitly in .gitattributes. Right
292after committing you still have the original file in your work
293tree and this file is not yet corrupted. You can explicitly tell
2de9b711 294Git that this file is binary and Git will handle the file
21e5ad50
SP
295appropriately.
296+
297Unfortunately, the desired effect of cleaning up text files with
298mixed line endings and the undesired effect of corrupting binary
299files cannot be distinguished. In both cases CRLFs are removed
300in an irreversible way. For text files this is the right thing
301to do because CRLFs are line endings, while for binary files
302converting CRLFs corrupts data.
303+
304Note, this safety check does not mean that a checkout will generate a
305file identical to the original file for a different setting of
942e7747
EB
306`core.eol` and `core.autocrlf`, but only for the current one. For
307example, a text file with `LF` would be accepted with `core.eol=lf`
308and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
309resulting file would contain `CRLF`, although the original file
310contained `LF`. However, in both work trees the line endings would be
311consistent, that is either all `LF` or all `CRLF`, but never mixed. A
312file with mixed line endings would be reported by the `core.safecrlf`
313mechanism.
314
942e7747
EB
315core.autocrlf::
316 Setting this variable to "true" is almost the same as setting
317 the `text` attribute to "auto" on all files except that text
318 files are not guaranteed to be normalized: files that contain
319 `CRLF` in the repository will not be touched. Use this
320 setting if you want to have `CRLF` line endings in your
321 working directory even though the repository does not have
322 normalized line endings. This variable can be set to 'input',
323 in which case no output conversion is performed.
324
78a8d641
JS
325core.symlinks::
326 If false, symbolic links are checked out as small plain files that
5162e697
DM
327 contain the link text. linkgit:git-update-index[1] and
328 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 329 file. Useful on filesystems like FAT that do not support
7b357240
MO
330 symbolic links.
331+
332The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
333will probe and set core.symlinks false if appropriate when the repository
334is created.
78a8d641 335
1ab661dd
PB
336core.gitProxy::
337 A "proxy command" to execute (as 'command host port') instead
338 of establishing direct connection to the remote server when
2de9b711 339 using the Git protocol for fetching. If the variable value is
1ab661dd
PB
340 in the "COMMAND for DOMAIN" format, the command is applied only
341 on hostnames ending with the specified domain string. This variable
342 may be set multiple times and is matched in the given order;
343 the first match wins.
b8936cf0
FD
344+
345Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
346(which always applies universally, without the special "for"
347handling).
642d0844
ES
348+
349The special string `none` can be used as the proxy command to
350specify that no proxy be used for a given domain pattern.
351This is useful for excluding servers inside a firewall from
352proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
353
354core.ignoreStat::
b7f685a7
MSO
355 If true, commands which modify both the working tree and the index
356 will mark the updated paths with the "assume unchanged" bit in the
357 index. These marked files are then assumed to stay unchanged in the
f7d650c0 358 working tree, until you mark them otherwise manually - Git will not
b7f685a7
MSO
359 detect the file changes by lstat() calls. This is useful on systems
360 where those are very slow, such as Microsoft Windows.
361 See linkgit:git-update-index[1].
1ab661dd
PB
362 False by default.
363
9f0bb90d
JH
364core.preferSymlinkRefs::
365 Instead of the default "symref" format for HEAD
366 and other symbolic reference files, use symbolic links.
367 This is sometimes needed to work with old scripts that
368 expect HEAD to be a symbolic link.
1ab661dd 369
e4a15f40
SP
370core.bare::
371 If true this repository is assumed to be 'bare' and has no
372 working directory associated with it. If this is the case a
373 number of commands that require a working directory will be
5162e697 374 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 375+
5162e697
DM
376This setting is automatically guessed by linkgit:git-clone[1] or
377linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
378repository that ends in "/.git" is assumed to be not bare (bare =
379false), while all other repositories are assumed to be bare (bare
380= true).
381
892c41b9 382core.worktree::
ea472c1e 383 Set the path to the root of the working tree.
06ada152 384 This can be overridden by the GIT_WORK_TREE environment
ea472c1e 385 variable and the '--work-tree' command line option.
d424a47e 386 The value can be an absolute path or relative to the path to
ea472c1e
JH
387 the .git directory, which is either specified by --git-dir
388 or GIT_DIR, or automatically discovered.
389 If --git-dir or GIT_DIR is specified but none of
302cc11a 390 --work-tree, GIT_WORK_TREE and core.worktree is specified,
ea472c1e 391 the current working directory is regarded as the top level
98acf759 392 of your working tree.
ea472c1e
JH
393+
394Note that this variable is honored even when set in a configuration
395file in a ".git" subdirectory of a directory and its value differs
396from the latter directory (e.g. "/path/to/.git/config" has
397core.worktree set to "/different/path"), which is most likely a
2de9b711 398misconfiguration. Running Git commands in the "/path/to" directory will
ea472c1e
JH
399still use "/different/path" as the root of the work tree and can cause
400confusion unless you know what you are doing (e.g. you are creating a
401read-only snapshot of the same index to a location different from the
402repository's usual working tree).
892c41b9 403
6de08ae6 404core.logAllRefUpdates::
14cd5607 405 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5 406 "$GIT_DIR/logs/<ref>", by appending the new and old
d5fa1f1a 407 SHA-1, the date/time and the reason of the update, but
4057deb5
JH
408 only when the file exists. If this configuration
409 variable is set to true, missing "$GIT_DIR/logs/<ref>"
cd8e3711
BW
410 file is automatically created for branch heads (i.e. under
411 refs/heads/), remote refs (i.e. under refs/remotes/),
412 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
a862f97e
JH
413+
414This information can be used to determine what commit
415was the tip of a branch "2 days ago".
416+
417This value is true by default in a repository that has
418a working directory associated with it, and false by
419default in a bare repository.
6de08ae6 420
1ab661dd
PB
421core.repositoryFormatVersion::
422 Internal variable identifying the repository format and layout
423 version.
424
425core.sharedRepository::
d5dc6a76
JF
426 When 'group' (or 'true'), the repository is made shareable between
427 several users in a group (making sure all the files and objects are
428 group-writable). When 'all' (or 'world' or 'everybody'), the
429 repository will be readable by all users, additionally to being
2de9b711 430 group-shareable. When 'umask' (or 'false'), Git will use permissions
06cbe855
HO
431 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
432 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
433 user's umask value (whereas the other options will only override
434 requested parts of the user's umask value). Examples: '0660' will make
435 the repo read/write-able for the owner and group, but inaccessible to
436 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
437 repository that is group-readable but not group-writable.
438 See linkgit:git-init[1]. False by default.
1ab661dd
PB
439
440core.warnAmbiguousRefs::
2de9b711 441 If true, Git will warn you if the ref name you passed it is ambiguous
48dfe969 442 and might match multiple refs in the repository. True by default.
1ab661dd 443
3d3e95af 444core.compression::
960ccca6
DH
445 An integer -1..9, indicating a default compression level.
446 -1 is the zlib default. 0 means no compression,
447 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
448 If set, this provides a default to other compression variables,
449 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
450
451core.loosecompression::
12f6c308 452 An integer -1..9, indicating the compression level for objects that
960ccca6 453 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 454 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 455 slowest. If not set, defaults to core.compression. If that is
de1b2460 456 not set, defaults to 1 (best speed).
12f6c308 457
60bb8b14
SP
458core.packedGitWindowSize::
459 Number of bytes of a pack file to map into memory in a
460 single mapping operation. Larger window sizes may allow
461 your system to process a smaller number of large pack files
462 more quickly. Smaller window sizes will negatively affect
eb92242f 463 performance due to increased calls to the operating system's
60bb8b14 464 memory manager, but may improve performance when accessing
22bac0ea
SP
465 a large number of large pack files.
466+
467Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
468MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
469be reasonable for all users/operating systems. You probably do
470not need to adjust this value.
eb92242f
SP
471+
472Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 473
77ccc5bb
SP
474core.packedGitLimit::
475 Maximum number of bytes to map simultaneously into memory
476 from pack files. If Git needs to access more than this many
477 bytes at once to complete an operation it will unmap existing
478 regions to reclaim virtual address space within the process.
22bac0ea
SP
479+
480Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
481This should be reasonable for all users/operating systems, except on
482the largest projects. You probably do not need to adjust this value.
eb92242f
SP
483+
484Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 485
18bdec11
SP
486core.deltaBaseCacheLimit::
487 Maximum number of bytes to reserve for caching base objects
6b677a28 488 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
489 entire decompressed base objects in a cache Git is able
490 to avoid unpacking and decompressing frequently used base
491 objects multiple times.
492+
493Default is 16 MiB on all platforms. This should be reasonable
494for all users/operating systems, except on the largest projects.
495You probably do not need to adjust this value.
496+
497Common unit suffixes of 'k', 'm', or 'g' are supported.
498
5eef828b
SP
499core.bigFileThreshold::
500 Files larger than this size are stored deflated, without
501 attempting delta compression. Storing large files without
502 delta compression avoids excessive memory usage, at the
503 slight expense of increased disk usage.
504+
505Default is 512 MiB on all platforms. This should be reasonable
506for most projects as source code and other text files can still
507be delta compressed, but larger binary media files won't be.
508+
509Common unit suffixes of 'k', 'm', or 'g' are supported.
5eef828b 510
e8964a5b 511core.excludesfile::
0ba956d3 512 In addition to '.gitignore' (per-directory) and
2de9b711 513 '.git/info/exclude', Git looks into this file for patterns
6cf378f0
JK
514 of files which are not meant to be tracked. "`~/`" is expanded
515 to the value of `$HOME` and "`~user/`" to the specified user's
dc79687e
HKNN
516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518 is used instead. See linkgit:gitignore[5].
0ba956d3 519
d3e7da89
AK
520core.askpass::
521 Some commands (e.g. svn and http interfaces) that interactively
522 ask for a password can be told to use an external program given
453842c9
KF
523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524 environment variable. If not set, fall back to the value of the
525 'SSH_ASKPASS' environment variable or, failing that, a simple password
526 prompt. The external program shall be given a suitable prompt as
527 command line argument and write the password on its STDOUT.
d3e7da89 528
6df42ab9
PO
529core.attributesfile::
530 In addition to '.gitattributes' (per-directory) and
2de9b711 531 '.git/info/attributes', Git looks into this file for attributes
6df42ab9 532 (see linkgit:gitattributes[5]). Path expansions are made the same
684e40f6
HKNN
533 way as for `core.excludesfile`. Its default value is
534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535 set or empty, $HOME/.config/git/attributes is used instead.
6df42ab9 536
ef0c2abf
AR
537core.editor::
538 Commands such as `commit` and `tag` that lets you edit
02783075 539 messages by launching an editor uses the value of this
ef0c2abf 540 variable when it is set, and the environment variable
b4479f07 541 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 542
eff80a9f
JH
543core.commentchar::
544 Commands such as `commit` and `tag` that lets you edit
545 messages consider a line that begins with this character
546 commented, and removes them after the editor returns
547 (default '#').
548
821881d8 549sequence.editor::
3322ad42 550 Text editor used by `git rebase -i` for editing the rebase instruction file.
821881d8
PO
551 The value is meant to be interpreted by the shell when it is used.
552 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
553 When not configured the default commit message editor is used instead.
554
54adf370 555core.pager::
97d01f2a
JH
556 Text viewer for use by Git commands (e.g., 'less'). The value
557 is meant to be interpreted by the shell. The order of preference
558 is the `$GIT_PAGER` environment variable, then `core.pager`
559 configuration, then `$PAGER`, and then the default chosen at
560 compile time (usually 'less').
561+
562When the `LESS` environment variable is unset, Git sets it to `FRSX`
563(if `LESS` environment variable is set, Git does not change it at
564all). If you want to selectively override Git's default setting
565for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
566be passed to the shell by Git, which will translate the final
567command to `LESS=FRSX less -+S`. The environment tells the command
568to set the `S` option to chop long lines but the command line
569resets it to the default to fold long lines.
54adf370 570
91af7ae5
JH
571core.whitespace::
572 A comma separated list of common whitespace problems to
0b444cdb
TR
573 notice. 'git diff' will use `color.diff.whitespace` to
574 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
575 consider them as errors. You can prefix `-` to disable
576 any of them (e.g. `-trailing-space`):
91af7ae5 577+
aeb84b05 578* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
579 as an error (enabled by default).
580* `space-before-tab` treats a space character that appears immediately
581 before a tab character in the initial indent part of the line as an
582 error (enabled by default).
2ce4fee8
WL
583* `indent-with-non-tab` treats a line that is indented with space
584 characters instead of the equivalent tabs as an error (not enabled by
585 default).
3e3ec2ab
CW
586* `tab-in-indent` treats a tab character in the initial indent part of
587 the line as an error (not enabled by default).
77b15bbd
JH
588* `blank-at-eof` treats blank lines added at the end of file as an error
589 (enabled by default).
aeb84b05
JH
590* `trailing-space` is a short-hand to cover both `blank-at-eol` and
591 `blank-at-eof`.
b2979ff5
JH
592* `cr-at-eol` treats a carriage-return at the end of line as
593 part of the line terminator, i.e. with it, `trailing-space`
594 does not trigger if the character before such a carriage-return
595 is not a whitespace (not enabled by default).
f4b05a49 596* `tabwidth=<n>` tells how many character positions a tab occupies; this
2de9b711 597 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
f4b05a49 598 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 599
aafe9fba
LT
600core.fsyncobjectfiles::
601 This boolean will enable 'fsync()' when writing object files.
602+
603This is a total waste of time and effort on a filesystem that orders
604data writes properly, but can be useful for filesystems that do not use
605journalling (traditional UNIX filesystems) or that only journal metadata
606and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
607
671c9b7e
LT
608core.preloadindex::
609 Enable parallel index preload for operations like 'git diff'
610+
611This can speed up operations like 'git diff' and 'git status' especially
612on filesystems like NFS that have weak caching semantics and thus
2de9b711 613relatively high IO latencies. With this set to 'true', Git will do the
671c9b7e
LT
614index comparison to the filesystem data in parallel, allowing
615overlapping IO's.
616
348df166
JS
617core.createObject::
618 You can set this to 'link', in which case a hardlink followed by
619 a delete of the source are used to make sure that object creation
620 will not overwrite existing objects.
621+
622On some file system/operating system combinations, this is unreliable.
623Set this config setting to 'rename' there; However, This will remove the
624check that makes sure that existing object files will not get overwritten.
be66a6c4 625
a97a7468
JS
626core.notesRef::
627 When showing commit messages, also show notes which are stored in
9eb3f816
JN
628 the given ref. The ref must be fully qualified. If the given
629 ref does not exist, it is not an error but means that no
630 notes should be printed.
a97a7468 631+
9eb3f816
JN
632This setting defaults to "refs/notes/commits", and it can be overridden by
633the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
a97a7468 634
08aefc9e
NTND
635core.sparseCheckout::
636 Enable "sparse checkout" feature. See section "Sparse checkout" in
637 linkgit:git-read-tree[1] for more information.
638
a71f09fe 639core.abbrev::
dce96489
LT
640 Set the length object names are abbreviated to. If unspecified,
641 many commands abbreviate to 7 hexdigits, which may not be enough
642 for abbreviated object names to stay unique for sufficiently long
643 time.
644
13bd2134 645add.ignore-errors::
6b3020a2 646add.ignoreErrors::
0b444cdb 647 Tells 'git add' to continue adding files when some files cannot be
13bd2134 648 added due to indexing errors. Equivalent to the '--ignore-errors'
2de9b711 649 option of linkgit:git-add[1]. Older versions of Git accept only
6b3020a2 650 `add.ignore-errors`, which does not follow the usual naming
2de9b711 651 convention for configuration variables. Newer versions of Git
6b3020a2 652 honor `add.ignoreErrors` as well.
13bd2134 653
4514ad4f 654alias.*::
5162e697 655 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
656 after defining "alias.last = cat-file commit HEAD", the invocation
657 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84 658 confusion and troubles with script usage, aliases that
2de9b711 659 hide existing Git commands are ignored. Arguments are split by
99b41c84
PB
660 spaces, the usual shell quoting and escaping is supported.
661 quote pair and a backslash can be used to quote them.
f368f5a6
JH
662+
663If the alias expansion is prefixed with an exclamation point,
664it will be treated as a shell command. For example, defining
665"alias.new = !gitk --all --not ORIG_HEAD", the invocation
666"git new" is equivalent to running the shell command
595b8dbf
SC
667"gitk --all --not ORIG_HEAD". Note that shell commands will be
668executed from the top-level directory of a repository, which may
669not necessarily be the current directory.
7cf16a14
MG
670'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
671from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 672
e80d4cbe
SH
673am.keepcr::
674 If true, git-am will call git-mailsplit for patches in mbox format
675 with parameter '--keep-cr'. In this case git-mailsplit will
6b677a28 676 not remove `\r` from lines ending with `\r\n`. Can be overridden
e80d4cbe
SH
677 by giving '--no-keep-cr' from the command line.
678 See linkgit:git-am[1], linkgit:git-mailsplit[1].
679
86c91f91 680apply.ignorewhitespace::
0b444cdb 681 When set to 'change', tells 'git apply' to ignore changes in
86c91f91
GB
682 whitespace, in the same way as the '--ignore-space-change'
683 option.
0b444cdb 684 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
685 respect all whitespace differences.
686 See linkgit:git-apply[1].
687
1ab661dd 688apply.whitespace::
0b444cdb 689 Tells 'git apply' how to handle whitespaces, in the same way
5162e697 690 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 691
9902387d 692branch.autosetupmerge::
add0951a 693 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
694 so that linkgit:git-pull[1] will appropriately merge from the
695 starting point branch. Note that even if this option is not set,
9902387d 696 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
697 and `--no-track` options. The valid settings are: `false` -- no
698 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
699 starting point is a remote-tracking branch; `always` --
700 automatic setup is done when the starting point is either a
701 local branch or remote-tracking
572fc81d 702 branch. This option defaults to true.
9902387d 703
c998ae9b 704branch.autosetuprebase::
0b444cdb 705 When a new branch is created with 'git branch' or 'git checkout'
2de9b711 706 that tracks another branch, this variable tells Git to set
c998ae9b
DS
707 up pull to rebase instead of merge (see "branch.<name>.rebase").
708 When `never`, rebase is never automatically set to true.
709 When `local`, rebase is set to true for tracked branches of
710 other local branches.
711 When `remote`, rebase is set to true for tracked branches of
29b9a66f 712 remote-tracking branches.
c998ae9b
DS
713 When `always`, rebase will be set to true for all tracking
714 branches.
715 See "branch.autosetupmerge" for details on how to set up a
716 branch to track another branch.
717 This option defaults to never.
718
648ad18f 719branch.<name>.remote::
224c2171
RR
720 When on branch <name>, it tells 'git fetch' and 'git push'
721 which remote to fetch from/push to. The remote to push to
722 may be overridden with `remote.pushdefault` (for all branches).
9f765ce6
RR
723 The remote to push to, for the current branch, may be further
724 overridden by `branch.<name>.pushremote`. If no remote is
725 configured, or if you are not on any branch, it defaults to
726 `origin` for fetching and `remote.pushdefault` for pushing.
b85ecea6
PO
727 Additionally, `.` (a period) is the current local repository
728 (a dot-repository), see `branch.<name>.merge`'s final note below.
9f765ce6
RR
729
730branch.<name>.pushremote::
731 When on branch <name>, it overrides `branch.<name>.remote` for
732 pushing. It also overrides `remote.pushdefault` for pushing
733 from branch <name>. When you pull from one place (e.g. your
734 upstream) and push to another place (e.g. your own publishing
735 repository), you would want to set `remote.pushdefault` to
736 specify the remote to push to for all branches, and use this
737 option to override it for a specific branch.
648ad18f 738
5372806a 739branch.<name>.merge::
76d3cc50 740 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 741 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
742 branch to merge and can also affect 'git push' (see push.default).
743 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
744 refspec to be marked for merging in FETCH_HEAD. The value is
745 handled like the remote part of a refspec, and must match a
746 ref which is fetched from the remote given by
747 "branch.<name>.remote".
0b444cdb
TR
748 The merge information is used by 'git pull' (which at first calls
749 'git fetch') to lookup the default branch for merging. Without
750 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 751 Specify multiple values to get an octopus merge.
0b444cdb 752 If you wish to setup 'git pull' so that it merges into <name> from
9debc324 753 another branch in the local repository, you can point
b85ecea6
PO
754 branch.<name>.merge to the desired branch, and use the relative path
755 setting `.` (a period) for branch.<name>.remote.
5372806a 756
aec7b362
LH
757branch.<name>.mergeoptions::
758 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 759 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
760 option values containing whitespace characters are currently not
761 supported.
762
cd67e4d4
JS
763branch.<name>.rebase::
764 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 765 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
766 "git pull" is run. See "pull.rebase" for doing this in a non
767 branch-specific manner.
66713ef3
SH
768+
769 When preserve, also pass `--preserve-merges` along to 'git rebase'
770 so that locally committed merge commits will not be flattened
771 by running 'git pull'.
6b37dff1
ÆAB
772+
773*NOTE*: this is a possibly dangerous operation; do *not* use
774it unless you understand the implications (see linkgit:git-rebase[1]
775for details).
cd67e4d4 776
a5ba2cbe
NTND
777branch.<name>.description::
778 Branch description, can be edited with
779 `git branch --edit-description`. Branch description is
780 automatically added in the format-patch cover letter or
781 request-pull summary.
782
1658c614
CC
783browser.<tool>.cmd::
784 Specify the command to invoke the specified browser. The
785 specified command is evaluated in shell with the URLs passed
565e135a 786 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 787
584627b4
CC
788browser.<tool>.path::
789 Override the path for the given tool that may be used to
ab989adf
CC
790 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
791 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 792
2122591b 793clean.requireForce::
f85f7947
JX
794 A boolean to make git-clean do nothing unless given -f,
795 -i or -n. Defaults to true.
2122591b 796
f3673988
BG
797color.branch::
798 A boolean to enable/disable color in the output of
5162e697 799 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 800 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
801 only when the output is to a terminal. Defaults to false.
802
803color.branch.<slot>::
804 Use customized color for branch coloration. `<slot>` is one of
805 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
806 `remote` (a remote-tracking branch in refs/remotes/),
807 `upstream` (upstream tracking branch), `plain` (other
4f193f20
MW
808 refs).
809+
810The value for these configuration variables is a list of colors (at most
811two) and attributes (at most one), separated by spaces. The colors
812accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
813`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
814`blink` and `reverse`. The first color given is the foreground; the
815second is the background. The position of the attribute, if any,
816doesn't matter.
f3673988 817
a159ca0c 818color.diff::
6999c540
MG
819 Whether to use ANSI escape sequences to add color to patches.
820 If this is set to `always`, linkgit:git-diff[1],
821 linkgit:git-log[1], and linkgit:git-show[1] will use color
822 for all patches. If it is set to `true` or `auto`, those
823 commands will only use color when output is to the terminal.
824 Defaults to false.
825+
826This does not affect linkgit:git-format-patch[1] nor the
827'git-diff-{asterisk}' plumbing commands. Can be overridden on the
828command line with the `--color[=<when>]` option.
b5376648 829
a159ca0c 830color.diff.<slot>::
4f193f20
MW
831 Use customized color for diff colorization. `<slot>` specifies
832 which part of the patch to use the specified color, and is one
833 of `plain` (context text), `meta` (metainformation), `frag`
89cb73a1
BW
834 (hunk header), 'func' (function in hunk header), `old` (removed lines),
835 `new` (added lines), `commit` (commit headers), or `whitespace`
836 (highlighting whitespace errors). The values of these variables may be
837 specified as in color.branch.<slot>.
b5376648 838
5e11bee6
NR
839color.decorate.<slot>::
840 Use customized color for 'git log --decorate' output. `<slot>` is one
841 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 842 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 843
7e8f59d5
RS
844color.grep::
845 When set to `always`, always highlight matches. When `false` (or
846 `never`), never. When set to `true` or `auto`, use color only
847 when the output is written to the terminal. Defaults to `false`.
848
55f638bd
ML
849color.grep.<slot>::
850 Use customized color for grep colorization. `<slot>` specifies which
851 part of the line to use the specified color, and is one of
852+
853--
00588bb5
ML
854`context`;;
855 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
856`filename`;;
857 filename prefix (when not using `-h`)
00588bb5
ML
858`function`;;
859 function name lines (when using `-p`)
55f638bd
ML
860`linenumber`;;
861 line number prefix (when using `-n`)
862`match`;;
863 matching text
00588bb5
ML
864`selected`;;
865 non-matching text in selected lines
55f638bd
ML
866`separator`;;
867 separators between fields on a line (`:`, `-`, and `=`)
868 and between hunks (`--`)
869--
870+
871The values of these variables may be specified as in color.branch.<slot>.
7e8f59d5 872
b4c61ed6 873color.interactive::
47ee06f1 874 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
875 and displays (such as those used by "git-add --interactive" and
876 "git-clean --interactive"). When false (or `never`), never.
877 When set to `true` or `auto`, use colors only when the output is
878 to the terminal. Defaults to false.
b4c61ed6
JH
879
880color.interactive.<slot>::
7a9b0b80
JX
881 Use customized color for 'git add --interactive' and 'git clean
882 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
883 or `error`, for four distinct types of normal output from
884 interactive commands. The values of these variables may be
885 specified as in color.branch.<slot>.
b4c61ed6 886
1d77043b
JH
887color.pager::
888 A boolean to enable/disable colored output when the pager is in
889 use (default is true).
890
ab07ba2a
MH
891color.showbranch::
892 A boolean to enable/disable color in the output of
893 linkgit:git-show-branch[1]. May be set to `always`,
894 `false` (or `never`) or `auto` (or `true`), in which case colors are used
895 only when the output is to a terminal. Defaults to false.
896
1d77043b
JH
897color.status::
898 A boolean to enable/disable color in the output of
5162e697 899 linkgit:git-status[1]. May be set to `always`,
cec99d8c 900 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
901 only when the output is to a terminal. Defaults to false.
902
903color.status.<slot>::
904 Use customized color for status colorization. `<slot>` is
905 one of `header` (the header text of the status message),
82dca848
SP
906 `added` or `updated` (files which are added but not committed),
907 `changed` (files which are changed but not added in the index),
2de9b711 908 `untracked` (files which are not tracked by Git),
1d282327 909 `branch` (the current branch), or
950ce2e2
CP
910 `nobranch` (the color the 'no branch' warning is shown in, defaulting
911 to red). The values of these variables may be specified as in
912 color.branch.<slot>.
1d77043b 913
6b2f2d98 914color.ui::
6999c540
MG
915 This variable determines the default value for variables such
916 as `color.diff` and `color.grep` that control the use of color
917 per command family. Its scope will expand as more commands learn
918 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
919 to `false` or `never` if you prefer Git commands not to use
920 color unless enabled explicitly with some other configuration
921 or the `--color` option. Set it to `always` if you want all
922 output not intended for machine consumption to use color, to
923 `true` or `auto` (this is the default since Git 1.8.4) if you
924 want such output to use color when written to the terminal.
6b2f2d98 925
7e29b825
NTND
926column.ui::
927 Specify whether supported commands should output in columns.
928 This variable consists of a list of tokens separated by spaces
929 or commas:
930+
5e62cc14
RR
931These options control when the feature should be enabled
932(defaults to 'never'):
933+
7e29b825
NTND
934--
935`always`;;
936 always show in columns
937`never`;;
938 never show in columns
939`auto`;;
940 show in columns if the output is to the terminal
5e62cc14
RR
941--
942+
943These options control layout (defaults to 'column'). Setting any
944of these implies 'always' if none of 'always', 'never', or 'auto' are
945specified.
946+
947--
077539d7 948`column`;;
5e62cc14 949 fill columns before rows
077539d7
NTND
950`row`;;
951 fill rows before columns
7e29b825
NTND
952`plain`;;
953 show in one column
5e62cc14
RR
954--
955+
956Finally, these options can be combined with a layout option (defaults
957to 'nodense'):
958+
959--
3f8eccbe
NTND
960`dense`;;
961 make unequal size columns to utilize more space
962`nodense`;;
963 make equal size columns
7e29b825 964--
7e29b825 965
ebe31ef2
NTND
966column.branch::
967 Specify whether to output branch listing in `git branch` in columns.
968 See `column.ui` for details.
969
1b8fd467
JX
970column.clean::
971 Specify the layout when list items in `git clean -i`, which always
972 shows files and directories in columns. See `column.ui` for details.
973
323d0530
NTND
974column.status::
975 Specify whether to output untracked files in `git status` in columns.
976 See `column.ui` for details.
977
d96e3c15
NTND
978column.tag::
979 Specify whether to output tag listing in `git tag` in columns.
980 See `column.ui` for details.
981
51fb3a3d
RT
982commit.cleanup::
983 This setting overrides the default of the `--cleanup` option in
984 `git commit`. See linkgit:git-commit[1] for details. Changing the
985 default can be useful when you always want to keep lines that begin
986 with comment character `#` in your log message, in which case you
987 would do `git config commit.cleanup whitespace` (note that you will
988 have to remove the help lines that begin with `#` in the commit log
989 template yourself, if you do this).
990
88955ed2 991commit.status::
bed575e4
JHI
992 A boolean to enable/disable inclusion of status information in the
993 commit message template when using an editor to prepare the commit
994 message. Defaults to true.
995
b0f34c3d
MM
996commit.template::
997 Specify a file to use as the template for new commit messages.
6cf378f0 998 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
df2a79f4 999 specified user's home directory.
b0f34c3d 1000
a6fc9fd3
JK
1001credential.helper::
1002 Specify an external helper to be called when a username or
1003 password credential is needed; the helper may consult external
1004 storage to avoid prompting the user for the credentials. See
1005 linkgit:gitcredentials[7] for details.
1006
1007credential.useHttpPath::
1008 When acquiring credentials, consider the "path" component of an http
1009 or https URL to be important. Defaults to false. See
1010 linkgit:gitcredentials[7] for more information.
1011
1012credential.username::
1013 If no username is set for a network authentication, use this username
1014 by default. See credential.<context>.* below, and
1015 linkgit:gitcredentials[7].
1016
1017credential.<url>.*::
1018 Any of the credential.* options above can be applied selectively to
1019 some credentials. For example "credential.https://example.com.username"
1020 would set the default username only for https connections to
1021 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1022 matched.
1023
19299a84 1024include::diff-config.txt[]
afcbc8e7
DA
1025
1026difftool.<tool>.path::
1027 Override the path for the given tool. This is useful in case
1028 your tool is not in the PATH.
1029
1030difftool.<tool>.cmd::
1031 Specify the command to invoke the specified diff tool.
1032 The specified command is evaluated in shell with the following
1033 variables available: 'LOCAL' is set to the name of the temporary
1034 file containing the contents of the diff pre-image and 'REMOTE'
1035 is set to the name of the temporary file containing the contents
1036 of the diff post-image.
1037
a904392e
DA
1038difftool.prompt::
1039 Prompt before each invocation of the diff tool.
1040
be254a0e 1041fetch.recurseSubmodules::
1fb25502
JL
1042 This option can be either set to a boolean value or to 'on-demand'.
1043 Setting it to a boolean changes the behavior of fetch and pull to
1044 unconditionally recurse into submodules when set to true or to not
1045 recurse at all when set to false. When set to 'on-demand' (the default
1046 value), fetch and pull will only recurse into a populated submodule
1047 when its superproject retrieves a commit that updates the submodule's
1048 reference.
be254a0e 1049
5e838ea7
JH
1050fetch.fsckObjects::
1051 If it is set to true, git-fetch-pack will check all fetched
1052 objects. It will abort in the case of a malformed object or a
1053 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1054 Defaults to false. If not set, the value of `transfer.fsckObjects`
1055 is used instead.
5e838ea7 1056
af7cf268 1057fetch.unpackLimit::
2de9b711 1058 If the number of objects fetched over the Git native
af7cf268
JH
1059 transfer is below this
1060 limit, then the objects will be unpacked into loose object
1061 files. However if the number of received objects equals or
1062 exceeds this limit then the received pack will be stored as
1063 a pack, after adding any missing delta bases. Storing the
1064 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1065 especially on slow filesystems. If not set, the value of
1066 `transfer.unpackLimit` is used instead.
af7cf268 1067
737c5a9c
MS
1068fetch.prune::
1069 If true, fetch will automatically behave as if the `--prune`
1070 option was given on the command line. See also `remote.<name>.prune`.
1071
48d3448d
SB
1072format.attach::
1073 Enable multipart/mixed attachments as the default for
1074 'format-patch'. The value can also be a double quoted string
1075 which will enable attachments as the default and set the
1076 value as the boundary. See the --attach option in
1077 linkgit:git-format-patch[1].
1078
49604a4d 1079format.numbered::
a567fdcb
BG
1080 A boolean which can enable or disable sequence numbers in patch
1081 subjects. It defaults to "auto" which enables it only if there
1082 is more than one patch. It can be enabled or disabled for all
1083 messages by setting it to "true" or "false". See --numbered
1084 option in linkgit:git-format-patch[1].
49604a4d 1085
1ab661dd
PB
1086format.headers::
1087 Additional email headers to include in a patch to be submitted
5162e697 1088 by mail. See linkgit:git-format-patch[1].
1ab661dd 1089
312a30eb 1090format.to::
48d3448d 1091format.cc::
312a30eb
MV
1092 Additional recipients to include in a patch to be submitted
1093 by mail. See the --to and --cc options in
1094 linkgit:git-format-patch[1].
48d3448d
SB
1095
1096format.subjectprefix::
1097 The default for format-patch is to output files with the '[PATCH]'
1098 subject prefix. Use this variable to change that prefix.
1099
6622d9c7
SB
1100format.signature::
1101 The default for format-patch is to output a signature containing
2de9b711 1102 the Git version number. Use this variable to change that default.
6622d9c7
SB
1103 Set this variable to the empty string ("") to suppress
1104 signature generation.
1105
78cb59c8
JS
1106format.suffix::
1107 The default for format-patch is to output files with the suffix
1108 `.patch`. Use this variable to change that suffix (make sure to
1109 include the dot if you want it).
1ab661dd 1110
94c22a5e
CR
1111format.pretty::
1112 The default pretty format for log/show/whatchanged command,
1113 See linkgit:git-log[1], linkgit:git-show[1],
1114 linkgit:git-whatchanged[1].
1115
30984ed2 1116format.thread::
0b444cdb 1117 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1118 a boolean value, or `shallow` or `deep`. `shallow` threading
1119 makes every mail a reply to the head of the series,
30984ed2 1120 where the head is chosen from the cover letter, the
6cf378f0 1121 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1122 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1123 A true boolean value is the same as `shallow`, and a false
1124 value disables threading.
1125
1d1876e9 1126format.signoff::
240ae2b8
FC
1127 A boolean value which lets you enable the `-s/--signoff` option of
1128 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1129 patch should be a conscious act and means that you certify you have
1130 the rights to submit this work under the same open source license.
1131 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1132
2a4c2607
FC
1133format.coverLetter::
1134 A boolean that controls whether to generate a cover-letter when
1135 format-patch is invoked, but in addition can be set to "auto", to
1136 generate a cover-letter only when there's more than one patch.
1137
26488f59
RR
1138filter.<driver>.clean::
1139 The command which is used to convert the content of a worktree
1140 file to a blob upon checkin. See linkgit:gitattributes[5] for
1141 details.
1142
1143filter.<driver>.smudge::
1144 The command which is used to convert the content of a blob
1145 object to a worktree file upon checkout. See
1146 linkgit:gitattributes[5] for details.
1147
0d7566a5
TT
1148gc.aggressiveWindow::
1149 The window size parameter used in the delta compression
0b444cdb 1150 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1151 to 250.
0d7566a5 1152
e9831e83
JH
1153gc.auto::
1154 When there are approximately more than this many loose
1155 objects in the repository, `git gc --auto` will pack them.
1156 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1157 light-weight garbage collection from time to time. The
1158 default value is 6700. Setting this to 0 disables it.
e9831e83 1159
17815501
JH
1160gc.autopacklimit::
1161 When there are more than this many packs that are not
1162 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1163 --auto` consolidates them into one larger pack. The
97063974 1164 default value is 50. Setting this to 0 disables it.
17815501 1165
c2120e5e 1166gc.packrefs::
efc266e8
JN
1167 Running `git pack-refs` in a repository renders it
1168 unclonable by Git versions prior to 1.5.1.2 over dumb
1169 transports such as HTTP. This variable determines whether
4be0c352 1170 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1171 to enable it within all non-bare repos or it can be set to a
1172 boolean value. The default is `true`.
c2120e5e 1173
25ee9731 1174gc.pruneexpire::
0b444cdb 1175 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
1176 Override the grace period with this config variable. The value
1177 "now" may be used to disable this grace period and always prune
1178 unreachable objects immediately.
25ee9731 1179
4aec56d1 1180gc.reflogexpire::
eb523a8d 1181gc.<pattern>.reflogexpire::
0b444cdb 1182 'git reflog expire' removes reflog entries older than
eb523a8d
JH
1183 this time; defaults to 90 days. With "<pattern>" (e.g.
1184 "refs/stash") in the middle the setting applies only to
1185 the refs that match the <pattern>.
4aec56d1
JH
1186
1187gc.reflogexpireunreachable::
eb523a8d 1188gc.<ref>.reflogexpireunreachable::
0b444cdb 1189 'git reflog expire' removes reflog entries older than
4aec56d1 1190 this time and are not reachable from the current tip;
eb523a8d
JH
1191 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1192 in the middle, the setting applies only to the refs that
1193 match the <pattern>.
4aec56d1 1194
48c32424
JH
1195gc.rerereresolved::
1196 Records of conflicted merge you resolved earlier are
0b444cdb 1197 kept for this many days when 'git rerere gc' is run.
5162e697 1198 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
1199
1200gc.rerereunresolved::
1201 Records of conflicted merge you have not resolved are
0b444cdb 1202 kept for this many days when 'git rerere gc' is run.
5162e697 1203 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1204
280514e1
FE
1205gitcvs.commitmsgannotation::
1206 Append this string to each commit message. Set to empty string
1207 to disable this feature. Defaults to "via git-CVS emulator".
1208
1ab661dd 1209gitcvs.enabled::
db218723 1210 Whether the CVS server interface is enabled for this repository.
5162e697 1211 See linkgit:git-cvsserver[1].
1ab661dd
PB
1212
1213gitcvs.logfile::
db218723 1214 Path to a log file where the CVS server interface well... logs
5162e697 1215 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1216
1707adb7 1217gitcvs.usecrlfattr::
5ec3e670
EB
1218 If true, the server will look up the end-of-line conversion
1219 attributes for files to determine the '-k' modes to use. If
2de9b711 1220 the attributes force Git to treat a file as text,
6b677a28 1221 the '-k' mode will be left blank so CVS clients will
5ec3e670 1222 treat it as text. If they suppress text conversion, the file
1168d402 1223 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670
EB
1224 the client might otherwise do. If the attributes do not allow
1225 the file type to be determined, then 'gitcvs.allbinary' is
1226 used. See linkgit:gitattributes[5].
8a06a632 1227
eabb0bfd 1228gitcvs.allbinary::
90948a42
MO
1229 This is used if 'gitcvs.usecrlfattr' does not resolve
1230 the correct '-kb' mode to use. If true, all
1231 unresolved files are sent to the client in
1232 mode '-kb'. This causes the client to treat them
1233 as binary files, which suppresses any newline munging it
1234 otherwise might do. Alternatively, if it is set to "guess",
1235 then the contents of the file are examined to decide if
1236 it is binary, similar to 'core.autocrlf'.
abbf5947 1237
04752868
FL
1238gitcvs.dbname::
1239 Database used by git-cvsserver to cache revision information
2de9b711 1240 derived from the Git repository. The exact meaning depends on the
04752868
FL
1241 used database driver, for SQLite (which is the default driver) this
1242 is a filename. Supports variable substitution (see
5162e697 1243 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1244 Default: '%Ggitcvs.%m.sqlite'
1245
1246gitcvs.dbdriver::
1247 Used Perl DBI driver. You can specify any available driver
240ae2b8 1248 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1249 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1250 reported *not* to work with 'DBD::mysql'. Experimental feature.
1251 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1252 See linkgit:git-cvsserver[1].
eabb0bfd 1253
04752868
FL
1254gitcvs.dbuser, gitcvs.dbpass::
1255 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1256 since SQLite has no concept of database users and/or passwords.
1257 'gitcvs.dbuser' supports variable substitution (see
5162e697 1258 linkgit:git-cvsserver[1] for details).
04752868 1259
6aeeffd1
JE
1260gitcvs.dbTableNamePrefix::
1261 Database table name prefix. Prepended to the names of any
1262 database tables used, allowing a single database to be used
1263 for several repositories. Supports variable substitution (see
1264 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1265 characters will be replaced with underscores.
1266
8a06a632
MO
1267All gitcvs variables except for 'gitcvs.usecrlfattr' and
1268'gitcvs.allbinary' can also be specified as
1269'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1270is one of "ext" and "pserver") to make them apply only for the given
1271access method.
04752868 1272
cd82323f
JN
1273gitweb.category::
1274gitweb.description::
1275gitweb.owner::
1276gitweb.url::
1277 See linkgit:gitweb[1] for description.
1278
1279gitweb.avatar::
1280gitweb.blame::
1281gitweb.grep::
1282gitweb.highlight::
1283gitweb.patches::
1284gitweb.pickaxe::
1285gitweb.remote_heads::
1286gitweb.showsizes::
1287gitweb.snapshot::
1288 See linkgit:gitweb.conf[5] for description.
1289
b22520a3
JR
1290grep.lineNumber::
1291 If set to true, enable '-n' option by default.
1292
84befcd0
S
1293grep.patternType::
1294 Set the default matching behavior. Using a value of 'basic', 'extended',
1295 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1296 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1297 value 'default' will return to the default matching behavior.
1298
b22520a3 1299grep.extendedRegexp::
84befcd0
S
1300 If set to true, enable '--extended-regexp' option by default. This
1301 option is ignored when the 'grep.patternType' option is set to a value
1302 other than 'default'.
b22520a3 1303
0c5e70f0
JH
1304gpg.program::
1305 Use this custom program instead of "gpg" found on $PATH when
1306 making or verifying a PGP signature. The program must support the
1307 same command line interface as GPG, namely, to verify a detached
1308 signature, "gpg --verify $file - <$signature" is run, and the
1309 program is expected to signal a good signature by exiting with
1310 code 0, and to generate an ascii-armored detached signature, the
1311 standard input of "gpg -bsau $key" is fed with the contents to be
1312 signed, and the program is expected to send the result to its
1313 standard output.
1314
d84ae0db
GH
1315gui.commitmsgwidth::
1316 Defines how wide the commit message window is in the
1317 linkgit:git-gui[1]. "75" is the default.
1318
1319gui.diffcontext::
1320 Specifies how many context lines should be used in calls to diff
1321 made by the linkgit:git-gui[1]. The default is "5".
1322
a2df1fb2
AG
1323gui.encoding::
1324 Specifies the default encoding to use for displaying of
1325 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1326 It can be overridden by setting the 'encoding' attribute
1327 for relevant files (see linkgit:gitattributes[5]).
1328 If this option is not set, the tools default to the
1329 locale encoding.
1330
d84ae0db
GH
1331gui.matchtrackingbranch::
1332 Determines if new branches created with linkgit:git-gui[1] should
1333 default to tracking remote branches with matching names or
1334 not. Default: "false".
1335
1336gui.newbranchtemplate::
1337 Is used as suggested name when creating new branches using the
1338 linkgit:git-gui[1].
1339
1340gui.pruneduringfetch::
8b3f3f84 1341 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1342 performing a fetch. The default value is "false".
1343
1344gui.trustmtime::
1345 Determines if linkgit:git-gui[1] should trust the file modification
1346 timestamp or not. By default the timestamps are not trusted.
1347
1348gui.spellingdictionary::
1349 Specifies the dictionary used for spell checking commit messages in
1350 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1351 off.
1352
a2df1fb2 1353gui.fastcopyblame::
ca768288 1354 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1355 location detection. It makes blame significantly faster on huge
1356 repositories at the expense of less thorough copy detection.
1357
1358gui.copyblamethreshold::
76bac890 1359 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1360 detection, measured in alphanumeric characters. See the
1361 linkgit:git-blame[1] manual for more information on copy detection.
1362
1363gui.blamehistoryctx::
1364 Specifies the radius of history context in days to show in
1365 linkgit:gitk[1] for the selected commit, when the `Show History
1366 Context` menu item is invoked from 'git gui blame'. If this
1367 variable is set to zero, the whole history is shown.
1368
390c3480
AG
1369guitool.<name>.cmd::
1370 Specifies the shell command line to execute when the corresponding item
1371 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1372 mandatory for every tool. The command is executed from the root of
1373 the working directory, and in the environment it receives the name of
1374 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1375 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1376 the head is detached, 'CUR_BRANCH' is empty).
1377
1378guitool.<name>.needsfile::
1379 Run the tool only if a diff is selected in the GUI. It guarantees
1380 that 'FILENAME' is not empty.
1381
1382guitool.<name>.noconsole::
1383 Run the command silently, without creating a window to display its
1384 output.
1385
1386guitool.<name>.norescan::
1387 Don't rescan the working directory for changes after the tool
1388 finishes execution.
1389
1390guitool.<name>.confirm::
1391 Show a confirmation dialog before actually running the tool.
1392
1393guitool.<name>.argprompt::
1394 Request a string argument from the user, and pass it to the tool
1395 through the 'ARGS' environment variable. Since requesting an
1396 argument implies confirmation, the 'confirm' option has no effect
1397 if this is enabled. If the option is set to 'true', 'yes', or '1',
1398 the dialog uses a built-in generic prompt; otherwise the exact
1399 value of the variable is used.
1400
1401guitool.<name>.revprompt::
1402 Request a single valid revision from the user, and set the
1403 'REVISION' environment variable. In other aspects this option
1404 is similar to 'argprompt', and can be used together with it.
1405
1406guitool.<name>.revunmerged::
1407 Show only unmerged branches in the 'revprompt' subdialog.
1408 This is useful for tools similar to merge or rebase, but not
1409 for things like checkout or reset.
1410
1411guitool.<name>.title::
1412 Specifies the title to use for the prompt dialog. The default
1413 is the tool name.
1414
1415guitool.<name>.prompt::
1416 Specifies the general prompt string to display at the top of
1417 the dialog, before subsections for 'argprompt' and 'revprompt'.
1418 The default value includes the actual command.
1419
983a9eeb
CC
1420help.browser::
1421 Specify the browser that will be used to display help in the
1422 'web' format. See linkgit:git-help[1].
1423
1424help.format::
1425 Override the default help format used by linkgit:git-help[1].
1426 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1427 the default. 'web' and 'html' are the same.
1428
f0e90716
AR
1429help.autocorrect::
1430 Automatically correct and execute mistyped commands after
1431 waiting for the given number of deciseconds (0.1 sec). If more
1432 than one command can be deduced from the entered text, nothing
1433 will be executed. If the value of this option is negative,
1434 the corrected command will be executed immediately. If the
1435 value is 0 - the command will be just shown but not executed.
1436 This is the default.
1437
b1f809d0
SS
1438help.htmlpath::
1439 Specify the path where the HTML documentation resides. File system paths
1440 and URLs are supported. HTML pages will be prefixed with this path when
1441 help is displayed in the 'web' format. This defaults to the documentation
1442 path of your Git installation.
1443
9c5665aa 1444http.proxy::
b2c8c6d9
CB
1445 Override the HTTP proxy, normally configured using the 'http_proxy',
1446 'https_proxy', and 'all_proxy' environment variables (see
1447 `curl(1)`). This can be overridden on a per-remote basis; see
1448 remote.<name>.proxy
9c5665aa 1449
bcfb95dd
DB
1450http.cookiefile::
1451 File containing previously stored cookie lines which should be used
2de9b711 1452 in the Git http session, if they match the server. The file format
bcfb95dd
DB
1453 of the file to read cookies from should be plain HTTP headers or
1454 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1455 NOTE that the file specified with http.cookiefile is only used as
912b2acf
DB
1456 input unless http.saveCookies is set.
1457
1458http.savecookies::
1459 If set, store cookies received during requests to the file specified by
1460 http.cookiefile. Has no effect if http.cookiefile is unset.
bcfb95dd 1461
1ab661dd
PB
1462http.sslVerify::
1463 Whether to verify the SSL certificate when fetching or pushing
37425065 1464 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1465 variable.
1466
1467http.sslCert::
1468 File containing the SSL certificate when fetching or pushing
37425065 1469 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1470 variable.
1471
1472http.sslKey::
1473 File containing the SSL private key when fetching or pushing
abda1ef5 1474 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1475 variable.
1476
754ae192 1477http.sslCertPasswordProtected::
2de9b711 1478 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
1479 OpenSSL will prompt the user, possibly many times, if the
1480 certificate or private key is encrypted. Can be overridden by the
1481 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1482
1ab661dd
PB
1483http.sslCAInfo::
1484 File containing the certificates to verify the peer with when
abda1ef5 1485 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1486 'GIT_SSL_CAINFO' environment variable.
1487
1488http.sslCAPath::
1489 Path containing files with the CA certificates to verify the peer
37425065 1490 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1491 by the 'GIT_SSL_CAPATH' environment variable.
1492
4bc444eb
MV
1493http.sslTry::
1494 Attempt to use AUTH SSL/TLS and encrypted data transfers
1495 when connecting via regular FTP protocol. This might be needed
1496 if the FTP server requires it for security reasons or you wish
1497 to connect securely whenever remote FTP server supports it.
1498 Default is false since it might trigger certificate verification
1499 errors on misconfigured servers.
1500
1ab661dd 1501http.maxRequests::
abda1ef5 1502 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1503 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1504
ad75ebe5
TRC
1505http.minSessions::
1506 The number of curl sessions (counted across slots) to be kept across
1507 requests. They will not be ended with curl_easy_cleanup() until
1508 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1509 value will be capped at 1. Defaults to 1.
1510
de1a2fdd
SP
1511http.postBuffer::
1512 Maximum size in bytes of the buffer used by smart HTTP
1513 transports when POSTing data to the remote system.
1514 For requests larger than this buffer size, HTTP/1.1 and
1515 Transfer-Encoding: chunked is used to avoid creating a
1516 massive pack file locally. Default is 1 MiB, which is
1517 sufficient for most requests.
1518
1ab661dd
PB
1519http.lowSpeedLimit, http.lowSpeedTime::
1520 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1521 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1522 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1523 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1524
3ea099d4
SK
1525http.noEPSV::
1526 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1527 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1528 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1529 environment variable. Default is false (curl will use EPSV).
1530
b1d1058c
SO
1531http.useragent::
1532 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 1533 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
1534 This option allows you to override this value to a more common value
1535 such as Mozilla/4.0. This may be necessary, for instance, if
1536 connecting through a firewall that restricts HTTP connections to a set
1537 of common USER_AGENT strings (but not including those like git/1.7.1).
1538 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1539
6a56993b
KM
1540http.<url>.*::
1541 Any of the http.* options above can be applied selectively to some urls.
1542 For a config key to match a URL, each element of the config key is
1543 compared to that of the URL, in the following order:
1544+
1545--
1546. Scheme (e.g., `https` in `https://example.com/`). This field
1547 must match exactly between the config key and the URL.
1548
1549. Host/domain name (e.g., `example.com` in `https://example.com/`).
1550 This field must match exactly between the config key and the URL.
1551
1552. Port number (e.g., `8080` in `http://example.com:8080/`).
1553 This field must match exactly between the config key and the URL.
1554 Omitted port numbers are automatically converted to the correct
1555 default for the scheme before matching.
1556
1557. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1558 path field of the config key must match the path field of the URL
1559 either exactly or as a prefix of slash-delimited path elements. This means
1560 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1561 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1562 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1563 key with just path `foo/`).
1564
1565. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1566 the config key has a user name it must match the user name in the
1567 URL exactly. If the config key does not have a user name, that
1568 config key will match a URL with any user name (including none),
1569 but at a lower precedence than a config key with a user name.
1570--
1571+
1572The list above is ordered by decreasing precedence; a URL that matches
1573a config key's path is preferred to one that matches its user name. For example,
1574if the URL is `https://user@example.com/foo/bar` a config key match of
1575`https://example.com/foo` will be preferred over a config key match of
1576`https://user@example.com`.
1577+
1578All URLs are normalized before attempting any matching (the password part,
1579if embedded in the URL, is always ignored for matching purposes) so that
1580equivalent urls that are simply spelled differently will match properly.
1581Environment variable settings always override any matches. The urls that are
1582matched against are those given directly to Git commands. This means any URLs
1583visited as a result of a redirection do not participate in matching.
1584
1ab661dd 1585i18n.commitEncoding::
2de9b711 1586 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
1587 does not care per se, but this information is necessary e.g. when
1588 importing commits from emails or in the gitk graphical history
1589 browser (and possibly at other places in the future or in other
5162e697 1590 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1591
d2c11a38
JH
1592i18n.logOutputEncoding::
1593 Character encoding the commit messages are converted to when
0b444cdb 1594 running 'git log' and friends.
d2c11a38 1595
b0f34c3d
MM
1596imap::
1597 The configuration variables in the 'imap' section are described
1598 in linkgit:git-imap-send[1].
1599
d8a8488d
SD
1600init.templatedir::
1601 Specify the directory from which templates will be copied.
1602 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1603
983a9eeb
CC
1604instaweb.browser::
1605 Specify the program that will be used to browse your working
1606 repository in gitweb. See linkgit:git-instaweb[1].
1607
1608instaweb.httpd::
1609 The HTTP daemon command-line to start gitweb on your working
1610 repository. See linkgit:git-instaweb[1].
1611
1612instaweb.local::
1613 If true the web server started by linkgit:git-instaweb[1] will
1614 be bound to the local IP (127.0.0.1).
1615
1616instaweb.modulepath::
6b677a28
VS
1617 The default module path for linkgit:git-instaweb[1] to use
1618 instead of /usr/lib/apache2/modules. Only used if httpd
1619 is Apache.
983a9eeb
CC
1620
1621instaweb.port::
1622 The port number to bind the gitweb httpd to. See
1623 linkgit:git-instaweb[1].
1624
ca6ac7f1 1625interactive.singlekey::
57f6ec02 1626 In interactive commands, allow the user to provide one-letter
ca6ac7f1 1627 input with a single key (i.e., without hitting enter).
6cf378f0 1628 Currently this is used by the `--patch` mode of
e6b57a8a
CI
1629 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1630 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1631 setting is silently ignored if portable keystroke input
1632 is not available.
ca6ac7f1 1633
0c47695a
JS
1634log.abbrevCommit::
1635 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
1636 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1637 override this option with `--no-abbrev-commit`.
0c47695a 1638
dd0ffd5b 1639log.date::
e860795d
JN
1640 Set the default date-time mode for the 'log' command.
1641 Setting a value for log.date is similar to using 'git log''s
6cf378f0 1642 `--date` option. Possible values are `relative`, `local`,
e860795d
JN
1643 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1644 for details.
dd0ffd5b 1645
eb734454
SD
1646log.decorate::
1647 Print out the ref names of any commits that are shown by the log
1648 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1649 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1650 specified, the full ref name (including prefix) will be printed.
1651 This is the same as the log commands '--decorate' option.
1652
0f03ca94
PB
1653log.showroot::
1654 If true, the initial commit will be shown as a big creation event.
1655 This is equivalent to a diff against an empty tree.
5162e697 1656 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1657 normally hide the root commit will now show it. True by default.
1658
e6bb5f78
AP
1659log.mailmap::
1660 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1661 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1662
d551a488
MSO
1663mailmap.file::
1664 The location of an augmenting mailmap file. The default
1665 mailmap, located in the root of the repository, is loaded
1666 first, then the mailmap file pointed to by this variable.
1667 The location of the mailmap file may be in a repository
1668 subdirectory, or somewhere outside of the repository itself.
1669 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1670
08610900
JK
1671mailmap.blob::
1672 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
1673 blob in the repository. If both `mailmap.file` and
1674 `mailmap.blob` are given, both are parsed, with entries from
1675 `mailmap.file` taking precedence. In a bare repository, this
1676 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1677 defaults to empty.
08610900 1678
b5578f33 1679man.viewer::
b8322ea8 1680 Specify the programs that may be used to display help in the
b5578f33
CC
1681 'man' format. See linkgit:git-help[1].
1682
0bb64009
CC
1683man.<tool>.cmd::
1684 Specify the command to invoke the specified man viewer. The
1685 specified command is evaluated in shell with the man page
1686 passed as argument. (See linkgit:git-help[1].)
1687
7e8114c0
CC
1688man.<tool>.path::
1689 Override the path for the given tool that may be used to
1690 display help in the 'man' format. See linkgit:git-help[1].
1691
b0f34c3d 1692include::merge-config.txt[]
b5412484 1693
77680caa
JS
1694mergetool.<tool>.path::
1695 Override the path for the given tool. This is useful in case
1696 your tool is not in the PATH.
1697
964473a0
CB
1698mergetool.<tool>.cmd::
1699 Specify the command to invoke the specified merge tool. The
1700 specified command is evaluated in shell with the following
1701 variables available: 'BASE' is the name of a temporary file
1702 containing the common base of the files to be merged, if available;
1703 'LOCAL' is the name of a temporary file containing the contents of
1704 the file on the current branch; 'REMOTE' is the name of a temporary
1705 file containing the contents of the file from the branch being
1706 merged; 'MERGED' contains the name of the file to which the merge
1707 tool should write the results of a successful merge.
1708
1709mergetool.<tool>.trustExitCode::
1710 For a custom merge command, specify whether the exit code of
1711 the merge command can be used to determine whether the merge was
1712 successful. If this is not set to true then the merge target file
1713 timestamp is checked and the merge assumed to have been successful
1714 if the file has been updated, otherwise the user is prompted to
1715 indicate the success of the merge.
1716
44c36d1c
CB
1717mergetool.keepBackup::
1718 After performing a merge, the original file with conflict markers
1719 can be saved as a file with a `.orig` extension. If this variable
1720 is set to `false` then this file is not preserved. Defaults to
1721 `true` (i.e. keep the backup files).
1722
162eba8b 1723mergetool.keepTemporaries::
2de9b711 1724 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
1725 files to pass to the tool. If the tool returns an error and this
1726 variable is set to `true`, then these temporary files will be
1727 preserved, otherwise they will be removed after the tool has
1728 exited. Defaults to `false`.
1729
682b451f
CB
1730mergetool.prompt::
1731 Prompt before each invocation of the merge resolution program.
1732
894a9d33
TR
1733notes.displayRef::
1734 The (fully qualified) refname from which to show notes when
1735 showing commit messages. The value of this variable can be set
1736 to a glob, in which case notes from all matching refs will be
1737 shown. You may also specify this configuration variable
1738 several times. A warning will be issued for refs that do not
1739 exist, but a glob that does not match any refs is silently
1740 ignored.
1741+
1742This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1743environment variable, which must be a colon separated list of refs or
1744globs.
1745+
1746The effective value of "core.notesRef" (possibly overridden by
1747GIT_NOTES_REF) is also implicitly added to the list of refs to be
1748displayed.
1749
6956f858
TR
1750notes.rewrite.<command>::
1751 When rewriting commits with <command> (currently `amend` or
2de9b711 1752 `rebase`) and this variable is set to `true`, Git
6956f858
TR
1753 automatically copies your notes from the original to the
1754 rewritten commit. Defaults to `true`, but see
1755 "notes.rewriteRef" below.
6956f858
TR
1756
1757notes.rewriteMode::
1758 When copying notes during a rewrite (see the
1759 "notes.rewrite.<command>" option), determines what to do if
1760 the target commit already has a note. Must be one of
1761 `overwrite`, `concatenate`, or `ignore`. Defaults to
1762 `concatenate`.
1763+
1764This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1765environment variable.
1766
1767notes.rewriteRef::
1768 When copying notes during a rewrite, specifies the (fully
1769 qualified) ref whose notes should be copied. The ref may be a
1770 glob, in which case notes in all matching refs will be copied.
1771 You may also specify this configuration several times.
1772+
1773Does not have a default value; you must configure this variable to
2b4aa89c
TR
1774enable note rewriting. Set it to `refs/notes/commits` to enable
1775rewriting for the default commit notes.
cfb88e9a
LAS
1776+
1777This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1778environment variable, which must be a colon separated list of refs or
1779globs.
6956f858 1780
4812a93a 1781pack.window::
5162e697 1782 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1783 window size is given on the command line. Defaults to 10.
1784
842aaf93 1785pack.depth::
5162e697 1786 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1787 maximum depth is given on the command line. Defaults to 50.
842aaf93 1788
e93b15cd 1789pack.windowMemory::
5162e697 1790 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1791 when no limit is given on the command line. The value can be
1792 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1793 limit.
1794
960ccca6
DH
1795pack.compression::
1796 An integer -1..9, indicating the compression level for objects
1797 in a pack file. -1 is the zlib default. 0 means no
1798 compression, and 1..9 are various speed/size tradeoffs, 9 being
1799 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1800 not set, defaults to -1, the zlib default, which is "a default
1801 compromise between speed and compression (currently equivalent
1802 to level 6)."
89d71f75
JK
1803+
1804Note that changing the compression level will not automatically recompress
1805all existing objects. You can force recompression by passing the -F option
1806to linkgit:git-repack[1].
960ccca6 1807
074b2eea 1808pack.deltaCacheSize::
02783075 1809 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
1810 linkgit:git-pack-objects[1] before writing them out to a pack.
1811 This cache is used to speed up the writing object phase by not
1812 having to recompute the final delta result once the best match
1813 for all objects is found. Repacking large repositories on machines
1814 which are tight with memory might be badly impacted by this though,
1815 especially if this cache pushes the system into swapping.
1816 A value of 0 means no limit. The smallest size of 1 byte may be
1817 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 1818
e3dfddb3 1819pack.deltaCacheLimit::
693b86ff 1820 The maximum size of a delta, that is cached in
5749b0b2
NP
1821 linkgit:git-pack-objects[1]. This cache is used to speed up the
1822 writing object phase by not having to recompute the final delta
1823 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 1824
693b86ff
NP
1825pack.threads::
1826 Specifies the number of threads to spawn when searching for best
5162e697 1827 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1828 be compiled with pthreads otherwise this option is ignored with a
1829 warning. This is meant to reduce packing time on multiprocessor
1830 machines. The required amount of memory for the delta search window
1831 is however multiplied by the number of threads.
2de9b711 1832 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 1833 and set the number of threads accordingly.
693b86ff 1834
4d00bda2
NP
1835pack.indexVersion::
1836 Specify the default pack index version. Valid values are 1 for
1837 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1838 the new pack index with capabilities for packs larger than 4 GB
1839 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1840 packs. Version 2 is the default. Note that version 2 is enforced
1841 and this config option ignored whenever the corresponding pack is
1842 larger than 2 GB.
1843+
2de9b711 1844If you have an old Git that does not understand the version 2 `*.idx` file,
c0a5e2d4 1845cloning or fetching over a non native protocol (e.g. "http" and "rsync")
6cf378f0 1846that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 1847other side may give you a repository that cannot be accessed with your
2de9b711 1848older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 1849you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 1850the `*.idx` file.
4d00bda2 1851
dbdbfec4 1852pack.packSizeLimit::
07cf0f24
NP
1853 The maximum size of a pack. This setting only affects
1854 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 1855 is unaffected. It can be overridden by the `--max-pack-size`
07cf0f24
NP
1856 option of linkgit:git-repack[1]. The minimum size allowed is
1857 limited to 1 MiB. The default is unlimited.
1858 Common unit suffixes of 'k', 'm', or 'g' are
1859 supported.
2b84b5a8 1860
6b8fda2d
VM
1861pack.useBitmaps::
1862 When true, git will use pack bitmaps (if available) when packing
1863 to stdout (e.g., during the server side of a fetch). Defaults to
1864 true. You should not generally need to turn this off unless
1865 you are debugging pack bitmaps.
1866
7cc8f971
VM
1867pack.writebitmaps::
1868 When true, git will write a bitmap index when packing all
1869 objects to disk (e.g., when `git repack -a` is run). This
1870 index can speed up the "counting objects" phase of subsequent
1871 packs created for clones and fetches, at the cost of some disk
1872 space and extra time spent on the initial repack. Defaults to
1873 false.
1874
4370c2d6 1875pager.<cmd>::
9bad7233 1876 If the value is boolean, turns on or off pagination of the
2de9b711 1877 output of a particular Git subcommand when writing to a tty.
9bad7233 1878 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
1879 pager specified by the value of `pager.<cmd>`. If `--paginate`
1880 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
1881 precedence over this option. To disable pagination for all
1882 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 1883
8028184e
WP
1884pretty.<name>::
1885 Alias for a --pretty= format string, as specified in
1886 linkgit:git-log[1]. Any aliases defined here can be used just
1887 as the built-in pretty formats could. For example,
6cf378f0 1888 running `git config pretty.changelog "format:* %H %s"`
8028184e 1889 would cause the invocation `git log --pretty=changelog`
6cf378f0 1890 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
1891 Note that an alias with the same name as a built-in format
1892 will be silently ignored.
1893
6b37dff1
ÆAB
1894pull.rebase::
1895 When true, rebase branches on top of the fetched branch, instead
1896 of merging the default branch from the default remote when "git
1897 pull" is run. See "branch.<name>.rebase" for setting this on a
1898 per-branch basis.
66713ef3
SH
1899+
1900 When preserve, also pass `--preserve-merges` along to 'git rebase'
1901 so that locally committed merge commits will not be flattened
1902 by running 'git pull'.
6b37dff1
ÆAB
1903+
1904*NOTE*: this is a possibly dangerous operation; do *not* use
1905it unless you understand the implications (see linkgit:git-rebase[1]
1906for details).
1907
1ab661dd
PB
1908pull.octopus::
1909 The default merge strategy to use when pulling multiple branches
1910 at once.
1911
1912pull.twohead::
1913 The default merge strategy to use when pulling a single branch.
1914
52153747 1915push.default::
87a70e4c
RR
1916 Defines the action `git push` should take if no refspec is
1917 explicitly given. Different values are well-suited for
1918 specific workflows; for instance, in a purely central workflow
1919 (i.e. the fetch source is equal to the push destination),
1920 `upstream` is probably what you want. Possible values are:
52153747 1921+
b1290514 1922--
87a70e4c
RR
1923
1924* `nothing` - do not push anything (error out) unless a refspec is
1925 explicitly given. This is primarily meant for people who want to
1926 avoid mistakes by always being explicit.
1927
1928* `current` - push the current branch to update a branch with the same
1929 name on the receiving end. Works in both central and non-central
1930 workflows.
1931
1932* `upstream` - push the current branch back to the branch whose
1933 changes are usually integrated into the current branch (which is
1934 called `@{upstream}`). This mode only makes sense if you are
1935 pushing to the same repository you would normally pull from
1936 (i.e. central workflow).
1937
ed2b1829
RR
1938* `simple` - in centralized workflow, work like `upstream` with an
1939 added safety to refuse to push if the upstream branch's name is
1940 different from the local one.
b1290514 1941+
ed2b1829
RR
1942When pushing to a remote that is different from the remote you normally
1943pull from, work as `current`. This is the safest option and is suited
1944for beginners.
b1290514 1945+
87a70e4c
RR
1946This mode will become the default in Git 2.0.
1947
1948* `matching` - push all branches having the same name on both ends.
1949 This makes the repository you are pushing to remember the set of
1950 branches that will be pushed out (e.g. if you always push 'maint'
1951 and 'master' there and no other branches, the repository you push
1952 to will have these two branches, and your local 'maint' and
1953 'master' will be pushed there).
1954+
1955To use this mode effectively, you have to make sure _all_ the
1956branches you would push out are ready to be pushed out before
1957running 'git push', as the whole point of this mode is to allow you
1958to push all of the branches in one go. If you usually finish work
1959on only one branch and push out the result, while other branches are
1960unfinished, this mode is not for you. Also this mode is not
1961suitable for pushing into a shared central repository, as other
1962people may add new branches there, or update the tip of existing
1963branches outside your control.
1964+
1965This is currently the default, but Git 2.0 will change the default
1966to `simple`.
1967
1968--
52153747 1969
a9c3821c
TAV
1970rebase.stat::
1971 Whether to show a diffstat of what changed upstream since the last
1972 rebase. False by default.
1973
dd1e5b31
HV
1974rebase.autosquash::
1975 If set to true enable '--autosquash' option by default.
1976
58794775
RR
1977rebase.autostash::
1978 When set to true, automatically create a temporary stash
1979 before the operation begins, and apply it after the operation
1980 ends. This means that you can run rebase on a dirty worktree.
1981 However, use with care: the final stash application after a
1982 successful rebase might result in non-trivial conflicts.
1983 Defaults to false.
1984
77e3efbf
JH
1985receive.autogc::
1986 By default, git-receive-pack will run "git-gc --auto" after
1987 receiving data from git-push and updating refs. You can stop
1988 it by setting this variable to false.
1989
b0f34c3d
MM
1990receive.fsckObjects::
1991 If it is set to true, git-receive-pack will check all received
1992 objects. It will abort in the case of a malformed object or a
1993 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1994 Defaults to false. If not set, the value of `transfer.fsckObjects`
1995 is used instead.
b0f34c3d
MM
1996
1997receive.unpackLimit::
1998 If the number of objects received in a push is below this
1999 limit then the objects will be unpacked into loose object
2000 files. However if the number of received objects equals or
2001 exceeds this limit then the received pack will be stored as
2002 a pack, after adding any missing delta bases. Storing the
2003 pack from a push can make the push operation complete faster,
2004 especially on slow filesystems. If not set, the value of
2005 `transfer.unpackLimit` is used instead.
2006
42fc11c1
JH
2007receive.denyDeletes::
2008 If set to true, git-receive-pack will deny a ref update that deletes
2009 the ref. Use this to prevent such a ref deletion via a push.
2010
662c83ff
TR
2011receive.denyDeleteCurrent::
2012 If set to true, git-receive-pack will deny a ref update that
2013 deletes the currently checked out branch of a non-bare repository.
2014
42fc11c1 2015receive.denyCurrentBranch::
f3838ce1 2016 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
2017 to the currently checked out branch of a non-bare repository.
2018 Such a push is potentially dangerous because it brings the HEAD
2019 out of sync with the index and working tree. If set to "warn",
2020 print a warning of such a push to stderr, but allow the push to
2021 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 2022 message. Defaults to "refuse".
42fc11c1 2023
b0f34c3d
MM
2024receive.denyNonFastForwards::
2025 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 2026 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
2027 even if that push is forced. This configuration variable is
2028 set when initializing a shared repository.
2029
daebaa78
JH
2030receive.hiderefs::
2031 String(s) `receive-pack` uses to decide which refs to omit
2032 from its initial advertisement. Use more than one
2033 definitions to specify multiple prefix strings. A ref that
2034 are under the hierarchies listed on the value of this
2035 variable is excluded, and is hidden when responding to `git
2036 push`, and an attempt to update or delete a hidden ref by
2037 `git push` is rejected.
2038
77e3efbf
JH
2039receive.updateserverinfo::
2040 If set to true, git-receive-pack will run git-update-server-info
2041 after receiving data from git-push and updating refs.
2042
224c2171
RR
2043remote.pushdefault::
2044 The remote to push to by default. Overrides
9f765ce6
RR
2045 `branch.<name>.remote` for all branches, and is overridden by
2046 `branch.<name>.pushremote` for specific branches.
224c2171 2047
0cc6d346 2048remote.<name>.url::
5162e697
DM
2049 The URL of a remote repository. See linkgit:git-fetch[1] or
2050 linkgit:git-push[1].
0cc6d346 2051
20346234
MG
2052remote.<name>.pushurl::
2053 The push URL of a remote repository. See linkgit:git-push[1].
2054
14c98218
SV
2055remote.<name>.proxy::
2056 For remotes that require curl (http, https and ftp), the URL to
2057 the proxy to use for that remote. Set to the empty string to
2058 disable proxying for that remote.
2059
0cc6d346 2060remote.<name>.fetch::
5162e697
DM
2061 The default set of "refspec" for linkgit:git-fetch[1]. See
2062 linkgit:git-fetch[1].
0cc6d346
SB
2063
2064remote.<name>.push::
5162e697
DM
2065 The default set of "refspec" for linkgit:git-push[1]. See
2066 linkgit:git-push[1].
0cc6d346 2067
84bb2dfd
PB
2068remote.<name>.mirror::
2069 If true, pushing to this remote will automatically behave
6cf378f0 2070 as if the `--mirror` option was given on the command line.
84bb2dfd 2071
1918278e
TT
2072remote.<name>.skipDefaultUpdate::
2073 If true, this remote will be skipped by default when updating
7cc91a2f
BG
2074 using linkgit:git-fetch[1] or the `update` subcommand of
2075 linkgit:git-remote[1].
2076
2077remote.<name>.skipFetchAll::
2078 If true, this remote will be skipped by default when updating
2079 using linkgit:git-fetch[1] or the `update` subcommand of
2080 linkgit:git-remote[1].
1918278e 2081
060aafc1 2082remote.<name>.receivepack::
5dee29ac 2083 The default program to execute on the remote side when pushing. See
79f43f3d 2084 option \--receive-pack of linkgit:git-push[1].
060aafc1 2085
5dee29ac
UKK
2086remote.<name>.uploadpack::
2087 The default program to execute on the remote side when fetching. See
79f43f3d 2088 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 2089
047f636d 2090remote.<name>.tagopt::
79f43f3d 2091 Setting this value to \--no-tags disables automatic tag following when
944163a4
ST
2092 fetching from remote <name>. Setting it to \--tags will fetch every
2093 tag from remote <name>, even if they are not reachable from remote
ed368546
DJ
2094 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2095 override this setting. See options \--tags and \--no-tags of
2096 linkgit:git-fetch[1].
047f636d 2097
c578f51d 2098remote.<name>.vcs::
2de9b711 2099 Setting this to a value <vcs> will cause Git to interact with
c578f51d
DB
2100 the remote with the git-remote-<vcs> helper.
2101
737c5a9c
MS
2102remote.<name>.prune::
2103 When set to true, fetching from this remote by default will also
2104 remove any remote-tracking branches which no longer exist on the
2105 remote (as if the `--prune` option was give on the command line).
2106 Overrides `fetch.prune` settings, if any.
2107
1918278e
TT
2108remotes.<group>::
2109 The list of remotes which are fetched by "git remote update
5162e697 2110 <group>". See linkgit:git-remote[1].
1918278e 2111
b6945f57 2112repack.usedeltabaseoffset::
22c79eab
NP
2113 By default, linkgit:git-repack[1] creates packs that use
2114 delta-base offset. If you need to share your repository with
2de9b711 2115 Git older than version 1.4.4, either directly or via a dumb
22c79eab 2116 protocol such as http, then you need to set this option to
2de9b711 2117 "false" and repack. Access from old Git versions over the
22c79eab 2118 native protocol are unaffected by this option.
b6945f57 2119
b0f34c3d
MM
2120rerere.autoupdate::
2121 When set to true, `git-rerere` updates the index with the
2122 resulting contents after it cleanly resolves conflicts using
2123 previously recorded resolution. Defaults to false.
2124
2125rerere.enabled::
2126 Activate recording of resolved conflicts, so that identical
07b88a00
TR
2127 conflict hunks can be resolved automatically, should they be
2128 encountered again. By default, linkgit:git-rerere[1] is
2129 enabled if there is an `rr-cache` directory under the
b6fb7fed
JH
2130 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2131 repository.
b0f34c3d 2132
65180c66
YD
2133sendemail.identity::
2134 A configuration identity. When given, causes values in the
2135 'sendemail.<identity>' subsection to take precedence over
2136 values in the 'sendemail' section. The default identity is
2137 the value of 'sendemail.identity'.
2138
2139sendemail.smtpencryption::
2140 See linkgit:git-send-email[1] for description. Note that this
2141 setting is not subject to the 'identity' mechanism.
2142
2143sendemail.smtpssl::
2144 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2145
35035bbf
RR
2146sendemail.smtpsslcertpath::
2147 Path to ca-certificates (either a directory or a single file).
2148 Set it to an empty string to disable certificate verification.
2149
65180c66
YD
2150sendemail.<identity>.*::
2151 Identity-specific versions of the 'sendemail.*' parameters
2152 found below, taking precedence over those when the this
2153 identity is selected, through command-line or
2154 'sendemail.identity'.
2155
2156sendemail.aliasesfile::
2157sendemail.aliasfiletype::
402596aa 2158sendemail.annotate::
65180c66
YD
2159sendemail.bcc::
2160sendemail.cc::
2161sendemail.cccmd::
2162sendemail.chainreplyto::
2163sendemail.confirm::
2164sendemail.envelopesender::
2165sendemail.from::
2166sendemail.multiedit::
2167sendemail.signedoffbycc::
2168sendemail.smtppass::
2169sendemail.suppresscc::
2170sendemail.suppressfrom::
2171sendemail.to::
69cf7bfd 2172sendemail.smtpdomain::
65180c66
YD
2173sendemail.smtpserver::
2174sendemail.smtpserverport::
052fbea2 2175sendemail.smtpserveroption::
65180c66
YD
2176sendemail.smtpuser::
2177sendemail.thread::
2178sendemail.validate::
2179 See linkgit:git-send-email[1] for description.
2180
2181sendemail.signedoffcc::
2182 Deprecated alias for 'sendemail.signedoffbycc'.
2183
1ab661dd 2184showbranch.default::
5162e697
DM
2185 The default set of branches for linkgit:git-show-branch[1].
2186 See linkgit:git-show-branch[1].
1ab661dd 2187
46f721c8 2188status.relativePaths::
5162e697 2189 By default, linkgit:git-status[1] shows paths relative to the
46f721c8 2190 current directory. Setting this variable to `false` shows paths
2de9b711 2191 relative to the repository root (this was the default for Git
46f721c8
JK
2192 prior to v1.5.4).
2193
4fb5166a
JJGG
2194status.short::
2195 Set to true to enable --short by default in linkgit:git-status[1].
2196 The option --no-short takes precedence over this variable.
2197
ec85d070
JJGG
2198status.branch::
2199 Set to true to enable --branch by default in linkgit:git-status[1].
2200 The option --no-branch takes precedence over this variable.
2201
2556b996
MM
2202status.displayCommentPrefix::
2203 If set to true, linkgit:git-status[1] will insert a comment
2204 prefix before each output line (starting with
2205 `core.commentChar`, i.e. `#` by default). This was the
2206 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2207 Defaults to false.
2208
d6293d1f
MSO
2209status.showUntrackedFiles::
2210 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2211 files which are not currently tracked by Git. Directories which
2212 contain only untracked files, are shown with the directory name
2213 only. Showing untracked files means that Git needs to lstat() all
2214 all the files in the whole repository, which might be slow on some
2215 systems. So, this variable controls how the commands displays
2216 the untracked files. Possible values are:
2217+
2218--
9373bdc4
CF
2219* `no` - Show no untracked files.
2220* `normal` - Show untracked files and directories.
2221* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
2222--
2223+
2224If this variable is not specified, it defaults to 'normal'.
2225This variable can be overridden with the -u|--untracked-files option
2226of linkgit:git-status[1] and linkgit:git-commit[1].
2227
4b2343fa
MG
2228status.submodulesummary::
2229 Defaults to false.
2230 If this is set to a non zero number or true (identical to -1 or an
2231 unlimited number), the submodule summary will be enabled and a
2232 summary of commits for modified submodules will be shown (see
bb58b696
JL
2233 --summary-limit option of linkgit:git-submodule[1]). Please note
2234 that the summary output command will be suppressed for all
2235 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2236 for those submodules where `submodule.<name>.ignore=all`. To
2237 also view the summary for ignored submodules you can either use
2238 the --ignore-submodules=dirty command line option or the 'git
2239 submodule summary' command, which shows a similar output but does
2240 not honor these settings.
4b2343fa 2241
0ad0a61f
JN
2242submodule.<name>.path::
2243submodule.<name>.url::
2244submodule.<name>.update::
2245 The path within this project, URL, and the updating strategy
2246 for a submodule. These variables are initially populated
2247 by 'git submodule init'; edit them to override the
2248 URL and other values found in the `.gitmodules` file. See
2249 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2250
06b1abb5
TK
2251submodule.<name>.branch::
2252 The remote branch name for a submodule, used by `git submodule
2253 update --remote`. Set this option to override the value found in
2254 the `.gitmodules` file. See linkgit:git-submodule[1] and
2255 linkgit:gitmodules[5] for details.
2256
c1a3c364 2257submodule.<name>.fetchRecurseSubmodules::
bf42b384 2258 This option can be used to control recursive fetching of this
469bfc96 2259 submodule. It can be overridden by using the --[no-]recurse-submodules
c1a3c364
JL
2260 command line option to "git fetch" and "git pull".
2261 This setting will override that from in the linkgit:gitmodules[5]
2262 file.
2263
aee9c7d6
JL
2264submodule.<name>.ignore::
2265 Defines under what circumstances "git status" and the diff family show
2266 a submodule as modified. When set to "all", it will never be considered
2267 modified, "dirty" will ignore all changes to the submodules work tree and
2268 takes only differences between the HEAD of the submodule and the commit
2269 recorded in the superproject into account. "untracked" will additionally
2270 let submodules with modified tracked files in their work tree show up.
2271 Using "none" (the default when this option is not set) also shows
2272 submodules that have untracked files in their work tree as changed.
302ad7a9 2273 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 2274 both settings can be overridden on the command line by using the
bb58b696
JL
2275 "--ignore-submodules" option. The 'git submodule' commands are not
2276 affected by this setting.
aee9c7d6 2277
ce1a79b6 2278tar.umask::
687157c7
RS
2279 This variable can be used to restrict the permission bits of
2280 tar archive entries. The default is 0002, which turns off the
2281 world write bit. The special value "user" indicates that the
2282 archiving user's umask will be used instead. See umask(2) and
5162e697 2283 linkgit:git-archive[1].
ce1a79b6 2284
dab76d3a
JH
2285transfer.fsckObjects::
2286 When `fetch.fsckObjects` or `receive.fsckObjects` are
2287 not set, the value of this variable is used instead.
2288 Defaults to false.
2289
daebaa78
JH
2290transfer.hiderefs::
2291 This variable can be used to set both `receive.hiderefs`
2292 and `uploadpack.hiderefs` at the same time to the same
2293 values. See entries for these other variables.
2294
b0f34c3d
MM
2295transfer.unpackLimit::
2296 When `fetch.unpackLimit` or `receive.unpackLimit` are
2297 not set, the value of this variable is used instead.
2298 The default value is 100.
2299
daebaa78
JH
2300uploadpack.hiderefs::
2301 String(s) `upload-pack` uses to decide which refs to omit
2302 from its initial advertisement. Use more than one
2303 definitions to specify multiple prefix strings. A ref that
2304 are under the hierarchies listed on the value of this
2305 variable is excluded, and is hidden from `git ls-remote`,
2306 `git fetch`, etc. An attempt to fetch a hidden ref by `git
390eb36b
JH
2307 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2308
2309uploadpack.allowtipsha1inwant::
2310 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2311 to accept a fetch request that asks for an object at the tip
2312 of a hidden ref (by default, such a request is rejected).
2313 see also `uploadpack.hiderefs`.
daebaa78 2314
05e95155
JK
2315uploadpack.keepalive::
2316 When `upload-pack` has started `pack-objects`, there may be a
2317 quiet period while `pack-objects` prepares the pack. Normally
2318 it would output progress information, but if `--quiet` was used
2319 for the fetch, `pack-objects` will output nothing at all until
2320 the pack data begins. Some clients and networks may consider
2321 the server to be hung and give up. Setting this option instructs
2322 `upload-pack` to send an empty keepalive packet every
2323 `uploadpack.keepalive` seconds. Setting this option to 0
115dedd7 2324 disables keepalive packets entirely. The default is 5 seconds.
05e95155 2325
55029ae4
DB
2326url.<base>.insteadOf::
2327 Any URL that starts with this value will be rewritten to
2328 start, instead, with <base>. In cases where some site serves a
2329 large number of repositories, and serves them with multiple
2330 access methods, and some users need to use different access
2331 methods, this feature allows people to specify any of the
2de9b711 2332 equivalent URLs and have Git automatically rewrite the URL to
55029ae4 2333 the best alternative for the particular user, even for a
844112ca
JH
2334 never-before-seen repository on the site. When more than one
2335 insteadOf strings match a given URL, the longest match is used.
55029ae4 2336
1c2eafb8
JT
2337url.<base>.pushInsteadOf::
2338 Any URL that starts with this value will not be pushed to;
2339 instead, it will be rewritten to start with <base>, and the
2340 resulting URL will be pushed to. In cases where some site serves
2341 a large number of repositories, and serves them with multiple
2342 access methods, some of which do not allow push, this feature
2de9b711 2343 allows people to specify a pull-only URL and have Git
1c2eafb8
JT
2344 automatically use an appropriate URL to push, even for a
2345 never-before-seen repository on the site. When more than one
2346 pushInsteadOf strings match a given URL, the longest match is
2de9b711 2347 used. If a remote has an explicit pushurl, Git will ignore this
1c2eafb8
JT
2348 setting for that remote.
2349
1ab661dd
PB
2350user.email::
2351 Your email address to be recorded in any newly created commits.
28a94f88 2352 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 2353 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
2354
2355user.name::
2356 Your full name to be recorded in any newly created commits.
abda1ef5 2357 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 2358 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 2359
d67778ec 2360user.signingkey::
f0551693
NV
2361 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2362 key you want it to automatically when creating a signed tag or
2363 commit, you can override the default selection with this variable.
2364 This option is passed unchanged to gpg's --local-user parameter,
2365 so you may specify a key using any method that gpg supports.
d67778ec 2366
983a9eeb
CC
2367web.browser::
2368 Specify a web browser that may be used by some commands.
2369 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2370 may use it.