4 The git configuration file contains a number of variables that affect
5 the git command's 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 and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 0/1, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
91 ; Don't trust file modes
96 external = /usr/local/bin/diff-wrapper
101 merge = refs/heads/devel
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwritting local changes.
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
158 (Windows-only) If true (which is the default), mark newly-created
159 directories and files whose name starts with a dot as hidden.
160 If 'dotGitOnly', only the .git/ directory is hidden, but no other
161 files starting with a dot.
163 core.ignoreCygwinFSTricks::
164 This option is only used by Cygwin implementation of Git. If false,
165 the Cygwin stat() and lstat() functions are used. This may be useful
166 if your repository consists of a few separate directories joined in
167 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
168 whenever it is possible and falls back to Cygwin functions only to
169 handle symbol links. The native mode is more than twice faster than
170 normal Cygwin l/stat() functions. True by default, unless core.filemode
171 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
172 POSIX emulation is required to support core.filemode.
175 If true, this option enables various workarounds to enable
176 git to work better on filesystems that are not case sensitive,
177 like FAT. For example, if a directory listing finds
178 "makefile" when git expects "Makefile", git will assume
179 it is really the same file, and continue to remember it as
182 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
183 will probe and set core.ignorecase true if appropriate when the repository
187 If false, the ctime differences between the index and the
188 working copy are ignored; useful when the inode change time
189 is regularly modified by something outside Git (file system
190 crawlers and some backup systems).
191 See linkgit:git-update-index[1]. True by default.
194 The commands that output paths (e.g. 'ls-files',
195 'diff'), when not given the `-z` option, will quote
196 "unusual" characters in the pathname by enclosing the
197 pathname in a double-quote pair and with backslashes the
198 same way strings in C source code are quoted. If this
199 variable is set to false, the bytes higher than 0x80 are
200 not quoted but output as verbatim. Note that double
201 quote, backslash and control characters are always
202 quoted without `-z` regardless of the setting of this
206 Sets the line ending type to use in the working directory for
207 files that have the `text` property set. Alternatives are
208 'lf', 'crlf' and 'native', which uses the platform's native
209 line ending. The default value is `native`. See
210 linkgit:gitattributes[5] for more information on end-of-line
214 If true, makes git check if converting `CRLF` is reversible when
215 end-of-line conversion is active. Git will verify if a command
216 modifies a file in the work tree either directly or indirectly.
217 For example, committing a file followed by checking out the
218 same file should yield the original file in the work tree. If
219 this is not the case for the current setting of
220 `core.autocrlf`, git will reject the file. The variable can
221 be set to "warn", in which case git will only warn about an
222 irreversible conversion but continue the operation.
224 CRLF conversion bears a slight chance of corrupting data.
225 When it is enabled, git will convert CRLF to LF during commit and LF to
226 CRLF during checkout. A file that contains a mixture of LF and
227 CRLF before the commit cannot be recreated by git. For text
228 files this is the right thing to do: it corrects line endings
229 such that we have only LF line endings in the repository.
230 But for binary files that are accidentally classified as text the
231 conversion can corrupt data.
233 If you recognize such corruption early you can easily fix it by
234 setting the conversion type explicitly in .gitattributes. Right
235 after committing you still have the original file in your work
236 tree and this file is not yet corrupted. You can explicitly tell
237 git that this file is binary and git will handle the file
240 Unfortunately, the desired effect of cleaning up text files with
241 mixed line endings and the undesired effect of corrupting binary
242 files cannot be distinguished. In both cases CRLFs are removed
243 in an irreversible way. For text files this is the right thing
244 to do because CRLFs are line endings, while for binary files
245 converting CRLFs corrupts data.
247 Note, this safety check does not mean that a checkout will generate a
248 file identical to the original file for a different setting of
249 `core.eol` and `core.autocrlf`, but only for the current one. For
250 example, a text file with `LF` would be accepted with `core.eol=lf`
251 and could later be checked out with `core.eol=crlf`, in which case the
252 resulting file would contain `CRLF`, although the original file
253 contained `LF`. However, in both work trees the line endings would be
254 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
255 file with mixed line endings would be reported by the `core.safecrlf`
259 Setting this variable to "true" is almost the same as setting
260 the `text` attribute to "auto" on all files except that text
261 files are not guaranteed to be normalized: files that contain
262 `CRLF` in the repository will not be touched. Use this
263 setting if you want to have `CRLF` line endings in your
264 working directory even though the repository does not have
265 normalized line endings. This variable can be set to 'input',
266 in which case no output conversion is performed.
269 If false, symbolic links are checked out as small plain files that
270 contain the link text. linkgit:git-update-index[1] and
271 linkgit:git-add[1] will not change the recorded type to regular
272 file. Useful on filesystems like FAT that do not support
275 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
276 will probe and set core.symlinks false if appropriate when the repository
280 A "proxy command" to execute (as 'command host port') instead
281 of establishing direct connection to the remote server when
282 using the git protocol for fetching. If the variable value is
283 in the "COMMAND for DOMAIN" format, the command is applied only
284 on hostnames ending with the specified domain string. This variable
285 may be set multiple times and is matched in the given order;
286 the first match wins.
288 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
289 (which always applies universally, without the special "for"
292 The special string `none` can be used as the proxy command to
293 specify that no proxy be used for a given domain pattern.
294 This is useful for excluding servers inside a firewall from
295 proxy use, while defaulting to a common proxy for external domains.
298 If true, commands which modify both the working tree and the index
299 will mark the updated paths with the "assume unchanged" bit in the
300 index. These marked files are then assumed to stay unchanged in the
301 working copy, until you mark them otherwise manually - Git will not
302 detect the file changes by lstat() calls. This is useful on systems
303 where those are very slow, such as Microsoft Windows.
304 See linkgit:git-update-index[1].
307 core.preferSymlinkRefs::
308 Instead of the default "symref" format for HEAD
309 and other symbolic reference files, use symbolic links.
310 This is sometimes needed to work with old scripts that
311 expect HEAD to be a symbolic link.
314 If true this repository is assumed to be 'bare' and has no
315 working directory associated with it. If this is the case a
316 number of commands that require a working directory will be
317 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
319 This setting is automatically guessed by linkgit:git-clone[1] or
320 linkgit:git-init[1] when the repository was created. By default a
321 repository that ends in "/.git" is assumed to be not bare (bare =
322 false), while all other repositories are assumed to be bare (bare
326 Set the path to the root of the work tree.
327 This can be overridden by the GIT_WORK_TREE environment
328 variable and the '--work-tree' command line option. It can be
329 an absolute path or a relative path to the .git directory,
330 either specified by --git-dir or GIT_DIR, or automatically
332 If --git-dir or GIT_DIR are specified but none of
333 --work-tree, GIT_WORK_TREE and core.worktree is specified,
334 the current working directory is regarded as the root of the
337 Note that this variable is honored even when set in a configuration
338 file in a ".git" subdirectory of a directory, and its value differs
339 from the latter directory (e.g. "/path/to/.git/config" has
340 core.worktree set to "/different/path"), which is most likely a
341 misconfiguration. Running git commands in "/path/to" directory will
342 still use "/different/path" as the root of the work tree and can cause
343 great confusion to the users.
345 core.logAllRefUpdates::
346 Enable the reflog. Updates to a ref <ref> is logged to the file
347 "$GIT_DIR/logs/<ref>", by appending the new and old
348 SHA1, the date/time and the reason of the update, but
349 only when the file exists. If this configuration
350 variable is set to true, missing "$GIT_DIR/logs/<ref>"
351 file is automatically created for branch heads.
353 This information can be used to determine what commit
354 was the tip of a branch "2 days ago".
356 This value is true by default in a repository that has
357 a working directory associated with it, and false by
358 default in a bare repository.
360 core.repositoryFormatVersion::
361 Internal variable identifying the repository format and layout
364 core.sharedRepository::
365 When 'group' (or 'true'), the repository is made shareable between
366 several users in a group (making sure all the files and objects are
367 group-writable). When 'all' (or 'world' or 'everybody'), the
368 repository will be readable by all users, additionally to being
369 group-shareable. When 'umask' (or 'false'), git will use permissions
370 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
371 files in the repository will have this mode value. '0xxx' will override
372 user's umask value (whereas the other options will only override
373 requested parts of the user's umask value). Examples: '0660' will make
374 the repo read/write-able for the owner and group, but inaccessible to
375 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
376 repository that is group-readable but not group-writable.
377 See linkgit:git-init[1]. False by default.
379 core.warnAmbiguousRefs::
380 If true, git will warn you if the ref name you passed it is ambiguous
381 and might match multiple refs in the .git/refs/ tree. True by default.
384 An integer -1..9, indicating a default compression level.
385 -1 is the zlib default. 0 means no compression,
386 and 1..9 are various speed/size tradeoffs, 9 being slowest.
387 If set, this provides a default to other compression variables,
388 such as 'core.loosecompression' and 'pack.compression'.
390 core.loosecompression::
391 An integer -1..9, indicating the compression level for objects that
392 are not in a pack file. -1 is the zlib default. 0 means no
393 compression, and 1..9 are various speed/size tradeoffs, 9 being
394 slowest. If not set, defaults to core.compression. If that is
395 not set, defaults to 1 (best speed).
397 core.packedGitWindowSize::
398 Number of bytes of a pack file to map into memory in a
399 single mapping operation. Larger window sizes may allow
400 your system to process a smaller number of large pack files
401 more quickly. Smaller window sizes will negatively affect
402 performance due to increased calls to the operating system's
403 memory manager, but may improve performance when accessing
404 a large number of large pack files.
406 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
407 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
408 be reasonable for all users/operating systems. You probably do
409 not need to adjust this value.
411 Common unit suffixes of 'k', 'm', or 'g' are supported.
413 core.packedGitLimit::
414 Maximum number of bytes to map simultaneously into memory
415 from pack files. If Git needs to access more than this many
416 bytes at once to complete an operation it will unmap existing
417 regions to reclaim virtual address space within the process.
419 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
420 This should be reasonable for all users/operating systems, except on
421 the largest projects. You probably do not need to adjust this value.
423 Common unit suffixes of 'k', 'm', or 'g' are supported.
425 core.deltaBaseCacheLimit::
426 Maximum number of bytes to reserve for caching base objects
427 that multiple deltafied objects reference. By storing the
428 entire decompressed base objects in a cache Git is able
429 to avoid unpacking and decompressing frequently used base
430 objects multiple times.
432 Default is 16 MiB on all platforms. This should be reasonable
433 for all users/operating systems, except on the largest projects.
434 You probably do not need to adjust this value.
436 Common unit suffixes of 'k', 'm', or 'g' are supported.
438 core.bigFileThreshold::
439 Files larger than this size are stored deflated, without
440 attempting delta compression. Storing large files without
441 delta compression avoids excessive memory usage, at the
442 slight expense of increased disk usage.
444 Default is 512 MiB on all platforms. This should be reasonable
445 for most projects as source code and other text files can still
446 be delta compressed, but larger binary media files won't be.
448 Common unit suffixes of 'k', 'm', or 'g' are supported.
450 Currently only linkgit:git-fast-import[1] honors this setting.
453 In addition to '.gitignore' (per-directory) and
454 '.git/info/exclude', git looks into this file for patterns
455 of files which are not meant to be tracked. "{tilde}/" is expanded
456 to the value of `$HOME` and "{tilde}user/" to the specified user's
457 home directory. See linkgit:gitignore[5].
460 Commands such as `commit` and `tag` that lets you edit
461 messages by launching an editor uses the value of this
462 variable when it is set, and the environment variable
463 `GIT_EDITOR` is not set. See linkgit:git-var[1].
466 The command that git will use to paginate output. Can
467 be overridden with the `GIT_PAGER` environment
468 variable. Note that git sets the `LESS` environment
469 variable to `FRSX` if it is unset when it runs the
470 pager. One can change these settings by setting the
471 `LESS` variable to some other value. Alternately,
472 these settings can be overridden on a project or
473 global basis by setting the `core.pager` option.
474 Setting `core.pager` has no affect on the `LESS`
475 environment variable behaviour above, so if you want
476 to override git's default settings this way, you need
477 to be explicit. For example, to disable the S option
478 in a backward compatible manner, set `core.pager`
479 to `less -+$LESS -FRX`. This will be passed to the
480 shell by git, which will translate the final command to
481 `LESS=FRSX less -+FRSX -FRX`.
484 A comma separated list of common whitespace problems to
485 notice. 'git diff' will use `color.diff.whitespace` to
486 highlight them, and 'git apply --whitespace=error' will
487 consider them as errors. You can prefix `-` to disable
488 any of them (e.g. `-trailing-space`):
490 * `blank-at-eol` treats trailing whitespaces at the end of the line
491 as an error (enabled by default).
492 * `space-before-tab` treats a space character that appears immediately
493 before a tab character in the initial indent part of the line as an
494 error (enabled by default).
495 * `indent-with-non-tab` treats a line that is indented with 8 or more
496 space characters as an error (not enabled by default).
497 * `tab-in-indent` treats a tab character in the initial indent part of
498 the line as an error (not enabled by default).
499 * `blank-at-eof` treats blank lines added at the end of file as an error
500 (enabled by default).
501 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
503 * `cr-at-eol` treats a carriage-return at the end of line as
504 part of the line terminator, i.e. with it, `trailing-space`
505 does not trigger if the character before such a carriage-return
506 is not a whitespace (not enabled by default).
508 core.fsyncobjectfiles::
509 This boolean will enable 'fsync()' when writing object files.
511 This is a total waste of time and effort on a filesystem that orders
512 data writes properly, but can be useful for filesystems that do not use
513 journalling (traditional UNIX filesystems) or that only journal metadata
514 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
517 Enable parallel index preload for operations like 'git diff'
519 This can speed up operations like 'git diff' and 'git status' especially
520 on filesystems like NFS that have weak caching semantics and thus
521 relatively high IO latencies. With this set to 'true', git will do the
522 index comparison to the filesystem data in parallel, allowing
526 You can set this to 'link', in which case a hardlink followed by
527 a delete of the source are used to make sure that object creation
528 will not overwrite existing objects.
530 On some file system/operating system combinations, this is unreliable.
531 Set this config setting to 'rename' there; However, This will remove the
532 check that makes sure that existing object files will not get overwritten.
535 When showing commit messages, also show notes which are stored in
536 the given ref. The ref must be fully qualified. If the given
537 ref does not exist, it is not an error but means that no
538 notes should be printed.
540 This setting defaults to "refs/notes/commits", and it can be overridden by
541 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
543 core.sparseCheckout::
544 Enable "sparse checkout" feature. See section "Sparse checkout" in
545 linkgit:git-read-tree[1] for more information.
548 Tells 'git add' to continue adding files when some files cannot be
549 added due to indexing errors. Equivalent to the '--ignore-errors'
550 option of linkgit:git-add[1].
553 Command aliases for the linkgit:git[1] command wrapper - e.g.
554 after defining "alias.last = cat-file commit HEAD", the invocation
555 "git last" is equivalent to "git cat-file commit HEAD". To avoid
556 confusion and troubles with script usage, aliases that
557 hide existing git commands are ignored. Arguments are split by
558 spaces, the usual shell quoting and escaping is supported.
559 quote pair and a backslash can be used to quote them.
561 If the alias expansion is prefixed with an exclamation point,
562 it will be treated as a shell command. For example, defining
563 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
564 "git new" is equivalent to running the shell command
565 "gitk --all --not ORIG_HEAD". Note that shell commands will be
566 executed from the top-level directory of a repository, which may
567 not necessarily be the current directory.
570 If true, git-am will call git-mailsplit for patches in mbox format
571 with parameter '--keep-cr'. In this case git-mailsplit will
572 not remove `\r` from lines ending with `\r\n`. Can be overrriden
573 by giving '--no-keep-cr' from the command line.
574 See linkgit:git-am[1], linkgit:git-mailsplit[1].
576 apply.ignorewhitespace::
577 When set to 'change', tells 'git apply' to ignore changes in
578 whitespace, in the same way as the '--ignore-space-change'
580 When set to one of: no, none, never, false tells 'git apply' to
581 respect all whitespace differences.
582 See linkgit:git-apply[1].
585 Tells 'git apply' how to handle whitespaces, in the same way
586 as the '--whitespace' option. See linkgit:git-apply[1].
588 branch.autosetupmerge::
589 Tells 'git branch' and 'git checkout' to set up new branches
590 so that linkgit:git-pull[1] will appropriately merge from the
591 starting point branch. Note that even if this option is not set,
592 this behavior can be chosen per-branch using the `--track`
593 and `--no-track` options. The valid settings are: `false` -- no
594 automatic setup is done; `true` -- automatic setup is done when the
595 starting point is a remote branch; `always` -- automatic setup is
596 done when the starting point is either a local branch or remote
597 branch. This option defaults to true.
599 branch.autosetuprebase::
600 When a new branch is created with 'git branch' or 'git checkout'
601 that tracks another branch, this variable tells git to set
602 up pull to rebase instead of merge (see "branch.<name>.rebase").
603 When `never`, rebase is never automatically set to true.
604 When `local`, rebase is set to true for tracked branches of
605 other local branches.
606 When `remote`, rebase is set to true for tracked branches of
608 When `always`, rebase will be set to true for all tracking
610 See "branch.autosetupmerge" for details on how to set up a
611 branch to track another branch.
612 This option defaults to never.
614 branch.<name>.remote::
615 When in branch <name>, it tells 'git fetch' and 'git push' which
616 remote to fetch from/push to. It defaults to `origin` if no remote is
617 configured. `origin` is also used if you are not on any branch.
619 branch.<name>.merge::
620 Defines, together with branch.<name>.remote, the upstream branch
621 for the given branch. It tells 'git fetch'/'git pull' which
622 branch to merge and can also affect 'git push' (see push.default).
623 When in branch <name>, it tells 'git fetch' the default
624 refspec to be marked for merging in FETCH_HEAD. The value is
625 handled like the remote part of a refspec, and must match a
626 ref which is fetched from the remote given by
627 "branch.<name>.remote".
628 The merge information is used by 'git pull' (which at first calls
629 'git fetch') to lookup the default branch for merging. Without
630 this option, 'git pull' defaults to merge the first refspec fetched.
631 Specify multiple values to get an octopus merge.
632 If you wish to setup 'git pull' so that it merges into <name> from
633 another branch in the local repository, you can point
634 branch.<name>.merge to the desired branch, and use the special setting
635 `.` (a period) for branch.<name>.remote.
637 branch.<name>.mergeoptions::
638 Sets default options for merging into branch <name>. The syntax and
639 supported options are the same as those of linkgit:git-merge[1], but
640 option values containing whitespace characters are currently not
643 branch.<name>.rebase::
644 When true, rebase the branch <name> on top of the fetched branch,
645 instead of merging the default branch from the default remote when
647 *NOTE*: this is a possibly dangerous operation; do *not* use
648 it unless you understand the implications (see linkgit:git-rebase[1]
652 Specify the command to invoke the specified browser. The
653 specified command is evaluated in shell with the URLs passed
654 as arguments. (See linkgit:git-web--browse[1].)
656 browser.<tool>.path::
657 Override the path for the given tool that may be used to
658 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
659 working repository in gitweb (see linkgit:git-instaweb[1]).
662 A boolean to make git-clean do nothing unless given -f
663 or -n. Defaults to true.
666 A boolean to enable/disable color in the output of
667 linkgit:git-branch[1]. May be set to `always`,
668 `false` (or `never`) or `auto` (or `true`), in which case colors are used
669 only when the output is to a terminal. Defaults to false.
671 color.branch.<slot>::
672 Use customized color for branch coloration. `<slot>` is one of
673 `current` (the current branch), `local` (a local branch),
674 `remote` (a tracking branch in refs/remotes/), `plain` (other
677 The value for these configuration variables is a list of colors (at most
678 two) and attributes (at most one), separated by spaces. The colors
679 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
680 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
681 `blink` and `reverse`. The first color given is the foreground; the
682 second is the background. The position of the attribute, if any,
686 When set to `always`, always use colors in patch.
687 When false (or `never`), never. When set to `true` or `auto`, use
688 colors only when the output is to the terminal. Defaults to false.
691 Use customized color for diff colorization. `<slot>` specifies
692 which part of the patch to use the specified color, and is one
693 of `plain` (context text), `meta` (metainformation), `frag`
694 (hunk header), 'func' (function in hunk header), `old` (removed lines),
695 `new` (added lines), `commit` (commit headers), or `whitespace`
696 (highlighting whitespace errors). The values of these variables may be
697 specified as in color.branch.<slot>.
699 color.decorate.<slot>::
700 Use customized color for 'git log --decorate' output. `<slot>` is one
701 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
702 branches, remote tracking branches, tags, stash and HEAD, respectively.
705 When set to `always`, always highlight matches. When `false` (or
706 `never`), never. When set to `true` or `auto`, use color only
707 when the output is written to the terminal. Defaults to `false`.
710 Use customized color for grep colorization. `<slot>` specifies which
711 part of the line to use the specified color, and is one of
715 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
717 filename prefix (when not using `-h`)
719 function name lines (when using `-p`)
721 line number prefix (when using `-n`)
725 non-matching text in selected lines
727 separators between fields on a line (`:`, `-`, and `=`)
728 and between hunks (`--`)
731 The values of these variables may be specified as in color.branch.<slot>.
734 When set to `always`, always use colors for interactive prompts
735 and displays (such as those used by "git-add --interactive").
736 When false (or `never`), never. When set to `true` or `auto`, use
737 colors only when the output is to the terminal. Defaults to false.
739 color.interactive.<slot>::
740 Use customized color for 'git add --interactive'
741 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
742 four distinct types of normal output from interactive
743 commands. The values of these variables may be specified as
744 in color.branch.<slot>.
747 A boolean to enable/disable colored output when the pager is in
748 use (default is true).
751 A boolean to enable/disable color in the output of
752 linkgit:git-show-branch[1]. May be set to `always`,
753 `false` (or `never`) or `auto` (or `true`), in which case colors are used
754 only when the output is to a terminal. Defaults to false.
757 A boolean to enable/disable color in the output of
758 linkgit:git-status[1]. May be set to `always`,
759 `false` (or `never`) or `auto` (or `true`), in which case colors are used
760 only when the output is to a terminal. Defaults to false.
762 color.status.<slot>::
763 Use customized color for status colorization. `<slot>` is
764 one of `header` (the header text of the status message),
765 `added` or `updated` (files which are added but not committed),
766 `changed` (files which are changed but not added in the index),
767 `untracked` (files which are not tracked by git), or
768 `nobranch` (the color the 'no branch' warning is shown in, defaulting
769 to red). The values of these variables may be specified as in
773 When set to `always`, always use colors in all git commands which
774 are capable of colored output. When false (or `never`), never. When
775 set to `true` or `auto`, use colors only when the output is to the
776 terminal. When more specific variables of color.* are set, they always
777 take precedence over this setting. Defaults to false.
780 A boolean to enable/disable inclusion of status information in the
781 commit message template when using an editor to prepare the commit
782 message. Defaults to true.
785 Specify a file to use as the template for new commit messages.
786 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
787 specified user's home directory.
789 diff.autorefreshindex::
790 When using 'git diff' to compare with work tree
791 files, do not consider stat-only change as changed.
792 Instead, silently run `git update-index --refresh` to
793 update the cached stat information for paths whose
794 contents in the work tree match the contents in the
795 index. This option defaults to true. Note that this
796 affects only 'git diff' Porcelain, and not lower level
797 'diff' commands such as 'git diff-files'.
800 If this config variable is set, diff generation is not
801 performed using the internal diff machinery, but using the
802 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
803 environment variable. The command is called with parameters
804 as described under "git Diffs" in linkgit:git[1]. Note: if
805 you want to use an external diff program only on a subset of
806 your files, you might want to use linkgit:gitattributes[5] instead.
808 diff.mnemonicprefix::
809 If set, 'git diff' uses a prefix pair that is different from the
810 standard "a/" and "b/" depending on what is being compared. When
811 this configuration is in effect, reverse diff output also swaps
812 the order of the prefixes:
814 If set, 'git diff' does not show any source or destination prefix.
816 compares the (i)ndex and the (w)ork tree;
818 compares a (c)ommit and the (w)ork tree;
819 `git diff --cached`;;
820 compares a (c)ommit and the (i)ndex;
821 `git diff HEAD:file1 file2`;;
822 compares an (o)bject and a (w)ork tree entity;
823 `git diff --no-index a b`;;
824 compares two non-git things (1) and (2).
827 The number of files to consider when performing the copy/rename
828 detection; equivalent to the 'git diff' option '-l'.
831 Tells git to detect renames. If set to any boolean value, it
832 will enable basic rename detection. If set to "copies" or
833 "copy", it will detect copies, as well.
835 diff.suppressBlankEmpty::
836 A boolean to inhibit the standard behavior of printing a space
837 before each empty output line. Defaults to false.
840 Controls which diff tool is used. `diff.tool` overrides
841 `merge.tool` when used by linkgit:git-difftool[1] and has
842 the same valid values as `merge.tool` minus "tortoisemerge"
845 difftool.<tool>.path::
846 Override the path for the given tool. This is useful in case
847 your tool is not in the PATH.
849 difftool.<tool>.cmd::
850 Specify the command to invoke the specified diff tool.
851 The specified command is evaluated in shell with the following
852 variables available: 'LOCAL' is set to the name of the temporary
853 file containing the contents of the diff pre-image and 'REMOTE'
854 is set to the name of the temporary file containing the contents
855 of the diff post-image.
858 Prompt before each invocation of the diff tool.
861 A POSIX Extended Regular Expression used to determine what is a "word"
862 when performing word-by-word difference calculations. Character
863 sequences that match the regular expression are "words", all other
864 characters are *ignorable* whitespace.
867 If the number of objects fetched over the git native
868 transfer is below this
869 limit, then the objects will be unpacked into loose object
870 files. However if the number of received objects equals or
871 exceeds this limit then the received pack will be stored as
872 a pack, after adding any missing delta bases. Storing the
873 pack from a push can make the push operation complete faster,
874 especially on slow filesystems. If not set, the value of
875 `transfer.unpackLimit` is used instead.
878 Enable multipart/mixed attachments as the default for
879 'format-patch'. The value can also be a double quoted string
880 which will enable attachments as the default and set the
881 value as the boundary. See the --attach option in
882 linkgit:git-format-patch[1].
885 A boolean which can enable or disable sequence numbers in patch
886 subjects. It defaults to "auto" which enables it only if there
887 is more than one patch. It can be enabled or disabled for all
888 messages by setting it to "true" or "false". See --numbered
889 option in linkgit:git-format-patch[1].
892 Additional email headers to include in a patch to be submitted
893 by mail. See linkgit:git-format-patch[1].
896 Additional "Cc:" headers to include in a patch to be submitted
897 by mail. See the --cc option in linkgit:git-format-patch[1].
899 format.subjectprefix::
900 The default for format-patch is to output files with the '[PATCH]'
901 subject prefix. Use this variable to change that prefix.
904 The default for format-patch is to output a signature containing
905 the git version number. Use this variable to change that default.
906 Set this variable to the empty string ("") to suppress
907 signature generation.
910 The default for format-patch is to output files with the suffix
911 `.patch`. Use this variable to change that suffix (make sure to
912 include the dot if you want it).
915 The default pretty format for log/show/whatchanged command,
916 See linkgit:git-log[1], linkgit:git-show[1],
917 linkgit:git-whatchanged[1].
920 The default threading style for 'git format-patch'. Can be
921 a boolean value, or `shallow` or `deep`. `shallow` threading
922 makes every mail a reply to the head of the series,
923 where the head is chosen from the cover letter, the
924 `\--in-reply-to`, and the first patch mail, in this order.
925 `deep` threading makes every mail a reply to the previous one.
926 A true boolean value is the same as `shallow`, and a false
927 value disables threading.
930 A boolean value which lets you enable the `-s/--signoff` option of
931 format-patch by default. *Note:* Adding the Signed-off-by: line to a
932 patch should be a conscious act and means that you certify you have
933 the rights to submit this work under the same open source license.
934 Please see the 'SubmittingPatches' document for further discussion.
936 gc.aggressiveWindow::
937 The window size parameter used in the delta compression
938 algorithm used by 'git gc --aggressive'. This defaults
942 When there are approximately more than this many loose
943 objects in the repository, `git gc --auto` will pack them.
944 Some Porcelain commands use this command to perform a
945 light-weight garbage collection from time to time. The
946 default value is 6700. Setting this to 0 disables it.
949 When there are more than this many packs that are not
950 marked with `*.keep` file in the repository, `git gc
951 --auto` consolidates them into one larger pack. The
952 default value is 50. Setting this to 0 disables it.
955 Running `git pack-refs` in a repository renders it
956 unclonable by Git versions prior to 1.5.1.2 over dumb
957 transports such as HTTP. This variable determines whether
958 'git gc' runs `git pack-refs`. This can be set to `nobare`
959 to enable it within all non-bare repos or it can be set to a
960 boolean value. The default is `true`.
963 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
964 Override the grace period with this config variable. The value
965 "now" may be used to disable this grace period and always prune
966 unreachable objects immediately.
969 gc.<pattern>.reflogexpire::
970 'git reflog expire' removes reflog entries older than
971 this time; defaults to 90 days. With "<pattern>" (e.g.
972 "refs/stash") in the middle the setting applies only to
973 the refs that match the <pattern>.
975 gc.reflogexpireunreachable::
976 gc.<ref>.reflogexpireunreachable::
977 'git reflog expire' removes reflog entries older than
978 this time and are not reachable from the current tip;
979 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
980 in the middle, the setting applies only to the refs that
984 Records of conflicted merge you resolved earlier are
985 kept for this many days when 'git rerere gc' is run.
986 The default is 60 days. See linkgit:git-rerere[1].
988 gc.rerereunresolved::
989 Records of conflicted merge you have not resolved are
990 kept for this many days when 'git rerere gc' is run.
991 The default is 15 days. See linkgit:git-rerere[1].
993 gitcvs.commitmsgannotation::
994 Append this string to each commit message. Set to empty string
995 to disable this feature. Defaults to "via git-CVS emulator".
998 Whether the CVS server interface is enabled for this repository.
999 See linkgit:git-cvsserver[1].
1002 Path to a log file where the CVS server interface well... logs
1003 various stuff. See linkgit:git-cvsserver[1].
1005 gitcvs.usecrlfattr::
1006 If true, the server will look up the end-of-line conversion
1007 attributes for files to determine the '-k' modes to use. If
1008 the attributes force git to treat a file as text,
1009 the '-k' mode will be left blank so cvs clients will
1010 treat it as text. If they suppress text conversion, the file
1011 will be set with '-kb' mode, which suppresses any newline munging
1012 the client might otherwise do. If the attributes do not allow
1013 the file type to be determined, then 'gitcvs.allbinary' is
1014 used. See linkgit:gitattributes[5].
1017 This is used if 'gitcvs.usecrlfattr' does not resolve
1018 the correct '-kb' mode to use. If true, all
1019 unresolved files are sent to the client in
1020 mode '-kb'. This causes the client to treat them
1021 as binary files, which suppresses any newline munging it
1022 otherwise might do. Alternatively, if it is set to "guess",
1023 then the contents of the file are examined to decide if
1024 it is binary, similar to 'core.autocrlf'.
1027 Database used by git-cvsserver to cache revision information
1028 derived from the git repository. The exact meaning depends on the
1029 used database driver, for SQLite (which is the default driver) this
1030 is a filename. Supports variable substitution (see
1031 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1032 Default: '%Ggitcvs.%m.sqlite'
1035 Used Perl DBI driver. You can specify any available driver
1036 for this here, but it might not work. git-cvsserver is tested
1037 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1038 reported *not* to work with 'DBD::mysql'. Experimental feature.
1039 May not contain double colons (`:`). Default: 'SQLite'.
1040 See linkgit:git-cvsserver[1].
1042 gitcvs.dbuser, gitcvs.dbpass::
1043 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1044 since SQLite has no concept of database users and/or passwords.
1045 'gitcvs.dbuser' supports variable substitution (see
1046 linkgit:git-cvsserver[1] for details).
1048 gitcvs.dbTableNamePrefix::
1049 Database table name prefix. Prepended to the names of any
1050 database tables used, allowing a single database to be used
1051 for several repositories. Supports variable substitution (see
1052 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1053 characters will be replaced with underscores.
1055 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1056 'gitcvs.allbinary' can also be specified as
1057 'gitcvs.<access_method>.<varname>' (where 'access_method'
1058 is one of "ext" and "pserver") to make them apply only for the given
1061 gui.commitmsgwidth::
1062 Defines how wide the commit message window is in the
1063 linkgit:git-gui[1]. "75" is the default.
1066 Specifies how many context lines should be used in calls to diff
1067 made by the linkgit:git-gui[1]. The default is "5".
1070 Specifies the default encoding to use for displaying of
1071 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1072 It can be overridden by setting the 'encoding' attribute
1073 for relevant files (see linkgit:gitattributes[5]).
1074 If this option is not set, the tools default to the
1077 gui.matchtrackingbranch::
1078 Determines if new branches created with linkgit:git-gui[1] should
1079 default to tracking remote branches with matching names or
1080 not. Default: "false".
1082 gui.newbranchtemplate::
1083 Is used as suggested name when creating new branches using the
1086 gui.pruneduringfetch::
1087 "true" if linkgit:git-gui[1] should prune tracking branches when
1088 performing a fetch. The default value is "false".
1091 Determines if linkgit:git-gui[1] should trust the file modification
1092 timestamp or not. By default the timestamps are not trusted.
1094 gui.spellingdictionary::
1095 Specifies the dictionary used for spell checking commit messages in
1096 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1100 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1101 location detection. It makes blame significantly faster on huge
1102 repositories at the expense of less thorough copy detection.
1104 gui.copyblamethreshold::
1105 Specifies the threshold to use in 'git gui blame' original location
1106 detection, measured in alphanumeric characters. See the
1107 linkgit:git-blame[1] manual for more information on copy detection.
1109 gui.blamehistoryctx::
1110 Specifies the radius of history context in days to show in
1111 linkgit:gitk[1] for the selected commit, when the `Show History
1112 Context` menu item is invoked from 'git gui blame'. If this
1113 variable is set to zero, the whole history is shown.
1115 guitool.<name>.cmd::
1116 Specifies the shell command line to execute when the corresponding item
1117 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1118 mandatory for every tool. The command is executed from the root of
1119 the working directory, and in the environment it receives the name of
1120 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1121 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1122 the head is detached, 'CUR_BRANCH' is empty).
1124 guitool.<name>.needsfile::
1125 Run the tool only if a diff is selected in the GUI. It guarantees
1126 that 'FILENAME' is not empty.
1128 guitool.<name>.noconsole::
1129 Run the command silently, without creating a window to display its
1132 guitool.<name>.norescan::
1133 Don't rescan the working directory for changes after the tool
1136 guitool.<name>.confirm::
1137 Show a confirmation dialog before actually running the tool.
1139 guitool.<name>.argprompt::
1140 Request a string argument from the user, and pass it to the tool
1141 through the 'ARGS' environment variable. Since requesting an
1142 argument implies confirmation, the 'confirm' option has no effect
1143 if this is enabled. If the option is set to 'true', 'yes', or '1',
1144 the dialog uses a built-in generic prompt; otherwise the exact
1145 value of the variable is used.
1147 guitool.<name>.revprompt::
1148 Request a single valid revision from the user, and set the
1149 'REVISION' environment variable. In other aspects this option
1150 is similar to 'argprompt', and can be used together with it.
1152 guitool.<name>.revunmerged::
1153 Show only unmerged branches in the 'revprompt' subdialog.
1154 This is useful for tools similar to merge or rebase, but not
1155 for things like checkout or reset.
1157 guitool.<name>.title::
1158 Specifies the title to use for the prompt dialog. The default
1161 guitool.<name>.prompt::
1162 Specifies the general prompt string to display at the top of
1163 the dialog, before subsections for 'argprompt' and 'revprompt'.
1164 The default value includes the actual command.
1167 Specify the browser that will be used to display help in the
1168 'web' format. See linkgit:git-help[1].
1171 Override the default help format used by linkgit:git-help[1].
1172 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1173 the default. 'web' and 'html' are the same.
1176 Automatically correct and execute mistyped commands after
1177 waiting for the given number of deciseconds (0.1 sec). If more
1178 than one command can be deduced from the entered text, nothing
1179 will be executed. If the value of this option is negative,
1180 the corrected command will be executed immediately. If the
1181 value is 0 - the command will be just shown but not executed.
1182 This is the default.
1185 Override the HTTP proxy, normally configured using the 'http_proxy'
1186 environment variable (see linkgit:curl[1]). This can be overridden
1187 on a per-remote basis; see remote.<name>.proxy
1190 Whether to verify the SSL certificate when fetching or pushing
1191 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1195 File containing the SSL certificate when fetching or pushing
1196 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1200 File containing the SSL private key when fetching or pushing
1201 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1204 http.sslCertPasswordProtected::
1205 Enable git's password prompt for the SSL certificate. Otherwise
1206 OpenSSL will prompt the user, possibly many times, if the
1207 certificate or private key is encrypted. Can be overridden by the
1208 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1211 File containing the certificates to verify the peer with when
1212 fetching or pushing over HTTPS. Can be overridden by the
1213 'GIT_SSL_CAINFO' environment variable.
1216 Path containing files with the CA certificates to verify the peer
1217 with when fetching or pushing over HTTPS. Can be overridden
1218 by the 'GIT_SSL_CAPATH' environment variable.
1221 How many HTTP requests to launch in parallel. Can be overridden
1222 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1225 The number of curl sessions (counted across slots) to be kept across
1226 requests. They will not be ended with curl_easy_cleanup() until
1227 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1228 value will be capped at 1. Defaults to 1.
1231 Maximum size in bytes of the buffer used by smart HTTP
1232 transports when POSTing data to the remote system.
1233 For requests larger than this buffer size, HTTP/1.1 and
1234 Transfer-Encoding: chunked is used to avoid creating a
1235 massive pack file locally. Default is 1 MiB, which is
1236 sufficient for most requests.
1238 http.lowSpeedLimit, http.lowSpeedTime::
1239 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1240 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1241 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1242 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1245 A boolean which disables using of EPSV ftp command by curl.
1246 This can helpful with some "poor" ftp servers which don't
1247 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1248 environment variable. Default is false (curl will use EPSV).
1250 i18n.commitEncoding::
1251 Character encoding the commit messages are stored in; git itself
1252 does not care per se, but this information is necessary e.g. when
1253 importing commits from emails or in the gitk graphical history
1254 browser (and possibly at other places in the future or in other
1255 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1257 i18n.logOutputEncoding::
1258 Character encoding the commit messages are converted to when
1259 running 'git log' and friends.
1262 The configuration variables in the 'imap' section are described
1263 in linkgit:git-imap-send[1].
1266 Specify the directory from which templates will be copied.
1267 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1270 Specify the program that will be used to browse your working
1271 repository in gitweb. See linkgit:git-instaweb[1].
1274 The HTTP daemon command-line to start gitweb on your working
1275 repository. See linkgit:git-instaweb[1].
1278 If true the web server started by linkgit:git-instaweb[1] will
1279 be bound to the local IP (127.0.0.1).
1281 instaweb.modulepath::
1282 The module path for an apache httpd used by linkgit:git-instaweb[1].
1285 The port number to bind the gitweb httpd to. See
1286 linkgit:git-instaweb[1].
1288 interactive.singlekey::
1289 In interactive commands, allow the user to provide one-letter
1290 input with a single key (i.e., without hitting enter).
1291 Currently this is used only by the `\--patch` mode of
1292 linkgit:git-add[1]. Note that this setting is silently
1293 ignored if portable keystroke input is not available.
1296 Set default date-time mode for the log command. Setting log.date
1297 value is similar to using 'git log'\'s --date option. The value is one of the
1298 following alternatives: {relative,local,default,iso,rfc,short}.
1299 See linkgit:git-log[1].
1302 Print out the ref names of any commits that are shown by the log
1303 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1304 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1305 specified, the full ref name (including prefix) will be printed.
1306 This is the same as the log commands '--decorate' option.
1309 If true, the initial commit will be shown as a big creation event.
1310 This is equivalent to a diff against an empty tree.
1311 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1312 normally hide the root commit will now show it. True by default.
1315 The location of an augmenting mailmap file. The default
1316 mailmap, located in the root of the repository, is loaded
1317 first, then the mailmap file pointed to by this variable.
1318 The location of the mailmap file may be in a repository
1319 subdirectory, or somewhere outside of the repository itself.
1320 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1323 Specify the programs that may be used to display help in the
1324 'man' format. See linkgit:git-help[1].
1327 Specify the command to invoke the specified man viewer. The
1328 specified command is evaluated in shell with the man page
1329 passed as argument. (See linkgit:git-help[1].)
1332 Override the path for the given tool that may be used to
1333 display help in the 'man' format. See linkgit:git-help[1].
1335 include::merge-config.txt[]
1337 mergetool.<tool>.path::
1338 Override the path for the given tool. This is useful in case
1339 your tool is not in the PATH.
1341 mergetool.<tool>.cmd::
1342 Specify the command to invoke the specified merge tool. The
1343 specified command is evaluated in shell with the following
1344 variables available: 'BASE' is the name of a temporary file
1345 containing the common base of the files to be merged, if available;
1346 'LOCAL' is the name of a temporary file containing the contents of
1347 the file on the current branch; 'REMOTE' is the name of a temporary
1348 file containing the contents of the file from the branch being
1349 merged; 'MERGED' contains the name of the file to which the merge
1350 tool should write the results of a successful merge.
1352 mergetool.<tool>.trustExitCode::
1353 For a custom merge command, specify whether the exit code of
1354 the merge command can be used to determine whether the merge was
1355 successful. If this is not set to true then the merge target file
1356 timestamp is checked and the merge assumed to have been successful
1357 if the file has been updated, otherwise the user is prompted to
1358 indicate the success of the merge.
1360 mergetool.keepBackup::
1361 After performing a merge, the original file with conflict markers
1362 can be saved as a file with a `.orig` extension. If this variable
1363 is set to `false` then this file is not preserved. Defaults to
1364 `true` (i.e. keep the backup files).
1366 mergetool.keepTemporaries::
1367 When invoking a custom merge tool, git uses a set of temporary
1368 files to pass to the tool. If the tool returns an error and this
1369 variable is set to `true`, then these temporary files will be
1370 preserved, otherwise they will be removed after the tool has
1371 exited. Defaults to `false`.
1374 Prompt before each invocation of the merge resolution program.
1377 The (fully qualified) refname from which to show notes when
1378 showing commit messages. The value of this variable can be set
1379 to a glob, in which case notes from all matching refs will be
1380 shown. You may also specify this configuration variable
1381 several times. A warning will be issued for refs that do not
1382 exist, but a glob that does not match any refs is silently
1385 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1386 environment variable, which must be a colon separated list of refs or
1389 The effective value of "core.notesRef" (possibly overridden by
1390 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1393 notes.rewrite.<command>::
1394 When rewriting commits with <command> (currently `amend` or
1395 `rebase`) and this variable is set to `true`, git
1396 automatically copies your notes from the original to the
1397 rewritten commit. Defaults to `true`, but see
1398 "notes.rewriteRef" below.
1401 When copying notes during a rewrite (see the
1402 "notes.rewrite.<command>" option), determines what to do if
1403 the target commit already has a note. Must be one of
1404 `overwrite`, `concatenate`, or `ignore`. Defaults to
1407 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1408 environment variable.
1411 When copying notes during a rewrite, specifies the (fully
1412 qualified) ref whose notes should be copied. The ref may be a
1413 glob, in which case notes in all matching refs will be copied.
1414 You may also specify this configuration several times.
1416 Does not have a default value; you must configure this variable to
1417 enable note rewriting.
1419 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1420 environment variable, which must be a colon separated list of refs or
1424 The size of the window used by linkgit:git-pack-objects[1] when no
1425 window size is given on the command line. Defaults to 10.
1428 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1429 maximum depth is given on the command line. Defaults to 50.
1432 The window memory size limit used by linkgit:git-pack-objects[1]
1433 when no limit is given on the command line. The value can be
1434 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1438 An integer -1..9, indicating the compression level for objects
1439 in a pack file. -1 is the zlib default. 0 means no
1440 compression, and 1..9 are various speed/size tradeoffs, 9 being
1441 slowest. If not set, defaults to core.compression. If that is
1442 not set, defaults to -1, the zlib default, which is "a default
1443 compromise between speed and compression (currently equivalent
1446 pack.deltaCacheSize::
1447 The maximum memory in bytes used for caching deltas in
1448 linkgit:git-pack-objects[1] before writing them out to a pack.
1449 This cache is used to speed up the writing object phase by not
1450 having to recompute the final delta result once the best match
1451 for all objects is found. Repacking large repositories on machines
1452 which are tight with memory might be badly impacted by this though,
1453 especially if this cache pushes the system into swapping.
1454 A value of 0 means no limit. The smallest size of 1 byte may be
1455 used to virtually disable this cache. Defaults to 256 MiB.
1457 pack.deltaCacheLimit::
1458 The maximum size of a delta, that is cached in
1459 linkgit:git-pack-objects[1]. This cache is used to speed up the
1460 writing object phase by not having to recompute the final delta
1461 result once the best match for all objects is found. Defaults to 1000.
1464 Specifies the number of threads to spawn when searching for best
1465 delta matches. This requires that linkgit:git-pack-objects[1]
1466 be compiled with pthreads otherwise this option is ignored with a
1467 warning. This is meant to reduce packing time on multiprocessor
1468 machines. The required amount of memory for the delta search window
1469 is however multiplied by the number of threads.
1470 Specifying 0 will cause git to auto-detect the number of CPU's
1471 and set the number of threads accordingly.
1474 Specify the default pack index version. Valid values are 1 for
1475 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1476 the new pack index with capabilities for packs larger than 4 GB
1477 as well as proper protection against the repacking of corrupted
1478 packs. Version 2 is the default. Note that version 2 is enforced
1479 and this config option ignored whenever the corresponding pack is
1482 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1483 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1484 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1485 other side may give you a repository that cannot be accessed with your
1486 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1487 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1488 the `{asterisk}.idx` file.
1490 pack.packSizeLimit::
1491 The maximum size of a pack. This setting only affects
1492 packing to a file when repacking, i.e. the git:// protocol
1493 is unaffected. It can be overridden by the `\--max-pack-size`
1494 option of linkgit:git-repack[1]. The minimum size allowed is
1495 limited to 1 MiB. The default is unlimited.
1496 Common unit suffixes of 'k', 'm', or 'g' are
1500 Allows turning on or off pagination of the output of a
1501 particular git subcommand when writing to a tty. If
1502 `\--paginate` or `\--no-pager` is specified on the command line,
1503 it takes precedence over this option. To disable pagination for
1504 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1507 Alias for a --pretty= format string, as specified in
1508 linkgit:git-log[1]. Any aliases defined here can be used just
1509 as the built-in pretty formats could. For example,
1510 running `git config pretty.changelog "format:{asterisk} %H %s"`
1511 would cause the invocation `git log --pretty=changelog`
1512 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1513 Note that an alias with the same name as a built-in format
1514 will be silently ignored.
1517 The default merge strategy to use when pulling multiple branches
1521 The default merge strategy to use when pulling a single branch.
1524 Defines the action git push should take if no refspec is given
1525 on the command line, no refspec is configured in the remote, and
1526 no refspec is implied by any of the options given on the command
1527 line. Possible values are:
1529 * `nothing` do not push anything.
1530 * `matching` push all matching branches.
1531 All branches having the same name in both ends are considered to be
1532 matching. This is the default.
1533 * `tracking` push the current branch to its upstream branch.
1534 * `current` push the current branch to a branch of the same name.
1537 Whether to show a diffstat of what changed upstream since the last
1538 rebase. False by default.
1541 By default, git-receive-pack will run "git-gc --auto" after
1542 receiving data from git-push and updating refs. You can stop
1543 it by setting this variable to false.
1545 receive.fsckObjects::
1546 If it is set to true, git-receive-pack will check all received
1547 objects. It will abort in the case of a malformed object or a
1548 broken link. The result of an abort are only dangling objects.
1551 receive.unpackLimit::
1552 If the number of objects received in a push is below this
1553 limit then the objects will be unpacked into loose object
1554 files. However if the number of received objects equals or
1555 exceeds this limit then the received pack will be stored as
1556 a pack, after adding any missing delta bases. Storing the
1557 pack from a push can make the push operation complete faster,
1558 especially on slow filesystems. If not set, the value of
1559 `transfer.unpackLimit` is used instead.
1561 receive.denyDeletes::
1562 If set to true, git-receive-pack will deny a ref update that deletes
1563 the ref. Use this to prevent such a ref deletion via a push.
1565 receive.denyCurrentBranch::
1566 If set to true or "refuse", git-receive-pack will deny a ref update
1567 to the currently checked out branch of a non-bare repository.
1568 Such a push is potentially dangerous because it brings the HEAD
1569 out of sync with the index and working tree. If set to "warn",
1570 print a warning of such a push to stderr, but allow the push to
1571 proceed. If set to false or "ignore", allow such pushes with no
1572 message. Defaults to "refuse".
1574 receive.denyNonFastForwards::
1575 If set to true, git-receive-pack will deny a ref update which is
1576 not a fast-forward. Use this to prevent such an update via a push,
1577 even if that push is forced. This configuration variable is
1578 set when initializing a shared repository.
1580 receive.updateserverinfo::
1581 If set to true, git-receive-pack will run git-update-server-info
1582 after receiving data from git-push and updating refs.
1585 The URL of a remote repository. See linkgit:git-fetch[1] or
1586 linkgit:git-push[1].
1588 remote.<name>.pushurl::
1589 The push URL of a remote repository. See linkgit:git-push[1].
1591 remote.<name>.proxy::
1592 For remotes that require curl (http, https and ftp), the URL to
1593 the proxy to use for that remote. Set to the empty string to
1594 disable proxying for that remote.
1596 remote.<name>.fetch::
1597 The default set of "refspec" for linkgit:git-fetch[1]. See
1598 linkgit:git-fetch[1].
1600 remote.<name>.push::
1601 The default set of "refspec" for linkgit:git-push[1]. See
1602 linkgit:git-push[1].
1604 remote.<name>.mirror::
1605 If true, pushing to this remote will automatically behave
1606 as if the `\--mirror` option was given on the command line.
1608 remote.<name>.skipDefaultUpdate::
1609 If true, this remote will be skipped by default when updating
1610 using linkgit:git-fetch[1] or the `update` subcommand of
1611 linkgit:git-remote[1].
1613 remote.<name>.skipFetchAll::
1614 If true, this remote will be skipped by default when updating
1615 using linkgit:git-fetch[1] or the `update` subcommand of
1616 linkgit:git-remote[1].
1618 remote.<name>.receivepack::
1619 The default program to execute on the remote side when pushing. See
1620 option \--receive-pack of linkgit:git-push[1].
1622 remote.<name>.uploadpack::
1623 The default program to execute on the remote side when fetching. See
1624 option \--upload-pack of linkgit:git-fetch-pack[1].
1626 remote.<name>.tagopt::
1627 Setting this value to \--no-tags disables automatic tag following when
1628 fetching from remote <name>. Setting it to \--tags will fetch every
1629 tag from remote <name>, even if they are not reachable from remote
1633 Setting this to a value <vcs> will cause git to interact with
1634 the remote with the git-remote-<vcs> helper.
1637 The list of remotes which are fetched by "git remote update
1638 <group>". See linkgit:git-remote[1].
1640 repack.usedeltabaseoffset::
1641 By default, linkgit:git-repack[1] creates packs that use
1642 delta-base offset. If you need to share your repository with
1643 git older than version 1.4.4, either directly or via a dumb
1644 protocol such as http, then you need to set this option to
1645 "false" and repack. Access from old git versions over the
1646 native protocol are unaffected by this option.
1649 When set to true, `git-rerere` updates the index with the
1650 resulting contents after it cleanly resolves conflicts using
1651 previously recorded resolution. Defaults to false.
1654 Activate recording of resolved conflicts, so that identical
1655 conflict hunks can be resolved automatically, should they
1656 be encountered again. linkgit:git-rerere[1] command is by
1657 default enabled if you create `rr-cache` directory under
1658 `$GIT_DIR`, but can be disabled by setting this option to false.
1660 sendemail.identity::
1661 A configuration identity. When given, causes values in the
1662 'sendemail.<identity>' subsection to take precedence over
1663 values in the 'sendemail' section. The default identity is
1664 the value of 'sendemail.identity'.
1666 sendemail.smtpencryption::
1667 See linkgit:git-send-email[1] for description. Note that this
1668 setting is not subject to the 'identity' mechanism.
1671 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1673 sendemail.<identity>.*::
1674 Identity-specific versions of the 'sendemail.*' parameters
1675 found below, taking precedence over those when the this
1676 identity is selected, through command-line or
1677 'sendemail.identity'.
1679 sendemail.aliasesfile::
1680 sendemail.aliasfiletype::
1684 sendemail.chainreplyto::
1686 sendemail.envelopesender::
1688 sendemail.multiedit::
1689 sendemail.signedoffbycc::
1690 sendemail.smtppass::
1691 sendemail.suppresscc::
1692 sendemail.suppressfrom::
1694 sendemail.smtpdomain::
1695 sendemail.smtpserver::
1696 sendemail.smtpserverport::
1697 sendemail.smtpuser::
1699 sendemail.validate::
1700 See linkgit:git-send-email[1] for description.
1702 sendemail.signedoffcc::
1703 Deprecated alias for 'sendemail.signedoffbycc'.
1705 showbranch.default::
1706 The default set of branches for linkgit:git-show-branch[1].
1707 See linkgit:git-show-branch[1].
1709 status.relativePaths::
1710 By default, linkgit:git-status[1] shows paths relative to the
1711 current directory. Setting this variable to `false` shows paths
1712 relative to the repository root (this was the default for git
1715 status.showUntrackedFiles::
1716 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1717 files which are not currently tracked by Git. Directories which
1718 contain only untracked files, are shown with the directory name
1719 only. Showing untracked files means that Git needs to lstat() all
1720 all the files in the whole repository, which might be slow on some
1721 systems. So, this variable controls how the commands displays
1722 the untracked files. Possible values are:
1725 - 'no' - Show no untracked files
1726 - 'normal' - Shows untracked files and directories
1727 - 'all' - Shows also individual files in untracked directories.
1730 If this variable is not specified, it defaults to 'normal'.
1731 This variable can be overridden with the -u|--untracked-files option
1732 of linkgit:git-status[1] and linkgit:git-commit[1].
1734 status.submodulesummary::
1736 If this is set to a non zero number or true (identical to -1 or an
1737 unlimited number), the submodule summary will be enabled and a
1738 summary of commits for modified submodules will be shown (see
1739 --summary-limit option of linkgit:git-submodule[1]).
1742 This variable can be used to restrict the permission bits of
1743 tar archive entries. The default is 0002, which turns off the
1744 world write bit. The special value "user" indicates that the
1745 archiving user's umask will be used instead. See umask(2) and
1746 linkgit:git-archive[1].
1748 transfer.unpackLimit::
1749 When `fetch.unpackLimit` or `receive.unpackLimit` are
1750 not set, the value of this variable is used instead.
1751 The default value is 100.
1753 url.<base>.insteadOf::
1754 Any URL that starts with this value will be rewritten to
1755 start, instead, with <base>. In cases where some site serves a
1756 large number of repositories, and serves them with multiple
1757 access methods, and some users need to use different access
1758 methods, this feature allows people to specify any of the
1759 equivalent URLs and have git automatically rewrite the URL to
1760 the best alternative for the particular user, even for a
1761 never-before-seen repository on the site. When more than one
1762 insteadOf strings match a given URL, the longest match is used.
1764 url.<base>.pushInsteadOf::
1765 Any URL that starts with this value will not be pushed to;
1766 instead, it will be rewritten to start with <base>, and the
1767 resulting URL will be pushed to. In cases where some site serves
1768 a large number of repositories, and serves them with multiple
1769 access methods, some of which do not allow push, this feature
1770 allows people to specify a pull-only URL and have git
1771 automatically use an appropriate URL to push, even for a
1772 never-before-seen repository on the site. When more than one
1773 pushInsteadOf strings match a given URL, the longest match is
1774 used. If a remote has an explicit pushurl, git will ignore this
1775 setting for that remote.
1778 Your email address to be recorded in any newly created commits.
1779 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1780 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1783 Your full name to be recorded in any newly created commits.
1784 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1785 environment variables. See linkgit:git-commit-tree[1].
1788 If linkgit:git-tag[1] is not selecting the key you want it to
1789 automatically when creating a signed tag, you can override the
1790 default selection with this variable. This option is passed
1791 unchanged to gpg's --local-user parameter, so you may specify a key
1792 using any method that gpg supports.
1795 Specify a web browser that may be used by some commands.
1796 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]