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