4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 1/0, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
91 ; Don't trust file modes
96 external = /usr/local/bin/diff-wrapper
101 merge = refs/heads/devel
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwriting local changes.
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
157 core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
218 CRLF conversion bears a slight chance of corrupting data.
219 When it is enabled, git will convert CRLF to LF during commit and LF to
220 CRLF during checkout. A file that contains a mixture of LF and
221 CRLF before the commit cannot be recreated by git. For text
222 files this is the right thing to do: it corrects line endings
223 such that we have only LF line endings in the repository.
224 But for binary files that are accidentally classified as text the
225 conversion can corrupt data.
227 If you recognize such corruption early you can easily fix it by
228 setting the conversion type explicitly in .gitattributes. Right
229 after committing you still have the original file in your work
230 tree and this file is not yet corrupted. You can explicitly tell
231 git that this file is binary and git will handle the file
234 Unfortunately, the desired effect of cleaning up text files with
235 mixed line endings and the undesired effect of corrupting binary
236 files cannot be distinguished. In both cases CRLFs are removed
237 in an irreversible way. For text files this is the right thing
238 to do because CRLFs are line endings, while for binary files
239 converting CRLFs corrupts data.
241 Note, this safety check does not mean that a checkout will generate a
242 file identical to the original file for a different setting of
243 `core.eol` and `core.autocrlf`, but only for the current one. For
244 example, a text file with `LF` would be accepted with `core.eol=lf`
245 and could later be checked out with `core.eol=crlf`, in which case the
246 resulting file would contain `CRLF`, although the original file
247 contained `LF`. However, in both work trees the line endings would be
248 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249 file with mixed line endings would be reported by the `core.safecrlf`
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
263 If false, symbolic links are checked out as small plain files that
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
266 file. Useful on filesystems like FAT that do not support
269 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270 will probe and set core.symlinks false if appropriate when the repository
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
282 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283 (which always applies universally, without the special "for"
286 The special string `none` can be used as the proxy command to
287 specify that no proxy be used for a given domain pattern.
288 This is useful for excluding servers inside a firewall from
289 proxy use, while defaulting to a common proxy for external domains.
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
301 core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
313 This setting is automatically guessed by linkgit:git-clone[1] or
314 linkgit:git-init[1] when the repository was created. By default a
315 repository that ends in "/.git" is assumed to be not bare (bare =
316 false), while all other repositories are assumed to be bare (bare
320 Set the path to the root of the working tree.
321 This can be overridden by the GIT_WORK_TREE environment
322 variable and the '--work-tree' command line option.
323 The value can be an absolute path or relative to the path to
324 the .git directory, which is either specified by --git-dir
325 or GIT_DIR, or automatically discovered.
326 If --git-dir or GIT_DIR is specified but none of
327 --work-tree, GIT_WORK_TREE and core.worktree is specified,
328 the current working directory is regarded as the top level
329 of your working tree.
331 Note that this variable is honored even when set in a configuration
332 file in a ".git" subdirectory of a directory and its value differs
333 from the latter directory (e.g. "/path/to/.git/config" has
334 core.worktree set to "/different/path"), which is most likely a
335 misconfiguration. Running git commands in the "/path/to" directory will
336 still use "/different/path" as the root of the work tree and can cause
337 confusion unless you know what you are doing (e.g. you are creating a
338 read-only snapshot of the same index to a location different from the
339 repository's usual working tree).
341 core.logAllRefUpdates::
342 Enable the reflog. Updates to a ref <ref> is logged to the file
343 "$GIT_DIR/logs/<ref>", by appending the new and old
344 SHA1, the date/time and the reason of the update, but
345 only when the file exists. If this configuration
346 variable is set to true, missing "$GIT_DIR/logs/<ref>"
347 file is automatically created for branch heads (i.e. under
348 refs/heads/), remote refs (i.e. under refs/remotes/),
349 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
351 This information can be used to determine what commit
352 was the tip of a branch "2 days ago".
354 This value is true by default in a repository that has
355 a working directory associated with it, and false by
356 default in a bare repository.
358 core.repositoryFormatVersion::
359 Internal variable identifying the repository format and layout
362 core.sharedRepository::
363 When 'group' (or 'true'), the repository is made shareable between
364 several users in a group (making sure all the files and objects are
365 group-writable). When 'all' (or 'world' or 'everybody'), the
366 repository will be readable by all users, additionally to being
367 group-shareable. When 'umask' (or 'false'), git will use permissions
368 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
369 files in the repository will have this mode value. '0xxx' will override
370 user's umask value (whereas the other options will only override
371 requested parts of the user's umask value). Examples: '0660' will make
372 the repo read/write-able for the owner and group, but inaccessible to
373 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
374 repository that is group-readable but not group-writable.
375 See linkgit:git-init[1]. False by default.
377 core.warnAmbiguousRefs::
378 If true, git will warn you if the ref name you passed it is ambiguous
379 and might match multiple refs in the .git/refs/ tree. True by default.
382 An integer -1..9, indicating a default compression level.
383 -1 is the zlib default. 0 means no compression,
384 and 1..9 are various speed/size tradeoffs, 9 being slowest.
385 If set, this provides a default to other compression variables,
386 such as 'core.loosecompression' and 'pack.compression'.
388 core.loosecompression::
389 An integer -1..9, indicating the compression level for objects that
390 are not in a pack file. -1 is the zlib default. 0 means no
391 compression, and 1..9 are various speed/size tradeoffs, 9 being
392 slowest. If not set, defaults to core.compression. If that is
393 not set, defaults to 1 (best speed).
395 core.packedGitWindowSize::
396 Number of bytes of a pack file to map into memory in a
397 single mapping operation. Larger window sizes may allow
398 your system to process a smaller number of large pack files
399 more quickly. Smaller window sizes will negatively affect
400 performance due to increased calls to the operating system's
401 memory manager, but may improve performance when accessing
402 a large number of large pack files.
404 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
405 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
406 be reasonable for all users/operating systems. You probably do
407 not need to adjust this value.
409 Common unit suffixes of 'k', 'm', or 'g' are supported.
411 core.packedGitLimit::
412 Maximum number of bytes to map simultaneously into memory
413 from pack files. If Git needs to access more than this many
414 bytes at once to complete an operation it will unmap existing
415 regions to reclaim virtual address space within the process.
417 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
418 This should be reasonable for all users/operating systems, except on
419 the largest projects. You probably do not need to adjust this value.
421 Common unit suffixes of 'k', 'm', or 'g' are supported.
423 core.deltaBaseCacheLimit::
424 Maximum number of bytes to reserve for caching base objects
425 that may be referenced by multiple deltified objects. By storing the
426 entire decompressed base objects in a cache Git is able
427 to avoid unpacking and decompressing frequently used base
428 objects multiple times.
430 Default is 16 MiB on all platforms. This should be reasonable
431 for all users/operating systems, except on the largest projects.
432 You probably do not need to adjust this value.
434 Common unit suffixes of 'k', 'm', or 'g' are supported.
436 core.bigFileThreshold::
437 Files larger than this size are stored deflated, without
438 attempting delta compression. Storing large files without
439 delta compression avoids excessive memory usage, at the
440 slight expense of increased disk usage.
442 Default is 512 MiB on all platforms. This should be reasonable
443 for most projects as source code and other text files can still
444 be delta compressed, but larger binary media files won't be.
446 Common unit suffixes of 'k', 'm', or 'g' are supported.
449 In addition to '.gitignore' (per-directory) and
450 '.git/info/exclude', git looks into this file for patterns
451 of files which are not meant to be tracked. "{tilde}/" is expanded
452 to the value of `$HOME` and "{tilde}user/" to the specified user's
453 home directory. See linkgit:gitignore[5].
456 Some commands (e.g. svn and http interfaces) that interactively
457 ask for a password can be told to use an external program given
458 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
459 environment variable. If not set, fall back to the value of the
460 'SSH_ASKPASS' environment variable or, failing that, a simple password
461 prompt. The external program shall be given a suitable prompt as
462 command line argument and write the password on its STDOUT.
464 core.attributesfile::
465 In addition to '.gitattributes' (per-directory) and
466 '.git/info/attributes', git looks into this file for attributes
467 (see linkgit:gitattributes[5]). Path expansions are made the same
468 way as for `core.excludesfile`.
471 Commands such as `commit` and `tag` that lets you edit
472 messages by launching an editor uses the value of this
473 variable when it is set, and the environment variable
474 `GIT_EDITOR` is not set. See linkgit:git-var[1].
477 Text editor used by `git rebase -i` for editing the rebase insn file.
478 The value is meant to be interpreted by the shell when it is used.
479 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
480 When not configured the default commit message editor is used instead.
483 The command that git will use to paginate output. Can
484 be overridden with the `GIT_PAGER` environment
485 variable. Note that git sets the `LESS` environment
486 variable to `FRSX` if it is unset when it runs the
487 pager. One can change these settings by setting the
488 `LESS` variable to some other value. Alternately,
489 these settings can be overridden on a project or
490 global basis by setting the `core.pager` option.
491 Setting `core.pager` has no affect on the `LESS`
492 environment variable behaviour above, so if you want
493 to override git's default settings this way, you need
494 to be explicit. For example, to disable the S option
495 in a backward compatible manner, set `core.pager`
496 to `less -+$LESS -FRX`. This will be passed to the
497 shell by git, which will translate the final command to
498 `LESS=FRSX less -+FRSX -FRX`.
501 A comma separated list of common whitespace problems to
502 notice. 'git diff' will use `color.diff.whitespace` to
503 highlight them, and 'git apply --whitespace=error' will
504 consider them as errors. You can prefix `-` to disable
505 any of them (e.g. `-trailing-space`):
507 * `blank-at-eol` treats trailing whitespaces at the end of the line
508 as an error (enabled by default).
509 * `space-before-tab` treats a space character that appears immediately
510 before a tab character in the initial indent part of the line as an
511 error (enabled by default).
512 * `indent-with-non-tab` treats a line that is indented with 8 or more
513 space characters as an error (not enabled by default).
514 * `tab-in-indent` treats a tab character in the initial indent part of
515 the line as an error (not enabled by default).
516 * `blank-at-eof` treats blank lines added at the end of file as an error
517 (enabled by default).
518 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
520 * `cr-at-eol` treats a carriage-return at the end of line as
521 part of the line terminator, i.e. with it, `trailing-space`
522 does not trigger if the character before such a carriage-return
523 is not a whitespace (not enabled by default).
524 * `tabwidth=<n>` tells how many character positions a tab occupies; this
525 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
526 errors. The default tab width is 8. Allowed values are 1 to 63.
528 core.fsyncobjectfiles::
529 This boolean will enable 'fsync()' when writing object files.
531 This is a total waste of time and effort on a filesystem that orders
532 data writes properly, but can be useful for filesystems that do not use
533 journalling (traditional UNIX filesystems) or that only journal metadata
534 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
537 Enable parallel index preload for operations like 'git diff'
539 This can speed up operations like 'git diff' and 'git status' especially
540 on filesystems like NFS that have weak caching semantics and thus
541 relatively high IO latencies. With this set to 'true', git will do the
542 index comparison to the filesystem data in parallel, allowing
546 You can set this to 'link', in which case a hardlink followed by
547 a delete of the source are used to make sure that object creation
548 will not overwrite existing objects.
550 On some file system/operating system combinations, this is unreliable.
551 Set this config setting to 'rename' there; However, This will remove the
552 check that makes sure that existing object files will not get overwritten.
555 When showing commit messages, also show notes which are stored in
556 the given ref. The ref must be fully qualified. If the given
557 ref does not exist, it is not an error but means that no
558 notes should be printed.
560 This setting defaults to "refs/notes/commits", and it can be overridden by
561 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
563 core.sparseCheckout::
564 Enable "sparse checkout" feature. See section "Sparse checkout" in
565 linkgit:git-read-tree[1] for more information.
568 Set the length object names are abbreviated to. If unspecified,
569 many commands abbreviate to 7 hexdigits, which may not be enough
570 for abbreviated object names to stay unique for sufficiently long
575 Tells 'git add' to continue adding files when some files cannot be
576 added due to indexing errors. Equivalent to the '--ignore-errors'
577 option of linkgit:git-add[1]. Older versions of git accept only
578 `add.ignore-errors`, which does not follow the usual naming
579 convention for configuration variables. Newer versions of git
580 honor `add.ignoreErrors` as well.
583 Command aliases for the linkgit:git[1] command wrapper - e.g.
584 after defining "alias.last = cat-file commit HEAD", the invocation
585 "git last" is equivalent to "git cat-file commit HEAD". To avoid
586 confusion and troubles with script usage, aliases that
587 hide existing git commands are ignored. Arguments are split by
588 spaces, the usual shell quoting and escaping is supported.
589 quote pair and a backslash can be used to quote them.
591 If the alias expansion is prefixed with an exclamation point,
592 it will be treated as a shell command. For example, defining
593 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
594 "git new" is equivalent to running the shell command
595 "gitk --all --not ORIG_HEAD". Note that shell commands will be
596 executed from the top-level directory of a repository, which may
597 not necessarily be the current directory.
598 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
599 from the original current directory. See linkgit:git-rev-parse[1].
602 If true, git-am will call git-mailsplit for patches in mbox format
603 with parameter '--keep-cr'. In this case git-mailsplit will
604 not remove `\r` from lines ending with `\r\n`. Can be overridden
605 by giving '--no-keep-cr' from the command line.
606 See linkgit:git-am[1], linkgit:git-mailsplit[1].
608 apply.ignorewhitespace::
609 When set to 'change', tells 'git apply' to ignore changes in
610 whitespace, in the same way as the '--ignore-space-change'
612 When set to one of: no, none, never, false tells 'git apply' to
613 respect all whitespace differences.
614 See linkgit:git-apply[1].
617 Tells 'git apply' how to handle whitespaces, in the same way
618 as the '--whitespace' option. See linkgit:git-apply[1].
620 branch.autosetupmerge::
621 Tells 'git branch' and 'git checkout' to set up new branches
622 so that linkgit:git-pull[1] will appropriately merge from the
623 starting point branch. Note that even if this option is not set,
624 this behavior can be chosen per-branch using the `--track`
625 and `--no-track` options. The valid settings are: `false` -- no
626 automatic setup is done; `true` -- automatic setup is done when the
627 starting point is a remote-tracking branch; `always` --
628 automatic setup is done when the starting point is either a
629 local branch or remote-tracking
630 branch. This option defaults to true.
632 branch.autosetuprebase::
633 When a new branch is created with 'git branch' or 'git checkout'
634 that tracks another branch, this variable tells git to set
635 up pull to rebase instead of merge (see "branch.<name>.rebase").
636 When `never`, rebase is never automatically set to true.
637 When `local`, rebase is set to true for tracked branches of
638 other local branches.
639 When `remote`, rebase is set to true for tracked branches of
640 remote-tracking branches.
641 When `always`, rebase will be set to true for all tracking
643 See "branch.autosetupmerge" for details on how to set up a
644 branch to track another branch.
645 This option defaults to never.
647 branch.<name>.remote::
648 When in branch <name>, it tells 'git fetch' and 'git push' which
649 remote to fetch from/push to. It defaults to `origin` if no remote is
650 configured. `origin` is also used if you are not on any branch.
652 branch.<name>.merge::
653 Defines, together with branch.<name>.remote, the upstream branch
654 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
655 branch to merge and can also affect 'git push' (see push.default).
656 When in branch <name>, it tells 'git fetch' the default
657 refspec to be marked for merging in FETCH_HEAD. The value is
658 handled like the remote part of a refspec, and must match a
659 ref which is fetched from the remote given by
660 "branch.<name>.remote".
661 The merge information is used by 'git pull' (which at first calls
662 'git fetch') to lookup the default branch for merging. Without
663 this option, 'git pull' defaults to merge the first refspec fetched.
664 Specify multiple values to get an octopus merge.
665 If you wish to setup 'git pull' so that it merges into <name> from
666 another branch in the local repository, you can point
667 branch.<name>.merge to the desired branch, and use the special setting
668 `.` (a period) for branch.<name>.remote.
670 branch.<name>.mergeoptions::
671 Sets default options for merging into branch <name>. The syntax and
672 supported options are the same as those of linkgit:git-merge[1], but
673 option values containing whitespace characters are currently not
676 branch.<name>.rebase::
677 When true, rebase the branch <name> on top of the fetched branch,
678 instead of merging the default branch from the default remote when
680 *NOTE*: this is a possibly dangerous operation; do *not* use
681 it unless you understand the implications (see linkgit:git-rebase[1]
685 Specify the command to invoke the specified browser. The
686 specified command is evaluated in shell with the URLs passed
687 as arguments. (See linkgit:git-web{litdd}browse[1].)
689 browser.<tool>.path::
690 Override the path for the given tool that may be used to
691 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
692 working repository in gitweb (see linkgit:git-instaweb[1]).
695 A boolean to make git-clean do nothing unless given -f
696 or -n. Defaults to true.
699 A boolean to enable/disable color in the output of
700 linkgit:git-branch[1]. May be set to `always`,
701 `false` (or `never`) or `auto` (or `true`), in which case colors are used
702 only when the output is to a terminal. Defaults to false.
704 color.branch.<slot>::
705 Use customized color for branch coloration. `<slot>` is one of
706 `current` (the current branch), `local` (a local branch),
707 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
710 The value for these configuration variables is a list of colors (at most
711 two) and attributes (at most one), separated by spaces. The colors
712 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
713 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
714 `blink` and `reverse`. The first color given is the foreground; the
715 second is the background. The position of the attribute, if any,
719 Whether to use ANSI escape sequences to add color to patches.
720 If this is set to `always`, linkgit:git-diff[1],
721 linkgit:git-log[1], and linkgit:git-show[1] will use color
722 for all patches. If it is set to `true` or `auto`, those
723 commands will only use color when output is to the terminal.
726 This does not affect linkgit:git-format-patch[1] nor the
727 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
728 command line with the `--color[=<when>]` option.
731 Use customized color for diff colorization. `<slot>` specifies
732 which part of the patch to use the specified color, and is one
733 of `plain` (context text), `meta` (metainformation), `frag`
734 (hunk header), 'func' (function in hunk header), `old` (removed lines),
735 `new` (added lines), `commit` (commit headers), or `whitespace`
736 (highlighting whitespace errors). The values of these variables may be
737 specified as in color.branch.<slot>.
739 color.decorate.<slot>::
740 Use customized color for 'git log --decorate' output. `<slot>` is one
741 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
742 branches, remote-tracking branches, tags, stash and HEAD, respectively.
745 When set to `always`, always highlight matches. When `false` (or
746 `never`), never. When set to `true` or `auto`, use color only
747 when the output is written to the terminal. Defaults to `false`.
750 Use customized color for grep colorization. `<slot>` specifies which
751 part of the line to use the specified color, and is one of
755 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
757 filename prefix (when not using `-h`)
759 function name lines (when using `-p`)
761 line number prefix (when using `-n`)
765 non-matching text in selected lines
767 separators between fields on a line (`:`, `-`, and `=`)
768 and between hunks (`--`)
771 The values of these variables may be specified as in color.branch.<slot>.
774 When set to `always`, always use colors for interactive prompts
775 and displays (such as those used by "git-add --interactive").
776 When false (or `never`), never. When set to `true` or `auto`, use
777 colors only when the output is to the terminal. Defaults to false.
779 color.interactive.<slot>::
780 Use customized color for 'git add --interactive'
781 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
782 four distinct types of normal output from interactive
783 commands. The values of these variables may be specified as
784 in color.branch.<slot>.
787 A boolean to enable/disable colored output when the pager is in
788 use (default is true).
791 A boolean to enable/disable color in the output of
792 linkgit:git-show-branch[1]. May be set to `always`,
793 `false` (or `never`) or `auto` (or `true`), in which case colors are used
794 only when the output is to a terminal. Defaults to false.
797 A boolean to enable/disable color in the output of
798 linkgit:git-status[1]. May be set to `always`,
799 `false` (or `never`) or `auto` (or `true`), in which case colors are used
800 only when the output is to a terminal. Defaults to false.
802 color.status.<slot>::
803 Use customized color for status colorization. `<slot>` is
804 one of `header` (the header text of the status message),
805 `added` or `updated` (files which are added but not committed),
806 `changed` (files which are changed but not added in the index),
807 `untracked` (files which are not tracked by git),
808 `branch` (the current branch), or
809 `nobranch` (the color the 'no branch' warning is shown in, defaulting
810 to red). The values of these variables may be specified as in
814 This variable determines the default value for variables such
815 as `color.diff` and `color.grep` that control the use of color
816 per command family. Its scope will expand as more commands learn
817 configuration to set a default for the `--color` option. Set it
818 to `always` if you want all output not intended for machine
819 consumption to use color, to `true` or `auto` if you want such
820 output to use color when written to the terminal, or to `false` or
821 `never` if you prefer git commands not to use color unless enabled
822 explicitly with some other configuration or the `--color` option.
825 A boolean to enable/disable inclusion of status information in the
826 commit message template when using an editor to prepare the commit
827 message. Defaults to true.
830 Specify a file to use as the template for new commit messages.
831 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
832 specified user's home directory.
834 include::diff-config.txt[]
836 difftool.<tool>.path::
837 Override the path for the given tool. This is useful in case
838 your tool is not in the PATH.
840 difftool.<tool>.cmd::
841 Specify the command to invoke the specified diff tool.
842 The specified command is evaluated in shell with the following
843 variables available: 'LOCAL' is set to the name of the temporary
844 file containing the contents of the diff pre-image and 'REMOTE'
845 is set to the name of the temporary file containing the contents
846 of the diff post-image.
849 Prompt before each invocation of the diff tool.
852 A POSIX Extended Regular Expression used to determine what is a "word"
853 when performing word-by-word difference calculations. Character
854 sequences that match the regular expression are "words", all other
855 characters are *ignorable* whitespace.
857 fetch.recurseSubmodules::
858 This option can be either set to a boolean value or to 'on-demand'.
859 Setting it to a boolean changes the behavior of fetch and pull to
860 unconditionally recurse into submodules when set to true or to not
861 recurse at all when set to false. When set to 'on-demand' (the default
862 value), fetch and pull will only recurse into a populated submodule
863 when its superproject retrieves a commit that updates the submodule's
867 If the number of objects fetched over the git native
868 transfer is below this
869 limit, then the objects will be unpacked into loose object
870 files. However if the number of received objects equals or
871 exceeds this limit then the received pack will be stored as
872 a pack, after adding any missing delta bases. Storing the
873 pack from a push can make the push operation complete faster,
874 especially on slow filesystems. If not set, the value of
875 `transfer.unpackLimit` is used instead.
878 Enable multipart/mixed attachments as the default for
879 'format-patch'. The value can also be a double quoted string
880 which will enable attachments as the default and set the
881 value as the boundary. See the --attach option in
882 linkgit:git-format-patch[1].
885 A boolean which can enable or disable sequence numbers in patch
886 subjects. It defaults to "auto" which enables it only if there
887 is more than one patch. It can be enabled or disabled for all
888 messages by setting it to "true" or "false". See --numbered
889 option in linkgit:git-format-patch[1].
892 Additional email headers to include in a patch to be submitted
893 by mail. See linkgit:git-format-patch[1].
897 Additional recipients to include in a patch to be submitted
898 by mail. See the --to and --cc options in
899 linkgit:git-format-patch[1].
901 format.subjectprefix::
902 The default for format-patch is to output files with the '[PATCH]'
903 subject prefix. Use this variable to change that prefix.
906 The default for format-patch is to output a signature containing
907 the git version number. Use this variable to change that default.
908 Set this variable to the empty string ("") to suppress
909 signature generation.
912 The default for format-patch is to output files with the suffix
913 `.patch`. Use this variable to change that suffix (make sure to
914 include the dot if you want it).
917 The default pretty format for log/show/whatchanged command,
918 See linkgit:git-log[1], linkgit:git-show[1],
919 linkgit:git-whatchanged[1].
922 The default threading style for 'git format-patch'. Can be
923 a boolean value, or `shallow` or `deep`. `shallow` threading
924 makes every mail a reply to the head of the series,
925 where the head is chosen from the cover letter, the
926 `\--in-reply-to`, and the first patch mail, in this order.
927 `deep` threading makes every mail a reply to the previous one.
928 A true boolean value is the same as `shallow`, and a false
929 value disables threading.
932 A boolean value which lets you enable the `-s/--signoff` option of
933 format-patch by default. *Note:* Adding the Signed-off-by: line to a
934 patch should be a conscious act and means that you certify you have
935 the rights to submit this work under the same open source license.
936 Please see the 'SubmittingPatches' document for further discussion.
938 filter.<driver>.clean::
939 The command which is used to convert the content of a worktree
940 file to a blob upon checkin. See linkgit:gitattributes[5] for
943 filter.<driver>.smudge::
944 The command which is used to convert the content of a blob
945 object to a worktree file upon checkout. See
946 linkgit:gitattributes[5] for details.
948 gc.aggressiveWindow::
949 The window size parameter used in the delta compression
950 algorithm used by 'git gc --aggressive'. This defaults
954 When there are approximately more than this many loose
955 objects in the repository, `git gc --auto` will pack them.
956 Some Porcelain commands use this command to perform a
957 light-weight garbage collection from time to time. The
958 default value is 6700. Setting this to 0 disables it.
961 When there are more than this many packs that are not
962 marked with `*.keep` file in the repository, `git gc
963 --auto` consolidates them into one larger pack. The
964 default value is 50. Setting this to 0 disables it.
967 Running `git pack-refs` in a repository renders it
968 unclonable by Git versions prior to 1.5.1.2 over dumb
969 transports such as HTTP. This variable determines whether
970 'git gc' runs `git pack-refs`. This can be set to `notbare`
971 to enable it within all non-bare repos or it can be set to a
972 boolean value. The default is `true`.
975 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
976 Override the grace period with this config variable. The value
977 "now" may be used to disable this grace period and always prune
978 unreachable objects immediately.
981 gc.<pattern>.reflogexpire::
982 'git reflog expire' removes reflog entries older than
983 this time; defaults to 90 days. With "<pattern>" (e.g.
984 "refs/stash") in the middle the setting applies only to
985 the refs that match the <pattern>.
987 gc.reflogexpireunreachable::
988 gc.<ref>.reflogexpireunreachable::
989 'git reflog expire' removes reflog entries older than
990 this time and are not reachable from the current tip;
991 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
992 in the middle, the setting applies only to the refs that
996 Records of conflicted merge you resolved earlier are
997 kept for this many days when 'git rerere gc' is run.
998 The default is 60 days. See linkgit:git-rerere[1].
1000 gc.rerereunresolved::
1001 Records of conflicted merge you have not resolved are
1002 kept for this many days when 'git rerere gc' is run.
1003 The default is 15 days. See linkgit:git-rerere[1].
1005 gitcvs.commitmsgannotation::
1006 Append this string to each commit message. Set to empty string
1007 to disable this feature. Defaults to "via git-CVS emulator".
1010 Whether the CVS server interface is enabled for this repository.
1011 See linkgit:git-cvsserver[1].
1014 Path to a log file where the CVS server interface well... logs
1015 various stuff. See linkgit:git-cvsserver[1].
1017 gitcvs.usecrlfattr::
1018 If true, the server will look up the end-of-line conversion
1019 attributes for files to determine the '-k' modes to use. If
1020 the attributes force git to treat a file as text,
1021 the '-k' mode will be left blank so CVS clients will
1022 treat it as text. If they suppress text conversion, the file
1023 will be set with '-kb' mode, which suppresses any newline munging
1024 the client might otherwise do. If the attributes do not allow
1025 the file type to be determined, then 'gitcvs.allbinary' is
1026 used. See linkgit:gitattributes[5].
1029 This is used if 'gitcvs.usecrlfattr' does not resolve
1030 the correct '-kb' mode to use. If true, all
1031 unresolved files are sent to the client in
1032 mode '-kb'. This causes the client to treat them
1033 as binary files, which suppresses any newline munging it
1034 otherwise might do. Alternatively, if it is set to "guess",
1035 then the contents of the file are examined to decide if
1036 it is binary, similar to 'core.autocrlf'.
1039 Database used by git-cvsserver to cache revision information
1040 derived from the git repository. The exact meaning depends on the
1041 used database driver, for SQLite (which is the default driver) this
1042 is a filename. Supports variable substitution (see
1043 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1044 Default: '%Ggitcvs.%m.sqlite'
1047 Used Perl DBI driver. You can specify any available driver
1048 for this here, but it might not work. git-cvsserver is tested
1049 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1050 reported *not* to work with 'DBD::mysql'. Experimental feature.
1051 May not contain double colons (`:`). Default: 'SQLite'.
1052 See linkgit:git-cvsserver[1].
1054 gitcvs.dbuser, gitcvs.dbpass::
1055 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1056 since SQLite has no concept of database users and/or passwords.
1057 'gitcvs.dbuser' supports variable substitution (see
1058 linkgit:git-cvsserver[1] for details).
1060 gitcvs.dbTableNamePrefix::
1061 Database table name prefix. Prepended to the names of any
1062 database tables used, allowing a single database to be used
1063 for several repositories. Supports variable substitution (see
1064 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1065 characters will be replaced with underscores.
1067 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1068 'gitcvs.allbinary' can also be specified as
1069 'gitcvs.<access_method>.<varname>' (where 'access_method'
1070 is one of "ext" and "pserver") to make them apply only for the given
1074 If set to true, enable '-n' option by default.
1076 grep.extendedRegexp::
1077 If set to true, enable '--extended-regexp' option by default.
1079 gui.commitmsgwidth::
1080 Defines how wide the commit message window is in the
1081 linkgit:git-gui[1]. "75" is the default.
1084 Specifies how many context lines should be used in calls to diff
1085 made by the linkgit:git-gui[1]. The default is "5".
1088 Specifies the default encoding to use for displaying of
1089 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1090 It can be overridden by setting the 'encoding' attribute
1091 for relevant files (see linkgit:gitattributes[5]).
1092 If this option is not set, the tools default to the
1095 gui.matchtrackingbranch::
1096 Determines if new branches created with linkgit:git-gui[1] should
1097 default to tracking remote branches with matching names or
1098 not. Default: "false".
1100 gui.newbranchtemplate::
1101 Is used as suggested name when creating new branches using the
1104 gui.pruneduringfetch::
1105 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1106 performing a fetch. The default value is "false".
1109 Determines if linkgit:git-gui[1] should trust the file modification
1110 timestamp or not. By default the timestamps are not trusted.
1112 gui.spellingdictionary::
1113 Specifies the dictionary used for spell checking commit messages in
1114 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1118 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1119 location detection. It makes blame significantly faster on huge
1120 repositories at the expense of less thorough copy detection.
1122 gui.copyblamethreshold::
1123 Specifies the threshold to use in 'git gui blame' original location
1124 detection, measured in alphanumeric characters. See the
1125 linkgit:git-blame[1] manual for more information on copy detection.
1127 gui.blamehistoryctx::
1128 Specifies the radius of history context in days to show in
1129 linkgit:gitk[1] for the selected commit, when the `Show History
1130 Context` menu item is invoked from 'git gui blame'. If this
1131 variable is set to zero, the whole history is shown.
1133 guitool.<name>.cmd::
1134 Specifies the shell command line to execute when the corresponding item
1135 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1136 mandatory for every tool. The command is executed from the root of
1137 the working directory, and in the environment it receives the name of
1138 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1139 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1140 the head is detached, 'CUR_BRANCH' is empty).
1142 guitool.<name>.needsfile::
1143 Run the tool only if a diff is selected in the GUI. It guarantees
1144 that 'FILENAME' is not empty.
1146 guitool.<name>.noconsole::
1147 Run the command silently, without creating a window to display its
1150 guitool.<name>.norescan::
1151 Don't rescan the working directory for changes after the tool
1154 guitool.<name>.confirm::
1155 Show a confirmation dialog before actually running the tool.
1157 guitool.<name>.argprompt::
1158 Request a string argument from the user, and pass it to the tool
1159 through the 'ARGS' environment variable. Since requesting an
1160 argument implies confirmation, the 'confirm' option has no effect
1161 if this is enabled. If the option is set to 'true', 'yes', or '1',
1162 the dialog uses a built-in generic prompt; otherwise the exact
1163 value of the variable is used.
1165 guitool.<name>.revprompt::
1166 Request a single valid revision from the user, and set the
1167 'REVISION' environment variable. In other aspects this option
1168 is similar to 'argprompt', and can be used together with it.
1170 guitool.<name>.revunmerged::
1171 Show only unmerged branches in the 'revprompt' subdialog.
1172 This is useful for tools similar to merge or rebase, but not
1173 for things like checkout or reset.
1175 guitool.<name>.title::
1176 Specifies the title to use for the prompt dialog. The default
1179 guitool.<name>.prompt::
1180 Specifies the general prompt string to display at the top of
1181 the dialog, before subsections for 'argprompt' and 'revprompt'.
1182 The default value includes the actual command.
1185 Specify the browser that will be used to display help in the
1186 'web' format. See linkgit:git-help[1].
1189 Override the default help format used by linkgit:git-help[1].
1190 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1191 the default. 'web' and 'html' are the same.
1194 Automatically correct and execute mistyped commands after
1195 waiting for the given number of deciseconds (0.1 sec). If more
1196 than one command can be deduced from the entered text, nothing
1197 will be executed. If the value of this option is negative,
1198 the corrected command will be executed immediately. If the
1199 value is 0 - the command will be just shown but not executed.
1200 This is the default.
1203 Override the HTTP proxy, normally configured using the 'http_proxy'
1204 environment variable (see linkgit:curl[1]). This can be overridden
1205 on a per-remote basis; see remote.<name>.proxy
1208 File containing previously stored cookie lines which should be used
1209 in the git http session, if they match the server. The file format
1210 of the file to read cookies from should be plain HTTP headers or
1211 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1212 NOTE that the file specified with http.cookiefile is only used as
1213 input. No cookies will be stored in the file.
1216 Whether to verify the SSL certificate when fetching or pushing
1217 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1221 File containing the SSL certificate when fetching or pushing
1222 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1226 File containing the SSL private key when fetching or pushing
1227 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1230 http.sslCertPasswordProtected::
1231 Enable git's password prompt for the SSL certificate. Otherwise
1232 OpenSSL will prompt the user, possibly many times, if the
1233 certificate or private key is encrypted. Can be overridden by the
1234 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1237 File containing the certificates to verify the peer with when
1238 fetching or pushing over HTTPS. Can be overridden by the
1239 'GIT_SSL_CAINFO' environment variable.
1242 Path containing files with the CA certificates to verify the peer
1243 with when fetching or pushing over HTTPS. Can be overridden
1244 by the 'GIT_SSL_CAPATH' environment variable.
1247 How many HTTP requests to launch in parallel. Can be overridden
1248 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1251 The number of curl sessions (counted across slots) to be kept across
1252 requests. They will not be ended with curl_easy_cleanup() until
1253 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1254 value will be capped at 1. Defaults to 1.
1257 Maximum size in bytes of the buffer used by smart HTTP
1258 transports when POSTing data to the remote system.
1259 For requests larger than this buffer size, HTTP/1.1 and
1260 Transfer-Encoding: chunked is used to avoid creating a
1261 massive pack file locally. Default is 1 MiB, which is
1262 sufficient for most requests.
1264 http.lowSpeedLimit, http.lowSpeedTime::
1265 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1266 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1267 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1268 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1271 A boolean which disables using of EPSV ftp command by curl.
1272 This can helpful with some "poor" ftp servers which don't
1273 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1274 environment variable. Default is false (curl will use EPSV).
1277 The HTTP USER_AGENT string presented to an HTTP server. The default
1278 value represents the version of the client git such as git/1.7.1.
1279 This option allows you to override this value to a more common value
1280 such as Mozilla/4.0. This may be necessary, for instance, if
1281 connecting through a firewall that restricts HTTP connections to a set
1282 of common USER_AGENT strings (but not including those like git/1.7.1).
1283 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1285 i18n.commitEncoding::
1286 Character encoding the commit messages are stored in; git itself
1287 does not care per se, but this information is necessary e.g. when
1288 importing commits from emails or in the gitk graphical history
1289 browser (and possibly at other places in the future or in other
1290 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1292 i18n.logOutputEncoding::
1293 Character encoding the commit messages are converted to when
1294 running 'git log' and friends.
1297 The configuration variables in the 'imap' section are described
1298 in linkgit:git-imap-send[1].
1301 Specify the directory from which templates will be copied.
1302 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1305 Specify the program that will be used to browse your working
1306 repository in gitweb. See linkgit:git-instaweb[1].
1309 The HTTP daemon command-line to start gitweb on your working
1310 repository. See linkgit:git-instaweb[1].
1313 If true the web server started by linkgit:git-instaweb[1] will
1314 be bound to the local IP (127.0.0.1).
1316 instaweb.modulepath::
1317 The default module path for linkgit:git-instaweb[1] to use
1318 instead of /usr/lib/apache2/modules. Only used if httpd
1322 The port number to bind the gitweb httpd to. See
1323 linkgit:git-instaweb[1].
1325 interactive.singlekey::
1326 In interactive commands, allow the user to provide one-letter
1327 input with a single key (i.e., without hitting enter).
1328 Currently this is used by the `\--patch` mode of
1329 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1330 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1331 setting is silently ignored if portable keystroke input
1335 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1336 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1337 override this option with `\--no-abbrev-commit`.
1340 Set the default date-time mode for the 'log' command.
1341 Setting a value for log.date is similar to using 'git log''s
1342 `\--date` option. Possible values are `relative`, `local`,
1343 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1347 Print out the ref names of any commits that are shown by the log
1348 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1349 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1350 specified, the full ref name (including prefix) will be printed.
1351 This is the same as the log commands '--decorate' option.
1354 If true, the initial commit will be shown as a big creation event.
1355 This is equivalent to a diff against an empty tree.
1356 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1357 normally hide the root commit will now show it. True by default.
1360 The location of an augmenting mailmap file. The default
1361 mailmap, located in the root of the repository, is loaded
1362 first, then the mailmap file pointed to by this variable.
1363 The location of the mailmap file may be in a repository
1364 subdirectory, or somewhere outside of the repository itself.
1365 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1368 Specify the programs that may be used to display help in the
1369 'man' format. See linkgit:git-help[1].
1372 Specify the command to invoke the specified man viewer. The
1373 specified command is evaluated in shell with the man page
1374 passed as argument. (See linkgit:git-help[1].)
1377 Override the path for the given tool that may be used to
1378 display help in the 'man' format. See linkgit:git-help[1].
1380 include::merge-config.txt[]
1382 mergetool.<tool>.path::
1383 Override the path for the given tool. This is useful in case
1384 your tool is not in the PATH.
1386 mergetool.<tool>.cmd::
1387 Specify the command to invoke the specified merge tool. The
1388 specified command is evaluated in shell with the following
1389 variables available: 'BASE' is the name of a temporary file
1390 containing the common base of the files to be merged, if available;
1391 'LOCAL' is the name of a temporary file containing the contents of
1392 the file on the current branch; 'REMOTE' is the name of a temporary
1393 file containing the contents of the file from the branch being
1394 merged; 'MERGED' contains the name of the file to which the merge
1395 tool should write the results of a successful merge.
1397 mergetool.<tool>.trustExitCode::
1398 For a custom merge command, specify whether the exit code of
1399 the merge command can be used to determine whether the merge was
1400 successful. If this is not set to true then the merge target file
1401 timestamp is checked and the merge assumed to have been successful
1402 if the file has been updated, otherwise the user is prompted to
1403 indicate the success of the merge.
1405 mergetool.keepBackup::
1406 After performing a merge, the original file with conflict markers
1407 can be saved as a file with a `.orig` extension. If this variable
1408 is set to `false` then this file is not preserved. Defaults to
1409 `true` (i.e. keep the backup files).
1411 mergetool.keepTemporaries::
1412 When invoking a custom merge tool, git uses a set of temporary
1413 files to pass to the tool. If the tool returns an error and this
1414 variable is set to `true`, then these temporary files will be
1415 preserved, otherwise they will be removed after the tool has
1416 exited. Defaults to `false`.
1419 Prompt before each invocation of the merge resolution program.
1422 The (fully qualified) refname from which to show notes when
1423 showing commit messages. The value of this variable can be set
1424 to a glob, in which case notes from all matching refs will be
1425 shown. You may also specify this configuration variable
1426 several times. A warning will be issued for refs that do not
1427 exist, but a glob that does not match any refs is silently
1430 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1431 environment variable, which must be a colon separated list of refs or
1434 The effective value of "core.notesRef" (possibly overridden by
1435 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1438 notes.rewrite.<command>::
1439 When rewriting commits with <command> (currently `amend` or
1440 `rebase`) and this variable is set to `true`, git
1441 automatically copies your notes from the original to the
1442 rewritten commit. Defaults to `true`, but see
1443 "notes.rewriteRef" below.
1446 When copying notes during a rewrite (see the
1447 "notes.rewrite.<command>" option), determines what to do if
1448 the target commit already has a note. Must be one of
1449 `overwrite`, `concatenate`, or `ignore`. Defaults to
1452 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1453 environment variable.
1456 When copying notes during a rewrite, specifies the (fully
1457 qualified) ref whose notes should be copied. The ref may be a
1458 glob, in which case notes in all matching refs will be copied.
1459 You may also specify this configuration several times.
1461 Does not have a default value; you must configure this variable to
1462 enable note rewriting.
1464 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1465 environment variable, which must be a colon separated list of refs or
1469 The size of the window used by linkgit:git-pack-objects[1] when no
1470 window size is given on the command line. Defaults to 10.
1473 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1474 maximum depth is given on the command line. Defaults to 50.
1477 The window memory size limit used by linkgit:git-pack-objects[1]
1478 when no limit is given on the command line. The value can be
1479 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1483 An integer -1..9, indicating the compression level for objects
1484 in a pack file. -1 is the zlib default. 0 means no
1485 compression, and 1..9 are various speed/size tradeoffs, 9 being
1486 slowest. If not set, defaults to core.compression. If that is
1487 not set, defaults to -1, the zlib default, which is "a default
1488 compromise between speed and compression (currently equivalent
1491 Note that changing the compression level will not automatically recompress
1492 all existing objects. You can force recompression by passing the -F option
1493 to linkgit:git-repack[1].
1495 pack.deltaCacheSize::
1496 The maximum memory in bytes used for caching deltas in
1497 linkgit:git-pack-objects[1] before writing them out to a pack.
1498 This cache is used to speed up the writing object phase by not
1499 having to recompute the final delta result once the best match
1500 for all objects is found. Repacking large repositories on machines
1501 which are tight with memory might be badly impacted by this though,
1502 especially if this cache pushes the system into swapping.
1503 A value of 0 means no limit. The smallest size of 1 byte may be
1504 used to virtually disable this cache. Defaults to 256 MiB.
1506 pack.deltaCacheLimit::
1507 The maximum size of a delta, that is cached in
1508 linkgit:git-pack-objects[1]. This cache is used to speed up the
1509 writing object phase by not having to recompute the final delta
1510 result once the best match for all objects is found. Defaults to 1000.
1513 Specifies the number of threads to spawn when searching for best
1514 delta matches. This requires that linkgit:git-pack-objects[1]
1515 be compiled with pthreads otherwise this option is ignored with a
1516 warning. This is meant to reduce packing time on multiprocessor
1517 machines. The required amount of memory for the delta search window
1518 is however multiplied by the number of threads.
1519 Specifying 0 will cause git to auto-detect the number of CPU's
1520 and set the number of threads accordingly.
1523 Specify the default pack index version. Valid values are 1 for
1524 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1525 the new pack index with capabilities for packs larger than 4 GB
1526 as well as proper protection against the repacking of corrupted
1527 packs. Version 2 is the default. Note that version 2 is enforced
1528 and this config option ignored whenever the corresponding pack is
1531 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1532 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1533 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1534 other side may give you a repository that cannot be accessed with your
1535 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1536 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1537 the `{asterisk}.idx` file.
1539 pack.packSizeLimit::
1540 The maximum size of a pack. This setting only affects
1541 packing to a file when repacking, i.e. the git:// protocol
1542 is unaffected. It can be overridden by the `\--max-pack-size`
1543 option of linkgit:git-repack[1]. The minimum size allowed is
1544 limited to 1 MiB. The default is unlimited.
1545 Common unit suffixes of 'k', 'm', or 'g' are
1549 If the value is boolean, turns on or off pagination of the
1550 output of a particular git subcommand when writing to a tty.
1551 Otherwise, turns on pagination for the subcommand using the
1552 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1553 or `\--no-pager` is specified on the command line, it takes
1554 precedence over this option. To disable pagination for all
1555 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1558 Alias for a --pretty= format string, as specified in
1559 linkgit:git-log[1]. Any aliases defined here can be used just
1560 as the built-in pretty formats could. For example,
1561 running `git config pretty.changelog "format:{asterisk} %H %s"`
1562 would cause the invocation `git log --pretty=changelog`
1563 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1564 Note that an alias with the same name as a built-in format
1565 will be silently ignored.
1568 The default merge strategy to use when pulling multiple branches
1572 The default merge strategy to use when pulling a single branch.
1575 Defines the action git push should take if no refspec is given
1576 on the command line, no refspec is configured in the remote, and
1577 no refspec is implied by any of the options given on the command
1578 line. Possible values are:
1580 * `nothing` - do not push anything.
1581 * `matching` - push all matching branches.
1582 All branches having the same name in both ends are considered to be
1583 matching. This is the default.
1584 * `upstream` - push the current branch to its upstream branch.
1585 * `tracking` - deprecated synonym for `upstream`.
1586 * `current` - push the current branch to a branch of the same name.
1589 Whether to show a diffstat of what changed upstream since the last
1590 rebase. False by default.
1593 If set to true enable '--autosquash' option by default.
1596 By default, git-receive-pack will run "git-gc --auto" after
1597 receiving data from git-push and updating refs. You can stop
1598 it by setting this variable to false.
1600 receive.fsckObjects::
1601 If it is set to true, git-receive-pack will check all received
1602 objects. It will abort in the case of a malformed object or a
1603 broken link. The result of an abort are only dangling objects.
1606 receive.unpackLimit::
1607 If the number of objects received in a push is below this
1608 limit then the objects will be unpacked into loose object
1609 files. However if the number of received objects equals or
1610 exceeds this limit then the received pack will be stored as
1611 a pack, after adding any missing delta bases. Storing the
1612 pack from a push can make the push operation complete faster,
1613 especially on slow filesystems. If not set, the value of
1614 `transfer.unpackLimit` is used instead.
1616 receive.denyDeletes::
1617 If set to true, git-receive-pack will deny a ref update that deletes
1618 the ref. Use this to prevent such a ref deletion via a push.
1620 receive.denyDeleteCurrent::
1621 If set to true, git-receive-pack will deny a ref update that
1622 deletes the currently checked out branch of a non-bare repository.
1624 receive.denyCurrentBranch::
1625 If set to true or "refuse", git-receive-pack will deny a ref update
1626 to the currently checked out branch of a non-bare repository.
1627 Such a push is potentially dangerous because it brings the HEAD
1628 out of sync with the index and working tree. If set to "warn",
1629 print a warning of such a push to stderr, but allow the push to
1630 proceed. If set to false or "ignore", allow such pushes with no
1631 message. Defaults to "refuse".
1633 receive.denyNonFastForwards::
1634 If set to true, git-receive-pack will deny a ref update which is
1635 not a fast-forward. Use this to prevent such an update via a push,
1636 even if that push is forced. This configuration variable is
1637 set when initializing a shared repository.
1639 receive.updateserverinfo::
1640 If set to true, git-receive-pack will run git-update-server-info
1641 after receiving data from git-push and updating refs.
1644 The URL of a remote repository. See linkgit:git-fetch[1] or
1645 linkgit:git-push[1].
1647 remote.<name>.pushurl::
1648 The push URL of a remote repository. See linkgit:git-push[1].
1650 remote.<name>.proxy::
1651 For remotes that require curl (http, https and ftp), the URL to
1652 the proxy to use for that remote. Set to the empty string to
1653 disable proxying for that remote.
1655 remote.<name>.fetch::
1656 The default set of "refspec" for linkgit:git-fetch[1]. See
1657 linkgit:git-fetch[1].
1659 remote.<name>.push::
1660 The default set of "refspec" for linkgit:git-push[1]. See
1661 linkgit:git-push[1].
1663 remote.<name>.mirror::
1664 If true, pushing to this remote will automatically behave
1665 as if the `\--mirror` option was given on the command line.
1667 remote.<name>.skipDefaultUpdate::
1668 If true, this remote will be skipped by default when updating
1669 using linkgit:git-fetch[1] or the `update` subcommand of
1670 linkgit:git-remote[1].
1672 remote.<name>.skipFetchAll::
1673 If true, this remote will be skipped by default when updating
1674 using linkgit:git-fetch[1] or the `update` subcommand of
1675 linkgit:git-remote[1].
1677 remote.<name>.receivepack::
1678 The default program to execute on the remote side when pushing. See
1679 option \--receive-pack of linkgit:git-push[1].
1681 remote.<name>.uploadpack::
1682 The default program to execute on the remote side when fetching. See
1683 option \--upload-pack of linkgit:git-fetch-pack[1].
1685 remote.<name>.tagopt::
1686 Setting this value to \--no-tags disables automatic tag following when
1687 fetching from remote <name>. Setting it to \--tags will fetch every
1688 tag from remote <name>, even if they are not reachable from remote
1689 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1690 override this setting. See options \--tags and \--no-tags of
1691 linkgit:git-fetch[1].
1694 Setting this to a value <vcs> will cause git to interact with
1695 the remote with the git-remote-<vcs> helper.
1698 The list of remotes which are fetched by "git remote update
1699 <group>". See linkgit:git-remote[1].
1701 repack.usedeltabaseoffset::
1702 By default, linkgit:git-repack[1] creates packs that use
1703 delta-base offset. If you need to share your repository with
1704 git older than version 1.4.4, either directly or via a dumb
1705 protocol such as http, then you need to set this option to
1706 "false" and repack. Access from old git versions over the
1707 native protocol are unaffected by this option.
1710 When set to true, `git-rerere` updates the index with the
1711 resulting contents after it cleanly resolves conflicts using
1712 previously recorded resolution. Defaults to false.
1715 Activate recording of resolved conflicts, so that identical
1716 conflict hunks can be resolved automatically, should they
1717 be encountered again. linkgit:git-rerere[1] command is by
1718 default enabled if you create `rr-cache` directory under
1719 `$GIT_DIR`, but can be disabled by setting this option to false.
1721 sendemail.identity::
1722 A configuration identity. When given, causes values in the
1723 'sendemail.<identity>' subsection to take precedence over
1724 values in the 'sendemail' section. The default identity is
1725 the value of 'sendemail.identity'.
1727 sendemail.smtpencryption::
1728 See linkgit:git-send-email[1] for description. Note that this
1729 setting is not subject to the 'identity' mechanism.
1732 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1734 sendemail.<identity>.*::
1735 Identity-specific versions of the 'sendemail.*' parameters
1736 found below, taking precedence over those when the this
1737 identity is selected, through command-line or
1738 'sendemail.identity'.
1740 sendemail.aliasesfile::
1741 sendemail.aliasfiletype::
1745 sendemail.chainreplyto::
1747 sendemail.envelopesender::
1749 sendemail.multiedit::
1750 sendemail.signedoffbycc::
1751 sendemail.smtppass::
1752 sendemail.suppresscc::
1753 sendemail.suppressfrom::
1755 sendemail.smtpdomain::
1756 sendemail.smtpserver::
1757 sendemail.smtpserverport::
1758 sendemail.smtpserveroption::
1759 sendemail.smtpuser::
1761 sendemail.validate::
1762 See linkgit:git-send-email[1] for description.
1764 sendemail.signedoffcc::
1765 Deprecated alias for 'sendemail.signedoffbycc'.
1767 showbranch.default::
1768 The default set of branches for linkgit:git-show-branch[1].
1769 See linkgit:git-show-branch[1].
1771 status.relativePaths::
1772 By default, linkgit:git-status[1] shows paths relative to the
1773 current directory. Setting this variable to `false` shows paths
1774 relative to the repository root (this was the default for git
1777 status.showUntrackedFiles::
1778 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1779 files which are not currently tracked by Git. Directories which
1780 contain only untracked files, are shown with the directory name
1781 only. Showing untracked files means that Git needs to lstat() all
1782 all the files in the whole repository, which might be slow on some
1783 systems. So, this variable controls how the commands displays
1784 the untracked files. Possible values are:
1787 * `no` - Show no untracked files.
1788 * `normal` - Show untracked files and directories.
1789 * `all` - Show also individual files in untracked directories.
1792 If this variable is not specified, it defaults to 'normal'.
1793 This variable can be overridden with the -u|--untracked-files option
1794 of linkgit:git-status[1] and linkgit:git-commit[1].
1796 status.submodulesummary::
1798 If this is set to a non zero number or true (identical to -1 or an
1799 unlimited number), the submodule summary will be enabled and a
1800 summary of commits for modified submodules will be shown (see
1801 --summary-limit option of linkgit:git-submodule[1]).
1803 submodule.<name>.path::
1804 submodule.<name>.url::
1805 submodule.<name>.update::
1806 The path within this project, URL, and the updating strategy
1807 for a submodule. These variables are initially populated
1808 by 'git submodule init'; edit them to override the
1809 URL and other values found in the `.gitmodules` file. See
1810 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1812 submodule.<name>.fetchRecurseSubmodules::
1813 This option can be used to control recursive fetching of this
1814 submodule. It can be overridden by using the --[no-]recurse-submodules
1815 command line option to "git fetch" and "git pull".
1816 This setting will override that from in the linkgit:gitmodules[5]
1819 submodule.<name>.ignore::
1820 Defines under what circumstances "git status" and the diff family show
1821 a submodule as modified. When set to "all", it will never be considered
1822 modified, "dirty" will ignore all changes to the submodules work tree and
1823 takes only differences between the HEAD of the submodule and the commit
1824 recorded in the superproject into account. "untracked" will additionally
1825 let submodules with modified tracked files in their work tree show up.
1826 Using "none" (the default when this option is not set) also shows
1827 submodules that have untracked files in their work tree as changed.
1828 This setting overrides any setting made in .gitmodules for this submodule,
1829 both settings can be overridden on the command line by using the
1830 "--ignore-submodules" option.
1833 This variable can be used to restrict the permission bits of
1834 tar archive entries. The default is 0002, which turns off the
1835 world write bit. The special value "user" indicates that the
1836 archiving user's umask will be used instead. See umask(2) and
1837 linkgit:git-archive[1].
1839 transfer.unpackLimit::
1840 When `fetch.unpackLimit` or `receive.unpackLimit` are
1841 not set, the value of this variable is used instead.
1842 The default value is 100.
1844 url.<base>.insteadOf::
1845 Any URL that starts with this value will be rewritten to
1846 start, instead, with <base>. In cases where some site serves a
1847 large number of repositories, and serves them with multiple
1848 access methods, and some users need to use different access
1849 methods, this feature allows people to specify any of the
1850 equivalent URLs and have git automatically rewrite the URL to
1851 the best alternative for the particular user, even for a
1852 never-before-seen repository on the site. When more than one
1853 insteadOf strings match a given URL, the longest match is used.
1855 url.<base>.pushInsteadOf::
1856 Any URL that starts with this value will not be pushed to;
1857 instead, it will be rewritten to start with <base>, and the
1858 resulting URL will be pushed to. In cases where some site serves
1859 a large number of repositories, and serves them with multiple
1860 access methods, some of which do not allow push, this feature
1861 allows people to specify a pull-only URL and have git
1862 automatically use an appropriate URL to push, even for a
1863 never-before-seen repository on the site. When more than one
1864 pushInsteadOf strings match a given URL, the longest match is
1865 used. If a remote has an explicit pushurl, git will ignore this
1866 setting for that remote.
1869 Your email address to be recorded in any newly created commits.
1870 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1871 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1874 Your full name to be recorded in any newly created commits.
1875 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1876 environment variables. See linkgit:git-commit-tree[1].
1879 If linkgit:git-tag[1] is not selecting the key you want it to
1880 automatically when creating a signed tag, you can override the
1881 default selection with this variable. This option is passed
1882 unchanged to gpg's --local-user parameter, so you may specify a key
1883 using any method that gpg supports.
1886 Specify a web browser that may be used by some commands.
1887 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]