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