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 overwritting 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.
144 If false, the executable bit differences between the index and
145 the working copy are ignored; useful on broken filesystems like FAT.
146 See linkgit:git-update-index[1].
148 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
149 will probe and set core.fileMode false if appropriate when the
150 repository is created.
152 core.ignoreCygwinFSTricks::
153 This option is only used by Cygwin implementation of Git. If false,
154 the Cygwin stat() and lstat() functions are used. This may be useful
155 if your repository consists of a few separate directories joined in
156 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
157 whenever it is possible and falls back to Cygwin functions only to
158 handle symbol links. The native mode is more than twice faster than
159 normal Cygwin l/stat() functions. True by default, unless core.filemode
160 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
161 POSIX emulation is required to support core.filemode.
164 If true, this option enables various workarounds to enable
165 git to work better on filesystems that are not case sensitive,
166 like FAT. For example, if a directory listing finds
167 "makefile" when git expects "Makefile", git will assume
168 it is really the same file, and continue to remember it as
171 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
172 will probe and set core.ignorecase true if appropriate when the repository
176 If false, the ctime differences between the index and the
177 working copy are ignored; useful when the inode change time
178 is regularly modified by something outside Git (file system
179 crawlers and some backup systems).
180 See linkgit:git-update-index[1]. True by default.
183 The commands that output paths (e.g. 'ls-files',
184 'diff'), when not given the `-z` option, will quote
185 "unusual" characters in the pathname by enclosing the
186 pathname in a double-quote pair and with backslashes the
187 same way strings in C source code are quoted. If this
188 variable is set to false, the bytes higher than 0x80 are
189 not quoted but output as verbatim. Note that double
190 quote, backslash and control characters are always
191 quoted without `-z` regardless of the setting of this
195 If true, makes git convert `CRLF` at the end of lines in text files to
196 `LF` when reading from the filesystem, and convert in reverse when
197 writing to the filesystem. The variable can be set to
198 'input', in which case the conversion happens only while
199 reading from the filesystem but files are written out with
200 `LF` at the end of lines. A file is considered
201 "text" (i.e. be subjected to the autocrlf mechanism) based on
202 the file's `crlf` attribute, or if `crlf` is unspecified,
203 based on the file's contents. See linkgit:gitattributes[5].
206 If true, makes git check if converting `CRLF` as controlled by
207 `core.autocrlf` is reversible. Git will verify if a command
208 modifies a file in the work tree either directly or indirectly.
209 For example, committing a file followed by checking out the
210 same file should yield the original file in the work tree. If
211 this is not the case for the current setting of
212 `core.autocrlf`, git will reject the file. The variable can
213 be set to "warn", in which case git will only warn about an
214 irreversible conversion but continue the operation.
216 CRLF conversion bears a slight chance of corrupting data.
217 autocrlf=true will convert CRLF to LF during commit and LF to
218 CRLF during checkout. A file that contains a mixture of LF and
219 CRLF before the commit cannot be recreated by git. For text
220 files this is the right thing to do: it corrects line endings
221 such that we have only LF line endings in the repository.
222 But for binary files that are accidentally classified as text the
223 conversion can corrupt data.
225 If you recognize such corruption early you can easily fix it by
226 setting the conversion type explicitly in .gitattributes. Right
227 after committing you still have the original file in your work
228 tree and this file is not yet corrupted. You can explicitly tell
229 git that this file is binary and git will handle the file
232 Unfortunately, the desired effect of cleaning up text files with
233 mixed line endings and the undesired effect of corrupting binary
234 files cannot be distinguished. In both cases CRLFs are removed
235 in an irreversible way. For text files this is the right thing
236 to do because CRLFs are line endings, while for binary files
237 converting CRLFs corrupts data.
239 Note, this safety check does not mean that a checkout will generate a
240 file identical to the original file for a different setting of
241 `core.autocrlf`, but only for the current one. For example, a text
242 file with `LF` would be accepted with `core.autocrlf=input` and could
243 later be checked out with `core.autocrlf=true`, in which case the
244 resulting file would contain `CRLF`, although the original file
245 contained `LF`. However, in both work trees the line endings would be
246 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
247 file with mixed line endings would be reported by the `core.safecrlf`
251 If false, symbolic links are checked out as small plain files that
252 contain the link text. linkgit:git-update-index[1] and
253 linkgit:git-add[1] will not change the recorded type to regular
254 file. Useful on filesystems like FAT that do not support
257 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
258 will probe and set core.symlinks false if appropriate when the repository
262 A "proxy command" to execute (as 'command host port') instead
263 of establishing direct connection to the remote server when
264 using the git protocol for fetching. If the variable value is
265 in the "COMMAND for DOMAIN" format, the command is applied only
266 on hostnames ending with the specified domain string. This variable
267 may be set multiple times and is matched in the given order;
268 the first match wins.
270 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
271 (which always applies universally, without the special "for"
274 The special string `none` can be used as the proxy command to
275 specify that no proxy be used for a given domain pattern.
276 This is useful for excluding servers inside a firewall from
277 proxy use, while defaulting to a common proxy for external domains.
280 If true, commands which modify both the working tree and the index
281 will mark the updated paths with the "assume unchanged" bit in the
282 index. These marked files are then assumed to stay unchanged in the
283 working copy, until you mark them otherwise manually - Git will not
284 detect the file changes by lstat() calls. This is useful on systems
285 where those are very slow, such as Microsoft Windows.
286 See linkgit:git-update-index[1].
289 core.preferSymlinkRefs::
290 Instead of the default "symref" format for HEAD
291 and other symbolic reference files, use symbolic links.
292 This is sometimes needed to work with old scripts that
293 expect HEAD to be a symbolic link.
296 If true this repository is assumed to be 'bare' and has no
297 working directory associated with it. If this is the case a
298 number of commands that require a working directory will be
299 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
301 This setting is automatically guessed by linkgit:git-clone[1] or
302 linkgit:git-init[1] when the repository was created. By default a
303 repository that ends in "/.git" is assumed to be not bare (bare =
304 false), while all other repositories are assumed to be bare (bare
308 Set the path to the root of the work tree.
309 This can be overridden by the GIT_WORK_TREE environment
310 variable and the '--work-tree' command line option. It can be
311 an absolute path or a relative path to the .git directory,
312 either specified by --git-dir or GIT_DIR, or automatically
314 If --git-dir or GIT_DIR are specified but none of
315 --work-tree, GIT_WORK_TREE and core.worktree is specified,
316 the current working directory is regarded as the root of the
319 Note that this variable is honored even when set in a configuration
320 file in a ".git" subdirectory of a directory, and its value differs
321 from the latter directory (e.g. "/path/to/.git/config" has
322 core.worktree set to "/different/path"), which is most likely a
323 misconfiguration. Running git commands in "/path/to" directory will
324 still use "/different/path" as the root of the work tree and can cause
325 great confusion to the users.
327 core.logAllRefUpdates::
328 Enable the reflog. Updates to a ref <ref> is logged to the file
329 "$GIT_DIR/logs/<ref>", by appending the new and old
330 SHA1, the date/time and the reason of the update, but
331 only when the file exists. If this configuration
332 variable is set to true, missing "$GIT_DIR/logs/<ref>"
333 file is automatically created for branch heads (i.e. under
334 refs/heads/), remote refs (i.e. under refs/remotes/),
335 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
337 This information can be used to determine what commit
338 was the tip of a branch "2 days ago".
340 This value is true by default in a repository that has
341 a working directory associated with it, and false by
342 default in a bare repository.
344 core.repositoryFormatVersion::
345 Internal variable identifying the repository format and layout
348 core.sharedRepository::
349 When 'group' (or 'true'), the repository is made shareable between
350 several users in a group (making sure all the files and objects are
351 group-writable). When 'all' (or 'world' or 'everybody'), the
352 repository will be readable by all users, additionally to being
353 group-shareable. When 'umask' (or 'false'), git will use permissions
354 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
355 files in the repository will have this mode value. '0xxx' will override
356 user's umask value (whereas the other options will only override
357 requested parts of the user's umask value). Examples: '0660' will make
358 the repo read/write-able for the owner and group, but inaccessible to
359 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
360 repository that is group-readable but not group-writable.
361 See linkgit:git-init[1]. False by default.
363 core.warnAmbiguousRefs::
364 If true, git will warn you if the ref name you passed it is ambiguous
365 and might match multiple refs in the .git/refs/ tree. True by default.
368 An integer -1..9, indicating a default compression level.
369 -1 is the zlib default. 0 means no compression,
370 and 1..9 are various speed/size tradeoffs, 9 being slowest.
371 If set, this provides a default to other compression variables,
372 such as 'core.loosecompression' and 'pack.compression'.
374 core.loosecompression::
375 An integer -1..9, indicating the compression level for objects that
376 are not in a pack file. -1 is the zlib default. 0 means no
377 compression, and 1..9 are various speed/size tradeoffs, 9 being
378 slowest. If not set, defaults to core.compression. If that is
379 not set, defaults to 1 (best speed).
381 core.packedGitWindowSize::
382 Number of bytes of a pack file to map into memory in a
383 single mapping operation. Larger window sizes may allow
384 your system to process a smaller number of large pack files
385 more quickly. Smaller window sizes will negatively affect
386 performance due to increased calls to the operating system's
387 memory manager, but may improve performance when accessing
388 a large number of large pack files.
390 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
391 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
392 be reasonable for all users/operating systems. You probably do
393 not need to adjust this value.
395 Common unit suffixes of 'k', 'm', or 'g' are supported.
397 core.packedGitLimit::
398 Maximum number of bytes to map simultaneously into memory
399 from pack files. If Git needs to access more than this many
400 bytes at once to complete an operation it will unmap existing
401 regions to reclaim virtual address space within the process.
403 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
404 This should be reasonable for all users/operating systems, except on
405 the largest projects. You probably do not need to adjust this value.
407 Common unit suffixes of 'k', 'm', or 'g' are supported.
409 core.deltaBaseCacheLimit::
410 Maximum number of bytes to reserve for caching base objects
411 that multiple deltafied objects reference. By storing the
412 entire decompressed base objects in a cache Git is able
413 to avoid unpacking and decompressing frequently used base
414 objects multiple times.
416 Default is 16 MiB on all platforms. This should be reasonable
417 for all users/operating systems, except on the largest projects.
418 You probably do not need to adjust this value.
420 Common unit suffixes of 'k', 'm', or 'g' are supported.
422 core.bigFileThreshold::
423 Files larger than this size are stored deflated, without
424 attempting delta compression. Storing large files without
425 delta compression avoids excessive memory usage, at the
426 slight expense of increased disk usage.
428 Default is 512 MiB on all platforms. This should be reasonable
429 for most projects as source code and other text files can still
430 be delta compressed, but larger binary media files won't be.
432 Common unit suffixes of 'k', 'm', or 'g' are supported.
434 Currently only linkgit:git-fast-import[1] honors this setting.
437 In addition to '.gitignore' (per-directory) and
438 '.git/info/exclude', git looks into this file for patterns
439 of files which are not meant to be tracked. "{tilde}/" is expanded
440 to the value of `$HOME` and "{tilde}user/" to the specified user's
441 home directory. See linkgit:gitignore[5].
444 Commands such as `commit` and `tag` that lets you edit
445 messages by launching an editor uses the value of this
446 variable when it is set, and the environment variable
447 `GIT_EDITOR` is not set. See linkgit:git-var[1].
450 The command that git will use to paginate output. Can
451 be overridden with the `GIT_PAGER` environment
452 variable. Note that git sets the `LESS` environment
453 variable to `FRSX` if it is unset when it runs the
454 pager. One can change these settings by setting the
455 `LESS` variable to some other value. Alternately,
456 these settings can be overridden on a project or
457 global basis by setting the `core.pager` option.
458 Setting `core.pager` has no affect on the `LESS`
459 environment variable behaviour above, so if you want
460 to override git's default settings this way, you need
461 to be explicit. For example, to disable the S option
462 in a backward compatible manner, set `core.pager`
463 to `less -+$LESS -FRX`. This will be passed to the
464 shell by git, which will translate the final command to
465 `LESS=FRSX less -+FRSX -FRX`.
468 A comma separated list of common whitespace problems to
469 notice. 'git diff' will use `color.diff.whitespace` to
470 highlight them, and 'git apply --whitespace=error' will
471 consider them as errors. You can prefix `-` to disable
472 any of them (e.g. `-trailing-space`):
474 * `blank-at-eol` treats trailing whitespaces at the end of the line
475 as an error (enabled by default).
476 * `space-before-tab` treats a space character that appears immediately
477 before a tab character in the initial indent part of the line as an
478 error (enabled by default).
479 * `indent-with-non-tab` treats a line that is indented with 8 or more
480 space characters as an error (not enabled by default).
481 * `blank-at-eof` treats blank lines added at the end of file as an error
482 (enabled by default).
483 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
485 * `cr-at-eol` treats a carriage-return at the end of line as
486 part of the line terminator, i.e. with it, `trailing-space`
487 does not trigger if the character before such a carriage-return
488 is not a whitespace (not enabled by default).
490 core.fsyncobjectfiles::
491 This boolean will enable 'fsync()' when writing object files.
493 This is a total waste of time and effort on a filesystem that orders
494 data writes properly, but can be useful for filesystems that do not use
495 journalling (traditional UNIX filesystems) or that only journal metadata
496 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
499 Enable parallel index preload for operations like 'git diff'
501 This can speed up operations like 'git diff' and 'git status' especially
502 on filesystems like NFS that have weak caching semantics and thus
503 relatively high IO latencies. With this set to 'true', git will do the
504 index comparison to the filesystem data in parallel, allowing
508 You can set this to 'link', in which case a hardlink followed by
509 a delete of the source are used to make sure that object creation
510 will not overwrite existing objects.
512 On some file system/operating system combinations, this is unreliable.
513 Set this config setting to 'rename' there; However, This will remove the
514 check that makes sure that existing object files will not get overwritten.
517 When showing commit messages, also show notes which are stored in
518 the given ref. This ref is expected to contain files named
519 after the full SHA-1 of the commit they annotate.
521 If such a file exists in the given ref, the referenced blob is read, and
522 appended to the commit message, separated by a "Notes:" line. If the
523 given ref itself does not exist, it is not an error, but means that no
524 notes should be printed.
526 This setting defaults to "refs/notes/commits", and can be overridden by
527 the `GIT_NOTES_REF` environment variable.
529 core.sparseCheckout::
530 Enable "sparse checkout" feature. See section "Sparse checkout" in
531 linkgit:git-read-tree[1] for more information.
534 Tells 'git add' to continue adding files when some files cannot be
535 added due to indexing errors. Equivalent to the '--ignore-errors'
536 option of linkgit:git-add[1].
539 Command aliases for the linkgit:git[1] command wrapper - e.g.
540 after defining "alias.last = cat-file commit HEAD", the invocation
541 "git last" is equivalent to "git cat-file commit HEAD". To avoid
542 confusion and troubles with script usage, aliases that
543 hide existing git commands are ignored. Arguments are split by
544 spaces, the usual shell quoting and escaping is supported.
545 quote pair and a backslash can be used to quote them.
547 If the alias expansion is prefixed with an exclamation point,
548 it will be treated as a shell command. For example, defining
549 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
550 "git new" is equivalent to running the shell command
551 "gitk --all --not ORIG_HEAD". Note that shell commands will be
552 executed from the top-level directory of a repository, which may
553 not necessarily be the current directory.
555 apply.ignorewhitespace::
556 When set to 'change', tells 'git apply' to ignore changes in
557 whitespace, in the same way as the '--ignore-space-change'
559 When set to one of: no, none, never, false tells 'git apply' to
560 respect all whitespace differences.
561 See linkgit:git-apply[1].
564 Tells 'git apply' how to handle whitespaces, in the same way
565 as the '--whitespace' option. See linkgit:git-apply[1].
567 branch.autosetupmerge::
568 Tells 'git branch' and 'git checkout' to set up new branches
569 so that linkgit:git-pull[1] will appropriately merge from the
570 starting point branch. Note that even if this option is not set,
571 this behavior can be chosen per-branch using the `--track`
572 and `--no-track` options. The valid settings are: `false` -- no
573 automatic setup is done; `true` -- automatic setup is done when the
574 starting point is a remote branch; `always` -- automatic setup is
575 done when the starting point is either a local branch or remote
576 branch. This option defaults to true.
578 branch.autosetuprebase::
579 When a new branch is created with 'git branch' or 'git checkout'
580 that tracks another branch, this variable tells git to set
581 up pull to rebase instead of merge (see "branch.<name>.rebase").
582 When `never`, rebase is never automatically set to true.
583 When `local`, rebase is set to true for tracked branches of
584 other local branches.
585 When `remote`, rebase is set to true for tracked branches of
587 When `always`, rebase will be set to true for all tracking
589 See "branch.autosetupmerge" for details on how to set up a
590 branch to track another branch.
591 This option defaults to never.
593 branch.<name>.remote::
594 When in branch <name>, it tells 'git fetch' and 'git push' which
595 remote to fetch from/push to. It defaults to `origin` if no remote is
596 configured. `origin` is also used if you are not on any branch.
598 branch.<name>.merge::
599 Defines, together with branch.<name>.remote, the upstream branch
600 for the given branch. It tells 'git fetch'/'git pull' which
601 branch to merge and can also affect 'git push' (see push.default).
602 When in branch <name>, it tells 'git fetch' the default
603 refspec to be marked for merging in FETCH_HEAD. The value is
604 handled like the remote part of a refspec, and must match a
605 ref which is fetched from the remote given by
606 "branch.<name>.remote".
607 The merge information is used by 'git pull' (which at first calls
608 'git fetch') to lookup the default branch for merging. Without
609 this option, 'git pull' defaults to merge the first refspec fetched.
610 Specify multiple values to get an octopus merge.
611 If you wish to setup 'git pull' so that it merges into <name> from
612 another branch in the local repository, you can point
613 branch.<name>.merge to the desired branch, and use the special setting
614 `.` (a period) for branch.<name>.remote.
616 branch.<name>.mergeoptions::
617 Sets default options for merging into branch <name>. The syntax and
618 supported options are the same as those of linkgit:git-merge[1], but
619 option values containing whitespace characters are currently not
622 branch.<name>.rebase::
623 When true, rebase the branch <name> on top of the fetched branch,
624 instead of merging the default branch from the default remote when
626 *NOTE*: this is a possibly dangerous operation; do *not* use
627 it unless you understand the implications (see linkgit:git-rebase[1]
631 Specify the command to invoke the specified browser. The
632 specified command is evaluated in shell with the URLs passed
633 as arguments. (See linkgit:git-web--browse[1].)
635 browser.<tool>.path::
636 Override the path for the given tool that may be used to
637 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
638 working repository in gitweb (see linkgit:git-instaweb[1]).
641 A boolean to make git-clean do nothing unless given -f
642 or -n. Defaults to true.
645 A boolean to enable/disable color in the output of
646 linkgit:git-branch[1]. May be set to `always`,
647 `false` (or `never`) or `auto` (or `true`), in which case colors are used
648 only when the output is to a terminal. Defaults to false.
650 color.branch.<slot>::
651 Use customized color for branch coloration. `<slot>` is one of
652 `current` (the current branch), `local` (a local branch),
653 `remote` (a tracking branch in refs/remotes/), `plain` (other
656 The value for these configuration variables is a list of colors (at most
657 two) and attributes (at most one), separated by spaces. The colors
658 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
659 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
660 `blink` and `reverse`. The first color given is the foreground; the
661 second is the background. The position of the attribute, if any,
665 When set to `always`, always use colors in patch.
666 When false (or `never`), never. When set to `true` or `auto`, use
667 colors only when the output is to the terminal. Defaults to false.
670 Use customized color for diff colorization. `<slot>` specifies
671 which part of the patch to use the specified color, and is one
672 of `plain` (context text), `meta` (metainformation), `frag`
673 (hunk header), 'func' (function in hunk header), `old` (removed lines),
674 `new` (added lines), `commit` (commit headers), or `whitespace`
675 (highlighting whitespace errors). The values of these variables may be
676 specified as in color.branch.<slot>.
679 When set to `always`, always highlight matches. When `false` (or
680 `never`), never. When set to `true` or `auto`, use color only
681 when the output is written to the terminal. Defaults to `false`.
684 Use customized color for matches. The value of this variable
685 may be specified as in color.branch.<slot>. It is passed using
686 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
687 calling an external 'grep'.
690 When set to `always`, always use colors for interactive prompts
691 and displays (such as those used by "git-add --interactive").
692 When false (or `never`), never. When set to `true` or `auto`, use
693 colors only when the output is to the terminal. Defaults to false.
695 color.interactive.<slot>::
696 Use customized color for 'git add --interactive'
697 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
698 four distinct types of normal output from interactive
699 commands. The values of these variables may be specified as
700 in color.branch.<slot>.
703 A boolean to enable/disable colored output when the pager is in
704 use (default is true).
707 A boolean to enable/disable color in the output of
708 linkgit:git-show-branch[1]. May be set to `always`,
709 `false` (or `never`) or `auto` (or `true`), in which case colors are used
710 only when the output is to a terminal. Defaults to false.
713 A boolean to enable/disable color in the output of
714 linkgit:git-status[1]. May be set to `always`,
715 `false` (or `never`) or `auto` (or `true`), in which case colors are used
716 only when the output is to a terminal. Defaults to false.
718 color.status.<slot>::
719 Use customized color for status colorization. `<slot>` is
720 one of `header` (the header text of the status message),
721 `added` or `updated` (files which are added but not committed),
722 `changed` (files which are changed but not added in the index),
723 `untracked` (files which are not tracked by git), or
724 `nobranch` (the color the 'no branch' warning is shown in, defaulting
725 to red). The values of these variables may be specified as in
729 When set to `always`, always use colors in all git commands which
730 are capable of colored output. When false (or `never`), never. When
731 set to `true` or `auto`, use colors only when the output is to the
732 terminal. When more specific variables of color.* are set, they always
733 take precedence over this setting. Defaults to false.
736 A boolean to enable/disable inclusion of status information in the
737 commit message template when using an editor to prepare the commit
738 message. Defaults to true.
741 Specify a file to use as the template for new commit messages.
742 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
743 specified user's home directory.
745 diff.autorefreshindex::
746 When using 'git diff' to compare with work tree
747 files, do not consider stat-only change as changed.
748 Instead, silently run `git update-index --refresh` to
749 update the cached stat information for paths whose
750 contents in the work tree match the contents in the
751 index. This option defaults to true. Note that this
752 affects only 'git diff' Porcelain, and not lower level
753 'diff' commands such as 'git diff-files'.
756 If this config variable is set, diff generation is not
757 performed using the internal diff machinery, but using the
758 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
759 environment variable. The command is called with parameters
760 as described under "git Diffs" in linkgit:git[1]. Note: if
761 you want to use an external diff program only on a subset of
762 your files, you might want to use linkgit:gitattributes[5] instead.
764 diff.mnemonicprefix::
765 If set, 'git diff' uses a prefix pair that is different from the
766 standard "a/" and "b/" depending on what is being compared. When
767 this configuration is in effect, reverse diff output also swaps
768 the order of the prefixes:
770 compares the (i)ndex and the (w)ork tree;
772 compares a (c)ommit and the (w)ork tree;
773 `git diff --cached`;;
774 compares a (c)ommit and the (i)ndex;
775 `git diff HEAD:file1 file2`;;
776 compares an (o)bject and a (w)ork tree entity;
777 `git diff --no-index a b`;;
778 compares two non-git things (1) and (2).
781 The number of files to consider when performing the copy/rename
782 detection; equivalent to the 'git diff' option '-l'.
785 Tells git to detect renames. If set to any boolean value, it
786 will enable basic rename detection. If set to "copies" or
787 "copy", it will detect copies, as well.
789 diff.suppressBlankEmpty::
790 A boolean to inhibit the standard behavior of printing a space
791 before each empty output line. Defaults to false.
794 Controls which diff tool is used. `diff.tool` overrides
795 `merge.tool` when used by linkgit:git-difftool[1] and has
796 the same valid values as `merge.tool` minus "tortoisemerge"
799 difftool.<tool>.path::
800 Override the path for the given tool. This is useful in case
801 your tool is not in the PATH.
803 difftool.<tool>.cmd::
804 Specify the command to invoke the specified diff tool.
805 The specified command is evaluated in shell with the following
806 variables available: 'LOCAL' is set to the name of the temporary
807 file containing the contents of the diff pre-image and 'REMOTE'
808 is set to the name of the temporary file containing the contents
809 of the diff post-image.
812 Prompt before each invocation of the diff tool.
815 A POSIX Extended Regular Expression used to determine what is a "word"
816 when performing word-by-word difference calculations. Character
817 sequences that match the regular expression are "words", all other
818 characters are *ignorable* whitespace.
821 If the number of objects fetched over the git native
822 transfer is below this
823 limit, then the objects will be unpacked into loose object
824 files. However if the number of received objects equals or
825 exceeds this limit then the received pack will be stored as
826 a pack, after adding any missing delta bases. Storing the
827 pack from a push can make the push operation complete faster,
828 especially on slow filesystems. If not set, the value of
829 `transfer.unpackLimit` is used instead.
832 Enable multipart/mixed attachments as the default for
833 'format-patch'. The value can also be a double quoted string
834 which will enable attachments as the default and set the
835 value as the boundary. See the --attach option in
836 linkgit:git-format-patch[1].
839 A boolean which can enable or disable sequence numbers in patch
840 subjects. It defaults to "auto" which enables it only if there
841 is more than one patch. It can be enabled or disabled for all
842 messages by setting it to "true" or "false". See --numbered
843 option in linkgit:git-format-patch[1].
846 Additional email headers to include in a patch to be submitted
847 by mail. See linkgit:git-format-patch[1].
850 Additional "Cc:" headers to include in a patch to be submitted
851 by mail. See the --cc option in linkgit:git-format-patch[1].
853 format.subjectprefix::
854 The default for format-patch is to output files with the '[PATCH]'
855 subject prefix. Use this variable to change that prefix.
858 The default for format-patch is to output files with the suffix
859 `.patch`. Use this variable to change that suffix (make sure to
860 include the dot if you want it).
863 The default pretty format for log/show/whatchanged command,
864 See linkgit:git-log[1], linkgit:git-show[1],
865 linkgit:git-whatchanged[1].
868 The default threading style for 'git format-patch'. Can be
869 a boolean value, or `shallow` or `deep`. `shallow` threading
870 makes every mail a reply to the head of the series,
871 where the head is chosen from the cover letter, the
872 `\--in-reply-to`, and the first patch mail, in this order.
873 `deep` threading makes every mail a reply to the previous one.
874 A true boolean value is the same as `shallow`, and a false
875 value disables threading.
878 A boolean value which lets you enable the `-s/--signoff` option of
879 format-patch by default. *Note:* Adding the Signed-off-by: line to a
880 patch should be a conscious act and means that you certify you have
881 the rights to submit this work under the same open source license.
882 Please see the 'SubmittingPatches' document for further discussion.
884 gc.aggressiveWindow::
885 The window size parameter used in the delta compression
886 algorithm used by 'git gc --aggressive'. This defaults
890 When there are approximately more than this many loose
891 objects in the repository, `git gc --auto` will pack them.
892 Some Porcelain commands use this command to perform a
893 light-weight garbage collection from time to time. The
894 default value is 6700. Setting this to 0 disables it.
897 When there are more than this many packs that are not
898 marked with `*.keep` file in the repository, `git gc
899 --auto` consolidates them into one larger pack. The
900 default value is 50. Setting this to 0 disables it.
903 Running `git pack-refs` in a repository renders it
904 unclonable by Git versions prior to 1.5.1.2 over dumb
905 transports such as HTTP. This variable determines whether
906 'git gc' runs `git pack-refs`. This can be set to `nobare`
907 to enable it within all non-bare repos or it can be set to a
908 boolean value. The default is `true`.
911 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
912 Override the grace period with this config variable. The value
913 "now" may be used to disable this grace period and always prune
914 unreachable objects immediately.
917 'git reflog expire' removes reflog entries older than
918 this time; defaults to 90 days.
920 gc.reflogexpireunreachable::
921 'git reflog expire' removes reflog entries older than
922 this time and are not reachable from the current tip;
926 Records of conflicted merge you resolved earlier are
927 kept for this many days when 'git rerere gc' is run.
928 The default is 60 days. See linkgit:git-rerere[1].
930 gc.rerereunresolved::
931 Records of conflicted merge you have not resolved are
932 kept for this many days when 'git rerere gc' is run.
933 The default is 15 days. See linkgit:git-rerere[1].
935 gitcvs.commitmsgannotation::
936 Append this string to each commit message. Set to empty string
937 to disable this feature. Defaults to "via git-CVS emulator".
940 Whether the CVS server interface is enabled for this repository.
941 See linkgit:git-cvsserver[1].
944 Path to a log file where the CVS server interface well... logs
945 various stuff. See linkgit:git-cvsserver[1].
948 If true, the server will look up the `crlf` attribute for
949 files to determine the '-k' modes to use. If `crlf` is set,
950 the '-k' mode will be left blank, so cvs clients will
951 treat it as text. If `crlf` is explicitly unset, the file
952 will be set with '-kb' mode, which suppresses any newline munging
953 the client might otherwise do. If `crlf` is not specified,
954 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
957 This is used if 'gitcvs.usecrlfattr' does not resolve
958 the correct '-kb' mode to use. If true, all
959 unresolved files are sent to the client in
960 mode '-kb'. This causes the client to treat them
961 as binary files, which suppresses any newline munging it
962 otherwise might do. Alternatively, if it is set to "guess",
963 then the contents of the file are examined to decide if
964 it is binary, similar to 'core.autocrlf'.
967 Database used by git-cvsserver to cache revision information
968 derived from the git repository. The exact meaning depends on the
969 used database driver, for SQLite (which is the default driver) this
970 is a filename. Supports variable substitution (see
971 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
972 Default: '%Ggitcvs.%m.sqlite'
975 Used Perl DBI driver. You can specify any available driver
976 for this here, but it might not work. git-cvsserver is tested
977 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
978 reported *not* to work with 'DBD::mysql'. Experimental feature.
979 May not contain double colons (`:`). Default: 'SQLite'.
980 See linkgit:git-cvsserver[1].
982 gitcvs.dbuser, gitcvs.dbpass::
983 Database user and password. Only useful if setting 'gitcvs.dbdriver',
984 since SQLite has no concept of database users and/or passwords.
985 'gitcvs.dbuser' supports variable substitution (see
986 linkgit:git-cvsserver[1] for details).
988 gitcvs.dbTableNamePrefix::
989 Database table name prefix. Prepended to the names of any
990 database tables used, allowing a single database to be used
991 for several repositories. Supports variable substitution (see
992 linkgit:git-cvsserver[1] for details). Any non-alphabetic
993 characters will be replaced with underscores.
995 All gitcvs variables except for 'gitcvs.usecrlfattr' and
996 'gitcvs.allbinary' can also be specified as
997 'gitcvs.<access_method>.<varname>' (where 'access_method'
998 is one of "ext" and "pserver") to make them apply only for the given
1001 gui.commitmsgwidth::
1002 Defines how wide the commit message window is in the
1003 linkgit:git-gui[1]. "75" is the default.
1006 Specifies how many context lines should be used in calls to diff
1007 made by the linkgit:git-gui[1]. The default is "5".
1010 Specifies the default encoding to use for displaying of
1011 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1012 It can be overridden by setting the 'encoding' attribute
1013 for relevant files (see linkgit:gitattributes[5]).
1014 If this option is not set, the tools default to the
1017 gui.matchtrackingbranch::
1018 Determines if new branches created with linkgit:git-gui[1] should
1019 default to tracking remote branches with matching names or
1020 not. Default: "false".
1022 gui.newbranchtemplate::
1023 Is used as suggested name when creating new branches using the
1026 gui.pruneduringfetch::
1027 "true" if linkgit:git-gui[1] should prune tracking branches when
1028 performing a fetch. The default value is "false".
1031 Determines if linkgit:git-gui[1] should trust the file modification
1032 timestamp or not. By default the timestamps are not trusted.
1034 gui.spellingdictionary::
1035 Specifies the dictionary used for spell checking commit messages in
1036 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1040 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1041 location detection. It makes blame significantly faster on huge
1042 repositories at the expense of less thorough copy detection.
1044 gui.copyblamethreshold::
1045 Specifies the threshold to use in 'git gui blame' original location
1046 detection, measured in alphanumeric characters. See the
1047 linkgit:git-blame[1] manual for more information on copy detection.
1049 gui.blamehistoryctx::
1050 Specifies the radius of history context in days to show in
1051 linkgit:gitk[1] for the selected commit, when the `Show History
1052 Context` menu item is invoked from 'git gui blame'. If this
1053 variable is set to zero, the whole history is shown.
1055 guitool.<name>.cmd::
1056 Specifies the shell command line to execute when the corresponding item
1057 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1058 mandatory for every tool. The command is executed from the root of
1059 the working directory, and in the environment it receives the name of
1060 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1061 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1062 the head is detached, 'CUR_BRANCH' is empty).
1064 guitool.<name>.needsfile::
1065 Run the tool only if a diff is selected in the GUI. It guarantees
1066 that 'FILENAME' is not empty.
1068 guitool.<name>.noconsole::
1069 Run the command silently, without creating a window to display its
1072 guitool.<name>.norescan::
1073 Don't rescan the working directory for changes after the tool
1076 guitool.<name>.confirm::
1077 Show a confirmation dialog before actually running the tool.
1079 guitool.<name>.argprompt::
1080 Request a string argument from the user, and pass it to the tool
1081 through the 'ARGS' environment variable. Since requesting an
1082 argument implies confirmation, the 'confirm' option has no effect
1083 if this is enabled. If the option is set to 'true', 'yes', or '1',
1084 the dialog uses a built-in generic prompt; otherwise the exact
1085 value of the variable is used.
1087 guitool.<name>.revprompt::
1088 Request a single valid revision from the user, and set the
1089 'REVISION' environment variable. In other aspects this option
1090 is similar to 'argprompt', and can be used together with it.
1092 guitool.<name>.revunmerged::
1093 Show only unmerged branches in the 'revprompt' subdialog.
1094 This is useful for tools similar to merge or rebase, but not
1095 for things like checkout or reset.
1097 guitool.<name>.title::
1098 Specifies the title to use for the prompt dialog. The default
1101 guitool.<name>.prompt::
1102 Specifies the general prompt string to display at the top of
1103 the dialog, before subsections for 'argprompt' and 'revprompt'.
1104 The default value includes the actual command.
1107 Specify the browser that will be used to display help in the
1108 'web' format. See linkgit:git-help[1].
1111 Override the default help format used by linkgit:git-help[1].
1112 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1113 the default. 'web' and 'html' are the same.
1116 Automatically correct and execute mistyped commands after
1117 waiting for the given number of deciseconds (0.1 sec). If more
1118 than one command can be deduced from the entered text, nothing
1119 will be executed. If the value of this option is negative,
1120 the corrected command will be executed immediately. If the
1121 value is 0 - the command will be just shown but not executed.
1122 This is the default.
1125 Override the HTTP proxy, normally configured using the 'http_proxy'
1126 environment variable (see linkgit:curl[1]). This can be overridden
1127 on a per-remote basis; see remote.<name>.proxy
1130 Whether to verify the SSL certificate when fetching or pushing
1131 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1135 File containing the SSL certificate when fetching or pushing
1136 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1140 File containing the SSL private key when fetching or pushing
1141 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1144 http.sslCertPasswordProtected::
1145 Enable git's password prompt for the SSL certificate. Otherwise
1146 OpenSSL will prompt the user, possibly many times, if the
1147 certificate or private key is encrypted. Can be overridden by the
1148 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1151 File containing the certificates to verify the peer with when
1152 fetching or pushing over HTTPS. Can be overridden by the
1153 'GIT_SSL_CAINFO' environment variable.
1156 Path containing files with the CA certificates to verify the peer
1157 with when fetching or pushing over HTTPS. Can be overridden
1158 by the 'GIT_SSL_CAPATH' environment variable.
1161 How many HTTP requests to launch in parallel. Can be overridden
1162 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1165 The number of curl sessions (counted across slots) to be kept across
1166 requests. They will not be ended with curl_easy_cleanup() until
1167 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1168 value will be capped at 1. Defaults to 1.
1171 Maximum size in bytes of the buffer used by smart HTTP
1172 transports when POSTing data to the remote system.
1173 For requests larger than this buffer size, HTTP/1.1 and
1174 Transfer-Encoding: chunked is used to avoid creating a
1175 massive pack file locally. Default is 1 MiB, which is
1176 sufficient for most requests.
1178 http.lowSpeedLimit, http.lowSpeedTime::
1179 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1180 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1181 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1182 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1185 A boolean which disables using of EPSV ftp command by curl.
1186 This can helpful with some "poor" ftp servers which don't
1187 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1188 environment variable. Default is false (curl will use EPSV).
1190 i18n.commitEncoding::
1191 Character encoding the commit messages are stored in; git itself
1192 does not care per se, but this information is necessary e.g. when
1193 importing commits from emails or in the gitk graphical history
1194 browser (and possibly at other places in the future or in other
1195 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1197 i18n.logOutputEncoding::
1198 Character encoding the commit messages are converted to when
1199 running 'git log' and friends.
1202 The configuration variables in the 'imap' section are described
1203 in linkgit:git-imap-send[1].
1206 Specify the program that will be used to browse your working
1207 repository in gitweb. See linkgit:git-instaweb[1].
1210 The HTTP daemon command-line to start gitweb on your working
1211 repository. See linkgit:git-instaweb[1].
1214 If true the web server started by linkgit:git-instaweb[1] will
1215 be bound to the local IP (127.0.0.1).
1217 instaweb.modulepath::
1218 The module path for an apache httpd used by linkgit:git-instaweb[1].
1221 The port number to bind the gitweb httpd to. See
1222 linkgit:git-instaweb[1].
1224 interactive.singlekey::
1225 In interactive commands, allow the user to provide one-letter
1226 input with a single key (i.e., without hitting enter).
1227 Currently this is used only by the `\--patch` mode of
1228 linkgit:git-add[1]. Note that this setting is silently
1229 ignored if portable keystroke input is not available.
1232 Set default date-time mode for the log command. Setting log.date
1233 value is similar to using 'git log'\'s --date option. The value is one of the
1234 following alternatives: {relative,local,default,iso,rfc,short}.
1235 See linkgit:git-log[1].
1238 If true, the initial commit will be shown as a big creation event.
1239 This is equivalent to a diff against an empty tree.
1240 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1241 normally hide the root commit will now show it. True by default.
1244 The location of an augmenting mailmap file. The default
1245 mailmap, located in the root of the repository, is loaded
1246 first, then the mailmap file pointed to by this variable.
1247 The location of the mailmap file may be in a repository
1248 subdirectory, or somewhere outside of the repository itself.
1249 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1252 Specify the programs that may be used to display help in the
1253 'man' format. See linkgit:git-help[1].
1256 Specify the command to invoke the specified man viewer. The
1257 specified command is evaluated in shell with the man page
1258 passed as argument. (See linkgit:git-help[1].)
1261 Override the path for the given tool that may be used to
1262 display help in the 'man' format. See linkgit:git-help[1].
1264 include::merge-config.txt[]
1266 mergetool.<tool>.path::
1267 Override the path for the given tool. This is useful in case
1268 your tool is not in the PATH.
1270 mergetool.<tool>.cmd::
1271 Specify the command to invoke the specified merge tool. The
1272 specified command is evaluated in shell with the following
1273 variables available: 'BASE' is the name of a temporary file
1274 containing the common base of the files to be merged, if available;
1275 'LOCAL' is the name of a temporary file containing the contents of
1276 the file on the current branch; 'REMOTE' is the name of a temporary
1277 file containing the contents of the file from the branch being
1278 merged; 'MERGED' contains the name of the file to which the merge
1279 tool should write the results of a successful merge.
1281 mergetool.<tool>.trustExitCode::
1282 For a custom merge command, specify whether the exit code of
1283 the merge command can be used to determine whether the merge was
1284 successful. If this is not set to true then the merge target file
1285 timestamp is checked and the merge assumed to have been successful
1286 if the file has been updated, otherwise the user is prompted to
1287 indicate the success of the merge.
1289 mergetool.keepBackup::
1290 After performing a merge, the original file with conflict markers
1291 can be saved as a file with a `.orig` extension. If this variable
1292 is set to `false` then this file is not preserved. Defaults to
1293 `true` (i.e. keep the backup files).
1295 mergetool.keepTemporaries::
1296 When invoking a custom merge tool, git uses a set of temporary
1297 files to pass to the tool. If the tool returns an error and this
1298 variable is set to `true`, then these temporary files will be
1299 preserved, otherwise they will be removed after the tool has
1300 exited. Defaults to `false`.
1303 Prompt before each invocation of the merge resolution program.
1306 The size of the window used by linkgit:git-pack-objects[1] when no
1307 window size is given on the command line. Defaults to 10.
1310 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1311 maximum depth is given on the command line. Defaults to 50.
1314 The window memory size limit used by linkgit:git-pack-objects[1]
1315 when no limit is given on the command line. The value can be
1316 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1320 An integer -1..9, indicating the compression level for objects
1321 in a pack file. -1 is the zlib default. 0 means no
1322 compression, and 1..9 are various speed/size tradeoffs, 9 being
1323 slowest. If not set, defaults to core.compression. If that is
1324 not set, defaults to -1, the zlib default, which is "a default
1325 compromise between speed and compression (currently equivalent
1328 pack.deltaCacheSize::
1329 The maximum memory in bytes used for caching deltas in
1330 linkgit:git-pack-objects[1] before writing them out to a pack.
1331 This cache is used to speed up the writing object phase by not
1332 having to recompute the final delta result once the best match
1333 for all objects is found. Repacking large repositories on machines
1334 which are tight with memory might be badly impacted by this though,
1335 especially if this cache pushes the system into swapping.
1336 A value of 0 means no limit. The smallest size of 1 byte may be
1337 used to virtually disable this cache. Defaults to 256 MiB.
1339 pack.deltaCacheLimit::
1340 The maximum size of a delta, that is cached in
1341 linkgit:git-pack-objects[1]. This cache is used to speed up the
1342 writing object phase by not having to recompute the final delta
1343 result once the best match for all objects is found. Defaults to 1000.
1346 Specifies the number of threads to spawn when searching for best
1347 delta matches. This requires that linkgit:git-pack-objects[1]
1348 be compiled with pthreads otherwise this option is ignored with a
1349 warning. This is meant to reduce packing time on multiprocessor
1350 machines. The required amount of memory for the delta search window
1351 is however multiplied by the number of threads.
1352 Specifying 0 will cause git to auto-detect the number of CPU's
1353 and set the number of threads accordingly.
1356 Specify the default pack index version. Valid values are 1 for
1357 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1358 the new pack index with capabilities for packs larger than 4 GB
1359 as well as proper protection against the repacking of corrupted
1360 packs. Version 2 is the default. Note that version 2 is enforced
1361 and this config option ignored whenever the corresponding pack is
1364 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1365 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1366 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1367 other side may give you a repository that cannot be accessed with your
1368 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1369 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1370 the `{asterisk}.idx` file.
1372 pack.packSizeLimit::
1373 The maximum size of a pack. This setting only affects
1374 packing to a file when repacking, i.e. the git:// protocol
1375 is unaffected. It can be overridden by the `\--max-pack-size`
1376 option of linkgit:git-repack[1]. The minimum size allowed is
1377 limited to 1 MiB. The default is unlimited.
1378 Common unit suffixes of 'k', 'm', or 'g' are
1382 Allows turning on or off pagination of the output of a
1383 particular git subcommand when writing to a tty. If
1384 `\--paginate` or `\--no-pager` is specified on the command line,
1385 it takes precedence over this option. To disable pagination for
1386 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1389 The default merge strategy to use when pulling multiple branches
1393 The default merge strategy to use when pulling a single branch.
1396 Defines the action git push should take if no refspec is given
1397 on the command line, no refspec is configured in the remote, and
1398 no refspec is implied by any of the options given on the command
1399 line. Possible values are:
1401 * `nothing` do not push anything.
1402 * `matching` push all matching branches.
1403 All branches having the same name in both ends are considered to be
1404 matching. This is the default.
1405 * `tracking` push the current branch to its upstream branch.
1406 * `current` push the current branch to a branch of the same name.
1409 Whether to show a diffstat of what changed upstream since the last
1410 rebase. False by default.
1413 By default, git-receive-pack will run "git-gc --auto" after
1414 receiving data from git-push and updating refs. You can stop
1415 it by setting this variable to false.
1417 receive.fsckObjects::
1418 If it is set to true, git-receive-pack will check all received
1419 objects. It will abort in the case of a malformed object or a
1420 broken link. The result of an abort are only dangling objects.
1423 receive.unpackLimit::
1424 If the number of objects received in a push is below this
1425 limit then the objects will be unpacked into loose object
1426 files. However if the number of received objects equals or
1427 exceeds this limit then the received pack will be stored as
1428 a pack, after adding any missing delta bases. Storing the
1429 pack from a push can make the push operation complete faster,
1430 especially on slow filesystems. If not set, the value of
1431 `transfer.unpackLimit` is used instead.
1433 receive.denyDeletes::
1434 If set to true, git-receive-pack will deny a ref update that deletes
1435 the ref. Use this to prevent such a ref deletion via a push.
1437 receive.denyCurrentBranch::
1438 If set to true or "refuse", receive-pack will deny a ref update
1439 to the currently checked out branch of a non-bare repository.
1440 Such a push is potentially dangerous because it brings the HEAD
1441 out of sync with the index and working tree. If set to "warn",
1442 print a warning of such a push to stderr, but allow the push to
1443 proceed. If set to false or "ignore", allow such pushes with no
1444 message. Defaults to "warn".
1446 receive.denyNonFastForwards::
1447 If set to true, git-receive-pack will deny a ref update which is
1448 not a fast-forward. Use this to prevent such an update via a push,
1449 even if that push is forced. This configuration variable is
1450 set when initializing a shared repository.
1452 receive.updateserverinfo::
1453 If set to true, git-receive-pack will run git-update-server-info
1454 after receiving data from git-push and updating refs.
1457 The URL of a remote repository. See linkgit:git-fetch[1] or
1458 linkgit:git-push[1].
1460 remote.<name>.pushurl::
1461 The push URL of a remote repository. See linkgit:git-push[1].
1463 remote.<name>.proxy::
1464 For remotes that require curl (http, https and ftp), the URL to
1465 the proxy to use for that remote. Set to the empty string to
1466 disable proxying for that remote.
1468 remote.<name>.fetch::
1469 The default set of "refspec" for linkgit:git-fetch[1]. See
1470 linkgit:git-fetch[1].
1472 remote.<name>.push::
1473 The default set of "refspec" for linkgit:git-push[1]. See
1474 linkgit:git-push[1].
1476 remote.<name>.mirror::
1477 If true, pushing to this remote will automatically behave
1478 as if the `\--mirror` option was given on the command line.
1480 remote.<name>.skipDefaultUpdate::
1481 If true, this remote will be skipped by default when updating
1482 using linkgit:git-fetch[1] or the `update` subcommand of
1483 linkgit:git-remote[1].
1485 remote.<name>.skipFetchAll::
1486 If true, this remote will be skipped by default when updating
1487 using linkgit:git-fetch[1] or the `update` subcommand of
1488 linkgit:git-remote[1].
1490 remote.<name>.receivepack::
1491 The default program to execute on the remote side when pushing. See
1492 option \--receive-pack of linkgit:git-push[1].
1494 remote.<name>.uploadpack::
1495 The default program to execute on the remote side when fetching. See
1496 option \--upload-pack of linkgit:git-fetch-pack[1].
1498 remote.<name>.tagopt::
1499 Setting this value to \--no-tags disables automatic tag following when
1500 fetching from remote <name>
1503 Setting this to a value <vcs> will cause git to interact with
1504 the remote with the git-remote-<vcs> helper.
1507 The list of remotes which are fetched by "git remote update
1508 <group>". See linkgit:git-remote[1].
1510 repack.usedeltabaseoffset::
1511 By default, linkgit:git-repack[1] creates packs that use
1512 delta-base offset. If you need to share your repository with
1513 git older than version 1.4.4, either directly or via a dumb
1514 protocol such as http, then you need to set this option to
1515 "false" and repack. Access from old git versions over the
1516 native protocol are unaffected by this option.
1519 When set to true, `git-rerere` updates the index with the
1520 resulting contents after it cleanly resolves conflicts using
1521 previously recorded resolution. Defaults to false.
1524 Activate recording of resolved conflicts, so that identical
1525 conflict hunks can be resolved automatically, should they
1526 be encountered again. linkgit:git-rerere[1] command is by
1527 default enabled if you create `rr-cache` directory under
1528 `$GIT_DIR`, but can be disabled by setting this option to false.
1530 sendemail.identity::
1531 A configuration identity. When given, causes values in the
1532 'sendemail.<identity>' subsection to take precedence over
1533 values in the 'sendemail' section. The default identity is
1534 the value of 'sendemail.identity'.
1536 sendemail.smtpencryption::
1537 See linkgit:git-send-email[1] for description. Note that this
1538 setting is not subject to the 'identity' mechanism.
1541 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1543 sendemail.<identity>.*::
1544 Identity-specific versions of the 'sendemail.*' parameters
1545 found below, taking precedence over those when the this
1546 identity is selected, through command-line or
1547 'sendemail.identity'.
1549 sendemail.aliasesfile::
1550 sendemail.aliasfiletype::
1554 sendemail.chainreplyto::
1556 sendemail.envelopesender::
1558 sendemail.multiedit::
1559 sendemail.signedoffbycc::
1560 sendemail.smtppass::
1561 sendemail.suppresscc::
1562 sendemail.suppressfrom::
1564 sendemail.smtpserver::
1565 sendemail.smtpserverport::
1566 sendemail.smtpuser::
1568 sendemail.validate::
1569 See linkgit:git-send-email[1] for description.
1571 sendemail.signedoffcc::
1572 Deprecated alias for 'sendemail.signedoffbycc'.
1574 showbranch.default::
1575 The default set of branches for linkgit:git-show-branch[1].
1576 See linkgit:git-show-branch[1].
1578 status.relativePaths::
1579 By default, linkgit:git-status[1] shows paths relative to the
1580 current directory. Setting this variable to `false` shows paths
1581 relative to the repository root (this was the default for git
1584 status.showUntrackedFiles::
1585 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1586 files which are not currently tracked by Git. Directories which
1587 contain only untracked files, are shown with the directory name
1588 only. Showing untracked files means that Git needs to lstat() all
1589 all the files in the whole repository, which might be slow on some
1590 systems. So, this variable controls how the commands displays
1591 the untracked files. Possible values are:
1594 - 'no' - Show no untracked files
1595 - 'normal' - Shows untracked files and directories
1596 - 'all' - Shows also individual files in untracked directories.
1599 If this variable is not specified, it defaults to 'normal'.
1600 This variable can be overridden with the -u|--untracked-files option
1601 of linkgit:git-status[1] and linkgit:git-commit[1].
1604 This variable can be used to restrict the permission bits of
1605 tar archive entries. The default is 0002, which turns off the
1606 world write bit. The special value "user" indicates that the
1607 archiving user's umask will be used instead. See umask(2) and
1608 linkgit:git-archive[1].
1610 transfer.unpackLimit::
1611 When `fetch.unpackLimit` or `receive.unpackLimit` are
1612 not set, the value of this variable is used instead.
1613 The default value is 100.
1615 url.<base>.insteadOf::
1616 Any URL that starts with this value will be rewritten to
1617 start, instead, with <base>. In cases where some site serves a
1618 large number of repositories, and serves them with multiple
1619 access methods, and some users need to use different access
1620 methods, this feature allows people to specify any of the
1621 equivalent URLs and have git automatically rewrite the URL to
1622 the best alternative for the particular user, even for a
1623 never-before-seen repository on the site. When more than one
1624 insteadOf strings match a given URL, the longest match is used.
1626 url.<base>.pushInsteadOf::
1627 Any URL that starts with this value will not be pushed to;
1628 instead, it will be rewritten to start with <base>, and the
1629 resulting URL will be pushed to. In cases where some site serves
1630 a large number of repositories, and serves them with multiple
1631 access methods, some of which do not allow push, this feature
1632 allows people to specify a pull-only URL and have git
1633 automatically use an appropriate URL to push, even for a
1634 never-before-seen repository on the site. When more than one
1635 pushInsteadOf strings match a given URL, the longest match is
1636 used. If a remote has an explicit pushurl, git will ignore this
1637 setting for that remote.
1640 Your email address to be recorded in any newly created commits.
1641 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1642 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1645 Your full name to be recorded in any newly created commits.
1646 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1647 environment variables. See linkgit:git-commit-tree[1].
1650 If linkgit:git-tag[1] is not selecting the key you want it to
1651 automatically when creating a signed tag, you can override the
1652 default selection with this variable. This option is passed
1653 unchanged to gpg's --local-user parameter, so you may specify a key
1654 using any method that gpg supports.
1657 Specify a web browser that may be used by some commands.
1658 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]