Merge branch 'jk/notes-merge-config'
[git/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
a5285b6c
JH
17variables may appear multiple times; we say then that the variable is
18multivalued.
1ab661dd 19
e136f33b
JN
20Syntax
21~~~~~~
22
1ab661dd 23The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
24ignored. The '#' and ';' characters begin comments to the end of line,
25blank lines are ignored.
26
27The file consists of sections and variables. A section begins with
28the name of the section in square brackets and continues until the next
05c3e5c7 29section begins. Section names are case-insensitive. Only alphanumeric
dcb11263 30characters, `-` and `.` are allowed in section names. Each variable
773002a7
SB
31must belong to some section, which means that there must be a section
32header before the first setting of a variable.
e136f33b
JN
33
34Sections can be further divided into subsections. To begin a subsection
35put its name in double quotes, separated by space from the section name,
773002a7 36in the section header, like in the example below:
e136f33b
JN
37
38--------
39 [section "subsection"]
40
41--------
42
b7ee2266 43Subsection names are case sensitive and can contain any characters except
05c3e5c7
JH
44newline (doublequote `"` and backslash can be included by escaping them
45as `\"` and `\\`, respectively). Section headers cannot span multiple
e136f33b
JN
46lines. Variables may belong directly to a section or to a given subsection.
47You can have `[section]` if you have `[section "subsection"]`, but you
48don't need to.
49
f7376329
CMN
50There is also a deprecated `[section.subsection]` syntax. With this
51syntax, the subsection name is converted to lower-case and is also
52compared case sensitively. These subsection names follow the same
53restrictions as section names.
e136f33b 54
2ceb639f
NS
55All the other lines (and the remainder of the line after the section
56header) are recognized as setting variables, in the form
1c448b3b
JH
57'name = value' (or just 'name', which is a short-hand to say that
58the variable is the boolean "true").
e0a4aae8 59The variable names are case-insensitive, allow only alphanumeric characters
a5285b6c 60and `-`, and must start with an alphabetic character.
e136f33b 61
ff5507ed
JH
62A line that defines a value can be continued to the next line by
63ending it with a `\`; the backquote and the end-of-line are
64stripped. Leading whitespaces after 'name =', the remainder of the
65line after the first comment character '#' or ';', and trailing
66whitespaces of the line are discarded unless they are enclosed in
67double quotes. Internal whitespaces within the value are retained
68verbatim.
e136f33b 69
ff5507ed
JH
70Inside double quotes, double quote `"` and backslash `\` characters
71must be escaped: use `\"` for `"` and `\\` for `\`.
e136f33b 72
dcb11263
CJ
73The following escape sequences (beside `\"` and `\\`) are recognized:
74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
a58088ab
JL
75and `\b` for backspace (BS). Other char escape sequences (including octal
76escape sequences) are invalid.
e136f33b 77
1ab661dd 78
9b25a0b5
JK
79Includes
80~~~~~~~~
81
82You can include one config file from another by setting the special
83`include.path` variable to the name of the file to be included. The
84included file is expanded immediately, as if its contents had been
85found at the location of the include directive. If the value of the
86`include.path` variable is a relative path, the path is considered to be
87relative to the configuration file in which the include directive was
9a7b0bca
JK
88found. The value of `include.path` is subject to tilde expansion: `~/`
89is expanded to the value of `$HOME`, and `~user/` to the specified
4c0a89fc 90user's home directory. See below for examples.
9b25a0b5 91
1ab661dd
PB
92Example
93~~~~~~~
94
95 # Core variables
96 [core]
97 ; Don't trust file modes
98 filemode = false
99
100 # Our diff algorithm
101 [diff]
6bb9e51b 102 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
103 renames = true
104
910c00c8
AK
105 [branch "devel"]
106 remote = origin
107 merge = refs/heads/devel
108
e136f33b
JN
109 # Proxy settings
110 [core]
29093c28 111 gitProxy="ssh" for "kernel.org"
e136f33b 112 gitProxy=default-proxy ; for the rest
910c00c8 113
9b25a0b5
JK
114 [include]
115 path = /path/to/foo.inc ; include by absolute path
116 path = foo ; expand "foo" relative to the current file
4c0a89fc 117 path = ~/foo ; expand "foo" in your $HOME directory
9b25a0b5 118
5f7b91ba
JH
119
120Values
121~~~~~~
122
123Values of many variables are treated as a simple string, but there
124are variables that take values of specific types and there are rules
125as to how to spell them.
126
127boolean::
128
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
131 case-insensitive.
132
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134 or `1`. Also, a variable defined without `= <value>`
135 is taken as true.
136
137 false;; Boolean false can be spelled as `no`, `off`,
138 `false`, or `0`.
139+
140When converting value to the canonical form using '--bool' type
141specifier; 'git config' will ensure that the output is "true" or
142"false" (spelled in lowercase).
143
144integer::
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
148
b92c1a28
JH
149color::
150 The value for a variables that takes a color is a list of
151 colors (at most two) and attributes (at most one), separated
152 by spaces. The colors accepted are `normal`, `black`,
153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155 `reverse`. The first color given is the foreground; the
156 second is the background. The position of the attribute, if
5f456b3c
JH
157 any, doesn't matter. Attributes may be turned off specifically
158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
159+
160Colors (foreground and background) may also be given as numbers between
1610 and 255; these use ANSI 256-color mode (but note that not all
162terminals may support this). If your terminal supports it, you may also
163specify 24-bit RGB values as hex, like `#ff0ab3`.
5ee87585
JH
164+
165The attributes are meant to be reset at the beginning of each item
166in the colored output, so setting color.decorate.branch to `black`
167will paint that branch name in a plain `black`, even if the previous
168thing on the same output line (e.g. opening parenthesis before the
169list of branch names in `log --decorate` output) is set to be
170painted with `bold` or some other attribute.
b92c1a28 171
5f7b91ba 172
1ab661dd
PB
173Variables
174~~~~~~~~~
175
176Note that this list is non-comprehensive and not necessarily complete.
b8936cf0 177For command-specific variables, you will find a more detailed description
93728b23
CA
178in the appropriate manual page.
179
180Other git-related tools may and do use their own variables. When
181inventing new variables for use in your own tool, make sure their
182names do not conflict with those that are used by Git itself and
183other popular tools, and describe them in your documentation.
184
1ab661dd 185
75194438 186advice.*::
26e94af0
JH
187 These variables control various optional help messages designed to
188 aid new users. All 'advice.*' variables default to 'true', and you
189 can tell Git that you do not need help by setting these to 'false':
75194438
JK
190+
191--
1184564e 192 pushUpdateRejected::
f25950f3 193 Set this variable to 'false' if you want to disable
009055f3 194 'pushNonFFCurrent',
75e5c0dc
JH
195 'pushNonFFMatching', 'pushAlreadyExists',
196 'pushFetchFirst', and 'pushNeedsForce'
b4505682 197 simultaneously.
f25950f3
CT
198 pushNonFFCurrent::
199 Advice shown when linkgit:git-push[1] fails due to a
200 non-fast-forward update to the current branch.
f25950f3
CT
201 pushNonFFMatching::
202 Advice shown when you ran linkgit:git-push[1] and pushed
203 'matching refs' explicitly (i.e. you used ':', or
204 specified a refspec that isn't your current branch) and
205 it resulted in a non-fast-forward error.
b4505682
CR
206 pushAlreadyExists::
207 Shown when linkgit:git-push[1] rejects an update that
208 does not qualify for fast-forwarding (e.g., a tag.)
75e5c0dc
JH
209 pushFetchFirst::
210 Shown when linkgit:git-push[1] rejects an update that
211 tries to overwrite a remote ref that points at an
212 object we do not have.
213 pushNeedsForce::
214 Shown when linkgit:git-push[1] rejects an update that
215 tries to overwrite a remote ref that points at an
a8a5406a
RH
216 object that is not a commit-ish, or make the remote
217 ref point at an object that is not a commit-ish.
edf563fb 218 statusHints::
83c750ac 219 Show directions on how to proceed from the current
552755a8 220 state in the output of linkgit:git-status[1], in
83c750ac 221 the template shown when writing commit messages in
552755a8
MM
222 linkgit:git-commit[1], and in the help message shown
223 by linkgit:git-checkout[1] when switching branch.
6a38ef2c
NTND
224 statusUoption::
225 Advise to consider using the `-u` option to linkgit:git-status[1]
226 when the command takes more than 2 seconds to enumerate untracked
227 files.
4c371f91
MM
228 commitBeforeMerge::
229 Advice shown when linkgit:git-merge[1] refuses to
6b677a28 230 merge to avoid overwriting local changes.
d38a30df 231 resolveConflict::
4f021b34 232 Advice shown by various commands when conflicts
d38a30df 233 prevent the operation from being performed.
b706fcfe
JK
234 implicitIdentity::
235 Advice on how to set your identity configuration when
236 your information is guessed from the system username and
26e94af0 237 domain name.
13be3e31 238 detachedHead::
26e94af0 239 Advice shown when you used linkgit:git-checkout[1] to
13be3e31 240 move to the detach HEAD state, to instruct how to create
26e94af0 241 a local branch after the fact.
14bf2d58
PG
242 amWorkDir::
243 Advice that shows the location of the patch file when
244 linkgit:git-am[1] fails to apply it.
7e309446
MLM
245 rmHints::
246 In case of failure in the output of linkgit:git-rm[1],
247 show directions on how to proceed from the current state.
75194438
JK
248--
249
1ab661dd 250core.fileMode::
ecdab412
TB
251 Tells Git if the executable bit of files in the working tree
252 is to be honored.
7b357240 253+
ecdab412
TB
254Some filesystems lose the executable bit when a file that is
255marked as executable is checked out, or checks out an
256non-executable file with executable bit on.
257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258to see if it handles the executable bit correctly
259and this variable is automatically set as necessary.
260+
261A repository, however, may be on a filesystem that handles
262the filemode correctly, and this variable is set to 'true'
263when created, but later may be made accessible from another
264environment that loses the filemode (e.g. exporting ext4 via
265CIFS mount, visiting a Cygwin created repository with
266Git for Windows or Eclipse).
267In such a case it may be necessary to set this variable to 'false'.
268See linkgit:git-update-index[1].
269+
270The default is true (when core.filemode is not specified in the config file).
1ab661dd 271
da0005b8 272core.ignoreCase::
7b357240 273 If true, this option enables various workarounds to enable
2de9b711 274 Git to work better on filesystems that are not case sensitive,
7b357240 275 like FAT. For example, if a directory listing finds
2de9b711 276 "makefile" when Git expects "Makefile", Git will assume
7b357240
MO
277 it is really the same file, and continue to remember it as
278 "Makefile".
279+
280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
da0005b8 281will probe and set core.ignoreCase true if appropriate when the repository
7b357240
MO
282is created.
283
da0005b8 284core.precomposeUnicode::
2de9b711 285 This option is only used by Mac OS implementation of Git.
da0005b8 286 When core.precomposeUnicode=true, Git reverts the unicode decomposition
76759c7d
TB
287 of filenames done by Mac OS. This is useful when sharing a repository
288 between Mac OS and Linux or Windows.
2de9b711
TA
289 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290 When false, file names are handled fully transparent by Git,
291 which is backward compatible with older versions of Git.
76759c7d 292
a42643aa
JK
293core.protectHFS::
294 If set to true, do not allow checkout of paths that would
295 be considered equivalent to `.git` on an HFS+ filesystem.
296 Defaults to `true` on Mac OS, and `false` elsewhere.
297
2b4c6efc
JS
298core.protectNTFS::
299 If set to true, do not allow checkout of paths that would
300 cause problems with the NTFS filesystem, e.g. conflict with
301 8.3 "short" names.
302 Defaults to `true` on Windows, and `false` elsewhere.
303
1ce4790b
AR
304core.trustctime::
305 If false, the ctime differences between the index and the
f7d650c0 306 working tree are ignored; useful when the inode change time
1ce4790b
AR
307 is regularly modified by something outside Git (file system
308 crawlers and some backup systems).
309 See linkgit:git-update-index[1]. True by default.
310
da0005b8 311core.checkStat::
c08e4d5b
RR
312 Determines which stat fields to match between the index
313 and work tree. The user can set this to 'default' or
314 'minimal'. Default (or explicitly 'default'), is to check
315 all fields, including the sub-second part of mtime and ctime.
316
da0005b8 317core.quotePath::
5833d730
JN
318 The commands that output paths (e.g. 'ls-files',
319 'diff'), when not given the `-z` option, will quote
9378c161
JH
320 "unusual" characters in the pathname by enclosing the
321 pathname in a double-quote pair and with backslashes the
322 same way strings in C source code are quoted. If this
323 variable is set to false, the bytes higher than 0x80 are
324 not quoted but output as verbatim. Note that double
325 quote, backslash and control characters are always
326 quoted without `-z` regardless of the setting of this
327 variable.
328
942e7747
EB
329core.eol::
330 Sets the line ending type to use in the working directory for
331 files that have the `text` property set. Alternatives are
332 'lf', 'crlf' and 'native', which uses the platform's native
333 line ending. The default value is `native`. See
334 linkgit:gitattributes[5] for more information on end-of-line
335 conversion.
5cb71f82 336
21e5ad50 337core.safecrlf::
2de9b711 338 If true, makes Git check if converting `CRLF` is reversible when
fd6cce9e 339 end-of-line conversion is active. Git will verify if a command
21e5ad50
SP
340 modifies a file in the work tree either directly or indirectly.
341 For example, committing a file followed by checking out the
342 same file should yield the original file in the work tree. If
343 this is not the case for the current setting of
2de9b711
TA
344 `core.autocrlf`, Git will reject the file. The variable can
345 be set to "warn", in which case Git will only warn about an
21e5ad50
SP
346 irreversible conversion but continue the operation.
347+
348CRLF conversion bears a slight chance of corrupting data.
2de9b711 349When it is enabled, Git will convert CRLF to LF during commit and LF to
21e5ad50 350CRLF during checkout. A file that contains a mixture of LF and
2de9b711 351CRLF before the commit cannot be recreated by Git. For text
21e5ad50
SP
352files this is the right thing to do: it corrects line endings
353such that we have only LF line endings in the repository.
354But for binary files that are accidentally classified as text the
355conversion can corrupt data.
356+
357If you recognize such corruption early you can easily fix it by
358setting the conversion type explicitly in .gitattributes. Right
359after committing you still have the original file in your work
360tree and this file is not yet corrupted. You can explicitly tell
2de9b711 361Git that this file is binary and Git will handle the file
21e5ad50
SP
362appropriately.
363+
364Unfortunately, the desired effect of cleaning up text files with
365mixed line endings and the undesired effect of corrupting binary
366files cannot be distinguished. In both cases CRLFs are removed
367in an irreversible way. For text files this is the right thing
368to do because CRLFs are line endings, while for binary files
369converting CRLFs corrupts data.
370+
371Note, this safety check does not mean that a checkout will generate a
372file identical to the original file for a different setting of
942e7747
EB
373`core.eol` and `core.autocrlf`, but only for the current one. For
374example, a text file with `LF` would be accepted with `core.eol=lf`
375and could later be checked out with `core.eol=crlf`, in which case the
21e5ad50
SP
376resulting file would contain `CRLF`, although the original file
377contained `LF`. However, in both work trees the line endings would be
378consistent, that is either all `LF` or all `CRLF`, but never mixed. A
379file with mixed line endings would be reported by the `core.safecrlf`
380mechanism.
381
942e7747
EB
382core.autocrlf::
383 Setting this variable to "true" is almost the same as setting
384 the `text` attribute to "auto" on all files except that text
385 files are not guaranteed to be normalized: files that contain
386 `CRLF` in the repository will not be touched. Use this
387 setting if you want to have `CRLF` line endings in your
388 working directory even though the repository does not have
389 normalized line endings. This variable can be set to 'input',
390 in which case no output conversion is performed.
391
78a8d641
JS
392core.symlinks::
393 If false, symbolic links are checked out as small plain files that
5162e697
DM
394 contain the link text. linkgit:git-update-index[1] and
395 linkgit:git-add[1] will not change the recorded type to regular
78a8d641 396 file. Useful on filesystems like FAT that do not support
7b357240
MO
397 symbolic links.
398+
399The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
400will probe and set core.symlinks false if appropriate when the repository
401is created.
78a8d641 402
1ab661dd
PB
403core.gitProxy::
404 A "proxy command" to execute (as 'command host port') instead
405 of establishing direct connection to the remote server when
2de9b711 406 using the Git protocol for fetching. If the variable value is
1ab661dd
PB
407 in the "COMMAND for DOMAIN" format, the command is applied only
408 on hostnames ending with the specified domain string. This variable
409 may be set multiple times and is matched in the given order;
410 the first match wins.
b8936cf0
FD
411+
412Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413(which always applies universally, without the special "for"
414handling).
642d0844
ES
415+
416The special string `none` can be used as the proxy command to
417specify that no proxy be used for a given domain pattern.
418This is useful for excluding servers inside a firewall from
419proxy use, while defaulting to a common proxy for external domains.
1ab661dd
PB
420
421core.ignoreStat::
92be938e
PO
422 If true, Git will avoid using lstat() calls to detect if files have
423 changed by setting the "assume-unchanged" bit for those tracked files
424 which it has updated identically in both the index and working tree.
425+
426When files are modified outside of Git, the user will need to stage
427the modified files explicitly (e.g. see 'Examples' section in
428linkgit:git-update-index[1]).
429Git will not normally detect changes to those files.
430+
431This is useful on systems where lstat() calls are very slow, such as
432CIFS/Microsoft Windows.
433+
434False by default.
1ab661dd 435
9f0bb90d
JH
436core.preferSymlinkRefs::
437 Instead of the default "symref" format for HEAD
438 and other symbolic reference files, use symbolic links.
439 This is sometimes needed to work with old scripts that
440 expect HEAD to be a symbolic link.
1ab661dd 441
e4a15f40
SP
442core.bare::
443 If true this repository is assumed to be 'bare' and has no
444 working directory associated with it. If this is the case a
445 number of commands that require a working directory will be
5162e697 446 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 447+
5162e697
DM
448This setting is automatically guessed by linkgit:git-clone[1] or
449linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
450repository that ends in "/.git" is assumed to be not bare (bare =
451false), while all other repositories are assumed to be bare (bare
452= true).
453
892c41b9 454core.worktree::
ea472c1e 455 Set the path to the root of the working tree.
31e26ebc
NTND
456 If GIT_COMMON_DIR environment variable is set, core.worktree
457 is ignored and not used for determining the root of working tree.
06ada152 458 This can be overridden by the GIT_WORK_TREE environment
06ab60c0 459 variable and the '--work-tree' command-line option.
d424a47e 460 The value can be an absolute path or relative to the path to
ea472c1e
JH
461 the .git directory, which is either specified by --git-dir
462 or GIT_DIR, or automatically discovered.
463 If --git-dir or GIT_DIR is specified but none of
302cc11a 464 --work-tree, GIT_WORK_TREE and core.worktree is specified,
ea472c1e 465 the current working directory is regarded as the top level
98acf759 466 of your working tree.
ea472c1e
JH
467+
468Note that this variable is honored even when set in a configuration
469file in a ".git" subdirectory of a directory and its value differs
470from the latter directory (e.g. "/path/to/.git/config" has
471core.worktree set to "/different/path"), which is most likely a
2de9b711 472misconfiguration. Running Git commands in the "/path/to" directory will
ea472c1e
JH
473still use "/different/path" as the root of the work tree and can cause
474confusion unless you know what you are doing (e.g. you are creating a
475read-only snapshot of the same index to a location different from the
476repository's usual working tree).
892c41b9 477
6de08ae6 478core.logAllRefUpdates::
14cd5607 479 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5 480 "$GIT_DIR/logs/<ref>", by appending the new and old
d5fa1f1a 481 SHA-1, the date/time and the reason of the update, but
4057deb5
JH
482 only when the file exists. If this configuration
483 variable is set to true, missing "$GIT_DIR/logs/<ref>"
cd8e3711
BW
484 file is automatically created for branch heads (i.e. under
485 refs/heads/), remote refs (i.e. under refs/remotes/),
486 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
a862f97e
JH
487+
488This information can be used to determine what commit
489was the tip of a branch "2 days ago".
490+
491This value is true by default in a repository that has
492a working directory associated with it, and false by
493default in a bare repository.
6de08ae6 494
1ab661dd
PB
495core.repositoryFormatVersion::
496 Internal variable identifying the repository format and layout
497 version.
498
499core.sharedRepository::
d5dc6a76
JF
500 When 'group' (or 'true'), the repository is made shareable between
501 several users in a group (making sure all the files and objects are
502 group-writable). When 'all' (or 'world' or 'everybody'), the
503 repository will be readable by all users, additionally to being
2de9b711 504 group-shareable. When 'umask' (or 'false'), Git will use permissions
06cbe855
HO
505 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
506 files in the repository will have this mode value. '0xxx' will override
098082fb
JH
507 user's umask value (whereas the other options will only override
508 requested parts of the user's umask value). Examples: '0660' will make
509 the repo read/write-able for the owner and group, but inaccessible to
510 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
06cbe855
HO
511 repository that is group-readable but not group-writable.
512 See linkgit:git-init[1]. False by default.
1ab661dd
PB
513
514core.warnAmbiguousRefs::
2de9b711 515 If true, Git will warn you if the ref name you passed it is ambiguous
48dfe969 516 and might match multiple refs in the repository. True by default.
1ab661dd 517
3d3e95af 518core.compression::
960ccca6
DH
519 An integer -1..9, indicating a default compression level.
520 -1 is the zlib default. 0 means no compression,
521 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309 522 If set, this provides a default to other compression variables,
da0005b8 523 such as 'core.looseCompression' and 'pack.compression'.
960ccca6 524
da0005b8 525core.looseCompression::
12f6c308 526 An integer -1..9, indicating the compression level for objects that
960ccca6 527 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 528 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 529 slowest. If not set, defaults to core.compression. If that is
de1b2460 530 not set, defaults to 1 (best speed).
12f6c308 531
60bb8b14
SP
532core.packedGitWindowSize::
533 Number of bytes of a pack file to map into memory in a
534 single mapping operation. Larger window sizes may allow
535 your system to process a smaller number of large pack files
536 more quickly. Smaller window sizes will negatively affect
eb92242f 537 performance due to increased calls to the operating system's
60bb8b14 538 memory manager, but may improve performance when accessing
22bac0ea
SP
539 a large number of large pack files.
540+
541Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
542MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
543be reasonable for all users/operating systems. You probably do
544not need to adjust this value.
eb92242f
SP
545+
546Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 547
77ccc5bb
SP
548core.packedGitLimit::
549 Maximum number of bytes to map simultaneously into memory
550 from pack files. If Git needs to access more than this many
551 bytes at once to complete an operation it will unmap existing
552 regions to reclaim virtual address space within the process.
22bac0ea
SP
553+
554Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
555This should be reasonable for all users/operating systems, except on
556the largest projects. You probably do not need to adjust this value.
eb92242f
SP
557+
558Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 559
18bdec11
SP
560core.deltaBaseCacheLimit::
561 Maximum number of bytes to reserve for caching base objects
6b677a28 562 that may be referenced by multiple deltified objects. By storing the
18bdec11
SP
563 entire decompressed base objects in a cache Git is able
564 to avoid unpacking and decompressing frequently used base
565 objects multiple times.
566+
4874f544 567Default is 96 MiB on all platforms. This should be reasonable
18bdec11
SP
568for all users/operating systems, except on the largest projects.
569You probably do not need to adjust this value.
570+
571Common unit suffixes of 'k', 'm', or 'g' are supported.
572
5eef828b
SP
573core.bigFileThreshold::
574 Files larger than this size are stored deflated, without
575 attempting delta compression. Storing large files without
576 delta compression avoids excessive memory usage, at the
6bf3b813
NTND
577 slight expense of increased disk usage. Additionally files
578 larger than this size are always treated as binary.
5eef828b
SP
579+
580Default is 512 MiB on all platforms. This should be reasonable
581for most projects as source code and other text files can still
582be delta compressed, but larger binary media files won't be.
583+
584Common unit suffixes of 'k', 'm', or 'g' are supported.
5eef828b 585
da0005b8 586core.excludesFile::
0ba956d3 587 In addition to '.gitignore' (per-directory) and
2de9b711 588 '.git/info/exclude', Git looks into this file for patterns
6cf378f0
JK
589 of files which are not meant to be tracked. "`~/`" is expanded
590 to the value of `$HOME` and "`~user/`" to the specified user's
dc79687e
HKNN
591 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
592 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
593 is used instead. See linkgit:gitignore[5].
0ba956d3 594
da0005b8 595core.askPass::
d3e7da89
AK
596 Some commands (e.g. svn and http interfaces) that interactively
597 ask for a password can be told to use an external program given
453842c9
KF
598 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
599 environment variable. If not set, fall back to the value of the
600 'SSH_ASKPASS' environment variable or, failing that, a simple password
601 prompt. The external program shall be given a suitable prompt as
06ab60c0 602 command-line argument and write the password on its STDOUT.
d3e7da89 603
da0005b8 604core.attributesFile::
6df42ab9 605 In addition to '.gitattributes' (per-directory) and
2de9b711 606 '.git/info/attributes', Git looks into this file for attributes
6df42ab9 607 (see linkgit:gitattributes[5]). Path expansions are made the same
da0005b8 608 way as for `core.excludesFile`. Its default value is
684e40f6
HKNN
609 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
610 set or empty, $HOME/.config/git/attributes is used instead.
6df42ab9 611
ef0c2abf
AR
612core.editor::
613 Commands such as `commit` and `tag` that lets you edit
02783075 614 messages by launching an editor uses the value of this
ef0c2abf 615 variable when it is set, and the environment variable
b4479f07 616 `GIT_EDITOR` is not set. See linkgit:git-var[1].
ef0c2abf 617
da0005b8 618core.commentChar::
eff80a9f
JH
619 Commands such as `commit` and `tag` that lets you edit
620 messages consider a line that begins with this character
621 commented, and removes them after the editor returns
622 (default '#').
84c9dc2c
NTND
623+
624If set to "auto", `git-commit` would select a character that is not
625the beginning character of any line in existing commit messages.
eff80a9f 626
f4ab4f3a
MH
627core.packedRefsTimeout::
628 The length of time, in milliseconds, to retry when trying to
629 lock the `packed-refs` file. Value 0 means not to retry at
630 all; -1 means to try indefinitely. Default is 1000 (i.e.,
631 retry for 1 second).
632
821881d8 633sequence.editor::
3322ad42 634 Text editor used by `git rebase -i` for editing the rebase instruction file.
821881d8
PO
635 The value is meant to be interpreted by the shell when it is used.
636 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
637 When not configured the default commit message editor is used instead.
638
54adf370 639core.pager::
97d01f2a
JH
640 Text viewer for use by Git commands (e.g., 'less'). The value
641 is meant to be interpreted by the shell. The order of preference
642 is the `$GIT_PAGER` environment variable, then `core.pager`
643 configuration, then `$PAGER`, and then the default chosen at
644 compile time (usually 'less').
645+
b3275838 646When the `LESS` environment variable is unset, Git sets it to `FRX`
97d01f2a
JH
647(if `LESS` environment variable is set, Git does not change it at
648all). If you want to selectively override Git's default setting
b3275838 649for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
97d01f2a 650be passed to the shell by Git, which will translate the final
b3275838
MM
651command to `LESS=FRX less -S`. The environment does not set the
652`S` option but the command line does, instructing less to truncate
653long lines. Similarly, setting `core.pager` to `less -+F` will
654deactivate the `F` option specified by the environment from the
655command-line, deactivating the "quit if one screen" behavior of
656`less`. One can specifically activate some flags for particular
657commands: for example, setting `pager.blame` to `less -S` enables
658line truncation only for `git blame`.
e54c1f2d
JN
659+
660Likewise, when the `LV` environment variable is unset, Git sets it
661to `-c`. You can override this setting by exporting `LV` with
662another value or setting `core.pager` to `lv +c`.
54adf370 663
91af7ae5
JH
664core.whitespace::
665 A comma separated list of common whitespace problems to
0b444cdb
TR
666 notice. 'git diff' will use `color.diff.whitespace` to
667 highlight them, and 'git apply --whitespace=error' will
c921cc92
JH
668 consider them as errors. You can prefix `-` to disable
669 any of them (e.g. `-trailing-space`):
91af7ae5 670+
aeb84b05 671* `blank-at-eol` treats trailing whitespaces at the end of the line
91af7ae5
JH
672 as an error (enabled by default).
673* `space-before-tab` treats a space character that appears immediately
674 before a tab character in the initial indent part of the line as an
675 error (enabled by default).
2ce4fee8
WL
676* `indent-with-non-tab` treats a line that is indented with space
677 characters instead of the equivalent tabs as an error (not enabled by
678 default).
3e3ec2ab
CW
679* `tab-in-indent` treats a tab character in the initial indent part of
680 the line as an error (not enabled by default).
77b15bbd
JH
681* `blank-at-eof` treats blank lines added at the end of file as an error
682 (enabled by default).
aeb84b05
JH
683* `trailing-space` is a short-hand to cover both `blank-at-eol` and
684 `blank-at-eof`.
b2979ff5
JH
685* `cr-at-eol` treats a carriage-return at the end of line as
686 part of the line terminator, i.e. with it, `trailing-space`
687 does not trigger if the character before such a carriage-return
688 is not a whitespace (not enabled by default).
f4b05a49 689* `tabwidth=<n>` tells how many character positions a tab occupies; this
2de9b711 690 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
f4b05a49 691 errors. The default tab width is 8. Allowed values are 1 to 63.
91af7ae5 692
da0005b8 693core.fsyncObjectFiles::
aafe9fba
LT
694 This boolean will enable 'fsync()' when writing object files.
695+
696This is a total waste of time and effort on a filesystem that orders
697data writes properly, but can be useful for filesystems that do not use
698journalling (traditional UNIX filesystems) or that only journal metadata
699and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
700
da0005b8 701core.preloadIndex::
671c9b7e
LT
702 Enable parallel index preload for operations like 'git diff'
703+
704This can speed up operations like 'git diff' and 'git status' especially
705on filesystems like NFS that have weak caching semantics and thus
299e2987 706relatively high IO latencies. When enabled, Git will do the
671c9b7e 707index comparison to the filesystem data in parallel, allowing
299e2987 708overlapping IO's. Defaults to true.
671c9b7e 709
348df166
JS
710core.createObject::
711 You can set this to 'link', in which case a hardlink followed by
712 a delete of the source are used to make sure that object creation
713 will not overwrite existing objects.
714+
715On some file system/operating system combinations, this is unreliable.
716Set this config setting to 'rename' there; However, This will remove the
717check that makes sure that existing object files will not get overwritten.
be66a6c4 718
a97a7468
JS
719core.notesRef::
720 When showing commit messages, also show notes which are stored in
9eb3f816
JN
721 the given ref. The ref must be fully qualified. If the given
722 ref does not exist, it is not an error but means that no
723 notes should be printed.
a97a7468 724+
9eb3f816
JN
725This setting defaults to "refs/notes/commits", and it can be overridden by
726the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
a97a7468 727
08aefc9e
NTND
728core.sparseCheckout::
729 Enable "sparse checkout" feature. See section "Sparse checkout" in
730 linkgit:git-read-tree[1] for more information.
731
a71f09fe 732core.abbrev::
dce96489
LT
733 Set the length object names are abbreviated to. If unspecified,
734 many commands abbreviate to 7 hexdigits, which may not be enough
735 for abbreviated object names to stay unique for sufficiently long
736 time.
737
6b3020a2 738add.ignoreErrors::
502e7f98 739add.ignore-errors (deprecated)::
0b444cdb 740 Tells 'git add' to continue adding files when some files cannot be
13bd2134 741 added due to indexing errors. Equivalent to the '--ignore-errors'
394e1505
JH
742 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
743 as it does not follow the usual naming convention for configuration
744 variables.
13bd2134 745
4514ad4f 746alias.*::
5162e697 747 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
748 after defining "alias.last = cat-file commit HEAD", the invocation
749 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84 750 confusion and troubles with script usage, aliases that
2de9b711 751 hide existing Git commands are ignored. Arguments are split by
99b41c84 752 spaces, the usual shell quoting and escaping is supported.
a79c3a1b 753 A quote pair or a backslash can be used to quote them.
f368f5a6
JH
754+
755If the alias expansion is prefixed with an exclamation point,
756it will be treated as a shell command. For example, defining
757"alias.new = !gitk --all --not ORIG_HEAD", the invocation
758"git new" is equivalent to running the shell command
595b8dbf
SC
759"gitk --all --not ORIG_HEAD". Note that shell commands will be
760executed from the top-level directory of a repository, which may
761not necessarily be the current directory.
7cf16a14
MG
762'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
763from the original current directory. See linkgit:git-rev-parse[1].
dfd42a3c 764
e80d4cbe
SH
765am.keepcr::
766 If true, git-am will call git-mailsplit for patches in mbox format
767 with parameter '--keep-cr'. In this case git-mailsplit will
6b677a28 768 not remove `\r` from lines ending with `\r\n`. Can be overridden
e80d4cbe
SH
769 by giving '--no-keep-cr' from the command line.
770 See linkgit:git-am[1], linkgit:git-mailsplit[1].
771
e97a5e76
RL
772am.threeWay::
773 By default, `git am` will fail if the patch does not apply cleanly. When
774 set to true, this setting tells `git am` to fall back on 3-way merge if
775 the patch records the identity of blobs it is supposed to apply to and
776 we have those blobs available locally (equivalent to giving the `--3way`
777 option from the command line). Defaults to `false`.
778 See linkgit:git-am[1].
779
da0005b8 780apply.ignoreWhitespace::
0b444cdb 781 When set to 'change', tells 'git apply' to ignore changes in
86c91f91
GB
782 whitespace, in the same way as the '--ignore-space-change'
783 option.
0b444cdb 784 When set to one of: no, none, never, false tells 'git apply' to
86c91f91
GB
785 respect all whitespace differences.
786 See linkgit:git-apply[1].
787
1ab661dd 788apply.whitespace::
0b444cdb 789 Tells 'git apply' how to handle whitespaces, in the same way
5162e697 790 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 791
da0005b8 792branch.autoSetupMerge::
add0951a 793 Tells 'git branch' and 'git checkout' to set up new branches
572fc81d
JS
794 so that linkgit:git-pull[1] will appropriately merge from the
795 starting point branch. Note that even if this option is not set,
9902387d 796 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
797 and `--no-track` options. The valid settings are: `false` -- no
798 automatic setup is done; `true` -- automatic setup is done when the
29b9a66f
MM
799 starting point is a remote-tracking branch; `always` --
800 automatic setup is done when the starting point is either a
801 local branch or remote-tracking
572fc81d 802 branch. This option defaults to true.
9902387d 803
da0005b8 804branch.autoSetupRebase::
0b444cdb 805 When a new branch is created with 'git branch' or 'git checkout'
2de9b711 806 that tracks another branch, this variable tells Git to set
c998ae9b
DS
807 up pull to rebase instead of merge (see "branch.<name>.rebase").
808 When `never`, rebase is never automatically set to true.
809 When `local`, rebase is set to true for tracked branches of
810 other local branches.
811 When `remote`, rebase is set to true for tracked branches of
29b9a66f 812 remote-tracking branches.
c998ae9b
DS
813 When `always`, rebase will be set to true for all tracking
814 branches.
da0005b8 815 See "branch.autoSetupMerge" for details on how to set up a
c998ae9b
DS
816 branch to track another branch.
817 This option defaults to never.
818
648ad18f 819branch.<name>.remote::
224c2171
RR
820 When on branch <name>, it tells 'git fetch' and 'git push'
821 which remote to fetch from/push to. The remote to push to
da0005b8 822 may be overridden with `remote.pushDefault` (for all branches).
9f765ce6 823 The remote to push to, for the current branch, may be further
da0005b8 824 overridden by `branch.<name>.pushRemote`. If no remote is
9f765ce6 825 configured, or if you are not on any branch, it defaults to
da0005b8 826 `origin` for fetching and `remote.pushDefault` for pushing.
b85ecea6
PO
827 Additionally, `.` (a period) is the current local repository
828 (a dot-repository), see `branch.<name>.merge`'s final note below.
9f765ce6 829
da0005b8 830branch.<name>.pushRemote::
9f765ce6 831 When on branch <name>, it overrides `branch.<name>.remote` for
da0005b8 832 pushing. It also overrides `remote.pushDefault` for pushing
9f765ce6
RR
833 from branch <name>. When you pull from one place (e.g. your
834 upstream) and push to another place (e.g. your own publishing
da0005b8 835 repository), you would want to set `remote.pushDefault` to
9f765ce6
RR
836 specify the remote to push to for all branches, and use this
837 option to override it for a specific branch.
648ad18f 838
5372806a 839branch.<name>.merge::
76d3cc50 840 Defines, together with branch.<name>.remote, the upstream branch
15a147e6 841 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
0b444cdb
TR
842 branch to merge and can also affect 'git push' (see push.default).
843 When in branch <name>, it tells 'git fetch' the default
b888d61c
DB
844 refspec to be marked for merging in FETCH_HEAD. The value is
845 handled like the remote part of a refspec, and must match a
846 ref which is fetched from the remote given by
847 "branch.<name>.remote".
0b444cdb
TR
848 The merge information is used by 'git pull' (which at first calls
849 'git fetch') to lookup the default branch for merging. Without
850 this option, 'git pull' defaults to merge the first refspec fetched.
62b339a5 851 Specify multiple values to get an octopus merge.
0b444cdb 852 If you wish to setup 'git pull' so that it merges into <name> from
9debc324 853 another branch in the local repository, you can point
b85ecea6
PO
854 branch.<name>.merge to the desired branch, and use the relative path
855 setting `.` (a period) for branch.<name>.remote.
5372806a 856
da0005b8 857branch.<name>.mergeOptions::
aec7b362 858 Sets default options for merging into branch <name>. The syntax and
25dcc0d6 859 supported options are the same as those of linkgit:git-merge[1], but
aec7b362
LH
860 option values containing whitespace characters are currently not
861 supported.
862
cd67e4d4
JS
863branch.<name>.rebase::
864 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa 865 instead of merging the default branch from the default remote when
6b37dff1
ÆAB
866 "git pull" is run. See "pull.rebase" for doing this in a non
867 branch-specific manner.
66713ef3
SH
868+
869 When preserve, also pass `--preserve-merges` along to 'git rebase'
870 so that locally committed merge commits will not be flattened
871 by running 'git pull'.
6b37dff1
ÆAB
872+
873*NOTE*: this is a possibly dangerous operation; do *not* use
874it unless you understand the implications (see linkgit:git-rebase[1]
875for details).
cd67e4d4 876
a5ba2cbe
NTND
877branch.<name>.description::
878 Branch description, can be edited with
879 `git branch --edit-description`. Branch description is
880 automatically added in the format-patch cover letter or
881 request-pull summary.
882
1658c614
CC
883browser.<tool>.cmd::
884 Specify the command to invoke the specified browser. The
885 specified command is evaluated in shell with the URLs passed
565e135a 886 as arguments. (See linkgit:git-web{litdd}browse[1].)
1658c614 887
584627b4
CC
888browser.<tool>.path::
889 Override the path for the given tool that may be used to
ab989adf
CC
890 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
891 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 892
2122591b 893clean.requireForce::
f85f7947
JX
894 A boolean to make git-clean do nothing unless given -f,
895 -i or -n. Defaults to true.
2122591b 896
f3673988
BG
897color.branch::
898 A boolean to enable/disable color in the output of
5162e697 899 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 900 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
901 only when the output is to a terminal. Defaults to false.
902
903color.branch.<slot>::
904 Use customized color for branch coloration. `<slot>` is one of
905 `current` (the current branch), `local` (a local branch),
dbda21fa
FC
906 `remote` (a remote-tracking branch in refs/remotes/),
907 `upstream` (upstream tracking branch), `plain` (other
4f193f20 908 refs).
f3673988 909
a159ca0c 910color.diff::
6999c540
MG
911 Whether to use ANSI escape sequences to add color to patches.
912 If this is set to `always`, linkgit:git-diff[1],
913 linkgit:git-log[1], and linkgit:git-show[1] will use color
914 for all patches. If it is set to `true` or `auto`, those
915 commands will only use color when output is to the terminal.
916 Defaults to false.
917+
a58088ab 918This does not affect linkgit:git-format-patch[1] or the
6999c540
MG
919'git-diff-{asterisk}' plumbing commands. Can be overridden on the
920command line with the `--color[=<when>]` option.
b5376648 921
a159ca0c 922color.diff.<slot>::
4f193f20
MW
923 Use customized color for diff colorization. `<slot>` specifies
924 which part of the patch to use the specified color, and is one
74b15bfb
JK
925 of `context` (context text - `plain` is a historical synonym),
926 `meta` (metainformation), `frag`
89cb73a1
BW
927 (hunk header), 'func' (function in hunk header), `old` (removed lines),
928 `new` (added lines), `commit` (commit headers), or `whitespace`
b92c1a28 929 (highlighting whitespace errors).
b5376648 930
5e11bee6
NR
931color.decorate.<slot>::
932 Use customized color for 'git log --decorate' output. `<slot>` is one
933 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
0e615b25 934 branches, remote-tracking branches, tags, stash and HEAD, respectively.
5e11bee6 935
7e8f59d5
RS
936color.grep::
937 When set to `always`, always highlight matches. When `false` (or
938 `never`), never. When set to `true` or `auto`, use color only
939 when the output is written to the terminal. Defaults to `false`.
940
55f638bd
ML
941color.grep.<slot>::
942 Use customized color for grep colorization. `<slot>` specifies which
943 part of the line to use the specified color, and is one of
944+
945--
00588bb5
ML
946`context`;;
947 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
55f638bd
ML
948`filename`;;
949 filename prefix (when not using `-h`)
00588bb5
ML
950`function`;;
951 function name lines (when using `-p`)
55f638bd
ML
952`linenumber`;;
953 line number prefix (when using `-n`)
954`match`;;
79a77109
RS
955 matching text (same as setting `matchContext` and `matchSelected`)
956`matchContext`;;
957 matching text in context lines
958`matchSelected`;;
959 matching text in selected lines
00588bb5
ML
960`selected`;;
961 non-matching text in selected lines
55f638bd
ML
962`separator`;;
963 separators between fields on a line (`:`, `-`, and `=`)
964 and between hunks (`--`)
965--
7e8f59d5 966
b4c61ed6 967color.interactive::
47ee06f1 968 When set to `always`, always use colors for interactive prompts
7a9b0b80
JX
969 and displays (such as those used by "git-add --interactive" and
970 "git-clean --interactive"). When false (or `never`), never.
971 When set to `true` or `auto`, use colors only when the output is
972 to the terminal. Defaults to false.
b4c61ed6
JH
973
974color.interactive.<slot>::
7a9b0b80
JX
975 Use customized color for 'git add --interactive' and 'git clean
976 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
977 or `error`, for four distinct types of normal output from
b92c1a28 978 interactive commands.
b4c61ed6 979
1d77043b
JH
980color.pager::
981 A boolean to enable/disable colored output when the pager is in
982 use (default is true).
983
da0005b8 984color.showBranch::
ab07ba2a
MH
985 A boolean to enable/disable color in the output of
986 linkgit:git-show-branch[1]. May be set to `always`,
987 `false` (or `never`) or `auto` (or `true`), in which case colors are used
988 only when the output is to a terminal. Defaults to false.
989
1d77043b
JH
990color.status::
991 A boolean to enable/disable color in the output of
5162e697 992 linkgit:git-status[1]. May be set to `always`,
cec99d8c 993 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
994 only when the output is to a terminal. Defaults to false.
995
996color.status.<slot>::
997 Use customized color for status colorization. `<slot>` is
998 one of `header` (the header text of the status message),
82dca848
SP
999 `added` or `updated` (files which are added but not committed),
1000 `changed` (files which are changed but not added in the index),
2de9b711 1001 `untracked` (files which are not tracked by Git),
0d6accc0 1002 `branch` (the current branch),
950ce2e2 1003 `nobranch` (the color the 'no branch' warning is shown in, defaulting
0d6accc0
MG
1004 to red), or
1005 `unmerged` (files which have unmerged changes).
1d77043b 1006
6b2f2d98 1007color.ui::
6999c540
MG
1008 This variable determines the default value for variables such
1009 as `color.diff` and `color.grep` that control the use of color
1010 per command family. Its scope will expand as more commands learn
1011 configuration to set a default for the `--color` option. Set it
4c7f1819
MM
1012 to `false` or `never` if you prefer Git commands not to use
1013 color unless enabled explicitly with some other configuration
1014 or the `--color` option. Set it to `always` if you want all
1015 output not intended for machine consumption to use color, to
1016 `true` or `auto` (this is the default since Git 1.8.4) if you
1017 want such output to use color when written to the terminal.
6b2f2d98 1018
7e29b825
NTND
1019column.ui::
1020 Specify whether supported commands should output in columns.
1021 This variable consists of a list of tokens separated by spaces
1022 or commas:
1023+
5e62cc14
RR
1024These options control when the feature should be enabled
1025(defaults to 'never'):
1026+
7e29b825
NTND
1027--
1028`always`;;
1029 always show in columns
1030`never`;;
1031 never show in columns
1032`auto`;;
1033 show in columns if the output is to the terminal
5e62cc14
RR
1034--
1035+
1036These options control layout (defaults to 'column'). Setting any
1037of these implies 'always' if none of 'always', 'never', or 'auto' are
1038specified.
1039+
1040--
077539d7 1041`column`;;
5e62cc14 1042 fill columns before rows
077539d7
NTND
1043`row`;;
1044 fill rows before columns
7e29b825
NTND
1045`plain`;;
1046 show in one column
5e62cc14
RR
1047--
1048+
1049Finally, these options can be combined with a layout option (defaults
1050to 'nodense'):
1051+
1052--
3f8eccbe
NTND
1053`dense`;;
1054 make unequal size columns to utilize more space
1055`nodense`;;
1056 make equal size columns
7e29b825 1057--
7e29b825 1058
ebe31ef2
NTND
1059column.branch::
1060 Specify whether to output branch listing in `git branch` in columns.
1061 See `column.ui` for details.
1062
1b8fd467
JX
1063column.clean::
1064 Specify the layout when list items in `git clean -i`, which always
1065 shows files and directories in columns. See `column.ui` for details.
1066
323d0530
NTND
1067column.status::
1068 Specify whether to output untracked files in `git status` in columns.
1069 See `column.ui` for details.
1070
d96e3c15
NTND
1071column.tag::
1072 Specify whether to output tag listing in `git tag` in columns.
1073 See `column.ui` for details.
1074
51fb3a3d
RT
1075commit.cleanup::
1076 This setting overrides the default of the `--cleanup` option in
1077 `git commit`. See linkgit:git-commit[1] for details. Changing the
1078 default can be useful when you always want to keep lines that begin
1079 with comment character `#` in your log message, in which case you
1080 would do `git config commit.cleanup whitespace` (note that you will
1081 have to remove the help lines that begin with `#` in the commit log
1082 template yourself, if you do this).
1083
da0005b8 1084commit.gpgSign::
d95bfb12
NV
1085
1086 A boolean to specify whether all commits should be GPG signed.
1087 Use of this option when doing operations such as rebase can
1088 result in a large number of commits being signed. It may be
1089 convenient to use an agent to avoid typing your GPG passphrase
1090 several times.
1091
88955ed2 1092commit.status::
bed575e4
JHI
1093 A boolean to enable/disable inclusion of status information in the
1094 commit message template when using an editor to prepare the commit
1095 message. Defaults to true.
1096
b0f34c3d
MM
1097commit.template::
1098 Specify a file to use as the template for new commit messages.
6cf378f0 1099 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
df2a79f4 1100 specified user's home directory.
b0f34c3d 1101
a6fc9fd3
JK
1102credential.helper::
1103 Specify an external helper to be called when a username or
1104 password credential is needed; the helper may consult external
1105 storage to avoid prompting the user for the credentials. See
1106 linkgit:gitcredentials[7] for details.
1107
1108credential.useHttpPath::
1109 When acquiring credentials, consider the "path" component of an http
1110 or https URL to be important. Defaults to false. See
1111 linkgit:gitcredentials[7] for more information.
1112
1113credential.username::
1114 If no username is set for a network authentication, use this username
1115 by default. See credential.<context>.* below, and
1116 linkgit:gitcredentials[7].
1117
1118credential.<url>.*::
1119 Any of the credential.* options above can be applied selectively to
1120 some credentials. For example "credential.https://example.com.username"
1121 would set the default username only for https connections to
1122 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1123 matched.
1124
19299a84 1125include::diff-config.txt[]
afcbc8e7
DA
1126
1127difftool.<tool>.path::
1128 Override the path for the given tool. This is useful in case
1129 your tool is not in the PATH.
1130
1131difftool.<tool>.cmd::
1132 Specify the command to invoke the specified diff tool.
1133 The specified command is evaluated in shell with the following
1134 variables available: 'LOCAL' is set to the name of the temporary
1135 file containing the contents of the diff pre-image and 'REMOTE'
1136 is set to the name of the temporary file containing the contents
1137 of the diff post-image.
1138
a904392e
DA
1139difftool.prompt::
1140 Prompt before each invocation of the diff tool.
1141
be254a0e 1142fetch.recurseSubmodules::
1fb25502
JL
1143 This option can be either set to a boolean value or to 'on-demand'.
1144 Setting it to a boolean changes the behavior of fetch and pull to
1145 unconditionally recurse into submodules when set to true or to not
1146 recurse at all when set to false. When set to 'on-demand' (the default
1147 value), fetch and pull will only recurse into a populated submodule
1148 when its superproject retrieves a commit that updates the submodule's
1149 reference.
be254a0e 1150
5e838ea7
JH
1151fetch.fsckObjects::
1152 If it is set to true, git-fetch-pack will check all fetched
1153 objects. It will abort in the case of a malformed object or a
1154 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
1155 Defaults to false. If not set, the value of `transfer.fsckObjects`
1156 is used instead.
5e838ea7 1157
af7cf268 1158fetch.unpackLimit::
2de9b711 1159 If the number of objects fetched over the Git native
af7cf268
JH
1160 transfer is below this
1161 limit, then the objects will be unpacked into loose object
1162 files. However if the number of received objects equals or
1163 exceeds this limit then the received pack will be stored as
1164 a pack, after adding any missing delta bases. Storing the
1165 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1166 especially on slow filesystems. If not set, the value of
1167 `transfer.unpackLimit` is used instead.
af7cf268 1168
737c5a9c
MS
1169fetch.prune::
1170 If true, fetch will automatically behave as if the `--prune`
1171 option was given on the command line. See also `remote.<name>.prune`.
1172
48d3448d
SB
1173format.attach::
1174 Enable multipart/mixed attachments as the default for
1175 'format-patch'. The value can also be a double quoted string
1176 which will enable attachments as the default and set the
1177 value as the boundary. See the --attach option in
1178 linkgit:git-format-patch[1].
1179
49604a4d 1180format.numbered::
a567fdcb
BG
1181 A boolean which can enable or disable sequence numbers in patch
1182 subjects. It defaults to "auto" which enables it only if there
1183 is more than one patch. It can be enabled or disabled for all
1184 messages by setting it to "true" or "false". See --numbered
1185 option in linkgit:git-format-patch[1].
49604a4d 1186
1ab661dd
PB
1187format.headers::
1188 Additional email headers to include in a patch to be submitted
5162e697 1189 by mail. See linkgit:git-format-patch[1].
1ab661dd 1190
312a30eb 1191format.to::
48d3448d 1192format.cc::
312a30eb
MV
1193 Additional recipients to include in a patch to be submitted
1194 by mail. See the --to and --cc options in
1195 linkgit:git-format-patch[1].
48d3448d 1196
da0005b8 1197format.subjectPrefix::
48d3448d
SB
1198 The default for format-patch is to output files with the '[PATCH]'
1199 subject prefix. Use this variable to change that prefix.
1200
6622d9c7
SB
1201format.signature::
1202 The default for format-patch is to output a signature containing
2de9b711 1203 the Git version number. Use this variable to change that default.
6622d9c7
SB
1204 Set this variable to the empty string ("") to suppress
1205 signature generation.
1206
da0005b8 1207format.signatureFile::
7022650f
JM
1208 Works just like format.signature except the contents of the
1209 file specified by this variable will be used as the signature.
1210
78cb59c8
JS
1211format.suffix::
1212 The default for format-patch is to output files with the suffix
1213 `.patch`. Use this variable to change that suffix (make sure to
1214 include the dot if you want it).
1ab661dd 1215
94c22a5e
CR
1216format.pretty::
1217 The default pretty format for log/show/whatchanged command,
1218 See linkgit:git-log[1], linkgit:git-show[1],
1219 linkgit:git-whatchanged[1].
1220
30984ed2 1221format.thread::
0b444cdb 1222 The default threading style for 'git format-patch'. Can be
578b62bf
JN
1223 a boolean value, or `shallow` or `deep`. `shallow` threading
1224 makes every mail a reply to the head of the series,
30984ed2 1225 where the head is chosen from the cover letter, the
6cf378f0 1226 `--in-reply-to`, and the first patch mail, in this order.
fd1ff306 1227 `deep` threading makes every mail a reply to the previous one.
30984ed2
TR
1228 A true boolean value is the same as `shallow`, and a false
1229 value disables threading.
1230
da0005b8 1231format.signOff::
240ae2b8
FC
1232 A boolean value which lets you enable the `-s/--signoff` option of
1233 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1234 patch should be a conscious act and means that you certify you have
1235 the rights to submit this work under the same open source license.
1236 Please see the 'SubmittingPatches' document for further discussion.
1d1876e9 1237
2a4c2607
FC
1238format.coverLetter::
1239 A boolean that controls whether to generate a cover-letter when
1240 format-patch is invoked, but in addition can be set to "auto", to
1241 generate a cover-letter only when there's more than one patch.
1242
26488f59
RR
1243filter.<driver>.clean::
1244 The command which is used to convert the content of a worktree
1245 file to a blob upon checkin. See linkgit:gitattributes[5] for
1246 details.
1247
1248filter.<driver>.smudge::
1249 The command which is used to convert the content of a blob
1250 object to a worktree file upon checkout. See
1251 linkgit:gitattributes[5] for details.
1252
2becf00f
JS
1253fsck.<msg-id>::
1254 Allows overriding the message type (error, warn or ignore) of a
1255 specific message ID such as `missingEmail`.
1256+
1257For convenience, fsck prefixes the error/warning with the message ID,
1258e.g. "missingEmail: invalid author/committer line - missing email" means
1259that setting `fsck.missingEmail = ignore` will hide that issue.
1260+
1261This feature is intended to support working with legacy repositories
1262which cannot be repaired without disruptive changes.
1263
1335f732
JS
1264fsck.skipList::
1265 The path to a sorted list of object names (i.e. one SHA-1 per
1266 line) that are known to be broken in a non-fatal way and should
1267 be ignored. This feature is useful when an established project
1268 should be accepted despite early commits containing errors that
1269 can be safely ignored such as invalid committer email addresses.
1270 Note: corrupt objects cannot be skipped with this setting.
1271
125f8146
NTND
1272gc.aggressiveDepth::
1273 The depth parameter used in the delta compression
1274 algorithm used by 'git gc --aggressive'. This defaults
1275 to 250.
1276
0d7566a5
TT
1277gc.aggressiveWindow::
1278 The window size parameter used in the delta compression
0b444cdb 1279 algorithm used by 'git gc --aggressive'. This defaults
f78683f3 1280 to 250.
0d7566a5 1281
e9831e83
JH
1282gc.auto::
1283 When there are approximately more than this many loose
1284 objects in the repository, `git gc --auto` will pack them.
1285 Some Porcelain commands use this command to perform a
80cd9cf9
MB
1286 light-weight garbage collection from time to time. The
1287 default value is 6700. Setting this to 0 disables it.
e9831e83 1288
da0005b8 1289gc.autoPackLimit::
17815501
JH
1290 When there are more than this many packs that are not
1291 marked with `*.keep` file in the repository, `git gc
80cd9cf9 1292 --auto` consolidates them into one larger pack. The
97063974 1293 default value is 50. Setting this to 0 disables it.
17815501 1294
da0005b8 1295gc.autoDetach::
f745acb0 1296 Make `git gc --auto` return immediately and run in background
9f673f94
NTND
1297 if the system supports it. Default is true.
1298
da0005b8 1299gc.packRefs::
efc266e8
JN
1300 Running `git pack-refs` in a repository renders it
1301 unclonable by Git versions prior to 1.5.1.2 over dumb
1302 transports such as HTTP. This variable determines whether
4be0c352 1303 'git gc' runs `git pack-refs`. This can be set to `notbare`
efc266e8
JN
1304 to enable it within all non-bare repos or it can be set to a
1305 boolean value. The default is `true`.
c2120e5e 1306
da0005b8 1307gc.pruneExpire::
0b444cdb 1308 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
8e8daf33 1309 Override the grace period with this config variable. The value
8cc88166
ES
1310 "now" may be used to disable this grace period and always prune
1311 unreachable objects immediately, or "never" may be used to
1312 suppress pruning.
25ee9731 1313
114ff888 1314gc.worktreePruneExpire::
b07244f4 1315 When 'git gc' is run, it calls
fe819b4b 1316 'git worktree prune --expire 3.months.ago'.
b07244f4
MH
1317 This config variable can be used to set a different grace
1318 period. The value "now" may be used to disable the grace
8cc88166
ES
1319 period and prune $GIT_DIR/worktrees immediately, or "never"
1320 may be used to suppress pruning.
e3df33bb 1321
da0005b8
NTND
1322gc.reflogExpire::
1323gc.<pattern>.reflogExpire::
0b444cdb 1324 'git reflog expire' removes reflog entries older than
8cc88166
ES
1325 this time; defaults to 90 days. The value "now" expires all
1326 entries immediately, and "never" suppresses expiration
1327 altogether. With "<pattern>" (e.g.
eb523a8d
JH
1328 "refs/stash") in the middle the setting applies only to
1329 the refs that match the <pattern>.
4aec56d1 1330
da0005b8 1331gc.reflogExpireUnreachable::
f04c6904 1332gc.<pattern>.reflogExpireUnreachable::
0b444cdb 1333 'git reflog expire' removes reflog entries older than
4aec56d1 1334 this time and are not reachable from the current tip;
8cc88166
ES
1335 defaults to 30 days. The value "now" expires all entries
1336 immediately, and "never" suppresses expiration altogether.
1337 With "<pattern>" (e.g. "refs/stash")
eb523a8d
JH
1338 in the middle, the setting applies only to the refs that
1339 match the <pattern>.
4aec56d1 1340
da0005b8 1341gc.rerereResolved::
48c32424 1342 Records of conflicted merge you resolved earlier are
0b444cdb 1343 kept for this many days when 'git rerere gc' is run.
5162e697 1344 The default is 60 days. See linkgit:git-rerere[1].
48c32424 1345
da0005b8 1346gc.rerereUnresolved::
48c32424 1347 Records of conflicted merge you have not resolved are
0b444cdb 1348 kept for this many days when 'git rerere gc' is run.
5162e697 1349 The default is 15 days. See linkgit:git-rerere[1].
48c32424 1350
da0005b8 1351gitcvs.commitMsgAnnotation::
280514e1
FE
1352 Append this string to each commit message. Set to empty string
1353 to disable this feature. Defaults to "via git-CVS emulator".
1354
1ab661dd 1355gitcvs.enabled::
db218723 1356 Whether the CVS server interface is enabled for this repository.
5162e697 1357 See linkgit:git-cvsserver[1].
1ab661dd 1358
da0005b8 1359gitcvs.logFile::
db218723 1360 Path to a log file where the CVS server interface well... logs
5162e697 1361 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 1362
1707adb7 1363gitcvs.usecrlfattr::
5ec3e670
EB
1364 If true, the server will look up the end-of-line conversion
1365 attributes for files to determine the '-k' modes to use. If
2de9b711 1366 the attributes force Git to treat a file as text,
6b677a28 1367 the '-k' mode will be left blank so CVS clients will
5ec3e670 1368 treat it as text. If they suppress text conversion, the file
1168d402 1369 will be set with '-kb' mode, which suppresses any newline munging
5ec3e670 1370 the client might otherwise do. If the attributes do not allow
da0005b8 1371 the file type to be determined, then 'gitcvs.allBinary' is
5ec3e670 1372 used. See linkgit:gitattributes[5].
8a06a632 1373
da0005b8 1374gitcvs.allBinary::
90948a42
MO
1375 This is used if 'gitcvs.usecrlfattr' does not resolve
1376 the correct '-kb' mode to use. If true, all
1377 unresolved files are sent to the client in
1378 mode '-kb'. This causes the client to treat them
1379 as binary files, which suppresses any newline munging it
1380 otherwise might do. Alternatively, if it is set to "guess",
1381 then the contents of the file are examined to decide if
1382 it is binary, similar to 'core.autocrlf'.
abbf5947 1383
da0005b8 1384gitcvs.dbName::
04752868 1385 Database used by git-cvsserver to cache revision information
2de9b711 1386 derived from the Git repository. The exact meaning depends on the
04752868
FL
1387 used database driver, for SQLite (which is the default driver) this
1388 is a filename. Supports variable substitution (see
5162e697 1389 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
1390 Default: '%Ggitcvs.%m.sqlite'
1391
da0005b8 1392gitcvs.dbDriver::
04752868 1393 Used Perl DBI driver. You can specify any available driver
240ae2b8 1394 for this here, but it might not work. git-cvsserver is tested
04752868
FL
1395 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1396 reported *not* to work with 'DBD::mysql'. Experimental feature.
1397 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 1398 See linkgit:git-cvsserver[1].
eabb0bfd 1399
da0005b8
NTND
1400gitcvs.dbUser, gitcvs.dbPass::
1401 Database user and password. Only useful if setting 'gitcvs.dbDriver',
04752868 1402 since SQLite has no concept of database users and/or passwords.
da0005b8 1403 'gitcvs.dbUser' supports variable substitution (see
5162e697 1404 linkgit:git-cvsserver[1] for details).
04752868 1405
6aeeffd1
JE
1406gitcvs.dbTableNamePrefix::
1407 Database table name prefix. Prepended to the names of any
1408 database tables used, allowing a single database to be used
1409 for several repositories. Supports variable substitution (see
1410 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1411 characters will be replaced with underscores.
1412
8a06a632 1413All gitcvs variables except for 'gitcvs.usecrlfattr' and
da0005b8 1414'gitcvs.allBinary' can also be specified as
8a06a632 1415'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
1416is one of "ext" and "pserver") to make them apply only for the given
1417access method.
04752868 1418
cd82323f
JN
1419gitweb.category::
1420gitweb.description::
1421gitweb.owner::
1422gitweb.url::
1423 See linkgit:gitweb[1] for description.
1424
1425gitweb.avatar::
1426gitweb.blame::
1427gitweb.grep::
1428gitweb.highlight::
1429gitweb.patches::
1430gitweb.pickaxe::
1431gitweb.remote_heads::
da0005b8 1432gitweb.showSizes::
cd82323f
JN
1433gitweb.snapshot::
1434 See linkgit:gitweb.conf[5] for description.
1435
b22520a3
JR
1436grep.lineNumber::
1437 If set to true, enable '-n' option by default.
1438
84befcd0
S
1439grep.patternType::
1440 Set the default matching behavior. Using a value of 'basic', 'extended',
1441 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1442 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1443 value 'default' will return to the default matching behavior.
1444
b22520a3 1445grep.extendedRegexp::
84befcd0
S
1446 If set to true, enable '--extended-regexp' option by default. This
1447 option is ignored when the 'grep.patternType' option is set to a value
1448 other than 'default'.
b22520a3 1449
0c5e70f0
JH
1450gpg.program::
1451 Use this custom program instead of "gpg" found on $PATH when
1452 making or verifying a PGP signature. The program must support the
06ab60c0 1453 same command-line interface as GPG, namely, to verify a detached
0c5e70f0
JH
1454 signature, "gpg --verify $file - <$signature" is run, and the
1455 program is expected to signal a good signature by exiting with
f745acb0 1456 code 0, and to generate an ASCII-armored detached signature, the
0c5e70f0
JH
1457 standard input of "gpg -bsau $key" is fed with the contents to be
1458 signed, and the program is expected to send the result to its
1459 standard output.
1460
da0005b8 1461gui.commitMsgWidth::
d84ae0db
GH
1462 Defines how wide the commit message window is in the
1463 linkgit:git-gui[1]. "75" is the default.
1464
da0005b8 1465gui.diffContext::
d84ae0db
GH
1466 Specifies how many context lines should be used in calls to diff
1467 made by the linkgit:git-gui[1]. The default is "5".
1468
da0005b8 1469gui.displayUntracked::
ec9fa62a
MK
1470 Determines if linkgit::git-gui[1] shows untracked files
1471 in the file list. The default is "true".
1472
a2df1fb2
AG
1473gui.encoding::
1474 Specifies the default encoding to use for displaying of
1475 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1476 It can be overridden by setting the 'encoding' attribute
1477 for relevant files (see linkgit:gitattributes[5]).
1478 If this option is not set, the tools default to the
1479 locale encoding.
1480
da0005b8 1481gui.matchTrackingBranch::
d84ae0db
GH
1482 Determines if new branches created with linkgit:git-gui[1] should
1483 default to tracking remote branches with matching names or
1484 not. Default: "false".
1485
da0005b8 1486gui.newBranchTemplate::
d84ae0db
GH
1487 Is used as suggested name when creating new branches using the
1488 linkgit:git-gui[1].
1489
da0005b8 1490gui.pruneDuringFetch::
8b3f3f84 1491 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
d84ae0db
GH
1492 performing a fetch. The default value is "false".
1493
1494gui.trustmtime::
1495 Determines if linkgit:git-gui[1] should trust the file modification
1496 timestamp or not. By default the timestamps are not trusted.
1497
da0005b8 1498gui.spellingDictionary::
d84ae0db
GH
1499 Specifies the dictionary used for spell checking commit messages in
1500 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1501 off.
1502
da0005b8 1503gui.fastCopyBlame::
ca768288 1504 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
a2df1fb2
AG
1505 location detection. It makes blame significantly faster on huge
1506 repositories at the expense of less thorough copy detection.
1507
da0005b8 1508gui.copyBlameThreshold::
76bac890 1509 Specifies the threshold to use in 'git gui blame' original location
a2df1fb2
AG
1510 detection, measured in alphanumeric characters. See the
1511 linkgit:git-blame[1] manual for more information on copy detection.
1512
1513gui.blamehistoryctx::
1514 Specifies the radius of history context in days to show in
1515 linkgit:gitk[1] for the selected commit, when the `Show History
1516 Context` menu item is invoked from 'git gui blame'. If this
1517 variable is set to zero, the whole history is shown.
1518
390c3480
AG
1519guitool.<name>.cmd::
1520 Specifies the shell command line to execute when the corresponding item
1521 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1522 mandatory for every tool. The command is executed from the root of
1523 the working directory, and in the environment it receives the name of
1524 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1525 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1526 the head is detached, 'CUR_BRANCH' is empty).
1527
da0005b8 1528guitool.<name>.needsFile::
390c3480
AG
1529 Run the tool only if a diff is selected in the GUI. It guarantees
1530 that 'FILENAME' is not empty.
1531
da0005b8 1532guitool.<name>.noConsole::
390c3480
AG
1533 Run the command silently, without creating a window to display its
1534 output.
1535
da0005b8 1536guitool.<name>.noRescan::
390c3480
AG
1537 Don't rescan the working directory for changes after the tool
1538 finishes execution.
1539
1540guitool.<name>.confirm::
1541 Show a confirmation dialog before actually running the tool.
1542
da0005b8 1543guitool.<name>.argPrompt::
390c3480
AG
1544 Request a string argument from the user, and pass it to the tool
1545 through the 'ARGS' environment variable. Since requesting an
1546 argument implies confirmation, the 'confirm' option has no effect
1547 if this is enabled. If the option is set to 'true', 'yes', or '1',
1548 the dialog uses a built-in generic prompt; otherwise the exact
1549 value of the variable is used.
1550
da0005b8 1551guitool.<name>.revPrompt::
390c3480
AG
1552 Request a single valid revision from the user, and set the
1553 'REVISION' environment variable. In other aspects this option
da0005b8 1554 is similar to 'argPrompt', and can be used together with it.
390c3480 1555
da0005b8
NTND
1556guitool.<name>.revUnmerged::
1557 Show only unmerged branches in the 'revPrompt' subdialog.
390c3480
AG
1558 This is useful for tools similar to merge or rebase, but not
1559 for things like checkout or reset.
1560
1561guitool.<name>.title::
1562 Specifies the title to use for the prompt dialog. The default
1563 is the tool name.
1564
1565guitool.<name>.prompt::
1566 Specifies the general prompt string to display at the top of
da0005b8 1567 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
390c3480
AG
1568 The default value includes the actual command.
1569
983a9eeb
CC
1570help.browser::
1571 Specify the browser that will be used to display help in the
1572 'web' format. See linkgit:git-help[1].
1573
1574help.format::
1575 Override the default help format used by linkgit:git-help[1].
1576 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1577 the default. 'web' and 'html' are the same.
1578
da0005b8 1579help.autoCorrect::
f0e90716
AR
1580 Automatically correct and execute mistyped commands after
1581 waiting for the given number of deciseconds (0.1 sec). If more
1582 than one command can be deduced from the entered text, nothing
1583 will be executed. If the value of this option is negative,
1584 the corrected command will be executed immediately. If the
1585 value is 0 - the command will be just shown but not executed.
1586 This is the default.
1587
da0005b8 1588help.htmlPath::
b1f809d0
SS
1589 Specify the path where the HTML documentation resides. File system paths
1590 and URLs are supported. HTML pages will be prefixed with this path when
1591 help is displayed in the 'web' format. This defaults to the documentation
1592 path of your Git installation.
1593
9c5665aa 1594http.proxy::
b2c8c6d9
CB
1595 Override the HTTP proxy, normally configured using the 'http_proxy',
1596 'https_proxy', and 'all_proxy' environment variables (see
1597 `curl(1)`). This can be overridden on a per-remote basis; see
1598 remote.<name>.proxy
9c5665aa 1599
da0005b8 1600http.cookieFile::
bcfb95dd 1601 File containing previously stored cookie lines which should be used
2de9b711 1602 in the Git http session, if they match the server. The file format
bcfb95dd
DB
1603 of the file to read cookies from should be plain HTTP headers or
1604 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
da0005b8 1605 NOTE that the file specified with http.cookieFile is only used as
912b2acf
DB
1606 input unless http.saveCookies is set.
1607
da0005b8 1608http.saveCookies::
912b2acf 1609 If set, store cookies received during requests to the file specified by
da0005b8 1610 http.cookieFile. Has no effect if http.cookieFile is unset.
bcfb95dd 1611
01861cb7
EP
1612http.sslVersion::
1613 The SSL version to use when negotiating an SSL connection, if you
1614 want to force the default. The available and default version
1615 depend on whether libcurl was built against NSS or OpenSSL and the
1616 particular configuration of the crypto library in use. Internally
1617 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1618 documentation for more details on the format of this option and
1619 for the ssl version supported. Actually the possible values of
1620 this option are:
1621
1622 - sslv2
1623 - sslv3
1624 - tlsv1
1625 - tlsv1.0
1626 - tlsv1.1
1627 - tlsv1.2
1628
1629+
1630Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1631To force git to use libcurl's default ssl version and ignore any
1632explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1633empty string.
1634
f6f2a9e4
LKS
1635http.sslCipherList::
1636 A list of SSL ciphers to use when negotiating an SSL connection.
1637 The available ciphers depend on whether libcurl was built against
1638 NSS or OpenSSL and the particular configuration of the crypto
1639 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1640 option; see the libcurl documentation for more details on the format
1641 of this list.
1642+
1643Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1644To force git to use libcurl's default cipher list and ignore any
1645explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1646empty string.
1647
1ab661dd
PB
1648http.sslVerify::
1649 Whether to verify the SSL certificate when fetching or pushing
37425065 1650 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
1651 variable.
1652
1653http.sslCert::
1654 File containing the SSL certificate when fetching or pushing
37425065 1655 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
1656 variable.
1657
1658http.sslKey::
1659 File containing the SSL private key when fetching or pushing
abda1ef5 1660 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
1661 variable.
1662
754ae192 1663http.sslCertPasswordProtected::
2de9b711 1664 Enable Git's password prompt for the SSL certificate. Otherwise
754ae192
ML
1665 OpenSSL will prompt the user, possibly many times, if the
1666 certificate or private key is encrypted. Can be overridden by the
1667 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1668
1ab661dd
PB
1669http.sslCAInfo::
1670 File containing the certificates to verify the peer with when
abda1ef5 1671 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
1672 'GIT_SSL_CAINFO' environment variable.
1673
1674http.sslCAPath::
1675 Path containing files with the CA certificates to verify the peer
37425065 1676 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
1677 by the 'GIT_SSL_CAPATH' environment variable.
1678
4bc444eb
MV
1679http.sslTry::
1680 Attempt to use AUTH SSL/TLS and encrypted data transfers
1681 when connecting via regular FTP protocol. This might be needed
1682 if the FTP server requires it for security reasons or you wish
1683 to connect securely whenever remote FTP server supports it.
1684 Default is false since it might trigger certificate verification
1685 errors on misconfigured servers.
1686
1ab661dd 1687http.maxRequests::
abda1ef5 1688 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
1689 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1690
ad75ebe5
TRC
1691http.minSessions::
1692 The number of curl sessions (counted across slots) to be kept across
1693 requests. They will not be ended with curl_easy_cleanup() until
1694 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1695 value will be capped at 1. Defaults to 1.
1696
de1a2fdd
SP
1697http.postBuffer::
1698 Maximum size in bytes of the buffer used by smart HTTP
1699 transports when POSTing data to the remote system.
1700 For requests larger than this buffer size, HTTP/1.1 and
1701 Transfer-Encoding: chunked is used to avoid creating a
1702 massive pack file locally. Default is 1 MiB, which is
1703 sufficient for most requests.
1704
1ab661dd
PB
1705http.lowSpeedLimit, http.lowSpeedTime::
1706 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1707 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 1708 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
1709 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1710
3ea099d4
SK
1711http.noEPSV::
1712 A boolean which disables using of EPSV ftp command by curl.
befc9c42 1713 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
1714 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1715 environment variable. Default is false (curl will use EPSV).
1716
da0005b8 1717http.userAgent::
b1d1058c 1718 The HTTP USER_AGENT string presented to an HTTP server. The default
2de9b711 1719 value represents the version of the client Git such as git/1.7.1.
b1d1058c
SO
1720 This option allows you to override this value to a more common value
1721 such as Mozilla/4.0. This may be necessary, for instance, if
1722 connecting through a firewall that restricts HTTP connections to a set
1723 of common USER_AGENT strings (but not including those like git/1.7.1).
1724 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1725
6a56993b 1726http.<url>.*::
f745acb0 1727 Any of the http.* options above can be applied selectively to some URLs.
6a56993b
KM
1728 For a config key to match a URL, each element of the config key is
1729 compared to that of the URL, in the following order:
1730+
1731--
1732. Scheme (e.g., `https` in `https://example.com/`). This field
1733 must match exactly between the config key and the URL.
1734
1735. Host/domain name (e.g., `example.com` in `https://example.com/`).
1736 This field must match exactly between the config key and the URL.
1737
1738. Port number (e.g., `8080` in `http://example.com:8080/`).
1739 This field must match exactly between the config key and the URL.
1740 Omitted port numbers are automatically converted to the correct
1741 default for the scheme before matching.
1742
1743. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1744 path field of the config key must match the path field of the URL
1745 either exactly or as a prefix of slash-delimited path elements. This means
1746 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1747 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1748 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1749 key with just path `foo/`).
1750
1751. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1752 the config key has a user name it must match the user name in the
1753 URL exactly. If the config key does not have a user name, that
1754 config key will match a URL with any user name (including none),
1755 but at a lower precedence than a config key with a user name.
1756--
1757+
1758The list above is ordered by decreasing precedence; a URL that matches
1759a config key's path is preferred to one that matches its user name. For example,
1760if the URL is `https://user@example.com/foo/bar` a config key match of
1761`https://example.com/foo` will be preferred over a config key match of
1762`https://user@example.com`.
1763+
1764All URLs are normalized before attempting any matching (the password part,
1765if embedded in the URL, is always ignored for matching purposes) so that
f745acb0
TA
1766equivalent URLs that are simply spelled differently will match properly.
1767Environment variable settings always override any matches. The URLs that are
6a56993b
KM
1768matched against are those given directly to Git commands. This means any URLs
1769visited as a result of a redirection do not participate in matching.
1770
1ab661dd 1771i18n.commitEncoding::
2de9b711 1772 Character encoding the commit messages are stored in; Git itself
1ab661dd
PB
1773 does not care per se, but this information is necessary e.g. when
1774 importing commits from emails or in the gitk graphical history
1775 browser (and possibly at other places in the future or in other
5162e697 1776 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 1777
d2c11a38
JH
1778i18n.logOutputEncoding::
1779 Character encoding the commit messages are converted to when
0b444cdb 1780 running 'git log' and friends.
d2c11a38 1781
b0f34c3d
MM
1782imap::
1783 The configuration variables in the 'imap' section are described
1784 in linkgit:git-imap-send[1].
1785
3c09d684
TG
1786index.version::
1787 Specify the version with which new index files should be
1788 initialized. This does not affect existing repositories.
1789
da0005b8 1790init.templateDir::
d8a8488d
SD
1791 Specify the directory from which templates will be copied.
1792 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1793
983a9eeb
CC
1794instaweb.browser::
1795 Specify the program that will be used to browse your working
1796 repository in gitweb. See linkgit:git-instaweb[1].
1797
1798instaweb.httpd::
1799 The HTTP daemon command-line to start gitweb on your working
1800 repository. See linkgit:git-instaweb[1].
1801
1802instaweb.local::
1803 If true the web server started by linkgit:git-instaweb[1] will
1804 be bound to the local IP (127.0.0.1).
1805
da0005b8 1806instaweb.modulePath::
6b677a28
VS
1807 The default module path for linkgit:git-instaweb[1] to use
1808 instead of /usr/lib/apache2/modules. Only used if httpd
1809 is Apache.
983a9eeb
CC
1810
1811instaweb.port::
1812 The port number to bind the gitweb httpd to. See
1813 linkgit:git-instaweb[1].
1814
da0005b8 1815interactive.singleKey::
57f6ec02 1816 In interactive commands, allow the user to provide one-letter
ca6ac7f1 1817 input with a single key (i.e., without hitting enter).
6cf378f0 1818 Currently this is used by the `--patch` mode of
e6b57a8a
CI
1819 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1820 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1821 setting is silently ignored if portable keystroke input
8358f1ac 1822 is not available; requires the Perl module Term::ReadKey.
ca6ac7f1 1823
0c47695a
JS
1824log.abbrevCommit::
1825 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6cf378f0
JK
1826 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1827 override this option with `--no-abbrev-commit`.
0c47695a 1828
dd0ffd5b 1829log.date::
e860795d
JN
1830 Set the default date-time mode for the 'log' command.
1831 Setting a value for log.date is similar to using 'git log''s
6cf378f0 1832 `--date` option. Possible values are `relative`, `local`,
e860795d
JN
1833 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1834 for details.
dd0ffd5b 1835
eb734454
SD
1836log.decorate::
1837 Print out the ref names of any commits that are shown by the log
1838 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1839 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1840 specified, the full ref name (including prefix) will be printed.
1841 This is the same as the log commands '--decorate' option.
1842
da0005b8 1843log.showRoot::
0f03ca94
PB
1844 If true, the initial commit will be shown as a big creation event.
1845 This is equivalent to a diff against an empty tree.
5162e697 1846 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
1847 normally hide the root commit will now show it. True by default.
1848
e6bb5f78
AP
1849log.mailmap::
1850 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1851 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1852
d5c4b185
MM
1853mailinfo.scissors::
1854 If true, makes linkgit:git-mailinfo[1] (and therefore
1855 linkgit:git-am[1]) act by default as if the --scissors option
1856 was provided on the command-line. When active, this features
1857 removes everything from the message body before a scissors
1858 line (i.e. consisting mainly of ">8", "8<" and "-").
1859
d551a488
MSO
1860mailmap.file::
1861 The location of an augmenting mailmap file. The default
1862 mailmap, located in the root of the repository, is loaded
1863 first, then the mailmap file pointed to by this variable.
1864 The location of the mailmap file may be in a repository
1865 subdirectory, or somewhere outside of the repository itself.
1866 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1867
08610900
JK
1868mailmap.blob::
1869 Like `mailmap.file`, but consider the value as a reference to a
8c473cec
JK
1870 blob in the repository. If both `mailmap.file` and
1871 `mailmap.blob` are given, both are parsed, with entries from
1872 `mailmap.file` taking precedence. In a bare repository, this
1873 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1874 defaults to empty.
08610900 1875
b5578f33 1876man.viewer::
b8322ea8 1877 Specify the programs that may be used to display help in the
b5578f33
CC
1878 'man' format. See linkgit:git-help[1].
1879
0bb64009
CC
1880man.<tool>.cmd::
1881 Specify the command to invoke the specified man viewer. The
1882 specified command is evaluated in shell with the man page
1883 passed as argument. (See linkgit:git-help[1].)
1884
7e8114c0
CC
1885man.<tool>.path::
1886 Override the path for the given tool that may be used to
1887 display help in the 'man' format. See linkgit:git-help[1].
1888
b0f34c3d 1889include::merge-config.txt[]
b5412484 1890
77680caa
JS
1891mergetool.<tool>.path::
1892 Override the path for the given tool. This is useful in case
1893 your tool is not in the PATH.
1894
964473a0
CB
1895mergetool.<tool>.cmd::
1896 Specify the command to invoke the specified merge tool. The
1897 specified command is evaluated in shell with the following
1898 variables available: 'BASE' is the name of a temporary file
1899 containing the common base of the files to be merged, if available;
1900 'LOCAL' is the name of a temporary file containing the contents of
1901 the file on the current branch; 'REMOTE' is the name of a temporary
1902 file containing the contents of the file from the branch being
1903 merged; 'MERGED' contains the name of the file to which the merge
1904 tool should write the results of a successful merge.
1905
1906mergetool.<tool>.trustExitCode::
1907 For a custom merge command, specify whether the exit code of
1908 the merge command can be used to determine whether the merge was
1909 successful. If this is not set to true then the merge target file
1910 timestamp is checked and the merge assumed to have been successful
1911 if the file has been updated, otherwise the user is prompted to
1912 indicate the success of the merge.
1913
b12d0450
DA
1914mergetool.meld.hasOutput::
1915 Older versions of `meld` do not support the `--output` option.
1916 Git will attempt to detect whether `meld` supports `--output`
1917 by inspecting the output of `meld --help`. Configuring
1918 `mergetool.meld.hasOutput` will make Git skip these checks and
1919 use the configured value instead. Setting `mergetool.meld.hasOutput`
1920 to `true` tells Git to unconditionally use the `--output` option,
1921 and `false` avoids using `--output`.
1922
44c36d1c
CB
1923mergetool.keepBackup::
1924 After performing a merge, the original file with conflict markers
1925 can be saved as a file with a `.orig` extension. If this variable
1926 is set to `false` then this file is not preserved. Defaults to
1927 `true` (i.e. keep the backup files).
1928
162eba8b 1929mergetool.keepTemporaries::
2de9b711 1930 When invoking a custom merge tool, Git uses a set of temporary
162eba8b
CB
1931 files to pass to the tool. If the tool returns an error and this
1932 variable is set to `true`, then these temporary files will be
1933 preserved, otherwise they will be removed after the tool has
1934 exited. Defaults to `false`.
1935
8f0cb41d
DA
1936mergetool.writeToTemp::
1937 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1938 conflicting files in the worktree by default. Git will attempt
1939 to use a temporary directory for these files when set `true`.
1940 Defaults to `false`.
1941
682b451f
CB
1942mergetool.prompt::
1943 Prompt before each invocation of the merge resolution program.
1944
d2d68d99
JK
1945notes.mergeStrategy::
1946 Which merge strategy to choose by default when resolving notes
1947 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
1948 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
1949 section of linkgit:git-notes[1] for more information on each strategy.
1950
4f655e22
JK
1951notes.<name>.mergeStrategy::
1952 Which merge strategy to choose when doing a notes merge into
1953 refs/notes/<name>. This overrides the more general
1954 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
1955 linkgit:git-notes[1] for more information on the available strategies.
1956
894a9d33
TR
1957notes.displayRef::
1958 The (fully qualified) refname from which to show notes when
1959 showing commit messages. The value of this variable can be set
1960 to a glob, in which case notes from all matching refs will be
1961 shown. You may also specify this configuration variable
1962 several times. A warning will be issued for refs that do not
1963 exist, but a glob that does not match any refs is silently
1964 ignored.
1965+
1966This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1967environment variable, which must be a colon separated list of refs or
1968globs.
1969+
1970The effective value of "core.notesRef" (possibly overridden by
1971GIT_NOTES_REF) is also implicitly added to the list of refs to be
1972displayed.
1973
6956f858
TR
1974notes.rewrite.<command>::
1975 When rewriting commits with <command> (currently `amend` or
2de9b711 1976 `rebase`) and this variable is set to `true`, Git
6956f858
TR
1977 automatically copies your notes from the original to the
1978 rewritten commit. Defaults to `true`, but see
1979 "notes.rewriteRef" below.
6956f858
TR
1980
1981notes.rewriteMode::
1982 When copying notes during a rewrite (see the
1983 "notes.rewrite.<command>" option), determines what to do if
1984 the target commit already has a note. Must be one of
e48ad1b9
JK
1985 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
1986 Defaults to `concatenate`.
6956f858
TR
1987+
1988This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1989environment variable.
1990
1991notes.rewriteRef::
1992 When copying notes during a rewrite, specifies the (fully
1993 qualified) ref whose notes should be copied. The ref may be a
1994 glob, in which case notes in all matching refs will be copied.
1995 You may also specify this configuration several times.
1996+
1997Does not have a default value; you must configure this variable to
2b4aa89c
TR
1998enable note rewriting. Set it to `refs/notes/commits` to enable
1999rewriting for the default commit notes.
cfb88e9a
LAS
2000+
2001This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2002environment variable, which must be a colon separated list of refs or
2003globs.
6956f858 2004
4812a93a 2005pack.window::
5162e697 2006 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
2007 window size is given on the command line. Defaults to 10.
2008
842aaf93 2009pack.depth::
5162e697 2010 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 2011 maximum depth is given on the command line. Defaults to 50.
842aaf93 2012
e93b15cd 2013pack.windowMemory::
f4694a8c
RB
2014 The maximum size of memory that is consumed by each thread
2015 in linkgit:git-pack-objects[1] for pack window memory when
2016 no limit is given on the command line. The value can be
2017 suffixed with "k", "m", or "g". When left unconfigured (or
2018 set explicitly to 0), there will be no limit.
e93b15cd 2019
960ccca6
DH
2020pack.compression::
2021 An integer -1..9, indicating the compression level for objects
2022 in a pack file. -1 is the zlib default. 0 means no
2023 compression, and 1..9 are various speed/size tradeoffs, 9 being
2024 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
2025 not set, defaults to -1, the zlib default, which is "a default
2026 compromise between speed and compression (currently equivalent
2027 to level 6)."
89d71f75
JK
2028+
2029Note that changing the compression level will not automatically recompress
2030all existing objects. You can force recompression by passing the -F option
2031to linkgit:git-repack[1].
960ccca6 2032
074b2eea 2033pack.deltaCacheSize::
02783075 2034 The maximum memory in bytes used for caching deltas in
5749b0b2
NP
2035 linkgit:git-pack-objects[1] before writing them out to a pack.
2036 This cache is used to speed up the writing object phase by not
2037 having to recompute the final delta result once the best match
2038 for all objects is found. Repacking large repositories on machines
2039 which are tight with memory might be badly impacted by this though,
2040 especially if this cache pushes the system into swapping.
2041 A value of 0 means no limit. The smallest size of 1 byte may be
2042 used to virtually disable this cache. Defaults to 256 MiB.
074b2eea 2043
e3dfddb3 2044pack.deltaCacheLimit::
693b86ff 2045 The maximum size of a delta, that is cached in
5749b0b2
NP
2046 linkgit:git-pack-objects[1]. This cache is used to speed up the
2047 writing object phase by not having to recompute the final delta
2048 result once the best match for all objects is found. Defaults to 1000.
e3dfddb3 2049
693b86ff
NP
2050pack.threads::
2051 Specifies the number of threads to spawn when searching for best
5162e697 2052 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
2053 be compiled with pthreads otherwise this option is ignored with a
2054 warning. This is meant to reduce packing time on multiprocessor
2055 machines. The required amount of memory for the delta search window
2056 is however multiplied by the number of threads.
2de9b711 2057 Specifying 0 will cause Git to auto-detect the number of CPU's
833e3df1 2058 and set the number of threads accordingly.
693b86ff 2059
4d00bda2
NP
2060pack.indexVersion::
2061 Specify the default pack index version. Valid values are 1 for
2062 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2063 the new pack index with capabilities for packs larger than 4 GB
2064 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
2065 packs. Version 2 is the default. Note that version 2 is enforced
2066 and this config option ignored whenever the corresponding pack is
2067 larger than 2 GB.
2068+
2de9b711 2069If you have an old Git that does not understand the version 2 `*.idx` file,
c0a5e2d4 2070cloning or fetching over a non native protocol (e.g. "http" and "rsync")
6cf378f0 2071that will copy both `*.pack` file and corresponding `*.idx` file from the
c0a5e2d4 2072other side may give you a repository that cannot be accessed with your
2de9b711 2073older version of Git. If the `*.pack` file is smaller than 2 GB, however,
c0a5e2d4 2074you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
6cf378f0 2075the `*.idx` file.
4d00bda2 2076
dbdbfec4 2077pack.packSizeLimit::
07cf0f24
NP
2078 The maximum size of a pack. This setting only affects
2079 packing to a file when repacking, i.e. the git:// protocol
6cf378f0 2080 is unaffected. It can be overridden by the `--max-pack-size`
07cf0f24
NP
2081 option of linkgit:git-repack[1]. The minimum size allowed is
2082 limited to 1 MiB. The default is unlimited.
2083 Common unit suffixes of 'k', 'm', or 'g' are
2084 supported.
2b84b5a8 2085
6b8fda2d
VM
2086pack.useBitmaps::
2087 When true, git will use pack bitmaps (if available) when packing
2088 to stdout (e.g., during the server side of a fetch). Defaults to
2089 true. You should not generally need to turn this off unless
2090 you are debugging pack bitmaps.
2091
da0005b8 2092pack.writeBitmaps (deprecated)::
71d76cb4 2093 This is a deprecated synonym for `repack.writeBitmaps`.
7cc8f971 2094
ae4f07fb
VM
2095pack.writeBitmapHashCache::
2096 When true, git will include a "hash cache" section in the bitmap
2097 index (if one is written). This cache can be used to feed git's
2098 delta heuristics, potentially leading to better deltas between
2099 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2100 between an older, bitmapped pack and objects that have been
2101 pushed since the last gc). The downside is that it consumes 4
2102 bytes per object of disk space, and that JGit's bitmap
2103 implementation does not understand it, causing it to complain if
2104 Git and JGit are used on the same repository. Defaults to false.
2105
4370c2d6 2106pager.<cmd>::
9bad7233 2107 If the value is boolean, turns on or off pagination of the
2de9b711 2108 output of a particular Git subcommand when writing to a tty.
9bad7233 2109 Otherwise, turns on pagination for the subcommand using the
6cf378f0
JK
2110 pager specified by the value of `pager.<cmd>`. If `--paginate`
2111 or `--no-pager` is specified on the command line, it takes
9bad7233
JK
2112 precedence over this option. To disable pagination for all
2113 commands, set `core.pager` or `GIT_PAGER` to `cat`.
4370c2d6 2114
8028184e
WP
2115pretty.<name>::
2116 Alias for a --pretty= format string, as specified in
2117 linkgit:git-log[1]. Any aliases defined here can be used just
2118 as the built-in pretty formats could. For example,
6cf378f0 2119 running `git config pretty.changelog "format:* %H %s"`
8028184e 2120 would cause the invocation `git log --pretty=changelog`
6cf378f0 2121 to be equivalent to running `git log "--pretty=format:* %H %s"`.
8028184e
WP
2122 Note that an alias with the same name as a built-in format
2123 will be silently ignored.
2124
b814da89
DA
2125pull.ff::
2126 By default, Git does not create an extra merge commit when merging
2127 a commit that is a descendant of the current commit. Instead, the
2128 tip of the current branch is fast-forwarded. When set to `false`,
2129 this variable tells Git to create an extra merge commit in such
2130 a case (equivalent to giving the `--no-ff` option from the command
2131 line). When set to `only`, only such fast-forward merges are
2132 allowed (equivalent to giving the `--ff-only` option from the
eb8dc05c 2133 command line). This setting overrides `merge.ff` when pulling.
b814da89 2134
6b37dff1
ÆAB
2135pull.rebase::
2136 When true, rebase branches on top of the fetched branch, instead
2137 of merging the default branch from the default remote when "git
2138 pull" is run. See "branch.<name>.rebase" for setting this on a
2139 per-branch basis.
66713ef3
SH
2140+
2141 When preserve, also pass `--preserve-merges` along to 'git rebase'
2142 so that locally committed merge commits will not be flattened
2143 by running 'git pull'.
6b37dff1
ÆAB
2144+
2145*NOTE*: this is a possibly dangerous operation; do *not* use
2146it unless you understand the implications (see linkgit:git-rebase[1]
2147for details).
2148
1ab661dd
PB
2149pull.octopus::
2150 The default merge strategy to use when pulling multiple branches
2151 at once.
2152
2153pull.twohead::
2154 The default merge strategy to use when pulling a single branch.
2155
52153747 2156push.default::
87a70e4c
RR
2157 Defines the action `git push` should take if no refspec is
2158 explicitly given. Different values are well-suited for
2159 specific workflows; for instance, in a purely central workflow
2160 (i.e. the fetch source is equal to the push destination),
2161 `upstream` is probably what you want. Possible values are:
52153747 2162+
b1290514 2163--
87a70e4c
RR
2164
2165* `nothing` - do not push anything (error out) unless a refspec is
2166 explicitly given. This is primarily meant for people who want to
2167 avoid mistakes by always being explicit.
2168
2169* `current` - push the current branch to update a branch with the same
2170 name on the receiving end. Works in both central and non-central
2171 workflows.
2172
2173* `upstream` - push the current branch back to the branch whose
2174 changes are usually integrated into the current branch (which is
2175 called `@{upstream}`). This mode only makes sense if you are
2176 pushing to the same repository you would normally pull from
2177 (i.e. central workflow).
2178
ed2b1829
RR
2179* `simple` - in centralized workflow, work like `upstream` with an
2180 added safety to refuse to push if the upstream branch's name is
2181 different from the local one.
b1290514 2182+
ed2b1829
RR
2183When pushing to a remote that is different from the remote you normally
2184pull from, work as `current`. This is the safest option and is suited
2185for beginners.
b1290514 2186+
009055f3 2187This mode has become the default in Git 2.0.
87a70e4c
RR
2188
2189* `matching` - push all branches having the same name on both ends.
2190 This makes the repository you are pushing to remember the set of
2191 branches that will be pushed out (e.g. if you always push 'maint'
2192 and 'master' there and no other branches, the repository you push
2193 to will have these two branches, and your local 'maint' and
2194 'master' will be pushed there).
2195+
2196To use this mode effectively, you have to make sure _all_ the
2197branches you would push out are ready to be pushed out before
2198running 'git push', as the whole point of this mode is to allow you
2199to push all of the branches in one go. If you usually finish work
2200on only one branch and push out the result, while other branches are
2201unfinished, this mode is not for you. Also this mode is not
2202suitable for pushing into a shared central repository, as other
2203people may add new branches there, or update the tip of existing
2204branches outside your control.
2205+
009055f3
JH
2206This used to be the default, but not since Git 2.0 (`simple` is the
2207new default).
87a70e4c
RR
2208
2209--
52153747 2210
a8bc269f
DO
2211push.followTags::
2212 If set to true enable '--follow-tags' option by default. You
2213 may override this configuration at time of push by specifying
2214 '--no-follow-tags'.
2215
2216
a9c3821c
TAV
2217rebase.stat::
2218 Whether to show a diffstat of what changed upstream since the last
2219 rebase. False by default.
2220
da0005b8 2221rebase.autoSquash::
dd1e5b31
HV
2222 If set to true enable '--autosquash' option by default.
2223
da0005b8 2224rebase.autoStash::
58794775
RR
2225 When set to true, automatically create a temporary stash
2226 before the operation begins, and apply it after the operation
2227 ends. This means that you can run rebase on a dirty worktree.
2228 However, use with care: the final stash application after a
2229 successful rebase might result in non-trivial conflicts.
2230 Defaults to false.
2231
37079959
GR
2232rebase.missingCommitsCheck::
2233 If set to "warn", git rebase -i will print a warning if some
2234 commits are removed (e.g. a line was deleted), however the
2235 rebase will still proceed. If set to "error", it will print
2236 the previous warning and stop the rebase, 'git rebase
2237 --edit-todo' can then be used to correct the error. If set to
2238 "ignore", no checking is done.
2239 To drop a commit without warning or error, use the `drop`
2240 command in the todo-list.
2241 Defaults to "ignore".
2242
16cf51c7
MR
2243rebase.instructionFormat
2244 A format string, as specified in linkgit:git-log[1], to be used for
2245 the instruction list during an interactive rebase. The format will automatically
2246 have the long commit hash prepended to the format.
2247
da0005b8 2248receive.advertiseAtomic::
04b39f19
SB
2249 By default, git-receive-pack will advertise the atomic push
2250 capability to its clients. If you don't want to this capability
2251 to be advertised, set this variable to false.
2252
77e3efbf
JH
2253receive.autogc::
2254 By default, git-receive-pack will run "git-gc --auto" after
2255 receiving data from git-push and updating refs. You can stop
2256 it by setting this variable to false.
2257
da0005b8 2258receive.certNonceSeed::
b89363e4
JH
2259 By setting this variable to a string, `git receive-pack`
2260 will accept a `git push --signed` and verifies it by using
2261 a "nonce" protected by HMAC using this string as a secret
2262 key.
2263
da0005b8 2264receive.certNonceSlop::
5732373d
JH
2265 When a `git push --signed` sent a push certificate with a
2266 "nonce" that was issued by a receive-pack serving the same
2267 repository within this many seconds, export the "nonce"
2268 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2269 hooks (instead of what the receive-pack asked the sending
2270 side to include). This may allow writing checks in
2271 `pre-receive` and `post-receive` a bit easier. Instead of
2272 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2273 that records by how many seconds the nonce is stale to
2274 decide if they want to accept the certificate, they only
2275 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2276
b0f34c3d
MM
2277receive.fsckObjects::
2278 If it is set to true, git-receive-pack will check all received
2279 objects. It will abort in the case of a malformed object or a
2280 broken link. The result of an abort are only dangling objects.
dab76d3a
JH
2281 Defaults to false. If not set, the value of `transfer.fsckObjects`
2282 is used instead.
b0f34c3d 2283
4b55b9b4
JS
2284receive.fsck.<msg-id>::
2285 When `receive.fsckObjects` is set to true, errors can be switched
2286 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2287 setting where the `<msg-id>` is the fsck message ID and the value
2288 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2289 the error/warning with the message ID, e.g. "missingEmail: invalid
2290 author/committer line - missing email" means that setting
2291 `receive.fsck.missingEmail = ignore` will hide that issue.
2292+
2293This feature is intended to support working with legacy repositories
2294which would not pass pushing when `receive.fsckObjects = true`, allowing
2295the host to accept repositories with certain known issues but still catch
2296other issues.
2297
cd94c6f9
JS
2298receive.fsck.skipList::
2299 The path to a sorted list of object names (i.e. one SHA-1 per
2300 line) that are known to be broken in a non-fatal way and should
2301 be ignored. This feature is useful when an established project
2302 should be accepted despite early commits containing errors that
2303 can be safely ignored such as invalid committer email addresses.
2304 Note: corrupt objects cannot be skipped with this setting.
2305
b0f34c3d
MM
2306receive.unpackLimit::
2307 If the number of objects received in a push is below this
2308 limit then the objects will be unpacked into loose object
2309 files. However if the number of received objects equals or
2310 exceeds this limit then the received pack will be stored as
2311 a pack, after adding any missing delta bases. Storing the
2312 pack from a push can make the push operation complete faster,
2313 especially on slow filesystems. If not set, the value of
2314 `transfer.unpackLimit` is used instead.
2315
42fc11c1
JH
2316receive.denyDeletes::
2317 If set to true, git-receive-pack will deny a ref update that deletes
2318 the ref. Use this to prevent such a ref deletion via a push.
2319
662c83ff
TR
2320receive.denyDeleteCurrent::
2321 If set to true, git-receive-pack will deny a ref update that
2322 deletes the currently checked out branch of a non-bare repository.
2323
42fc11c1 2324receive.denyCurrentBranch::
f3838ce1 2325 If set to true or "refuse", git-receive-pack will deny a ref update
42fc11c1
JH
2326 to the currently checked out branch of a non-bare repository.
2327 Such a push is potentially dangerous because it brings the HEAD
2328 out of sync with the index and working tree. If set to "warn",
2329 print a warning of such a push to stderr, but allow the push to
2330 proceed. If set to false or "ignore", allow such pushes with no
7d182f52 2331 message. Defaults to "refuse".
1404bcbb
JS
2332+
2333Another option is "updateInstead" which will update the working
08553319 2334tree if pushing into the current branch. This option is
1404bcbb
JS
2335intended for synchronizing working directories when one side is not easily
2336accessible via interactive ssh (e.g. a live web site, hence the requirement
2337that the working directory be clean). This mode also comes in handy when
2338developing inside a VM to test and fix code on different Operating Systems.
08553319
JH
2339+
2340By default, "updateInstead" will refuse the push if the working tree or
2341the index have any difference from the HEAD, but the `push-to-checkout`
2342hook can be used to customize this. See linkgit:githooks[5].
42fc11c1 2343
b0f34c3d
MM
2344receive.denyNonFastForwards::
2345 If set to true, git-receive-pack will deny a ref update which is
a75d7b54 2346 not a fast-forward. Use this to prevent such an update via a push,
b0f34c3d
MM
2347 even if that push is forced. This configuration variable is
2348 set when initializing a shared repository.
2349
da0005b8 2350receive.hideRefs::
cc118a65
JK
2351 This variable is the same as `transfer.hideRefs`, but applies
2352 only to `receive-pack` (and so affects pushes, but not fetches).
2353 An attempt to update or delete a hidden ref by `git push` is
2354 rejected.
daebaa78 2355
da0005b8 2356receive.updateServerInfo::
77e3efbf
JH
2357 If set to true, git-receive-pack will run git-update-server-info
2358 after receiving data from git-push and updating refs.
2359
da0005b8 2360receive.shallowUpdate::
0a1bc12b
NTND
2361 If set to true, .git/shallow can be updated when new refs
2362 require new shallow roots. Otherwise those refs are rejected.
2363
da0005b8 2364remote.pushDefault::
224c2171 2365 The remote to push to by default. Overrides
9f765ce6 2366 `branch.<name>.remote` for all branches, and is overridden by
da0005b8 2367 `branch.<name>.pushRemote` for specific branches.
224c2171 2368
0cc6d346 2369remote.<name>.url::
5162e697
DM
2370 The URL of a remote repository. See linkgit:git-fetch[1] or
2371 linkgit:git-push[1].
0cc6d346 2372
20346234
MG
2373remote.<name>.pushurl::
2374 The push URL of a remote repository. See linkgit:git-push[1].
2375
14c98218
SV
2376remote.<name>.proxy::
2377 For remotes that require curl (http, https and ftp), the URL to
2378 the proxy to use for that remote. Set to the empty string to
2379 disable proxying for that remote.
2380
0cc6d346 2381remote.<name>.fetch::
5162e697
DM
2382 The default set of "refspec" for linkgit:git-fetch[1]. See
2383 linkgit:git-fetch[1].
0cc6d346
SB
2384
2385remote.<name>.push::
5162e697
DM
2386 The default set of "refspec" for linkgit:git-push[1]. See
2387 linkgit:git-push[1].
0cc6d346 2388
84bb2dfd
PB
2389remote.<name>.mirror::
2390 If true, pushing to this remote will automatically behave
6cf378f0 2391 as if the `--mirror` option was given on the command line.
84bb2dfd 2392
1918278e
TT
2393remote.<name>.skipDefaultUpdate::
2394 If true, this remote will be skipped by default when updating
7cc91a2f
BG
2395 using linkgit:git-fetch[1] or the `update` subcommand of
2396 linkgit:git-remote[1].
2397
2398remote.<name>.skipFetchAll::
2399 If true, this remote will be skipped by default when updating
2400 using linkgit:git-fetch[1] or the `update` subcommand of
2401 linkgit:git-remote[1].
1918278e 2402
060aafc1 2403remote.<name>.receivepack::
5dee29ac 2404 The default program to execute on the remote side when pushing. See
1c262bb7 2405 option --receive-pack of linkgit:git-push[1].
060aafc1 2406
5dee29ac
UKK
2407remote.<name>.uploadpack::
2408 The default program to execute on the remote side when fetching. See
1c262bb7 2409 option --upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 2410
da0005b8 2411remote.<name>.tagOpt::
1c262bb7
JK
2412 Setting this value to --no-tags disables automatic tag following when
2413 fetching from remote <name>. Setting it to --tags will fetch every
944163a4 2414 tag from remote <name>, even if they are not reachable from remote
ed368546 2415 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1c262bb7 2416 override this setting. See options --tags and --no-tags of
ed368546 2417 linkgit:git-fetch[1].
047f636d 2418
c578f51d 2419remote.<name>.vcs::
2de9b711 2420 Setting this to a value <vcs> will cause Git to interact with
c578f51d
DB
2421 the remote with the git-remote-<vcs> helper.
2422
737c5a9c
MS
2423remote.<name>.prune::
2424 When set to true, fetching from this remote by default will also
0838bf47
MH
2425 remove any remote-tracking references that no longer exist on the
2426 remote (as if the `--prune` option was given on the command line).
737c5a9c
MS
2427 Overrides `fetch.prune` settings, if any.
2428
1918278e
TT
2429remotes.<group>::
2430 The list of remotes which are fetched by "git remote update
5162e697 2431 <group>". See linkgit:git-remote[1].
1918278e 2432
da0005b8 2433repack.useDeltaBaseOffset::
22c79eab
NP
2434 By default, linkgit:git-repack[1] creates packs that use
2435 delta-base offset. If you need to share your repository with
2de9b711 2436 Git older than version 1.4.4, either directly or via a dumb
22c79eab 2437 protocol such as http, then you need to set this option to
2de9b711 2438 "false" and repack. Access from old Git versions over the
22c79eab 2439 native protocol are unaffected by this option.
b6945f57 2440
ee34a2be
JK
2441repack.packKeptObjects::
2442 If set to true, makes `git repack` act as if
2443 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2444 details. Defaults to `false` normally, but `true` if a bitmap
2445 index is being written (either via `--write-bitmap-index` or
71d76cb4
JK
2446 `repack.writeBitmaps`).
2447
2448repack.writeBitmaps::
2449 When true, git will write a bitmap index when packing all
2450 objects to disk (e.g., when `git repack -a` is run). This
2451 index can speed up the "counting objects" phase of subsequent
2452 packs created for clones and fetches, at the cost of some disk
2453 space and extra time spent on the initial repack. Defaults to
2454 false.
ee34a2be 2455
da0005b8 2456rerere.autoUpdate::
b0f34c3d
MM
2457 When set to true, `git-rerere` updates the index with the
2458 resulting contents after it cleanly resolves conflicts using
2459 previously recorded resolution. Defaults to false.
2460
2461rerere.enabled::
2462 Activate recording of resolved conflicts, so that identical
07b88a00
TR
2463 conflict hunks can be resolved automatically, should they be
2464 encountered again. By default, linkgit:git-rerere[1] is
2465 enabled if there is an `rr-cache` directory under the
b6fb7fed
JH
2466 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2467 repository.
b0f34c3d 2468
65180c66
YD
2469sendemail.identity::
2470 A configuration identity. When given, causes values in the
2471 'sendemail.<identity>' subsection to take precedence over
2472 values in the 'sendemail' section. The default identity is
2473 the value of 'sendemail.identity'.
2474
da0005b8 2475sendemail.smtpEncryption::
65180c66
YD
2476 See linkgit:git-send-email[1] for description. Note that this
2477 setting is not subject to the 'identity' mechanism.
2478
502e7f98 2479sendemail.smtpssl (deprecated)::
da0005b8 2480 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
65180c66 2481
35035bbf
RR
2482sendemail.smtpsslcertpath::
2483 Path to ca-certificates (either a directory or a single file).
2484 Set it to an empty string to disable certificate verification.
2485
65180c66
YD
2486sendemail.<identity>.*::
2487 Identity-specific versions of the 'sendemail.*' parameters
2488 found below, taking precedence over those when the this
2489 identity is selected, through command-line or
2490 'sendemail.identity'.
2491
da0005b8
NTND
2492sendemail.aliasesFile::
2493sendemail.aliasFileType::
402596aa 2494sendemail.annotate::
65180c66
YD
2495sendemail.bcc::
2496sendemail.cc::
da0005b8
NTND
2497sendemail.ccCmd::
2498sendemail.chainReplyTo::
65180c66 2499sendemail.confirm::
da0005b8 2500sendemail.envelopeSender::
65180c66 2501sendemail.from::
da0005b8 2502sendemail.multiEdit::
65180c66 2503sendemail.signedoffbycc::
da0005b8 2504sendemail.smtpPass::
65180c66 2505sendemail.suppresscc::
da0005b8 2506sendemail.suppressFrom::
65180c66 2507sendemail.to::
da0005b8
NTND
2508sendemail.smtpDomain::
2509sendemail.smtpServer::
2510sendemail.smtpServerPort::
2511sendemail.smtpServerOption::
2512sendemail.smtpUser::
65180c66 2513sendemail.thread::
da0005b8 2514sendemail.transferEncoding::
65180c66 2515sendemail.validate::
ac1596a6 2516sendemail.xmailer::
65180c66
YD
2517 See linkgit:git-send-email[1] for description.
2518
502e7f98 2519sendemail.signedoffcc (deprecated)::
65180c66
YD
2520 Deprecated alias for 'sendemail.signedoffbycc'.
2521
1ab661dd 2522showbranch.default::
5162e697
DM
2523 The default set of branches for linkgit:git-show-branch[1].
2524 See linkgit:git-show-branch[1].
1ab661dd 2525
46f721c8 2526status.relativePaths::
5162e697 2527 By default, linkgit:git-status[1] shows paths relative to the
46f721c8 2528 current directory. Setting this variable to `false` shows paths
2de9b711 2529 relative to the repository root (this was the default for Git
46f721c8
JK
2530 prior to v1.5.4).
2531
4fb5166a
JJGG
2532status.short::
2533 Set to true to enable --short by default in linkgit:git-status[1].
2534 The option --no-short takes precedence over this variable.
2535
ec85d070
JJGG
2536status.branch::
2537 Set to true to enable --branch by default in linkgit:git-status[1].
2538 The option --no-branch takes precedence over this variable.
2539
2556b996
MM
2540status.displayCommentPrefix::
2541 If set to true, linkgit:git-status[1] will insert a comment
2542 prefix before each output line (starting with
2543 `core.commentChar`, i.e. `#` by default). This was the
2544 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2545 Defaults to false.
2546
d6293d1f
MSO
2547status.showUntrackedFiles::
2548 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2549 files which are not currently tracked by Git. Directories which
2550 contain only untracked files, are shown with the directory name
2551 only. Showing untracked files means that Git needs to lstat() all
71069cdf 2552 the files in the whole repository, which might be slow on some
d6293d1f
MSO
2553 systems. So, this variable controls how the commands displays
2554 the untracked files. Possible values are:
2555+
2556--
9373bdc4
CF
2557* `no` - Show no untracked files.
2558* `normal` - Show untracked files and directories.
2559* `all` - Show also individual files in untracked directories.
d6293d1f
MSO
2560--
2561+
2562If this variable is not specified, it defaults to 'normal'.
2563This variable can be overridden with the -u|--untracked-files option
2564of linkgit:git-status[1] and linkgit:git-commit[1].
2565
da0005b8 2566status.submoduleSummary::
4b2343fa
MG
2567 Defaults to false.
2568 If this is set to a non zero number or true (identical to -1 or an
2569 unlimited number), the submodule summary will be enabled and a
2570 summary of commits for modified submodules will be shown (see
bb58b696
JL
2571 --summary-limit option of linkgit:git-submodule[1]). Please note
2572 that the summary output command will be suppressed for all
2573 submodules when `diff.ignoreSubmodules` is set to 'all' or only
1d2f393a
JL
2574 for those submodules where `submodule.<name>.ignore=all`. The only
2575 exception to that rule is that status and commit will show staged
2576 submodule changes. To
bb58b696 2577 also view the summary for ignored submodules you can either use
06ab60c0 2578 the --ignore-submodules=dirty command-line option or the 'git
bb58b696
JL
2579 submodule summary' command, which shows a similar output but does
2580 not honor these settings.
4b2343fa 2581
0ad0a61f
JN
2582submodule.<name>.path::
2583submodule.<name>.url::
5c31acfb
MS
2584 The path within this project and URL for a submodule. These
2585 variables are initially populated by 'git submodule init'. See
2586 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2587 details.
2588
0ad0a61f 2589submodule.<name>.update::
5c31acfb
MS
2590 The default update procedure for a submodule. This variable
2591 is populated by `git submodule init` from the
2592 linkgit:gitmodules[5] file. See description of 'update'
2593 command in linkgit:git-submodule[1].
0ad0a61f 2594
06b1abb5
TK
2595submodule.<name>.branch::
2596 The remote branch name for a submodule, used by `git submodule
2597 update --remote`. Set this option to override the value found in
2598 the `.gitmodules` file. See linkgit:git-submodule[1] and
2599 linkgit:gitmodules[5] for details.
2600
c1a3c364 2601submodule.<name>.fetchRecurseSubmodules::
bf42b384 2602 This option can be used to control recursive fetching of this
469bfc96 2603 submodule. It can be overridden by using the --[no-]recurse-submodules
06ab60c0 2604 command-line option to "git fetch" and "git pull".
c1a3c364
JL
2605 This setting will override that from in the linkgit:gitmodules[5]
2606 file.
2607
aee9c7d6
JL
2608submodule.<name>.ignore::
2609 Defines under what circumstances "git status" and the diff family show
2610 a submodule as modified. When set to "all", it will never be considered
1d2f393a
JL
2611 modified (but it will nonetheless show up in the output of status and
2612 commit when it has been staged), "dirty" will ignore all changes
2613 to the submodules work tree and
aee9c7d6
JL
2614 takes only differences between the HEAD of the submodule and the commit
2615 recorded in the superproject into account. "untracked" will additionally
2616 let submodules with modified tracked files in their work tree show up.
2617 Using "none" (the default when this option is not set) also shows
2618 submodules that have untracked files in their work tree as changed.
302ad7a9 2619 This setting overrides any setting made in .gitmodules for this submodule,
3776ea9d 2620 both settings can be overridden on the command line by using the
bb58b696
JL
2621 "--ignore-submodules" option. The 'git submodule' commands are not
2622 affected by this setting.
aee9c7d6 2623
b150794d
JK
2624tag.sort::
2625 This variable controls the sort ordering of tags when displayed by
2626 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2627 value of this variable will be used as the default.
2628
ce1a79b6 2629tar.umask::
687157c7
RS
2630 This variable can be used to restrict the permission bits of
2631 tar archive entries. The default is 0002, which turns off the
2632 world write bit. The special value "user" indicates that the
2633 archiving user's umask will be used instead. See umask(2) and
5162e697 2634 linkgit:git-archive[1].
ce1a79b6 2635
dab76d3a
JH
2636transfer.fsckObjects::
2637 When `fetch.fsckObjects` or `receive.fsckObjects` are
2638 not set, the value of this variable is used instead.
2639 Defaults to false.
2640
da0005b8 2641transfer.hideRefs::
cc118a65
JK
2642 String(s) `receive-pack` and `upload-pack` use to decide which
2643 refs to omit from their initial advertisements. Use more than
2644 one definition to specify multiple prefix strings. A ref that is
2645 under the hierarchies listed in the value of this variable is
2646 excluded, and is hidden when responding to `git push` or `git
2647 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2648 program-specific versions of this config.
2bc31d16
JK
2649+
2650You may also include a `!` in front of the ref name to negate the entry,
2651explicitly exposing it, even if an earlier entry marked it as hidden.
2652If you have multiple hideRefs values, later entries override earlier ones
2653(and entries in more-specific config files override less-specific ones).
daebaa78 2654
b0f34c3d
MM
2655transfer.unpackLimit::
2656 When `fetch.unpackLimit` or `receive.unpackLimit` are
2657 not set, the value of this variable is used instead.
2658 The default value is 100.
2659
7671b632
SG
2660uploadarchive.allowUnreachable::
2661 If true, allow clients to use `git archive --remote` to request
2662 any tree, whether reachable from the ref tips or not. See the
2663 discussion in the `SECURITY` section of
2664 linkgit:git-upload-archive[1] for more details. Defaults to
2665 `false`.
2666
da0005b8 2667uploadpack.hideRefs::
cc118a65
JK
2668 This variable is the same as `transfer.hideRefs`, but applies
2669 only to `upload-pack` (and so affects only fetches, not pushes).
2670 An attempt to fetch a hidden ref by `git fetch` will fail. See
2671 also `uploadpack.allowTipSHA1InWant`.
390eb36b 2672
bc0a4741 2673uploadpack.allowTipSHA1InWant::
da0005b8 2674 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
390eb36b
JH
2675 to accept a fetch request that asks for an object at the tip
2676 of a hidden ref (by default, such a request is rejected).
da0005b8 2677 see also `uploadpack.hideRefs`.
daebaa78 2678
68ee6289
FM
2679uploadpack.allowReachableSHA1InWant::
2680 Allow `upload-pack` to accept a fetch request that asks for an
2681 object that is reachable from any ref tip. However, note that
2682 calculating object reachability is computationally expensive.
2683 Defaults to `false`.
2684
da0005b8 2685uploadpack.keepAlive::
05e95155
JK
2686 When `upload-pack` has started `pack-objects`, there may be a
2687 quiet period while `pack-objects` prepares the pack. Normally
2688 it would output progress information, but if `--quiet` was used
2689 for the fetch, `pack-objects` will output nothing at all until
2690 the pack data begins. Some clients and networks may consider
2691 the server to be hung and give up. Setting this option instructs
2692 `upload-pack` to send an empty keepalive packet every
da0005b8 2693 `uploadpack.keepAlive` seconds. Setting this option to 0
115dedd7 2694 disables keepalive packets entirely. The default is 5 seconds.
05e95155 2695
55029ae4
DB
2696url.<base>.insteadOf::
2697 Any URL that starts with this value will be rewritten to
2698 start, instead, with <base>. In cases where some site serves a
2699 large number of repositories, and serves them with multiple
2700 access methods, and some users need to use different access
2701 methods, this feature allows people to specify any of the
2de9b711 2702 equivalent URLs and have Git automatically rewrite the URL to
55029ae4 2703 the best alternative for the particular user, even for a
844112ca
JH
2704 never-before-seen repository on the site. When more than one
2705 insteadOf strings match a given URL, the longest match is used.
55029ae4 2706
1c2eafb8
JT
2707url.<base>.pushInsteadOf::
2708 Any URL that starts with this value will not be pushed to;
2709 instead, it will be rewritten to start with <base>, and the
2710 resulting URL will be pushed to. In cases where some site serves
2711 a large number of repositories, and serves them with multiple
2712 access methods, some of which do not allow push, this feature
2de9b711 2713 allows people to specify a pull-only URL and have Git
1c2eafb8
JT
2714 automatically use an appropriate URL to push, even for a
2715 never-before-seen repository on the site. When more than one
2716 pushInsteadOf strings match a given URL, the longest match is
2de9b711 2717 used. If a remote has an explicit pushurl, Git will ignore this
1c2eafb8
JT
2718 setting for that remote.
2719
1ab661dd
PB
2720user.email::
2721 Your email address to be recorded in any newly created commits.
28a94f88 2722 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 2723 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
2724
2725user.name::
2726 Your full name to be recorded in any newly created commits.
abda1ef5 2727 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 2728 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 2729
da0005b8 2730user.signingKey::
f0551693
NV
2731 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2732 key you want it to automatically when creating a signed tag or
2733 commit, you can override the default selection with this variable.
2734 This option is passed unchanged to gpg's --local-user parameter,
2735 so you may specify a key using any method that gpg supports.
d67778ec 2736
d811c8e1
NTND
2737versionsort.prereleaseSuffix::
2738 When version sort is used in linkgit:git-tag[1], prerelease
2739 tags (e.g. "1.0-rc1") may appear after the main release
2740 "1.0". By specifying the suffix "-rc" in this variable,
5751a3d1
NTND
2741 "1.0-rc1" will appear before "1.0".
2742+
2743This variable can be specified multiple times, once per suffix. The
2744order of suffixes in the config file determines the sorting order
2745(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2746is sorted before 1.0-rcXX). The sorting order between different
2747suffixes is undefined if they are in multiple config files.
d811c8e1 2748
983a9eeb
CC
2749web.browser::
2750 Specify a web browser that may be used by some commands.
2751 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2752 may use it.