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).
525 * `tabwidth=<n>` tells how many character positions a tab occupies; this
526 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
527 errors. The default tab width is 8. Allowed values are 1 to 63.
529 core.fsyncobjectfiles::
530 This boolean will enable 'fsync()' when writing object files.
532 This is a total waste of time and effort on a filesystem that orders
533 data writes properly, but can be useful for filesystems that do not use
534 journalling (traditional UNIX filesystems) or that only journal metadata
535 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
538 Enable parallel index preload for operations like 'git diff'
540 This can speed up operations like 'git diff' and 'git status' especially
541 on filesystems like NFS that have weak caching semantics and thus
542 relatively high IO latencies. With this set to 'true', git will do the
543 index comparison to the filesystem data in parallel, allowing
547 You can set this to 'link', in which case a hardlink followed by
548 a delete of the source are used to make sure that object creation
549 will not overwrite existing objects.
551 On some file system/operating system combinations, this is unreliable.
552 Set this config setting to 'rename' there; However, This will remove the
553 check that makes sure that existing object files will not get overwritten.
556 When showing commit messages, also show notes which are stored in
557 the given ref. The ref must be fully qualified. If the given
558 ref does not exist, it is not an error but means that no
559 notes should be printed.
561 This setting defaults to "refs/notes/commits", and it can be overridden by
562 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
564 core.sparseCheckout::
565 Enable "sparse checkout" feature. See section "Sparse checkout" in
566 linkgit:git-read-tree[1] for more information.
570 Tells 'git add' to continue adding files when some files cannot be
571 added due to indexing errors. Equivalent to the '--ignore-errors'
572 option of linkgit:git-add[1]. Older versions of git accept only
573 `add.ignore-errors`, which does not follow the usual naming
574 convention for configuration variables. Newer versions of git
575 honor `add.ignoreErrors` as well.
578 Command aliases for the linkgit:git[1] command wrapper - e.g.
579 after defining "alias.last = cat-file commit HEAD", the invocation
580 "git last" is equivalent to "git cat-file commit HEAD". To avoid
581 confusion and troubles with script usage, aliases that
582 hide existing git commands are ignored. Arguments are split by
583 spaces, the usual shell quoting and escaping is supported.
584 quote pair and a backslash can be used to quote them.
586 If the alias expansion is prefixed with an exclamation point,
587 it will be treated as a shell command. For example, defining
588 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
589 "git new" is equivalent to running the shell command
590 "gitk --all --not ORIG_HEAD". Note that shell commands will be
591 executed from the top-level directory of a repository, which may
592 not necessarily be the current directory.
595 If true, git-am will call git-mailsplit for patches in mbox format
596 with parameter '--keep-cr'. In this case git-mailsplit will
597 not remove `\r` from lines ending with `\r\n`. Can be overridden
598 by giving '--no-keep-cr' from the command line.
599 See linkgit:git-am[1], linkgit:git-mailsplit[1].
601 apply.ignorewhitespace::
602 When set to 'change', tells 'git apply' to ignore changes in
603 whitespace, in the same way as the '--ignore-space-change'
605 When set to one of: no, none, never, false tells 'git apply' to
606 respect all whitespace differences.
607 See linkgit:git-apply[1].
610 Tells 'git apply' how to handle whitespaces, in the same way
611 as the '--whitespace' option. See linkgit:git-apply[1].
613 branch.autosetupmerge::
614 Tells 'git branch' and 'git checkout' to set up new branches
615 so that linkgit:git-pull[1] will appropriately merge from the
616 starting point branch. Note that even if this option is not set,
617 this behavior can be chosen per-branch using the `--track`
618 and `--no-track` options. The valid settings are: `false` -- no
619 automatic setup is done; `true` -- automatic setup is done when the
620 starting point is a remote-tracking branch; `always` --
621 automatic setup is done when the starting point is either a
622 local branch or remote-tracking
623 branch. This option defaults to true.
625 branch.autosetuprebase::
626 When a new branch is created with 'git branch' or 'git checkout'
627 that tracks another branch, this variable tells git to set
628 up pull to rebase instead of merge (see "branch.<name>.rebase").
629 When `never`, rebase is never automatically set to true.
630 When `local`, rebase is set to true for tracked branches of
631 other local branches.
632 When `remote`, rebase is set to true for tracked branches of
633 remote-tracking branches.
634 When `always`, rebase will be set to true for all tracking
636 See "branch.autosetupmerge" for details on how to set up a
637 branch to track another branch.
638 This option defaults to never.
640 branch.<name>.remote::
641 When in branch <name>, it tells 'git fetch' and 'git push' which
642 remote to fetch from/push to. It defaults to `origin` if no remote is
643 configured. `origin` is also used if you are not on any branch.
645 branch.<name>.merge::
646 Defines, together with branch.<name>.remote, the upstream branch
647 for the given branch. It tells 'git fetch'/'git pull' which
648 branch to merge and can also affect 'git push' (see push.default).
649 When in branch <name>, it tells 'git fetch' the default
650 refspec to be marked for merging in FETCH_HEAD. The value is
651 handled like the remote part of a refspec, and must match a
652 ref which is fetched from the remote given by
653 "branch.<name>.remote".
654 The merge information is used by 'git pull' (which at first calls
655 'git fetch') to lookup the default branch for merging. Without
656 this option, 'git pull' defaults to merge the first refspec fetched.
657 Specify multiple values to get an octopus merge.
658 If you wish to setup 'git pull' so that it merges into <name> from
659 another branch in the local repository, you can point
660 branch.<name>.merge to the desired branch, and use the special setting
661 `.` (a period) for branch.<name>.remote.
663 branch.<name>.mergeoptions::
664 Sets default options for merging into branch <name>. The syntax and
665 supported options are the same as those of linkgit:git-merge[1], but
666 option values containing whitespace characters are currently not
669 branch.<name>.rebase::
670 When true, rebase the branch <name> on top of the fetched branch,
671 instead of merging the default branch from the default remote when
673 *NOTE*: this is a possibly dangerous operation; do *not* use
674 it unless you understand the implications (see linkgit:git-rebase[1]
678 Specify the command to invoke the specified browser. The
679 specified command is evaluated in shell with the URLs passed
680 as arguments. (See linkgit:git-web--browse[1].)
682 browser.<tool>.path::
683 Override the path for the given tool that may be used to
684 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
685 working repository in gitweb (see linkgit:git-instaweb[1]).
688 A boolean to make git-clean do nothing unless given -f
689 or -n. Defaults to true.
692 A boolean to enable/disable color in the output of
693 linkgit:git-branch[1]. May be set to `always`,
694 `false` (or `never`) or `auto` (or `true`), in which case colors are used
695 only when the output is to a terminal. Defaults to false.
697 color.branch.<slot>::
698 Use customized color for branch coloration. `<slot>` is one of
699 `current` (the current branch), `local` (a local branch),
700 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
703 The value for these configuration variables is a list of colors (at most
704 two) and attributes (at most one), separated by spaces. The colors
705 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
706 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
707 `blink` and `reverse`. The first color given is the foreground; the
708 second is the background. The position of the attribute, if any,
712 When set to `always`, always use colors in patch.
713 When false (or `never`), never. When set to `true` or `auto`, use
714 colors only when the output is to the terminal. Defaults to false.
717 Use customized color for diff colorization. `<slot>` specifies
718 which part of the patch to use the specified color, and is one
719 of `plain` (context text), `meta` (metainformation), `frag`
720 (hunk header), 'func' (function in hunk header), `old` (removed lines),
721 `new` (added lines), `commit` (commit headers), or `whitespace`
722 (highlighting whitespace errors). The values of these variables may be
723 specified as in color.branch.<slot>.
725 color.decorate.<slot>::
726 Use customized color for 'git log --decorate' output. `<slot>` is one
727 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
728 branches, remote-tracking branches, tags, stash and HEAD, respectively.
731 When set to `always`, always highlight matches. When `false` (or
732 `never`), never. When set to `true` or `auto`, use color only
733 when the output is written to the terminal. Defaults to `false`.
736 Use customized color for grep colorization. `<slot>` specifies which
737 part of the line to use the specified color, and is one of
741 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
743 filename prefix (when not using `-h`)
745 function name lines (when using `-p`)
747 line number prefix (when using `-n`)
751 non-matching text in selected lines
753 separators between fields on a line (`:`, `-`, and `=`)
754 and between hunks (`--`)
757 The values of these variables may be specified as in color.branch.<slot>.
760 When set to `always`, always use colors for interactive prompts
761 and displays (such as those used by "git-add --interactive").
762 When false (or `never`), never. When set to `true` or `auto`, use
763 colors only when the output is to the terminal. Defaults to false.
765 color.interactive.<slot>::
766 Use customized color for 'git add --interactive'
767 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
768 four distinct types of normal output from interactive
769 commands. The values of these variables may be specified as
770 in color.branch.<slot>.
773 A boolean to enable/disable colored output when the pager is in
774 use (default is true).
777 A boolean to enable/disable color in the output of
778 linkgit:git-show-branch[1]. May be set to `always`,
779 `false` (or `never`) or `auto` (or `true`), in which case colors are used
780 only when the output is to a terminal. Defaults to false.
783 A boolean to enable/disable color in the output of
784 linkgit:git-status[1]. May be set to `always`,
785 `false` (or `never`) or `auto` (or `true`), in which case colors are used
786 only when the output is to a terminal. Defaults to false.
788 color.status.<slot>::
789 Use customized color for status colorization. `<slot>` is
790 one of `header` (the header text of the status message),
791 `added` or `updated` (files which are added but not committed),
792 `changed` (files which are changed but not added in the index),
793 `untracked` (files which are not tracked by git),
794 `branch` (the current branch), or
795 `nobranch` (the color the 'no branch' warning is shown in, defaulting
796 to red). The values of these variables may be specified as in
800 When set to `always`, always use colors in all git commands which
801 are capable of colored output. When false (or `never`), never. When
802 set to `true` or `auto`, use colors only when the output is to the
803 terminal. When more specific variables of color.* are set, they always
804 take precedence over this setting. Defaults to false.
807 A boolean to enable/disable inclusion of status information in the
808 commit message template when using an editor to prepare the commit
809 message. Defaults to true.
812 Specify a file to use as the template for new commit messages.
813 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
814 specified user's home directory.
816 diff.autorefreshindex::
817 When using 'git diff' to compare with work tree
818 files, do not consider stat-only change as changed.
819 Instead, silently run `git update-index --refresh` to
820 update the cached stat information for paths whose
821 contents in the work tree match the contents in the
822 index. This option defaults to true. Note that this
823 affects only 'git diff' Porcelain, and not lower level
824 'diff' commands such as 'git diff-files'.
827 If this config variable is set, diff generation is not
828 performed using the internal diff machinery, but using the
829 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
830 environment variable. The command is called with parameters
831 as described under "git Diffs" in linkgit:git[1]. Note: if
832 you want to use an external diff program only on a subset of
833 your files, you might want to use linkgit:gitattributes[5] instead.
835 diff.mnemonicprefix::
836 If set, 'git diff' uses a prefix pair that is different from the
837 standard "a/" and "b/" depending on what is being compared. When
838 this configuration is in effect, reverse diff output also swaps
839 the order of the prefixes:
841 compares the (i)ndex and the (w)ork tree;
843 compares a (c)ommit and the (w)ork tree;
844 `git diff --cached`;;
845 compares a (c)ommit and the (i)ndex;
846 `git diff HEAD:file1 file2`;;
847 compares an (o)bject and a (w)ork tree entity;
848 `git diff --no-index a b`;;
849 compares two non-git things (1) and (2).
852 If set, 'git diff' does not show any source or destination prefix.
855 The number of files to consider when performing the copy/rename
856 detection; equivalent to the 'git diff' option '-l'.
859 Tells git to detect renames. If set to any boolean value, it
860 will enable basic rename detection. If set to "copies" or
861 "copy", it will detect copies, as well.
863 diff.ignoreSubmodules::
864 Sets the default value of --ignore-submodules. Note that this
865 affects only 'git diff' Porcelain, and not lower level 'diff'
866 commands such as 'git diff-files'. 'git checkout' also honors
867 this setting when reporting uncommitted changes.
869 diff.suppressBlankEmpty::
870 A boolean to inhibit the standard behavior of printing a space
871 before each empty output line. Defaults to false.
874 Controls which diff tool is used. `diff.tool` overrides
875 `merge.tool` when used by linkgit:git-difftool[1] and has
876 the same valid values as `merge.tool` minus "tortoisemerge"
879 difftool.<tool>.path::
880 Override the path for the given tool. This is useful in case
881 your tool is not in the PATH.
883 difftool.<tool>.cmd::
884 Specify the command to invoke the specified diff tool.
885 The specified command is evaluated in shell with the following
886 variables available: 'LOCAL' is set to the name of the temporary
887 file containing the contents of the diff pre-image and 'REMOTE'
888 is set to the name of the temporary file containing the contents
889 of the diff post-image.
892 Prompt before each invocation of the diff tool.
895 A POSIX Extended Regular Expression used to determine what is a "word"
896 when performing word-by-word difference calculations. Character
897 sequences that match the regular expression are "words", all other
898 characters are *ignorable* whitespace.
900 fetch.recurseSubmodules::
901 A boolean value which changes the behavior for fetch and pull, the
902 default is to not recursively fetch populated sumodules unless
903 configured otherwise.
906 If the number of objects fetched over the git native
907 transfer is below this
908 limit, then the objects will be unpacked into loose object
909 files. However if the number of received objects equals or
910 exceeds this limit then the received pack will be stored as
911 a pack, after adding any missing delta bases. Storing the
912 pack from a push can make the push operation complete faster,
913 especially on slow filesystems. If not set, the value of
914 `transfer.unpackLimit` is used instead.
917 Enable multipart/mixed attachments as the default for
918 'format-patch'. The value can also be a double quoted string
919 which will enable attachments as the default and set the
920 value as the boundary. See the --attach option in
921 linkgit:git-format-patch[1].
924 A boolean which can enable or disable sequence numbers in patch
925 subjects. It defaults to "auto" which enables it only if there
926 is more than one patch. It can be enabled or disabled for all
927 messages by setting it to "true" or "false". See --numbered
928 option in linkgit:git-format-patch[1].
931 Additional email headers to include in a patch to be submitted
932 by mail. See linkgit:git-format-patch[1].
936 Additional recipients to include in a patch to be submitted
937 by mail. See the --to and --cc options in
938 linkgit:git-format-patch[1].
940 format.subjectprefix::
941 The default for format-patch is to output files with the '[PATCH]'
942 subject prefix. Use this variable to change that prefix.
945 The default for format-patch is to output a signature containing
946 the git version number. Use this variable to change that default.
947 Set this variable to the empty string ("") to suppress
948 signature generation.
951 The default for format-patch is to output files with the suffix
952 `.patch`. Use this variable to change that suffix (make sure to
953 include the dot if you want it).
956 The default pretty format for log/show/whatchanged command,
957 See linkgit:git-log[1], linkgit:git-show[1],
958 linkgit:git-whatchanged[1].
961 The default threading style for 'git format-patch'. Can be
962 a boolean value, or `shallow` or `deep`. `shallow` threading
963 makes every mail a reply to the head of the series,
964 where the head is chosen from the cover letter, the
965 `\--in-reply-to`, and the first patch mail, in this order.
966 `deep` threading makes every mail a reply to the previous one.
967 A true boolean value is the same as `shallow`, and a false
968 value disables threading.
971 A boolean value which lets you enable the `-s/--signoff` option of
972 format-patch by default. *Note:* Adding the Signed-off-by: line to a
973 patch should be a conscious act and means that you certify you have
974 the rights to submit this work under the same open source license.
975 Please see the 'SubmittingPatches' document for further discussion.
977 gc.aggressiveWindow::
978 The window size parameter used in the delta compression
979 algorithm used by 'git gc --aggressive'. This defaults
983 When there are approximately more than this many loose
984 objects in the repository, `git gc --auto` will pack them.
985 Some Porcelain commands use this command to perform a
986 light-weight garbage collection from time to time. The
987 default value is 6700. Setting this to 0 disables it.
990 When there are more than this many packs that are not
991 marked with `*.keep` file in the repository, `git gc
992 --auto` consolidates them into one larger pack. The
993 default value is 50. Setting this to 0 disables it.
996 Running `git pack-refs` in a repository renders it
997 unclonable by Git versions prior to 1.5.1.2 over dumb
998 transports such as HTTP. This variable determines whether
999 'git gc' runs `git pack-refs`. This can be set to `notbare`
1000 to enable it within all non-bare repos or it can be set to a
1001 boolean value. The default is `true`.
1004 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1005 Override the grace period with this config variable. The value
1006 "now" may be used to disable this grace period and always prune
1007 unreachable objects immediately.
1010 gc.<pattern>.reflogexpire::
1011 'git reflog expire' removes reflog entries older than
1012 this time; defaults to 90 days. With "<pattern>" (e.g.
1013 "refs/stash") in the middle the setting applies only to
1014 the refs that match the <pattern>.
1016 gc.reflogexpireunreachable::
1017 gc.<ref>.reflogexpireunreachable::
1018 'git reflog expire' removes reflog entries older than
1019 this time and are not reachable from the current tip;
1020 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1021 in the middle, the setting applies only to the refs that
1022 match the <pattern>.
1025 Records of conflicted merge you resolved earlier are
1026 kept for this many days when 'git rerere gc' is run.
1027 The default is 60 days. See linkgit:git-rerere[1].
1029 gc.rerereunresolved::
1030 Records of conflicted merge you have not resolved are
1031 kept for this many days when 'git rerere gc' is run.
1032 The default is 15 days. See linkgit:git-rerere[1].
1034 gitcvs.commitmsgannotation::
1035 Append this string to each commit message. Set to empty string
1036 to disable this feature. Defaults to "via git-CVS emulator".
1039 Whether the CVS server interface is enabled for this repository.
1040 See linkgit:git-cvsserver[1].
1043 Path to a log file where the CVS server interface well... logs
1044 various stuff. See linkgit:git-cvsserver[1].
1046 gitcvs.usecrlfattr::
1047 If true, the server will look up the end-of-line conversion
1048 attributes for files to determine the '-k' modes to use. If
1049 the attributes force git to treat a file as text,
1050 the '-k' mode will be left blank so CVS clients will
1051 treat it as text. If they suppress text conversion, the file
1052 will be set with '-kb' mode, which suppresses any newline munging
1053 the client might otherwise do. If the attributes do not allow
1054 the file type to be determined, then 'gitcvs.allbinary' is
1055 used. See linkgit:gitattributes[5].
1058 This is used if 'gitcvs.usecrlfattr' does not resolve
1059 the correct '-kb' mode to use. If true, all
1060 unresolved files are sent to the client in
1061 mode '-kb'. This causes the client to treat them
1062 as binary files, which suppresses any newline munging it
1063 otherwise might do. Alternatively, if it is set to "guess",
1064 then the contents of the file are examined to decide if
1065 it is binary, similar to 'core.autocrlf'.
1068 Database used by git-cvsserver to cache revision information
1069 derived from the git repository. The exact meaning depends on the
1070 used database driver, for SQLite (which is the default driver) this
1071 is a filename. Supports variable substitution (see
1072 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1073 Default: '%Ggitcvs.%m.sqlite'
1076 Used Perl DBI driver. You can specify any available driver
1077 for this here, but it might not work. git-cvsserver is tested
1078 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1079 reported *not* to work with 'DBD::mysql'. Experimental feature.
1080 May not contain double colons (`:`). Default: 'SQLite'.
1081 See linkgit:git-cvsserver[1].
1083 gitcvs.dbuser, gitcvs.dbpass::
1084 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1085 since SQLite has no concept of database users and/or passwords.
1086 'gitcvs.dbuser' supports variable substitution (see
1087 linkgit:git-cvsserver[1] for details).
1089 gitcvs.dbTableNamePrefix::
1090 Database table name prefix. Prepended to the names of any
1091 database tables used, allowing a single database to be used
1092 for several repositories. Supports variable substitution (see
1093 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1094 characters will be replaced with underscores.
1096 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1097 'gitcvs.allbinary' can also be specified as
1098 'gitcvs.<access_method>.<varname>' (where 'access_method'
1099 is one of "ext" and "pserver") to make them apply only for the given
1102 gui.commitmsgwidth::
1103 Defines how wide the commit message window is in the
1104 linkgit:git-gui[1]. "75" is the default.
1107 Specifies how many context lines should be used in calls to diff
1108 made by the linkgit:git-gui[1]. The default is "5".
1111 Specifies the default encoding to use for displaying of
1112 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1113 It can be overridden by setting the 'encoding' attribute
1114 for relevant files (see linkgit:gitattributes[5]).
1115 If this option is not set, the tools default to the
1118 gui.matchtrackingbranch::
1119 Determines if new branches created with linkgit:git-gui[1] should
1120 default to tracking remote branches with matching names or
1121 not. Default: "false".
1123 gui.newbranchtemplate::
1124 Is used as suggested name when creating new branches using the
1127 gui.pruneduringfetch::
1128 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1129 performing a fetch. The default value is "false".
1132 Determines if linkgit:git-gui[1] should trust the file modification
1133 timestamp or not. By default the timestamps are not trusted.
1135 gui.spellingdictionary::
1136 Specifies the dictionary used for spell checking commit messages in
1137 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1141 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1142 location detection. It makes blame significantly faster on huge
1143 repositories at the expense of less thorough copy detection.
1145 gui.copyblamethreshold::
1146 Specifies the threshold to use in 'git gui blame' original location
1147 detection, measured in alphanumeric characters. See the
1148 linkgit:git-blame[1] manual for more information on copy detection.
1150 gui.blamehistoryctx::
1151 Specifies the radius of history context in days to show in
1152 linkgit:gitk[1] for the selected commit, when the `Show History
1153 Context` menu item is invoked from 'git gui blame'. If this
1154 variable is set to zero, the whole history is shown.
1156 guitool.<name>.cmd::
1157 Specifies the shell command line to execute when the corresponding item
1158 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1159 mandatory for every tool. The command is executed from the root of
1160 the working directory, and in the environment it receives the name of
1161 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1162 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1163 the head is detached, 'CUR_BRANCH' is empty).
1165 guitool.<name>.needsfile::
1166 Run the tool only if a diff is selected in the GUI. It guarantees
1167 that 'FILENAME' is not empty.
1169 guitool.<name>.noconsole::
1170 Run the command silently, without creating a window to display its
1173 guitool.<name>.norescan::
1174 Don't rescan the working directory for changes after the tool
1177 guitool.<name>.confirm::
1178 Show a confirmation dialog before actually running the tool.
1180 guitool.<name>.argprompt::
1181 Request a string argument from the user, and pass it to the tool
1182 through the 'ARGS' environment variable. Since requesting an
1183 argument implies confirmation, the 'confirm' option has no effect
1184 if this is enabled. If the option is set to 'true', 'yes', or '1',
1185 the dialog uses a built-in generic prompt; otherwise the exact
1186 value of the variable is used.
1188 guitool.<name>.revprompt::
1189 Request a single valid revision from the user, and set the
1190 'REVISION' environment variable. In other aspects this option
1191 is similar to 'argprompt', and can be used together with it.
1193 guitool.<name>.revunmerged::
1194 Show only unmerged branches in the 'revprompt' subdialog.
1195 This is useful for tools similar to merge or rebase, but not
1196 for things like checkout or reset.
1198 guitool.<name>.title::
1199 Specifies the title to use for the prompt dialog. The default
1202 guitool.<name>.prompt::
1203 Specifies the general prompt string to display at the top of
1204 the dialog, before subsections for 'argprompt' and 'revprompt'.
1205 The default value includes the actual command.
1208 Specify the browser that will be used to display help in the
1209 'web' format. See linkgit:git-help[1].
1212 Override the default help format used by linkgit:git-help[1].
1213 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1214 the default. 'web' and 'html' are the same.
1217 Automatically correct and execute mistyped commands after
1218 waiting for the given number of deciseconds (0.1 sec). If more
1219 than one command can be deduced from the entered text, nothing
1220 will be executed. If the value of this option is negative,
1221 the corrected command will be executed immediately. If the
1222 value is 0 - the command will be just shown but not executed.
1223 This is the default.
1226 Override the HTTP proxy, normally configured using the 'http_proxy'
1227 environment variable (see linkgit:curl[1]). This can be overridden
1228 on a per-remote basis; see remote.<name>.proxy
1231 Whether to verify the SSL certificate when fetching or pushing
1232 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1236 File containing the SSL certificate when fetching or pushing
1237 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1241 File containing the SSL private key when fetching or pushing
1242 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1245 http.sslCertPasswordProtected::
1246 Enable git's password prompt for the SSL certificate. Otherwise
1247 OpenSSL will prompt the user, possibly many times, if the
1248 certificate or private key is encrypted. Can be overridden by the
1249 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1252 File containing the certificates to verify the peer with when
1253 fetching or pushing over HTTPS. Can be overridden by the
1254 'GIT_SSL_CAINFO' environment variable.
1257 Path containing files with the CA certificates to verify the peer
1258 with when fetching or pushing over HTTPS. Can be overridden
1259 by the 'GIT_SSL_CAPATH' environment variable.
1262 How many HTTP requests to launch in parallel. Can be overridden
1263 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1266 The number of curl sessions (counted across slots) to be kept across
1267 requests. They will not be ended with curl_easy_cleanup() until
1268 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1269 value will be capped at 1. Defaults to 1.
1272 Maximum size in bytes of the buffer used by smart HTTP
1273 transports when POSTing data to the remote system.
1274 For requests larger than this buffer size, HTTP/1.1 and
1275 Transfer-Encoding: chunked is used to avoid creating a
1276 massive pack file locally. Default is 1 MiB, which is
1277 sufficient for most requests.
1279 http.lowSpeedLimit, http.lowSpeedTime::
1280 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1281 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1282 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1283 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1286 A boolean which disables using of EPSV ftp command by curl.
1287 This can helpful with some "poor" ftp servers which don't
1288 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1289 environment variable. Default is false (curl will use EPSV).
1292 The HTTP USER_AGENT string presented to an HTTP server. The default
1293 value represents the version of the client git such as git/1.7.1.
1294 This option allows you to override this value to a more common value
1295 such as Mozilla/4.0. This may be necessary, for instance, if
1296 connecting through a firewall that restricts HTTP connections to a set
1297 of common USER_AGENT strings (but not including those like git/1.7.1).
1298 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1300 i18n.commitEncoding::
1301 Character encoding the commit messages are stored in; git itself
1302 does not care per se, but this information is necessary e.g. when
1303 importing commits from emails or in the gitk graphical history
1304 browser (and possibly at other places in the future or in other
1305 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1307 i18n.logOutputEncoding::
1308 Character encoding the commit messages are converted to when
1309 running 'git log' and friends.
1312 The configuration variables in the 'imap' section are described
1313 in linkgit:git-imap-send[1].
1316 Specify the directory from which templates will be copied.
1317 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1320 Specify the program that will be used to browse your working
1321 repository in gitweb. See linkgit:git-instaweb[1].
1324 The HTTP daemon command-line to start gitweb on your working
1325 repository. See linkgit:git-instaweb[1].
1328 If true the web server started by linkgit:git-instaweb[1] will
1329 be bound to the local IP (127.0.0.1).
1331 instaweb.modulepath::
1332 The default module path for linkgit:git-instaweb[1] to use
1333 instead of /usr/lib/apache2/modules. Only used if httpd
1337 The port number to bind the gitweb httpd to. See
1338 linkgit:git-instaweb[1].
1340 interactive.singlekey::
1341 In interactive commands, allow the user to provide one-letter
1342 input with a single key (i.e., without hitting enter).
1343 Currently this is used only by the `\--patch` mode of
1344 linkgit:git-add[1]. Note that this setting is silently
1345 ignored if portable keystroke input is not available.
1348 Set the default date-time mode for the 'log' command.
1349 Setting a value for log.date is similar to using 'git log''s
1350 `\--date` option. Possible values are `relative`, `local`,
1351 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1355 Print out the ref names of any commits that are shown by the log
1356 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1357 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1358 specified, the full ref name (including prefix) will be printed.
1359 This is the same as the log commands '--decorate' option.
1362 If true, the initial commit will be shown as a big creation event.
1363 This is equivalent to a diff against an empty tree.
1364 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1365 normally hide the root commit will now show it. True by default.
1368 The location of an augmenting mailmap file. The default
1369 mailmap, located in the root of the repository, is loaded
1370 first, then the mailmap file pointed to by this variable.
1371 The location of the mailmap file may be in a repository
1372 subdirectory, or somewhere outside of the repository itself.
1373 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1376 Specify the programs that may be used to display help in the
1377 'man' format. See linkgit:git-help[1].
1380 Specify the command to invoke the specified man viewer. The
1381 specified command is evaluated in shell with the man page
1382 passed as argument. (See linkgit:git-help[1].)
1385 Override the path for the given tool that may be used to
1386 display help in the 'man' format. See linkgit:git-help[1].
1388 include::merge-config.txt[]
1390 mergetool.<tool>.path::
1391 Override the path for the given tool. This is useful in case
1392 your tool is not in the PATH.
1394 mergetool.<tool>.cmd::
1395 Specify the command to invoke the specified merge tool. The
1396 specified command is evaluated in shell with the following
1397 variables available: 'BASE' is the name of a temporary file
1398 containing the common base of the files to be merged, if available;
1399 'LOCAL' is the name of a temporary file containing the contents of
1400 the file on the current branch; 'REMOTE' is the name of a temporary
1401 file containing the contents of the file from the branch being
1402 merged; 'MERGED' contains the name of the file to which the merge
1403 tool should write the results of a successful merge.
1405 mergetool.<tool>.trustExitCode::
1406 For a custom merge command, specify whether the exit code of
1407 the merge command can be used to determine whether the merge was
1408 successful. If this is not set to true then the merge target file
1409 timestamp is checked and the merge assumed to have been successful
1410 if the file has been updated, otherwise the user is prompted to
1411 indicate the success of the merge.
1413 mergetool.keepBackup::
1414 After performing a merge, the original file with conflict markers
1415 can be saved as a file with a `.orig` extension. If this variable
1416 is set to `false` then this file is not preserved. Defaults to
1417 `true` (i.e. keep the backup files).
1419 mergetool.keepTemporaries::
1420 When invoking a custom merge tool, git uses a set of temporary
1421 files to pass to the tool. If the tool returns an error and this
1422 variable is set to `true`, then these temporary files will be
1423 preserved, otherwise they will be removed after the tool has
1424 exited. Defaults to `false`.
1427 Prompt before each invocation of the merge resolution program.
1430 The (fully qualified) refname from which to show notes when
1431 showing commit messages. The value of this variable can be set
1432 to a glob, in which case notes from all matching refs will be
1433 shown. You may also specify this configuration variable
1434 several times. A warning will be issued for refs that do not
1435 exist, but a glob that does not match any refs is silently
1438 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1439 environment variable, which must be a colon separated list of refs or
1442 The effective value of "core.notesRef" (possibly overridden by
1443 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1446 notes.rewrite.<command>::
1447 When rewriting commits with <command> (currently `amend` or
1448 `rebase`) and this variable is set to `true`, git
1449 automatically copies your notes from the original to the
1450 rewritten commit. Defaults to `true`, but see
1451 "notes.rewriteRef" below.
1454 When copying notes during a rewrite (see the
1455 "notes.rewrite.<command>" option), determines what to do if
1456 the target commit already has a note. Must be one of
1457 `overwrite`, `concatenate`, or `ignore`. Defaults to
1460 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1461 environment variable.
1464 When copying notes during a rewrite, specifies the (fully
1465 qualified) ref whose notes should be copied. The ref may be a
1466 glob, in which case notes in all matching refs will be copied.
1467 You may also specify this configuration several times.
1469 Does not have a default value; you must configure this variable to
1470 enable note rewriting.
1472 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1473 environment variable, which must be a colon separated list of refs or
1477 The size of the window used by linkgit:git-pack-objects[1] when no
1478 window size is given on the command line. Defaults to 10.
1481 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1482 maximum depth is given on the command line. Defaults to 50.
1485 The window memory size limit used by linkgit:git-pack-objects[1]
1486 when no limit is given on the command line. The value can be
1487 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1491 An integer -1..9, indicating the compression level for objects
1492 in a pack file. -1 is the zlib default. 0 means no
1493 compression, and 1..9 are various speed/size tradeoffs, 9 being
1494 slowest. If not set, defaults to core.compression. If that is
1495 not set, defaults to -1, the zlib default, which is "a default
1496 compromise between speed and compression (currently equivalent
1499 Note that changing the compression level will not automatically recompress
1500 all existing objects. You can force recompression by passing the -F option
1501 to linkgit:git-repack[1].
1503 pack.deltaCacheSize::
1504 The maximum memory in bytes used for caching deltas in
1505 linkgit:git-pack-objects[1] before writing them out to a pack.
1506 This cache is used to speed up the writing object phase by not
1507 having to recompute the final delta result once the best match
1508 for all objects is found. Repacking large repositories on machines
1509 which are tight with memory might be badly impacted by this though,
1510 especially if this cache pushes the system into swapping.
1511 A value of 0 means no limit. The smallest size of 1 byte may be
1512 used to virtually disable this cache. Defaults to 256 MiB.
1514 pack.deltaCacheLimit::
1515 The maximum size of a delta, that is cached in
1516 linkgit:git-pack-objects[1]. This cache is used to speed up the
1517 writing object phase by not having to recompute the final delta
1518 result once the best match for all objects is found. Defaults to 1000.
1521 Specifies the number of threads to spawn when searching for best
1522 delta matches. This requires that linkgit:git-pack-objects[1]
1523 be compiled with pthreads otherwise this option is ignored with a
1524 warning. This is meant to reduce packing time on multiprocessor
1525 machines. The required amount of memory for the delta search window
1526 is however multiplied by the number of threads.
1527 Specifying 0 will cause git to auto-detect the number of CPU's
1528 and set the number of threads accordingly.
1531 Specify the default pack index version. Valid values are 1 for
1532 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1533 the new pack index with capabilities for packs larger than 4 GB
1534 as well as proper protection against the repacking of corrupted
1535 packs. Version 2 is the default. Note that version 2 is enforced
1536 and this config option ignored whenever the corresponding pack is
1539 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1540 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1541 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1542 other side may give you a repository that cannot be accessed with your
1543 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1544 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1545 the `{asterisk}.idx` file.
1547 pack.packSizeLimit::
1548 The maximum size of a pack. This setting only affects
1549 packing to a file when repacking, i.e. the git:// protocol
1550 is unaffected. It can be overridden by the `\--max-pack-size`
1551 option of linkgit:git-repack[1]. The minimum size allowed is
1552 limited to 1 MiB. The default is unlimited.
1553 Common unit suffixes of 'k', 'm', or 'g' are
1557 If the value is boolean, turns on or off pagination of the
1558 output of a particular git subcommand when writing to a tty.
1559 Otherwise, turns on pagination for the subcommand using the
1560 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1561 or `\--no-pager` is specified on the command line, it takes
1562 precedence over this option. To disable pagination for all
1563 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1566 Alias for a --pretty= format string, as specified in
1567 linkgit:git-log[1]. Any aliases defined here can be used just
1568 as the built-in pretty formats could. For example,
1569 running `git config pretty.changelog "format:{asterisk} %H %s"`
1570 would cause the invocation `git log --pretty=changelog`
1571 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1572 Note that an alias with the same name as a built-in format
1573 will be silently ignored.
1576 The default merge strategy to use when pulling multiple branches
1580 The default merge strategy to use when pulling a single branch.
1583 Defines the action git push should take if no refspec is given
1584 on the command line, no refspec is configured in the remote, and
1585 no refspec is implied by any of the options given on the command
1586 line. Possible values are:
1588 * `nothing` - do not push anything.
1589 * `matching` - push all matching branches.
1590 All branches having the same name in both ends are considered to be
1591 matching. This is the default.
1592 * `tracking` - push the current branch to its upstream branch.
1593 * `current` - push the current branch to a branch of the same name.
1596 Whether to show a diffstat of what changed upstream since the last
1597 rebase. False by default.
1600 If set to true enable '--autosquash' option by default.
1603 By default, git-receive-pack will run "git-gc --auto" after
1604 receiving data from git-push and updating refs. You can stop
1605 it by setting this variable to false.
1607 receive.fsckObjects::
1608 If it is set to true, git-receive-pack will check all received
1609 objects. It will abort in the case of a malformed object or a
1610 broken link. The result of an abort are only dangling objects.
1613 receive.unpackLimit::
1614 If the number of objects received in a push is below this
1615 limit then the objects will be unpacked into loose object
1616 files. However if the number of received objects equals or
1617 exceeds this limit then the received pack will be stored as
1618 a pack, after adding any missing delta bases. Storing the
1619 pack from a push can make the push operation complete faster,
1620 especially on slow filesystems. If not set, the value of
1621 `transfer.unpackLimit` is used instead.
1623 receive.denyDeletes::
1624 If set to true, git-receive-pack will deny a ref update that deletes
1625 the ref. Use this to prevent such a ref deletion via a push.
1627 receive.denyDeleteCurrent::
1628 If set to true, git-receive-pack will deny a ref update that
1629 deletes the currently checked out branch of a non-bare repository.
1631 receive.denyCurrentBranch::
1632 If set to true or "refuse", git-receive-pack will deny a ref update
1633 to the currently checked out branch of a non-bare repository.
1634 Such a push is potentially dangerous because it brings the HEAD
1635 out of sync with the index and working tree. If set to "warn",
1636 print a warning of such a push to stderr, but allow the push to
1637 proceed. If set to false or "ignore", allow such pushes with no
1638 message. Defaults to "refuse".
1640 receive.denyNonFastForwards::
1641 If set to true, git-receive-pack will deny a ref update which is
1642 not a fast-forward. Use this to prevent such an update via a push,
1643 even if that push is forced. This configuration variable is
1644 set when initializing a shared repository.
1646 receive.updateserverinfo::
1647 If set to true, git-receive-pack will run git-update-server-info
1648 after receiving data from git-push and updating refs.
1651 The URL of a remote repository. See linkgit:git-fetch[1] or
1652 linkgit:git-push[1].
1654 remote.<name>.pushurl::
1655 The push URL of a remote repository. See linkgit:git-push[1].
1657 remote.<name>.proxy::
1658 For remotes that require curl (http, https and ftp), the URL to
1659 the proxy to use for that remote. Set to the empty string to
1660 disable proxying for that remote.
1662 remote.<name>.fetch::
1663 The default set of "refspec" for linkgit:git-fetch[1]. See
1664 linkgit:git-fetch[1].
1666 remote.<name>.push::
1667 The default set of "refspec" for linkgit:git-push[1]. See
1668 linkgit:git-push[1].
1670 remote.<name>.mirror::
1671 If true, pushing to this remote will automatically behave
1672 as if the `\--mirror` option was given on the command line.
1674 remote.<name>.skipDefaultUpdate::
1675 If true, this remote will be skipped by default when updating
1676 using linkgit:git-fetch[1] or the `update` subcommand of
1677 linkgit:git-remote[1].
1679 remote.<name>.skipFetchAll::
1680 If true, this remote will be skipped by default when updating
1681 using linkgit:git-fetch[1] or the `update` subcommand of
1682 linkgit:git-remote[1].
1684 remote.<name>.receivepack::
1685 The default program to execute on the remote side when pushing. See
1686 option \--receive-pack of linkgit:git-push[1].
1688 remote.<name>.uploadpack::
1689 The default program to execute on the remote side when fetching. See
1690 option \--upload-pack of linkgit:git-fetch-pack[1].
1692 remote.<name>.tagopt::
1693 Setting this value to \--no-tags disables automatic tag following when
1694 fetching from remote <name>. Setting it to \--tags will fetch every
1695 tag from remote <name>, even if they are not reachable from remote
1696 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1697 override this setting. See options \--tags and \--no-tags of
1698 linkgit:git-fetch[1].
1701 Setting this to a value <vcs> will cause git to interact with
1702 the remote with the git-remote-<vcs> helper.
1705 The list of remotes which are fetched by "git remote update
1706 <group>". See linkgit:git-remote[1].
1708 repack.usedeltabaseoffset::
1709 By default, linkgit:git-repack[1] creates packs that use
1710 delta-base offset. If you need to share your repository with
1711 git older than version 1.4.4, either directly or via a dumb
1712 protocol such as http, then you need to set this option to
1713 "false" and repack. Access from old git versions over the
1714 native protocol are unaffected by this option.
1717 When set to true, `git-rerere` updates the index with the
1718 resulting contents after it cleanly resolves conflicts using
1719 previously recorded resolution. Defaults to false.
1722 Activate recording of resolved conflicts, so that identical
1723 conflict hunks can be resolved automatically, should they
1724 be encountered again. linkgit:git-rerere[1] command is by
1725 default enabled if you create `rr-cache` directory under
1726 `$GIT_DIR`, but can be disabled by setting this option to false.
1728 sendemail.identity::
1729 A configuration identity. When given, causes values in the
1730 'sendemail.<identity>' subsection to take precedence over
1731 values in the 'sendemail' section. The default identity is
1732 the value of 'sendemail.identity'.
1734 sendemail.smtpencryption::
1735 See linkgit:git-send-email[1] for description. Note that this
1736 setting is not subject to the 'identity' mechanism.
1739 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1741 sendemail.<identity>.*::
1742 Identity-specific versions of the 'sendemail.*' parameters
1743 found below, taking precedence over those when the this
1744 identity is selected, through command-line or
1745 'sendemail.identity'.
1747 sendemail.aliasesfile::
1748 sendemail.aliasfiletype::
1752 sendemail.chainreplyto::
1754 sendemail.envelopesender::
1756 sendemail.multiedit::
1757 sendemail.signedoffbycc::
1758 sendemail.smtppass::
1759 sendemail.suppresscc::
1760 sendemail.suppressfrom::
1762 sendemail.smtpdomain::
1763 sendemail.smtpserver::
1764 sendemail.smtpserverport::
1765 sendemail.smtpserveroption::
1766 sendemail.smtpuser::
1768 sendemail.validate::
1769 See linkgit:git-send-email[1] for description.
1771 sendemail.signedoffcc::
1772 Deprecated alias for 'sendemail.signedoffbycc'.
1774 showbranch.default::
1775 The default set of branches for linkgit:git-show-branch[1].
1776 See linkgit:git-show-branch[1].
1778 status.relativePaths::
1779 By default, linkgit:git-status[1] shows paths relative to the
1780 current directory. Setting this variable to `false` shows paths
1781 relative to the repository root (this was the default for git
1784 status.showUntrackedFiles::
1785 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1786 files which are not currently tracked by Git. Directories which
1787 contain only untracked files, are shown with the directory name
1788 only. Showing untracked files means that Git needs to lstat() all
1789 all the files in the whole repository, which might be slow on some
1790 systems. So, this variable controls how the commands displays
1791 the untracked files. Possible values are:
1794 * `no` - Show no untracked files.
1795 * `normal` - Show untracked files and directories.
1796 * `all` - Show also individual files in untracked directories.
1799 If this variable is not specified, it defaults to 'normal'.
1800 This variable can be overridden with the -u|--untracked-files option
1801 of linkgit:git-status[1] and linkgit:git-commit[1].
1803 status.submodulesummary::
1805 If this is set to a non zero number or true (identical to -1 or an
1806 unlimited number), the submodule summary will be enabled and a
1807 summary of commits for modified submodules will be shown (see
1808 --summary-limit option of linkgit:git-submodule[1]).
1810 submodule.<name>.path::
1811 submodule.<name>.url::
1812 submodule.<name>.update::
1813 The path within this project, URL, and the updating strategy
1814 for a submodule. These variables are initially populated
1815 by 'git submodule init'; edit them to override the
1816 URL and other values found in the `.gitmodules` file. See
1817 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1819 submodule.<name>.fetchRecurseSubmodules::
1820 This option can be used to enable/disable recursive fetching of this
1821 submodule. It can be overriden by using the --[no-]recurse-submodules
1822 command line option to "git fetch" and "git pull".
1823 This setting will override that from in the linkgit:gitmodules[5]
1826 submodule.<name>.ignore::
1827 Defines under what circumstances "git status" and the diff family show
1828 a submodule as modified. When set to "all", it will never be considered
1829 modified, "dirty" will ignore all changes to the submodules work tree and
1830 takes only differences between the HEAD of the submodule and the commit
1831 recorded in the superproject into account. "untracked" will additionally
1832 let submodules with modified tracked files in their work tree show up.
1833 Using "none" (the default when this option is not set) also shows
1834 submodules that have untracked files in their work tree as changed.
1835 This setting overrides any setting made in .gitmodules for this submodule,
1836 both settings can be overridden on the command line by using the
1837 "--ignore-submodules" option.
1840 This variable can be used to restrict the permission bits of
1841 tar archive entries. The default is 0002, which turns off the
1842 world write bit. The special value "user" indicates that the
1843 archiving user's umask will be used instead. See umask(2) and
1844 linkgit:git-archive[1].
1846 transfer.unpackLimit::
1847 When `fetch.unpackLimit` or `receive.unpackLimit` are
1848 not set, the value of this variable is used instead.
1849 The default value is 100.
1851 url.<base>.insteadOf::
1852 Any URL that starts with this value will be rewritten to
1853 start, instead, with <base>. In cases where some site serves a
1854 large number of repositories, and serves them with multiple
1855 access methods, and some users need to use different access
1856 methods, this feature allows people to specify any of the
1857 equivalent URLs and have git automatically rewrite the URL to
1858 the best alternative for the particular user, even for a
1859 never-before-seen repository on the site. When more than one
1860 insteadOf strings match a given URL, the longest match is used.
1862 url.<base>.pushInsteadOf::
1863 Any URL that starts with this value will not be pushed to;
1864 instead, it will be rewritten to start with <base>, and the
1865 resulting URL will be pushed to. In cases where some site serves
1866 a large number of repositories, and serves them with multiple
1867 access methods, some of which do not allow push, this feature
1868 allows people to specify a pull-only URL and have git
1869 automatically use an appropriate URL to push, even for a
1870 never-before-seen repository on the site. When more than one
1871 pushInsteadOf strings match a given URL, the longest match is
1872 used. If a remote has an explicit pushurl, git will ignore this
1873 setting for that remote.
1876 Your email address to be recorded in any newly created commits.
1877 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1878 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1881 Your full name to be recorded in any newly created commits.
1882 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1883 environment variables. See linkgit:git-commit-tree[1].
1886 If linkgit:git-tag[1] is not selecting the key you want it to
1887 automatically when creating a signed tag, you can override the
1888 default selection with this variable. This option is passed
1889 unchanged to gpg's --local-user parameter, so you may specify a key
1890 using any method that gpg supports.
1893 Specify a web browser that may be used by some commands.
1894 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]