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