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