mingw: unset PERL5LIB by default
[git/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
10
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
18 multivalued.
19
20 Syntax
21 ~~~~~~
22
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
26
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
33
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
37
38 --------
39 [section "subsection"]
40
41 --------
42
43 Subsection names are case sensitive and can contain any characters except
44 newline and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
50 need to.
51
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
56
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
63
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
70 verbatim.
71
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
74
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
79
80
81 Includes
82 ~~~~~~~~
83
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
88 below.
89
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
94
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
100
101 Conditional includes
102 ~~~~~~~~~~~~~~~~~~~~
103
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
106 included.
107
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
110 are:
111
112 `gitdir`::
113
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
117 +
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
122 .git file is.
123 +
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
127
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
130
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
133
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
137
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
141
142 `gitdir/i`::
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
145
146 A few more notes on matching via `gitdir` and `gitdir/i`:
147
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
149
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
153 will match.
154 +
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
159
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
162
163 Example
164 ~~~~~~~
165
166 # Core variables
167 [core]
168 ; Don't trust file modes
169 filemode = false
170
171 # Our diff algorithm
172 [diff]
173 external = /usr/local/bin/diff-wrapper
174 renames = true
175
176 [branch "devel"]
177 remote = origin
178 merge = refs/heads/devel
179
180 # Proxy settings
181 [core]
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
184
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
189
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
193
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
197
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
201
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
206 path = foo.inc
207
208 Values
209 ~~~~~~
210
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
214
215 boolean::
216
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
219 case-insensitive.
220
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
223 is taken as true.
224
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
227 +
228 When converting a value to its canonical form using the `--type=bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
231
232 integer::
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
236
237 color::
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
241 +
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
245 +
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
249 hex, like `#ff0ab3`.
250 +
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
256 `no-ul`, etc).
257 +
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
260 +
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
269
270 pathname::
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
276
277
278 Variables
279 ~~~~~~~~~
280
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
284
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
289
290
291 advice.*::
292 These variables control various optional help messages designed to
293 aid new users. All 'advice.*' variables default to 'true', and you
294 can tell Git that you do not need help by setting these to 'false':
295 +
296 --
297 pushUpdateRejected::
298 Set this variable to 'false' if you want to disable
299 'pushNonFFCurrent',
300 'pushNonFFMatching', 'pushAlreadyExists',
301 'pushFetchFirst', and 'pushNeedsForce'
302 simultaneously.
303 pushNonFFCurrent::
304 Advice shown when linkgit:git-push[1] fails due to a
305 non-fast-forward update to the current branch.
306 pushNonFFMatching::
307 Advice shown when you ran linkgit:git-push[1] and pushed
308 'matching refs' explicitly (i.e. you used ':', or
309 specified a refspec that isn't your current branch) and
310 it resulted in a non-fast-forward error.
311 pushAlreadyExists::
312 Shown when linkgit:git-push[1] rejects an update that
313 does not qualify for fast-forwarding (e.g., a tag.)
314 pushFetchFirst::
315 Shown when linkgit:git-push[1] rejects an update that
316 tries to overwrite a remote ref that points at an
317 object we do not have.
318 pushNeedsForce::
319 Shown when linkgit:git-push[1] rejects an update that
320 tries to overwrite a remote ref that points at an
321 object that is not a commit-ish, or make the remote
322 ref point at an object that is not a commit-ish.
323 statusHints::
324 Show directions on how to proceed from the current
325 state in the output of linkgit:git-status[1], in
326 the template shown when writing commit messages in
327 linkgit:git-commit[1], and in the help message shown
328 by linkgit:git-checkout[1] when switching branch.
329 statusUoption::
330 Advise to consider using the `-u` option to linkgit:git-status[1]
331 when the command takes more than 2 seconds to enumerate untracked
332 files.
333 commitBeforeMerge::
334 Advice shown when linkgit:git-merge[1] refuses to
335 merge to avoid overwriting local changes.
336 resolveConflict::
337 Advice shown by various commands when conflicts
338 prevent the operation from being performed.
339 implicitIdentity::
340 Advice on how to set your identity configuration when
341 your information is guessed from the system username and
342 domain name.
343 detachedHead::
344 Advice shown when you used linkgit:git-checkout[1] to
345 move to the detach HEAD state, to instruct how to create
346 a local branch after the fact.
347 checkoutAmbiguousRemoteBranchName::
348 Advice shown when the argument to
349 linkgit:git-checkout[1] ambiguously resolves to a
350 remote tracking branch on more than one remote in
351 situations where an unambiguous argument would have
352 otherwise caused a remote-tracking branch to be
353 checked out. See the `checkout.defaultRemote`
354 configuration variable for how to set a given remote
355 to used by default in some situations where this
356 advice would be printed.
357 amWorkDir::
358 Advice that shows the location of the patch file when
359 linkgit:git-am[1] fails to apply it.
360 rmHints::
361 In case of failure in the output of linkgit:git-rm[1],
362 show directions on how to proceed from the current state.
363 addEmbeddedRepo::
364 Advice on what to do when you've accidentally added one
365 git repo inside of another.
366 ignoredHook::
367 Advice shown if a hook is ignored because the hook is not
368 set as executable.
369 waitingForEditor::
370 Print a message to the terminal whenever Git is waiting for
371 editor input from the user.
372 --
373
374 core.fileMode::
375 Tells Git if the executable bit of files in the working tree
376 is to be honored.
377 +
378 Some filesystems lose the executable bit when a file that is
379 marked as executable is checked out, or checks out a
380 non-executable file with executable bit on.
381 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
382 to see if it handles the executable bit correctly
383 and this variable is automatically set as necessary.
384 +
385 A repository, however, may be on a filesystem that handles
386 the filemode correctly, and this variable is set to 'true'
387 when created, but later may be made accessible from another
388 environment that loses the filemode (e.g. exporting ext4 via
389 CIFS mount, visiting a Cygwin created repository with
390 Git for Windows or Eclipse).
391 In such a case it may be necessary to set this variable to 'false'.
392 See linkgit:git-update-index[1].
393 +
394 The default is true (when core.filemode is not specified in the config file).
395
396 core.hideDotFiles::
397 (Windows-only) If true, mark newly-created directories and files whose
398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
399 directory is hidden, but no other files starting with a dot. The
400 default mode is 'dotGitOnly'.
401
402 core.ignoreCase::
403 Internal variable which enables various workarounds to enable
404 Git to work better on filesystems that are not case sensitive,
405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
406 finds "makefile" when Git expects "Makefile", Git will assume
407 it is really the same file, and continue to remember it as
408 "Makefile".
409 +
410 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
411 will probe and set core.ignoreCase true if appropriate when the repository
412 is created.
413 +
414 Git relies on the proper configuration of this variable for your operating
415 and file system. Modifying this value may result in unexpected behavior.
416
417 core.precomposeUnicode::
418 This option is only used by Mac OS implementation of Git.
419 When core.precomposeUnicode=true, Git reverts the unicode decomposition
420 of filenames done by Mac OS. This is useful when sharing a repository
421 between Mac OS and Linux or Windows.
422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
423 When false, file names are handled fully transparent by Git,
424 which is backward compatible with older versions of Git.
425
426 core.protectHFS::
427 If set to true, do not allow checkout of paths that would
428 be considered equivalent to `.git` on an HFS+ filesystem.
429 Defaults to `true` on Mac OS, and `false` elsewhere.
430
431 core.protectNTFS::
432 If set to true, do not allow checkout of paths that would
433 cause problems with the NTFS filesystem, e.g. conflict with
434 8.3 "short" names.
435 Defaults to `true` on Windows, and `false` elsewhere.
436
437 core.fsmonitor::
438 If set, the value of this variable is used as a command which
439 will identify all files that may have changed since the
440 requested date/time. This information is used to speed up git by
441 avoiding unnecessary processing of files that have not changed.
442 See the "fsmonitor-watchman" section of linkgit:githooks[5].
443
444 core.trustctime::
445 If false, the ctime differences between the index and the
446 working tree are ignored; useful when the inode change time
447 is regularly modified by something outside Git (file system
448 crawlers and some backup systems).
449 See linkgit:git-update-index[1]. True by default.
450
451 core.splitIndex::
452 If true, the split-index feature of the index will be used.
453 See linkgit:git-update-index[1]. False by default.
454
455 core.untrackedCache::
456 Determines what to do about the untracked cache feature of the
457 index. It will be kept, if this variable is unset or set to
458 `keep`. It will automatically be added if set to `true`. And
459 it will automatically be removed, if set to `false`. Before
460 setting it to `true`, you should check that mtime is working
461 properly on your system.
462 See linkgit:git-update-index[1]. `keep` by default.
463
464 core.checkStat::
465 When missing or is set to `default`, many fields in the stat
466 structure are checked to detect if a file has been modified
467 since Git looked at it. When this configuration variable is
468 set to `minimal`, sub-second part of mtime and ctime, the
469 uid and gid of the owner of the file, the inode number (and
470 the device number, if Git was compiled to use it), are
471 excluded from the check among these fields, leaving only the
472 whole-second part of mtime (and ctime, if `core.trustCtime`
473 is set) and the filesize to be checked.
474 +
475 There are implementations of Git that do not leave usable values in
476 some fields (e.g. JGit); by excluding these fields from the
477 comparison, the `minimal` mode may help interoperability when the
478 same repository is used by these other systems at the same time.
479
480 core.quotePath::
481 Commands that output paths (e.g. 'ls-files', 'diff'), will
482 quote "unusual" characters in the pathname by enclosing the
483 pathname in double-quotes and escaping those characters with
484 backslashes in the same way C escapes control characters (e.g.
485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in
487 UTF-8). If this variable is set to false, bytes higher than
488 0x80 are not considered "unusual" any more. Double-quotes,
489 backslash and control characters are always escaped regardless
490 of the setting of this variable. A simple space character is
491 not considered "unusual". Many commands can output pathnames
492 completely verbatim using the `-z` option. The default value
493 is true.
494
495 core.eol::
496 Sets the line ending type to use in the working directory for
497 files that have the `text` property set when core.autocrlf is false.
498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
499 native line ending. The default value is `native`. See
500 linkgit:gitattributes[5] for more information on end-of-line
501 conversion.
502
503 core.safecrlf::
504 If true, makes Git check if converting `CRLF` is reversible when
505 end-of-line conversion is active. Git will verify if a command
506 modifies a file in the work tree either directly or indirectly.
507 For example, committing a file followed by checking out the
508 same file should yield the original file in the work tree. If
509 this is not the case for the current setting of
510 `core.autocrlf`, Git will reject the file. The variable can
511 be set to "warn", in which case Git will only warn about an
512 irreversible conversion but continue the operation.
513 +
514 CRLF conversion bears a slight chance of corrupting data.
515 When it is enabled, Git will convert CRLF to LF during commit and LF to
516 CRLF during checkout. A file that contains a mixture of LF and
517 CRLF before the commit cannot be recreated by Git. For text
518 files this is the right thing to do: it corrects line endings
519 such that we have only LF line endings in the repository.
520 But for binary files that are accidentally classified as text the
521 conversion can corrupt data.
522 +
523 If you recognize such corruption early you can easily fix it by
524 setting the conversion type explicitly in .gitattributes. Right
525 after committing you still have the original file in your work
526 tree and this file is not yet corrupted. You can explicitly tell
527 Git that this file is binary and Git will handle the file
528 appropriately.
529 +
530 Unfortunately, the desired effect of cleaning up text files with
531 mixed line endings and the undesired effect of corrupting binary
532 files cannot be distinguished. In both cases CRLFs are removed
533 in an irreversible way. For text files this is the right thing
534 to do because CRLFs are line endings, while for binary files
535 converting CRLFs corrupts data.
536 +
537 Note, this safety check does not mean that a checkout will generate a
538 file identical to the original file for a different setting of
539 `core.eol` and `core.autocrlf`, but only for the current one. For
540 example, a text file with `LF` would be accepted with `core.eol=lf`
541 and could later be checked out with `core.eol=crlf`, in which case the
542 resulting file would contain `CRLF`, although the original file
543 contained `LF`. However, in both work trees the line endings would be
544 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
545 file with mixed line endings would be reported by the `core.safecrlf`
546 mechanism.
547
548 core.autocrlf::
549 Setting this variable to "true" is the same as setting
550 the `text` attribute to "auto" on all files and core.eol to "crlf".
551 Set to true if you want to have `CRLF` line endings in your
552 working directory and the repository has LF line endings.
553 This variable can be set to 'input',
554 in which case no output conversion is performed.
555
556 core.checkRoundtripEncoding::
557 A comma and/or whitespace separated list of encodings that Git
558 performs UTF-8 round trip checks on if they are used in an
559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
560 The default value is `SHIFT-JIS`.
561
562 core.symlinks::
563 If false, symbolic links are checked out as small plain files that
564 contain the link text. linkgit:git-update-index[1] and
565 linkgit:git-add[1] will not change the recorded type to regular
566 file. Useful on filesystems like FAT that do not support
567 symbolic links.
568 +
569 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
570 will probe and set core.symlinks false if appropriate when the repository
571 is created.
572
573 core.gitProxy::
574 A "proxy command" to execute (as 'command host port') instead
575 of establishing direct connection to the remote server when
576 using the Git protocol for fetching. If the variable value is
577 in the "COMMAND for DOMAIN" format, the command is applied only
578 on hostnames ending with the specified domain string. This variable
579 may be set multiple times and is matched in the given order;
580 the first match wins.
581 +
582 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
583 (which always applies universally, without the special "for"
584 handling).
585 +
586 The special string `none` can be used as the proxy command to
587 specify that no proxy be used for a given domain pattern.
588 This is useful for excluding servers inside a firewall from
589 proxy use, while defaulting to a common proxy for external domains.
590
591 core.sshCommand::
592 If this variable is set, `git fetch` and `git push` will
593 use the specified command instead of `ssh` when they need to
594 connect to a remote system. The command is in the same form as
595 the `GIT_SSH_COMMAND` environment variable and is overridden
596 when the environment variable is set.
597
598 core.ignoreStat::
599 If true, Git will avoid using lstat() calls to detect if files have
600 changed by setting the "assume-unchanged" bit for those tracked files
601 which it has updated identically in both the index and working tree.
602 +
603 When files are modified outside of Git, the user will need to stage
604 the modified files explicitly (e.g. see 'Examples' section in
605 linkgit:git-update-index[1]).
606 Git will not normally detect changes to those files.
607 +
608 This is useful on systems where lstat() calls are very slow, such as
609 CIFS/Microsoft Windows.
610 +
611 False by default.
612
613 core.preferSymlinkRefs::
614 Instead of the default "symref" format for HEAD
615 and other symbolic reference files, use symbolic links.
616 This is sometimes needed to work with old scripts that
617 expect HEAD to be a symbolic link.
618
619 core.alternateRefsCommand::
620 When advertising tips of available history from an alternate, use the shell to
621 execute the specified command instead of linkgit:git-for-each-ref[1]. The
622 first argument is the absolute path of the alternate. Output must contain one
623 hex object id per line (i.e., the same as produced by `git for-each-ref
624 --format='%(objectname)'`).
625 +
626 Note that you cannot generally put `git for-each-ref` directly into the config
627 value, as it does not take a repository path as an argument (but you can wrap
628 the command above in a shell script).
629
630 core.alternateRefsPrefixes::
631 When listing references from an alternate, list only references that begin
632 with the given prefix. Prefixes match as if they were given as arguments to
633 linkgit:git-for-each-ref[1]. To list multiple prefixes, separate them with
634 whitespace. If `core.alternateRefsCommand` is set, setting
635 `core.alternateRefsPrefixes` has no effect.
636
637 core.bare::
638 If true this repository is assumed to be 'bare' and has no
639 working directory associated with it. If this is the case a
640 number of commands that require a working directory will be
641 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
642 +
643 This setting is automatically guessed by linkgit:git-clone[1] or
644 linkgit:git-init[1] when the repository was created. By default a
645 repository that ends in "/.git" is assumed to be not bare (bare =
646 false), while all other repositories are assumed to be bare (bare
647 = true).
648
649 core.worktree::
650 Set the path to the root of the working tree.
651 If `GIT_COMMON_DIR` environment variable is set, core.worktree
652 is ignored and not used for determining the root of working tree.
653 This can be overridden by the `GIT_WORK_TREE` environment
654 variable and the `--work-tree` command-line option.
655 The value can be an absolute path or relative to the path to
656 the .git directory, which is either specified by --git-dir
657 or GIT_DIR, or automatically discovered.
658 If --git-dir or GIT_DIR is specified but none of
659 --work-tree, GIT_WORK_TREE and core.worktree is specified,
660 the current working directory is regarded as the top level
661 of your working tree.
662 +
663 Note that this variable is honored even when set in a configuration
664 file in a ".git" subdirectory of a directory and its value differs
665 from the latter directory (e.g. "/path/to/.git/config" has
666 core.worktree set to "/different/path"), which is most likely a
667 misconfiguration. Running Git commands in the "/path/to" directory will
668 still use "/different/path" as the root of the work tree and can cause
669 confusion unless you know what you are doing (e.g. you are creating a
670 read-only snapshot of the same index to a location different from the
671 repository's usual working tree).
672
673 core.logAllRefUpdates::
674 Enable the reflog. Updates to a ref <ref> is logged to the file
675 "`$GIT_DIR/logs/<ref>`", by appending the new and old
676 SHA-1, the date/time and the reason of the update, but
677 only when the file exists. If this configuration
678 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
679 file is automatically created for branch heads (i.e. under
680 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
681 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
682 If it is set to `always`, then a missing reflog is automatically
683 created for any ref under `refs/`.
684 +
685 This information can be used to determine what commit
686 was the tip of a branch "2 days ago".
687 +
688 This value is true by default in a repository that has
689 a working directory associated with it, and false by
690 default in a bare repository.
691
692 core.repositoryFormatVersion::
693 Internal variable identifying the repository format and layout
694 version.
695
696 core.sharedRepository::
697 When 'group' (or 'true'), the repository is made shareable between
698 several users in a group (making sure all the files and objects are
699 group-writable). When 'all' (or 'world' or 'everybody'), the
700 repository will be readable by all users, additionally to being
701 group-shareable. When 'umask' (or 'false'), Git will use permissions
702 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
703 files in the repository will have this mode value. '0xxx' will override
704 user's umask value (whereas the other options will only override
705 requested parts of the user's umask value). Examples: '0660' will make
706 the repo read/write-able for the owner and group, but inaccessible to
707 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
708 repository that is group-readable but not group-writable.
709 See linkgit:git-init[1]. False by default.
710
711 core.warnAmbiguousRefs::
712 If true, Git will warn you if the ref name you passed it is ambiguous
713 and might match multiple refs in the repository. True by default.
714
715 core.compression::
716 An integer -1..9, indicating a default compression level.
717 -1 is the zlib default. 0 means no compression,
718 and 1..9 are various speed/size tradeoffs, 9 being slowest.
719 If set, this provides a default to other compression variables,
720 such as `core.looseCompression` and `pack.compression`.
721
722 core.looseCompression::
723 An integer -1..9, indicating the compression level for objects that
724 are not in a pack file. -1 is the zlib default. 0 means no
725 compression, and 1..9 are various speed/size tradeoffs, 9 being
726 slowest. If not set, defaults to core.compression. If that is
727 not set, defaults to 1 (best speed).
728
729 core.packedGitWindowSize::
730 Number of bytes of a pack file to map into memory in a
731 single mapping operation. Larger window sizes may allow
732 your system to process a smaller number of large pack files
733 more quickly. Smaller window sizes will negatively affect
734 performance due to increased calls to the operating system's
735 memory manager, but may improve performance when accessing
736 a large number of large pack files.
737 +
738 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
739 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
740 be reasonable for all users/operating systems. You probably do
741 not need to adjust this value.
742 +
743 Common unit suffixes of 'k', 'm', or 'g' are supported.
744
745 core.packedGitLimit::
746 Maximum number of bytes to map simultaneously into memory
747 from pack files. If Git needs to access more than this many
748 bytes at once to complete an operation it will unmap existing
749 regions to reclaim virtual address space within the process.
750 +
751 Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
752 unlimited) on 64 bit platforms.
753 This should be reasonable for all users/operating systems, except on
754 the largest projects. You probably do not need to adjust this value.
755 +
756 Common unit suffixes of 'k', 'm', or 'g' are supported.
757
758 core.deltaBaseCacheLimit::
759 Maximum number of bytes to reserve for caching base objects
760 that may be referenced by multiple deltified objects. By storing the
761 entire decompressed base objects in a cache Git is able
762 to avoid unpacking and decompressing frequently used base
763 objects multiple times.
764 +
765 Default is 96 MiB on all platforms. This should be reasonable
766 for all users/operating systems, except on the largest projects.
767 You probably do not need to adjust this value.
768 +
769 Common unit suffixes of 'k', 'm', or 'g' are supported.
770
771 core.bigFileThreshold::
772 Files larger than this size are stored deflated, without
773 attempting delta compression. Storing large files without
774 delta compression avoids excessive memory usage, at the
775 slight expense of increased disk usage. Additionally files
776 larger than this size are always treated as binary.
777 +
778 Default is 512 MiB on all platforms. This should be reasonable
779 for most projects as source code and other text files can still
780 be delta compressed, but larger binary media files won't be.
781 +
782 Common unit suffixes of 'k', 'm', or 'g' are supported.
783
784 core.excludesFile::
785 Specifies the pathname to the file that contains patterns to
786 describe paths that are not meant to be tracked, in addition
787 to '.gitignore' (per-directory) and '.git/info/exclude'.
788 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
789 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
790 is used instead. See linkgit:gitignore[5].
791
792 core.askPass::
793 Some commands (e.g. svn and http interfaces) that interactively
794 ask for a password can be told to use an external program given
795 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
796 environment variable. If not set, fall back to the value of the
797 `SSH_ASKPASS` environment variable or, failing that, a simple password
798 prompt. The external program shall be given a suitable prompt as
799 command-line argument and write the password on its STDOUT.
800
801 core.attributesFile::
802 In addition to '.gitattributes' (per-directory) and
803 '.git/info/attributes', Git looks into this file for attributes
804 (see linkgit:gitattributes[5]). Path expansions are made the same
805 way as for `core.excludesFile`. Its default value is
806 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
807 set or empty, `$HOME/.config/git/attributes` is used instead.
808
809 core.hooksPath::
810 By default Git will look for your hooks in the
811 '$GIT_DIR/hooks' directory. Set this to different path,
812 e.g. '/etc/git/hooks', and Git will try to find your hooks in
813 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
814 in '$GIT_DIR/hooks/pre-receive'.
815 +
816 The path can be either absolute or relative. A relative path is
817 taken as relative to the directory where the hooks are run (see
818 the "DESCRIPTION" section of linkgit:githooks[5]).
819 +
820 This configuration variable is useful in cases where you'd like to
821 centrally configure your Git hooks instead of configuring them on a
822 per-repository basis, or as a more flexible and centralized
823 alternative to having an `init.templateDir` where you've changed
824 default hooks.
825
826 core.editor::
827 Commands such as `commit` and `tag` that let you edit
828 messages by launching an editor use the value of this
829 variable when it is set, and the environment variable
830 `GIT_EDITOR` is not set. See linkgit:git-var[1].
831
832 core.commentChar::
833 Commands such as `commit` and `tag` that let you edit
834 messages consider a line that begins with this character
835 commented, and removes them after the editor returns
836 (default '#').
837 +
838 If set to "auto", `git-commit` would select a character that is not
839 the beginning character of any line in existing commit messages.
840
841 core.filesRefLockTimeout::
842 The length of time, in milliseconds, to retry when trying to
843 lock an individual reference. Value 0 means not to retry at
844 all; -1 means to try indefinitely. Default is 100 (i.e.,
845 retry for 100ms).
846
847 core.packedRefsTimeout::
848 The length of time, in milliseconds, to retry when trying to
849 lock the `packed-refs` file. Value 0 means not to retry at
850 all; -1 means to try indefinitely. Default is 1000 (i.e.,
851 retry for 1 second).
852
853 core.pager::
854 Text viewer for use by Git commands (e.g., 'less'). The value
855 is meant to be interpreted by the shell. The order of preference
856 is the `$GIT_PAGER` environment variable, then `core.pager`
857 configuration, then `$PAGER`, and then the default chosen at
858 compile time (usually 'less').
859 +
860 When the `LESS` environment variable is unset, Git sets it to `FRX`
861 (if `LESS` environment variable is set, Git does not change it at
862 all). If you want to selectively override Git's default setting
863 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
864 be passed to the shell by Git, which will translate the final
865 command to `LESS=FRX less -S`. The environment does not set the
866 `S` option but the command line does, instructing less to truncate
867 long lines. Similarly, setting `core.pager` to `less -+F` will
868 deactivate the `F` option specified by the environment from the
869 command-line, deactivating the "quit if one screen" behavior of
870 `less`. One can specifically activate some flags for particular
871 commands: for example, setting `pager.blame` to `less -S` enables
872 line truncation only for `git blame`.
873 +
874 Likewise, when the `LV` environment variable is unset, Git sets it
875 to `-c`. You can override this setting by exporting `LV` with
876 another value or setting `core.pager` to `lv +c`.
877
878 core.whitespace::
879 A comma separated list of common whitespace problems to
880 notice. 'git diff' will use `color.diff.whitespace` to
881 highlight them, and 'git apply --whitespace=error' will
882 consider them as errors. You can prefix `-` to disable
883 any of them (e.g. `-trailing-space`):
884 +
885 * `blank-at-eol` treats trailing whitespaces at the end of the line
886 as an error (enabled by default).
887 * `space-before-tab` treats a space character that appears immediately
888 before a tab character in the initial indent part of the line as an
889 error (enabled by default).
890 * `indent-with-non-tab` treats a line that is indented with space
891 characters instead of the equivalent tabs as an error (not enabled by
892 default).
893 * `tab-in-indent` treats a tab character in the initial indent part of
894 the line as an error (not enabled by default).
895 * `blank-at-eof` treats blank lines added at the end of file as an error
896 (enabled by default).
897 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
898 `blank-at-eof`.
899 * `cr-at-eol` treats a carriage-return at the end of line as
900 part of the line terminator, i.e. with it, `trailing-space`
901 does not trigger if the character before such a carriage-return
902 is not a whitespace (not enabled by default).
903 * `tabwidth=<n>` tells how many character positions a tab occupies; this
904 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
905 errors. The default tab width is 8. Allowed values are 1 to 63.
906
907 core.fsyncObjectFiles::
908 This boolean will enable 'fsync()' when writing object files.
909 +
910 This is a total waste of time and effort on a filesystem that orders
911 data writes properly, but can be useful for filesystems that do not use
912 journalling (traditional UNIX filesystems) or that only journal metadata
913 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
914
915 core.preloadIndex::
916 Enable parallel index preload for operations like 'git diff'
917 +
918 This can speed up operations like 'git diff' and 'git status' especially
919 on filesystems like NFS that have weak caching semantics and thus
920 relatively high IO latencies. When enabled, Git will do the
921 index comparison to the filesystem data in parallel, allowing
922 overlapping IO's. Defaults to true.
923
924 core.unsetenvvars::
925 Windows-only: comma-separated list of environment variables'
926 names that need to be unset before spawning any other process.
927 Defaults to `PERL5LIB` to account for the fact that Git for
928 Windows insists on using its own Perl interpreter.
929
930 core.createObject::
931 You can set this to 'link', in which case a hardlink followed by
932 a delete of the source are used to make sure that object creation
933 will not overwrite existing objects.
934 +
935 On some file system/operating system combinations, this is unreliable.
936 Set this config setting to 'rename' there; However, This will remove the
937 check that makes sure that existing object files will not get overwritten.
938
939 core.notesRef::
940 When showing commit messages, also show notes which are stored in
941 the given ref. The ref must be fully qualified. If the given
942 ref does not exist, it is not an error but means that no
943 notes should be printed.
944 +
945 This setting defaults to "refs/notes/commits", and it can be overridden by
946 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
947
948 core.commitGraph::
949 If true, then git will read the commit-graph file (if it exists)
950 to parse the graph structure of commits. Defaults to false. See
951 linkgit:git-commit-graph[1] for more information.
952
953 core.useReplaceRefs::
954 If set to `false`, behave as if the `--no-replace-objects`
955 option was given on the command line. See linkgit:git[1] and
956 linkgit:git-replace[1] for more information.
957
958 core.multiPackIndex::
959 Use the multi-pack-index file to track multiple packfiles using a
960 single index. See link:technical/multi-pack-index.html[the
961 multi-pack-index design document].
962
963 core.sparseCheckout::
964 Enable "sparse checkout" feature. See section "Sparse checkout" in
965 linkgit:git-read-tree[1] for more information.
966
967 core.abbrev::
968 Set the length object names are abbreviated to. If
969 unspecified or set to "auto", an appropriate value is
970 computed based on the approximate number of packed objects
971 in your repository, which hopefully is enough for
972 abbreviated object names to stay unique for some time.
973 The minimum length is 4.
974
975 add.ignoreErrors::
976 add.ignore-errors (deprecated)::
977 Tells 'git add' to continue adding files when some files cannot be
978 added due to indexing errors. Equivalent to the `--ignore-errors`
979 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
980 as it does not follow the usual naming convention for configuration
981 variables.
982
983 alias.*::
984 Command aliases for the linkgit:git[1] command wrapper - e.g.
985 after defining "alias.last = cat-file commit HEAD", the invocation
986 "git last" is equivalent to "git cat-file commit HEAD". To avoid
987 confusion and troubles with script usage, aliases that
988 hide existing Git commands are ignored. Arguments are split by
989 spaces, the usual shell quoting and escaping is supported.
990 A quote pair or a backslash can be used to quote them.
991 +
992 If the alias expansion is prefixed with an exclamation point,
993 it will be treated as a shell command. For example, defining
994 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
995 "git new" is equivalent to running the shell command
996 "gitk --all --not ORIG_HEAD". Note that shell commands will be
997 executed from the top-level directory of a repository, which may
998 not necessarily be the current directory.
999 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
1000 from the original current directory. See linkgit:git-rev-parse[1].
1001
1002 am.keepcr::
1003 If true, git-am will call git-mailsplit for patches in mbox format
1004 with parameter `--keep-cr`. In this case git-mailsplit will
1005 not remove `\r` from lines ending with `\r\n`. Can be overridden
1006 by giving `--no-keep-cr` from the command line.
1007 See linkgit:git-am[1], linkgit:git-mailsplit[1].
1008
1009 am.threeWay::
1010 By default, `git am` will fail if the patch does not apply cleanly. When
1011 set to true, this setting tells `git am` to fall back on 3-way merge if
1012 the patch records the identity of blobs it is supposed to apply to and
1013 we have those blobs available locally (equivalent to giving the `--3way`
1014 option from the command line). Defaults to `false`.
1015 See linkgit:git-am[1].
1016
1017 apply.ignoreWhitespace::
1018 When set to 'change', tells 'git apply' to ignore changes in
1019 whitespace, in the same way as the `--ignore-space-change`
1020 option.
1021 When set to one of: no, none, never, false tells 'git apply' to
1022 respect all whitespace differences.
1023 See linkgit:git-apply[1].
1024
1025 apply.whitespace::
1026 Tells 'git apply' how to handle whitespaces, in the same way
1027 as the `--whitespace` option. See linkgit:git-apply[1].
1028
1029 blame.blankBoundary::
1030 Show blank commit object name for boundary commits in
1031 linkgit:git-blame[1]. This option defaults to false.
1032
1033 blame.coloring::
1034 This determines the coloring scheme to be applied to blame
1035 output. It can be 'repeatedLines', 'highlightRecent',
1036 or 'none' which is the default.
1037
1038 blame.date::
1039 Specifies the format used to output dates in linkgit:git-blame[1].
1040 If unset the iso format is used. For supported values,
1041 see the discussion of the `--date` option at linkgit:git-log[1].
1042
1043 blame.showEmail::
1044 Show the author email instead of author name in linkgit:git-blame[1].
1045 This option defaults to false.
1046
1047 blame.showRoot::
1048 Do not treat root commits as boundaries in linkgit:git-blame[1].
1049 This option defaults to false.
1050
1051 branch.autoSetupMerge::
1052 Tells 'git branch' and 'git checkout' to set up new branches
1053 so that linkgit:git-pull[1] will appropriately merge from the
1054 starting point branch. Note that even if this option is not set,
1055 this behavior can be chosen per-branch using the `--track`
1056 and `--no-track` options. The valid settings are: `false` -- no
1057 automatic setup is done; `true` -- automatic setup is done when the
1058 starting point is a remote-tracking branch; `always` --
1059 automatic setup is done when the starting point is either a
1060 local branch or remote-tracking
1061 branch. This option defaults to true.
1062
1063 branch.autoSetupRebase::
1064 When a new branch is created with 'git branch' or 'git checkout'
1065 that tracks another branch, this variable tells Git to set
1066 up pull to rebase instead of merge (see "branch.<name>.rebase").
1067 When `never`, rebase is never automatically set to true.
1068 When `local`, rebase is set to true for tracked branches of
1069 other local branches.
1070 When `remote`, rebase is set to true for tracked branches of
1071 remote-tracking branches.
1072 When `always`, rebase will be set to true for all tracking
1073 branches.
1074 See "branch.autoSetupMerge" for details on how to set up a
1075 branch to track another branch.
1076 This option defaults to never.
1077
1078 branch.sort::
1079 This variable controls the sort ordering of branches when displayed by
1080 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1081 value of this variable will be used as the default.
1082 See linkgit:git-for-each-ref[1] field names for valid values.
1083
1084 branch.<name>.remote::
1085 When on branch <name>, it tells 'git fetch' and 'git push'
1086 which remote to fetch from/push to. The remote to push to
1087 may be overridden with `remote.pushDefault` (for all branches).
1088 The remote to push to, for the current branch, may be further
1089 overridden by `branch.<name>.pushRemote`. If no remote is
1090 configured, or if you are not on any branch, it defaults to
1091 `origin` for fetching and `remote.pushDefault` for pushing.
1092 Additionally, `.` (a period) is the current local repository
1093 (a dot-repository), see `branch.<name>.merge`'s final note below.
1094
1095 branch.<name>.pushRemote::
1096 When on branch <name>, it overrides `branch.<name>.remote` for
1097 pushing. It also overrides `remote.pushDefault` for pushing
1098 from branch <name>. When you pull from one place (e.g. your
1099 upstream) and push to another place (e.g. your own publishing
1100 repository), you would want to set `remote.pushDefault` to
1101 specify the remote to push to for all branches, and use this
1102 option to override it for a specific branch.
1103
1104 branch.<name>.merge::
1105 Defines, together with branch.<name>.remote, the upstream branch
1106 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1107 branch to merge and can also affect 'git push' (see push.default).
1108 When in branch <name>, it tells 'git fetch' the default
1109 refspec to be marked for merging in FETCH_HEAD. The value is
1110 handled like the remote part of a refspec, and must match a
1111 ref which is fetched from the remote given by
1112 "branch.<name>.remote".
1113 The merge information is used by 'git pull' (which at first calls
1114 'git fetch') to lookup the default branch for merging. Without
1115 this option, 'git pull' defaults to merge the first refspec fetched.
1116 Specify multiple values to get an octopus merge.
1117 If you wish to setup 'git pull' so that it merges into <name> from
1118 another branch in the local repository, you can point
1119 branch.<name>.merge to the desired branch, and use the relative path
1120 setting `.` (a period) for branch.<name>.remote.
1121
1122 branch.<name>.mergeOptions::
1123 Sets default options for merging into branch <name>. The syntax and
1124 supported options are the same as those of linkgit:git-merge[1], but
1125 option values containing whitespace characters are currently not
1126 supported.
1127
1128 branch.<name>.rebase::
1129 When true, rebase the branch <name> on top of the fetched branch,
1130 instead of merging the default branch from the default remote when
1131 "git pull" is run. See "pull.rebase" for doing this in a non
1132 branch-specific manner.
1133 +
1134 When `merges`, pass the `--rebase-merges` option to 'git rebase'
1135 so that the local merge commits are included in the rebase (see
1136 linkgit:git-rebase[1] for details).
1137 +
1138 When preserve, also pass `--preserve-merges` along to 'git rebase'
1139 so that locally committed merge commits will not be flattened
1140 by running 'git pull'.
1141 +
1142 When the value is `interactive`, the rebase is run in interactive mode.
1143 +
1144 *NOTE*: this is a possibly dangerous operation; do *not* use
1145 it unless you understand the implications (see linkgit:git-rebase[1]
1146 for details).
1147
1148 branch.<name>.description::
1149 Branch description, can be edited with
1150 `git branch --edit-description`. Branch description is
1151 automatically added in the format-patch cover letter or
1152 request-pull summary.
1153
1154 browser.<tool>.cmd::
1155 Specify the command to invoke the specified browser. The
1156 specified command is evaluated in shell with the URLs passed
1157 as arguments. (See linkgit:git-web{litdd}browse[1].)
1158
1159 browser.<tool>.path::
1160 Override the path for the given tool that may be used to
1161 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1162 working repository in gitweb (see linkgit:git-instaweb[1]).
1163
1164 checkout.defaultRemote::
1165 When you run 'git checkout <something>' and only have one
1166 remote, it may implicitly fall back on checking out and
1167 tracking e.g. 'origin/<something>'. This stops working as soon
1168 as you have more than one remote with a '<something>'
1169 reference. This setting allows for setting the name of a
1170 preferred remote that should always win when it comes to
1171 disambiguation. The typical use-case is to set this to
1172 `origin`.
1173 +
1174 Currently this is used by linkgit:git-checkout[1] when 'git checkout
1175 <something>' will checkout the '<something>' branch on another remote,
1176 and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1177 remote branch. This setting might be used for other checkout-like
1178 commands or functionality in the future.
1179
1180 checkout.optimizeNewBranch::
1181 Optimizes the performance of "git checkout -b <new_branch>" when
1182 using sparse-checkout. When set to true, git will not update the
1183 repo based on the current sparse-checkout settings. This means it
1184 will not update the skip-worktree bit in the index nor add/remove
1185 files in the working directory to reflect the current sparse checkout
1186 settings nor will it show the local changes.
1187
1188 clean.requireForce::
1189 A boolean to make git-clean do nothing unless given -f,
1190 -i or -n. Defaults to true.
1191
1192 color.advice::
1193 A boolean to enable/disable color in hints (e.g. when a push
1194 failed, see `advice.*` for a list). May be set to `always`,
1195 `false` (or `never`) or `auto` (or `true`), in which case colors
1196 are used only when the error output goes to a terminal. If
1197 unset, then the value of `color.ui` is used (`auto` by default).
1198
1199 color.advice.hint::
1200 Use customized color for hints.
1201
1202 color.blame.highlightRecent::
1203 This can be used to color the metadata of a blame line depending
1204 on age of the line.
1205 +
1206 This setting should be set to a comma-separated list of color and date settings,
1207 starting and ending with a color, the dates should be set from oldest to newest.
1208 The metadata will be colored given the colors if the the line was introduced
1209 before the given timestamp, overwriting older timestamped colors.
1210 +
1211 Instead of an absolute timestamp relative timestamps work as well, e.g.
1212 2.weeks.ago is valid to address anything older than 2 weeks.
1213 +
1214 It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1215 everything older than one year blue, recent changes between one month and
1216 one year old are kept white, and lines introduced within the last month are
1217 colored red.
1218
1219 color.blame.repeatedLines::
1220 Use the customized color for the part of git-blame output that
1221 is repeated meta information per line (such as commit id,
1222 author name, date and timezone). Defaults to cyan.
1223
1224 color.branch::
1225 A boolean to enable/disable color in the output of
1226 linkgit:git-branch[1]. May be set to `always`,
1227 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1228 only when the output is to a terminal. If unset, then the
1229 value of `color.ui` is used (`auto` by default).
1230
1231 color.branch.<slot>::
1232 Use customized color for branch coloration. `<slot>` is one of
1233 `current` (the current branch), `local` (a local branch),
1234 `remote` (a remote-tracking branch in refs/remotes/),
1235 `upstream` (upstream tracking branch), `plain` (other
1236 refs).
1237
1238 color.diff::
1239 Whether to use ANSI escape sequences to add color to patches.
1240 If this is set to `always`, linkgit:git-diff[1],
1241 linkgit:git-log[1], and linkgit:git-show[1] will use color
1242 for all patches. If it is set to `true` or `auto`, those
1243 commands will only use color when output is to the terminal.
1244 If unset, then the value of `color.ui` is used (`auto` by
1245 default).
1246 +
1247 This does not affect linkgit:git-format-patch[1] or the
1248 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1249 command line with the `--color[=<when>]` option.
1250
1251 color.diff.<slot>::
1252 Use customized color for diff colorization. `<slot>` specifies
1253 which part of the patch to use the specified color, and is one
1254 of `context` (context text - `plain` is a historical synonym),
1255 `meta` (metainformation), `frag`
1256 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1257 `new` (added lines), `commit` (commit headers), `whitespace`
1258 (highlighting whitespace errors), `oldMoved` (deleted lines),
1259 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1260 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1261 `newMovedAlternativeDimmed` (See the '<mode>'
1262 setting of '--color-moved' in linkgit:git-diff[1] for details),
1263 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1264 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1265
1266 color.decorate.<slot>::
1267 Use customized color for 'git log --decorate' output. `<slot>` is one
1268 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1269 branches, remote-tracking branches, tags, stash and HEAD, respectively
1270 and `grafted` for grafted commits.
1271
1272 color.grep::
1273 When set to `always`, always highlight matches. When `false` (or
1274 `never`), never. When set to `true` or `auto`, use color only
1275 when the output is written to the terminal. If unset, then the
1276 value of `color.ui` is used (`auto` by default).
1277
1278 color.grep.<slot>::
1279 Use customized color for grep colorization. `<slot>` specifies which
1280 part of the line to use the specified color, and is one of
1281 +
1282 --
1283 `context`;;
1284 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1285 `filename`;;
1286 filename prefix (when not using `-h`)
1287 `function`;;
1288 function name lines (when using `-p`)
1289 `lineNumber`;;
1290 line number prefix (when using `-n`)
1291 `column`;;
1292 column number prefix (when using `--column`)
1293 `match`;;
1294 matching text (same as setting `matchContext` and `matchSelected`)
1295 `matchContext`;;
1296 matching text in context lines
1297 `matchSelected`;;
1298 matching text in selected lines
1299 `selected`;;
1300 non-matching text in selected lines
1301 `separator`;;
1302 separators between fields on a line (`:`, `-`, and `=`)
1303 and between hunks (`--`)
1304 --
1305
1306 color.interactive::
1307 When set to `always`, always use colors for interactive prompts
1308 and displays (such as those used by "git-add --interactive" and
1309 "git-clean --interactive"). When false (or `never`), never.
1310 When set to `true` or `auto`, use colors only when the output is
1311 to the terminal. If unset, then the value of `color.ui` is
1312 used (`auto` by default).
1313
1314 color.interactive.<slot>::
1315 Use customized color for 'git add --interactive' and 'git clean
1316 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1317 or `error`, for four distinct types of normal output from
1318 interactive commands.
1319
1320 color.pager::
1321 A boolean to enable/disable colored output when the pager is in
1322 use (default is true).
1323
1324 color.push::
1325 A boolean to enable/disable color in push errors. May be set to
1326 `always`, `false` (or `never`) or `auto` (or `true`), in which
1327 case colors are used only when the error output goes to a terminal.
1328 If unset, then the value of `color.ui` is used (`auto` by default).
1329
1330 color.push.error::
1331 Use customized color for push errors.
1332
1333 color.remote::
1334 If set, keywords at the start of the line are highlighted. The
1335 keywords are "error", "warning", "hint" and "success", and are
1336 matched case-insensitively. May be set to `always`, `false` (or
1337 `never`) or `auto` (or `true`). If unset, then the value of
1338 `color.ui` is used (`auto` by default).
1339
1340 color.remote.<slot>::
1341 Use customized color for each remote keyword. `<slot>` may be
1342 `hint`, `warning`, `success` or `error` which match the
1343 corresponding keyword.
1344
1345 color.showBranch::
1346 A boolean to enable/disable color in the output of
1347 linkgit:git-show-branch[1]. May be set to `always`,
1348 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1349 only when the output is to a terminal. If unset, then the
1350 value of `color.ui` is used (`auto` by default).
1351
1352 color.status::
1353 A boolean to enable/disable color in the output of
1354 linkgit:git-status[1]. May be set to `always`,
1355 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1356 only when the output is to a terminal. If unset, then the
1357 value of `color.ui` is used (`auto` by default).
1358
1359 color.status.<slot>::
1360 Use customized color for status colorization. `<slot>` is
1361 one of `header` (the header text of the status message),
1362 `added` or `updated` (files which are added but not committed),
1363 `changed` (files which are changed but not added in the index),
1364 `untracked` (files which are not tracked by Git),
1365 `branch` (the current branch),
1366 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1367 to red),
1368 `localBranch` or `remoteBranch` (the local and remote branch names,
1369 respectively, when branch and tracking information is displayed in the
1370 status short-format), or
1371 `unmerged` (files which have unmerged changes).
1372
1373 color.transport::
1374 A boolean to enable/disable color when pushes are rejected. May be
1375 set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1376 case colors are used only when the error output goes to a terminal.
1377 If unset, then the value of `color.ui` is used (`auto` by default).
1378
1379 color.transport.rejected::
1380 Use customized color when a push was rejected.
1381
1382 color.ui::
1383 This variable determines the default value for variables such
1384 as `color.diff` and `color.grep` that control the use of color
1385 per command family. Its scope will expand as more commands learn
1386 configuration to set a default for the `--color` option. Set it
1387 to `false` or `never` if you prefer Git commands not to use
1388 color unless enabled explicitly with some other configuration
1389 or the `--color` option. Set it to `always` if you want all
1390 output not intended for machine consumption to use color, to
1391 `true` or `auto` (this is the default since Git 1.8.4) if you
1392 want such output to use color when written to the terminal.
1393
1394 column.ui::
1395 Specify whether supported commands should output in columns.
1396 This variable consists of a list of tokens separated by spaces
1397 or commas:
1398 +
1399 These options control when the feature should be enabled
1400 (defaults to 'never'):
1401 +
1402 --
1403 `always`;;
1404 always show in columns
1405 `never`;;
1406 never show in columns
1407 `auto`;;
1408 show in columns if the output is to the terminal
1409 --
1410 +
1411 These options control layout (defaults to 'column'). Setting any
1412 of these implies 'always' if none of 'always', 'never', or 'auto' are
1413 specified.
1414 +
1415 --
1416 `column`;;
1417 fill columns before rows
1418 `row`;;
1419 fill rows before columns
1420 `plain`;;
1421 show in one column
1422 --
1423 +
1424 Finally, these options can be combined with a layout option (defaults
1425 to 'nodense'):
1426 +
1427 --
1428 `dense`;;
1429 make unequal size columns to utilize more space
1430 `nodense`;;
1431 make equal size columns
1432 --
1433
1434 column.branch::
1435 Specify whether to output branch listing in `git branch` in columns.
1436 See `column.ui` for details.
1437
1438 column.clean::
1439 Specify the layout when list items in `git clean -i`, which always
1440 shows files and directories in columns. See `column.ui` for details.
1441
1442 column.status::
1443 Specify whether to output untracked files in `git status` in columns.
1444 See `column.ui` for details.
1445
1446 column.tag::
1447 Specify whether to output tag listing in `git tag` in columns.
1448 See `column.ui` for details.
1449
1450 commit.cleanup::
1451 This setting overrides the default of the `--cleanup` option in
1452 `git commit`. See linkgit:git-commit[1] for details. Changing the
1453 default can be useful when you always want to keep lines that begin
1454 with comment character `#` in your log message, in which case you
1455 would do `git config commit.cleanup whitespace` (note that you will
1456 have to remove the help lines that begin with `#` in the commit log
1457 template yourself, if you do this).
1458
1459 commit.gpgSign::
1460
1461 A boolean to specify whether all commits should be GPG signed.
1462 Use of this option when doing operations such as rebase can
1463 result in a large number of commits being signed. It may be
1464 convenient to use an agent to avoid typing your GPG passphrase
1465 several times.
1466
1467 commit.status::
1468 A boolean to enable/disable inclusion of status information in the
1469 commit message template when using an editor to prepare the commit
1470 message. Defaults to true.
1471
1472 commit.template::
1473 Specify the pathname of a file to use as the template for
1474 new commit messages.
1475
1476 commit.verbose::
1477 A boolean or int to specify the level of verbose with `git commit`.
1478 See linkgit:git-commit[1].
1479
1480 credential.helper::
1481 Specify an external helper to be called when a username or
1482 password credential is needed; the helper may consult external
1483 storage to avoid prompting the user for the credentials. Note
1484 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1485 for details.
1486
1487 credential.useHttpPath::
1488 When acquiring credentials, consider the "path" component of an http
1489 or https URL to be important. Defaults to false. See
1490 linkgit:gitcredentials[7] for more information.
1491
1492 credential.username::
1493 If no username is set for a network authentication, use this username
1494 by default. See credential.<context>.* below, and
1495 linkgit:gitcredentials[7].
1496
1497 credential.<url>.*::
1498 Any of the credential.* options above can be applied selectively to
1499 some credentials. For example "credential.https://example.com.username"
1500 would set the default username only for https connections to
1501 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1502 matched.
1503
1504 credentialCache.ignoreSIGHUP::
1505 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1506
1507 completion.commands::
1508 This is only used by git-completion.bash to add or remove
1509 commands from the list of completed commands. Normally only
1510 porcelain commands and a few select others are completed. You
1511 can add more commands, separated by space, in this
1512 variable. Prefixing the command with '-' will remove it from
1513 the existing list.
1514
1515 include::diff-config.txt[]
1516
1517 difftool.<tool>.path::
1518 Override the path for the given tool. This is useful in case
1519 your tool is not in the PATH.
1520
1521 difftool.<tool>.cmd::
1522 Specify the command to invoke the specified diff tool.
1523 The specified command is evaluated in shell with the following
1524 variables available: 'LOCAL' is set to the name of the temporary
1525 file containing the contents of the diff pre-image and 'REMOTE'
1526 is set to the name of the temporary file containing the contents
1527 of the diff post-image.
1528
1529 difftool.prompt::
1530 Prompt before each invocation of the diff tool.
1531
1532 fastimport.unpackLimit::
1533 If the number of objects imported by linkgit:git-fast-import[1]
1534 is below this limit, then the objects will be unpacked into
1535 loose object files. However if the number of imported objects
1536 equals or exceeds this limit then the pack will be stored as a
1537 pack. Storing the pack from a fast-import can make the import
1538 operation complete faster, especially on slow filesystems. If
1539 not set, the value of `transfer.unpackLimit` is used instead.
1540
1541 include::fetch-config.txt[]
1542
1543 include::format-config.txt[]
1544
1545 filter.<driver>.clean::
1546 The command which is used to convert the content of a worktree
1547 file to a blob upon checkin. See linkgit:gitattributes[5] for
1548 details.
1549
1550 filter.<driver>.smudge::
1551 The command which is used to convert the content of a blob
1552 object to a worktree file upon checkout. See
1553 linkgit:gitattributes[5] for details.
1554
1555 fsck.<msg-id>::
1556 During fsck git may find issues with legacy data which
1557 wouldn't be generated by current versions of git, and which
1558 wouldn't be sent over the wire if `transfer.fsckObjects` was
1559 set. This feature is intended to support working with legacy
1560 repositories containing such data.
1561 +
1562 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1563 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1564 to clone or fetch it set `fetch.fsck.<msg-id>`.
1565 +
1566 The rest of the documentation discusses `fsck.*` for brevity, but the
1567 same applies for the corresponding `receive.fsck.*` and
1568 `fetch.<msg-id>.*`. variables.
1569 +
1570 Unlike variables like `color.ui` and `core.editor` the
1571 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1572 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1573 uniformly configure the same fsck settings in different circumstances
1574 all three of them they must all set to the same values.
1575 +
1576 When `fsck.<msg-id>` is set, errors can be switched to warnings and
1577 vice versa by configuring the `fsck.<msg-id>` setting where the
1578 `<msg-id>` is the fsck message ID and the value is one of `error`,
1579 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
1580 with the message ID, e.g. "missingEmail: invalid author/committer line
1581 - missing email" means that setting `fsck.missingEmail = ignore` will
1582 hide that issue.
1583 +
1584 In general, it is better to enumerate existing objects with problems
1585 with `fsck.skipList`, instead of listing the kind of breakages these
1586 problematic objects share to be ignored, as doing the latter will
1587 allow new instances of the same breakages go unnoticed.
1588 +
1589 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1590 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1591 will only cause git to warn.
1592
1593 fsck.skipList::
1594 The path to a list of object names (i.e. one unabbreviated SHA-1 per
1595 line) that are known to be broken in a non-fatal way and should
1596 be ignored. On versions of Git 2.20 and later comments ('#'), empty
1597 lines, and any leading and trailing whitespace is ignored. Everything
1598 but a SHA-1 per line will error out on older versions.
1599 +
1600 This feature is useful when an established project should be accepted
1601 despite early commits containing errors that can be safely ignored
1602 such as invalid committer email addresses. Note: corrupt objects
1603 cannot be skipped with this setting.
1604 +
1605 Like `fsck.<msg-id>` this variable has corresponding
1606 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1607 +
1608 Unlike variables like `color.ui` and `core.editor` the
1609 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1610 fall back on the `fsck.skipList` configuration if they aren't set. To
1611 uniformly configure the same fsck settings in different circumstances
1612 all three of them they must all set to the same values.
1613 +
1614 Older versions of Git (before 2.20) documented that the object names
1615 list should be sorted. This was never a requirement, the object names
1616 could appear in any order, but when reading the list we tracked whether
1617 the list was sorted for the purposes of an internal binary search
1618 implementation, which could save itself some work with an already sorted
1619 list. Unless you had a humongous list there was no reason to go out of
1620 your way to pre-sort the list. After Git version 2.20 a hash implementation
1621 is used instead, so there's now no reason to pre-sort the list.
1622
1623 gc.aggressiveDepth::
1624 The depth parameter used in the delta compression
1625 algorithm used by 'git gc --aggressive'. This defaults
1626 to 50.
1627
1628 gc.aggressiveWindow::
1629 The window size parameter used in the delta compression
1630 algorithm used by 'git gc --aggressive'. This defaults
1631 to 250.
1632
1633 gc.auto::
1634 When there are approximately more than this many loose
1635 objects in the repository, `git gc --auto` will pack them.
1636 Some Porcelain commands use this command to perform a
1637 light-weight garbage collection from time to time. The
1638 default value is 6700. Setting this to 0 disables it.
1639
1640 gc.autoPackLimit::
1641 When there are more than this many packs that are not
1642 marked with `*.keep` file in the repository, `git gc
1643 --auto` consolidates them into one larger pack. The
1644 default value is 50. Setting this to 0 disables it.
1645
1646 gc.autoDetach::
1647 Make `git gc --auto` return immediately and run in background
1648 if the system supports it. Default is true.
1649
1650 gc.bigPackThreshold::
1651 If non-zero, all packs larger than this limit are kept when
1652 `git gc` is run. This is very similar to `--keep-base-pack`
1653 except that all packs that meet the threshold are kept, not
1654 just the base pack. Defaults to zero. Common unit suffixes of
1655 'k', 'm', or 'g' are supported.
1656 +
1657 Note that if the number of kept packs is more than gc.autoPackLimit,
1658 this configuration variable is ignored, all packs except the base pack
1659 will be repacked. After this the number of packs should go below
1660 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1661
1662 gc.writeCommitGraph::
1663 If true, then gc will rewrite the commit-graph file when
1664 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1665 '--auto' the commit-graph will be updated if housekeeping is
1666 required. Default is false. See linkgit:git-commit-graph[1]
1667 for details.
1668
1669 gc.logExpiry::
1670 If the file gc.log exists, then `git gc --auto` will print
1671 its content and exit with status zero instead of running
1672 unless that file is more than 'gc.logExpiry' old. Default is
1673 "1.day". See `gc.pruneExpire` for more ways to specify its
1674 value.
1675
1676 gc.packRefs::
1677 Running `git pack-refs` in a repository renders it
1678 unclonable by Git versions prior to 1.5.1.2 over dumb
1679 transports such as HTTP. This variable determines whether
1680 'git gc' runs `git pack-refs`. This can be set to `notbare`
1681 to enable it within all non-bare repos or it can be set to a
1682 boolean value. The default is `true`.
1683
1684 gc.pruneExpire::
1685 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1686 Override the grace period with this config variable. The value
1687 "now" may be used to disable this grace period and always prune
1688 unreachable objects immediately, or "never" may be used to
1689 suppress pruning. This feature helps prevent corruption when
1690 'git gc' runs concurrently with another process writing to the
1691 repository; see the "NOTES" section of linkgit:git-gc[1].
1692
1693 gc.worktreePruneExpire::
1694 When 'git gc' is run, it calls
1695 'git worktree prune --expire 3.months.ago'.
1696 This config variable can be used to set a different grace
1697 period. The value "now" may be used to disable the grace
1698 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1699 may be used to suppress pruning.
1700
1701 gc.reflogExpire::
1702 gc.<pattern>.reflogExpire::
1703 'git reflog expire' removes reflog entries older than
1704 this time; defaults to 90 days. The value "now" expires all
1705 entries immediately, and "never" suppresses expiration
1706 altogether. With "<pattern>" (e.g.
1707 "refs/stash") in the middle the setting applies only to
1708 the refs that match the <pattern>.
1709
1710 gc.reflogExpireUnreachable::
1711 gc.<pattern>.reflogExpireUnreachable::
1712 'git reflog expire' removes reflog entries older than
1713 this time and are not reachable from the current tip;
1714 defaults to 30 days. The value "now" expires all entries
1715 immediately, and "never" suppresses expiration altogether.
1716 With "<pattern>" (e.g. "refs/stash")
1717 in the middle, the setting applies only to the refs that
1718 match the <pattern>.
1719
1720 gc.rerereResolved::
1721 Records of conflicted merge you resolved earlier are
1722 kept for this many days when 'git rerere gc' is run.
1723 You can also use more human-readable "1.month.ago", etc.
1724 The default is 60 days. See linkgit:git-rerere[1].
1725
1726 gc.rerereUnresolved::
1727 Records of conflicted merge you have not resolved are
1728 kept for this many days when 'git rerere gc' is run.
1729 You can also use more human-readable "1.month.ago", etc.
1730 The default is 15 days. See linkgit:git-rerere[1].
1731
1732 include::gitcvs-config.txt[]
1733
1734 gitweb.category::
1735 gitweb.description::
1736 gitweb.owner::
1737 gitweb.url::
1738 See linkgit:gitweb[1] for description.
1739
1740 gitweb.avatar::
1741 gitweb.blame::
1742 gitweb.grep::
1743 gitweb.highlight::
1744 gitweb.patches::
1745 gitweb.pickaxe::
1746 gitweb.remote_heads::
1747 gitweb.showSizes::
1748 gitweb.snapshot::
1749 See linkgit:gitweb.conf[5] for description.
1750
1751 grep.lineNumber::
1752 If set to true, enable `-n` option by default.
1753
1754 grep.column::
1755 If set to true, enable the `--column` option by default.
1756
1757 grep.patternType::
1758 Set the default matching behavior. Using a value of 'basic', 'extended',
1759 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1760 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1761 value 'default' will return to the default matching behavior.
1762
1763 grep.extendedRegexp::
1764 If set to true, enable `--extended-regexp` option by default. This
1765 option is ignored when the `grep.patternType` option is set to a value
1766 other than 'default'.
1767
1768 grep.threads::
1769 Number of grep worker threads to use.
1770 See `grep.threads` in linkgit:git-grep[1] for more information.
1771
1772 grep.fallbackToNoIndex::
1773 If set to true, fall back to git grep --no-index if git grep
1774 is executed outside of a git repository. Defaults to false.
1775
1776 gpg.program::
1777 Use this custom program instead of "`gpg`" found on `$PATH` when
1778 making or verifying a PGP signature. The program must support the
1779 same command-line interface as GPG, namely, to verify a detached
1780 signature, "`gpg --verify $file - <$signature`" is run, and the
1781 program is expected to signal a good signature by exiting with
1782 code 0, and to generate an ASCII-armored detached signature, the
1783 standard input of "`gpg -bsau $key`" is fed with the contents to be
1784 signed, and the program is expected to send the result to its
1785 standard output.
1786
1787 gpg.format::
1788 Specifies which key format to use when signing with `--gpg-sign`.
1789 Default is "openpgp" and another possible value is "x509".
1790
1791 gpg.<format>.program::
1792 Use this to customize the program used for the signing format you
1793 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1794 be used as a legacy synonym for `gpg.openpgp.program`. The default
1795 value for `gpg.x509.program` is "gpgsm".
1796
1797 include::gui-config.txt[]
1798
1799 guitool.<name>.cmd::
1800 Specifies the shell command line to execute when the corresponding item
1801 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1802 mandatory for every tool. The command is executed from the root of
1803 the working directory, and in the environment it receives the name of
1804 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1805 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1806 the head is detached, 'CUR_BRANCH' is empty).
1807
1808 guitool.<name>.needsFile::
1809 Run the tool only if a diff is selected in the GUI. It guarantees
1810 that 'FILENAME' is not empty.
1811
1812 guitool.<name>.noConsole::
1813 Run the command silently, without creating a window to display its
1814 output.
1815
1816 guitool.<name>.noRescan::
1817 Don't rescan the working directory for changes after the tool
1818 finishes execution.
1819
1820 guitool.<name>.confirm::
1821 Show a confirmation dialog before actually running the tool.
1822
1823 guitool.<name>.argPrompt::
1824 Request a string argument from the user, and pass it to the tool
1825 through the `ARGS` environment variable. Since requesting an
1826 argument implies confirmation, the 'confirm' option has no effect
1827 if this is enabled. If the option is set to 'true', 'yes', or '1',
1828 the dialog uses a built-in generic prompt; otherwise the exact
1829 value of the variable is used.
1830
1831 guitool.<name>.revPrompt::
1832 Request a single valid revision from the user, and set the
1833 `REVISION` environment variable. In other aspects this option
1834 is similar to 'argPrompt', and can be used together with it.
1835
1836 guitool.<name>.revUnmerged::
1837 Show only unmerged branches in the 'revPrompt' subdialog.
1838 This is useful for tools similar to merge or rebase, but not
1839 for things like checkout or reset.
1840
1841 guitool.<name>.title::
1842 Specifies the title to use for the prompt dialog. The default
1843 is the tool name.
1844
1845 guitool.<name>.prompt::
1846 Specifies the general prompt string to display at the top of
1847 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1848 The default value includes the actual command.
1849
1850 help.browser::
1851 Specify the browser that will be used to display help in the
1852 'web' format. See linkgit:git-help[1].
1853
1854 help.format::
1855 Override the default help format used by linkgit:git-help[1].
1856 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1857 the default. 'web' and 'html' are the same.
1858
1859 help.autoCorrect::
1860 Automatically correct and execute mistyped commands after
1861 waiting for the given number of deciseconds (0.1 sec). If more
1862 than one command can be deduced from the entered text, nothing
1863 will be executed. If the value of this option is negative,
1864 the corrected command will be executed immediately. If the
1865 value is 0 - the command will be just shown but not executed.
1866 This is the default.
1867
1868 help.htmlPath::
1869 Specify the path where the HTML documentation resides. File system paths
1870 and URLs are supported. HTML pages will be prefixed with this path when
1871 help is displayed in the 'web' format. This defaults to the documentation
1872 path of your Git installation.
1873
1874 http.proxy::
1875 Override the HTTP proxy, normally configured using the 'http_proxy',
1876 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1877 addition to the syntax understood by curl, it is possible to specify a
1878 proxy string with a user name but no password, in which case git will
1879 attempt to acquire one in the same way it does for other credentials. See
1880 linkgit:gitcredentials[7] for more information. The syntax thus is
1881 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1882 on a per-remote basis; see remote.<name>.proxy
1883
1884 http.proxyAuthMethod::
1885 Set the method with which to authenticate against the HTTP proxy. This
1886 only takes effect if the configured proxy string contains a user name part
1887 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1888 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1889 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1890 variable. Possible values are:
1891 +
1892 --
1893 * `anyauth` - Automatically pick a suitable authentication method. It is
1894 assumed that the proxy answers an unauthenticated request with a 407
1895 status code and one or more Proxy-authenticate headers with supported
1896 authentication methods. This is the default.
1897 * `basic` - HTTP Basic authentication
1898 * `digest` - HTTP Digest authentication; this prevents the password from being
1899 transmitted to the proxy in clear text
1900 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1901 of `curl(1)`)
1902 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1903 --
1904
1905 http.emptyAuth::
1906 Attempt authentication without seeking a username or password. This
1907 can be used to attempt GSS-Negotiate authentication without specifying
1908 a username in the URL, as libcurl normally requires a username for
1909 authentication.
1910
1911 http.delegation::
1912 Control GSSAPI credential delegation. The delegation is disabled
1913 by default in libcurl since version 7.21.7. Set parameter to tell
1914 the server what it is allowed to delegate when it comes to user
1915 credentials. Used with GSS/kerberos. Possible values are:
1916 +
1917 --
1918 * `none` - Don't allow any delegation.
1919 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1920 Kerberos service ticket, which is a matter of realm policy.
1921 * `always` - Unconditionally allow the server to delegate.
1922 --
1923
1924
1925 http.extraHeader::
1926 Pass an additional HTTP header when communicating with a server. If
1927 more than one such entry exists, all of them are added as extra
1928 headers. To allow overriding the settings inherited from the system
1929 config, an empty value will reset the extra headers to the empty list.
1930
1931 http.cookieFile::
1932 The pathname of a file containing previously stored cookie lines,
1933 which should be used
1934 in the Git http session, if they match the server. The file format
1935 of the file to read cookies from should be plain HTTP headers or
1936 the Netscape/Mozilla cookie file format (see `curl(1)`).
1937 NOTE that the file specified with http.cookieFile is used only as
1938 input unless http.saveCookies is set.
1939
1940 http.saveCookies::
1941 If set, store cookies received during requests to the file specified by
1942 http.cookieFile. Has no effect if http.cookieFile is unset.
1943
1944 http.sslVersion::
1945 The SSL version to use when negotiating an SSL connection, if you
1946 want to force the default. The available and default version
1947 depend on whether libcurl was built against NSS or OpenSSL and the
1948 particular configuration of the crypto library in use. Internally
1949 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1950 documentation for more details on the format of this option and
1951 for the ssl version supported. Actually the possible values of
1952 this option are:
1953
1954 - sslv2
1955 - sslv3
1956 - tlsv1
1957 - tlsv1.0
1958 - tlsv1.1
1959 - tlsv1.2
1960 - tlsv1.3
1961
1962 +
1963 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1964 To force git to use libcurl's default ssl version and ignore any
1965 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1966 empty string.
1967
1968 http.sslCipherList::
1969 A list of SSL ciphers to use when negotiating an SSL connection.
1970 The available ciphers depend on whether libcurl was built against
1971 NSS or OpenSSL and the particular configuration of the crypto
1972 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1973 option; see the libcurl documentation for more details on the format
1974 of this list.
1975 +
1976 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1977 To force git to use libcurl's default cipher list and ignore any
1978 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1979 empty string.
1980
1981 http.sslVerify::
1982 Whether to verify the SSL certificate when fetching or pushing
1983 over HTTPS. Defaults to true. Can be overridden by the
1984 `GIT_SSL_NO_VERIFY` environment variable.
1985
1986 http.sslCert::
1987 File containing the SSL certificate when fetching or pushing
1988 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1989 variable.
1990
1991 http.sslKey::
1992 File containing the SSL private key when fetching or pushing
1993 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1994 variable.
1995
1996 http.sslCertPasswordProtected::
1997 Enable Git's password prompt for the SSL certificate. Otherwise
1998 OpenSSL will prompt the user, possibly many times, if the
1999 certificate or private key is encrypted. Can be overridden by the
2000 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2001
2002 http.sslCAInfo::
2003 File containing the certificates to verify the peer with when
2004 fetching or pushing over HTTPS. Can be overridden by the
2005 `GIT_SSL_CAINFO` environment variable.
2006
2007 http.sslCAPath::
2008 Path containing files with the CA certificates to verify the peer
2009 with when fetching or pushing over HTTPS. Can be overridden
2010 by the `GIT_SSL_CAPATH` environment variable.
2011
2012 http.pinnedpubkey::
2013 Public key of the https service. It may either be the filename of
2014 a PEM or DER encoded public key file or a string starting with
2015 'sha256//' followed by the base64 encoded sha256 hash of the
2016 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2017 exit with an error if this option is set but not supported by
2018 cURL.
2019
2020 http.sslTry::
2021 Attempt to use AUTH SSL/TLS and encrypted data transfers
2022 when connecting via regular FTP protocol. This might be needed
2023 if the FTP server requires it for security reasons or you wish
2024 to connect securely whenever remote FTP server supports it.
2025 Default is false since it might trigger certificate verification
2026 errors on misconfigured servers.
2027
2028 http.maxRequests::
2029 How many HTTP requests to launch in parallel. Can be overridden
2030 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2031
2032 http.minSessions::
2033 The number of curl sessions (counted across slots) to be kept across
2034 requests. They will not be ended with curl_easy_cleanup() until
2035 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2036 value will be capped at 1. Defaults to 1.
2037
2038 http.postBuffer::
2039 Maximum size in bytes of the buffer used by smart HTTP
2040 transports when POSTing data to the remote system.
2041 For requests larger than this buffer size, HTTP/1.1 and
2042 Transfer-Encoding: chunked is used to avoid creating a
2043 massive pack file locally. Default is 1 MiB, which is
2044 sufficient for most requests.
2045
2046 http.lowSpeedLimit, http.lowSpeedTime::
2047 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2048 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2049 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2050 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2051
2052 http.noEPSV::
2053 A boolean which disables using of EPSV ftp command by curl.
2054 This can helpful with some "poor" ftp servers which don't
2055 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2056 environment variable. Default is false (curl will use EPSV).
2057
2058 http.userAgent::
2059 The HTTP USER_AGENT string presented to an HTTP server. The default
2060 value represents the version of the client Git such as git/1.7.1.
2061 This option allows you to override this value to a more common value
2062 such as Mozilla/4.0. This may be necessary, for instance, if
2063 connecting through a firewall that restricts HTTP connections to a set
2064 of common USER_AGENT strings (but not including those like git/1.7.1).
2065 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2066
2067 http.followRedirects::
2068 Whether git should follow HTTP redirects. If set to `true`, git
2069 will transparently follow any redirect issued by a server it
2070 encounters. If set to `false`, git will treat all redirects as
2071 errors. If set to `initial`, git will follow redirects only for
2072 the initial request to a remote, but not for subsequent
2073 follow-up HTTP requests. Since git uses the redirected URL as
2074 the base for the follow-up requests, this is generally
2075 sufficient. The default is `initial`.
2076
2077 http.<url>.*::
2078 Any of the http.* options above can be applied selectively to some URLs.
2079 For a config key to match a URL, each element of the config key is
2080 compared to that of the URL, in the following order:
2081 +
2082 --
2083 . Scheme (e.g., `https` in `https://example.com/`). This field
2084 must match exactly between the config key and the URL.
2085
2086 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2087 This field must match between the config key and the URL. It is
2088 possible to specify a `*` as part of the host name to match all subdomains
2089 at this level. `https://*.example.com/` for example would match
2090 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2091
2092 . Port number (e.g., `8080` in `http://example.com:8080/`).
2093 This field must match exactly between the config key and the URL.
2094 Omitted port numbers are automatically converted to the correct
2095 default for the scheme before matching.
2096
2097 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2098 path field of the config key must match the path field of the URL
2099 either exactly or as a prefix of slash-delimited path elements. This means
2100 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2101 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2102 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2103 key with just path `foo/`).
2104
2105 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2106 the config key has a user name it must match the user name in the
2107 URL exactly. If the config key does not have a user name, that
2108 config key will match a URL with any user name (including none),
2109 but at a lower precedence than a config key with a user name.
2110 --
2111 +
2112 The list above is ordered by decreasing precedence; a URL that matches
2113 a config key's path is preferred to one that matches its user name. For example,
2114 if the URL is `https://user@example.com/foo/bar` a config key match of
2115 `https://example.com/foo` will be preferred over a config key match of
2116 `https://user@example.com`.
2117 +
2118 All URLs are normalized before attempting any matching (the password part,
2119 if embedded in the URL, is always ignored for matching purposes) so that
2120 equivalent URLs that are simply spelled differently will match properly.
2121 Environment variable settings always override any matches. The URLs that are
2122 matched against are those given directly to Git commands. This means any URLs
2123 visited as a result of a redirection do not participate in matching.
2124
2125 ssh.variant::
2126 By default, Git determines the command line arguments to use
2127 based on the basename of the configured SSH command (configured
2128 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2129 the config setting `core.sshCommand`). If the basename is
2130 unrecognized, Git will attempt to detect support of OpenSSH
2131 options by first invoking the configured SSH command with the
2132 `-G` (print configuration) option and will subsequently use
2133 OpenSSH options (if that is successful) or no options besides
2134 the host and remote command (if it fails).
2135 +
2136 The config variable `ssh.variant` can be set to override this detection.
2137 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2138 `tortoiseplink`, `simple` (no options except the host and remote command).
2139 The default auto-detection can be explicitly requested using the value
2140 `auto`. Any other value is treated as `ssh`. This setting can also be
2141 overridden via the environment variable `GIT_SSH_VARIANT`.
2142 +
2143 The current command-line parameters used for each variant are as
2144 follows:
2145 +
2146 --
2147
2148 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2149
2150 * `simple` - [username@]host command
2151
2152 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2153
2154 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2155
2156 --
2157 +
2158 Except for the `simple` variant, command-line parameters are likely to
2159 change as git gains new features.
2160
2161 i18n.commitEncoding::
2162 Character encoding the commit messages are stored in; Git itself
2163 does not care per se, but this information is necessary e.g. when
2164 importing commits from emails or in the gitk graphical history
2165 browser (and possibly at other places in the future or in other
2166 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2167
2168 i18n.logOutputEncoding::
2169 Character encoding the commit messages are converted to when
2170 running 'git log' and friends.
2171
2172 imap::
2173 The configuration variables in the 'imap' section are described
2174 in linkgit:git-imap-send[1].
2175
2176 index.threads::
2177 Specifies the number of threads to spawn when loading the index.
2178 This is meant to reduce index load time on multiprocessor machines.
2179 Specifying 0 or 'true' will cause Git to auto-detect the number of
2180 CPU's and set the number of threads accordingly. Specifying 1 or
2181 'false' will disable multithreading. Defaults to 'true'.
2182
2183 index.version::
2184 Specify the version with which new index files should be
2185 initialized. This does not affect existing repositories.
2186
2187 init.templateDir::
2188 Specify the directory from which templates will be copied.
2189 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2190
2191 instaweb.browser::
2192 Specify the program that will be used to browse your working
2193 repository in gitweb. See linkgit:git-instaweb[1].
2194
2195 instaweb.httpd::
2196 The HTTP daemon command-line to start gitweb on your working
2197 repository. See linkgit:git-instaweb[1].
2198
2199 instaweb.local::
2200 If true the web server started by linkgit:git-instaweb[1] will
2201 be bound to the local IP (127.0.0.1).
2202
2203 instaweb.modulePath::
2204 The default module path for linkgit:git-instaweb[1] to use
2205 instead of /usr/lib/apache2/modules. Only used if httpd
2206 is Apache.
2207
2208 instaweb.port::
2209 The port number to bind the gitweb httpd to. See
2210 linkgit:git-instaweb[1].
2211
2212 interactive.singleKey::
2213 In interactive commands, allow the user to provide one-letter
2214 input with a single key (i.e., without hitting enter).
2215 Currently this is used by the `--patch` mode of
2216 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2217 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2218 setting is silently ignored if portable keystroke input
2219 is not available; requires the Perl module Term::ReadKey.
2220
2221 interactive.diffFilter::
2222 When an interactive command (such as `git add --patch`) shows
2223 a colorized diff, git will pipe the diff through the shell
2224 command defined by this configuration variable. The command may
2225 mark up the diff further for human consumption, provided that it
2226 retains a one-to-one correspondence with the lines in the
2227 original diff. Defaults to disabled (no filtering).
2228
2229 log.abbrevCommit::
2230 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2231 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2232 override this option with `--no-abbrev-commit`.
2233
2234 log.date::
2235 Set the default date-time mode for the 'log' command.
2236 Setting a value for log.date is similar to using 'git log''s
2237 `--date` option. See linkgit:git-log[1] for details.
2238
2239 log.decorate::
2240 Print out the ref names of any commits that are shown by the log
2241 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2242 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2243 specified, the full ref name (including prefix) will be printed.
2244 If 'auto' is specified, then if the output is going to a terminal,
2245 the ref names are shown as if 'short' were given, otherwise no ref
2246 names are shown. This is the same as the `--decorate` option
2247 of the `git log`.
2248
2249 log.follow::
2250 If `true`, `git log` will act as if the `--follow` option was used when
2251 a single <path> is given. This has the same limitations as `--follow`,
2252 i.e. it cannot be used to follow multiple files and does not work well
2253 on non-linear history.
2254
2255 log.graphColors::
2256 A list of colors, separated by commas, that can be used to draw
2257 history lines in `git log --graph`.
2258
2259 log.showRoot::
2260 If true, the initial commit will be shown as a big creation event.
2261 This is equivalent to a diff against an empty tree.
2262 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2263 normally hide the root commit will now show it. True by default.
2264
2265 log.showSignature::
2266 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2267 linkgit:git-whatchanged[1] assume `--show-signature`.
2268
2269 log.mailmap::
2270 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2271 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2272
2273 mailinfo.scissors::
2274 If true, makes linkgit:git-mailinfo[1] (and therefore
2275 linkgit:git-am[1]) act by default as if the --scissors option
2276 was provided on the command-line. When active, this features
2277 removes everything from the message body before a scissors
2278 line (i.e. consisting mainly of ">8", "8<" and "-").
2279
2280 mailmap.file::
2281 The location of an augmenting mailmap file. The default
2282 mailmap, located in the root of the repository, is loaded
2283 first, then the mailmap file pointed to by this variable.
2284 The location of the mailmap file may be in a repository
2285 subdirectory, or somewhere outside of the repository itself.
2286 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2287
2288 mailmap.blob::
2289 Like `mailmap.file`, but consider the value as a reference to a
2290 blob in the repository. If both `mailmap.file` and
2291 `mailmap.blob` are given, both are parsed, with entries from
2292 `mailmap.file` taking precedence. In a bare repository, this
2293 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2294 defaults to empty.
2295
2296 man.viewer::
2297 Specify the programs that may be used to display help in the
2298 'man' format. See linkgit:git-help[1].
2299
2300 man.<tool>.cmd::
2301 Specify the command to invoke the specified man viewer. The
2302 specified command is evaluated in shell with the man page
2303 passed as argument. (See linkgit:git-help[1].)
2304
2305 man.<tool>.path::
2306 Override the path for the given tool that may be used to
2307 display help in the 'man' format. See linkgit:git-help[1].
2308
2309 include::merge-config.txt[]
2310
2311 mergetool.<tool>.path::
2312 Override the path for the given tool. This is useful in case
2313 your tool is not in the PATH.
2314
2315 mergetool.<tool>.cmd::
2316 Specify the command to invoke the specified merge tool. The
2317 specified command is evaluated in shell with the following
2318 variables available: 'BASE' is the name of a temporary file
2319 containing the common base of the files to be merged, if available;
2320 'LOCAL' is the name of a temporary file containing the contents of
2321 the file on the current branch; 'REMOTE' is the name of a temporary
2322 file containing the contents of the file from the branch being
2323 merged; 'MERGED' contains the name of the file to which the merge
2324 tool should write the results of a successful merge.
2325
2326 mergetool.<tool>.trustExitCode::
2327 For a custom merge command, specify whether the exit code of
2328 the merge command can be used to determine whether the merge was
2329 successful. If this is not set to true then the merge target file
2330 timestamp is checked and the merge assumed to have been successful
2331 if the file has been updated, otherwise the user is prompted to
2332 indicate the success of the merge.
2333
2334 mergetool.meld.hasOutput::
2335 Older versions of `meld` do not support the `--output` option.
2336 Git will attempt to detect whether `meld` supports `--output`
2337 by inspecting the output of `meld --help`. Configuring
2338 `mergetool.meld.hasOutput` will make Git skip these checks and
2339 use the configured value instead. Setting `mergetool.meld.hasOutput`
2340 to `true` tells Git to unconditionally use the `--output` option,
2341 and `false` avoids using `--output`.
2342
2343 mergetool.keepBackup::
2344 After performing a merge, the original file with conflict markers
2345 can be saved as a file with a `.orig` extension. If this variable
2346 is set to `false` then this file is not preserved. Defaults to
2347 `true` (i.e. keep the backup files).
2348
2349 mergetool.keepTemporaries::
2350 When invoking a custom merge tool, Git uses a set of temporary
2351 files to pass to the tool. If the tool returns an error and this
2352 variable is set to `true`, then these temporary files will be
2353 preserved, otherwise they will be removed after the tool has
2354 exited. Defaults to `false`.
2355
2356 mergetool.writeToTemp::
2357 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2358 conflicting files in the worktree by default. Git will attempt
2359 to use a temporary directory for these files when set `true`.
2360 Defaults to `false`.
2361
2362 mergetool.prompt::
2363 Prompt before each invocation of the merge resolution program.
2364
2365 notes.mergeStrategy::
2366 Which merge strategy to choose by default when resolving notes
2367 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2368 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2369 section of linkgit:git-notes[1] for more information on each strategy.
2370
2371 notes.<name>.mergeStrategy::
2372 Which merge strategy to choose when doing a notes merge into
2373 refs/notes/<name>. This overrides the more general
2374 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2375 linkgit:git-notes[1] for more information on the available strategies.
2376
2377 notes.displayRef::
2378 The (fully qualified) refname from which to show notes when
2379 showing commit messages. The value of this variable can be set
2380 to a glob, in which case notes from all matching refs will be
2381 shown. You may also specify this configuration variable
2382 several times. A warning will be issued for refs that do not
2383 exist, but a glob that does not match any refs is silently
2384 ignored.
2385 +
2386 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2387 environment variable, which must be a colon separated list of refs or
2388 globs.
2389 +
2390 The effective value of "core.notesRef" (possibly overridden by
2391 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2392 displayed.
2393
2394 notes.rewrite.<command>::
2395 When rewriting commits with <command> (currently `amend` or
2396 `rebase`) and this variable is set to `true`, Git
2397 automatically copies your notes from the original to the
2398 rewritten commit. Defaults to `true`, but see
2399 "notes.rewriteRef" below.
2400
2401 notes.rewriteMode::
2402 When copying notes during a rewrite (see the
2403 "notes.rewrite.<command>" option), determines what to do if
2404 the target commit already has a note. Must be one of
2405 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2406 Defaults to `concatenate`.
2407 +
2408 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2409 environment variable.
2410
2411 notes.rewriteRef::
2412 When copying notes during a rewrite, specifies the (fully
2413 qualified) ref whose notes should be copied. The ref may be a
2414 glob, in which case notes in all matching refs will be copied.
2415 You may also specify this configuration several times.
2416 +
2417 Does not have a default value; you must configure this variable to
2418 enable note rewriting. Set it to `refs/notes/commits` to enable
2419 rewriting for the default commit notes.
2420 +
2421 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2422 environment variable, which must be a colon separated list of refs or
2423 globs.
2424
2425 pack.window::
2426 The size of the window used by linkgit:git-pack-objects[1] when no
2427 window size is given on the command line. Defaults to 10.
2428
2429 pack.depth::
2430 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2431 maximum depth is given on the command line. Defaults to 50.
2432 Maximum value is 4095.
2433
2434 pack.windowMemory::
2435 The maximum size of memory that is consumed by each thread
2436 in linkgit:git-pack-objects[1] for pack window memory when
2437 no limit is given on the command line. The value can be
2438 suffixed with "k", "m", or "g". When left unconfigured (or
2439 set explicitly to 0), there will be no limit.
2440
2441 pack.compression::
2442 An integer -1..9, indicating the compression level for objects
2443 in a pack file. -1 is the zlib default. 0 means no
2444 compression, and 1..9 are various speed/size tradeoffs, 9 being
2445 slowest. If not set, defaults to core.compression. If that is
2446 not set, defaults to -1, the zlib default, which is "a default
2447 compromise between speed and compression (currently equivalent
2448 to level 6)."
2449 +
2450 Note that changing the compression level will not automatically recompress
2451 all existing objects. You can force recompression by passing the -F option
2452 to linkgit:git-repack[1].
2453
2454 pack.island::
2455 An extended regular expression configuring a set of delta
2456 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
2457 for details.
2458
2459 pack.islandCore::
2460 Specify an island name which gets to have its objects be
2461 packed first. This creates a kind of pseudo-pack at the front
2462 of one pack, so that the objects from the specified island are
2463 hopefully faster to copy into any pack that should be served
2464 to a user requesting these objects. In practice this means
2465 that the island specified should likely correspond to what is
2466 the most commonly cloned in the repo. See also "DELTA ISLANDS"
2467 in linkgit:git-pack-objects[1].
2468
2469 pack.deltaCacheSize::
2470 The maximum memory in bytes used for caching deltas in
2471 linkgit:git-pack-objects[1] before writing them out to a pack.
2472 This cache is used to speed up the writing object phase by not
2473 having to recompute the final delta result once the best match
2474 for all objects is found. Repacking large repositories on machines
2475 which are tight with memory might be badly impacted by this though,
2476 especially if this cache pushes the system into swapping.
2477 A value of 0 means no limit. The smallest size of 1 byte may be
2478 used to virtually disable this cache. Defaults to 256 MiB.
2479
2480 pack.deltaCacheLimit::
2481 The maximum size of a delta, that is cached in
2482 linkgit:git-pack-objects[1]. This cache is used to speed up the
2483 writing object phase by not having to recompute the final delta
2484 result once the best match for all objects is found.
2485 Defaults to 1000. Maximum value is 65535.
2486
2487 pack.threads::
2488 Specifies the number of threads to spawn when searching for best
2489 delta matches. This requires that linkgit:git-pack-objects[1]
2490 be compiled with pthreads otherwise this option is ignored with a
2491 warning. This is meant to reduce packing time on multiprocessor
2492 machines. The required amount of memory for the delta search window
2493 is however multiplied by the number of threads.
2494 Specifying 0 will cause Git to auto-detect the number of CPU's
2495 and set the number of threads accordingly.
2496
2497 pack.indexVersion::
2498 Specify the default pack index version. Valid values are 1 for
2499 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2500 the new pack index with capabilities for packs larger than 4 GB
2501 as well as proper protection against the repacking of corrupted
2502 packs. Version 2 is the default. Note that version 2 is enforced
2503 and this config option ignored whenever the corresponding pack is
2504 larger than 2 GB.
2505 +
2506 If you have an old Git that does not understand the version 2 `*.idx` file,
2507 cloning or fetching over a non native protocol (e.g. "http")
2508 that will copy both `*.pack` file and corresponding `*.idx` file from the
2509 other side may give you a repository that cannot be accessed with your
2510 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2511 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2512 the `*.idx` file.
2513
2514 pack.packSizeLimit::
2515 The maximum size of a pack. This setting only affects
2516 packing to a file when repacking, i.e. the git:// protocol
2517 is unaffected. It can be overridden by the `--max-pack-size`
2518 option of linkgit:git-repack[1]. Reaching this limit results
2519 in the creation of multiple packfiles; which in turn prevents
2520 bitmaps from being created.
2521 The minimum size allowed is limited to 1 MiB.
2522 The default is unlimited.
2523 Common unit suffixes of 'k', 'm', or 'g' are
2524 supported.
2525
2526 pack.useBitmaps::
2527 When true, git will use pack bitmaps (if available) when packing
2528 to stdout (e.g., during the server side of a fetch). Defaults to
2529 true. You should not generally need to turn this off unless
2530 you are debugging pack bitmaps.
2531
2532 pack.writeBitmaps (deprecated)::
2533 This is a deprecated synonym for `repack.writeBitmaps`.
2534
2535 pack.writeBitmapHashCache::
2536 When true, git will include a "hash cache" section in the bitmap
2537 index (if one is written). This cache can be used to feed git's
2538 delta heuristics, potentially leading to better deltas between
2539 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2540 between an older, bitmapped pack and objects that have been
2541 pushed since the last gc). The downside is that it consumes 4
2542 bytes per object of disk space, and that JGit's bitmap
2543 implementation does not understand it, causing it to complain if
2544 Git and JGit are used on the same repository. Defaults to false.
2545
2546 pager.<cmd>::
2547 If the value is boolean, turns on or off pagination of the
2548 output of a particular Git subcommand when writing to a tty.
2549 Otherwise, turns on pagination for the subcommand using the
2550 pager specified by the value of `pager.<cmd>`. If `--paginate`
2551 or `--no-pager` is specified on the command line, it takes
2552 precedence over this option. To disable pagination for all
2553 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2554
2555 pretty.<name>::
2556 Alias for a --pretty= format string, as specified in
2557 linkgit:git-log[1]. Any aliases defined here can be used just
2558 as the built-in pretty formats could. For example,
2559 running `git config pretty.changelog "format:* %H %s"`
2560 would cause the invocation `git log --pretty=changelog`
2561 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2562 Note that an alias with the same name as a built-in format
2563 will be silently ignored.
2564
2565 protocol.allow::
2566 If set, provide a user defined default policy for all protocols which
2567 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2568 if unset, known-safe protocols (http, https, git, ssh, file) have a
2569 default policy of `always`, known-dangerous protocols (ext) have a
2570 default policy of `never`, and all other protocols have a default
2571 policy of `user`. Supported policies:
2572 +
2573 --
2574
2575 * `always` - protocol is always able to be used.
2576
2577 * `never` - protocol is never able to be used.
2578
2579 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2580 either unset or has a value of 1. This policy should be used when you want a
2581 protocol to be directly usable by the user but don't want it used by commands which
2582 execute clone/fetch/push commands without user input, e.g. recursive
2583 submodule initialization.
2584
2585 --
2586
2587 protocol.<name>.allow::
2588 Set a policy to be used by protocol `<name>` with clone/fetch/push
2589 commands. See `protocol.allow` above for the available policies.
2590 +
2591 The protocol names currently used by git are:
2592 +
2593 --
2594 - `file`: any local file-based path (including `file://` URLs,
2595 or local paths)
2596
2597 - `git`: the anonymous git protocol over a direct TCP
2598 connection (or proxy, if configured)
2599
2600 - `ssh`: git over ssh (including `host:path` syntax,
2601 `ssh://`, etc).
2602
2603 - `http`: git over http, both "smart http" and "dumb http".
2604 Note that this does _not_ include `https`; if you want to configure
2605 both, you must do so individually.
2606
2607 - any external helpers are named by their protocol (e.g., use
2608 `hg` to allow the `git-remote-hg` helper)
2609 --
2610
2611 protocol.version::
2612 Experimental. If set, clients will attempt to communicate with a
2613 server using the specified protocol version. If unset, no
2614 attempt will be made by the client to communicate using a
2615 particular protocol version, this results in protocol version 0
2616 being used.
2617 Supported versions:
2618 +
2619 --
2620
2621 * `0` - the original wire protocol.
2622
2623 * `1` - the original wire protocol with the addition of a version string
2624 in the initial response from the server.
2625
2626 * `2` - link:technical/protocol-v2.html[wire protocol version 2].
2627
2628 --
2629
2630 include::pull-config.txt[]
2631
2632 include::push-config.txt[]
2633
2634 include::rebase-config.txt[]
2635
2636 include::receive-config.txt[]
2637
2638 remote.pushDefault::
2639 The remote to push to by default. Overrides
2640 `branch.<name>.remote` for all branches, and is overridden by
2641 `branch.<name>.pushRemote` for specific branches.
2642
2643 remote.<name>.url::
2644 The URL of a remote repository. See linkgit:git-fetch[1] or
2645 linkgit:git-push[1].
2646
2647 remote.<name>.pushurl::
2648 The push URL of a remote repository. See linkgit:git-push[1].
2649
2650 remote.<name>.proxy::
2651 For remotes that require curl (http, https and ftp), the URL to
2652 the proxy to use for that remote. Set to the empty string to
2653 disable proxying for that remote.
2654
2655 remote.<name>.proxyAuthMethod::
2656 For remotes that require curl (http, https and ftp), the method to use for
2657 authenticating against the proxy in use (probably set in
2658 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2659
2660 remote.<name>.fetch::
2661 The default set of "refspec" for linkgit:git-fetch[1]. See
2662 linkgit:git-fetch[1].
2663
2664 remote.<name>.push::
2665 The default set of "refspec" for linkgit:git-push[1]. See
2666 linkgit:git-push[1].
2667
2668 remote.<name>.mirror::
2669 If true, pushing to this remote will automatically behave
2670 as if the `--mirror` option was given on the command line.
2671
2672 remote.<name>.skipDefaultUpdate::
2673 If true, this remote will be skipped by default when updating
2674 using linkgit:git-fetch[1] or the `update` subcommand of
2675 linkgit:git-remote[1].
2676
2677 remote.<name>.skipFetchAll::
2678 If true, this remote will be skipped by default when updating
2679 using linkgit:git-fetch[1] or the `update` subcommand of
2680 linkgit:git-remote[1].
2681
2682 remote.<name>.receivepack::
2683 The default program to execute on the remote side when pushing. See
2684 option --receive-pack of linkgit:git-push[1].
2685
2686 remote.<name>.uploadpack::
2687 The default program to execute on the remote side when fetching. See
2688 option --upload-pack of linkgit:git-fetch-pack[1].
2689
2690 remote.<name>.tagOpt::
2691 Setting this value to --no-tags disables automatic tag following when
2692 fetching from remote <name>. Setting it to --tags will fetch every
2693 tag from remote <name>, even if they are not reachable from remote
2694 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2695 override this setting. See options --tags and --no-tags of
2696 linkgit:git-fetch[1].
2697
2698 remote.<name>.vcs::
2699 Setting this to a value <vcs> will cause Git to interact with
2700 the remote with the git-remote-<vcs> helper.
2701
2702 remote.<name>.prune::
2703 When set to true, fetching from this remote by default will also
2704 remove any remote-tracking references that no longer exist on the
2705 remote (as if the `--prune` option was given on the command line).
2706 Overrides `fetch.prune` settings, if any.
2707
2708 remote.<name>.pruneTags::
2709 When set to true, fetching from this remote by default will also
2710 remove any local tags that no longer exist on the remote if pruning
2711 is activated in general via `remote.<name>.prune`, `fetch.prune` or
2712 `--prune`. Overrides `fetch.pruneTags` settings, if any.
2713 +
2714 See also `remote.<name>.prune` and the PRUNING section of
2715 linkgit:git-fetch[1].
2716
2717 remotes.<group>::
2718 The list of remotes which are fetched by "git remote update
2719 <group>". See linkgit:git-remote[1].
2720
2721 repack.useDeltaBaseOffset::
2722 By default, linkgit:git-repack[1] creates packs that use
2723 delta-base offset. If you need to share your repository with
2724 Git older than version 1.4.4, either directly or via a dumb
2725 protocol such as http, then you need to set this option to
2726 "false" and repack. Access from old Git versions over the
2727 native protocol are unaffected by this option.
2728
2729 repack.packKeptObjects::
2730 If set to true, makes `git repack` act as if
2731 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2732 details. Defaults to `false` normally, but `true` if a bitmap
2733 index is being written (either via `--write-bitmap-index` or
2734 `repack.writeBitmaps`).
2735
2736 repack.useDeltaIslands::
2737 If set to true, makes `git repack` act as if `--delta-islands`
2738 was passed. Defaults to `false`.
2739
2740 repack.writeBitmaps::
2741 When true, git will write a bitmap index when packing all
2742 objects to disk (e.g., when `git repack -a` is run). This
2743 index can speed up the "counting objects" phase of subsequent
2744 packs created for clones and fetches, at the cost of some disk
2745 space and extra time spent on the initial repack. This has
2746 no effect if multiple packfiles are created.
2747 Defaults to false.
2748
2749 rerere.autoUpdate::
2750 When set to true, `git-rerere` updates the index with the
2751 resulting contents after it cleanly resolves conflicts using
2752 previously recorded resolution. Defaults to false.
2753
2754 rerere.enabled::
2755 Activate recording of resolved conflicts, so that identical
2756 conflict hunks can be resolved automatically, should they be
2757 encountered again. By default, linkgit:git-rerere[1] is
2758 enabled if there is an `rr-cache` directory under the
2759 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2760 repository.
2761
2762 include::sendemail-config.txt[]
2763
2764 sequence.editor::
2765 Text editor used by `git rebase -i` for editing the rebase instruction file.
2766 The value is meant to be interpreted by the shell when it is used.
2767 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
2768 When not configured the default commit message editor is used instead.
2769
2770 showBranch.default::
2771 The default set of branches for linkgit:git-show-branch[1].
2772 See linkgit:git-show-branch[1].
2773
2774 splitIndex.maxPercentChange::
2775 When the split index feature is used, this specifies the
2776 percent of entries the split index can contain compared to the
2777 total number of entries in both the split index and the shared
2778 index before a new shared index is written.
2779 The value should be between 0 and 100. If the value is 0 then
2780 a new shared index is always written, if it is 100 a new
2781 shared index is never written.
2782 By default the value is 20, so a new shared index is written
2783 if the number of entries in the split index would be greater
2784 than 20 percent of the total number of entries.
2785 See linkgit:git-update-index[1].
2786
2787 splitIndex.sharedIndexExpire::
2788 When the split index feature is used, shared index files that
2789 were not modified since the time this variable specifies will
2790 be removed when a new shared index file is created. The value
2791 "now" expires all entries immediately, and "never" suppresses
2792 expiration altogether.
2793 The default value is "2.weeks.ago".
2794 Note that a shared index file is considered modified (for the
2795 purpose of expiration) each time a new split-index file is
2796 either created based on it or read from it.
2797 See linkgit:git-update-index[1].
2798
2799 status.relativePaths::
2800 By default, linkgit:git-status[1] shows paths relative to the
2801 current directory. Setting this variable to `false` shows paths
2802 relative to the repository root (this was the default for Git
2803 prior to v1.5.4).
2804
2805 status.short::
2806 Set to true to enable --short by default in linkgit:git-status[1].
2807 The option --no-short takes precedence over this variable.
2808
2809 status.branch::
2810 Set to true to enable --branch by default in linkgit:git-status[1].
2811 The option --no-branch takes precedence over this variable.
2812
2813 status.displayCommentPrefix::
2814 If set to true, linkgit:git-status[1] will insert a comment
2815 prefix before each output line (starting with
2816 `core.commentChar`, i.e. `#` by default). This was the
2817 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2818 Defaults to false.
2819
2820 status.renameLimit::
2821 The number of files to consider when performing rename detection
2822 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
2823 the value of diff.renameLimit.
2824
2825 status.renames::
2826 Whether and how Git detects renames in linkgit:git-status[1] and
2827 linkgit:git-commit[1] . If set to "false", rename detection is
2828 disabled. If set to "true", basic rename detection is enabled.
2829 If set to "copies" or "copy", Git will detect copies, as well.
2830 Defaults to the value of diff.renames.
2831
2832 status.showStash::
2833 If set to true, linkgit:git-status[1] will display the number of
2834 entries currently stashed away.
2835 Defaults to false.
2836
2837 status.showUntrackedFiles::
2838 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2839 files which are not currently tracked by Git. Directories which
2840 contain only untracked files, are shown with the directory name
2841 only. Showing untracked files means that Git needs to lstat() all
2842 the files in the whole repository, which might be slow on some
2843 systems. So, this variable controls how the commands displays
2844 the untracked files. Possible values are:
2845 +
2846 --
2847 * `no` - Show no untracked files.
2848 * `normal` - Show untracked files and directories.
2849 * `all` - Show also individual files in untracked directories.
2850 --
2851 +
2852 If this variable is not specified, it defaults to 'normal'.
2853 This variable can be overridden with the -u|--untracked-files option
2854 of linkgit:git-status[1] and linkgit:git-commit[1].
2855
2856 status.submoduleSummary::
2857 Defaults to false.
2858 If this is set to a non zero number or true (identical to -1 or an
2859 unlimited number), the submodule summary will be enabled and a
2860 summary of commits for modified submodules will be shown (see
2861 --summary-limit option of linkgit:git-submodule[1]). Please note
2862 that the summary output command will be suppressed for all
2863 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2864 for those submodules where `submodule.<name>.ignore=all`. The only
2865 exception to that rule is that status and commit will show staged
2866 submodule changes. To
2867 also view the summary for ignored submodules you can either use
2868 the --ignore-submodules=dirty command-line option or the 'git
2869 submodule summary' command, which shows a similar output but does
2870 not honor these settings.
2871
2872 stash.showPatch::
2873 If this is set to true, the `git stash show` command without an
2874 option will show the stash entry in patch form. Defaults to false.
2875 See description of 'show' command in linkgit:git-stash[1].
2876
2877 stash.showStat::
2878 If this is set to true, the `git stash show` command without an
2879 option will show diffstat of the stash entry. Defaults to true.
2880 See description of 'show' command in linkgit:git-stash[1].
2881
2882 include::submodule-config.txt[]
2883
2884 tag.forceSignAnnotated::
2885 A boolean to specify whether annotated tags created should be GPG signed.
2886 If `--annotate` is specified on the command line, it takes
2887 precedence over this option.
2888
2889 tag.sort::
2890 This variable controls the sort ordering of tags when displayed by
2891 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2892 value of this variable will be used as the default.
2893
2894 tar.umask::
2895 This variable can be used to restrict the permission bits of
2896 tar archive entries. The default is 0002, which turns off the
2897 world write bit. The special value "user" indicates that the
2898 archiving user's umask will be used instead. See umask(2) and
2899 linkgit:git-archive[1].
2900
2901 transfer.fsckObjects::
2902 When `fetch.fsckObjects` or `receive.fsckObjects` are
2903 not set, the value of this variable is used instead.
2904 Defaults to false.
2905 +
2906 When set, the fetch or receive will abort in the case of a malformed
2907 object or a link to a nonexistent object. In addition, various other
2908 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
2909 and potential security issues like the existence of a `.GIT` directory
2910 or a malicious `.gitmodules` file (see the release notes for v2.2.1
2911 and v2.17.1 for details). Other sanity and security checks may be
2912 added in future releases.
2913 +
2914 On the receiving side, failing fsckObjects will make those objects
2915 unreachable, see "QUARANTINE ENVIRONMENT" in
2916 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
2917 instead be left unreferenced in the repository.
2918 +
2919 Due to the non-quarantine nature of the `fetch.fsckObjects`
2920 implementation it can not be relied upon to leave the object store
2921 clean like `receive.fsckObjects` can.
2922 +
2923 As objects are unpacked they're written to the object store, so there
2924 can be cases where malicious objects get introduced even though the
2925 "fetch" failed, only to have a subsequent "fetch" succeed because only
2926 new incoming objects are checked, not those that have already been
2927 written to the object store. That difference in behavior should not be
2928 relied upon. In the future, such objects may be quarantined for
2929 "fetch" as well.
2930 +
2931 For now, the paranoid need to find some way to emulate the quarantine
2932 environment if they'd like the same protection as "push". E.g. in the
2933 case of an internal mirror do the mirroring in two steps, one to fetch
2934 the untrusted objects, and then do a second "push" (which will use the
2935 quarantine) to another internal repo, and have internal clients
2936 consume this pushed-to repository, or embargo internal fetches and
2937 only allow them once a full "fsck" has run (and no new fetches have
2938 happened in the meantime).
2939
2940 transfer.hideRefs::
2941 String(s) `receive-pack` and `upload-pack` use to decide which
2942 refs to omit from their initial advertisements. Use more than
2943 one definition to specify multiple prefix strings. A ref that is
2944 under the hierarchies listed in the value of this variable is
2945 excluded, and is hidden when responding to `git push` or `git
2946 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2947 program-specific versions of this config.
2948 +
2949 You may also include a `!` in front of the ref name to negate the entry,
2950 explicitly exposing it, even if an earlier entry marked it as hidden.
2951 If you have multiple hideRefs values, later entries override earlier ones
2952 (and entries in more-specific config files override less-specific ones).
2953 +
2954 If a namespace is in use, the namespace prefix is stripped from each
2955 reference before it is matched against `transfer.hiderefs` patterns.
2956 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2957 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2958 is omitted from the advertisements but `refs/heads/master` and
2959 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2960 "have" lines. In order to match refs before stripping, add a `^` in front of
2961 the ref name. If you combine `!` and `^`, `!` must be specified first.
2962 +
2963 Even if you hide refs, a client may still be able to steal the target
2964 objects via the techniques described in the "SECURITY" section of the
2965 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
2966 separate repository.
2967
2968 transfer.unpackLimit::
2969 When `fetch.unpackLimit` or `receive.unpackLimit` are
2970 not set, the value of this variable is used instead.
2971 The default value is 100.
2972
2973 uploadarchive.allowUnreachable::
2974 If true, allow clients to use `git archive --remote` to request
2975 any tree, whether reachable from the ref tips or not. See the
2976 discussion in the "SECURITY" section of
2977 linkgit:git-upload-archive[1] for more details. Defaults to
2978 `false`.
2979
2980 uploadpack.hideRefs::
2981 This variable is the same as `transfer.hideRefs`, but applies
2982 only to `upload-pack` (and so affects only fetches, not pushes).
2983 An attempt to fetch a hidden ref by `git fetch` will fail. See
2984 also `uploadpack.allowTipSHA1InWant`.
2985
2986 uploadpack.allowTipSHA1InWant::
2987 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2988 to accept a fetch request that asks for an object at the tip
2989 of a hidden ref (by default, such a request is rejected).
2990 See also `uploadpack.hideRefs`. Even if this is false, a client
2991 may be able to steal objects via the techniques described in the
2992 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
2993 best to keep private data in a separate repository.
2994
2995 uploadpack.allowReachableSHA1InWant::
2996 Allow `upload-pack` to accept a fetch request that asks for an
2997 object that is reachable from any ref tip. However, note that
2998 calculating object reachability is computationally expensive.
2999 Defaults to `false`. Even if this is false, a client may be able
3000 to steal objects via the techniques described in the "SECURITY"
3001 section of the linkgit:gitnamespaces[7] man page; it's best to
3002 keep private data in a separate repository.
3003
3004 uploadpack.allowAnySHA1InWant::
3005 Allow `upload-pack` to accept a fetch request that asks for any
3006 object at all.
3007 Defaults to `false`.
3008
3009 uploadpack.keepAlive::
3010 When `upload-pack` has started `pack-objects`, there may be a
3011 quiet period while `pack-objects` prepares the pack. Normally
3012 it would output progress information, but if `--quiet` was used
3013 for the fetch, `pack-objects` will output nothing at all until
3014 the pack data begins. Some clients and networks may consider
3015 the server to be hung and give up. Setting this option instructs
3016 `upload-pack` to send an empty keepalive packet every
3017 `uploadpack.keepAlive` seconds. Setting this option to 0
3018 disables keepalive packets entirely. The default is 5 seconds.
3019
3020 uploadpack.packObjectsHook::
3021 If this option is set, when `upload-pack` would run
3022 `git pack-objects` to create a packfile for a client, it will
3023 run this shell command instead. The `pack-objects` command and
3024 arguments it _would_ have run (including the `git pack-objects`
3025 at the beginning) are appended to the shell command. The stdin
3026 and stdout of the hook are treated as if `pack-objects` itself
3027 was run. I.e., `upload-pack` will feed input intended for
3028 `pack-objects` to the hook, and expects a completed packfile on
3029 stdout.
3030 +
3031 Note that this configuration variable is ignored if it is seen in the
3032 repository-level config (this is a safety measure against fetching from
3033 untrusted repositories).
3034
3035 uploadpack.allowFilter::
3036 If this option is set, `upload-pack` will support partial
3037 clone and partial fetch object filtering.
3038
3039 uploadpack.allowRefInWant::
3040 If this option is set, `upload-pack` will support the `ref-in-want`
3041 feature of the protocol version 2 `fetch` command. This feature
3042 is intended for the benefit of load-balanced servers which may
3043 not have the same view of what OIDs their refs point to due to
3044 replication delay.
3045
3046 url.<base>.insteadOf::
3047 Any URL that starts with this value will be rewritten to
3048 start, instead, with <base>. In cases where some site serves a
3049 large number of repositories, and serves them with multiple
3050 access methods, and some users need to use different access
3051 methods, this feature allows people to specify any of the
3052 equivalent URLs and have Git automatically rewrite the URL to
3053 the best alternative for the particular user, even for a
3054 never-before-seen repository on the site. When more than one
3055 insteadOf strings match a given URL, the longest match is used.
3056 +
3057 Note that any protocol restrictions will be applied to the rewritten
3058 URL. If the rewrite changes the URL to use a custom protocol or remote
3059 helper, you may need to adjust the `protocol.*.allow` config to permit
3060 the request. In particular, protocols you expect to use for submodules
3061 must be set to `always` rather than the default of `user`. See the
3062 description of `protocol.allow` above.
3063
3064 url.<base>.pushInsteadOf::
3065 Any URL that starts with this value will not be pushed to;
3066 instead, it will be rewritten to start with <base>, and the
3067 resulting URL will be pushed to. In cases where some site serves
3068 a large number of repositories, and serves them with multiple
3069 access methods, some of which do not allow push, this feature
3070 allows people to specify a pull-only URL and have Git
3071 automatically use an appropriate URL to push, even for a
3072 never-before-seen repository on the site. When more than one
3073 pushInsteadOf strings match a given URL, the longest match is
3074 used. If a remote has an explicit pushurl, Git will ignore this
3075 setting for that remote.
3076
3077 user.email::
3078 Your email address to be recorded in any newly created commits.
3079 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3080 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3081
3082 user.name::
3083 Your full name to be recorded in any newly created commits.
3084 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3085 environment variables. See linkgit:git-commit-tree[1].
3086
3087 user.useConfigOnly::
3088 Instruct Git to avoid trying to guess defaults for `user.email`
3089 and `user.name`, and instead retrieve the values only from the
3090 configuration. For example, if you have multiple email addresses
3091 and would like to use a different one for each repository, then
3092 with this configuration option set to `true` in the global config
3093 along with a name, Git will prompt you to set up an email before
3094 making new commits in a newly cloned repository.
3095 Defaults to `false`.
3096
3097 user.signingKey::
3098 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3099 key you want it to automatically when creating a signed tag or
3100 commit, you can override the default selection with this variable.
3101 This option is passed unchanged to gpg's --local-user parameter,
3102 so you may specify a key using any method that gpg supports.
3103
3104 versionsort.prereleaseSuffix (deprecated)::
3105 Deprecated alias for `versionsort.suffix`. Ignored if
3106 `versionsort.suffix` is set.
3107
3108 versionsort.suffix::
3109 Even when version sort is used in linkgit:git-tag[1], tagnames
3110 with the same base version but different suffixes are still sorted
3111 lexicographically, resulting e.g. in prerelease tags appearing
3112 after the main release (e.g. "1.0-rc1" after "1.0"). This
3113 variable can be specified to determine the sorting order of tags
3114 with different suffixes.
3115 +
3116 By specifying a single suffix in this variable, any tagname containing
3117 that suffix will appear before the corresponding main release. E.g. if
3118 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3119 "1.0". If specified multiple times, once per suffix, then the order of
3120 suffixes in the configuration will determine the sorting order of tagnames
3121 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3122 configuration, then all "1.0-preX" tags will be listed before any
3123 "1.0-rcX" tags. The placement of the main release tag relative to tags
3124 with various suffixes can be determined by specifying the empty suffix
3125 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3126 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3127 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3128 "v4.8-bfsX".
3129 +
3130 If more than one suffixes match the same tagname, then that tagname will
3131 be sorted according to the suffix which starts at the earliest position in
3132 the tagname. If more than one different matching suffixes start at
3133 that earliest position, then that tagname will be sorted according to the
3134 longest of those suffixes.
3135 The sorting order between different suffixes is undefined if they are
3136 in multiple config files.
3137
3138 web.browser::
3139 Specify a web browser that may be used by some commands.
3140 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3141 may use it.
3142
3143 worktree.guessRemote::
3144 With `add`, if no branch argument, and neither of `-b` nor
3145 `-B` nor `--detach` are given, the command defaults to
3146 creating a new branch from HEAD. If `worktree.guessRemote` is
3147 set to true, `worktree add` tries to find a remote-tracking
3148 branch whose name uniquely matches the new branch name. If
3149 such a branch exists, it is checked out and set as "upstream"
3150 for the new branch. If no such match can be found, it falls
3151 back to creating a new branch from the current HEAD.