grep -I: do not bother to read known-binary files
[git/dscho.git] / Documentation / config.txt
blobf778d630d2e090cf0ac6dbf4d6b65d441946f271
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, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character.  Some
17 variables may appear multiple times.
19 Syntax
20 ~~~~~~
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored.  The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables.  A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins.  Section names are not case sensitive.  Only alphanumeric
29 characters, `-` and `.` are allowed in section names.  Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections.  To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
37 --------
38         [section "subsection"]
40 --------
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively).  Section headers cannot span multiple
45 lines.  Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'.  If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character.  There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
68 1/0, true/false or on/off.  Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS).  No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
102 Example
103 ~~~~~~~
105         # Core variables
106         [core]
107                 ; Don't trust file modes
108                 filemode = false
110         # Our diff algorithm
111         [diff]
112                 external = /usr/local/bin/diff-wrapper
113                 renames = true
115         [branch "devel"]
116                 remote = origin
117                 merge = refs/heads/devel
119         # Proxy settings
120         [core]
121                 gitProxy="ssh" for "kernel.org"
122                 gitProxy=default-proxy ; for the rest
124         [include]
125                 path = /path/to/foo.inc ; include by absolute path
126                 path = foo ; expand "foo" relative to the current file
127                 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
137 advice.*::
138         These variables control various optional help messages designed to
139         aid new users. All 'advice.*' variables default to 'true', and you
140         can tell Git that you do not need help by setting these to 'false':
143         pushNonFastForward::
144                 Set this variable to 'false' if you want to disable
145                 'pushNonFFCurrent', 'pushNonFFDefault', and
146                 'pushNonFFMatching' simultaneously.
147         pushNonFFCurrent::
148                 Advice shown when linkgit:git-push[1] fails due to a
149                 non-fast-forward update to the current branch.
150         pushNonFFDefault::
151                 Advice to set 'push.default' to 'upstream' or 'current'
152                 when you ran linkgit:git-push[1] and pushed 'matching
153                 refs' by default (i.e. you did not provide an explicit
154                 refspec, and no 'push.default' configuration was set)
155                 and it resulted in a non-fast-forward error.
156         pushNonFFMatching::
157                 Advice shown when you ran linkgit:git-push[1] and pushed
158                 'matching refs' explicitly (i.e. you used ':', or
159                 specified a refspec that isn't your current branch) and
160                 it resulted in a non-fast-forward error.
161         statusHints::
162                 Show directions on how to proceed from the current
163                 state in the output of linkgit:git-status[1] and in
164                 the template shown when writing commit messages in
165                 linkgit:git-commit[1].
166         commitBeforeMerge::
167                 Advice shown when linkgit:git-merge[1] refuses to
168                 merge to avoid overwriting local changes.
169         resolveConflict::
170                 Advices shown by various commands when conflicts
171                 prevent the operation from being performed.
172         implicitIdentity::
173                 Advice on how to set your identity configuration when
174                 your information is guessed from the system username and
175                 domain name.
176         detachedHead::
177                 Advice shown when you used linkgit:git-checkout[1] to
178                 move to the detach HEAD state, to instruct how to create
179                 a local branch after the fact.
180         amWorkDir::
181                 Advice that shows the location of the patch file when
182                 linkgit:git-am[1] fails to apply it.
185 core.fileMode::
186         If false, the executable bit differences between the index and
187         the working tree are ignored; useful on broken filesystems like FAT.
188         See linkgit:git-update-index[1].
190 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
191 will probe and set core.fileMode false if appropriate when the
192 repository is created.
194 core.hideDotFiles::
195         (Windows-only) If true (which is the default), mark newly-created
196         directories and files whose name starts with a dot as hidden.
197         If 'dotGitOnly', only the .git/ directory is hidden, but no other
198         files starting with a dot.
200 core.ignoreCygwinFSTricks::
201         This option is only used by Cygwin implementation of Git. If false,
202         the Cygwin stat() and lstat() functions are used. This may be useful
203         if your repository consists of a few separate directories joined in
204         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
205         whenever it is possible and falls back to Cygwin functions only to
206         handle symbol links. The native mode is more than twice faster than
207         normal Cygwin l/stat() functions. True by default, unless core.filemode
208         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
209         POSIX emulation is required to support core.filemode.
211 core.ignorecase::
212         If true, this option enables various workarounds to enable
213         git to work better on filesystems that are not case sensitive,
214         like FAT. For example, if a directory listing finds
215         "makefile" when git expects "Makefile", git will assume
216         it is really the same file, and continue to remember it as
217         "Makefile".
219 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
220 will probe and set core.ignorecase true if appropriate when the repository
221 is created.
223 core.precomposeunicode::
224         This option is only used by Mac OS implementation of git.
225         When core.precomposeunicode=true, git reverts the unicode decomposition
226         of filenames done by Mac OS. This is useful when sharing a repository
227         between Mac OS and Linux or Windows.
228         (Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7).
229         When false, file names are handled fully transparent by git,
230         which is backward compatible with older versions of git.
232 core.trustctime::
233         If false, the ctime differences between the index and the
234         working tree are ignored; useful when the inode change time
235         is regularly modified by something outside Git (file system
236         crawlers and some backup systems).
237         See linkgit:git-update-index[1]. True by default.
239 core.quotepath::
240         The commands that output paths (e.g. 'ls-files',
241         'diff'), when not given the `-z` option, will quote
242         "unusual" characters in the pathname by enclosing the
243         pathname in a double-quote pair and with backslashes the
244         same way strings in C source code are quoted.  If this
245         variable is set to false, the bytes higher than 0x80 are
246         not quoted but output as verbatim.  Note that double
247         quote, backslash and control characters are always
248         quoted without `-z` regardless of the setting of this
249         variable.
251 core.eol::
252         Sets the line ending type to use in the working directory for
253         files that have the `text` property set.  Alternatives are
254         'lf', 'crlf' and 'native', which uses the platform's native
255         line ending.  The default value is `native`.  See
256         linkgit:gitattributes[5] for more information on end-of-line
257         conversion.
259 core.safecrlf::
260         If true, makes git check if converting `CRLF` is reversible when
261         end-of-line conversion is active.  Git will verify if a command
262         modifies a file in the work tree either directly or indirectly.
263         For example, committing a file followed by checking out the
264         same file should yield the original file in the work tree.  If
265         this is not the case for the current setting of
266         `core.autocrlf`, git will reject the file.  The variable can
267         be set to "warn", in which case git will only warn about an
268         irreversible conversion but continue the operation.
270 CRLF conversion bears a slight chance of corrupting data.
271 When it is enabled, git will convert CRLF to LF during commit and LF to
272 CRLF during checkout.  A file that contains a mixture of LF and
273 CRLF before the commit cannot be recreated by git.  For text
274 files this is the right thing to do: it corrects line endings
275 such that we have only LF line endings in the repository.
276 But for binary files that are accidentally classified as text the
277 conversion can corrupt data.
279 If you recognize such corruption early you can easily fix it by
280 setting the conversion type explicitly in .gitattributes.  Right
281 after committing you still have the original file in your work
282 tree and this file is not yet corrupted.  You can explicitly tell
283 git that this file is binary and git will handle the file
284 appropriately.
286 Unfortunately, the desired effect of cleaning up text files with
287 mixed line endings and the undesired effect of corrupting binary
288 files cannot be distinguished.  In both cases CRLFs are removed
289 in an irreversible way.  For text files this is the right thing
290 to do because CRLFs are line endings, while for binary files
291 converting CRLFs corrupts data.
293 Note, this safety check does not mean that a checkout will generate a
294 file identical to the original file for a different setting of
295 `core.eol` and `core.autocrlf`, but only for the current one.  For
296 example, a text file with `LF` would be accepted with `core.eol=lf`
297 and could later be checked out with `core.eol=crlf`, in which case the
298 resulting file would contain `CRLF`, although the original file
299 contained `LF`.  However, in both work trees the line endings would be
300 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
301 file with mixed line endings would be reported by the `core.safecrlf`
302 mechanism.
304 core.autocrlf::
305         Setting this variable to "true" is almost the same as setting
306         the `text` attribute to "auto" on all files except that text
307         files are not guaranteed to be normalized: files that contain
308         `CRLF` in the repository will not be touched.  Use this
309         setting if you want to have `CRLF` line endings in your
310         working directory even though the repository does not have
311         normalized line endings.  This variable can be set to 'input',
312         in which case no output conversion is performed.
314 core.symlinks::
315         If false, symbolic links are checked out as small plain files that
316         contain the link text. linkgit:git-update-index[1] and
317         linkgit:git-add[1] will not change the recorded type to regular
318         file. Useful on filesystems like FAT that do not support
319         symbolic links.
321 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
322 will probe and set core.symlinks false if appropriate when the repository
323 is created.
325 core.gitProxy::
326         A "proxy command" to execute (as 'command host port') instead
327         of establishing direct connection to the remote server when
328         using the git protocol for fetching. If the variable value is
329         in the "COMMAND for DOMAIN" format, the command is applied only
330         on hostnames ending with the specified domain string. This variable
331         may be set multiple times and is matched in the given order;
332         the first match wins.
334 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
335 (which always applies universally, without the special "for"
336 handling).
338 The special string `none` can be used as the proxy command to
339 specify that no proxy be used for a given domain pattern.
340 This is useful for excluding servers inside a firewall from
341 proxy use, while defaulting to a common proxy for external domains.
343 core.ignoreStat::
344         If true, commands which modify both the working tree and the index
345         will mark the updated paths with the "assume unchanged" bit in the
346         index. These marked files are then assumed to stay unchanged in the
347         working tree, until you mark them otherwise manually - Git will not
348         detect the file changes by lstat() calls. This is useful on systems
349         where those are very slow, such as Microsoft Windows.
350         See linkgit:git-update-index[1].
351         False by default.
353 core.preferSymlinkRefs::
354         Instead of the default "symref" format for HEAD
355         and other symbolic reference files, use symbolic links.
356         This is sometimes needed to work with old scripts that
357         expect HEAD to be a symbolic link.
359 core.bare::
360         If true this repository is assumed to be 'bare' and has no
361         working directory associated with it.  If this is the case a
362         number of commands that require a working directory will be
363         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
365 This setting is automatically guessed by linkgit:git-clone[1] or
366 linkgit:git-init[1] when the repository was created.  By default a
367 repository that ends in "/.git" is assumed to be not bare (bare =
368 false), while all other repositories are assumed to be bare (bare
369 = true).
371 core.worktree::
372         Set the path to the root of the working tree.
373         This can be overridden by the GIT_WORK_TREE environment
374         variable and the '--work-tree' command line option.
375         The value can be an absolute path or relative to the path to
376         the .git directory, which is either specified by --git-dir
377         or GIT_DIR, or automatically discovered.
378         If --git-dir or GIT_DIR is specified but none of
379         --work-tree, GIT_WORK_TREE and core.worktree is specified,
380         the current working directory is regarded as the top level
381         of your working tree.
383 Note that this variable is honored even when set in a configuration
384 file in a ".git" subdirectory of a directory and its value differs
385 from the latter directory (e.g. "/path/to/.git/config" has
386 core.worktree set to "/different/path"), which is most likely a
387 misconfiguration.  Running git commands in the "/path/to" directory will
388 still use "/different/path" as the root of the work tree and can cause
389 confusion unless you know what you are doing (e.g. you are creating a
390 read-only snapshot of the same index to a location different from the
391 repository's usual working tree).
393 core.logAllRefUpdates::
394         Enable the reflog. Updates to a ref <ref> is logged to the file
395         "$GIT_DIR/logs/<ref>", by appending the new and old
396         SHA1, the date/time and the reason of the update, but
397         only when the file exists.  If this configuration
398         variable is set to true, missing "$GIT_DIR/logs/<ref>"
399         file is automatically created for branch heads (i.e. under
400         refs/heads/), remote refs (i.e. under refs/remotes/),
401         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
403 This information can be used to determine what commit
404 was the tip of a branch "2 days ago".
406 This value is true by default in a repository that has
407 a working directory associated with it, and false by
408 default in a bare repository.
410 core.repositoryFormatVersion::
411         Internal variable identifying the repository format and layout
412         version.
414 core.sharedRepository::
415         When 'group' (or 'true'), the repository is made shareable between
416         several users in a group (making sure all the files and objects are
417         group-writable). When 'all' (or 'world' or 'everybody'), the
418         repository will be readable by all users, additionally to being
419         group-shareable. When 'umask' (or 'false'), git will use permissions
420         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
421         files in the repository will have this mode value. '0xxx' will override
422         user's umask value (whereas the other options will only override
423         requested parts of the user's umask value). Examples: '0660' will make
424         the repo read/write-able for the owner and group, but inaccessible to
425         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
426         repository that is group-readable but not group-writable.
427         See linkgit:git-init[1]. False by default.
429 core.warnAmbiguousRefs::
430         If true, git will warn you if the ref name you passed it is ambiguous
431         and might match multiple refs in the .git/refs/ tree. True by default.
433 core.compression::
434         An integer -1..9, indicating a default compression level.
435         -1 is the zlib default. 0 means no compression,
436         and 1..9 are various speed/size tradeoffs, 9 being slowest.
437         If set, this provides a default to other compression variables,
438         such as 'core.loosecompression' and 'pack.compression'.
440 core.loosecompression::
441         An integer -1..9, indicating the compression level for objects that
442         are not in a pack file. -1 is the zlib default. 0 means no
443         compression, and 1..9 are various speed/size tradeoffs, 9 being
444         slowest.  If not set,  defaults to core.compression.  If that is
445         not set,  defaults to 1 (best speed).
447 core.packedGitWindowSize::
448         Number of bytes of a pack file to map into memory in a
449         single mapping operation.  Larger window sizes may allow
450         your system to process a smaller number of large pack files
451         more quickly.  Smaller window sizes will negatively affect
452         performance due to increased calls to the operating system's
453         memory manager, but may improve performance when accessing
454         a large number of large pack files.
456 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
457 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
458 be reasonable for all users/operating systems.  You probably do
459 not need to adjust this value.
461 Common unit suffixes of 'k', 'm', or 'g' are supported.
463 core.packedGitLimit::
464         Maximum number of bytes to map simultaneously into memory
465         from pack files.  If Git needs to access more than this many
466         bytes at once to complete an operation it will unmap existing
467         regions to reclaim virtual address space within the process.
469 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
470 This should be reasonable for all users/operating systems, except on
471 the largest projects.  You probably do not need to adjust this value.
473 Common unit suffixes of 'k', 'm', or 'g' are supported.
475 core.deltaBaseCacheLimit::
476         Maximum number of bytes to reserve for caching base objects
477         that may be referenced by multiple deltified objects.  By storing the
478         entire decompressed base objects in a cache Git is able
479         to avoid unpacking and decompressing frequently used base
480         objects multiple times.
482 Default is 16 MiB on all platforms.  This should be reasonable
483 for all users/operating systems, except on the largest projects.
484 You probably do not need to adjust this value.
486 Common unit suffixes of 'k', 'm', or 'g' are supported.
488 core.bigFileThreshold::
489         Files larger than this size are stored deflated, without
490         attempting delta compression.  Storing large files without
491         delta compression avoids excessive memory usage, at the
492         slight expense of increased disk usage.
494 Default is 512 MiB on all platforms.  This should be reasonable
495 for most projects as source code and other text files can still
496 be delta compressed, but larger binary media files won't be.
498 Common unit suffixes of 'k', 'm', or 'g' are supported.
500 core.excludesfile::
501         In addition to '.gitignore' (per-directory) and
502         '.git/info/exclude', git looks into this file for patterns
503         of files which are not meant to be tracked.  "`~/`" is expanded
504         to the value of `$HOME` and "`~user/`" to the specified user's
505         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
506         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
507         is used instead. See linkgit:gitignore[5].
509 core.askpass::
510         Some commands (e.g. svn and http interfaces) that interactively
511         ask for a password can be told to use an external program given
512         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
513         environment variable. If not set, fall back to the value of the
514         'SSH_ASKPASS' environment variable or, failing that, a simple password
515         prompt. The external program shall be given a suitable prompt as
516         command line argument and write the password on its STDOUT.
518 core.attributesfile::
519         In addition to '.gitattributes' (per-directory) and
520         '.git/info/attributes', git looks into this file for attributes
521         (see linkgit:gitattributes[5]). Path expansions are made the same
522         way as for `core.excludesfile`. Its default value is
523         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
524         set or empty, $HOME/.config/git/attributes is used instead.
526 core.editor::
527         Commands such as `commit` and `tag` that lets you edit
528         messages by launching an editor uses the value of this
529         variable when it is set, and the environment variable
530         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
532 sequence.editor::
533         Text editor used by `git rebase -i` for editing the rebase insn file.
534         The value is meant to be interpreted by the shell when it is used.
535         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
536         When not configured the default commit message editor is used instead.
538 core.pager::
539         The command that git will use to paginate output.  Can
540         be overridden with the `GIT_PAGER` environment
541         variable.  Note that git sets the `LESS` environment
542         variable to `FRSX` if it is unset when it runs the
543         pager.  One can change these settings by setting the
544         `LESS` variable to some other value.  Alternately,
545         these settings can be overridden on a project or
546         global basis by setting the `core.pager` option.
547         Setting `core.pager` has no affect on the `LESS`
548         environment variable behaviour above, so if you want
549         to override git's default settings this way, you need
550         to be explicit.  For example, to disable the S option
551         in a backward compatible manner, set `core.pager`
552         to `less -+$LESS -FRX`.  This will be passed to the
553         shell by git, which will translate the final command to
554         `LESS=FRSX less -+FRSX -FRX`.
556 core.whitespace::
557         A comma separated list of common whitespace problems to
558         notice.  'git diff' will use `color.diff.whitespace` to
559         highlight them, and 'git apply --whitespace=error' will
560         consider them as errors.  You can prefix `-` to disable
561         any of them (e.g. `-trailing-space`):
563 * `blank-at-eol` treats trailing whitespaces at the end of the line
564   as an error (enabled by default).
565 * `space-before-tab` treats a space character that appears immediately
566   before a tab character in the initial indent part of the line as an
567   error (enabled by default).
568 * `indent-with-non-tab` treats a line that is indented with space
569   characters instead of the equivalent tabs as an error (not enabled by
570   default).
571 * `tab-in-indent` treats a tab character in the initial indent part of
572   the line as an error (not enabled by default).
573 * `blank-at-eof` treats blank lines added at the end of file as an error
574   (enabled by default).
575 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
576   `blank-at-eof`.
577 * `cr-at-eol` treats a carriage-return at the end of line as
578   part of the line terminator, i.e. with it, `trailing-space`
579   does not trigger if the character before such a carriage-return
580   is not a whitespace (not enabled by default).
581 * `tabwidth=<n>` tells how many character positions a tab occupies; this
582   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
583   errors. The default tab width is 8. Allowed values are 1 to 63.
585 core.fsyncobjectfiles::
586         This boolean will enable 'fsync()' when writing object files.
588 This is a total waste of time and effort on a filesystem that orders
589 data writes properly, but can be useful for filesystems that do not use
590 journalling (traditional UNIX filesystems) or that only journal metadata
591 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
593 core.preloadindex::
594         Enable parallel index preload for operations like 'git diff'
596 This can speed up operations like 'git diff' and 'git status' especially
597 on filesystems like NFS that have weak caching semantics and thus
598 relatively high IO latencies.  With this set to 'true', git will do the
599 index comparison to the filesystem data in parallel, allowing
600 overlapping IO's.
602 core.createObject::
603         You can set this to 'link', in which case a hardlink followed by
604         a delete of the source are used to make sure that object creation
605         will not overwrite existing objects.
607 On some file system/operating system combinations, this is unreliable.
608 Set this config setting to 'rename' there; However, This will remove the
609 check that makes sure that existing object files will not get overwritten.
611 core.notesRef::
612         When showing commit messages, also show notes which are stored in
613         the given ref.  The ref must be fully qualified.  If the given
614         ref does not exist, it is not an error but means that no
615         notes should be printed.
617 This setting defaults to "refs/notes/commits", and it can be overridden by
618 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
620 core.sparseCheckout::
621         Enable "sparse checkout" feature. See section "Sparse checkout" in
622         linkgit:git-read-tree[1] for more information.
624 core.abbrev::
625         Set the length object names are abbreviated to.  If unspecified,
626         many commands abbreviate to 7 hexdigits, which may not be enough
627         for abbreviated object names to stay unique for sufficiently long
628         time.
630 add.ignore-errors::
631 add.ignoreErrors::
632         Tells 'git add' to continue adding files when some files cannot be
633         added due to indexing errors. Equivalent to the '--ignore-errors'
634         option of linkgit:git-add[1].  Older versions of git accept only
635         `add.ignore-errors`, which does not follow the usual naming
636         convention for configuration variables.  Newer versions of git
637         honor `add.ignoreErrors` as well.
639 alias.*::
640         Command aliases for the linkgit:git[1] command wrapper - e.g.
641         after defining "alias.last = cat-file commit HEAD", the invocation
642         "git last" is equivalent to "git cat-file commit HEAD". To avoid
643         confusion and troubles with script usage, aliases that
644         hide existing git commands are ignored. Arguments are split by
645         spaces, the usual shell quoting and escaping is supported.
646         quote pair and a backslash can be used to quote them.
648 If the alias expansion is prefixed with an exclamation point,
649 it will be treated as a shell command.  For example, defining
650 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
651 "git new" is equivalent to running the shell command
652 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
653 executed from the top-level directory of a repository, which may
654 not necessarily be the current directory.
655 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
656 from the original current directory. See linkgit:git-rev-parse[1].
658 am.keepcr::
659         If true, git-am will call git-mailsplit for patches in mbox format
660         with parameter '--keep-cr'. In this case git-mailsplit will
661         not remove `\r` from lines ending with `\r\n`. Can be overridden
662         by giving '--no-keep-cr' from the command line.
663         See linkgit:git-am[1], linkgit:git-mailsplit[1].
665 apply.ignorewhitespace::
666         When set to 'change', tells 'git apply' to ignore changes in
667         whitespace, in the same way as the '--ignore-space-change'
668         option.
669         When set to one of: no, none, never, false tells 'git apply' to
670         respect all whitespace differences.
671         See linkgit:git-apply[1].
673 apply.whitespace::
674         Tells 'git apply' how to handle whitespaces, in the same way
675         as the '--whitespace' option. See linkgit:git-apply[1].
677 branch.autosetupmerge::
678         Tells 'git branch' and 'git checkout' to set up new branches
679         so that linkgit:git-pull[1] will appropriately merge from the
680         starting point branch. Note that even if this option is not set,
681         this behavior can be chosen per-branch using the `--track`
682         and `--no-track` options. The valid settings are: `false` -- no
683         automatic setup is done; `true` -- automatic setup is done when the
684         starting point is a remote-tracking branch; `always` --
685         automatic setup is done when the starting point is either a
686         local branch or remote-tracking
687         branch. This option defaults to true.
689 branch.autosetuprebase::
690         When a new branch is created with 'git branch' or 'git checkout'
691         that tracks another branch, this variable tells git to set
692         up pull to rebase instead of merge (see "branch.<name>.rebase").
693         When `never`, rebase is never automatically set to true.
694         When `local`, rebase is set to true for tracked branches of
695         other local branches.
696         When `remote`, rebase is set to true for tracked branches of
697         remote-tracking branches.
698         When `always`, rebase will be set to true for all tracking
699         branches.
700         See "branch.autosetupmerge" for details on how to set up a
701         branch to track another branch.
702         This option defaults to never.
704 branch.<name>.remote::
705         When in branch <name>, it tells 'git fetch' and 'git push' which
706         remote to fetch from/push to.  It defaults to `origin` if no remote is
707         configured. `origin` is also used if you are not on any branch.
709 branch.<name>.merge::
710         Defines, together with branch.<name>.remote, the upstream branch
711         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
712         branch to merge and can also affect 'git push' (see push.default).
713         When in branch <name>, it tells 'git fetch' the default
714         refspec to be marked for merging in FETCH_HEAD. The value is
715         handled like the remote part of a refspec, and must match a
716         ref which is fetched from the remote given by
717         "branch.<name>.remote".
718         The merge information is used by 'git pull' (which at first calls
719         'git fetch') to lookup the default branch for merging. Without
720         this option, 'git pull' defaults to merge the first refspec fetched.
721         Specify multiple values to get an octopus merge.
722         If you wish to setup 'git pull' so that it merges into <name> from
723         another branch in the local repository, you can point
724         branch.<name>.merge to the desired branch, and use the special setting
725         `.` (a period) for branch.<name>.remote.
727 branch.<name>.mergeoptions::
728         Sets default options for merging into branch <name>. The syntax and
729         supported options are the same as those of linkgit:git-merge[1], but
730         option values containing whitespace characters are currently not
731         supported.
733 branch.<name>.rebase::
734         When true, rebase the branch <name> on top of the fetched branch,
735         instead of merging the default branch from the default remote when
736         "git pull" is run. See "pull.rebase" for doing this in a non
737         branch-specific manner.
739 *NOTE*: this is a possibly dangerous operation; do *not* use
740 it unless you understand the implications (see linkgit:git-rebase[1]
741 for details).
743 browser.<tool>.cmd::
744         Specify the command to invoke the specified browser. The
745         specified command is evaluated in shell with the URLs passed
746         as arguments. (See linkgit:git-web{litdd}browse[1].)
748 browser.<tool>.path::
749         Override the path for the given tool that may be used to
750         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
751         working repository in gitweb (see linkgit:git-instaweb[1]).
753 clean.requireForce::
754         A boolean to make git-clean do nothing unless given -f
755         or -n.   Defaults to true.
757 color.branch::
758         A boolean to enable/disable color in the output of
759         linkgit:git-branch[1]. May be set to `always`,
760         `false` (or `never`) or `auto` (or `true`), in which case colors are used
761         only when the output is to a terminal. Defaults to false.
763 color.branch.<slot>::
764         Use customized color for branch coloration. `<slot>` is one of
765         `current` (the current branch), `local` (a local branch),
766         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
767         refs).
769 The value for these configuration variables is a list of colors (at most
770 two) and attributes (at most one), separated by spaces.  The colors
771 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
772 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
773 `blink` and `reverse`.  The first color given is the foreground; the
774 second is the background.  The position of the attribute, if any,
775 doesn't matter.
777 color.diff::
778         Whether to use ANSI escape sequences to add color to patches.
779         If this is set to `always`, linkgit:git-diff[1],
780         linkgit:git-log[1], and linkgit:git-show[1] will use color
781         for all patches.  If it is set to `true` or `auto`, those
782         commands will only use color when output is to the terminal.
783         Defaults to false.
785 This does not affect linkgit:git-format-patch[1] nor the
786 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
787 command line with the `--color[=<when>]` option.
789 color.diff.<slot>::
790         Use customized color for diff colorization.  `<slot>` specifies
791         which part of the patch to use the specified color, and is one
792         of `plain` (context text), `meta` (metainformation), `frag`
793         (hunk header), 'func' (function in hunk header), `old` (removed lines),
794         `new` (added lines), `commit` (commit headers), or `whitespace`
795         (highlighting whitespace errors). The values of these variables may be
796         specified as in color.branch.<slot>.
798 color.decorate.<slot>::
799         Use customized color for 'git log --decorate' output.  `<slot>` is one
800         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
801         branches, remote-tracking branches, tags, stash and HEAD, respectively.
803 color.grep::
804         When set to `always`, always highlight matches.  When `false` (or
805         `never`), never.  When set to `true` or `auto`, use color only
806         when the output is written to the terminal.  Defaults to `false`.
808 color.grep.<slot>::
809         Use customized color for grep colorization.  `<slot>` specifies which
810         part of the line to use the specified color, and is one of
813 `context`;;
814         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
815 `filename`;;
816         filename prefix (when not using `-h`)
817 `function`;;
818         function name lines (when using `-p`)
819 `linenumber`;;
820         line number prefix (when using `-n`)
821 `match`;;
822         matching text
823 `selected`;;
824         non-matching text in selected lines
825 `separator`;;
826         separators between fields on a line (`:`, `-`, and `=`)
827         and between hunks (`--`)
830 The values of these variables may be specified as in color.branch.<slot>.
832 color.interactive::
833         When set to `always`, always use colors for interactive prompts
834         and displays (such as those used by "git-add --interactive").
835         When false (or `never`), never.  When set to `true` or `auto`, use
836         colors only when the output is to the terminal. Defaults to false.
838 color.interactive.<slot>::
839         Use customized color for 'git add --interactive'
840         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
841         four distinct types of normal output from interactive
842         commands.  The values of these variables may be specified as
843         in color.branch.<slot>.
845 color.pager::
846         A boolean to enable/disable colored output when the pager is in
847         use (default is true).
849 color.showbranch::
850         A boolean to enable/disable color in the output of
851         linkgit:git-show-branch[1]. May be set to `always`,
852         `false` (or `never`) or `auto` (or `true`), in which case colors are used
853         only when the output is to a terminal. Defaults to false.
855 color.status::
856         A boolean to enable/disable color in the output of
857         linkgit:git-status[1]. May be set to `always`,
858         `false` (or `never`) or `auto` (or `true`), in which case colors are used
859         only when the output is to a terminal. Defaults to false.
861 color.status.<slot>::
862         Use customized color for status colorization. `<slot>` is
863         one of `header` (the header text of the status message),
864         `added` or `updated` (files which are added but not committed),
865         `changed` (files which are changed but not added in the index),
866         `untracked` (files which are not tracked by git),
867         `branch` (the current branch), or
868         `nobranch` (the color the 'no branch' warning is shown in, defaulting
869         to red). The values of these variables may be specified as in
870         color.branch.<slot>.
872 color.ui::
873         This variable determines the default value for variables such
874         as `color.diff` and `color.grep` that control the use of color
875         per command family. Its scope will expand as more commands learn
876         configuration to set a default for the `--color` option.  Set it
877         to `always` if you want all output not intended for machine
878         consumption to use color, to `true` or `auto` if you want such
879         output to use color when written to the terminal, or to `false` or
880         `never` if you prefer git commands not to use color unless enabled
881         explicitly with some other configuration or the `--color` option.
883 column.ui::
884         Specify whether supported commands should output in columns.
885         This variable consists of a list of tokens separated by spaces
886         or commas:
889 `always`;;
890         always show in columns
891 `never`;;
892         never show in columns
893 `auto`;;
894         show in columns if the output is to the terminal
895 `column`;;
896         fill columns before rows (default)
897 `row`;;
898         fill rows before columns
899 `plain`;;
900         show in one column
901 `dense`;;
902         make unequal size columns to utilize more space
903 `nodense`;;
904         make equal size columns
907 This option defaults to 'never'.
909 column.branch::
910         Specify whether to output branch listing in `git branch` in columns.
911         See `column.ui` for details.
913 column.status::
914         Specify whether to output untracked files in `git status` in columns.
915         See `column.ui` for details.
917 column.tag::
918         Specify whether to output tag listing in `git tag` in columns.
919         See `column.ui` for details.
921 commit.status::
922         A boolean to enable/disable inclusion of status information in the
923         commit message template when using an editor to prepare the commit
924         message.  Defaults to true.
926 commit.template::
927         Specify a file to use as the template for new commit messages.
928         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
929         specified user's home directory.
931 credential.helper::
932         Specify an external helper to be called when a username or
933         password credential is needed; the helper may consult external
934         storage to avoid prompting the user for the credentials. See
935         linkgit:gitcredentials[7] for details.
937 credential.useHttpPath::
938         When acquiring credentials, consider the "path" component of an http
939         or https URL to be important. Defaults to false. See
940         linkgit:gitcredentials[7] for more information.
942 credential.username::
943         If no username is set for a network authentication, use this username
944         by default. See credential.<context>.* below, and
945         linkgit:gitcredentials[7].
947 credential.<url>.*::
948         Any of the credential.* options above can be applied selectively to
949         some credentials. For example "credential.https://example.com.username"
950         would set the default username only for https connections to
951         example.com. See linkgit:gitcredentials[7] for details on how URLs are
952         matched.
954 include::diff-config.txt[]
956 difftool.<tool>.path::
957         Override the path for the given tool.  This is useful in case
958         your tool is not in the PATH.
960 difftool.<tool>.cmd::
961         Specify the command to invoke the specified diff tool.
962         The specified command is evaluated in shell with the following
963         variables available:  'LOCAL' is set to the name of the temporary
964         file containing the contents of the diff pre-image and 'REMOTE'
965         is set to the name of the temporary file containing the contents
966         of the diff post-image.
968 difftool.prompt::
969         Prompt before each invocation of the diff tool.
971 diff.wordRegex::
972         A POSIX Extended Regular Expression used to determine what is a "word"
973         when performing word-by-word difference calculations.  Character
974         sequences that match the regular expression are "words", all other
975         characters are *ignorable* whitespace.
977 fetch.recurseSubmodules::
978         This option can be either set to a boolean value or to 'on-demand'.
979         Setting it to a boolean changes the behavior of fetch and pull to
980         unconditionally recurse into submodules when set to true or to not
981         recurse at all when set to false. When set to 'on-demand' (the default
982         value), fetch and pull will only recurse into a populated submodule
983         when its superproject retrieves a commit that updates the submodule's
984         reference.
986 fetch.fsckObjects::
987         If it is set to true, git-fetch-pack will check all fetched
988         objects. It will abort in the case of a malformed object or a
989         broken link. The result of an abort are only dangling objects.
990         Defaults to false. If not set, the value of `transfer.fsckObjects`
991         is used instead.
993 fetch.unpackLimit::
994         If the number of objects fetched over the git native
995         transfer is below this
996         limit, then the objects will be unpacked into loose object
997         files. However if the number of received objects equals or
998         exceeds this limit then the received pack will be stored as
999         a pack, after adding any missing delta bases.  Storing the
1000         pack from a push can make the push operation complete faster,
1001         especially on slow filesystems.  If not set, the value of
1002         `transfer.unpackLimit` is used instead.
1004 format.attach::
1005         Enable multipart/mixed attachments as the default for
1006         'format-patch'.  The value can also be a double quoted string
1007         which will enable attachments as the default and set the
1008         value as the boundary.  See the --attach option in
1009         linkgit:git-format-patch[1].
1011 format.numbered::
1012         A boolean which can enable or disable sequence numbers in patch
1013         subjects.  It defaults to "auto" which enables it only if there
1014         is more than one patch.  It can be enabled or disabled for all
1015         messages by setting it to "true" or "false".  See --numbered
1016         option in linkgit:git-format-patch[1].
1018 format.headers::
1019         Additional email headers to include in a patch to be submitted
1020         by mail.  See linkgit:git-format-patch[1].
1022 format.to::
1023 format.cc::
1024         Additional recipients to include in a patch to be submitted
1025         by mail.  See the --to and --cc options in
1026         linkgit:git-format-patch[1].
1028 format.subjectprefix::
1029         The default for format-patch is to output files with the '[PATCH]'
1030         subject prefix. Use this variable to change that prefix.
1032 format.signature::
1033         The default for format-patch is to output a signature containing
1034         the git version number. Use this variable to change that default.
1035         Set this variable to the empty string ("") to suppress
1036         signature generation.
1038 format.suffix::
1039         The default for format-patch is to output files with the suffix
1040         `.patch`. Use this variable to change that suffix (make sure to
1041         include the dot if you want it).
1043 format.pretty::
1044         The default pretty format for log/show/whatchanged command,
1045         See linkgit:git-log[1], linkgit:git-show[1],
1046         linkgit:git-whatchanged[1].
1048 format.thread::
1049         The default threading style for 'git format-patch'.  Can be
1050         a boolean value, or `shallow` or `deep`.  `shallow` threading
1051         makes every mail a reply to the head of the series,
1052         where the head is chosen from the cover letter, the
1053         `--in-reply-to`, and the first patch mail, in this order.
1054         `deep` threading makes every mail a reply to the previous one.
1055         A true boolean value is the same as `shallow`, and a false
1056         value disables threading.
1058 format.signoff::
1059     A boolean value which lets you enable the `-s/--signoff` option of
1060     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1061     patch should be a conscious act and means that you certify you have
1062     the rights to submit this work under the same open source license.
1063     Please see the 'SubmittingPatches' document for further discussion.
1065 filter.<driver>.clean::
1066         The command which is used to convert the content of a worktree
1067         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1068         details.
1070 filter.<driver>.smudge::
1071         The command which is used to convert the content of a blob
1072         object to a worktree file upon checkout.  See
1073         linkgit:gitattributes[5] for details.
1075 gc.aggressiveWindow::
1076         The window size parameter used in the delta compression
1077         algorithm used by 'git gc --aggressive'.  This defaults
1078         to 250.
1080 gc.auto::
1081         When there are approximately more than this many loose
1082         objects in the repository, `git gc --auto` will pack them.
1083         Some Porcelain commands use this command to perform a
1084         light-weight garbage collection from time to time.  The
1085         default value is 6700.  Setting this to 0 disables it.
1087 gc.autopacklimit::
1088         When there are more than this many packs that are not
1089         marked with `*.keep` file in the repository, `git gc
1090         --auto` consolidates them into one larger pack.  The
1091         default value is 50.  Setting this to 0 disables it.
1093 gc.packrefs::
1094         Running `git pack-refs` in a repository renders it
1095         unclonable by Git versions prior to 1.5.1.2 over dumb
1096         transports such as HTTP.  This variable determines whether
1097         'git gc' runs `git pack-refs`. This can be set to `notbare`
1098         to enable it within all non-bare repos or it can be set to a
1099         boolean value.  The default is `true`.
1101 gc.pruneexpire::
1102         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1103         Override the grace period with this config variable.  The value
1104         "now" may be used to disable this  grace period and always prune
1105         unreachable objects immediately.
1107 gc.reflogexpire::
1108 gc.<pattern>.reflogexpire::
1109         'git reflog expire' removes reflog entries older than
1110         this time; defaults to 90 days.  With "<pattern>" (e.g.
1111         "refs/stash") in the middle the setting applies only to
1112         the refs that match the <pattern>.
1114 gc.reflogexpireunreachable::
1115 gc.<ref>.reflogexpireunreachable::
1116         'git reflog expire' removes reflog entries older than
1117         this time and are not reachable from the current tip;
1118         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1119         in the middle, the setting applies only to the refs that
1120         match the <pattern>.
1122 gc.rerereresolved::
1123         Records of conflicted merge you resolved earlier are
1124         kept for this many days when 'git rerere gc' is run.
1125         The default is 60 days.  See linkgit:git-rerere[1].
1127 gc.rerereunresolved::
1128         Records of conflicted merge you have not resolved are
1129         kept for this many days when 'git rerere gc' is run.
1130         The default is 15 days.  See linkgit:git-rerere[1].
1132 gitcvs.commitmsgannotation::
1133         Append this string to each commit message. Set to empty string
1134         to disable this feature. Defaults to "via git-CVS emulator".
1136 gitcvs.enabled::
1137         Whether the CVS server interface is enabled for this repository.
1138         See linkgit:git-cvsserver[1].
1140 gitcvs.logfile::
1141         Path to a log file where the CVS server interface well... logs
1142         various stuff. See linkgit:git-cvsserver[1].
1144 gitcvs.usecrlfattr::
1145         If true, the server will look up the end-of-line conversion
1146         attributes for files to determine the '-k' modes to use. If
1147         the attributes force git to treat a file as text,
1148         the '-k' mode will be left blank so CVS clients will
1149         treat it as text. If they suppress text conversion, the file
1150         will be set with '-kb' mode, which suppresses any newline munging
1151         the client might otherwise do. If the attributes do not allow
1152         the file type to be determined, then 'gitcvs.allbinary' is
1153         used. See linkgit:gitattributes[5].
1155 gitcvs.allbinary::
1156         This is used if 'gitcvs.usecrlfattr' does not resolve
1157         the correct '-kb' mode to use. If true, all
1158         unresolved files are sent to the client in
1159         mode '-kb'. This causes the client to treat them
1160         as binary files, which suppresses any newline munging it
1161         otherwise might do. Alternatively, if it is set to "guess",
1162         then the contents of the file are examined to decide if
1163         it is binary, similar to 'core.autocrlf'.
1165 gitcvs.dbname::
1166         Database used by git-cvsserver to cache revision information
1167         derived from the git repository. The exact meaning depends on the
1168         used database driver, for SQLite (which is the default driver) this
1169         is a filename. Supports variable substitution (see
1170         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1171         Default: '%Ggitcvs.%m.sqlite'
1173 gitcvs.dbdriver::
1174         Used Perl DBI driver. You can specify any available driver
1175         for this here, but it might not work. git-cvsserver is tested
1176         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1177         reported *not* to work with 'DBD::mysql'. Experimental feature.
1178         May not contain double colons (`:`). Default: 'SQLite'.
1179         See linkgit:git-cvsserver[1].
1181 gitcvs.dbuser, gitcvs.dbpass::
1182         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1183         since SQLite has no concept of database users and/or passwords.
1184         'gitcvs.dbuser' supports variable substitution (see
1185         linkgit:git-cvsserver[1] for details).
1187 gitcvs.dbTableNamePrefix::
1188         Database table name prefix.  Prepended to the names of any
1189         database tables used, allowing a single database to be used
1190         for several repositories.  Supports variable substitution (see
1191         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1192         characters will be replaced with underscores.
1194 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1195 'gitcvs.allbinary' can also be specified as
1196 'gitcvs.<access_method>.<varname>' (where 'access_method'
1197 is one of "ext" and "pserver") to make them apply only for the given
1198 access method.
1200 gitweb.category::
1201 gitweb.description::
1202 gitweb.owner::
1203 gitweb.url::
1204         See linkgit:gitweb[1] for description.
1206 gitweb.avatar::
1207 gitweb.blame::
1208 gitweb.grep::
1209 gitweb.highlight::
1210 gitweb.patches::
1211 gitweb.pickaxe::
1212 gitweb.remote_heads::
1213 gitweb.showsizes::
1214 gitweb.snapshot::
1215         See linkgit:gitweb.conf[5] for description.
1217 grep.lineNumber::
1218         If set to true, enable '-n' option by default.
1220 grep.patternType::
1221         Set the default matching behavior. Using a value of 'basic', 'extended',
1222         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1223         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1224         value 'default' will return to the default matching behavior.
1226 grep.extendedRegexp::
1227         If set to true, enable '--extended-regexp' option by default. This
1228         option is ignored when the 'grep.patternType' option is set to a value
1229         other than 'default'.
1231 gpg.program::
1232         Use this custom program instead of "gpg" found on $PATH when
1233         making or verifying a PGP signature. The program must support the
1234         same command line interface as GPG, namely, to verify a detached
1235         signature, "gpg --verify $file - <$signature" is run, and the
1236         program is expected to signal a good signature by exiting with
1237         code 0, and to generate an ascii-armored detached signature, the
1238         standard input of "gpg -bsau $key" is fed with the contents to be
1239         signed, and the program is expected to send the result to its
1240         standard output.
1242 gui.commitmsgwidth::
1243         Defines how wide the commit message window is in the
1244         linkgit:git-gui[1]. "75" is the default.
1246 gui.diffcontext::
1247         Specifies how many context lines should be used in calls to diff
1248         made by the linkgit:git-gui[1]. The default is "5".
1250 gui.encoding::
1251         Specifies the default encoding to use for displaying of
1252         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1253         It can be overridden by setting the 'encoding' attribute
1254         for relevant files (see linkgit:gitattributes[5]).
1255         If this option is not set, the tools default to the
1256         locale encoding.
1258 gui.matchtrackingbranch::
1259         Determines if new branches created with linkgit:git-gui[1] should
1260         default to tracking remote branches with matching names or
1261         not. Default: "false".
1263 gui.newbranchtemplate::
1264         Is used as suggested name when creating new branches using the
1265         linkgit:git-gui[1].
1267 gui.pruneduringfetch::
1268         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1269         performing a fetch. The default value is "false".
1271 gui.trustmtime::
1272         Determines if linkgit:git-gui[1] should trust the file modification
1273         timestamp or not. By default the timestamps are not trusted.
1275 gui.spellingdictionary::
1276         Specifies the dictionary used for spell checking commit messages in
1277         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1278         off.
1280 gui.fastcopyblame::
1281         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1282         location detection. It makes blame significantly faster on huge
1283         repositories at the expense of less thorough copy detection.
1285 gui.copyblamethreshold::
1286         Specifies the threshold to use in 'git gui blame' original location
1287         detection, measured in alphanumeric characters. See the
1288         linkgit:git-blame[1] manual for more information on copy detection.
1290 gui.blamehistoryctx::
1291         Specifies the radius of history context in days to show in
1292         linkgit:gitk[1] for the selected commit, when the `Show History
1293         Context` menu item is invoked from 'git gui blame'. If this
1294         variable is set to zero, the whole history is shown.
1296 guitool.<name>.cmd::
1297         Specifies the shell command line to execute when the corresponding item
1298         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1299         mandatory for every tool. The command is executed from the root of
1300         the working directory, and in the environment it receives the name of
1301         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1302         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1303         the head is detached, 'CUR_BRANCH' is empty).
1305 guitool.<name>.needsfile::
1306         Run the tool only if a diff is selected in the GUI. It guarantees
1307         that 'FILENAME' is not empty.
1309 guitool.<name>.noconsole::
1310         Run the command silently, without creating a window to display its
1311         output.
1313 guitool.<name>.norescan::
1314         Don't rescan the working directory for changes after the tool
1315         finishes execution.
1317 guitool.<name>.confirm::
1318         Show a confirmation dialog before actually running the tool.
1320 guitool.<name>.argprompt::
1321         Request a string argument from the user, and pass it to the tool
1322         through the 'ARGS' environment variable. Since requesting an
1323         argument implies confirmation, the 'confirm' option has no effect
1324         if this is enabled. If the option is set to 'true', 'yes', or '1',
1325         the dialog uses a built-in generic prompt; otherwise the exact
1326         value of the variable is used.
1328 guitool.<name>.revprompt::
1329         Request a single valid revision from the user, and set the
1330         'REVISION' environment variable. In other aspects this option
1331         is similar to 'argprompt', and can be used together with it.
1333 guitool.<name>.revunmerged::
1334         Show only unmerged branches in the 'revprompt' subdialog.
1335         This is useful for tools similar to merge or rebase, but not
1336         for things like checkout or reset.
1338 guitool.<name>.title::
1339         Specifies the title to use for the prompt dialog. The default
1340         is the tool name.
1342 guitool.<name>.prompt::
1343         Specifies the general prompt string to display at the top of
1344         the dialog, before subsections for 'argprompt' and 'revprompt'.
1345         The default value includes the actual command.
1347 help.browser::
1348         Specify the browser that will be used to display help in the
1349         'web' format. See linkgit:git-help[1].
1351 help.format::
1352         Override the default help format used by linkgit:git-help[1].
1353         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1354         the default. 'web' and 'html' are the same.
1356 help.autocorrect::
1357         Automatically correct and execute mistyped commands after
1358         waiting for the given number of deciseconds (0.1 sec). If more
1359         than one command can be deduced from the entered text, nothing
1360         will be executed.  If the value of this option is negative,
1361         the corrected command will be executed immediately. If the
1362         value is 0 - the command will be just shown but not executed.
1363         This is the default.
1365 http.proxy::
1366         Override the HTTP proxy, normally configured using the 'http_proxy',
1367         'https_proxy', and 'all_proxy' environment variables (see
1368         `curl(1)`).  This can be overridden on a per-remote basis; see
1369         remote.<name>.proxy
1371 http.cookiefile::
1372         File containing previously stored cookie lines which should be used
1373         in the git http session, if they match the server. The file format
1374         of the file to read cookies from should be plain HTTP headers or
1375         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1376         NOTE that the file specified with http.cookiefile is only used as
1377         input. No cookies will be stored in the file.
1379 http.sslVerify::
1380         Whether to verify the SSL certificate when fetching or pushing
1381         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1382         variable.
1384 http.sslCert::
1385         File containing the SSL certificate when fetching or pushing
1386         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1387         variable.
1389 http.sslKey::
1390         File containing the SSL private key when fetching or pushing
1391         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1392         variable.
1394 http.sslCertPasswordProtected::
1395         Enable git's password prompt for the SSL certificate.  Otherwise
1396         OpenSSL will prompt the user, possibly many times, if the
1397         certificate or private key is encrypted.  Can be overridden by the
1398         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1400 http.sslCAInfo::
1401         File containing the certificates to verify the peer with when
1402         fetching or pushing over HTTPS. Can be overridden by the
1403         'GIT_SSL_CAINFO' environment variable.
1405 http.sslCAPath::
1406         Path containing files with the CA certificates to verify the peer
1407         with when fetching or pushing over HTTPS. Can be overridden
1408         by the 'GIT_SSL_CAPATH' environment variable.
1410 http.maxRequests::
1411         How many HTTP requests to launch in parallel. Can be overridden
1412         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1414 http.minSessions::
1415         The number of curl sessions (counted across slots) to be kept across
1416         requests. They will not be ended with curl_easy_cleanup() until
1417         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1418         value will be capped at 1. Defaults to 1.
1420 http.postBuffer::
1421         Maximum size in bytes of the buffer used by smart HTTP
1422         transports when POSTing data to the remote system.
1423         For requests larger than this buffer size, HTTP/1.1 and
1424         Transfer-Encoding: chunked is used to avoid creating a
1425         massive pack file locally.  Default is 1 MiB, which is
1426         sufficient for most requests.
1428 http.lowSpeedLimit, http.lowSpeedTime::
1429         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1430         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1431         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1432         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1434 http.noEPSV::
1435         A boolean which disables using of EPSV ftp command by curl.
1436         This can helpful with some "poor" ftp servers which don't
1437         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1438         environment variable. Default is false (curl will use EPSV).
1440 http.useragent::
1441         The HTTP USER_AGENT string presented to an HTTP server.  The default
1442         value represents the version of the client git such as git/1.7.1.
1443         This option allows you to override this value to a more common value
1444         such as Mozilla/4.0.  This may be necessary, for instance, if
1445         connecting through a firewall that restricts HTTP connections to a set
1446         of common USER_AGENT strings (but not including those like git/1.7.1).
1447         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1449 i18n.commitEncoding::
1450         Character encoding the commit messages are stored in; git itself
1451         does not care per se, but this information is necessary e.g. when
1452         importing commits from emails or in the gitk graphical history
1453         browser (and possibly at other places in the future or in other
1454         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1456 i18n.logOutputEncoding::
1457         Character encoding the commit messages are converted to when
1458         running 'git log' and friends.
1460 imap::
1461         The configuration variables in the 'imap' section are described
1462         in linkgit:git-imap-send[1].
1464 init.templatedir::
1465         Specify the directory from which templates will be copied.
1466         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1468 instaweb.browser::
1469         Specify the program that will be used to browse your working
1470         repository in gitweb. See linkgit:git-instaweb[1].
1472 instaweb.httpd::
1473         The HTTP daemon command-line to start gitweb on your working
1474         repository. See linkgit:git-instaweb[1].
1476 instaweb.local::
1477         If true the web server started by linkgit:git-instaweb[1] will
1478         be bound to the local IP (127.0.0.1).
1480 instaweb.modulepath::
1481         The default module path for linkgit:git-instaweb[1] to use
1482         instead of /usr/lib/apache2/modules.  Only used if httpd
1483         is Apache.
1485 instaweb.port::
1486         The port number to bind the gitweb httpd to. See
1487         linkgit:git-instaweb[1].
1489 interactive.singlekey::
1490         In interactive commands, allow the user to provide one-letter
1491         input with a single key (i.e., without hitting enter).
1492         Currently this is used by the `--patch` mode of
1493         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1494         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1495         setting is silently ignored if portable keystroke input
1496         is not available.
1498 log.abbrevCommit::
1499         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1500         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1501         override this option with `--no-abbrev-commit`.
1503 log.date::
1504         Set the default date-time mode for the 'log' command.
1505         Setting a value for log.date is similar to using 'git log''s
1506         `--date` option.  Possible values are `relative`, `local`,
1507         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1508         for details.
1510 log.decorate::
1511         Print out the ref names of any commits that are shown by the log
1512         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1513         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1514         specified, the full ref name (including prefix) will be printed.
1515         This is the same as the log commands '--decorate' option.
1517 log.showroot::
1518         If true, the initial commit will be shown as a big creation event.
1519         This is equivalent to a diff against an empty tree.
1520         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1521         normally hide the root commit will now show it. True by default.
1523 mailmap.file::
1524         The location of an augmenting mailmap file. The default
1525         mailmap, located in the root of the repository, is loaded
1526         first, then the mailmap file pointed to by this variable.
1527         The location of the mailmap file may be in a repository
1528         subdirectory, or somewhere outside of the repository itself.
1529         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1531 man.viewer::
1532         Specify the programs that may be used to display help in the
1533         'man' format. See linkgit:git-help[1].
1535 man.<tool>.cmd::
1536         Specify the command to invoke the specified man viewer. The
1537         specified command is evaluated in shell with the man page
1538         passed as argument. (See linkgit:git-help[1].)
1540 man.<tool>.path::
1541         Override the path for the given tool that may be used to
1542         display help in the 'man' format. See linkgit:git-help[1].
1544 include::merge-config.txt[]
1546 mergetool.<tool>.path::
1547         Override the path for the given tool.  This is useful in case
1548         your tool is not in the PATH.
1550 mergetool.<tool>.cmd::
1551         Specify the command to invoke the specified merge tool.  The
1552         specified command is evaluated in shell with the following
1553         variables available: 'BASE' is the name of a temporary file
1554         containing the common base of the files to be merged, if available;
1555         'LOCAL' is the name of a temporary file containing the contents of
1556         the file on the current branch; 'REMOTE' is the name of a temporary
1557         file containing the contents of the file from the branch being
1558         merged; 'MERGED' contains the name of the file to which the merge
1559         tool should write the results of a successful merge.
1561 mergetool.<tool>.trustExitCode::
1562         For a custom merge command, specify whether the exit code of
1563         the merge command can be used to determine whether the merge was
1564         successful.  If this is not set to true then the merge target file
1565         timestamp is checked and the merge assumed to have been successful
1566         if the file has been updated, otherwise the user is prompted to
1567         indicate the success of the merge.
1569 mergetool.keepBackup::
1570         After performing a merge, the original file with conflict markers
1571         can be saved as a file with a `.orig` extension.  If this variable
1572         is set to `false` then this file is not preserved.  Defaults to
1573         `true` (i.e. keep the backup files).
1575 mergetool.keepTemporaries::
1576         When invoking a custom merge tool, git uses a set of temporary
1577         files to pass to the tool. If the tool returns an error and this
1578         variable is set to `true`, then these temporary files will be
1579         preserved, otherwise they will be removed after the tool has
1580         exited. Defaults to `false`.
1582 mergetool.prompt::
1583         Prompt before each invocation of the merge resolution program.
1585 notes.displayRef::
1586         The (fully qualified) refname from which to show notes when
1587         showing commit messages.  The value of this variable can be set
1588         to a glob, in which case notes from all matching refs will be
1589         shown.  You may also specify this configuration variable
1590         several times.  A warning will be issued for refs that do not
1591         exist, but a glob that does not match any refs is silently
1592         ignored.
1594 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1595 environment variable, which must be a colon separated list of refs or
1596 globs.
1598 The effective value of "core.notesRef" (possibly overridden by
1599 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1600 displayed.
1602 notes.rewrite.<command>::
1603         When rewriting commits with <command> (currently `amend` or
1604         `rebase`) and this variable is set to `true`, git
1605         automatically copies your notes from the original to the
1606         rewritten commit.  Defaults to `true`, but see
1607         "notes.rewriteRef" below.
1609 notes.rewriteMode::
1610         When copying notes during a rewrite (see the
1611         "notes.rewrite.<command>" option), determines what to do if
1612         the target commit already has a note.  Must be one of
1613         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1614         `concatenate`.
1616 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1617 environment variable.
1619 notes.rewriteRef::
1620         When copying notes during a rewrite, specifies the (fully
1621         qualified) ref whose notes should be copied.  The ref may be a
1622         glob, in which case notes in all matching refs will be copied.
1623         You may also specify this configuration several times.
1625 Does not have a default value; you must configure this variable to
1626 enable note rewriting.  Set it to `refs/notes/commits` to enable
1627 rewriting for the default commit notes.
1629 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1630 environment variable, which must be a colon separated list of refs or
1631 globs.
1633 pack.window::
1634         The size of the window used by linkgit:git-pack-objects[1] when no
1635         window size is given on the command line. Defaults to 10.
1637 pack.depth::
1638         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1639         maximum depth is given on the command line. Defaults to 50.
1641 pack.windowMemory::
1642         The window memory size limit used by linkgit:git-pack-objects[1]
1643         when no limit is given on the command line.  The value can be
1644         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1645         limit.
1647 pack.compression::
1648         An integer -1..9, indicating the compression level for objects
1649         in a pack file. -1 is the zlib default. 0 means no
1650         compression, and 1..9 are various speed/size tradeoffs, 9 being
1651         slowest.  If not set,  defaults to core.compression.  If that is
1652         not set,  defaults to -1, the zlib default, which is "a default
1653         compromise between speed and compression (currently equivalent
1654         to level 6)."
1656 Note that changing the compression level will not automatically recompress
1657 all existing objects. You can force recompression by passing the -F option
1658 to linkgit:git-repack[1].
1660 pack.deltaCacheSize::
1661         The maximum memory in bytes used for caching deltas in
1662         linkgit:git-pack-objects[1] before writing them out to a pack.
1663         This cache is used to speed up the writing object phase by not
1664         having to recompute the final delta result once the best match
1665         for all objects is found.  Repacking large repositories on machines
1666         which are tight with memory might be badly impacted by this though,
1667         especially if this cache pushes the system into swapping.
1668         A value of 0 means no limit. The smallest size of 1 byte may be
1669         used to virtually disable this cache. Defaults to 256 MiB.
1671 pack.deltaCacheLimit::
1672         The maximum size of a delta, that is cached in
1673         linkgit:git-pack-objects[1]. This cache is used to speed up the
1674         writing object phase by not having to recompute the final delta
1675         result once the best match for all objects is found. Defaults to 1000.
1677 pack.threads::
1678         Specifies the number of threads to spawn when searching for best
1679         delta matches.  This requires that linkgit:git-pack-objects[1]
1680         be compiled with pthreads otherwise this option is ignored with a
1681         warning. This is meant to reduce packing time on multiprocessor
1682         machines. The required amount of memory for the delta search window
1683         is however multiplied by the number of threads.
1684         Specifying 0 will cause git to auto-detect the number of CPU's
1685         and set the number of threads accordingly.
1687 pack.indexVersion::
1688         Specify the default pack index version.  Valid values are 1 for
1689         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1690         the new pack index with capabilities for packs larger than 4 GB
1691         as well as proper protection against the repacking of corrupted
1692         packs.  Version 2 is the default.  Note that version 2 is enforced
1693         and this config option ignored whenever the corresponding pack is
1694         larger than 2 GB.
1696 If you have an old git that does not understand the version 2 `*.idx` file,
1697 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1698 that will copy both `*.pack` file and corresponding `*.idx` file from the
1699 other side may give you a repository that cannot be accessed with your
1700 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1701 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1702 the `*.idx` file.
1704 pack.packSizeLimit::
1705         The maximum size of a pack.  This setting only affects
1706         packing to a file when repacking, i.e. the git:// protocol
1707         is unaffected.  It can be overridden by the `--max-pack-size`
1708         option of linkgit:git-repack[1]. The minimum size allowed is
1709         limited to 1 MiB. The default is unlimited.
1710         Common unit suffixes of 'k', 'm', or 'g' are
1711         supported.
1713 pager.<cmd>::
1714         If the value is boolean, turns on or off pagination of the
1715         output of a particular git subcommand when writing to a tty.
1716         Otherwise, turns on pagination for the subcommand using the
1717         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1718         or `--no-pager` is specified on the command line, it takes
1719         precedence over this option.  To disable pagination for all
1720         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1722 pretty.<name>::
1723         Alias for a --pretty= format string, as specified in
1724         linkgit:git-log[1]. Any aliases defined here can be used just
1725         as the built-in pretty formats could. For example,
1726         running `git config pretty.changelog "format:* %H %s"`
1727         would cause the invocation `git log --pretty=changelog`
1728         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1729         Note that an alias with the same name as a built-in format
1730         will be silently ignored.
1732 pull.rebase::
1733         When true, rebase branches on top of the fetched branch, instead
1734         of merging the default branch from the default remote when "git
1735         pull" is run. See "branch.<name>.rebase" for setting this on a
1736         per-branch basis.
1738 *NOTE*: this is a possibly dangerous operation; do *not* use
1739 it unless you understand the implications (see linkgit:git-rebase[1]
1740 for details).
1742 pull.octopus::
1743         The default merge strategy to use when pulling multiple branches
1744         at once.
1746 pull.twohead::
1747         The default merge strategy to use when pulling a single branch.
1749 push.default::
1750         Defines the action git push should take if no refspec is given
1751         on the command line, no refspec is configured in the remote, and
1752         no refspec is implied by any of the options given on the command
1753         line. Possible values are:
1756 * `nothing` - do not push anything.
1757 * `matching` - push all branches having the same name in both ends.
1758   This is for those who prepare all the branches into a publishable
1759   shape and then push them out with a single command.  It is not
1760   appropriate for pushing into a repository shared by multiple users,
1761   since locally stalled branches will attempt a non-fast forward push
1762   if other users updated the branch.
1763   +
1764   This is currently the default, but Git 2.0 will change the default
1765   to `simple`.
1766 * `upstream` - push the current branch to its upstream branch.
1767   With this, `git push` will update the same remote ref as the one which
1768   is merged by `git pull`, making `push` and `pull` symmetrical.
1769   See "branch.<name>.merge" for how to configure the upstream branch.
1770 * `simple` - like `upstream`, but refuses to push if the upstream
1771   branch's name is different from the local one. This is the safest
1772   option and is well-suited for beginners. It will become the default
1773   in Git 2.0.
1774 * `current` - push the current branch to a branch of the same name.
1777 The `simple`, `current` and `upstream` modes are for those who want to
1778 push out a single branch after finishing work, even when the other
1779 branches are not yet ready to be pushed out. If you are working with
1780 other people to push into the same shared repository, you would want
1781 to use one of these.
1783 rebase.stat::
1784         Whether to show a diffstat of what changed upstream since the last
1785         rebase. False by default.
1787 rebase.autosquash::
1788         If set to true enable '--autosquash' option by default.
1790 receive.autogc::
1791         By default, git-receive-pack will run "git-gc --auto" after
1792         receiving data from git-push and updating refs.  You can stop
1793         it by setting this variable to false.
1795 receive.fsckObjects::
1796         If it is set to true, git-receive-pack will check all received
1797         objects. It will abort in the case of a malformed object or a
1798         broken link. The result of an abort are only dangling objects.
1799         Defaults to false. If not set, the value of `transfer.fsckObjects`
1800         is used instead.
1802 receive.unpackLimit::
1803         If the number of objects received in a push is below this
1804         limit then the objects will be unpacked into loose object
1805         files. However if the number of received objects equals or
1806         exceeds this limit then the received pack will be stored as
1807         a pack, after adding any missing delta bases.  Storing the
1808         pack from a push can make the push operation complete faster,
1809         especially on slow filesystems.  If not set, the value of
1810         `transfer.unpackLimit` is used instead.
1812 receive.denyDeletes::
1813         If set to true, git-receive-pack will deny a ref update that deletes
1814         the ref. Use this to prevent such a ref deletion via a push.
1816 receive.denyDeleteCurrent::
1817         If set to true, git-receive-pack will deny a ref update that
1818         deletes the currently checked out branch of a non-bare repository.
1820 receive.denyCurrentBranch::
1821         If set to true or "refuse", git-receive-pack will deny a ref update
1822         to the currently checked out branch of a non-bare repository.
1823         Such a push is potentially dangerous because it brings the HEAD
1824         out of sync with the index and working tree. If set to "warn",
1825         print a warning of such a push to stderr, but allow the push to
1826         proceed. If set to false or "ignore", allow such pushes with no
1827         message. Defaults to "refuse".
1829 There are two more options that are meant for Git experts: "updateInstead"
1830 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1831 the HEAD so it does not need to change.  Both options come with their own
1832 set of possible *complications*, but can be appropriate in rare workflows.
1834 receive.denyNonFastForwards::
1835         If set to true, git-receive-pack will deny a ref update which is
1836         not a fast-forward. Use this to prevent such an update via a push,
1837         even if that push is forced. This configuration variable is
1838         set when initializing a shared repository.
1840 receive.updateserverinfo::
1841         If set to true, git-receive-pack will run git-update-server-info
1842         after receiving data from git-push and updating refs.
1844 remote.<name>.url::
1845         The URL of a remote repository.  See linkgit:git-fetch[1] or
1846         linkgit:git-push[1].
1848 remote.<name>.pushurl::
1849         The push URL of a remote repository.  See linkgit:git-push[1].
1851 remote.<name>.proxy::
1852         For remotes that require curl (http, https and ftp), the URL to
1853         the proxy to use for that remote.  Set to the empty string to
1854         disable proxying for that remote.
1856 remote.<name>.fetch::
1857         The default set of "refspec" for linkgit:git-fetch[1]. See
1858         linkgit:git-fetch[1].
1860 remote.<name>.push::
1861         The default set of "refspec" for linkgit:git-push[1]. See
1862         linkgit:git-push[1].
1864 remote.<name>.mirror::
1865         If true, pushing to this remote will automatically behave
1866         as if the `--mirror` option was given on the command line.
1868 remote.<name>.skipDefaultUpdate::
1869         If true, this remote will be skipped by default when updating
1870         using linkgit:git-fetch[1] or the `update` subcommand of
1871         linkgit:git-remote[1].
1873 remote.<name>.skipFetchAll::
1874         If true, this remote will be skipped by default when updating
1875         using linkgit:git-fetch[1] or the `update` subcommand of
1876         linkgit:git-remote[1].
1878 remote.<name>.receivepack::
1879         The default program to execute on the remote side when pushing.  See
1880         option \--receive-pack of linkgit:git-push[1].
1882 remote.<name>.uploadpack::
1883         The default program to execute on the remote side when fetching.  See
1884         option \--upload-pack of linkgit:git-fetch-pack[1].
1886 remote.<name>.tagopt::
1887         Setting this value to \--no-tags disables automatic tag following when
1888         fetching from remote <name>. Setting it to \--tags will fetch every
1889         tag from remote <name>, even if they are not reachable from remote
1890         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1891         override this setting. See options \--tags and \--no-tags of
1892         linkgit:git-fetch[1].
1894 remote.<name>.vcs::
1895         Setting this to a value <vcs> will cause git to interact with
1896         the remote with the git-remote-<vcs> helper.
1898 remotes.<group>::
1899         The list of remotes which are fetched by "git remote update
1900         <group>".  See linkgit:git-remote[1].
1902 repack.usedeltabaseoffset::
1903         By default, linkgit:git-repack[1] creates packs that use
1904         delta-base offset. If you need to share your repository with
1905         git older than version 1.4.4, either directly or via a dumb
1906         protocol such as http, then you need to set this option to
1907         "false" and repack. Access from old git versions over the
1908         native protocol are unaffected by this option.
1910 rerere.autoupdate::
1911         When set to true, `git-rerere` updates the index with the
1912         resulting contents after it cleanly resolves conflicts using
1913         previously recorded resolution.  Defaults to false.
1915 rerere.enabled::
1916         Activate recording of resolved conflicts, so that identical
1917         conflict hunks can be resolved automatically, should they be
1918         encountered again.  By default, linkgit:git-rerere[1] is
1919         enabled if there is an `rr-cache` directory under the
1920         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1921         repository.
1923 sendemail.identity::
1924         A configuration identity. When given, causes values in the
1925         'sendemail.<identity>' subsection to take precedence over
1926         values in the 'sendemail' section. The default identity is
1927         the value of 'sendemail.identity'.
1929 sendemail.smtpencryption::
1930         See linkgit:git-send-email[1] for description.  Note that this
1931         setting is not subject to the 'identity' mechanism.
1933 sendemail.smtpssl::
1934         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1936 sendemail.<identity>.*::
1937         Identity-specific versions of the 'sendemail.*' parameters
1938         found below, taking precedence over those when the this
1939         identity is selected, through command-line or
1940         'sendemail.identity'.
1942 sendemail.aliasesfile::
1943 sendemail.aliasfiletype::
1944 sendemail.bcc::
1945 sendemail.cc::
1946 sendemail.cccmd::
1947 sendemail.chainreplyto::
1948 sendemail.confirm::
1949 sendemail.envelopesender::
1950 sendemail.from::
1951 sendemail.multiedit::
1952 sendemail.signedoffbycc::
1953 sendemail.smtppass::
1954 sendemail.suppresscc::
1955 sendemail.suppressfrom::
1956 sendemail.to::
1957 sendemail.smtpdomain::
1958 sendemail.smtpserver::
1959 sendemail.smtpserverport::
1960 sendemail.smtpserveroption::
1961 sendemail.smtpuser::
1962 sendemail.thread::
1963 sendemail.validate::
1964         See linkgit:git-send-email[1] for description.
1966 sendemail.signedoffcc::
1967         Deprecated alias for 'sendemail.signedoffbycc'.
1969 showbranch.default::
1970         The default set of branches for linkgit:git-show-branch[1].
1971         See linkgit:git-show-branch[1].
1973 status.relativePaths::
1974         By default, linkgit:git-status[1] shows paths relative to the
1975         current directory. Setting this variable to `false` shows paths
1976         relative to the repository root (this was the default for git
1977         prior to v1.5.4).
1979 status.showUntrackedFiles::
1980         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1981         files which are not currently tracked by Git. Directories which
1982         contain only untracked files, are shown with the directory name
1983         only. Showing untracked files means that Git needs to lstat() all
1984         all the files in the whole repository, which might be slow on some
1985         systems. So, this variable controls how the commands displays
1986         the untracked files. Possible values are:
1989 * `no` - Show no untracked files.
1990 * `normal` - Show untracked files and directories.
1991 * `all` - Show also individual files in untracked directories.
1994 If this variable is not specified, it defaults to 'normal'.
1995 This variable can be overridden with the -u|--untracked-files option
1996 of linkgit:git-status[1] and linkgit:git-commit[1].
1998 status.submodulesummary::
1999         Defaults to false.
2000         If this is set to a non zero number or true (identical to -1 or an
2001         unlimited number), the submodule summary will be enabled and a
2002         summary of commits for modified submodules will be shown (see
2003         --summary-limit option of linkgit:git-submodule[1]).
2005 submodule.<name>.path::
2006 submodule.<name>.url::
2007 submodule.<name>.update::
2008         The path within this project, URL, and the updating strategy
2009         for a submodule.  These variables are initially populated
2010         by 'git submodule init'; edit them to override the
2011         URL and other values found in the `.gitmodules` file.  See
2012         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2014 submodule.<name>.fetchRecurseSubmodules::
2015         This option can be used to control recursive fetching of this
2016         submodule. It can be overridden by using the --[no-]recurse-submodules
2017         command line option to "git fetch" and "git pull".
2018         This setting will override that from in the linkgit:gitmodules[5]
2019         file.
2021 submodule.<name>.ignore::
2022         Defines under what circumstances "git status" and the diff family show
2023         a submodule as modified. When set to "all", it will never be considered
2024         modified, "dirty" will ignore all changes to the submodules work tree and
2025         takes only differences between the HEAD of the submodule and the commit
2026         recorded in the superproject into account. "untracked" will additionally
2027         let submodules with modified tracked files in their work tree show up.
2028         Using "none" (the default when this option is not set) also shows
2029         submodules that have untracked files in their work tree as changed.
2030         This setting overrides any setting made in .gitmodules for this submodule,
2031         both settings can be overridden on the command line by using the
2032         "--ignore-submodules" option.
2034 tar.umask::
2035         This variable can be used to restrict the permission bits of
2036         tar archive entries.  The default is 0002, which turns off the
2037         world write bit.  The special value "user" indicates that the
2038         archiving user's umask will be used instead.  See umask(2) and
2039         linkgit:git-archive[1].
2041 transfer.fsckObjects::
2042         When `fetch.fsckObjects` or `receive.fsckObjects` are
2043         not set, the value of this variable is used instead.
2044         Defaults to false.
2046 transfer.unpackLimit::
2047         When `fetch.unpackLimit` or `receive.unpackLimit` are
2048         not set, the value of this variable is used instead.
2049         The default value is 100.
2051 url.<base>.insteadOf::
2052         Any URL that starts with this value will be rewritten to
2053         start, instead, with <base>. In cases where some site serves a
2054         large number of repositories, and serves them with multiple
2055         access methods, and some users need to use different access
2056         methods, this feature allows people to specify any of the
2057         equivalent URLs and have git automatically rewrite the URL to
2058         the best alternative for the particular user, even for a
2059         never-before-seen repository on the site.  When more than one
2060         insteadOf strings match a given URL, the longest match is used.
2062 url.<base>.pushInsteadOf::
2063         Any URL that starts with this value will not be pushed to;
2064         instead, it will be rewritten to start with <base>, and the
2065         resulting URL will be pushed to. In cases where some site serves
2066         a large number of repositories, and serves them with multiple
2067         access methods, some of which do not allow push, this feature
2068         allows people to specify a pull-only URL and have git
2069         automatically use an appropriate URL to push, even for a
2070         never-before-seen repository on the site.  When more than one
2071         pushInsteadOf strings match a given URL, the longest match is
2072         used.  If a remote has an explicit pushurl, git will ignore this
2073         setting for that remote.
2075 user.email::
2076         Your email address to be recorded in any newly created commits.
2077         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2078         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2080 user.name::
2081         Your full name to be recorded in any newly created commits.
2082         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2083         environment variables.  See linkgit:git-commit-tree[1].
2085 user.signingkey::
2086         If linkgit:git-tag[1] is not selecting the key you want it to
2087         automatically when creating a signed tag, you can override the
2088         default selection with this variable.  This option is passed
2089         unchanged to gpg's --local-user parameter, so you may specify a key
2090         using any method that gpg supports.
2092 web.browser::
2093         Specify a web browser that may be used by some commands.
2094         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2095         may use it.