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.
157 core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
200 If true, makes git convert `CRLF` at the end of lines in text files to
201 `LF` when reading from the work tree, and convert in reverse when
202 writing to the work tree. The variable can be set to
203 'input', in which case the conversion happens only while
204 reading from the work tree but files are written out to the work
205 tree with `LF` at the end of lines. A file is considered
206 "text" (i.e. be subjected to the autocrlf mechanism) based on
207 the file's `crlf` attribute, or if `crlf` is unspecified,
208 based on the file's contents. See linkgit:gitattributes[5].
211 If true, makes git check if converting `CRLF` as controlled by
212 `core.autocrlf` is reversible. Git will verify if a command
213 modifies a file in the work tree either directly or indirectly.
214 For example, committing a file followed by checking out the
215 same file should yield the original file in the work tree. If
216 this is not the case for the current setting of
217 `core.autocrlf`, git will reject the file. The variable can
218 be set to "warn", in which case git will only warn about an
219 irreversible conversion but continue the operation.
221 CRLF conversion bears a slight chance of corrupting data.
222 autocrlf=true will convert CRLF to LF during commit and LF to
223 CRLF during checkout. A file that contains a mixture of LF and
224 CRLF before the commit cannot be recreated by git. For text
225 files this is the right thing to do: it corrects line endings
226 such that we have only LF line endings in the repository.
227 But for binary files that are accidentally classified as text the
228 conversion can corrupt data.
230 If you recognize such corruption early you can easily fix it by
231 setting the conversion type explicitly in .gitattributes. Right
232 after committing you still have the original file in your work
233 tree and this file is not yet corrupted. You can explicitly tell
234 git that this file is binary and git will handle the file
237 Unfortunately, the desired effect of cleaning up text files with
238 mixed line endings and the undesired effect of corrupting binary
239 files cannot be distinguished. In both cases CRLFs are removed
240 in an irreversible way. For text files this is the right thing
241 to do because CRLFs are line endings, while for binary files
242 converting CRLFs corrupts data.
244 Note, this safety check does not mean that a checkout will generate a
245 file identical to the original file for a different setting of
246 `core.autocrlf`, but only for the current one. For example, a text
247 file with `LF` would be accepted with `core.autocrlf=input` and could
248 later be checked out with `core.autocrlf=true`, in which case the
249 resulting file would contain `CRLF`, although the original file
250 contained `LF`. However, in both work trees the line endings would be
251 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
252 file with mixed line endings would be reported by the `core.safecrlf`
256 If false, symbolic links are checked out as small plain files that
257 contain the link text. linkgit:git-update-index[1] and
258 linkgit:git-add[1] will not change the recorded type to regular
259 file. Useful on filesystems like FAT that do not support
262 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
263 will probe and set core.symlinks false if appropriate when the repository
267 A "proxy command" to execute (as 'command host port') instead
268 of establishing direct connection to the remote server when
269 using the git protocol for fetching. If the variable value is
270 in the "COMMAND for DOMAIN" format, the command is applied only
271 on hostnames ending with the specified domain string. This variable
272 may be set multiple times and is matched in the given order;
273 the first match wins.
275 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
276 (which always applies universally, without the special "for"
279 The special string `none` can be used as the proxy command to
280 specify that no proxy be used for a given domain pattern.
281 This is useful for excluding servers inside a firewall from
282 proxy use, while defaulting to a common proxy for external domains.
285 If true, commands which modify both the working tree and the index
286 will mark the updated paths with the "assume unchanged" bit in the
287 index. These marked files are then assumed to stay unchanged in the
288 working copy, until you mark them otherwise manually - Git will not
289 detect the file changes by lstat() calls. This is useful on systems
290 where those are very slow, such as Microsoft Windows.
291 See linkgit:git-update-index[1].
294 core.preferSymlinkRefs::
295 Instead of the default "symref" format for HEAD
296 and other symbolic reference files, use symbolic links.
297 This is sometimes needed to work with old scripts that
298 expect HEAD to be a symbolic link.
301 If true this repository is assumed to be 'bare' and has no
302 working directory associated with it. If this is the case a
303 number of commands that require a working directory will be
304 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
306 This setting is automatically guessed by linkgit:git-clone[1] or
307 linkgit:git-init[1] when the repository was created. By default a
308 repository that ends in "/.git" is assumed to be not bare (bare =
309 false), while all other repositories are assumed to be bare (bare
313 Set the path to the root of the work tree.
314 This can be overridden by the GIT_WORK_TREE environment
315 variable and the '--work-tree' command line option. It can be
316 an absolute path or a relative path to the .git directory,
317 either specified by --git-dir or GIT_DIR, or automatically
319 If --git-dir or GIT_DIR are specified but none of
320 --work-tree, GIT_WORK_TREE and core.worktree is specified,
321 the current working directory is regarded as the root of the
324 Note that this variable is honored even when set in a configuration
325 file in a ".git" subdirectory of a directory, and its value differs
326 from the latter directory (e.g. "/path/to/.git/config" has
327 core.worktree set to "/different/path"), which is most likely a
328 misconfiguration. Running git commands in "/path/to" directory will
329 still use "/different/path" as the root of the work tree and can cause
330 great confusion to the users.
332 core.logAllRefUpdates::
333 Enable the reflog. Updates to a ref <ref> is logged to the file
334 "$GIT_DIR/logs/<ref>", by appending the new and old
335 SHA1, the date/time and the reason of the update, but
336 only when the file exists. If this configuration
337 variable is set to true, missing "$GIT_DIR/logs/<ref>"
338 file is automatically created for branch heads.
340 This information can be used to determine what commit
341 was the tip of a branch "2 days ago".
343 This value is true by default in a repository that has
344 a working directory associated with it, and false by
345 default in a bare repository.
347 core.repositoryFormatVersion::
348 Internal variable identifying the repository format and layout
351 core.sharedRepository::
352 When 'group' (or 'true'), the repository is made shareable between
353 several users in a group (making sure all the files and objects are
354 group-writable). When 'all' (or 'world' or 'everybody'), the
355 repository will be readable by all users, additionally to being
356 group-shareable. When 'umask' (or 'false'), git will use permissions
357 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
358 files in the repository will have this mode value. '0xxx' will override
359 user's umask value (whereas the other options will only override
360 requested parts of the user's umask value). Examples: '0660' will make
361 the repo read/write-able for the owner and group, but inaccessible to
362 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
363 repository that is group-readable but not group-writable.
364 See linkgit:git-init[1]. False by default.
366 core.warnAmbiguousRefs::
367 If true, git will warn you if the ref name you passed it is ambiguous
368 and might match multiple refs in the .git/refs/ tree. True by default.
371 An integer -1..9, indicating a default compression level.
372 -1 is the zlib default. 0 means no compression,
373 and 1..9 are various speed/size tradeoffs, 9 being slowest.
374 If set, this provides a default to other compression variables,
375 such as 'core.loosecompression' and 'pack.compression'.
377 core.loosecompression::
378 An integer -1..9, indicating the compression level for objects that
379 are not in a pack file. -1 is the zlib default. 0 means no
380 compression, and 1..9 are various speed/size tradeoffs, 9 being
381 slowest. If not set, defaults to core.compression. If that is
382 not set, defaults to 1 (best speed).
384 core.packedGitWindowSize::
385 Number of bytes of a pack file to map into memory in a
386 single mapping operation. Larger window sizes may allow
387 your system to process a smaller number of large pack files
388 more quickly. Smaller window sizes will negatively affect
389 performance due to increased calls to the operating system's
390 memory manager, but may improve performance when accessing
391 a large number of large pack files.
393 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
394 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
395 be reasonable for all users/operating systems. You probably do
396 not need to adjust this value.
398 Common unit suffixes of 'k', 'm', or 'g' are supported.
400 core.packedGitLimit::
401 Maximum number of bytes to map simultaneously into memory
402 from pack files. If Git needs to access more than this many
403 bytes at once to complete an operation it will unmap existing
404 regions to reclaim virtual address space within the process.
406 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
407 This should be reasonable for all users/operating systems, except on
408 the largest projects. You probably do not need to adjust this value.
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.deltaBaseCacheLimit::
413 Maximum number of bytes to reserve for caching base objects
414 that multiple deltafied objects reference. By storing the
415 entire decompressed base objects in a cache Git is able
416 to avoid unpacking and decompressing frequently used base
417 objects multiple times.
419 Default is 16 MiB on all platforms. This should be reasonable
420 for all users/operating systems, except on the largest projects.
421 You probably do not need to adjust this value.
423 Common unit suffixes of 'k', 'm', or 'g' are supported.
425 core.bigFileThreshold::
426 Files larger than this size are stored deflated, without
427 attempting delta compression. Storing large files without
428 delta compression avoids excessive memory usage, at the
429 slight expense of increased disk usage.
431 Default is 512 MiB on all platforms. This should be reasonable
432 for most projects as source code and other text files can still
433 be delta compressed, but larger binary media files won't be.
435 Common unit suffixes of 'k', 'm', or 'g' are supported.
437 Currently only linkgit:git-fast-import[1] honors this setting.
440 In addition to '.gitignore' (per-directory) and
441 '.git/info/exclude', git looks into this file for patterns
442 of files which are not meant to be tracked. "{tilde}/" is expanded
443 to the value of `$HOME` and "{tilde}user/" to the specified user's
444 home directory. See linkgit:gitignore[5].
447 Commands such as `commit` and `tag` that lets you edit
448 messages by launching an editor uses the value of this
449 variable when it is set, and the environment variable
450 `GIT_EDITOR` is not set. See linkgit:git-var[1].
453 The command that git will use to paginate output. Can
454 be overridden with the `GIT_PAGER` environment
455 variable. Note that git sets the `LESS` environment
456 variable to `FRSX` if it is unset when it runs the
457 pager. One can change these settings by setting the
458 `LESS` variable to some other value. Alternately,
459 these settings can be overridden on a project or
460 global basis by setting the `core.pager` option.
461 Setting `core.pager` has no affect on the `LESS`
462 environment variable behaviour above, so if you want
463 to override git's default settings this way, you need
464 to be explicit. For example, to disable the S option
465 in a backward compatible manner, set `core.pager`
466 to `less -+$LESS -FRX`. This will be passed to the
467 shell by git, which will translate the final command to
468 `LESS=FRSX less -+FRSX -FRX`.
471 A comma separated list of common whitespace problems to
472 notice. 'git diff' will use `color.diff.whitespace` to
473 highlight them, and 'git apply --whitespace=error' will
474 consider them as errors. You can prefix `-` to disable
475 any of them (e.g. `-trailing-space`):
477 * `blank-at-eol` treats trailing whitespaces at the end of the line
478 as an error (enabled by default).
479 * `space-before-tab` treats a space character that appears immediately
480 before a tab character in the initial indent part of the line as an
481 error (enabled by default).
482 * `indent-with-non-tab` treats a line that is indented with 8 or more
483 space characters as an error (not enabled by default).
484 * `tab-in-indent` treats a tab character in the initial indent part of
485 the line as an error (not enabled by default).
486 * `blank-at-eof` treats blank lines added at the end of file as an error
487 (enabled by default).
488 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
490 * `cr-at-eol` treats a carriage-return at the end of line as
491 part of the line terminator, i.e. with it, `trailing-space`
492 does not trigger if the character before such a carriage-return
493 is not a whitespace (not enabled by default).
495 core.fsyncobjectfiles::
496 This boolean will enable 'fsync()' when writing object files.
498 This is a total waste of time and effort on a filesystem that orders
499 data writes properly, but can be useful for filesystems that do not use
500 journalling (traditional UNIX filesystems) or that only journal metadata
501 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
504 Enable parallel index preload for operations like 'git diff'
506 This can speed up operations like 'git diff' and 'git status' especially
507 on filesystems like NFS that have weak caching semantics and thus
508 relatively high IO latencies. With this set to 'true', git will do the
509 index comparison to the filesystem data in parallel, allowing
513 You can set this to 'link', in which case a hardlink followed by
514 a delete of the source are used to make sure that object creation
515 will not overwrite existing objects.
517 On some file system/operating system combinations, this is unreliable.
518 Set this config setting to 'rename' there; However, This will remove the
519 check that makes sure that existing object files will not get overwritten.
522 When showing commit messages, also show notes which are stored in
523 the given ref. The ref must be fully qualified. If the given
524 ref does not exist, it is not an error but means that no
525 notes should be printed.
527 This setting defaults to "refs/notes/commits", and it can be overridden by
528 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
530 core.sparseCheckout::
531 Enable "sparse checkout" feature. See section "Sparse checkout" in
532 linkgit:git-read-tree[1] for more information.
535 Tells 'git add' to continue adding files when some files cannot be
536 added due to indexing errors. Equivalent to the '--ignore-errors'
537 option of linkgit:git-add[1].
540 Command aliases for the linkgit:git[1] command wrapper - e.g.
541 after defining "alias.last = cat-file commit HEAD", the invocation
542 "git last" is equivalent to "git cat-file commit HEAD". To avoid
543 confusion and troubles with script usage, aliases that
544 hide existing git commands are ignored. Arguments are split by
545 spaces, the usual shell quoting and escaping is supported.
546 quote pair and a backslash can be used to quote them.
548 If the alias expansion is prefixed with an exclamation point,
549 it will be treated as a shell command. For example, defining
550 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
551 "git new" is equivalent to running the shell command
552 "gitk --all --not ORIG_HEAD". Note that shell commands will be
553 executed from the top-level directory of a repository, which may
554 not necessarily be the current directory.
557 If true, git-am will call git-mailsplit for patches in mbox format
558 with parameter '--keep-cr'. In this case git-mailsplit will
559 not remove `\r` from lines ending with `\r\n`. Can be overrriden
560 by giving '--no-keep-cr' from the command line.
561 See linkgit:git-am[1], linkgit:git-mailsplit[1].
563 apply.ignorewhitespace::
564 When set to 'change', tells 'git apply' to ignore changes in
565 whitespace, in the same way as the '--ignore-space-change'
567 When set to one of: no, none, never, false tells 'git apply' to
568 respect all whitespace differences.
569 See linkgit:git-apply[1].
572 Tells 'git apply' how to handle whitespaces, in the same way
573 as the '--whitespace' option. See linkgit:git-apply[1].
575 branch.autosetupmerge::
576 Tells 'git branch' and 'git checkout' to set up new branches
577 so that linkgit:git-pull[1] will appropriately merge from the
578 starting point branch. Note that even if this option is not set,
579 this behavior can be chosen per-branch using the `--track`
580 and `--no-track` options. The valid settings are: `false` -- no
581 automatic setup is done; `true` -- automatic setup is done when the
582 starting point is a remote branch; `always` -- automatic setup is
583 done when the starting point is either a local branch or remote
584 branch. This option defaults to true.
586 branch.autosetuprebase::
587 When a new branch is created with 'git branch' or 'git checkout'
588 that tracks another branch, this variable tells git to set
589 up pull to rebase instead of merge (see "branch.<name>.rebase").
590 When `never`, rebase is never automatically set to true.
591 When `local`, rebase is set to true for tracked branches of
592 other local branches.
593 When `remote`, rebase is set to true for tracked branches of
595 When `always`, rebase will be set to true for all tracking
597 See "branch.autosetupmerge" for details on how to set up a
598 branch to track another branch.
599 This option defaults to never.
601 branch.<name>.remote::
602 When in branch <name>, it tells 'git fetch' and 'git push' which
603 remote to fetch from/push to. It defaults to `origin` if no remote is
604 configured. `origin` is also used if you are not on any branch.
606 branch.<name>.merge::
607 Defines, together with branch.<name>.remote, the upstream branch
608 for the given branch. It tells 'git fetch'/'git pull' which
609 branch to merge and can also affect 'git push' (see push.default).
610 When in branch <name>, it tells 'git fetch' the default
611 refspec to be marked for merging in FETCH_HEAD. The value is
612 handled like the remote part of a refspec, and must match a
613 ref which is fetched from the remote given by
614 "branch.<name>.remote".
615 The merge information is used by 'git pull' (which at first calls
616 'git fetch') to lookup the default branch for merging. Without
617 this option, 'git pull' defaults to merge the first refspec fetched.
618 Specify multiple values to get an octopus merge.
619 If you wish to setup 'git pull' so that it merges into <name> from
620 another branch in the local repository, you can point
621 branch.<name>.merge to the desired branch, and use the special setting
622 `.` (a period) for branch.<name>.remote.
624 branch.<name>.mergeoptions::
625 Sets default options for merging into branch <name>. The syntax and
626 supported options are the same as those of linkgit:git-merge[1], but
627 option values containing whitespace characters are currently not
630 branch.<name>.rebase::
631 When true, rebase the branch <name> on top of the fetched branch,
632 instead of merging the default branch from the default remote when
634 *NOTE*: this is a possibly dangerous operation; do *not* use
635 it unless you understand the implications (see linkgit:git-rebase[1]
639 Specify the command to invoke the specified browser. The
640 specified command is evaluated in shell with the URLs passed
641 as arguments. (See linkgit:git-web--browse[1].)
643 browser.<tool>.path::
644 Override the path for the given tool that may be used to
645 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
646 working repository in gitweb (see linkgit:git-instaweb[1]).
649 A boolean to make git-clean do nothing unless given -f
650 or -n. Defaults to true.
653 A boolean to enable/disable color in the output of
654 linkgit:git-branch[1]. May be set to `always`,
655 `false` (or `never`) or `auto` (or `true`), in which case colors are used
656 only when the output is to a terminal. Defaults to false.
658 color.branch.<slot>::
659 Use customized color for branch coloration. `<slot>` is one of
660 `current` (the current branch), `local` (a local branch),
661 `remote` (a tracking branch in refs/remotes/), `plain` (other
664 The value for these configuration variables is a list of colors (at most
665 two) and attributes (at most one), separated by spaces. The colors
666 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
667 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
668 `blink` and `reverse`. The first color given is the foreground; the
669 second is the background. The position of the attribute, if any,
673 When set to `always`, always use colors in patch.
674 When false (or `never`), never. When set to `true` or `auto`, use
675 colors only when the output is to the terminal. Defaults to false.
678 Use customized color for diff colorization. `<slot>` specifies
679 which part of the patch to use the specified color, and is one
680 of `plain` (context text), `meta` (metainformation), `frag`
681 (hunk header), 'func' (function in hunk header), `old` (removed lines),
682 `new` (added lines), `commit` (commit headers), or `whitespace`
683 (highlighting whitespace errors). The values of these variables may be
684 specified as in color.branch.<slot>.
687 When set to `always`, always highlight matches. When `false` (or
688 `never`), never. When set to `true` or `auto`, use color only
689 when the output is written to the terminal. Defaults to `false`.
692 Use customized color for grep colorization. `<slot>` specifies which
693 part of the line to use the specified color, and is one of
697 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
699 filename prefix (when not using `-h`)
701 function name lines (when using `-p`)
703 line number prefix (when using `-n`)
707 non-matching text in selected lines
709 separators between fields on a line (`:`, `-`, and `=`)
710 and between hunks (`--`)
713 The values of these variables may be specified as in color.branch.<slot>.
716 When set to `always`, always use colors for interactive prompts
717 and displays (such as those used by "git-add --interactive").
718 When false (or `never`), never. When set to `true` or `auto`, use
719 colors only when the output is to the terminal. Defaults to false.
721 color.interactive.<slot>::
722 Use customized color for 'git add --interactive'
723 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
724 four distinct types of normal output from interactive
725 commands. The values of these variables may be specified as
726 in color.branch.<slot>.
729 A boolean to enable/disable colored output when the pager is in
730 use (default is true).
733 A boolean to enable/disable color in the output of
734 linkgit:git-show-branch[1]. May be set to `always`,
735 `false` (or `never`) or `auto` (or `true`), in which case colors are used
736 only when the output is to a terminal. Defaults to false.
739 A boolean to enable/disable color in the output of
740 linkgit:git-status[1]. May be set to `always`,
741 `false` (or `never`) or `auto` (or `true`), in which case colors are used
742 only when the output is to a terminal. Defaults to false.
744 color.status.<slot>::
745 Use customized color for status colorization. `<slot>` is
746 one of `header` (the header text of the status message),
747 `added` or `updated` (files which are added but not committed),
748 `changed` (files which are changed but not added in the index),
749 `untracked` (files which are not tracked by git), or
750 `nobranch` (the color the 'no branch' warning is shown in, defaulting
751 to red). The values of these variables may be specified as in
755 When set to `always`, always use colors in all git commands which
756 are capable of colored output. When false (or `never`), never. When
757 set to `true` or `auto`, use colors only when the output is to the
758 terminal. When more specific variables of color.* are set, they always
759 take precedence over this setting. Defaults to false.
762 A boolean to enable/disable inclusion of status information in the
763 commit message template when using an editor to prepare the commit
764 message. Defaults to true.
767 Specify a file to use as the template for new commit messages.
768 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
769 specified user's home directory.
771 diff.autorefreshindex::
772 When using 'git diff' to compare with work tree
773 files, do not consider stat-only change as changed.
774 Instead, silently run `git update-index --refresh` to
775 update the cached stat information for paths whose
776 contents in the work tree match the contents in the
777 index. This option defaults to true. Note that this
778 affects only 'git diff' Porcelain, and not lower level
779 'diff' commands such as 'git diff-files'.
782 If this config variable is set, diff generation is not
783 performed using the internal diff machinery, but using the
784 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
785 environment variable. The command is called with parameters
786 as described under "git Diffs" in linkgit:git[1]. Note: if
787 you want to use an external diff program only on a subset of
788 your files, you might want to use linkgit:gitattributes[5] instead.
790 diff.mnemonicprefix::
791 If set, 'git diff' uses a prefix pair that is different from the
792 standard "a/" and "b/" depending on what is being compared. When
793 this configuration is in effect, reverse diff output also swaps
794 the order of the prefixes:
796 If set, 'git diff' does not show any source or destination prefix.
798 compares the (i)ndex and the (w)ork tree;
800 compares a (c)ommit and the (w)ork tree;
801 `git diff --cached`;;
802 compares a (c)ommit and the (i)ndex;
803 `git diff HEAD:file1 file2`;;
804 compares an (o)bject and a (w)ork tree entity;
805 `git diff --no-index a b`;;
806 compares two non-git things (1) and (2).
809 The number of files to consider when performing the copy/rename
810 detection; equivalent to the 'git diff' option '-l'.
813 Tells git to detect renames. If set to any boolean value, it
814 will enable basic rename detection. If set to "copies" or
815 "copy", it will detect copies, as well.
817 diff.suppressBlankEmpty::
818 A boolean to inhibit the standard behavior of printing a space
819 before each empty output line. Defaults to false.
822 Controls which diff tool is used. `diff.tool` overrides
823 `merge.tool` when used by linkgit:git-difftool[1] and has
824 the same valid values as `merge.tool` minus "tortoisemerge"
827 difftool.<tool>.path::
828 Override the path for the given tool. This is useful in case
829 your tool is not in the PATH.
831 difftool.<tool>.cmd::
832 Specify the command to invoke the specified diff tool.
833 The specified command is evaluated in shell with the following
834 variables available: 'LOCAL' is set to the name of the temporary
835 file containing the contents of the diff pre-image and 'REMOTE'
836 is set to the name of the temporary file containing the contents
837 of the diff post-image.
840 Prompt before each invocation of the diff tool.
843 A POSIX Extended Regular Expression used to determine what is a "word"
844 when performing word-by-word difference calculations. Character
845 sequences that match the regular expression are "words", all other
846 characters are *ignorable* whitespace.
849 If the number of objects fetched over the git native
850 transfer is below this
851 limit, then the objects will be unpacked into loose object
852 files. However if the number of received objects equals or
853 exceeds this limit then the received pack will be stored as
854 a pack, after adding any missing delta bases. Storing the
855 pack from a push can make the push operation complete faster,
856 especially on slow filesystems. If not set, the value of
857 `transfer.unpackLimit` is used instead.
860 Enable multipart/mixed attachments as the default for
861 'format-patch'. The value can also be a double quoted string
862 which will enable attachments as the default and set the
863 value as the boundary. See the --attach option in
864 linkgit:git-format-patch[1].
867 A boolean which can enable or disable sequence numbers in patch
868 subjects. It defaults to "auto" which enables it only if there
869 is more than one patch. It can be enabled or disabled for all
870 messages by setting it to "true" or "false". See --numbered
871 option in linkgit:git-format-patch[1].
874 Additional email headers to include in a patch to be submitted
875 by mail. See linkgit:git-format-patch[1].
878 Additional "Cc:" headers to include in a patch to be submitted
879 by mail. See the --cc option in linkgit:git-format-patch[1].
881 format.subjectprefix::
882 The default for format-patch is to output files with the '[PATCH]'
883 subject prefix. Use this variable to change that prefix.
886 The default for format-patch is to output files with the suffix
887 `.patch`. Use this variable to change that suffix (make sure to
888 include the dot if you want it).
891 The default pretty format for log/show/whatchanged command,
892 See linkgit:git-log[1], linkgit:git-show[1],
893 linkgit:git-whatchanged[1].
896 The default threading style for 'git format-patch'. Can be
897 a boolean value, or `shallow` or `deep`. `shallow` threading
898 makes every mail a reply to the head of the series,
899 where the head is chosen from the cover letter, the
900 `\--in-reply-to`, and the first patch mail, in this order.
901 `deep` threading makes every mail a reply to the previous one.
902 A true boolean value is the same as `shallow`, and a false
903 value disables threading.
906 A boolean value which lets you enable the `-s/--signoff` option of
907 format-patch by default. *Note:* Adding the Signed-off-by: line to a
908 patch should be a conscious act and means that you certify you have
909 the rights to submit this work under the same open source license.
910 Please see the 'SubmittingPatches' document for further discussion.
912 gc.aggressiveWindow::
913 The window size parameter used in the delta compression
914 algorithm used by 'git gc --aggressive'. This defaults
918 When there are approximately more than this many loose
919 objects in the repository, `git gc --auto` will pack them.
920 Some Porcelain commands use this command to perform a
921 light-weight garbage collection from time to time. The
922 default value is 6700. Setting this to 0 disables it.
925 When there are more than this many packs that are not
926 marked with `*.keep` file in the repository, `git gc
927 --auto` consolidates them into one larger pack. The
928 default value is 50. Setting this to 0 disables it.
931 Running `git pack-refs` in a repository renders it
932 unclonable by Git versions prior to 1.5.1.2 over dumb
933 transports such as HTTP. This variable determines whether
934 'git gc' runs `git pack-refs`. This can be set to `nobare`
935 to enable it within all non-bare repos or it can be set to a
936 boolean value. The default is `true`.
939 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
940 Override the grace period with this config variable. The value
941 "now" may be used to disable this grace period and always prune
942 unreachable objects immediately.
945 gc.<pattern>.reflogexpire::
946 'git reflog expire' removes reflog entries older than
947 this time; defaults to 90 days. With "<pattern>" (e.g.
948 "refs/stash") in the middle the setting applies only to
949 the refs that match the <pattern>.
951 gc.reflogexpireunreachable::
952 gc.<ref>.reflogexpireunreachable::
953 'git reflog expire' removes reflog entries older than
954 this time and are not reachable from the current tip;
955 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
956 in the middle, the setting applies only to the refs that
960 Records of conflicted merge you resolved earlier are
961 kept for this many days when 'git rerere gc' is run.
962 The default is 60 days. See linkgit:git-rerere[1].
964 gc.rerereunresolved::
965 Records of conflicted merge you have not resolved are
966 kept for this many days when 'git rerere gc' is run.
967 The default is 15 days. See linkgit:git-rerere[1].
969 gitcvs.commitmsgannotation::
970 Append this string to each commit message. Set to empty string
971 to disable this feature. Defaults to "via git-CVS emulator".
974 Whether the CVS server interface is enabled for this repository.
975 See linkgit:git-cvsserver[1].
978 Path to a log file where the CVS server interface well... logs
979 various stuff. See linkgit:git-cvsserver[1].
982 If true, the server will look up the `crlf` attribute for
983 files to determine the '-k' modes to use. If `crlf` is set,
984 the '-k' mode will be left blank, so cvs clients will
985 treat it as text. If `crlf` is explicitly unset, the file
986 will be set with '-kb' mode, which suppresses any newline munging
987 the client might otherwise do. If `crlf` is not specified,
988 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
991 This is used if 'gitcvs.usecrlfattr' does not resolve
992 the correct '-kb' mode to use. If true, all
993 unresolved files are sent to the client in
994 mode '-kb'. This causes the client to treat them
995 as binary files, which suppresses any newline munging it
996 otherwise might do. Alternatively, if it is set to "guess",
997 then the contents of the file are examined to decide if
998 it is binary, similar to 'core.autocrlf'.
1001 Database used by git-cvsserver to cache revision information
1002 derived from the git repository. The exact meaning depends on the
1003 used database driver, for SQLite (which is the default driver) this
1004 is a filename. Supports variable substitution (see
1005 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1006 Default: '%Ggitcvs.%m.sqlite'
1009 Used Perl DBI driver. You can specify any available driver
1010 for this here, but it might not work. git-cvsserver is tested
1011 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1012 reported *not* to work with 'DBD::mysql'. Experimental feature.
1013 May not contain double colons (`:`). Default: 'SQLite'.
1014 See linkgit:git-cvsserver[1].
1016 gitcvs.dbuser, gitcvs.dbpass::
1017 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1018 since SQLite has no concept of database users and/or passwords.
1019 'gitcvs.dbuser' supports variable substitution (see
1020 linkgit:git-cvsserver[1] for details).
1022 gitcvs.dbTableNamePrefix::
1023 Database table name prefix. Prepended to the names of any
1024 database tables used, allowing a single database to be used
1025 for several repositories. Supports variable substitution (see
1026 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1027 characters will be replaced with underscores.
1029 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1030 'gitcvs.allbinary' can also be specified as
1031 'gitcvs.<access_method>.<varname>' (where 'access_method'
1032 is one of "ext" and "pserver") to make them apply only for the given
1035 gui.commitmsgwidth::
1036 Defines how wide the commit message window is in the
1037 linkgit:git-gui[1]. "75" is the default.
1040 Specifies how many context lines should be used in calls to diff
1041 made by the linkgit:git-gui[1]. The default is "5".
1044 Specifies the default encoding to use for displaying of
1045 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1046 It can be overridden by setting the 'encoding' attribute
1047 for relevant files (see linkgit:gitattributes[5]).
1048 If this option is not set, the tools default to the
1051 gui.matchtrackingbranch::
1052 Determines if new branches created with linkgit:git-gui[1] should
1053 default to tracking remote branches with matching names or
1054 not. Default: "false".
1056 gui.newbranchtemplate::
1057 Is used as suggested name when creating new branches using the
1060 gui.pruneduringfetch::
1061 "true" if linkgit:git-gui[1] should prune tracking branches when
1062 performing a fetch. The default value is "false".
1065 Determines if linkgit:git-gui[1] should trust the file modification
1066 timestamp or not. By default the timestamps are not trusted.
1068 gui.spellingdictionary::
1069 Specifies the dictionary used for spell checking commit messages in
1070 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1074 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1075 location detection. It makes blame significantly faster on huge
1076 repositories at the expense of less thorough copy detection.
1078 gui.copyblamethreshold::
1079 Specifies the threshold to use in 'git gui blame' original location
1080 detection, measured in alphanumeric characters. See the
1081 linkgit:git-blame[1] manual for more information on copy detection.
1083 gui.blamehistoryctx::
1084 Specifies the radius of history context in days to show in
1085 linkgit:gitk[1] for the selected commit, when the `Show History
1086 Context` menu item is invoked from 'git gui blame'. If this
1087 variable is set to zero, the whole history is shown.
1089 guitool.<name>.cmd::
1090 Specifies the shell command line to execute when the corresponding item
1091 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1092 mandatory for every tool. The command is executed from the root of
1093 the working directory, and in the environment it receives the name of
1094 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1095 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1096 the head is detached, 'CUR_BRANCH' is empty).
1098 guitool.<name>.needsfile::
1099 Run the tool only if a diff is selected in the GUI. It guarantees
1100 that 'FILENAME' is not empty.
1102 guitool.<name>.noconsole::
1103 Run the command silently, without creating a window to display its
1106 guitool.<name>.norescan::
1107 Don't rescan the working directory for changes after the tool
1110 guitool.<name>.confirm::
1111 Show a confirmation dialog before actually running the tool.
1113 guitool.<name>.argprompt::
1114 Request a string argument from the user, and pass it to the tool
1115 through the 'ARGS' environment variable. Since requesting an
1116 argument implies confirmation, the 'confirm' option has no effect
1117 if this is enabled. If the option is set to 'true', 'yes', or '1',
1118 the dialog uses a built-in generic prompt; otherwise the exact
1119 value of the variable is used.
1121 guitool.<name>.revprompt::
1122 Request a single valid revision from the user, and set the
1123 'REVISION' environment variable. In other aspects this option
1124 is similar to 'argprompt', and can be used together with it.
1126 guitool.<name>.revunmerged::
1127 Show only unmerged branches in the 'revprompt' subdialog.
1128 This is useful for tools similar to merge or rebase, but not
1129 for things like checkout or reset.
1131 guitool.<name>.title::
1132 Specifies the title to use for the prompt dialog. The default
1135 guitool.<name>.prompt::
1136 Specifies the general prompt string to display at the top of
1137 the dialog, before subsections for 'argprompt' and 'revprompt'.
1138 The default value includes the actual command.
1141 Specify the browser that will be used to display help in the
1142 'web' format. See linkgit:git-help[1].
1145 Override the default help format used by linkgit:git-help[1].
1146 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1147 the default. 'web' and 'html' are the same.
1150 Automatically correct and execute mistyped commands after
1151 waiting for the given number of deciseconds (0.1 sec). If more
1152 than one command can be deduced from the entered text, nothing
1153 will be executed. If the value of this option is negative,
1154 the corrected command will be executed immediately. If the
1155 value is 0 - the command will be just shown but not executed.
1156 This is the default.
1159 Override the HTTP proxy, normally configured using the 'http_proxy'
1160 environment variable (see linkgit:curl[1]). This can be overridden
1161 on a per-remote basis; see remote.<name>.proxy
1164 Whether to verify the SSL certificate when fetching or pushing
1165 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1169 File containing the SSL certificate when fetching or pushing
1170 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1174 File containing the SSL private key when fetching or pushing
1175 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1178 http.sslCertPasswordProtected::
1179 Enable git's password prompt for the SSL certificate. Otherwise
1180 OpenSSL will prompt the user, possibly many times, if the
1181 certificate or private key is encrypted. Can be overridden by the
1182 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1185 File containing the certificates to verify the peer with when
1186 fetching or pushing over HTTPS. Can be overridden by the
1187 'GIT_SSL_CAINFO' environment variable.
1190 Path containing files with the CA certificates to verify the peer
1191 with when fetching or pushing over HTTPS. Can be overridden
1192 by the 'GIT_SSL_CAPATH' environment variable.
1195 How many HTTP requests to launch in parallel. Can be overridden
1196 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1199 The number of curl sessions (counted across slots) to be kept across
1200 requests. They will not be ended with curl_easy_cleanup() until
1201 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1202 value will be capped at 1. Defaults to 1.
1205 Maximum size in bytes of the buffer used by smart HTTP
1206 transports when POSTing data to the remote system.
1207 For requests larger than this buffer size, HTTP/1.1 and
1208 Transfer-Encoding: chunked is used to avoid creating a
1209 massive pack file locally. Default is 1 MiB, which is
1210 sufficient for most requests.
1212 http.lowSpeedLimit, http.lowSpeedTime::
1213 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1214 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1215 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1216 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1219 A boolean which disables using of EPSV ftp command by curl.
1220 This can helpful with some "poor" ftp servers which don't
1221 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1222 environment variable. Default is false (curl will use EPSV).
1224 i18n.commitEncoding::
1225 Character encoding the commit messages are stored in; git itself
1226 does not care per se, but this information is necessary e.g. when
1227 importing commits from emails or in the gitk graphical history
1228 browser (and possibly at other places in the future or in other
1229 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1231 i18n.logOutputEncoding::
1232 Character encoding the commit messages are converted to when
1233 running 'git log' and friends.
1236 The configuration variables in the 'imap' section are described
1237 in linkgit:git-imap-send[1].
1240 Specify the directory from which templates will be copied.
1241 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1244 Specify the program that will be used to browse your working
1245 repository in gitweb. See linkgit:git-instaweb[1].
1248 The HTTP daemon command-line to start gitweb on your working
1249 repository. See linkgit:git-instaweb[1].
1252 If true the web server started by linkgit:git-instaweb[1] will
1253 be bound to the local IP (127.0.0.1).
1255 instaweb.modulepath::
1256 The module path for an apache httpd used by linkgit:git-instaweb[1].
1259 The port number to bind the gitweb httpd to. See
1260 linkgit:git-instaweb[1].
1262 interactive.singlekey::
1263 In interactive commands, allow the user to provide one-letter
1264 input with a single key (i.e., without hitting enter).
1265 Currently this is used only by the `\--patch` mode of
1266 linkgit:git-add[1]. Note that this setting is silently
1267 ignored if portable keystroke input is not available.
1270 Set default date-time mode for the log command. Setting log.date
1271 value is similar to using 'git log'\'s --date option. The value is one of the
1272 following alternatives: {relative,local,default,iso,rfc,short}.
1273 See linkgit:git-log[1].
1276 Print out the ref names of any commits that are shown by the log
1277 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1278 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1279 specified, the full ref name (including prefix) will be printed.
1280 This is the same as the log commands '--decorate' option.
1283 If true, the initial commit will be shown as a big creation event.
1284 This is equivalent to a diff against an empty tree.
1285 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1286 normally hide the root commit will now show it. True by default.
1289 The location of an augmenting mailmap file. The default
1290 mailmap, located in the root of the repository, is loaded
1291 first, then the mailmap file pointed to by this variable.
1292 The location of the mailmap file may be in a repository
1293 subdirectory, or somewhere outside of the repository itself.
1294 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1297 Specify the programs that may be used to display help in the
1298 'man' format. See linkgit:git-help[1].
1301 Specify the command to invoke the specified man viewer. The
1302 specified command is evaluated in shell with the man page
1303 passed as argument. (See linkgit:git-help[1].)
1306 Override the path for the given tool that may be used to
1307 display help in the 'man' format. See linkgit:git-help[1].
1309 include::merge-config.txt[]
1311 mergetool.<tool>.path::
1312 Override the path for the given tool. This is useful in case
1313 your tool is not in the PATH.
1315 mergetool.<tool>.cmd::
1316 Specify the command to invoke the specified merge tool. The
1317 specified command is evaluated in shell with the following
1318 variables available: 'BASE' is the name of a temporary file
1319 containing the common base of the files to be merged, if available;
1320 'LOCAL' is the name of a temporary file containing the contents of
1321 the file on the current branch; 'REMOTE' is the name of a temporary
1322 file containing the contents of the file from the branch being
1323 merged; 'MERGED' contains the name of the file to which the merge
1324 tool should write the results of a successful merge.
1326 mergetool.<tool>.trustExitCode::
1327 For a custom merge command, specify whether the exit code of
1328 the merge command can be used to determine whether the merge was
1329 successful. If this is not set to true then the merge target file
1330 timestamp is checked and the merge assumed to have been successful
1331 if the file has been updated, otherwise the user is prompted to
1332 indicate the success of the merge.
1334 mergetool.keepBackup::
1335 After performing a merge, the original file with conflict markers
1336 can be saved as a file with a `.orig` extension. If this variable
1337 is set to `false` then this file is not preserved. Defaults to
1338 `true` (i.e. keep the backup files).
1340 mergetool.keepTemporaries::
1341 When invoking a custom merge tool, git uses a set of temporary
1342 files to pass to the tool. If the tool returns an error and this
1343 variable is set to `true`, then these temporary files will be
1344 preserved, otherwise they will be removed after the tool has
1345 exited. Defaults to `false`.
1348 Prompt before each invocation of the merge resolution program.
1351 The (fully qualified) refname from which to show notes when
1352 showing commit messages. The value of this variable can be set
1353 to a glob, in which case notes from all matching refs will be
1354 shown. You may also specify this configuration variable
1355 several times. A warning will be issued for refs that do not
1356 exist, but a glob that does not match any refs is silently
1359 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1360 environment variable, which must be a colon separated list of refs or
1363 The effective value of "core.notesRef" (possibly overridden by
1364 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1367 notes.rewrite.<command>::
1368 When rewriting commits with <command> (currently `amend` or
1369 `rebase`) and this variable is set to `true`, git
1370 automatically copies your notes from the original to the
1371 rewritten commit. Defaults to `true`, but see
1372 "notes.rewriteRef" below.
1375 When copying notes during a rewrite (see the
1376 "notes.rewrite.<command>" option), determines what to do if
1377 the target commit already has a note. Must be one of
1378 `overwrite`, `concatenate`, or `ignore`. Defaults to
1381 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1382 environment variable.
1385 When copying notes during a rewrite, specifies the (fully
1386 qualified) ref whose notes should be copied. The ref may be a
1387 glob, in which case notes in all matching refs will be copied.
1388 You may also specify this configuration several times.
1390 Does not have a default value; you must configure this variable to
1391 enable note rewriting.
1393 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1394 environment variable, which must be a colon separated list of refs or
1398 The size of the window used by linkgit:git-pack-objects[1] when no
1399 window size is given on the command line. Defaults to 10.
1402 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1403 maximum depth is given on the command line. Defaults to 50.
1406 The window memory size limit used by linkgit:git-pack-objects[1]
1407 when no limit is given on the command line. The value can be
1408 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1412 An integer -1..9, indicating the compression level for objects
1413 in a pack file. -1 is the zlib default. 0 means no
1414 compression, and 1..9 are various speed/size tradeoffs, 9 being
1415 slowest. If not set, defaults to core.compression. If that is
1416 not set, defaults to -1, the zlib default, which is "a default
1417 compromise between speed and compression (currently equivalent
1420 pack.deltaCacheSize::
1421 The maximum memory in bytes used for caching deltas in
1422 linkgit:git-pack-objects[1] before writing them out to a pack.
1423 This cache is used to speed up the writing object phase by not
1424 having to recompute the final delta result once the best match
1425 for all objects is found. Repacking large repositories on machines
1426 which are tight with memory might be badly impacted by this though,
1427 especially if this cache pushes the system into swapping.
1428 A value of 0 means no limit. The smallest size of 1 byte may be
1429 used to virtually disable this cache. Defaults to 256 MiB.
1431 pack.deltaCacheLimit::
1432 The maximum size of a delta, that is cached in
1433 linkgit:git-pack-objects[1]. This cache is used to speed up the
1434 writing object phase by not having to recompute the final delta
1435 result once the best match for all objects is found. Defaults to 1000.
1438 Specifies the number of threads to spawn when searching for best
1439 delta matches. This requires that linkgit:git-pack-objects[1]
1440 be compiled with pthreads otherwise this option is ignored with a
1441 warning. This is meant to reduce packing time on multiprocessor
1442 machines. The required amount of memory for the delta search window
1443 is however multiplied by the number of threads.
1444 Specifying 0 will cause git to auto-detect the number of CPU's
1445 and set the number of threads accordingly.
1448 Specify the default pack index version. Valid values are 1 for
1449 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1450 the new pack index with capabilities for packs larger than 4 GB
1451 as well as proper protection against the repacking of corrupted
1452 packs. Version 2 is the default. Note that version 2 is enforced
1453 and this config option ignored whenever the corresponding pack is
1456 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1457 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1458 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1459 other side may give you a repository that cannot be accessed with your
1460 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1461 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1462 the `{asterisk}.idx` file.
1464 pack.packSizeLimit::
1465 The maximum size of a pack. This setting only affects
1466 packing to a file when repacking, i.e. the git:// protocol
1467 is unaffected. It can be overridden by the `\--max-pack-size`
1468 option of linkgit:git-repack[1]. The minimum size allowed is
1469 limited to 1 MiB. The default is unlimited.
1470 Common unit suffixes of 'k', 'm', or 'g' are
1474 Allows turning on or off pagination of the output of a
1475 particular git subcommand when writing to a tty. If
1476 `\--paginate` or `\--no-pager` is specified on the command line,
1477 it takes precedence over this option. To disable pagination for
1478 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1481 Alias for a --pretty= format string, as specified in
1482 linkgit:git-log[1]. Any aliases defined here can be used just
1483 as the built-in pretty formats could. For example,
1484 running `git config pretty.changelog "format:{asterisk} %H %s"`
1485 would cause the invocation `git log --pretty=changelog`
1486 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1487 Note that an alias with the same name as a built-in format
1488 will be silently ignored.
1491 The default merge strategy to use when pulling multiple branches
1495 The default merge strategy to use when pulling a single branch.
1498 Defines the action git push should take if no refspec is given
1499 on the command line, no refspec is configured in the remote, and
1500 no refspec is implied by any of the options given on the command
1501 line. Possible values are:
1503 * `nothing` do not push anything.
1504 * `matching` push all matching branches.
1505 All branches having the same name in both ends are considered to be
1506 matching. This is the default.
1507 * `tracking` push the current branch to its upstream branch.
1508 * `current` push the current branch to a branch of the same name.
1511 Whether to show a diffstat of what changed upstream since the last
1512 rebase. False by default.
1515 By default, git-receive-pack will run "git-gc --auto" after
1516 receiving data from git-push and updating refs. You can stop
1517 it by setting this variable to false.
1519 receive.fsckObjects::
1520 If it is set to true, git-receive-pack will check all received
1521 objects. It will abort in the case of a malformed object or a
1522 broken link. The result of an abort are only dangling objects.
1525 receive.unpackLimit::
1526 If the number of objects received in a push is below this
1527 limit then the objects will be unpacked into loose object
1528 files. However if the number of received objects equals or
1529 exceeds this limit then the received pack will be stored as
1530 a pack, after adding any missing delta bases. Storing the
1531 pack from a push can make the push operation complete faster,
1532 especially on slow filesystems. If not set, the value of
1533 `transfer.unpackLimit` is used instead.
1535 receive.denyDeletes::
1536 If set to true, git-receive-pack will deny a ref update that deletes
1537 the ref. Use this to prevent such a ref deletion via a push.
1539 receive.denyCurrentBranch::
1540 If set to true or "refuse", git-receive-pack will deny a ref update
1541 to the currently checked out branch of a non-bare repository.
1542 Such a push is potentially dangerous because it brings the HEAD
1543 out of sync with the index and working tree. If set to "warn",
1544 print a warning of such a push to stderr, but allow the push to
1545 proceed. If set to false or "ignore", allow such pushes with no
1546 message. Defaults to "refuse".
1548 receive.denyNonFastForwards::
1549 If set to true, git-receive-pack will deny a ref update which is
1550 not a fast-forward. Use this to prevent such an update via a push,
1551 even if that push is forced. This configuration variable is
1552 set when initializing a shared repository.
1554 receive.updateserverinfo::
1555 If set to true, git-receive-pack will run git-update-server-info
1556 after receiving data from git-push and updating refs.
1559 The URL of a remote repository. See linkgit:git-fetch[1] or
1560 linkgit:git-push[1].
1562 remote.<name>.pushurl::
1563 The push URL of a remote repository. See linkgit:git-push[1].
1565 remote.<name>.proxy::
1566 For remotes that require curl (http, https and ftp), the URL to
1567 the proxy to use for that remote. Set to the empty string to
1568 disable proxying for that remote.
1570 remote.<name>.fetch::
1571 The default set of "refspec" for linkgit:git-fetch[1]. See
1572 linkgit:git-fetch[1].
1574 remote.<name>.push::
1575 The default set of "refspec" for linkgit:git-push[1]. See
1576 linkgit:git-push[1].
1578 remote.<name>.mirror::
1579 If true, pushing to this remote will automatically behave
1580 as if the `\--mirror` option was given on the command line.
1582 remote.<name>.skipDefaultUpdate::
1583 If true, this remote will be skipped by default when updating
1584 using linkgit:git-fetch[1] or the `update` subcommand of
1585 linkgit:git-remote[1].
1587 remote.<name>.skipFetchAll::
1588 If true, this remote will be skipped by default when updating
1589 using linkgit:git-fetch[1] or the `update` subcommand of
1590 linkgit:git-remote[1].
1592 remote.<name>.receivepack::
1593 The default program to execute on the remote side when pushing. See
1594 option \--receive-pack of linkgit:git-push[1].
1596 remote.<name>.uploadpack::
1597 The default program to execute on the remote side when fetching. See
1598 option \--upload-pack of linkgit:git-fetch-pack[1].
1600 remote.<name>.tagopt::
1601 Setting this value to \--no-tags disables automatic tag following when
1602 fetching from remote <name>. Setting it to \--tags will fetch every
1603 tag from remote <name>, even if they are not reachable from remote
1607 Setting this to a value <vcs> will cause git to interact with
1608 the remote with the git-remote-<vcs> helper.
1611 The list of remotes which are fetched by "git remote update
1612 <group>". See linkgit:git-remote[1].
1614 repack.usedeltabaseoffset::
1615 By default, linkgit:git-repack[1] creates packs that use
1616 delta-base offset. If you need to share your repository with
1617 git older than version 1.4.4, either directly or via a dumb
1618 protocol such as http, then you need to set this option to
1619 "false" and repack. Access from old git versions over the
1620 native protocol are unaffected by this option.
1623 When set to true, `git-rerere` updates the index with the
1624 resulting contents after it cleanly resolves conflicts using
1625 previously recorded resolution. Defaults to false.
1628 Activate recording of resolved conflicts, so that identical
1629 conflict hunks can be resolved automatically, should they
1630 be encountered again. linkgit:git-rerere[1] command is by
1631 default enabled if you create `rr-cache` directory under
1632 `$GIT_DIR`, but can be disabled by setting this option to false.
1634 sendemail.identity::
1635 A configuration identity. When given, causes values in the
1636 'sendemail.<identity>' subsection to take precedence over
1637 values in the 'sendemail' section. The default identity is
1638 the value of 'sendemail.identity'.
1640 sendemail.smtpencryption::
1641 See linkgit:git-send-email[1] for description. Note that this
1642 setting is not subject to the 'identity' mechanism.
1645 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1647 sendemail.<identity>.*::
1648 Identity-specific versions of the 'sendemail.*' parameters
1649 found below, taking precedence over those when the this
1650 identity is selected, through command-line or
1651 'sendemail.identity'.
1653 sendemail.aliasesfile::
1654 sendemail.aliasfiletype::
1658 sendemail.chainreplyto::
1660 sendemail.envelopesender::
1662 sendemail.multiedit::
1663 sendemail.signedoffbycc::
1664 sendemail.smtppass::
1665 sendemail.suppresscc::
1666 sendemail.suppressfrom::
1668 sendemail.smtpdomain::
1669 sendemail.smtpserver::
1670 sendemail.smtpserverport::
1671 sendemail.smtpuser::
1673 sendemail.validate::
1674 See linkgit:git-send-email[1] for description.
1676 sendemail.signedoffcc::
1677 Deprecated alias for 'sendemail.signedoffbycc'.
1679 showbranch.default::
1680 The default set of branches for linkgit:git-show-branch[1].
1681 See linkgit:git-show-branch[1].
1683 status.relativePaths::
1684 By default, linkgit:git-status[1] shows paths relative to the
1685 current directory. Setting this variable to `false` shows paths
1686 relative to the repository root (this was the default for git
1689 status.showUntrackedFiles::
1690 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1691 files which are not currently tracked by Git. Directories which
1692 contain only untracked files, are shown with the directory name
1693 only. Showing untracked files means that Git needs to lstat() all
1694 all the files in the whole repository, which might be slow on some
1695 systems. So, this variable controls how the commands displays
1696 the untracked files. Possible values are:
1699 - 'no' - Show no untracked files
1700 - 'normal' - Shows untracked files and directories
1701 - 'all' - Shows also individual files in untracked directories.
1704 If this variable is not specified, it defaults to 'normal'.
1705 This variable can be overridden with the -u|--untracked-files option
1706 of linkgit:git-status[1] and linkgit:git-commit[1].
1708 status.submodulesummary::
1710 If this is set to a non zero number or true (identical to -1 or an
1711 unlimited number), the submodule summary will be enabled and a
1712 summary of commits for modified submodules will be shown (see
1713 --summary-limit option of linkgit:git-submodule[1]).
1716 This variable can be used to restrict the permission bits of
1717 tar archive entries. The default is 0002, which turns off the
1718 world write bit. The special value "user" indicates that the
1719 archiving user's umask will be used instead. See umask(2) and
1720 linkgit:git-archive[1].
1722 transfer.unpackLimit::
1723 When `fetch.unpackLimit` or `receive.unpackLimit` are
1724 not set, the value of this variable is used instead.
1725 The default value is 100.
1727 url.<base>.insteadOf::
1728 Any URL that starts with this value will be rewritten to
1729 start, instead, with <base>. In cases where some site serves a
1730 large number of repositories, and serves them with multiple
1731 access methods, and some users need to use different access
1732 methods, this feature allows people to specify any of the
1733 equivalent URLs and have git automatically rewrite the URL to
1734 the best alternative for the particular user, even for a
1735 never-before-seen repository on the site. When more than one
1736 insteadOf strings match a given URL, the longest match is used.
1738 url.<base>.pushInsteadOf::
1739 Any URL that starts with this value will not be pushed to;
1740 instead, it will be rewritten to start with <base>, and the
1741 resulting URL will be pushed to. In cases where some site serves
1742 a large number of repositories, and serves them with multiple
1743 access methods, some of which do not allow push, this feature
1744 allows people to specify a pull-only URL and have git
1745 automatically use an appropriate URL to push, even for a
1746 never-before-seen repository on the site. When more than one
1747 pushInsteadOf strings match a given URL, the longest match is
1748 used. If a remote has an explicit pushurl, git will ignore this
1749 setting for that remote.
1752 Your email address to be recorded in any newly created commits.
1753 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1754 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1757 Your full name to be recorded in any newly created commits.
1758 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1759 environment variables. See linkgit:git-commit-tree[1].
1762 If linkgit:git-tag[1] is not selecting the key you want it to
1763 automatically when creating a signed tag, you can override the
1764 default selection with this variable. This option is passed
1765 unchanged to gpg's --local-user parameter, so you may specify a key
1766 using any method that gpg supports.
1769 Specify a web browser that may be used by some commands.
1770 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]