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