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