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