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