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