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