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 deprecated `[section.subsection]` syntax. With this
49 syntax, the subsection name is converted to lower-case and is also
50 compared case sensitively. These subsection names follow the same
51 restrictions as section names.
53 All the other lines (and the remainder of the line after the section
54 header) are recognized as setting variables, in the form
55 'name = value'. If there is no equal sign on the line, the entire line
56 is taken as 'name' and the variable is recognized as boolean "true".
57 The variable names are case-insensitive and only alphanumeric
58 characters and `-` are allowed. There can be more than one value
59 for a given variable; we say then that variable is multivalued.
61 Leading and trailing whitespace in a variable value is discarded.
62 Internal whitespace within a variable value is retained verbatim.
64 The values following the equals sign in variable assign are all either
65 a string, an integer, or a boolean. Boolean values may be given as yes/no,
66 1/0, true/false or on/off. Case is not significant in boolean values, when
67 converting value to the canonical form using '--bool' type specifier;
68 'git config' will ensure that the output is "true" or "false".
70 String values may be entirely or partially enclosed in double quotes.
71 You need to enclose variable values in double quotes if you want to
72 preserve leading or trailing whitespace, or if the variable value contains
73 comment characters (i.e. it contains '#' or ';').
74 Double quote `"` and backslash `\` characters in variable values must
75 be escaped: use `\"` for `"` and `\\` for `\`.
77 The following escape sequences (beside `\"` and `\\`) are recognized:
78 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
79 and `\b` for backspace (BS). No other char escape sequence, nor octal
80 char sequences are valid.
82 Variable values ending in a `\` are continued on the next line in the
83 customary UNIX fashion.
85 Some variables may require a special value format.
92 ; Don't trust file modes
97 external = /usr/local/bin/diff-wrapper
102 merge = refs/heads/devel
106 gitProxy="ssh" for "kernel.org"
107 gitProxy=default-proxy ; for the rest
112 Note that this list is non-comprehensive and not necessarily complete.
113 For command-specific variables, you will find a more detailed description
114 in the appropriate manual page. You will find a description of non-core
115 porcelain configuration variables in the respective porcelain documentation.
118 These variables control various optional help messages designed to
119 aid new users. All 'advice.*' variables default to 'true', and you
120 can tell Git that you do not need help by setting these to 'false':
124 Advice shown when linkgit:git-push[1] refuses
125 non-fast-forward refs.
127 Directions on how to stage/unstage/add shown in the
128 output of linkgit:git-status[1] and the template shown
129 when writing commit messages.
131 Advice shown when linkgit:git-merge[1] refuses to
132 merge to avoid overwriting local changes.
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
137 Advice on how to set your identity configuration when
138 your information is guessed from the system username and
141 Advice shown when you used linkgit:git-checkout[1] to
142 move to the detach HEAD state, to instruct how to create
143 a local branch after the fact.
147 If false, the executable bit differences between the index and
148 the working tree are ignored; useful on broken filesystems like FAT.
149 See linkgit:git-update-index[1].
151 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
152 will probe and set core.fileMode false if appropriate when the
153 repository is created.
156 (Windows-only) If true (which is the default), mark newly-created
157 directories and files whose name starts with a dot as hidden.
158 If 'dotGitOnly', only the .git/ directory is hidden, but no other
159 files starting with a dot.
161 core.ignoreCygwinFSTricks::
162 This option is only used by Cygwin implementation of Git. If false,
163 the Cygwin stat() and lstat() functions are used. This may be useful
164 if your repository consists of a few separate directories joined in
165 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
166 whenever it is possible and falls back to Cygwin functions only to
167 handle symbol links. The native mode is more than twice faster than
168 normal Cygwin l/stat() functions. True by default, unless core.filemode
169 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
170 POSIX emulation is required to support core.filemode.
173 If true, this option enables various workarounds to enable
174 git to work better on filesystems that are not case sensitive,
175 like FAT. For example, if a directory listing finds
176 "makefile" when git expects "Makefile", git will assume
177 it is really the same file, and continue to remember it as
180 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
181 will probe and set core.ignorecase true if appropriate when the repository
185 If false, the ctime differences between the index and the
186 working tree are ignored; useful when the inode change time
187 is regularly modified by something outside Git (file system
188 crawlers and some backup systems).
189 See linkgit:git-update-index[1]. True by default.
192 The commands that output paths (e.g. 'ls-files',
193 'diff'), when not given the `-z` option, will quote
194 "unusual" characters in the pathname by enclosing the
195 pathname in a double-quote pair and with backslashes the
196 same way strings in C source code are quoted. If this
197 variable is set to false, the bytes higher than 0x80 are
198 not quoted but output as verbatim. Note that double
199 quote, backslash and control characters are always
200 quoted without `-z` regardless of the setting of this
204 Sets the line ending type to use in the working directory for
205 files that have the `text` property set. Alternatives are
206 'lf', 'crlf' and 'native', which uses the platform's native
207 line ending. The default value is `native`. See
208 linkgit:gitattributes[5] for more information on end-of-line
212 If true, makes git check if converting `CRLF` is reversible when
213 end-of-line conversion is active. Git will verify if a command
214 modifies a file in the work tree either directly or indirectly.
215 For example, committing a file followed by checking out the
216 same file should yield the original file in the work tree. If
217 this is not the case for the current setting of
218 `core.autocrlf`, git will reject the file. The variable can
219 be set to "warn", in which case git will only warn about an
220 irreversible conversion but continue the operation.
222 CRLF conversion bears a slight chance of corrupting data.
223 When it is enabled, git will convert CRLF to LF during commit and LF to
224 CRLF during checkout. A file that contains a mixture of LF and
225 CRLF before the commit cannot be recreated by git. For text
226 files this is the right thing to do: it corrects line endings
227 such that we have only LF line endings in the repository.
228 But for binary files that are accidentally classified as text the
229 conversion can corrupt data.
231 If you recognize such corruption early you can easily fix it by
232 setting the conversion type explicitly in .gitattributes. Right
233 after committing you still have the original file in your work
234 tree and this file is not yet corrupted. You can explicitly tell
235 git that this file is binary and git will handle the file
238 Unfortunately, the desired effect of cleaning up text files with
239 mixed line endings and the undesired effect of corrupting binary
240 files cannot be distinguished. In both cases CRLFs are removed
241 in an irreversible way. For text files this is the right thing
242 to do because CRLFs are line endings, while for binary files
243 converting CRLFs corrupts data.
245 Note, this safety check does not mean that a checkout will generate a
246 file identical to the original file for a different setting of
247 `core.eol` and `core.autocrlf`, but only for the current one. For
248 example, a text file with `LF` would be accepted with `core.eol=lf`
249 and could later be checked out with `core.eol=crlf`, in which case the
250 resulting file would contain `CRLF`, although the original file
251 contained `LF`. However, in both work trees the line endings would be
252 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
253 file with mixed line endings would be reported by the `core.safecrlf`
257 Setting this variable to "true" is almost the same as setting
258 the `text` attribute to "auto" on all files except that text
259 files are not guaranteed to be normalized: files that contain
260 `CRLF` in the repository will not be touched. Use this
261 setting if you want to have `CRLF` line endings in your
262 working directory even though the repository does not have
263 normalized line endings. This variable can be set to 'input',
264 in which case no output conversion is performed.
267 If false, symbolic links are checked out as small plain files that
268 contain the link text. linkgit:git-update-index[1] and
269 linkgit:git-add[1] will not change the recorded type to regular
270 file. Useful on filesystems like FAT that do not support
273 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
274 will probe and set core.symlinks false if appropriate when the repository
278 A "proxy command" to execute (as 'command host port') instead
279 of establishing direct connection to the remote server when
280 using the git protocol for fetching. If the variable value is
281 in the "COMMAND for DOMAIN" format, the command is applied only
282 on hostnames ending with the specified domain string. This variable
283 may be set multiple times and is matched in the given order;
284 the first match wins.
286 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
287 (which always applies universally, without the special "for"
290 The special string `none` can be used as the proxy command to
291 specify that no proxy be used for a given domain pattern.
292 This is useful for excluding servers inside a firewall from
293 proxy use, while defaulting to a common proxy for external domains.
296 If true, commands which modify both the working tree and the index
297 will mark the updated paths with the "assume unchanged" bit in the
298 index. These marked files are then assumed to stay unchanged in the
299 working tree, until you mark them otherwise manually - Git will not
300 detect the file changes by lstat() calls. This is useful on systems
301 where those are very slow, such as Microsoft Windows.
302 See linkgit:git-update-index[1].
305 core.preferSymlinkRefs::
306 Instead of the default "symref" format for HEAD
307 and other symbolic reference files, use symbolic links.
308 This is sometimes needed to work with old scripts that
309 expect HEAD to be a symbolic link.
312 If true this repository is assumed to be 'bare' and has no
313 working directory associated with it. If this is the case a
314 number of commands that require a working directory will be
315 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
317 This setting is automatically guessed by linkgit:git-clone[1] or
318 linkgit:git-init[1] when the repository was created. By default a
319 repository that ends in "/.git" is assumed to be not bare (bare =
320 false), while all other repositories are assumed to be bare (bare
324 Set the path to the root of the working tree.
325 This can be overridden by the GIT_WORK_TREE environment
326 variable and the '--work-tree' command line option.
327 The value can be an absolute path or relative to the path to
328 the .git directory, which is either specified by --git-dir
329 or GIT_DIR, or automatically discovered.
330 If --git-dir or GIT_DIR is specified but none of
331 --work-tree, GIT_WORK_TREE and core.worktree is specified,
332 the current working directory is regarded as the top level
333 of your working tree.
335 Note that this variable is honored even when set in a configuration
336 file in a ".git" subdirectory of a directory and its value differs
337 from the latter directory (e.g. "/path/to/.git/config" has
338 core.worktree set to "/different/path"), which is most likely a
339 misconfiguration. Running git commands in the "/path/to" directory will
340 still use "/different/path" as the root of the work tree and can cause
341 confusion unless you know what you are doing (e.g. you are creating a
342 read-only snapshot of the same index to a location different from the
343 repository's usual working tree).
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 (i.e. under
352 refs/heads/), remote refs (i.e. under refs/remotes/),
353 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
355 This information can be used to determine what commit
356 was the tip of a branch "2 days ago".
358 This value is true by default in a repository that has
359 a working directory associated with it, and false by
360 default in a bare repository.
362 core.repositoryFormatVersion::
363 Internal variable identifying the repository format and layout
366 core.sharedRepository::
367 When 'group' (or 'true'), the repository is made shareable between
368 several users in a group (making sure all the files and objects are
369 group-writable). When 'all' (or 'world' or 'everybody'), the
370 repository will be readable by all users, additionally to being
371 group-shareable. When 'umask' (or 'false'), git will use permissions
372 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
373 files in the repository will have this mode value. '0xxx' will override
374 user's umask value (whereas the other options will only override
375 requested parts of the user's umask value). Examples: '0660' will make
376 the repo read/write-able for the owner and group, but inaccessible to
377 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
378 repository that is group-readable but not group-writable.
379 See linkgit:git-init[1]. False by default.
381 core.warnAmbiguousRefs::
382 If true, git will warn you if the ref name you passed it is ambiguous
383 and might match multiple refs in the .git/refs/ tree. True by default.
386 An integer -1..9, indicating a default compression level.
387 -1 is the zlib default. 0 means no compression,
388 and 1..9 are various speed/size tradeoffs, 9 being slowest.
389 If set, this provides a default to other compression variables,
390 such as 'core.loosecompression' and 'pack.compression'.
392 core.loosecompression::
393 An integer -1..9, indicating the compression level for objects that
394 are not in a pack file. -1 is the zlib default. 0 means no
395 compression, and 1..9 are various speed/size tradeoffs, 9 being
396 slowest. If not set, defaults to core.compression. If that is
397 not set, defaults to 1 (best speed).
399 core.packedGitWindowSize::
400 Number of bytes of a pack file to map into memory in a
401 single mapping operation. Larger window sizes may allow
402 your system to process a smaller number of large pack files
403 more quickly. Smaller window sizes will negatively affect
404 performance due to increased calls to the operating system's
405 memory manager, but may improve performance when accessing
406 a large number of large pack files.
408 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
409 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
410 be reasonable for all users/operating systems. You probably do
411 not need to adjust this value.
413 Common unit suffixes of 'k', 'm', or 'g' are supported.
415 core.packedGitLimit::
416 Maximum number of bytes to map simultaneously into memory
417 from pack files. If Git needs to access more than this many
418 bytes at once to complete an operation it will unmap existing
419 regions to reclaim virtual address space within the process.
421 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
422 This should be reasonable for all users/operating systems, except on
423 the largest projects. You probably do not need to adjust this value.
425 Common unit suffixes of 'k', 'm', or 'g' are supported.
427 core.deltaBaseCacheLimit::
428 Maximum number of bytes to reserve for caching base objects
429 that may be referenced by multiple deltified objects. By storing the
430 entire decompressed base objects in a cache Git is able
431 to avoid unpacking and decompressing frequently used base
432 objects multiple times.
434 Default is 16 MiB on all platforms. This should be reasonable
435 for all users/operating systems, except on the largest projects.
436 You probably do not need to adjust this value.
438 Common unit suffixes of 'k', 'm', or 'g' are supported.
440 core.bigFileThreshold::
441 Files larger than this size are stored deflated, without
442 attempting delta compression. Storing large files without
443 delta compression avoids excessive memory usage, at the
444 slight expense of increased disk usage.
446 Default is 512 MiB on all platforms. This should be reasonable
447 for most projects as source code and other text files can still
448 be delta compressed, but larger binary media files won't be.
450 Common unit suffixes of 'k', 'm', or 'g' are supported.
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 Some commands (e.g. svn and http interfaces) that interactively
461 ask for a password can be told to use an external program given
462 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
463 environment variable. If not set, fall back to the value of the
464 'SSH_ASKPASS' environment variable or, failing that, a simple password
465 prompt. The external program shall be given a suitable prompt as
466 command line argument and write the password on its STDOUT.
468 core.attributesfile::
469 In addition to '.gitattributes' (per-directory) and
470 '.git/info/attributes', git looks into this file for attributes
471 (see linkgit:gitattributes[5]). Path expansions are made the same
472 way as for `core.excludesfile`.
475 Commands such as `commit` and `tag` that lets you edit
476 messages by launching an editor uses the value of this
477 variable when it is set, and the environment variable
478 `GIT_EDITOR` is not set. See linkgit:git-var[1].
481 Text editor used by `git rebase -i` for editing the rebase insn file.
482 The value is meant to be interpreted by the shell when it is used.
483 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
484 When not configured the default commit message editor is used instead.
487 The command that git will use to paginate output. Can
488 be overridden with the `GIT_PAGER` environment
489 variable. Note that git sets the `LESS` environment
490 variable to `FRSX` if it is unset when it runs the
491 pager. One can change these settings by setting the
492 `LESS` variable to some other value. Alternately,
493 these settings can be overridden on a project or
494 global basis by setting the `core.pager` option.
495 Setting `core.pager` has no affect on the `LESS`
496 environment variable behaviour above, so if you want
497 to override git's default settings this way, you need
498 to be explicit. For example, to disable the S option
499 in a backward compatible manner, set `core.pager`
500 to `less -+$LESS -FRX`. This will be passed to the
501 shell by git, which will translate the final command to
502 `LESS=FRSX less -+FRSX -FRX`.
505 A comma separated list of common whitespace problems to
506 notice. 'git diff' will use `color.diff.whitespace` to
507 highlight them, and 'git apply --whitespace=error' will
508 consider them as errors. You can prefix `-` to disable
509 any of them (e.g. `-trailing-space`):
511 * `blank-at-eol` treats trailing whitespaces at the end of the line
512 as an error (enabled by default).
513 * `space-before-tab` treats a space character that appears immediately
514 before a tab character in the initial indent part of the line as an
515 error (enabled by default).
516 * `indent-with-non-tab` treats a line that is indented with 8 or more
517 space characters as an error (not enabled by default).
518 * `tab-in-indent` treats a tab character in the initial indent part of
519 the line as an error (not enabled by default).
520 * `blank-at-eof` treats blank lines added at the end of file as an error
521 (enabled by default).
522 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
524 * `cr-at-eol` treats a carriage-return at the end of line as
525 part of the line terminator, i.e. with it, `trailing-space`
526 does not trigger if the character before such a carriage-return
527 is not a whitespace (not enabled by default).
528 * `tabwidth=<n>` tells how many character positions a tab occupies; this
529 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
530 errors. The default tab width is 8. Allowed values are 1 to 63.
532 core.fsyncobjectfiles::
533 This boolean will enable 'fsync()' when writing object files.
535 This is a total waste of time and effort on a filesystem that orders
536 data writes properly, but can be useful for filesystems that do not use
537 journalling (traditional UNIX filesystems) or that only journal metadata
538 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
541 Enable parallel index preload for operations like 'git diff'
543 This can speed up operations like 'git diff' and 'git status' especially
544 on filesystems like NFS that have weak caching semantics and thus
545 relatively high IO latencies. With this set to 'true', git will do the
546 index comparison to the filesystem data in parallel, allowing
550 You can set this to 'link', in which case a hardlink followed by
551 a delete of the source are used to make sure that object creation
552 will not overwrite existing objects.
554 On some file system/operating system combinations, this is unreliable.
555 Set this config setting to 'rename' there; However, This will remove the
556 check that makes sure that existing object files will not get overwritten.
559 When showing commit messages, also show notes which are stored in
560 the given ref. The ref must be fully qualified. If the given
561 ref does not exist, it is not an error but means that no
562 notes should be printed.
564 This setting defaults to "refs/notes/commits", and it can be overridden by
565 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
567 core.sparseCheckout::
568 Enable "sparse checkout" feature. See section "Sparse checkout" in
569 linkgit:git-read-tree[1] for more information.
572 Set the length object names are abbreviated to. If unspecified,
573 many commands abbreviate to 7 hexdigits, which may not be enough
574 for abbreviated object names to stay unique for sufficiently long
579 Tells 'git add' to continue adding files when some files cannot be
580 added due to indexing errors. Equivalent to the '--ignore-errors'
581 option of linkgit:git-add[1]. Older versions of git accept only
582 `add.ignore-errors`, which does not follow the usual naming
583 convention for configuration variables. Newer versions of git
584 honor `add.ignoreErrors` as well.
587 Command aliases for the linkgit:git[1] command wrapper - e.g.
588 after defining "alias.last = cat-file commit HEAD", the invocation
589 "git last" is equivalent to "git cat-file commit HEAD". To avoid
590 confusion and troubles with script usage, aliases that
591 hide existing git commands are ignored. Arguments are split by
592 spaces, the usual shell quoting and escaping is supported.
593 quote pair and a backslash can be used to quote them.
595 If the alias expansion is prefixed with an exclamation point,
596 it will be treated as a shell command. For example, defining
597 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
598 "git new" is equivalent to running the shell command
599 "gitk --all --not ORIG_HEAD". Note that shell commands will be
600 executed from the top-level directory of a repository, which may
601 not necessarily be the current directory.
602 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
603 from the original current directory. See linkgit:git-rev-parse[1].
606 If true, git-am will call git-mailsplit for patches in mbox format
607 with parameter '--keep-cr'. In this case git-mailsplit will
608 not remove `\r` from lines ending with `\r\n`. Can be overridden
609 by giving '--no-keep-cr' from the command line.
610 See linkgit:git-am[1], linkgit:git-mailsplit[1].
612 apply.ignorewhitespace::
613 When set to 'change', tells 'git apply' to ignore changes in
614 whitespace, in the same way as the '--ignore-space-change'
616 When set to one of: no, none, never, false tells 'git apply' to
617 respect all whitespace differences.
618 See linkgit:git-apply[1].
621 Tells 'git apply' how to handle whitespaces, in the same way
622 as the '--whitespace' option. See linkgit:git-apply[1].
624 branch.autosetupmerge::
625 Tells 'git branch' and 'git checkout' to set up new branches
626 so that linkgit:git-pull[1] will appropriately merge from the
627 starting point branch. Note that even if this option is not set,
628 this behavior can be chosen per-branch using the `--track`
629 and `--no-track` options. The valid settings are: `false` -- no
630 automatic setup is done; `true` -- automatic setup is done when the
631 starting point is a remote-tracking branch; `always` --
632 automatic setup is done when the starting point is either a
633 local branch or remote-tracking
634 branch. This option defaults to true.
636 branch.autosetuprebase::
637 When a new branch is created with 'git branch' or 'git checkout'
638 that tracks another branch, this variable tells git to set
639 up pull to rebase instead of merge (see "branch.<name>.rebase").
640 When `never`, rebase is never automatically set to true.
641 When `local`, rebase is set to true for tracked branches of
642 other local branches.
643 When `remote`, rebase is set to true for tracked branches of
644 remote-tracking branches.
645 When `always`, rebase will be set to true for all tracking
647 See "branch.autosetupmerge" for details on how to set up a
648 branch to track another branch.
649 This option defaults to never.
651 branch.<name>.remote::
652 When in branch <name>, it tells 'git fetch' and 'git push' which
653 remote to fetch from/push to. It defaults to `origin` if no remote is
654 configured. `origin` is also used if you are not on any branch.
656 branch.<name>.merge::
657 Defines, together with branch.<name>.remote, the upstream branch
658 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
659 branch to merge and can also affect 'git push' (see push.default).
660 When in branch <name>, it tells 'git fetch' the default
661 refspec to be marked for merging in FETCH_HEAD. The value is
662 handled like the remote part of a refspec, and must match a
663 ref which is fetched from the remote given by
664 "branch.<name>.remote".
665 The merge information is used by 'git pull' (which at first calls
666 'git fetch') to lookup the default branch for merging. Without
667 this option, 'git pull' defaults to merge the first refspec fetched.
668 Specify multiple values to get an octopus merge.
669 If you wish to setup 'git pull' so that it merges into <name> from
670 another branch in the local repository, you can point
671 branch.<name>.merge to the desired branch, and use the special setting
672 `.` (a period) for branch.<name>.remote.
674 branch.<name>.mergeoptions::
675 Sets default options for merging into branch <name>. The syntax and
676 supported options are the same as those of linkgit:git-merge[1], but
677 option values containing whitespace characters are currently not
680 branch.<name>.rebase::
681 When true, rebase the branch <name> on top of the fetched branch,
682 instead of merging the default branch from the default remote when
683 "git pull" is run. See "pull.rebase" for doing this in a non
684 branch-specific manner.
686 *NOTE*: this is a possibly dangerous operation; do *not* use
687 it unless you understand the implications (see linkgit:git-rebase[1]
691 Specify the command to invoke the specified browser. The
692 specified command is evaluated in shell with the URLs passed
693 as arguments. (See linkgit:git-web{litdd}browse[1].)
695 browser.<tool>.path::
696 Override the path for the given tool that may be used to
697 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
698 working repository in gitweb (see linkgit:git-instaweb[1]).
701 A boolean to make git-clean do nothing unless given -f
702 or -n. Defaults to true.
705 A boolean to enable/disable color in the output of
706 linkgit:git-branch[1]. May be set to `always`,
707 `false` (or `never`) or `auto` (or `true`), in which case colors are used
708 only when the output is to a terminal. Defaults to false.
710 color.branch.<slot>::
711 Use customized color for branch coloration. `<slot>` is one of
712 `current` (the current branch), `local` (a local branch),
713 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
716 The value for these configuration variables is a list of colors (at most
717 two) and attributes (at most one), separated by spaces. The colors
718 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
719 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
720 `blink` and `reverse`. The first color given is the foreground; the
721 second is the background. The position of the attribute, if any,
725 Whether to use ANSI escape sequences to add color to patches.
726 If this is set to `always`, linkgit:git-diff[1],
727 linkgit:git-log[1], and linkgit:git-show[1] will use color
728 for all patches. If it is set to `true` or `auto`, those
729 commands will only use color when output is to the terminal.
732 This does not affect linkgit:git-format-patch[1] nor the
733 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
734 command line with the `--color[=<when>]` option.
737 Use customized color for diff colorization. `<slot>` specifies
738 which part of the patch to use the specified color, and is one
739 of `plain` (context text), `meta` (metainformation), `frag`
740 (hunk header), 'func' (function in hunk header), `old` (removed lines),
741 `new` (added lines), `commit` (commit headers), or `whitespace`
742 (highlighting whitespace errors). The values of these variables may be
743 specified as in color.branch.<slot>.
745 color.decorate.<slot>::
746 Use customized color for 'git log --decorate' output. `<slot>` is one
747 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
748 branches, remote-tracking branches, tags, stash and HEAD, respectively.
751 When set to `always`, always highlight matches. When `false` (or
752 `never`), never. When set to `true` or `auto`, use color only
753 when the output is written to the terminal. Defaults to `false`.
756 Use customized color for grep colorization. `<slot>` specifies which
757 part of the line to use the specified color, and is one of
761 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
763 filename prefix (when not using `-h`)
765 function name lines (when using `-p`)
767 line number prefix (when using `-n`)
771 non-matching text in selected lines
773 separators between fields on a line (`:`, `-`, and `=`)
774 and between hunks (`--`)
777 The values of these variables may be specified as in color.branch.<slot>.
780 When set to `always`, always use colors for interactive prompts
781 and displays (such as those used by "git-add --interactive").
782 When false (or `never`), never. When set to `true` or `auto`, use
783 colors only when the output is to the terminal. Defaults to false.
785 color.interactive.<slot>::
786 Use customized color for 'git add --interactive'
787 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
788 four distinct types of normal output from interactive
789 commands. The values of these variables may be specified as
790 in color.branch.<slot>.
793 A boolean to enable/disable colored output when the pager is in
794 use (default is true).
797 A boolean to enable/disable color in the output of
798 linkgit:git-show-branch[1]. May be set to `always`,
799 `false` (or `never`) or `auto` (or `true`), in which case colors are used
800 only when the output is to a terminal. Defaults to false.
803 A boolean to enable/disable color in the output of
804 linkgit:git-status[1]. May be set to `always`,
805 `false` (or `never`) or `auto` (or `true`), in which case colors are used
806 only when the output is to a terminal. Defaults to false.
808 color.status.<slot>::
809 Use customized color for status colorization. `<slot>` is
810 one of `header` (the header text of the status message),
811 `added` or `updated` (files which are added but not committed),
812 `changed` (files which are changed but not added in the index),
813 `untracked` (files which are not tracked by git),
814 `branch` (the current branch), or
815 `nobranch` (the color the 'no branch' warning is shown in, defaulting
816 to red). The values of these variables may be specified as in
820 This variable determines the default value for variables such
821 as `color.diff` and `color.grep` that control the use of color
822 per command family. Its scope will expand as more commands learn
823 configuration to set a default for the `--color` option. Set it
824 to `always` if you want all output not intended for machine
825 consumption to use color, to `true` or `auto` if you want such
826 output to use color when written to the terminal, or to `false` or
827 `never` if you prefer git commands not to use color unless enabled
828 explicitly with some other configuration or the `--color` option.
831 A boolean to enable/disable inclusion of status information in the
832 commit message template when using an editor to prepare the commit
833 message. Defaults to true.
836 Specify a file to use as the template for new commit messages.
837 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
838 specified user's home directory.
841 Specify an external helper to be called when a username or
842 password credential is needed; the helper may consult external
843 storage to avoid prompting the user for the credentials. See
844 linkgit:gitcredentials[7] for details.
846 credential.useHttpPath::
847 When acquiring credentials, consider the "path" component of an http
848 or https URL to be important. Defaults to false. See
849 linkgit:gitcredentials[7] for more information.
851 credential.username::
852 If no username is set for a network authentication, use this username
853 by default. See credential.<context>.* below, and
854 linkgit:gitcredentials[7].
857 Any of the credential.* options above can be applied selectively to
858 some credentials. For example "credential.https://example.com.username"
859 would set the default username only for https connections to
860 example.com. See linkgit:gitcredentials[7] for details on how URLs are
863 include::diff-config.txt[]
865 difftool.<tool>.path::
866 Override the path for the given tool. This is useful in case
867 your tool is not in the PATH.
869 difftool.<tool>.cmd::
870 Specify the command to invoke the specified diff tool.
871 The specified command is evaluated in shell with the following
872 variables available: 'LOCAL' is set to the name of the temporary
873 file containing the contents of the diff pre-image and 'REMOTE'
874 is set to the name of the temporary file containing the contents
875 of the diff post-image.
878 Prompt before each invocation of the diff tool.
881 A POSIX Extended Regular Expression used to determine what is a "word"
882 when performing word-by-word difference calculations. Character
883 sequences that match the regular expression are "words", all other
884 characters are *ignorable* whitespace.
886 fetch.recurseSubmodules::
887 This option can be either set to a boolean value or to 'on-demand'.
888 Setting it to a boolean changes the behavior of fetch and pull to
889 unconditionally recurse into submodules when set to true or to not
890 recurse at all when set to false. When set to 'on-demand' (the default
891 value), fetch and pull will only recurse into a populated submodule
892 when its superproject retrieves a commit that updates the submodule's
896 If it is set to true, git-fetch-pack will check all fetched
897 objects. It will abort in the case of a malformed object or a
898 broken link. The result of an abort are only dangling objects.
899 Defaults to false. If not set, the value of `transfer.fsckObjects`
903 If the number of objects fetched over the git native
904 transfer is below this
905 limit, then the objects will be unpacked into loose object
906 files. However if the number of received objects equals or
907 exceeds this limit then the received pack will be stored as
908 a pack, after adding any missing delta bases. Storing the
909 pack from a push can make the push operation complete faster,
910 especially on slow filesystems. If not set, the value of
911 `transfer.unpackLimit` is used instead.
914 Enable multipart/mixed attachments as the default for
915 'format-patch'. The value can also be a double quoted string
916 which will enable attachments as the default and set the
917 value as the boundary. See the --attach option in
918 linkgit:git-format-patch[1].
921 A boolean which can enable or disable sequence numbers in patch
922 subjects. It defaults to "auto" which enables it only if there
923 is more than one patch. It can be enabled or disabled for all
924 messages by setting it to "true" or "false". See --numbered
925 option in linkgit:git-format-patch[1].
928 Additional email headers to include in a patch to be submitted
929 by mail. See linkgit:git-format-patch[1].
933 Additional recipients to include in a patch to be submitted
934 by mail. See the --to and --cc options in
935 linkgit:git-format-patch[1].
937 format.subjectprefix::
938 The default for format-patch is to output files with the '[PATCH]'
939 subject prefix. Use this variable to change that prefix.
942 The default for format-patch is to output a signature containing
943 the git version number. Use this variable to change that default.
944 Set this variable to the empty string ("") to suppress
945 signature generation.
948 The default for format-patch is to output files with the suffix
949 `.patch`. Use this variable to change that suffix (make sure to
950 include the dot if you want it).
953 The default pretty format for log/show/whatchanged command,
954 See linkgit:git-log[1], linkgit:git-show[1],
955 linkgit:git-whatchanged[1].
958 The default threading style for 'git format-patch'. Can be
959 a boolean value, or `shallow` or `deep`. `shallow` threading
960 makes every mail a reply to the head of the series,
961 where the head is chosen from the cover letter, the
962 `\--in-reply-to`, and the first patch mail, in this order.
963 `deep` threading makes every mail a reply to the previous one.
964 A true boolean value is the same as `shallow`, and a false
965 value disables threading.
968 A boolean value which lets you enable the `-s/--signoff` option of
969 format-patch by default. *Note:* Adding the Signed-off-by: line to a
970 patch should be a conscious act and means that you certify you have
971 the rights to submit this work under the same open source license.
972 Please see the 'SubmittingPatches' document for further discussion.
974 filter.<driver>.clean::
975 The command which is used to convert the content of a worktree
976 file to a blob upon checkin. See linkgit:gitattributes[5] for
979 filter.<driver>.smudge::
980 The command which is used to convert the content of a blob
981 object to a worktree file upon checkout. See
982 linkgit:gitattributes[5] for details.
984 gc.aggressiveWindow::
985 The window size parameter used in the delta compression
986 algorithm used by 'git gc --aggressive'. This defaults
990 When there are approximately more than this many loose
991 objects in the repository, `git gc --auto` will pack them.
992 Some Porcelain commands use this command to perform a
993 light-weight garbage collection from time to time. The
994 default value is 6700. Setting this to 0 disables it.
997 When there are more than this many packs that are not
998 marked with `*.keep` file in the repository, `git gc
999 --auto` consolidates them into one larger pack. The
1000 default value is 50. Setting this to 0 disables it.
1003 Running `git pack-refs` in a repository renders it
1004 unclonable by Git versions prior to 1.5.1.2 over dumb
1005 transports such as HTTP. This variable determines whether
1006 'git gc' runs `git pack-refs`. This can be set to `notbare`
1007 to enable it within all non-bare repos or it can be set to a
1008 boolean value. The default is `true`.
1011 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1012 Override the grace period with this config variable. The value
1013 "now" may be used to disable this grace period and always prune
1014 unreachable objects immediately.
1017 gc.<pattern>.reflogexpire::
1018 'git reflog expire' removes reflog entries older than
1019 this time; defaults to 90 days. With "<pattern>" (e.g.
1020 "refs/stash") in the middle the setting applies only to
1021 the refs that match the <pattern>.
1023 gc.reflogexpireunreachable::
1024 gc.<ref>.reflogexpireunreachable::
1025 'git reflog expire' removes reflog entries older than
1026 this time and are not reachable from the current tip;
1027 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1028 in the middle, the setting applies only to the refs that
1029 match the <pattern>.
1032 Records of conflicted merge you resolved earlier are
1033 kept for this many days when 'git rerere gc' is run.
1034 The default is 60 days. See linkgit:git-rerere[1].
1036 gc.rerereunresolved::
1037 Records of conflicted merge you have not resolved are
1038 kept for this many days when 'git rerere gc' is run.
1039 The default is 15 days. See linkgit:git-rerere[1].
1041 gitcvs.commitmsgannotation::
1042 Append this string to each commit message. Set to empty string
1043 to disable this feature. Defaults to "via git-CVS emulator".
1046 Whether the CVS server interface is enabled for this repository.
1047 See linkgit:git-cvsserver[1].
1050 Path to a log file where the CVS server interface well... logs
1051 various stuff. See linkgit:git-cvsserver[1].
1053 gitcvs.usecrlfattr::
1054 If true, the server will look up the end-of-line conversion
1055 attributes for files to determine the '-k' modes to use. If
1056 the attributes force git to treat a file as text,
1057 the '-k' mode will be left blank so CVS clients will
1058 treat it as text. If they suppress text conversion, the file
1059 will be set with '-kb' mode, which suppresses any newline munging
1060 the client might otherwise do. If the attributes do not allow
1061 the file type to be determined, then 'gitcvs.allbinary' is
1062 used. See linkgit:gitattributes[5].
1065 This is used if 'gitcvs.usecrlfattr' does not resolve
1066 the correct '-kb' mode to use. If true, all
1067 unresolved files are sent to the client in
1068 mode '-kb'. This causes the client to treat them
1069 as binary files, which suppresses any newline munging it
1070 otherwise might do. Alternatively, if it is set to "guess",
1071 then the contents of the file are examined to decide if
1072 it is binary, similar to 'core.autocrlf'.
1075 Database used by git-cvsserver to cache revision information
1076 derived from the git repository. The exact meaning depends on the
1077 used database driver, for SQLite (which is the default driver) this
1078 is a filename. Supports variable substitution (see
1079 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1080 Default: '%Ggitcvs.%m.sqlite'
1083 Used Perl DBI driver. You can specify any available driver
1084 for this here, but it might not work. git-cvsserver is tested
1085 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1086 reported *not* to work with 'DBD::mysql'. Experimental feature.
1087 May not contain double colons (`:`). Default: 'SQLite'.
1088 See linkgit:git-cvsserver[1].
1090 gitcvs.dbuser, gitcvs.dbpass::
1091 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1092 since SQLite has no concept of database users and/or passwords.
1093 'gitcvs.dbuser' supports variable substitution (see
1094 linkgit:git-cvsserver[1] for details).
1096 gitcvs.dbTableNamePrefix::
1097 Database table name prefix. Prepended to the names of any
1098 database tables used, allowing a single database to be used
1099 for several repositories. Supports variable substitution (see
1100 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1101 characters will be replaced with underscores.
1103 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1104 'gitcvs.allbinary' can also be specified as
1105 'gitcvs.<access_method>.<varname>' (where 'access_method'
1106 is one of "ext" and "pserver") to make them apply only for the given
1110 gitweb.description::
1113 See linkgit:gitweb[1] for description.
1121 gitweb.remote_heads::
1124 See linkgit:gitweb.conf[5] for description.
1127 If set to true, enable '-n' option by default.
1129 grep.extendedRegexp::
1130 If set to true, enable '--extended-regexp' option by default.
1133 Use this custom program instead of "gpg" found on $PATH when
1134 making or verifying a PGP signature. The program must support the
1135 same command line interface as GPG, namely, to verify a detached
1136 signature, "gpg --verify $file - <$signature" is run, and the
1137 program is expected to signal a good signature by exiting with
1138 code 0, and to generate an ascii-armored detached signature, the
1139 standard input of "gpg -bsau $key" is fed with the contents to be
1140 signed, and the program is expected to send the result to its
1143 gui.commitmsgwidth::
1144 Defines how wide the commit message window is in the
1145 linkgit:git-gui[1]. "75" is the default.
1148 Specifies how many context lines should be used in calls to diff
1149 made by the linkgit:git-gui[1]. The default is "5".
1152 Specifies the default encoding to use for displaying of
1153 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1154 It can be overridden by setting the 'encoding' attribute
1155 for relevant files (see linkgit:gitattributes[5]).
1156 If this option is not set, the tools default to the
1159 gui.matchtrackingbranch::
1160 Determines if new branches created with linkgit:git-gui[1] should
1161 default to tracking remote branches with matching names or
1162 not. Default: "false".
1164 gui.newbranchtemplate::
1165 Is used as suggested name when creating new branches using the
1168 gui.pruneduringfetch::
1169 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1170 performing a fetch. The default value is "false".
1173 Determines if linkgit:git-gui[1] should trust the file modification
1174 timestamp or not. By default the timestamps are not trusted.
1176 gui.spellingdictionary::
1177 Specifies the dictionary used for spell checking commit messages in
1178 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1182 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1183 location detection. It makes blame significantly faster on huge
1184 repositories at the expense of less thorough copy detection.
1186 gui.copyblamethreshold::
1187 Specifies the threshold to use in 'git gui blame' original location
1188 detection, measured in alphanumeric characters. See the
1189 linkgit:git-blame[1] manual for more information on copy detection.
1191 gui.blamehistoryctx::
1192 Specifies the radius of history context in days to show in
1193 linkgit:gitk[1] for the selected commit, when the `Show History
1194 Context` menu item is invoked from 'git gui blame'. If this
1195 variable is set to zero, the whole history is shown.
1197 guitool.<name>.cmd::
1198 Specifies the shell command line to execute when the corresponding item
1199 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1200 mandatory for every tool. The command is executed from the root of
1201 the working directory, and in the environment it receives the name of
1202 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1203 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1204 the head is detached, 'CUR_BRANCH' is empty).
1206 guitool.<name>.needsfile::
1207 Run the tool only if a diff is selected in the GUI. It guarantees
1208 that 'FILENAME' is not empty.
1210 guitool.<name>.noconsole::
1211 Run the command silently, without creating a window to display its
1214 guitool.<name>.norescan::
1215 Don't rescan the working directory for changes after the tool
1218 guitool.<name>.confirm::
1219 Show a confirmation dialog before actually running the tool.
1221 guitool.<name>.argprompt::
1222 Request a string argument from the user, and pass it to the tool
1223 through the 'ARGS' environment variable. Since requesting an
1224 argument implies confirmation, the 'confirm' option has no effect
1225 if this is enabled. If the option is set to 'true', 'yes', or '1',
1226 the dialog uses a built-in generic prompt; otherwise the exact
1227 value of the variable is used.
1229 guitool.<name>.revprompt::
1230 Request a single valid revision from the user, and set the
1231 'REVISION' environment variable. In other aspects this option
1232 is similar to 'argprompt', and can be used together with it.
1234 guitool.<name>.revunmerged::
1235 Show only unmerged branches in the 'revprompt' subdialog.
1236 This is useful for tools similar to merge or rebase, but not
1237 for things like checkout or reset.
1239 guitool.<name>.title::
1240 Specifies the title to use for the prompt dialog. The default
1243 guitool.<name>.prompt::
1244 Specifies the general prompt string to display at the top of
1245 the dialog, before subsections for 'argprompt' and 'revprompt'.
1246 The default value includes the actual command.
1249 Specify the browser that will be used to display help in the
1250 'web' format. See linkgit:git-help[1].
1253 Override the default help format used by linkgit:git-help[1].
1254 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1255 the default. 'web' and 'html' are the same.
1258 Automatically correct and execute mistyped commands after
1259 waiting for the given number of deciseconds (0.1 sec). If more
1260 than one command can be deduced from the entered text, nothing
1261 will be executed. If the value of this option is negative,
1262 the corrected command will be executed immediately. If the
1263 value is 0 - the command will be just shown but not executed.
1264 This is the default.
1267 Override the HTTP proxy, normally configured using the 'http_proxy'
1268 environment variable (see linkgit:curl[1]). This can be overridden
1269 on a per-remote basis; see remote.<name>.proxy
1272 File containing previously stored cookie lines which should be used
1273 in the git http session, if they match the server. The file format
1274 of the file to read cookies from should be plain HTTP headers or
1275 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1276 NOTE that the file specified with http.cookiefile is only used as
1277 input. No cookies will be stored in the file.
1280 Whether to verify the SSL certificate when fetching or pushing
1281 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1285 File containing the SSL certificate when fetching or pushing
1286 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1290 File containing the SSL private key when fetching or pushing
1291 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1294 http.sslCertPasswordProtected::
1295 Enable git's password prompt for the SSL certificate. Otherwise
1296 OpenSSL will prompt the user, possibly many times, if the
1297 certificate or private key is encrypted. Can be overridden by the
1298 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1301 File containing the certificates to verify the peer with when
1302 fetching or pushing over HTTPS. Can be overridden by the
1303 'GIT_SSL_CAINFO' environment variable.
1306 Path containing files with the CA certificates to verify the peer
1307 with when fetching or pushing over HTTPS. Can be overridden
1308 by the 'GIT_SSL_CAPATH' environment variable.
1311 How many HTTP requests to launch in parallel. Can be overridden
1312 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1315 The number of curl sessions (counted across slots) to be kept across
1316 requests. They will not be ended with curl_easy_cleanup() until
1317 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1318 value will be capped at 1. Defaults to 1.
1321 Maximum size in bytes of the buffer used by smart HTTP
1322 transports when POSTing data to the remote system.
1323 For requests larger than this buffer size, HTTP/1.1 and
1324 Transfer-Encoding: chunked is used to avoid creating a
1325 massive pack file locally. Default is 1 MiB, which is
1326 sufficient for most requests.
1328 http.lowSpeedLimit, http.lowSpeedTime::
1329 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1330 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1331 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1332 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1335 A boolean which disables using of EPSV ftp command by curl.
1336 This can helpful with some "poor" ftp servers which don't
1337 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1338 environment variable. Default is false (curl will use EPSV).
1341 The HTTP USER_AGENT string presented to an HTTP server. The default
1342 value represents the version of the client git such as git/1.7.1.
1343 This option allows you to override this value to a more common value
1344 such as Mozilla/4.0. This may be necessary, for instance, if
1345 connecting through a firewall that restricts HTTP connections to a set
1346 of common USER_AGENT strings (but not including those like git/1.7.1).
1347 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1349 i18n.commitEncoding::
1350 Character encoding the commit messages are stored in; git itself
1351 does not care per se, but this information is necessary e.g. when
1352 importing commits from emails or in the gitk graphical history
1353 browser (and possibly at other places in the future or in other
1354 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1356 i18n.logOutputEncoding::
1357 Character encoding the commit messages are converted to when
1358 running 'git log' and friends.
1361 The configuration variables in the 'imap' section are described
1362 in linkgit:git-imap-send[1].
1365 Specify the directory from which templates will be copied.
1366 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1369 Specify the program that will be used to browse your working
1370 repository in gitweb. See linkgit:git-instaweb[1].
1373 The HTTP daemon command-line to start gitweb on your working
1374 repository. See linkgit:git-instaweb[1].
1377 If true the web server started by linkgit:git-instaweb[1] will
1378 be bound to the local IP (127.0.0.1).
1380 instaweb.modulepath::
1381 The default module path for linkgit:git-instaweb[1] to use
1382 instead of /usr/lib/apache2/modules. Only used if httpd
1386 The port number to bind the gitweb httpd to. See
1387 linkgit:git-instaweb[1].
1389 interactive.singlekey::
1390 In interactive commands, allow the user to provide one-letter
1391 input with a single key (i.e., without hitting enter).
1392 Currently this is used by the `\--patch` mode of
1393 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1394 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1395 setting is silently ignored if portable keystroke input
1399 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1400 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1401 override this option with `\--no-abbrev-commit`.
1404 Set the default date-time mode for the 'log' command.
1405 Setting a value for log.date is similar to using 'git log''s
1406 `\--date` option. Possible values are `relative`, `local`,
1407 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1411 Print out the ref names of any commits that are shown by the log
1412 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1413 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1414 specified, the full ref name (including prefix) will be printed.
1415 This is the same as the log commands '--decorate' option.
1418 If true, the initial commit will be shown as a big creation event.
1419 This is equivalent to a diff against an empty tree.
1420 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1421 normally hide the root commit will now show it. True by default.
1424 The location of an augmenting mailmap file. The default
1425 mailmap, located in the root of the repository, is loaded
1426 first, then the mailmap file pointed to by this variable.
1427 The location of the mailmap file may be in a repository
1428 subdirectory, or somewhere outside of the repository itself.
1429 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1432 Specify the programs that may be used to display help in the
1433 'man' format. See linkgit:git-help[1].
1436 Specify the command to invoke the specified man viewer. The
1437 specified command is evaluated in shell with the man page
1438 passed as argument. (See linkgit:git-help[1].)
1441 Override the path for the given tool that may be used to
1442 display help in the 'man' format. See linkgit:git-help[1].
1444 include::merge-config.txt[]
1446 mergetool.<tool>.path::
1447 Override the path for the given tool. This is useful in case
1448 your tool is not in the PATH.
1450 mergetool.<tool>.cmd::
1451 Specify the command to invoke the specified merge tool. The
1452 specified command is evaluated in shell with the following
1453 variables available: 'BASE' is the name of a temporary file
1454 containing the common base of the files to be merged, if available;
1455 'LOCAL' is the name of a temporary file containing the contents of
1456 the file on the current branch; 'REMOTE' is the name of a temporary
1457 file containing the contents of the file from the branch being
1458 merged; 'MERGED' contains the name of the file to which the merge
1459 tool should write the results of a successful merge.
1461 mergetool.<tool>.trustExitCode::
1462 For a custom merge command, specify whether the exit code of
1463 the merge command can be used to determine whether the merge was
1464 successful. If this is not set to true then the merge target file
1465 timestamp is checked and the merge assumed to have been successful
1466 if the file has been updated, otherwise the user is prompted to
1467 indicate the success of the merge.
1469 mergetool.keepBackup::
1470 After performing a merge, the original file with conflict markers
1471 can be saved as a file with a `.orig` extension. If this variable
1472 is set to `false` then this file is not preserved. Defaults to
1473 `true` (i.e. keep the backup files).
1475 mergetool.keepTemporaries::
1476 When invoking a custom merge tool, git uses a set of temporary
1477 files to pass to the tool. If the tool returns an error and this
1478 variable is set to `true`, then these temporary files will be
1479 preserved, otherwise they will be removed after the tool has
1480 exited. Defaults to `false`.
1483 Prompt before each invocation of the merge resolution program.
1486 The (fully qualified) refname from which to show notes when
1487 showing commit messages. The value of this variable can be set
1488 to a glob, in which case notes from all matching refs will be
1489 shown. You may also specify this configuration variable
1490 several times. A warning will be issued for refs that do not
1491 exist, but a glob that does not match any refs is silently
1494 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1495 environment variable, which must be a colon separated list of refs or
1498 The effective value of "core.notesRef" (possibly overridden by
1499 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1502 notes.rewrite.<command>::
1503 When rewriting commits with <command> (currently `amend` or
1504 `rebase`) and this variable is set to `true`, git
1505 automatically copies your notes from the original to the
1506 rewritten commit. Defaults to `true`, but see
1507 "notes.rewriteRef" below.
1510 When copying notes during a rewrite (see the
1511 "notes.rewrite.<command>" option), determines what to do if
1512 the target commit already has a note. Must be one of
1513 `overwrite`, `concatenate`, or `ignore`. Defaults to
1516 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1517 environment variable.
1520 When copying notes during a rewrite, specifies the (fully
1521 qualified) ref whose notes should be copied. The ref may be a
1522 glob, in which case notes in all matching refs will be copied.
1523 You may also specify this configuration several times.
1525 Does not have a default value; you must configure this variable to
1526 enable note rewriting. Set it to `refs/notes/commits` to enable
1527 rewriting for the default commit notes.
1529 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1530 environment variable, which must be a colon separated list of refs or
1534 The size of the window used by linkgit:git-pack-objects[1] when no
1535 window size is given on the command line. Defaults to 10.
1538 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1539 maximum depth is given on the command line. Defaults to 50.
1542 The window memory size limit used by linkgit:git-pack-objects[1]
1543 when no limit is given on the command line. The value can be
1544 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1548 An integer -1..9, indicating the compression level for objects
1549 in a pack file. -1 is the zlib default. 0 means no
1550 compression, and 1..9 are various speed/size tradeoffs, 9 being
1551 slowest. If not set, defaults to core.compression. If that is
1552 not set, defaults to -1, the zlib default, which is "a default
1553 compromise between speed and compression (currently equivalent
1556 Note that changing the compression level will not automatically recompress
1557 all existing objects. You can force recompression by passing the -F option
1558 to linkgit:git-repack[1].
1560 pack.deltaCacheSize::
1561 The maximum memory in bytes used for caching deltas in
1562 linkgit:git-pack-objects[1] before writing them out to a pack.
1563 This cache is used to speed up the writing object phase by not
1564 having to recompute the final delta result once the best match
1565 for all objects is found. Repacking large repositories on machines
1566 which are tight with memory might be badly impacted by this though,
1567 especially if this cache pushes the system into swapping.
1568 A value of 0 means no limit. The smallest size of 1 byte may be
1569 used to virtually disable this cache. Defaults to 256 MiB.
1571 pack.deltaCacheLimit::
1572 The maximum size of a delta, that is cached in
1573 linkgit:git-pack-objects[1]. This cache is used to speed up the
1574 writing object phase by not having to recompute the final delta
1575 result once the best match for all objects is found. Defaults to 1000.
1578 Specifies the number of threads to spawn when searching for best
1579 delta matches. This requires that linkgit:git-pack-objects[1]
1580 be compiled with pthreads otherwise this option is ignored with a
1581 warning. This is meant to reduce packing time on multiprocessor
1582 machines. The required amount of memory for the delta search window
1583 is however multiplied by the number of threads.
1584 Specifying 0 will cause git to auto-detect the number of CPU's
1585 and set the number of threads accordingly.
1588 Specify the default pack index version. Valid values are 1 for
1589 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1590 the new pack index with capabilities for packs larger than 4 GB
1591 as well as proper protection against the repacking of corrupted
1592 packs. Version 2 is the default. Note that version 2 is enforced
1593 and this config option ignored whenever the corresponding pack is
1596 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1597 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1598 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1599 other side may give you a repository that cannot be accessed with your
1600 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1601 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1602 the `{asterisk}.idx` file.
1604 pack.packSizeLimit::
1605 The maximum size of a pack. This setting only affects
1606 packing to a file when repacking, i.e. the git:// protocol
1607 is unaffected. It can be overridden by the `\--max-pack-size`
1608 option of linkgit:git-repack[1]. The minimum size allowed is
1609 limited to 1 MiB. The default is unlimited.
1610 Common unit suffixes of 'k', 'm', or 'g' are
1614 If the value is boolean, turns on or off pagination of the
1615 output of a particular git subcommand when writing to a tty.
1616 Otherwise, turns on pagination for the subcommand using the
1617 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1618 or `\--no-pager` is specified on the command line, it takes
1619 precedence over this option. To disable pagination for all
1620 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1623 Alias for a --pretty= format string, as specified in
1624 linkgit:git-log[1]. Any aliases defined here can be used just
1625 as the built-in pretty formats could. For example,
1626 running `git config pretty.changelog "format:{asterisk} %H %s"`
1627 would cause the invocation `git log --pretty=changelog`
1628 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1629 Note that an alias with the same name as a built-in format
1630 will be silently ignored.
1633 When true, rebase branches on top of the fetched branch, instead
1634 of merging the default branch from the default remote when "git
1635 pull" is run. See "branch.<name>.rebase" for setting this on a
1638 *NOTE*: this is a possibly dangerous operation; do *not* use
1639 it unless you understand the implications (see linkgit:git-rebase[1]
1643 The default merge strategy to use when pulling multiple branches
1647 The default merge strategy to use when pulling a single branch.
1650 Defines the action git push should take if no refspec is given
1651 on the command line, no refspec is configured in the remote, and
1652 no refspec is implied by any of the options given on the command
1653 line. Possible values are:
1655 * `nothing` - do not push anything.
1656 * `matching` - push all matching branches.
1657 All branches having the same name in both ends are considered to be
1658 matching. This is the default.
1659 * `upstream` - push the current branch to its upstream branch.
1660 * `tracking` - deprecated synonym for `upstream`.
1661 * `current` - push the current branch to a branch of the same name.
1664 Whether to show a diffstat of what changed upstream since the last
1665 rebase. False by default.
1668 If set to true enable '--autosquash' option by default.
1671 By default, git-receive-pack will run "git-gc --auto" after
1672 receiving data from git-push and updating refs. You can stop
1673 it by setting this variable to false.
1675 receive.fsckObjects::
1676 If it is set to true, git-receive-pack will check all received
1677 objects. It will abort in the case of a malformed object or a
1678 broken link. The result of an abort are only dangling objects.
1679 Defaults to false. If not set, the value of `transfer.fsckObjects`
1682 receive.unpackLimit::
1683 If the number of objects received in a push is below this
1684 limit then the objects will be unpacked into loose object
1685 files. However if the number of received objects equals or
1686 exceeds this limit then the received pack will be stored as
1687 a pack, after adding any missing delta bases. Storing the
1688 pack from a push can make the push operation complete faster,
1689 especially on slow filesystems. If not set, the value of
1690 `transfer.unpackLimit` is used instead.
1692 receive.denyDeletes::
1693 If set to true, git-receive-pack will deny a ref update that deletes
1694 the ref. Use this to prevent such a ref deletion via a push.
1696 receive.denyDeleteCurrent::
1697 If set to true, git-receive-pack will deny a ref update that
1698 deletes the currently checked out branch of a non-bare repository.
1700 receive.denyCurrentBranch::
1701 If set to true or "refuse", git-receive-pack will deny a ref update
1702 to the currently checked out branch of a non-bare repository.
1703 Such a push is potentially dangerous because it brings the HEAD
1704 out of sync with the index and working tree. If set to "warn",
1705 print a warning of such a push to stderr, but allow the push to
1706 proceed. If set to false or "ignore", allow such pushes with no
1707 message. Defaults to "refuse".
1709 There are two more options that are meant for Git experts: "updateInstead"
1710 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1711 the HEAD so it does not need to change. Both options come with their own
1712 set of possible *complications*, but can be appropriate in rare workflows.
1714 receive.denyNonFastForwards::
1715 If set to true, git-receive-pack will deny a ref update which is
1716 not a fast-forward. Use this to prevent such an update via a push,
1717 even if that push is forced. This configuration variable is
1718 set when initializing a shared repository.
1720 receive.updateserverinfo::
1721 If set to true, git-receive-pack will run git-update-server-info
1722 after receiving data from git-push and updating refs.
1725 The URL of a remote repository. See linkgit:git-fetch[1] or
1726 linkgit:git-push[1].
1728 remote.<name>.pushurl::
1729 The push URL of a remote repository. See linkgit:git-push[1].
1731 remote.<name>.proxy::
1732 For remotes that require curl (http, https and ftp), the URL to
1733 the proxy to use for that remote. Set to the empty string to
1734 disable proxying for that remote.
1736 remote.<name>.fetch::
1737 The default set of "refspec" for linkgit:git-fetch[1]. See
1738 linkgit:git-fetch[1].
1740 remote.<name>.push::
1741 The default set of "refspec" for linkgit:git-push[1]. See
1742 linkgit:git-push[1].
1744 remote.<name>.mirror::
1745 If true, pushing to this remote will automatically behave
1746 as if the `\--mirror` option was given on the command line.
1748 remote.<name>.skipDefaultUpdate::
1749 If true, this remote will be skipped by default when updating
1750 using linkgit:git-fetch[1] or the `update` subcommand of
1751 linkgit:git-remote[1].
1753 remote.<name>.skipFetchAll::
1754 If true, this remote will be skipped by default when updating
1755 using linkgit:git-fetch[1] or the `update` subcommand of
1756 linkgit:git-remote[1].
1758 remote.<name>.receivepack::
1759 The default program to execute on the remote side when pushing. See
1760 option \--receive-pack of linkgit:git-push[1].
1762 remote.<name>.uploadpack::
1763 The default program to execute on the remote side when fetching. See
1764 option \--upload-pack of linkgit:git-fetch-pack[1].
1766 remote.<name>.tagopt::
1767 Setting this value to \--no-tags disables automatic tag following when
1768 fetching from remote <name>. Setting it to \--tags will fetch every
1769 tag from remote <name>, even if they are not reachable from remote
1770 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1771 override this setting. See options \--tags and \--no-tags of
1772 linkgit:git-fetch[1].
1775 Setting this to a value <vcs> will cause git to interact with
1776 the remote with the git-remote-<vcs> helper.
1779 The list of remotes which are fetched by "git remote update
1780 <group>". See linkgit:git-remote[1].
1782 repack.usedeltabaseoffset::
1783 By default, linkgit:git-repack[1] creates packs that use
1784 delta-base offset. If you need to share your repository with
1785 git older than version 1.4.4, either directly or via a dumb
1786 protocol such as http, then you need to set this option to
1787 "false" and repack. Access from old git versions over the
1788 native protocol are unaffected by this option.
1791 When set to true, `git-rerere` updates the index with the
1792 resulting contents after it cleanly resolves conflicts using
1793 previously recorded resolution. Defaults to false.
1796 Activate recording of resolved conflicts, so that identical
1797 conflict hunks can be resolved automatically, should they
1798 be encountered again. linkgit:git-rerere[1] command is by
1799 default enabled if you create `rr-cache` directory under
1800 `$GIT_DIR`, but can be disabled by setting this option to false.
1802 sendemail.identity::
1803 A configuration identity. When given, causes values in the
1804 'sendemail.<identity>' subsection to take precedence over
1805 values in the 'sendemail' section. The default identity is
1806 the value of 'sendemail.identity'.
1808 sendemail.smtpencryption::
1809 See linkgit:git-send-email[1] for description. Note that this
1810 setting is not subject to the 'identity' mechanism.
1813 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1815 sendemail.<identity>.*::
1816 Identity-specific versions of the 'sendemail.*' parameters
1817 found below, taking precedence over those when the this
1818 identity is selected, through command-line or
1819 'sendemail.identity'.
1821 sendemail.aliasesfile::
1822 sendemail.aliasfiletype::
1826 sendemail.chainreplyto::
1828 sendemail.envelopesender::
1830 sendemail.multiedit::
1831 sendemail.signedoffbycc::
1832 sendemail.smtppass::
1833 sendemail.suppresscc::
1834 sendemail.suppressfrom::
1836 sendemail.smtpdomain::
1837 sendemail.smtpserver::
1838 sendemail.smtpserverport::
1839 sendemail.smtpserveroption::
1840 sendemail.smtpuser::
1842 sendemail.validate::
1843 See linkgit:git-send-email[1] for description.
1845 sendemail.signedoffcc::
1846 Deprecated alias for 'sendemail.signedoffbycc'.
1848 showbranch.default::
1849 The default set of branches for linkgit:git-show-branch[1].
1850 See linkgit:git-show-branch[1].
1852 status.relativePaths::
1853 By default, linkgit:git-status[1] shows paths relative to the
1854 current directory. Setting this variable to `false` shows paths
1855 relative to the repository root (this was the default for git
1858 status.showUntrackedFiles::
1859 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1860 files which are not currently tracked by Git. Directories which
1861 contain only untracked files, are shown with the directory name
1862 only. Showing untracked files means that Git needs to lstat() all
1863 all the files in the whole repository, which might be slow on some
1864 systems. So, this variable controls how the commands displays
1865 the untracked files. Possible values are:
1868 * `no` - Show no untracked files.
1869 * `normal` - Show untracked files and directories.
1870 * `all` - Show also individual files in untracked directories.
1873 If this variable is not specified, it defaults to 'normal'.
1874 This variable can be overridden with the -u|--untracked-files option
1875 of linkgit:git-status[1] and linkgit:git-commit[1].
1877 status.submodulesummary::
1879 If this is set to a non zero number or true (identical to -1 or an
1880 unlimited number), the submodule summary will be enabled and a
1881 summary of commits for modified submodules will be shown (see
1882 --summary-limit option of linkgit:git-submodule[1]).
1884 submodule.<name>.path::
1885 submodule.<name>.url::
1886 submodule.<name>.update::
1887 The path within this project, URL, and the updating strategy
1888 for a submodule. These variables are initially populated
1889 by 'git submodule init'; edit them to override the
1890 URL and other values found in the `.gitmodules` file. See
1891 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1893 submodule.<name>.fetchRecurseSubmodules::
1894 This option can be used to control recursive fetching of this
1895 submodule. It can be overridden by using the --[no-]recurse-submodules
1896 command line option to "git fetch" and "git pull".
1897 This setting will override that from in the linkgit:gitmodules[5]
1900 submodule.<name>.ignore::
1901 Defines under what circumstances "git status" and the diff family show
1902 a submodule as modified. When set to "all", it will never be considered
1903 modified, "dirty" will ignore all changes to the submodules work tree and
1904 takes only differences between the HEAD of the submodule and the commit
1905 recorded in the superproject into account. "untracked" will additionally
1906 let submodules with modified tracked files in their work tree show up.
1907 Using "none" (the default when this option is not set) also shows
1908 submodules that have untracked files in their work tree as changed.
1909 This setting overrides any setting made in .gitmodules for this submodule,
1910 both settings can be overridden on the command line by using the
1911 "--ignore-submodules" option.
1914 This variable can be used to restrict the permission bits of
1915 tar archive entries. The default is 0002, which turns off the
1916 world write bit. The special value "user" indicates that the
1917 archiving user's umask will be used instead. See umask(2) and
1918 linkgit:git-archive[1].
1920 transfer.fsckObjects::
1921 When `fetch.fsckObjects` or `receive.fsckObjects` are
1922 not set, the value of this variable is used instead.
1925 transfer.unpackLimit::
1926 When `fetch.unpackLimit` or `receive.unpackLimit` are
1927 not set, the value of this variable is used instead.
1928 The default value is 100.
1930 url.<base>.insteadOf::
1931 Any URL that starts with this value will be rewritten to
1932 start, instead, with <base>. In cases where some site serves a
1933 large number of repositories, and serves them with multiple
1934 access methods, and some users need to use different access
1935 methods, this feature allows people to specify any of the
1936 equivalent URLs and have git automatically rewrite the URL to
1937 the best alternative for the particular user, even for a
1938 never-before-seen repository on the site. When more than one
1939 insteadOf strings match a given URL, the longest match is used.
1941 url.<base>.pushInsteadOf::
1942 Any URL that starts with this value will not be pushed to;
1943 instead, it will be rewritten to start with <base>, and the
1944 resulting URL will be pushed to. In cases where some site serves
1945 a large number of repositories, and serves them with multiple
1946 access methods, some of which do not allow push, this feature
1947 allows people to specify a pull-only URL and have git
1948 automatically use an appropriate URL to push, even for a
1949 never-before-seen repository on the site. When more than one
1950 pushInsteadOf strings match a given URL, the longest match is
1951 used. If a remote has an explicit pushurl, git will ignore this
1952 setting for that remote.
1955 Your email address to be recorded in any newly created commits.
1956 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1957 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1960 Your full name to be recorded in any newly created commits.
1961 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1962 environment variables. See linkgit:git-commit-tree[1].
1965 If linkgit:git-tag[1] is not selecting the key you want it to
1966 automatically when creating a signed tag, you can override the
1967 default selection with this variable. This option is passed
1968 unchanged to gpg's --local-user parameter, so you may specify a key
1969 using any method that gpg supports.
1972 Specify a web browser that may be used by some commands.
1973 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]