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