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 An integer -1..9, indicating a default compression level.
379 -1 is the zlib default. 0 means no compression,
380 and 1..9 are various speed/size tradeoffs, 9 being slowest.
381 If set, this provides a default to other compression variables,
382 such as 'core.loosecompression' and 'pack.compression'.
384 core.loosecompression::
385 An integer -1..9, indicating the compression level for objects that
386 are not in a pack file. -1 is the zlib default. 0 means no
387 compression, and 1..9 are various speed/size tradeoffs, 9 being
388 slowest. If not set, defaults to core.compression. If that is
389 not set, defaults to 1 (best speed).
391 core.packedGitWindowSize::
392 Number of bytes of a pack file to map into memory in a
393 single mapping operation. Larger window sizes may allow
394 your system to process a smaller number of large pack files
395 more quickly. Smaller window sizes will negatively affect
396 performance due to increased calls to the operating system's
397 memory manager, but may improve performance when accessing
398 a large number of large pack files.
400 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
401 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
402 be reasonable for all users/operating systems. You probably do
403 not need to adjust this value.
405 Common unit suffixes of 'k', 'm', or 'g' are supported.
407 core.packedGitLimit::
408 Maximum number of bytes to map simultaneously into memory
409 from pack files. If Git needs to access more than this many
410 bytes at once to complete an operation it will unmap existing
411 regions to reclaim virtual address space within the process.
413 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
414 This should be reasonable for all users/operating systems, except on
415 the largest projects. You probably do not need to adjust this value.
417 Common unit suffixes of 'k', 'm', or 'g' are supported.
419 core.deltaBaseCacheLimit::
420 Maximum number of bytes to reserve for caching base objects
421 that may be referenced by multiple deltified objects. By storing the
422 entire decompressed base objects in a cache Git is able
423 to avoid unpacking and decompressing frequently used base
424 objects multiple times.
426 Default is 16 MiB on all platforms. This should be reasonable
427 for all users/operating systems, except on the largest projects.
428 You probably do not need to adjust this value.
430 Common unit suffixes of 'k', 'm', or 'g' are supported.
432 core.bigFileThreshold::
433 Files larger than this size are stored deflated, without
434 attempting delta compression. Storing large files without
435 delta compression avoids excessive memory usage, at the
436 slight expense of increased disk usage.
438 Default is 512 MiB on all platforms. This should be reasonable
439 for most projects as source code and other text files can still
440 be delta compressed, but larger binary media files won't be.
442 Common unit suffixes of 'k', 'm', or 'g' are supported.
444 Currently only linkgit:git-fast-import[1] honors this setting.
447 In addition to '.gitignore' (per-directory) and
448 '.git/info/exclude', git looks into this file for patterns
449 of files which are not meant to be tracked. "{tilde}/" is expanded
450 to the value of `$HOME` and "{tilde}user/" to the specified user's
451 home directory. See linkgit:gitignore[5].
454 Some commands (e.g. svn and http interfaces) that interactively
455 ask for a password can be told to use an external program given
456 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
457 environment variable. If not set, fall back to the value of the
458 'SSH_ASKPASS' environment variable or, failing that, a simple password
459 prompt. The external program shall be given a suitable prompt as
460 command line argument and write the password on its STDOUT.
462 core.attributesfile::
463 In addition to '.gitattributes' (per-directory) and
464 '.git/info/attributes', git looks into this file for attributes
465 (see linkgit:gitattributes[5]). Path expansions are made the same
466 way as for `core.excludesfile`.
469 Commands such as `commit` and `tag` that lets you edit
470 messages by launching an editor uses the value of this
471 variable when it is set, and the environment variable
472 `GIT_EDITOR` is not set. See linkgit:git-var[1].
475 The command that git will use to paginate output. Can
476 be overridden with the `GIT_PAGER` environment
477 variable. Note that git sets the `LESS` environment
478 variable to `FRSX` if it is unset when it runs the
479 pager. One can change these settings by setting the
480 `LESS` variable to some other value. Alternately,
481 these settings can be overridden on a project or
482 global basis by setting the `core.pager` option.
483 Setting `core.pager` has no affect on the `LESS`
484 environment variable behaviour above, so if you want
485 to override git's default settings this way, you need
486 to be explicit. For example, to disable the S option
487 in a backward compatible manner, set `core.pager`
488 to `less -+$LESS -FRX`. This will be passed to the
489 shell by git, which will translate the final command to
490 `LESS=FRSX less -+FRSX -FRX`.
493 A comma separated list of common whitespace problems to
494 notice. 'git diff' will use `color.diff.whitespace` to
495 highlight them, and 'git apply --whitespace=error' will
496 consider them as errors. You can prefix `-` to disable
497 any of them (e.g. `-trailing-space`):
499 * `blank-at-eol` treats trailing whitespaces at the end of the line
500 as an error (enabled by default).
501 * `space-before-tab` treats a space character that appears immediately
502 before a tab character in the initial indent part of the line as an
503 error (enabled by default).
504 * `indent-with-non-tab` treats a line that is indented with 8 or more
505 space characters as an error (not enabled by default).
506 * `tab-in-indent` treats a tab character in the initial indent part of
507 the line as an error (not enabled by default).
508 * `blank-at-eof` treats blank lines added at the end of file as an error
509 (enabled by default).
510 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
512 * `cr-at-eol` treats a carriage-return at the end of line as
513 part of the line terminator, i.e. with it, `trailing-space`
514 does not trigger if the character before such a carriage-return
515 is not a whitespace (not enabled by default).
517 core.fsyncobjectfiles::
518 This boolean will enable 'fsync()' when writing object files.
520 This is a total waste of time and effort on a filesystem that orders
521 data writes properly, but can be useful for filesystems that do not use
522 journalling (traditional UNIX filesystems) or that only journal metadata
523 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
526 Enable parallel index preload for operations like 'git diff'
528 This can speed up operations like 'git diff' and 'git status' especially
529 on filesystems like NFS that have weak caching semantics and thus
530 relatively high IO latencies. With this set to 'true', git will do the
531 index comparison to the filesystem data in parallel, allowing
535 You can set this to 'link', in which case a hardlink followed by
536 a delete of the source are used to make sure that object creation
537 will not overwrite existing objects.
539 On some file system/operating system combinations, this is unreliable.
540 Set this config setting to 'rename' there; However, This will remove the
541 check that makes sure that existing object files will not get overwritten.
544 When showing commit messages, also show notes which are stored in
545 the given ref. The ref must be fully qualified. If the given
546 ref does not exist, it is not an error but means that no
547 notes should be printed.
549 This setting defaults to "refs/notes/commits", and it can be overridden by
550 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
552 core.sparseCheckout::
553 Enable "sparse checkout" feature. See section "Sparse checkout" in
554 linkgit:git-read-tree[1] for more information.
558 Tells 'git add' to continue adding files when some files cannot be
559 added due to indexing errors. Equivalent to the '--ignore-errors'
560 option of linkgit:git-add[1]. Older versions of git accept only
561 `add.ignore-errors`, which does not follow the usual naming
562 convention for configuration variables. Newer versions of git
563 honor `add.ignoreErrors` as well.
566 Command aliases for the linkgit:git[1] command wrapper - e.g.
567 after defining "alias.last = cat-file commit HEAD", the invocation
568 "git last" is equivalent to "git cat-file commit HEAD". To avoid
569 confusion and troubles with script usage, aliases that
570 hide existing git commands are ignored. Arguments are split by
571 spaces, the usual shell quoting and escaping is supported.
572 quote pair and a backslash can be used to quote them.
574 If the alias expansion is prefixed with an exclamation point,
575 it will be treated as a shell command. For example, defining
576 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
577 "git new" is equivalent to running the shell command
578 "gitk --all --not ORIG_HEAD". Note that shell commands will be
579 executed from the top-level directory of a repository, which may
580 not necessarily be the current directory.
583 If true, git-am will call git-mailsplit for patches in mbox format
584 with parameter '--keep-cr'. In this case git-mailsplit will
585 not remove `\r` from lines ending with `\r\n`. Can be overridden
586 by giving '--no-keep-cr' from the command line.
587 See linkgit:git-am[1], linkgit:git-mailsplit[1].
589 apply.ignorewhitespace::
590 When set to 'change', tells 'git apply' to ignore changes in
591 whitespace, in the same way as the '--ignore-space-change'
593 When set to one of: no, none, never, false tells 'git apply' to
594 respect all whitespace differences.
595 See linkgit:git-apply[1].
598 Tells 'git apply' how to handle whitespaces, in the same way
599 as the '--whitespace' option. See linkgit:git-apply[1].
601 branch.autosetupmerge::
602 Tells 'git branch' and 'git checkout' to set up new branches
603 so that linkgit:git-pull[1] will appropriately merge from the
604 starting point branch. Note that even if this option is not set,
605 this behavior can be chosen per-branch using the `--track`
606 and `--no-track` options. The valid settings are: `false` -- no
607 automatic setup is done; `true` -- automatic setup is done when the
608 starting point is a remote branch; `always` -- automatic setup is
609 done when the starting point is either a local branch or remote
610 branch. This option defaults to true.
612 branch.autosetuprebase::
613 When a new branch is created with 'git branch' or 'git checkout'
614 that tracks another branch, this variable tells git to set
615 up pull to rebase instead of merge (see "branch.<name>.rebase").
616 When `never`, rebase is never automatically set to true.
617 When `local`, rebase is set to true for tracked branches of
618 other local branches.
619 When `remote`, rebase is set to true for tracked branches of
621 When `always`, rebase will be set to true for all tracking
623 See "branch.autosetupmerge" for details on how to set up a
624 branch to track another branch.
625 This option defaults to never.
627 branch.<name>.remote::
628 When in branch <name>, it tells 'git fetch' and 'git push' which
629 remote to fetch from/push to. It defaults to `origin` if no remote is
630 configured. `origin` is also used if you are not on any branch.
632 branch.<name>.merge::
633 Defines, together with branch.<name>.remote, the upstream branch
634 for the given branch. It tells 'git fetch'/'git pull' which
635 branch to merge and can also affect 'git push' (see push.default).
636 When in branch <name>, it tells 'git fetch' the default
637 refspec to be marked for merging in FETCH_HEAD. The value is
638 handled like the remote part of a refspec, and must match a
639 ref which is fetched from the remote given by
640 "branch.<name>.remote".
641 The merge information is used by 'git pull' (which at first calls
642 'git fetch') to lookup the default branch for merging. Without
643 this option, 'git pull' defaults to merge the first refspec fetched.
644 Specify multiple values to get an octopus merge.
645 If you wish to setup 'git pull' so that it merges into <name> from
646 another branch in the local repository, you can point
647 branch.<name>.merge to the desired branch, and use the special setting
648 `.` (a period) for branch.<name>.remote.
650 branch.<name>.mergeoptions::
651 Sets default options for merging into branch <name>. The syntax and
652 supported options are the same as those of linkgit:git-merge[1], but
653 option values containing whitespace characters are currently not
656 branch.<name>.rebase::
657 When true, rebase the branch <name> on top of the fetched branch,
658 instead of merging the default branch from the default remote when
660 *NOTE*: this is a possibly dangerous operation; do *not* use
661 it unless you understand the implications (see linkgit:git-rebase[1]
665 Specify the command to invoke the specified browser. The
666 specified command is evaluated in shell with the URLs passed
667 as arguments. (See linkgit:git-web--browse[1].)
669 browser.<tool>.path::
670 Override the path for the given tool that may be used to
671 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
672 working repository in gitweb (see linkgit:git-instaweb[1]).
675 A boolean to make git-clean do nothing unless given -f
676 or -n. Defaults to true.
679 A boolean to enable/disable color in the output of
680 linkgit:git-branch[1]. May be set to `always`,
681 `false` (or `never`) or `auto` (or `true`), in which case colors are used
682 only when the output is to a terminal. Defaults to false.
684 color.branch.<slot>::
685 Use customized color for branch coloration. `<slot>` is one of
686 `current` (the current branch), `local` (a local branch),
687 `remote` (a tracking branch in refs/remotes/), `plain` (other
690 The value for these configuration variables is a list of colors (at most
691 two) and attributes (at most one), separated by spaces. The colors
692 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
693 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
694 `blink` and `reverse`. The first color given is the foreground; the
695 second is the background. The position of the attribute, if any,
699 When set to `always`, always use colors in patch.
700 When false (or `never`), never. When set to `true` or `auto`, use
701 colors only when the output is to the terminal. Defaults to false.
704 Use customized color for diff colorization. `<slot>` specifies
705 which part of the patch to use the specified color, and is one
706 of `plain` (context text), `meta` (metainformation), `frag`
707 (hunk header), 'func' (function in hunk header), `old` (removed lines),
708 `new` (added lines), `commit` (commit headers), or `whitespace`
709 (highlighting whitespace errors). The values of these variables may be
710 specified as in color.branch.<slot>.
712 color.decorate.<slot>::
713 Use customized color for 'git log --decorate' output. `<slot>` is one
714 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
715 branches, remote tracking branches, tags, stash and HEAD, respectively.
718 When set to `always`, always highlight matches. When `false` (or
719 `never`), never. When set to `true` or `auto`, use color only
720 when the output is written to the terminal. Defaults to `false`.
723 Use customized color for grep colorization. `<slot>` specifies which
724 part of the line to use the specified color, and is one of
728 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
730 filename prefix (when not using `-h`)
732 function name lines (when using `-p`)
734 line number prefix (when using `-n`)
738 non-matching text in selected lines
740 separators between fields on a line (`:`, `-`, and `=`)
741 and between hunks (`--`)
744 The values of these variables may be specified as in color.branch.<slot>.
747 When set to `always`, always use colors for interactive prompts
748 and displays (such as those used by "git-add --interactive").
749 When false (or `never`), never. When set to `true` or `auto`, use
750 colors only when the output is to the terminal. Defaults to false.
752 color.interactive.<slot>::
753 Use customized color for 'git add --interactive'
754 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
755 four distinct types of normal output from interactive
756 commands. The values of these variables may be specified as
757 in color.branch.<slot>.
760 A boolean to enable/disable colored output when the pager is in
761 use (default is true).
764 A boolean to enable/disable color in the output of
765 linkgit:git-show-branch[1]. May be set to `always`,
766 `false` (or `never`) or `auto` (or `true`), in which case colors are used
767 only when the output is to a terminal. Defaults to false.
770 A boolean to enable/disable color in the output of
771 linkgit:git-status[1]. May be set to `always`,
772 `false` (or `never`) or `auto` (or `true`), in which case colors are used
773 only when the output is to a terminal. Defaults to false.
775 color.status.<slot>::
776 Use customized color for status colorization. `<slot>` is
777 one of `header` (the header text of the status message),
778 `added` or `updated` (files which are added but not committed),
779 `changed` (files which are changed but not added in the index),
780 `untracked` (files which are not tracked by git), or
781 `nobranch` (the color the 'no branch' warning is shown in, defaulting
782 to red). The values of these variables may be specified as in
786 When set to `always`, always use colors in all git commands which
787 are capable of colored output. When false (or `never`), never. When
788 set to `true` or `auto`, use colors only when the output is to the
789 terminal. When more specific variables of color.* are set, they always
790 take precedence over this setting. Defaults to false.
793 A boolean to enable/disable inclusion of status information in the
794 commit message template when using an editor to prepare the commit
795 message. Defaults to true.
798 Specify a file to use as the template for new commit messages.
799 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
800 specified user's home directory.
802 diff.autorefreshindex::
803 When using 'git diff' to compare with work tree
804 files, do not consider stat-only change as changed.
805 Instead, silently run `git update-index --refresh` to
806 update the cached stat information for paths whose
807 contents in the work tree match the contents in the
808 index. This option defaults to true. Note that this
809 affects only 'git diff' Porcelain, and not lower level
810 'diff' commands such as 'git diff-files'.
813 If this config variable is set, diff generation is not
814 performed using the internal diff machinery, but using the
815 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
816 environment variable. The command is called with parameters
817 as described under "git Diffs" in linkgit:git[1]. Note: if
818 you want to use an external diff program only on a subset of
819 your files, you might want to use linkgit:gitattributes[5] instead.
821 diff.mnemonicprefix::
822 If set, 'git diff' uses a prefix pair that is different from the
823 standard "a/" and "b/" depending on what is being compared. When
824 this configuration is in effect, reverse diff output also swaps
825 the order of the prefixes:
827 compares the (i)ndex and the (w)ork tree;
829 compares a (c)ommit and the (w)ork tree;
830 `git diff --cached`;;
831 compares a (c)ommit and the (i)ndex;
832 `git diff HEAD:file1 file2`;;
833 compares an (o)bject and a (w)ork tree entity;
834 `git diff --no-index a b`;;
835 compares two non-git things (1) and (2).
838 If set, 'git diff' does not show any source or destination prefix.
841 The number of files to consider when performing the copy/rename
842 detection; equivalent to the 'git diff' option '-l'.
845 Tells git to detect renames. If set to any boolean value, it
846 will enable basic rename detection. If set to "copies" or
847 "copy", it will detect copies, as well.
849 diff.ignoreSubmodules::
850 Sets the default value of --ignore-submodules. Note that this
851 affects only 'git diff' Porcelain, and not lower level 'diff'
852 commands such as 'git diff-files'. 'git checkout' also honors
853 this setting when reporting uncommitted changes.
855 diff.suppressBlankEmpty::
856 A boolean to inhibit the standard behavior of printing a space
857 before each empty output line. Defaults to false.
860 Controls which diff tool is used. `diff.tool` overrides
861 `merge.tool` when used by linkgit:git-difftool[1] and has
862 the same valid values as `merge.tool` minus "tortoisemerge"
865 difftool.<tool>.path::
866 Override the path for the given tool. This is useful in case
867 your tool is not in the PATH.
869 difftool.<tool>.cmd::
870 Specify the command to invoke the specified diff tool.
871 The specified command is evaluated in shell with the following
872 variables available: 'LOCAL' is set to the name of the temporary
873 file containing the contents of the diff pre-image and 'REMOTE'
874 is set to the name of the temporary file containing the contents
875 of the diff post-image.
878 Prompt before each invocation of the diff tool.
881 A POSIX Extended Regular Expression used to determine what is a "word"
882 when performing word-by-word difference calculations. Character
883 sequences that match the regular expression are "words", all other
884 characters are *ignorable* whitespace.
887 If the number of objects fetched over the git native
888 transfer is below this
889 limit, then the objects will be unpacked into loose object
890 files. However if the number of received objects equals or
891 exceeds this limit then the received pack will be stored as
892 a pack, after adding any missing delta bases. Storing the
893 pack from a push can make the push operation complete faster,
894 especially on slow filesystems. If not set, the value of
895 `transfer.unpackLimit` is used instead.
898 Enable multipart/mixed attachments as the default for
899 'format-patch'. The value can also be a double quoted string
900 which will enable attachments as the default and set the
901 value as the boundary. See the --attach option in
902 linkgit:git-format-patch[1].
905 A boolean which can enable or disable sequence numbers in patch
906 subjects. It defaults to "auto" which enables it only if there
907 is more than one patch. It can be enabled or disabled for all
908 messages by setting it to "true" or "false". See --numbered
909 option in linkgit:git-format-patch[1].
912 Additional email headers to include in a patch to be submitted
913 by mail. See linkgit:git-format-patch[1].
917 Additional recipients to include in a patch to be submitted
918 by mail. See the --to and --cc options in
919 linkgit:git-format-patch[1].
921 format.subjectprefix::
922 The default for format-patch is to output files with the '[PATCH]'
923 subject prefix. Use this variable to change that prefix.
926 The default for format-patch is to output a signature containing
927 the git version number. Use this variable to change that default.
928 Set this variable to the empty string ("") to suppress
929 signature generation.
932 The default for format-patch is to output files with the suffix
933 `.patch`. Use this variable to change that suffix (make sure to
934 include the dot if you want it).
937 The default pretty format for log/show/whatchanged command,
938 See linkgit:git-log[1], linkgit:git-show[1],
939 linkgit:git-whatchanged[1].
942 The default threading style for 'git format-patch'. Can be
943 a boolean value, or `shallow` or `deep`. `shallow` threading
944 makes every mail a reply to the head of the series,
945 where the head is chosen from the cover letter, the
946 `\--in-reply-to`, and the first patch mail, in this order.
947 `deep` threading makes every mail a reply to the previous one.
948 A true boolean value is the same as `shallow`, and a false
949 value disables threading.
952 A boolean value which lets you enable the `-s/--signoff` option of
953 format-patch by default. *Note:* Adding the Signed-off-by: line to a
954 patch should be a conscious act and means that you certify you have
955 the rights to submit this work under the same open source license.
956 Please see the 'SubmittingPatches' document for further discussion.
958 gc.aggressiveWindow::
959 The window size parameter used in the delta compression
960 algorithm used by 'git gc --aggressive'. This defaults
964 When there are approximately more than this many loose
965 objects in the repository, `git gc --auto` will pack them.
966 Some Porcelain commands use this command to perform a
967 light-weight garbage collection from time to time. The
968 default value is 6700. Setting this to 0 disables it.
971 When there are more than this many packs that are not
972 marked with `*.keep` file in the repository, `git gc
973 --auto` consolidates them into one larger pack. The
974 default value is 50. Setting this to 0 disables it.
977 Running `git pack-refs` in a repository renders it
978 unclonable by Git versions prior to 1.5.1.2 over dumb
979 transports such as HTTP. This variable determines whether
980 'git gc' runs `git pack-refs`. This can be set to `nobare`
981 to enable it within all non-bare repos or it can be set to a
982 boolean value. The default is `true`.
985 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
986 Override the grace period with this config variable. The value
987 "now" may be used to disable this grace period and always prune
988 unreachable objects immediately.
991 gc.<pattern>.reflogexpire::
992 'git reflog expire' removes reflog entries older than
993 this time; defaults to 90 days. With "<pattern>" (e.g.
994 "refs/stash") in the middle the setting applies only to
995 the refs that match the <pattern>.
997 gc.reflogexpireunreachable::
998 gc.<ref>.reflogexpireunreachable::
999 'git reflog expire' removes reflog entries older than
1000 this time and are not reachable from the current tip;
1001 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1002 in the middle, the setting applies only to the refs that
1003 match the <pattern>.
1006 Records of conflicted merge you resolved earlier are
1007 kept for this many days when 'git rerere gc' is run.
1008 The default is 60 days. See linkgit:git-rerere[1].
1010 gc.rerereunresolved::
1011 Records of conflicted merge you have not resolved are
1012 kept for this many days when 'git rerere gc' is run.
1013 The default is 15 days. See linkgit:git-rerere[1].
1015 gitcvs.commitmsgannotation::
1016 Append this string to each commit message. Set to empty string
1017 to disable this feature. Defaults to "via git-CVS emulator".
1020 Whether the CVS server interface is enabled for this repository.
1021 See linkgit:git-cvsserver[1].
1024 Path to a log file where the CVS server interface well... logs
1025 various stuff. See linkgit:git-cvsserver[1].
1027 gitcvs.usecrlfattr::
1028 If true, the server will look up the end-of-line conversion
1029 attributes for files to determine the '-k' modes to use. If
1030 the attributes force git to treat a file as text,
1031 the '-k' mode will be left blank so CVS clients will
1032 treat it as text. If they suppress text conversion, the file
1033 will be set with '-kb' mode, which suppresses any newline munging
1034 the client might otherwise do. If the attributes do not allow
1035 the file type to be determined, then 'gitcvs.allbinary' is
1036 used. See linkgit:gitattributes[5].
1039 This is used if 'gitcvs.usecrlfattr' does not resolve
1040 the correct '-kb' mode to use. If true, all
1041 unresolved files are sent to the client in
1042 mode '-kb'. This causes the client to treat them
1043 as binary files, which suppresses any newline munging it
1044 otherwise might do. Alternatively, if it is set to "guess",
1045 then the contents of the file are examined to decide if
1046 it is binary, similar to 'core.autocrlf'.
1049 Database used by git-cvsserver to cache revision information
1050 derived from the git repository. The exact meaning depends on the
1051 used database driver, for SQLite (which is the default driver) this
1052 is a filename. Supports variable substitution (see
1053 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1054 Default: '%Ggitcvs.%m.sqlite'
1057 Used Perl DBI driver. You can specify any available driver
1058 for this here, but it might not work. git-cvsserver is tested
1059 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1060 reported *not* to work with 'DBD::mysql'. Experimental feature.
1061 May not contain double colons (`:`). Default: 'SQLite'.
1062 See linkgit:git-cvsserver[1].
1064 gitcvs.dbuser, gitcvs.dbpass::
1065 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1066 since SQLite has no concept of database users and/or passwords.
1067 'gitcvs.dbuser' supports variable substitution (see
1068 linkgit:git-cvsserver[1] for details).
1070 gitcvs.dbTableNamePrefix::
1071 Database table name prefix. Prepended to the names of any
1072 database tables used, allowing a single database to be used
1073 for several repositories. Supports variable substitution (see
1074 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1075 characters will be replaced with underscores.
1077 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1078 'gitcvs.allbinary' can also be specified as
1079 'gitcvs.<access_method>.<varname>' (where 'access_method'
1080 is one of "ext" and "pserver") to make them apply only for the given
1083 gui.commitmsgwidth::
1084 Defines how wide the commit message window is in the
1085 linkgit:git-gui[1]. "75" is the default.
1088 Specifies how many context lines should be used in calls to diff
1089 made by the linkgit:git-gui[1]. The default is "5".
1092 Specifies the default encoding to use for displaying of
1093 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1094 It can be overridden by setting the 'encoding' attribute
1095 for relevant files (see linkgit:gitattributes[5]).
1096 If this option is not set, the tools default to the
1099 gui.matchtrackingbranch::
1100 Determines if new branches created with linkgit:git-gui[1] should
1101 default to tracking remote branches with matching names or
1102 not. Default: "false".
1104 gui.newbranchtemplate::
1105 Is used as suggested name when creating new branches using the
1108 gui.pruneduringfetch::
1109 "true" if linkgit:git-gui[1] should prune tracking branches when
1110 performing a fetch. The default value is "false".
1113 Determines if linkgit:git-gui[1] should trust the file modification
1114 timestamp or not. By default the timestamps are not trusted.
1116 gui.spellingdictionary::
1117 Specifies the dictionary used for spell checking commit messages in
1118 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1122 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1123 location detection. It makes blame significantly faster on huge
1124 repositories at the expense of less thorough copy detection.
1126 gui.copyblamethreshold::
1127 Specifies the threshold to use in 'git gui blame' original location
1128 detection, measured in alphanumeric characters. See the
1129 linkgit:git-blame[1] manual for more information on copy detection.
1131 gui.blamehistoryctx::
1132 Specifies the radius of history context in days to show in
1133 linkgit:gitk[1] for the selected commit, when the `Show History
1134 Context` menu item is invoked from 'git gui blame'. If this
1135 variable is set to zero, the whole history is shown.
1137 guitool.<name>.cmd::
1138 Specifies the shell command line to execute when the corresponding item
1139 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1140 mandatory for every tool. The command is executed from the root of
1141 the working directory, and in the environment it receives the name of
1142 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1143 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1144 the head is detached, 'CUR_BRANCH' is empty).
1146 guitool.<name>.needsfile::
1147 Run the tool only if a diff is selected in the GUI. It guarantees
1148 that 'FILENAME' is not empty.
1150 guitool.<name>.noconsole::
1151 Run the command silently, without creating a window to display its
1154 guitool.<name>.norescan::
1155 Don't rescan the working directory for changes after the tool
1158 guitool.<name>.confirm::
1159 Show a confirmation dialog before actually running the tool.
1161 guitool.<name>.argprompt::
1162 Request a string argument from the user, and pass it to the tool
1163 through the 'ARGS' environment variable. Since requesting an
1164 argument implies confirmation, the 'confirm' option has no effect
1165 if this is enabled. If the option is set to 'true', 'yes', or '1',
1166 the dialog uses a built-in generic prompt; otherwise the exact
1167 value of the variable is used.
1169 guitool.<name>.revprompt::
1170 Request a single valid revision from the user, and set the
1171 'REVISION' environment variable. In other aspects this option
1172 is similar to 'argprompt', and can be used together with it.
1174 guitool.<name>.revunmerged::
1175 Show only unmerged branches in the 'revprompt' subdialog.
1176 This is useful for tools similar to merge or rebase, but not
1177 for things like checkout or reset.
1179 guitool.<name>.title::
1180 Specifies the title to use for the prompt dialog. The default
1183 guitool.<name>.prompt::
1184 Specifies the general prompt string to display at the top of
1185 the dialog, before subsections for 'argprompt' and 'revprompt'.
1186 The default value includes the actual command.
1189 Specify the browser that will be used to display help in the
1190 'web' format. See linkgit:git-help[1].
1193 Override the default help format used by linkgit:git-help[1].
1194 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1195 the default. 'web' and 'html' are the same.
1198 Automatically correct and execute mistyped commands after
1199 waiting for the given number of deciseconds (0.1 sec). If more
1200 than one command can be deduced from the entered text, nothing
1201 will be executed. If the value of this option is negative,
1202 the corrected command will be executed immediately. If the
1203 value is 0 - the command will be just shown but not executed.
1204 This is the default.
1207 Override the HTTP proxy, normally configured using the 'http_proxy'
1208 environment variable (see linkgit:curl[1]). This can be overridden
1209 on a per-remote basis; see remote.<name>.proxy
1212 Whether to verify the SSL certificate when fetching or pushing
1213 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1217 File containing the SSL certificate when fetching or pushing
1218 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1222 File containing the SSL private key when fetching or pushing
1223 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1226 http.sslCertPasswordProtected::
1227 Enable git's password prompt for the SSL certificate. Otherwise
1228 OpenSSL will prompt the user, possibly many times, if the
1229 certificate or private key is encrypted. Can be overridden by the
1230 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1233 File containing the certificates to verify the peer with when
1234 fetching or pushing over HTTPS. Can be overridden by the
1235 'GIT_SSL_CAINFO' environment variable.
1238 Path containing files with the CA certificates to verify the peer
1239 with when fetching or pushing over HTTPS. Can be overridden
1240 by the 'GIT_SSL_CAPATH' environment variable.
1243 How many HTTP requests to launch in parallel. Can be overridden
1244 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1247 The number of curl sessions (counted across slots) to be kept across
1248 requests. They will not be ended with curl_easy_cleanup() until
1249 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1250 value will be capped at 1. Defaults to 1.
1253 Maximum size in bytes of the buffer used by smart HTTP
1254 transports when POSTing data to the remote system.
1255 For requests larger than this buffer size, HTTP/1.1 and
1256 Transfer-Encoding: chunked is used to avoid creating a
1257 massive pack file locally. Default is 1 MiB, which is
1258 sufficient for most requests.
1260 http.lowSpeedLimit, http.lowSpeedTime::
1261 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1262 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1263 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1264 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1267 A boolean which disables using of EPSV ftp command by curl.
1268 This can helpful with some "poor" ftp servers which don't
1269 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1270 environment variable. Default is false (curl will use EPSV).
1273 The HTTP USER_AGENT string presented to an HTTP server. The default
1274 value represents the version of the client git such as git/1.7.1.
1275 This option allows you to override this value to a more common value
1276 such as Mozilla/4.0. This may be necessary, for instance, if
1277 connecting through a firewall that restricts HTTP connections to a set
1278 of common USER_AGENT strings (but not including those like git/1.7.1).
1279 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1281 i18n.commitEncoding::
1282 Character encoding the commit messages are stored in; git itself
1283 does not care per se, but this information is necessary e.g. when
1284 importing commits from emails or in the gitk graphical history
1285 browser (and possibly at other places in the future or in other
1286 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1288 i18n.logOutputEncoding::
1289 Character encoding the commit messages are converted to when
1290 running 'git log' and friends.
1293 The configuration variables in the 'imap' section are described
1294 in linkgit:git-imap-send[1].
1297 Specify the directory from which templates will be copied.
1298 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1301 Specify the program that will be used to browse your working
1302 repository in gitweb. See linkgit:git-instaweb[1].
1305 The HTTP daemon command-line to start gitweb on your working
1306 repository. See linkgit:git-instaweb[1].
1309 If true the web server started by linkgit:git-instaweb[1] will
1310 be bound to the local IP (127.0.0.1).
1312 instaweb.modulepath::
1313 The default module path for linkgit:git-instaweb[1] to use
1314 instead of /usr/lib/apache2/modules. Only used if httpd
1318 The port number to bind the gitweb httpd to. See
1319 linkgit:git-instaweb[1].
1321 interactive.singlekey::
1322 In interactive commands, allow the user to provide one-letter
1323 input with a single key (i.e., without hitting enter).
1324 Currently this is used only by the `\--patch` mode of
1325 linkgit:git-add[1]. Note that this setting is silently
1326 ignored if portable keystroke input is not available.
1329 Set the default date-time mode for the 'log' command.
1330 Setting a value for log.date is similar to using 'git log''s
1331 `\--date` option. Possible values are `relative`, `local`,
1332 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1336 Print out the ref names of any commits that are shown by the log
1337 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1338 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1339 specified, the full ref name (including prefix) will be printed.
1340 This is the same as the log commands '--decorate' option.
1343 If true, the initial commit will be shown as a big creation event.
1344 This is equivalent to a diff against an empty tree.
1345 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1346 normally hide the root commit will now show it. True by default.
1349 The location of an augmenting mailmap file. The default
1350 mailmap, located in the root of the repository, is loaded
1351 first, then the mailmap file pointed to by this variable.
1352 The location of the mailmap file may be in a repository
1353 subdirectory, or somewhere outside of the repository itself.
1354 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1357 Specify the programs that may be used to display help in the
1358 'man' format. See linkgit:git-help[1].
1361 Specify the command to invoke the specified man viewer. The
1362 specified command is evaluated in shell with the man page
1363 passed as argument. (See linkgit:git-help[1].)
1366 Override the path for the given tool that may be used to
1367 display help in the 'man' format. See linkgit:git-help[1].
1369 include::merge-config.txt[]
1371 mergetool.<tool>.path::
1372 Override the path for the given tool. This is useful in case
1373 your tool is not in the PATH.
1375 mergetool.<tool>.cmd::
1376 Specify the command to invoke the specified merge tool. The
1377 specified command is evaluated in shell with the following
1378 variables available: 'BASE' is the name of a temporary file
1379 containing the common base of the files to be merged, if available;
1380 'LOCAL' is the name of a temporary file containing the contents of
1381 the file on the current branch; 'REMOTE' is the name of a temporary
1382 file containing the contents of the file from the branch being
1383 merged; 'MERGED' contains the name of the file to which the merge
1384 tool should write the results of a successful merge.
1386 mergetool.<tool>.trustExitCode::
1387 For a custom merge command, specify whether the exit code of
1388 the merge command can be used to determine whether the merge was
1389 successful. If this is not set to true then the merge target file
1390 timestamp is checked and the merge assumed to have been successful
1391 if the file has been updated, otherwise the user is prompted to
1392 indicate the success of the merge.
1394 mergetool.keepBackup::
1395 After performing a merge, the original file with conflict markers
1396 can be saved as a file with a `.orig` extension. If this variable
1397 is set to `false` then this file is not preserved. Defaults to
1398 `true` (i.e. keep the backup files).
1400 mergetool.keepTemporaries::
1401 When invoking a custom merge tool, git uses a set of temporary
1402 files to pass to the tool. If the tool returns an error and this
1403 variable is set to `true`, then these temporary files will be
1404 preserved, otherwise they will be removed after the tool has
1405 exited. Defaults to `false`.
1408 Prompt before each invocation of the merge resolution program.
1411 The (fully qualified) refname from which to show notes when
1412 showing commit messages. The value of this variable can be set
1413 to a glob, in which case notes from all matching refs will be
1414 shown. You may also specify this configuration variable
1415 several times. A warning will be issued for refs that do not
1416 exist, but a glob that does not match any refs is silently
1419 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1420 environment variable, which must be a colon separated list of refs or
1423 The effective value of "core.notesRef" (possibly overridden by
1424 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1427 notes.rewrite.<command>::
1428 When rewriting commits with <command> (currently `amend` or
1429 `rebase`) and this variable is set to `true`, git
1430 automatically copies your notes from the original to the
1431 rewritten commit. Defaults to `true`, but see
1432 "notes.rewriteRef" below.
1435 When copying notes during a rewrite (see the
1436 "notes.rewrite.<command>" option), determines what to do if
1437 the target commit already has a note. Must be one of
1438 `overwrite`, `concatenate`, or `ignore`. Defaults to
1441 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1442 environment variable.
1445 When copying notes during a rewrite, specifies the (fully
1446 qualified) ref whose notes should be copied. The ref may be a
1447 glob, in which case notes in all matching refs will be copied.
1448 You may also specify this configuration several times.
1450 Does not have a default value; you must configure this variable to
1451 enable note rewriting.
1453 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1454 environment variable, which must be a colon separated list of refs or
1458 The size of the window used by linkgit:git-pack-objects[1] when no
1459 window size is given on the command line. Defaults to 10.
1462 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1463 maximum depth is given on the command line. Defaults to 50.
1466 The window memory size limit used by linkgit:git-pack-objects[1]
1467 when no limit is given on the command line. The value can be
1468 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1472 An integer -1..9, indicating the compression level for objects
1473 in a pack file. -1 is the zlib default. 0 means no
1474 compression, and 1..9 are various speed/size tradeoffs, 9 being
1475 slowest. If not set, defaults to core.compression. If that is
1476 not set, defaults to -1, the zlib default, which is "a default
1477 compromise between speed and compression (currently equivalent
1480 Note that changing the compression level will not automatically recompress
1481 all existing objects. You can force recompression by passing the -F option
1482 to linkgit:git-repack[1].
1484 pack.deltaCacheSize::
1485 The maximum memory in bytes used for caching deltas in
1486 linkgit:git-pack-objects[1] before writing them out to a pack.
1487 This cache is used to speed up the writing object phase by not
1488 having to recompute the final delta result once the best match
1489 for all objects is found. Repacking large repositories on machines
1490 which are tight with memory might be badly impacted by this though,
1491 especially if this cache pushes the system into swapping.
1492 A value of 0 means no limit. The smallest size of 1 byte may be
1493 used to virtually disable this cache. Defaults to 256 MiB.
1495 pack.deltaCacheLimit::
1496 The maximum size of a delta, that is cached in
1497 linkgit:git-pack-objects[1]. This cache is used to speed up the
1498 writing object phase by not having to recompute the final delta
1499 result once the best match for all objects is found. Defaults to 1000.
1502 Specifies the number of threads to spawn when searching for best
1503 delta matches. This requires that linkgit:git-pack-objects[1]
1504 be compiled with pthreads otherwise this option is ignored with a
1505 warning. This is meant to reduce packing time on multiprocessor
1506 machines. The required amount of memory for the delta search window
1507 is however multiplied by the number of threads.
1508 Specifying 0 will cause git to auto-detect the number of CPU's
1509 and set the number of threads accordingly.
1512 Specify the default pack index version. Valid values are 1 for
1513 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1514 the new pack index with capabilities for packs larger than 4 GB
1515 as well as proper protection against the repacking of corrupted
1516 packs. Version 2 is the default. Note that version 2 is enforced
1517 and this config option ignored whenever the corresponding pack is
1520 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1521 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1522 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1523 other side may give you a repository that cannot be accessed with your
1524 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1525 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1526 the `{asterisk}.idx` file.
1528 pack.packSizeLimit::
1529 The maximum size of a pack. This setting only affects
1530 packing to a file when repacking, i.e. the git:// protocol
1531 is unaffected. It can be overridden by the `\--max-pack-size`
1532 option of linkgit:git-repack[1]. The minimum size allowed is
1533 limited to 1 MiB. The default is unlimited.
1534 Common unit suffixes of 'k', 'm', or 'g' are
1538 Allows turning on or off pagination of the output of a
1539 particular git subcommand when writing to a tty. If
1540 `\--paginate` or `\--no-pager` is specified on the command line,
1541 it takes precedence over this option. To disable pagination for
1542 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1545 Alias for a --pretty= format string, as specified in
1546 linkgit:git-log[1]. Any aliases defined here can be used just
1547 as the built-in pretty formats could. For example,
1548 running `git config pretty.changelog "format:{asterisk} %H %s"`
1549 would cause the invocation `git log --pretty=changelog`
1550 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1551 Note that an alias with the same name as a built-in format
1552 will be silently ignored.
1555 The default merge strategy to use when pulling multiple branches
1559 The default merge strategy to use when pulling a single branch.
1562 Defines the action git push should take if no refspec is given
1563 on the command line, no refspec is configured in the remote, and
1564 no refspec is implied by any of the options given on the command
1565 line. Possible values are:
1567 * `nothing` - do not push anything.
1568 * `matching` - push all matching branches.
1569 All branches having the same name in both ends are considered to be
1570 matching. This is the default.
1571 * `tracking` - push the current branch to its upstream branch.
1572 * `current` - push the current branch to a branch of the same name.
1575 Whether to show a diffstat of what changed upstream since the last
1576 rebase. False by default.
1579 If set to true enable '--autosquash' option by default.
1582 By default, git-receive-pack will run "git-gc --auto" after
1583 receiving data from git-push and updating refs. You can stop
1584 it by setting this variable to false.
1586 receive.fsckObjects::
1587 If it is set to true, git-receive-pack will check all received
1588 objects. It will abort in the case of a malformed object or a
1589 broken link. The result of an abort are only dangling objects.
1592 receive.unpackLimit::
1593 If the number of objects received in a push is below this
1594 limit then the objects will be unpacked into loose object
1595 files. However if the number of received objects equals or
1596 exceeds this limit then the received pack will be stored as
1597 a pack, after adding any missing delta bases. Storing the
1598 pack from a push can make the push operation complete faster,
1599 especially on slow filesystems. If not set, the value of
1600 `transfer.unpackLimit` is used instead.
1602 receive.denyDeletes::
1603 If set to true, git-receive-pack will deny a ref update that deletes
1604 the ref. Use this to prevent such a ref deletion via a push.
1606 receive.denyDeleteCurrent::
1607 If set to true, git-receive-pack will deny a ref update that
1608 deletes the currently checked out branch of a non-bare repository.
1610 receive.denyCurrentBranch::
1611 If set to true or "refuse", git-receive-pack will deny a ref update
1612 to the currently checked out branch of a non-bare repository.
1613 Such a push is potentially dangerous because it brings the HEAD
1614 out of sync with the index and working tree. If set to "warn",
1615 print a warning of such a push to stderr, but allow the push to
1616 proceed. If set to false or "ignore", allow such pushes with no
1617 message. Defaults to "refuse".
1619 receive.denyNonFastForwards::
1620 If set to true, git-receive-pack will deny a ref update which is
1621 not a fast-forward. Use this to prevent such an update via a push,
1622 even if that push is forced. This configuration variable is
1623 set when initializing a shared repository.
1625 receive.updateserverinfo::
1626 If set to true, git-receive-pack will run git-update-server-info
1627 after receiving data from git-push and updating refs.
1630 The URL of a remote repository. See linkgit:git-fetch[1] or
1631 linkgit:git-push[1].
1633 remote.<name>.pushurl::
1634 The push URL of a remote repository. See linkgit:git-push[1].
1636 remote.<name>.proxy::
1637 For remotes that require curl (http, https and ftp), the URL to
1638 the proxy to use for that remote. Set to the empty string to
1639 disable proxying for that remote.
1641 remote.<name>.fetch::
1642 The default set of "refspec" for linkgit:git-fetch[1]. See
1643 linkgit:git-fetch[1].
1645 remote.<name>.push::
1646 The default set of "refspec" for linkgit:git-push[1]. See
1647 linkgit:git-push[1].
1649 remote.<name>.mirror::
1650 If true, pushing to this remote will automatically behave
1651 as if the `\--mirror` option was given on the command line.
1653 remote.<name>.skipDefaultUpdate::
1654 If true, this remote will be skipped by default when updating
1655 using linkgit:git-fetch[1] or the `update` subcommand of
1656 linkgit:git-remote[1].
1658 remote.<name>.skipFetchAll::
1659 If true, this remote will be skipped by default when updating
1660 using linkgit:git-fetch[1] or the `update` subcommand of
1661 linkgit:git-remote[1].
1663 remote.<name>.receivepack::
1664 The default program to execute on the remote side when pushing. See
1665 option \--receive-pack of linkgit:git-push[1].
1667 remote.<name>.uploadpack::
1668 The default program to execute on the remote side when fetching. See
1669 option \--upload-pack of linkgit:git-fetch-pack[1].
1671 remote.<name>.tagopt::
1672 Setting this value to \--no-tags disables automatic tag following when
1673 fetching from remote <name>. Setting it to \--tags will fetch every
1674 tag from remote <name>, even if they are not reachable from remote
1675 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1676 override this setting. See options \--tags and \--no-tags of
1677 linkgit:git-fetch[1].
1680 Setting this to a value <vcs> will cause git to interact with
1681 the remote with the git-remote-<vcs> helper.
1684 The list of remotes which are fetched by "git remote update
1685 <group>". See linkgit:git-remote[1].
1687 repack.usedeltabaseoffset::
1688 By default, linkgit:git-repack[1] creates packs that use
1689 delta-base offset. If you need to share your repository with
1690 git older than version 1.4.4, either directly or via a dumb
1691 protocol such as http, then you need to set this option to
1692 "false" and repack. Access from old git versions over the
1693 native protocol are unaffected by this option.
1696 When set to true, `git-rerere` updates the index with the
1697 resulting contents after it cleanly resolves conflicts using
1698 previously recorded resolution. Defaults to false.
1701 Activate recording of resolved conflicts, so that identical
1702 conflict hunks can be resolved automatically, should they
1703 be encountered again. linkgit:git-rerere[1] command is by
1704 default enabled if you create `rr-cache` directory under
1705 `$GIT_DIR`, but can be disabled by setting this option to false.
1707 sendemail.identity::
1708 A configuration identity. When given, causes values in the
1709 'sendemail.<identity>' subsection to take precedence over
1710 values in the 'sendemail' section. The default identity is
1711 the value of 'sendemail.identity'.
1713 sendemail.smtpencryption::
1714 See linkgit:git-send-email[1] for description. Note that this
1715 setting is not subject to the 'identity' mechanism.
1718 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1720 sendemail.<identity>.*::
1721 Identity-specific versions of the 'sendemail.*' parameters
1722 found below, taking precedence over those when the this
1723 identity is selected, through command-line or
1724 'sendemail.identity'.
1726 sendemail.aliasesfile::
1727 sendemail.aliasfiletype::
1731 sendemail.chainreplyto::
1733 sendemail.envelopesender::
1735 sendemail.multiedit::
1736 sendemail.signedoffbycc::
1737 sendemail.smtppass::
1738 sendemail.suppresscc::
1739 sendemail.suppressfrom::
1741 sendemail.smtpdomain::
1742 sendemail.smtpserver::
1743 sendemail.smtpserverport::
1744 sendemail.smtpserveroption::
1745 sendemail.smtpuser::
1747 sendemail.validate::
1748 See linkgit:git-send-email[1] for description.
1750 sendemail.signedoffcc::
1751 Deprecated alias for 'sendemail.signedoffbycc'.
1753 showbranch.default::
1754 The default set of branches for linkgit:git-show-branch[1].
1755 See linkgit:git-show-branch[1].
1757 status.relativePaths::
1758 By default, linkgit:git-status[1] shows paths relative to the
1759 current directory. Setting this variable to `false` shows paths
1760 relative to the repository root (this was the default for git
1763 status.showUntrackedFiles::
1764 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1765 files which are not currently tracked by Git. Directories which
1766 contain only untracked files, are shown with the directory name
1767 only. Showing untracked files means that Git needs to lstat() all
1768 all the files in the whole repository, which might be slow on some
1769 systems. So, this variable controls how the commands displays
1770 the untracked files. Possible values are:
1773 * `no` - Show no untracked files.
1774 * `normal` - Show untracked files and directories.
1775 * `all` - Show also individual files in untracked directories.
1778 If this variable is not specified, it defaults to 'normal'.
1779 This variable can be overridden with the -u|--untracked-files option
1780 of linkgit:git-status[1] and linkgit:git-commit[1].
1782 status.submodulesummary::
1784 If this is set to a non zero number or true (identical to -1 or an
1785 unlimited number), the submodule summary will be enabled and a
1786 summary of commits for modified submodules will be shown (see
1787 --summary-limit option of linkgit:git-submodule[1]).
1789 submodule.<name>.path::
1790 submodule.<name>.url::
1791 submodule.<name>.update::
1792 The path within this project, URL, and the updating strategy
1793 for a submodule. These variables are initially populated
1794 by 'git submodule init'; edit them to override the
1795 URL and other values found in the `.gitmodules` file. See
1796 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1798 submodule.<name>.ignore::
1799 Defines under what circumstances "git status" and the diff family show
1800 a submodule as modified. When set to "all", it will never be considered
1801 modified, "dirty" will ignore all changes to the submodules work tree and
1802 takes only differences between the HEAD of the submodule and the commit
1803 recorded in the superproject into account. "untracked" will additionally
1804 let submodules with modified tracked files in their work tree show up.
1805 Using "none" (the default when this option is not set) also shows
1806 submodules that have untracked files in their work tree as changed.
1807 This setting overrides any setting made in .gitmodules for this submodule,
1808 both settings can be overridden on the command line by using the
1809 "--ignore-submodules" option.
1812 This variable can be used to restrict the permission bits of
1813 tar archive entries. The default is 0002, which turns off the
1814 world write bit. The special value "user" indicates that the
1815 archiving user's umask will be used instead. See umask(2) and
1816 linkgit:git-archive[1].
1818 transfer.unpackLimit::
1819 When `fetch.unpackLimit` or `receive.unpackLimit` are
1820 not set, the value of this variable is used instead.
1821 The default value is 100.
1823 url.<base>.insteadOf::
1824 Any URL that starts with this value will be rewritten to
1825 start, instead, with <base>. In cases where some site serves a
1826 large number of repositories, and serves them with multiple
1827 access methods, and some users need to use different access
1828 methods, this feature allows people to specify any of the
1829 equivalent URLs and have git automatically rewrite the URL to
1830 the best alternative for the particular user, even for a
1831 never-before-seen repository on the site. When more than one
1832 insteadOf strings match a given URL, the longest match is used.
1834 url.<base>.pushInsteadOf::
1835 Any URL that starts with this value will not be pushed to;
1836 instead, it will be rewritten to start with <base>, and the
1837 resulting URL will be pushed to. In cases where some site serves
1838 a large number of repositories, and serves them with multiple
1839 access methods, some of which do not allow push, this feature
1840 allows people to specify a pull-only URL and have git
1841 automatically use an appropriate URL to push, even for a
1842 never-before-seen repository on the site. When more than one
1843 pushInsteadOf strings match a given URL, the longest match is
1844 used. If a remote has an explicit pushurl, git will ignore this
1845 setting for that remote.
1848 Your email address to be recorded in any newly created commits.
1849 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1850 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1853 Your full name to be recorded in any newly created commits.
1854 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1855 environment variables. See linkgit:git-commit-tree[1].
1858 If linkgit:git-tag[1] is not selecting the key you want it to
1859 automatically when creating a signed tag, you can override the
1860 default selection with this variable. This option is passed
1861 unchanged to gpg's --local-user parameter, so you may specify a key
1862 using any method that gpg supports.
1865 Specify a web browser that may be used by some commands.
1866 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]