4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 0/1, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
91 ; Don't trust file modes
96 external = /usr/local/bin/diff-wrapper
101 merge = refs/heads/devel
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid 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 work tree.
321 This can be overridden by the GIT_WORK_TREE environment
322 variable and the '--work-tree' command line option. It can be
323 an absolute path or a relative path to the .git directory,
324 either specified by --git-dir or GIT_DIR, or automatically
326 If --git-dir or GIT_DIR are specified but none of
327 --work-tree, GIT_WORK_TREE and core.worktree is specified,
328 the current working directory is regarded as the root of the
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 "/path/to" directory will
336 still use "/different/path" as the root of the work tree and can cause
337 great confusion to the users.
339 core.logAllRefUpdates::
340 Enable the reflog. Updates to a ref <ref> is logged to the file
341 "$GIT_DIR/logs/<ref>", by appending the new and old
342 SHA1, the date/time and the reason of the update, but
343 only when the file exists. If this configuration
344 variable is set to true, missing "$GIT_DIR/logs/<ref>"
345 file is automatically created for branch heads.
347 This information can be used to determine what commit
348 was the tip of a branch "2 days ago".
350 This value is true by default in a repository that has
351 a working directory associated with it, and false by
352 default in a bare repository.
354 core.repositoryFormatVersion::
355 Internal variable identifying the repository format and layout
358 core.sharedRepository::
359 When 'group' (or 'true'), the repository is made shareable between
360 several users in a group (making sure all the files and objects are
361 group-writable). When 'all' (or 'world' or 'everybody'), the
362 repository will be readable by all users, additionally to being
363 group-shareable. When 'umask' (or 'false'), git will use permissions
364 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
365 files in the repository will have this mode value. '0xxx' will override
366 user's umask value (whereas the other options will only override
367 requested parts of the user's umask value). Examples: '0660' will make
368 the repo read/write-able for the owner and group, but inaccessible to
369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
370 repository that is group-readable but not group-writable.
371 See linkgit:git-init[1]. False by default.
373 core.warnAmbiguousRefs::
374 If true, git will warn you if the ref name you passed it is ambiguous
375 and might match multiple refs in the .git/refs/ tree. True by default.
378 Even though git makes sure that it uses enough hexdigits to show
379 an abbreviated object name unambiguously, as more objects are
380 added to the repository over time, a short name that used to be
381 unique will stop being unique. Git uses this many extra hexdigits
382 that are more than necessary to make the object name currently
383 unique, in the hope that its output will stay unique a bit longer.
387 An integer -1..9, indicating a default compression level.
388 -1 is the zlib default. 0 means no compression,
389 and 1..9 are various speed/size tradeoffs, 9 being slowest.
390 If set, this provides a default to other compression variables,
391 such as 'core.loosecompression' and 'pack.compression'.
393 core.loosecompression::
394 An integer -1..9, indicating the compression level for objects that
395 are not in a pack file. -1 is the zlib default. 0 means no
396 compression, and 1..9 are various speed/size tradeoffs, 9 being
397 slowest. If not set, defaults to core.compression. If that is
398 not set, defaults to 1 (best speed).
400 core.packedGitWindowSize::
401 Number of bytes of a pack file to map into memory in a
402 single mapping operation. Larger window sizes may allow
403 your system to process a smaller number of large pack files
404 more quickly. Smaller window sizes will negatively affect
405 performance due to increased calls to the operating system's
406 memory manager, but may improve performance when accessing
407 a large number of large pack files.
409 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
410 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
411 be reasonable for all users/operating systems. You probably do
412 not need to adjust this value.
414 Common unit suffixes of 'k', 'm', or 'g' are supported.
416 core.packedGitLimit::
417 Maximum number of bytes to map simultaneously into memory
418 from pack files. If Git needs to access more than this many
419 bytes at once to complete an operation it will unmap existing
420 regions to reclaim virtual address space within the process.
422 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
423 This should be reasonable for all users/operating systems, except on
424 the largest projects. You probably do not need to adjust this value.
426 Common unit suffixes of 'k', 'm', or 'g' are supported.
428 core.deltaBaseCacheLimit::
429 Maximum number of bytes to reserve for caching base objects
430 that may be referenced by multiple deltified objects. By storing the
431 entire decompressed base objects in a cache Git is able
432 to avoid unpacking and decompressing frequently used base
433 objects multiple times.
435 Default is 16 MiB on all platforms. This should be reasonable
436 for all users/operating systems, except on the largest projects.
437 You probably do not need to adjust this value.
439 Common unit suffixes of 'k', 'm', or 'g' are supported.
441 core.bigFileThreshold::
442 Files larger than this size are stored deflated, without
443 attempting delta compression. Storing large files without
444 delta compression avoids excessive memory usage, at the
445 slight expense of increased disk usage.
447 Default is 512 MiB on all platforms. This should be reasonable
448 for most projects as source code and other text files can still
449 be delta compressed, but larger binary media files won't be.
451 Common unit suffixes of 'k', 'm', or 'g' are supported.
453 Currently only linkgit:git-fast-import[1] honors this setting.
456 In addition to '.gitignore' (per-directory) and
457 '.git/info/exclude', git looks into this file for patterns
458 of files which are not meant to be tracked. "{tilde}/" is expanded
459 to the value of `$HOME` and "{tilde}user/" to the specified user's
460 home directory. See linkgit:gitignore[5].
463 Some commands (e.g. svn and http interfaces) that interactively
464 ask for a password can be told to use an external program given
465 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
466 environment variable. If not set, fall back to the value of the
467 'SSH_ASKPASS' environment variable or, failing that, a simple password
468 prompt. The external program shall be given a suitable prompt as
469 command line argument and write the password on its STDOUT.
471 core.attributesfile::
472 In addition to '.gitattributes' (per-directory) and
473 '.git/info/attributes', git looks into this file for attributes
474 (see linkgit:gitattributes[5]). Path expansions are made the same
475 way as for `core.excludesfile`.
478 Commands such as `commit` and `tag` that lets you edit
479 messages by launching an editor uses the value of this
480 variable when it is set, and the environment variable
481 `GIT_EDITOR` is not set. See linkgit:git-var[1].
484 The command that git will use to paginate output. Can
485 be overridden with the `GIT_PAGER` environment
486 variable. Note that git sets the `LESS` environment
487 variable to `FRSX` if it is unset when it runs the
488 pager. One can change these settings by setting the
489 `LESS` variable to some other value. Alternately,
490 these settings can be overridden on a project or
491 global basis by setting the `core.pager` option.
492 Setting `core.pager` has no affect on the `LESS`
493 environment variable behaviour above, so if you want
494 to override git's default settings this way, you need
495 to be explicit. For example, to disable the S option
496 in a backward compatible manner, set `core.pager`
497 to `less -+$LESS -FRX`. This will be passed to the
498 shell by git, which will translate the final command to
499 `LESS=FRSX less -+FRSX -FRX`.
502 A comma separated list of common whitespace problems to
503 notice. 'git diff' will use `color.diff.whitespace` to
504 highlight them, and 'git apply --whitespace=error' will
505 consider them as errors. You can prefix `-` to disable
506 any of them (e.g. `-trailing-space`):
508 * `blank-at-eol` treats trailing whitespaces at the end of the line
509 as an error (enabled by default).
510 * `space-before-tab` treats a space character that appears immediately
511 before a tab character in the initial indent part of the line as an
512 error (enabled by default).
513 * `indent-with-non-tab` treats a line that is indented with 8 or more
514 space characters as an error (not enabled by default).
515 * `tab-in-indent` treats a tab character in the initial indent part of
516 the line as an error (not enabled by default).
517 * `blank-at-eof` treats blank lines added at the end of file as an error
518 (enabled by default).
519 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
521 * `cr-at-eol` treats a carriage-return at the end of line as
522 part of the line terminator, i.e. with it, `trailing-space`
523 does not trigger if the character before such a carriage-return
524 is not a whitespace (not enabled by default).
526 core.fsyncobjectfiles::
527 This boolean will enable 'fsync()' when writing object files.
529 This is a total waste of time and effort on a filesystem that orders
530 data writes properly, but can be useful for filesystems that do not use
531 journalling (traditional UNIX filesystems) or that only journal metadata
532 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
535 Enable parallel index preload for operations like 'git diff'
537 This can speed up operations like 'git diff' and 'git status' especially
538 on filesystems like NFS that have weak caching semantics and thus
539 relatively high IO latencies. With this set to 'true', git will do the
540 index comparison to the filesystem data in parallel, allowing
544 You can set this to 'link', in which case a hardlink followed by
545 a delete of the source are used to make sure that object creation
546 will not overwrite existing objects.
548 On some file system/operating system combinations, this is unreliable.
549 Set this config setting to 'rename' there; However, This will remove the
550 check that makes sure that existing object files will not get overwritten.
553 When showing commit messages, also show notes which are stored in
554 the given ref. The ref must be fully qualified. If the given
555 ref does not exist, it is not an error but means that no
556 notes should be printed.
558 This setting defaults to "refs/notes/commits", and it can be overridden by
559 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
561 core.sparseCheckout::
562 Enable "sparse checkout" feature. See section "Sparse checkout" in
563 linkgit:git-read-tree[1] for more information.
567 Tells 'git add' to continue adding files when some files cannot be
568 added due to indexing errors. Equivalent to the '--ignore-errors'
569 option of linkgit:git-add[1]. Older versions of git accept only
570 `add.ignore-errors`, which does not follow the usual naming
571 convention for configuration variables. Newer versions of git
572 honor `add.ignoreErrors` as well.
575 Command aliases for the linkgit:git[1] command wrapper - e.g.
576 after defining "alias.last = cat-file commit HEAD", the invocation
577 "git last" is equivalent to "git cat-file commit HEAD". To avoid
578 confusion and troubles with script usage, aliases that
579 hide existing git commands are ignored. Arguments are split by
580 spaces, the usual shell quoting and escaping is supported.
581 quote pair and a backslash can be used to quote them.
583 If the alias expansion is prefixed with an exclamation point,
584 it will be treated as a shell command. For example, defining
585 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
586 "git new" is equivalent to running the shell command
587 "gitk --all --not ORIG_HEAD". Note that shell commands will be
588 executed from the top-level directory of a repository, which may
589 not necessarily be the current directory.
592 If true, git-am will call git-mailsplit for patches in mbox format
593 with parameter '--keep-cr'. In this case git-mailsplit will
594 not remove `\r` from lines ending with `\r\n`. Can be overridden
595 by giving '--no-keep-cr' from the command line.
596 See linkgit:git-am[1], linkgit:git-mailsplit[1].
598 apply.ignorewhitespace::
599 When set to 'change', tells 'git apply' to ignore changes in
600 whitespace, in the same way as the '--ignore-space-change'
602 When set to one of: no, none, never, false tells 'git apply' to
603 respect all whitespace differences.
604 See linkgit:git-apply[1].
607 Tells 'git apply' how to handle whitespaces, in the same way
608 as the '--whitespace' option. See linkgit:git-apply[1].
610 branch.autosetupmerge::
611 Tells 'git branch' and 'git checkout' to set up new branches
612 so that linkgit:git-pull[1] will appropriately merge from the
613 starting point branch. Note that even if this option is not set,
614 this behavior can be chosen per-branch using the `--track`
615 and `--no-track` options. The valid settings are: `false` -- no
616 automatic setup is done; `true` -- automatic setup is done when the
617 starting point is a remote-tracking branch; `always` --
618 automatic setup is done when the starting point is either a
619 local branch or remote-tracking
620 branch. This option defaults to true.
622 branch.autosetuprebase::
623 When a new branch is created with 'git branch' or 'git checkout'
624 that tracks another branch, this variable tells git to set
625 up pull to rebase instead of merge (see "branch.<name>.rebase").
626 When `never`, rebase is never automatically set to true.
627 When `local`, rebase is set to true for tracked branches of
628 other local branches.
629 When `remote`, rebase is set to true for tracked branches of
630 remote-tracking branches.
631 When `always`, rebase will be set to true for all tracking
633 See "branch.autosetupmerge" for details on how to set up a
634 branch to track another branch.
635 This option defaults to never.
637 branch.<name>.remote::
638 When in branch <name>, it tells 'git fetch' and 'git push' which
639 remote to fetch from/push to. It defaults to `origin` if no remote is
640 configured. `origin` is also used if you are not on any branch.
642 branch.<name>.merge::
643 Defines, together with branch.<name>.remote, the upstream branch
644 for the given branch. It tells 'git fetch'/'git pull' which
645 branch to merge and can also affect 'git push' (see push.default).
646 When in branch <name>, it tells 'git fetch' the default
647 refspec to be marked for merging in FETCH_HEAD. The value is
648 handled like the remote part of a refspec, and must match a
649 ref which is fetched from the remote given by
650 "branch.<name>.remote".
651 The merge information is used by 'git pull' (which at first calls
652 'git fetch') to lookup the default branch for merging. Without
653 this option, 'git pull' defaults to merge the first refspec fetched.
654 Specify multiple values to get an octopus merge.
655 If you wish to setup 'git pull' so that it merges into <name> from
656 another branch in the local repository, you can point
657 branch.<name>.merge to the desired branch, and use the special setting
658 `.` (a period) for branch.<name>.remote.
660 branch.<name>.mergeoptions::
661 Sets default options for merging into branch <name>. The syntax and
662 supported options are the same as those of linkgit:git-merge[1], but
663 option values containing whitespace characters are currently not
666 branch.<name>.rebase::
667 When true, rebase the branch <name> on top of the fetched branch,
668 instead of merging the default branch from the default remote when
670 *NOTE*: this is a possibly dangerous operation; do *not* use
671 it unless you understand the implications (see linkgit:git-rebase[1]
675 Specify the command to invoke the specified browser. The
676 specified command is evaluated in shell with the URLs passed
677 as arguments. (See linkgit:git-web--browse[1].)
679 browser.<tool>.path::
680 Override the path for the given tool that may be used to
681 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
682 working repository in gitweb (see linkgit:git-instaweb[1]).
685 A boolean to make git-clean do nothing unless given -f
686 or -n. Defaults to true.
689 A boolean to enable/disable color in the output of
690 linkgit:git-branch[1]. May be set to `always`,
691 `false` (or `never`) or `auto` (or `true`), in which case colors are used
692 only when the output is to a terminal. Defaults to false.
694 color.branch.<slot>::
695 Use customized color for branch coloration. `<slot>` is one of
696 `current` (the current branch), `local` (a local branch),
697 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
700 The value for these configuration variables is a list of colors (at most
701 two) and attributes (at most one), separated by spaces. The colors
702 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
703 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
704 `blink` and `reverse`. The first color given is the foreground; the
705 second is the background. The position of the attribute, if any,
709 When set to `always`, always use colors in patch.
710 When false (or `never`), never. When set to `true` or `auto`, use
711 colors only when the output is to the terminal. Defaults to false.
714 Use customized color for diff colorization. `<slot>` specifies
715 which part of the patch to use the specified color, and is one
716 of `plain` (context text), `meta` (metainformation), `frag`
717 (hunk header), 'func' (function in hunk header), `old` (removed lines),
718 `new` (added lines), `commit` (commit headers), or `whitespace`
719 (highlighting whitespace errors). The values of these variables may be
720 specified as in color.branch.<slot>.
722 color.decorate.<slot>::
723 Use customized color for 'git log --decorate' output. `<slot>` is one
724 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
725 branches, remote-tracking branches, tags, stash and HEAD, respectively.
728 When set to `always`, always highlight matches. When `false` (or
729 `never`), never. When set to `true` or `auto`, use color only
730 when the output is written to the terminal. Defaults to `false`.
733 Use customized color for grep colorization. `<slot>` specifies which
734 part of the line to use the specified color, and is one of
738 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
740 filename prefix (when not using `-h`)
742 function name lines (when using `-p`)
744 line number prefix (when using `-n`)
748 non-matching text in selected lines
750 separators between fields on a line (`:`, `-`, and `=`)
751 and between hunks (`--`)
754 The values of these variables may be specified as in color.branch.<slot>.
757 When set to `always`, always use colors for interactive prompts
758 and displays (such as those used by "git-add --interactive").
759 When false (or `never`), never. When set to `true` or `auto`, use
760 colors only when the output is to the terminal. Defaults to false.
762 color.interactive.<slot>::
763 Use customized color for 'git add --interactive'
764 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
765 four distinct types of normal output from interactive
766 commands. The values of these variables may be specified as
767 in color.branch.<slot>.
770 A boolean to enable/disable colored output when the pager is in
771 use (default is true).
774 A boolean to enable/disable color in the output of
775 linkgit:git-show-branch[1]. May be set to `always`,
776 `false` (or `never`) or `auto` (or `true`), in which case colors are used
777 only when the output is to a terminal. Defaults to false.
780 A boolean to enable/disable color in the output of
781 linkgit:git-status[1]. May be set to `always`,
782 `false` (or `never`) or `auto` (or `true`), in which case colors are used
783 only when the output is to a terminal. Defaults to false.
785 color.status.<slot>::
786 Use customized color for status colorization. `<slot>` is
787 one of `header` (the header text of the status message),
788 `added` or `updated` (files which are added but not committed),
789 `changed` (files which are changed but not added in the index),
790 `untracked` (files which are not tracked by git), or
791 `nobranch` (the color the 'no branch' warning is shown in, defaulting
792 to red). The values of these variables may be specified as in
796 When set to `always`, always use colors in all git commands which
797 are capable of colored output. When false (or `never`), never. When
798 set to `true` or `auto`, use colors only when the output is to the
799 terminal. When more specific variables of color.* are set, they always
800 take precedence over this setting. Defaults to false.
803 A boolean to enable/disable inclusion of status information in the
804 commit message template when using an editor to prepare the commit
805 message. Defaults to true.
808 Specify a file to use as the template for new commit messages.
809 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
810 specified user's home directory.
812 diff.autorefreshindex::
813 When using 'git diff' to compare with work tree
814 files, do not consider stat-only change as changed.
815 Instead, silently run `git update-index --refresh` to
816 update the cached stat information for paths whose
817 contents in the work tree match the contents in the
818 index. This option defaults to true. Note that this
819 affects only 'git diff' Porcelain, and not lower level
820 'diff' commands such as 'git diff-files'.
823 If this config variable is set, diff generation is not
824 performed using the internal diff machinery, but using the
825 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
826 environment variable. The command is called with parameters
827 as described under "git Diffs" in linkgit:git[1]. Note: if
828 you want to use an external diff program only on a subset of
829 your files, you might want to use linkgit:gitattributes[5] instead.
831 diff.mnemonicprefix::
832 If set, 'git diff' uses a prefix pair that is different from the
833 standard "a/" and "b/" depending on what is being compared. When
834 this configuration is in effect, reverse diff output also swaps
835 the order of the prefixes:
837 compares the (i)ndex and the (w)ork tree;
839 compares a (c)ommit and the (w)ork tree;
840 `git diff --cached`;;
841 compares a (c)ommit and the (i)ndex;
842 `git diff HEAD:file1 file2`;;
843 compares an (o)bject and a (w)ork tree entity;
844 `git diff --no-index a b`;;
845 compares two non-git things (1) and (2).
848 If set, 'git diff' does not show any source or destination prefix.
851 The number of files to consider when performing the copy/rename
852 detection; equivalent to the 'git diff' option '-l'.
855 Tells git to detect renames. If set to any boolean value, it
856 will enable basic rename detection. If set to "copies" or
857 "copy", it will detect copies, as well.
859 diff.ignoreSubmodules::
860 Sets the default value of --ignore-submodules. Note that this
861 affects only 'git diff' Porcelain, and not lower level 'diff'
862 commands such as 'git diff-files'. 'git checkout' also honors
863 this setting when reporting uncommitted changes.
865 diff.suppressBlankEmpty::
866 A boolean to inhibit the standard behavior of printing a space
867 before each empty output line. Defaults to false.
870 Controls which diff tool is used. `diff.tool` overrides
871 `merge.tool` when used by linkgit:git-difftool[1] and has
872 the same valid values as `merge.tool` minus "tortoisemerge"
875 difftool.<tool>.path::
876 Override the path for the given tool. This is useful in case
877 your tool is not in the PATH.
879 difftool.<tool>.cmd::
880 Specify the command to invoke the specified diff tool.
881 The specified command is evaluated in shell with the following
882 variables available: 'LOCAL' is set to the name of the temporary
883 file containing the contents of the diff pre-image and 'REMOTE'
884 is set to the name of the temporary file containing the contents
885 of the diff post-image.
888 Prompt before each invocation of the diff tool.
891 A POSIX Extended Regular Expression used to determine what is a "word"
892 when performing word-by-word difference calculations. Character
893 sequences that match the regular expression are "words", all other
894 characters are *ignorable* whitespace.
896 fetch.recurseSubmodules::
897 A boolean value which changes the behavior for fetch and pull, the
898 default is to not recursively fetch populated sumodules unless
899 configured otherwise.
902 If the number of objects fetched over the git native
903 transfer is below this
904 limit, then the objects will be unpacked into loose object
905 files. However if the number of received objects equals or
906 exceeds this limit then the received pack will be stored as
907 a pack, after adding any missing delta bases. Storing the
908 pack from a push can make the push operation complete faster,
909 especially on slow filesystems. If not set, the value of
910 `transfer.unpackLimit` is used instead.
913 Enable multipart/mixed attachments as the default for
914 'format-patch'. The value can also be a double quoted string
915 which will enable attachments as the default and set the
916 value as the boundary. See the --attach option in
917 linkgit:git-format-patch[1].
920 A boolean which can enable or disable sequence numbers in patch
921 subjects. It defaults to "auto" which enables it only if there
922 is more than one patch. It can be enabled or disabled for all
923 messages by setting it to "true" or "false". See --numbered
924 option in linkgit:git-format-patch[1].
927 Additional email headers to include in a patch to be submitted
928 by mail. See linkgit:git-format-patch[1].
932 Additional recipients to include in a patch to be submitted
933 by mail. See the --to and --cc options in
934 linkgit:git-format-patch[1].
936 format.subjectprefix::
937 The default for format-patch is to output files with the '[PATCH]'
938 subject prefix. Use this variable to change that prefix.
941 The default for format-patch is to output a signature containing
942 the git version number. Use this variable to change that default.
943 Set this variable to the empty string ("") to suppress
944 signature generation.
947 The default for format-patch is to output files with the suffix
948 `.patch`. Use this variable to change that suffix (make sure to
949 include the dot if you want it).
952 The default pretty format for log/show/whatchanged command,
953 See linkgit:git-log[1], linkgit:git-show[1],
954 linkgit:git-whatchanged[1].
957 The default threading style for 'git format-patch'. Can be
958 a boolean value, or `shallow` or `deep`. `shallow` threading
959 makes every mail a reply to the head of the series,
960 where the head is chosen from the cover letter, the
961 `\--in-reply-to`, and the first patch mail, in this order.
962 `deep` threading makes every mail a reply to the previous one.
963 A true boolean value is the same as `shallow`, and a false
964 value disables threading.
967 A boolean value which lets you enable the `-s/--signoff` option of
968 format-patch by default. *Note:* Adding the Signed-off-by: line to a
969 patch should be a conscious act and means that you certify you have
970 the rights to submit this work under the same open source license.
971 Please see the 'SubmittingPatches' document for further discussion.
973 gc.aggressiveWindow::
974 The window size parameter used in the delta compression
975 algorithm used by 'git gc --aggressive'. This defaults
979 When there are approximately more than this many loose
980 objects in the repository, `git gc --auto` will pack them.
981 Some Porcelain commands use this command to perform a
982 light-weight garbage collection from time to time. The
983 default value is 6700. Setting this to 0 disables it.
986 When there are more than this many packs that are not
987 marked with `*.keep` file in the repository, `git gc
988 --auto` consolidates them into one larger pack. The
989 default value is 50. Setting this to 0 disables it.
992 Running `git pack-refs` in a repository renders it
993 unclonable by Git versions prior to 1.5.1.2 over dumb
994 transports such as HTTP. This variable determines whether
995 'git gc' runs `git pack-refs`. This can be set to `nobare`
996 to enable it within all non-bare repos or it can be set to a
997 boolean value. The default is `true`.
1000 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1001 Override the grace period with this config variable. The value
1002 "now" may be used to disable this grace period and always prune
1003 unreachable objects immediately.
1006 gc.<pattern>.reflogexpire::
1007 'git reflog expire' removes reflog entries older than
1008 this time; defaults to 90 days. With "<pattern>" (e.g.
1009 "refs/stash") in the middle the setting applies only to
1010 the refs that match the <pattern>.
1012 gc.reflogexpireunreachable::
1013 gc.<ref>.reflogexpireunreachable::
1014 'git reflog expire' removes reflog entries older than
1015 this time and are not reachable from the current tip;
1016 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1017 in the middle, the setting applies only to the refs that
1018 match the <pattern>.
1021 Records of conflicted merge you resolved earlier are
1022 kept for this many days when 'git rerere gc' is run.
1023 The default is 60 days. See linkgit:git-rerere[1].
1025 gc.rerereunresolved::
1026 Records of conflicted merge you have not resolved are
1027 kept for this many days when 'git rerere gc' is run.
1028 The default is 15 days. See linkgit:git-rerere[1].
1030 gitcvs.commitmsgannotation::
1031 Append this string to each commit message. Set to empty string
1032 to disable this feature. Defaults to "via git-CVS emulator".
1035 Whether the CVS server interface is enabled for this repository.
1036 See linkgit:git-cvsserver[1].
1039 Path to a log file where the CVS server interface well... logs
1040 various stuff. See linkgit:git-cvsserver[1].
1042 gitcvs.usecrlfattr::
1043 If true, the server will look up the end-of-line conversion
1044 attributes for files to determine the '-k' modes to use. If
1045 the attributes force git to treat a file as text,
1046 the '-k' mode will be left blank so CVS clients will
1047 treat it as text. If they suppress text conversion, the file
1048 will be set with '-kb' mode, which suppresses any newline munging
1049 the client might otherwise do. If the attributes do not allow
1050 the file type to be determined, then 'gitcvs.allbinary' is
1051 used. See linkgit:gitattributes[5].
1054 This is used if 'gitcvs.usecrlfattr' does not resolve
1055 the correct '-kb' mode to use. If true, all
1056 unresolved files are sent to the client in
1057 mode '-kb'. This causes the client to treat them
1058 as binary files, which suppresses any newline munging it
1059 otherwise might do. Alternatively, if it is set to "guess",
1060 then the contents of the file are examined to decide if
1061 it is binary, similar to 'core.autocrlf'.
1064 Database used by git-cvsserver to cache revision information
1065 derived from the git repository. The exact meaning depends on the
1066 used database driver, for SQLite (which is the default driver) this
1067 is a filename. Supports variable substitution (see
1068 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1069 Default: '%Ggitcvs.%m.sqlite'
1072 Used Perl DBI driver. You can specify any available driver
1073 for this here, but it might not work. git-cvsserver is tested
1074 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1075 reported *not* to work with 'DBD::mysql'. Experimental feature.
1076 May not contain double colons (`:`). Default: 'SQLite'.
1077 See linkgit:git-cvsserver[1].
1079 gitcvs.dbuser, gitcvs.dbpass::
1080 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1081 since SQLite has no concept of database users and/or passwords.
1082 'gitcvs.dbuser' supports variable substitution (see
1083 linkgit:git-cvsserver[1] for details).
1085 gitcvs.dbTableNamePrefix::
1086 Database table name prefix. Prepended to the names of any
1087 database tables used, allowing a single database to be used
1088 for several repositories. Supports variable substitution (see
1089 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1090 characters will be replaced with underscores.
1092 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1093 'gitcvs.allbinary' can also be specified as
1094 'gitcvs.<access_method>.<varname>' (where 'access_method'
1095 is one of "ext" and "pserver") to make them apply only for the given
1098 gui.commitmsgwidth::
1099 Defines how wide the commit message window is in the
1100 linkgit:git-gui[1]. "75" is the default.
1103 Specifies how many context lines should be used in calls to diff
1104 made by the linkgit:git-gui[1]. The default is "5".
1107 Specifies the default encoding to use for displaying of
1108 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1109 It can be overridden by setting the 'encoding' attribute
1110 for relevant files (see linkgit:gitattributes[5]).
1111 If this option is not set, the tools default to the
1114 gui.matchtrackingbranch::
1115 Determines if new branches created with linkgit:git-gui[1] should
1116 default to tracking remote branches with matching names or
1117 not. Default: "false".
1119 gui.newbranchtemplate::
1120 Is used as suggested name when creating new branches using the
1123 gui.pruneduringfetch::
1124 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1125 performing a fetch. The default value is "false".
1128 Determines if linkgit:git-gui[1] should trust the file modification
1129 timestamp or not. By default the timestamps are not trusted.
1131 gui.spellingdictionary::
1132 Specifies the dictionary used for spell checking commit messages in
1133 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1137 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1138 location detection. It makes blame significantly faster on huge
1139 repositories at the expense of less thorough copy detection.
1141 gui.copyblamethreshold::
1142 Specifies the threshold to use in 'git gui blame' original location
1143 detection, measured in alphanumeric characters. See the
1144 linkgit:git-blame[1] manual for more information on copy detection.
1146 gui.blamehistoryctx::
1147 Specifies the radius of history context in days to show in
1148 linkgit:gitk[1] for the selected commit, when the `Show History
1149 Context` menu item is invoked from 'git gui blame'. If this
1150 variable is set to zero, the whole history is shown.
1152 guitool.<name>.cmd::
1153 Specifies the shell command line to execute when the corresponding item
1154 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1155 mandatory for every tool. The command is executed from the root of
1156 the working directory, and in the environment it receives the name of
1157 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1158 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1159 the head is detached, 'CUR_BRANCH' is empty).
1161 guitool.<name>.needsfile::
1162 Run the tool only if a diff is selected in the GUI. It guarantees
1163 that 'FILENAME' is not empty.
1165 guitool.<name>.noconsole::
1166 Run the command silently, without creating a window to display its
1169 guitool.<name>.norescan::
1170 Don't rescan the working directory for changes after the tool
1173 guitool.<name>.confirm::
1174 Show a confirmation dialog before actually running the tool.
1176 guitool.<name>.argprompt::
1177 Request a string argument from the user, and pass it to the tool
1178 through the 'ARGS' environment variable. Since requesting an
1179 argument implies confirmation, the 'confirm' option has no effect
1180 if this is enabled. If the option is set to 'true', 'yes', or '1',
1181 the dialog uses a built-in generic prompt; otherwise the exact
1182 value of the variable is used.
1184 guitool.<name>.revprompt::
1185 Request a single valid revision from the user, and set the
1186 'REVISION' environment variable. In other aspects this option
1187 is similar to 'argprompt', and can be used together with it.
1189 guitool.<name>.revunmerged::
1190 Show only unmerged branches in the 'revprompt' subdialog.
1191 This is useful for tools similar to merge or rebase, but not
1192 for things like checkout or reset.
1194 guitool.<name>.title::
1195 Specifies the title to use for the prompt dialog. The default
1198 guitool.<name>.prompt::
1199 Specifies the general prompt string to display at the top of
1200 the dialog, before subsections for 'argprompt' and 'revprompt'.
1201 The default value includes the actual command.
1204 Specify the browser that will be used to display help in the
1205 'web' format. See linkgit:git-help[1].
1208 Override the default help format used by linkgit:git-help[1].
1209 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1210 the default. 'web' and 'html' are the same.
1213 Automatically correct and execute mistyped commands after
1214 waiting for the given number of deciseconds (0.1 sec). If more
1215 than one command can be deduced from the entered text, nothing
1216 will be executed. If the value of this option is negative,
1217 the corrected command will be executed immediately. If the
1218 value is 0 - the command will be just shown but not executed.
1219 This is the default.
1222 Override the HTTP proxy, normally configured using the 'http_proxy'
1223 environment variable (see linkgit:curl[1]). This can be overridden
1224 on a per-remote basis; see remote.<name>.proxy
1227 Whether to verify the SSL certificate when fetching or pushing
1228 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1232 File containing the SSL certificate when fetching or pushing
1233 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1237 File containing the SSL private key when fetching or pushing
1238 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1241 http.sslCertPasswordProtected::
1242 Enable git's password prompt for the SSL certificate. Otherwise
1243 OpenSSL will prompt the user, possibly many times, if the
1244 certificate or private key is encrypted. Can be overridden by the
1245 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1248 File containing the certificates to verify the peer with when
1249 fetching or pushing over HTTPS. Can be overridden by the
1250 'GIT_SSL_CAINFO' environment variable.
1253 Path containing files with the CA certificates to verify the peer
1254 with when fetching or pushing over HTTPS. Can be overridden
1255 by the 'GIT_SSL_CAPATH' environment variable.
1258 How many HTTP requests to launch in parallel. Can be overridden
1259 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1262 The number of curl sessions (counted across slots) to be kept across
1263 requests. They will not be ended with curl_easy_cleanup() until
1264 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1265 value will be capped at 1. Defaults to 1.
1268 Maximum size in bytes of the buffer used by smart HTTP
1269 transports when POSTing data to the remote system.
1270 For requests larger than this buffer size, HTTP/1.1 and
1271 Transfer-Encoding: chunked is used to avoid creating a
1272 massive pack file locally. Default is 1 MiB, which is
1273 sufficient for most requests.
1275 http.lowSpeedLimit, http.lowSpeedTime::
1276 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1277 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1278 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1279 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1282 A boolean which disables using of EPSV ftp command by curl.
1283 This can helpful with some "poor" ftp servers which don't
1284 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1285 environment variable. Default is false (curl will use EPSV).
1288 The HTTP USER_AGENT string presented to an HTTP server. The default
1289 value represents the version of the client git such as git/1.7.1.
1290 This option allows you to override this value to a more common value
1291 such as Mozilla/4.0. This may be necessary, for instance, if
1292 connecting through a firewall that restricts HTTP connections to a set
1293 of common USER_AGENT strings (but not including those like git/1.7.1).
1294 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1296 i18n.commitEncoding::
1297 Character encoding the commit messages are stored in; git itself
1298 does not care per se, but this information is necessary e.g. when
1299 importing commits from emails or in the gitk graphical history
1300 browser (and possibly at other places in the future or in other
1301 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1303 i18n.logOutputEncoding::
1304 Character encoding the commit messages are converted to when
1305 running 'git log' and friends.
1308 The configuration variables in the 'imap' section are described
1309 in linkgit:git-imap-send[1].
1312 Specify the directory from which templates will be copied.
1313 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1316 Specify the program that will be used to browse your working
1317 repository in gitweb. See linkgit:git-instaweb[1].
1320 The HTTP daemon command-line to start gitweb on your working
1321 repository. See linkgit:git-instaweb[1].
1324 If true the web server started by linkgit:git-instaweb[1] will
1325 be bound to the local IP (127.0.0.1).
1327 instaweb.modulepath::
1328 The default module path for linkgit:git-instaweb[1] to use
1329 instead of /usr/lib/apache2/modules. Only used if httpd
1333 The port number to bind the gitweb httpd to. See
1334 linkgit:git-instaweb[1].
1336 interactive.singlekey::
1337 In interactive commands, allow the user to provide one-letter
1338 input with a single key (i.e., without hitting enter).
1339 Currently this is used only by the `\--patch` mode of
1340 linkgit:git-add[1]. Note that this setting is silently
1341 ignored if portable keystroke input is not available.
1344 Set the default date-time mode for the 'log' command.
1345 Setting a value for log.date is similar to using 'git log''s
1346 `\--date` option. Possible values are `relative`, `local`,
1347 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1351 Print out the ref names of any commits that are shown by the log
1352 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1353 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1354 specified, the full ref name (including prefix) will be printed.
1355 This is the same as the log commands '--decorate' option.
1358 If true, the initial commit will be shown as a big creation event.
1359 This is equivalent to a diff against an empty tree.
1360 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1361 normally hide the root commit will now show it. True by default.
1364 The location of an augmenting mailmap file. The default
1365 mailmap, located in the root of the repository, is loaded
1366 first, then the mailmap file pointed to by this variable.
1367 The location of the mailmap file may be in a repository
1368 subdirectory, or somewhere outside of the repository itself.
1369 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1372 Specify the programs that may be used to display help in the
1373 'man' format. See linkgit:git-help[1].
1376 Specify the command to invoke the specified man viewer. The
1377 specified command is evaluated in shell with the man page
1378 passed as argument. (See linkgit:git-help[1].)
1381 Override the path for the given tool that may be used to
1382 display help in the 'man' format. See linkgit:git-help[1].
1384 include::merge-config.txt[]
1386 mergetool.<tool>.path::
1387 Override the path for the given tool. This is useful in case
1388 your tool is not in the PATH.
1390 mergetool.<tool>.cmd::
1391 Specify the command to invoke the specified merge tool. The
1392 specified command is evaluated in shell with the following
1393 variables available: 'BASE' is the name of a temporary file
1394 containing the common base of the files to be merged, if available;
1395 'LOCAL' is the name of a temporary file containing the contents of
1396 the file on the current branch; 'REMOTE' is the name of a temporary
1397 file containing the contents of the file from the branch being
1398 merged; 'MERGED' contains the name of the file to which the merge
1399 tool should write the results of a successful merge.
1401 mergetool.<tool>.trustExitCode::
1402 For a custom merge command, specify whether the exit code of
1403 the merge command can be used to determine whether the merge was
1404 successful. If this is not set to true then the merge target file
1405 timestamp is checked and the merge assumed to have been successful
1406 if the file has been updated, otherwise the user is prompted to
1407 indicate the success of the merge.
1409 mergetool.keepBackup::
1410 After performing a merge, the original file with conflict markers
1411 can be saved as a file with a `.orig` extension. If this variable
1412 is set to `false` then this file is not preserved. Defaults to
1413 `true` (i.e. keep the backup files).
1415 mergetool.keepTemporaries::
1416 When invoking a custom merge tool, git uses a set of temporary
1417 files to pass to the tool. If the tool returns an error and this
1418 variable is set to `true`, then these temporary files will be
1419 preserved, otherwise they will be removed after the tool has
1420 exited. Defaults to `false`.
1423 Prompt before each invocation of the merge resolution program.
1426 The (fully qualified) refname from which to show notes when
1427 showing commit messages. The value of this variable can be set
1428 to a glob, in which case notes from all matching refs will be
1429 shown. You may also specify this configuration variable
1430 several times. A warning will be issued for refs that do not
1431 exist, but a glob that does not match any refs is silently
1434 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1435 environment variable, which must be a colon separated list of refs or
1438 The effective value of "core.notesRef" (possibly overridden by
1439 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1442 notes.rewrite.<command>::
1443 When rewriting commits with <command> (currently `amend` or
1444 `rebase`) and this variable is set to `true`, git
1445 automatically copies your notes from the original to the
1446 rewritten commit. Defaults to `true`, but see
1447 "notes.rewriteRef" below.
1450 When copying notes during a rewrite (see the
1451 "notes.rewrite.<command>" option), determines what to do if
1452 the target commit already has a note. Must be one of
1453 `overwrite`, `concatenate`, or `ignore`. Defaults to
1456 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1457 environment variable.
1460 When copying notes during a rewrite, specifies the (fully
1461 qualified) ref whose notes should be copied. The ref may be a
1462 glob, in which case notes in all matching refs will be copied.
1463 You may also specify this configuration several times.
1465 Does not have a default value; you must configure this variable to
1466 enable note rewriting.
1468 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1469 environment variable, which must be a colon separated list of refs or
1473 The size of the window used by linkgit:git-pack-objects[1] when no
1474 window size is given on the command line. Defaults to 10.
1477 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1478 maximum depth is given on the command line. Defaults to 50.
1481 The window memory size limit used by linkgit:git-pack-objects[1]
1482 when no limit is given on the command line. The value can be
1483 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1487 An integer -1..9, indicating the compression level for objects
1488 in a pack file. -1 is the zlib default. 0 means no
1489 compression, and 1..9 are various speed/size tradeoffs, 9 being
1490 slowest. If not set, defaults to core.compression. If that is
1491 not set, defaults to -1, the zlib default, which is "a default
1492 compromise between speed and compression (currently equivalent
1495 Note that changing the compression level will not automatically recompress
1496 all existing objects. You can force recompression by passing the -F option
1497 to linkgit:git-repack[1].
1499 pack.deltaCacheSize::
1500 The maximum memory in bytes used for caching deltas in
1501 linkgit:git-pack-objects[1] before writing them out to a pack.
1502 This cache is used to speed up the writing object phase by not
1503 having to recompute the final delta result once the best match
1504 for all objects is found. Repacking large repositories on machines
1505 which are tight with memory might be badly impacted by this though,
1506 especially if this cache pushes the system into swapping.
1507 A value of 0 means no limit. The smallest size of 1 byte may be
1508 used to virtually disable this cache. Defaults to 256 MiB.
1510 pack.deltaCacheLimit::
1511 The maximum size of a delta, that is cached in
1512 linkgit:git-pack-objects[1]. This cache is used to speed up the
1513 writing object phase by not having to recompute the final delta
1514 result once the best match for all objects is found. Defaults to 1000.
1517 Specifies the number of threads to spawn when searching for best
1518 delta matches. This requires that linkgit:git-pack-objects[1]
1519 be compiled with pthreads otherwise this option is ignored with a
1520 warning. This is meant to reduce packing time on multiprocessor
1521 machines. The required amount of memory for the delta search window
1522 is however multiplied by the number of threads.
1523 Specifying 0 will cause git to auto-detect the number of CPU's
1524 and set the number of threads accordingly.
1527 Specify the default pack index version. Valid values are 1 for
1528 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1529 the new pack index with capabilities for packs larger than 4 GB
1530 as well as proper protection against the repacking of corrupted
1531 packs. Version 2 is the default. Note that version 2 is enforced
1532 and this config option ignored whenever the corresponding pack is
1535 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1536 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1537 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1538 other side may give you a repository that cannot be accessed with your
1539 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1540 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1541 the `{asterisk}.idx` file.
1543 pack.packSizeLimit::
1544 The maximum size of a pack. This setting only affects
1545 packing to a file when repacking, i.e. the git:// protocol
1546 is unaffected. It can be overridden by the `\--max-pack-size`
1547 option of linkgit:git-repack[1]. The minimum size allowed is
1548 limited to 1 MiB. The default is unlimited.
1549 Common unit suffixes of 'k', 'm', or 'g' are
1553 If the value is boolean, turns on or off pagination of the
1554 output of a particular git subcommand when writing to a tty.
1555 Otherwise, turns on pagination for the subcommand using the
1556 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1557 or `\--no-pager` is specified on the command line, it takes
1558 precedence over this option. To disable pagination for all
1559 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1562 Alias for a --pretty= format string, as specified in
1563 linkgit:git-log[1]. Any aliases defined here can be used just
1564 as the built-in pretty formats could. For example,
1565 running `git config pretty.changelog "format:{asterisk} %H %s"`
1566 would cause the invocation `git log --pretty=changelog`
1567 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1568 Note that an alias with the same name as a built-in format
1569 will be silently ignored.
1572 The default merge strategy to use when pulling multiple branches
1576 The default merge strategy to use when pulling a single branch.
1579 Defines the action git push should take if no refspec is given
1580 on the command line, no refspec is configured in the remote, and
1581 no refspec is implied by any of the options given on the command
1582 line. Possible values are:
1584 * `nothing` - do not push anything.
1585 * `matching` - push all matching branches.
1586 All branches having the same name in both ends are considered to be
1587 matching. This is the default.
1588 * `tracking` - push the current branch to its upstream branch.
1589 * `current` - push the current branch to a branch of the same name.
1592 Whether to show a diffstat of what changed upstream since the last
1593 rebase. False by default.
1596 If set to true enable '--autosquash' option by default.
1599 By default, git-receive-pack will run "git-gc --auto" after
1600 receiving data from git-push and updating refs. You can stop
1601 it by setting this variable to false.
1603 receive.fsckObjects::
1604 If it is set to true, git-receive-pack will check all received
1605 objects. It will abort in the case of a malformed object or a
1606 broken link. The result of an abort are only dangling objects.
1609 receive.unpackLimit::
1610 If the number of objects received in a push is below this
1611 limit then the objects will be unpacked into loose object
1612 files. However if the number of received objects equals or
1613 exceeds this limit then the received pack will be stored as
1614 a pack, after adding any missing delta bases. Storing the
1615 pack from a push can make the push operation complete faster,
1616 especially on slow filesystems. If not set, the value of
1617 `transfer.unpackLimit` is used instead.
1619 receive.denyDeletes::
1620 If set to true, git-receive-pack will deny a ref update that deletes
1621 the ref. Use this to prevent such a ref deletion via a push.
1623 receive.denyDeleteCurrent::
1624 If set to true, git-receive-pack will deny a ref update that
1625 deletes the currently checked out branch of a non-bare repository.
1627 receive.denyCurrentBranch::
1628 If set to true or "refuse", git-receive-pack will deny a ref update
1629 to the currently checked out branch of a non-bare repository.
1630 Such a push is potentially dangerous because it brings the HEAD
1631 out of sync with the index and working tree. If set to "warn",
1632 print a warning of such a push to stderr, but allow the push to
1633 proceed. If set to false or "ignore", allow such pushes with no
1634 message. Defaults to "refuse".
1636 receive.denyNonFastForwards::
1637 If set to true, git-receive-pack will deny a ref update which is
1638 not a fast-forward. Use this to prevent such an update via a push,
1639 even if that push is forced. This configuration variable is
1640 set when initializing a shared repository.
1642 receive.updateserverinfo::
1643 If set to true, git-receive-pack will run git-update-server-info
1644 after receiving data from git-push and updating refs.
1647 The URL of a remote repository. See linkgit:git-fetch[1] or
1648 linkgit:git-push[1].
1650 remote.<name>.pushurl::
1651 The push URL of a remote repository. See linkgit:git-push[1].
1653 remote.<name>.proxy::
1654 For remotes that require curl (http, https and ftp), the URL to
1655 the proxy to use for that remote. Set to the empty string to
1656 disable proxying for that remote.
1658 remote.<name>.fetch::
1659 The default set of "refspec" for linkgit:git-fetch[1]. See
1660 linkgit:git-fetch[1].
1662 remote.<name>.push::
1663 The default set of "refspec" for linkgit:git-push[1]. See
1664 linkgit:git-push[1].
1666 remote.<name>.mirror::
1667 If true, pushing to this remote will automatically behave
1668 as if the `\--mirror` option was given on the command line.
1670 remote.<name>.skipDefaultUpdate::
1671 If true, this remote will be skipped by default when updating
1672 using linkgit:git-fetch[1] or the `update` subcommand of
1673 linkgit:git-remote[1].
1675 remote.<name>.skipFetchAll::
1676 If true, this remote will be skipped by default when updating
1677 using linkgit:git-fetch[1] or the `update` subcommand of
1678 linkgit:git-remote[1].
1680 remote.<name>.receivepack::
1681 The default program to execute on the remote side when pushing. See
1682 option \--receive-pack of linkgit:git-push[1].
1684 remote.<name>.uploadpack::
1685 The default program to execute on the remote side when fetching. See
1686 option \--upload-pack of linkgit:git-fetch-pack[1].
1688 remote.<name>.tagopt::
1689 Setting this value to \--no-tags disables automatic tag following when
1690 fetching from remote <name>. Setting it to \--tags will fetch every
1691 tag from remote <name>, even if they are not reachable from remote
1692 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1693 override this setting. See options \--tags and \--no-tags of
1694 linkgit:git-fetch[1].
1697 Setting this to a value <vcs> will cause git to interact with
1698 the remote with the git-remote-<vcs> helper.
1701 The list of remotes which are fetched by "git remote update
1702 <group>". See linkgit:git-remote[1].
1704 repack.usedeltabaseoffset::
1705 By default, linkgit:git-repack[1] creates packs that use
1706 delta-base offset. If you need to share your repository with
1707 git older than version 1.4.4, either directly or via a dumb
1708 protocol such as http, then you need to set this option to
1709 "false" and repack. Access from old git versions over the
1710 native protocol are unaffected by this option.
1713 When set to true, `git-rerere` updates the index with the
1714 resulting contents after it cleanly resolves conflicts using
1715 previously recorded resolution. Defaults to false.
1718 Activate recording of resolved conflicts, so that identical
1719 conflict hunks can be resolved automatically, should they
1720 be encountered again. linkgit:git-rerere[1] command is by
1721 default enabled if you create `rr-cache` directory under
1722 `$GIT_DIR`, but can be disabled by setting this option to false.
1724 sendemail.identity::
1725 A configuration identity. When given, causes values in the
1726 'sendemail.<identity>' subsection to take precedence over
1727 values in the 'sendemail' section. The default identity is
1728 the value of 'sendemail.identity'.
1730 sendemail.smtpencryption::
1731 See linkgit:git-send-email[1] for description. Note that this
1732 setting is not subject to the 'identity' mechanism.
1735 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1737 sendemail.<identity>.*::
1738 Identity-specific versions of the 'sendemail.*' parameters
1739 found below, taking precedence over those when the this
1740 identity is selected, through command-line or
1741 'sendemail.identity'.
1743 sendemail.aliasesfile::
1744 sendemail.aliasfiletype::
1748 sendemail.chainreplyto::
1750 sendemail.envelopesender::
1752 sendemail.multiedit::
1753 sendemail.signedoffbycc::
1754 sendemail.smtppass::
1755 sendemail.suppresscc::
1756 sendemail.suppressfrom::
1758 sendemail.smtpdomain::
1759 sendemail.smtpserver::
1760 sendemail.smtpserverport::
1761 sendemail.smtpserveroption::
1762 sendemail.smtpuser::
1764 sendemail.validate::
1765 See linkgit:git-send-email[1] for description.
1767 sendemail.signedoffcc::
1768 Deprecated alias for 'sendemail.signedoffbycc'.
1770 showbranch.default::
1771 The default set of branches for linkgit:git-show-branch[1].
1772 See linkgit:git-show-branch[1].
1774 status.relativePaths::
1775 By default, linkgit:git-status[1] shows paths relative to the
1776 current directory. Setting this variable to `false` shows paths
1777 relative to the repository root (this was the default for git
1780 status.showUntrackedFiles::
1781 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1782 files which are not currently tracked by Git. Directories which
1783 contain only untracked files, are shown with the directory name
1784 only. Showing untracked files means that Git needs to lstat() all
1785 all the files in the whole repository, which might be slow on some
1786 systems. So, this variable controls how the commands displays
1787 the untracked files. Possible values are:
1790 * `no` - Show no untracked files.
1791 * `normal` - Show untracked files and directories.
1792 * `all` - Show also individual files in untracked directories.
1795 If this variable is not specified, it defaults to 'normal'.
1796 This variable can be overridden with the -u|--untracked-files option
1797 of linkgit:git-status[1] and linkgit:git-commit[1].
1799 status.submodulesummary::
1801 If this is set to a non zero number or true (identical to -1 or an
1802 unlimited number), the submodule summary will be enabled and a
1803 summary of commits for modified submodules will be shown (see
1804 --summary-limit option of linkgit:git-submodule[1]).
1806 submodule.<name>.path::
1807 submodule.<name>.url::
1808 submodule.<name>.update::
1809 The path within this project, URL, and the updating strategy
1810 for a submodule. These variables are initially populated
1811 by 'git submodule init'; edit them to override the
1812 URL and other values found in the `.gitmodules` file. See
1813 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1815 submodule.<name>.fetchRecurseSubmodules::
1816 This option can be used to enable/disable recursive fetching of this
1817 submodule. It can be overriden by using the --[no-]recurse-submodules
1818 command line option to "git fetch" and "git pull".
1819 This setting will override that from in the linkgit:gitmodules[5]
1822 submodule.<name>.ignore::
1823 Defines under what circumstances "git status" and the diff family show
1824 a submodule as modified. When set to "all", it will never be considered
1825 modified, "dirty" will ignore all changes to the submodules work tree and
1826 takes only differences between the HEAD of the submodule and the commit
1827 recorded in the superproject into account. "untracked" will additionally
1828 let submodules with modified tracked files in their work tree show up.
1829 Using "none" (the default when this option is not set) also shows
1830 submodules that have untracked files in their work tree as changed.
1831 This setting overrides any setting made in .gitmodules for this submodule,
1832 both settings can be overridden on the command line by using the
1833 "--ignore-submodules" option.
1836 This variable can be used to restrict the permission bits of
1837 tar archive entries. The default is 0002, which turns off the
1838 world write bit. The special value "user" indicates that the
1839 archiving user's umask will be used instead. See umask(2) and
1840 linkgit:git-archive[1].
1842 transfer.unpackLimit::
1843 When `fetch.unpackLimit` or `receive.unpackLimit` are
1844 not set, the value of this variable is used instead.
1845 The default value is 100.
1847 url.<base>.insteadOf::
1848 Any URL that starts with this value will be rewritten to
1849 start, instead, with <base>. In cases where some site serves a
1850 large number of repositories, and serves them with multiple
1851 access methods, and some users need to use different access
1852 methods, this feature allows people to specify any of the
1853 equivalent URLs and have git automatically rewrite the URL to
1854 the best alternative for the particular user, even for a
1855 never-before-seen repository on the site. When more than one
1856 insteadOf strings match a given URL, the longest match is used.
1858 url.<base>.pushInsteadOf::
1859 Any URL that starts with this value will not be pushed to;
1860 instead, it will be rewritten to start with <base>, and the
1861 resulting URL will be pushed to. In cases where some site serves
1862 a large number of repositories, and serves them with multiple
1863 access methods, some of which do not allow push, this feature
1864 allows people to specify a pull-only URL and have git
1865 automatically use an appropriate URL to push, even for a
1866 never-before-seen repository on the site. When more than one
1867 pushInsteadOf strings match a given URL, the longest match is
1868 used. If a remote has an explicit pushurl, git will ignore this
1869 setting for that remote.
1872 Your email address to be recorded in any newly created commits.
1873 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1874 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1877 Your full name to be recorded in any newly created commits.
1878 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1879 environment variables. See linkgit:git-commit-tree[1].
1882 If linkgit:git-tag[1] is not selecting the key you want it to
1883 automatically when creating a signed tag, you can override the
1884 default selection with this variable. This option is passed
1885 unchanged to gpg's --local-user parameter, so you may specify a key
1886 using any method that gpg supports.
1889 Specify a web browser that may be used by some commands.
1890 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]