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