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