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