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.
136 If false, the executable bit differences between the index and
137 the working copy are ignored; useful on broken filesystems like FAT.
138 See linkgit:git-update-index[1].
140 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
141 will probe and set core.fileMode false if appropriate when the
142 repository is created.
144 core.ignoreCygwinFSTricks::
145 This option is only used by Cygwin implementation of Git. If false,
146 the Cygwin stat() and lstat() functions are used. This may be useful
147 if your repository consists of a few separate directories joined in
148 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
149 whenever it is possible and falls back to Cygwin functions only to
150 handle symbol links. The native mode is more than twice faster than
151 normal Cygwin l/stat() functions. True by default, unless core.filemode
152 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
153 POSIX emulation is required to support core.filemode.
156 If true, this option enables various workarounds to enable
157 git to work better on filesystems that are not case sensitive,
158 like FAT. For example, if a directory listing finds
159 "makefile" when git expects "Makefile", git will assume
160 it is really the same file, and continue to remember it as
163 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
164 will probe and set core.ignorecase true if appropriate when the repository
168 If false, the ctime differences between the index and the
169 working copy are ignored; useful when the inode change time
170 is regularly modified by something outside Git (file system
171 crawlers and some backup systems).
172 See linkgit:git-update-index[1]. True by default.
175 The commands that output paths (e.g. 'ls-files',
176 'diff'), when not given the `-z` option, will quote
177 "unusual" characters in the pathname by enclosing the
178 pathname in a double-quote pair and with backslashes the
179 same way strings in C source code are quoted. If this
180 variable is set to false, the bytes higher than 0x80 are
181 not quoted but output as verbatim. Note that double
182 quote, backslash and control characters are always
183 quoted without `-z` regardless of the setting of this
187 If true, makes git convert `CRLF` at the end of lines in text files to
188 `LF` when reading from the filesystem, and convert in reverse when
189 writing to the filesystem. The variable can be set to
190 'input', in which case the conversion happens only while
191 reading from the filesystem but files are written out with
192 `LF` at the end of lines. A file is considered
193 "text" (i.e. be subjected to the autocrlf mechanism) based on
194 the file's `crlf` attribute, or if `crlf` is unspecified,
195 based on the file's contents. See linkgit:gitattributes[5].
198 If true, makes git check if converting `CRLF` as controlled by
199 `core.autocrlf` is reversible. Git will verify if a command
200 modifies a file in the work tree either directly or indirectly.
201 For example, committing a file followed by checking out the
202 same file should yield the original file in the work tree. If
203 this is not the case for the current setting of
204 `core.autocrlf`, git will reject the file. The variable can
205 be set to "warn", in which case git will only warn about an
206 irreversible conversion but continue the operation.
208 CRLF conversion bears a slight chance of corrupting data.
209 autocrlf=true will convert CRLF to LF during commit and LF to
210 CRLF during checkout. A file that contains a mixture of LF and
211 CRLF before the commit cannot be recreated by git. For text
212 files this is the right thing to do: it corrects line endings
213 such that we have only LF line endings in the repository.
214 But for binary files that are accidentally classified as text the
215 conversion can corrupt data.
217 If you recognize such corruption early you can easily fix it by
218 setting the conversion type explicitly in .gitattributes. Right
219 after committing you still have the original file in your work
220 tree and this file is not yet corrupted. You can explicitly tell
221 git that this file is binary and git will handle the file
224 Unfortunately, the desired effect of cleaning up text files with
225 mixed line endings and the undesired effect of corrupting binary
226 files cannot be distinguished. In both cases CRLFs are removed
227 in an irreversible way. For text files this is the right thing
228 to do because CRLFs are line endings, while for binary files
229 converting CRLFs corrupts data.
231 Note, this safety check does not mean that a checkout will generate a
232 file identical to the original file for a different setting of
233 `core.autocrlf`, but only for the current one. For example, a text
234 file with `LF` would be accepted with `core.autocrlf=input` and could
235 later be checked out with `core.autocrlf=true`, in which case the
236 resulting file would contain `CRLF`, although the original file
237 contained `LF`. However, in both work trees the line endings would be
238 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
239 file with mixed line endings would be reported by the `core.safecrlf`
243 If false, symbolic links are checked out as small plain files that
244 contain the link text. linkgit:git-update-index[1] and
245 linkgit:git-add[1] will not change the recorded type to regular
246 file. Useful on filesystems like FAT that do not support
249 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
250 will probe and set core.symlinks false if appropriate when the repository
254 A "proxy command" to execute (as 'command host port') instead
255 of establishing direct connection to the remote server when
256 using the git protocol for fetching. If the variable value is
257 in the "COMMAND for DOMAIN" format, the command is applied only
258 on hostnames ending with the specified domain string. This variable
259 may be set multiple times and is matched in the given order;
260 the first match wins.
262 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
263 (which always applies universally, without the special "for"
266 The special string `none` can be used as the proxy command to
267 specify that no proxy be used for a given domain pattern.
268 This is useful for excluding servers inside a firewall from
269 proxy use, while defaulting to a common proxy for external domains.
272 If true, commands which modify both the working tree and the index
273 will mark the updated paths with the "assume unchanged" bit in the
274 index. These marked files are then assumed to stay unchanged in the
275 working copy, until you mark them otherwise manually - Git will not
276 detect the file changes by lstat() calls. This is useful on systems
277 where those are very slow, such as Microsoft Windows.
278 See linkgit:git-update-index[1].
281 core.preferSymlinkRefs::
282 Instead of the default "symref" format for HEAD
283 and other symbolic reference files, use symbolic links.
284 This is sometimes needed to work with old scripts that
285 expect HEAD to be a symbolic link.
288 If true this repository is assumed to be 'bare' and has no
289 working directory associated with it. If this is the case a
290 number of commands that require a working directory will be
291 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
293 This setting is automatically guessed by linkgit:git-clone[1] or
294 linkgit:git-init[1] when the repository was created. By default a
295 repository that ends in "/.git" is assumed to be not bare (bare =
296 false), while all other repositories are assumed to be bare (bare
300 Set the path to the working tree. The value will not be
301 used in combination with repositories found automatically in
302 a .git directory (i.e. $GIT_DIR is not set).
303 This can be overridden by the GIT_WORK_TREE environment
304 variable and the '--work-tree' command line option. It can be
305 a absolute path or relative path to the directory specified by
306 --git-dir or GIT_DIR.
307 Note: If --git-dir or GIT_DIR are specified but none of
308 --work-tree, GIT_WORK_TREE and core.worktree is specified,
309 the current working directory is regarded as the top directory
310 of your working tree.
312 core.logAllRefUpdates::
313 Enable the reflog. Updates to a ref <ref> is logged to the file
314 "$GIT_DIR/logs/<ref>", by appending the new and old
315 SHA1, the date/time and the reason of the update, but
316 only when the file exists. If this configuration
317 variable is set to true, missing "$GIT_DIR/logs/<ref>"
318 file is automatically created for branch heads.
320 This information can be used to determine what commit
321 was the tip of a branch "2 days ago".
323 This value is true by default in a repository that has
324 a working directory associated with it, and false by
325 default in a bare repository.
327 core.repositoryFormatVersion::
328 Internal variable identifying the repository format and layout
331 core.sharedRepository::
332 When 'group' (or 'true'), the repository is made shareable between
333 several users in a group (making sure all the files and objects are
334 group-writable). When 'all' (or 'world' or 'everybody'), the
335 repository will be readable by all users, additionally to being
336 group-shareable. When 'umask' (or 'false'), git will use permissions
337 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
338 files in the repository will have this mode value. '0xxx' will override
339 user's umask value (whereas the other options will only override
340 requested parts of the user's umask value). Examples: '0660' will make
341 the repo read/write-able for the owner and group, but inaccessible to
342 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
343 repository that is group-readable but not group-writable.
344 See linkgit:git-init[1]. False by default.
346 core.warnAmbiguousRefs::
347 If true, git will warn you if the ref name you passed it is ambiguous
348 and might match multiple refs in the .git/refs/ tree. True by default.
351 An integer -1..9, indicating a default compression level.
352 -1 is the zlib default. 0 means no compression,
353 and 1..9 are various speed/size tradeoffs, 9 being slowest.
354 If set, this provides a default to other compression variables,
355 such as 'core.loosecompression' and 'pack.compression'.
357 core.loosecompression::
358 An integer -1..9, indicating the compression level for objects that
359 are not in a pack file. -1 is the zlib default. 0 means no
360 compression, and 1..9 are various speed/size tradeoffs, 9 being
361 slowest. If not set, defaults to core.compression. If that is
362 not set, defaults to 1 (best speed).
364 core.packedGitWindowSize::
365 Number of bytes of a pack file to map into memory in a
366 single mapping operation. Larger window sizes may allow
367 your system to process a smaller number of large pack files
368 more quickly. Smaller window sizes will negatively affect
369 performance due to increased calls to the operating system's
370 memory manager, but may improve performance when accessing
371 a large number of large pack files.
373 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
374 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
375 be reasonable for all users/operating systems. You probably do
376 not need to adjust this value.
378 Common unit suffixes of 'k', 'm', or 'g' are supported.
380 core.packedGitLimit::
381 Maximum number of bytes to map simultaneously into memory
382 from pack files. If Git needs to access more than this many
383 bytes at once to complete an operation it will unmap existing
384 regions to reclaim virtual address space within the process.
386 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
387 This should be reasonable for all users/operating systems, except on
388 the largest projects. You probably do not need to adjust this value.
390 Common unit suffixes of 'k', 'm', or 'g' are supported.
392 core.deltaBaseCacheLimit::
393 Maximum number of bytes to reserve for caching base objects
394 that multiple deltafied objects reference. By storing the
395 entire decompressed base objects in a cache Git is able
396 to avoid unpacking and decompressing frequently used base
397 objects multiple times.
399 Default is 16 MiB on all platforms. This should be reasonable
400 for all users/operating systems, except on the largest projects.
401 You probably do not need to adjust this value.
403 Common unit suffixes of 'k', 'm', or 'g' are supported.
406 In addition to '.gitignore' (per-directory) and
407 '.git/info/exclude', git looks into this file for patterns
408 of files which are not meant to be tracked. "{tilde}/" is expanded
409 to the value of `$HOME` and "{tilde}user/" to the specified user's
410 home directory. See linkgit:gitignore[5].
413 Commands such as `commit` and `tag` that lets you edit
414 messages by launching an editor uses the value of this
415 variable when it is set, and the environment variable
416 `GIT_EDITOR` is not set. See linkgit:git-var[1].
419 The command that git will use to paginate output. Can
420 be overridden with the `GIT_PAGER` environment
421 variable. Note that git sets the `LESS` environment
422 variable to `FRSX` if it is unset when it runs the
423 pager. One can change these settings by setting the
424 `LESS` variable to some other value. Alternately,
425 these settings can be overridden on a project or
426 global basis by setting the `core.pager` option.
427 Setting `core.pager` has no affect on the `LESS`
428 environment variable behaviour above, so if you want
429 to override git's default settings this way, you need
430 to be explicit. For example, to disable the S option
431 in a backward compatible manner, set `core.pager`
432 to `less -+$LESS -FRX`. This will be passed to the
433 shell by git, which will translate the final command to
434 `LESS=FRSX less -+FRSX -FRX`.
437 A comma separated list of common whitespace problems to
438 notice. 'git-diff' will use `color.diff.whitespace` to
439 highlight them, and 'git-apply --whitespace=error' will
440 consider them as errors. You can prefix `-` to disable
441 any of them (e.g. `-trailing-space`):
443 * `blank-at-eol` treats trailing whitespaces at the end of the line
444 as an error (enabled by default).
445 * `space-before-tab` treats a space character that appears immediately
446 before a tab character in the initial indent part of the line as an
447 error (enabled by default).
448 * `indent-with-non-tab` treats a line that is indented with 8 or more
449 space characters as an error (not enabled by default).
450 * `blank-at-eof` treats blank lines added at the end of file as an error
451 (enabled by default).
452 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
454 * `cr-at-eol` treats a carriage-return at the end of line as
455 part of the line terminator, i.e. with it, `trailing-space`
456 does not trigger if the character before such a carriage-return
457 is not a whitespace (not enabled by default).
459 core.fsyncobjectfiles::
460 This boolean will enable 'fsync()' when writing object files.
462 This is a total waste of time and effort on a filesystem that orders
463 data writes properly, but can be useful for filesystems that do not use
464 journalling (traditional UNIX filesystems) or that only journal metadata
465 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
468 Enable parallel index preload for operations like 'git diff'
470 This can speed up operations like 'git diff' and 'git status' especially
471 on filesystems like NFS that have weak caching semantics and thus
472 relatively high IO latencies. With this set to 'true', git will do the
473 index comparison to the filesystem data in parallel, allowing
477 You can set this to 'link', in which case a hardlink followed by
478 a delete of the source are used to make sure that object creation
479 will not overwrite existing objects.
481 On some file system/operating system combinations, this is unreliable.
482 Set this config setting to 'rename' there; However, This will remove the
483 check that makes sure that existing object files will not get overwritten.
486 When showing commit messages, also show notes which are stored in
487 the given ref. This ref is expected to contain files named
488 after the full SHA-1 of the commit they annotate.
490 If such a file exists in the given ref, the referenced blob is read, and
491 appended to the commit message, separated by a "Notes:" line. If the
492 given ref itself does not exist, it is not an error, but means that no
493 notes should be printed.
495 This setting defaults to "refs/notes/commits", and can be overridden by
496 the `GIT_NOTES_REF` environment variable.
499 Tells 'git-add' to continue adding files when some files cannot be
500 added due to indexing errors. Equivalent to the '--ignore-errors'
501 option of linkgit:git-add[1].
504 Command aliases for the linkgit:git[1] command wrapper - e.g.
505 after defining "alias.last = cat-file commit HEAD", the invocation
506 "git last" is equivalent to "git cat-file commit HEAD". To avoid
507 confusion and troubles with script usage, aliases that
508 hide existing git commands are ignored. Arguments are split by
509 spaces, the usual shell quoting and escaping is supported.
510 quote pair and a backslash can be used to quote them.
512 If the alias expansion is prefixed with an exclamation point,
513 it will be treated as a shell command. For example, defining
514 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
515 "git new" is equivalent to running the shell command
516 "gitk --all --not ORIG_HEAD". Note that shell commands will be
517 executed from the top-level directory of a repository, which may
518 not necessarily be the current directory.
520 apply.ignorewhitespace::
521 When set to 'change', tells 'git-apply' to ignore changes in
522 whitespace, in the same way as the '--ignore-space-change'
524 When set to one of: no, none, never, false tells 'git-apply' to
525 respect all whitespace differences.
526 See linkgit:git-apply[1].
529 Tells 'git-apply' how to handle whitespaces, in the same way
530 as the '--whitespace' option. See linkgit:git-apply[1].
532 branch.autosetupmerge::
533 Tells 'git-branch' and 'git-checkout' to setup new branches
534 so that linkgit:git-pull[1] will appropriately merge from the
535 starting point branch. Note that even if this option is not set,
536 this behavior can be chosen per-branch using the `--track`
537 and `--no-track` options. The valid settings are: `false` -- no
538 automatic setup is done; `true` -- automatic setup is done when the
539 starting point is a remote branch; `always` -- automatic setup is
540 done when the starting point is either a local branch or remote
541 branch. This option defaults to true.
543 branch.autosetuprebase::
544 When a new branch is created with 'git-branch' or 'git-checkout'
545 that tracks another branch, this variable tells git to set
546 up pull to rebase instead of merge (see "branch.<name>.rebase").
547 When `never`, rebase is never automatically set to true.
548 When `local`, rebase is set to true for tracked branches of
549 other local branches.
550 When `remote`, rebase is set to true for tracked branches of
552 When `always`, rebase will be set to true for all tracking
554 See "branch.autosetupmerge" for details on how to set up a
555 branch to track another branch.
556 This option defaults to never.
558 branch.<name>.remote::
559 When in branch <name>, it tells 'git-fetch' and 'git-push' which
560 remote to fetch from/push to. It defaults to `origin` if no remote is
561 configured. `origin` is also used if you are not on any branch.
563 branch.<name>.merge::
564 Defines, together with branch.<name>.remote, the upstream branch
565 for the given branch. It tells 'git-fetch'/'git-pull' which
566 branch to merge and can also affect 'git-push' (see push.default).
567 When in branch <name>, it tells 'git-fetch' the default
568 refspec to be marked for merging in FETCH_HEAD. The value is
569 handled like the remote part of a refspec, and must match a
570 ref which is fetched from the remote given by
571 "branch.<name>.remote".
572 The merge information is used by 'git-pull' (which at first calls
573 'git-fetch') to lookup the default branch for merging. Without
574 this option, 'git-pull' defaults to merge the first refspec fetched.
575 Specify multiple values to get an octopus merge.
576 If you wish to setup 'git-pull' so that it merges into <name> from
577 another branch in the local repository, you can point
578 branch.<name>.merge to the desired branch, and use the special setting
579 `.` (a period) for branch.<name>.remote.
581 branch.<name>.mergeoptions::
582 Sets default options for merging into branch <name>. The syntax and
583 supported options are the same as those of linkgit:git-merge[1], but
584 option values containing whitespace characters are currently not
587 branch.<name>.rebase::
588 When true, rebase the branch <name> on top of the fetched branch,
589 instead of merging the default branch from the default remote when
591 *NOTE*: this is a possibly dangerous operation; do *not* use
592 it unless you understand the implications (see linkgit:git-rebase[1]
596 Specify the command to invoke the specified browser. The
597 specified command is evaluated in shell with the URLs passed
598 as arguments. (See linkgit:git-web--browse[1].)
600 browser.<tool>.path::
601 Override the path for the given tool that may be used to
602 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
603 working repository in gitweb (see linkgit:git-instaweb[1]).
606 A boolean to make git-clean do nothing unless given -f
607 or -n. Defaults to true.
610 A boolean to enable/disable color in the output of
611 linkgit:git-branch[1]. May be set to `always`,
612 `false` (or `never`) or `auto` (or `true`), in which case colors are used
613 only when the output is to a terminal. Defaults to false.
615 color.branch.<slot>::
616 Use customized color for branch coloration. `<slot>` is one of
617 `current` (the current branch), `local` (a local branch),
618 `remote` (a tracking branch in refs/remotes/), `plain` (other
621 The value for these configuration variables is a list of colors (at most
622 two) and attributes (at most one), separated by spaces. The colors
623 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
624 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
625 `blink` and `reverse`. The first color given is the foreground; the
626 second is the background. The position of the attribute, if any,
630 When set to `always`, always use colors in patch.
631 When false (or `never`), never. When set to `true` or `auto`, use
632 colors only when the output is to the terminal. Defaults to false.
635 Use customized color for diff colorization. `<slot>` specifies
636 which part of the patch to use the specified color, and is one
637 of `plain` (context text), `meta` (metainformation), `frag`
638 (hunk header), 'func' (function in hunk header), `old` (removed lines),
639 `new` (added lines), `commit` (commit headers), or `whitespace`
640 (highlighting whitespace errors). The values of these variables may be
641 specified as in color.branch.<slot>.
644 When set to `always`, always highlight matches. When `false` (or
645 `never`), never. When set to `true` or `auto`, use color only
646 when the output is written to the terminal. Defaults to `false`.
648 color.grep.external::
649 The string value of this variable is passed to an external 'grep'
650 command as a command line option if match highlighting is turned
651 on. If set to an empty string, no option is passed at all,
652 turning off coloring for external 'grep' calls; this is the default.
653 For GNU grep, set it to `--color=always` to highlight matches even
654 when a pager is used.
657 Use customized color for matches. The value of this variable
658 may be specified as in color.branch.<slot>. It is passed using
659 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
660 calling an external 'grep'.
663 When set to `always`, always use colors for interactive prompts
664 and displays (such as those used by "git-add --interactive").
665 When false (or `never`), never. When set to `true` or `auto`, use
666 colors only when the output is to the terminal. Defaults to false.
668 color.interactive.<slot>::
669 Use customized color for 'git-add --interactive'
670 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
671 four distinct types of normal output from interactive
672 commands. The values of these variables may be specified as
673 in color.branch.<slot>.
676 A boolean to enable/disable colored output when the pager is in
677 use (default is true).
680 A boolean to enable/disable color in the output of
681 linkgit:git-show-branch[1]. May be set to `always`,
682 `false` (or `never`) or `auto` (or `true`), in which case colors are used
683 only when the output is to a terminal. Defaults to false.
686 A boolean to enable/disable color in the output of
687 linkgit:git-status[1]. May be set to `always`,
688 `false` (or `never`) or `auto` (or `true`), in which case colors are used
689 only when the output is to a terminal. Defaults to false.
691 color.status.<slot>::
692 Use customized color for status colorization. `<slot>` is
693 one of `header` (the header text of the status message),
694 `added` or `updated` (files which are added but not committed),
695 `changed` (files which are changed but not added in the index),
696 `untracked` (files which are not tracked by git), or
697 `nobranch` (the color the 'no branch' warning is shown in, defaulting
698 to red). The values of these variables may be specified as in
702 When set to `always`, always use colors in all git commands which
703 are capable of colored output. When false (or `never`), never. When
704 set to `true` or `auto`, use colors only when the output is to the
705 terminal. When more specific variables of color.* are set, they always
706 take precedence over this setting. Defaults to false.
709 Specify a file to use as the template for new commit messages.
710 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
711 specified user's home directory.
713 diff.autorefreshindex::
714 When using 'git-diff' to compare with work tree
715 files, do not consider stat-only change as changed.
716 Instead, silently run `git update-index --refresh` to
717 update the cached stat information for paths whose
718 contents in the work tree match the contents in the
719 index. This option defaults to true. Note that this
720 affects only 'git-diff' Porcelain, and not lower level
721 'diff' commands, such as 'git-diff-files'.
724 If this config variable is set, diff generation is not
725 performed using the internal diff machinery, but using the
726 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
727 environment variable. The command is called with parameters
728 as described under "git Diffs" in linkgit:git[1]. Note: if
729 you want to use an external diff program only on a subset of
730 your files, you might want to use linkgit:gitattributes[5] instead.
732 diff.mnemonicprefix::
733 If set, 'git-diff' uses a prefix pair that is different from the
734 standard "a/" and "b/" depending on what is being compared. When
735 this configuration is in effect, reverse diff output also swaps
736 the order of the prefixes:
738 compares the (i)ndex and the (w)ork tree;
740 compares a (c)ommit and the (w)ork tree;
741 'git diff --cached';;
742 compares a (c)ommit and the (i)ndex;
743 'git-diff HEAD:file1 file2';;
744 compares an (o)bject and a (w)ork tree entity;
745 'git diff --no-index a b';;
746 compares two non-git things (1) and (2).
749 The number of files to consider when performing the copy/rename
750 detection; equivalent to the 'git-diff' option '-l'.
753 Tells git to detect renames. If set to any boolean value, it
754 will enable basic rename detection. If set to "copies" or
755 "copy", it will detect copies, as well.
757 diff.suppressBlankEmpty::
758 A boolean to inhibit the standard behavior of printing a space
759 before each empty output line. Defaults to false.
762 Controls which diff tool is used. `diff.tool` overrides
763 `merge.tool` when used by linkgit:git-difftool[1] and has
764 the same valid values as `merge.tool` minus "tortoisemerge"
767 difftool.<tool>.path::
768 Override the path for the given tool. This is useful in case
769 your tool is not in the PATH.
771 difftool.<tool>.cmd::
772 Specify the command to invoke the specified diff tool.
773 The specified command is evaluated in shell with the following
774 variables available: 'LOCAL' is set to the name of the temporary
775 file containing the contents of the diff pre-image and 'REMOTE'
776 is set to the name of the temporary file containing the contents
777 of the diff post-image.
780 Prompt before each invocation of the diff tool.
783 A POSIX Extended Regular Expression used to determine what is a "word"
784 when performing word-by-word difference calculations. Character
785 sequences that match the regular expression are "words", all other
786 characters are *ignorable* whitespace.
789 If the number of objects fetched over the git native
790 transfer is below this
791 limit, then the objects will be unpacked into loose object
792 files. However if the number of received objects equals or
793 exceeds this limit then the received pack will be stored as
794 a pack, after adding any missing delta bases. Storing the
795 pack from a push can make the push operation complete faster,
796 especially on slow filesystems. If not set, the value of
797 `transfer.unpackLimit` is used instead.
800 Enable multipart/mixed attachments as the default for
801 'format-patch'. The value can also be a double quoted string
802 which will enable attachments as the default and set the
803 value as the boundary. See the --attach option in
804 linkgit:git-format-patch[1].
807 A boolean which can enable or disable sequence numbers in patch
808 subjects. It defaults to "auto" which enables it only if there
809 is more than one patch. It can be enabled or disabled for all
810 messages by setting it to "true" or "false". See --numbered
811 option in linkgit:git-format-patch[1].
814 Additional email headers to include in a patch to be submitted
815 by mail. See linkgit:git-format-patch[1].
818 Additional "Cc:" headers to include in a patch to be submitted
819 by mail. See the --cc option in linkgit:git-format-patch[1].
821 format.subjectprefix::
822 The default for format-patch is to output files with the '[PATCH]'
823 subject prefix. Use this variable to change that prefix.
826 The default for format-patch is to output files with the suffix
827 `.patch`. Use this variable to change that suffix (make sure to
828 include the dot if you want it).
831 The default pretty format for log/show/whatchanged command,
832 See linkgit:git-log[1], linkgit:git-show[1],
833 linkgit:git-whatchanged[1].
836 The default threading style for 'git-format-patch'. Can be
837 either a boolean value, `shallow` or `deep`. `shallow`
838 threading makes every mail a reply to the head of the series,
839 where the head is chosen from the cover letter, the
840 `\--in-reply-to`, and the first patch mail, in this order.
841 `deep` threading makes every mail a reply to the previous one.
842 A true boolean value is the same as `shallow`, and a false
843 value disables threading.
846 A boolean value which lets you enable the `-s/--signoff` option of
847 format-patch by default. *Note:* Adding the Signed-off-by: line to a
848 patch should be a conscious act and means that you certify you have
849 the rights to submit this work under the same open source license.
850 Please see the 'SubmittingPatches' document for further discussion.
852 gc.aggressiveWindow::
853 The window size parameter used in the delta compression
854 algorithm used by 'git-gc --aggressive'. This defaults
858 When there are approximately more than this many loose
859 objects in the repository, `git gc --auto` will pack them.
860 Some Porcelain commands use this command to perform a
861 light-weight garbage collection from time to time. The
862 default value is 6700. Setting this to 0 disables it.
865 When there are more than this many packs that are not
866 marked with `*.keep` file in the repository, `git gc
867 --auto` consolidates them into one larger pack. The
868 default value is 50. Setting this to 0 disables it.
871 'git-gc' does not run `git pack-refs` in a bare repository by
872 default so that older dumb-transport clients can still fetch
873 from the repository. Setting this to `true` lets 'git-gc'
874 to run `git pack-refs`. Setting this to `false` tells
875 'git-gc' never to run `git pack-refs`. The default setting is
876 `notbare`. Enable it only when you know you do not have to
877 support such clients. The default setting will change to `true`
878 at some stage, and setting this to `false` will continue to
879 prevent `git pack-refs` from being run from 'git-gc'.
882 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
883 Override the grace period with this config variable. The value
884 "now" may be used to disable this grace period and always prune
885 unreachable objects immediately.
888 'git-reflog expire' removes reflog entries older than
889 this time; defaults to 90 days.
891 gc.reflogexpireunreachable::
892 'git-reflog expire' removes reflog entries older than
893 this time and are not reachable from the current tip;
897 Records of conflicted merge you resolved earlier are
898 kept for this many days when 'git-rerere gc' is run.
899 The default is 60 days. See linkgit:git-rerere[1].
901 gc.rerereunresolved::
902 Records of conflicted merge you have not resolved are
903 kept for this many days when 'git-rerere gc' is run.
904 The default is 15 days. See linkgit:git-rerere[1].
906 gitcvs.commitmsgannotation::
907 Append this string to each commit message. Set to empty string
908 to disable this feature. Defaults to "via git-CVS emulator".
911 Whether the CVS server interface is enabled for this repository.
912 See linkgit:git-cvsserver[1].
915 Path to a log file where the CVS server interface well... logs
916 various stuff. See linkgit:git-cvsserver[1].
919 If true, the server will look up the `crlf` attribute for
920 files to determine the '-k' modes to use. If `crlf` is set,
921 the '-k' mode will be left blank, so cvs clients will
922 treat it as text. If `crlf` is explicitly unset, the file
923 will be set with '-kb' mode, which suppresses any newline munging
924 the client might otherwise do. If `crlf` is not specified,
925 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
928 This is used if 'gitcvs.usecrlfattr' does not resolve
929 the correct '-kb' mode to use. If true, all
930 unresolved files are sent to the client in
931 mode '-kb'. This causes the client to treat them
932 as binary files, which suppresses any newline munging it
933 otherwise might do. Alternatively, if it is set to "guess",
934 then the contents of the file are examined to decide if
935 it is binary, similar to 'core.autocrlf'.
938 Database used by git-cvsserver to cache revision information
939 derived from the git repository. The exact meaning depends on the
940 used database driver, for SQLite (which is the default driver) this
941 is a filename. Supports variable substitution (see
942 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
943 Default: '%Ggitcvs.%m.sqlite'
946 Used Perl DBI driver. You can specify any available driver
947 for this here, but it might not work. git-cvsserver is tested
948 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
949 reported *not* to work with 'DBD::mysql'. Experimental feature.
950 May not contain double colons (`:`). Default: 'SQLite'.
951 See linkgit:git-cvsserver[1].
953 gitcvs.dbuser, gitcvs.dbpass::
954 Database user and password. Only useful if setting 'gitcvs.dbdriver',
955 since SQLite has no concept of database users and/or passwords.
956 'gitcvs.dbuser' supports variable substitution (see
957 linkgit:git-cvsserver[1] for details).
959 gitcvs.dbTableNamePrefix::
960 Database table name prefix. Prepended to the names of any
961 database tables used, allowing a single database to be used
962 for several repositories. Supports variable substitution (see
963 linkgit:git-cvsserver[1] for details). Any non-alphabetic
964 characters will be replaced with underscores.
966 All gitcvs variables except for 'gitcvs.usecrlfattr' and
967 'gitcvs.allbinary' can also be specified as
968 'gitcvs.<access_method>.<varname>' (where 'access_method'
969 is one of "ext" and "pserver") to make them apply only for the given
973 Defines how wide the commit message window is in the
974 linkgit:git-gui[1]. "75" is the default.
977 Specifies how many context lines should be used in calls to diff
978 made by the linkgit:git-gui[1]. The default is "5".
981 Specifies the default encoding to use for displaying of
982 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
983 It can be overridden by setting the 'encoding' attribute
984 for relevant files (see linkgit:gitattributes[5]).
985 If this option is not set, the tools default to the
988 gui.matchtrackingbranch::
989 Determines if new branches created with linkgit:git-gui[1] should
990 default to tracking remote branches with matching names or
991 not. Default: "false".
993 gui.newbranchtemplate::
994 Is used as suggested name when creating new branches using the
997 gui.pruneduringfetch::
998 "true" if linkgit:git-gui[1] should prune tracking branches when
999 performing a fetch. The default value is "false".
1002 Determines if linkgit:git-gui[1] should trust the file modification
1003 timestamp or not. By default the timestamps are not trusted.
1005 gui.spellingdictionary::
1006 Specifies the dictionary used for spell checking commit messages in
1007 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1011 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
1012 location detection. It makes blame significantly faster on huge
1013 repositories at the expense of less thorough copy detection.
1015 gui.copyblamethreshold::
1016 Specifies the threshold to use in 'git gui blame' original location
1017 detection, measured in alphanumeric characters. See the
1018 linkgit:git-blame[1] manual for more information on copy detection.
1020 gui.blamehistoryctx::
1021 Specifies the radius of history context in days to show in
1022 linkgit:gitk[1] for the selected commit, when the `Show History
1023 Context` menu item is invoked from 'git gui blame'. If this
1024 variable is set to zero, the whole history is shown.
1026 guitool.<name>.cmd::
1027 Specifies the shell command line to execute when the corresponding item
1028 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1029 mandatory for every tool. The command is executed from the root of
1030 the working directory, and in the environment it receives the name of
1031 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1032 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1033 the head is detached, 'CUR_BRANCH' is empty).
1035 guitool.<name>.needsfile::
1036 Run the tool only if a diff is selected in the GUI. It guarantees
1037 that 'FILENAME' is not empty.
1039 guitool.<name>.noconsole::
1040 Run the command silently, without creating a window to display its
1043 guitool.<name>.norescan::
1044 Don't rescan the working directory for changes after the tool
1047 guitool.<name>.confirm::
1048 Show a confirmation dialog before actually running the tool.
1050 guitool.<name>.argprompt::
1051 Request a string argument from the user, and pass it to the tool
1052 through the 'ARGS' environment variable. Since requesting an
1053 argument implies confirmation, the 'confirm' option has no effect
1054 if this is enabled. If the option is set to 'true', 'yes', or '1',
1055 the dialog uses a built-in generic prompt; otherwise the exact
1056 value of the variable is used.
1058 guitool.<name>.revprompt::
1059 Request a single valid revision from the user, and set the
1060 'REVISION' environment variable. In other aspects this option
1061 is similar to 'argprompt', and can be used together with it.
1063 guitool.<name>.revunmerged::
1064 Show only unmerged branches in the 'revprompt' subdialog.
1065 This is useful for tools similar to merge or rebase, but not
1066 for things like checkout or reset.
1068 guitool.<name>.title::
1069 Specifies the title to use for the prompt dialog. The default
1072 guitool.<name>.prompt::
1073 Specifies the general prompt string to display at the top of
1074 the dialog, before subsections for 'argprompt' and 'revprompt'.
1075 The default value includes the actual command.
1078 Specify the browser that will be used to display help in the
1079 'web' format. See linkgit:git-help[1].
1082 Override the default help format used by linkgit:git-help[1].
1083 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1084 the default. 'web' and 'html' are the same.
1087 Automatically correct and execute mistyped commands after
1088 waiting for the given number of deciseconds (0.1 sec). If more
1089 than one command can be deduced from the entered text, nothing
1090 will be executed. If the value of this option is negative,
1091 the corrected command will be executed immediately. If the
1092 value is 0 - the command will be just shown but not executed.
1093 This is the default.
1096 Override the HTTP proxy, normally configured using the 'http_proxy'
1097 environment variable (see linkgit:curl[1]). This can be overridden
1098 on a per-remote basis; see remote.<name>.proxy
1101 Whether to verify the SSL certificate when fetching or pushing
1102 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1106 File containing the SSL certificate when fetching or pushing
1107 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1111 File containing the SSL private key when fetching or pushing
1112 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1115 http.sslCertPasswordProtected::
1116 Enable git's password prompt for the SSL certificate. Otherwise
1117 OpenSSL will prompt the user, possibly many times, if the
1118 certificate or private key is encrypted. Can be overridden by the
1119 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1122 File containing the certificates to verify the peer with when
1123 fetching or pushing over HTTPS. Can be overridden by the
1124 'GIT_SSL_CAINFO' environment variable.
1127 Path containing files with the CA certificates to verify the peer
1128 with when fetching or pushing over HTTPS. Can be overridden
1129 by the 'GIT_SSL_CAPATH' environment variable.
1132 How many HTTP requests to launch in parallel. Can be overridden
1133 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1136 Maximum size in bytes of the buffer used by smart HTTP
1137 transports when POSTing data to the remote system.
1138 For requests larger than this buffer size, HTTP/1.1 and
1139 Transfer-Encoding: chunked is used to avoid creating a
1140 massive pack file locally. Default is 1 MiB, which is
1141 sufficient for most requests.
1143 http.lowSpeedLimit, http.lowSpeedTime::
1144 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1145 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1146 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1147 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1150 A boolean which disables using of EPSV ftp command by curl.
1151 This can helpful with some "poor" ftp servers which don't
1152 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1153 environment variable. Default is false (curl will use EPSV).
1155 i18n.commitEncoding::
1156 Character encoding the commit messages are stored in; git itself
1157 does not care per se, but this information is necessary e.g. when
1158 importing commits from emails or in the gitk graphical history
1159 browser (and possibly at other places in the future or in other
1160 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1162 i18n.logOutputEncoding::
1163 Character encoding the commit messages are converted to when
1164 running 'git-log' and friends.
1167 The configuration variables in the 'imap' section are described
1168 in linkgit:git-imap-send[1].
1171 Specify the program that will be used to browse your working
1172 repository in gitweb. See linkgit:git-instaweb[1].
1175 The HTTP daemon command-line to start gitweb on your working
1176 repository. See linkgit:git-instaweb[1].
1179 If true the web server started by linkgit:git-instaweb[1] will
1180 be bound to the local IP (127.0.0.1).
1182 instaweb.modulepath::
1183 The module path for an apache httpd used by linkgit:git-instaweb[1].
1186 The port number to bind the gitweb httpd to. See
1187 linkgit:git-instaweb[1].
1189 interactive.singlekey::
1190 In interactive commands, allow the user to provide one-letter
1191 input with a single key (i.e., without hitting enter).
1192 Currently this is used only by the `\--patch` mode of
1193 linkgit:git-add[1]. Note that this setting is silently
1194 ignored if portable keystroke input is not available.
1197 Set default date-time mode for the log command. Setting log.date
1198 value is similar to using 'git-log'\'s --date option. The value is one of the
1199 following alternatives: {relative,local,default,iso,rfc,short}.
1200 See linkgit:git-log[1].
1203 If true, the initial commit will be shown as a big creation event.
1204 This is equivalent to a diff against an empty tree.
1205 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1206 normally hide the root commit will now show it. True by default.
1209 The location of an augmenting mailmap file. The default
1210 mailmap, located in the root of the repository, is loaded
1211 first, then the mailmap file pointed to by this variable.
1212 The location of the mailmap file may be in a repository
1213 subdirectory, or somewhere outside of the repository itself.
1214 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1217 Specify the programs that may be used to display help in the
1218 'man' format. See linkgit:git-help[1].
1221 Specify the command to invoke the specified man viewer. The
1222 specified command is evaluated in shell with the man page
1223 passed as argument. (See linkgit:git-help[1].)
1226 Override the path for the given tool that may be used to
1227 display help in the 'man' format. See linkgit:git-help[1].
1229 include::merge-config.txt[]
1231 mergetool.<tool>.path::
1232 Override the path for the given tool. This is useful in case
1233 your tool is not in the PATH.
1235 mergetool.<tool>.cmd::
1236 Specify the command to invoke the specified merge tool. The
1237 specified command is evaluated in shell with the following
1238 variables available: 'BASE' is the name of a temporary file
1239 containing the common base of the files to be merged, if available;
1240 'LOCAL' is the name of a temporary file containing the contents of
1241 the file on the current branch; 'REMOTE' is the name of a temporary
1242 file containing the contents of the file from the branch being
1243 merged; 'MERGED' contains the name of the file to which the merge
1244 tool should write the results of a successful merge.
1246 mergetool.<tool>.trustExitCode::
1247 For a custom merge command, specify whether the exit code of
1248 the merge command can be used to determine whether the merge was
1249 successful. If this is not set to true then the merge target file
1250 timestamp is checked and the merge assumed to have been successful
1251 if the file has been updated, otherwise the user is prompted to
1252 indicate the success of the merge.
1254 mergetool.keepBackup::
1255 After performing a merge, the original file with conflict markers
1256 can be saved as a file with a `.orig` extension. If this variable
1257 is set to `false` then this file is not preserved. Defaults to
1258 `true` (i.e. keep the backup files).
1260 mergetool.keepTemporaries::
1261 When invoking a custom merge tool, git uses a set of temporary
1262 files to pass to the tool. If the tool returns an error and this
1263 variable is set to `true`, then these temporary files will be
1264 preserved, otherwise they will be removed after the tool has
1265 exited. Defaults to `false`.
1268 Prompt before each invocation of the merge resolution program.
1271 The size of the window used by linkgit:git-pack-objects[1] when no
1272 window size is given on the command line. Defaults to 10.
1275 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1276 maximum depth is given on the command line. Defaults to 50.
1279 The window memory size limit used by linkgit:git-pack-objects[1]
1280 when no limit is given on the command line. The value can be
1281 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1285 An integer -1..9, indicating the compression level for objects
1286 in a pack file. -1 is the zlib default. 0 means no
1287 compression, and 1..9 are various speed/size tradeoffs, 9 being
1288 slowest. If not set, defaults to core.compression. If that is
1289 not set, defaults to -1, the zlib default, which is "a default
1290 compromise between speed and compression (currently equivalent
1293 pack.deltaCacheSize::
1294 The maximum memory in bytes used for caching deltas in
1295 linkgit:git-pack-objects[1] before writing them out to a pack.
1296 This cache is used to speed up the writing object phase by not
1297 having to recompute the final delta result once the best match
1298 for all objects is found. Repacking large repositories on machines
1299 which are tight with memory might be badly impacted by this though,
1300 especially if this cache pushes the system into swapping.
1301 A value of 0 means no limit. The smallest size of 1 byte may be
1302 used to virtually disable this cache. Defaults to 256 MiB.
1304 pack.deltaCacheLimit::
1305 The maximum size of a delta, that is cached in
1306 linkgit:git-pack-objects[1]. This cache is used to speed up the
1307 writing object phase by not having to recompute the final delta
1308 result once the best match for all objects is found. Defaults to 1000.
1311 Specifies the number of threads to spawn when searching for best
1312 delta matches. This requires that linkgit:git-pack-objects[1]
1313 be compiled with pthreads otherwise this option is ignored with a
1314 warning. This is meant to reduce packing time on multiprocessor
1315 machines. The required amount of memory for the delta search window
1316 is however multiplied by the number of threads.
1317 Specifying 0 will cause git to auto-detect the number of CPU's
1318 and set the number of threads accordingly.
1321 Specify the default pack index version. Valid values are 1 for
1322 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1323 the new pack index with capabilities for packs larger than 4 GB
1324 as well as proper protection against the repacking of corrupted
1325 packs. Version 2 is the default. Note that version 2 is enforced
1326 and this config option ignored whenever the corresponding pack is
1329 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1330 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1331 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1332 other side may give you a repository that cannot be accessed with your
1333 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1334 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1335 the `{asterisk}.idx` file.
1337 pack.packSizeLimit::
1338 The default maximum size of a pack. This setting only affects
1339 packing to a file, i.e. the git:// protocol is unaffected. It
1340 can be overridden by the `\--max-pack-size` option of
1341 linkgit:git-repack[1].
1344 Allows turning on or off pagination of the output of a
1345 particular git subcommand when writing to a tty. If
1346 `\--paginate` or `\--no-pager` is specified on the command line,
1347 it takes precedence over this option. To disable pagination for
1348 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1351 The default merge strategy to use when pulling multiple branches
1355 The default merge strategy to use when pulling a single branch.
1358 Defines the action git push should take if no refspec is given
1359 on the command line, no refspec is configured in the remote, and
1360 no refspec is implied by any of the options given on the command
1361 line. Possible values are:
1363 * `nothing` do not push anything.
1364 * `matching` push all matching branches.
1365 All branches having the same name in both ends are considered to be
1366 matching. This is the default.
1367 * `tracking` push the current branch to its upstream branch.
1368 * `current` push the current branch to a branch of the same name.
1371 Whether to show a diffstat of what changed upstream since the last
1372 rebase. False by default.
1375 By default, git-receive-pack will run "git-gc --auto" after
1376 receiving data from git-push and updating refs. You can stop
1377 it by setting this variable to false.
1379 receive.fsckObjects::
1380 If it is set to true, git-receive-pack will check all received
1381 objects. It will abort in the case of a malformed object or a
1382 broken link. The result of an abort are only dangling objects.
1385 receive.unpackLimit::
1386 If the number of objects received in a push is below this
1387 limit then the objects will be unpacked into loose object
1388 files. However if the number of received objects equals or
1389 exceeds this limit then the received pack will be stored as
1390 a pack, after adding any missing delta bases. Storing the
1391 pack from a push can make the push operation complete faster,
1392 especially on slow filesystems. If not set, the value of
1393 `transfer.unpackLimit` is used instead.
1395 receive.denyDeletes::
1396 If set to true, git-receive-pack will deny a ref update that deletes
1397 the ref. Use this to prevent such a ref deletion via a push.
1399 receive.denyCurrentBranch::
1400 If set to true or "refuse", receive-pack will deny a ref update
1401 to the currently checked out branch of a non-bare repository.
1402 Such a push is potentially dangerous because it brings the HEAD
1403 out of sync with the index and working tree. If set to "warn",
1404 print a warning of such a push to stderr, but allow the push to
1405 proceed. If set to false or "ignore", allow such pushes with no
1406 message. Defaults to "warn".
1408 receive.denyNonFastForwards::
1409 If set to true, git-receive-pack will deny a ref update which is
1410 not a fast-forward. Use this to prevent such an update via a push,
1411 even if that push is forced. This configuration variable is
1412 set when initializing a shared repository.
1414 receive.updateserverinfo::
1415 If set to true, git-receive-pack will run git-update-server-info
1416 after receiving data from git-push and updating refs.
1419 The URL of a remote repository. See linkgit:git-fetch[1] or
1420 linkgit:git-push[1].
1422 remote.<name>.pushurl::
1423 The push URL of a remote repository. See linkgit:git-push[1].
1425 remote.<name>.proxy::
1426 For remotes that require curl (http, https and ftp), the URL to
1427 the proxy to use for that remote. Set to the empty string to
1428 disable proxying for that remote.
1430 remote.<name>.fetch::
1431 The default set of "refspec" for linkgit:git-fetch[1]. See
1432 linkgit:git-fetch[1].
1434 remote.<name>.push::
1435 The default set of "refspec" for linkgit:git-push[1]. See
1436 linkgit:git-push[1].
1438 remote.<name>.mirror::
1439 If true, pushing to this remote will automatically behave
1440 as if the `\--mirror` option was given on the command line.
1442 remote.<name>.skipDefaultUpdate::
1443 If true, this remote will be skipped by default when updating
1444 using linkgit:git-fetch[1] or the `update` subcommand of
1445 linkgit:git-remote[1].
1447 remote.<name>.skipFetchAll::
1448 If true, this remote will be skipped by default when updating
1449 using linkgit:git-fetch[1] or the `update` subcommand of
1450 linkgit:git-remote[1].
1452 remote.<name>.receivepack::
1453 The default program to execute on the remote side when pushing. See
1454 option \--receive-pack of linkgit:git-push[1].
1456 remote.<name>.uploadpack::
1457 The default program to execute on the remote side when fetching. See
1458 option \--upload-pack of linkgit:git-fetch-pack[1].
1460 remote.<name>.tagopt::
1461 Setting this value to \--no-tags disables automatic tag following when
1462 fetching from remote <name>
1465 The list of remotes which are fetched by "git remote update
1466 <group>". See linkgit:git-remote[1].
1468 repack.usedeltabaseoffset::
1469 By default, linkgit:git-repack[1] creates packs that use
1470 delta-base offset. If you need to share your repository with
1471 git older than version 1.4.4, either directly or via a dumb
1472 protocol such as http, then you need to set this option to
1473 "false" and repack. Access from old git versions over the
1474 native protocol are unaffected by this option.
1477 When set to true, `git-rerere` updates the index with the
1478 resulting contents after it cleanly resolves conflicts using
1479 previously recorded resolution. Defaults to false.
1482 Activate recording of resolved conflicts, so that identical
1483 conflict hunks can be resolved automatically, should they
1484 be encountered again. linkgit:git-rerere[1] command is by
1485 default enabled if you create `rr-cache` directory under
1486 `$GIT_DIR`, but can be disabled by setting this option to false.
1488 sendemail.identity::
1489 A configuration identity. When given, causes values in the
1490 'sendemail.<identity>' subsection to take precedence over
1491 values in the 'sendemail' section. The default identity is
1492 the value of 'sendemail.identity'.
1494 sendemail.smtpencryption::
1495 See linkgit:git-send-email[1] for description. Note that this
1496 setting is not subject to the 'identity' mechanism.
1499 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1501 sendemail.<identity>.*::
1502 Identity-specific versions of the 'sendemail.*' parameters
1503 found below, taking precedence over those when the this
1504 identity is selected, through command-line or
1505 'sendemail.identity'.
1507 sendemail.aliasesfile::
1508 sendemail.aliasfiletype::
1512 sendemail.chainreplyto::
1514 sendemail.envelopesender::
1516 sendemail.multiedit::
1517 sendemail.signedoffbycc::
1518 sendemail.smtppass::
1519 sendemail.suppresscc::
1520 sendemail.suppressfrom::
1522 sendemail.smtpserver::
1523 sendemail.smtpserverport::
1524 sendemail.smtpuser::
1526 sendemail.validate::
1527 See linkgit:git-send-email[1] for description.
1529 sendemail.signedoffcc::
1530 Deprecated alias for 'sendemail.signedoffbycc'.
1532 showbranch.default::
1533 The default set of branches for linkgit:git-show-branch[1].
1534 See linkgit:git-show-branch[1].
1536 status.relativePaths::
1537 By default, linkgit:git-status[1] shows paths relative to the
1538 current directory. Setting this variable to `false` shows paths
1539 relative to the repository root (this was the default for git
1542 status.showUntrackedFiles::
1543 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1544 files which are not currently tracked by Git. Directories which
1545 contain only untracked files, are shown with the directory name
1546 only. Showing untracked files means that Git needs to lstat() all
1547 all the files in the whole repository, which might be slow on some
1548 systems. So, this variable controls how the commands displays
1549 the untracked files. Possible values are:
1552 - 'no' - Show no untracked files
1553 - 'normal' - Shows untracked files and directories
1554 - 'all' - Shows also individual files in untracked directories.
1557 If this variable is not specified, it defaults to 'normal'.
1558 This variable can be overridden with the -u|--untracked-files option
1559 of linkgit:git-status[1] and linkgit:git-commit[1].
1562 This variable can be used to restrict the permission bits of
1563 tar archive entries. The default is 0002, which turns off the
1564 world write bit. The special value "user" indicates that the
1565 archiving user's umask will be used instead. See umask(2) and
1566 linkgit:git-archive[1].
1568 transfer.unpackLimit::
1569 When `fetch.unpackLimit` or `receive.unpackLimit` are
1570 not set, the value of this variable is used instead.
1571 The default value is 100.
1573 url.<base>.insteadOf::
1574 Any URL that starts with this value will be rewritten to
1575 start, instead, with <base>. In cases where some site serves a
1576 large number of repositories, and serves them with multiple
1577 access methods, and some users need to use different access
1578 methods, this feature allows people to specify any of the
1579 equivalent URLs and have git automatically rewrite the URL to
1580 the best alternative for the particular user, even for a
1581 never-before-seen repository on the site. When more than one
1582 insteadOf strings match a given URL, the longest match is used.
1584 url.<base>.pushInsteadOf::
1585 Any URL that starts with this value will not be pushed to;
1586 instead, it will be rewritten to start with <base>, and the
1587 resulting URL will be pushed to. In cases where some site serves
1588 a large number of repositories, and serves them with multiple
1589 access methods, some of which do not allow push, this feature
1590 allows people to specify a pull-only URL and have git
1591 automatically use an appropriate URL to push, even for a
1592 never-before-seen repository on the site. When more than one
1593 pushInsteadOf strings match a given URL, the longest match is
1594 used. If a remote has an explicit pushurl, git will ignore this
1595 setting for that remote.
1598 Your email address to be recorded in any newly created commits.
1599 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1600 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1603 Your full name to be recorded in any newly created commits.
1604 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1605 environment variables. See linkgit:git-commit-tree[1].
1608 If linkgit:git-tag[1] is not selecting the key you want it to
1609 automatically when creating a signed tag, you can override the
1610 default selection with this variable. This option is passed
1611 unchanged to gpg's --local-user parameter, so you may specify a key
1612 using any method that gpg supports.
1615 Specify a web browser that may be used by some commands.
1616 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]