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