walker: drop fields of `struct walker` which are always 1
[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 "kernel.org"
183 gitProxy=default-proxy ; for the rest
185 [include]
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
206 path = foo.inc
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.sparseCheckout::
902 Enable "sparse checkout" feature. See section "Sparse checkout" in
903 linkgit:git-read-tree[1] for more information.
905 core.abbrev::
906 Set the length object names are abbreviated to. If
907 unspecified or set to "auto", an appropriate value is
908 computed based on the approximate number of packed objects
909 in your repository, which hopefully is enough for
910 abbreviated object names to stay unique for some time.
911 The minimum length is 4.
913 add.ignoreErrors::
914 add.ignore-errors (deprecated)::
915 Tells 'git add' to continue adding files when some files cannot be
916 added due to indexing errors. Equivalent to the `--ignore-errors`
917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
918 as it does not follow the usual naming convention for configuration
919 variables.
921 alias.*::
922 Command aliases for the linkgit:git[1] command wrapper - e.g.
923 after defining "alias.last = cat-file commit HEAD", the invocation
924 "git last" is equivalent to "git cat-file commit HEAD". To avoid
925 confusion and troubles with script usage, aliases that
926 hide existing Git commands are ignored. Arguments are split by
927 spaces, the usual shell quoting and escaping is supported.
928 A quote pair or a backslash can be used to quote them.
929 +
930 If the alias expansion is prefixed with an exclamation point,
931 it will be treated as a shell command. For example, defining
932 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
933 "git new" is equivalent to running the shell command
934 "gitk --all --not ORIG_HEAD". Note that shell commands will be
935 executed from the top-level directory of a repository, which may
936 not necessarily be the current directory.
937 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
938 from the original current directory. See linkgit:git-rev-parse[1].
940 am.keepcr::
941 If true, git-am will call git-mailsplit for patches in mbox format
942 with parameter `--keep-cr`. In this case git-mailsplit will
943 not remove `\r` from lines ending with `\r\n`. Can be overridden
944 by giving `--no-keep-cr` from the command line.
945 See linkgit:git-am[1], linkgit:git-mailsplit[1].
947 am.threeWay::
948 By default, `git am` will fail if the patch does not apply cleanly. When
949 set to true, this setting tells `git am` to fall back on 3-way merge if
950 the patch records the identity of blobs it is supposed to apply to and
951 we have those blobs available locally (equivalent to giving the `--3way`
952 option from the command line). Defaults to `false`.
953 See linkgit:git-am[1].
955 apply.ignoreWhitespace::
956 When set to 'change', tells 'git apply' to ignore changes in
957 whitespace, in the same way as the `--ignore-space-change`
958 option.
959 When set to one of: no, none, never, false tells 'git apply' to
960 respect all whitespace differences.
961 See linkgit:git-apply[1].
963 apply.whitespace::
964 Tells 'git apply' how to handle whitespaces, in the same way
965 as the `--whitespace` option. See linkgit:git-apply[1].
967 blame.showRoot::
968 Do not treat root commits as boundaries in linkgit:git-blame[1].
969 This option defaults to false.
971 blame.blankBoundary::
972 Show blank commit object name for boundary commits in
973 linkgit:git-blame[1]. This option defaults to false.
975 blame.showEmail::
976 Show the author email instead of author name in linkgit:git-blame[1].
977 This option defaults to false.
979 blame.date::
980 Specifies the format used to output dates in linkgit:git-blame[1].
981 If unset the iso format is used. For supported values,
982 see the discussion of the `--date` option at linkgit:git-log[1].
984 branch.autoSetupMerge::
985 Tells 'git branch' and 'git checkout' to set up new branches
986 so that linkgit:git-pull[1] will appropriately merge from the
987 starting point branch. Note that even if this option is not set,
988 this behavior can be chosen per-branch using the `--track`
989 and `--no-track` options. The valid settings are: `false` -- no
990 automatic setup is done; `true` -- automatic setup is done when the
991 starting point is a remote-tracking branch; `always` --
992 automatic setup is done when the starting point is either a
993 local branch or remote-tracking
994 branch. This option defaults to true.
996 branch.autoSetupRebase::
997 When a new branch is created with 'git branch' or 'git checkout'
998 that tracks another branch, this variable tells Git to set
999 up pull to rebase instead of merge (see "branch.<name>.rebase").
1000 When `never`, rebase is never automatically set to true.
1001 When `local`, rebase is set to true for tracked branches of
1002 other local branches.
1003 When `remote`, rebase is set to true for tracked branches of
1004 remote-tracking branches.
1005 When `always`, rebase will be set to true for all tracking
1006 branches.
1007 See "branch.autoSetupMerge" for details on how to set up a
1008 branch to track another branch.
1009 This option defaults to never.
1011 branch.<name>.remote::
1012 When on branch <name>, it tells 'git fetch' and 'git push'
1013 which remote to fetch from/push to. The remote to push to
1014 may be overridden with `remote.pushDefault` (for all branches).
1015 The remote to push to, for the current branch, may be further
1016 overridden by `branch.<name>.pushRemote`. If no remote is
1017 configured, or if you are not on any branch, it defaults to
1018 `origin` for fetching and `remote.pushDefault` for pushing.
1019 Additionally, `.` (a period) is the current local repository
1020 (a dot-repository), see `branch.<name>.merge`'s final note below.
1022 branch.<name>.pushRemote::
1023 When on branch <name>, it overrides `branch.<name>.remote` for
1024 pushing. It also overrides `remote.pushDefault` for pushing
1025 from branch <name>. When you pull from one place (e.g. your
1026 upstream) and push to another place (e.g. your own publishing
1027 repository), you would want to set `remote.pushDefault` to
1028 specify the remote to push to for all branches, and use this
1029 option to override it for a specific branch.
1031 branch.<name>.merge::
1032 Defines, together with branch.<name>.remote, the upstream branch
1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1034 branch to merge and can also affect 'git push' (see push.default).
1035 When in branch <name>, it tells 'git fetch' the default
1036 refspec to be marked for merging in FETCH_HEAD. The value is
1037 handled like the remote part of a refspec, and must match a
1038 ref which is fetched from the remote given by
1039 "branch.<name>.remote".
1040 The merge information is used by 'git pull' (which at first calls
1041 'git fetch') to lookup the default branch for merging. Without
1042 this option, 'git pull' defaults to merge the first refspec fetched.
1043 Specify multiple values to get an octopus merge.
1044 If you wish to setup 'git pull' so that it merges into <name> from
1045 another branch in the local repository, you can point
1046 branch.<name>.merge to the desired branch, and use the relative path
1047 setting `.` (a period) for branch.<name>.remote.
1049 branch.<name>.mergeOptions::
1050 Sets default options for merging into branch <name>. The syntax and
1051 supported options are the same as those of linkgit:git-merge[1], but
1052 option values containing whitespace characters are currently not
1053 supported.
1055 branch.<name>.rebase::
1056 When true, rebase the branch <name> on top of the fetched branch,
1057 instead of merging the default branch from the default remote when
1058 "git pull" is run. See "pull.rebase" for doing this in a non
1059 branch-specific manner.
1060 +
1061 When preserve, also pass `--preserve-merges` along to 'git rebase'
1062 so that locally committed merge commits will not be flattened
1063 by running 'git pull'.
1064 +
1065 When the value is `interactive`, the rebase is run in interactive mode.
1066 +
1067 *NOTE*: this is a possibly dangerous operation; do *not* use
1068 it unless you understand the implications (see linkgit:git-rebase[1]
1069 for details).
1071 branch.<name>.description::
1072 Branch description, can be edited with
1073 `git branch --edit-description`. Branch description is
1074 automatically added in the format-patch cover letter or
1075 request-pull summary.
1077 browser.<tool>.cmd::
1078 Specify the command to invoke the specified browser. The
1079 specified command is evaluated in shell with the URLs passed
1080 as arguments. (See linkgit:git-web{litdd}browse[1].)
1082 browser.<tool>.path::
1083 Override the path for the given tool that may be used to
1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1085 working repository in gitweb (see linkgit:git-instaweb[1]).
1087 clean.requireForce::
1088 A boolean to make git-clean do nothing unless given -f,
1089 -i or -n. Defaults to true.
1091 color.branch::
1092 A boolean to enable/disable color in the output of
1093 linkgit:git-branch[1]. May be set to `always`,
1094 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1095 only when the output is to a terminal. If unset, then the
1096 value of `color.ui` is used (`auto` by default).
1098 color.branch.<slot>::
1099 Use customized color for branch coloration. `<slot>` is one of
1100 `current` (the current branch), `local` (a local branch),
1101 `remote` (a remote-tracking branch in refs/remotes/),
1102 `upstream` (upstream tracking branch), `plain` (other
1103 refs).
1105 color.diff::
1106 Whether to use ANSI escape sequences to add color to patches.
1107 If this is set to `always`, linkgit:git-diff[1],
1108 linkgit:git-log[1], and linkgit:git-show[1] will use color
1109 for all patches. If it is set to `true` or `auto`, those
1110 commands will only use color when output is to the terminal.
1111 If unset, then the value of `color.ui` is used (`auto` by
1112 default).
1113 +
1114 This does not affect linkgit:git-format-patch[1] or the
1115 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1116 command line with the `--color[=<when>]` option.
1118 diff.colorMoved::
1119 If set to either a valid `<mode>` or a true value, moved lines
1120 in a diff are colored differently, for details of valid modes
1121 see '--color-moved' in linkgit:git-diff[1]. If simply set to
1122 true the default color mode will be used. When set to false,
1123 moved lines are not colored.
1125 color.diff.<slot>::
1126 Use customized color for diff colorization. `<slot>` specifies
1127 which part of the patch to use the specified color, and is one
1128 of `context` (context text - `plain` is a historical synonym),
1129 `meta` (metainformation), `frag`
1130 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1131 `new` (added lines), `commit` (commit headers), `whitespace`
1132 (highlighting whitespace errors), `oldMoved` (deleted lines),
1133 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1134 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1135 and `newMovedAlternativeDimmed` (See the '<mode>'
1136 setting of '--color-moved' in linkgit:git-diff[1] for details).
1138 color.decorate.<slot>::
1139 Use customized color for 'git log --decorate' output. `<slot>` is one
1140 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1141 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1143 color.grep::
1144 When set to `always`, always highlight matches. When `false` (or
1145 `never`), never. When set to `true` or `auto`, use color only
1146 when the output is written to the terminal. If unset, then the
1147 value of `color.ui` is used (`auto` by default).
1149 color.grep.<slot>::
1150 Use customized color for grep colorization. `<slot>` specifies which
1151 part of the line to use the specified color, and is one of
1152 +
1153 --
1154 `context`;;
1155 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1156 `filename`;;
1157 filename prefix (when not using `-h`)
1158 `function`;;
1159 function name lines (when using `-p`)
1160 `linenumber`;;
1161 line number prefix (when using `-n`)
1162 `match`;;
1163 matching text (same as setting `matchContext` and `matchSelected`)
1164 `matchContext`;;
1165 matching text in context lines
1166 `matchSelected`;;
1167 matching text in selected lines
1168 `selected`;;
1169 non-matching text in selected lines
1170 `separator`;;
1171 separators between fields on a line (`:`, `-`, and `=`)
1172 and between hunks (`--`)
1173 --
1175 color.interactive::
1176 When set to `always`, always use colors for interactive prompts
1177 and displays (such as those used by "git-add --interactive" and
1178 "git-clean --interactive"). When false (or `never`), never.
1179 When set to `true` or `auto`, use colors only when the output is
1180 to the terminal. If unset, then the value of `color.ui` is
1181 used (`auto` by default).
1183 color.interactive.<slot>::
1184 Use customized color for 'git add --interactive' and 'git clean
1185 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1186 or `error`, for four distinct types of normal output from
1187 interactive commands.
1189 color.pager::
1190 A boolean to enable/disable colored output when the pager is in
1191 use (default is true).
1193 color.showBranch::
1194 A boolean to enable/disable color in the output of
1195 linkgit:git-show-branch[1]. May be set to `always`,
1196 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1197 only when the output is to a terminal. If unset, then the
1198 value of `color.ui` is used (`auto` by default).
1200 color.status::
1201 A boolean to enable/disable color in the output of
1202 linkgit:git-status[1]. May be set to `always`,
1203 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1204 only when the output is to a terminal. If unset, then the
1205 value of `color.ui` is used (`auto` by default).
1207 color.status.<slot>::
1208 Use customized color for status colorization. `<slot>` is
1209 one of `header` (the header text of the status message),
1210 `added` or `updated` (files which are added but not committed),
1211 `changed` (files which are changed but not added in the index),
1212 `untracked` (files which are not tracked by Git),
1213 `branch` (the current branch),
1214 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1215 to red),
1216 `localBranch` or `remoteBranch` (the local and remote branch names,
1217 respectively, when branch and tracking information is displayed in the
1218 status short-format), or
1219 `unmerged` (files which have unmerged changes).
1221 color.ui::
1222 This variable determines the default value for variables such
1223 as `color.diff` and `color.grep` that control the use of color
1224 per command family. Its scope will expand as more commands learn
1225 configuration to set a default for the `--color` option. Set it
1226 to `false` or `never` if you prefer Git commands not to use
1227 color unless enabled explicitly with some other configuration
1228 or the `--color` option. Set it to `always` if you want all
1229 output not intended for machine consumption to use color, to
1230 `true` or `auto` (this is the default since Git 1.8.4) if you
1231 want such output to use color when written to the terminal.
1233 column.ui::
1234 Specify whether supported commands should output in columns.
1235 This variable consists of a list of tokens separated by spaces
1236 or commas:
1237 +
1238 These options control when the feature should be enabled
1239 (defaults to 'never'):
1240 +
1241 --
1242 `always`;;
1243 always show in columns
1244 `never`;;
1245 never show in columns
1246 `auto`;;
1247 show in columns if the output is to the terminal
1248 --
1249 +
1250 These options control layout (defaults to 'column'). Setting any
1251 of these implies 'always' if none of 'always', 'never', or 'auto' are
1252 specified.
1253 +
1254 --
1255 `column`;;
1256 fill columns before rows
1257 `row`;;
1258 fill rows before columns
1259 `plain`;;
1260 show in one column
1261 --
1262 +
1263 Finally, these options can be combined with a layout option (defaults
1264 to 'nodense'):
1265 +
1266 --
1267 `dense`;;
1268 make unequal size columns to utilize more space
1269 `nodense`;;
1270 make equal size columns
1271 --
1273 column.branch::
1274 Specify whether to output branch listing in `git branch` in columns.
1275 See `column.ui` for details.
1277 column.clean::
1278 Specify the layout when list items in `git clean -i`, which always
1279 shows files and directories in columns. See `column.ui` for details.
1281 column.status::
1282 Specify whether to output untracked files in `git status` in columns.
1283 See `column.ui` for details.
1285 column.tag::
1286 Specify whether to output tag listing in `git tag` in columns.
1287 See `column.ui` for details.
1289 commit.cleanup::
1290 This setting overrides the default of the `--cleanup` option in
1291 `git commit`. See linkgit:git-commit[1] for details. Changing the
1292 default can be useful when you always want to keep lines that begin
1293 with comment character `#` in your log message, in which case you
1294 would do `git config commit.cleanup whitespace` (note that you will
1295 have to remove the help lines that begin with `#` in the commit log
1296 template yourself, if you do this).
1298 commit.gpgSign::
1300 A boolean to specify whether all commits should be GPG signed.
1301 Use of this option when doing operations such as rebase can
1302 result in a large number of commits being signed. It may be
1303 convenient to use an agent to avoid typing your GPG passphrase
1304 several times.
1306 commit.status::
1307 A boolean to enable/disable inclusion of status information in the
1308 commit message template when using an editor to prepare the commit
1309 message. Defaults to true.
1311 commit.template::
1312 Specify the pathname of a file to use as the template for
1313 new commit messages.
1315 commit.verbose::
1316 A boolean or int to specify the level of verbose with `git commit`.
1317 See linkgit:git-commit[1].
1319 credential.helper::
1320 Specify an external helper to be called when a username or
1321 password credential is needed; the helper may consult external
1322 storage to avoid prompting the user for the credentials. Note
1323 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1324 for details.
1326 credential.useHttpPath::
1327 When acquiring credentials, consider the "path" component of an http
1328 or https URL to be important. Defaults to false. See
1329 linkgit:gitcredentials[7] for more information.
1331 credential.username::
1332 If no username is set for a network authentication, use this username
1333 by default. See credential.<context>.* below, and
1334 linkgit:gitcredentials[7].
1336 credential.<url>.*::
1337 Any of the credential.* options above can be applied selectively to
1338 some credentials. For example "credential.https://example.com.username"
1339 would set the default username only for https connections to
1340 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1341 matched.
1343 credentialCache.ignoreSIGHUP::
1344 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1346 include::diff-config.txt[]
1348 difftool.<tool>.path::
1349 Override the path for the given tool. This is useful in case
1350 your tool is not in the PATH.
1352 difftool.<tool>.cmd::
1353 Specify the command to invoke the specified diff tool.
1354 The specified command is evaluated in shell with the following
1355 variables available: 'LOCAL' is set to the name of the temporary
1356 file containing the contents of the diff pre-image and 'REMOTE'
1357 is set to the name of the temporary file containing the contents
1358 of the diff post-image.
1360 difftool.prompt::
1361 Prompt before each invocation of the diff tool.
1363 fastimport.unpackLimit::
1364 If the number of objects imported by linkgit:git-fast-import[1]
1365 is below this limit, then the objects will be unpacked into
1366 loose object files. However if the number of imported objects
1367 equals or exceeds this limit then the pack will be stored as a
1368 pack. Storing the pack from a fast-import can make the import
1369 operation complete faster, especially on slow filesystems. If
1370 not set, the value of `transfer.unpackLimit` is used instead.
1372 fetch.recurseSubmodules::
1373 This option can be either set to a boolean value or to 'on-demand'.
1374 Setting it to a boolean changes the behavior of fetch and pull to
1375 unconditionally recurse into submodules when set to true or to not
1376 recurse at all when set to false. When set to 'on-demand' (the default
1377 value), fetch and pull will only recurse into a populated submodule
1378 when its superproject retrieves a commit that updates the submodule's
1379 reference.
1381 fetch.fsckObjects::
1382 If it is set to true, git-fetch-pack will check all fetched
1383 objects. It will abort in the case of a malformed object or a
1384 broken link. The result of an abort are only dangling objects.
1385 Defaults to false. If not set, the value of `transfer.fsckObjects`
1386 is used instead.
1388 fetch.unpackLimit::
1389 If the number of objects fetched over the Git native
1390 transfer is below this
1391 limit, then the objects will be unpacked into loose object
1392 files. However if the number of received objects equals or
1393 exceeds this limit then the received pack will be stored as
1394 a pack, after adding any missing delta bases. Storing the
1395 pack from a push can make the push operation complete faster,
1396 especially on slow filesystems. If not set, the value of
1397 `transfer.unpackLimit` is used instead.
1399 fetch.prune::
1400 If true, fetch will automatically behave as if the `--prune`
1401 option was given on the command line. See also `remote.<name>.prune`
1402 and the PRUNING section of linkgit:git-fetch[1].
1404 fetch.pruneTags::
1405 If true, fetch will automatically behave as if the
1406 `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1407 if not set already. This allows for setting both this option
1408 and `fetch.prune` to maintain a 1=1 mapping to upstream
1409 refs. See also `remote.<name>.pruneTags` and the PRUNING
1410 section of linkgit:git-fetch[1].
1412 fetch.output::
1413 Control how ref update status is printed. Valid values are
1414 `full` and `compact`. Default value is `full`. See section
1415 OUTPUT in linkgit:git-fetch[1] for detail.
1417 format.attach::
1418 Enable multipart/mixed attachments as the default for
1419 'format-patch'. The value can also be a double quoted string
1420 which will enable attachments as the default and set the
1421 value as the boundary. See the --attach option in
1422 linkgit:git-format-patch[1].
1424 format.from::
1425 Provides the default value for the `--from` option to format-patch.
1426 Accepts a boolean value, or a name and email address. If false,
1427 format-patch defaults to `--no-from`, using commit authors directly in
1428 the "From:" field of patch mails. If true, format-patch defaults to
1429 `--from`, using your committer identity in the "From:" field of patch
1430 mails and including a "From:" field in the body of the patch mail if
1431 different. If set to a non-boolean value, format-patch uses that
1432 value instead of your committer identity. Defaults to false.
1434 format.numbered::
1435 A boolean which can enable or disable sequence numbers in patch
1436 subjects. It defaults to "auto" which enables it only if there
1437 is more than one patch. It can be enabled or disabled for all
1438 messages by setting it to "true" or "false". See --numbered
1439 option in linkgit:git-format-patch[1].
1441 format.headers::
1442 Additional email headers to include in a patch to be submitted
1443 by mail. See linkgit:git-format-patch[1].
1445 format.to::
1446 format.cc::
1447 Additional recipients to include in a patch to be submitted
1448 by mail. See the --to and --cc options in
1449 linkgit:git-format-patch[1].
1451 format.subjectPrefix::
1452 The default for format-patch is to output files with the '[PATCH]'
1453 subject prefix. Use this variable to change that prefix.
1455 format.signature::
1456 The default for format-patch is to output a signature containing
1457 the Git version number. Use this variable to change that default.
1458 Set this variable to the empty string ("") to suppress
1459 signature generation.
1461 format.signatureFile::
1462 Works just like format.signature except the contents of the
1463 file specified by this variable will be used as the signature.
1465 format.suffix::
1466 The default for format-patch is to output files with the suffix
1467 `.patch`. Use this variable to change that suffix (make sure to
1468 include the dot if you want it).
1470 format.pretty::
1471 The default pretty format for log/show/whatchanged command,
1472 See linkgit:git-log[1], linkgit:git-show[1],
1473 linkgit:git-whatchanged[1].
1475 format.thread::
1476 The default threading style for 'git format-patch'. Can be
1477 a boolean value, or `shallow` or `deep`. `shallow` threading
1478 makes every mail a reply to the head of the series,
1479 where the head is chosen from the cover letter, the
1480 `--in-reply-to`, and the first patch mail, in this order.
1481 `deep` threading makes every mail a reply to the previous one.
1482 A true boolean value is the same as `shallow`, and a false
1483 value disables threading.
1485 format.signOff::
1486 A boolean value which lets you enable the `-s/--signoff` option of
1487 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1488 patch should be a conscious act and means that you certify you have
1489 the rights to submit this work under the same open source license.
1490 Please see the 'SubmittingPatches' document for further discussion.
1492 format.coverLetter::
1493 A boolean that controls whether to generate a cover-letter when
1494 format-patch is invoked, but in addition can be set to "auto", to
1495 generate a cover-letter only when there's more than one patch.
1497 format.outputDirectory::
1498 Set a custom directory to store the resulting files instead of the
1499 current working directory.
1501 format.useAutoBase::
1502 A boolean value which lets you enable the `--base=auto` option of
1503 format-patch by default.
1505 filter.<driver>.clean::
1506 The command which is used to convert the content of a worktree
1507 file to a blob upon checkin. See linkgit:gitattributes[5] for
1508 details.
1510 filter.<driver>.smudge::
1511 The command which is used to convert the content of a blob
1512 object to a worktree file upon checkout. See
1513 linkgit:gitattributes[5] for details.
1515 fsck.<msg-id>::
1516 Allows overriding the message type (error, warn or ignore) of a
1517 specific message ID such as `missingEmail`.
1518 +
1519 For convenience, fsck prefixes the error/warning with the message ID,
1520 e.g. "missingEmail: invalid author/committer line - missing email" means
1521 that setting `fsck.missingEmail = ignore` will hide that issue.
1522 +
1523 This feature is intended to support working with legacy repositories
1524 which cannot be repaired without disruptive changes.
1526 fsck.skipList::
1527 The path to a sorted list of object names (i.e. one SHA-1 per
1528 line) that are known to be broken in a non-fatal way and should
1529 be ignored. This feature is useful when an established project
1530 should be accepted despite early commits containing errors that
1531 can be safely ignored such as invalid committer email addresses.
1532 Note: corrupt objects cannot be skipped with this setting.
1534 gc.aggressiveDepth::
1535 The depth parameter used in the delta compression
1536 algorithm used by 'git gc --aggressive'. This defaults
1537 to 50.
1539 gc.aggressiveWindow::
1540 The window size parameter used in the delta compression
1541 algorithm used by 'git gc --aggressive'. This defaults
1542 to 250.
1544 gc.auto::
1545 When there are approximately more than this many loose
1546 objects in the repository, `git gc --auto` will pack them.
1547 Some Porcelain commands use this command to perform a
1548 light-weight garbage collection from time to time. The
1549 default value is 6700. Setting this to 0 disables it.
1551 gc.autoPackLimit::
1552 When there are more than this many packs that are not
1553 marked with `*.keep` file in the repository, `git gc
1554 --auto` consolidates them into one larger pack. The
1555 default value is 50. Setting this to 0 disables it.
1557 gc.autoDetach::
1558 Make `git gc --auto` return immediately and run in background
1559 if the system supports it. Default is true.
1561 gc.logExpiry::
1562 If the file gc.log exists, then `git gc --auto` won't run
1563 unless that file is more than 'gc.logExpiry' old. Default is
1564 "1.day". See `gc.pruneExpire` for more ways to specify its
1565 value.
1567 gc.packRefs::
1568 Running `git pack-refs` in a repository renders it
1569 unclonable by Git versions prior to over dumb
1570 transports such as HTTP. This variable determines whether
1571 'git gc' runs `git pack-refs`. This can be set to `notbare`
1572 to enable it within all non-bare repos or it can be set to a
1573 boolean value. The default is `true`.
1575 gc.pruneExpire::
1576 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1577 Override the grace period with this config variable. The value
1578 "now" may be used to disable this grace period and always prune
1579 unreachable objects immediately, or "never" may be used to
1580 suppress pruning. This feature helps prevent corruption when
1581 'git gc' runs concurrently with another process writing to the
1582 repository; see the "NOTES" section of linkgit:git-gc[1].
1584 gc.worktreePruneExpire::
1585 When 'git gc' is run, it calls
1586 'git worktree prune --expire 3.months.ago'.
1587 This config variable can be used to set a different grace
1588 period. The value "now" may be used to disable the grace
1589 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1590 may be used to suppress pruning.
1592 gc.reflogExpire::
1593 gc.<pattern>.reflogExpire::
1594 'git reflog expire' removes reflog entries older than
1595 this time; defaults to 90 days. The value "now" expires all
1596 entries immediately, and "never" suppresses expiration
1597 altogether. With "<pattern>" (e.g.
1598 "refs/stash") in the middle the setting applies only to
1599 the refs that match the <pattern>.
1601 gc.reflogExpireUnreachable::
1602 gc.<pattern>.reflogExpireUnreachable::
1603 'git reflog expire' removes reflog entries older than
1604 this time and are not reachable from the current tip;
1605 defaults to 30 days. The value "now" expires all entries
1606 immediately, and "never" suppresses expiration altogether.
1607 With "<pattern>" (e.g. "refs/stash")
1608 in the middle, the setting applies only to the refs that
1609 match the <pattern>.
1611 gc.rerereResolved::
1612 Records of conflicted merge you resolved earlier are
1613 kept for this many days when 'git rerere gc' is run.
1614 You can also use more human-readable "1.month.ago", etc.
1615 The default is 60 days. See linkgit:git-rerere[1].
1617 gc.rerereUnresolved::
1618 Records of conflicted merge you have not resolved are
1619 kept for this many days when 'git rerere gc' is run.
1620 You can also use more human-readable "1.month.ago", etc.
1621 The default is 15 days. See linkgit:git-rerere[1].
1623 gitcvs.commitMsgAnnotation::
1624 Append this string to each commit message. Set to empty string
1625 to disable this feature. Defaults to "via git-CVS emulator".
1627 gitcvs.enabled::
1628 Whether the CVS server interface is enabled for this repository.
1629 See linkgit:git-cvsserver[1].
1631 gitcvs.logFile::
1632 Path to a log file where the CVS server interface well... logs
1633 various stuff. See linkgit:git-cvsserver[1].
1635 gitcvs.usecrlfattr::
1636 If true, the server will look up the end-of-line conversion
1637 attributes for files to determine the `-k` modes to use. If
1638 the attributes force Git to treat a file as text,
1639 the `-k` mode will be left blank so CVS clients will
1640 treat it as text. If they suppress text conversion, the file
1641 will be set with '-kb' mode, which suppresses any newline munging
1642 the client might otherwise do. If the attributes do not allow
1643 the file type to be determined, then `gitcvs.allBinary` is
1644 used. See linkgit:gitattributes[5].
1646 gitcvs.allBinary::
1647 This is used if `gitcvs.usecrlfattr` does not resolve
1648 the correct '-kb' mode to use. If true, all
1649 unresolved files are sent to the client in
1650 mode '-kb'. This causes the client to treat them
1651 as binary files, which suppresses any newline munging it
1652 otherwise might do. Alternatively, if it is set to "guess",
1653 then the contents of the file are examined to decide if
1654 it is binary, similar to `core.autocrlf`.
1656 gitcvs.dbName::
1657 Database used by git-cvsserver to cache revision information
1658 derived from the Git repository. The exact meaning depends on the
1659 used database driver, for SQLite (which is the default driver) this
1660 is a filename. Supports variable substitution (see
1661 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1662 Default: '%Ggitcvs.%m.sqlite'
1664 gitcvs.dbDriver::
1665 Used Perl DBI driver. You can specify any available driver
1666 for this here, but it might not work. git-cvsserver is tested
1667 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1668 reported *not* to work with 'DBD::mysql'. Experimental feature.
1669 May not contain double colons (`:`). Default: 'SQLite'.
1670 See linkgit:git-cvsserver[1].
1672 gitcvs.dbUser, gitcvs.dbPass::
1673 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1674 since SQLite has no concept of database users and/or passwords.
1675 'gitcvs.dbUser' supports variable substitution (see
1676 linkgit:git-cvsserver[1] for details).
1678 gitcvs.dbTableNamePrefix::
1679 Database table name prefix. Prepended to the names of any
1680 database tables used, allowing a single database to be used
1681 for several repositories. Supports variable substitution (see
1682 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1683 characters will be replaced with underscores.
1685 All gitcvs variables except for `gitcvs.usecrlfattr` and
1686 `gitcvs.allBinary` can also be specified as
1687 'gitcvs.<access_method>.<varname>' (where 'access_method'
1688 is one of "ext" and "pserver") to make them apply only for the given
1689 access method.
1691 gitweb.category::
1692 gitweb.description::
1693 gitweb.owner::
1694 gitweb.url::
1695 See linkgit:gitweb[1] for description.
1697 gitweb.avatar::
1698 gitweb.blame::
1699 gitweb.grep::
1700 gitweb.highlight::
1701 gitweb.patches::
1702 gitweb.pickaxe::
1703 gitweb.remote_heads::
1704 gitweb.showSizes::
1705 gitweb.snapshot::
1706 See linkgit:gitweb.conf[5] for description.
1708 grep.lineNumber::
1709 If set to true, enable `-n` option by default.
1711 grep.patternType::
1712 Set the default matching behavior. Using a value of 'basic', 'extended',
1713 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1714 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1715 value 'default' will return to the default matching behavior.
1717 grep.extendedRegexp::
1718 If set to true, enable `--extended-regexp` option by default. This
1719 option is ignored when the `grep.patternType` option is set to a value
1720 other than 'default'.
1722 grep.threads::
1723 Number of grep worker threads to use.
1724 See `grep.threads` in linkgit:git-grep[1] for more information.
1726 grep.fallbackToNoIndex::
1727 If set to true, fall back to git grep --no-index if git grep
1728 is executed outside of a git repository. Defaults to false.
1730 gpg.program::
1731 Use this custom program instead of "`gpg`" found on `$PATH` when
1732 making or verifying a PGP signature. The program must support the
1733 same command-line interface as GPG, namely, to verify a detached
1734 signature, "`gpg --verify $file - <$signature`" is run, and the
1735 program is expected to signal a good signature by exiting with
1736 code 0, and to generate an ASCII-armored detached signature, the
1737 standard input of "`gpg -bsau $key`" is fed with the contents to be
1738 signed, and the program is expected to send the result to its
1739 standard output.
1741 gui.commitMsgWidth::
1742 Defines how wide the commit message window is in the
1743 linkgit:git-gui[1]. "75" is the default.
1745 gui.diffContext::
1746 Specifies how many context lines should be used in calls to diff
1747 made by the linkgit:git-gui[1]. The default is "5".
1749 gui.displayUntracked::
1750 Determines if linkgit:git-gui[1] shows untracked files
1751 in the file list. The default is "true".
1753 gui.encoding::
1754 Specifies the default encoding to use for displaying of
1755 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1756 It can be overridden by setting the 'encoding' attribute
1757 for relevant files (see linkgit:gitattributes[5]).
1758 If this option is not set, the tools default to the
1759 locale encoding.
1761 gui.matchTrackingBranch::
1762 Determines if new branches created with linkgit:git-gui[1] should
1763 default to tracking remote branches with matching names or
1764 not. Default: "false".
1766 gui.newBranchTemplate::
1767 Is used as suggested name when creating new branches using the
1768 linkgit:git-gui[1].
1770 gui.pruneDuringFetch::
1771 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1772 performing a fetch. The default value is "false".
1774 gui.trustmtime::
1775 Determines if linkgit:git-gui[1] should trust the file modification
1776 timestamp or not. By default the timestamps are not trusted.
1778 gui.spellingDictionary::
1779 Specifies the dictionary used for spell checking commit messages in
1780 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1781 off.
1783 gui.fastCopyBlame::
1784 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1785 location detection. It makes blame significantly faster on huge
1786 repositories at the expense of less thorough copy detection.
1788 gui.copyBlameThreshold::
1789 Specifies the threshold to use in 'git gui blame' original location
1790 detection, measured in alphanumeric characters. See the
1791 linkgit:git-blame[1] manual for more information on copy detection.
1793 gui.blamehistoryctx::
1794 Specifies the radius of history context in days to show in
1795 linkgit:gitk[1] for the selected commit, when the `Show History
1796 Context` menu item is invoked from 'git gui blame'. If this
1797 variable is set to zero, the whole history is shown.
1799 guitool.<name>.cmd::
1800 Specifies the shell command line to execute when the corresponding item
1801 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1802 mandatory for every tool. The command is executed from the root of
1803 the working directory, and in the environment it receives the name of
1804 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1805 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1806 the head is detached, 'CUR_BRANCH' is empty).
1808 guitool.<name>.needsFile::
1809 Run the tool only if a diff is selected in the GUI. It guarantees
1810 that 'FILENAME' is not empty.
1812 guitool.<name>.noConsole::
1813 Run the command silently, without creating a window to display its
1814 output.
1816 guitool.<name>.noRescan::
1817 Don't rescan the working directory for changes after the tool
1818 finishes execution.
1820 guitool.<name>.confirm::
1821 Show a confirmation dialog before actually running the tool.
1823 guitool.<name>.argPrompt::
1824 Request a string argument from the user, and pass it to the tool
1825 through the `ARGS` environment variable. Since requesting an
1826 argument implies confirmation, the 'confirm' option has no effect
1827 if this is enabled. If the option is set to 'true', 'yes', or '1',
1828 the dialog uses a built-in generic prompt; otherwise the exact
1829 value of the variable is used.
1831 guitool.<name>.revPrompt::
1832 Request a single valid revision from the user, and set the
1833 `REVISION` environment variable. In other aspects this option
1834 is similar to 'argPrompt', and can be used together with it.
1836 guitool.<name>.revUnmerged::
1837 Show only unmerged branches in the 'revPrompt' subdialog.
1838 This is useful for tools similar to merge or rebase, but not
1839 for things like checkout or reset.
1841 guitool.<name>.title::
1842 Specifies the title to use for the prompt dialog. The default
1843 is the tool name.
1845 guitool.<name>.prompt::
1846 Specifies the general prompt string to display at the top of
1847 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1848 The default value includes the actual command.
1850 help.browser::
1851 Specify the browser that will be used to display help in the
1852 'web' format. See linkgit:git-help[1].
1854 help.format::
1855 Override the default help format used by linkgit:git-help[1].
1856 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1857 the default. 'web' and 'html' are the same.
1859 help.autoCorrect::
1860 Automatically correct and execute mistyped commands after
1861 waiting for the given number of deciseconds (0.1 sec). If more
1862 than one command can be deduced from the entered text, nothing
1863 will be executed. If the value of this option is negative,
1864 the corrected command will be executed immediately. If the
1865 value is 0 - the command will be just shown but not executed.
1866 This is the default.
1868 help.htmlPath::
1869 Specify the path where the HTML documentation resides. File system paths
1870 and URLs are supported. HTML pages will be prefixed with this path when
1871 help is displayed in the 'web' format. This defaults to the documentation
1872 path of your Git installation.
1874 http.proxy::
1875 Override the HTTP proxy, normally configured using the 'http_proxy',
1876 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1877 addition to the syntax understood by curl, it is possible to specify a
1878 proxy string with a user name but no password, in which case git will
1879 attempt to acquire one in the same way it does for other credentials. See
1880 linkgit:gitcredentials[7] for more information. The syntax thus is
1881 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1882 on a per-remote basis; see remote.<name>.proxy
1884 http.proxyAuthMethod::
1885 Set the method with which to authenticate against the HTTP proxy. This
1886 only takes effect if the configured proxy string contains a user name part
1887 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1888 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1889 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1890 variable. Possible values are:
1891 +
1892 --
1893 * `anyauth` - Automatically pick a suitable authentication method. It is
1894 assumed that the proxy answers an unauthenticated request with a 407
1895 status code and one or more Proxy-authenticate headers with supported
1896 authentication methods. This is the default.
1897 * `basic` - HTTP Basic authentication
1898 * `digest` - HTTP Digest authentication; this prevents the password from being
1899 transmitted to the proxy in clear text
1900 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1901 of `curl(1)`)
1902 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1903 --
1905 http.emptyAuth::
1906 Attempt authentication without seeking a username or password. This
1907 can be used to attempt GSS-Negotiate authentication without specifying
1908 a username in the URL, as libcurl normally requires a username for
1909 authentication.
1911 http.delegation::
1912 Control GSSAPI credential delegation. The delegation is disabled
1913 by default in libcurl since version 7.21.7. Set parameter to tell
1914 the server what it is allowed to delegate when it comes to user
1915 credentials. Used with GSS/kerberos. Possible values are:
1916 +
1917 --
1918 * `none` - Don't allow any delegation.
1919 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1920 Kerberos service ticket, which is a matter of realm policy.
1921 * `always` - Unconditionally allow the server to delegate.
1922 --
1925 http.extraHeader::
1926 Pass an additional HTTP header when communicating with a server. If
1927 more than one such entry exists, all of them are added as extra
1928 headers. To allow overriding the settings inherited from the system
1929 config, an empty value will reset the extra headers to the empty list.
1931 http.cookieFile::
1932 The pathname of a file containing previously stored cookie lines,
1933 which should be used
1934 in the Git http session, if they match the server. The file format
1935 of the file to read cookies from should be plain HTTP headers or
1936 the Netscape/Mozilla cookie file format (see `curl(1)`).
1937 NOTE that the file specified with http.cookieFile is used only as
1938 input unless http.saveCookies is set.
1940 http.saveCookies::
1941 If set, store cookies received during requests to the file specified by
1942 http.cookieFile. Has no effect if http.cookieFile is unset.
1944 http.sslVersion::
1945 The SSL version to use when negotiating an SSL connection, if you
1946 want to force the default. The available and default version
1947 depend on whether libcurl was built against NSS or OpenSSL and the
1948 particular configuration of the crypto library in use. Internally
1949 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1950 documentation for more details on the format of this option and
1951 for the ssl version supported. Actually the possible values of
1952 this option are:
1954 - sslv2
1955 - sslv3
1956 - tlsv1
1957 - tlsv1.0
1958 - tlsv1.1
1959 - tlsv1.2
1961 +
1962 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1963 To force git to use libcurl's default ssl version and ignore any
1964 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1965 empty string.
1967 http.sslCipherList::
1968 A list of SSL ciphers to use when negotiating an SSL connection.
1969 The available ciphers depend on whether libcurl was built against
1970 NSS or OpenSSL and the particular configuration of the crypto
1971 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1972 option; see the libcurl documentation for more details on the format
1973 of this list.
1974 +
1975 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1976 To force git to use libcurl's default cipher list and ignore any
1977 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1978 empty string.
1980 http.sslVerify::
1981 Whether to verify the SSL certificate when fetching or pushing
1982 over HTTPS. Defaults to true. Can be overridden by the
1983 `GIT_SSL_NO_VERIFY` environment variable.
1985 http.sslCert::
1986 File containing the SSL certificate when fetching or pushing
1987 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1988 variable.
1990 http.sslKey::
1991 File containing the SSL private key when fetching or pushing
1992 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1993 variable.
1995 http.sslCertPasswordProtected::
1996 Enable Git's password prompt for the SSL certificate. Otherwise
1997 OpenSSL will prompt the user, possibly many times, if the
1998 certificate or private key is encrypted. Can be overridden by the
1999 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2001 http.sslCAInfo::
2002 File containing the certificates to verify the peer with when
2003 fetching or pushing over HTTPS. Can be overridden by the
2004 `GIT_SSL_CAINFO` environment variable.
2006 http.sslCAPath::
2007 Path containing files with the CA certificates to verify the peer
2008 with when fetching or pushing over HTTPS. Can be overridden
2009 by the `GIT_SSL_CAPATH` environment variable.
2011 http.pinnedpubkey::
2012 Public key of the https service. It may either be the filename of
2013 a PEM or DER encoded public key file or a string starting with
2014 'sha256//' followed by the base64 encoded sha256 hash of the
2015 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2016 exit with an error if this option is set but not supported by
2017 cURL.
2019 http.sslTry::
2020 Attempt to use AUTH SSL/TLS and encrypted data transfers
2021 when connecting via regular FTP protocol. This might be needed
2022 if the FTP server requires it for security reasons or you wish
2023 to connect securely whenever remote FTP server supports it.
2024 Default is false since it might trigger certificate verification
2025 errors on misconfigured servers.
2027 http.maxRequests::
2028 How many HTTP requests to launch in parallel. Can be overridden
2029 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2031 http.minSessions::
2032 The number of curl sessions (counted across slots) to be kept across
2033 requests. They will not be ended with curl_easy_cleanup() until
2034 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2035 value will be capped at 1. Defaults to 1.
2037 http.postBuffer::
2038 Maximum size in bytes of the buffer used by smart HTTP
2039 transports when POSTing data to the remote system.
2040 For requests larger than this buffer size, HTTP/1.1 and
2041 Transfer-Encoding: chunked is used to avoid creating a
2042 massive pack file locally. Default is 1 MiB, which is
2043 sufficient for most requests.
2045 http.lowSpeedLimit, http.lowSpeedTime::
2046 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2047 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2048 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2049 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2051 http.noEPSV::
2052 A boolean which disables using of EPSV ftp command by curl.
2053 This can helpful with some "poor" ftp servers which don't
2054 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2055 environment variable. Default is false (curl will use EPSV).
2057 http.userAgent::
2058 The HTTP USER_AGENT string presented to an HTTP server. The default
2059 value represents the version of the client Git such as git/1.7.1.
2060 This option allows you to override this value to a more common value
2061 such as Mozilla/4.0. This may be necessary, for instance, if
2062 connecting through a firewall that restricts HTTP connections to a set
2063 of common USER_AGENT strings (but not including those like git/1.7.1).
2064 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2066 http.followRedirects::
2067 Whether git should follow HTTP redirects. If set to `true`, git
2068 will transparently follow any redirect issued by a server it
2069 encounters. If set to `false`, git will treat all redirects as
2070 errors. If set to `initial`, git will follow redirects only for
2071 the initial request to a remote, but not for subsequent
2072 follow-up HTTP requests. Since git uses the redirected URL as
2073 the base for the follow-up requests, this is generally
2074 sufficient. The default is `initial`.
2076 http.<url>.*::
2077 Any of the http.* options above can be applied selectively to some URLs.
2078 For a config key to match a URL, each element of the config key is
2079 compared to that of the URL, in the following order:
2080 +
2081 --
2082 . Scheme (e.g., `https` in `https://example.com/`). This field
2083 must match exactly between the config key and the URL.
2085 . Host/domain name (e.g., `example.com` in `https://example.com/`).
2086 This field must match between the config key and the URL. It is
2087 possible to specify a `*` as part of the host name to match all subdomains
2088 at this level. `https://*.example.com/` for example would match
2089 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2091 . Port number (e.g., `8080` in `http://example.com:8080/`).
2092 This field must match exactly between the config key and the URL.
2093 Omitted port numbers are automatically converted to the correct
2094 default for the scheme before matching.
2096 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2097 path field of the config key must match the path field of the URL
2098 either exactly or as a prefix of slash-delimited path elements. This means
2099 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2100 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2101 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2102 key with just path `foo/`).
2104 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
2105 the config key has a user name it must match the user name in the
2106 URL exactly. If the config key does not have a user name, that
2107 config key will match a URL with any user name (including none),
2108 but at a lower precedence than a config key with a user name.
2109 --
2110 +
2111 The list above is ordered by decreasing precedence; a URL that matches
2112 a config key's path is preferred to one that matches its user name. For example,
2113 if the URL is `https://user@example.com/foo/bar` a config key match of
2114 `https://example.com/foo` will be preferred over a config key match of
2115 `https://user@example.com`.
2116 +
2117 All URLs are normalized before attempting any matching (the password part,
2118 if embedded in the URL, is always ignored for matching purposes) so that
2119 equivalent URLs that are simply spelled differently will match properly.
2120 Environment variable settings always override any matches. The URLs that are
2121 matched against are those given directly to Git commands. This means any URLs
2122 visited as a result of a redirection do not participate in matching.
2124 ssh.variant::
2125 By default, Git determines the command line arguments to use
2126 based on the basename of the configured SSH command (configured
2127 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2128 the config setting `core.sshCommand`). If the basename is
2129 unrecognized, Git will attempt to detect support of OpenSSH
2130 options by first invoking the configured SSH command with the
2131 `-G` (print configuration) option and will subsequently use
2132 OpenSSH options (if that is successful) or no options besides
2133 the host and remote command (if it fails).
2134 +
2135 The config variable `ssh.variant` can be set to override this detection.
2136 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2137 `tortoiseplink`, `simple` (no options except the host and remote command).
2138 The default auto-detection can be explicitly requested using the value
2139 `auto`. Any other value is treated as `ssh`. This setting can also be
2140 overridden via the environment variable `GIT_SSH_VARIANT`.
2141 +
2142 The current command-line parameters used for each variant are as
2143 follows:
2144 +
2145 --
2147 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2149 * `simple` - [username@]host command
2151 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2153 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2155 --
2156 +
2157 Except for the `simple` variant, command-line parameters are likely to
2158 change as git gains new features.
2160 i18n.commitEncoding::
2161 Character encoding the commit messages are stored in; Git itself
2162 does not care per se, but this information is necessary e.g. when
2163 importing commits from emails or in the gitk graphical history
2164 browser (and possibly at other places in the future or in other
2165 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2167 i18n.logOutputEncoding::
2168 Character encoding the commit messages are converted to when
2169 running 'git log' and friends.
2171 imap::
2172 The configuration variables in the 'imap' section are described
2173 in linkgit:git-imap-send[1].
2175 index.version::
2176 Specify the version with which new index files should be
2177 initialized. This does not affect existing repositories.
2179 init.templateDir::
2180 Specify the directory from which templates will be copied.
2181 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2183 instaweb.browser::
2184 Specify the program that will be used to browse your working
2185 repository in gitweb. See linkgit:git-instaweb[1].
2187 instaweb.httpd::
2188 The HTTP daemon command-line to start gitweb on your working
2189 repository. See linkgit:git-instaweb[1].
2191 instaweb.local::
2192 If true the web server started by linkgit:git-instaweb[1] will
2193 be bound to the local IP (
2195 instaweb.modulePath::
2196 The default module path for linkgit:git-instaweb[1] to use
2197 instead of /usr/lib/apache2/modules. Only used if httpd
2198 is Apache.
2200 instaweb.port::
2201 The port number to bind the gitweb httpd to. See
2202 linkgit:git-instaweb[1].
2204 interactive.singleKey::
2205 In interactive commands, allow the user to provide one-letter
2206 input with a single key (i.e., without hitting enter).
2207 Currently this is used by the `--patch` mode of
2208 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2209 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2210 setting is silently ignored if portable keystroke input
2211 is not available; requires the Perl module Term::ReadKey.
2213 interactive.diffFilter::
2214 When an interactive command (such as `git add --patch`) shows
2215 a colorized diff, git will pipe the diff through the shell
2216 command defined by this configuration variable. The command may
2217 mark up the diff further for human consumption, provided that it
2218 retains a one-to-one correspondence with the lines in the
2219 original diff. Defaults to disabled (no filtering).
2221 log.abbrevCommit::
2222 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2223 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2224 override this option with `--no-abbrev-commit`.
2226 log.date::
2227 Set the default date-time mode for the 'log' command.
2228 Setting a value for log.date is similar to using 'git log''s
2229 `--date` option. See linkgit:git-log[1] for details.
2231 log.decorate::
2232 Print out the ref names of any commits that are shown by the log
2233 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2234 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2235 specified, the full ref name (including prefix) will be printed.
2236 If 'auto' is specified, then if the output is going to a terminal,
2237 the ref names are shown as if 'short' were given, otherwise no ref
2238 names are shown. This is the same as the `--decorate` option
2239 of the `git log`.
2241 log.follow::
2242 If `true`, `git log` will act as if the `--follow` option was used when
2243 a single <path> is given. This has the same limitations as `--follow`,
2244 i.e. it cannot be used to follow multiple files and does not work well
2245 on non-linear history.
2247 log.graphColors::
2248 A list of colors, separated by commas, that can be used to draw
2249 history lines in `git log --graph`.
2251 log.showRoot::
2252 If true, the initial commit will be shown as a big creation event.
2253 This is equivalent to a diff against an empty tree.
2254 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2255 normally hide the root commit will now show it. True by default.
2257 log.showSignature::
2258 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2259 linkgit:git-whatchanged[1] assume `--show-signature`.
2261 log.mailmap::
2262 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2263 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2265 mailinfo.scissors::
2266 If true, makes linkgit:git-mailinfo[1] (and therefore
2267 linkgit:git-am[1]) act by default as if the --scissors option
2268 was provided on the command-line. When active, this features
2269 removes everything from the message body before a scissors
2270 line (i.e. consisting mainly of ">8", "8<" and "-").
2272 mailmap.file::
2273 The location of an augmenting mailmap file. The default
2274 mailmap, located in the root of the repository, is loaded
2275 first, then the mailmap file pointed to by this variable.
2276 The location of the mailmap file may be in a repository
2277 subdirectory, or somewhere outside of the repository itself.
2278 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2280 mailmap.blob::
2281 Like `mailmap.file`, but consider the value as a reference to a
2282 blob in the repository. If both `mailmap.file` and
2283 `mailmap.blob` are given, both are parsed, with entries from
2284 `mailmap.file` taking precedence. In a bare repository, this
2285 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2286 defaults to empty.
2288 man.viewer::
2289 Specify the programs that may be used to display help in the
2290 'man' format. See linkgit:git-help[1].
2292 man.<tool>.cmd::
2293 Specify the command to invoke the specified man viewer. The
2294 specified command is evaluated in shell with the man page
2295 passed as argument. (See linkgit:git-help[1].)
2297 man.<tool>.path::
2298 Override the path for the given tool that may be used to
2299 display help in the 'man' format. See linkgit:git-help[1].
2301 include::merge-config.txt[]
2303 mergetool.<tool>.path::
2304 Override the path for the given tool. This is useful in case
2305 your tool is not in the PATH.
2307 mergetool.<tool>.cmd::
2308 Specify the command to invoke the specified merge tool. The
2309 specified command is evaluated in shell with the following
2310 variables available: 'BASE' is the name of a temporary file
2311 containing the common base of the files to be merged, if available;
2312 'LOCAL' is the name of a temporary file containing the contents of
2313 the file on the current branch; 'REMOTE' is the name of a temporary
2314 file containing the contents of the file from the branch being
2315 merged; 'MERGED' contains the name of the file to which the merge
2316 tool should write the results of a successful merge.
2318 mergetool.<tool>.trustExitCode::
2319 For a custom merge command, specify whether the exit code of
2320 the merge command can be used to determine whether the merge was
2321 successful. If this is not set to true then the merge target file
2322 timestamp is checked and the merge assumed to have been successful
2323 if the file has been updated, otherwise the user is prompted to
2324 indicate the success of the merge.
2326 mergetool.meld.hasOutput::
2327 Older versions of `meld` do not support the `--output` option.
2328 Git will attempt to detect whether `meld` supports `--output`
2329 by inspecting the output of `meld --help`. Configuring
2330 `mergetool.meld.hasOutput` will make Git skip these checks and
2331 use the configured value instead. Setting `mergetool.meld.hasOutput`
2332 to `true` tells Git to unconditionally use the `--output` option,
2333 and `false` avoids using `--output`.
2335 mergetool.keepBackup::
2336 After performing a merge, the original file with conflict markers
2337 can be saved as a file with a `.orig` extension. If this variable
2338 is set to `false` then this file is not preserved. Defaults to
2339 `true` (i.e. keep the backup files).
2341 mergetool.keepTemporaries::
2342 When invoking a custom merge tool, Git uses a set of temporary
2343 files to pass to the tool. If the tool returns an error and this
2344 variable is set to `true`, then these temporary files will be
2345 preserved, otherwise they will be removed after the tool has
2346 exited. Defaults to `false`.
2348 mergetool.writeToTemp::
2349 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2350 conflicting files in the worktree by default. Git will attempt
2351 to use a temporary directory for these files when set `true`.
2352 Defaults to `false`.
2354 mergetool.prompt::
2355 Prompt before each invocation of the merge resolution program.
2357 notes.mergeStrategy::
2358 Which merge strategy to choose by default when resolving notes
2359 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2360 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2361 section of linkgit:git-notes[1] for more information on each strategy.
2363 notes.<name>.mergeStrategy::
2364 Which merge strategy to choose when doing a notes merge into
2365 refs/notes/<name>. This overrides the more general
2366 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2367 linkgit:git-notes[1] for more information on the available strategies.
2369 notes.displayRef::
2370 The (fully qualified) refname from which to show notes when
2371 showing commit messages. The value of this variable can be set
2372 to a glob, in which case notes from all matching refs will be
2373 shown. You may also specify this configuration variable
2374 several times. A warning will be issued for refs that do not
2375 exist, but a glob that does not match any refs is silently
2376 ignored.
2377 +
2378 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2379 environment variable, which must be a colon separated list of refs or
2380 globs.
2381 +
2382 The effective value of "core.notesRef" (possibly overridden by
2383 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2384 displayed.
2386 notes.rewrite.<command>::
2387 When rewriting commits with <command> (currently `amend` or
2388 `rebase`) and this variable is set to `true`, Git
2389 automatically copies your notes from the original to the
2390 rewritten commit. Defaults to `true`, but see
2391 "notes.rewriteRef" below.
2393 notes.rewriteMode::
2394 When copying notes during a rewrite (see the
2395 "notes.rewrite.<command>" option), determines what to do if
2396 the target commit already has a note. Must be one of
2397 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2398 Defaults to `concatenate`.
2399 +
2400 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2401 environment variable.
2403 notes.rewriteRef::
2404 When copying notes during a rewrite, specifies the (fully
2405 qualified) ref whose notes should be copied. The ref may be a
2406 glob, in which case notes in all matching refs will be copied.
2407 You may also specify this configuration several times.
2408 +
2409 Does not have a default value; you must configure this variable to
2410 enable note rewriting. Set it to `refs/notes/commits` to enable
2411 rewriting for the default commit notes.
2412 +
2413 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2414 environment variable, which must be a colon separated list of refs or
2415 globs.
2417 pack.window::
2418 The size of the window used by linkgit:git-pack-objects[1] when no
2419 window size is given on the command line. Defaults to 10.
2421 pack.depth::
2422 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2423 maximum depth is given on the command line. Defaults to 50.
2425 pack.windowMemory::
2426 The maximum size of memory that is consumed by each thread
2427 in linkgit:git-pack-objects[1] for pack window memory when
2428 no limit is given on the command line. The value can be
2429 suffixed with "k", "m", or "g". When left unconfigured (or
2430 set explicitly to 0), there will be no limit.
2432 pack.compression::
2433 An integer -1..9, indicating the compression level for objects
2434 in a pack file. -1 is the zlib default. 0 means no
2435 compression, and 1..9 are various speed/size tradeoffs, 9 being
2436 slowest. If not set, defaults to core.compression. If that is
2437 not set, defaults to -1, the zlib default, which is "a default
2438 compromise between speed and compression (currently equivalent
2439 to level 6)."
2440 +
2441 Note that changing the compression level will not automatically recompress
2442 all existing objects. You can force recompression by passing the -F option
2443 to linkgit:git-repack[1].
2445 pack.deltaCacheSize::
2446 The maximum memory in bytes used for caching deltas in
2447 linkgit:git-pack-objects[1] before writing them out to a pack.
2448 This cache is used to speed up the writing object phase by not
2449 having to recompute the final delta result once the best match
2450 for all objects is found. Repacking large repositories on machines
2451 which are tight with memory might be badly impacted by this though,
2452 especially if this cache pushes the system into swapping.
2453 A value of 0 means no limit. The smallest size of 1 byte may be
2454 used to virtually disable this cache. Defaults to 256 MiB.
2456 pack.deltaCacheLimit::
2457 The maximum size of a delta, that is cached in
2458 linkgit:git-pack-objects[1]. This cache is used to speed up the
2459 writing object phase by not having to recompute the final delta
2460 result once the best match for all objects is found. Defaults to 1000.
2462 pack.threads::
2463 Specifies the number of threads to spawn when searching for best
2464 delta matches. This requires that linkgit:git-pack-objects[1]
2465 be compiled with pthreads otherwise this option is ignored with a
2466 warning. This is meant to reduce packing time on multiprocessor
2467 machines. The required amount of memory for the delta search window
2468 is however multiplied by the number of threads.
2469 Specifying 0 will cause Git to auto-detect the number of CPU's
2470 and set the number of threads accordingly.
2472 pack.indexVersion::
2473 Specify the default pack index version. Valid values are 1 for
2474 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2475 the new pack index with capabilities for packs larger than 4 GB
2476 as well as proper protection against the repacking of corrupted
2477 packs. Version 2 is the default. Note that version 2 is enforced
2478 and this config option ignored whenever the corresponding pack is
2479 larger than 2 GB.
2480 +
2481 If you have an old Git that does not understand the version 2 `*.idx` file,
2482 cloning or fetching over a non native protocol (e.g. "http")
2483 that will copy both `*.pack` file and corresponding `*.idx` file from the
2484 other side may give you a repository that cannot be accessed with your
2485 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2486 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2487 the `*.idx` file.
2489 pack.packSizeLimit::
2490 The maximum size of a pack. This setting only affects
2491 packing to a file when repacking, i.e. the git:// protocol
2492 is unaffected. It can be overridden by the `--max-pack-size`
2493 option of linkgit:git-repack[1]. Reaching this limit results
2494 in the creation of multiple packfiles; which in turn prevents
2495 bitmaps from being created.
2496 The minimum size allowed is limited to 1 MiB.
2497 The default is unlimited.
2498 Common unit suffixes of 'k', 'm', or 'g' are
2499 supported.
2501 pack.useBitmaps::
2502 When true, git will use pack bitmaps (if available) when packing
2503 to stdout (e.g., during the server side of a fetch). Defaults to
2504 true. You should not generally need to turn this off unless
2505 you are debugging pack bitmaps.
2507 pack.writeBitmaps (deprecated)::
2508 This is a deprecated synonym for `repack.writeBitmaps`.
2510 pack.writeBitmapHashCache::
2511 When true, git will include a "hash cache" section in the bitmap
2512 index (if one is written). This cache can be used to feed git's
2513 delta heuristics, potentially leading to better deltas between
2514 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2515 between an older, bitmapped pack and objects that have been
2516 pushed since the last gc). The downside is that it consumes 4
2517 bytes per object of disk space, and that JGit's bitmap
2518 implementation does not understand it, causing it to complain if
2519 Git and JGit are used on the same repository. Defaults to false.
2521 pager.<cmd>::
2522 If the value is boolean, turns on or off pagination of the
2523 output of a particular Git subcommand when writing to a tty.
2524 Otherwise, turns on pagination for the subcommand using the
2525 pager specified by the value of `pager.<cmd>`. If `--paginate`
2526 or `--no-pager` is specified on the command line, it takes
2527 precedence over this option. To disable pagination for all
2528 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2530 pretty.<name>::
2531 Alias for a --pretty= format string, as specified in
2532 linkgit:git-log[1]. Any aliases defined here can be used just
2533 as the built-in pretty formats could. For example,
2534 running `git config pretty.changelog "format:* %H %s"`
2535 would cause the invocation `git log --pretty=changelog`
2536 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2537 Note that an alias with the same name as a built-in format
2538 will be silently ignored.
2540 protocol.allow::
2541 If set, provide a user defined default policy for all protocols which
2542 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2543 if unset, known-safe protocols (http, https, git, ssh, file) have a
2544 default policy of `always`, known-dangerous protocols (ext) have a
2545 default policy of `never`, and all other protocols have a default
2546 policy of `user`. Supported policies:
2547 +
2548 --
2550 * `always` - protocol is always able to be used.
2552 * `never` - protocol is never able to be used.
2554 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2555 either unset or has a value of 1. This policy should be used when you want a
2556 protocol to be directly usable by the user but don't want it used by commands which
2557 execute clone/fetch/push commands without user input, e.g. recursive
2558 submodule initialization.
2560 --
2562 protocol.<name>.allow::
2563 Set a policy to be used by protocol `<name>` with clone/fetch/push
2564 commands. See `protocol.allow` above for the available policies.
2565 +
2566 The protocol names currently used by git are:
2567 +
2568 --
2569 - `file`: any local file-based path (including `file://` URLs,
2570 or local paths)
2572 - `git`: the anonymous git protocol over a direct TCP
2573 connection (or proxy, if configured)
2575 - `ssh`: git over ssh (including `host:path` syntax,
2576 `ssh://`, etc).
2578 - `http`: git over http, both "smart http" and "dumb http".
2579 Note that this does _not_ include `https`; if you want to configure
2580 both, you must do so individually.
2582 - any external helpers are named by their protocol (e.g., use
2583 `hg` to allow the `git-remote-hg` helper)
2584 --
2586 protocol.version::
2587 Experimental. If set, clients will attempt to communicate with a
2588 server using the specified protocol version. If unset, no
2589 attempt will be made by the client to communicate using a
2590 particular protocol version, this results in protocol version 0
2591 being used.
2592 Supported versions:
2593 +
2594 --
2596 * `0` - the original wire protocol.
2598 * `1` - the original wire protocol with the addition of a version string
2599 in the initial response from the server.
2601 --
2603 pull.ff::
2604 By default, Git does not create an extra merge commit when merging
2605 a commit that is a descendant of the current commit. Instead, the
2606 tip of the current branch is fast-forwarded. When set to `false`,
2607 this variable tells Git to create an extra merge commit in such
2608 a case (equivalent to giving the `--no-ff` option from the command
2609 line). When set to `only`, only such fast-forward merges are
2610 allowed (equivalent to giving the `--ff-only` option from the
2611 command line). This setting overrides `merge.ff` when pulling.
2613 pull.rebase::
2614 When true, rebase branches on top of the fetched branch, instead
2615 of merging the default branch from the default remote when "git
2616 pull" is run. See "branch.<name>.rebase" for setting this on a
2617 per-branch basis.
2618 +
2619 When preserve, also pass `--preserve-merges` along to 'git rebase'
2620 so that locally committed merge commits will not be flattened
2621 by running 'git pull'.
2622 +
2623 When the value is `interactive`, the rebase is run in interactive mode.
2624 +
2625 *NOTE*: this is a possibly dangerous operation; do *not* use
2626 it unless you understand the implications (see linkgit:git-rebase[1]
2627 for details).
2629 pull.octopus::
2630 The default merge strategy to use when pulling multiple branches
2631 at once.
2633 pull.twohead::
2634 The default merge strategy to use when pulling a single branch.
2636 push.default::
2637 Defines the action `git push` should take if no refspec is
2638 explicitly given. Different values are well-suited for
2639 specific workflows; for instance, in a purely central workflow
2640 (i.e. the fetch source is equal to the push destination),
2641 `upstream` is probably what you want. Possible values are:
2642 +
2643 --
2645 * `nothing` - do not push anything (error out) unless a refspec is
2646 explicitly given. This is primarily meant for people who want to
2647 avoid mistakes by always being explicit.
2649 * `current` - push the current branch to update a branch with the same
2650 name on the receiving end. Works in both central and non-central
2651 workflows.
2653 * `upstream` - push the current branch back to the branch whose
2654 changes are usually integrated into the current branch (which is
2655 called `@{upstream}`). This mode only makes sense if you are
2656 pushing to the same repository you would normally pull from
2657 (i.e. central workflow).
2659 * `tracking` - This is a deprecated synonym for `upstream`.
2661 * `simple` - in centralized workflow, work like `upstream` with an
2662 added safety to refuse to push if the upstream branch's name is
2663 different from the local one.
2664 +
2665 When pushing to a remote that is different from the remote you normally
2666 pull from, work as `current`. This is the safest option and is suited
2667 for beginners.
2668 +
2669 This mode has become the default in Git 2.0.
2671 * `matching` - push all branches having the same name on both ends.
2672 This makes the repository you are pushing to remember the set of
2673 branches that will be pushed out (e.g. if you always push 'maint'
2674 and 'master' there and no other branches, the repository you push
2675 to will have these two branches, and your local 'maint' and
2676 'master' will be pushed there).
2677 +
2678 To use this mode effectively, you have to make sure _all_ the
2679 branches you would push out are ready to be pushed out before
2680 running 'git push', as the whole point of this mode is to allow you
2681 to push all of the branches in one go. If you usually finish work
2682 on only one branch and push out the result, while other branches are
2683 unfinished, this mode is not for you. Also this mode is not
2684 suitable for pushing into a shared central repository, as other
2685 people may add new branches there, or update the tip of existing
2686 branches outside your control.
2687 +
2688 This used to be the default, but not since Git 2.0 (`simple` is the
2689 new default).
2691 --
2693 push.followTags::
2694 If set to true enable `--follow-tags` option by default. You
2695 may override this configuration at time of push by specifying
2696 `--no-follow-tags`.
2698 push.gpgSign::
2699 May be set to a boolean value, or the string 'if-asked'. A true
2700 value causes all pushes to be GPG signed, as if `--signed` is
2701 passed to linkgit:git-push[1]. The string 'if-asked' causes
2702 pushes to be signed if the server supports it, as if
2703 `--signed=if-asked` is passed to 'git push'. A false value may
2704 override a value from a lower-priority config file. An explicit
2705 command-line flag always overrides this config option.
2707 push.pushOption::
2708 When no `--push-option=<option>` argument is given from the
2709 command line, `git push` behaves as if each <value> of
2710 this variable is given as `--push-option=<value>`.
2711 +
2712 This is a multi-valued variable, and an empty value can be used in a
2713 higher priority configuration file (e.g. `.git/config` in a
2714 repository) to clear the values inherited from a lower priority
2715 configuration files (e.g. `$HOME/.gitconfig`).
2716 +
2717 --
2719 Example:
2721 /etc/gitconfig
2722 push.pushoption = a
2723 push.pushoption = b
2725 ~/.gitconfig
2726 push.pushoption = c
2728 repo/.git/config
2729 push.pushoption =
2730 push.pushoption = b
2732 This will result in only b (a and c are cleared).
2734 --
2736 push.recurseSubmodules::
2737 Make sure all submodule commits used by the revisions to be pushed
2738 are available on a remote-tracking branch. If the value is 'check'
2739 then Git will verify that all submodule commits that changed in the
2740 revisions to be pushed are available on at least one remote of the
2741 submodule. If any commits are missing, the push will be aborted and
2742 exit with non-zero status. If the value is 'on-demand' then all
2743 submodules that changed in the revisions to be pushed will be
2744 pushed. If on-demand was not able to push all necessary revisions
2745 it will also be aborted and exit with non-zero status. If the value
2746 is 'no' then default behavior of ignoring submodules when pushing
2747 is retained. You may override this configuration at time of push by
2748 specifying '--recurse-submodules=check|on-demand|no'.
2750 include::rebase-config.txt[]
2752 receive.advertiseAtomic::
2753 By default, git-receive-pack will advertise the atomic push
2754 capability to its clients. If you don't want to advertise this
2755 capability, set this variable to false.
2757 receive.advertisePushOptions::
2758 When set to true, git-receive-pack will advertise the push options
2759 capability to its clients. False by default.
2761 receive.autogc::
2762 By default, git-receive-pack will run "git-gc --auto" after
2763 receiving data from git-push and updating refs. You can stop
2764 it by setting this variable to false.
2766 receive.certNonceSeed::
2767 By setting this variable to a string, `git receive-pack`
2768 will accept a `git push --signed` and verifies it by using
2769 a "nonce" protected by HMAC using this string as a secret
2770 key.
2772 receive.certNonceSlop::
2773 When a `git push --signed` sent a push certificate with a
2774 "nonce" that was issued by a receive-pack serving the same
2775 repository within this many seconds, export the "nonce"
2776 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2777 hooks (instead of what the receive-pack asked the sending
2778 side to include). This may allow writing checks in
2779 `pre-receive` and `post-receive` a bit easier. Instead of
2780 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2781 that records by how many seconds the nonce is stale to
2782 decide if they want to accept the certificate, they only
2783 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2785 receive.fsckObjects::
2786 If it is set to true, git-receive-pack will check all received
2787 objects. It will abort in the case of a malformed object or a
2788 broken link. The result of an abort are only dangling objects.
2789 Defaults to false. If not set, the value of `transfer.fsckObjects`
2790 is used instead.
2792 receive.fsck.<msg-id>::
2793 When `receive.fsckObjects` is set to true, errors can be switched
2794 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2795 setting where the `<msg-id>` is the fsck message ID and the value
2796 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2797 the error/warning with the message ID, e.g. "missingEmail: invalid
2798 author/committer line - missing email" means that setting
2799 `receive.fsck.missingEmail = ignore` will hide that issue.
2800 +
2801 This feature is intended to support working with legacy repositories
2802 which would not pass pushing when `receive.fsckObjects = true`, allowing
2803 the host to accept repositories with certain known issues but still catch
2804 other issues.
2806 receive.fsck.skipList::
2807 The path to a sorted list of object names (i.e. one SHA-1 per
2808 line) that are known to be broken in a non-fatal way and should
2809 be ignored. This feature is useful when an established project
2810 should be accepted despite early commits containing errors that
2811 can be safely ignored such as invalid committer email addresses.
2812 Note: corrupt objects cannot be skipped with this setting.
2814 receive.keepAlive::
2815 After receiving the pack from the client, `receive-pack` may
2816 produce no output (if `--quiet` was specified) while processing
2817 the pack, causing some networks to drop the TCP connection.
2818 With this option set, if `receive-pack` does not transmit
2819 any data in this phase for `receive.keepAlive` seconds, it will
2820 send a short keepalive packet. The default is 5 seconds; set
2821 to 0 to disable keepalives entirely.
2823 receive.unpackLimit::
2824 If the number of objects received in a push is below this
2825 limit then the objects will be unpacked into loose object
2826 files. However if the number of received objects equals or
2827 exceeds this limit then the received pack will be stored as
2828 a pack, after adding any missing delta bases. Storing the
2829 pack from a push can make the push operation complete faster,
2830 especially on slow filesystems. If not set, the value of
2831 `transfer.unpackLimit` is used instead.
2833 receive.maxInputSize::
2834 If the size of the incoming pack stream is larger than this
2835 limit, then git-receive-pack will error out, instead of
2836 accepting the pack file. If not set or set to 0, then the size
2837 is unlimited.
2839 receive.denyDeletes::
2840 If set to true, git-receive-pack will deny a ref update that deletes
2841 the ref. Use this to prevent such a ref deletion via a push.
2843 receive.denyDeleteCurrent::
2844 If set to true, git-receive-pack will deny a ref update that
2845 deletes the currently checked out branch of a non-bare repository.
2847 receive.denyCurrentBranch::
2848 If set to true or "refuse", git-receive-pack will deny a ref update
2849 to the currently checked out branch of a non-bare repository.
2850 Such a push is potentially dangerous because it brings the HEAD
2851 out of sync with the index and working tree. If set to "warn",
2852 print a warning of such a push to stderr, but allow the push to
2853 proceed. If set to false or "ignore", allow such pushes with no
2854 message. Defaults to "refuse".
2855 +
2856 Another option is "updateInstead" which will update the working
2857 tree if pushing into the current branch. This option is
2858 intended for synchronizing working directories when one side is not easily
2859 accessible via interactive ssh (e.g. a live web site, hence the requirement
2860 that the working directory be clean). This mode also comes in handy when
2861 developing inside a VM to test and fix code on different Operating Systems.
2862 +
2863 By default, "updateInstead" will refuse the push if the working tree or
2864 the index have any difference from the HEAD, but the `push-to-checkout`
2865 hook can be used to customize this. See linkgit:githooks[5].
2867 receive.denyNonFastForwards::
2868 If set to true, git-receive-pack will deny a ref update which is
2869 not a fast-forward. Use this to prevent such an update via a push,
2870 even if that push is forced. This configuration variable is
2871 set when initializing a shared repository.
2873 receive.hideRefs::
2874 This variable is the same as `transfer.hideRefs`, but applies
2875 only to `receive-pack` (and so affects pushes, but not fetches).
2876 An attempt to update or delete a hidden ref by `git push` is
2877 rejected.
2879 receive.updateServerInfo::
2880 If set to true, git-receive-pack will run git-update-server-info
2881 after receiving data from git-push and updating refs.
2883 receive.shallowUpdate::
2884 If set to true, .git/shallow can be updated when new refs
2885 require new shallow roots. Otherwise those refs are rejected.
2887 remote.pushDefault::
2888 The remote to push to by default. Overrides
2889 `branch.<name>.remote` for all branches, and is overridden by
2890 `branch.<name>.pushRemote` for specific branches.
2892 remote.<name>.url::
2893 The URL of a remote repository. See linkgit:git-fetch[1] or
2894 linkgit:git-push[1].
2896 remote.<name>.pushurl::
2897 The push URL of a remote repository. See linkgit:git-push[1].
2899 remote.<name>.proxy::
2900 For remotes that require curl (http, https and ftp), the URL to
2901 the proxy to use for that remote. Set to the empty string to
2902 disable proxying for that remote.
2904 remote.<name>.proxyAuthMethod::
2905 For remotes that require curl (http, https and ftp), the method to use for
2906 authenticating against the proxy in use (probably set in
2907 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2909 remote.<name>.fetch::
2910 The default set of "refspec" for linkgit:git-fetch[1]. See
2911 linkgit:git-fetch[1].
2913 remote.<name>.push::
2914 The default set of "refspec" for linkgit:git-push[1]. See
2915 linkgit:git-push[1].
2917 remote.<name>.mirror::
2918 If true, pushing to this remote will automatically behave
2919 as if the `--mirror` option was given on the command line.
2921 remote.<name>.skipDefaultUpdate::
2922 If true, this remote will be skipped by default when updating
2923 using linkgit:git-fetch[1] or the `update` subcommand of
2924 linkgit:git-remote[1].
2926 remote.<name>.skipFetchAll::
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>.receivepack::
2932 The default program to execute on the remote side when pushing. See
2933 option --receive-pack of linkgit:git-push[1].
2935 remote.<name>.uploadpack::
2936 The default program to execute on the remote side when fetching. See
2937 option --upload-pack of linkgit:git-fetch-pack[1].
2939 remote.<name>.tagOpt::
2940 Setting this value to --no-tags disables automatic tag following when
2941 fetching from remote <name>. Setting it to --tags will fetch every
2942 tag from remote <name>, even if they are not reachable from remote
2943 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2944 override this setting. See options --tags and --no-tags of
2945 linkgit:git-fetch[1].
2947 remote.<name>.vcs::
2948 Setting this to a value <vcs> will cause Git to interact with
2949 the remote with the git-remote-<vcs> helper.
2951 remote.<name>.prune::
2952 When set to true, fetching from this remote by default will also
2953 remove any remote-tracking references that no longer exist on the
2954 remote (as if the `--prune` option was given on the command line).
2955 Overrides `fetch.prune` settings, if any.
2957 remote.<name>.pruneTags::
2958 When set to true, fetching from this remote by default will also
2959 remove any local tags that no longer exist on the remote if pruning
2960 is activated in general via `remote.<name>.prune`, `fetch.prune` or
2961 `--prune`. Overrides `fetch.pruneTags` settings, if any.
2962 +
2963 See also `remote.<name>.prune` and the PRUNING section of
2964 linkgit:git-fetch[1].
2966 remotes.<group>::
2967 The list of remotes which are fetched by "git remote update
2968 <group>". See linkgit:git-remote[1].
2970 repack.useDeltaBaseOffset::
2971 By default, linkgit:git-repack[1] creates packs that use
2972 delta-base offset. If you need to share your repository with
2973 Git older than version 1.4.4, either directly or via a dumb
2974 protocol such as http, then you need to set this option to
2975 "false" and repack. Access from old Git versions over the
2976 native protocol are unaffected by this option.
2978 repack.packKeptObjects::
2979 If set to true, makes `git repack` act as if
2980 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2981 details. Defaults to `false` normally, but `true` if a bitmap
2982 index is being written (either via `--write-bitmap-index` or
2983 `repack.writeBitmaps`).
2985 repack.writeBitmaps::
2986 When true, git will write a bitmap index when packing all
2987 objects to disk (e.g., when `git repack -a` is run). This
2988 index can speed up the "counting objects" phase of subsequent
2989 packs created for clones and fetches, at the cost of some disk
2990 space and extra time spent on the initial repack. This has
2991 no effect if multiple packfiles are created.
2992 Defaults to false.
2994 rerere.autoUpdate::
2995 When set to true, `git-rerere` updates the index with the
2996 resulting contents after it cleanly resolves conflicts using
2997 previously recorded resolution. Defaults to false.
2999 rerere.enabled::
3000 Activate recording of resolved conflicts, so that identical
3001 conflict hunks can be resolved automatically, should they be
3002 encountered again. By default, linkgit:git-rerere[1] is
3003 enabled if there is an `rr-cache` directory under the
3004 `$GIT_DIR`, e.g. if "rerere" was previously used in the
3005 repository.
3007 sendemail.identity::
3008 A configuration identity. When given, causes values in the
3009 'sendemail.<identity>' subsection to take precedence over
3010 values in the 'sendemail' section. The default identity is
3011 the value of `sendemail.identity`.
3013 sendemail.smtpEncryption::
3014 See linkgit:git-send-email[1] for description. Note that this
3015 setting is not subject to the 'identity' mechanism.
3017 sendemail.smtpssl (deprecated)::
3018 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3020 sendemail.smtpsslcertpath::
3021 Path to ca-certificates (either a directory or a single file).
3022 Set it to an empty string to disable certificate verification.
3024 sendemail.<identity>.*::
3025 Identity-specific versions of the 'sendemail.*' parameters
3026 found below, taking precedence over those when this
3027 identity is selected, through either the command-line or
3028 `sendemail.identity`.
3030 sendemail.aliasesFile::
3031 sendemail.aliasFileType::
3032 sendemail.annotate::
3033 sendemail.bcc::
3034 sendemail.cc::
3035 sendemail.ccCmd::
3036 sendemail.chainReplyTo::
3037 sendemail.confirm::
3038 sendemail.envelopeSender::
3039 sendemail.from::
3040 sendemail.multiEdit::
3041 sendemail.signedoffbycc::
3042 sendemail.smtpPass::
3043 sendemail.suppresscc::
3044 sendemail.suppressFrom::
3045 sendemail.to::
3046 sendemail.tocmd::
3047 sendemail.smtpDomain::
3048 sendemail.smtpServer::
3049 sendemail.smtpServerPort::
3050 sendemail.smtpServerOption::
3051 sendemail.smtpUser::
3052 sendemail.thread::
3053 sendemail.transferEncoding::
3054 sendemail.validate::
3055 sendemail.xmailer::
3056 See linkgit:git-send-email[1] for description.
3058 sendemail.signedoffcc (deprecated)::
3059 Deprecated alias for `sendemail.signedoffbycc`.
3061 sendemail.smtpBatchSize::
3062 Number of messages to be sent per connection, after that a relogin
3063 will happen. If the value is 0 or undefined, send all messages in
3064 one connection.
3065 See also the `--batch-size` option of linkgit:git-send-email[1].
3067 sendemail.smtpReloginDelay::
3068 Seconds wait before reconnecting to smtp server.
3069 See also the `--relogin-delay` option of linkgit:git-send-email[1].
3071 showbranch.default::
3072 The default set of branches for linkgit:git-show-branch[1].
3073 See linkgit:git-show-branch[1].
3075 splitIndex.maxPercentChange::
3076 When the split index feature is used, this specifies the
3077 percent of entries the split index can contain compared to the
3078 total number of entries in both the split index and the shared
3079 index before a new shared index is written.
3080 The value should be between 0 and 100. If the value is 0 then
3081 a new shared index is always written, if it is 100 a new
3082 shared index is never written.
3083 By default the value is 20, so a new shared index is written
3084 if the number of entries in the split index would be greater
3085 than 20 percent of the total number of entries.
3086 See linkgit:git-update-index[1].
3088 splitIndex.sharedIndexExpire::
3089 When the split index feature is used, shared index files that
3090 were not modified since the time this variable specifies will
3091 be removed when a new shared index file is created. The value
3092 "now" expires all entries immediately, and "never" suppresses
3093 expiration altogether.
3094 The default value is "2.weeks.ago".
3095 Note that a shared index file is considered modified (for the
3096 purpose of expiration) each time a new split-index file is
3097 either created based on it or read from it.
3098 See linkgit:git-update-index[1].
3100 status.relativePaths::
3101 By default, linkgit:git-status[1] shows paths relative to the
3102 current directory. Setting this variable to `false` shows paths
3103 relative to the repository root (this was the default for Git
3104 prior to v1.5.4).
3106 status.short::
3107 Set to true to enable --short by default in linkgit:git-status[1].
3108 The option --no-short takes precedence over this variable.
3110 status.branch::
3111 Set to true to enable --branch by default in linkgit:git-status[1].
3112 The option --no-branch takes precedence over this variable.
3114 status.displayCommentPrefix::
3115 If set to true, linkgit:git-status[1] will insert a comment
3116 prefix before each output line (starting with
3117 `core.commentChar`, i.e. `#` by default). This was the
3118 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3119 Defaults to false.
3121 status.showStash::
3122 If set to true, linkgit:git-status[1] will display the number of
3123 entries currently stashed away.
3124 Defaults to false.
3126 status.showUntrackedFiles::
3127 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3128 files which are not currently tracked by Git. Directories which
3129 contain only untracked files, are shown with the directory name
3130 only. Showing untracked files means that Git needs to lstat() all
3131 the files in the whole repository, which might be slow on some
3132 systems. So, this variable controls how the commands displays
3133 the untracked files. Possible values are:
3134 +
3135 --
3136 * `no` - Show no untracked files.
3137 * `normal` - Show untracked files and directories.
3138 * `all` - Show also individual files in untracked directories.
3139 --
3140 +
3141 If this variable is not specified, it defaults to 'normal'.
3142 This variable can be overridden with the -u|--untracked-files option
3143 of linkgit:git-status[1] and linkgit:git-commit[1].
3145 status.submoduleSummary::
3146 Defaults to false.
3147 If this is set to a non zero number or true (identical to -1 or an
3148 unlimited number), the submodule summary will be enabled and a
3149 summary of commits for modified submodules will be shown (see
3150 --summary-limit option of linkgit:git-submodule[1]). Please note
3151 that the summary output command will be suppressed for all
3152 submodules when `diff.ignoreSubmodules` is set to 'all' or only
3153 for those submodules where `submodule.<name>.ignore=all`. The only
3154 exception to that rule is that status and commit will show staged
3155 submodule changes. To
3156 also view the summary for ignored submodules you can either use
3157 the --ignore-submodules=dirty command-line option or the 'git
3158 submodule summary' command, which shows a similar output but does
3159 not honor these settings.
3161 stash.showPatch::
3162 If this is set to true, the `git stash show` command without an
3163 option will show the stash entry in patch form. Defaults to false.
3164 See description of 'show' command in linkgit:git-stash[1].
3166 stash.showStat::
3167 If this is set to true, the `git stash show` command without an
3168 option will show diffstat of the stash entry. Defaults to true.
3169 See description of 'show' command in linkgit:git-stash[1].
3171 submodule.<name>.url::
3172 The URL for a submodule. This variable is copied from the .gitmodules
3173 file to the git config via 'git submodule init'. The user can change
3174 the configured URL before obtaining the submodule via 'git submodule
3175 update'. If neither submodule.<name>.active or submodule.active are
3176 set, the presence of this variable is used as a fallback to indicate
3177 whether the submodule is of interest to git commands.
3178 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3180 submodule.<name>.update::
3181 The method by which a submodule is updated by 'git submodule update',
3182 which is the only affected command, others such as
3183 'git checkout --recurse-submodules' are unaffected. It exists for
3184 historical reasons, when 'git submodule' was the only command to
3185 interact with submodules; settings like `submodule.active`
3186 and `pull.rebase` are more specific. It is populated by
3187 `git submodule init` from the linkgit:gitmodules[5] file.
3188 See description of 'update' command in linkgit:git-submodule[1].
3190 submodule.<name>.branch::
3191 The remote branch name for a submodule, used by `git submodule
3192 update --remote`. Set this option to override the value found in
3193 the `.gitmodules` file. See linkgit:git-submodule[1] and
3194 linkgit:gitmodules[5] for details.
3196 submodule.<name>.fetchRecurseSubmodules::
3197 This option can be used to control recursive fetching of this
3198 submodule. It can be overridden by using the --[no-]recurse-submodules
3199 command-line option to "git fetch" and "git pull".
3200 This setting will override that from in the linkgit:gitmodules[5]
3201 file.
3203 submodule.<name>.ignore::
3204 Defines under what circumstances "git status" and the diff family show
3205 a submodule as modified. When set to "all", it will never be considered
3206 modified (but it will nonetheless show up in the output of status and
3207 commit when it has been staged), "dirty" will ignore all changes
3208 to the submodules work tree and
3209 takes only differences between the HEAD of the submodule and the commit
3210 recorded in the superproject into account. "untracked" will additionally
3211 let submodules with modified tracked files in their work tree show up.
3212 Using "none" (the default when this option is not set) also shows
3213 submodules that have untracked files in their work tree as changed.
3214 This setting overrides any setting made in .gitmodules for this submodule,
3215 both settings can be overridden on the command line by using the
3216 "--ignore-submodules" option. The 'git submodule' commands are not
3217 affected by this setting.
3219 submodule.<name>.active::
3220 Boolean value indicating if the submodule is of interest to git
3221 commands. This config option takes precedence over the
3222 submodule.active config option.
3224 submodule.active::
3225 A repeated field which contains a pathspec used to match against a
3226 submodule's path to determine if the submodule is of interest to git
3227 commands.
3229 submodule.recurse::
3230 Specifies if commands recurse into submodules by default. This
3231 applies to all commands that have a `--recurse-submodules` option,
3232 except `clone`.
3233 Defaults to false.
3235 submodule.fetchJobs::
3236 Specifies how many submodules are fetched/cloned at the same time.
3237 A positive integer allows up to that number of submodules fetched
3238 in parallel. A value of 0 will give some reasonable default.
3239 If unset, it defaults to 1.
3241 submodule.alternateLocation::
3242 Specifies how the submodules obtain alternates when submodules are
3243 cloned. Possible values are `no`, `superproject`.
3244 By default `no` is assumed, which doesn't add references. When the
3245 value is set to `superproject` the submodule to be cloned computes
3246 its alternates location relative to the superprojects alternate.
3248 submodule.alternateErrorStrategy::
3249 Specifies how to treat errors with the alternates for a submodule
3250 as computed via `submodule.alternateLocation`. Possible values are
3251 `ignore`, `info`, `die`. Default is `die`.
3253 tag.forceSignAnnotated::
3254 A boolean to specify whether annotated tags created should be GPG signed.
3255 If `--annotate` is specified on the command line, it takes
3256 precedence over this option.
3258 tag.sort::
3259 This variable controls the sort ordering of tags when displayed by
3260 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3261 value of this variable will be used as the default.
3263 tar.umask::
3264 This variable can be used to restrict the permission bits of
3265 tar archive entries. The default is 0002, which turns off the
3266 world write bit. The special value "user" indicates that the
3267 archiving user's umask will be used instead. See umask(2) and
3268 linkgit:git-archive[1].
3270 transfer.fsckObjects::
3271 When `fetch.fsckObjects` or `receive.fsckObjects` are
3272 not set, the value of this variable is used instead.
3273 Defaults to false.
3275 transfer.hideRefs::
3276 String(s) `receive-pack` and `upload-pack` use to decide which
3277 refs to omit from their initial advertisements. Use more than
3278 one definition to specify multiple prefix strings. A ref that is
3279 under the hierarchies listed in the value of this variable is
3280 excluded, and is hidden when responding to `git push` or `git
3281 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3282 program-specific versions of this config.
3283 +
3284 You may also include a `!` in front of the ref name to negate the entry,
3285 explicitly exposing it, even if an earlier entry marked it as hidden.
3286 If you have multiple hideRefs values, later entries override earlier ones
3287 (and entries in more-specific config files override less-specific ones).
3288 +
3289 If a namespace is in use, the namespace prefix is stripped from each
3290 reference before it is matched against `transfer.hiderefs` patterns.
3291 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3292 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3293 is omitted from the advertisements but `refs/heads/master` and
3294 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3295 "have" lines. In order to match refs before stripping, add a `^` in front of
3296 the ref name. If you combine `!` and `^`, `!` must be specified first.
3297 +
3298 Even if you hide refs, a client may still be able to steal the target
3299 objects via the techniques described in the "SECURITY" section of the
3300 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3301 separate repository.
3303 transfer.unpackLimit::
3304 When `fetch.unpackLimit` or `receive.unpackLimit` are
3305 not set, the value of this variable is used instead.
3306 The default value is 100.
3308 uploadarchive.allowUnreachable::
3309 If true, allow clients to use `git archive --remote` to request
3310 any tree, whether reachable from the ref tips or not. See the
3311 discussion in the "SECURITY" section of
3312 linkgit:git-upload-archive[1] for more details. Defaults to
3313 `false`.
3315 uploadpack.hideRefs::
3316 This variable is the same as `transfer.hideRefs`, but applies
3317 only to `upload-pack` (and so affects only fetches, not pushes).
3318 An attempt to fetch a hidden ref by `git fetch` will fail. See
3319 also `uploadpack.allowTipSHA1InWant`.
3321 uploadpack.allowTipSHA1InWant::
3322 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3323 to accept a fetch request that asks for an object at the tip
3324 of a hidden ref (by default, such a request is rejected).
3325 See also `uploadpack.hideRefs`. Even if this is false, a client
3326 may be able to steal objects via the techniques described in the
3327 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3328 best to keep private data in a separate repository.
3330 uploadpack.allowReachableSHA1InWant::
3331 Allow `upload-pack` to accept a fetch request that asks for an
3332 object that is reachable from any ref tip. However, note that
3333 calculating object reachability is computationally expensive.
3334 Defaults to `false`. Even if this is false, a client may be able
3335 to steal objects via the techniques described in the "SECURITY"
3336 section of the linkgit:gitnamespaces[7] man page; it's best to
3337 keep private data in a separate repository.
3339 uploadpack.allowAnySHA1InWant::
3340 Allow `upload-pack` to accept a fetch request that asks for any
3341 object at all.
3342 Defaults to `false`.
3344 uploadpack.keepAlive::
3345 When `upload-pack` has started `pack-objects`, there may be a
3346 quiet period while `pack-objects` prepares the pack. Normally
3347 it would output progress information, but if `--quiet` was used
3348 for the fetch, `pack-objects` will output nothing at all until
3349 the pack data begins. Some clients and networks may consider
3350 the server to be hung and give up. Setting this option instructs
3351 `upload-pack` to send an empty keepalive packet every
3352 `uploadpack.keepAlive` seconds. Setting this option to 0
3353 disables keepalive packets entirely. The default is 5 seconds.
3355 uploadpack.packObjectsHook::
3356 If this option is set, when `upload-pack` would run
3357 `git pack-objects` to create a packfile for a client, it will
3358 run this shell command instead. The `pack-objects` command and
3359 arguments it _would_ have run (including the `git pack-objects`
3360 at the beginning) are appended to the shell command. The stdin
3361 and stdout of the hook are treated as if `pack-objects` itself
3362 was run. I.e., `upload-pack` will feed input intended for
3363 `pack-objects` to the hook, and expects a completed packfile on
3364 stdout.
3366 uploadpack.allowFilter::
3367 If this option is set, `upload-pack` will support partial
3368 clone and partial fetch object filtering.
3369 +
3370 Note that this configuration variable is ignored if it is seen in the
3371 repository-level config (this is a safety measure against fetching from
3372 untrusted repositories).
3374 url.<base>.insteadOf::
3375 Any URL that starts with this value will be rewritten to
3376 start, instead, with <base>. In cases where some site serves a
3377 large number of repositories, and serves them with multiple
3378 access methods, and some users need to use different access
3379 methods, this feature allows people to specify any of the
3380 equivalent URLs and have Git automatically rewrite the URL to
3381 the best alternative for the particular user, even for a
3382 never-before-seen repository on the site. When more than one
3383 insteadOf strings match a given URL, the longest match is used.
3384 +
3385 Note that any protocol restrictions will be applied to the rewritten
3386 URL. If the rewrite changes the URL to use a custom protocol or remote
3387 helper, you may need to adjust the `protocol.*.allow` config to permit
3388 the request. In particular, protocols you expect to use for submodules
3389 must be set to `always` rather than the default of `user`. See the
3390 description of `protocol.allow` above.
3392 url.<base>.pushInsteadOf::
3393 Any URL that starts with this value will not be pushed to;
3394 instead, it will be rewritten to start with <base>, and the
3395 resulting URL will be pushed to. In cases where some site serves
3396 a large number of repositories, and serves them with multiple
3397 access methods, some of which do not allow push, this feature
3398 allows people to specify a pull-only URL and have Git
3399 automatically use an appropriate URL to push, even for a
3400 never-before-seen repository on the site. When more than one
3401 pushInsteadOf strings match a given URL, the longest match is
3402 used. If a remote has an explicit pushurl, Git will ignore this
3403 setting for that remote.
3405 user.email::
3406 Your email address to be recorded in any newly created commits.
3407 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3408 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3410 user.name::
3411 Your full name to be recorded in any newly created commits.
3412 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3413 environment variables. See linkgit:git-commit-tree[1].
3415 user.useConfigOnly::
3416 Instruct Git to avoid trying to guess defaults for `user.email`
3417 and `user.name`, and instead retrieve the values only from the
3418 configuration. For example, if you have multiple email addresses
3419 and would like to use a different one for each repository, then
3420 with this configuration option set to `true` in the global config
3421 along with a name, Git will prompt you to set up an email before
3422 making new commits in a newly cloned repository.
3423 Defaults to `false`.
3425 user.signingKey::
3426 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3427 key you want it to automatically when creating a signed tag or
3428 commit, you can override the default selection with this variable.
3429 This option is passed unchanged to gpg's --local-user parameter,
3430 so you may specify a key using any method that gpg supports.
3432 versionsort.prereleaseSuffix (deprecated)::
3433 Deprecated alias for `versionsort.suffix`. Ignored if
3434 `versionsort.suffix` is set.
3436 versionsort.suffix::
3437 Even when version sort is used in linkgit:git-tag[1], tagnames
3438 with the same base version but different suffixes are still sorted
3439 lexicographically, resulting e.g. in prerelease tags appearing
3440 after the main release (e.g. "1.0-rc1" after "1.0"). This
3441 variable can be specified to determine the sorting order of tags
3442 with different suffixes.
3443 +
3444 By specifying a single suffix in this variable, any tagname containing
3445 that suffix will appear before the corresponding main release. E.g. if
3446 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3447 "1.0". If specified multiple times, once per suffix, then the order of
3448 suffixes in the configuration will determine the sorting order of tagnames
3449 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3450 configuration, then all "1.0-preX" tags will be listed before any
3451 "1.0-rcX" tags. The placement of the main release tag relative to tags
3452 with various suffixes can be determined by specifying the empty suffix
3453 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3454 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3455 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3456 "v4.8-bfsX".
3457 +
3458 If more than one suffixes match the same tagname, then that tagname will
3459 be sorted according to the suffix which starts at the earliest position in
3460 the tagname. If more than one different matching suffixes start at
3461 that earliest position, then that tagname will be sorted according to the
3462 longest of those suffixes.
3463 The sorting order between different suffixes is undefined if they are
3464 in multiple config files.
3466 web.browser::
3467 Specify a web browser that may be used by some commands.
3468 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3469 may use it.
3471 worktree.guessRemote::
3472 With `add`, if no branch argument, and neither of `-b` nor
3473 `-B` nor `--detach` are given, the command defaults to
3474 creating a new branch from HEAD. If `worktree.guessRemote` is
3475 set to true, `worktree add` tries to find a remote-tracking
3476 branch whose name uniquely matches the new branch name. If
3477 such a branch exists, it is checked out and set as "upstream"
3478 for the new branch. If no such match can be found, it falls
3479 back to creating a new branch from the current HEAD.