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