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