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