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