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.
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 If true, makes git convert `CRLF` at the end of lines in text files to
201 `LF` when reading from the filesystem, and convert in reverse when
202 writing to the filesystem. The variable can be set to
203 'input', in which case the conversion happens only while
204 reading from the filesystem but files are written out with
205 `LF` at the end of lines. A file is considered
206 "text" (i.e. be subjected to the autocrlf mechanism) based on
207 the file's `crlf` attribute, or if `crlf` is unspecified,
208 based on the file's contents. See linkgit:gitattributes[5].
211 If true, makes git check if converting `CRLF` as controlled by
212 `core.autocrlf` is reversible. Git will verify if a command
213 modifies a file in the work tree either directly or indirectly.
214 For example, committing a file followed by checking out the
215 same file should yield the original file in the work tree. If
216 this is not the case for the current setting of
217 `core.autocrlf`, git will reject the file. The variable can
218 be set to "warn", in which case git will only warn about an
219 irreversible conversion but continue the operation.
221 CRLF conversion bears a slight chance of corrupting data.
222 autocrlf=true will convert CRLF to LF during commit and LF to
223 CRLF during checkout. A file that contains a mixture of LF and
224 CRLF before the commit cannot be recreated by git. For text
225 files this is the right thing to do: it corrects line endings
226 such that we have only LF line endings in the repository.
227 But for binary files that are accidentally classified as text the
228 conversion can corrupt data.
230 If you recognize such corruption early you can easily fix it by
231 setting the conversion type explicitly in .gitattributes. Right
232 after committing you still have the original file in your work
233 tree and this file is not yet corrupted. You can explicitly tell
234 git that this file is binary and git will handle the file
237 Unfortunately, the desired effect of cleaning up text files with
238 mixed line endings and the undesired effect of corrupting binary
239 files cannot be distinguished. In both cases CRLFs are removed
240 in an irreversible way. For text files this is the right thing
241 to do because CRLFs are line endings, while for binary files
242 converting CRLFs corrupts data.
244 Note, this safety check does not mean that a checkout will generate a
245 file identical to the original file for a different setting of
246 `core.autocrlf`, but only for the current one. For example, a text
247 file with `LF` would be accepted with `core.autocrlf=input` and could
248 later be checked out with `core.autocrlf=true`, in which case the
249 resulting file would contain `CRLF`, although the original file
250 contained `LF`. However, in both work trees the line endings would be
251 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
252 file with mixed line endings would be reported by the `core.safecrlf`
256 If false, symbolic links are checked out as small plain files that
257 contain the link text. linkgit:git-update-index[1] and
258 linkgit:git-add[1] will not change the recorded type to regular
259 file. Useful on filesystems like FAT that do not support
262 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
263 will probe and set core.symlinks false if appropriate when the repository
267 A "proxy command" to execute (as 'command host port') instead
268 of establishing direct connection to the remote server when
269 using the git protocol for fetching. If the variable value is
270 in the "COMMAND for DOMAIN" format, the command is applied only
271 on hostnames ending with the specified domain string. This variable
272 may be set multiple times and is matched in the given order;
273 the first match wins.
275 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
276 (which always applies universally, without the special "for"
279 The special string `none` can be used as the proxy command to
280 specify that no proxy be used for a given domain pattern.
281 This is useful for excluding servers inside a firewall from
282 proxy use, while defaulting to a common proxy for external domains.
285 If true, commands which modify both the working tree and the index
286 will mark the updated paths with the "assume unchanged" bit in the
287 index. These marked files are then assumed to stay unchanged in the
288 working copy, until you mark them otherwise manually - Git will not
289 detect the file changes by lstat() calls. This is useful on systems
290 where those are very slow, such as Microsoft Windows.
291 See linkgit:git-update-index[1].
294 core.preferSymlinkRefs::
295 Instead of the default "symref" format for HEAD
296 and other symbolic reference files, use symbolic links.
297 This is sometimes needed to work with old scripts that
298 expect HEAD to be a symbolic link.
301 If true this repository is assumed to be 'bare' and has no
302 working directory associated with it. If this is the case a
303 number of commands that require a working directory will be
304 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
306 This setting is automatically guessed by linkgit:git-clone[1] or
307 linkgit:git-init[1] when the repository was created. By default a
308 repository that ends in "/.git" is assumed to be not bare (bare =
309 false), while all other repositories are assumed to be bare (bare
313 Set the path to the root of the work tree.
314 This can be overridden by the GIT_WORK_TREE environment
315 variable and the '--work-tree' command line option. It can be
316 an absolute path or a relative path to the .git directory,
317 either specified by --git-dir or GIT_DIR, or automatically
319 If --git-dir or GIT_DIR are specified but none of
320 --work-tree, GIT_WORK_TREE and core.worktree is specified,
321 the current working directory is regarded as the root of the
324 Note that this variable is honored even when set in a configuration
325 file in a ".git" subdirectory of a directory, and its value differs
326 from the latter directory (e.g. "/path/to/.git/config" has
327 core.worktree set to "/different/path"), which is most likely a
328 misconfiguration. Running git commands in "/path/to" directory will
329 still use "/different/path" as the root of the work tree and can cause
330 great confusion to the users.
332 core.logAllRefUpdates::
333 Enable the reflog. Updates to a ref <ref> is logged to the file
334 "$GIT_DIR/logs/<ref>", by appending the new and old
335 SHA1, the date/time and the reason of the update, but
336 only when the file exists. If this configuration
337 variable is set to true, missing "$GIT_DIR/logs/<ref>"
338 file is automatically created for branch heads.
340 This information can be used to determine what commit
341 was the tip of a branch "2 days ago".
343 This value is true by default in a repository that has
344 a working directory associated with it, and false by
345 default in a bare repository.
347 core.repositoryFormatVersion::
348 Internal variable identifying the repository format and layout
351 core.sharedRepository::
352 When 'group' (or 'true'), the repository is made shareable between
353 several users in a group (making sure all the files and objects are
354 group-writable). When 'all' (or 'world' or 'everybody'), the
355 repository will be readable by all users, additionally to being
356 group-shareable. When 'umask' (or 'false'), git will use permissions
357 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
358 files in the repository will have this mode value. '0xxx' will override
359 user's umask value (whereas the other options will only override
360 requested parts of the user's umask value). Examples: '0660' will make
361 the repo read/write-able for the owner and group, but inaccessible to
362 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
363 repository that is group-readable but not group-writable.
364 See linkgit:git-init[1]. False by default.
366 core.warnAmbiguousRefs::
367 If true, git will warn you if the ref name you passed it is ambiguous
368 and might match multiple refs in the .git/refs/ tree. True by default.
371 An integer -1..9, indicating a default compression level.
372 -1 is the zlib default. 0 means no compression,
373 and 1..9 are various speed/size tradeoffs, 9 being slowest.
374 If set, this provides a default to other compression variables,
375 such as 'core.loosecompression' and 'pack.compression'.
377 core.loosecompression::
378 An integer -1..9, indicating the compression level for objects that
379 are not in a pack file. -1 is the zlib default. 0 means no
380 compression, and 1..9 are various speed/size tradeoffs, 9 being
381 slowest. If not set, defaults to core.compression. If that is
382 not set, defaults to 1 (best speed).
384 core.packedGitWindowSize::
385 Number of bytes of a pack file to map into memory in a
386 single mapping operation. Larger window sizes may allow
387 your system to process a smaller number of large pack files
388 more quickly. Smaller window sizes will negatively affect
389 performance due to increased calls to the operating system's
390 memory manager, but may improve performance when accessing
391 a large number of large pack files.
393 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
394 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
395 be reasonable for all users/operating systems. You probably do
396 not need to adjust this value.
398 Common unit suffixes of 'k', 'm', or 'g' are supported.
400 core.packedGitLimit::
401 Maximum number of bytes to map simultaneously into memory
402 from pack files. If Git needs to access more than this many
403 bytes at once to complete an operation it will unmap existing
404 regions to reclaim virtual address space within the process.
406 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
407 This should be reasonable for all users/operating systems, except on
408 the largest projects. You probably do not need to adjust this value.
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.deltaBaseCacheLimit::
413 Maximum number of bytes to reserve for caching base objects
414 that multiple deltafied objects reference. By storing the
415 entire decompressed base objects in a cache Git is able
416 to avoid unpacking and decompressing frequently used base
417 objects multiple times.
419 Default is 16 MiB on all platforms. This should be reasonable
420 for all users/operating systems, except on the largest projects.
421 You probably do not need to adjust this value.
423 Common unit suffixes of 'k', 'm', or 'g' are supported.
425 core.bigFileThreshold::
426 Files larger than this size are stored deflated, without
427 attempting delta compression. Storing large files without
428 delta compression avoids excessive memory usage, at the
429 slight expense of increased disk usage.
431 Default is 512 MiB on all platforms. This should be reasonable
432 for most projects as source code and other text files can still
433 be delta compressed, but larger binary media files won't be.
435 Common unit suffixes of 'k', 'm', or 'g' are supported.
437 Currently only linkgit:git-fast-import[1] honors this setting.
440 In addition to '.gitignore' (per-directory) and
441 '.git/info/exclude', git looks into this file for patterns
442 of files which are not meant to be tracked. "{tilde}/" is expanded
443 to the value of `$HOME` and "{tilde}user/" to the specified user's
444 home directory. See linkgit:gitignore[5].
447 Commands such as `commit` and `tag` that lets you edit
448 messages by launching an editor uses the value of this
449 variable when it is set, and the environment variable
450 `GIT_EDITOR` is not set. See linkgit:git-var[1].
453 The command that git will use to paginate output. Can
454 be overridden with the `GIT_PAGER` environment
455 variable. Note that git sets the `LESS` environment
456 variable to `FRSX` if it is unset when it runs the
457 pager. One can change these settings by setting the
458 `LESS` variable to some other value. Alternately,
459 these settings can be overridden on a project or
460 global basis by setting the `core.pager` option.
461 Setting `core.pager` has no affect on the `LESS`
462 environment variable behaviour above, so if you want
463 to override git's default settings this way, you need
464 to be explicit. For example, to disable the S option
465 in a backward compatible manner, set `core.pager`
466 to `less -+$LESS -FRX`. This will be passed to the
467 shell by git, which will translate the final command to
468 `LESS=FRSX less -+FRSX -FRX`.
471 A comma separated list of common whitespace problems to
472 notice. 'git diff' will use `color.diff.whitespace` to
473 highlight them, and 'git apply --whitespace=error' will
474 consider them as errors. You can prefix `-` to disable
475 any of them (e.g. `-trailing-space`):
477 * `blank-at-eol` treats trailing whitespaces at the end of the line
478 as an error (enabled by default).
479 * `space-before-tab` treats a space character that appears immediately
480 before a tab character in the initial indent part of the line as an
481 error (enabled by default).
482 * `indent-with-non-tab` treats a line that is indented with 8 or more
483 space characters as an error (not enabled by default).
484 * `blank-at-eof` treats blank lines added at the end of file as an error
485 (enabled by default).
486 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
488 * `cr-at-eol` treats a carriage-return at the end of line as
489 part of the line terminator, i.e. with it, `trailing-space`
490 does not trigger if the character before such a carriage-return
491 is not a whitespace (not enabled by default).
493 core.fsyncobjectfiles::
494 This boolean will enable 'fsync()' when writing object files.
496 This is a total waste of time and effort on a filesystem that orders
497 data writes properly, but can be useful for filesystems that do not use
498 journalling (traditional UNIX filesystems) or that only journal metadata
499 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
502 Enable parallel index preload for operations like 'git diff'
504 This can speed up operations like 'git diff' and 'git status' especially
505 on filesystems like NFS that have weak caching semantics and thus
506 relatively high IO latencies. With this set to 'true', git will do the
507 index comparison to the filesystem data in parallel, allowing
511 You can set this to 'link', in which case a hardlink followed by
512 a delete of the source are used to make sure that object creation
513 will not overwrite existing objects.
515 On some file system/operating system combinations, this is unreliable.
516 Set this config setting to 'rename' there; However, This will remove the
517 check that makes sure that existing object files will not get overwritten.
520 When showing commit messages, also show notes which are stored in
521 the given ref. This ref is expected to contain files named
522 after the full SHA-1 of the commit they annotate.
524 If such a file exists in the given ref, the referenced blob is read, and
525 appended to the commit message, separated by a "Notes:" line. If the
526 given ref itself does not exist, it is not an error, but means that no
527 notes should be printed.
529 This setting defaults to "refs/notes/commits", and can be overridden by
530 the `GIT_NOTES_REF` environment variable.
532 core.sparseCheckout::
533 Enable "sparse checkout" feature. See section "Sparse checkout" in
534 linkgit:git-read-tree[1] for more information.
537 Tells 'git add' to continue adding files when some files cannot be
538 added due to indexing errors. Equivalent to the '--ignore-errors'
539 option of linkgit:git-add[1].
542 Command aliases for the linkgit:git[1] command wrapper - e.g.
543 after defining "alias.last = cat-file commit HEAD", the invocation
544 "git last" is equivalent to "git cat-file commit HEAD". To avoid
545 confusion and troubles with script usage, aliases that
546 hide existing git commands are ignored. Arguments are split by
547 spaces, the usual shell quoting and escaping is supported.
548 quote pair and a backslash can be used to quote them.
550 If the alias expansion is prefixed with an exclamation point,
551 it will be treated as a shell command. For example, defining
552 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
553 "git new" is equivalent to running the shell command
554 "gitk --all --not ORIG_HEAD". Note that shell commands will be
555 executed from the top-level directory of a repository, which may
556 not necessarily be the current directory.
558 apply.ignorewhitespace::
559 When set to 'change', tells 'git apply' to ignore changes in
560 whitespace, in the same way as the '--ignore-space-change'
562 When set to one of: no, none, never, false tells 'git apply' to
563 respect all whitespace differences.
564 See linkgit:git-apply[1].
567 Tells 'git apply' how to handle whitespaces, in the same way
568 as the '--whitespace' option. See linkgit:git-apply[1].
570 branch.autosetupmerge::
571 Tells 'git branch' and 'git checkout' to set up new branches
572 so that linkgit:git-pull[1] will appropriately merge from the
573 starting point branch. Note that even if this option is not set,
574 this behavior can be chosen per-branch using the `--track`
575 and `--no-track` options. The valid settings are: `false` -- no
576 automatic setup is done; `true` -- automatic setup is done when the
577 starting point is a remote branch; `always` -- automatic setup is
578 done when the starting point is either a local branch or remote
579 branch. This option defaults to true.
581 branch.autosetuprebase::
582 When a new branch is created with 'git branch' or 'git checkout'
583 that tracks another branch, this variable tells git to set
584 up pull to rebase instead of merge (see "branch.<name>.rebase").
585 When `never`, rebase is never automatically set to true.
586 When `local`, rebase is set to true for tracked branches of
587 other local branches.
588 When `remote`, rebase is set to true for tracked branches of
590 When `always`, rebase will be set to true for all tracking
592 See "branch.autosetupmerge" for details on how to set up a
593 branch to track another branch.
594 This option defaults to never.
596 branch.<name>.remote::
597 When in branch <name>, it tells 'git fetch' and 'git push' which
598 remote to fetch from/push to. It defaults to `origin` if no remote is
599 configured. `origin` is also used if you are not on any branch.
601 branch.<name>.merge::
602 Defines, together with branch.<name>.remote, the upstream branch
603 for the given branch. It tells 'git fetch'/'git pull' which
604 branch to merge and can also affect 'git push' (see push.default).
605 When in branch <name>, it tells 'git fetch' the default
606 refspec to be marked for merging in FETCH_HEAD. The value is
607 handled like the remote part of a refspec, and must match a
608 ref which is fetched from the remote given by
609 "branch.<name>.remote".
610 The merge information is used by 'git pull' (which at first calls
611 'git fetch') to lookup the default branch for merging. Without
612 this option, 'git pull' defaults to merge the first refspec fetched.
613 Specify multiple values to get an octopus merge.
614 If you wish to setup 'git pull' so that it merges into <name> from
615 another branch in the local repository, you can point
616 branch.<name>.merge to the desired branch, and use the special setting
617 `.` (a period) for branch.<name>.remote.
619 branch.<name>.mergeoptions::
620 Sets default options for merging into branch <name>. The syntax and
621 supported options are the same as those of linkgit:git-merge[1], but
622 option values containing whitespace characters are currently not
625 branch.<name>.rebase::
626 When true, rebase the branch <name> on top of the fetched branch,
627 instead of merging the default branch from the default remote when
629 *NOTE*: this is a possibly dangerous operation; do *not* use
630 it unless you understand the implications (see linkgit:git-rebase[1]
634 Specify the command to invoke the specified browser. The
635 specified command is evaluated in shell with the URLs passed
636 as arguments. (See linkgit:git-web--browse[1].)
638 browser.<tool>.path::
639 Override the path for the given tool that may be used to
640 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
641 working repository in gitweb (see linkgit:git-instaweb[1]).
644 A boolean to make git-clean do nothing unless given -f
645 or -n. Defaults to true.
648 A boolean to enable/disable color in the output of
649 linkgit:git-branch[1]. May be set to `always`,
650 `false` (or `never`) or `auto` (or `true`), in which case colors are used
651 only when the output is to a terminal. Defaults to false.
653 color.branch.<slot>::
654 Use customized color for branch coloration. `<slot>` is one of
655 `current` (the current branch), `local` (a local branch),
656 `remote` (a tracking branch in refs/remotes/), `plain` (other
659 The value for these configuration variables is a list of colors (at most
660 two) and attributes (at most one), separated by spaces. The colors
661 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
662 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
663 `blink` and `reverse`. The first color given is the foreground; the
664 second is the background. The position of the attribute, if any,
668 When set to `always`, always use colors in patch.
669 When false (or `never`), never. When set to `true` or `auto`, use
670 colors only when the output is to the terminal. Defaults to false.
673 Use customized color for diff colorization. `<slot>` specifies
674 which part of the patch to use the specified color, and is one
675 of `plain` (context text), `meta` (metainformation), `frag`
676 (hunk header), 'func' (function in hunk header), `old` (removed lines),
677 `new` (added lines), `commit` (commit headers), or `whitespace`
678 (highlighting whitespace errors). The values of these variables may be
679 specified as in color.branch.<slot>.
682 When set to `always`, always highlight matches. When `false` (or
683 `never`), never. When set to `true` or `auto`, use color only
684 when the output is written to the terminal. Defaults to `false`.
687 Use customized color for grep colorization. `<slot>` specifies which
688 part of the line to use the specified color, and is one of
692 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
694 filename prefix (when not using `-h`)
696 function name lines (when using `-p`)
698 line number prefix (when using `-n`)
702 non-matching text in selected lines
704 separators between fields on a line (`:`, `-`, and `=`)
705 and between hunks (`--`)
708 The values of these variables may be specified as in color.branch.<slot>.
711 When set to `always`, always use colors for interactive prompts
712 and displays (such as those used by "git-add --interactive").
713 When false (or `never`), never. When set to `true` or `auto`, use
714 colors only when the output is to the terminal. Defaults to false.
716 color.interactive.<slot>::
717 Use customized color for 'git add --interactive'
718 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
719 four distinct types of normal output from interactive
720 commands. The values of these variables may be specified as
721 in color.branch.<slot>.
724 A boolean to enable/disable colored output when the pager is in
725 use (default is true).
728 A boolean to enable/disable color in the output of
729 linkgit:git-show-branch[1]. May be set to `always`,
730 `false` (or `never`) or `auto` (or `true`), in which case colors are used
731 only when the output is to a terminal. Defaults to false.
734 A boolean to enable/disable color in the output of
735 linkgit:git-status[1]. May be set to `always`,
736 `false` (or `never`) or `auto` (or `true`), in which case colors are used
737 only when the output is to a terminal. Defaults to false.
739 color.status.<slot>::
740 Use customized color for status colorization. `<slot>` is
741 one of `header` (the header text of the status message),
742 `added` or `updated` (files which are added but not committed),
743 `changed` (files which are changed but not added in the index),
744 `untracked` (files which are not tracked by git), or
745 `nobranch` (the color the 'no branch' warning is shown in, defaulting
746 to red). The values of these variables may be specified as in
750 When set to `always`, always use colors in all git commands which
751 are capable of colored output. When false (or `never`), never. When
752 set to `true` or `auto`, use colors only when the output is to the
753 terminal. When more specific variables of color.* are set, they always
754 take precedence over this setting. Defaults to false.
757 A boolean to enable/disable inclusion of status information in the
758 commit message template when using an editor to prepare the commit
759 message. Defaults to true.
762 Specify a file to use as the template for new commit messages.
763 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
764 specified user's home directory.
766 diff.autorefreshindex::
767 When using 'git diff' to compare with work tree
768 files, do not consider stat-only change as changed.
769 Instead, silently run `git update-index --refresh` to
770 update the cached stat information for paths whose
771 contents in the work tree match the contents in the
772 index. This option defaults to true. Note that this
773 affects only 'git diff' Porcelain, and not lower level
774 'diff' commands such as 'git diff-files'.
777 If this config variable is set, diff generation is not
778 performed using the internal diff machinery, but using the
779 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
780 environment variable. The command is called with parameters
781 as described under "git Diffs" in linkgit:git[1]. Note: if
782 you want to use an external diff program only on a subset of
783 your files, you might want to use linkgit:gitattributes[5] instead.
785 diff.mnemonicprefix::
786 If set, 'git diff' uses a prefix pair that is different from the
787 standard "a/" and "b/" depending on what is being compared. When
788 this configuration is in effect, reverse diff output also swaps
789 the order of the prefixes:
791 compares the (i)ndex and the (w)ork tree;
793 compares a (c)ommit and the (w)ork tree;
794 `git diff --cached`;;
795 compares a (c)ommit and the (i)ndex;
796 `git diff HEAD:file1 file2`;;
797 compares an (o)bject and a (w)ork tree entity;
798 `git diff --no-index a b`;;
799 compares two non-git things (1) and (2).
802 The number of files to consider when performing the copy/rename
803 detection; equivalent to the 'git diff' option '-l'.
806 Tells git to detect renames. If set to any boolean value, it
807 will enable basic rename detection. If set to "copies" or
808 "copy", it will detect copies, as well.
810 diff.suppressBlankEmpty::
811 A boolean to inhibit the standard behavior of printing a space
812 before each empty output line. Defaults to false.
815 Controls which diff tool is used. `diff.tool` overrides
816 `merge.tool` when used by linkgit:git-difftool[1] and has
817 the same valid values as `merge.tool` minus "tortoisemerge"
820 difftool.<tool>.path::
821 Override the path for the given tool. This is useful in case
822 your tool is not in the PATH.
824 difftool.<tool>.cmd::
825 Specify the command to invoke the specified diff tool.
826 The specified command is evaluated in shell with the following
827 variables available: 'LOCAL' is set to the name of the temporary
828 file containing the contents of the diff pre-image and 'REMOTE'
829 is set to the name of the temporary file containing the contents
830 of the diff post-image.
833 Prompt before each invocation of the diff tool.
836 A POSIX Extended Regular Expression used to determine what is a "word"
837 when performing word-by-word difference calculations. Character
838 sequences that match the regular expression are "words", all other
839 characters are *ignorable* whitespace.
842 If the number of objects fetched over the git native
843 transfer is below this
844 limit, then the objects will be unpacked into loose object
845 files. However if the number of received objects equals or
846 exceeds this limit then the received pack will be stored as
847 a pack, after adding any missing delta bases. Storing the
848 pack from a push can make the push operation complete faster,
849 especially on slow filesystems. If not set, the value of
850 `transfer.unpackLimit` is used instead.
853 Enable multipart/mixed attachments as the default for
854 'format-patch'. The value can also be a double quoted string
855 which will enable attachments as the default and set the
856 value as the boundary. See the --attach option in
857 linkgit:git-format-patch[1].
860 A boolean which can enable or disable sequence numbers in patch
861 subjects. It defaults to "auto" which enables it only if there
862 is more than one patch. It can be enabled or disabled for all
863 messages by setting it to "true" or "false". See --numbered
864 option in linkgit:git-format-patch[1].
867 Additional email headers to include in a patch to be submitted
868 by mail. See linkgit:git-format-patch[1].
871 Additional "Cc:" headers to include in a patch to be submitted
872 by mail. See the --cc option in linkgit:git-format-patch[1].
874 format.subjectprefix::
875 The default for format-patch is to output files with the '[PATCH]'
876 subject prefix. Use this variable to change that prefix.
879 The default for format-patch is to output files with the suffix
880 `.patch`. Use this variable to change that suffix (make sure to
881 include the dot if you want it).
884 The default pretty format for log/show/whatchanged command,
885 See linkgit:git-log[1], linkgit:git-show[1],
886 linkgit:git-whatchanged[1].
889 The default threading style for 'git format-patch'. Can be
890 a boolean value, or `shallow` or `deep`. `shallow` threading
891 makes every mail a reply to the head of the series,
892 where the head is chosen from the cover letter, the
893 `\--in-reply-to`, and the first patch mail, in this order.
894 `deep` threading makes every mail a reply to the previous one.
895 A true boolean value is the same as `shallow`, and a false
896 value disables threading.
899 A boolean value which lets you enable the `-s/--signoff` option of
900 format-patch by default. *Note:* Adding the Signed-off-by: line to a
901 patch should be a conscious act and means that you certify you have
902 the rights to submit this work under the same open source license.
903 Please see the 'SubmittingPatches' document for further discussion.
905 gc.aggressiveWindow::
906 The window size parameter used in the delta compression
907 algorithm used by 'git gc --aggressive'. This defaults
911 When there are approximately more than this many loose
912 objects in the repository, `git gc --auto` will pack them.
913 Some Porcelain commands use this command to perform a
914 light-weight garbage collection from time to time. The
915 default value is 6700. Setting this to 0 disables it.
918 When there are more than this many packs that are not
919 marked with `*.keep` file in the repository, `git gc
920 --auto` consolidates them into one larger pack. The
921 default value is 50. Setting this to 0 disables it.
924 Running `git pack-refs` in a repository renders it
925 unclonable by Git versions prior to 1.5.1.2 over dumb
926 transports such as HTTP. This variable determines whether
927 'git gc' runs `git pack-refs`. This can be set to `nobare`
928 to enable it within all non-bare repos or it can be set to a
929 boolean value. The default is `true`.
932 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
933 Override the grace period with this config variable. The value
934 "now" may be used to disable this grace period and always prune
935 unreachable objects immediately.
938 'git reflog expire' removes reflog entries older than
939 this time; defaults to 90 days.
941 gc.reflogexpireunreachable::
942 'git reflog expire' removes reflog entries older than
943 this time and are not reachable from the current tip;
947 Records of conflicted merge you resolved earlier are
948 kept for this many days when 'git rerere gc' is run.
949 The default is 60 days. See linkgit:git-rerere[1].
951 gc.rerereunresolved::
952 Records of conflicted merge you have not resolved are
953 kept for this many days when 'git rerere gc' is run.
954 The default is 15 days. See linkgit:git-rerere[1].
956 gitcvs.commitmsgannotation::
957 Append this string to each commit message. Set to empty string
958 to disable this feature. Defaults to "via git-CVS emulator".
961 Whether the CVS server interface is enabled for this repository.
962 See linkgit:git-cvsserver[1].
965 Path to a log file where the CVS server interface well... logs
966 various stuff. See linkgit:git-cvsserver[1].
969 If true, the server will look up the `crlf` attribute for
970 files to determine the '-k' modes to use. If `crlf` is set,
971 the '-k' mode will be left blank, so cvs clients will
972 treat it as text. If `crlf` is explicitly unset, the file
973 will be set with '-kb' mode, which suppresses any newline munging
974 the client might otherwise do. If `crlf` is not specified,
975 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
978 This is used if 'gitcvs.usecrlfattr' does not resolve
979 the correct '-kb' mode to use. If true, all
980 unresolved files are sent to the client in
981 mode '-kb'. This causes the client to treat them
982 as binary files, which suppresses any newline munging it
983 otherwise might do. Alternatively, if it is set to "guess",
984 then the contents of the file are examined to decide if
985 it is binary, similar to 'core.autocrlf'.
988 Database used by git-cvsserver to cache revision information
989 derived from the git repository. The exact meaning depends on the
990 used database driver, for SQLite (which is the default driver) this
991 is a filename. Supports variable substitution (see
992 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
993 Default: '%Ggitcvs.%m.sqlite'
996 Used Perl DBI driver. You can specify any available driver
997 for this here, but it might not work. git-cvsserver is tested
998 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
999 reported *not* to work with 'DBD::mysql'. Experimental feature.
1000 May not contain double colons (`:`). Default: 'SQLite'.
1001 See linkgit:git-cvsserver[1].
1003 gitcvs.dbuser, gitcvs.dbpass::
1004 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1005 since SQLite has no concept of database users and/or passwords.
1006 'gitcvs.dbuser' supports variable substitution (see
1007 linkgit:git-cvsserver[1] for details).
1009 gitcvs.dbTableNamePrefix::
1010 Database table name prefix. Prepended to the names of any
1011 database tables used, allowing a single database to be used
1012 for several repositories. Supports variable substitution (see
1013 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1014 characters will be replaced with underscores.
1016 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1017 'gitcvs.allbinary' can also be specified as
1018 'gitcvs.<access_method>.<varname>' (where 'access_method'
1019 is one of "ext" and "pserver") to make them apply only for the given
1022 gui.commitmsgwidth::
1023 Defines how wide the commit message window is in the
1024 linkgit:git-gui[1]. "75" is the default.
1027 Specifies how many context lines should be used in calls to diff
1028 made by the linkgit:git-gui[1]. The default is "5".
1031 Specifies the default encoding to use for displaying of
1032 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1033 It can be overridden by setting the 'encoding' attribute
1034 for relevant files (see linkgit:gitattributes[5]).
1035 If this option is not set, the tools default to the
1038 gui.matchtrackingbranch::
1039 Determines if new branches created with linkgit:git-gui[1] should
1040 default to tracking remote branches with matching names or
1041 not. Default: "false".
1043 gui.newbranchtemplate::
1044 Is used as suggested name when creating new branches using the
1047 gui.pruneduringfetch::
1048 "true" if linkgit:git-gui[1] should prune tracking branches when
1049 performing a fetch. The default value is "false".
1052 Determines if linkgit:git-gui[1] should trust the file modification
1053 timestamp or not. By default the timestamps are not trusted.
1055 gui.spellingdictionary::
1056 Specifies the dictionary used for spell checking commit messages in
1057 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1061 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1062 location detection. It makes blame significantly faster on huge
1063 repositories at the expense of less thorough copy detection.
1065 gui.copyblamethreshold::
1066 Specifies the threshold to use in 'git gui blame' original location
1067 detection, measured in alphanumeric characters. See the
1068 linkgit:git-blame[1] manual for more information on copy detection.
1070 gui.blamehistoryctx::
1071 Specifies the radius of history context in days to show in
1072 linkgit:gitk[1] for the selected commit, when the `Show History
1073 Context` menu item is invoked from 'git gui blame'. If this
1074 variable is set to zero, the whole history is shown.
1076 guitool.<name>.cmd::
1077 Specifies the shell command line to execute when the corresponding item
1078 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1079 mandatory for every tool. The command is executed from the root of
1080 the working directory, and in the environment it receives the name of
1081 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1082 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1083 the head is detached, 'CUR_BRANCH' is empty).
1085 guitool.<name>.needsfile::
1086 Run the tool only if a diff is selected in the GUI. It guarantees
1087 that 'FILENAME' is not empty.
1089 guitool.<name>.noconsole::
1090 Run the command silently, without creating a window to display its
1093 guitool.<name>.norescan::
1094 Don't rescan the working directory for changes after the tool
1097 guitool.<name>.confirm::
1098 Show a confirmation dialog before actually running the tool.
1100 guitool.<name>.argprompt::
1101 Request a string argument from the user, and pass it to the tool
1102 through the 'ARGS' environment variable. Since requesting an
1103 argument implies confirmation, the 'confirm' option has no effect
1104 if this is enabled. If the option is set to 'true', 'yes', or '1',
1105 the dialog uses a built-in generic prompt; otherwise the exact
1106 value of the variable is used.
1108 guitool.<name>.revprompt::
1109 Request a single valid revision from the user, and set the
1110 'REVISION' environment variable. In other aspects this option
1111 is similar to 'argprompt', and can be used together with it.
1113 guitool.<name>.revunmerged::
1114 Show only unmerged branches in the 'revprompt' subdialog.
1115 This is useful for tools similar to merge or rebase, but not
1116 for things like checkout or reset.
1118 guitool.<name>.title::
1119 Specifies the title to use for the prompt dialog. The default
1122 guitool.<name>.prompt::
1123 Specifies the general prompt string to display at the top of
1124 the dialog, before subsections for 'argprompt' and 'revprompt'.
1125 The default value includes the actual command.
1128 Specify the browser that will be used to display help in the
1129 'web' format. See linkgit:git-help[1].
1132 Override the default help format used by linkgit:git-help[1].
1133 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1134 the default. 'web' and 'html' are the same.
1137 Automatically correct and execute mistyped commands after
1138 waiting for the given number of deciseconds (0.1 sec). If more
1139 than one command can be deduced from the entered text, nothing
1140 will be executed. If the value of this option is negative,
1141 the corrected command will be executed immediately. If the
1142 value is 0 - the command will be just shown but not executed.
1143 This is the default.
1146 Override the HTTP proxy, normally configured using the 'http_proxy'
1147 environment variable (see linkgit:curl[1]). This can be overridden
1148 on a per-remote basis; see remote.<name>.proxy
1151 Whether to verify the SSL certificate when fetching or pushing
1152 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1156 File containing the SSL certificate when fetching or pushing
1157 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1161 File containing the SSL private key when fetching or pushing
1162 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1165 http.sslCertPasswordProtected::
1166 Enable git's password prompt for the SSL certificate. Otherwise
1167 OpenSSL will prompt the user, possibly many times, if the
1168 certificate or private key is encrypted. Can be overridden by the
1169 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1172 File containing the certificates to verify the peer with when
1173 fetching or pushing over HTTPS. Can be overridden by the
1174 'GIT_SSL_CAINFO' environment variable.
1177 Path containing files with the CA certificates to verify the peer
1178 with when fetching or pushing over HTTPS. Can be overridden
1179 by the 'GIT_SSL_CAPATH' environment variable.
1182 How many HTTP requests to launch in parallel. Can be overridden
1183 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1186 The number of curl sessions (counted across slots) to be kept across
1187 requests. They will not be ended with curl_easy_cleanup() until
1188 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1189 value will be capped at 1. Defaults to 1.
1192 Maximum size in bytes of the buffer used by smart HTTP
1193 transports when POSTing data to the remote system.
1194 For requests larger than this buffer size, HTTP/1.1 and
1195 Transfer-Encoding: chunked is used to avoid creating a
1196 massive pack file locally. Default is 1 MiB, which is
1197 sufficient for most requests.
1199 http.lowSpeedLimit, http.lowSpeedTime::
1200 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1201 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1202 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1203 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1206 A boolean which disables using of EPSV ftp command by curl.
1207 This can helpful with some "poor" ftp servers which don't
1208 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1209 environment variable. Default is false (curl will use EPSV).
1211 i18n.commitEncoding::
1212 Character encoding the commit messages are stored in; git itself
1213 does not care per se, but this information is necessary e.g. when
1214 importing commits from emails or in the gitk graphical history
1215 browser (and possibly at other places in the future or in other
1216 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1218 i18n.logOutputEncoding::
1219 Character encoding the commit messages are converted to when
1220 running 'git log' and friends.
1223 The configuration variables in the 'imap' section are described
1224 in linkgit:git-imap-send[1].
1227 Specify the program that will be used to browse your working
1228 repository in gitweb. See linkgit:git-instaweb[1].
1231 The HTTP daemon command-line to start gitweb on your working
1232 repository. See linkgit:git-instaweb[1].
1235 If true the web server started by linkgit:git-instaweb[1] will
1236 be bound to the local IP (127.0.0.1).
1238 instaweb.modulepath::
1239 The module path for an apache httpd used by linkgit:git-instaweb[1].
1242 The port number to bind the gitweb httpd to. See
1243 linkgit:git-instaweb[1].
1245 interactive.singlekey::
1246 In interactive commands, allow the user to provide one-letter
1247 input with a single key (i.e., without hitting enter).
1248 Currently this is used only by the `\--patch` mode of
1249 linkgit:git-add[1]. Note that this setting is silently
1250 ignored if portable keystroke input is not available.
1253 Set default date-time mode for the log command. Setting log.date
1254 value is similar to using 'git log'\'s --date option. The value is one of the
1255 following alternatives: {relative,local,default,iso,rfc,short}.
1256 See linkgit:git-log[1].
1259 If true, the initial commit will be shown as a big creation event.
1260 This is equivalent to a diff against an empty tree.
1261 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1262 normally hide the root commit will now show it. True by default.
1265 The location of an augmenting mailmap file. The default
1266 mailmap, located in the root of the repository, is loaded
1267 first, then the mailmap file pointed to by this variable.
1268 The location of the mailmap file may be in a repository
1269 subdirectory, or somewhere outside of the repository itself.
1270 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1273 Specify the programs that may be used to display help in the
1274 'man' format. See linkgit:git-help[1].
1277 Specify the command to invoke the specified man viewer. The
1278 specified command is evaluated in shell with the man page
1279 passed as argument. (See linkgit:git-help[1].)
1282 Override the path for the given tool that may be used to
1283 display help in the 'man' format. See linkgit:git-help[1].
1285 include::merge-config.txt[]
1287 mergetool.<tool>.path::
1288 Override the path for the given tool. This is useful in case
1289 your tool is not in the PATH.
1291 mergetool.<tool>.cmd::
1292 Specify the command to invoke the specified merge tool. The
1293 specified command is evaluated in shell with the following
1294 variables available: 'BASE' is the name of a temporary file
1295 containing the common base of the files to be merged, if available;
1296 'LOCAL' is the name of a temporary file containing the contents of
1297 the file on the current branch; 'REMOTE' is the name of a temporary
1298 file containing the contents of the file from the branch being
1299 merged; 'MERGED' contains the name of the file to which the merge
1300 tool should write the results of a successful merge.
1302 mergetool.<tool>.trustExitCode::
1303 For a custom merge command, specify whether the exit code of
1304 the merge command can be used to determine whether the merge was
1305 successful. If this is not set to true then the merge target file
1306 timestamp is checked and the merge assumed to have been successful
1307 if the file has been updated, otherwise the user is prompted to
1308 indicate the success of the merge.
1310 mergetool.keepBackup::
1311 After performing a merge, the original file with conflict markers
1312 can be saved as a file with a `.orig` extension. If this variable
1313 is set to `false` then this file is not preserved. Defaults to
1314 `true` (i.e. keep the backup files).
1316 mergetool.keepTemporaries::
1317 When invoking a custom merge tool, git uses a set of temporary
1318 files to pass to the tool. If the tool returns an error and this
1319 variable is set to `true`, then these temporary files will be
1320 preserved, otherwise they will be removed after the tool has
1321 exited. Defaults to `false`.
1324 Prompt before each invocation of the merge resolution program.
1327 The size of the window used by linkgit:git-pack-objects[1] when no
1328 window size is given on the command line. Defaults to 10.
1331 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1332 maximum depth is given on the command line. Defaults to 50.
1335 The window memory size limit used by linkgit:git-pack-objects[1]
1336 when no limit is given on the command line. The value can be
1337 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1341 An integer -1..9, indicating the compression level for objects
1342 in a pack file. -1 is the zlib default. 0 means no
1343 compression, and 1..9 are various speed/size tradeoffs, 9 being
1344 slowest. If not set, defaults to core.compression. If that is
1345 not set, defaults to -1, the zlib default, which is "a default
1346 compromise between speed and compression (currently equivalent
1349 pack.deltaCacheSize::
1350 The maximum memory in bytes used for caching deltas in
1351 linkgit:git-pack-objects[1] before writing them out to a pack.
1352 This cache is used to speed up the writing object phase by not
1353 having to recompute the final delta result once the best match
1354 for all objects is found. Repacking large repositories on machines
1355 which are tight with memory might be badly impacted by this though,
1356 especially if this cache pushes the system into swapping.
1357 A value of 0 means no limit. The smallest size of 1 byte may be
1358 used to virtually disable this cache. Defaults to 256 MiB.
1360 pack.deltaCacheLimit::
1361 The maximum size of a delta, that is cached in
1362 linkgit:git-pack-objects[1]. This cache is used to speed up the
1363 writing object phase by not having to recompute the final delta
1364 result once the best match for all objects is found. Defaults to 1000.
1367 Specifies the number of threads to spawn when searching for best
1368 delta matches. This requires that linkgit:git-pack-objects[1]
1369 be compiled with pthreads otherwise this option is ignored with a
1370 warning. This is meant to reduce packing time on multiprocessor
1371 machines. The required amount of memory for the delta search window
1372 is however multiplied by the number of threads.
1373 Specifying 0 will cause git to auto-detect the number of CPU's
1374 and set the number of threads accordingly.
1377 Specify the default pack index version. Valid values are 1 for
1378 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1379 the new pack index with capabilities for packs larger than 4 GB
1380 as well as proper protection against the repacking of corrupted
1381 packs. Version 2 is the default. Note that version 2 is enforced
1382 and this config option ignored whenever the corresponding pack is
1385 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1386 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1387 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1388 other side may give you a repository that cannot be accessed with your
1389 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1390 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1391 the `{asterisk}.idx` file.
1393 pack.packSizeLimit::
1394 The maximum size of a pack. This setting only affects
1395 packing to a file when repacking, i.e. the git:// protocol
1396 is unaffected. It can be overridden by the `\--max-pack-size`
1397 option of linkgit:git-repack[1]. The minimum size allowed is
1398 limited to 1 MiB. The default is unlimited.
1399 Common unit suffixes of 'k', 'm', or 'g' are
1403 Allows turning on or off pagination of the output of a
1404 particular git subcommand when writing to a tty. If
1405 `\--paginate` or `\--no-pager` is specified on the command line,
1406 it takes precedence over this option. To disable pagination for
1407 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1410 The default merge strategy to use when pulling multiple branches
1414 The default merge strategy to use when pulling a single branch.
1417 Defines the action git push should take if no refspec is given
1418 on the command line, no refspec is configured in the remote, and
1419 no refspec is implied by any of the options given on the command
1420 line. Possible values are:
1422 * `nothing` do not push anything.
1423 * `matching` push all matching branches.
1424 All branches having the same name in both ends are considered to be
1425 matching. This is the default.
1426 * `tracking` push the current branch to its upstream branch.
1427 * `current` push the current branch to a branch of the same name.
1430 Whether to show a diffstat of what changed upstream since the last
1431 rebase. False by default.
1434 By default, git-receive-pack will run "git-gc --auto" after
1435 receiving data from git-push and updating refs. You can stop
1436 it by setting this variable to false.
1438 receive.fsckObjects::
1439 If it is set to true, git-receive-pack will check all received
1440 objects. It will abort in the case of a malformed object or a
1441 broken link. The result of an abort are only dangling objects.
1444 receive.unpackLimit::
1445 If the number of objects received in a push is below this
1446 limit then the objects will be unpacked into loose object
1447 files. However if the number of received objects equals or
1448 exceeds this limit then the received pack will be stored as
1449 a pack, after adding any missing delta bases. Storing the
1450 pack from a push can make the push operation complete faster,
1451 especially on slow filesystems. If not set, the value of
1452 `transfer.unpackLimit` is used instead.
1454 receive.denyDeletes::
1455 If set to true, git-receive-pack will deny a ref update that deletes
1456 the ref. Use this to prevent such a ref deletion via a push.
1458 receive.denyCurrentBranch::
1459 If set to true or "refuse", receive-pack will deny a ref update
1460 to the currently checked out branch of a non-bare repository.
1461 Such a push is potentially dangerous because it brings the HEAD
1462 out of sync with the index and working tree. If set to "warn",
1463 print a warning of such a push to stderr, but allow the push to
1464 proceed. If set to false or "ignore", allow such pushes with no
1465 message. Defaults to "warn".
1467 receive.denyNonFastForwards::
1468 If set to true, git-receive-pack will deny a ref update which is
1469 not a fast-forward. Use this to prevent such an update via a push,
1470 even if that push is forced. This configuration variable is
1471 set when initializing a shared repository.
1473 receive.updateserverinfo::
1474 If set to true, git-receive-pack will run git-update-server-info
1475 after receiving data from git-push and updating refs.
1478 The URL of a remote repository. See linkgit:git-fetch[1] or
1479 linkgit:git-push[1].
1481 remote.<name>.pushurl::
1482 The push URL of a remote repository. See linkgit:git-push[1].
1484 remote.<name>.proxy::
1485 For remotes that require curl (http, https and ftp), the URL to
1486 the proxy to use for that remote. Set to the empty string to
1487 disable proxying for that remote.
1489 remote.<name>.fetch::
1490 The default set of "refspec" for linkgit:git-fetch[1]. See
1491 linkgit:git-fetch[1].
1493 remote.<name>.push::
1494 The default set of "refspec" for linkgit:git-push[1]. See
1495 linkgit:git-push[1].
1497 remote.<name>.mirror::
1498 If true, pushing to this remote will automatically behave
1499 as if the `\--mirror` option was given on the command line.
1501 remote.<name>.skipDefaultUpdate::
1502 If true, this remote will be skipped by default when updating
1503 using linkgit:git-fetch[1] or the `update` subcommand of
1504 linkgit:git-remote[1].
1506 remote.<name>.skipFetchAll::
1507 If true, this remote will be skipped by default when updating
1508 using linkgit:git-fetch[1] or the `update` subcommand of
1509 linkgit:git-remote[1].
1511 remote.<name>.receivepack::
1512 The default program to execute on the remote side when pushing. See
1513 option \--receive-pack of linkgit:git-push[1].
1515 remote.<name>.uploadpack::
1516 The default program to execute on the remote side when fetching. See
1517 option \--upload-pack of linkgit:git-fetch-pack[1].
1519 remote.<name>.tagopt::
1520 Setting this value to \--no-tags disables automatic tag following when
1521 fetching from remote <name>
1524 Setting this to a value <vcs> will cause git to interact with
1525 the remote with the git-remote-<vcs> helper.
1528 The list of remotes which are fetched by "git remote update
1529 <group>". See linkgit:git-remote[1].
1531 repack.usedeltabaseoffset::
1532 By default, linkgit:git-repack[1] creates packs that use
1533 delta-base offset. If you need to share your repository with
1534 git older than version 1.4.4, either directly or via a dumb
1535 protocol such as http, then you need to set this option to
1536 "false" and repack. Access from old git versions over the
1537 native protocol are unaffected by this option.
1540 When set to true, `git-rerere` updates the index with the
1541 resulting contents after it cleanly resolves conflicts using
1542 previously recorded resolution. Defaults to false.
1545 Activate recording of resolved conflicts, so that identical
1546 conflict hunks can be resolved automatically, should they
1547 be encountered again. linkgit:git-rerere[1] command is by
1548 default enabled if you create `rr-cache` directory under
1549 `$GIT_DIR`, but can be disabled by setting this option to false.
1551 sendemail.identity::
1552 A configuration identity. When given, causes values in the
1553 'sendemail.<identity>' subsection to take precedence over
1554 values in the 'sendemail' section. The default identity is
1555 the value of 'sendemail.identity'.
1557 sendemail.smtpencryption::
1558 See linkgit:git-send-email[1] for description. Note that this
1559 setting is not subject to the 'identity' mechanism.
1562 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1564 sendemail.<identity>.*::
1565 Identity-specific versions of the 'sendemail.*' parameters
1566 found below, taking precedence over those when the this
1567 identity is selected, through command-line or
1568 'sendemail.identity'.
1570 sendemail.aliasesfile::
1571 sendemail.aliasfiletype::
1575 sendemail.chainreplyto::
1577 sendemail.envelopesender::
1579 sendemail.multiedit::
1580 sendemail.signedoffbycc::
1581 sendemail.smtppass::
1582 sendemail.suppresscc::
1583 sendemail.suppressfrom::
1585 sendemail.smtpserver::
1586 sendemail.smtpserverport::
1587 sendemail.smtpuser::
1589 sendemail.validate::
1590 See linkgit:git-send-email[1] for description.
1592 sendemail.signedoffcc::
1593 Deprecated alias for 'sendemail.signedoffbycc'.
1595 showbranch.default::
1596 The default set of branches for linkgit:git-show-branch[1].
1597 See linkgit:git-show-branch[1].
1599 status.relativePaths::
1600 By default, linkgit:git-status[1] shows paths relative to the
1601 current directory. Setting this variable to `false` shows paths
1602 relative to the repository root (this was the default for git
1605 status.showUntrackedFiles::
1606 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1607 files which are not currently tracked by Git. Directories which
1608 contain only untracked files, are shown with the directory name
1609 only. Showing untracked files means that Git needs to lstat() all
1610 all the files in the whole repository, which might be slow on some
1611 systems. So, this variable controls how the commands displays
1612 the untracked files. Possible values are:
1615 - 'no' - Show no untracked files
1616 - 'normal' - Shows untracked files and directories
1617 - 'all' - Shows also individual files in untracked directories.
1620 If this variable is not specified, it defaults to 'normal'.
1621 This variable can be overridden with the -u|--untracked-files option
1622 of linkgit:git-status[1] and linkgit:git-commit[1].
1625 This variable can be used to restrict the permission bits of
1626 tar archive entries. The default is 0002, which turns off the
1627 world write bit. The special value "user" indicates that the
1628 archiving user's umask will be used instead. See umask(2) and
1629 linkgit:git-archive[1].
1631 transfer.unpackLimit::
1632 When `fetch.unpackLimit` or `receive.unpackLimit` are
1633 not set, the value of this variable is used instead.
1634 The default value is 100.
1636 url.<base>.insteadOf::
1637 Any URL that starts with this value will be rewritten to
1638 start, instead, with <base>. In cases where some site serves a
1639 large number of repositories, and serves them with multiple
1640 access methods, and some users need to use different access
1641 methods, this feature allows people to specify any of the
1642 equivalent URLs and have git automatically rewrite the URL to
1643 the best alternative for the particular user, even for a
1644 never-before-seen repository on the site. When more than one
1645 insteadOf strings match a given URL, the longest match is used.
1647 url.<base>.pushInsteadOf::
1648 Any URL that starts with this value will not be pushed to;
1649 instead, it will be rewritten to start with <base>, and the
1650 resulting URL will be pushed to. In cases where some site serves
1651 a large number of repositories, and serves them with multiple
1652 access methods, some of which do not allow push, this feature
1653 allows people to specify a pull-only URL and have git
1654 automatically use an appropriate URL to push, even for a
1655 never-before-seen repository on the site. When more than one
1656 pushInsteadOf strings match a given URL, the longest match is
1657 used. If a remote has an explicit pushurl, git will ignore this
1658 setting for that remote.
1661 Your email address to be recorded in any newly created commits.
1662 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1663 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1666 Your full name to be recorded in any newly created commits.
1667 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1668 environment variables. See linkgit:git-commit-tree[1].
1671 If linkgit:git-tag[1] is not selecting the key you want it to
1672 automatically when creating a signed tag, you can override the
1673 default selection with this variable. This option is passed
1674 unchanged to gpg's --local-user parameter, so you may specify a key
1675 using any method that gpg supports.
1678 Specify a web browser that may be used by some commands.
1679 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]