Merge branch 'mo/maint-crlf-doc' into maint
[git/gitweb.git] / Documentation / config.txt
blob35e72e4a380496b20d4c606a69f8fa5ad2766b10
1 CONFIGURATION FILE
2 ------------------
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.
18 Syntax
19 ~~~~~~
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:
36 --------
37         [section "subsection"]
39 --------
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
46 don't need to.
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
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.
86 Example
87 ~~~~~~~
89         # Core variables
90         [core]
91                 ; Don't trust file modes
92                 filemode = false
94         # Our diff algorithm
95         [diff]
96                 external = /usr/local/bin/diff-wrapper
97                 renames = true
99         [branch "devel"]
100                 remote = origin
101                 merge = refs/heads/devel
103         # Proxy settings
104         [core]
105                 gitProxy="ssh" for "kernel.org"
106                 gitProxy=default-proxy ; for the rest
108 Variables
109 ~~~~~~~~~
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.
116 advice.*::
117         When set to 'true', display the given optional help message.
118         When set to 'false', do not display. The configuration variables
119         are:
122         pushNonFastForward::
123                 Advice shown when linkgit:git-push[1] refuses
124                 non-fast-forward refs. Default: true.
125         statusHints::
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.
131 core.fileMode::
132         If false, the executable bit differences between the index and
133         the working copy are ignored; useful on broken filesystems like FAT.
134         See linkgit:git-update-index[1]. True by default.
136 core.ignoreCygwinFSTricks::
137         This option is only used by Cygwin implementation of Git. If false,
138         the Cygwin stat() and lstat() functions are used. This may be useful
139         if your repository consists of a few separate directories joined in
140         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
141         whenever it is possible and falls back to Cygwin functions only to
142         handle symbol links. The native mode is more than twice faster than
143         normal Cygwin l/stat() functions. True by default, unless core.filemode
144         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
145         POSIX emulation is required to support core.filemode.
147 core.trustctime::
148         If false, the ctime differences between the index and the
149         working copy are ignored; useful when the inode change time
150         is regularly modified by something outside Git (file system
151         crawlers and some backup systems).
152         See linkgit:git-update-index[1]. True by default.
154 core.quotepath::
155         The commands that output paths (e.g. 'ls-files',
156         'diff'), when not given the `-z` option, will quote
157         "unusual" characters in the pathname by enclosing the
158         pathname in a double-quote pair and with backslashes the
159         same way strings in C source code are quoted.  If this
160         variable is set to false, the bytes higher than 0x80 are
161         not quoted but output as verbatim.  Note that double
162         quote, backslash and control characters are always
163         quoted without `-z` regardless of the setting of this
164         variable.
166 core.autocrlf::
167         If true, makes git convert `CRLF` at the end of lines in text files to
168         `LF` when reading from the filesystem, and convert in reverse when
169         writing to the filesystem.  The variable can be set to
170         'input', in which case the conversion happens only while
171         reading from the filesystem but files are written out with
172         `LF` at the end of lines.  A file is considered
173         "text" (i.e. be subjected to the autocrlf mechanism) based on
174         the file's `crlf` attribute, or if `crlf` is unspecified,
175         based on the file's contents.  See linkgit:gitattributes[5].
177 core.safecrlf::
178         If true, makes git check if converting `CRLF` as controlled by
179         `core.autocrlf` is reversible.  Git will verify if a command
180         modifies a file in the work tree either directly or indirectly.
181         For example, committing a file followed by checking out the
182         same file should yield the original file in the work tree.  If
183         this is not the case for the current setting of
184         `core.autocrlf`, git will reject the file.  The variable can
185         be set to "warn", in which case git will only warn about an
186         irreversible conversion but continue the operation.
188 CRLF conversion bears a slight chance of corrupting data.
189 autocrlf=true will convert CRLF to LF during commit and LF to
190 CRLF during checkout.  A file that contains a mixture of LF and
191 CRLF before the commit cannot be recreated by git.  For text
192 files this is the right thing to do: it corrects line endings
193 such that we have only LF line endings in the repository.
194 But for binary files that are accidentally classified as text the
195 conversion can corrupt data.
197 If you recognize such corruption early you can easily fix it by
198 setting the conversion type explicitly in .gitattributes.  Right
199 after committing you still have the original file in your work
200 tree and this file is not yet corrupted.  You can explicitly tell
201 git that this file is binary and git will handle the file
202 appropriately.
204 Unfortunately, the desired effect of cleaning up text files with
205 mixed line endings and the undesired effect of corrupting binary
206 files cannot be distinguished.  In both cases CRLFs are removed
207 in an irreversible way.  For text files this is the right thing
208 to do because CRLFs are line endings, while for binary files
209 converting CRLFs corrupts data.
211 Note, this safety check does not mean that a checkout will generate a
212 file identical to the original file for a different setting of
213 `core.autocrlf`, but only for the current one.  For example, a text
214 file with `LF` would be accepted with `core.autocrlf=input` and could
215 later be checked out with `core.autocrlf=true`, in which case the
216 resulting file would contain `CRLF`, although the original file
217 contained `LF`.  However, in both work trees the line endings would be
218 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
219 file with mixed line endings would be reported by the `core.safecrlf`
220 mechanism.
222 core.symlinks::
223         If false, symbolic links are checked out as small plain files that
224         contain the link text. linkgit:git-update-index[1] and
225         linkgit:git-add[1] will not change the recorded type to regular
226         file. Useful on filesystems like FAT that do not support
227         symbolic links. True by default.
229 core.gitProxy::
230         A "proxy command" to execute (as 'command host port') instead
231         of establishing direct connection to the remote server when
232         using the git protocol for fetching. If the variable value is
233         in the "COMMAND for DOMAIN" format, the command is applied only
234         on hostnames ending with the specified domain string. This variable
235         may be set multiple times and is matched in the given order;
236         the first match wins.
238 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
239 (which always applies universally, without the special "for"
240 handling).
242 The special string `none` can be used as the proxy command to
243 specify that no proxy be used for a given domain pattern.
244 This is useful for excluding servers inside a firewall from
245 proxy use, while defaulting to a common proxy for external domains.
247 core.ignoreStat::
248         If true, commands which modify both the working tree and the index
249         will mark the updated paths with the "assume unchanged" bit in the
250         index. These marked files are then assumed to stay unchanged in the
251         working copy, until you mark them otherwise manually - Git will not
252         detect the file changes by lstat() calls. This is useful on systems
253         where those are very slow, such as Microsoft Windows.
254         See linkgit:git-update-index[1].
255         False by default.
257 core.preferSymlinkRefs::
258         Instead of the default "symref" format for HEAD
259         and other symbolic reference files, use symbolic links.
260         This is sometimes needed to work with old scripts that
261         expect HEAD to be a symbolic link.
263 core.bare::
264         If true this repository is assumed to be 'bare' and has no
265         working directory associated with it.  If this is the case a
266         number of commands that require a working directory will be
267         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
269 This setting is automatically guessed by linkgit:git-clone[1] or
270 linkgit:git-init[1] when the repository was created.  By default a
271 repository that ends in "/.git" is assumed to be not bare (bare =
272 false), while all other repositories are assumed to be bare (bare
273 = true).
275 core.worktree::
276         Set the path to the working tree.  The value will not be
277         used in combination with repositories found automatically in
278         a .git directory (i.e. $GIT_DIR is not set).
279         This can be overridden by the GIT_WORK_TREE environment
280         variable and the '--work-tree' command line option. It can be
281         a absolute path or relative path to the directory specified by
282         --git-dir or GIT_DIR.
283         Note: If --git-dir or GIT_DIR are specified but none of
284         --work-tree, GIT_WORK_TREE and core.worktree is specified,
285         the current working directory is regarded as the top directory
286         of your working tree.
288 core.logAllRefUpdates::
289         Enable the reflog. Updates to a ref <ref> is logged to the file
290         "$GIT_DIR/logs/<ref>", by appending the new and old
291         SHA1, the date/time and the reason of the update, but
292         only when the file exists.  If this configuration
293         variable is set to true, missing "$GIT_DIR/logs/<ref>"
294         file is automatically created for branch heads.
296 This information can be used to determine what commit
297 was the tip of a branch "2 days ago".
299 This value is true by default in a repository that has
300 a working directory associated with it, and false by
301 default in a bare repository.
303 core.repositoryFormatVersion::
304         Internal variable identifying the repository format and layout
305         version.
307 core.sharedRepository::
308         When 'group' (or 'true'), the repository is made shareable between
309         several users in a group (making sure all the files and objects are
310         group-writable). When 'all' (or 'world' or 'everybody'), the
311         repository will be readable by all users, additionally to being
312         group-shareable. When 'umask' (or 'false'), git will use permissions
313         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
314         files in the repository will have this mode value. '0xxx' will override
315         user's umask value (whereas the other options will only override
316         requested parts of the user's umask value). Examples: '0660' will make
317         the repo read/write-able for the owner and group, but inaccessible to
318         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
319         repository that is group-readable but not group-writable.
320         See linkgit:git-init[1]. False by default.
322 core.warnAmbiguousRefs::
323         If true, git will warn you if the ref name you passed it is ambiguous
324         and might match multiple refs in the .git/refs/ tree. True by default.
326 core.compression::
327         An integer -1..9, indicating a default compression level.
328         -1 is the zlib default. 0 means no compression,
329         and 1..9 are various speed/size tradeoffs, 9 being slowest.
330         If set, this provides a default to other compression variables,
331         such as 'core.loosecompression' and 'pack.compression'.
333 core.loosecompression::
334         An integer -1..9, indicating the compression level for objects that
335         are not in a pack file. -1 is the zlib default. 0 means no
336         compression, and 1..9 are various speed/size tradeoffs, 9 being
337         slowest.  If not set,  defaults to core.compression.  If that is
338         not set,  defaults to 1 (best speed).
340 core.packedGitWindowSize::
341         Number of bytes of a pack file to map into memory in a
342         single mapping operation.  Larger window sizes may allow
343         your system to process a smaller number of large pack files
344         more quickly.  Smaller window sizes will negatively affect
345         performance due to increased calls to the operating system's
346         memory manager, but may improve performance when accessing
347         a large number of large pack files.
349 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
350 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
351 be reasonable for all users/operating systems.  You probably do
352 not need to adjust this value.
354 Common unit suffixes of 'k', 'm', or 'g' are supported.
356 core.packedGitLimit::
357         Maximum number of bytes to map simultaneously into memory
358         from pack files.  If Git needs to access more than this many
359         bytes at once to complete an operation it will unmap existing
360         regions to reclaim virtual address space within the process.
362 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
363 This should be reasonable for all users/operating systems, except on
364 the largest projects.  You probably do not need to adjust this value.
366 Common unit suffixes of 'k', 'm', or 'g' are supported.
368 core.deltaBaseCacheLimit::
369         Maximum number of bytes to reserve for caching base objects
370         that multiple deltafied objects reference.  By storing the
371         entire decompressed base objects in a cache Git is able
372         to avoid unpacking and decompressing frequently used base
373         objects multiple times.
375 Default is 16 MiB on all platforms.  This should be reasonable
376 for all users/operating systems, except on the largest projects.
377 You probably do not need to adjust this value.
379 Common unit suffixes of 'k', 'm', or 'g' are supported.
381 core.excludesfile::
382         In addition to '.gitignore' (per-directory) and
383         '.git/info/exclude', git looks into this file for patterns
384         of files which are not meant to be tracked.  "{tilde}/" is expanded
385         to the value of `$HOME` and "{tilde}user/" to the specified user's
386         home directory.  See linkgit:gitignore[5].
388 core.editor::
389         Commands such as `commit` and `tag` that lets you edit
390         messages by launching an editor uses the value of this
391         variable when it is set, and the environment variable
392         `GIT_EDITOR` is not set.  The order of preference is
393         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
394         `EDITOR` environment variables and then finally `vi`.
396 core.pager::
397         The command that git will use to paginate output.  Can
398         be overridden with the `GIT_PAGER` environment
399         variable.  Note that git sets the `LESS` environment
400         variable to `FRSX` if it is unset when it runs the
401         pager.  One can change these settings by setting the
402         `LESS` variable to some other value.  Alternately,
403         these settings can be overridden on a project or
404         global basis by setting the `core.pager` option.
405         Setting `core.pager` has no affect on the `LESS`
406         environment variable behaviour above, so if you want
407         to override git's default settings this way, you need
408         to be explicit.  For example, to disable the S option
409         in a backward compatible manner, set `core.pager`
410         to `less -+$LESS -FRX`.  This will be passed to the
411         shell by git, which will translate the final command to
412         `LESS=FRSX less -+FRSX -FRX`.
414 core.whitespace::
415         A comma separated list of common whitespace problems to
416         notice.  'git-diff' will use `color.diff.whitespace` to
417         highlight them, and 'git-apply --whitespace=error' will
418         consider them as errors.  You can prefix `-` to disable
419         any of them (e.g. `-trailing-space`):
421 * `blank-at-eol` treats trailing whitespaces at the end of the line
422   as an error (enabled by default).
423 * `space-before-tab` treats a space character that appears immediately
424   before a tab character in the initial indent part of the line as an
425   error (enabled by default).
426 * `indent-with-non-tab` treats a line that is indented with 8 or more
427   space characters as an error (not enabled by default).
428 * `blank-at-eof` treats blank lines added at the end of file as an error
429   (enabled by default).
430 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
431   `blank-at-eof`.
432 * `cr-at-eol` treats a carriage-return at the end of line as
433   part of the line terminator, i.e. with it, `trailing-space`
434   does not trigger if the character before such a carriage-return
435   is not a whitespace (not enabled by default).
437 core.fsyncobjectfiles::
438         This boolean will enable 'fsync()' when writing object files.
440 This is a total waste of time and effort on a filesystem that orders
441 data writes properly, but can be useful for filesystems that do not use
442 journalling (traditional UNIX filesystems) or that only journal metadata
443 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
445 core.preloadindex::
446         Enable parallel index preload for operations like 'git diff'
448 This can speed up operations like 'git diff' and 'git status' especially
449 on filesystems like NFS that have weak caching semantics and thus
450 relatively high IO latencies.  With this set to 'true', git will do the
451 index comparison to the filesystem data in parallel, allowing
452 overlapping IO's.
454 core.createObject::
455         You can set this to 'link', in which case a hardlink followed by
456         a delete of the source are used to make sure that object creation
457         will not overwrite existing objects.
459 On some file system/operating system combinations, this is unreliable.
460 Set this config setting to 'rename' there; However, This will remove the
461 check that makes sure that existing object files will not get overwritten.
463 add.ignore-errors::
464         Tells 'git-add' to continue adding files when some files cannot be
465         added due to indexing errors. Equivalent to the '--ignore-errors'
466         option of linkgit:git-add[1].
468 alias.*::
469         Command aliases for the linkgit:git[1] command wrapper - e.g.
470         after defining "alias.last = cat-file commit HEAD", the invocation
471         "git last" is equivalent to "git cat-file commit HEAD". To avoid
472         confusion and troubles with script usage, aliases that
473         hide existing git commands are ignored. Arguments are split by
474         spaces, the usual shell quoting and escaping is supported.
475         quote pair and a backslash can be used to quote them.
477 If the alias expansion is prefixed with an exclamation point,
478 it will be treated as a shell command.  For example, defining
479 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
480 "git new" is equivalent to running the shell command
481 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
482 executed from the top-level directory of a repository, which may
483 not necessarily be the current directory.
485 apply.ignorewhitespace::
486         When set to 'change', tells 'git-apply' to ignore changes in
487         whitespace, in the same way as the '--ignore-space-change'
488         option.
489         When set to one of: no, none, never, false tells 'git-apply' to
490         respect all whitespace differences.
491         See linkgit:git-apply[1].
493 apply.whitespace::
494         Tells 'git-apply' how to handle whitespaces, in the same way
495         as the '--whitespace' option. See linkgit:git-apply[1].
497 branch.autosetupmerge::
498         Tells 'git-branch' and 'git-checkout' to setup new branches
499         so that linkgit:git-pull[1] will appropriately merge from the
500         starting point branch. Note that even if this option is not set,
501         this behavior can be chosen per-branch using the `--track`
502         and `--no-track` options. The valid settings are: `false` -- no
503         automatic setup is done; `true` -- automatic setup is done when the
504         starting point is a remote branch; `always` -- automatic setup is
505         done when the starting point is either a local branch or remote
506         branch. This option defaults to true.
508 branch.autosetuprebase::
509         When a new branch is created with 'git-branch' or 'git-checkout'
510         that tracks another branch, this variable tells git to set
511         up pull to rebase instead of merge (see "branch.<name>.rebase").
512         When `never`, rebase is never automatically set to true.
513         When `local`, rebase is set to true for tracked branches of
514         other local branches.
515         When `remote`, rebase is set to true for tracked branches of
516         remote branches.
517         When `always`, rebase will be set to true for all tracking
518         branches.
519         See "branch.autosetupmerge" for details on how to set up a
520         branch to track another branch.
521         This option defaults to never.
523 branch.<name>.remote::
524         When in branch <name>, it tells 'git-fetch' and 'git-push' which
525         remote to fetch from/push to.  It defaults to `origin` if no remote is
526         configured. `origin` is also used if you are not on any branch.
528 branch.<name>.merge::
529         Defines, together with branch.<name>.remote, the upstream branch
530         for the given branch. It tells 'git-fetch'/'git-pull' which
531         branch to merge and can also affect 'git-push' (see push.default).
532         When in branch <name>, it tells 'git-fetch' the default
533         refspec to be marked for merging in FETCH_HEAD. The value is
534         handled like the remote part of a refspec, and must match a
535         ref which is fetched from the remote given by
536         "branch.<name>.remote".
537         The merge information is used by 'git-pull' (which at first calls
538         'git-fetch') to lookup the default branch for merging. Without
539         this option, 'git-pull' defaults to merge the first refspec fetched.
540         Specify multiple values to get an octopus merge.
541         If you wish to setup 'git-pull' so that it merges into <name> from
542         another branch in the local repository, you can point
543         branch.<name>.merge to the desired branch, and use the special setting
544         `.` (a period) for branch.<name>.remote.
546 branch.<name>.mergeoptions::
547         Sets default options for merging into branch <name>. The syntax and
548         supported options are the same as those of linkgit:git-merge[1], but
549         option values containing whitespace characters are currently not
550         supported.
552 branch.<name>.rebase::
553         When true, rebase the branch <name> on top of the fetched branch,
554         instead of merging the default branch from the default remote when
555         "git pull" is run.
556         *NOTE*: this is a possibly dangerous operation; do *not* use
557         it unless you understand the implications (see linkgit:git-rebase[1]
558         for details).
560 browser.<tool>.cmd::
561         Specify the command to invoke the specified browser. The
562         specified command is evaluated in shell with the URLs passed
563         as arguments. (See linkgit:git-web--browse[1].)
565 browser.<tool>.path::
566         Override the path for the given tool that may be used to
567         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
568         working repository in gitweb (see linkgit:git-instaweb[1]).
570 clean.requireForce::
571         A boolean to make git-clean do nothing unless given -f
572         or -n.   Defaults to true.
574 color.branch::
575         A boolean to enable/disable color in the output of
576         linkgit:git-branch[1]. May be set to `always`,
577         `false` (or `never`) or `auto` (or `true`), in which case colors are used
578         only when the output is to a terminal. Defaults to false.
580 color.branch.<slot>::
581         Use customized color for branch coloration. `<slot>` is one of
582         `current` (the current branch), `local` (a local branch),
583         `remote` (a tracking branch in refs/remotes/), `plain` (other
584         refs).
586 The value for these configuration variables is a list of colors (at most
587 two) and attributes (at most one), separated by spaces.  The colors
588 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
589 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
590 `blink` and `reverse`.  The first color given is the foreground; the
591 second is the background.  The position of the attribute, if any,
592 doesn't matter.
594 color.diff::
595         When set to `always`, always use colors in patch.
596         When false (or `never`), never.  When set to `true` or `auto`, use
597         colors only when the output is to the terminal. Defaults to false.
599 color.diff.<slot>::
600         Use customized color for diff colorization.  `<slot>` specifies
601         which part of the patch to use the specified color, and is one
602         of `plain` (context text), `meta` (metainformation), `frag`
603         (hunk header), `old` (removed lines), `new` (added lines),
604         `commit` (commit headers), or `whitespace` (highlighting
605         whitespace errors). The values of these variables may be specified as
606         in color.branch.<slot>.
608 color.grep::
609         When set to `always`, always highlight matches.  When `false` (or
610         `never`), never.  When set to `true` or `auto`, use color only
611         when the output is written to the terminal.  Defaults to `false`.
613 color.grep.external::
614         The string value of this variable is passed to an external 'grep'
615         command as a command line option if match highlighting is turned
616         on.  If set to an empty string, no option is passed at all,
617         turning off coloring for external 'grep' calls; this is the default.
618         For GNU grep, set it to `--color=always` to highlight matches even
619         when a pager is used.
621 color.grep.match::
622         Use customized color for matches.  The value of this variable
623         may be specified as in color.branch.<slot>.  It is passed using
624         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
625         calling an external 'grep'.
627 color.interactive::
628         When set to `always`, always use colors for interactive prompts
629         and displays (such as those used by "git-add --interactive").
630         When false (or `never`), never.  When set to `true` or `auto`, use
631         colors only when the output is to the terminal. Defaults to false.
633 color.interactive.<slot>::
634         Use customized color for 'git-add --interactive'
635         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
636         four distinct types of normal output from interactive
637         commands.  The values of these variables may be specified as
638         in color.branch.<slot>.
640 color.pager::
641         A boolean to enable/disable colored output when the pager is in
642         use (default is true).
644 color.showbranch::
645         A boolean to enable/disable color in the output of
646         linkgit:git-show-branch[1]. May be set to `always`,
647         `false` (or `never`) or `auto` (or `true`), in which case colors are used
648         only when the output is to a terminal. Defaults to false.
650 color.status::
651         A boolean to enable/disable color in the output of
652         linkgit:git-status[1]. May be set to `always`,
653         `false` (or `never`) or `auto` (or `true`), in which case colors are used
654         only when the output is to a terminal. Defaults to false.
656 color.status.<slot>::
657         Use customized color for status colorization. `<slot>` is
658         one of `header` (the header text of the status message),
659         `added` or `updated` (files which are added but not committed),
660         `changed` (files which are changed but not added in the index),
661         `untracked` (files which are not tracked by git), or
662         `nobranch` (the color the 'no branch' warning is shown in, defaulting
663         to red). The values of these variables may be specified as in
664         color.branch.<slot>.
666 color.ui::
667         When set to `always`, always use colors in all git commands which
668         are capable of colored output. When false (or `never`), never. When
669         set to `true` or `auto`, use colors only when the output is to the
670         terminal. When more specific variables of color.* are set, they always
671         take precedence over this setting. Defaults to false.
673 commit.template::
674         Specify a file to use as the template for new commit messages.
675         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
676         specified user's home directory.
678 diff.autorefreshindex::
679         When using 'git-diff' to compare with work tree
680         files, do not consider stat-only change as changed.
681         Instead, silently run `git update-index --refresh` to
682         update the cached stat information for paths whose
683         contents in the work tree match the contents in the
684         index.  This option defaults to true.  Note that this
685         affects only 'git-diff' Porcelain, and not lower level
686         'diff' commands, such as 'git-diff-files'.
688 diff.external::
689         If this config variable is set, diff generation is not
690         performed using the internal diff machinery, but using the
691         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
692         environment variable.  The command is called with parameters
693         as described under "git Diffs" in linkgit:git[1].  Note: if
694         you want to use an external diff program only on a subset of
695         your files, you might want to use linkgit:gitattributes[5] instead.
697 diff.mnemonicprefix::
698         If set, 'git-diff' uses a prefix pair that is different from the
699         standard "a/" and "b/" depending on what is being compared.  When
700         this configuration is in effect, reverse diff output also swaps
701         the order of the prefixes:
702 'git-diff';;
703         compares the (i)ndex and the (w)ork tree;
704 'git-diff HEAD';;
705          compares a (c)ommit and the (w)ork tree;
706 'git diff --cached';;
707         compares a (c)ommit and the (i)ndex;
708 'git-diff HEAD:file1 file2';;
709         compares an (o)bject and a (w)ork tree entity;
710 'git diff --no-index a b';;
711         compares two non-git things (1) and (2).
713 diff.renameLimit::
714         The number of files to consider when performing the copy/rename
715         detection; equivalent to the 'git-diff' option '-l'.
717 diff.renames::
718         Tells git to detect renames.  If set to any boolean value, it
719         will enable basic rename detection.  If set to "copies" or
720         "copy", it will detect copies, as well.
722 diff.suppressBlankEmpty::
723         A boolean to inhibit the standard behavior of printing a space
724         before each empty output line. Defaults to false.
726 diff.tool::
727         Controls which diff tool is used.  `diff.tool` overrides
728         `merge.tool` when used by linkgit:git-difftool[1] and has
729         the same valid values as `merge.tool` minus "tortoisemerge"
730         and plus "kompare".
732 difftool.<tool>.path::
733         Override the path for the given tool.  This is useful in case
734         your tool is not in the PATH.
736 difftool.<tool>.cmd::
737         Specify the command to invoke the specified diff tool.
738         The specified command is evaluated in shell with the following
739         variables available:  'LOCAL' is set to the name of the temporary
740         file containing the contents of the diff pre-image and 'REMOTE'
741         is set to the name of the temporary file containing the contents
742         of the diff post-image.
744 difftool.prompt::
745         Prompt before each invocation of the diff tool.
747 diff.wordRegex::
748         A POSIX Extended Regular Expression used to determine what is a "word"
749         when performing word-by-word difference calculations.  Character
750         sequences that match the regular expression are "words", all other
751         characters are *ignorable* whitespace.
753 fetch.unpackLimit::
754         If the number of objects fetched over the git native
755         transfer is below this
756         limit, then the objects will be unpacked into loose object
757         files. However if the number of received objects equals or
758         exceeds this limit then the received pack will be stored as
759         a pack, after adding any missing delta bases.  Storing the
760         pack from a push can make the push operation complete faster,
761         especially on slow filesystems.  If not set, the value of
762         `transfer.unpackLimit` is used instead.
764 format.attach::
765         Enable multipart/mixed attachments as the default for
766         'format-patch'.  The value can also be a double quoted string
767         which will enable attachments as the default and set the
768         value as the boundary.  See the --attach option in
769         linkgit:git-format-patch[1].
771 format.numbered::
772         A boolean which can enable or disable sequence numbers in patch
773         subjects.  It defaults to "auto" which enables it only if there
774         is more than one patch.  It can be enabled or disabled for all
775         messages by setting it to "true" or "false".  See --numbered
776         option in linkgit:git-format-patch[1].
778 format.headers::
779         Additional email headers to include in a patch to be submitted
780         by mail.  See linkgit:git-format-patch[1].
782 format.cc::
783         Additional "Cc:" headers to include in a patch to be submitted
784         by mail.  See the --cc option in linkgit:git-format-patch[1].
786 format.subjectprefix::
787         The default for format-patch is to output files with the '[PATCH]'
788         subject prefix. Use this variable to change that prefix.
790 format.suffix::
791         The default for format-patch is to output files with the suffix
792         `.patch`. Use this variable to change that suffix (make sure to
793         include the dot if you want it).
795 format.pretty::
796         The default pretty format for log/show/whatchanged command,
797         See linkgit:git-log[1], linkgit:git-show[1],
798         linkgit:git-whatchanged[1].
800 format.thread::
801         The default threading style for 'git-format-patch'.  Can be
802         either a boolean value, `shallow` or `deep`.  `shallow`
803         threading makes every mail a reply to the head of the series,
804         where the head is chosen from the cover letter, the
805         `\--in-reply-to`, and the first patch mail, in this order.
806         `deep` threading makes every mail a reply to the previous one.
807         A true boolean value is the same as `shallow`, and a false
808         value disables threading.
810 format.signoff::
811     A boolean value which lets you enable the `-s/--signoff` option of
812     format-patch by default. *Note:* Adding the Signed-off-by: line to a
813     patch should be a conscious act and means that you certify you have
814     the rights to submit this work under the same open source license.
815     Please see the 'SubmittingPatches' document for further discussion.
817 gc.aggressiveWindow::
818         The window size parameter used in the delta compression
819         algorithm used by 'git-gc --aggressive'.  This defaults
820         to 10.
822 gc.auto::
823         When there are approximately more than this many loose
824         objects in the repository, `git gc --auto` will pack them.
825         Some Porcelain commands use this command to perform a
826         light-weight garbage collection from time to time.  The
827         default value is 6700.  Setting this to 0 disables it.
829 gc.autopacklimit::
830         When there are more than this many packs that are not
831         marked with `*.keep` file in the repository, `git gc
832         --auto` consolidates them into one larger pack.  The
833         default value is 50.  Setting this to 0 disables it.
835 gc.packrefs::
836         'git-gc' does not run `git pack-refs` in a bare repository by
837         default so that older dumb-transport clients can still fetch
838         from the repository.  Setting this to `true` lets 'git-gc'
839         to run `git pack-refs`.  Setting this to `false` tells
840         'git-gc' never to run `git pack-refs`. The default setting is
841         `notbare`. Enable it only when you know you do not have to
842         support such clients.  The default setting will change to `true`
843         at some stage, and setting this to `false` will continue to
844         prevent `git pack-refs` from being run from 'git-gc'.
846 gc.pruneexpire::
847         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
848         Override the grace period with this config variable.  The value
849         "now" may be used to disable this  grace period and always prune
850         unreachable objects immediately.
852 gc.reflogexpire::
853         'git-reflog expire' removes reflog entries older than
854         this time; defaults to 90 days.
856 gc.reflogexpireunreachable::
857         'git-reflog expire' removes reflog entries older than
858         this time and are not reachable from the current tip;
859         defaults to 30 days.
861 gc.rerereresolved::
862         Records of conflicted merge you resolved earlier are
863         kept for this many days when 'git-rerere gc' is run.
864         The default is 60 days.  See linkgit:git-rerere[1].
866 gc.rerereunresolved::
867         Records of conflicted merge you have not resolved are
868         kept for this many days when 'git-rerere gc' is run.
869         The default is 15 days.  See linkgit:git-rerere[1].
871 gitcvs.commitmsgannotation::
872         Append this string to each commit message. Set to empty string
873         to disable this feature. Defaults to "via git-CVS emulator".
875 gitcvs.enabled::
876         Whether the CVS server interface is enabled for this repository.
877         See linkgit:git-cvsserver[1].
879 gitcvs.logfile::
880         Path to a log file where the CVS server interface well... logs
881         various stuff. See linkgit:git-cvsserver[1].
883 gitcvs.usecrlfattr::
884         If true, the server will look up the `crlf` attribute for
885         files to determine the '-k' modes to use. If `crlf` is set,
886         the '-k' mode will be left blank, so cvs clients will
887         treat it as text. If `crlf` is explicitly unset, the file
888         will be set with '-kb' mode, which suppresses any newline munging
889         the client might otherwise do. If `crlf` is not specified,
890         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
892 gitcvs.allbinary::
893         This is used if 'gitcvs.usecrlfattr' does not resolve
894         the correct '-kb' mode to use. If true, all
895         unresolved files are sent to the client in
896         mode '-kb'. This causes the client to treat them
897         as binary files, which suppresses any newline munging it
898         otherwise might do. Alternatively, if it is set to "guess",
899         then the contents of the file are examined to decide if
900         it is binary, similar to 'core.autocrlf'.
902 gitcvs.dbname::
903         Database used by git-cvsserver to cache revision information
904         derived from the git repository. The exact meaning depends on the
905         used database driver, for SQLite (which is the default driver) this
906         is a filename. Supports variable substitution (see
907         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
908         Default: '%Ggitcvs.%m.sqlite'
910 gitcvs.dbdriver::
911         Used Perl DBI driver. You can specify any available driver
912         for this here, but it might not work. git-cvsserver is tested
913         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
914         reported *not* to work with 'DBD::mysql'. Experimental feature.
915         May not contain double colons (`:`). Default: 'SQLite'.
916         See linkgit:git-cvsserver[1].
918 gitcvs.dbuser, gitcvs.dbpass::
919         Database user and password. Only useful if setting 'gitcvs.dbdriver',
920         since SQLite has no concept of database users and/or passwords.
921         'gitcvs.dbuser' supports variable substitution (see
922         linkgit:git-cvsserver[1] for details).
924 gitcvs.dbTableNamePrefix::
925         Database table name prefix.  Prepended to the names of any
926         database tables used, allowing a single database to be used
927         for several repositories.  Supports variable substitution (see
928         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
929         characters will be replaced with underscores.
931 All gitcvs variables except for 'gitcvs.usecrlfattr' and
932 'gitcvs.allbinary' can also be specified as
933 'gitcvs.<access_method>.<varname>' (where 'access_method'
934 is one of "ext" and "pserver") to make them apply only for the given
935 access method.
937 gui.commitmsgwidth::
938         Defines how wide the commit message window is in the
939         linkgit:git-gui[1]. "75" is the default.
941 gui.diffcontext::
942         Specifies how many context lines should be used in calls to diff
943         made by the linkgit:git-gui[1]. The default is "5".
945 gui.encoding::
946         Specifies the default encoding to use for displaying of
947         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
948         It can be overridden by setting the 'encoding' attribute
949         for relevant files (see linkgit:gitattributes[5]).
950         If this option is not set, the tools default to the
951         locale encoding.
953 gui.matchtrackingbranch::
954         Determines if new branches created with linkgit:git-gui[1] should
955         default to tracking remote branches with matching names or
956         not. Default: "false".
958 gui.newbranchtemplate::
959         Is used as suggested name when creating new branches using the
960         linkgit:git-gui[1].
962 gui.pruneduringfetch::
963         "true" if linkgit:git-gui[1] should prune tracking branches when
964         performing a fetch. The default value is "false".
966 gui.trustmtime::
967         Determines if linkgit:git-gui[1] should trust the file modification
968         timestamp or not. By default the timestamps are not trusted.
970 gui.spellingdictionary::
971         Specifies the dictionary used for spell checking commit messages in
972         the linkgit:git-gui[1]. When set to "none" spell checking is turned
973         off.
975 gui.fastcopyblame::
976         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
977         location detection. It makes blame significantly faster on huge
978         repositories at the expense of less thorough copy detection.
980 gui.copyblamethreshold::
981         Specifies the threshold to use in 'git gui blame' original location
982         detection, measured in alphanumeric characters. See the
983         linkgit:git-blame[1] manual for more information on copy detection.
985 gui.blamehistoryctx::
986         Specifies the radius of history context in days to show in
987         linkgit:gitk[1] for the selected commit, when the `Show History
988         Context` menu item is invoked from 'git gui blame'. If this
989         variable is set to zero, the whole history is shown.
991 guitool.<name>.cmd::
992         Specifies the shell command line to execute when the corresponding item
993         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
994         mandatory for every tool. The command is executed from the root of
995         the working directory, and in the environment it receives the name of
996         the tool as 'GIT_GUITOOL', the name of the currently selected file as
997         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
998         the head is detached, 'CUR_BRANCH' is empty).
1000 guitool.<name>.needsfile::
1001         Run the tool only if a diff is selected in the GUI. It guarantees
1002         that 'FILENAME' is not empty.
1004 guitool.<name>.noconsole::
1005         Run the command silently, without creating a window to display its
1006         output.
1008 guitool.<name>.norescan::
1009         Don't rescan the working directory for changes after the tool
1010         finishes execution.
1012 guitool.<name>.confirm::
1013         Show a confirmation dialog before actually running the tool.
1015 guitool.<name>.argprompt::
1016         Request a string argument from the user, and pass it to the tool
1017         through the 'ARGS' environment variable. Since requesting an
1018         argument implies confirmation, the 'confirm' option has no effect
1019         if this is enabled. If the option is set to 'true', 'yes', or '1',
1020         the dialog uses a built-in generic prompt; otherwise the exact
1021         value of the variable is used.
1023 guitool.<name>.revprompt::
1024         Request a single valid revision from the user, and set the
1025         'REVISION' environment variable. In other aspects this option
1026         is similar to 'argprompt', and can be used together with it.
1028 guitool.<name>.revunmerged::
1029         Show only unmerged branches in the 'revprompt' subdialog.
1030         This is useful for tools similar to merge or rebase, but not
1031         for things like checkout or reset.
1033 guitool.<name>.title::
1034         Specifies the title to use for the prompt dialog. The default
1035         is the tool name.
1037 guitool.<name>.prompt::
1038         Specifies the general prompt string to display at the top of
1039         the dialog, before subsections for 'argprompt' and 'revprompt'.
1040         The default value includes the actual command.
1042 help.browser::
1043         Specify the browser that will be used to display help in the
1044         'web' format. See linkgit:git-help[1].
1046 help.format::
1047         Override the default help format used by linkgit:git-help[1].
1048         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1049         the default. 'web' and 'html' are the same.
1051 help.autocorrect::
1052         Automatically correct and execute mistyped commands after
1053         waiting for the given number of deciseconds (0.1 sec). If more
1054         than one command can be deduced from the entered text, nothing
1055         will be executed.  If the value of this option is negative,
1056         the corrected command will be executed immediately. If the
1057         value is 0 - the command will be just shown but not executed.
1058         This is the default.
1060 http.proxy::
1061         Override the HTTP proxy, normally configured using the 'http_proxy'
1062         environment variable (see linkgit:curl[1]).  This can be overridden
1063         on a per-remote basis; see remote.<name>.proxy
1065 http.sslVerify::
1066         Whether to verify the SSL certificate when fetching or pushing
1067         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1068         variable.
1070 http.sslCert::
1071         File containing the SSL certificate when fetching or pushing
1072         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1073         variable.
1075 http.sslKey::
1076         File containing the SSL private key when fetching or pushing
1077         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1078         variable.
1080 http.sslCertPasswordProtected::
1081         Enable git's password prompt for the SSL certificate.  Otherwise
1082         OpenSSL will prompt the user, possibly many times, if the
1083         certificate or private key is encrypted.  Can be overridden by the
1084         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1086 http.sslCAInfo::
1087         File containing the certificates to verify the peer with when
1088         fetching or pushing over HTTPS. Can be overridden by the
1089         'GIT_SSL_CAINFO' environment variable.
1091 http.sslCAPath::
1092         Path containing files with the CA certificates to verify the peer
1093         with when fetching or pushing over HTTPS. Can be overridden
1094         by the 'GIT_SSL_CAPATH' environment variable.
1096 http.maxRequests::
1097         How many HTTP requests to launch in parallel. Can be overridden
1098         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1100 http.lowSpeedLimit, http.lowSpeedTime::
1101         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1102         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1103         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1104         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1106 http.noEPSV::
1107         A boolean which disables using of EPSV ftp command by curl.
1108         This can helpful with some "poor" ftp servers which don't
1109         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1110         environment variable. Default is false (curl will use EPSV).
1112 i18n.commitEncoding::
1113         Character encoding the commit messages are stored in; git itself
1114         does not care per se, but this information is necessary e.g. when
1115         importing commits from emails or in the gitk graphical history
1116         browser (and possibly at other places in the future or in other
1117         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1119 i18n.logOutputEncoding::
1120         Character encoding the commit messages are converted to when
1121         running 'git-log' and friends.
1123 imap::
1124         The configuration variables in the 'imap' section are described
1125         in linkgit:git-imap-send[1].
1127 instaweb.browser::
1128         Specify the program that will be used to browse your working
1129         repository in gitweb. See linkgit:git-instaweb[1].
1131 instaweb.httpd::
1132         The HTTP daemon command-line to start gitweb on your working
1133         repository. See linkgit:git-instaweb[1].
1135 instaweb.local::
1136         If true the web server started by linkgit:git-instaweb[1] will
1137         be bound to the local IP (127.0.0.1).
1139 instaweb.modulepath::
1140         The module path for an apache httpd used by linkgit:git-instaweb[1].
1142 instaweb.port::
1143         The port number to bind the gitweb httpd to. See
1144         linkgit:git-instaweb[1].
1146 interactive.singlekey::
1147         In interactive commands, allow the user to provide one-letter
1148         input with a single key (i.e., without hitting enter).
1149         Currently this is used only by the `\--patch` mode of
1150         linkgit:git-add[1].  Note that this setting is silently
1151         ignored if portable keystroke input is not available.
1153 log.date::
1154         Set default date-time mode for the log command. Setting log.date
1155         value is similar to using 'git-log'\'s --date option. The value is one of the
1156         following alternatives: {relative,local,default,iso,rfc,short}.
1157         See linkgit:git-log[1].
1159 log.showroot::
1160         If true, the initial commit will be shown as a big creation event.
1161         This is equivalent to a diff against an empty tree.
1162         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1163         normally hide the root commit will now show it. True by default.
1165 mailmap.file::
1166         The location of an augmenting mailmap file. The default
1167         mailmap, located in the root of the repository, is loaded
1168         first, then the mailmap file pointed to by this variable.
1169         The location of the mailmap file may be in a repository
1170         subdirectory, or somewhere outside of the repository itself.
1171         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1173 man.viewer::
1174         Specify the programs that may be used to display help in the
1175         'man' format. See linkgit:git-help[1].
1177 man.<tool>.cmd::
1178         Specify the command to invoke the specified man viewer. The
1179         specified command is evaluated in shell with the man page
1180         passed as argument. (See linkgit:git-help[1].)
1182 man.<tool>.path::
1183         Override the path for the given tool that may be used to
1184         display help in the 'man' format. See linkgit:git-help[1].
1186 include::merge-config.txt[]
1188 mergetool.<tool>.path::
1189         Override the path for the given tool.  This is useful in case
1190         your tool is not in the PATH.
1192 mergetool.<tool>.cmd::
1193         Specify the command to invoke the specified merge tool.  The
1194         specified command is evaluated in shell with the following
1195         variables available: 'BASE' is the name of a temporary file
1196         containing the common base of the files to be merged, if available;
1197         'LOCAL' is the name of a temporary file containing the contents of
1198         the file on the current branch; 'REMOTE' is the name of a temporary
1199         file containing the contents of the file from the branch being
1200         merged; 'MERGED' contains the name of the file to which the merge
1201         tool should write the results of a successful merge.
1203 mergetool.<tool>.trustExitCode::
1204         For a custom merge command, specify whether the exit code of
1205         the merge command can be used to determine whether the merge was
1206         successful.  If this is not set to true then the merge target file
1207         timestamp is checked and the merge assumed to have been successful
1208         if the file has been updated, otherwise the user is prompted to
1209         indicate the success of the merge.
1211 mergetool.keepBackup::
1212         After performing a merge, the original file with conflict markers
1213         can be saved as a file with a `.orig` extension.  If this variable
1214         is set to `false` then this file is not preserved.  Defaults to
1215         `true` (i.e. keep the backup files).
1217 mergetool.keepTemporaries::
1218         When invoking a custom merge tool, git uses a set of temporary
1219         files to pass to the tool. If the tool returns an error and this
1220         variable is set to `true`, then these temporary files will be
1221         preserved, otherwise they will be removed after the tool has
1222         exited. Defaults to `false`.
1224 mergetool.prompt::
1225         Prompt before each invocation of the merge resolution program.
1227 pack.window::
1228         The size of the window used by linkgit:git-pack-objects[1] when no
1229         window size is given on the command line. Defaults to 10.
1231 pack.depth::
1232         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1233         maximum depth is given on the command line. Defaults to 50.
1235 pack.windowMemory::
1236         The window memory size limit used by linkgit:git-pack-objects[1]
1237         when no limit is given on the command line.  The value can be
1238         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1239         limit.
1241 pack.compression::
1242         An integer -1..9, indicating the compression level for objects
1243         in a pack file. -1 is the zlib default. 0 means no
1244         compression, and 1..9 are various speed/size tradeoffs, 9 being
1245         slowest.  If not set,  defaults to core.compression.  If that is
1246         not set,  defaults to -1, the zlib default, which is "a default
1247         compromise between speed and compression (currently equivalent
1248         to level 6)."
1250 pack.deltaCacheSize::
1251         The maximum memory in bytes used for caching deltas in
1252         linkgit:git-pack-objects[1] before writing them out to a pack.
1253         This cache is used to speed up the writing object phase by not
1254         having to recompute the final delta result once the best match
1255         for all objects is found.  Repacking large repositories on machines
1256         which are tight with memory might be badly impacted by this though,
1257         especially if this cache pushes the system into swapping.
1258         A value of 0 means no limit. The smallest size of 1 byte may be
1259         used to virtually disable this cache. Defaults to 256 MiB.
1261 pack.deltaCacheLimit::
1262         The maximum size of a delta, that is cached in
1263         linkgit:git-pack-objects[1]. This cache is used to speed up the
1264         writing object phase by not having to recompute the final delta
1265         result once the best match for all objects is found. Defaults to 1000.
1267 pack.threads::
1268         Specifies the number of threads to spawn when searching for best
1269         delta matches.  This requires that linkgit:git-pack-objects[1]
1270         be compiled with pthreads otherwise this option is ignored with a
1271         warning. This is meant to reduce packing time on multiprocessor
1272         machines. The required amount of memory for the delta search window
1273         is however multiplied by the number of threads.
1274         Specifying 0 will cause git to auto-detect the number of CPU's
1275         and set the number of threads accordingly.
1277 pack.indexVersion::
1278         Specify the default pack index version.  Valid values are 1 for
1279         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1280         the new pack index with capabilities for packs larger than 4 GB
1281         as well as proper protection against the repacking of corrupted
1282         packs.  Version 2 is the default.  Note that version 2 is enforced
1283         and this config option ignored whenever the corresponding pack is
1284         larger than 2 GB.
1286 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1287 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1288 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1289 other side may give you a repository that cannot be accessed with your
1290 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1291 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1292 the `{asterisk}.idx` file.
1294 pack.packSizeLimit::
1295         The default maximum size of a pack.  This setting only affects
1296         packing to a file, i.e. the git:// protocol is unaffected.  It
1297         can be overridden by the `\--max-pack-size` option of
1298         linkgit:git-repack[1].
1300 pager.<cmd>::
1301         Allows turning on or off pagination of the output of a
1302         particular git subcommand when writing to a tty.  If
1303         `\--paginate` or `\--no-pager` is specified on the command line,
1304         it takes precedence over this option.  To disable pagination for
1305         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1307 pull.octopus::
1308         The default merge strategy to use when pulling multiple branches
1309         at once.
1311 pull.twohead::
1312         The default merge strategy to use when pulling a single branch.
1314 push.default::
1315         Defines the action git push should take if no refspec is given
1316         on the command line, no refspec is configured in the remote, and
1317         no refspec is implied by any of the options given on the command
1318         line. Possible values are:
1320 * `nothing` do not push anything.
1321 * `matching` push all matching branches.
1322   All branches having the same name in both ends are considered to be
1323   matching. This is the default.
1324 * `tracking` push the current branch to its upstream branch.
1325 * `current` push the current branch to a branch of the same name.
1327 rebase.stat::
1328         Whether to show a diffstat of what changed upstream since the last
1329         rebase. False by default.
1331 receive.autogc::
1332         By default, git-receive-pack will run "git-gc --auto" after
1333         receiving data from git-push and updating refs.  You can stop
1334         it by setting this variable to false.
1336 receive.fsckObjects::
1337         If it is set to true, git-receive-pack will check all received
1338         objects. It will abort in the case of a malformed object or a
1339         broken link. The result of an abort are only dangling objects.
1340         Defaults to false.
1342 receive.unpackLimit::
1343         If the number of objects received in a push is below this
1344         limit then the objects will be unpacked into loose object
1345         files. However if the number of received objects equals or
1346         exceeds this limit then the received pack will be stored as
1347         a pack, after adding any missing delta bases.  Storing the
1348         pack from a push can make the push operation complete faster,
1349         especially on slow filesystems.  If not set, the value of
1350         `transfer.unpackLimit` is used instead.
1352 receive.denyDeletes::
1353         If set to true, git-receive-pack will deny a ref update that deletes
1354         the ref. Use this to prevent such a ref deletion via a push.
1356 receive.denyCurrentBranch::
1357         If set to true or "refuse", receive-pack will deny a ref update
1358         to the currently checked out branch of a non-bare repository.
1359         Such a push is potentially dangerous because it brings the HEAD
1360         out of sync with the index and working tree. If set to "warn",
1361         print a warning of such a push to stderr, but allow the push to
1362         proceed. If set to false or "ignore", allow such pushes with no
1363         message. Defaults to "warn".
1365 receive.denyNonFastForwards::
1366         If set to true, git-receive-pack will deny a ref update which is
1367         not a fast forward. Use this to prevent such an update via a push,
1368         even if that push is forced. This configuration variable is
1369         set when initializing a shared repository.
1371 receive.updateserverinfo::
1372         If set to true, git-receive-pack will run git-update-server-info
1373         after receiving data from git-push and updating refs.
1375 remote.<name>.url::
1376         The URL of a remote repository.  See linkgit:git-fetch[1] or
1377         linkgit:git-push[1].
1379 remote.<name>.pushurl::
1380         The push URL of a remote repository.  See linkgit:git-push[1].
1382 remote.<name>.proxy::
1383         For remotes that require curl (http, https and ftp), the URL to
1384         the proxy to use for that remote.  Set to the empty string to
1385         disable proxying for that remote.
1387 remote.<name>.fetch::
1388         The default set of "refspec" for linkgit:git-fetch[1]. See
1389         linkgit:git-fetch[1].
1391 remote.<name>.push::
1392         The default set of "refspec" for linkgit:git-push[1]. See
1393         linkgit:git-push[1].
1395 remote.<name>.mirror::
1396         If true, pushing to this remote will automatically behave
1397         as if the `\--mirror` option was given on the command line.
1399 remote.<name>.skipDefaultUpdate::
1400         If true, this remote will be skipped by default when updating
1401         using the update subcommand of linkgit:git-remote[1].
1403 remote.<name>.receivepack::
1404         The default program to execute on the remote side when pushing.  See
1405         option \--receive-pack of linkgit:git-push[1].
1407 remote.<name>.uploadpack::
1408         The default program to execute on the remote side when fetching.  See
1409         option \--upload-pack of linkgit:git-fetch-pack[1].
1411 remote.<name>.tagopt::
1412         Setting this value to \--no-tags disables automatic tag following when
1413         fetching from remote <name>
1415 remotes.<group>::
1416         The list of remotes which are fetched by "git remote update
1417         <group>".  See linkgit:git-remote[1].
1419 repack.usedeltabaseoffset::
1420         By default, linkgit:git-repack[1] creates packs that use
1421         delta-base offset. If you need to share your repository with
1422         git older than version 1.4.4, either directly or via a dumb
1423         protocol such as http, then you need to set this option to
1424         "false" and repack. Access from old git versions over the
1425         native protocol are unaffected by this option.
1427 rerere.autoupdate::
1428         When set to true, `git-rerere` updates the index with the
1429         resulting contents after it cleanly resolves conflicts using
1430         previously recorded resolution.  Defaults to false.
1432 rerere.enabled::
1433         Activate recording of resolved conflicts, so that identical
1434         conflict hunks can be resolved automatically, should they
1435         be encountered again.  linkgit:git-rerere[1] command is by
1436         default enabled if you create `rr-cache` directory under
1437         `$GIT_DIR`, but can be disabled by setting this option to false.
1439 sendemail.identity::
1440         A configuration identity. When given, causes values in the
1441         'sendemail.<identity>' subsection to take precedence over
1442         values in the 'sendemail' section. The default identity is
1443         the value of 'sendemail.identity'.
1445 sendemail.smtpencryption::
1446         See linkgit:git-send-email[1] for description.  Note that this
1447         setting is not subject to the 'identity' mechanism.
1449 sendemail.smtpssl::
1450         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1452 sendemail.<identity>.*::
1453         Identity-specific versions of the 'sendemail.*' parameters
1454         found below, taking precedence over those when the this
1455         identity is selected, through command-line or
1456         'sendemail.identity'.
1458 sendemail.aliasesfile::
1459 sendemail.aliasfiletype::
1460 sendemail.bcc::
1461 sendemail.cc::
1462 sendemail.cccmd::
1463 sendemail.chainreplyto::
1464 sendemail.confirm::
1465 sendemail.envelopesender::
1466 sendemail.from::
1467 sendemail.multiedit::
1468 sendemail.signedoffbycc::
1469 sendemail.smtppass::
1470 sendemail.suppresscc::
1471 sendemail.suppressfrom::
1472 sendemail.to::
1473 sendemail.smtpserver::
1474 sendemail.smtpserverport::
1475 sendemail.smtpuser::
1476 sendemail.thread::
1477 sendemail.validate::
1478         See linkgit:git-send-email[1] for description.
1480 sendemail.signedoffcc::
1481         Deprecated alias for 'sendemail.signedoffbycc'.
1483 showbranch.default::
1484         The default set of branches for linkgit:git-show-branch[1].
1485         See linkgit:git-show-branch[1].
1487 status.relativePaths::
1488         By default, linkgit:git-status[1] shows paths relative to the
1489         current directory. Setting this variable to `false` shows paths
1490         relative to the repository root (this was the default for git
1491         prior to v1.5.4).
1493 status.showUntrackedFiles::
1494         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1495         files which are not currently tracked by Git. Directories which
1496         contain only untracked files, are shown with the directory name
1497         only. Showing untracked files means that Git needs to lstat() all
1498         all the files in the whole repository, which might be slow on some
1499         systems. So, this variable controls how the commands displays
1500         the untracked files. Possible values are:
1503         - 'no'     - Show no untracked files
1504         - 'normal' - Shows untracked files and directories
1505         - 'all'    - Shows also individual files in untracked directories.
1508 If this variable is not specified, it defaults to 'normal'.
1509 This variable can be overridden with the -u|--untracked-files option
1510 of linkgit:git-status[1] and linkgit:git-commit[1].
1512 tar.umask::
1513         This variable can be used to restrict the permission bits of
1514         tar archive entries.  The default is 0002, which turns off the
1515         world write bit.  The special value "user" indicates that the
1516         archiving user's umask will be used instead.  See umask(2) and
1517         linkgit:git-archive[1].
1519 transfer.unpackLimit::
1520         When `fetch.unpackLimit` or `receive.unpackLimit` are
1521         not set, the value of this variable is used instead.
1522         The default value is 100.
1524 url.<base>.insteadOf::
1525         Any URL that starts with this value will be rewritten to
1526         start, instead, with <base>. In cases where some site serves a
1527         large number of repositories, and serves them with multiple
1528         access methods, and some users need to use different access
1529         methods, this feature allows people to specify any of the
1530         equivalent URLs and have git automatically rewrite the URL to
1531         the best alternative for the particular user, even for a
1532         never-before-seen repository on the site.  When more than one
1533         insteadOf strings match a given URL, the longest match is used.
1535 url.<base>.pushInsteadOf::
1536         Any URL that starts with this value will not be pushed to;
1537         instead, it will be rewritten to start with <base>, and the
1538         resulting URL will be pushed to. In cases where some site serves
1539         a large number of repositories, and serves them with multiple
1540         access methods, some of which do not allow push, this feature
1541         allows people to specify a pull-only URL and have git
1542         automatically use an appropriate URL to push, even for a
1543         never-before-seen repository on the site.  When more than one
1544         pushInsteadOf strings match a given URL, the longest match is
1545         used.  If a remote has an explicit pushurl, git will ignore this
1546         setting for that remote.
1548 user.email::
1549         Your email address to be recorded in any newly created commits.
1550         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1551         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1553 user.name::
1554         Your full name to be recorded in any newly created commits.
1555         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1556         environment variables.  See linkgit:git-commit-tree[1].
1558 user.signingkey::
1559         If linkgit:git-tag[1] is not selecting the key you want it to
1560         automatically when creating a signed tag, you can override the
1561         default selection with this variable.  This option is passed
1562         unchanged to gpg's --local-user parameter, so you may specify a key
1563         using any method that gpg supports.
1565 web.browser::
1566         Specify a web browser that may be used by some commands.
1567         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1568         may use it.