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.
685 When the value is `interactive`, the rebase is run in interactive mode.
687 *NOTE*: this is a possibly dangerous operation; do *not* use
688 it unless you understand the implications (see linkgit:git-rebase[1]
692 Specify the command to invoke the specified browser. The
693 specified command is evaluated in shell with the URLs passed
694 as arguments. (See linkgit:git-web{litdd}browse[1].)
696 browser.<tool>.path::
697 Override the path for the given tool that may be used to
698 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
699 working repository in gitweb (see linkgit:git-instaweb[1]).
702 A boolean to make git-clean do nothing unless given -f
703 or -n. Defaults to true.
706 A boolean to enable/disable color in the output of
707 linkgit:git-branch[1]. May be set to `always`,
708 `false` (or `never`) or `auto` (or `true`), in which case colors are used
709 only when the output is to a terminal. Defaults to false.
711 color.branch.<slot>::
712 Use customized color for branch coloration. `<slot>` is one of
713 `current` (the current branch), `local` (a local branch),
714 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
717 The value for these configuration variables is a list of colors (at most
718 two) and attributes (at most one), separated by spaces. The colors
719 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
720 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
721 `blink` and `reverse`. The first color given is the foreground; the
722 second is the background. The position of the attribute, if any,
726 Whether to use ANSI escape sequences to add color to patches.
727 If this is set to `always`, linkgit:git-diff[1],
728 linkgit:git-log[1], and linkgit:git-show[1] will use color
729 for all patches. If it is set to `true` or `auto`, those
730 commands will only use color when output is to the terminal.
733 This does not affect linkgit:git-format-patch[1] nor the
734 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
735 command line with the `--color[=<when>]` option.
738 Use customized color for diff colorization. `<slot>` specifies
739 which part of the patch to use the specified color, and is one
740 of `plain` (context text), `meta` (metainformation), `frag`
741 (hunk header), 'func' (function in hunk header), `old` (removed lines),
742 `new` (added lines), `commit` (commit headers), or `whitespace`
743 (highlighting whitespace errors). The values of these variables may be
744 specified as in color.branch.<slot>.
746 color.decorate.<slot>::
747 Use customized color for 'git log --decorate' output. `<slot>` is one
748 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
749 branches, remote-tracking branches, tags, stash and HEAD, respectively.
752 When set to `always`, always highlight matches. When `false` (or
753 `never`), never. When set to `true` or `auto`, use color only
754 when the output is written to the terminal. Defaults to `false`.
757 Use customized color for grep colorization. `<slot>` specifies which
758 part of the line to use the specified color, and is one of
762 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
764 filename prefix (when not using `-h`)
766 function name lines (when using `-p`)
768 line number prefix (when using `-n`)
772 non-matching text in selected lines
774 separators between fields on a line (`:`, `-`, and `=`)
775 and between hunks (`--`)
778 The values of these variables may be specified as in color.branch.<slot>.
781 When set to `always`, always use colors for interactive prompts
782 and displays (such as those used by "git-add --interactive").
783 When false (or `never`), never. When set to `true` or `auto`, use
784 colors only when the output is to the terminal. Defaults to false.
786 color.interactive.<slot>::
787 Use customized color for 'git add --interactive'
788 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
789 four distinct types of normal output from interactive
790 commands. The values of these variables may be specified as
791 in color.branch.<slot>.
794 A boolean to enable/disable colored output when the pager is in
795 use (default is true).
798 A boolean to enable/disable color in the output of
799 linkgit:git-show-branch[1]. May be set to `always`,
800 `false` (or `never`) or `auto` (or `true`), in which case colors are used
801 only when the output is to a terminal. Defaults to false.
804 A boolean to enable/disable color in the output of
805 linkgit:git-status[1]. May be set to `always`,
806 `false` (or `never`) or `auto` (or `true`), in which case colors are used
807 only when the output is to a terminal. Defaults to false.
809 color.status.<slot>::
810 Use customized color for status colorization. `<slot>` is
811 one of `header` (the header text of the status message),
812 `added` or `updated` (files which are added but not committed),
813 `changed` (files which are changed but not added in the index),
814 `untracked` (files which are not tracked by git),
815 `branch` (the current branch), or
816 `nobranch` (the color the 'no branch' warning is shown in, defaulting
817 to red). The values of these variables may be specified as in
821 This variable determines the default value for variables such
822 as `color.diff` and `color.grep` that control the use of color
823 per command family. Its scope will expand as more commands learn
824 configuration to set a default for the `--color` option. Set it
825 to `always` if you want all output not intended for machine
826 consumption to use color, to `true` or `auto` if you want such
827 output to use color when written to the terminal, or to `false` or
828 `never` if you prefer git commands not to use color unless enabled
829 explicitly with some other configuration or the `--color` option.
832 A boolean to enable/disable inclusion of status information in the
833 commit message template when using an editor to prepare the commit
834 message. Defaults to true.
837 Specify a file to use as the template for new commit messages.
838 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
839 specified user's home directory.
842 Specify an external helper to be called when a username or
843 password credential is needed; the helper may consult external
844 storage to avoid prompting the user for the credentials. See
845 linkgit:gitcredentials[7] for details.
847 credential.useHttpPath::
848 When acquiring credentials, consider the "path" component of an http
849 or https URL to be important. Defaults to false. See
850 linkgit:gitcredentials[7] for more information.
852 credential.username::
853 If no username is set for a network authentication, use this username
854 by default. See credential.<context>.* below, and
855 linkgit:gitcredentials[7].
858 Any of the credential.* options above can be applied selectively to
859 some credentials. For example "credential.https://example.com.username"
860 would set the default username only for https connections to
861 example.com. See linkgit:gitcredentials[7] for details on how URLs are
864 include::diff-config.txt[]
866 difftool.<tool>.path::
867 Override the path for the given tool. This is useful in case
868 your tool is not in the PATH.
870 difftool.<tool>.cmd::
871 Specify the command to invoke the specified diff tool.
872 The specified command is evaluated in shell with the following
873 variables available: 'LOCAL' is set to the name of the temporary
874 file containing the contents of the diff pre-image and 'REMOTE'
875 is set to the name of the temporary file containing the contents
876 of the diff post-image.
879 Prompt before each invocation of the diff tool.
882 A POSIX Extended Regular Expression used to determine what is a "word"
883 when performing word-by-word difference calculations. Character
884 sequences that match the regular expression are "words", all other
885 characters are *ignorable* whitespace.
887 fetch.recurseSubmodules::
888 This option can be either set to a boolean value or to 'on-demand'.
889 Setting it to a boolean changes the behavior of fetch and pull to
890 unconditionally recurse into submodules when set to true or to not
891 recurse at all when set to false. When set to 'on-demand' (the default
892 value), fetch and pull will only recurse into a populated submodule
893 when its superproject retrieves a commit that updates the submodule's
897 If it is set to true, git-fetch-pack will check all fetched
898 objects. It will abort in the case of a malformed object or a
899 broken link. The result of an abort are only dangling objects.
900 Defaults to false. If not set, the value of `transfer.fsckObjects`
904 If the number of objects fetched over the git native
905 transfer is below this
906 limit, then the objects will be unpacked into loose object
907 files. However if the number of received objects equals or
908 exceeds this limit then the received pack will be stored as
909 a pack, after adding any missing delta bases. Storing the
910 pack from a push can make the push operation complete faster,
911 especially on slow filesystems. If not set, the value of
912 `transfer.unpackLimit` is used instead.
915 Enable multipart/mixed attachments as the default for
916 'format-patch'. The value can also be a double quoted string
917 which will enable attachments as the default and set the
918 value as the boundary. See the --attach option in
919 linkgit:git-format-patch[1].
922 A boolean which can enable or disable sequence numbers in patch
923 subjects. It defaults to "auto" which enables it only if there
924 is more than one patch. It can be enabled or disabled for all
925 messages by setting it to "true" or "false". See --numbered
926 option in linkgit:git-format-patch[1].
929 Additional email headers to include in a patch to be submitted
930 by mail. See linkgit:git-format-patch[1].
934 Additional recipients to include in a patch to be submitted
935 by mail. See the --to and --cc options in
936 linkgit:git-format-patch[1].
938 format.subjectprefix::
939 The default for format-patch is to output files with the '[PATCH]'
940 subject prefix. Use this variable to change that prefix.
943 The default for format-patch is to output a signature containing
944 the git version number. Use this variable to change that default.
945 Set this variable to the empty string ("") to suppress
946 signature generation.
949 The default for format-patch is to output files with the suffix
950 `.patch`. Use this variable to change that suffix (make sure to
951 include the dot if you want it).
954 The default pretty format for log/show/whatchanged command,
955 See linkgit:git-log[1], linkgit:git-show[1],
956 linkgit:git-whatchanged[1].
959 The default threading style for 'git format-patch'. Can be
960 a boolean value, or `shallow` or `deep`. `shallow` threading
961 makes every mail a reply to the head of the series,
962 where the head is chosen from the cover letter, the
963 `\--in-reply-to`, and the first patch mail, in this order.
964 `deep` threading makes every mail a reply to the previous one.
965 A true boolean value is the same as `shallow`, and a false
966 value disables threading.
969 A boolean value which lets you enable the `-s/--signoff` option of
970 format-patch by default. *Note:* Adding the Signed-off-by: line to a
971 patch should be a conscious act and means that you certify you have
972 the rights to submit this work under the same open source license.
973 Please see the 'SubmittingPatches' document for further discussion.
975 filter.<driver>.clean::
976 The command which is used to convert the content of a worktree
977 file to a blob upon checkin. See linkgit:gitattributes[5] for
980 filter.<driver>.smudge::
981 The command which is used to convert the content of a blob
982 object to a worktree file upon checkout. See
983 linkgit:gitattributes[5] for details.
985 gc.aggressiveWindow::
986 The window size parameter used in the delta compression
987 algorithm used by 'git gc --aggressive'. This defaults
991 When there are approximately more than this many loose
992 objects in the repository, `git gc --auto` will pack them.
993 Some Porcelain commands use this command to perform a
994 light-weight garbage collection from time to time. The
995 default value is 6700. Setting this to 0 disables it.
998 When there are more than this many packs that are not
999 marked with `*.keep` file in the repository, `git gc
1000 --auto` consolidates them into one larger pack. The
1001 default value is 50. Setting this to 0 disables it.
1004 Running `git pack-refs` in a repository renders it
1005 unclonable by Git versions prior to 1.5.1.2 over dumb
1006 transports such as HTTP. This variable determines whether
1007 'git gc' runs `git pack-refs`. This can be set to `notbare`
1008 to enable it within all non-bare repos or it can be set to a
1009 boolean value. The default is `true`.
1012 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1013 Override the grace period with this config variable. The value
1014 "now" may be used to disable this grace period and always prune
1015 unreachable objects immediately.
1018 gc.<pattern>.reflogexpire::
1019 'git reflog expire' removes reflog entries older than
1020 this time; defaults to 90 days. With "<pattern>" (e.g.
1021 "refs/stash") in the middle the setting applies only to
1022 the refs that match the <pattern>.
1024 gc.reflogexpireunreachable::
1025 gc.<ref>.reflogexpireunreachable::
1026 'git reflog expire' removes reflog entries older than
1027 this time and are not reachable from the current tip;
1028 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1029 in the middle, the setting applies only to the refs that
1030 match the <pattern>.
1033 Records of conflicted merge you resolved earlier are
1034 kept for this many days when 'git rerere gc' is run.
1035 The default is 60 days. See linkgit:git-rerere[1].
1037 gc.rerereunresolved::
1038 Records of conflicted merge you have not resolved are
1039 kept for this many days when 'git rerere gc' is run.
1040 The default is 15 days. See linkgit:git-rerere[1].
1042 gitcvs.commitmsgannotation::
1043 Append this string to each commit message. Set to empty string
1044 to disable this feature. Defaults to "via git-CVS emulator".
1047 Whether the CVS server interface is enabled for this repository.
1048 See linkgit:git-cvsserver[1].
1051 Path to a log file where the CVS server interface well... logs
1052 various stuff. See linkgit:git-cvsserver[1].
1054 gitcvs.usecrlfattr::
1055 If true, the server will look up the end-of-line conversion
1056 attributes for files to determine the '-k' modes to use. If
1057 the attributes force git to treat a file as text,
1058 the '-k' mode will be left blank so CVS clients will
1059 treat it as text. If they suppress text conversion, the file
1060 will be set with '-kb' mode, which suppresses any newline munging
1061 the client might otherwise do. If the attributes do not allow
1062 the file type to be determined, then 'gitcvs.allbinary' is
1063 used. See linkgit:gitattributes[5].
1066 This is used if 'gitcvs.usecrlfattr' does not resolve
1067 the correct '-kb' mode to use. If true, all
1068 unresolved files are sent to the client in
1069 mode '-kb'. This causes the client to treat them
1070 as binary files, which suppresses any newline munging it
1071 otherwise might do. Alternatively, if it is set to "guess",
1072 then the contents of the file are examined to decide if
1073 it is binary, similar to 'core.autocrlf'.
1076 Database used by git-cvsserver to cache revision information
1077 derived from the git repository. The exact meaning depends on the
1078 used database driver, for SQLite (which is the default driver) this
1079 is a filename. Supports variable substitution (see
1080 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1081 Default: '%Ggitcvs.%m.sqlite'
1084 Used Perl DBI driver. You can specify any available driver
1085 for this here, but it might not work. git-cvsserver is tested
1086 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1087 reported *not* to work with 'DBD::mysql'. Experimental feature.
1088 May not contain double colons (`:`). Default: 'SQLite'.
1089 See linkgit:git-cvsserver[1].
1091 gitcvs.dbuser, gitcvs.dbpass::
1092 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1093 since SQLite has no concept of database users and/or passwords.
1094 'gitcvs.dbuser' supports variable substitution (see
1095 linkgit:git-cvsserver[1] for details).
1097 gitcvs.dbTableNamePrefix::
1098 Database table name prefix. Prepended to the names of any
1099 database tables used, allowing a single database to be used
1100 for several repositories. Supports variable substitution (see
1101 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1102 characters will be replaced with underscores.
1104 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1105 'gitcvs.allbinary' can also be specified as
1106 'gitcvs.<access_method>.<varname>' (where 'access_method'
1107 is one of "ext" and "pserver") to make them apply only for the given
1111 gitweb.description::
1114 See linkgit:gitweb[1] for description.
1122 gitweb.remote_heads::
1125 See linkgit:gitweb.conf[5] for description.
1128 If set to true, enable '-n' option by default.
1130 grep.extendedRegexp::
1131 If set to true, enable '--extended-regexp' option by default.
1134 Use this custom program instead of "gpg" found on $PATH when
1135 making or verifying a PGP signature. The program must support the
1136 same command line interface as GPG, namely, to verify a detached
1137 signature, "gpg --verify $file - <$signature" is run, and the
1138 program is expected to signal a good signature by exiting with
1139 code 0, and to generate an ascii-armored detached signature, the
1140 standard input of "gpg -bsau $key" is fed with the contents to be
1141 signed, and the program is expected to send the result to its
1144 gui.commitmsgwidth::
1145 Defines how wide the commit message window is in the
1146 linkgit:git-gui[1]. "75" is the default.
1149 Specifies how many context lines should be used in calls to diff
1150 made by the linkgit:git-gui[1]. The default is "5".
1153 Specifies the default encoding to use for displaying of
1154 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1155 It can be overridden by setting the 'encoding' attribute
1156 for relevant files (see linkgit:gitattributes[5]).
1157 If this option is not set, the tools default to the
1160 gui.matchtrackingbranch::
1161 Determines if new branches created with linkgit:git-gui[1] should
1162 default to tracking remote branches with matching names or
1163 not. Default: "false".
1165 gui.newbranchtemplate::
1166 Is used as suggested name when creating new branches using the
1169 gui.pruneduringfetch::
1170 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1171 performing a fetch. The default value is "false".
1174 Determines if linkgit:git-gui[1] should trust the file modification
1175 timestamp or not. By default the timestamps are not trusted.
1177 gui.spellingdictionary::
1178 Specifies the dictionary used for spell checking commit messages in
1179 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1183 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1184 location detection. It makes blame significantly faster on huge
1185 repositories at the expense of less thorough copy detection.
1187 gui.copyblamethreshold::
1188 Specifies the threshold to use in 'git gui blame' original location
1189 detection, measured in alphanumeric characters. See the
1190 linkgit:git-blame[1] manual for more information on copy detection.
1192 gui.blamehistoryctx::
1193 Specifies the radius of history context in days to show in
1194 linkgit:gitk[1] for the selected commit, when the `Show History
1195 Context` menu item is invoked from 'git gui blame'. If this
1196 variable is set to zero, the whole history is shown.
1198 guitool.<name>.cmd::
1199 Specifies the shell command line to execute when the corresponding item
1200 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1201 mandatory for every tool. The command is executed from the root of
1202 the working directory, and in the environment it receives the name of
1203 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1204 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1205 the head is detached, 'CUR_BRANCH' is empty).
1207 guitool.<name>.needsfile::
1208 Run the tool only if a diff is selected in the GUI. It guarantees
1209 that 'FILENAME' is not empty.
1211 guitool.<name>.noconsole::
1212 Run the command silently, without creating a window to display its
1215 guitool.<name>.norescan::
1216 Don't rescan the working directory for changes after the tool
1219 guitool.<name>.confirm::
1220 Show a confirmation dialog before actually running the tool.
1222 guitool.<name>.argprompt::
1223 Request a string argument from the user, and pass it to the tool
1224 through the 'ARGS' environment variable. Since requesting an
1225 argument implies confirmation, the 'confirm' option has no effect
1226 if this is enabled. If the option is set to 'true', 'yes', or '1',
1227 the dialog uses a built-in generic prompt; otherwise the exact
1228 value of the variable is used.
1230 guitool.<name>.revprompt::
1231 Request a single valid revision from the user, and set the
1232 'REVISION' environment variable. In other aspects this option
1233 is similar to 'argprompt', and can be used together with it.
1235 guitool.<name>.revunmerged::
1236 Show only unmerged branches in the 'revprompt' subdialog.
1237 This is useful for tools similar to merge or rebase, but not
1238 for things like checkout or reset.
1240 guitool.<name>.title::
1241 Specifies the title to use for the prompt dialog. The default
1244 guitool.<name>.prompt::
1245 Specifies the general prompt string to display at the top of
1246 the dialog, before subsections for 'argprompt' and 'revprompt'.
1247 The default value includes the actual command.
1250 Specify the browser that will be used to display help in the
1251 'web' format. See linkgit:git-help[1].
1254 Override the default help format used by linkgit:git-help[1].
1255 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1256 the default. 'web' and 'html' are the same.
1259 Automatically correct and execute mistyped commands after
1260 waiting for the given number of deciseconds (0.1 sec). If more
1261 than one command can be deduced from the entered text, nothing
1262 will be executed. If the value of this option is negative,
1263 the corrected command will be executed immediately. If the
1264 value is 0 - the command will be just shown but not executed.
1265 This is the default.
1268 Override the HTTP proxy, normally configured using the 'http_proxy'
1269 environment variable (see linkgit:curl[1]). This can be overridden
1270 on a per-remote basis; see remote.<name>.proxy
1273 File containing previously stored cookie lines which should be used
1274 in the git http session, if they match the server. The file format
1275 of the file to read cookies from should be plain HTTP headers or
1276 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1277 NOTE that the file specified with http.cookiefile is only used as
1278 input. No cookies will be stored in the file.
1281 Whether to verify the SSL certificate when fetching or pushing
1282 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1286 File containing the SSL certificate when fetching or pushing
1287 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1291 File containing the SSL private key when fetching or pushing
1292 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1295 http.sslCertPasswordProtected::
1296 Enable git's password prompt for the SSL certificate. Otherwise
1297 OpenSSL will prompt the user, possibly many times, if the
1298 certificate or private key is encrypted. Can be overridden by the
1299 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1302 File containing the certificates to verify the peer with when
1303 fetching or pushing over HTTPS. Can be overridden by the
1304 'GIT_SSL_CAINFO' environment variable.
1307 Path containing files with the CA certificates to verify the peer
1308 with when fetching or pushing over HTTPS. Can be overridden
1309 by the 'GIT_SSL_CAPATH' environment variable.
1312 How many HTTP requests to launch in parallel. Can be overridden
1313 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1316 The number of curl sessions (counted across slots) to be kept across
1317 requests. They will not be ended with curl_easy_cleanup() until
1318 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1319 value will be capped at 1. Defaults to 1.
1322 Maximum size in bytes of the buffer used by smart HTTP
1323 transports when POSTing data to the remote system.
1324 For requests larger than this buffer size, HTTP/1.1 and
1325 Transfer-Encoding: chunked is used to avoid creating a
1326 massive pack file locally. Default is 1 MiB, which is
1327 sufficient for most requests.
1329 http.lowSpeedLimit, http.lowSpeedTime::
1330 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1331 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1332 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1333 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1336 A boolean which disables using of EPSV ftp command by curl.
1337 This can helpful with some "poor" ftp servers which don't
1338 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1339 environment variable. Default is false (curl will use EPSV).
1342 The HTTP USER_AGENT string presented to an HTTP server. The default
1343 value represents the version of the client git such as git/1.7.1.
1344 This option allows you to override this value to a more common value
1345 such as Mozilla/4.0. This may be necessary, for instance, if
1346 connecting through a firewall that restricts HTTP connections to a set
1347 of common USER_AGENT strings (but not including those like git/1.7.1).
1348 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1350 i18n.commitEncoding::
1351 Character encoding the commit messages are stored in; git itself
1352 does not care per se, but this information is necessary e.g. when
1353 importing commits from emails or in the gitk graphical history
1354 browser (and possibly at other places in the future or in other
1355 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1357 i18n.logOutputEncoding::
1358 Character encoding the commit messages are converted to when
1359 running 'git log' and friends.
1362 The configuration variables in the 'imap' section are described
1363 in linkgit:git-imap-send[1].
1366 Specify the directory from which templates will be copied.
1367 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1370 Specify the program that will be used to browse your working
1371 repository in gitweb. See linkgit:git-instaweb[1].
1374 The HTTP daemon command-line to start gitweb on your working
1375 repository. See linkgit:git-instaweb[1].
1378 If true the web server started by linkgit:git-instaweb[1] will
1379 be bound to the local IP (127.0.0.1).
1381 instaweb.modulepath::
1382 The default module path for linkgit:git-instaweb[1] to use
1383 instead of /usr/lib/apache2/modules. Only used if httpd
1387 The port number to bind the gitweb httpd to. See
1388 linkgit:git-instaweb[1].
1390 interactive.singlekey::
1391 In interactive commands, allow the user to provide one-letter
1392 input with a single key (i.e., without hitting enter).
1393 Currently this is used by the `\--patch` mode of
1394 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1395 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1396 setting is silently ignored if portable keystroke input
1400 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1401 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1402 override this option with `\--no-abbrev-commit`.
1405 Set the default date-time mode for the 'log' command.
1406 Setting a value for log.date is similar to using 'git log''s
1407 `\--date` option. Possible values are `relative`, `local`,
1408 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1412 Print out the ref names of any commits that are shown by the log
1413 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1414 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1415 specified, the full ref name (including prefix) will be printed.
1416 This is the same as the log commands '--decorate' option.
1419 If true, the initial commit will be shown as a big creation event.
1420 This is equivalent to a diff against an empty tree.
1421 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1422 normally hide the root commit will now show it. True by default.
1425 The location of an augmenting mailmap file. The default
1426 mailmap, located in the root of the repository, is loaded
1427 first, then the mailmap file pointed to by this variable.
1428 The location of the mailmap file may be in a repository
1429 subdirectory, or somewhere outside of the repository itself.
1430 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1433 Specify the programs that may be used to display help in the
1434 'man' format. See linkgit:git-help[1].
1437 Specify the command to invoke the specified man viewer. The
1438 specified command is evaluated in shell with the man page
1439 passed as argument. (See linkgit:git-help[1].)
1442 Override the path for the given tool that may be used to
1443 display help in the 'man' format. See linkgit:git-help[1].
1445 include::merge-config.txt[]
1447 mergetool.<tool>.path::
1448 Override the path for the given tool. This is useful in case
1449 your tool is not in the PATH.
1451 mergetool.<tool>.cmd::
1452 Specify the command to invoke the specified merge tool. The
1453 specified command is evaluated in shell with the following
1454 variables available: 'BASE' is the name of a temporary file
1455 containing the common base of the files to be merged, if available;
1456 'LOCAL' is the name of a temporary file containing the contents of
1457 the file on the current branch; 'REMOTE' is the name of a temporary
1458 file containing the contents of the file from the branch being
1459 merged; 'MERGED' contains the name of the file to which the merge
1460 tool should write the results of a successful merge.
1462 mergetool.<tool>.trustExitCode::
1463 For a custom merge command, specify whether the exit code of
1464 the merge command can be used to determine whether the merge was
1465 successful. If this is not set to true then the merge target file
1466 timestamp is checked and the merge assumed to have been successful
1467 if the file has been updated, otherwise the user is prompted to
1468 indicate the success of the merge.
1470 mergetool.keepBackup::
1471 After performing a merge, the original file with conflict markers
1472 can be saved as a file with a `.orig` extension. If this variable
1473 is set to `false` then this file is not preserved. Defaults to
1474 `true` (i.e. keep the backup files).
1476 mergetool.keepTemporaries::
1477 When invoking a custom merge tool, git uses a set of temporary
1478 files to pass to the tool. If the tool returns an error and this
1479 variable is set to `true`, then these temporary files will be
1480 preserved, otherwise they will be removed after the tool has
1481 exited. Defaults to `false`.
1484 Prompt before each invocation of the merge resolution program.
1487 The (fully qualified) refname from which to show notes when
1488 showing commit messages. The value of this variable can be set
1489 to a glob, in which case notes from all matching refs will be
1490 shown. You may also specify this configuration variable
1491 several times. A warning will be issued for refs that do not
1492 exist, but a glob that does not match any refs is silently
1495 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1496 environment variable, which must be a colon separated list of refs or
1499 The effective value of "core.notesRef" (possibly overridden by
1500 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1503 notes.rewrite.<command>::
1504 When rewriting commits with <command> (currently `amend` or
1505 `rebase`) and this variable is set to `true`, git
1506 automatically copies your notes from the original to the
1507 rewritten commit. Defaults to `true`, but see
1508 "notes.rewriteRef" below.
1511 When copying notes during a rewrite (see the
1512 "notes.rewrite.<command>" option), determines what to do if
1513 the target commit already has a note. Must be one of
1514 `overwrite`, `concatenate`, or `ignore`. Defaults to
1517 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1518 environment variable.
1521 When copying notes during a rewrite, specifies the (fully
1522 qualified) ref whose notes should be copied. The ref may be a
1523 glob, in which case notes in all matching refs will be copied.
1524 You may also specify this configuration several times.
1526 Does not have a default value; you must configure this variable to
1527 enable note rewriting. Set it to `refs/notes/commits` to enable
1528 rewriting for the default commit notes.
1530 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1531 environment variable, which must be a colon separated list of refs or
1535 The size of the window used by linkgit:git-pack-objects[1] when no
1536 window size is given on the command line. Defaults to 10.
1539 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1540 maximum depth is given on the command line. Defaults to 50.
1543 The window memory size limit used by linkgit:git-pack-objects[1]
1544 when no limit is given on the command line. The value can be
1545 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1549 An integer -1..9, indicating the compression level for objects
1550 in a pack file. -1 is the zlib default. 0 means no
1551 compression, and 1..9 are various speed/size tradeoffs, 9 being
1552 slowest. If not set, defaults to core.compression. If that is
1553 not set, defaults to -1, the zlib default, which is "a default
1554 compromise between speed and compression (currently equivalent
1557 Note that changing the compression level will not automatically recompress
1558 all existing objects. You can force recompression by passing the -F option
1559 to linkgit:git-repack[1].
1561 pack.deltaCacheSize::
1562 The maximum memory in bytes used for caching deltas in
1563 linkgit:git-pack-objects[1] before writing them out to a pack.
1564 This cache is used to speed up the writing object phase by not
1565 having to recompute the final delta result once the best match
1566 for all objects is found. Repacking large repositories on machines
1567 which are tight with memory might be badly impacted by this though,
1568 especially if this cache pushes the system into swapping.
1569 A value of 0 means no limit. The smallest size of 1 byte may be
1570 used to virtually disable this cache. Defaults to 256 MiB.
1572 pack.deltaCacheLimit::
1573 The maximum size of a delta, that is cached in
1574 linkgit:git-pack-objects[1]. This cache is used to speed up the
1575 writing object phase by not having to recompute the final delta
1576 result once the best match for all objects is found. Defaults to 1000.
1579 Specifies the number of threads to spawn when searching for best
1580 delta matches. This requires that linkgit:git-pack-objects[1]
1581 be compiled with pthreads otherwise this option is ignored with a
1582 warning. This is meant to reduce packing time on multiprocessor
1583 machines. The required amount of memory for the delta search window
1584 is however multiplied by the number of threads.
1585 Specifying 0 will cause git to auto-detect the number of CPU's
1586 and set the number of threads accordingly.
1589 Specify the default pack index version. Valid values are 1 for
1590 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1591 the new pack index with capabilities for packs larger than 4 GB
1592 as well as proper protection against the repacking of corrupted
1593 packs. Version 2 is the default. Note that version 2 is enforced
1594 and this config option ignored whenever the corresponding pack is
1597 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1598 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1599 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1600 other side may give you a repository that cannot be accessed with your
1601 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1602 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1603 the `{asterisk}.idx` file.
1605 pack.packSizeLimit::
1606 The maximum size of a pack. This setting only affects
1607 packing to a file when repacking, i.e. the git:// protocol
1608 is unaffected. It can be overridden by the `\--max-pack-size`
1609 option of linkgit:git-repack[1]. The minimum size allowed is
1610 limited to 1 MiB. The default is unlimited.
1611 Common unit suffixes of 'k', 'm', or 'g' are
1615 If the value is boolean, turns on or off pagination of the
1616 output of a particular git subcommand when writing to a tty.
1617 Otherwise, turns on pagination for the subcommand using the
1618 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1619 or `\--no-pager` is specified on the command line, it takes
1620 precedence over this option. To disable pagination for all
1621 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1624 Alias for a --pretty= format string, as specified in
1625 linkgit:git-log[1]. Any aliases defined here can be used just
1626 as the built-in pretty formats could. For example,
1627 running `git config pretty.changelog "format:{asterisk} %H %s"`
1628 would cause the invocation `git log --pretty=changelog`
1629 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1630 Note that an alias with the same name as a built-in format
1631 will be silently ignored.
1634 When true, rebase branches on top of the fetched branch, instead
1635 of merging the default branch from the default remote when "git
1636 pull" is run. See "branch.<name>.rebase" for setting this on a
1639 *NOTE*: this is a possibly dangerous operation; do *not* use
1640 it unless you understand the implications (see linkgit:git-rebase[1]
1644 The default merge strategy to use when pulling multiple branches
1648 The default merge strategy to use when pulling a single branch.
1651 Defines the action git push should take if no refspec is given
1652 on the command line, no refspec is configured in the remote, and
1653 no refspec is implied by any of the options given on the command
1654 line. Possible values are:
1656 * `nothing` - do not push anything.
1657 * `matching` - push all matching branches.
1658 All branches having the same name in both ends are considered to be
1659 matching. This is the default.
1660 * `upstream` - push the current branch to its upstream branch.
1661 * `tracking` - deprecated synonym for `upstream`.
1662 * `current` - push the current branch to a branch of the same name.
1665 Whether to show a diffstat of what changed upstream since the last
1666 rebase. False by default.
1669 If set to true enable '--autosquash' option by default.
1672 By default, git-receive-pack will run "git-gc --auto" after
1673 receiving data from git-push and updating refs. You can stop
1674 it by setting this variable to false.
1676 receive.fsckObjects::
1677 If it is set to true, git-receive-pack will check all received
1678 objects. It will abort in the case of a malformed object or a
1679 broken link. The result of an abort are only dangling objects.
1680 Defaults to false. If not set, the value of `transfer.fsckObjects`
1683 receive.unpackLimit::
1684 If the number of objects received in a push is below this
1685 limit then the objects will be unpacked into loose object
1686 files. However if the number of received objects equals or
1687 exceeds this limit then the received pack will be stored as
1688 a pack, after adding any missing delta bases. Storing the
1689 pack from a push can make the push operation complete faster,
1690 especially on slow filesystems. If not set, the value of
1691 `transfer.unpackLimit` is used instead.
1693 receive.denyDeletes::
1694 If set to true, git-receive-pack will deny a ref update that deletes
1695 the ref. Use this to prevent such a ref deletion via a push.
1697 receive.denyDeleteCurrent::
1698 If set to true, git-receive-pack will deny a ref update that
1699 deletes the currently checked out branch of a non-bare repository.
1701 receive.denyCurrentBranch::
1702 If set to true or "refuse", git-receive-pack will deny a ref update
1703 to the currently checked out branch of a non-bare repository.
1704 Such a push is potentially dangerous because it brings the HEAD
1705 out of sync with the index and working tree. If set to "warn",
1706 print a warning of such a push to stderr, but allow the push to
1707 proceed. If set to false or "ignore", allow such pushes with no
1708 message. Defaults to "refuse".
1710 There are two more options that are meant for Git experts: "updateInstead"
1711 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1712 the HEAD so it does not need to change. Both options come with their own
1713 set of possible *complications*, but can be appropriate in rare workflows.
1715 receive.denyNonFastForwards::
1716 If set to true, git-receive-pack will deny a ref update which is
1717 not a fast-forward. Use this to prevent such an update via a push,
1718 even if that push is forced. This configuration variable is
1719 set when initializing a shared repository.
1721 receive.updateserverinfo::
1722 If set to true, git-receive-pack will run git-update-server-info
1723 after receiving data from git-push and updating refs.
1726 The URL of a remote repository. See linkgit:git-fetch[1] or
1727 linkgit:git-push[1].
1729 remote.<name>.pushurl::
1730 The push URL of a remote repository. See linkgit:git-push[1].
1732 remote.<name>.proxy::
1733 For remotes that require curl (http, https and ftp), the URL to
1734 the proxy to use for that remote. Set to the empty string to
1735 disable proxying for that remote.
1737 remote.<name>.fetch::
1738 The default set of "refspec" for linkgit:git-fetch[1]. See
1739 linkgit:git-fetch[1].
1741 remote.<name>.push::
1742 The default set of "refspec" for linkgit:git-push[1]. See
1743 linkgit:git-push[1].
1745 remote.<name>.mirror::
1746 If true, pushing to this remote will automatically behave
1747 as if the `\--mirror` option was given on the command line.
1749 remote.<name>.skipDefaultUpdate::
1750 If true, this remote will be skipped by default when updating
1751 using linkgit:git-fetch[1] or the `update` subcommand of
1752 linkgit:git-remote[1].
1754 remote.<name>.skipFetchAll::
1755 If true, this remote will be skipped by default when updating
1756 using linkgit:git-fetch[1] or the `update` subcommand of
1757 linkgit:git-remote[1].
1759 remote.<name>.receivepack::
1760 The default program to execute on the remote side when pushing. See
1761 option \--receive-pack of linkgit:git-push[1].
1763 remote.<name>.uploadpack::
1764 The default program to execute on the remote side when fetching. See
1765 option \--upload-pack of linkgit:git-fetch-pack[1].
1767 remote.<name>.tagopt::
1768 Setting this value to \--no-tags disables automatic tag following when
1769 fetching from remote <name>. Setting it to \--tags will fetch every
1770 tag from remote <name>, even if they are not reachable from remote
1771 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1772 override this setting. See options \--tags and \--no-tags of
1773 linkgit:git-fetch[1].
1776 Setting this to a value <vcs> will cause git to interact with
1777 the remote with the git-remote-<vcs> helper.
1780 The list of remotes which are fetched by "git remote update
1781 <group>". See linkgit:git-remote[1].
1783 repack.usedeltabaseoffset::
1784 By default, linkgit:git-repack[1] creates packs that use
1785 delta-base offset. If you need to share your repository with
1786 git older than version 1.4.4, either directly or via a dumb
1787 protocol such as http, then you need to set this option to
1788 "false" and repack. Access from old git versions over the
1789 native protocol are unaffected by this option.
1792 When set to true, `git-rerere` updates the index with the
1793 resulting contents after it cleanly resolves conflicts using
1794 previously recorded resolution. Defaults to false.
1797 Activate recording of resolved conflicts, so that identical
1798 conflict hunks can be resolved automatically, should they be
1799 encountered again. By default, linkgit:git-rerere[1] is
1800 enabled if there is an `rr-cache` directory under the
1803 sendemail.identity::
1804 A configuration identity. When given, causes values in the
1805 'sendemail.<identity>' subsection to take precedence over
1806 values in the 'sendemail' section. The default identity is
1807 the value of 'sendemail.identity'.
1809 sendemail.smtpencryption::
1810 See linkgit:git-send-email[1] for description. Note that this
1811 setting is not subject to the 'identity' mechanism.
1814 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1816 sendemail.<identity>.*::
1817 Identity-specific versions of the 'sendemail.*' parameters
1818 found below, taking precedence over those when the this
1819 identity is selected, through command-line or
1820 'sendemail.identity'.
1822 sendemail.aliasesfile::
1823 sendemail.aliasfiletype::
1827 sendemail.chainreplyto::
1829 sendemail.envelopesender::
1831 sendemail.multiedit::
1832 sendemail.signedoffbycc::
1833 sendemail.smtppass::
1834 sendemail.suppresscc::
1835 sendemail.suppressfrom::
1837 sendemail.smtpdomain::
1838 sendemail.smtpserver::
1839 sendemail.smtpserverport::
1840 sendemail.smtpserveroption::
1841 sendemail.smtpuser::
1843 sendemail.validate::
1844 See linkgit:git-send-email[1] for description.
1846 sendemail.signedoffcc::
1847 Deprecated alias for 'sendemail.signedoffbycc'.
1849 showbranch.default::
1850 The default set of branches for linkgit:git-show-branch[1].
1851 See linkgit:git-show-branch[1].
1853 status.relativePaths::
1854 By default, linkgit:git-status[1] shows paths relative to the
1855 current directory. Setting this variable to `false` shows paths
1856 relative to the repository root (this was the default for git
1859 status.showUntrackedFiles::
1860 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1861 files which are not currently tracked by Git. Directories which
1862 contain only untracked files, are shown with the directory name
1863 only. Showing untracked files means that Git needs to lstat() all
1864 all the files in the whole repository, which might be slow on some
1865 systems. So, this variable controls how the commands displays
1866 the untracked files. Possible values are:
1869 * `no` - Show no untracked files.
1870 * `normal` - Show untracked files and directories.
1871 * `all` - Show also individual files in untracked directories.
1874 If this variable is not specified, it defaults to 'normal'.
1875 This variable can be overridden with the -u|--untracked-files option
1876 of linkgit:git-status[1] and linkgit:git-commit[1].
1878 status.submodulesummary::
1880 If this is set to a non zero number or true (identical to -1 or an
1881 unlimited number), the submodule summary will be enabled and a
1882 summary of commits for modified submodules will be shown (see
1883 --summary-limit option of linkgit:git-submodule[1]).
1885 submodule.<name>.path::
1886 submodule.<name>.url::
1887 submodule.<name>.update::
1888 The path within this project, URL, and the updating strategy
1889 for a submodule. These variables are initially populated
1890 by 'git submodule init'; edit them to override the
1891 URL and other values found in the `.gitmodules` file. See
1892 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1894 submodule.<name>.fetchRecurseSubmodules::
1895 This option can be used to control recursive fetching of this
1896 submodule. It can be overridden by using the --[no-]recurse-submodules
1897 command line option to "git fetch" and "git pull".
1898 This setting will override that from in the linkgit:gitmodules[5]
1901 submodule.<name>.ignore::
1902 Defines under what circumstances "git status" and the diff family show
1903 a submodule as modified. When set to "all", it will never be considered
1904 modified, "dirty" will ignore all changes to the submodules work tree and
1905 takes only differences between the HEAD of the submodule and the commit
1906 recorded in the superproject into account. "untracked" will additionally
1907 let submodules with modified tracked files in their work tree show up.
1908 Using "none" (the default when this option is not set) also shows
1909 submodules that have untracked files in their work tree as changed.
1910 This setting overrides any setting made in .gitmodules for this submodule,
1911 both settings can be overridden on the command line by using the
1912 "--ignore-submodules" option.
1915 This variable can be used to restrict the permission bits of
1916 tar archive entries. The default is 0002, which turns off the
1917 world write bit. The special value "user" indicates that the
1918 archiving user's umask will be used instead. See umask(2) and
1919 linkgit:git-archive[1].
1921 transfer.fsckObjects::
1922 When `fetch.fsckObjects` or `receive.fsckObjects` are
1923 not set, the value of this variable is used instead.
1926 transfer.unpackLimit::
1927 When `fetch.unpackLimit` or `receive.unpackLimit` are
1928 not set, the value of this variable is used instead.
1929 The default value is 100.
1931 url.<base>.insteadOf::
1932 Any URL that starts with this value will be rewritten to
1933 start, instead, with <base>. In cases where some site serves a
1934 large number of repositories, and serves them with multiple
1935 access methods, and some users need to use different access
1936 methods, this feature allows people to specify any of the
1937 equivalent URLs and have git automatically rewrite the URL to
1938 the best alternative for the particular user, even for a
1939 never-before-seen repository on the site. When more than one
1940 insteadOf strings match a given URL, the longest match is used.
1942 url.<base>.pushInsteadOf::
1943 Any URL that starts with this value will not be pushed to;
1944 instead, it will be rewritten to start with <base>, and the
1945 resulting URL will be pushed to. In cases where some site serves
1946 a large number of repositories, and serves them with multiple
1947 access methods, some of which do not allow push, this feature
1948 allows people to specify a pull-only URL and have git
1949 automatically use an appropriate URL to push, even for a
1950 never-before-seen repository on the site. When more than one
1951 pushInsteadOf strings match a given URL, the longest match is
1952 used. If a remote has an explicit pushurl, git will ignore this
1953 setting for that remote.
1956 Your email address to be recorded in any newly created commits.
1957 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1958 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1961 Your full name to be recorded in any newly created commits.
1962 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1963 environment variables. See linkgit:git-commit-tree[1].
1966 If linkgit:git-tag[1] is not selecting the key you want it to
1967 automatically when creating a signed tag, you can override the
1968 default selection with this variable. This option is passed
1969 unchanged to gpg's --local-user parameter, so you may specify a key
1970 using any method that gpg supports.
1973 Specify a web browser that may be used by some commands.
1974 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]