Win32 dirent: improve dirent implementation
[git/dscho.git] / Documentation / config.txt
blob48ce1c2843009b5494f72a9cb400512330479f4f
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.
738         When the value is `interactive`, the rebase is run in interactive mode.
740 *NOTE*: this is a possibly dangerous operation; do *not* use
741 it unless you understand the implications (see linkgit:git-rebase[1]
742 for details).
744 browser.<tool>.cmd::
745         Specify the command to invoke the specified browser. The
746         specified command is evaluated in shell with the URLs passed
747         as arguments. (See linkgit:git-web{litdd}browse[1].)
749 browser.<tool>.path::
750         Override the path for the given tool that may be used to
751         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
752         working repository in gitweb (see linkgit:git-instaweb[1]).
754 clean.requireForce::
755         A boolean to make git-clean do nothing unless given -f
756         or -n.   Defaults to true.
758 color.branch::
759         A boolean to enable/disable color in the output of
760         linkgit:git-branch[1]. May be set to `always`,
761         `false` (or `never`) or `auto` (or `true`), in which case colors are used
762         only when the output is to a terminal. Defaults to false.
764 color.branch.<slot>::
765         Use customized color for branch coloration. `<slot>` is one of
766         `current` (the current branch), `local` (a local branch),
767         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
768         refs).
770 The value for these configuration variables is a list of colors (at most
771 two) and attributes (at most one), separated by spaces.  The colors
772 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
773 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
774 `blink` and `reverse`.  The first color given is the foreground; the
775 second is the background.  The position of the attribute, if any,
776 doesn't matter.
778 color.diff::
779         Whether to use ANSI escape sequences to add color to patches.
780         If this is set to `always`, linkgit:git-diff[1],
781         linkgit:git-log[1], and linkgit:git-show[1] will use color
782         for all patches.  If it is set to `true` or `auto`, those
783         commands will only use color when output is to the terminal.
784         Defaults to false.
786 This does not affect linkgit:git-format-patch[1] nor the
787 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
788 command line with the `--color[=<when>]` option.
790 color.diff.<slot>::
791         Use customized color for diff colorization.  `<slot>` specifies
792         which part of the patch to use the specified color, and is one
793         of `plain` (context text), `meta` (metainformation), `frag`
794         (hunk header), 'func' (function in hunk header), `old` (removed lines),
795         `new` (added lines), `commit` (commit headers), or `whitespace`
796         (highlighting whitespace errors). The values of these variables may be
797         specified as in color.branch.<slot>.
799 color.decorate.<slot>::
800         Use customized color for 'git log --decorate' output.  `<slot>` is one
801         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
802         branches, remote-tracking branches, tags, stash and HEAD, respectively.
804 color.grep::
805         When set to `always`, always highlight matches.  When `false` (or
806         `never`), never.  When set to `true` or `auto`, use color only
807         when the output is written to the terminal.  Defaults to `false`.
809 color.grep.<slot>::
810         Use customized color for grep colorization.  `<slot>` specifies which
811         part of the line to use the specified color, and is one of
814 `context`;;
815         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
816 `filename`;;
817         filename prefix (when not using `-h`)
818 `function`;;
819         function name lines (when using `-p`)
820 `linenumber`;;
821         line number prefix (when using `-n`)
822 `match`;;
823         matching text
824 `selected`;;
825         non-matching text in selected lines
826 `separator`;;
827         separators between fields on a line (`:`, `-`, and `=`)
828         and between hunks (`--`)
831 The values of these variables may be specified as in color.branch.<slot>.
833 color.interactive::
834         When set to `always`, always use colors for interactive prompts
835         and displays (such as those used by "git-add --interactive").
836         When false (or `never`), never.  When set to `true` or `auto`, use
837         colors only when the output is to the terminal. Defaults to false.
839 color.interactive.<slot>::
840         Use customized color for 'git add --interactive'
841         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
842         four distinct types of normal output from interactive
843         commands.  The values of these variables may be specified as
844         in color.branch.<slot>.
846 color.pager::
847         A boolean to enable/disable colored output when the pager is in
848         use (default is true).
850 color.showbranch::
851         A boolean to enable/disable color in the output of
852         linkgit:git-show-branch[1]. May be set to `always`,
853         `false` (or `never`) or `auto` (or `true`), in which case colors are used
854         only when the output is to a terminal. Defaults to false.
856 color.status::
857         A boolean to enable/disable color in the output of
858         linkgit:git-status[1]. May be set to `always`,
859         `false` (or `never`) or `auto` (or `true`), in which case colors are used
860         only when the output is to a terminal. Defaults to false.
862 color.status.<slot>::
863         Use customized color for status colorization. `<slot>` is
864         one of `header` (the header text of the status message),
865         `added` or `updated` (files which are added but not committed),
866         `changed` (files which are changed but not added in the index),
867         `untracked` (files which are not tracked by git),
868         `branch` (the current branch), or
869         `nobranch` (the color the 'no branch' warning is shown in, defaulting
870         to red). The values of these variables may be specified as in
871         color.branch.<slot>.
873 color.ui::
874         This variable determines the default value for variables such
875         as `color.diff` and `color.grep` that control the use of color
876         per command family. Its scope will expand as more commands learn
877         configuration to set a default for the `--color` option.  Set it
878         to `always` if you want all output not intended for machine
879         consumption to use color, to `true` or `auto` if you want such
880         output to use color when written to the terminal, or to `false` or
881         `never` if you prefer git commands not to use color unless enabled
882         explicitly with some other configuration or the `--color` option.
884 column.ui::
885         Specify whether supported commands should output in columns.
886         This variable consists of a list of tokens separated by spaces
887         or commas:
890 `always`;;
891         always show in columns
892 `never`;;
893         never show in columns
894 `auto`;;
895         show in columns if the output is to the terminal
896 `column`;;
897         fill columns before rows (default)
898 `row`;;
899         fill rows before columns
900 `plain`;;
901         show in one column
902 `dense`;;
903         make unequal size columns to utilize more space
904 `nodense`;;
905         make equal size columns
908 This option defaults to 'never'.
910 column.branch::
911         Specify whether to output branch listing in `git branch` in columns.
912         See `column.ui` for details.
914 column.status::
915         Specify whether to output untracked files in `git status` in columns.
916         See `column.ui` for details.
918 column.tag::
919         Specify whether to output tag listing in `git tag` in columns.
920         See `column.ui` for details.
922 commit.status::
923         A boolean to enable/disable inclusion of status information in the
924         commit message template when using an editor to prepare the commit
925         message.  Defaults to true.
927 commit.template::
928         Specify a file to use as the template for new commit messages.
929         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
930         specified user's home directory.
932 credential.helper::
933         Specify an external helper to be called when a username or
934         password credential is needed; the helper may consult external
935         storage to avoid prompting the user for the credentials. See
936         linkgit:gitcredentials[7] for details.
938 credential.useHttpPath::
939         When acquiring credentials, consider the "path" component of an http
940         or https URL to be important. Defaults to false. See
941         linkgit:gitcredentials[7] for more information.
943 credential.username::
944         If no username is set for a network authentication, use this username
945         by default. See credential.<context>.* below, and
946         linkgit:gitcredentials[7].
948 credential.<url>.*::
949         Any of the credential.* options above can be applied selectively to
950         some credentials. For example "credential.https://example.com.username"
951         would set the default username only for https connections to
952         example.com. See linkgit:gitcredentials[7] for details on how URLs are
953         matched.
955 include::diff-config.txt[]
957 difftool.<tool>.path::
958         Override the path for the given tool.  This is useful in case
959         your tool is not in the PATH.
961 difftool.<tool>.cmd::
962         Specify the command to invoke the specified diff tool.
963         The specified command is evaluated in shell with the following
964         variables available:  'LOCAL' is set to the name of the temporary
965         file containing the contents of the diff pre-image and 'REMOTE'
966         is set to the name of the temporary file containing the contents
967         of the diff post-image.
969 difftool.prompt::
970         Prompt before each invocation of the diff tool.
972 diff.wordRegex::
973         A POSIX Extended Regular Expression used to determine what is a "word"
974         when performing word-by-word difference calculations.  Character
975         sequences that match the regular expression are "words", all other
976         characters are *ignorable* whitespace.
978 fetch.recurseSubmodules::
979         This option can be either set to a boolean value or to 'on-demand'.
980         Setting it to a boolean changes the behavior of fetch and pull to
981         unconditionally recurse into submodules when set to true or to not
982         recurse at all when set to false. When set to 'on-demand' (the default
983         value), fetch and pull will only recurse into a populated submodule
984         when its superproject retrieves a commit that updates the submodule's
985         reference.
987 fetch.fsckObjects::
988         If it is set to true, git-fetch-pack will check all fetched
989         objects. It will abort in the case of a malformed object or a
990         broken link. The result of an abort are only dangling objects.
991         Defaults to false. If not set, the value of `transfer.fsckObjects`
992         is used instead.
994 fetch.unpackLimit::
995         If the number of objects fetched over the git native
996         transfer is below this
997         limit, then the objects will be unpacked into loose object
998         files. However if the number of received objects equals or
999         exceeds this limit then the received pack will be stored as
1000         a pack, after adding any missing delta bases.  Storing the
1001         pack from a push can make the push operation complete faster,
1002         especially on slow filesystems.  If not set, the value of
1003         `transfer.unpackLimit` is used instead.
1005 format.attach::
1006         Enable multipart/mixed attachments as the default for
1007         'format-patch'.  The value can also be a double quoted string
1008         which will enable attachments as the default and set the
1009         value as the boundary.  See the --attach option in
1010         linkgit:git-format-patch[1].
1012 format.numbered::
1013         A boolean which can enable or disable sequence numbers in patch
1014         subjects.  It defaults to "auto" which enables it only if there
1015         is more than one patch.  It can be enabled or disabled for all
1016         messages by setting it to "true" or "false".  See --numbered
1017         option in linkgit:git-format-patch[1].
1019 format.headers::
1020         Additional email headers to include in a patch to be submitted
1021         by mail.  See linkgit:git-format-patch[1].
1023 format.to::
1024 format.cc::
1025         Additional recipients to include in a patch to be submitted
1026         by mail.  See the --to and --cc options in
1027         linkgit:git-format-patch[1].
1029 format.subjectprefix::
1030         The default for format-patch is to output files with the '[PATCH]'
1031         subject prefix. Use this variable to change that prefix.
1033 format.signature::
1034         The default for format-patch is to output a signature containing
1035         the git version number. Use this variable to change that default.
1036         Set this variable to the empty string ("") to suppress
1037         signature generation.
1039 format.suffix::
1040         The default for format-patch is to output files with the suffix
1041         `.patch`. Use this variable to change that suffix (make sure to
1042         include the dot if you want it).
1044 format.pretty::
1045         The default pretty format for log/show/whatchanged command,
1046         See linkgit:git-log[1], linkgit:git-show[1],
1047         linkgit:git-whatchanged[1].
1049 format.thread::
1050         The default threading style for 'git format-patch'.  Can be
1051         a boolean value, or `shallow` or `deep`.  `shallow` threading
1052         makes every mail a reply to the head of the series,
1053         where the head is chosen from the cover letter, the
1054         `--in-reply-to`, and the first patch mail, in this order.
1055         `deep` threading makes every mail a reply to the previous one.
1056         A true boolean value is the same as `shallow`, and a false
1057         value disables threading.
1059 format.signoff::
1060     A boolean value which lets you enable the `-s/--signoff` option of
1061     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1062     patch should be a conscious act and means that you certify you have
1063     the rights to submit this work under the same open source license.
1064     Please see the 'SubmittingPatches' document for further discussion.
1066 filter.<driver>.clean::
1067         The command which is used to convert the content of a worktree
1068         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1069         details.
1071 filter.<driver>.smudge::
1072         The command which is used to convert the content of a blob
1073         object to a worktree file upon checkout.  See
1074         linkgit:gitattributes[5] for details.
1076 gc.aggressiveWindow::
1077         The window size parameter used in the delta compression
1078         algorithm used by 'git gc --aggressive'.  This defaults
1079         to 250.
1081 gc.auto::
1082         When there are approximately more than this many loose
1083         objects in the repository, `git gc --auto` will pack them.
1084         Some Porcelain commands use this command to perform a
1085         light-weight garbage collection from time to time.  The
1086         default value is 6700.  Setting this to 0 disables it.
1088 gc.autopacklimit::
1089         When there are more than this many packs that are not
1090         marked with `*.keep` file in the repository, `git gc
1091         --auto` consolidates them into one larger pack.  The
1092         default value is 50.  Setting this to 0 disables it.
1094 gc.packrefs::
1095         Running `git pack-refs` in a repository renders it
1096         unclonable by Git versions prior to 1.5.1.2 over dumb
1097         transports such as HTTP.  This variable determines whether
1098         'git gc' runs `git pack-refs`. This can be set to `notbare`
1099         to enable it within all non-bare repos or it can be set to a
1100         boolean value.  The default is `true`.
1102 gc.pruneexpire::
1103         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1104         Override the grace period with this config variable.  The value
1105         "now" may be used to disable this  grace period and always prune
1106         unreachable objects immediately.
1108 gc.reflogexpire::
1109 gc.<pattern>.reflogexpire::
1110         'git reflog expire' removes reflog entries older than
1111         this time; defaults to 90 days.  With "<pattern>" (e.g.
1112         "refs/stash") in the middle the setting applies only to
1113         the refs that match the <pattern>.
1115 gc.reflogexpireunreachable::
1116 gc.<ref>.reflogexpireunreachable::
1117         'git reflog expire' removes reflog entries older than
1118         this time and are not reachable from the current tip;
1119         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1120         in the middle, the setting applies only to the refs that
1121         match the <pattern>.
1123 gc.rerereresolved::
1124         Records of conflicted merge you resolved earlier are
1125         kept for this many days when 'git rerere gc' is run.
1126         The default is 60 days.  See linkgit:git-rerere[1].
1128 gc.rerereunresolved::
1129         Records of conflicted merge you have not resolved are
1130         kept for this many days when 'git rerere gc' is run.
1131         The default is 15 days.  See linkgit:git-rerere[1].
1133 gitcvs.commitmsgannotation::
1134         Append this string to each commit message. Set to empty string
1135         to disable this feature. Defaults to "via git-CVS emulator".
1137 gitcvs.enabled::
1138         Whether the CVS server interface is enabled for this repository.
1139         See linkgit:git-cvsserver[1].
1141 gitcvs.logfile::
1142         Path to a log file where the CVS server interface well... logs
1143         various stuff. See linkgit:git-cvsserver[1].
1145 gitcvs.usecrlfattr::
1146         If true, the server will look up the end-of-line conversion
1147         attributes for files to determine the '-k' modes to use. If
1148         the attributes force git to treat a file as text,
1149         the '-k' mode will be left blank so CVS clients will
1150         treat it as text. If they suppress text conversion, the file
1151         will be set with '-kb' mode, which suppresses any newline munging
1152         the client might otherwise do. If the attributes do not allow
1153         the file type to be determined, then 'gitcvs.allbinary' is
1154         used. See linkgit:gitattributes[5].
1156 gitcvs.allbinary::
1157         This is used if 'gitcvs.usecrlfattr' does not resolve
1158         the correct '-kb' mode to use. If true, all
1159         unresolved files are sent to the client in
1160         mode '-kb'. This causes the client to treat them
1161         as binary files, which suppresses any newline munging it
1162         otherwise might do. Alternatively, if it is set to "guess",
1163         then the contents of the file are examined to decide if
1164         it is binary, similar to 'core.autocrlf'.
1166 gitcvs.dbname::
1167         Database used by git-cvsserver to cache revision information
1168         derived from the git repository. The exact meaning depends on the
1169         used database driver, for SQLite (which is the default driver) this
1170         is a filename. Supports variable substitution (see
1171         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1172         Default: '%Ggitcvs.%m.sqlite'
1174 gitcvs.dbdriver::
1175         Used Perl DBI driver. You can specify any available driver
1176         for this here, but it might not work. git-cvsserver is tested
1177         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1178         reported *not* to work with 'DBD::mysql'. Experimental feature.
1179         May not contain double colons (`:`). Default: 'SQLite'.
1180         See linkgit:git-cvsserver[1].
1182 gitcvs.dbuser, gitcvs.dbpass::
1183         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1184         since SQLite has no concept of database users and/or passwords.
1185         'gitcvs.dbuser' supports variable substitution (see
1186         linkgit:git-cvsserver[1] for details).
1188 gitcvs.dbTableNamePrefix::
1189         Database table name prefix.  Prepended to the names of any
1190         database tables used, allowing a single database to be used
1191         for several repositories.  Supports variable substitution (see
1192         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1193         characters will be replaced with underscores.
1195 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1196 'gitcvs.allbinary' can also be specified as
1197 'gitcvs.<access_method>.<varname>' (where 'access_method'
1198 is one of "ext" and "pserver") to make them apply only for the given
1199 access method.
1201 gitweb.category::
1202 gitweb.description::
1203 gitweb.owner::
1204 gitweb.url::
1205         See linkgit:gitweb[1] for description.
1207 gitweb.avatar::
1208 gitweb.blame::
1209 gitweb.grep::
1210 gitweb.highlight::
1211 gitweb.patches::
1212 gitweb.pickaxe::
1213 gitweb.remote_heads::
1214 gitweb.showsizes::
1215 gitweb.snapshot::
1216         See linkgit:gitweb.conf[5] for description.
1218 grep.lineNumber::
1219         If set to true, enable '-n' option by default.
1221 grep.patternType::
1222         Set the default matching behavior. Using a value of 'basic', 'extended',
1223         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1224         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1225         value 'default' will return to the default matching behavior.
1227 grep.extendedRegexp::
1228         If set to true, enable '--extended-regexp' option by default. This
1229         option is ignored when the 'grep.patternType' option is set to a value
1230         other than 'default'.
1232 gpg.program::
1233         Use this custom program instead of "gpg" found on $PATH when
1234         making or verifying a PGP signature. The program must support the
1235         same command line interface as GPG, namely, to verify a detached
1236         signature, "gpg --verify $file - <$signature" is run, and the
1237         program is expected to signal a good signature by exiting with
1238         code 0, and to generate an ascii-armored detached signature, the
1239         standard input of "gpg -bsau $key" is fed with the contents to be
1240         signed, and the program is expected to send the result to its
1241         standard output.
1243 gui.commitmsgwidth::
1244         Defines how wide the commit message window is in the
1245         linkgit:git-gui[1]. "75" is the default.
1247 gui.diffcontext::
1248         Specifies how many context lines should be used in calls to diff
1249         made by the linkgit:git-gui[1]. The default is "5".
1251 gui.encoding::
1252         Specifies the default encoding to use for displaying of
1253         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1254         It can be overridden by setting the 'encoding' attribute
1255         for relevant files (see linkgit:gitattributes[5]).
1256         If this option is not set, the tools default to the
1257         locale encoding.
1259 gui.matchtrackingbranch::
1260         Determines if new branches created with linkgit:git-gui[1] should
1261         default to tracking remote branches with matching names or
1262         not. Default: "false".
1264 gui.newbranchtemplate::
1265         Is used as suggested name when creating new branches using the
1266         linkgit:git-gui[1].
1268 gui.pruneduringfetch::
1269         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1270         performing a fetch. The default value is "false".
1272 gui.trustmtime::
1273         Determines if linkgit:git-gui[1] should trust the file modification
1274         timestamp or not. By default the timestamps are not trusted.
1276 gui.spellingdictionary::
1277         Specifies the dictionary used for spell checking commit messages in
1278         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1279         off.
1281 gui.fastcopyblame::
1282         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1283         location detection. It makes blame significantly faster on huge
1284         repositories at the expense of less thorough copy detection.
1286 gui.copyblamethreshold::
1287         Specifies the threshold to use in 'git gui blame' original location
1288         detection, measured in alphanumeric characters. See the
1289         linkgit:git-blame[1] manual for more information on copy detection.
1291 gui.blamehistoryctx::
1292         Specifies the radius of history context in days to show in
1293         linkgit:gitk[1] for the selected commit, when the `Show History
1294         Context` menu item is invoked from 'git gui blame'. If this
1295         variable is set to zero, the whole history is shown.
1297 guitool.<name>.cmd::
1298         Specifies the shell command line to execute when the corresponding item
1299         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1300         mandatory for every tool. The command is executed from the root of
1301         the working directory, and in the environment it receives the name of
1302         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1303         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1304         the head is detached, 'CUR_BRANCH' is empty).
1306 guitool.<name>.needsfile::
1307         Run the tool only if a diff is selected in the GUI. It guarantees
1308         that 'FILENAME' is not empty.
1310 guitool.<name>.noconsole::
1311         Run the command silently, without creating a window to display its
1312         output.
1314 guitool.<name>.norescan::
1315         Don't rescan the working directory for changes after the tool
1316         finishes execution.
1318 guitool.<name>.confirm::
1319         Show a confirmation dialog before actually running the tool.
1321 guitool.<name>.argprompt::
1322         Request a string argument from the user, and pass it to the tool
1323         through the 'ARGS' environment variable. Since requesting an
1324         argument implies confirmation, the 'confirm' option has no effect
1325         if this is enabled. If the option is set to 'true', 'yes', or '1',
1326         the dialog uses a built-in generic prompt; otherwise the exact
1327         value of the variable is used.
1329 guitool.<name>.revprompt::
1330         Request a single valid revision from the user, and set the
1331         'REVISION' environment variable. In other aspects this option
1332         is similar to 'argprompt', and can be used together with it.
1334 guitool.<name>.revunmerged::
1335         Show only unmerged branches in the 'revprompt' subdialog.
1336         This is useful for tools similar to merge or rebase, but not
1337         for things like checkout or reset.
1339 guitool.<name>.title::
1340         Specifies the title to use for the prompt dialog. The default
1341         is the tool name.
1343 guitool.<name>.prompt::
1344         Specifies the general prompt string to display at the top of
1345         the dialog, before subsections for 'argprompt' and 'revprompt'.
1346         The default value includes the actual command.
1348 help.browser::
1349         Specify the browser that will be used to display help in the
1350         'web' format. See linkgit:git-help[1].
1352 help.format::
1353         Override the default help format used by linkgit:git-help[1].
1354         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1355         the default. 'web' and 'html' are the same.
1357 help.autocorrect::
1358         Automatically correct and execute mistyped commands after
1359         waiting for the given number of deciseconds (0.1 sec). If more
1360         than one command can be deduced from the entered text, nothing
1361         will be executed.  If the value of this option is negative,
1362         the corrected command will be executed immediately. If the
1363         value is 0 - the command will be just shown but not executed.
1364         This is the default.
1366 http.proxy::
1367         Override the HTTP proxy, normally configured using the 'http_proxy',
1368         'https_proxy', and 'all_proxy' environment variables (see
1369         `curl(1)`).  This can be overridden on a per-remote basis; see
1370         remote.<name>.proxy
1372 http.cookiefile::
1373         File containing previously stored cookie lines which should be used
1374         in the git http session, if they match the server. The file format
1375         of the file to read cookies from should be plain HTTP headers or
1376         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1377         NOTE that the file specified with http.cookiefile is only used as
1378         input. No cookies will be stored in the file.
1380 http.sslVerify::
1381         Whether to verify the SSL certificate when fetching or pushing
1382         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1383         variable.
1385 http.sslCert::
1386         File containing the SSL certificate when fetching or pushing
1387         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1388         variable.
1390 http.sslKey::
1391         File containing the SSL private key when fetching or pushing
1392         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1393         variable.
1395 http.sslCertPasswordProtected::
1396         Enable git's password prompt for the SSL certificate.  Otherwise
1397         OpenSSL will prompt the user, possibly many times, if the
1398         certificate or private key is encrypted.  Can be overridden by the
1399         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1401 http.sslCAInfo::
1402         File containing the certificates to verify the peer with when
1403         fetching or pushing over HTTPS. Can be overridden by the
1404         'GIT_SSL_CAINFO' environment variable.
1406 http.sslCAPath::
1407         Path containing files with the CA certificates to verify the peer
1408         with when fetching or pushing over HTTPS. Can be overridden
1409         by the 'GIT_SSL_CAPATH' environment variable.
1411 http.maxRequests::
1412         How many HTTP requests to launch in parallel. Can be overridden
1413         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1415 http.minSessions::
1416         The number of curl sessions (counted across slots) to be kept across
1417         requests. They will not be ended with curl_easy_cleanup() until
1418         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1419         value will be capped at 1. Defaults to 1.
1421 http.postBuffer::
1422         Maximum size in bytes of the buffer used by smart HTTP
1423         transports when POSTing data to the remote system.
1424         For requests larger than this buffer size, HTTP/1.1 and
1425         Transfer-Encoding: chunked is used to avoid creating a
1426         massive pack file locally.  Default is 1 MiB, which is
1427         sufficient for most requests.
1429 http.lowSpeedLimit, http.lowSpeedTime::
1430         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1431         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1432         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1433         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1435 http.noEPSV::
1436         A boolean which disables using of EPSV ftp command by curl.
1437         This can helpful with some "poor" ftp servers which don't
1438         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1439         environment variable. Default is false (curl will use EPSV).
1441 http.useragent::
1442         The HTTP USER_AGENT string presented to an HTTP server.  The default
1443         value represents the version of the client git such as git/1.7.1.
1444         This option allows you to override this value to a more common value
1445         such as Mozilla/4.0.  This may be necessary, for instance, if
1446         connecting through a firewall that restricts HTTP connections to a set
1447         of common USER_AGENT strings (but not including those like git/1.7.1).
1448         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1450 i18n.commitEncoding::
1451         Character encoding the commit messages are stored in; git itself
1452         does not care per se, but this information is necessary e.g. when
1453         importing commits from emails or in the gitk graphical history
1454         browser (and possibly at other places in the future or in other
1455         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1457 i18n.logOutputEncoding::
1458         Character encoding the commit messages are converted to when
1459         running 'git log' and friends.
1461 imap::
1462         The configuration variables in the 'imap' section are described
1463         in linkgit:git-imap-send[1].
1465 init.templatedir::
1466         Specify the directory from which templates will be copied.
1467         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1469 instaweb.browser::
1470         Specify the program that will be used to browse your working
1471         repository in gitweb. See linkgit:git-instaweb[1].
1473 instaweb.httpd::
1474         The HTTP daemon command-line to start gitweb on your working
1475         repository. See linkgit:git-instaweb[1].
1477 instaweb.local::
1478         If true the web server started by linkgit:git-instaweb[1] will
1479         be bound to the local IP (127.0.0.1).
1481 instaweb.modulepath::
1482         The default module path for linkgit:git-instaweb[1] to use
1483         instead of /usr/lib/apache2/modules.  Only used if httpd
1484         is Apache.
1486 instaweb.port::
1487         The port number to bind the gitweb httpd to. See
1488         linkgit:git-instaweb[1].
1490 interactive.singlekey::
1491         In interactive commands, allow the user to provide one-letter
1492         input with a single key (i.e., without hitting enter).
1493         Currently this is used by the `--patch` mode of
1494         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1495         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1496         setting is silently ignored if portable keystroke input
1497         is not available.
1499 log.abbrevCommit::
1500         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1501         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1502         override this option with `--no-abbrev-commit`.
1504 log.date::
1505         Set the default date-time mode for the 'log' command.
1506         Setting a value for log.date is similar to using 'git log''s
1507         `--date` option.  Possible values are `relative`, `local`,
1508         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1509         for details.
1511 log.decorate::
1512         Print out the ref names of any commits that are shown by the log
1513         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1514         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1515         specified, the full ref name (including prefix) will be printed.
1516         This is the same as the log commands '--decorate' option.
1518 log.showroot::
1519         If true, the initial commit will be shown as a big creation event.
1520         This is equivalent to a diff against an empty tree.
1521         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1522         normally hide the root commit will now show it. True by default.
1524 mailmap.file::
1525         The location of an augmenting mailmap file. The default
1526         mailmap, located in the root of the repository, is loaded
1527         first, then the mailmap file pointed to by this variable.
1528         The location of the mailmap file may be in a repository
1529         subdirectory, or somewhere outside of the repository itself.
1530         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1532 man.viewer::
1533         Specify the programs that may be used to display help in the
1534         'man' format. See linkgit:git-help[1].
1536 man.<tool>.cmd::
1537         Specify the command to invoke the specified man viewer. The
1538         specified command is evaluated in shell with the man page
1539         passed as argument. (See linkgit:git-help[1].)
1541 man.<tool>.path::
1542         Override the path for the given tool that may be used to
1543         display help in the 'man' format. See linkgit:git-help[1].
1545 include::merge-config.txt[]
1547 mergetool.<tool>.path::
1548         Override the path for the given tool.  This is useful in case
1549         your tool is not in the PATH.
1551 mergetool.<tool>.cmd::
1552         Specify the command to invoke the specified merge tool.  The
1553         specified command is evaluated in shell with the following
1554         variables available: 'BASE' is the name of a temporary file
1555         containing the common base of the files to be merged, if available;
1556         'LOCAL' is the name of a temporary file containing the contents of
1557         the file on the current branch; 'REMOTE' is the name of a temporary
1558         file containing the contents of the file from the branch being
1559         merged; 'MERGED' contains the name of the file to which the merge
1560         tool should write the results of a successful merge.
1562 mergetool.<tool>.trustExitCode::
1563         For a custom merge command, specify whether the exit code of
1564         the merge command can be used to determine whether the merge was
1565         successful.  If this is not set to true then the merge target file
1566         timestamp is checked and the merge assumed to have been successful
1567         if the file has been updated, otherwise the user is prompted to
1568         indicate the success of the merge.
1570 mergetool.keepBackup::
1571         After performing a merge, the original file with conflict markers
1572         can be saved as a file with a `.orig` extension.  If this variable
1573         is set to `false` then this file is not preserved.  Defaults to
1574         `true` (i.e. keep the backup files).
1576 mergetool.keepTemporaries::
1577         When invoking a custom merge tool, git uses a set of temporary
1578         files to pass to the tool. If the tool returns an error and this
1579         variable is set to `true`, then these temporary files will be
1580         preserved, otherwise they will be removed after the tool has
1581         exited. Defaults to `false`.
1583 mergetool.prompt::
1584         Prompt before each invocation of the merge resolution program.
1586 notes.displayRef::
1587         The (fully qualified) refname from which to show notes when
1588         showing commit messages.  The value of this variable can be set
1589         to a glob, in which case notes from all matching refs will be
1590         shown.  You may also specify this configuration variable
1591         several times.  A warning will be issued for refs that do not
1592         exist, but a glob that does not match any refs is silently
1593         ignored.
1595 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1596 environment variable, which must be a colon separated list of refs or
1597 globs.
1599 The effective value of "core.notesRef" (possibly overridden by
1600 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1601 displayed.
1603 notes.rewrite.<command>::
1604         When rewriting commits with <command> (currently `amend` or
1605         `rebase`) and this variable is set to `true`, git
1606         automatically copies your notes from the original to the
1607         rewritten commit.  Defaults to `true`, but see
1608         "notes.rewriteRef" below.
1610 notes.rewriteMode::
1611         When copying notes during a rewrite (see the
1612         "notes.rewrite.<command>" option), determines what to do if
1613         the target commit already has a note.  Must be one of
1614         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1615         `concatenate`.
1617 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1618 environment variable.
1620 notes.rewriteRef::
1621         When copying notes during a rewrite, specifies the (fully
1622         qualified) ref whose notes should be copied.  The ref may be a
1623         glob, in which case notes in all matching refs will be copied.
1624         You may also specify this configuration several times.
1626 Does not have a default value; you must configure this variable to
1627 enable note rewriting.  Set it to `refs/notes/commits` to enable
1628 rewriting for the default commit notes.
1630 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1631 environment variable, which must be a colon separated list of refs or
1632 globs.
1634 pack.window::
1635         The size of the window used by linkgit:git-pack-objects[1] when no
1636         window size is given on the command line. Defaults to 10.
1638 pack.depth::
1639         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1640         maximum depth is given on the command line. Defaults to 50.
1642 pack.windowMemory::
1643         The window memory size limit used by linkgit:git-pack-objects[1]
1644         when no limit is given on the command line.  The value can be
1645         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1646         limit.
1648 pack.compression::
1649         An integer -1..9, indicating the compression level for objects
1650         in a pack file. -1 is the zlib default. 0 means no
1651         compression, and 1..9 are various speed/size tradeoffs, 9 being
1652         slowest.  If not set,  defaults to core.compression.  If that is
1653         not set,  defaults to -1, the zlib default, which is "a default
1654         compromise between speed and compression (currently equivalent
1655         to level 6)."
1657 Note that changing the compression level will not automatically recompress
1658 all existing objects. You can force recompression by passing the -F option
1659 to linkgit:git-repack[1].
1661 pack.deltaCacheSize::
1662         The maximum memory in bytes used for caching deltas in
1663         linkgit:git-pack-objects[1] before writing them out to a pack.
1664         This cache is used to speed up the writing object phase by not
1665         having to recompute the final delta result once the best match
1666         for all objects is found.  Repacking large repositories on machines
1667         which are tight with memory might be badly impacted by this though,
1668         especially if this cache pushes the system into swapping.
1669         A value of 0 means no limit. The smallest size of 1 byte may be
1670         used to virtually disable this cache. Defaults to 256 MiB.
1672 pack.deltaCacheLimit::
1673         The maximum size of a delta, that is cached in
1674         linkgit:git-pack-objects[1]. This cache is used to speed up the
1675         writing object phase by not having to recompute the final delta
1676         result once the best match for all objects is found. Defaults to 1000.
1678 pack.threads::
1679         Specifies the number of threads to spawn when searching for best
1680         delta matches.  This requires that linkgit:git-pack-objects[1]
1681         be compiled with pthreads otherwise this option is ignored with a
1682         warning. This is meant to reduce packing time on multiprocessor
1683         machines. The required amount of memory for the delta search window
1684         is however multiplied by the number of threads.
1685         Specifying 0 will cause git to auto-detect the number of CPU's
1686         and set the number of threads accordingly.
1688 pack.indexVersion::
1689         Specify the default pack index version.  Valid values are 1 for
1690         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1691         the new pack index with capabilities for packs larger than 4 GB
1692         as well as proper protection against the repacking of corrupted
1693         packs.  Version 2 is the default.  Note that version 2 is enforced
1694         and this config option ignored whenever the corresponding pack is
1695         larger than 2 GB.
1697 If you have an old git that does not understand the version 2 `*.idx` file,
1698 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1699 that will copy both `*.pack` file and corresponding `*.idx` file from the
1700 other side may give you a repository that cannot be accessed with your
1701 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1702 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1703 the `*.idx` file.
1705 pack.packSizeLimit::
1706         The maximum size of a pack.  This setting only affects
1707         packing to a file when repacking, i.e. the git:// protocol
1708         is unaffected.  It can be overridden by the `--max-pack-size`
1709         option of linkgit:git-repack[1]. The minimum size allowed is
1710         limited to 1 MiB. The default is unlimited.
1711         Common unit suffixes of 'k', 'm', or 'g' are
1712         supported.
1714 pager.<cmd>::
1715         If the value is boolean, turns on or off pagination of the
1716         output of a particular git subcommand when writing to a tty.
1717         Otherwise, turns on pagination for the subcommand using the
1718         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1719         or `--no-pager` is specified on the command line, it takes
1720         precedence over this option.  To disable pagination for all
1721         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1723 pretty.<name>::
1724         Alias for a --pretty= format string, as specified in
1725         linkgit:git-log[1]. Any aliases defined here can be used just
1726         as the built-in pretty formats could. For example,
1727         running `git config pretty.changelog "format:* %H %s"`
1728         would cause the invocation `git log --pretty=changelog`
1729         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1730         Note that an alias with the same name as a built-in format
1731         will be silently ignored.
1733 pull.rebase::
1734         When true, rebase branches on top of the fetched branch, instead
1735         of merging the default branch from the default remote when "git
1736         pull" is run. See "branch.<name>.rebase" for setting this on a
1737         per-branch basis.
1739 *NOTE*: this is a possibly dangerous operation; do *not* use
1740 it unless you understand the implications (see linkgit:git-rebase[1]
1741 for details).
1743 pull.octopus::
1744         The default merge strategy to use when pulling multiple branches
1745         at once.
1747 pull.twohead::
1748         The default merge strategy to use when pulling a single branch.
1750 push.default::
1751         Defines the action git push should take if no refspec is given
1752         on the command line, no refspec is configured in the remote, and
1753         no refspec is implied by any of the options given on the command
1754         line. Possible values are:
1757 * `nothing` - do not push anything.
1758 * `matching` - push all branches having the same name in both ends.
1759   This is for those who prepare all the branches into a publishable
1760   shape and then push them out with a single command.  It is not
1761   appropriate for pushing into a repository shared by multiple users,
1762   since locally stalled branches will attempt a non-fast forward push
1763   if other users updated the branch.
1764   +
1765   This is currently the default, but Git 2.0 will change the default
1766   to `simple`.
1767 * `upstream` - push the current branch to its upstream branch.
1768   With this, `git push` will update the same remote ref as the one which
1769   is merged by `git pull`, making `push` and `pull` symmetrical.
1770   See "branch.<name>.merge" for how to configure the upstream branch.
1771 * `simple` - like `upstream`, but refuses to push if the upstream
1772   branch's name is different from the local one. This is the safest
1773   option and is well-suited for beginners. It will become the default
1774   in Git 2.0.
1775 * `current` - push the current branch to a branch of the same name.
1778 The `simple`, `current` and `upstream` modes are for those who want to
1779 push out a single branch after finishing work, even when the other
1780 branches are not yet ready to be pushed out. If you are working with
1781 other people to push into the same shared repository, you would want
1782 to use one of these.
1784 rebase.stat::
1785         Whether to show a diffstat of what changed upstream since the last
1786         rebase. False by default.
1788 rebase.autosquash::
1789         If set to true enable '--autosquash' option by default.
1791 receive.autogc::
1792         By default, git-receive-pack will run "git-gc --auto" after
1793         receiving data from git-push and updating refs.  You can stop
1794         it by setting this variable to false.
1796 receive.fsckObjects::
1797         If it is set to true, git-receive-pack will check all received
1798         objects. It will abort in the case of a malformed object or a
1799         broken link. The result of an abort are only dangling objects.
1800         Defaults to false. If not set, the value of `transfer.fsckObjects`
1801         is used instead.
1803 receive.unpackLimit::
1804         If the number of objects received in a push is below this
1805         limit then the objects will be unpacked into loose object
1806         files. However if the number of received objects equals or
1807         exceeds this limit then the received pack will be stored as
1808         a pack, after adding any missing delta bases.  Storing the
1809         pack from a push can make the push operation complete faster,
1810         especially on slow filesystems.  If not set, the value of
1811         `transfer.unpackLimit` is used instead.
1813 receive.denyDeletes::
1814         If set to true, git-receive-pack will deny a ref update that deletes
1815         the ref. Use this to prevent such a ref deletion via a push.
1817 receive.denyDeleteCurrent::
1818         If set to true, git-receive-pack will deny a ref update that
1819         deletes the currently checked out branch of a non-bare repository.
1821 receive.denyCurrentBranch::
1822         If set to true or "refuse", git-receive-pack will deny a ref update
1823         to the currently checked out branch of a non-bare repository.
1824         Such a push is potentially dangerous because it brings the HEAD
1825         out of sync with the index and working tree. If set to "warn",
1826         print a warning of such a push to stderr, but allow the push to
1827         proceed. If set to false or "ignore", allow such pushes with no
1828         message. Defaults to "refuse".
1830 There are two more options that are meant for Git experts: "updateInstead"
1831 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1832 the HEAD so it does not need to change.  Both options come with their own
1833 set of possible *complications*, but can be appropriate in rare workflows.
1835 receive.denyNonFastForwards::
1836         If set to true, git-receive-pack will deny a ref update which is
1837         not a fast-forward. Use this to prevent such an update via a push,
1838         even if that push is forced. This configuration variable is
1839         set when initializing a shared repository.
1841 receive.updateserverinfo::
1842         If set to true, git-receive-pack will run git-update-server-info
1843         after receiving data from git-push and updating refs.
1845 remote.<name>.url::
1846         The URL of a remote repository.  See linkgit:git-fetch[1] or
1847         linkgit:git-push[1].
1849 remote.<name>.pushurl::
1850         The push URL of a remote repository.  See linkgit:git-push[1].
1852 remote.<name>.proxy::
1853         For remotes that require curl (http, https and ftp), the URL to
1854         the proxy to use for that remote.  Set to the empty string to
1855         disable proxying for that remote.
1857 remote.<name>.fetch::
1858         The default set of "refspec" for linkgit:git-fetch[1]. See
1859         linkgit:git-fetch[1].
1861 remote.<name>.push::
1862         The default set of "refspec" for linkgit:git-push[1]. See
1863         linkgit:git-push[1].
1865 remote.<name>.mirror::
1866         If true, pushing to this remote will automatically behave
1867         as if the `--mirror` option was given on the command line.
1869 remote.<name>.skipDefaultUpdate::
1870         If true, this remote will be skipped by default when updating
1871         using linkgit:git-fetch[1] or the `update` subcommand of
1872         linkgit:git-remote[1].
1874 remote.<name>.skipFetchAll::
1875         If true, this remote will be skipped by default when updating
1876         using linkgit:git-fetch[1] or the `update` subcommand of
1877         linkgit:git-remote[1].
1879 remote.<name>.receivepack::
1880         The default program to execute on the remote side when pushing.  See
1881         option \--receive-pack of linkgit:git-push[1].
1883 remote.<name>.uploadpack::
1884         The default program to execute on the remote side when fetching.  See
1885         option \--upload-pack of linkgit:git-fetch-pack[1].
1887 remote.<name>.tagopt::
1888         Setting this value to \--no-tags disables automatic tag following when
1889         fetching from remote <name>. Setting it to \--tags will fetch every
1890         tag from remote <name>, even if they are not reachable from remote
1891         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1892         override this setting. See options \--tags and \--no-tags of
1893         linkgit:git-fetch[1].
1895 remote.<name>.vcs::
1896         Setting this to a value <vcs> will cause git to interact with
1897         the remote with the git-remote-<vcs> helper.
1899 remotes.<group>::
1900         The list of remotes which are fetched by "git remote update
1901         <group>".  See linkgit:git-remote[1].
1903 repack.usedeltabaseoffset::
1904         By default, linkgit:git-repack[1] creates packs that use
1905         delta-base offset. If you need to share your repository with
1906         git older than version 1.4.4, either directly or via a dumb
1907         protocol such as http, then you need to set this option to
1908         "false" and repack. Access from old git versions over the
1909         native protocol are unaffected by this option.
1911 rerere.autoupdate::
1912         When set to true, `git-rerere` updates the index with the
1913         resulting contents after it cleanly resolves conflicts using
1914         previously recorded resolution.  Defaults to false.
1916 rerere.enabled::
1917         Activate recording of resolved conflicts, so that identical
1918         conflict hunks can be resolved automatically, should they be
1919         encountered again.  By default, linkgit:git-rerere[1] is
1920         enabled if there is an `rr-cache` directory under the
1921         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1922         repository.
1924 sendemail.identity::
1925         A configuration identity. When given, causes values in the
1926         'sendemail.<identity>' subsection to take precedence over
1927         values in the 'sendemail' section. The default identity is
1928         the value of 'sendemail.identity'.
1930 sendemail.smtpencryption::
1931         See linkgit:git-send-email[1] for description.  Note that this
1932         setting is not subject to the 'identity' mechanism.
1934 sendemail.smtpssl::
1935         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1937 sendemail.<identity>.*::
1938         Identity-specific versions of the 'sendemail.*' parameters
1939         found below, taking precedence over those when the this
1940         identity is selected, through command-line or
1941         'sendemail.identity'.
1943 sendemail.aliasesfile::
1944 sendemail.aliasfiletype::
1945 sendemail.bcc::
1946 sendemail.cc::
1947 sendemail.cccmd::
1948 sendemail.chainreplyto::
1949 sendemail.confirm::
1950 sendemail.envelopesender::
1951 sendemail.from::
1952 sendemail.multiedit::
1953 sendemail.signedoffbycc::
1954 sendemail.smtppass::
1955 sendemail.suppresscc::
1956 sendemail.suppressfrom::
1957 sendemail.to::
1958 sendemail.smtpdomain::
1959 sendemail.smtpserver::
1960 sendemail.smtpserverport::
1961 sendemail.smtpserveroption::
1962 sendemail.smtpuser::
1963 sendemail.thread::
1964 sendemail.validate::
1965         See linkgit:git-send-email[1] for description.
1967 sendemail.signedoffcc::
1968         Deprecated alias for 'sendemail.signedoffbycc'.
1970 showbranch.default::
1971         The default set of branches for linkgit:git-show-branch[1].
1972         See linkgit:git-show-branch[1].
1974 status.relativePaths::
1975         By default, linkgit:git-status[1] shows paths relative to the
1976         current directory. Setting this variable to `false` shows paths
1977         relative to the repository root (this was the default for git
1978         prior to v1.5.4).
1980 status.showUntrackedFiles::
1981         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1982         files which are not currently tracked by Git. Directories which
1983         contain only untracked files, are shown with the directory name
1984         only. Showing untracked files means that Git needs to lstat() all
1985         all the files in the whole repository, which might be slow on some
1986         systems. So, this variable controls how the commands displays
1987         the untracked files. Possible values are:
1990 * `no` - Show no untracked files.
1991 * `normal` - Show untracked files and directories.
1992 * `all` - Show also individual files in untracked directories.
1995 If this variable is not specified, it defaults to 'normal'.
1996 This variable can be overridden with the -u|--untracked-files option
1997 of linkgit:git-status[1] and linkgit:git-commit[1].
1999 status.submodulesummary::
2000         Defaults to false.
2001         If this is set to a non zero number or true (identical to -1 or an
2002         unlimited number), the submodule summary will be enabled and a
2003         summary of commits for modified submodules will be shown (see
2004         --summary-limit option of linkgit:git-submodule[1]).
2006 submodule.<name>.path::
2007 submodule.<name>.url::
2008 submodule.<name>.update::
2009         The path within this project, URL, and the updating strategy
2010         for a submodule.  These variables are initially populated
2011         by 'git submodule init'; edit them to override the
2012         URL and other values found in the `.gitmodules` file.  See
2013         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2015 submodule.<name>.fetchRecurseSubmodules::
2016         This option can be used to control recursive fetching of this
2017         submodule. It can be overridden by using the --[no-]recurse-submodules
2018         command line option to "git fetch" and "git pull".
2019         This setting will override that from in the linkgit:gitmodules[5]
2020         file.
2022 submodule.<name>.ignore::
2023         Defines under what circumstances "git status" and the diff family show
2024         a submodule as modified. When set to "all", it will never be considered
2025         modified, "dirty" will ignore all changes to the submodules work tree and
2026         takes only differences between the HEAD of the submodule and the commit
2027         recorded in the superproject into account. "untracked" will additionally
2028         let submodules with modified tracked files in their work tree show up.
2029         Using "none" (the default when this option is not set) also shows
2030         submodules that have untracked files in their work tree as changed.
2031         This setting overrides any setting made in .gitmodules for this submodule,
2032         both settings can be overridden on the command line by using the
2033         "--ignore-submodules" option.
2035 tar.umask::
2036         This variable can be used to restrict the permission bits of
2037         tar archive entries.  The default is 0002, which turns off the
2038         world write bit.  The special value "user" indicates that the
2039         archiving user's umask will be used instead.  See umask(2) and
2040         linkgit:git-archive[1].
2042 transfer.fsckObjects::
2043         When `fetch.fsckObjects` or `receive.fsckObjects` are
2044         not set, the value of this variable is used instead.
2045         Defaults to false.
2047 transfer.unpackLimit::
2048         When `fetch.unpackLimit` or `receive.unpackLimit` are
2049         not set, the value of this variable is used instead.
2050         The default value is 100.
2052 url.<base>.insteadOf::
2053         Any URL that starts with this value will be rewritten to
2054         start, instead, with <base>. In cases where some site serves a
2055         large number of repositories, and serves them with multiple
2056         access methods, and some users need to use different access
2057         methods, this feature allows people to specify any of the
2058         equivalent URLs and have git automatically rewrite the URL to
2059         the best alternative for the particular user, even for a
2060         never-before-seen repository on the site.  When more than one
2061         insteadOf strings match a given URL, the longest match is used.
2063 url.<base>.pushInsteadOf::
2064         Any URL that starts with this value will not be pushed to;
2065         instead, it will be rewritten to start with <base>, and the
2066         resulting URL will be pushed to. In cases where some site serves
2067         a large number of repositories, and serves them with multiple
2068         access methods, some of which do not allow push, this feature
2069         allows people to specify a pull-only URL and have git
2070         automatically use an appropriate URL to push, even for a
2071         never-before-seen repository on the site.  When more than one
2072         pushInsteadOf strings match a given URL, the longest match is
2073         used.  If a remote has an explicit pushurl, git will ignore this
2074         setting for that remote.
2076 user.email::
2077         Your email address to be recorded in any newly created commits.
2078         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2079         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2081 user.name::
2082         Your full name to be recorded in any newly created commits.
2083         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2084         environment variables.  See linkgit:git-commit-tree[1].
2086 user.signingkey::
2087         If linkgit:git-tag[1] is not selecting the key you want it to
2088         automatically when creating a signed tag, you can override the
2089         default selection with this variable.  This option is passed
2090         unchanged to gpg's --local-user parameter, so you may specify a key
2091         using any method that gpg supports.
2093 web.browser::
2094         Specify a web browser that may be used by some commands.
2095         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2096         may use it.