4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a deprecated `[section.subsection]` syntax. With this
49 syntax, the subsection name is converted to lower-case and is also
50 compared case sensitively. These subsection names follow the same
51 restrictions as section names.
53 All the other lines (and the remainder of the line after the section
54 header) are recognized as setting variables, in the form
55 'name = value'. If there is no equal sign on the line, the entire line
56 is taken as 'name' and the variable is recognized as boolean "true".
57 The variable names are case-insensitive and only alphanumeric
58 characters and `-` are allowed. There can be more than one value
59 for a given variable; we say then that variable is multivalued.
61 Leading and trailing whitespace in a variable value is discarded.
62 Internal whitespace within a variable value is retained verbatim.
64 The values following the equals sign in variable assign are all either
65 a string, an integer, or a boolean. Boolean values may be given as yes/no,
66 1/0, true/false or on/off. Case is not significant in boolean values, when
67 converting value to the canonical form using '--bool' type specifier;
68 'git config' will ensure that the output is "true" or "false".
70 String values may be entirely or partially enclosed in double quotes.
71 You need to enclose variable values in double quotes if you want to
72 preserve leading or trailing whitespace, or if the variable value contains
73 comment characters (i.e. it contains '#' or ';').
74 Double quote `"` and backslash `\` characters in variable values must
75 be escaped: use `\"` for `"` and `\\` for `\`.
77 The following escape sequences (beside `\"` and `\\`) are recognized:
78 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
79 and `\b` for backspace (BS). No other char escape sequence, nor octal
80 char sequences are valid.
82 Variable values ending in a `\` are continued on the next line in the
83 customary UNIX fashion.
85 Some variables may require a special value format.
92 ; Don't trust file modes
97 external = /usr/local/bin/diff-wrapper
102 merge = refs/heads/devel
106 gitProxy="ssh" for "kernel.org"
107 gitProxy=default-proxy ; for the rest
112 Note that this list is non-comprehensive and not necessarily complete.
113 For command-specific variables, you will find a more detailed description
114 in the appropriate manual page. You will find a description of non-core
115 porcelain configuration variables in the respective porcelain documentation.
118 When set to 'true', display the given optional help message.
119 When set to 'false', do not display. The configuration variables
124 Advice shown when linkgit:git-push[1] refuses
125 non-fast-forward refs. Default: true.
127 Directions on how to stage/unstage/add shown in the
128 output of linkgit:git-status[1] and the template shown
129 when writing commit messages. Default: true.
131 Advice shown when linkgit:git-merge[1] refuses to
132 merge to avoid overwriting local changes.
135 Advices shown by various commands when conflicts
136 prevent the operation from being performed.
139 Advice on how to set your identity configuration when
140 your information is guessed from the system username and
141 domain name. Default: true.
144 Advice shown when you used linkgit::git-checkout[1] to
145 move to the detach HEAD state, to instruct how to create
146 a local branch after the fact. Default: true.
150 If false, the executable bit differences between the index and
151 the working tree are ignored; useful on broken filesystems like FAT.
152 See linkgit:git-update-index[1].
154 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
155 will probe and set core.fileMode false if appropriate when the
156 repository is created.
159 (Windows-only) If true (which is the default), mark newly-created
160 directories and files whose name starts with a dot as hidden.
161 If 'dotGitOnly', only the .git/ directory is hidden, but no other
162 files starting with a dot.
164 core.ignoreCygwinFSTricks::
165 This option is only used by Cygwin implementation of Git. If false,
166 the Cygwin stat() and lstat() functions are used. This may be useful
167 if your repository consists of a few separate directories joined in
168 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
169 whenever it is possible and falls back to Cygwin functions only to
170 handle symbol links. The native mode is more than twice faster than
171 normal Cygwin l/stat() functions. True by default, unless core.filemode
172 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
173 POSIX emulation is required to support core.filemode.
176 If true, this option enables various workarounds to enable
177 git to work better on filesystems that are not case sensitive,
178 like FAT. For example, if a directory listing finds
179 "makefile" when git expects "Makefile", git will assume
180 it is really the same file, and continue to remember it as
183 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
184 will probe and set core.ignorecase true if appropriate when the repository
188 If false, the ctime differences between the index and the
189 working tree are ignored; useful when the inode change time
190 is regularly modified by something outside Git (file system
191 crawlers and some backup systems).
192 See linkgit:git-update-index[1]. True by default.
195 The commands that output paths (e.g. 'ls-files',
196 'diff'), when not given the `-z` option, will quote
197 "unusual" characters in the pathname by enclosing the
198 pathname in a double-quote pair and with backslashes the
199 same way strings in C source code are quoted. If this
200 variable is set to false, the bytes higher than 0x80 are
201 not quoted but output as verbatim. Note that double
202 quote, backslash and control characters are always
203 quoted without `-z` regardless of the setting of this
207 Sets the line ending type to use in the working directory for
208 files that have the `text` property set. Alternatives are
209 'lf', 'crlf' and 'native', which uses the platform's native
210 line ending. The default value is `native`. See
211 linkgit:gitattributes[5] for more information on end-of-line
215 If true, makes git check if converting `CRLF` is reversible when
216 end-of-line conversion is active. Git will verify if a command
217 modifies a file in the work tree either directly or indirectly.
218 For example, committing a file followed by checking out the
219 same file should yield the original file in the work tree. If
220 this is not the case for the current setting of
221 `core.autocrlf`, git will reject the file. The variable can
222 be set to "warn", in which case git will only warn about an
223 irreversible conversion but continue the operation.
225 CRLF conversion bears a slight chance of corrupting data.
226 When it is enabled, git will convert CRLF to LF during commit and LF to
227 CRLF during checkout. A file that contains a mixture of LF and
228 CRLF before the commit cannot be recreated by git. For text
229 files this is the right thing to do: it corrects line endings
230 such that we have only LF line endings in the repository.
231 But for binary files that are accidentally classified as text the
232 conversion can corrupt data.
234 If you recognize such corruption early you can easily fix it by
235 setting the conversion type explicitly in .gitattributes. Right
236 after committing you still have the original file in your work
237 tree and this file is not yet corrupted. You can explicitly tell
238 git that this file is binary and git will handle the file
241 Unfortunately, the desired effect of cleaning up text files with
242 mixed line endings and the undesired effect of corrupting binary
243 files cannot be distinguished. In both cases CRLFs are removed
244 in an irreversible way. For text files this is the right thing
245 to do because CRLFs are line endings, while for binary files
246 converting CRLFs corrupts data.
248 Note, this safety check does not mean that a checkout will generate a
249 file identical to the original file for a different setting of
250 `core.eol` and `core.autocrlf`, but only for the current one. For
251 example, a text file with `LF` would be accepted with `core.eol=lf`
252 and could later be checked out with `core.eol=crlf`, in which case the
253 resulting file would contain `CRLF`, although the original file
254 contained `LF`. However, in both work trees the line endings would be
255 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
256 file with mixed line endings would be reported by the `core.safecrlf`
260 Setting this variable to "true" is almost the same as setting
261 the `text` attribute to "auto" on all files except that text
262 files are not guaranteed to be normalized: files that contain
263 `CRLF` in the repository will not be touched. Use this
264 setting if you want to have `CRLF` line endings in your
265 working directory even though the repository does not have
266 normalized line endings. This variable can be set to 'input',
267 in which case no output conversion is performed.
270 If false, symbolic links are checked out as small plain files that
271 contain the link text. linkgit:git-update-index[1] and
272 linkgit:git-add[1] will not change the recorded type to regular
273 file. Useful on filesystems like FAT that do not support
276 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
277 will probe and set core.symlinks false if appropriate when the repository
281 A "proxy command" to execute (as 'command host port') instead
282 of establishing direct connection to the remote server when
283 using the git protocol for fetching. If the variable value is
284 in the "COMMAND for DOMAIN" format, the command is applied only
285 on hostnames ending with the specified domain string. This variable
286 may be set multiple times and is matched in the given order;
287 the first match wins.
289 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
290 (which always applies universally, without the special "for"
293 The special string `none` can be used as the proxy command to
294 specify that no proxy be used for a given domain pattern.
295 This is useful for excluding servers inside a firewall from
296 proxy use, while defaulting to a common proxy for external domains.
299 If true, commands which modify both the working tree and the index
300 will mark the updated paths with the "assume unchanged" bit in the
301 index. These marked files are then assumed to stay unchanged in the
302 working tree, until you mark them otherwise manually - Git will not
303 detect the file changes by lstat() calls. This is useful on systems
304 where those are very slow, such as Microsoft Windows.
305 See linkgit:git-update-index[1].
308 core.preferSymlinkRefs::
309 Instead of the default "symref" format for HEAD
310 and other symbolic reference files, use symbolic links.
311 This is sometimes needed to work with old scripts that
312 expect HEAD to be a symbolic link.
315 If true this repository is assumed to be 'bare' and has no
316 working directory associated with it. If this is the case a
317 number of commands that require a working directory will be
318 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
320 This setting is automatically guessed by linkgit:git-clone[1] or
321 linkgit:git-init[1] when the repository was created. By default a
322 repository that ends in "/.git" is assumed to be not bare (bare =
323 false), while all other repositories are assumed to be bare (bare
327 Set the path to the root of the working tree.
328 This can be overridden by the GIT_WORK_TREE environment
329 variable and the '--work-tree' command line option.
330 The value can be an absolute path or relative to the path to
331 the .git directory, which is either specified by --git-dir
332 or GIT_DIR, or automatically discovered.
333 If --git-dir or GIT_DIR is specified but none of
334 --work-tree, GIT_WORK_TREE and core.worktree is specified,
335 the current working directory is regarded as the top level
336 of your working tree.
338 Note that this variable is honored even when set in a configuration
339 file in a ".git" subdirectory of a directory and its value differs
340 from the latter directory (e.g. "/path/to/.git/config" has
341 core.worktree set to "/different/path"), which is most likely a
342 misconfiguration. Running git commands in the "/path/to" directory will
343 still use "/different/path" as the root of the work tree and can cause
344 confusion unless you know what you are doing (e.g. you are creating a
345 read-only snapshot of the same index to a location different from the
346 repository's usual working tree).
348 core.logAllRefUpdates::
349 Enable the reflog. Updates to a ref <ref> is logged to the file
350 "$GIT_DIR/logs/<ref>", by appending the new and old
351 SHA1, the date/time and the reason of the update, but
352 only when the file exists. If this configuration
353 variable is set to true, missing "$GIT_DIR/logs/<ref>"
354 file is automatically created for branch heads (i.e. under
355 refs/heads/), remote refs (i.e. under refs/remotes/),
356 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
358 This information can be used to determine what commit
359 was the tip of a branch "2 days ago".
361 This value is true by default in a repository that has
362 a working directory associated with it, and false by
363 default in a bare repository.
365 core.repositoryFormatVersion::
366 Internal variable identifying the repository format and layout
369 core.sharedRepository::
370 When 'group' (or 'true'), the repository is made shareable between
371 several users in a group (making sure all the files and objects are
372 group-writable). When 'all' (or 'world' or 'everybody'), the
373 repository will be readable by all users, additionally to being
374 group-shareable. When 'umask' (or 'false'), git will use permissions
375 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
376 files in the repository will have this mode value. '0xxx' will override
377 user's umask value (whereas the other options will only override
378 requested parts of the user's umask value). Examples: '0660' will make
379 the repo read/write-able for the owner and group, but inaccessible to
380 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
381 repository that is group-readable but not group-writable.
382 See linkgit:git-init[1]. False by default.
384 core.warnAmbiguousRefs::
385 If true, git will warn you if the ref name you passed it is ambiguous
386 and might match multiple refs in the .git/refs/ tree. True by default.
389 An integer -1..9, indicating a default compression level.
390 -1 is the zlib default. 0 means no compression,
391 and 1..9 are various speed/size tradeoffs, 9 being slowest.
392 If set, this provides a default to other compression variables,
393 such as 'core.loosecompression' and 'pack.compression'.
395 core.loosecompression::
396 An integer -1..9, indicating the compression level for objects that
397 are not in a pack file. -1 is the zlib default. 0 means no
398 compression, and 1..9 are various speed/size tradeoffs, 9 being
399 slowest. If not set, defaults to core.compression. If that is
400 not set, defaults to 1 (best speed).
402 core.packedGitWindowSize::
403 Number of bytes of a pack file to map into memory in a
404 single mapping operation. Larger window sizes may allow
405 your system to process a smaller number of large pack files
406 more quickly. Smaller window sizes will negatively affect
407 performance due to increased calls to the operating system's
408 memory manager, but may improve performance when accessing
409 a large number of large pack files.
411 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
412 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
413 be reasonable for all users/operating systems. You probably do
414 not need to adjust this value.
416 Common unit suffixes of 'k', 'm', or 'g' are supported.
418 core.packedGitLimit::
419 Maximum number of bytes to map simultaneously into memory
420 from pack files. If Git needs to access more than this many
421 bytes at once to complete an operation it will unmap existing
422 regions to reclaim virtual address space within the process.
424 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
425 This should be reasonable for all users/operating systems, except on
426 the largest projects. You probably do not need to adjust this value.
428 Common unit suffixes of 'k', 'm', or 'g' are supported.
430 core.deltaBaseCacheLimit::
431 Maximum number of bytes to reserve for caching base objects
432 that may be referenced by multiple deltified objects. By storing the
433 entire decompressed base objects in a cache Git is able
434 to avoid unpacking and decompressing frequently used base
435 objects multiple times.
437 Default is 16 MiB on all platforms. This should be reasonable
438 for all users/operating systems, except on the largest projects.
439 You probably do not need to adjust this value.
441 Common unit suffixes of 'k', 'm', or 'g' are supported.
443 core.bigFileThreshold::
444 Files larger than this size are stored deflated, without
445 attempting delta compression. Storing large files without
446 delta compression avoids excessive memory usage, at the
447 slight expense of increased disk usage.
449 Default is 512 MiB on all platforms. This should be reasonable
450 for most projects as source code and other text files can still
451 be delta compressed, but larger binary media files won't be.
453 Common unit suffixes of 'k', 'm', or 'g' are supported.
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 Text editor used by `git rebase -i` for editing the rebase insn file.
485 The value is meant to be interpreted by the shell when it is used.
486 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
487 When not configured the default commit message editor is used instead.
490 The command that git will use to paginate output. Can
491 be overridden with the `GIT_PAGER` environment
492 variable. Note that git sets the `LESS` environment
493 variable to `FRSX` if it is unset when it runs the
494 pager. One can change these settings by setting the
495 `LESS` variable to some other value. Alternately,
496 these settings can be overridden on a project or
497 global basis by setting the `core.pager` option.
498 Setting `core.pager` has no affect on the `LESS`
499 environment variable behaviour above, so if you want
500 to override git's default settings this way, you need
501 to be explicit. For example, to disable the S option
502 in a backward compatible manner, set `core.pager`
503 to `less -+$LESS -FRX`. This will be passed to the
504 shell by git, which will translate the final command to
505 `LESS=FRSX less -+FRSX -FRX`.
508 A comma separated list of common whitespace problems to
509 notice. 'git diff' will use `color.diff.whitespace` to
510 highlight them, and 'git apply --whitespace=error' will
511 consider them as errors. You can prefix `-` to disable
512 any of them (e.g. `-trailing-space`):
514 * `blank-at-eol` treats trailing whitespaces at the end of the line
515 as an error (enabled by default).
516 * `space-before-tab` treats a space character that appears immediately
517 before a tab character in the initial indent part of the line as an
518 error (enabled by default).
519 * `indent-with-non-tab` treats a line that is indented with 8 or more
520 space characters as an error (not enabled by default).
521 * `tab-in-indent` treats a tab character in the initial indent part of
522 the line as an error (not enabled by default).
523 * `blank-at-eof` treats blank lines added at the end of file as an error
524 (enabled by default).
525 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
527 * `cr-at-eol` treats a carriage-return at the end of line as
528 part of the line terminator, i.e. with it, `trailing-space`
529 does not trigger if the character before such a carriage-return
530 is not a whitespace (not enabled by default).
531 * `tabwidth=<n>` tells how many character positions a tab occupies; this
532 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
533 errors. The default tab width is 8. Allowed values are 1 to 63.
535 core.fsyncobjectfiles::
536 This boolean will enable 'fsync()' when writing object files.
538 This is a total waste of time and effort on a filesystem that orders
539 data writes properly, but can be useful for filesystems that do not use
540 journalling (traditional UNIX filesystems) or that only journal metadata
541 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
544 Enable parallel index preload for operations like 'git diff'
546 This can speed up operations like 'git diff' and 'git status' especially
547 on filesystems like NFS that have weak caching semantics and thus
548 relatively high IO latencies. With this set to 'true', git will do the
549 index comparison to the filesystem data in parallel, allowing
553 You can set this to 'link', in which case a hardlink followed by
554 a delete of the source are used to make sure that object creation
555 will not overwrite existing objects.
557 On some file system/operating system combinations, this is unreliable.
558 Set this config setting to 'rename' there; However, This will remove the
559 check that makes sure that existing object files will not get overwritten.
562 When showing commit messages, also show notes which are stored in
563 the given ref. The ref must be fully qualified. If the given
564 ref does not exist, it is not an error but means that no
565 notes should be printed.
567 This setting defaults to "refs/notes/commits", and it can be overridden by
568 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
570 core.sparseCheckout::
571 Enable "sparse checkout" feature. See section "Sparse checkout" in
572 linkgit:git-read-tree[1] for more information.
575 Set the length object names are abbreviated to. If unspecified,
576 many commands abbreviate to 7 hexdigits, which may not be enough
577 for abbreviated object names to stay unique for sufficiently long
582 Tells 'git add' to continue adding files when some files cannot be
583 added due to indexing errors. Equivalent to the '--ignore-errors'
584 option of linkgit:git-add[1]. Older versions of git accept only
585 `add.ignore-errors`, which does not follow the usual naming
586 convention for configuration variables. Newer versions of git
587 honor `add.ignoreErrors` as well.
590 Command aliases for the linkgit:git[1] command wrapper - e.g.
591 after defining "alias.last = cat-file commit HEAD", the invocation
592 "git last" is equivalent to "git cat-file commit HEAD". To avoid
593 confusion and troubles with script usage, aliases that
594 hide existing git commands are ignored. Arguments are split by
595 spaces, the usual shell quoting and escaping is supported.
596 quote pair and a backslash can be used to quote them.
598 If the alias expansion is prefixed with an exclamation point,
599 it will be treated as a shell command. For example, defining
600 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
601 "git new" is equivalent to running the shell command
602 "gitk --all --not ORIG_HEAD". Note that shell commands will be
603 executed from the top-level directory of a repository, which may
604 not necessarily be the current directory.
605 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
606 from the original current directory. See linkgit:git-rev-parse[1].
609 If true, git-am will call git-mailsplit for patches in mbox format
610 with parameter '--keep-cr'. In this case git-mailsplit will
611 not remove `\r` from lines ending with `\r\n`. Can be overridden
612 by giving '--no-keep-cr' from the command line.
613 See linkgit:git-am[1], linkgit:git-mailsplit[1].
615 apply.ignorewhitespace::
616 When set to 'change', tells 'git apply' to ignore changes in
617 whitespace, in the same way as the '--ignore-space-change'
619 When set to one of: no, none, never, false tells 'git apply' to
620 respect all whitespace differences.
621 See linkgit:git-apply[1].
624 Tells 'git apply' how to handle whitespaces, in the same way
625 as the '--whitespace' option. See linkgit:git-apply[1].
627 branch.autosetupmerge::
628 Tells 'git branch' and 'git checkout' to set up new branches
629 so that linkgit:git-pull[1] will appropriately merge from the
630 starting point branch. Note that even if this option is not set,
631 this behavior can be chosen per-branch using the `--track`
632 and `--no-track` options. The valid settings are: `false` -- no
633 automatic setup is done; `true` -- automatic setup is done when the
634 starting point is a remote-tracking branch; `always` --
635 automatic setup is done when the starting point is either a
636 local branch or remote-tracking
637 branch. This option defaults to true.
639 branch.autosetuprebase::
640 When a new branch is created with 'git branch' or 'git checkout'
641 that tracks another branch, this variable tells git to set
642 up pull to rebase instead of merge (see "branch.<name>.rebase").
643 When `never`, rebase is never automatically set to true.
644 When `local`, rebase is set to true for tracked branches of
645 other local branches.
646 When `remote`, rebase is set to true for tracked branches of
647 remote-tracking branches.
648 When `always`, rebase will be set to true for all tracking
650 See "branch.autosetupmerge" for details on how to set up a
651 branch to track another branch.
652 This option defaults to never.
654 branch.<name>.remote::
655 When in branch <name>, it tells 'git fetch' and 'git push' which
656 remote to fetch from/push to. It defaults to `origin` if no remote is
657 configured. `origin` is also used if you are not on any branch.
659 branch.<name>.merge::
660 Defines, together with branch.<name>.remote, the upstream branch
661 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
662 branch to merge and can also affect 'git push' (see push.default).
663 When in branch <name>, it tells 'git fetch' the default
664 refspec to be marked for merging in FETCH_HEAD. The value is
665 handled like the remote part of a refspec, and must match a
666 ref which is fetched from the remote given by
667 "branch.<name>.remote".
668 The merge information is used by 'git pull' (which at first calls
669 'git fetch') to lookup the default branch for merging. Without
670 this option, 'git pull' defaults to merge the first refspec fetched.
671 Specify multiple values to get an octopus merge.
672 If you wish to setup 'git pull' so that it merges into <name> from
673 another branch in the local repository, you can point
674 branch.<name>.merge to the desired branch, and use the special setting
675 `.` (a period) for branch.<name>.remote.
677 branch.<name>.mergeoptions::
678 Sets default options for merging into branch <name>. The syntax and
679 supported options are the same as those of linkgit:git-merge[1], but
680 option values containing whitespace characters are currently not
683 branch.<name>.rebase::
684 When true, rebase the branch <name> on top of the fetched branch,
685 instead of merging the default branch from the default remote when
687 *NOTE*: this is a possibly dangerous operation; do *not* use
688 it unless you understand the implications (see linkgit:git-rebase[1]
692 Specify the command to invoke the specified browser. The
693 specified command is evaluated in shell with the URLs passed
694 as arguments. (See linkgit:git-web{litdd}browse[1].)
696 browser.<tool>.path::
697 Override the path for the given tool that may be used to
698 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
699 working repository in gitweb (see linkgit:git-instaweb[1]).
702 A boolean to make git-clean do nothing unless given -f
703 or -n. Defaults to true.
706 A boolean to enable/disable color in the output of
707 linkgit:git-branch[1]. May be set to `always`,
708 `false` (or `never`) or `auto` (or `true`), in which case colors are used
709 only when the output is to a terminal. Defaults to false.
711 color.branch.<slot>::
712 Use customized color for branch coloration. `<slot>` is one of
713 `current` (the current branch), `local` (a local branch),
714 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
717 The value for these configuration variables is a list of colors (at most
718 two) and attributes (at most one), separated by spaces. The colors
719 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
720 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
721 `blink` and `reverse`. The first color given is the foreground; the
722 second is the background. The position of the attribute, if any,
726 Whether to use ANSI escape sequences to add color to patches.
727 If this is set to `always`, linkgit:git-diff[1],
728 linkgit:git-log[1], and linkgit:git-show[1] will use color
729 for all patches. If it is set to `true` or `auto`, those
730 commands will only use color when output is to the terminal.
733 This does not affect linkgit:git-format-patch[1] nor the
734 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
735 command line with the `--color[=<when>]` option.
738 Use customized color for diff colorization. `<slot>` specifies
739 which part of the patch to use the specified color, and is one
740 of `plain` (context text), `meta` (metainformation), `frag`
741 (hunk header), 'func' (function in hunk header), `old` (removed lines),
742 `new` (added lines), `commit` (commit headers), or `whitespace`
743 (highlighting whitespace errors). The values of these variables may be
744 specified as in color.branch.<slot>.
746 color.decorate.<slot>::
747 Use customized color for 'git log --decorate' output. `<slot>` is one
748 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
749 branches, remote-tracking branches, tags, stash and HEAD, respectively.
752 When set to `always`, always highlight matches. When `false` (or
753 `never`), never. When set to `true` or `auto`, use color only
754 when the output is written to the terminal. Defaults to `false`.
757 Use customized color for grep colorization. `<slot>` specifies which
758 part of the line to use the specified color, and is one of
762 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
764 filename prefix (when not using `-h`)
766 function name lines (when using `-p`)
768 line number prefix (when using `-n`)
772 non-matching text in selected lines
774 separators between fields on a line (`:`, `-`, and `=`)
775 and between hunks (`--`)
778 The values of these variables may be specified as in color.branch.<slot>.
781 When set to `always`, always use colors for interactive prompts
782 and displays (such as those used by "git-add --interactive").
783 When false (or `never`), never. When set to `true` or `auto`, use
784 colors only when the output is to the terminal. Defaults to false.
786 color.interactive.<slot>::
787 Use customized color for 'git add --interactive'
788 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
789 four distinct types of normal output from interactive
790 commands. The values of these variables may be specified as
791 in color.branch.<slot>.
794 A boolean to enable/disable colored output when the pager is in
795 use (default is true).
798 A boolean to enable/disable color in the output of
799 linkgit:git-show-branch[1]. May be set to `always`,
800 `false` (or `never`) or `auto` (or `true`), in which case colors are used
801 only when the output is to a terminal. Defaults to false.
804 A boolean to enable/disable color in the output of
805 linkgit:git-status[1]. May be set to `always`,
806 `false` (or `never`) or `auto` (or `true`), in which case colors are used
807 only when the output is to a terminal. Defaults to false.
809 color.status.<slot>::
810 Use customized color for status colorization. `<slot>` is
811 one of `header` (the header text of the status message),
812 `added` or `updated` (files which are added but not committed),
813 `changed` (files which are changed but not added in the index),
814 `untracked` (files which are not tracked by git),
815 `branch` (the current branch), or
816 `nobranch` (the color the 'no branch' warning is shown in, defaulting
817 to red). The values of these variables may be specified as in
821 This variable determines the default value for variables such
822 as `color.diff` and `color.grep` that control the use of color
823 per command family. Its scope will expand as more commands learn
824 configuration to set a default for the `--color` option. Set it
825 to `always` if you want all output not intended for machine
826 consumption to use color, to `true` or `auto` if you want such
827 output to use color when written to the terminal, or to `false` or
828 `never` if you prefer git commands not to use color unless enabled
829 explicitly with some other configuration or the `--color` option.
832 A boolean to enable/disable inclusion of status information in the
833 commit message template when using an editor to prepare the commit
834 message. Defaults to true.
837 Specify a file to use as the template for new commit messages.
838 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
839 specified user's home directory.
841 include::diff-config.txt[]
843 difftool.<tool>.path::
844 Override the path for the given tool. This is useful in case
845 your tool is not in the PATH.
847 difftool.<tool>.cmd::
848 Specify the command to invoke the specified diff tool.
849 The specified command is evaluated in shell with the following
850 variables available: 'LOCAL' is set to the name of the temporary
851 file containing the contents of the diff pre-image and 'REMOTE'
852 is set to the name of the temporary file containing the contents
853 of the diff post-image.
856 Prompt before each invocation of the diff tool.
859 A POSIX Extended Regular Expression used to determine what is a "word"
860 when performing word-by-word difference calculations. Character
861 sequences that match the regular expression are "words", all other
862 characters are *ignorable* whitespace.
864 fetch.recurseSubmodules::
865 This option can be either set to a boolean value or to 'on-demand'.
866 Setting it to a boolean changes the behavior of fetch and pull to
867 unconditionally recurse into submodules when set to true or to not
868 recurse at all when set to false. When set to 'on-demand' (the default
869 value), fetch and pull will only recurse into a populated submodule
870 when its superproject retrieves a commit that updates the submodule's
874 If it is set to true, git-fetch-pack will check all fetched
875 objects. It will abort in the case of a malformed object or a
876 broken link. The result of an abort are only dangling objects.
877 Defaults to false. If not set, the value of `transfer.fsckObjects`
881 If the number of objects fetched over the git native
882 transfer is below this
883 limit, then the objects will be unpacked into loose object
884 files. However if the number of received objects equals or
885 exceeds this limit then the received pack will be stored as
886 a pack, after adding any missing delta bases. Storing the
887 pack from a push can make the push operation complete faster,
888 especially on slow filesystems. If not set, the value of
889 `transfer.unpackLimit` is used instead.
892 Enable multipart/mixed attachments as the default for
893 'format-patch'. The value can also be a double quoted string
894 which will enable attachments as the default and set the
895 value as the boundary. See the --attach option in
896 linkgit:git-format-patch[1].
899 A boolean which can enable or disable sequence numbers in patch
900 subjects. It defaults to "auto" which enables it only if there
901 is more than one patch. It can be enabled or disabled for all
902 messages by setting it to "true" or "false". See --numbered
903 option in linkgit:git-format-patch[1].
906 Additional email headers to include in a patch to be submitted
907 by mail. See linkgit:git-format-patch[1].
911 Additional recipients to include in a patch to be submitted
912 by mail. See the --to and --cc options in
913 linkgit:git-format-patch[1].
915 format.subjectprefix::
916 The default for format-patch is to output files with the '[PATCH]'
917 subject prefix. Use this variable to change that prefix.
920 The default for format-patch is to output a signature containing
921 the git version number. Use this variable to change that default.
922 Set this variable to the empty string ("") to suppress
923 signature generation.
926 The default for format-patch is to output files with the suffix
927 `.patch`. Use this variable to change that suffix (make sure to
928 include the dot if you want it).
931 The default pretty format for log/show/whatchanged command,
932 See linkgit:git-log[1], linkgit:git-show[1],
933 linkgit:git-whatchanged[1].
936 The default threading style for 'git format-patch'. Can be
937 a boolean value, or `shallow` or `deep`. `shallow` threading
938 makes every mail a reply to the head of the series,
939 where the head is chosen from the cover letter, the
940 `\--in-reply-to`, and the first patch mail, in this order.
941 `deep` threading makes every mail a reply to the previous one.
942 A true boolean value is the same as `shallow`, and a false
943 value disables threading.
946 A boolean value which lets you enable the `-s/--signoff` option of
947 format-patch by default. *Note:* Adding the Signed-off-by: line to a
948 patch should be a conscious act and means that you certify you have
949 the rights to submit this work under the same open source license.
950 Please see the 'SubmittingPatches' document for further discussion.
952 filter.<driver>.clean::
953 The command which is used to convert the content of a worktree
954 file to a blob upon checkin. See linkgit:gitattributes[5] for
957 filter.<driver>.smudge::
958 The command which is used to convert the content of a blob
959 object to a worktree file upon checkout. See
960 linkgit:gitattributes[5] for details.
962 gc.aggressiveWindow::
963 The window size parameter used in the delta compression
964 algorithm used by 'git gc --aggressive'. This defaults
968 When there are approximately more than this many loose
969 objects in the repository, `git gc --auto` will pack them.
970 Some Porcelain commands use this command to perform a
971 light-weight garbage collection from time to time. The
972 default value is 6700. Setting this to 0 disables it.
975 When there are more than this many packs that are not
976 marked with `*.keep` file in the repository, `git gc
977 --auto` consolidates them into one larger pack. The
978 default value is 50. Setting this to 0 disables it.
981 Running `git pack-refs` in a repository renders it
982 unclonable by Git versions prior to 1.5.1.2 over dumb
983 transports such as HTTP. This variable determines whether
984 'git gc' runs `git pack-refs`. This can be set to `notbare`
985 to enable it within all non-bare repos or it can be set to a
986 boolean value. The default is `true`.
989 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
990 Override the grace period with this config variable. The value
991 "now" may be used to disable this grace period and always prune
992 unreachable objects immediately.
995 gc.<pattern>.reflogexpire::
996 'git reflog expire' removes reflog entries older than
997 this time; defaults to 90 days. With "<pattern>" (e.g.
998 "refs/stash") in the middle the setting applies only to
999 the refs that match the <pattern>.
1001 gc.reflogexpireunreachable::
1002 gc.<ref>.reflogexpireunreachable::
1003 'git reflog expire' removes reflog entries older than
1004 this time and are not reachable from the current tip;
1005 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1006 in the middle, the setting applies only to the refs that
1007 match the <pattern>.
1010 Records of conflicted merge you resolved earlier are
1011 kept for this many days when 'git rerere gc' is run.
1012 The default is 60 days. See linkgit:git-rerere[1].
1014 gc.rerereunresolved::
1015 Records of conflicted merge you have not resolved are
1016 kept for this many days when 'git rerere gc' is run.
1017 The default is 15 days. See linkgit:git-rerere[1].
1019 gitcvs.commitmsgannotation::
1020 Append this string to each commit message. Set to empty string
1021 to disable this feature. Defaults to "via git-CVS emulator".
1024 Whether the CVS server interface is enabled for this repository.
1025 See linkgit:git-cvsserver[1].
1028 Path to a log file where the CVS server interface well... logs
1029 various stuff. See linkgit:git-cvsserver[1].
1031 gitcvs.usecrlfattr::
1032 If true, the server will look up the end-of-line conversion
1033 attributes for files to determine the '-k' modes to use. If
1034 the attributes force git to treat a file as text,
1035 the '-k' mode will be left blank so CVS clients will
1036 treat it as text. If they suppress text conversion, the file
1037 will be set with '-kb' mode, which suppresses any newline munging
1038 the client might otherwise do. If the attributes do not allow
1039 the file type to be determined, then 'gitcvs.allbinary' is
1040 used. See linkgit:gitattributes[5].
1043 This is used if 'gitcvs.usecrlfattr' does not resolve
1044 the correct '-kb' mode to use. If true, all
1045 unresolved files are sent to the client in
1046 mode '-kb'. This causes the client to treat them
1047 as binary files, which suppresses any newline munging it
1048 otherwise might do. Alternatively, if it is set to "guess",
1049 then the contents of the file are examined to decide if
1050 it is binary, similar to 'core.autocrlf'.
1053 Database used by git-cvsserver to cache revision information
1054 derived from the git repository. The exact meaning depends on the
1055 used database driver, for SQLite (which is the default driver) this
1056 is a filename. Supports variable substitution (see
1057 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1058 Default: '%Ggitcvs.%m.sqlite'
1061 Used Perl DBI driver. You can specify any available driver
1062 for this here, but it might not work. git-cvsserver is tested
1063 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1064 reported *not* to work with 'DBD::mysql'. Experimental feature.
1065 May not contain double colons (`:`). Default: 'SQLite'.
1066 See linkgit:git-cvsserver[1].
1068 gitcvs.dbuser, gitcvs.dbpass::
1069 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1070 since SQLite has no concept of database users and/or passwords.
1071 'gitcvs.dbuser' supports variable substitution (see
1072 linkgit:git-cvsserver[1] for details).
1074 gitcvs.dbTableNamePrefix::
1075 Database table name prefix. Prepended to the names of any
1076 database tables used, allowing a single database to be used
1077 for several repositories. Supports variable substitution (see
1078 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1079 characters will be replaced with underscores.
1081 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1082 'gitcvs.allbinary' can also be specified as
1083 'gitcvs.<access_method>.<varname>' (where 'access_method'
1084 is one of "ext" and "pserver") to make them apply only for the given
1088 gitweb.description::
1091 See linkgit:gitweb[1] for description.
1099 gitweb.remote_heads::
1102 See linkgit:gitweb.conf[5] for description.
1105 If set to true, enable '-n' option by default.
1107 grep.extendedRegexp::
1108 If set to true, enable '--extended-regexp' option by default.
1110 gui.commitmsgwidth::
1111 Defines how wide the commit message window is in the
1112 linkgit:git-gui[1]. "75" is the default.
1115 Specifies how many context lines should be used in calls to diff
1116 made by the linkgit:git-gui[1]. The default is "5".
1119 Specifies the default encoding to use for displaying of
1120 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1121 It can be overridden by setting the 'encoding' attribute
1122 for relevant files (see linkgit:gitattributes[5]).
1123 If this option is not set, the tools default to the
1126 gui.matchtrackingbranch::
1127 Determines if new branches created with linkgit:git-gui[1] should
1128 default to tracking remote branches with matching names or
1129 not. Default: "false".
1131 gui.newbranchtemplate::
1132 Is used as suggested name when creating new branches using the
1135 gui.pruneduringfetch::
1136 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1137 performing a fetch. The default value is "false".
1140 Determines if linkgit:git-gui[1] should trust the file modification
1141 timestamp or not. By default the timestamps are not trusted.
1143 gui.spellingdictionary::
1144 Specifies the dictionary used for spell checking commit messages in
1145 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1149 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1150 location detection. It makes blame significantly faster on huge
1151 repositories at the expense of less thorough copy detection.
1153 gui.copyblamethreshold::
1154 Specifies the threshold to use in 'git gui blame' original location
1155 detection, measured in alphanumeric characters. See the
1156 linkgit:git-blame[1] manual for more information on copy detection.
1158 gui.blamehistoryctx::
1159 Specifies the radius of history context in days to show in
1160 linkgit:gitk[1] for the selected commit, when the `Show History
1161 Context` menu item is invoked from 'git gui blame'. If this
1162 variable is set to zero, the whole history is shown.
1164 guitool.<name>.cmd::
1165 Specifies the shell command line to execute when the corresponding item
1166 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1167 mandatory for every tool. The command is executed from the root of
1168 the working directory, and in the environment it receives the name of
1169 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1170 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1171 the head is detached, 'CUR_BRANCH' is empty).
1173 guitool.<name>.needsfile::
1174 Run the tool only if a diff is selected in the GUI. It guarantees
1175 that 'FILENAME' is not empty.
1177 guitool.<name>.noconsole::
1178 Run the command silently, without creating a window to display its
1181 guitool.<name>.norescan::
1182 Don't rescan the working directory for changes after the tool
1185 guitool.<name>.confirm::
1186 Show a confirmation dialog before actually running the tool.
1188 guitool.<name>.argprompt::
1189 Request a string argument from the user, and pass it to the tool
1190 through the 'ARGS' environment variable. Since requesting an
1191 argument implies confirmation, the 'confirm' option has no effect
1192 if this is enabled. If the option is set to 'true', 'yes', or '1',
1193 the dialog uses a built-in generic prompt; otherwise the exact
1194 value of the variable is used.
1196 guitool.<name>.revprompt::
1197 Request a single valid revision from the user, and set the
1198 'REVISION' environment variable. In other aspects this option
1199 is similar to 'argprompt', and can be used together with it.
1201 guitool.<name>.revunmerged::
1202 Show only unmerged branches in the 'revprompt' subdialog.
1203 This is useful for tools similar to merge or rebase, but not
1204 for things like checkout or reset.
1206 guitool.<name>.title::
1207 Specifies the title to use for the prompt dialog. The default
1210 guitool.<name>.prompt::
1211 Specifies the general prompt string to display at the top of
1212 the dialog, before subsections for 'argprompt' and 'revprompt'.
1213 The default value includes the actual command.
1216 Specify the browser that will be used to display help in the
1217 'web' format. See linkgit:git-help[1].
1220 Override the default help format used by linkgit:git-help[1].
1221 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1222 the default. 'web' and 'html' are the same.
1225 Automatically correct and execute mistyped commands after
1226 waiting for the given number of deciseconds (0.1 sec). If more
1227 than one command can be deduced from the entered text, nothing
1228 will be executed. If the value of this option is negative,
1229 the corrected command will be executed immediately. If the
1230 value is 0 - the command will be just shown but not executed.
1231 This is the default.
1234 Override the HTTP proxy, normally configured using the 'http_proxy'
1235 environment variable (see linkgit:curl[1]). This can be overridden
1236 on a per-remote basis; see remote.<name>.proxy
1239 File containing previously stored cookie lines which should be used
1240 in the git http session, if they match the server. The file format
1241 of the file to read cookies from should be plain HTTP headers or
1242 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1243 NOTE that the file specified with http.cookiefile is only used as
1244 input. No cookies will be stored in the file.
1247 Whether to verify the SSL certificate when fetching or pushing
1248 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1252 File containing the SSL certificate when fetching or pushing
1253 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1257 File containing the SSL private key when fetching or pushing
1258 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1261 http.sslCertPasswordProtected::
1262 Enable git's password prompt for the SSL certificate. Otherwise
1263 OpenSSL will prompt the user, possibly many times, if the
1264 certificate or private key is encrypted. Can be overridden by the
1265 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1268 File containing the certificates to verify the peer with when
1269 fetching or pushing over HTTPS. Can be overridden by the
1270 'GIT_SSL_CAINFO' environment variable.
1273 Path containing files with the CA certificates to verify the peer
1274 with when fetching or pushing over HTTPS. Can be overridden
1275 by the 'GIT_SSL_CAPATH' environment variable.
1278 How many HTTP requests to launch in parallel. Can be overridden
1279 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1282 The number of curl sessions (counted across slots) to be kept across
1283 requests. They will not be ended with curl_easy_cleanup() until
1284 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1285 value will be capped at 1. Defaults to 1.
1288 Maximum size in bytes of the buffer used by smart HTTP
1289 transports when POSTing data to the remote system.
1290 For requests larger than this buffer size, HTTP/1.1 and
1291 Transfer-Encoding: chunked is used to avoid creating a
1292 massive pack file locally. Default is 1 MiB, which is
1293 sufficient for most requests.
1295 http.lowSpeedLimit, http.lowSpeedTime::
1296 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1297 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1298 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1299 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1302 A boolean which disables using of EPSV ftp command by curl.
1303 This can helpful with some "poor" ftp servers which don't
1304 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1305 environment variable. Default is false (curl will use EPSV).
1308 The HTTP USER_AGENT string presented to an HTTP server. The default
1309 value represents the version of the client git such as git/1.7.1.
1310 This option allows you to override this value to a more common value
1311 such as Mozilla/4.0. This may be necessary, for instance, if
1312 connecting through a firewall that restricts HTTP connections to a set
1313 of common USER_AGENT strings (but not including those like git/1.7.1).
1314 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1316 i18n.commitEncoding::
1317 Character encoding the commit messages are stored in; git itself
1318 does not care per se, but this information is necessary e.g. when
1319 importing commits from emails or in the gitk graphical history
1320 browser (and possibly at other places in the future or in other
1321 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1323 i18n.logOutputEncoding::
1324 Character encoding the commit messages are converted to when
1325 running 'git log' and friends.
1328 The configuration variables in the 'imap' section are described
1329 in linkgit:git-imap-send[1].
1332 Specify the directory from which templates will be copied.
1333 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1336 Specify the program that will be used to browse your working
1337 repository in gitweb. See linkgit:git-instaweb[1].
1340 The HTTP daemon command-line to start gitweb on your working
1341 repository. See linkgit:git-instaweb[1].
1344 If true the web server started by linkgit:git-instaweb[1] will
1345 be bound to the local IP (127.0.0.1).
1347 instaweb.modulepath::
1348 The default module path for linkgit:git-instaweb[1] to use
1349 instead of /usr/lib/apache2/modules. Only used if httpd
1353 The port number to bind the gitweb httpd to. See
1354 linkgit:git-instaweb[1].
1356 interactive.singlekey::
1357 In interactive commands, allow the user to provide one-letter
1358 input with a single key (i.e., without hitting enter).
1359 Currently this is used by the `\--patch` mode of
1360 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1361 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1362 setting is silently ignored if portable keystroke input
1366 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1367 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1368 override this option with `\--no-abbrev-commit`.
1371 Set the default date-time mode for the 'log' command.
1372 Setting a value for log.date is similar to using 'git log''s
1373 `\--date` option. Possible values are `relative`, `local`,
1374 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1378 Print out the ref names of any commits that are shown by the log
1379 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1380 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1381 specified, the full ref name (including prefix) will be printed.
1382 This is the same as the log commands '--decorate' option.
1385 If true, the initial commit will be shown as a big creation event.
1386 This is equivalent to a diff against an empty tree.
1387 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1388 normally hide the root commit will now show it. True by default.
1391 The location of an augmenting mailmap file. The default
1392 mailmap, located in the root of the repository, is loaded
1393 first, then the mailmap file pointed to by this variable.
1394 The location of the mailmap file may be in a repository
1395 subdirectory, or somewhere outside of the repository itself.
1396 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1399 Specify the programs that may be used to display help in the
1400 'man' format. See linkgit:git-help[1].
1403 Specify the command to invoke the specified man viewer. The
1404 specified command is evaluated in shell with the man page
1405 passed as argument. (See linkgit:git-help[1].)
1408 Override the path for the given tool that may be used to
1409 display help in the 'man' format. See linkgit:git-help[1].
1411 include::merge-config.txt[]
1413 mergetool.<tool>.path::
1414 Override the path for the given tool. This is useful in case
1415 your tool is not in the PATH.
1417 mergetool.<tool>.cmd::
1418 Specify the command to invoke the specified merge tool. The
1419 specified command is evaluated in shell with the following
1420 variables available: 'BASE' is the name of a temporary file
1421 containing the common base of the files to be merged, if available;
1422 'LOCAL' is the name of a temporary file containing the contents of
1423 the file on the current branch; 'REMOTE' is the name of a temporary
1424 file containing the contents of the file from the branch being
1425 merged; 'MERGED' contains the name of the file to which the merge
1426 tool should write the results of a successful merge.
1428 mergetool.<tool>.trustExitCode::
1429 For a custom merge command, specify whether the exit code of
1430 the merge command can be used to determine whether the merge was
1431 successful. If this is not set to true then the merge target file
1432 timestamp is checked and the merge assumed to have been successful
1433 if the file has been updated, otherwise the user is prompted to
1434 indicate the success of the merge.
1436 mergetool.keepBackup::
1437 After performing a merge, the original file with conflict markers
1438 can be saved as a file with a `.orig` extension. If this variable
1439 is set to `false` then this file is not preserved. Defaults to
1440 `true` (i.e. keep the backup files).
1442 mergetool.keepTemporaries::
1443 When invoking a custom merge tool, git uses a set of temporary
1444 files to pass to the tool. If the tool returns an error and this
1445 variable is set to `true`, then these temporary files will be
1446 preserved, otherwise they will be removed after the tool has
1447 exited. Defaults to `false`.
1450 Prompt before each invocation of the merge resolution program.
1453 The (fully qualified) refname from which to show notes when
1454 showing commit messages. The value of this variable can be set
1455 to a glob, in which case notes from all matching refs will be
1456 shown. You may also specify this configuration variable
1457 several times. A warning will be issued for refs that do not
1458 exist, but a glob that does not match any refs is silently
1461 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1462 environment variable, which must be a colon separated list of refs or
1465 The effective value of "core.notesRef" (possibly overridden by
1466 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1469 notes.rewrite.<command>::
1470 When rewriting commits with <command> (currently `amend` or
1471 `rebase`) and this variable is set to `true`, git
1472 automatically copies your notes from the original to the
1473 rewritten commit. Defaults to `true`, but see
1474 "notes.rewriteRef" below.
1477 When copying notes during a rewrite (see the
1478 "notes.rewrite.<command>" option), determines what to do if
1479 the target commit already has a note. Must be one of
1480 `overwrite`, `concatenate`, or `ignore`. Defaults to
1483 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1484 environment variable.
1487 When copying notes during a rewrite, specifies the (fully
1488 qualified) ref whose notes should be copied. The ref may be a
1489 glob, in which case notes in all matching refs will be copied.
1490 You may also specify this configuration several times.
1492 Does not have a default value; you must configure this variable to
1493 enable note rewriting. Set it to `refs/notes/commits` to enable
1494 rewriting for the default commit notes.
1496 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1497 environment variable, which must be a colon separated list of refs or
1501 The size of the window used by linkgit:git-pack-objects[1] when no
1502 window size is given on the command line. Defaults to 10.
1505 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1506 maximum depth is given on the command line. Defaults to 50.
1509 The window memory size limit used by linkgit:git-pack-objects[1]
1510 when no limit is given on the command line. The value can be
1511 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1515 An integer -1..9, indicating the compression level for objects
1516 in a pack file. -1 is the zlib default. 0 means no
1517 compression, and 1..9 are various speed/size tradeoffs, 9 being
1518 slowest. If not set, defaults to core.compression. If that is
1519 not set, defaults to -1, the zlib default, which is "a default
1520 compromise between speed and compression (currently equivalent
1523 Note that changing the compression level will not automatically recompress
1524 all existing objects. You can force recompression by passing the -F option
1525 to linkgit:git-repack[1].
1527 pack.deltaCacheSize::
1528 The maximum memory in bytes used for caching deltas in
1529 linkgit:git-pack-objects[1] before writing them out to a pack.
1530 This cache is used to speed up the writing object phase by not
1531 having to recompute the final delta result once the best match
1532 for all objects is found. Repacking large repositories on machines
1533 which are tight with memory might be badly impacted by this though,
1534 especially if this cache pushes the system into swapping.
1535 A value of 0 means no limit. The smallest size of 1 byte may be
1536 used to virtually disable this cache. Defaults to 256 MiB.
1538 pack.deltaCacheLimit::
1539 The maximum size of a delta, that is cached in
1540 linkgit:git-pack-objects[1]. This cache is used to speed up the
1541 writing object phase by not having to recompute the final delta
1542 result once the best match for all objects is found. Defaults to 1000.
1545 Specifies the number of threads to spawn when searching for best
1546 delta matches. This requires that linkgit:git-pack-objects[1]
1547 be compiled with pthreads otherwise this option is ignored with a
1548 warning. This is meant to reduce packing time on multiprocessor
1549 machines. The required amount of memory for the delta search window
1550 is however multiplied by the number of threads.
1551 Specifying 0 will cause git to auto-detect the number of CPU's
1552 and set the number of threads accordingly.
1555 Specify the default pack index version. Valid values are 1 for
1556 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1557 the new pack index with capabilities for packs larger than 4 GB
1558 as well as proper protection against the repacking of corrupted
1559 packs. Version 2 is the default. Note that version 2 is enforced
1560 and this config option ignored whenever the corresponding pack is
1563 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1564 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1565 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1566 other side may give you a repository that cannot be accessed with your
1567 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1568 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1569 the `{asterisk}.idx` file.
1571 pack.packSizeLimit::
1572 The maximum size of a pack. This setting only affects
1573 packing to a file when repacking, i.e. the git:// protocol
1574 is unaffected. It can be overridden by the `\--max-pack-size`
1575 option of linkgit:git-repack[1]. The minimum size allowed is
1576 limited to 1 MiB. The default is unlimited.
1577 Common unit suffixes of 'k', 'm', or 'g' are
1581 If the value is boolean, turns on or off pagination of the
1582 output of a particular git subcommand when writing to a tty.
1583 Otherwise, turns on pagination for the subcommand using the
1584 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1585 or `\--no-pager` is specified on the command line, it takes
1586 precedence over this option. To disable pagination for all
1587 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1590 Alias for a --pretty= format string, as specified in
1591 linkgit:git-log[1]. Any aliases defined here can be used just
1592 as the built-in pretty formats could. For example,
1593 running `git config pretty.changelog "format:{asterisk} %H %s"`
1594 would cause the invocation `git log --pretty=changelog`
1595 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1596 Note that an alias with the same name as a built-in format
1597 will be silently ignored.
1600 The default merge strategy to use when pulling multiple branches
1604 The default merge strategy to use when pulling a single branch.
1607 Defines the action git push should take if no refspec is given
1608 on the command line, no refspec is configured in the remote, and
1609 no refspec is implied by any of the options given on the command
1610 line. Possible values are:
1612 * `nothing` - do not push anything.
1613 * `matching` - push all matching branches.
1614 All branches having the same name in both ends are considered to be
1615 matching. This is the default.
1616 * `upstream` - push the current branch to its upstream branch.
1617 * `tracking` - deprecated synonym for `upstream`.
1618 * `current` - push the current branch to a branch of the same name.
1621 Whether to show a diffstat of what changed upstream since the last
1622 rebase. False by default.
1625 If set to true enable '--autosquash' option by default.
1628 By default, git-receive-pack will run "git-gc --auto" after
1629 receiving data from git-push and updating refs. You can stop
1630 it by setting this variable to false.
1632 receive.fsckObjects::
1633 If it is set to true, git-receive-pack will check all received
1634 objects. It will abort in the case of a malformed object or a
1635 broken link. The result of an abort are only dangling objects.
1636 Defaults to false. If not set, the value of `transfer.fsckObjects`
1639 receive.unpackLimit::
1640 If the number of objects received in a push is below this
1641 limit then the objects will be unpacked into loose object
1642 files. However if the number of received objects equals or
1643 exceeds this limit then the received pack will be stored as
1644 a pack, after adding any missing delta bases. Storing the
1645 pack from a push can make the push operation complete faster,
1646 especially on slow filesystems. If not set, the value of
1647 `transfer.unpackLimit` is used instead.
1649 receive.denyDeletes::
1650 If set to true, git-receive-pack will deny a ref update that deletes
1651 the ref. Use this to prevent such a ref deletion via a push.
1653 receive.denyDeleteCurrent::
1654 If set to true, git-receive-pack will deny a ref update that
1655 deletes the currently checked out branch of a non-bare repository.
1657 receive.denyCurrentBranch::
1658 If set to true or "refuse", git-receive-pack will deny a ref update
1659 to the currently checked out branch of a non-bare repository.
1660 Such a push is potentially dangerous because it brings the HEAD
1661 out of sync with the index and working tree. If set to "warn",
1662 print a warning of such a push to stderr, but allow the push to
1663 proceed. If set to false or "ignore", allow such pushes with no
1664 message. Defaults to "refuse".
1666 receive.denyNonFastForwards::
1667 If set to true, git-receive-pack will deny a ref update which is
1668 not a fast-forward. Use this to prevent such an update via a push,
1669 even if that push is forced. This configuration variable is
1670 set when initializing a shared repository.
1672 receive.updateserverinfo::
1673 If set to true, git-receive-pack will run git-update-server-info
1674 after receiving data from git-push and updating refs.
1677 The URL of a remote repository. See linkgit:git-fetch[1] or
1678 linkgit:git-push[1].
1680 remote.<name>.pushurl::
1681 The push URL of a remote repository. See linkgit:git-push[1].
1683 remote.<name>.proxy::
1684 For remotes that require curl (http, https and ftp), the URL to
1685 the proxy to use for that remote. Set to the empty string to
1686 disable proxying for that remote.
1688 remote.<name>.fetch::
1689 The default set of "refspec" for linkgit:git-fetch[1]. See
1690 linkgit:git-fetch[1].
1692 remote.<name>.push::
1693 The default set of "refspec" for linkgit:git-push[1]. See
1694 linkgit:git-push[1].
1696 remote.<name>.mirror::
1697 If true, pushing to this remote will automatically behave
1698 as if the `\--mirror` option was given on the command line.
1700 remote.<name>.skipDefaultUpdate::
1701 If true, this remote will be skipped by default when updating
1702 using linkgit:git-fetch[1] or the `update` subcommand of
1703 linkgit:git-remote[1].
1705 remote.<name>.skipFetchAll::
1706 If true, this remote will be skipped by default when updating
1707 using linkgit:git-fetch[1] or the `update` subcommand of
1708 linkgit:git-remote[1].
1710 remote.<name>.receivepack::
1711 The default program to execute on the remote side when pushing. See
1712 option \--receive-pack of linkgit:git-push[1].
1714 remote.<name>.uploadpack::
1715 The default program to execute on the remote side when fetching. See
1716 option \--upload-pack of linkgit:git-fetch-pack[1].
1718 remote.<name>.tagopt::
1719 Setting this value to \--no-tags disables automatic tag following when
1720 fetching from remote <name>. Setting it to \--tags will fetch every
1721 tag from remote <name>, even if they are not reachable from remote
1722 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1723 override this setting. See options \--tags and \--no-tags of
1724 linkgit:git-fetch[1].
1727 Setting this to a value <vcs> will cause git to interact with
1728 the remote with the git-remote-<vcs> helper.
1731 The list of remotes which are fetched by "git remote update
1732 <group>". See linkgit:git-remote[1].
1734 repack.usedeltabaseoffset::
1735 By default, linkgit:git-repack[1] creates packs that use
1736 delta-base offset. If you need to share your repository with
1737 git older than version 1.4.4, either directly or via a dumb
1738 protocol such as http, then you need to set this option to
1739 "false" and repack. Access from old git versions over the
1740 native protocol are unaffected by this option.
1743 When set to true, `git-rerere` updates the index with the
1744 resulting contents after it cleanly resolves conflicts using
1745 previously recorded resolution. Defaults to false.
1748 Activate recording of resolved conflicts, so that identical
1749 conflict hunks can be resolved automatically, should they
1750 be encountered again. linkgit:git-rerere[1] command is by
1751 default enabled if you create `rr-cache` directory under
1752 `$GIT_DIR`, but can be disabled by setting this option to false.
1754 sendemail.identity::
1755 A configuration identity. When given, causes values in the
1756 'sendemail.<identity>' subsection to take precedence over
1757 values in the 'sendemail' section. The default identity is
1758 the value of 'sendemail.identity'.
1760 sendemail.smtpencryption::
1761 See linkgit:git-send-email[1] for description. Note that this
1762 setting is not subject to the 'identity' mechanism.
1765 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1767 sendemail.<identity>.*::
1768 Identity-specific versions of the 'sendemail.*' parameters
1769 found below, taking precedence over those when the this
1770 identity is selected, through command-line or
1771 'sendemail.identity'.
1773 sendemail.aliasesfile::
1774 sendemail.aliasfiletype::
1778 sendemail.chainreplyto::
1780 sendemail.envelopesender::
1782 sendemail.multiedit::
1783 sendemail.signedoffbycc::
1784 sendemail.smtppass::
1785 sendemail.suppresscc::
1786 sendemail.suppressfrom::
1788 sendemail.smtpdomain::
1789 sendemail.smtpserver::
1790 sendemail.smtpserverport::
1791 sendemail.smtpserveroption::
1792 sendemail.smtpuser::
1794 sendemail.validate::
1795 See linkgit:git-send-email[1] for description.
1797 sendemail.signedoffcc::
1798 Deprecated alias for 'sendemail.signedoffbycc'.
1800 showbranch.default::
1801 The default set of branches for linkgit:git-show-branch[1].
1802 See linkgit:git-show-branch[1].
1804 status.relativePaths::
1805 By default, linkgit:git-status[1] shows paths relative to the
1806 current directory. Setting this variable to `false` shows paths
1807 relative to the repository root (this was the default for git
1810 status.showUntrackedFiles::
1811 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1812 files which are not currently tracked by Git. Directories which
1813 contain only untracked files, are shown with the directory name
1814 only. Showing untracked files means that Git needs to lstat() all
1815 all the files in the whole repository, which might be slow on some
1816 systems. So, this variable controls how the commands displays
1817 the untracked files. Possible values are:
1820 * `no` - Show no untracked files.
1821 * `normal` - Show untracked files and directories.
1822 * `all` - Show also individual files in untracked directories.
1825 If this variable is not specified, it defaults to 'normal'.
1826 This variable can be overridden with the -u|--untracked-files option
1827 of linkgit:git-status[1] and linkgit:git-commit[1].
1829 status.submodulesummary::
1831 If this is set to a non zero number or true (identical to -1 or an
1832 unlimited number), the submodule summary will be enabled and a
1833 summary of commits for modified submodules will be shown (see
1834 --summary-limit option of linkgit:git-submodule[1]).
1836 submodule.<name>.path::
1837 submodule.<name>.url::
1838 submodule.<name>.update::
1839 The path within this project, URL, and the updating strategy
1840 for a submodule. These variables are initially populated
1841 by 'git submodule init'; edit them to override the
1842 URL and other values found in the `.gitmodules` file. See
1843 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1845 submodule.<name>.fetchRecurseSubmodules::
1846 This option can be used to control recursive fetching of this
1847 submodule. It can be overridden by using the --[no-]recurse-submodules
1848 command line option to "git fetch" and "git pull".
1849 This setting will override that from in the linkgit:gitmodules[5]
1852 submodule.<name>.ignore::
1853 Defines under what circumstances "git status" and the diff family show
1854 a submodule as modified. When set to "all", it will never be considered
1855 modified, "dirty" will ignore all changes to the submodules work tree and
1856 takes only differences between the HEAD of the submodule and the commit
1857 recorded in the superproject into account. "untracked" will additionally
1858 let submodules with modified tracked files in their work tree show up.
1859 Using "none" (the default when this option is not set) also shows
1860 submodules that have untracked files in their work tree as changed.
1861 This setting overrides any setting made in .gitmodules for this submodule,
1862 both settings can be overridden on the command line by using the
1863 "--ignore-submodules" option.
1866 This variable can be used to restrict the permission bits of
1867 tar archive entries. The default is 0002, which turns off the
1868 world write bit. The special value "user" indicates that the
1869 archiving user's umask will be used instead. See umask(2) and
1870 linkgit:git-archive[1].
1872 transfer.fsckObjects::
1873 When `fetch.fsckObjects` or `receive.fsckObjects` are
1874 not set, the value of this variable is used instead.
1877 transfer.unpackLimit::
1878 When `fetch.unpackLimit` or `receive.unpackLimit` are
1879 not set, the value of this variable is used instead.
1880 The default value is 100.
1882 url.<base>.insteadOf::
1883 Any URL that starts with this value will be rewritten to
1884 start, instead, with <base>. In cases where some site serves a
1885 large number of repositories, and serves them with multiple
1886 access methods, and some users need to use different access
1887 methods, this feature allows people to specify any of the
1888 equivalent URLs and have git automatically rewrite the URL to
1889 the best alternative for the particular user, even for a
1890 never-before-seen repository on the site. When more than one
1891 insteadOf strings match a given URL, the longest match is used.
1893 url.<base>.pushInsteadOf::
1894 Any URL that starts with this value will not be pushed to;
1895 instead, it will be rewritten to start with <base>, and the
1896 resulting URL will be pushed to. In cases where some site serves
1897 a large number of repositories, and serves them with multiple
1898 access methods, some of which do not allow push, this feature
1899 allows people to specify a pull-only URL and have git
1900 automatically use an appropriate URL to push, even for a
1901 never-before-seen repository on the site. When more than one
1902 pushInsteadOf strings match a given URL, the longest match is
1903 used. If a remote has an explicit pushurl, git will ignore this
1904 setting for that remote.
1907 Your email address to be recorded in any newly created commits.
1908 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1909 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1912 Your full name to be recorded in any newly created commits.
1913 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1914 environment variables. See linkgit:git-commit-tree[1].
1917 If linkgit:git-tag[1] is not selecting the key you want it to
1918 automatically when creating a signed tag, you can override the
1919 default selection with this variable. This option is passed
1920 unchanged to gpg's --local-user parameter, so you may specify a key
1921 using any method that gpg supports.
1924 Specify a web browser that may be used by some commands.
1925 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]