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