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.
90 You can include one config file from another by setting the special
91 `include.path` variable to the name of the file to be included. The
92 included file is expanded immediately, as if its contents had been
93 found at the location of the include directive. If the value of the
94 `include.path` variable is a relative path, the path is considered to be
95 relative to the configuration file in which the include directive was
96 found. See below for examples.
103 ; Don't trust file modes
108 external = /usr/local/bin/diff-wrapper
113 merge = refs/heads/devel
117 gitProxy="ssh" for "kernel.org"
118 gitProxy=default-proxy ; for the rest
121 path = /path/to/foo.inc ; include by absolute path
122 path = foo ; expand "foo" relative to the current file
127 Note that this list is non-comprehensive and not necessarily complete.
128 For command-specific variables, you will find a more detailed description
129 in the appropriate manual page. You will find a description of non-core
130 porcelain configuration variables in the respective porcelain documentation.
133 These variables control various optional help messages designed to
134 aid new users. All 'advice.*' variables default to 'true', and you
135 can tell Git that you do not need help by setting these to 'false':
139 Advice shown when linkgit:git-push[1] refuses
140 non-fast-forward refs.
142 Directions on how to stage/unstage/add shown in the
143 output of linkgit:git-status[1] and the template shown
144 when writing commit messages.
146 Advice shown when linkgit:git-merge[1] refuses to
147 merge to avoid overwriting local changes.
149 Advices shown by various commands when conflicts
150 prevent the operation from being performed.
152 Advice on how to set your identity configuration when
153 your information is guessed from the system username and
156 Advice shown when you used linkgit:git-checkout[1] to
157 move to the detach HEAD state, to instruct how to create
158 a local branch after the fact.
162 If false, the executable bit differences between the index and
163 the working tree are ignored; useful on broken filesystems like FAT.
164 See linkgit:git-update-index[1].
166 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
167 will probe and set core.fileMode false if appropriate when the
168 repository is created.
170 core.ignoreCygwinFSTricks::
171 This option is only used by Cygwin implementation of Git. If false,
172 the Cygwin stat() and lstat() functions are used. This may be useful
173 if your repository consists of a few separate directories joined in
174 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
175 whenever it is possible and falls back to Cygwin functions only to
176 handle symbol links. The native mode is more than twice faster than
177 normal Cygwin l/stat() functions. True by default, unless core.filemode
178 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
179 POSIX emulation is required to support core.filemode.
182 If true, this option enables various workarounds to enable
183 git to work better on filesystems that are not case sensitive,
184 like FAT. For example, if a directory listing finds
185 "makefile" when git expects "Makefile", git will assume
186 it is really the same file, and continue to remember it as
189 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
190 will probe and set core.ignorecase true if appropriate when the repository
194 If false, the ctime differences between the index and the
195 working tree are ignored; useful when the inode change time
196 is regularly modified by something outside Git (file system
197 crawlers and some backup systems).
198 See linkgit:git-update-index[1]. True by default.
201 The commands that output paths (e.g. 'ls-files',
202 'diff'), when not given the `-z` option, will quote
203 "unusual" characters in the pathname by enclosing the
204 pathname in a double-quote pair and with backslashes the
205 same way strings in C source code are quoted. If this
206 variable is set to false, the bytes higher than 0x80 are
207 not quoted but output as verbatim. Note that double
208 quote, backslash and control characters are always
209 quoted without `-z` regardless of the setting of this
213 Sets the line ending type to use in the working directory for
214 files that have the `text` property set. Alternatives are
215 'lf', 'crlf' and 'native', which uses the platform's native
216 line ending. The default value is `native`. See
217 linkgit:gitattributes[5] for more information on end-of-line
221 If true, makes git check if converting `CRLF` is reversible when
222 end-of-line conversion is active. Git will verify if a command
223 modifies a file in the work tree either directly or indirectly.
224 For example, committing a file followed by checking out the
225 same file should yield the original file in the work tree. If
226 this is not the case for the current setting of
227 `core.autocrlf`, git will reject the file. The variable can
228 be set to "warn", in which case git will only warn about an
229 irreversible conversion but continue the operation.
231 CRLF conversion bears a slight chance of corrupting data.
232 When it is enabled, git will convert CRLF to LF during commit and LF to
233 CRLF during checkout. A file that contains a mixture of LF and
234 CRLF before the commit cannot be recreated by git. For text
235 files this is the right thing to do: it corrects line endings
236 such that we have only LF line endings in the repository.
237 But for binary files that are accidentally classified as text the
238 conversion can corrupt data.
240 If you recognize such corruption early you can easily fix it by
241 setting the conversion type explicitly in .gitattributes. Right
242 after committing you still have the original file in your work
243 tree and this file is not yet corrupted. You can explicitly tell
244 git that this file is binary and git will handle the file
247 Unfortunately, the desired effect of cleaning up text files with
248 mixed line endings and the undesired effect of corrupting binary
249 files cannot be distinguished. In both cases CRLFs are removed
250 in an irreversible way. For text files this is the right thing
251 to do because CRLFs are line endings, while for binary files
252 converting CRLFs corrupts data.
254 Note, this safety check does not mean that a checkout will generate a
255 file identical to the original file for a different setting of
256 `core.eol` and `core.autocrlf`, but only for the current one. For
257 example, a text file with `LF` would be accepted with `core.eol=lf`
258 and could later be checked out with `core.eol=crlf`, in which case the
259 resulting file would contain `CRLF`, although the original file
260 contained `LF`. However, in both work trees the line endings would be
261 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
262 file with mixed line endings would be reported by the `core.safecrlf`
266 Setting this variable to "true" is almost the same as setting
267 the `text` attribute to "auto" on all files except that text
268 files are not guaranteed to be normalized: files that contain
269 `CRLF` in the repository will not be touched. Use this
270 setting if you want to have `CRLF` line endings in your
271 working directory even though the repository does not have
272 normalized line endings. This variable can be set to 'input',
273 in which case no output conversion is performed.
276 If false, symbolic links are checked out as small plain files that
277 contain the link text. linkgit:git-update-index[1] and
278 linkgit:git-add[1] will not change the recorded type to regular
279 file. Useful on filesystems like FAT that do not support
282 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
283 will probe and set core.symlinks false if appropriate when the repository
287 A "proxy command" to execute (as 'command host port') instead
288 of establishing direct connection to the remote server when
289 using the git protocol for fetching. If the variable value is
290 in the "COMMAND for DOMAIN" format, the command is applied only
291 on hostnames ending with the specified domain string. This variable
292 may be set multiple times and is matched in the given order;
293 the first match wins.
295 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
296 (which always applies universally, without the special "for"
299 The special string `none` can be used as the proxy command to
300 specify that no proxy be used for a given domain pattern.
301 This is useful for excluding servers inside a firewall from
302 proxy use, while defaulting to a common proxy for external domains.
305 If true, commands which modify both the working tree and the index
306 will mark the updated paths with the "assume unchanged" bit in the
307 index. These marked files are then assumed to stay unchanged in the
308 working tree, until you mark them otherwise manually - Git will not
309 detect the file changes by lstat() calls. This is useful on systems
310 where those are very slow, such as Microsoft Windows.
311 See linkgit:git-update-index[1].
314 core.preferSymlinkRefs::
315 Instead of the default "symref" format for HEAD
316 and other symbolic reference files, use symbolic links.
317 This is sometimes needed to work with old scripts that
318 expect HEAD to be a symbolic link.
321 If true this repository is assumed to be 'bare' and has no
322 working directory associated with it. If this is the case a
323 number of commands that require a working directory will be
324 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
326 This setting is automatically guessed by linkgit:git-clone[1] or
327 linkgit:git-init[1] when the repository was created. By default a
328 repository that ends in "/.git" is assumed to be not bare (bare =
329 false), while all other repositories are assumed to be bare (bare
333 Set the path to the root of the working tree.
334 This can be overridden by the GIT_WORK_TREE environment
335 variable and the '--work-tree' command line option.
336 The value can be an absolute path or relative to the path to
337 the .git directory, which is either specified by --git-dir
338 or GIT_DIR, or automatically discovered.
339 If --git-dir or GIT_DIR is specified but none of
340 --work-tree, GIT_WORK_TREE and core.worktree is specified,
341 the current working directory is regarded as the top level
342 of your working tree.
344 Note that this variable is honored even when set in a configuration
345 file in a ".git" subdirectory of a directory and its value differs
346 from the latter directory (e.g. "/path/to/.git/config" has
347 core.worktree set to "/different/path"), which is most likely a
348 misconfiguration. Running git commands in the "/path/to" directory will
349 still use "/different/path" as the root of the work tree and can cause
350 confusion unless you know what you are doing (e.g. you are creating a
351 read-only snapshot of the same index to a location different from the
352 repository's usual working tree).
354 core.logAllRefUpdates::
355 Enable the reflog. Updates to a ref <ref> is logged to the file
356 "$GIT_DIR/logs/<ref>", by appending the new and old
357 SHA1, the date/time and the reason of the update, but
358 only when the file exists. If this configuration
359 variable is set to true, missing "$GIT_DIR/logs/<ref>"
360 file is automatically created for branch heads (i.e. under
361 refs/heads/), remote refs (i.e. under refs/remotes/),
362 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
364 This information can be used to determine what commit
365 was the tip of a branch "2 days ago".
367 This value is true by default in a repository that has
368 a working directory associated with it, and false by
369 default in a bare repository.
371 core.repositoryFormatVersion::
372 Internal variable identifying the repository format and layout
375 core.sharedRepository::
376 When 'group' (or 'true'), the repository is made shareable between
377 several users in a group (making sure all the files and objects are
378 group-writable). When 'all' (or 'world' or 'everybody'), the
379 repository will be readable by all users, additionally to being
380 group-shareable. When 'umask' (or 'false'), git will use permissions
381 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
382 files in the repository will have this mode value. '0xxx' will override
383 user's umask value (whereas the other options will only override
384 requested parts of the user's umask value). Examples: '0660' will make
385 the repo read/write-able for the owner and group, but inaccessible to
386 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
387 repository that is group-readable but not group-writable.
388 See linkgit:git-init[1]. False by default.
390 core.warnAmbiguousRefs::
391 If true, git will warn you if the ref name you passed it is ambiguous
392 and might match multiple refs in the .git/refs/ tree. True by default.
395 An integer -1..9, indicating a default compression level.
396 -1 is the zlib default. 0 means no compression,
397 and 1..9 are various speed/size tradeoffs, 9 being slowest.
398 If set, this provides a default to other compression variables,
399 such as 'core.loosecompression' and 'pack.compression'.
401 core.loosecompression::
402 An integer -1..9, indicating the compression level for objects that
403 are not in a pack file. -1 is the zlib default. 0 means no
404 compression, and 1..9 are various speed/size tradeoffs, 9 being
405 slowest. If not set, defaults to core.compression. If that is
406 not set, defaults to 1 (best speed).
408 core.packedGitWindowSize::
409 Number of bytes of a pack file to map into memory in a
410 single mapping operation. Larger window sizes may allow
411 your system to process a smaller number of large pack files
412 more quickly. Smaller window sizes will negatively affect
413 performance due to increased calls to the operating system's
414 memory manager, but may improve performance when accessing
415 a large number of large pack files.
417 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
418 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
419 be reasonable for all users/operating systems. You probably do
420 not need to adjust this value.
422 Common unit suffixes of 'k', 'm', or 'g' are supported.
424 core.packedGitLimit::
425 Maximum number of bytes to map simultaneously into memory
426 from pack files. If Git needs to access more than this many
427 bytes at once to complete an operation it will unmap existing
428 regions to reclaim virtual address space within the process.
430 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
431 This should be reasonable for all users/operating systems, except on
432 the largest projects. You probably do not need to adjust this value.
434 Common unit suffixes of 'k', 'm', or 'g' are supported.
436 core.deltaBaseCacheLimit::
437 Maximum number of bytes to reserve for caching base objects
438 that may be referenced by multiple deltified objects. By storing the
439 entire decompressed base objects in a cache Git is able
440 to avoid unpacking and decompressing frequently used base
441 objects multiple times.
443 Default is 16 MiB on all platforms. This should be reasonable
444 for all users/operating systems, except on the largest projects.
445 You probably do not need to adjust this value.
447 Common unit suffixes of 'k', 'm', or 'g' are supported.
449 core.bigFileThreshold::
450 Files larger than this size are stored deflated, without
451 attempting delta compression. Storing large files without
452 delta compression avoids excessive memory usage, at the
453 slight expense of increased disk usage.
455 Default is 512 MiB on all platforms. This should be reasonable
456 for most projects as source code and other text files can still
457 be delta compressed, but larger binary media files won't be.
459 Common unit suffixes of 'k', 'm', or 'g' are supported.
462 In addition to '.gitignore' (per-directory) and
463 '.git/info/exclude', git looks into this file for patterns
464 of files which are not meant to be tracked. "{tilde}/" is expanded
465 to the value of `$HOME` and "{tilde}user/" to the specified user's
466 home directory. See linkgit:gitignore[5].
469 Some commands (e.g. svn and http interfaces) that interactively
470 ask for a password can be told to use an external program given
471 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
472 environment variable. If not set, fall back to the value of the
473 'SSH_ASKPASS' environment variable or, failing that, a simple password
474 prompt. The external program shall be given a suitable prompt as
475 command line argument and write the password on its STDOUT.
477 core.attributesfile::
478 In addition to '.gitattributes' (per-directory) and
479 '.git/info/attributes', git looks into this file for attributes
480 (see linkgit:gitattributes[5]). Path expansions are made the same
481 way as for `core.excludesfile`.
484 Commands such as `commit` and `tag` that lets you edit
485 messages by launching an editor uses the value of this
486 variable when it is set, and the environment variable
487 `GIT_EDITOR` is not set. See linkgit:git-var[1].
490 Text editor used by `git rebase -i` for editing the rebase insn file.
491 The value is meant to be interpreted by the shell when it is used.
492 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
493 When not configured the default commit message editor is used instead.
496 The command that git will use to paginate output. Can
497 be overridden with the `GIT_PAGER` environment
498 variable. Note that git sets the `LESS` environment
499 variable to `FRSX` if it is unset when it runs the
500 pager. One can change these settings by setting the
501 `LESS` variable to some other value. Alternately,
502 these settings can be overridden on a project or
503 global basis by setting the `core.pager` option.
504 Setting `core.pager` has no affect on the `LESS`
505 environment variable behaviour above, so if you want
506 to override git's default settings this way, you need
507 to be explicit. For example, to disable the S option
508 in a backward compatible manner, set `core.pager`
509 to `less -+$LESS -FRX`. This will be passed to the
510 shell by git, which will translate the final command to
511 `LESS=FRSX less -+FRSX -FRX`.
514 A comma separated list of common whitespace problems to
515 notice. 'git diff' will use `color.diff.whitespace` to
516 highlight them, and 'git apply --whitespace=error' will
517 consider them as errors. You can prefix `-` to disable
518 any of them (e.g. `-trailing-space`):
520 * `blank-at-eol` treats trailing whitespaces at the end of the line
521 as an error (enabled by default).
522 * `space-before-tab` treats a space character that appears immediately
523 before a tab character in the initial indent part of the line as an
524 error (enabled by default).
525 * `indent-with-non-tab` treats a line that is indented with 8 or more
526 space characters as an error (not enabled by default).
527 * `tab-in-indent` treats a tab character in the initial indent part of
528 the line as an error (not enabled by default).
529 * `blank-at-eof` treats blank lines added at the end of file as an error
530 (enabled by default).
531 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
533 * `cr-at-eol` treats a carriage-return at the end of line as
534 part of the line terminator, i.e. with it, `trailing-space`
535 does not trigger if the character before such a carriage-return
536 is not a whitespace (not enabled by default).
537 * `tabwidth=<n>` tells how many character positions a tab occupies; this
538 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
539 errors. The default tab width is 8. Allowed values are 1 to 63.
541 core.fsyncobjectfiles::
542 This boolean will enable 'fsync()' when writing object files.
544 This is a total waste of time and effort on a filesystem that orders
545 data writes properly, but can be useful for filesystems that do not use
546 journalling (traditional UNIX filesystems) or that only journal metadata
547 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
550 Enable parallel index preload for operations like 'git diff'
552 This can speed up operations like 'git diff' and 'git status' especially
553 on filesystems like NFS that have weak caching semantics and thus
554 relatively high IO latencies. With this set to 'true', git will do the
555 index comparison to the filesystem data in parallel, allowing
559 You can set this to 'link', in which case a hardlink followed by
560 a delete of the source are used to make sure that object creation
561 will not overwrite existing objects.
563 On some file system/operating system combinations, this is unreliable.
564 Set this config setting to 'rename' there; However, This will remove the
565 check that makes sure that existing object files will not get overwritten.
568 When showing commit messages, also show notes which are stored in
569 the given ref. The ref must be fully qualified. If the given
570 ref does not exist, it is not an error but means that no
571 notes should be printed.
573 This setting defaults to "refs/notes/commits", and it can be overridden by
574 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
576 core.sparseCheckout::
577 Enable "sparse checkout" feature. See section "Sparse checkout" in
578 linkgit:git-read-tree[1] for more information.
581 Set the length object names are abbreviated to. If unspecified,
582 many commands abbreviate to 7 hexdigits, which may not be enough
583 for abbreviated object names to stay unique for sufficiently long
588 Tells 'git add' to continue adding files when some files cannot be
589 added due to indexing errors. Equivalent to the '--ignore-errors'
590 option of linkgit:git-add[1]. Older versions of git accept only
591 `add.ignore-errors`, which does not follow the usual naming
592 convention for configuration variables. Newer versions of git
593 honor `add.ignoreErrors` as well.
596 Command aliases for the linkgit:git[1] command wrapper - e.g.
597 after defining "alias.last = cat-file commit HEAD", the invocation
598 "git last" is equivalent to "git cat-file commit HEAD". To avoid
599 confusion and troubles with script usage, aliases that
600 hide existing git commands are ignored. Arguments are split by
601 spaces, the usual shell quoting and escaping is supported.
602 quote pair and a backslash can be used to quote them.
604 If the alias expansion is prefixed with an exclamation point,
605 it will be treated as a shell command. For example, defining
606 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
607 "git new" is equivalent to running the shell command
608 "gitk --all --not ORIG_HEAD". Note that shell commands will be
609 executed from the top-level directory of a repository, which may
610 not necessarily be the current directory.
611 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
612 from the original current directory. See linkgit:git-rev-parse[1].
615 If true, git-am will call git-mailsplit for patches in mbox format
616 with parameter '--keep-cr'. In this case git-mailsplit will
617 not remove `\r` from lines ending with `\r\n`. Can be overridden
618 by giving '--no-keep-cr' from the command line.
619 See linkgit:git-am[1], linkgit:git-mailsplit[1].
621 apply.ignorewhitespace::
622 When set to 'change', tells 'git apply' to ignore changes in
623 whitespace, in the same way as the '--ignore-space-change'
625 When set to one of: no, none, never, false tells 'git apply' to
626 respect all whitespace differences.
627 See linkgit:git-apply[1].
630 Tells 'git apply' how to handle whitespaces, in the same way
631 as the '--whitespace' option. See linkgit:git-apply[1].
633 branch.autosetupmerge::
634 Tells 'git branch' and 'git checkout' to set up new branches
635 so that linkgit:git-pull[1] will appropriately merge from the
636 starting point branch. Note that even if this option is not set,
637 this behavior can be chosen per-branch using the `--track`
638 and `--no-track` options. The valid settings are: `false` -- no
639 automatic setup is done; `true` -- automatic setup is done when the
640 starting point is a remote-tracking branch; `always` --
641 automatic setup is done when the starting point is either a
642 local branch or remote-tracking
643 branch. This option defaults to true.
645 branch.autosetuprebase::
646 When a new branch is created with 'git branch' or 'git checkout'
647 that tracks another branch, this variable tells git to set
648 up pull to rebase instead of merge (see "branch.<name>.rebase").
649 When `never`, rebase is never automatically set to true.
650 When `local`, rebase is set to true for tracked branches of
651 other local branches.
652 When `remote`, rebase is set to true for tracked branches of
653 remote-tracking branches.
654 When `always`, rebase will be set to true for all tracking
656 See "branch.autosetupmerge" for details on how to set up a
657 branch to track another branch.
658 This option defaults to never.
660 branch.<name>.remote::
661 When in branch <name>, it tells 'git fetch' and 'git push' which
662 remote to fetch from/push to. It defaults to `origin` if no remote is
663 configured. `origin` is also used if you are not on any branch.
665 branch.<name>.merge::
666 Defines, together with branch.<name>.remote, the upstream branch
667 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
668 branch to merge and can also affect 'git push' (see push.default).
669 When in branch <name>, it tells 'git fetch' the default
670 refspec to be marked for merging in FETCH_HEAD. The value is
671 handled like the remote part of a refspec, and must match a
672 ref which is fetched from the remote given by
673 "branch.<name>.remote".
674 The merge information is used by 'git pull' (which at first calls
675 'git fetch') to lookup the default branch for merging. Without
676 this option, 'git pull' defaults to merge the first refspec fetched.
677 Specify multiple values to get an octopus merge.
678 If you wish to setup 'git pull' so that it merges into <name> from
679 another branch in the local repository, you can point
680 branch.<name>.merge to the desired branch, and use the special setting
681 `.` (a period) for branch.<name>.remote.
683 branch.<name>.mergeoptions::
684 Sets default options for merging into branch <name>. The syntax and
685 supported options are the same as those of linkgit:git-merge[1], but
686 option values containing whitespace characters are currently not
689 branch.<name>.rebase::
690 When true, rebase the branch <name> on top of the fetched branch,
691 instead of merging the default branch from the default remote when
692 "git pull" is run. See "pull.rebase" for doing this in a non
693 branch-specific manner.
695 *NOTE*: this is a possibly dangerous operation; do *not* use
696 it unless you understand the implications (see linkgit:git-rebase[1]
700 Specify the command to invoke the specified browser. The
701 specified command is evaluated in shell with the URLs passed
702 as arguments. (See linkgit:git-web{litdd}browse[1].)
704 browser.<tool>.path::
705 Override the path for the given tool that may be used to
706 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
707 working repository in gitweb (see linkgit:git-instaweb[1]).
710 A boolean to make git-clean do nothing unless given -f
711 or -n. Defaults to true.
714 A boolean to enable/disable color in the output of
715 linkgit:git-branch[1]. May be set to `always`,
716 `false` (or `never`) or `auto` (or `true`), in which case colors are used
717 only when the output is to a terminal. Defaults to false.
719 color.branch.<slot>::
720 Use customized color for branch coloration. `<slot>` is one of
721 `current` (the current branch), `local` (a local branch),
722 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
725 The value for these configuration variables is a list of colors (at most
726 two) and attributes (at most one), separated by spaces. The colors
727 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
728 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
729 `blink` and `reverse`. The first color given is the foreground; the
730 second is the background. The position of the attribute, if any,
734 Whether to use ANSI escape sequences to add color to patches.
735 If this is set to `always`, linkgit:git-diff[1],
736 linkgit:git-log[1], and linkgit:git-show[1] will use color
737 for all patches. If it is set to `true` or `auto`, those
738 commands will only use color when output is to the terminal.
741 This does not affect linkgit:git-format-patch[1] nor the
742 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
743 command line with the `--color[=<when>]` option.
746 Use customized color for diff colorization. `<slot>` specifies
747 which part of the patch to use the specified color, and is one
748 of `plain` (context text), `meta` (metainformation), `frag`
749 (hunk header), 'func' (function in hunk header), `old` (removed lines),
750 `new` (added lines), `commit` (commit headers), or `whitespace`
751 (highlighting whitespace errors). The values of these variables may be
752 specified as in color.branch.<slot>.
754 color.decorate.<slot>::
755 Use customized color for 'git log --decorate' output. `<slot>` is one
756 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
757 branches, remote-tracking branches, tags, stash and HEAD, respectively.
760 When set to `always`, always highlight matches. When `false` (or
761 `never`), never. When set to `true` or `auto`, use color only
762 when the output is written to the terminal. Defaults to `false`.
765 Use customized color for grep colorization. `<slot>` specifies which
766 part of the line to use the specified color, and is one of
770 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
772 filename prefix (when not using `-h`)
774 function name lines (when using `-p`)
776 line number prefix (when using `-n`)
780 non-matching text in selected lines
782 separators between fields on a line (`:`, `-`, and `=`)
783 and between hunks (`--`)
786 The values of these variables may be specified as in color.branch.<slot>.
789 When set to `always`, always use colors for interactive prompts
790 and displays (such as those used by "git-add --interactive").
791 When false (or `never`), never. When set to `true` or `auto`, use
792 colors only when the output is to the terminal. Defaults to false.
794 color.interactive.<slot>::
795 Use customized color for 'git add --interactive'
796 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
797 four distinct types of normal output from interactive
798 commands. The values of these variables may be specified as
799 in color.branch.<slot>.
802 A boolean to enable/disable colored output when the pager is in
803 use (default is true).
806 A boolean to enable/disable color in the output of
807 linkgit:git-show-branch[1]. May be set to `always`,
808 `false` (or `never`) or `auto` (or `true`), in which case colors are used
809 only when the output is to a terminal. Defaults to false.
812 A boolean to enable/disable color in the output of
813 linkgit:git-status[1]. May be set to `always`,
814 `false` (or `never`) or `auto` (or `true`), in which case colors are used
815 only when the output is to a terminal. Defaults to false.
817 color.status.<slot>::
818 Use customized color for status colorization. `<slot>` is
819 one of `header` (the header text of the status message),
820 `added` or `updated` (files which are added but not committed),
821 `changed` (files which are changed but not added in the index),
822 `untracked` (files which are not tracked by git),
823 `branch` (the current branch), or
824 `nobranch` (the color the 'no branch' warning is shown in, defaulting
825 to red). The values of these variables may be specified as in
829 This variable determines the default value for variables such
830 as `color.diff` and `color.grep` that control the use of color
831 per command family. Its scope will expand as more commands learn
832 configuration to set a default for the `--color` option. Set it
833 to `always` if you want all output not intended for machine
834 consumption to use color, to `true` or `auto` if you want such
835 output to use color when written to the terminal, or to `false` or
836 `never` if you prefer git commands not to use color unless enabled
837 explicitly with some other configuration or the `--color` option.
840 A boolean to enable/disable inclusion of status information in the
841 commit message template when using an editor to prepare the commit
842 message. Defaults to true.
845 Specify a file to use as the template for new commit messages.
846 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
847 specified user's home directory.
850 Specify an external helper to be called when a username or
851 password credential is needed; the helper may consult external
852 storage to avoid prompting the user for the credentials. See
853 linkgit:gitcredentials[7] for details.
855 credential.useHttpPath::
856 When acquiring credentials, consider the "path" component of an http
857 or https URL to be important. Defaults to false. See
858 linkgit:gitcredentials[7] for more information.
860 credential.username::
861 If no username is set for a network authentication, use this username
862 by default. See credential.<context>.* below, and
863 linkgit:gitcredentials[7].
866 Any of the credential.* options above can be applied selectively to
867 some credentials. For example "credential.https://example.com.username"
868 would set the default username only for https connections to
869 example.com. See linkgit:gitcredentials[7] for details on how URLs are
872 include::diff-config.txt[]
874 difftool.<tool>.path::
875 Override the path for the given tool. This is useful in case
876 your tool is not in the PATH.
878 difftool.<tool>.cmd::
879 Specify the command to invoke the specified diff tool.
880 The specified command is evaluated in shell with the following
881 variables available: 'LOCAL' is set to the name of the temporary
882 file containing the contents of the diff pre-image and 'REMOTE'
883 is set to the name of the temporary file containing the contents
884 of the diff post-image.
887 Prompt before each invocation of the diff tool.
890 A POSIX Extended Regular Expression used to determine what is a "word"
891 when performing word-by-word difference calculations. Character
892 sequences that match the regular expression are "words", all other
893 characters are *ignorable* whitespace.
895 fetch.recurseSubmodules::
896 This option can be either set to a boolean value or to 'on-demand'.
897 Setting it to a boolean changes the behavior of fetch and pull to
898 unconditionally recurse into submodules when set to true or to not
899 recurse at all when set to false. When set to 'on-demand' (the default
900 value), fetch and pull will only recurse into a populated submodule
901 when its superproject retrieves a commit that updates the submodule's
905 If it is set to true, git-fetch-pack will check all fetched
906 objects. It will abort in the case of a malformed object or a
907 broken link. The result of an abort are only dangling objects.
908 Defaults to false. If not set, the value of `transfer.fsckObjects`
912 If the number of objects fetched over the git native
913 transfer is below this
914 limit, then the objects will be unpacked into loose object
915 files. However if the number of received objects equals or
916 exceeds this limit then the received pack will be stored as
917 a pack, after adding any missing delta bases. Storing the
918 pack from a push can make the push operation complete faster,
919 especially on slow filesystems. If not set, the value of
920 `transfer.unpackLimit` is used instead.
923 Enable multipart/mixed attachments as the default for
924 'format-patch'. The value can also be a double quoted string
925 which will enable attachments as the default and set the
926 value as the boundary. See the --attach option in
927 linkgit:git-format-patch[1].
930 A boolean which can enable or disable sequence numbers in patch
931 subjects. It defaults to "auto" which enables it only if there
932 is more than one patch. It can be enabled or disabled for all
933 messages by setting it to "true" or "false". See --numbered
934 option in linkgit:git-format-patch[1].
937 Additional email headers to include in a patch to be submitted
938 by mail. See linkgit:git-format-patch[1].
942 Additional recipients to include in a patch to be submitted
943 by mail. See the --to and --cc options in
944 linkgit:git-format-patch[1].
946 format.subjectprefix::
947 The default for format-patch is to output files with the '[PATCH]'
948 subject prefix. Use this variable to change that prefix.
951 The default for format-patch is to output a signature containing
952 the git version number. Use this variable to change that default.
953 Set this variable to the empty string ("") to suppress
954 signature generation.
957 The default for format-patch is to output files with the suffix
958 `.patch`. Use this variable to change that suffix (make sure to
959 include the dot if you want it).
962 The default pretty format for log/show/whatchanged command,
963 See linkgit:git-log[1], linkgit:git-show[1],
964 linkgit:git-whatchanged[1].
967 The default threading style for 'git format-patch'. Can be
968 a boolean value, or `shallow` or `deep`. `shallow` threading
969 makes every mail a reply to the head of the series,
970 where the head is chosen from the cover letter, the
971 `\--in-reply-to`, and the first patch mail, in this order.
972 `deep` threading makes every mail a reply to the previous one.
973 A true boolean value is the same as `shallow`, and a false
974 value disables threading.
977 A boolean value which lets you enable the `-s/--signoff` option of
978 format-patch by default. *Note:* Adding the Signed-off-by: line to a
979 patch should be a conscious act and means that you certify you have
980 the rights to submit this work under the same open source license.
981 Please see the 'SubmittingPatches' document for further discussion.
983 filter.<driver>.clean::
984 The command which is used to convert the content of a worktree
985 file to a blob upon checkin. See linkgit:gitattributes[5] for
988 filter.<driver>.smudge::
989 The command which is used to convert the content of a blob
990 object to a worktree file upon checkout. See
991 linkgit:gitattributes[5] for details.
993 gc.aggressiveWindow::
994 The window size parameter used in the delta compression
995 algorithm used by 'git gc --aggressive'. This defaults
999 When there are approximately more than this many loose
1000 objects in the repository, `git gc --auto` will pack them.
1001 Some Porcelain commands use this command to perform a
1002 light-weight garbage collection from time to time. The
1003 default value is 6700. Setting this to 0 disables it.
1006 When there are more than this many packs that are not
1007 marked with `*.keep` file in the repository, `git gc
1008 --auto` consolidates them into one larger pack. The
1009 default value is 50. Setting this to 0 disables it.
1012 Running `git pack-refs` in a repository renders it
1013 unclonable by Git versions prior to 1.5.1.2 over dumb
1014 transports such as HTTP. This variable determines whether
1015 'git gc' runs `git pack-refs`. This can be set to `notbare`
1016 to enable it within all non-bare repos or it can be set to a
1017 boolean value. The default is `true`.
1020 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1021 Override the grace period with this config variable. The value
1022 "now" may be used to disable this grace period and always prune
1023 unreachable objects immediately.
1026 gc.<pattern>.reflogexpire::
1027 'git reflog expire' removes reflog entries older than
1028 this time; defaults to 90 days. With "<pattern>" (e.g.
1029 "refs/stash") in the middle the setting applies only to
1030 the refs that match the <pattern>.
1032 gc.reflogexpireunreachable::
1033 gc.<ref>.reflogexpireunreachable::
1034 'git reflog expire' removes reflog entries older than
1035 this time and are not reachable from the current tip;
1036 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1037 in the middle, the setting applies only to the refs that
1038 match the <pattern>.
1041 Records of conflicted merge you resolved earlier are
1042 kept for this many days when 'git rerere gc' is run.
1043 The default is 60 days. See linkgit:git-rerere[1].
1045 gc.rerereunresolved::
1046 Records of conflicted merge you have not resolved are
1047 kept for this many days when 'git rerere gc' is run.
1048 The default is 15 days. See linkgit:git-rerere[1].
1050 gitcvs.commitmsgannotation::
1051 Append this string to each commit message. Set to empty string
1052 to disable this feature. Defaults to "via git-CVS emulator".
1055 Whether the CVS server interface is enabled for this repository.
1056 See linkgit:git-cvsserver[1].
1059 Path to a log file where the CVS server interface well... logs
1060 various stuff. See linkgit:git-cvsserver[1].
1062 gitcvs.usecrlfattr::
1063 If true, the server will look up the end-of-line conversion
1064 attributes for files to determine the '-k' modes to use. If
1065 the attributes force git to treat a file as text,
1066 the '-k' mode will be left blank so CVS clients will
1067 treat it as text. If they suppress text conversion, the file
1068 will be set with '-kb' mode, which suppresses any newline munging
1069 the client might otherwise do. If the attributes do not allow
1070 the file type to be determined, then 'gitcvs.allbinary' is
1071 used. See linkgit:gitattributes[5].
1074 This is used if 'gitcvs.usecrlfattr' does not resolve
1075 the correct '-kb' mode to use. If true, all
1076 unresolved files are sent to the client in
1077 mode '-kb'. This causes the client to treat them
1078 as binary files, which suppresses any newline munging it
1079 otherwise might do. Alternatively, if it is set to "guess",
1080 then the contents of the file are examined to decide if
1081 it is binary, similar to 'core.autocrlf'.
1084 Database used by git-cvsserver to cache revision information
1085 derived from the git repository. The exact meaning depends on the
1086 used database driver, for SQLite (which is the default driver) this
1087 is a filename. Supports variable substitution (see
1088 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1089 Default: '%Ggitcvs.%m.sqlite'
1092 Used Perl DBI driver. You can specify any available driver
1093 for this here, but it might not work. git-cvsserver is tested
1094 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1095 reported *not* to work with 'DBD::mysql'. Experimental feature.
1096 May not contain double colons (`:`). Default: 'SQLite'.
1097 See linkgit:git-cvsserver[1].
1099 gitcvs.dbuser, gitcvs.dbpass::
1100 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1101 since SQLite has no concept of database users and/or passwords.
1102 'gitcvs.dbuser' supports variable substitution (see
1103 linkgit:git-cvsserver[1] for details).
1105 gitcvs.dbTableNamePrefix::
1106 Database table name prefix. Prepended to the names of any
1107 database tables used, allowing a single database to be used
1108 for several repositories. Supports variable substitution (see
1109 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1110 characters will be replaced with underscores.
1112 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1113 'gitcvs.allbinary' can also be specified as
1114 'gitcvs.<access_method>.<varname>' (where 'access_method'
1115 is one of "ext" and "pserver") to make them apply only for the given
1119 gitweb.description::
1122 See linkgit:gitweb[1] for description.
1130 gitweb.remote_heads::
1133 See linkgit:gitweb.conf[5] for description.
1136 If set to true, enable '-n' option by default.
1138 grep.extendedRegexp::
1139 If set to true, enable '--extended-regexp' option by default.
1142 Use this custom program instead of "gpg" found on $PATH when
1143 making or verifying a PGP signature. The program must support the
1144 same command line interface as GPG, namely, to verify a detached
1145 signature, "gpg --verify $file - <$signature" is run, and the
1146 program is expected to signal a good signature by exiting with
1147 code 0, and to generate an ascii-armored detached signature, the
1148 standard input of "gpg -bsau $key" is fed with the contents to be
1149 signed, and the program is expected to send the result to its
1152 gui.commitmsgwidth::
1153 Defines how wide the commit message window is in the
1154 linkgit:git-gui[1]. "75" is the default.
1157 Specifies how many context lines should be used in calls to diff
1158 made by the linkgit:git-gui[1]. The default is "5".
1161 Specifies the default encoding to use for displaying of
1162 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1163 It can be overridden by setting the 'encoding' attribute
1164 for relevant files (see linkgit:gitattributes[5]).
1165 If this option is not set, the tools default to the
1168 gui.matchtrackingbranch::
1169 Determines if new branches created with linkgit:git-gui[1] should
1170 default to tracking remote branches with matching names or
1171 not. Default: "false".
1173 gui.newbranchtemplate::
1174 Is used as suggested name when creating new branches using the
1177 gui.pruneduringfetch::
1178 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1179 performing a fetch. The default value is "false".
1182 Determines if linkgit:git-gui[1] should trust the file modification
1183 timestamp or not. By default the timestamps are not trusted.
1185 gui.spellingdictionary::
1186 Specifies the dictionary used for spell checking commit messages in
1187 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1191 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1192 location detection. It makes blame significantly faster on huge
1193 repositories at the expense of less thorough copy detection.
1195 gui.copyblamethreshold::
1196 Specifies the threshold to use in 'git gui blame' original location
1197 detection, measured in alphanumeric characters. See the
1198 linkgit:git-blame[1] manual for more information on copy detection.
1200 gui.blamehistoryctx::
1201 Specifies the radius of history context in days to show in
1202 linkgit:gitk[1] for the selected commit, when the `Show History
1203 Context` menu item is invoked from 'git gui blame'. If this
1204 variable is set to zero, the whole history is shown.
1206 guitool.<name>.cmd::
1207 Specifies the shell command line to execute when the corresponding item
1208 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1209 mandatory for every tool. The command is executed from the root of
1210 the working directory, and in the environment it receives the name of
1211 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1212 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1213 the head is detached, 'CUR_BRANCH' is empty).
1215 guitool.<name>.needsfile::
1216 Run the tool only if a diff is selected in the GUI. It guarantees
1217 that 'FILENAME' is not empty.
1219 guitool.<name>.noconsole::
1220 Run the command silently, without creating a window to display its
1223 guitool.<name>.norescan::
1224 Don't rescan the working directory for changes after the tool
1227 guitool.<name>.confirm::
1228 Show a confirmation dialog before actually running the tool.
1230 guitool.<name>.argprompt::
1231 Request a string argument from the user, and pass it to the tool
1232 through the 'ARGS' environment variable. Since requesting an
1233 argument implies confirmation, the 'confirm' option has no effect
1234 if this is enabled. If the option is set to 'true', 'yes', or '1',
1235 the dialog uses a built-in generic prompt; otherwise the exact
1236 value of the variable is used.
1238 guitool.<name>.revprompt::
1239 Request a single valid revision from the user, and set the
1240 'REVISION' environment variable. In other aspects this option
1241 is similar to 'argprompt', and can be used together with it.
1243 guitool.<name>.revunmerged::
1244 Show only unmerged branches in the 'revprompt' subdialog.
1245 This is useful for tools similar to merge or rebase, but not
1246 for things like checkout or reset.
1248 guitool.<name>.title::
1249 Specifies the title to use for the prompt dialog. The default
1252 guitool.<name>.prompt::
1253 Specifies the general prompt string to display at the top of
1254 the dialog, before subsections for 'argprompt' and 'revprompt'.
1255 The default value includes the actual command.
1258 Specify the browser that will be used to display help in the
1259 'web' format. See linkgit:git-help[1].
1262 Override the default help format used by linkgit:git-help[1].
1263 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1264 the default. 'web' and 'html' are the same.
1267 Automatically correct and execute mistyped commands after
1268 waiting for the given number of deciseconds (0.1 sec). If more
1269 than one command can be deduced from the entered text, nothing
1270 will be executed. If the value of this option is negative,
1271 the corrected command will be executed immediately. If the
1272 value is 0 - the command will be just shown but not executed.
1273 This is the default.
1276 Override the HTTP proxy, normally configured using the 'http_proxy'
1277 environment variable (see linkgit:curl[1]). This can be overridden
1278 on a per-remote basis; see remote.<name>.proxy
1281 File containing previously stored cookie lines which should be used
1282 in the git http session, if they match the server. The file format
1283 of the file to read cookies from should be plain HTTP headers or
1284 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1285 NOTE that the file specified with http.cookiefile is only used as
1286 input. No cookies will be stored in the file.
1289 Whether to verify the SSL certificate when fetching or pushing
1290 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1294 File containing the SSL certificate when fetching or pushing
1295 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1299 File containing the SSL private key when fetching or pushing
1300 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1303 http.sslCertPasswordProtected::
1304 Enable git's password prompt for the SSL certificate. Otherwise
1305 OpenSSL will prompt the user, possibly many times, if the
1306 certificate or private key is encrypted. Can be overridden by the
1307 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1310 File containing the certificates to verify the peer with when
1311 fetching or pushing over HTTPS. Can be overridden by the
1312 'GIT_SSL_CAINFO' environment variable.
1315 Path containing files with the CA certificates to verify the peer
1316 with when fetching or pushing over HTTPS. Can be overridden
1317 by the 'GIT_SSL_CAPATH' environment variable.
1320 How many HTTP requests to launch in parallel. Can be overridden
1321 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1324 The number of curl sessions (counted across slots) to be kept across
1325 requests. They will not be ended with curl_easy_cleanup() until
1326 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1327 value will be capped at 1. Defaults to 1.
1330 Maximum size in bytes of the buffer used by smart HTTP
1331 transports when POSTing data to the remote system.
1332 For requests larger than this buffer size, HTTP/1.1 and
1333 Transfer-Encoding: chunked is used to avoid creating a
1334 massive pack file locally. Default is 1 MiB, which is
1335 sufficient for most requests.
1337 http.lowSpeedLimit, http.lowSpeedTime::
1338 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1339 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1340 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1341 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1344 A boolean which disables using of EPSV ftp command by curl.
1345 This can helpful with some "poor" ftp servers which don't
1346 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1347 environment variable. Default is false (curl will use EPSV).
1350 The HTTP USER_AGENT string presented to an HTTP server. The default
1351 value represents the version of the client git such as git/1.7.1.
1352 This option allows you to override this value to a more common value
1353 such as Mozilla/4.0. This may be necessary, for instance, if
1354 connecting through a firewall that restricts HTTP connections to a set
1355 of common USER_AGENT strings (but not including those like git/1.7.1).
1356 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1358 i18n.commitEncoding::
1359 Character encoding the commit messages are stored in; git itself
1360 does not care per se, but this information is necessary e.g. when
1361 importing commits from emails or in the gitk graphical history
1362 browser (and possibly at other places in the future or in other
1363 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1365 i18n.logOutputEncoding::
1366 Character encoding the commit messages are converted to when
1367 running 'git log' and friends.
1370 The configuration variables in the 'imap' section are described
1371 in linkgit:git-imap-send[1].
1374 Specify the directory from which templates will be copied.
1375 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1378 Specify the program that will be used to browse your working
1379 repository in gitweb. See linkgit:git-instaweb[1].
1382 The HTTP daemon command-line to start gitweb on your working
1383 repository. See linkgit:git-instaweb[1].
1386 If true the web server started by linkgit:git-instaweb[1] will
1387 be bound to the local IP (127.0.0.1).
1389 instaweb.modulepath::
1390 The default module path for linkgit:git-instaweb[1] to use
1391 instead of /usr/lib/apache2/modules. Only used if httpd
1395 The port number to bind the gitweb httpd to. See
1396 linkgit:git-instaweb[1].
1398 interactive.singlekey::
1399 In interactive commands, allow the user to provide one-letter
1400 input with a single key (i.e., without hitting enter).
1401 Currently this is used by the `\--patch` mode of
1402 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1403 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1404 setting is silently ignored if portable keystroke input
1408 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1409 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1410 override this option with `\--no-abbrev-commit`.
1413 Set the default date-time mode for the 'log' command.
1414 Setting a value for log.date is similar to using 'git log''s
1415 `\--date` option. Possible values are `relative`, `local`,
1416 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1420 Print out the ref names of any commits that are shown by the log
1421 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1422 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1423 specified, the full ref name (including prefix) will be printed.
1424 This is the same as the log commands '--decorate' option.
1427 If true, the initial commit will be shown as a big creation event.
1428 This is equivalent to a diff against an empty tree.
1429 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1430 normally hide the root commit will now show it. True by default.
1433 The location of an augmenting mailmap file. The default
1434 mailmap, located in the root of the repository, is loaded
1435 first, then the mailmap file pointed to by this variable.
1436 The location of the mailmap file may be in a repository
1437 subdirectory, or somewhere outside of the repository itself.
1438 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1441 Specify the programs that may be used to display help in the
1442 'man' format. See linkgit:git-help[1].
1445 Specify the command to invoke the specified man viewer. The
1446 specified command is evaluated in shell with the man page
1447 passed as argument. (See linkgit:git-help[1].)
1450 Override the path for the given tool that may be used to
1451 display help in the 'man' format. See linkgit:git-help[1].
1453 include::merge-config.txt[]
1455 mergetool.<tool>.path::
1456 Override the path for the given tool. This is useful in case
1457 your tool is not in the PATH.
1459 mergetool.<tool>.cmd::
1460 Specify the command to invoke the specified merge tool. The
1461 specified command is evaluated in shell with the following
1462 variables available: 'BASE' is the name of a temporary file
1463 containing the common base of the files to be merged, if available;
1464 'LOCAL' is the name of a temporary file containing the contents of
1465 the file on the current branch; 'REMOTE' is the name of a temporary
1466 file containing the contents of the file from the branch being
1467 merged; 'MERGED' contains the name of the file to which the merge
1468 tool should write the results of a successful merge.
1470 mergetool.<tool>.trustExitCode::
1471 For a custom merge command, specify whether the exit code of
1472 the merge command can be used to determine whether the merge was
1473 successful. If this is not set to true then the merge target file
1474 timestamp is checked and the merge assumed to have been successful
1475 if the file has been updated, otherwise the user is prompted to
1476 indicate the success of the merge.
1478 mergetool.keepBackup::
1479 After performing a merge, the original file with conflict markers
1480 can be saved as a file with a `.orig` extension. If this variable
1481 is set to `false` then this file is not preserved. Defaults to
1482 `true` (i.e. keep the backup files).
1484 mergetool.keepTemporaries::
1485 When invoking a custom merge tool, git uses a set of temporary
1486 files to pass to the tool. If the tool returns an error and this
1487 variable is set to `true`, then these temporary files will be
1488 preserved, otherwise they will be removed after the tool has
1489 exited. Defaults to `false`.
1492 Prompt before each invocation of the merge resolution program.
1495 The (fully qualified) refname from which to show notes when
1496 showing commit messages. The value of this variable can be set
1497 to a glob, in which case notes from all matching refs will be
1498 shown. You may also specify this configuration variable
1499 several times. A warning will be issued for refs that do not
1500 exist, but a glob that does not match any refs is silently
1503 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1504 environment variable, which must be a colon separated list of refs or
1507 The effective value of "core.notesRef" (possibly overridden by
1508 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1511 notes.rewrite.<command>::
1512 When rewriting commits with <command> (currently `amend` or
1513 `rebase`) and this variable is set to `true`, git
1514 automatically copies your notes from the original to the
1515 rewritten commit. Defaults to `true`, but see
1516 "notes.rewriteRef" below.
1519 When copying notes during a rewrite (see the
1520 "notes.rewrite.<command>" option), determines what to do if
1521 the target commit already has a note. Must be one of
1522 `overwrite`, `concatenate`, or `ignore`. Defaults to
1525 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1526 environment variable.
1529 When copying notes during a rewrite, specifies the (fully
1530 qualified) ref whose notes should be copied. The ref may be a
1531 glob, in which case notes in all matching refs will be copied.
1532 You may also specify this configuration several times.
1534 Does not have a default value; you must configure this variable to
1535 enable note rewriting. Set it to `refs/notes/commits` to enable
1536 rewriting for the default commit notes.
1538 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1539 environment variable, which must be a colon separated list of refs or
1543 The size of the window used by linkgit:git-pack-objects[1] when no
1544 window size is given on the command line. Defaults to 10.
1547 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1548 maximum depth is given on the command line. Defaults to 50.
1551 The window memory size limit used by linkgit:git-pack-objects[1]
1552 when no limit is given on the command line. The value can be
1553 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1557 An integer -1..9, indicating the compression level for objects
1558 in a pack file. -1 is the zlib default. 0 means no
1559 compression, and 1..9 are various speed/size tradeoffs, 9 being
1560 slowest. If not set, defaults to core.compression. If that is
1561 not set, defaults to -1, the zlib default, which is "a default
1562 compromise between speed and compression (currently equivalent
1565 Note that changing the compression level will not automatically recompress
1566 all existing objects. You can force recompression by passing the -F option
1567 to linkgit:git-repack[1].
1569 pack.deltaCacheSize::
1570 The maximum memory in bytes used for caching deltas in
1571 linkgit:git-pack-objects[1] before writing them out to a pack.
1572 This cache is used to speed up the writing object phase by not
1573 having to recompute the final delta result once the best match
1574 for all objects is found. Repacking large repositories on machines
1575 which are tight with memory might be badly impacted by this though,
1576 especially if this cache pushes the system into swapping.
1577 A value of 0 means no limit. The smallest size of 1 byte may be
1578 used to virtually disable this cache. Defaults to 256 MiB.
1580 pack.deltaCacheLimit::
1581 The maximum size of a delta, that is cached in
1582 linkgit:git-pack-objects[1]. This cache is used to speed up the
1583 writing object phase by not having to recompute the final delta
1584 result once the best match for all objects is found. Defaults to 1000.
1587 Specifies the number of threads to spawn when searching for best
1588 delta matches. This requires that linkgit:git-pack-objects[1]
1589 be compiled with pthreads otherwise this option is ignored with a
1590 warning. This is meant to reduce packing time on multiprocessor
1591 machines. The required amount of memory for the delta search window
1592 is however multiplied by the number of threads.
1593 Specifying 0 will cause git to auto-detect the number of CPU's
1594 and set the number of threads accordingly.
1597 Specify the default pack index version. Valid values are 1 for
1598 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1599 the new pack index with capabilities for packs larger than 4 GB
1600 as well as proper protection against the repacking of corrupted
1601 packs. Version 2 is the default. Note that version 2 is enforced
1602 and this config option ignored whenever the corresponding pack is
1605 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1606 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1607 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1608 other side may give you a repository that cannot be accessed with your
1609 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1610 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1611 the `{asterisk}.idx` file.
1613 pack.packSizeLimit::
1614 The maximum size of a pack. This setting only affects
1615 packing to a file when repacking, i.e. the git:// protocol
1616 is unaffected. It can be overridden by the `\--max-pack-size`
1617 option of linkgit:git-repack[1]. The minimum size allowed is
1618 limited to 1 MiB. The default is unlimited.
1619 Common unit suffixes of 'k', 'm', or 'g' are
1623 If the value is boolean, turns on or off pagination of the
1624 output of a particular git subcommand when writing to a tty.
1625 Otherwise, turns on pagination for the subcommand using the
1626 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1627 or `\--no-pager` is specified on the command line, it takes
1628 precedence over this option. To disable pagination for all
1629 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1632 Alias for a --pretty= format string, as specified in
1633 linkgit:git-log[1]. Any aliases defined here can be used just
1634 as the built-in pretty formats could. For example,
1635 running `git config pretty.changelog "format:{asterisk} %H %s"`
1636 would cause the invocation `git log --pretty=changelog`
1637 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1638 Note that an alias with the same name as a built-in format
1639 will be silently ignored.
1642 When true, rebase branches on top of the fetched branch, instead
1643 of merging the default branch from the default remote when "git
1644 pull" is run. See "branch.<name>.rebase" for setting this on a
1647 *NOTE*: this is a possibly dangerous operation; do *not* use
1648 it unless you understand the implications (see linkgit:git-rebase[1]
1652 The default merge strategy to use when pulling multiple branches
1656 The default merge strategy to use when pulling a single branch.
1659 Defines the action git push should take if no refspec is given
1660 on the command line, no refspec is configured in the remote, and
1661 no refspec is implied by any of the options given on the command
1662 line. Possible values are:
1664 * `nothing` - do not push anything.
1665 * `matching` - push all matching branches.
1666 All branches having the same name in both ends are considered to be
1667 matching. This is the default.
1668 * `upstream` - push the current branch to its upstream branch.
1669 * `tracking` - deprecated synonym for `upstream`.
1670 * `current` - push the current branch to a branch of the same name.
1673 Whether to show a diffstat of what changed upstream since the last
1674 rebase. False by default.
1677 If set to true enable '--autosquash' option by default.
1680 By default, git-receive-pack will run "git-gc --auto" after
1681 receiving data from git-push and updating refs. You can stop
1682 it by setting this variable to false.
1684 receive.fsckObjects::
1685 If it is set to true, git-receive-pack will check all received
1686 objects. It will abort in the case of a malformed object or a
1687 broken link. The result of an abort are only dangling objects.
1688 Defaults to false. If not set, the value of `transfer.fsckObjects`
1691 receive.unpackLimit::
1692 If the number of objects received in a push is below this
1693 limit then the objects will be unpacked into loose object
1694 files. However if the number of received objects equals or
1695 exceeds this limit then the received pack will be stored as
1696 a pack, after adding any missing delta bases. Storing the
1697 pack from a push can make the push operation complete faster,
1698 especially on slow filesystems. If not set, the value of
1699 `transfer.unpackLimit` is used instead.
1701 receive.denyDeletes::
1702 If set to true, git-receive-pack will deny a ref update that deletes
1703 the ref. Use this to prevent such a ref deletion via a push.
1705 receive.denyDeleteCurrent::
1706 If set to true, git-receive-pack will deny a ref update that
1707 deletes the currently checked out branch of a non-bare repository.
1709 receive.denyCurrentBranch::
1710 If set to true or "refuse", git-receive-pack will deny a ref update
1711 to the currently checked out branch of a non-bare repository.
1712 Such a push is potentially dangerous because it brings the HEAD
1713 out of sync with the index and working tree. If set to "warn",
1714 print a warning of such a push to stderr, but allow the push to
1715 proceed. If set to false or "ignore", allow such pushes with no
1716 message. Defaults to "refuse".
1718 receive.denyNonFastForwards::
1719 If set to true, git-receive-pack will deny a ref update which is
1720 not a fast-forward. Use this to prevent such an update via a push,
1721 even if that push is forced. This configuration variable is
1722 set when initializing a shared repository.
1724 receive.updateserverinfo::
1725 If set to true, git-receive-pack will run git-update-server-info
1726 after receiving data from git-push and updating refs.
1729 The URL of a remote repository. See linkgit:git-fetch[1] or
1730 linkgit:git-push[1].
1732 remote.<name>.pushurl::
1733 The push URL of a remote repository. See linkgit:git-push[1].
1735 remote.<name>.proxy::
1736 For remotes that require curl (http, https and ftp), the URL to
1737 the proxy to use for that remote. Set to the empty string to
1738 disable proxying for that remote.
1740 remote.<name>.fetch::
1741 The default set of "refspec" for linkgit:git-fetch[1]. See
1742 linkgit:git-fetch[1].
1744 remote.<name>.push::
1745 The default set of "refspec" for linkgit:git-push[1]. See
1746 linkgit:git-push[1].
1748 remote.<name>.mirror::
1749 If true, pushing to this remote will automatically behave
1750 as if the `\--mirror` option was given on the command line.
1752 remote.<name>.skipDefaultUpdate::
1753 If true, this remote will be skipped by default when updating
1754 using linkgit:git-fetch[1] or the `update` subcommand of
1755 linkgit:git-remote[1].
1757 remote.<name>.skipFetchAll::
1758 If true, this remote will be skipped by default when updating
1759 using linkgit:git-fetch[1] or the `update` subcommand of
1760 linkgit:git-remote[1].
1762 remote.<name>.receivepack::
1763 The default program to execute on the remote side when pushing. See
1764 option \--receive-pack of linkgit:git-push[1].
1766 remote.<name>.uploadpack::
1767 The default program to execute on the remote side when fetching. See
1768 option \--upload-pack of linkgit:git-fetch-pack[1].
1770 remote.<name>.tagopt::
1771 Setting this value to \--no-tags disables automatic tag following when
1772 fetching from remote <name>. Setting it to \--tags will fetch every
1773 tag from remote <name>, even if they are not reachable from remote
1774 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1775 override this setting. See options \--tags and \--no-tags of
1776 linkgit:git-fetch[1].
1779 Setting this to a value <vcs> will cause git to interact with
1780 the remote with the git-remote-<vcs> helper.
1783 The list of remotes which are fetched by "git remote update
1784 <group>". See linkgit:git-remote[1].
1786 repack.usedeltabaseoffset::
1787 By default, linkgit:git-repack[1] creates packs that use
1788 delta-base offset. If you need to share your repository with
1789 git older than version 1.4.4, either directly or via a dumb
1790 protocol such as http, then you need to set this option to
1791 "false" and repack. Access from old git versions over the
1792 native protocol are unaffected by this option.
1795 When set to true, `git-rerere` updates the index with the
1796 resulting contents after it cleanly resolves conflicts using
1797 previously recorded resolution. Defaults to false.
1800 Activate recording of resolved conflicts, so that identical
1801 conflict hunks can be resolved automatically, should they be
1802 encountered again. By default, linkgit:git-rerere[1] is
1803 enabled if there is an `rr-cache` directory under the
1804 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1807 sendemail.identity::
1808 A configuration identity. When given, causes values in the
1809 'sendemail.<identity>' subsection to take precedence over
1810 values in the 'sendemail' section. The default identity is
1811 the value of 'sendemail.identity'.
1813 sendemail.smtpencryption::
1814 See linkgit:git-send-email[1] for description. Note that this
1815 setting is not subject to the 'identity' mechanism.
1818 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1820 sendemail.<identity>.*::
1821 Identity-specific versions of the 'sendemail.*' parameters
1822 found below, taking precedence over those when the this
1823 identity is selected, through command-line or
1824 'sendemail.identity'.
1826 sendemail.aliasesfile::
1827 sendemail.aliasfiletype::
1831 sendemail.chainreplyto::
1833 sendemail.envelopesender::
1835 sendemail.multiedit::
1836 sendemail.signedoffbycc::
1837 sendemail.smtppass::
1838 sendemail.suppresscc::
1839 sendemail.suppressfrom::
1841 sendemail.smtpdomain::
1842 sendemail.smtpserver::
1843 sendemail.smtpserverport::
1844 sendemail.smtpserveroption::
1845 sendemail.smtpuser::
1847 sendemail.validate::
1848 See linkgit:git-send-email[1] for description.
1850 sendemail.signedoffcc::
1851 Deprecated alias for 'sendemail.signedoffbycc'.
1853 showbranch.default::
1854 The default set of branches for linkgit:git-show-branch[1].
1855 See linkgit:git-show-branch[1].
1857 status.relativePaths::
1858 By default, linkgit:git-status[1] shows paths relative to the
1859 current directory. Setting this variable to `false` shows paths
1860 relative to the repository root (this was the default for git
1863 status.showUntrackedFiles::
1864 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1865 files which are not currently tracked by Git. Directories which
1866 contain only untracked files, are shown with the directory name
1867 only. Showing untracked files means that Git needs to lstat() all
1868 all the files in the whole repository, which might be slow on some
1869 systems. So, this variable controls how the commands displays
1870 the untracked files. Possible values are:
1873 * `no` - Show no untracked files.
1874 * `normal` - Show untracked files and directories.
1875 * `all` - Show also individual files in untracked directories.
1878 If this variable is not specified, it defaults to 'normal'.
1879 This variable can be overridden with the -u|--untracked-files option
1880 of linkgit:git-status[1] and linkgit:git-commit[1].
1882 status.submodulesummary::
1884 If this is set to a non zero number or true (identical to -1 or an
1885 unlimited number), the submodule summary will be enabled and a
1886 summary of commits for modified submodules will be shown (see
1887 --summary-limit option of linkgit:git-submodule[1]).
1889 submodule.<name>.path::
1890 submodule.<name>.url::
1891 submodule.<name>.update::
1892 The path within this project, URL, and the updating strategy
1893 for a submodule. These variables are initially populated
1894 by 'git submodule init'; edit them to override the
1895 URL and other values found in the `.gitmodules` file. See
1896 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1898 submodule.<name>.fetchRecurseSubmodules::
1899 This option can be used to control recursive fetching of this
1900 submodule. It can be overridden by using the --[no-]recurse-submodules
1901 command line option to "git fetch" and "git pull".
1902 This setting will override that from in the linkgit:gitmodules[5]
1905 submodule.<name>.ignore::
1906 Defines under what circumstances "git status" and the diff family show
1907 a submodule as modified. When set to "all", it will never be considered
1908 modified, "dirty" will ignore all changes to the submodules work tree and
1909 takes only differences between the HEAD of the submodule and the commit
1910 recorded in the superproject into account. "untracked" will additionally
1911 let submodules with modified tracked files in their work tree show up.
1912 Using "none" (the default when this option is not set) also shows
1913 submodules that have untracked files in their work tree as changed.
1914 This setting overrides any setting made in .gitmodules for this submodule,
1915 both settings can be overridden on the command line by using the
1916 "--ignore-submodules" option.
1919 This variable can be used to restrict the permission bits of
1920 tar archive entries. The default is 0002, which turns off the
1921 world write bit. The special value "user" indicates that the
1922 archiving user's umask will be used instead. See umask(2) and
1923 linkgit:git-archive[1].
1925 transfer.fsckObjects::
1926 When `fetch.fsckObjects` or `receive.fsckObjects` are
1927 not set, the value of this variable is used instead.
1930 transfer.unpackLimit::
1931 When `fetch.unpackLimit` or `receive.unpackLimit` are
1932 not set, the value of this variable is used instead.
1933 The default value is 100.
1935 url.<base>.insteadOf::
1936 Any URL that starts with this value will be rewritten to
1937 start, instead, with <base>. In cases where some site serves a
1938 large number of repositories, and serves them with multiple
1939 access methods, and some users need to use different access
1940 methods, this feature allows people to specify any of the
1941 equivalent URLs and have git automatically rewrite the URL to
1942 the best alternative for the particular user, even for a
1943 never-before-seen repository on the site. When more than one
1944 insteadOf strings match a given URL, the longest match is used.
1946 url.<base>.pushInsteadOf::
1947 Any URL that starts with this value will not be pushed to;
1948 instead, it will be rewritten to start with <base>, and the
1949 resulting URL will be pushed to. In cases where some site serves
1950 a large number of repositories, and serves them with multiple
1951 access methods, some of which do not allow push, this feature
1952 allows people to specify a pull-only URL and have git
1953 automatically use an appropriate URL to push, even for a
1954 never-before-seen repository on the site. When more than one
1955 pushInsteadOf strings match a given URL, the longest match is
1956 used. If a remote has an explicit pushurl, git will ignore this
1957 setting for that remote.
1960 Your email address to be recorded in any newly created commits.
1961 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1962 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1965 Your full name to be recorded in any newly created commits.
1966 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1967 environment variables. See linkgit:git-commit-tree[1].
1970 If linkgit:git-tag[1] is not selecting the key you want it to
1971 automatically when creating a signed tag, you can override the
1972 default selection with this variable. This option is passed
1973 unchanged to gpg's --local-user parameter, so you may specify a key
1974 using any method that gpg supports.
1977 Specify a web browser that may be used by some commands.
1978 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]