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