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