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