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