Add mailmap.file as configurational option for mailmap location
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
5ea5621f
JH
5the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
32043c9f
JS
8fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
5ea5621f
JH
10
11They can be used by both the git plumbing
b8936cf0 12and the porcelains. The variables are divided into sections, where
1ab661dd
PB
13in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
e136f33b
JN
18Syntax
19~~~~~~
20
1ab661dd 21The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
22ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37 [section "subsection"]
38
39--------
40
191453f6
JN
41Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
3dff5379 43respectively) and are case sensitive. Section header cannot span multiple
e136f33b
JN
44lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All the other lines are recognized as setting variables, in the form
53'name = value'. If there is no equal sign on the line, the entire line
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
56characters and '`-`' are allowed. There can be more than one value
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
ba020ef5 66'git-config' will ensure that the output is "true" or "false".
e136f33b
JN
67
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require special value format.
1ab661dd
PB
84
85Example
86~~~~~~~
87
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
92
93 # Our diff algorithm
94 [diff]
6bb9e51b 95 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
96 renames = true
97
910c00c8
AK
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
101
e136f33b
JN
102 # Proxy settings
103 [core]
29093c28 104 gitProxy="ssh" for "kernel.org"
e136f33b 105 gitProxy=default-proxy ; for the rest
910c00c8 106
1ab661dd
PB
107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116 If false, the executable bit differences between the index and
117 the working copy are ignored; useful on broken filesystems like FAT.
5162e697 118 See linkgit:git-update-index[1]. True by default.
1ab661dd 119
adbc0b6b
DP
120core.ignoreCygwinFSTricks::
121 This option is only used by Cygwin implementation of Git. If false,
122 the Cygwin stat() and lstat() functions are used. This may be useful
123 if your repository consists of a few separate directories joined in
124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125 whenever it is possible and falls back to Cygwin functions only to
126 handle symbol links. The native mode is more than twice faster than
7faee6b8
ML
127 normal Cygwin l/stat() functions. True by default, unless core.filemode
128 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129 POSIX emulation is required to support core.filemode.
adbc0b6b 130
1ce4790b
AR
131core.trustctime::
132 If false, the ctime differences between the index and the
133 working copy are ignored; useful when the inode change time
134 is regularly modified by something outside Git (file system
135 crawlers and some backup systems).
136 See linkgit:git-update-index[1]. True by default.
137
9378c161 138core.quotepath::
5833d730
JN
139 The commands that output paths (e.g. 'ls-files',
140 'diff'), when not given the `-z` option, will quote
9378c161
JH
141 "unusual" characters in the pathname by enclosing the
142 pathname in a double-quote pair and with backslashes the
143 same way strings in C source code are quoted. If this
144 variable is set to false, the bytes higher than 0x80 are
145 not quoted but output as verbatim. Note that double
146 quote, backslash and control characters are always
147 quoted without `-z` regardless of the setting of this
148 variable.
149
5cb71f82
FL
150core.autocrlf::
151 If true, makes git convert `CRLF` at the end of lines in text files to
152 `LF` when reading from the filesystem, and convert in reverse when
153 writing to the filesystem. The variable can be set to
154 'input', in which case the conversion happens only while
155 reading from the filesystem but files are written out with
156 `LF` at the end of lines. Currently, which paths to consider
157 "text" (i.e. be subjected to the autocrlf mechanism) is
158 decided purely based on the contents.
159
21e5ad50
SP
160core.safecrlf::
161 If true, makes git check if converting `CRLF` as controlled by
162 `core.autocrlf` is reversible. Git will verify if a command
163 modifies a file in the work tree either directly or indirectly.
164 For example, committing a file followed by checking out the
165 same file should yield the original file in the work tree. If
166 this is not the case for the current setting of
167 `core.autocrlf`, git will reject the file. The variable can
168 be set to "warn", in which case git will only warn about an
169 irreversible conversion but continue the operation.
170+
171CRLF conversion bears a slight chance of corrupting data.
172autocrlf=true will convert CRLF to LF during commit and LF to
173CRLF during checkout. A file that contains a mixture of LF and
174CRLF before the commit cannot be recreated by git. For text
175files this is the right thing to do: it corrects line endings
176such that we have only LF line endings in the repository.
177But for binary files that are accidentally classified as text the
178conversion can corrupt data.
179+
180If you recognize such corruption early you can easily fix it by
181setting the conversion type explicitly in .gitattributes. Right
182after committing you still have the original file in your work
183tree and this file is not yet corrupted. You can explicitly tell
184git that this file is binary and git will handle the file
185appropriately.
186+
187Unfortunately, the desired effect of cleaning up text files with
188mixed line endings and the undesired effect of corrupting binary
189files cannot be distinguished. In both cases CRLFs are removed
190in an irreversible way. For text files this is the right thing
191to do because CRLFs are line endings, while for binary files
192converting CRLFs corrupts data.
193+
194Note, this safety check does not mean that a checkout will generate a
195file identical to the original file for a different setting of
196`core.autocrlf`, but only for the current one. For example, a text
197file with `LF` would be accepted with `core.autocrlf=input` and could
198later be checked out with `core.autocrlf=true`, in which case the
199resulting file would contain `CRLF`, although the original file
200contained `LF`. However, in both work trees the line endings would be
201consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202file with mixed line endings would be reported by the `core.safecrlf`
203mechanism.
204
78a8d641
JS
205core.symlinks::
206 If false, symbolic links are checked out as small plain files that
5162e697
DM
207 contain the link text. linkgit:git-update-index[1] and
208 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
209 file. Useful on filesystems like FAT that do not support
210 symbolic links. True by default.
211
1ab661dd
PB
212core.gitProxy::
213 A "proxy command" to execute (as 'command host port') instead
214 of establishing direct connection to the remote server when
215 using the git protocol for fetching. If the variable value is
216 in the "COMMAND for DOMAIN" format, the command is applied only
217 on hostnames ending with the specified domain string. This variable
218 may be set multiple times and is matched in the given order;
219 the first match wins.
b8936cf0
FD
220+
221Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222(which always applies universally, without the special "for"
223handling).
1ab661dd
PB
224
225core.ignoreStat::
b7f685a7
MSO
226 If true, commands which modify both the working tree and the index
227 will mark the updated paths with the "assume unchanged" bit in the
228 index. These marked files are then assumed to stay unchanged in the
229 working copy, until you mark them otherwise manually - Git will not
230 detect the file changes by lstat() calls. This is useful on systems
231 where those are very slow, such as Microsoft Windows.
232 See linkgit:git-update-index[1].
1ab661dd
PB
233 False by default.
234
9f0bb90d
JH
235core.preferSymlinkRefs::
236 Instead of the default "symref" format for HEAD
237 and other symbolic reference files, use symbolic links.
238 This is sometimes needed to work with old scripts that
239 expect HEAD to be a symbolic link.
1ab661dd 240
e4a15f40
SP
241core.bare::
242 If true this repository is assumed to be 'bare' and has no
243 working directory associated with it. If this is the case a
244 number of commands that require a working directory will be
5162e697 245 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 246+
5162e697
DM
247This setting is automatically guessed by linkgit:git-clone[1] or
248linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
249repository that ends in "/.git" is assumed to be not bare (bare =
250false), while all other repositories are assumed to be bare (bare
251= true).
252
892c41b9
ML
253core.worktree::
254 Set the path to the working tree. The value will not be
255 used in combination with repositories found automatically in
256 a .git directory (i.e. $GIT_DIR is not set).
06ada152 257 This can be overridden by the GIT_WORK_TREE environment
302cc11a
LY
258 variable and the '--work-tree' command line option. It can be
259 a absolute path or relative path to the directory specified by
260 --git-dir or GIT_DIR.
261 Note: If --git-dir or GIT_DIR are specified but none of
262 --work-tree, GIT_WORK_TREE and core.worktree is specified,
263 the current working directory is regarded as the top directory
264 of your working tree.
892c41b9 265
6de08ae6 266core.logAllRefUpdates::
14cd5607 267 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
268 "$GIT_DIR/logs/<ref>", by appending the new and old
269 SHA1, the date/time and the reason of the update, but
270 only when the file exists. If this configuration
271 variable is set to true, missing "$GIT_DIR/logs/<ref>"
272 file is automatically created for branch heads.
a862f97e
JH
273+
274This information can be used to determine what commit
275was the tip of a branch "2 days ago".
276+
277This value is true by default in a repository that has
278a working directory associated with it, and false by
279default in a bare repository.
6de08ae6 280
1ab661dd
PB
281core.repositoryFormatVersion::
282 Internal variable identifying the repository format and layout
283 version.
284
285core.sharedRepository::
d5dc6a76
JF
286 When 'group' (or 'true'), the repository is made shareable between
287 several users in a group (making sure all the files and objects are
288 group-writable). When 'all' (or 'world' or 'everybody'), the
289 repository will be readable by all users, additionally to being
290 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
291 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
292 files in the repository will have this mode value. '0xxx' will override
293 user's umask value, and thus, users with a safe umask (0077) can use
294 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
295 repository that is group-readable but not group-writable.
296 See linkgit:git-init[1]. False by default.
1ab661dd
PB
297
298core.warnAmbiguousRefs::
299 If true, git will warn you if the ref name you passed it is ambiguous
300 and might match multiple refs in the .git/refs/ tree. True by default.
301
3d3e95af 302core.compression::
960ccca6
DH
303 An integer -1..9, indicating a default compression level.
304 -1 is the zlib default. 0 means no compression,
305 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
306 If set, this provides a default to other compression variables,
307 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
308
309core.loosecompression::
12f6c308 310 An integer -1..9, indicating the compression level for objects that
960ccca6 311 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 312 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 313 slowest. If not set, defaults to core.compression. If that is
de1b2460 314 not set, defaults to 1 (best speed).
12f6c308 315
60bb8b14
SP
316core.packedGitWindowSize::
317 Number of bytes of a pack file to map into memory in a
318 single mapping operation. Larger window sizes may allow
319 your system to process a smaller number of large pack files
320 more quickly. Smaller window sizes will negatively affect
eb92242f 321 performance due to increased calls to the operating system's
60bb8b14 322 memory manager, but may improve performance when accessing
22bac0ea
SP
323 a large number of large pack files.
324+
325Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
326MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
327be reasonable for all users/operating systems. You probably do
328not need to adjust this value.
eb92242f
SP
329+
330Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 331
77ccc5bb
SP
332core.packedGitLimit::
333 Maximum number of bytes to map simultaneously into memory
334 from pack files. If Git needs to access more than this many
335 bytes at once to complete an operation it will unmap existing
336 regions to reclaim virtual address space within the process.
22bac0ea
SP
337+
338Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
339This should be reasonable for all users/operating systems, except on
340the largest projects. You probably do not need to adjust this value.
eb92242f
SP
341+
342Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 343
18bdec11
SP
344core.deltaBaseCacheLimit::
345 Maximum number of bytes to reserve for caching base objects
346 that multiple deltafied objects reference. By storing the
347 entire decompressed base objects in a cache Git is able
348 to avoid unpacking and decompressing frequently used base
349 objects multiple times.
350+
351Default is 16 MiB on all platforms. This should be reasonable
352for all users/operating systems, except on the largest projects.
353You probably do not need to adjust this value.
354+
355Common unit suffixes of 'k', 'm', or 'g' are supported.
356
e8964a5b 357core.excludesfile::
0ba956d3
JS
358 In addition to '.gitignore' (per-directory) and
359 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 360 of files which are not meant to be tracked. See
5162e697 361 linkgit:gitignore[5].
0ba956d3 362
ef0c2abf
AR
363core.editor::
364 Commands such as `commit` and `tag` that lets you edit
02783075 365 messages by launching an editor uses the value of this
ef0c2abf
AR
366 variable when it is set, and the environment variable
367 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
368 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
369 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 370
54adf370 371core.pager::
ab54cd6c
JN
372 The command that git will use to paginate output. Can
373 be overridden with the `GIT_PAGER` environment
374 variable. Note that git sets the `LESS` environment
375 variable to `FRSX` if it is unset when it runs the
376 pager. One can change these settings by setting the
fee75457
CF
377 `LESS` variable to some other value. Alternately,
378 these settings can be overridden on a project or
379 global basis by setting the `core.pager` option.
380 Setting `core.pager` has no affect on the `LESS`
381 environment variable behaviour above, so if you want
382 to override git's default settings this way, you need
383 to be explicit. For example, to disable the S option
384 in a backward compatible manner, set `core.pager`
385 to "`less -+$LESS -FRX`". This will be passed to the
386 shell by git, which will translate the final command to
387 "`LESS=FRSX less -+FRSX -FRX`".
54adf370 388
91af7ae5
JH
389core.whitespace::
390 A comma separated list of common whitespace problems to
ba020ef5
JN
391 notice. 'git-diff' will use `color.diff.whitespace` to
392 highlight them, and 'git-apply --whitespace=error' will
c921cc92
JH
393 consider them as errors. You can prefix `-` to disable
394 any of them (e.g. `-trailing-space`):
91af7ae5
JH
395+
396* `trailing-space` treats trailing whitespaces at the end of the line
397 as an error (enabled by default).
398* `space-before-tab` treats a space character that appears immediately
399 before a tab character in the initial indent part of the line as an
400 error (enabled by default).
401* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 402 space characters as an error (not enabled by default).
b2979ff5
JH
403* `cr-at-eol` treats a carriage-return at the end of line as
404 part of the line terminator, i.e. with it, `trailing-space`
405 does not trigger if the character before such a carriage-return
406 is not a whitespace (not enabled by default).
91af7ae5 407
aafe9fba
LT
408core.fsyncobjectfiles::
409 This boolean will enable 'fsync()' when writing object files.
410+
411This is a total waste of time and effort on a filesystem that orders
412data writes properly, but can be useful for filesystems that do not use
413journalling (traditional UNIX filesystems) or that only journal metadata
414and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
415
671c9b7e
LT
416core.preloadindex::
417 Enable parallel index preload for operations like 'git diff'
418+
419This can speed up operations like 'git diff' and 'git status' especially
420on filesystems like NFS that have weak caching semantics and thus
421relatively high IO latencies. With this set to 'true', git will do the
422index comparison to the filesystem data in parallel, allowing
423overlapping IO's.
424
4514ad4f 425alias.*::
5162e697 426 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
427 after defining "alias.last = cat-file commit HEAD", the invocation
428 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
429 confusion and troubles with script usage, aliases that
430 hide existing git commands are ignored. Arguments are split by
431 spaces, the usual shell quoting and escaping is supported.
432 quote pair and a backslash can be used to quote them.
f368f5a6
JH
433+
434If the alias expansion is prefixed with an exclamation point,
435it will be treated as a shell command. For example, defining
436"alias.new = !gitk --all --not ORIG_HEAD", the invocation
437"git new" is equivalent to running the shell command
438"gitk --all --not ORIG_HEAD".
dfd42a3c 439
1ab661dd 440apply.whitespace::
ba020ef5 441 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 442 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 443
9902387d 444branch.autosetupmerge::
ba020ef5 445 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
446 so that linkgit:git-pull[1] will appropriately merge from the
447 starting point branch. Note that even if this option is not set,
9902387d 448 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
449 and `--no-track` options. The valid settings are: `false` -- no
450 automatic setup is done; `true` -- automatic setup is done when the
451 starting point is a remote branch; `always` -- automatic setup is
452 done when the starting point is either a local branch or remote
453 branch. This option defaults to true.
9902387d 454
c998ae9b 455branch.autosetuprebase::
ba020ef5 456 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
457 that tracks another branch, this variable tells git to set
458 up pull to rebase instead of merge (see "branch.<name>.rebase").
459 When `never`, rebase is never automatically set to true.
460 When `local`, rebase is set to true for tracked branches of
461 other local branches.
462 When `remote`, rebase is set to true for tracked branches of
463 remote branches.
464 When `always`, rebase will be set to true for all tracking
465 branches.
466 See "branch.autosetupmerge" for details on how to set up a
467 branch to track another branch.
468 This option defaults to never.
469
648ad18f 470branch.<name>.remote::
ba020ef5
JN
471 When in branch <name>, it tells 'git-fetch' which remote to fetch.
472 If this option is not given, 'git-fetch' defaults to remote "origin".
648ad18f 473
5372806a 474branch.<name>.merge::
ba020ef5 475 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
476 refspec to be marked for merging in FETCH_HEAD. The value is
477 handled like the remote part of a refspec, and must match a
478 ref which is fetched from the remote given by
479 "branch.<name>.remote".
ba020ef5
JN
480 The merge information is used by 'git-pull' (which at first calls
481 'git-fetch') to lookup the default branch for merging. Without
482 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 483 Specify multiple values to get an octopus merge.
ba020ef5 484 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
485 another branch in the local repository, you can point
486 branch.<name>.merge to the desired branch, and use the special setting
487 `.` (a period) for branch.<name>.remote.
5372806a 488
aec7b362
LH
489branch.<name>.mergeoptions::
490 Sets default options for merging into branch <name>. The syntax and
5162e697 491 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
492 option values containing whitespace characters are currently not
493 supported.
494
cd67e4d4
JS
495branch.<name>.rebase::
496 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
497 instead of merging the default branch from the default remote when
498 "git pull" is run.
cd67e4d4 499 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 500 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
501 for details).
502
1658c614
CC
503browser.<tool>.cmd::
504 Specify the command to invoke the specified browser. The
505 specified command is evaluated in shell with the URLs passed
506 as arguments. (See linkgit:git-web--browse[1].)
507
584627b4
CC
508browser.<tool>.path::
509 Override the path for the given tool that may be used to
ab989adf
CC
510 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
511 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 512
2122591b 513clean.requireForce::
562ca192
JH
514 A boolean to make git-clean do nothing unless given -f
515 or -n. Defaults to true.
2122591b 516
f3673988
BG
517color.branch::
518 A boolean to enable/disable color in the output of
5162e697 519 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 520 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
521 only when the output is to a terminal. Defaults to false.
522
523color.branch.<slot>::
524 Use customized color for branch coloration. `<slot>` is one of
525 `current` (the current branch), `local` (a local branch),
526 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
527 refs).
528+
529The value for these configuration variables is a list of colors (at most
530two) and attributes (at most one), separated by spaces. The colors
531accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
532`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
533`blink` and `reverse`. The first color given is the foreground; the
534second is the background. The position of the attribute, if any,
535doesn't matter.
f3673988 536
a159ca0c 537color.diff::
cec99d8c
JH
538 When set to `always`, always use colors in patch.
539 When false (or `never`), never. When set to `true` or `auto`, use
540 colors only when the output is to the terminal. Defaults to false.
b5376648 541
a159ca0c 542color.diff.<slot>::
4f193f20
MW
543 Use customized color for diff colorization. `<slot>` specifies
544 which part of the patch to use the specified color, and is one
545 of `plain` (context text), `meta` (metainformation), `frag`
546 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
547 `commit` (commit headers), or `whitespace` (highlighting
548 whitespace errors). The values of these variables may be specified as
4f193f20 549 in color.branch.<slot>.
b5376648 550
b4c61ed6 551color.interactive::
47ee06f1 552 When set to `always`, always use colors for interactive prompts
467c0197 553 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
554 When false (or `never`), never. When set to `true` or `auto`, use
555 colors only when the output is to the terminal. Defaults to false.
556
557color.interactive.<slot>::
ba020ef5 558 Use customized color for 'git-add --interactive'
b4c61ed6
JH
559 output. `<slot>` may be `prompt`, `header`, or `help`, for
560 three distinct types of normal output from interactive
561 programs. The values of these variables may be specified as
562 in color.branch.<slot>.
563
1d77043b
JH
564color.pager::
565 A boolean to enable/disable colored output when the pager is in
566 use (default is true).
567
568color.status::
569 A boolean to enable/disable color in the output of
5162e697 570 linkgit:git-status[1]. May be set to `always`,
cec99d8c 571 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
572 only when the output is to a terminal. Defaults to false.
573
574color.status.<slot>::
575 Use customized color for status colorization. `<slot>` is
576 one of `header` (the header text of the status message),
82dca848
SP
577 `added` or `updated` (files which are added but not committed),
578 `changed` (files which are changed but not added in the index),
950ce2e2
CP
579 `untracked` (files which are not tracked by git), or
580 `nobranch` (the color the 'no branch' warning is shown in, defaulting
581 to red). The values of these variables may be specified as in
582 color.branch.<slot>.
1d77043b 583
6b2f2d98
MK
584color.ui::
585 When set to `always`, always use colors in all git commands which
586 are capable of colored output. When false (or `never`), never. When
587 set to `true` or `auto`, use colors only when the output is to the
588 terminal. When more specific variables of color.* are set, they always
589 take precedence over this setting. Defaults to false.
590
b0f34c3d
MM
591commit.template::
592 Specify a file to use as the template for new commit messages.
593
aecbf914 594diff.autorefreshindex::
ba020ef5 595 When using 'git-diff' to compare with work tree
aecbf914
JH
596 files, do not consider stat-only change as changed.
597 Instead, silently run `git update-index --refresh` to
598 update the cached stat information for paths whose
599 contents in the work tree match the contents in the
600 index. This option defaults to true. Note that this
ba020ef5 601 affects only 'git-diff' Porcelain, and not lower level
5833d730 602 'diff' commands, such as 'git-diff-files'.
aecbf914 603
77680caa
JS
604diff.external::
605 If this config variable is set, diff generation is not
606 performed using the internal diff machinery, but using the
6bb9e51b
AM
607 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
608 environment variable. The command is called with parameters
609 as described under "git Diffs" in linkgit:git[1]. Note: if
610 you want to use an external diff program only on a subset of
611 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 612
a5a818ee
JH
613diff.mnemonicprefix::
614 If set, 'git-diff' uses a prefix pair that is different from the
615 standard "a/" and "b/" depending on what is being compared. When
616 this configuration is in effect, reverse diff output also swaps
617 the order of the prefixes:
618'git-diff';;
619 compares the (i)ndex and the (w)ork tree;
620'git-diff HEAD';;
621 compares a (c)ommit and the (w)ork tree;
622'git diff --cached';;
623 compares a (c)ommit and the (i)ndex;
624'git-diff HEAD:file1 file2';;
625 compares an (o)bject and a (w)ork tree entity;
626'git diff --no-index a b';;
627 compares two non-git things (1) and (2).
628
1ab661dd
PB
629diff.renameLimit::
630 The number of files to consider when performing the copy/rename
0979c106 631 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 632
b68ea12e
EW
633diff.renames::
634 Tells git to detect renames. If set to any boolean value, it
635 will enable basic rename detection. If set to "copies" or
636 "copy", it will detect copies, as well.
637
950db879 638diff.suppressBlankEmpty::
5fdb7098
RH
639 A boolean to inhibit the standard behavior of printing a space
640 before each empty output line. Defaults to false.
641
ae3b970a 642diff.wordRegex::
98a4d87b
BSSJ
643 A POSIX Extended Regular Expression used to determine what is a "word"
644 when performing word-by-word difference calculations. Character
645 sequences that match the regular expression are "words", all other
646 characters are *ignorable* whitespace.
647
af7cf268
JH
648fetch.unpackLimit::
649 If the number of objects fetched over the git native
650 transfer is below this
651 limit, then the objects will be unpacked into loose object
652 files. However if the number of received objects equals or
653 exceeds this limit then the received pack will be stored as
654 a pack, after adding any missing delta bases. Storing the
655 pack from a push can make the push operation complete faster,
80cd9cf9
MB
656 especially on slow filesystems. If not set, the value of
657 `transfer.unpackLimit` is used instead.
af7cf268 658
49604a4d 659format.numbered::
a567fdcb
BG
660 A boolean which can enable or disable sequence numbers in patch
661 subjects. It defaults to "auto" which enables it only if there
662 is more than one patch. It can be enabled or disabled for all
663 messages by setting it to "true" or "false". See --numbered
664 option in linkgit:git-format-patch[1].
49604a4d 665
1ab661dd
PB
666format.headers::
667 Additional email headers to include in a patch to be submitted
5162e697 668 by mail. See linkgit:git-format-patch[1].
1ab661dd 669
78cb59c8
JS
670format.suffix::
671 The default for format-patch is to output files with the suffix
672 `.patch`. Use this variable to change that suffix (make sure to
673 include the dot if you want it).
1ab661dd 674
94c22a5e
CR
675format.pretty::
676 The default pretty format for log/show/whatchanged command,
677 See linkgit:git-log[1], linkgit:git-show[1],
678 linkgit:git-whatchanged[1].
679
0d7566a5
TT
680gc.aggressiveWindow::
681 The window size parameter used in the delta compression
467c0197 682 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
683 to 10.
684
e9831e83
JH
685gc.auto::
686 When there are approximately more than this many loose
687 objects in the repository, `git gc --auto` will pack them.
688 Some Porcelain commands use this command to perform a
80cd9cf9
MB
689 light-weight garbage collection from time to time. The
690 default value is 6700. Setting this to 0 disables it.
e9831e83 691
17815501
JH
692gc.autopacklimit::
693 When there are more than this many packs that are not
694 marked with `*.keep` file in the repository, `git gc
80cd9cf9 695 --auto` consolidates them into one larger pack. The
97063974 696 default value is 50. Setting this to 0 disables it.
17815501 697
c2120e5e 698gc.packrefs::
ba020ef5 699 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 700 default so that older dumb-transport clients can still fetch
ba020ef5 701 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 702 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 703 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
704 `notbare`. Enable it only when you know you do not have to
705 support such clients. The default setting will change to `true`
706 at some stage, and setting this to `false` will continue to
ba020ef5 707 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 708
25ee9731 709gc.pruneexpire::
5833d730 710 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33
NP
711 Override the grace period with this config variable. The value
712 "now" may be used to disable this grace period and always prune
713 unreachable objects immediately.
25ee9731 714
4aec56d1 715gc.reflogexpire::
ba020ef5 716 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
717 this time; defaults to 90 days.
718
719gc.reflogexpireunreachable::
ba020ef5 720 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
721 this time and are not reachable from the current tip;
722 defaults to 30 days.
723
48c32424
JH
724gc.rerereresolved::
725 Records of conflicted merge you resolved earlier are
ba020ef5 726 kept for this many days when 'git-rerere gc' is run.
5162e697 727 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
728
729gc.rerereunresolved::
730 Records of conflicted merge you have not resolved are
ba020ef5 731 kept for this many days when 'git-rerere gc' is run.
5162e697 732 The default is 15 days. See linkgit:git-rerere[1].
48c32424 733
280514e1
FE
734gitcvs.commitmsgannotation::
735 Append this string to each commit message. Set to empty string
736 to disable this feature. Defaults to "via git-CVS emulator".
737
1ab661dd 738gitcvs.enabled::
db218723 739 Whether the CVS server interface is enabled for this repository.
5162e697 740 See linkgit:git-cvsserver[1].
1ab661dd
PB
741
742gitcvs.logfile::
db218723 743 Path to a log file where the CVS server interface well... logs
5162e697 744 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 745
1707adb7 746gitcvs.usecrlfattr::
8a06a632
MO
747 If true, the server will look up the `crlf` attribute for
748 files to determine the '-k' modes to use. If `crlf` is set,
749 the '-k' mode will be left blank, so cvs clients will
750 treat it as text. If `crlf` is explicitly unset, the file
1168d402 751 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 752 the client might otherwise do. If `crlf` is not specified,
ea449615 753 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 754
eabb0bfd 755gitcvs.allbinary::
90948a42
MO
756 This is used if 'gitcvs.usecrlfattr' does not resolve
757 the correct '-kb' mode to use. If true, all
758 unresolved files are sent to the client in
759 mode '-kb'. This causes the client to treat them
760 as binary files, which suppresses any newline munging it
761 otherwise might do. Alternatively, if it is set to "guess",
762 then the contents of the file are examined to decide if
763 it is binary, similar to 'core.autocrlf'.
abbf5947 764
04752868
FL
765gitcvs.dbname::
766 Database used by git-cvsserver to cache revision information
767 derived from the git repository. The exact meaning depends on the
768 used database driver, for SQLite (which is the default driver) this
769 is a filename. Supports variable substitution (see
5162e697 770 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
771 Default: '%Ggitcvs.%m.sqlite'
772
773gitcvs.dbdriver::
774 Used Perl DBI driver. You can specify any available driver
775 for this here, but it might not work. git-cvsserver is tested
776 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
777 reported *not* to work with 'DBD::mysql'. Experimental feature.
778 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 779 See linkgit:git-cvsserver[1].
eabb0bfd 780
04752868
FL
781gitcvs.dbuser, gitcvs.dbpass::
782 Database user and password. Only useful if setting 'gitcvs.dbdriver',
783 since SQLite has no concept of database users and/or passwords.
784 'gitcvs.dbuser' supports variable substitution (see
5162e697 785 linkgit:git-cvsserver[1] for details).
04752868 786
6aeeffd1
JE
787gitcvs.dbTableNamePrefix::
788 Database table name prefix. Prepended to the names of any
789 database tables used, allowing a single database to be used
790 for several repositories. Supports variable substitution (see
791 linkgit:git-cvsserver[1] for details). Any non-alphabetic
792 characters will be replaced with underscores.
793
8a06a632
MO
794All gitcvs variables except for 'gitcvs.usecrlfattr' and
795'gitcvs.allbinary' can also be specified as
796'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
797is one of "ext" and "pserver") to make them apply only for the given
798access method.
04752868 799
d84ae0db
GH
800gui.commitmsgwidth::
801 Defines how wide the commit message window is in the
802 linkgit:git-gui[1]. "75" is the default.
803
804gui.diffcontext::
805 Specifies how many context lines should be used in calls to diff
806 made by the linkgit:git-gui[1]. The default is "5".
807
a2df1fb2
AG
808gui.encoding::
809 Specifies the default encoding to use for displaying of
810 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
811 It can be overridden by setting the 'encoding' attribute
812 for relevant files (see linkgit:gitattributes[5]).
813 If this option is not set, the tools default to the
814 locale encoding.
815
d84ae0db
GH
816gui.matchtrackingbranch::
817 Determines if new branches created with linkgit:git-gui[1] should
818 default to tracking remote branches with matching names or
819 not. Default: "false".
820
821gui.newbranchtemplate::
822 Is used as suggested name when creating new branches using the
823 linkgit:git-gui[1].
824
825gui.pruneduringfetch::
826 "true" if linkgit:git-gui[1] should prune tracking branches when
827 performing a fetch. The default value is "false".
828
829gui.trustmtime::
830 Determines if linkgit:git-gui[1] should trust the file modification
831 timestamp or not. By default the timestamps are not trusted.
832
833gui.spellingdictionary::
834 Specifies the dictionary used for spell checking commit messages in
835 the linkgit:git-gui[1]. When set to "none" spell checking is turned
836 off.
837
a2df1fb2
AG
838gui.fastcopyblame::
839 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
840 location detection. It makes blame significantly faster on huge
841 repositories at the expense of less thorough copy detection.
842
843gui.copyblamethreshold::
76bac890 844 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
845 detection, measured in alphanumeric characters. See the
846 linkgit:git-blame[1] manual for more information on copy detection.
847
848gui.blamehistoryctx::
849 Specifies the radius of history context in days to show in
850 linkgit:gitk[1] for the selected commit, when the `Show History
851 Context` menu item is invoked from 'git gui blame'. If this
852 variable is set to zero, the whole history is shown.
853
390c3480
AG
854guitool.<name>.cmd::
855 Specifies the shell command line to execute when the corresponding item
856 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
857 mandatory for every tool. The command is executed from the root of
858 the working directory, and in the environment it receives the name of
859 the tool as 'GIT_GUITOOL', the name of the currently selected file as
860 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
861 the head is detached, 'CUR_BRANCH' is empty).
862
863guitool.<name>.needsfile::
864 Run the tool only if a diff is selected in the GUI. It guarantees
865 that 'FILENAME' is not empty.
866
867guitool.<name>.noconsole::
868 Run the command silently, without creating a window to display its
869 output.
870
871guitool.<name>.norescan::
872 Don't rescan the working directory for changes after the tool
873 finishes execution.
874
875guitool.<name>.confirm::
876 Show a confirmation dialog before actually running the tool.
877
878guitool.<name>.argprompt::
879 Request a string argument from the user, and pass it to the tool
880 through the 'ARGS' environment variable. Since requesting an
881 argument implies confirmation, the 'confirm' option has no effect
882 if this is enabled. If the option is set to 'true', 'yes', or '1',
883 the dialog uses a built-in generic prompt; otherwise the exact
884 value of the variable is used.
885
886guitool.<name>.revprompt::
887 Request a single valid revision from the user, and set the
888 'REVISION' environment variable. In other aspects this option
889 is similar to 'argprompt', and can be used together with it.
890
891guitool.<name>.revunmerged::
892 Show only unmerged branches in the 'revprompt' subdialog.
893 This is useful for tools similar to merge or rebase, but not
894 for things like checkout or reset.
895
896guitool.<name>.title::
897 Specifies the title to use for the prompt dialog. The default
898 is the tool name.
899
900guitool.<name>.prompt::
901 Specifies the general prompt string to display at the top of
902 the dialog, before subsections for 'argprompt' and 'revprompt'.
903 The default value includes the actual command.
904
983a9eeb
CC
905help.browser::
906 Specify the browser that will be used to display help in the
907 'web' format. See linkgit:git-help[1].
908
909help.format::
910 Override the default help format used by linkgit:git-help[1].
911 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
912 the default. 'web' and 'html' are the same.
913
f0e90716
AR
914help.autocorrect::
915 Automatically correct and execute mistyped commands after
916 waiting for the given number of deciseconds (0.1 sec). If more
917 than one command can be deduced from the entered text, nothing
918 will be executed. If the value of this option is negative,
919 the corrected command will be executed immediately. If the
920 value is 0 - the command will be just shown but not executed.
921 This is the default.
922
9c5665aa
SV
923http.proxy::
924 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 925 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 926 on a per-remote basis; see remote.<name>.proxy
9c5665aa 927
1ab661dd
PB
928http.sslVerify::
929 Whether to verify the SSL certificate when fetching or pushing
37425065 930 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
931 variable.
932
933http.sslCert::
934 File containing the SSL certificate when fetching or pushing
37425065 935 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
936 variable.
937
938http.sslKey::
939 File containing the SSL private key when fetching or pushing
abda1ef5 940 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
941 variable.
942
943http.sslCAInfo::
944 File containing the certificates to verify the peer with when
abda1ef5 945 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
946 'GIT_SSL_CAINFO' environment variable.
947
948http.sslCAPath::
949 Path containing files with the CA certificates to verify the peer
37425065 950 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
951 by the 'GIT_SSL_CAPATH' environment variable.
952
953http.maxRequests::
abda1ef5 954 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
955 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
956
957http.lowSpeedLimit, http.lowSpeedTime::
958 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
959 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 960 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
961 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
962
3ea099d4
SK
963http.noEPSV::
964 A boolean which disables using of EPSV ftp command by curl.
befc9c42 965 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
966 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
967 environment variable. Default is false (curl will use EPSV).
968
1ab661dd
PB
969i18n.commitEncoding::
970 Character encoding the commit messages are stored in; git itself
971 does not care per se, but this information is necessary e.g. when
972 importing commits from emails or in the gitk graphical history
973 browser (and possibly at other places in the future or in other
5162e697 974 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 975
d2c11a38
JH
976i18n.logOutputEncoding::
977 Character encoding the commit messages are converted to when
ba020ef5 978 running 'git-log' and friends.
d2c11a38 979
b0f34c3d
MM
980imap::
981 The configuration variables in the 'imap' section are described
982 in linkgit:git-imap-send[1].
983
983a9eeb
CC
984instaweb.browser::
985 Specify the program that will be used to browse your working
986 repository in gitweb. See linkgit:git-instaweb[1].
987
988instaweb.httpd::
989 The HTTP daemon command-line to start gitweb on your working
990 repository. See linkgit:git-instaweb[1].
991
992instaweb.local::
993 If true the web server started by linkgit:git-instaweb[1] will
994 be bound to the local IP (127.0.0.1).
995
996instaweb.modulepath::
997 The module path for an apache httpd used by linkgit:git-instaweb[1].
998
999instaweb.port::
1000 The port number to bind the gitweb httpd to. See
1001 linkgit:git-instaweb[1].
1002
dd0ffd5b
HO
1003log.date::
1004 Set default date-time mode for the log command. Setting log.date
0979c106 1005 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
1006 following alternatives: {relative,local,default,iso,rfc,short}.
1007 See linkgit:git-log[1].
1008
0f03ca94
PB
1009log.showroot::
1010 If true, the initial commit will be shown as a big creation event.
1011 This is equivalent to a diff against an empty tree.
5162e697 1012 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1013 normally hide the root commit will now show it. True by default.
1014
d551a488
MSO
1015mailmap.file::
1016 The location of an augmenting mailmap file. The default
1017 mailmap, located in the root of the repository, is loaded
1018 first, then the mailmap file pointed to by this variable.
1019 The location of the mailmap file may be in a repository
1020 subdirectory, or somewhere outside of the repository itself.
1021 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1022
b5578f33 1023man.viewer::
b8322ea8 1024 Specify the programs that may be used to display help in the
b5578f33
CC
1025 'man' format. See linkgit:git-help[1].
1026
0bb64009
CC
1027man.<tool>.cmd::
1028 Specify the command to invoke the specified man viewer. The
1029 specified command is evaluated in shell with the man page
1030 passed as argument. (See linkgit:git-help[1].)
1031
7e8114c0
CC
1032man.<tool>.path::
1033 Override the path for the given tool that may be used to
1034 display help in the 'man' format. See linkgit:git-help[1].
1035
b0f34c3d 1036include::merge-config.txt[]
b5412484 1037
77680caa
JS
1038mergetool.<tool>.path::
1039 Override the path for the given tool. This is useful in case
1040 your tool is not in the PATH.
1041
964473a0
CB
1042mergetool.<tool>.cmd::
1043 Specify the command to invoke the specified merge tool. The
1044 specified command is evaluated in shell with the following
1045 variables available: 'BASE' is the name of a temporary file
1046 containing the common base of the files to be merged, if available;
1047 'LOCAL' is the name of a temporary file containing the contents of
1048 the file on the current branch; 'REMOTE' is the name of a temporary
1049 file containing the contents of the file from the branch being
1050 merged; 'MERGED' contains the name of the file to which the merge
1051 tool should write the results of a successful merge.
1052
1053mergetool.<tool>.trustExitCode::
1054 For a custom merge command, specify whether the exit code of
1055 the merge command can be used to determine whether the merge was
1056 successful. If this is not set to true then the merge target file
1057 timestamp is checked and the merge assumed to have been successful
1058 if the file has been updated, otherwise the user is prompted to
1059 indicate the success of the merge.
1060
44c36d1c
CB
1061mergetool.keepBackup::
1062 After performing a merge, the original file with conflict markers
1063 can be saved as a file with a `.orig` extension. If this variable
1064 is set to `false` then this file is not preserved. Defaults to
1065 `true` (i.e. keep the backup files).
1066
162eba8b
CB
1067mergetool.keepTemporaries::
1068 When invoking a custom merge tool, git uses a set of temporary
1069 files to pass to the tool. If the tool returns an error and this
1070 variable is set to `true`, then these temporary files will be
1071 preserved, otherwise they will be removed after the tool has
1072 exited. Defaults to `false`.
1073
682b451f
CB
1074mergetool.prompt::
1075 Prompt before each invocation of the merge resolution program.
1076
4812a93a 1077pack.window::
5162e697 1078 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
1079 window size is given on the command line. Defaults to 10.
1080
842aaf93 1081pack.depth::
5162e697 1082 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 1083 maximum depth is given on the command line. Defaults to 50.
842aaf93 1084
e93b15cd 1085pack.windowMemory::
5162e697 1086 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
1087 when no limit is given on the command line. The value can be
1088 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1089 limit.
1090
960ccca6
DH
1091pack.compression::
1092 An integer -1..9, indicating the compression level for objects
1093 in a pack file. -1 is the zlib default. 0 means no
1094 compression, and 1..9 are various speed/size tradeoffs, 9 being
1095 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
1096 not set, defaults to -1, the zlib default, which is "a default
1097 compromise between speed and compression (currently equivalent
1098 to level 6)."
960ccca6 1099
074b2eea 1100pack.deltaCacheSize::
02783075 1101 The maximum memory in bytes used for caching deltas in
5162e697 1102 linkgit:git-pack-objects[1].
074b2eea
MK
1103 A value of 0 means no limit. Defaults to 0.
1104
e3dfddb3 1105pack.deltaCacheLimit::
693b86ff 1106 The maximum size of a delta, that is cached in
5162e697 1107 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 1108
693b86ff
NP
1109pack.threads::
1110 Specifies the number of threads to spawn when searching for best
5162e697 1111 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
1112 be compiled with pthreads otherwise this option is ignored with a
1113 warning. This is meant to reduce packing time on multiprocessor
1114 machines. The required amount of memory for the delta search window
1115 is however multiplied by the number of threads.
833e3df1
AE
1116 Specifying 0 will cause git to auto-detect the number of CPU's
1117 and set the number of threads accordingly.
693b86ff 1118
4d00bda2
NP
1119pack.indexVersion::
1120 Specify the default pack index version. Valid values are 1 for
1121 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1122 the new pack index with capabilities for packs larger than 4 GB
1123 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
1124 packs. Version 2 is the default. Note that version 2 is enforced
1125 and this config option ignored whenever the corresponding pack is
1126 larger than 2 GB.
1127+
1128If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1129cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1130that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1131other side may give you a repository that cannot be accessed with your
1132older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1133you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1134the `{asterisk}.idx` file.
4d00bda2 1135
dbdbfec4 1136pack.packSizeLimit::
2b84b5a8
JS
1137 The default maximum size of a pack. This setting only affects
1138 packing to a file, i.e. the git:// protocol is unaffected. It
1139 can be overridden by the `\--max-pack-size` option of
1140 linkgit:git-repack[1].
1141
4370c2d6 1142pager.<cmd>::
32818085
JN
1143 Allows turning on or off pagination of the output of a
1144 particular git subcommand when writing to a tty. If
1145 `\--paginate` or `\--no-pager` is specified on the command line,
1146 it takes precedence over this option. To disable pagination for
1147 all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
4370c2d6 1148
1ab661dd
PB
1149pull.octopus::
1150 The default merge strategy to use when pulling multiple branches
1151 at once.
1152
1153pull.twohead::
1154 The default merge strategy to use when pulling a single branch.
1155
b0f34c3d
MM
1156receive.fsckObjects::
1157 If it is set to true, git-receive-pack will check all received
1158 objects. It will abort in the case of a malformed object or a
1159 broken link. The result of an abort are only dangling objects.
1160 Defaults to false.
1161
1162receive.unpackLimit::
1163 If the number of objects received in a push is below this
1164 limit then the objects will be unpacked into loose object
1165 files. However if the number of received objects equals or
1166 exceeds this limit then the received pack will be stored as
1167 a pack, after adding any missing delta bases. Storing the
1168 pack from a push can make the push operation complete faster,
1169 especially on slow filesystems. If not set, the value of
1170 `transfer.unpackLimit` is used instead.
1171
42fc11c1
JH
1172receive.denyDeletes::
1173 If set to true, git-receive-pack will deny a ref update that deletes
1174 the ref. Use this to prevent such a ref deletion via a push.
1175
1176receive.denyCurrentBranch::
1177 If set to true or "refuse", receive-pack will deny a ref update
1178 to the currently checked out branch of a non-bare repository.
1179 Such a push is potentially dangerous because it brings the HEAD
1180 out of sync with the index and working tree. If set to "warn",
1181 print a warning of such a push to stderr, but allow the push to
1182 proceed. If set to false or "ignore", allow such pushes with no
1183 message. Defaults to "warn".
1184
b0f34c3d
MM
1185receive.denyNonFastForwards::
1186 If set to true, git-receive-pack will deny a ref update which is
1187 not a fast forward. Use this to prevent such an update via a push,
1188 even if that push is forced. This configuration variable is
1189 set when initializing a shared repository.
1190
0cc6d346 1191remote.<name>.url::
5162e697
DM
1192 The URL of a remote repository. See linkgit:git-fetch[1] or
1193 linkgit:git-push[1].
0cc6d346 1194
14c98218
SV
1195remote.<name>.proxy::
1196 For remotes that require curl (http, https and ftp), the URL to
1197 the proxy to use for that remote. Set to the empty string to
1198 disable proxying for that remote.
1199
0cc6d346 1200remote.<name>.fetch::
5162e697
DM
1201 The default set of "refspec" for linkgit:git-fetch[1]. See
1202 linkgit:git-fetch[1].
0cc6d346
SB
1203
1204remote.<name>.push::
5162e697
DM
1205 The default set of "refspec" for linkgit:git-push[1]. See
1206 linkgit:git-push[1].
0cc6d346 1207
84bb2dfd
PB
1208remote.<name>.mirror::
1209 If true, pushing to this remote will automatically behave
1210 as if the `\--mirror` option was given on the command line.
1211
1918278e
TT
1212remote.<name>.skipDefaultUpdate::
1213 If true, this remote will be skipped by default when updating
5162e697 1214 using the update subcommand of linkgit:git-remote[1].
1918278e 1215
060aafc1 1216remote.<name>.receivepack::
5dee29ac 1217 The default program to execute on the remote side when pushing. See
79f43f3d 1218 option \--receive-pack of linkgit:git-push[1].
060aafc1 1219
5dee29ac
UKK
1220remote.<name>.uploadpack::
1221 The default program to execute on the remote side when fetching. See
79f43f3d 1222 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1223
047f636d 1224remote.<name>.tagopt::
79f43f3d
UKK
1225 Setting this value to \--no-tags disables automatic tag following when
1226 fetching from remote <name>
047f636d 1227
1918278e
TT
1228remotes.<group>::
1229 The list of remotes which are fetched by "git remote update
5162e697 1230 <group>". See linkgit:git-remote[1].
1918278e 1231
b6945f57 1232repack.usedeltabaseoffset::
22c79eab
NP
1233 By default, linkgit:git-repack[1] creates packs that use
1234 delta-base offset. If you need to share your repository with
1235 git older than version 1.4.4, either directly or via a dumb
1236 protocol such as http, then you need to set this option to
1237 "false" and repack. Access from old git versions over the
1238 native protocol are unaffected by this option.
b6945f57 1239
b0f34c3d
MM
1240rerere.autoupdate::
1241 When set to true, `git-rerere` updates the index with the
1242 resulting contents after it cleanly resolves conflicts using
1243 previously recorded resolution. Defaults to false.
1244
1245rerere.enabled::
1246 Activate recording of resolved conflicts, so that identical
1247 conflict hunks can be resolved automatically, should they
1248 be encountered again. linkgit:git-rerere[1] command is by
1249 default enabled if you create `rr-cache` directory under
1250 `$GIT_DIR`, but can be disabled by setting this option to false.
1251
1ab661dd 1252showbranch.default::
5162e697
DM
1253 The default set of branches for linkgit:git-show-branch[1].
1254 See linkgit:git-show-branch[1].
1ab661dd 1255
46f721c8 1256status.relativePaths::
5162e697 1257 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1258 current directory. Setting this variable to `false` shows paths
1259 relative to the repository root (this was the default for git
1260 prior to v1.5.4).
1261
d6293d1f
MSO
1262status.showUntrackedFiles::
1263 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1264 files which are not currently tracked by Git. Directories which
1265 contain only untracked files, are shown with the directory name
1266 only. Showing untracked files means that Git needs to lstat() all
1267 all the files in the whole repository, which might be slow on some
1268 systems. So, this variable controls how the commands displays
1269 the untracked files. Possible values are:
1270+
1271--
1272 - 'no' - Show no untracked files
1273 - 'normal' - Shows untracked files and directories
1274 - 'all' - Shows also individual files in untracked directories.
1275--
1276+
1277If this variable is not specified, it defaults to 'normal'.
1278This variable can be overridden with the -u|--untracked-files option
1279of linkgit:git-status[1] and linkgit:git-commit[1].
1280
ce1a79b6 1281tar.umask::
687157c7
RS
1282 This variable can be used to restrict the permission bits of
1283 tar archive entries. The default is 0002, which turns off the
1284 world write bit. The special value "user" indicates that the
1285 archiving user's umask will be used instead. See umask(2) and
5162e697 1286 linkgit:git-archive[1].
ce1a79b6 1287
b0f34c3d
MM
1288transfer.unpackLimit::
1289 When `fetch.unpackLimit` or `receive.unpackLimit` are
1290 not set, the value of this variable is used instead.
1291 The default value is 100.
1292
55029ae4
DB
1293url.<base>.insteadOf::
1294 Any URL that starts with this value will be rewritten to
1295 start, instead, with <base>. In cases where some site serves a
1296 large number of repositories, and serves them with multiple
1297 access methods, and some users need to use different access
1298 methods, this feature allows people to specify any of the
1299 equivalent URLs and have git automatically rewrite the URL to
1300 the best alternative for the particular user, even for a
844112ca
JH
1301 never-before-seen repository on the site. When more than one
1302 insteadOf strings match a given URL, the longest match is used.
55029ae4 1303
1ab661dd
PB
1304user.email::
1305 Your email address to be recorded in any newly created commits.
28a94f88 1306 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1307 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1308
1309user.name::
1310 Your full name to be recorded in any newly created commits.
abda1ef5 1311 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1312 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1313
d67778ec 1314user.signingkey::
5162e697 1315 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1316 automatically when creating a signed tag, you can override the
1317 default selection with this variable. This option is passed
1318 unchanged to gpg's --local-user parameter, so you may specify a key
1319 using any method that gpg supports.
1320
983a9eeb
CC
1321web.browser::
1322 Specify a web browser that may be used by some commands.
1323 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1324 may use it.