mingw: introduce the 'core.hideDotFiles' setting
[git/git-svn.git] / Documentation / config.txt
blobaad958d4ea2bdcda9846e8380af6829313f593b2
1 CONFIGURATION FILE
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' 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; we say then that the variable is
18 multivalued.
20 Syntax
21 ~~~~~~
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored.  The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables.  A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins.  Section names are case-insensitive.  Only alphanumeric
30 characters, `-` and `.` are allowed in section names.  Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections.  To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
38 --------
39         [section "subsection"]
41 --------
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively).  Section headers cannot span multiple
46 lines.  Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
48 don't need to.
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped.  Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes.  Internal whitespaces within the value are retained
68 verbatim.
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS).  Other char escape sequences (including octal
76 escape sequences) are invalid.
79 Includes
80 ~~~~~~~~
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 included file is expanded immediately, as if its contents had been
85 found at the location of the include directive. If the value of the
86 `include.path` variable is a relative path, the path is considered to be
87 relative to the configuration file in which the include directive was
88 found. The value of `include.path` is subject to tilde expansion: `~/`
89 is expanded to the value of `$HOME`, and `~user/` to the specified
90 user's home directory. See below for examples.
92 Example
93 ~~~~~~~
95         # Core variables
96         [core]
97                 ; Don't trust file modes
98                 filemode = false
100         # Our diff algorithm
101         [diff]
102                 external = /usr/local/bin/diff-wrapper
103                 renames = true
105         [branch "devel"]
106                 remote = origin
107                 merge = refs/heads/devel
109         # Proxy settings
110         [core]
111                 gitProxy="ssh" for "kernel.org"
112                 gitProxy=default-proxy ; for the rest
114         [include]
115                 path = /path/to/foo.inc ; include by absolute path
116                 path = foo ; expand "foo" relative to the current file
117                 path = ~/foo ; expand "foo" in your $HOME directory
120 Values
121 ~~~~~~
123 Values of many variables are treated as a simple string, but there
124 are variables that take values of specific types and there are rules
125 as to how to spell them.
127 boolean::
129        When a variable is said to take a boolean value, many
130        synonyms are accepted for 'true' and 'false'; these are all
131        case-insensitive.
133        true;; Boolean true can be spelled as `yes`, `on`, `true`,
134                 or `1`.  Also, a variable defined without `= <value>`
135                 is taken as true.
137        false;; Boolean false can be spelled as `no`, `off`,
138                 `false`, or `0`.
140 When converting value to the canonical form using '--bool' type
141 specifier; 'git config' will ensure that the output is "true" or
142 "false" (spelled in lowercase).
144 integer::
145        The value for many variables that specify various sizes can
146        be suffixed with `k`, `M`,... to mean "scale the number by
147        1024", "by 1024x1024", etc.
149 color::
150        The value for a variables that takes a color is a list of
151        colors (at most two) and attributes (at most one), separated
152        by spaces.  The colors accepted are `normal`, `black`,
153        `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154        `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155        `reverse`.  The first color given is the foreground; the
156        second is the background.  The position of the attribute, if
157        any, doesn't matter. Attributes may be turned off specifically
158        by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
160 Colors (foreground and background) may also be given as numbers between
161 0 and 255; these use ANSI 256-color mode (but note that not all
162 terminals may support this).  If your terminal supports it, you may also
163 specify 24-bit RGB values as hex, like `#ff0ab3`.
165 The attributes are meant to be reset at the beginning of each item
166 in the colored output, so setting color.decorate.branch to `black`
167 will paint that branch name in a plain `black`, even if the previous
168 thing on the same output line (e.g. opening parenthesis before the
169 list of branch names in `log --decorate` output) is set to be
170 painted with `bold` or some other attribute.
173 Variables
174 ~~~~~~~~~
176 Note that this list is non-comprehensive and not necessarily complete.
177 For command-specific variables, you will find a more detailed description
178 in the appropriate manual page.
180 Other git-related tools may and do use their own variables.  When
181 inventing new variables for use in your own tool, make sure their
182 names do not conflict with those that are used by Git itself and
183 other popular tools, and describe them in your documentation.
186 advice.*::
187         These variables control various optional help messages designed to
188         aid new users. All 'advice.*' variables default to 'true', and you
189         can tell Git that you do not need help by setting these to 'false':
192         pushUpdateRejected::
193                 Set this variable to 'false' if you want to disable
194                 'pushNonFFCurrent',
195                 'pushNonFFMatching', 'pushAlreadyExists',
196                 'pushFetchFirst', and 'pushNeedsForce'
197                 simultaneously.
198         pushNonFFCurrent::
199                 Advice shown when linkgit:git-push[1] fails due to a
200                 non-fast-forward update to the current branch.
201         pushNonFFMatching::
202                 Advice shown when you ran linkgit:git-push[1] and pushed
203                 'matching refs' explicitly (i.e. you used ':', or
204                 specified a refspec that isn't your current branch) and
205                 it resulted in a non-fast-forward error.
206         pushAlreadyExists::
207                 Shown when linkgit:git-push[1] rejects an update that
208                 does not qualify for fast-forwarding (e.g., a tag.)
209         pushFetchFirst::
210                 Shown when linkgit:git-push[1] rejects an update that
211                 tries to overwrite a remote ref that points at an
212                 object we do not have.
213         pushNeedsForce::
214                 Shown when linkgit:git-push[1] rejects an update that
215                 tries to overwrite a remote ref that points at an
216                 object that is not a commit-ish, or make the remote
217                 ref point at an object that is not a commit-ish.
218         statusHints::
219                 Show directions on how to proceed from the current
220                 state in the output of linkgit:git-status[1], in
221                 the template shown when writing commit messages in
222                 linkgit:git-commit[1], and in the help message shown
223                 by linkgit:git-checkout[1] when switching branch.
224         statusUoption::
225                 Advise to consider using the `-u` option to linkgit:git-status[1]
226                 when the command takes more than 2 seconds to enumerate untracked
227                 files.
228         commitBeforeMerge::
229                 Advice shown when linkgit:git-merge[1] refuses to
230                 merge to avoid overwriting local changes.
231         resolveConflict::
232                 Advice shown by various commands when conflicts
233                 prevent the operation from being performed.
234         implicitIdentity::
235                 Advice on how to set your identity configuration when
236                 your information is guessed from the system username and
237                 domain name.
238         detachedHead::
239                 Advice shown when you used linkgit:git-checkout[1] to
240                 move to the detach HEAD state, to instruct how to create
241                 a local branch after the fact.
242         amWorkDir::
243                 Advice that shows the location of the patch file when
244                 linkgit:git-am[1] fails to apply it.
245         rmHints::
246                 In case of failure in the output of linkgit:git-rm[1],
247                 show directions on how to proceed from the current state.
250 core.fileMode::
251         Tells Git if the executable bit of files in the working tree
252         is to be honored.
254 Some filesystems lose the executable bit when a file that is
255 marked as executable is checked out, or checks out an
256 non-executable file with executable bit on.
257 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258 to see if it handles the executable bit correctly
259 and this variable is automatically set as necessary.
261 A repository, however, may be on a filesystem that handles
262 the filemode correctly, and this variable is set to 'true'
263 when created, but later may be made accessible from another
264 environment that loses the filemode (e.g. exporting ext4 via
265 CIFS mount, visiting a Cygwin created repository with
266 Git for Windows or Eclipse).
267 In such a case it may be necessary to set this variable to 'false'.
268 See linkgit:git-update-index[1].
270 The default is true (when core.filemode is not specified in the config file).
272 core.hideDotFiles::
273         (Windows-only) If true, mark newly-created directories and files whose
274         name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
275         directory is hidden, but no other files starting with a dot.  The
276         default mode is 'dotGitOnly'.
278 core.ignoreCase::
279         If true, this option enables various workarounds to enable
280         Git to work better on filesystems that are not case sensitive,
281         like FAT. For example, if a directory listing finds
282         "makefile" when Git expects "Makefile", Git will assume
283         it is really the same file, and continue to remember it as
284         "Makefile".
286 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
287 will probe and set core.ignoreCase true if appropriate when the repository
288 is created.
290 core.precomposeUnicode::
291         This option is only used by Mac OS implementation of Git.
292         When core.precomposeUnicode=true, Git reverts the unicode decomposition
293         of filenames done by Mac OS. This is useful when sharing a repository
294         between Mac OS and Linux or Windows.
295         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
296         When false, file names are handled fully transparent by Git,
297         which is backward compatible with older versions of Git.
299 core.protectHFS::
300         If set to true, do not allow checkout of paths that would
301         be considered equivalent to `.git` on an HFS+ filesystem.
302         Defaults to `true` on Mac OS, and `false` elsewhere.
304 core.protectNTFS::
305         If set to true, do not allow checkout of paths that would
306         cause problems with the NTFS filesystem, e.g. conflict with
307         8.3 "short" names.
308         Defaults to `true` on Windows, and `false` elsewhere.
310 core.trustctime::
311         If false, the ctime differences between the index and the
312         working tree are ignored; useful when the inode change time
313         is regularly modified by something outside Git (file system
314         crawlers and some backup systems).
315         See linkgit:git-update-index[1]. True by default.
317 core.untrackedCache::
318         Determines what to do about the untracked cache feature of the
319         index. It will be kept, if this variable is unset or set to
320         `keep`. It will automatically be added if set to `true`. And
321         it will automatically be removed, if set to `false`. Before
322         setting it to `true`, you should check that mtime is working
323         properly on your system.
324         See linkgit:git-update-index[1]. `keep` by default.
326 core.checkStat::
327         Determines which stat fields to match between the index
328         and work tree. The user can set this to 'default' or
329         'minimal'. Default (or explicitly 'default'), is to check
330         all fields, including the sub-second part of mtime and ctime.
332 core.quotePath::
333         The commands that output paths (e.g. 'ls-files',
334         'diff'), when not given the `-z` option, will quote
335         "unusual" characters in the pathname by enclosing the
336         pathname in a double-quote pair and with backslashes the
337         same way strings in C source code are quoted.  If this
338         variable is set to false, the bytes higher than 0x80 are
339         not quoted but output as verbatim.  Note that double
340         quote, backslash and control characters are always
341         quoted without `-z` regardless of the setting of this
342         variable.
344 core.eol::
345         Sets the line ending type to use in the working directory for
346         files that have the `text` property set.  Alternatives are
347         'lf', 'crlf' and 'native', which uses the platform's native
348         line ending.  The default value is `native`.  See
349         linkgit:gitattributes[5] for more information on end-of-line
350         conversion.
352 core.safecrlf::
353         If true, makes Git check if converting `CRLF` is reversible when
354         end-of-line conversion is active.  Git will verify if a command
355         modifies a file in the work tree either directly or indirectly.
356         For example, committing a file followed by checking out the
357         same file should yield the original file in the work tree.  If
358         this is not the case for the current setting of
359         `core.autocrlf`, Git will reject the file.  The variable can
360         be set to "warn", in which case Git will only warn about an
361         irreversible conversion but continue the operation.
363 CRLF conversion bears a slight chance of corrupting data.
364 When it is enabled, Git will convert CRLF to LF during commit and LF to
365 CRLF during checkout.  A file that contains a mixture of LF and
366 CRLF before the commit cannot be recreated by Git.  For text
367 files this is the right thing to do: it corrects line endings
368 such that we have only LF line endings in the repository.
369 But for binary files that are accidentally classified as text the
370 conversion can corrupt data.
372 If you recognize such corruption early you can easily fix it by
373 setting the conversion type explicitly in .gitattributes.  Right
374 after committing you still have the original file in your work
375 tree and this file is not yet corrupted.  You can explicitly tell
376 Git that this file is binary and Git will handle the file
377 appropriately.
379 Unfortunately, the desired effect of cleaning up text files with
380 mixed line endings and the undesired effect of corrupting binary
381 files cannot be distinguished.  In both cases CRLFs are removed
382 in an irreversible way.  For text files this is the right thing
383 to do because CRLFs are line endings, while for binary files
384 converting CRLFs corrupts data.
386 Note, this safety check does not mean that a checkout will generate a
387 file identical to the original file for a different setting of
388 `core.eol` and `core.autocrlf`, but only for the current one.  For
389 example, a text file with `LF` would be accepted with `core.eol=lf`
390 and could later be checked out with `core.eol=crlf`, in which case the
391 resulting file would contain `CRLF`, although the original file
392 contained `LF`.  However, in both work trees the line endings would be
393 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
394 file with mixed line endings would be reported by the `core.safecrlf`
395 mechanism.
397 core.autocrlf::
398         Setting this variable to "true" is almost the same as setting
399         the `text` attribute to "auto" on all files except that text
400         files are not guaranteed to be normalized: files that contain
401         `CRLF` in the repository will not be touched.  Use this
402         setting if you want to have `CRLF` line endings in your
403         working directory even though the repository does not have
404         normalized line endings.  This variable can be set to 'input',
405         in which case no output conversion is performed.
407 core.symlinks::
408         If false, symbolic links are checked out as small plain files that
409         contain the link text. linkgit:git-update-index[1] and
410         linkgit:git-add[1] will not change the recorded type to regular
411         file. Useful on filesystems like FAT that do not support
412         symbolic links.
414 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
415 will probe and set core.symlinks false if appropriate when the repository
416 is created.
418 core.gitProxy::
419         A "proxy command" to execute (as 'command host port') instead
420         of establishing direct connection to the remote server when
421         using the Git protocol for fetching. If the variable value is
422         in the "COMMAND for DOMAIN" format, the command is applied only
423         on hostnames ending with the specified domain string. This variable
424         may be set multiple times and is matched in the given order;
425         the first match wins.
427 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
428 (which always applies universally, without the special "for"
429 handling).
431 The special string `none` can be used as the proxy command to
432 specify that no proxy be used for a given domain pattern.
433 This is useful for excluding servers inside a firewall from
434 proxy use, while defaulting to a common proxy for external domains.
436 core.ignoreStat::
437         If true, Git will avoid using lstat() calls to detect if files have
438         changed by setting the "assume-unchanged" bit for those tracked files
439         which it has updated identically in both the index and working tree.
441 When files are modified outside of Git, the user will need to stage
442 the modified files explicitly (e.g. see 'Examples' section in
443 linkgit:git-update-index[1]).
444 Git will not normally detect changes to those files.
446 This is useful on systems where lstat() calls are very slow, such as
447 CIFS/Microsoft Windows.
449 False by default.
451 core.preferSymlinkRefs::
452         Instead of the default "symref" format for HEAD
453         and other symbolic reference files, use symbolic links.
454         This is sometimes needed to work with old scripts that
455         expect HEAD to be a symbolic link.
457 core.bare::
458         If true this repository is assumed to be 'bare' and has no
459         working directory associated with it.  If this is the case a
460         number of commands that require a working directory will be
461         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
463 This setting is automatically guessed by linkgit:git-clone[1] or
464 linkgit:git-init[1] when the repository was created.  By default a
465 repository that ends in "/.git" is assumed to be not bare (bare =
466 false), while all other repositories are assumed to be bare (bare
467 = true).
469 core.worktree::
470         Set the path to the root of the working tree.
471         If GIT_COMMON_DIR environment variable is set, core.worktree
472         is ignored and not used for determining the root of working tree.
473         This can be overridden by the GIT_WORK_TREE environment
474         variable and the '--work-tree' command-line option.
475         The value can be an absolute path or relative to the path to
476         the .git directory, which is either specified by --git-dir
477         or GIT_DIR, or automatically discovered.
478         If --git-dir or GIT_DIR is specified but none of
479         --work-tree, GIT_WORK_TREE and core.worktree is specified,
480         the current working directory is regarded as the top level
481         of your working tree.
483 Note that this variable is honored even when set in a configuration
484 file in a ".git" subdirectory of a directory and its value differs
485 from the latter directory (e.g. "/path/to/.git/config" has
486 core.worktree set to "/different/path"), which is most likely a
487 misconfiguration.  Running Git commands in the "/path/to" directory will
488 still use "/different/path" as the root of the work tree and can cause
489 confusion unless you know what you are doing (e.g. you are creating a
490 read-only snapshot of the same index to a location different from the
491 repository's usual working tree).
493 core.logAllRefUpdates::
494         Enable the reflog. Updates to a ref <ref> is logged to the file
495         "$GIT_DIR/logs/<ref>", by appending the new and old
496         SHA-1, the date/time and the reason of the update, but
497         only when the file exists.  If this configuration
498         variable is set to true, missing "$GIT_DIR/logs/<ref>"
499         file is automatically created for branch heads (i.e. under
500         refs/heads/), remote refs (i.e. under refs/remotes/),
501         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
503 This information can be used to determine what commit
504 was the tip of a branch "2 days ago".
506 This value is true by default in a repository that has
507 a working directory associated with it, and false by
508 default in a bare repository.
510 core.repositoryFormatVersion::
511         Internal variable identifying the repository format and layout
512         version.
514 core.sharedRepository::
515         When 'group' (or 'true'), the repository is made shareable between
516         several users in a group (making sure all the files and objects are
517         group-writable). When 'all' (or 'world' or 'everybody'), the
518         repository will be readable by all users, additionally to being
519         group-shareable. When 'umask' (or 'false'), Git will use permissions
520         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
521         files in the repository will have this mode value. '0xxx' will override
522         user's umask value (whereas the other options will only override
523         requested parts of the user's umask value). Examples: '0660' will make
524         the repo read/write-able for the owner and group, but inaccessible to
525         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
526         repository that is group-readable but not group-writable.
527         See linkgit:git-init[1]. False by default.
529 core.warnAmbiguousRefs::
530         If true, Git will warn you if the ref name you passed it is ambiguous
531         and might match multiple refs in the repository. True by default.
533 core.compression::
534         An integer -1..9, indicating a default compression level.
535         -1 is the zlib default. 0 means no compression,
536         and 1..9 are various speed/size tradeoffs, 9 being slowest.
537         If set, this provides a default to other compression variables,
538         such as 'core.looseCompression' and 'pack.compression'.
540 core.looseCompression::
541         An integer -1..9, indicating the compression level for objects that
542         are not in a pack file. -1 is the zlib default. 0 means no
543         compression, and 1..9 are various speed/size tradeoffs, 9 being
544         slowest.  If not set,  defaults to core.compression.  If that is
545         not set,  defaults to 1 (best speed).
547 core.packedGitWindowSize::
548         Number of bytes of a pack file to map into memory in a
549         single mapping operation.  Larger window sizes may allow
550         your system to process a smaller number of large pack files
551         more quickly.  Smaller window sizes will negatively affect
552         performance due to increased calls to the operating system's
553         memory manager, but may improve performance when accessing
554         a large number of large pack files.
556 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
557 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
558 be reasonable for all users/operating systems.  You probably do
559 not need to adjust this value.
561 Common unit suffixes of 'k', 'm', or 'g' are supported.
563 core.packedGitLimit::
564         Maximum number of bytes to map simultaneously into memory
565         from pack files.  If Git needs to access more than this many
566         bytes at once to complete an operation it will unmap existing
567         regions to reclaim virtual address space within the process.
569 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
570 This should be reasonable for all users/operating systems, except on
571 the largest projects.  You probably do not need to adjust this value.
573 Common unit suffixes of 'k', 'm', or 'g' are supported.
575 core.deltaBaseCacheLimit::
576         Maximum number of bytes to reserve for caching base objects
577         that may be referenced by multiple deltified objects.  By storing the
578         entire decompressed base objects in a cache Git is able
579         to avoid unpacking and decompressing frequently used base
580         objects multiple times.
582 Default is 96 MiB on all platforms.  This should be reasonable
583 for all users/operating systems, except on the largest projects.
584 You probably do not need to adjust this value.
586 Common unit suffixes of 'k', 'm', or 'g' are supported.
588 core.bigFileThreshold::
589         Files larger than this size are stored deflated, without
590         attempting delta compression.  Storing large files without
591         delta compression avoids excessive memory usage, at the
592         slight expense of increased disk usage. Additionally files
593         larger than this size are always treated as binary.
595 Default is 512 MiB on all platforms.  This should be reasonable
596 for most projects as source code and other text files can still
597 be delta compressed, but larger binary media files won't be.
599 Common unit suffixes of 'k', 'm', or 'g' are supported.
601 core.excludesFile::
602         In addition to '.gitignore' (per-directory) and
603         '.git/info/exclude', Git looks into this file for patterns
604         of files which are not meant to be tracked.  "`~/`" is expanded
605         to the value of `$HOME` and "`~user/`" to the specified user's
606         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
607         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
608         is used instead. See linkgit:gitignore[5].
610 core.askPass::
611         Some commands (e.g. svn and http interfaces) that interactively
612         ask for a password can be told to use an external program given
613         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
614         environment variable. If not set, fall back to the value of the
615         'SSH_ASKPASS' environment variable or, failing that, a simple password
616         prompt. The external program shall be given a suitable prompt as
617         command-line argument and write the password on its STDOUT.
619 core.attributesFile::
620         In addition to '.gitattributes' (per-directory) and
621         '.git/info/attributes', Git looks into this file for attributes
622         (see linkgit:gitattributes[5]). Path expansions are made the same
623         way as for `core.excludesFile`. Its default value is
624         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
625         set or empty, $HOME/.config/git/attributes is used instead.
627 core.editor::
628         Commands such as `commit` and `tag` that lets you edit
629         messages by launching an editor uses the value of this
630         variable when it is set, and the environment variable
631         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
633 core.commentChar::
634         Commands such as `commit` and `tag` that lets you edit
635         messages consider a line that begins with this character
636         commented, and removes them after the editor returns
637         (default '#').
639 If set to "auto", `git-commit` would select a character that is not
640 the beginning character of any line in existing commit messages.
642 core.packedRefsTimeout::
643         The length of time, in milliseconds, to retry when trying to
644         lock the `packed-refs` file. Value 0 means not to retry at
645         all; -1 means to try indefinitely. Default is 1000 (i.e.,
646         retry for 1 second).
648 sequence.editor::
649         Text editor used by `git rebase -i` for editing the rebase instruction file.
650         The value is meant to be interpreted by the shell when it is used.
651         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
652         When not configured the default commit message editor is used instead.
654 core.pager::
655         Text viewer for use by Git commands (e.g., 'less').  The value
656         is meant to be interpreted by the shell.  The order of preference
657         is the `$GIT_PAGER` environment variable, then `core.pager`
658         configuration, then `$PAGER`, and then the default chosen at
659         compile time (usually 'less').
661 When the `LESS` environment variable is unset, Git sets it to `FRX`
662 (if `LESS` environment variable is set, Git does not change it at
663 all).  If you want to selectively override Git's default setting
664 for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
665 be passed to the shell by Git, which will translate the final
666 command to `LESS=FRX less -S`. The environment does not set the
667 `S` option but the command line does, instructing less to truncate
668 long lines. Similarly, setting `core.pager` to `less -+F` will
669 deactivate the `F` option specified by the environment from the
670 command-line, deactivating the "quit if one screen" behavior of
671 `less`.  One can specifically activate some flags for particular
672 commands: for example, setting `pager.blame` to `less -S` enables
673 line truncation only for `git blame`.
675 Likewise, when the `LV` environment variable is unset, Git sets it
676 to `-c`.  You can override this setting by exporting `LV` with
677 another value or setting `core.pager` to `lv +c`.
679 core.whitespace::
680         A comma separated list of common whitespace problems to
681         notice.  'git diff' will use `color.diff.whitespace` to
682         highlight them, and 'git apply --whitespace=error' will
683         consider them as errors.  You can prefix `-` to disable
684         any of them (e.g. `-trailing-space`):
686 * `blank-at-eol` treats trailing whitespaces at the end of the line
687   as an error (enabled by default).
688 * `space-before-tab` treats a space character that appears immediately
689   before a tab character in the initial indent part of the line as an
690   error (enabled by default).
691 * `indent-with-non-tab` treats a line that is indented with space
692   characters instead of the equivalent tabs as an error (not enabled by
693   default).
694 * `tab-in-indent` treats a tab character in the initial indent part of
695   the line as an error (not enabled by default).
696 * `blank-at-eof` treats blank lines added at the end of file as an error
697   (enabled by default).
698 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
699   `blank-at-eof`.
700 * `cr-at-eol` treats a carriage-return at the end of line as
701   part of the line terminator, i.e. with it, `trailing-space`
702   does not trigger if the character before such a carriage-return
703   is not a whitespace (not enabled by default).
704 * `tabwidth=<n>` tells how many character positions a tab occupies; this
705   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
706   errors. The default tab width is 8. Allowed values are 1 to 63.
708 core.fsyncObjectFiles::
709         This boolean will enable 'fsync()' when writing object files.
711 This is a total waste of time and effort on a filesystem that orders
712 data writes properly, but can be useful for filesystems that do not use
713 journalling (traditional UNIX filesystems) or that only journal metadata
714 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
716 core.preloadIndex::
717         Enable parallel index preload for operations like 'git diff'
719 This can speed up operations like 'git diff' and 'git status' especially
720 on filesystems like NFS that have weak caching semantics and thus
721 relatively high IO latencies.  When enabled, Git will do the
722 index comparison to the filesystem data in parallel, allowing
723 overlapping IO's.  Defaults to true.
725 core.createObject::
726         You can set this to 'link', in which case a hardlink followed by
727         a delete of the source are used to make sure that object creation
728         will not overwrite existing objects.
730 On some file system/operating system combinations, this is unreliable.
731 Set this config setting to 'rename' there; However, This will remove the
732 check that makes sure that existing object files will not get overwritten.
734 core.notesRef::
735         When showing commit messages, also show notes which are stored in
736         the given ref.  The ref must be fully qualified.  If the given
737         ref does not exist, it is not an error but means that no
738         notes should be printed.
740 This setting defaults to "refs/notes/commits", and it can be overridden by
741 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
743 core.sparseCheckout::
744         Enable "sparse checkout" feature. See section "Sparse checkout" in
745         linkgit:git-read-tree[1] for more information.
747 core.abbrev::
748         Set the length object names are abbreviated to.  If unspecified,
749         many commands abbreviate to 7 hexdigits, which may not be enough
750         for abbreviated object names to stay unique for sufficiently long
751         time.
753 add.ignoreErrors::
754 add.ignore-errors (deprecated)::
755         Tells 'git add' to continue adding files when some files cannot be
756         added due to indexing errors. Equivalent to the '--ignore-errors'
757         option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
758         as it does not follow the usual naming convention for configuration
759         variables.
761 alias.*::
762         Command aliases for the linkgit:git[1] command wrapper - e.g.
763         after defining "alias.last = cat-file commit HEAD", the invocation
764         "git last" is equivalent to "git cat-file commit HEAD". To avoid
765         confusion and troubles with script usage, aliases that
766         hide existing Git commands are ignored. Arguments are split by
767         spaces, the usual shell quoting and escaping is supported.
768         A quote pair or a backslash can be used to quote them.
770 If the alias expansion is prefixed with an exclamation point,
771 it will be treated as a shell command.  For example, defining
772 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
773 "git new" is equivalent to running the shell command
774 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
775 executed from the top-level directory of a repository, which may
776 not necessarily be the current directory.
777 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
778 from the original current directory. See linkgit:git-rev-parse[1].
780 am.keepcr::
781         If true, git-am will call git-mailsplit for patches in mbox format
782         with parameter '--keep-cr'. In this case git-mailsplit will
783         not remove `\r` from lines ending with `\r\n`. Can be overridden
784         by giving '--no-keep-cr' from the command line.
785         See linkgit:git-am[1], linkgit:git-mailsplit[1].
787 am.threeWay::
788         By default, `git am` will fail if the patch does not apply cleanly. When
789         set to true, this setting tells `git am` to fall back on 3-way merge if
790         the patch records the identity of blobs it is supposed to apply to and
791         we have those blobs available locally (equivalent to giving the `--3way`
792         option from the command line). Defaults to `false`.
793         See linkgit:git-am[1].
795 apply.ignoreWhitespace::
796         When set to 'change', tells 'git apply' to ignore changes in
797         whitespace, in the same way as the '--ignore-space-change'
798         option.
799         When set to one of: no, none, never, false tells 'git apply' to
800         respect all whitespace differences.
801         See linkgit:git-apply[1].
803 apply.whitespace::
804         Tells 'git apply' how to handle whitespaces, in the same way
805         as the '--whitespace' option. See linkgit:git-apply[1].
807 branch.autoSetupMerge::
808         Tells 'git branch' and 'git checkout' to set up new branches
809         so that linkgit:git-pull[1] will appropriately merge from the
810         starting point branch. Note that even if this option is not set,
811         this behavior can be chosen per-branch using the `--track`
812         and `--no-track` options. The valid settings are: `false` -- no
813         automatic setup is done; `true` -- automatic setup is done when the
814         starting point is a remote-tracking branch; `always` --
815         automatic setup is done when the starting point is either a
816         local branch or remote-tracking
817         branch. This option defaults to true.
819 branch.autoSetupRebase::
820         When a new branch is created with 'git branch' or 'git checkout'
821         that tracks another branch, this variable tells Git to set
822         up pull to rebase instead of merge (see "branch.<name>.rebase").
823         When `never`, rebase is never automatically set to true.
824         When `local`, rebase is set to true for tracked branches of
825         other local branches.
826         When `remote`, rebase is set to true for tracked branches of
827         remote-tracking branches.
828         When `always`, rebase will be set to true for all tracking
829         branches.
830         See "branch.autoSetupMerge" for details on how to set up a
831         branch to track another branch.
832         This option defaults to never.
834 branch.<name>.remote::
835         When on branch <name>, it tells 'git fetch' and 'git push'
836         which remote to fetch from/push to.  The remote to push to
837         may be overridden with `remote.pushDefault` (for all branches).
838         The remote to push to, for the current branch, may be further
839         overridden by `branch.<name>.pushRemote`.  If no remote is
840         configured, or if you are not on any branch, it defaults to
841         `origin` for fetching and `remote.pushDefault` for pushing.
842         Additionally, `.` (a period) is the current local repository
843         (a dot-repository), see `branch.<name>.merge`'s final note below.
845 branch.<name>.pushRemote::
846         When on branch <name>, it overrides `branch.<name>.remote` for
847         pushing.  It also overrides `remote.pushDefault` for pushing
848         from branch <name>.  When you pull from one place (e.g. your
849         upstream) and push to another place (e.g. your own publishing
850         repository), you would want to set `remote.pushDefault` to
851         specify the remote to push to for all branches, and use this
852         option to override it for a specific branch.
854 branch.<name>.merge::
855         Defines, together with branch.<name>.remote, the upstream branch
856         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
857         branch to merge and can also affect 'git push' (see push.default).
858         When in branch <name>, it tells 'git fetch' the default
859         refspec to be marked for merging in FETCH_HEAD. The value is
860         handled like the remote part of a refspec, and must match a
861         ref which is fetched from the remote given by
862         "branch.<name>.remote".
863         The merge information is used by 'git pull' (which at first calls
864         'git fetch') to lookup the default branch for merging. Without
865         this option, 'git pull' defaults to merge the first refspec fetched.
866         Specify multiple values to get an octopus merge.
867         If you wish to setup 'git pull' so that it merges into <name> from
868         another branch in the local repository, you can point
869         branch.<name>.merge to the desired branch, and use the relative path
870         setting `.` (a period) for branch.<name>.remote.
872 branch.<name>.mergeOptions::
873         Sets default options for merging into branch <name>. The syntax and
874         supported options are the same as those of linkgit:git-merge[1], but
875         option values containing whitespace characters are currently not
876         supported.
878 branch.<name>.rebase::
879         When true, rebase the branch <name> on top of the fetched branch,
880         instead of merging the default branch from the default remote when
881         "git pull" is run. See "pull.rebase" for doing this in a non
882         branch-specific manner.
884 When preserve, also pass `--preserve-merges` along to 'git rebase'
885 so that locally committed merge commits will not be flattened
886 by running 'git pull'.
888 When the value is `interactive`, the rebase is run in interactive mode.
890 *NOTE*: this is a possibly dangerous operation; do *not* use
891 it unless you understand the implications (see linkgit:git-rebase[1]
892 for details).
894 branch.<name>.description::
895         Branch description, can be edited with
896         `git branch --edit-description`. Branch description is
897         automatically added in the format-patch cover letter or
898         request-pull summary.
900 browser.<tool>.cmd::
901         Specify the command to invoke the specified browser. The
902         specified command is evaluated in shell with the URLs passed
903         as arguments. (See linkgit:git-web{litdd}browse[1].)
905 browser.<tool>.path::
906         Override the path for the given tool that may be used to
907         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
908         working repository in gitweb (see linkgit:git-instaweb[1]).
910 clean.requireForce::
911         A boolean to make git-clean do nothing unless given -f,
912         -i or -n.   Defaults to true.
914 color.branch::
915         A boolean to enable/disable color in the output of
916         linkgit:git-branch[1]. May be set to `always`,
917         `false` (or `never`) or `auto` (or `true`), in which case colors are used
918         only when the output is to a terminal. Defaults to false.
920 color.branch.<slot>::
921         Use customized color for branch coloration. `<slot>` is one of
922         `current` (the current branch), `local` (a local branch),
923         `remote` (a remote-tracking branch in refs/remotes/),
924         `upstream` (upstream tracking branch), `plain` (other
925         refs).
927 color.diff::
928         Whether to use ANSI escape sequences to add color to patches.
929         If this is set to `always`, linkgit:git-diff[1],
930         linkgit:git-log[1], and linkgit:git-show[1] will use color
931         for all patches.  If it is set to `true` or `auto`, those
932         commands will only use color when output is to the terminal.
933         Defaults to false.
935 This does not affect linkgit:git-format-patch[1] or the
936 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
937 command line with the `--color[=<when>]` option.
939 color.diff.<slot>::
940         Use customized color for diff colorization.  `<slot>` specifies
941         which part of the patch to use the specified color, and is one
942         of `context` (context text - `plain` is a historical synonym),
943         `meta` (metainformation), `frag`
944         (hunk header), 'func' (function in hunk header), `old` (removed lines),
945         `new` (added lines), `commit` (commit headers), or `whitespace`
946         (highlighting whitespace errors).
948 color.decorate.<slot>::
949         Use customized color for 'git log --decorate' output.  `<slot>` is one
950         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
951         branches, remote-tracking branches, tags, stash and HEAD, respectively.
953 color.grep::
954         When set to `always`, always highlight matches.  When `false` (or
955         `never`), never.  When set to `true` or `auto`, use color only
956         when the output is written to the terminal.  Defaults to `false`.
958 color.grep.<slot>::
959         Use customized color for grep colorization.  `<slot>` specifies which
960         part of the line to use the specified color, and is one of
963 `context`;;
964         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
965 `filename`;;
966         filename prefix (when not using `-h`)
967 `function`;;
968         function name lines (when using `-p`)
969 `linenumber`;;
970         line number prefix (when using `-n`)
971 `match`;;
972         matching text (same as setting `matchContext` and `matchSelected`)
973 `matchContext`;;
974         matching text in context lines
975 `matchSelected`;;
976         matching text in selected lines
977 `selected`;;
978         non-matching text in selected lines
979 `separator`;;
980         separators between fields on a line (`:`, `-`, and `=`)
981         and between hunks (`--`)
984 color.interactive::
985         When set to `always`, always use colors for interactive prompts
986         and displays (such as those used by "git-add --interactive" and
987         "git-clean --interactive"). When false (or `never`), never.
988         When set to `true` or `auto`, use colors only when the output is
989         to the terminal. Defaults to false.
991 color.interactive.<slot>::
992         Use customized color for 'git add --interactive' and 'git clean
993         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
994         or `error`, for four distinct types of normal output from
995         interactive commands.
997 color.pager::
998         A boolean to enable/disable colored output when the pager is in
999         use (default is true).
1001 color.showBranch::
1002         A boolean to enable/disable color in the output of
1003         linkgit:git-show-branch[1]. May be set to `always`,
1004         `false` (or `never`) or `auto` (or `true`), in which case colors are used
1005         only when the output is to a terminal. Defaults to false.
1007 color.status::
1008         A boolean to enable/disable color in the output of
1009         linkgit:git-status[1]. May be set to `always`,
1010         `false` (or `never`) or `auto` (or `true`), in which case colors are used
1011         only when the output is to a terminal. Defaults to false.
1013 color.status.<slot>::
1014         Use customized color for status colorization. `<slot>` is
1015         one of `header` (the header text of the status message),
1016         `added` or `updated` (files which are added but not committed),
1017         `changed` (files which are changed but not added in the index),
1018         `untracked` (files which are not tracked by Git),
1019         `branch` (the current branch),
1020         `nobranch` (the color the 'no branch' warning is shown in, defaulting
1021         to red), or
1022         `unmerged` (files which have unmerged changes).
1024 color.ui::
1025         This variable determines the default value for variables such
1026         as `color.diff` and `color.grep` that control the use of color
1027         per command family. Its scope will expand as more commands learn
1028         configuration to set a default for the `--color` option.  Set it
1029         to `false` or `never` if you prefer Git commands not to use
1030         color unless enabled explicitly with some other configuration
1031         or the `--color` option. Set it to `always` if you want all
1032         output not intended for machine consumption to use color, to
1033         `true` or `auto` (this is the default since Git 1.8.4) if you
1034         want such output to use color when written to the terminal.
1036 column.ui::
1037         Specify whether supported commands should output in columns.
1038         This variable consists of a list of tokens separated by spaces
1039         or commas:
1041 These options control when the feature should be enabled
1042 (defaults to 'never'):
1045 `always`;;
1046         always show in columns
1047 `never`;;
1048         never show in columns
1049 `auto`;;
1050         show in columns if the output is to the terminal
1053 These options control layout (defaults to 'column').  Setting any
1054 of these implies 'always' if none of 'always', 'never', or 'auto' are
1055 specified.
1058 `column`;;
1059         fill columns before rows
1060 `row`;;
1061         fill rows before columns
1062 `plain`;;
1063         show in one column
1066 Finally, these options can be combined with a layout option (defaults
1067 to 'nodense'):
1070 `dense`;;
1071         make unequal size columns to utilize more space
1072 `nodense`;;
1073         make equal size columns
1076 column.branch::
1077         Specify whether to output branch listing in `git branch` in columns.
1078         See `column.ui` for details.
1080 column.clean::
1081         Specify the layout when list items in `git clean -i`, which always
1082         shows files and directories in columns. See `column.ui` for details.
1084 column.status::
1085         Specify whether to output untracked files in `git status` in columns.
1086         See `column.ui` for details.
1088 column.tag::
1089         Specify whether to output tag listing in `git tag` in columns.
1090         See `column.ui` for details.
1092 commit.cleanup::
1093         This setting overrides the default of the `--cleanup` option in
1094         `git commit`. See linkgit:git-commit[1] for details. Changing the
1095         default can be useful when you always want to keep lines that begin
1096         with comment character `#` in your log message, in which case you
1097         would do `git config commit.cleanup whitespace` (note that you will
1098         have to remove the help lines that begin with `#` in the commit log
1099         template yourself, if you do this).
1101 commit.gpgSign::
1103         A boolean to specify whether all commits should be GPG signed.
1104         Use of this option when doing operations such as rebase can
1105         result in a large number of commits being signed. It may be
1106         convenient to use an agent to avoid typing your GPG passphrase
1107         several times.
1109 commit.status::
1110         A boolean to enable/disable inclusion of status information in the
1111         commit message template when using an editor to prepare the commit
1112         message.  Defaults to true.
1114 commit.template::
1115         Specify a file to use as the template for new commit messages.
1116         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1117         specified user's home directory.
1119 credential.helper::
1120         Specify an external helper to be called when a username or
1121         password credential is needed; the helper may consult external
1122         storage to avoid prompting the user for the credentials. See
1123         linkgit:gitcredentials[7] for details.
1125 credential.useHttpPath::
1126         When acquiring credentials, consider the "path" component of an http
1127         or https URL to be important. Defaults to false. See
1128         linkgit:gitcredentials[7] for more information.
1130 credential.username::
1131         If no username is set for a network authentication, use this username
1132         by default. See credential.<context>.* below, and
1133         linkgit:gitcredentials[7].
1135 credential.<url>.*::
1136         Any of the credential.* options above can be applied selectively to
1137         some credentials. For example "credential.https://example.com.username"
1138         would set the default username only for https connections to
1139         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1140         matched.
1142 credentialCache.ignoreSIGHUP::
1143         Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1145 include::diff-config.txt[]
1147 difftool.<tool>.path::
1148         Override the path for the given tool.  This is useful in case
1149         your tool is not in the PATH.
1151 difftool.<tool>.cmd::
1152         Specify the command to invoke the specified diff tool.
1153         The specified command is evaluated in shell with the following
1154         variables available:  'LOCAL' is set to the name of the temporary
1155         file containing the contents of the diff pre-image and 'REMOTE'
1156         is set to the name of the temporary file containing the contents
1157         of the diff post-image.
1159 difftool.prompt::
1160         Prompt before each invocation of the diff tool.
1162 fetch.recurseSubmodules::
1163         This option can be either set to a boolean value or to 'on-demand'.
1164         Setting it to a boolean changes the behavior of fetch and pull to
1165         unconditionally recurse into submodules when set to true or to not
1166         recurse at all when set to false. When set to 'on-demand' (the default
1167         value), fetch and pull will only recurse into a populated submodule
1168         when its superproject retrieves a commit that updates the submodule's
1169         reference.
1171 fetch.fsckObjects::
1172         If it is set to true, git-fetch-pack will check all fetched
1173         objects. It will abort in the case of a malformed object or a
1174         broken link. The result of an abort are only dangling objects.
1175         Defaults to false. If not set, the value of `transfer.fsckObjects`
1176         is used instead.
1178 fetch.unpackLimit::
1179         If the number of objects fetched over the Git native
1180         transfer is below this
1181         limit, then the objects will be unpacked into loose object
1182         files. However if the number of received objects equals or
1183         exceeds this limit then the received pack will be stored as
1184         a pack, after adding any missing delta bases.  Storing the
1185         pack from a push can make the push operation complete faster,
1186         especially on slow filesystems.  If not set, the value of
1187         `transfer.unpackLimit` is used instead.
1189 fetch.prune::
1190         If true, fetch will automatically behave as if the `--prune`
1191         option was given on the command line.  See also `remote.<name>.prune`.
1193 format.attach::
1194         Enable multipart/mixed attachments as the default for
1195         'format-patch'.  The value can also be a double quoted string
1196         which will enable attachments as the default and set the
1197         value as the boundary.  See the --attach option in
1198         linkgit:git-format-patch[1].
1200 format.numbered::
1201         A boolean which can enable or disable sequence numbers in patch
1202         subjects.  It defaults to "auto" which enables it only if there
1203         is more than one patch.  It can be enabled or disabled for all
1204         messages by setting it to "true" or "false".  See --numbered
1205         option in linkgit:git-format-patch[1].
1207 format.headers::
1208         Additional email headers to include in a patch to be submitted
1209         by mail.  See linkgit:git-format-patch[1].
1211 format.to::
1212 format.cc::
1213         Additional recipients to include in a patch to be submitted
1214         by mail.  See the --to and --cc options in
1215         linkgit:git-format-patch[1].
1217 format.subjectPrefix::
1218         The default for format-patch is to output files with the '[PATCH]'
1219         subject prefix. Use this variable to change that prefix.
1221 format.signature::
1222         The default for format-patch is to output a signature containing
1223         the Git version number. Use this variable to change that default.
1224         Set this variable to the empty string ("") to suppress
1225         signature generation.
1227 format.signatureFile::
1228         Works just like format.signature except the contents of the
1229         file specified by this variable will be used as the signature.
1231 format.suffix::
1232         The default for format-patch is to output files with the suffix
1233         `.patch`. Use this variable to change that suffix (make sure to
1234         include the dot if you want it).
1236 format.pretty::
1237         The default pretty format for log/show/whatchanged command,
1238         See linkgit:git-log[1], linkgit:git-show[1],
1239         linkgit:git-whatchanged[1].
1241 format.thread::
1242         The default threading style for 'git format-patch'.  Can be
1243         a boolean value, or `shallow` or `deep`.  `shallow` threading
1244         makes every mail a reply to the head of the series,
1245         where the head is chosen from the cover letter, the
1246         `--in-reply-to`, and the first patch mail, in this order.
1247         `deep` threading makes every mail a reply to the previous one.
1248         A true boolean value is the same as `shallow`, and a false
1249         value disables threading.
1251 format.signOff::
1252         A boolean value which lets you enable the `-s/--signoff` option of
1253         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1254         patch should be a conscious act and means that you certify you have
1255         the rights to submit this work under the same open source license.
1256         Please see the 'SubmittingPatches' document for further discussion.
1258 format.coverLetter::
1259         A boolean that controls whether to generate a cover-letter when
1260         format-patch is invoked, but in addition can be set to "auto", to
1261         generate a cover-letter only when there's more than one patch.
1263 format.outputDirectory::
1264         Set a custom directory to store the resulting files instead of the
1265         current working directory.
1267 filter.<driver>.clean::
1268         The command which is used to convert the content of a worktree
1269         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1270         details.
1272 filter.<driver>.smudge::
1273         The command which is used to convert the content of a blob
1274         object to a worktree file upon checkout.  See
1275         linkgit:gitattributes[5] for details.
1277 fsck.<msg-id>::
1278         Allows overriding the message type (error, warn or ignore) of a
1279         specific message ID such as `missingEmail`.
1281 For convenience, fsck prefixes the error/warning with the message ID,
1282 e.g.  "missingEmail: invalid author/committer line - missing email" means
1283 that setting `fsck.missingEmail = ignore` will hide that issue.
1285 This feature is intended to support working with legacy repositories
1286 which cannot be repaired without disruptive changes.
1288 fsck.skipList::
1289         The path to a sorted list of object names (i.e. one SHA-1 per
1290         line) that are known to be broken in a non-fatal way and should
1291         be ignored. This feature is useful when an established project
1292         should be accepted despite early commits containing errors that
1293         can be safely ignored such as invalid committer email addresses.
1294         Note: corrupt objects cannot be skipped with this setting.
1296 gc.aggressiveDepth::
1297         The depth parameter used in the delta compression
1298         algorithm used by 'git gc --aggressive'.  This defaults
1299         to 250.
1301 gc.aggressiveWindow::
1302         The window size parameter used in the delta compression
1303         algorithm used by 'git gc --aggressive'.  This defaults
1304         to 250.
1306 gc.auto::
1307         When there are approximately more than this many loose
1308         objects in the repository, `git gc --auto` will pack them.
1309         Some Porcelain commands use this command to perform a
1310         light-weight garbage collection from time to time.  The
1311         default value is 6700.  Setting this to 0 disables it.
1313 gc.autoPackLimit::
1314         When there are more than this many packs that are not
1315         marked with `*.keep` file in the repository, `git gc
1316         --auto` consolidates them into one larger pack.  The
1317         default value is 50.  Setting this to 0 disables it.
1319 gc.autoDetach::
1320         Make `git gc --auto` return immediately and run in background
1321         if the system supports it. Default is true.
1323 gc.packRefs::
1324         Running `git pack-refs` in a repository renders it
1325         unclonable by Git versions prior to 1.5.1.2 over dumb
1326         transports such as HTTP.  This variable determines whether
1327         'git gc' runs `git pack-refs`. This can be set to `notbare`
1328         to enable it within all non-bare repos or it can be set to a
1329         boolean value.  The default is `true`.
1331 gc.pruneExpire::
1332         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1333         Override the grace period with this config variable.  The value
1334         "now" may be used to disable this grace period and always prune
1335         unreachable objects immediately, or "never" may be used to
1336         suppress pruning.
1338 gc.worktreePruneExpire::
1339         When 'git gc' is run, it calls
1340         'git worktree prune --expire 3.months.ago'.
1341         This config variable can be used to set a different grace
1342         period. The value "now" may be used to disable the grace
1343         period and prune $GIT_DIR/worktrees immediately, or "never"
1344         may be used to suppress pruning.
1346 gc.reflogExpire::
1347 gc.<pattern>.reflogExpire::
1348         'git reflog expire' removes reflog entries older than
1349         this time; defaults to 90 days. The value "now" expires all
1350         entries immediately, and "never" suppresses expiration
1351         altogether. With "<pattern>" (e.g.
1352         "refs/stash") in the middle the setting applies only to
1353         the refs that match the <pattern>.
1355 gc.reflogExpireUnreachable::
1356 gc.<pattern>.reflogExpireUnreachable::
1357         'git reflog expire' removes reflog entries older than
1358         this time and are not reachable from the current tip;
1359         defaults to 30 days. The value "now" expires all entries
1360         immediately, and "never" suppresses expiration altogether.
1361         With "<pattern>" (e.g. "refs/stash")
1362         in the middle, the setting applies only to the refs that
1363         match the <pattern>.
1365 gc.rerereResolved::
1366         Records of conflicted merge you resolved earlier are
1367         kept for this many days when 'git rerere gc' is run.
1368         The default is 60 days.  See linkgit:git-rerere[1].
1370 gc.rerereUnresolved::
1371         Records of conflicted merge you have not resolved are
1372         kept for this many days when 'git rerere gc' is run.
1373         The default is 15 days.  See linkgit:git-rerere[1].
1375 gitcvs.commitMsgAnnotation::
1376         Append this string to each commit message. Set to empty string
1377         to disable this feature. Defaults to "via git-CVS emulator".
1379 gitcvs.enabled::
1380         Whether the CVS server interface is enabled for this repository.
1381         See linkgit:git-cvsserver[1].
1383 gitcvs.logFile::
1384         Path to a log file where the CVS server interface well... logs
1385         various stuff. See linkgit:git-cvsserver[1].
1387 gitcvs.usecrlfattr::
1388         If true, the server will look up the end-of-line conversion
1389         attributes for files to determine the '-k' modes to use. If
1390         the attributes force Git to treat a file as text,
1391         the '-k' mode will be left blank so CVS clients will
1392         treat it as text. If they suppress text conversion, the file
1393         will be set with '-kb' mode, which suppresses any newline munging
1394         the client might otherwise do. If the attributes do not allow
1395         the file type to be determined, then 'gitcvs.allBinary' is
1396         used. See linkgit:gitattributes[5].
1398 gitcvs.allBinary::
1399         This is used if 'gitcvs.usecrlfattr' does not resolve
1400         the correct '-kb' mode to use. If true, all
1401         unresolved files are sent to the client in
1402         mode '-kb'. This causes the client to treat them
1403         as binary files, which suppresses any newline munging it
1404         otherwise might do. Alternatively, if it is set to "guess",
1405         then the contents of the file are examined to decide if
1406         it is binary, similar to 'core.autocrlf'.
1408 gitcvs.dbName::
1409         Database used by git-cvsserver to cache revision information
1410         derived from the Git repository. The exact meaning depends on the
1411         used database driver, for SQLite (which is the default driver) this
1412         is a filename. Supports variable substitution (see
1413         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1414         Default: '%Ggitcvs.%m.sqlite'
1416 gitcvs.dbDriver::
1417         Used Perl DBI driver. You can specify any available driver
1418         for this here, but it might not work. git-cvsserver is tested
1419         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1420         reported *not* to work with 'DBD::mysql'. Experimental feature.
1421         May not contain double colons (`:`). Default: 'SQLite'.
1422         See linkgit:git-cvsserver[1].
1424 gitcvs.dbUser, gitcvs.dbPass::
1425         Database user and password. Only useful if setting 'gitcvs.dbDriver',
1426         since SQLite has no concept of database users and/or passwords.
1427         'gitcvs.dbUser' supports variable substitution (see
1428         linkgit:git-cvsserver[1] for details).
1430 gitcvs.dbTableNamePrefix::
1431         Database table name prefix.  Prepended to the names of any
1432         database tables used, allowing a single database to be used
1433         for several repositories.  Supports variable substitution (see
1434         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1435         characters will be replaced with underscores.
1437 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1438 'gitcvs.allBinary' can also be specified as
1439 'gitcvs.<access_method>.<varname>' (where 'access_method'
1440 is one of "ext" and "pserver") to make them apply only for the given
1441 access method.
1443 gitweb.category::
1444 gitweb.description::
1445 gitweb.owner::
1446 gitweb.url::
1447         See linkgit:gitweb[1] for description.
1449 gitweb.avatar::
1450 gitweb.blame::
1451 gitweb.grep::
1452 gitweb.highlight::
1453 gitweb.patches::
1454 gitweb.pickaxe::
1455 gitweb.remote_heads::
1456 gitweb.showSizes::
1457 gitweb.snapshot::
1458         See linkgit:gitweb.conf[5] for description.
1460 grep.lineNumber::
1461         If set to true, enable '-n' option by default.
1463 grep.patternType::
1464         Set the default matching behavior. Using a value of 'basic', 'extended',
1465         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1466         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1467         value 'default' will return to the default matching behavior.
1469 grep.extendedRegexp::
1470         If set to true, enable '--extended-regexp' option by default. This
1471         option is ignored when the 'grep.patternType' option is set to a value
1472         other than 'default'.
1474 grep.threads::
1475         Number of grep worker threads to use.
1476         See `grep.threads` in linkgit:git-grep[1] for more information.
1478 grep.fallbackToNoIndex::
1479         If set to true, fall back to git grep --no-index if git grep
1480         is executed outside of a git repository.  Defaults to false.
1482 gpg.program::
1483         Use this custom program instead of "gpg" found on $PATH when
1484         making or verifying a PGP signature. The program must support the
1485         same command-line interface as GPG, namely, to verify a detached
1486         signature, "gpg --verify $file - <$signature" is run, and the
1487         program is expected to signal a good signature by exiting with
1488         code 0, and to generate an ASCII-armored detached signature, the
1489         standard input of "gpg -bsau $key" is fed with the contents to be
1490         signed, and the program is expected to send the result to its
1491         standard output.
1493 gui.commitMsgWidth::
1494         Defines how wide the commit message window is in the
1495         linkgit:git-gui[1]. "75" is the default.
1497 gui.diffContext::
1498         Specifies how many context lines should be used in calls to diff
1499         made by the linkgit:git-gui[1]. The default is "5".
1501 gui.displayUntracked::
1502         Determines if linkgit::git-gui[1] shows untracked files
1503         in the file list. The default is "true".
1505 gui.encoding::
1506         Specifies the default encoding to use for displaying of
1507         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1508         It can be overridden by setting the 'encoding' attribute
1509         for relevant files (see linkgit:gitattributes[5]).
1510         If this option is not set, the tools default to the
1511         locale encoding.
1513 gui.matchTrackingBranch::
1514         Determines if new branches created with linkgit:git-gui[1] should
1515         default to tracking remote branches with matching names or
1516         not. Default: "false".
1518 gui.newBranchTemplate::
1519         Is used as suggested name when creating new branches using the
1520         linkgit:git-gui[1].
1522 gui.pruneDuringFetch::
1523         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1524         performing a fetch. The default value is "false".
1526 gui.trustmtime::
1527         Determines if linkgit:git-gui[1] should trust the file modification
1528         timestamp or not. By default the timestamps are not trusted.
1530 gui.spellingDictionary::
1531         Specifies the dictionary used for spell checking commit messages in
1532         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1533         off.
1535 gui.fastCopyBlame::
1536         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1537         location detection. It makes blame significantly faster on huge
1538         repositories at the expense of less thorough copy detection.
1540 gui.copyBlameThreshold::
1541         Specifies the threshold to use in 'git gui blame' original location
1542         detection, measured in alphanumeric characters. See the
1543         linkgit:git-blame[1] manual for more information on copy detection.
1545 gui.blamehistoryctx::
1546         Specifies the radius of history context in days to show in
1547         linkgit:gitk[1] for the selected commit, when the `Show History
1548         Context` menu item is invoked from 'git gui blame'. If this
1549         variable is set to zero, the whole history is shown.
1551 guitool.<name>.cmd::
1552         Specifies the shell command line to execute when the corresponding item
1553         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1554         mandatory for every tool. The command is executed from the root of
1555         the working directory, and in the environment it receives the name of
1556         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1557         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1558         the head is detached, 'CUR_BRANCH' is empty).
1560 guitool.<name>.needsFile::
1561         Run the tool only if a diff is selected in the GUI. It guarantees
1562         that 'FILENAME' is not empty.
1564 guitool.<name>.noConsole::
1565         Run the command silently, without creating a window to display its
1566         output.
1568 guitool.<name>.noRescan::
1569         Don't rescan the working directory for changes after the tool
1570         finishes execution.
1572 guitool.<name>.confirm::
1573         Show a confirmation dialog before actually running the tool.
1575 guitool.<name>.argPrompt::
1576         Request a string argument from the user, and pass it to the tool
1577         through the 'ARGS' environment variable. Since requesting an
1578         argument implies confirmation, the 'confirm' option has no effect
1579         if this is enabled. If the option is set to 'true', 'yes', or '1',
1580         the dialog uses a built-in generic prompt; otherwise the exact
1581         value of the variable is used.
1583 guitool.<name>.revPrompt::
1584         Request a single valid revision from the user, and set the
1585         'REVISION' environment variable. In other aspects this option
1586         is similar to 'argPrompt', and can be used together with it.
1588 guitool.<name>.revUnmerged::
1589         Show only unmerged branches in the 'revPrompt' subdialog.
1590         This is useful for tools similar to merge or rebase, but not
1591         for things like checkout or reset.
1593 guitool.<name>.title::
1594         Specifies the title to use for the prompt dialog. The default
1595         is the tool name.
1597 guitool.<name>.prompt::
1598         Specifies the general prompt string to display at the top of
1599         the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1600         The default value includes the actual command.
1602 help.browser::
1603         Specify the browser that will be used to display help in the
1604         'web' format. See linkgit:git-help[1].
1606 help.format::
1607         Override the default help format used by linkgit:git-help[1].
1608         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1609         the default. 'web' and 'html' are the same.
1611 help.autoCorrect::
1612         Automatically correct and execute mistyped commands after
1613         waiting for the given number of deciseconds (0.1 sec). If more
1614         than one command can be deduced from the entered text, nothing
1615         will be executed.  If the value of this option is negative,
1616         the corrected command will be executed immediately. If the
1617         value is 0 - the command will be just shown but not executed.
1618         This is the default.
1620 help.htmlPath::
1621         Specify the path where the HTML documentation resides. File system paths
1622         and URLs are supported. HTML pages will be prefixed with this path when
1623         help is displayed in the 'web' format. This defaults to the documentation
1624         path of your Git installation.
1626 http.proxy::
1627         Override the HTTP proxy, normally configured using the 'http_proxy',
1628         'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1629         addition to the syntax understood by curl, it is possible to specify a
1630         proxy string with a user name but no password, in which case git will
1631         attempt to acquire one in the same way it does for other credentials. See
1632         linkgit:gitcredentials[7] for more information. The syntax thus is
1633         '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1634         on a per-remote basis; see remote.<name>.proxy
1636 http.proxyAuthMethod::
1637         Set the method with which to authenticate against the HTTP proxy. This
1638         only takes effect if the configured proxy string contains a user name part
1639         (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1640         overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1641         Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1642         variable.  Possible values are:
1645 * `anyauth` - Automatically pick a suitable authentication method. It is
1646   assumed that the proxy answers an unauthenticated request with a 407
1647   status code and one or more Proxy-authenticate headers with supported
1648   authentication methods. This is the default.
1649 * `basic` - HTTP Basic authentication
1650 * `digest` - HTTP Digest authentication; this prevents the password from being
1651   transmitted to the proxy in clear text
1652 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1653   of `curl(1)`)
1654 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1657 http.emptyAuth::
1658         Attempt authentication without seeking a username or password.  This
1659         can be used to attempt GSS-Negotiate authentication without specifying
1660         a username in the URL, as libcurl normally requires a username for
1661         authentication.
1663 http.cookieFile::
1664         File containing previously stored cookie lines which should be used
1665         in the Git http session, if they match the server. The file format
1666         of the file to read cookies from should be plain HTTP headers or
1667         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1668         NOTE that the file specified with http.cookieFile is only used as
1669         input unless http.saveCookies is set.
1671 http.saveCookies::
1672         If set, store cookies received during requests to the file specified by
1673         http.cookieFile. Has no effect if http.cookieFile is unset.
1675 http.sslVersion::
1676         The SSL version to use when negotiating an SSL connection, if you
1677         want to force the default.  The available and default version
1678         depend on whether libcurl was built against NSS or OpenSSL and the
1679         particular configuration of the crypto library in use. Internally
1680         this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1681         documentation for more details on the format of this option and
1682         for the ssl version supported. Actually the possible values of
1683         this option are:
1685         - sslv2
1686         - sslv3
1687         - tlsv1
1688         - tlsv1.0
1689         - tlsv1.1
1690         - tlsv1.2
1693 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1694 To force git to use libcurl's default ssl version and ignore any
1695 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1696 empty string.
1698 http.sslCipherList::
1699   A list of SSL ciphers to use when negotiating an SSL connection.
1700   The available ciphers depend on whether libcurl was built against
1701   NSS or OpenSSL and the particular configuration of the crypto
1702   library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1703   option; see the libcurl documentation for more details on the format
1704   of this list.
1706 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1707 To force git to use libcurl's default cipher list and ignore any
1708 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1709 empty string.
1711 http.sslVerify::
1712         Whether to verify the SSL certificate when fetching or pushing
1713         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1714         variable.
1716 http.sslCert::
1717         File containing the SSL certificate when fetching or pushing
1718         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1719         variable.
1721 http.sslKey::
1722         File containing the SSL private key when fetching or pushing
1723         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1724         variable.
1726 http.sslCertPasswordProtected::
1727         Enable Git's password prompt for the SSL certificate.  Otherwise
1728         OpenSSL will prompt the user, possibly many times, if the
1729         certificate or private key is encrypted.  Can be overridden by the
1730         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1732 http.sslCAInfo::
1733         File containing the certificates to verify the peer with when
1734         fetching or pushing over HTTPS. Can be overridden by the
1735         'GIT_SSL_CAINFO' environment variable.
1737 http.sslCAPath::
1738         Path containing files with the CA certificates to verify the peer
1739         with when fetching or pushing over HTTPS. Can be overridden
1740         by the 'GIT_SSL_CAPATH' environment variable.
1742 http.pinnedpubkey::
1743         Public key of the https service. It may either be the filename of
1744         a PEM or DER encoded public key file or a string starting with
1745         'sha256//' followed by the base64 encoded sha256 hash of the
1746         public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1747         exit with an error if this option is set but not supported by
1748         cURL.
1750 http.sslTry::
1751         Attempt to use AUTH SSL/TLS and encrypted data transfers
1752         when connecting via regular FTP protocol. This might be needed
1753         if the FTP server requires it for security reasons or you wish
1754         to connect securely whenever remote FTP server supports it.
1755         Default is false since it might trigger certificate verification
1756         errors on misconfigured servers.
1758 http.maxRequests::
1759         How many HTTP requests to launch in parallel. Can be overridden
1760         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1762 http.minSessions::
1763         The number of curl sessions (counted across slots) to be kept across
1764         requests. They will not be ended with curl_easy_cleanup() until
1765         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1766         value will be capped at 1. Defaults to 1.
1768 http.postBuffer::
1769         Maximum size in bytes of the buffer used by smart HTTP
1770         transports when POSTing data to the remote system.
1771         For requests larger than this buffer size, HTTP/1.1 and
1772         Transfer-Encoding: chunked is used to avoid creating a
1773         massive pack file locally.  Default is 1 MiB, which is
1774         sufficient for most requests.
1776 http.lowSpeedLimit, http.lowSpeedTime::
1777         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1778         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1779         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1780         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1782 http.noEPSV::
1783         A boolean which disables using of EPSV ftp command by curl.
1784         This can helpful with some "poor" ftp servers which don't
1785         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1786         environment variable. Default is false (curl will use EPSV).
1788 http.userAgent::
1789         The HTTP USER_AGENT string presented to an HTTP server.  The default
1790         value represents the version of the client Git such as git/1.7.1.
1791         This option allows you to override this value to a more common value
1792         such as Mozilla/4.0.  This may be necessary, for instance, if
1793         connecting through a firewall that restricts HTTP connections to a set
1794         of common USER_AGENT strings (but not including those like git/1.7.1).
1795         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1797 http.<url>.*::
1798         Any of the http.* options above can be applied selectively to some URLs.
1799         For a config key to match a URL, each element of the config key is
1800         compared to that of the URL, in the following order:
1803 . Scheme (e.g., `https` in `https://example.com/`). This field
1804   must match exactly between the config key and the URL.
1806 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1807   This field must match exactly between the config key and the URL.
1809 . Port number (e.g., `8080` in `http://example.com:8080/`).
1810   This field must match exactly between the config key and the URL.
1811   Omitted port numbers are automatically converted to the correct
1812   default for the scheme before matching.
1814 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1815   path field of the config key must match the path field of the URL
1816   either exactly or as a prefix of slash-delimited path elements.  This means
1817   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1818   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1819   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1820   key with just path `foo/`).
1822 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1823   the config key has a user name it must match the user name in the
1824   URL exactly. If the config key does not have a user name, that
1825   config key will match a URL with any user name (including none),
1826   but at a lower precedence than a config key with a user name.
1829 The list above is ordered by decreasing precedence; a URL that matches
1830 a config key's path is preferred to one that matches its user name. For example,
1831 if the URL is `https://user@example.com/foo/bar` a config key match of
1832 `https://example.com/foo` will be preferred over a config key match of
1833 `https://user@example.com`.
1835 All URLs are normalized before attempting any matching (the password part,
1836 if embedded in the URL, is always ignored for matching purposes) so that
1837 equivalent URLs that are simply spelled differently will match properly.
1838 Environment variable settings always override any matches.  The URLs that are
1839 matched against are those given directly to Git commands.  This means any URLs
1840 visited as a result of a redirection do not participate in matching.
1842 i18n.commitEncoding::
1843         Character encoding the commit messages are stored in; Git itself
1844         does not care per se, but this information is necessary e.g. when
1845         importing commits from emails or in the gitk graphical history
1846         browser (and possibly at other places in the future or in other
1847         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1849 i18n.logOutputEncoding::
1850         Character encoding the commit messages are converted to when
1851         running 'git log' and friends.
1853 imap::
1854         The configuration variables in the 'imap' section are described
1855         in linkgit:git-imap-send[1].
1857 index.version::
1858         Specify the version with which new index files should be
1859         initialized.  This does not affect existing repositories.
1861 init.templateDir::
1862         Specify the directory from which templates will be copied.
1863         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1865 instaweb.browser::
1866         Specify the program that will be used to browse your working
1867         repository in gitweb. See linkgit:git-instaweb[1].
1869 instaweb.httpd::
1870         The HTTP daemon command-line to start gitweb on your working
1871         repository. See linkgit:git-instaweb[1].
1873 instaweb.local::
1874         If true the web server started by linkgit:git-instaweb[1] will
1875         be bound to the local IP (127.0.0.1).
1877 instaweb.modulePath::
1878         The default module path for linkgit:git-instaweb[1] to use
1879         instead of /usr/lib/apache2/modules.  Only used if httpd
1880         is Apache.
1882 instaweb.port::
1883         The port number to bind the gitweb httpd to. See
1884         linkgit:git-instaweb[1].
1886 interactive.singleKey::
1887         In interactive commands, allow the user to provide one-letter
1888         input with a single key (i.e., without hitting enter).
1889         Currently this is used by the `--patch` mode of
1890         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1891         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1892         setting is silently ignored if portable keystroke input
1893         is not available; requires the Perl module Term::ReadKey.
1895 log.abbrevCommit::
1896         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1897         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1898         override this option with `--no-abbrev-commit`.
1900 log.date::
1901         Set the default date-time mode for the 'log' command.
1902         Setting a value for log.date is similar to using 'git log''s
1903         `--date` option.  See linkgit:git-log[1] for details.
1905 log.decorate::
1906         Print out the ref names of any commits that are shown by the log
1907         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1908         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1909         specified, the full ref name (including prefix) will be printed.
1910         This is the same as the log commands '--decorate' option.
1912 log.follow::
1913         If `true`, `git log` will act as if the `--follow` option was used when
1914         a single <path> is given.  This has the same limitations as `--follow`,
1915         i.e. it cannot be used to follow multiple files and does not work well
1916         on non-linear history.
1918 log.showRoot::
1919         If true, the initial commit will be shown as a big creation event.
1920         This is equivalent to a diff against an empty tree.
1921         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1922         normally hide the root commit will now show it. True by default.
1924 log.mailmap::
1925         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1926         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1928 mailinfo.scissors::
1929         If true, makes linkgit:git-mailinfo[1] (and therefore
1930         linkgit:git-am[1]) act by default as if the --scissors option
1931         was provided on the command-line. When active, this features
1932         removes everything from the message body before a scissors
1933         line (i.e. consisting mainly of ">8", "8<" and "-").
1935 mailmap.file::
1936         The location of an augmenting mailmap file. The default
1937         mailmap, located in the root of the repository, is loaded
1938         first, then the mailmap file pointed to by this variable.
1939         The location of the mailmap file may be in a repository
1940         subdirectory, or somewhere outside of the repository itself.
1941         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1943 mailmap.blob::
1944         Like `mailmap.file`, but consider the value as a reference to a
1945         blob in the repository. If both `mailmap.file` and
1946         `mailmap.blob` are given, both are parsed, with entries from
1947         `mailmap.file` taking precedence. In a bare repository, this
1948         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1949         defaults to empty.
1951 man.viewer::
1952         Specify the programs that may be used to display help in the
1953         'man' format. See linkgit:git-help[1].
1955 man.<tool>.cmd::
1956         Specify the command to invoke the specified man viewer. The
1957         specified command is evaluated in shell with the man page
1958         passed as argument. (See linkgit:git-help[1].)
1960 man.<tool>.path::
1961         Override the path for the given tool that may be used to
1962         display help in the 'man' format. See linkgit:git-help[1].
1964 include::merge-config.txt[]
1966 mergetool.<tool>.path::
1967         Override the path for the given tool.  This is useful in case
1968         your tool is not in the PATH.
1970 mergetool.<tool>.cmd::
1971         Specify the command to invoke the specified merge tool.  The
1972         specified command is evaluated in shell with the following
1973         variables available: 'BASE' is the name of a temporary file
1974         containing the common base of the files to be merged, if available;
1975         'LOCAL' is the name of a temporary file containing the contents of
1976         the file on the current branch; 'REMOTE' is the name of a temporary
1977         file containing the contents of the file from the branch being
1978         merged; 'MERGED' contains the name of the file to which the merge
1979         tool should write the results of a successful merge.
1981 mergetool.<tool>.trustExitCode::
1982         For a custom merge command, specify whether the exit code of
1983         the merge command can be used to determine whether the merge was
1984         successful.  If this is not set to true then the merge target file
1985         timestamp is checked and the merge assumed to have been successful
1986         if the file has been updated, otherwise the user is prompted to
1987         indicate the success of the merge.
1989 mergetool.meld.hasOutput::
1990         Older versions of `meld` do not support the `--output` option.
1991         Git will attempt to detect whether `meld` supports `--output`
1992         by inspecting the output of `meld --help`.  Configuring
1993         `mergetool.meld.hasOutput` will make Git skip these checks and
1994         use the configured value instead.  Setting `mergetool.meld.hasOutput`
1995         to `true` tells Git to unconditionally use the `--output` option,
1996         and `false` avoids using `--output`.
1998 mergetool.keepBackup::
1999         After performing a merge, the original file with conflict markers
2000         can be saved as a file with a `.orig` extension.  If this variable
2001         is set to `false` then this file is not preserved.  Defaults to
2002         `true` (i.e. keep the backup files).
2004 mergetool.keepTemporaries::
2005         When invoking a custom merge tool, Git uses a set of temporary
2006         files to pass to the tool. If the tool returns an error and this
2007         variable is set to `true`, then these temporary files will be
2008         preserved, otherwise they will be removed after the tool has
2009         exited. Defaults to `false`.
2011 mergetool.writeToTemp::
2012         Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2013         conflicting files in the worktree by default.  Git will attempt
2014         to use a temporary directory for these files when set `true`.
2015         Defaults to `false`.
2017 mergetool.prompt::
2018         Prompt before each invocation of the merge resolution program.
2020 notes.mergeStrategy::
2021         Which merge strategy to choose by default when resolving notes
2022         conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2023         `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2024         section of linkgit:git-notes[1] for more information on each strategy.
2026 notes.<name>.mergeStrategy::
2027         Which merge strategy to choose when doing a notes merge into
2028         refs/notes/<name>.  This overrides the more general
2029         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2030         linkgit:git-notes[1] for more information on the available strategies.
2032 notes.displayRef::
2033         The (fully qualified) refname from which to show notes when
2034         showing commit messages.  The value of this variable can be set
2035         to a glob, in which case notes from all matching refs will be
2036         shown.  You may also specify this configuration variable
2037         several times.  A warning will be issued for refs that do not
2038         exist, but a glob that does not match any refs is silently
2039         ignored.
2041 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2042 environment variable, which must be a colon separated list of refs or
2043 globs.
2045 The effective value of "core.notesRef" (possibly overridden by
2046 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2047 displayed.
2049 notes.rewrite.<command>::
2050         When rewriting commits with <command> (currently `amend` or
2051         `rebase`) and this variable is set to `true`, Git
2052         automatically copies your notes from the original to the
2053         rewritten commit.  Defaults to `true`, but see
2054         "notes.rewriteRef" below.
2056 notes.rewriteMode::
2057         When copying notes during a rewrite (see the
2058         "notes.rewrite.<command>" option), determines what to do if
2059         the target commit already has a note.  Must be one of
2060         `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2061         Defaults to `concatenate`.
2063 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2064 environment variable.
2066 notes.rewriteRef::
2067         When copying notes during a rewrite, specifies the (fully
2068         qualified) ref whose notes should be copied.  The ref may be a
2069         glob, in which case notes in all matching refs will be copied.
2070         You may also specify this configuration several times.
2072 Does not have a default value; you must configure this variable to
2073 enable note rewriting.  Set it to `refs/notes/commits` to enable
2074 rewriting for the default commit notes.
2076 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2077 environment variable, which must be a colon separated list of refs or
2078 globs.
2080 pack.window::
2081         The size of the window used by linkgit:git-pack-objects[1] when no
2082         window size is given on the command line. Defaults to 10.
2084 pack.depth::
2085         The maximum delta depth used by linkgit:git-pack-objects[1] when no
2086         maximum depth is given on the command line. Defaults to 50.
2088 pack.windowMemory::
2089         The maximum size of memory that is consumed by each thread
2090         in linkgit:git-pack-objects[1] for pack window memory when
2091         no limit is given on the command line.  The value can be
2092         suffixed with "k", "m", or "g".  When left unconfigured (or
2093         set explicitly to 0), there will be no limit.
2095 pack.compression::
2096         An integer -1..9, indicating the compression level for objects
2097         in a pack file. -1 is the zlib default. 0 means no
2098         compression, and 1..9 are various speed/size tradeoffs, 9 being
2099         slowest.  If not set,  defaults to core.compression.  If that is
2100         not set,  defaults to -1, the zlib default, which is "a default
2101         compromise between speed and compression (currently equivalent
2102         to level 6)."
2104 Note that changing the compression level will not automatically recompress
2105 all existing objects. You can force recompression by passing the -F option
2106 to linkgit:git-repack[1].
2108 pack.deltaCacheSize::
2109         The maximum memory in bytes used for caching deltas in
2110         linkgit:git-pack-objects[1] before writing them out to a pack.
2111         This cache is used to speed up the writing object phase by not
2112         having to recompute the final delta result once the best match
2113         for all objects is found.  Repacking large repositories on machines
2114         which are tight with memory might be badly impacted by this though,
2115         especially if this cache pushes the system into swapping.
2116         A value of 0 means no limit. The smallest size of 1 byte may be
2117         used to virtually disable this cache. Defaults to 256 MiB.
2119 pack.deltaCacheLimit::
2120         The maximum size of a delta, that is cached in
2121         linkgit:git-pack-objects[1]. This cache is used to speed up the
2122         writing object phase by not having to recompute the final delta
2123         result once the best match for all objects is found. Defaults to 1000.
2125 pack.threads::
2126         Specifies the number of threads to spawn when searching for best
2127         delta matches.  This requires that linkgit:git-pack-objects[1]
2128         be compiled with pthreads otherwise this option is ignored with a
2129         warning. This is meant to reduce packing time on multiprocessor
2130         machines. The required amount of memory for the delta search window
2131         is however multiplied by the number of threads.
2132         Specifying 0 will cause Git to auto-detect the number of CPU's
2133         and set the number of threads accordingly.
2135 pack.indexVersion::
2136         Specify the default pack index version.  Valid values are 1 for
2137         legacy pack index used by Git versions prior to 1.5.2, and 2 for
2138         the new pack index with capabilities for packs larger than 4 GB
2139         as well as proper protection against the repacking of corrupted
2140         packs.  Version 2 is the default.  Note that version 2 is enforced
2141         and this config option ignored whenever the corresponding pack is
2142         larger than 2 GB.
2144 If you have an old Git that does not understand the version 2 `*.idx` file,
2145 cloning or fetching over a non native protocol (e.g. "http")
2146 that will copy both `*.pack` file and corresponding `*.idx` file from the
2147 other side may give you a repository that cannot be accessed with your
2148 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2149 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2150 the `*.idx` file.
2152 pack.packSizeLimit::
2153         The maximum size of a pack.  This setting only affects
2154         packing to a file when repacking, i.e. the git:// protocol
2155         is unaffected.  It can be overridden by the `--max-pack-size`
2156         option of linkgit:git-repack[1]. The minimum size allowed is
2157         limited to 1 MiB. The default is unlimited.
2158         Common unit suffixes of 'k', 'm', or 'g' are
2159         supported.
2161 pack.useBitmaps::
2162         When true, git will use pack bitmaps (if available) when packing
2163         to stdout (e.g., during the server side of a fetch). Defaults to
2164         true. You should not generally need to turn this off unless
2165         you are debugging pack bitmaps.
2167 pack.writeBitmaps (deprecated)::
2168         This is a deprecated synonym for `repack.writeBitmaps`.
2170 pack.writeBitmapHashCache::
2171         When true, git will include a "hash cache" section in the bitmap
2172         index (if one is written). This cache can be used to feed git's
2173         delta heuristics, potentially leading to better deltas between
2174         bitmapped and non-bitmapped objects (e.g., when serving a fetch
2175         between an older, bitmapped pack and objects that have been
2176         pushed since the last gc). The downside is that it consumes 4
2177         bytes per object of disk space, and that JGit's bitmap
2178         implementation does not understand it, causing it to complain if
2179         Git and JGit are used on the same repository. Defaults to false.
2181 pager.<cmd>::
2182         If the value is boolean, turns on or off pagination of the
2183         output of a particular Git subcommand when writing to a tty.
2184         Otherwise, turns on pagination for the subcommand using the
2185         pager specified by the value of `pager.<cmd>`.  If `--paginate`
2186         or `--no-pager` is specified on the command line, it takes
2187         precedence over this option.  To disable pagination for all
2188         commands, set `core.pager` or `GIT_PAGER` to `cat`.
2190 pretty.<name>::
2191         Alias for a --pretty= format string, as specified in
2192         linkgit:git-log[1]. Any aliases defined here can be used just
2193         as the built-in pretty formats could. For example,
2194         running `git config pretty.changelog "format:* %H %s"`
2195         would cause the invocation `git log --pretty=changelog`
2196         to be equivalent to running `git log "--pretty=format:* %H %s"`.
2197         Note that an alias with the same name as a built-in format
2198         will be silently ignored.
2200 pull.ff::
2201         By default, Git does not create an extra merge commit when merging
2202         a commit that is a descendant of the current commit. Instead, the
2203         tip of the current branch is fast-forwarded. When set to `false`,
2204         this variable tells Git to create an extra merge commit in such
2205         a case (equivalent to giving the `--no-ff` option from the command
2206         line). When set to `only`, only such fast-forward merges are
2207         allowed (equivalent to giving the `--ff-only` option from the
2208         command line). This setting overrides `merge.ff` when pulling.
2210 pull.rebase::
2211         When true, rebase branches on top of the fetched branch, instead
2212         of merging the default branch from the default remote when "git
2213         pull" is run. See "branch.<name>.rebase" for setting this on a
2214         per-branch basis.
2216 When preserve, also pass `--preserve-merges` along to 'git rebase'
2217 so that locally committed merge commits will not be flattened
2218 by running 'git pull'.
2220 When the value is `interactive`, the rebase is run in interactive mode.
2222 *NOTE*: this is a possibly dangerous operation; do *not* use
2223 it unless you understand the implications (see linkgit:git-rebase[1]
2224 for details).
2226 pull.octopus::
2227         The default merge strategy to use when pulling multiple branches
2228         at once.
2230 pull.twohead::
2231         The default merge strategy to use when pulling a single branch.
2233 push.default::
2234         Defines the action `git push` should take if no refspec is
2235         explicitly given.  Different values are well-suited for
2236         specific workflows; for instance, in a purely central workflow
2237         (i.e. the fetch source is equal to the push destination),
2238         `upstream` is probably what you want.  Possible values are:
2242 * `nothing` - do not push anything (error out) unless a refspec is
2243   explicitly given. This is primarily meant for people who want to
2244   avoid mistakes by always being explicit.
2246 * `current` - push the current branch to update a branch with the same
2247   name on the receiving end.  Works in both central and non-central
2248   workflows.
2250 * `upstream` - push the current branch back to the branch whose
2251   changes are usually integrated into the current branch (which is
2252   called `@{upstream}`).  This mode only makes sense if you are
2253   pushing to the same repository you would normally pull from
2254   (i.e. central workflow).
2256 * `simple` - in centralized workflow, work like `upstream` with an
2257   added safety to refuse to push if the upstream branch's name is
2258   different from the local one.
2260 When pushing to a remote that is different from the remote you normally
2261 pull from, work as `current`.  This is the safest option and is suited
2262 for beginners.
2264 This mode has become the default in Git 2.0.
2266 * `matching` - push all branches having the same name on both ends.
2267   This makes the repository you are pushing to remember the set of
2268   branches that will be pushed out (e.g. if you always push 'maint'
2269   and 'master' there and no other branches, the repository you push
2270   to will have these two branches, and your local 'maint' and
2271   'master' will be pushed there).
2273 To use this mode effectively, you have to make sure _all_ the
2274 branches you would push out are ready to be pushed out before
2275 running 'git push', as the whole point of this mode is to allow you
2276 to push all of the branches in one go.  If you usually finish work
2277 on only one branch and push out the result, while other branches are
2278 unfinished, this mode is not for you.  Also this mode is not
2279 suitable for pushing into a shared central repository, as other
2280 people may add new branches there, or update the tip of existing
2281 branches outside your control.
2283 This used to be the default, but not since Git 2.0 (`simple` is the
2284 new default).
2288 push.followTags::
2289         If set to true enable '--follow-tags' option by default.  You
2290         may override this configuration at time of push by specifying
2291         '--no-follow-tags'.
2293 push.gpgSign::
2294         May be set to a boolean value, or the string 'if-asked'. A true
2295         value causes all pushes to be GPG signed, as if '--signed' is
2296         passed to linkgit:git-push[1]. The string 'if-asked' causes
2297         pushes to be signed if the server supports it, as if
2298         '--signed=if-asked' is passed to 'git push'. A false value may
2299         override a value from a lower-priority config file. An explicit
2300         command-line flag always overrides this config option.
2302 push.recurseSubmodules::
2303         Make sure all submodule commits used by the revisions to be pushed
2304         are available on a remote-tracking branch. If the value is 'check'
2305         then Git will verify that all submodule commits that changed in the
2306         revisions to be pushed are available on at least one remote of the
2307         submodule. If any commits are missing, the push will be aborted and
2308         exit with non-zero status. If the value is 'on-demand' then all
2309         submodules that changed in the revisions to be pushed will be
2310         pushed. If on-demand was not able to push all necessary revisions
2311         it will also be aborted and exit with non-zero status. If the value
2312         is 'no' then default behavior of ignoring submodules when pushing
2313         is retained. You may override this configuration at time of push by
2314         specifying '--recurse-submodules=check|on-demand|no'.
2316 rebase.stat::
2317         Whether to show a diffstat of what changed upstream since the last
2318         rebase. False by default.
2320 rebase.autoSquash::
2321         If set to true enable '--autosquash' option by default.
2323 rebase.autoStash::
2324         When set to true, automatically create a temporary stash
2325         before the operation begins, and apply it after the operation
2326         ends.  This means that you can run rebase on a dirty worktree.
2327         However, use with care: the final stash application after a
2328         successful rebase might result in non-trivial conflicts.
2329         Defaults to false.
2331 rebase.missingCommitsCheck::
2332         If set to "warn", git rebase -i will print a warning if some
2333         commits are removed (e.g. a line was deleted), however the
2334         rebase will still proceed. If set to "error", it will print
2335         the previous warning and stop the rebase, 'git rebase
2336         --edit-todo' can then be used to correct the error. If set to
2337         "ignore", no checking is done.
2338         To drop a commit without warning or error, use the `drop`
2339         command in the todo-list.
2340         Defaults to "ignore".
2342 rebase.instructionFormat
2343         A format string, as specified in linkgit:git-log[1], to be used for
2344         the instruction list during an interactive rebase.  The format will automatically
2345         have the long commit hash prepended to the format.
2347 receive.advertiseAtomic::
2348         By default, git-receive-pack will advertise the atomic push
2349         capability to its clients. If you don't want to this capability
2350         to be advertised, set this variable to false.
2352 receive.autogc::
2353         By default, git-receive-pack will run "git-gc --auto" after
2354         receiving data from git-push and updating refs.  You can stop
2355         it by setting this variable to false.
2357 receive.certNonceSeed::
2358         By setting this variable to a string, `git receive-pack`
2359         will accept a `git push --signed` and verifies it by using
2360         a "nonce" protected by HMAC using this string as a secret
2361         key.
2363 receive.certNonceSlop::
2364         When a `git push --signed` sent a push certificate with a
2365         "nonce" that was issued by a receive-pack serving the same
2366         repository within this many seconds, export the "nonce"
2367         found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2368         hooks (instead of what the receive-pack asked the sending
2369         side to include).  This may allow writing checks in
2370         `pre-receive` and `post-receive` a bit easier.  Instead of
2371         checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2372         that records by how many seconds the nonce is stale to
2373         decide if they want to accept the certificate, they only
2374         can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2376 receive.fsckObjects::
2377         If it is set to true, git-receive-pack will check all received
2378         objects. It will abort in the case of a malformed object or a
2379         broken link. The result of an abort are only dangling objects.
2380         Defaults to false. If not set, the value of `transfer.fsckObjects`
2381         is used instead.
2383 receive.fsck.<msg-id>::
2384         When `receive.fsckObjects` is set to true, errors can be switched
2385         to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2386         setting where the `<msg-id>` is the fsck message ID and the value
2387         is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2388         the error/warning with the message ID, e.g. "missingEmail: invalid
2389         author/committer line - missing email" means that setting
2390         `receive.fsck.missingEmail = ignore` will hide that issue.
2392 This feature is intended to support working with legacy repositories
2393 which would not pass pushing when `receive.fsckObjects = true`, allowing
2394 the host to accept repositories with certain known issues but still catch
2395 other issues.
2397 receive.fsck.skipList::
2398         The path to a sorted list of object names (i.e. one SHA-1 per
2399         line) that are known to be broken in a non-fatal way and should
2400         be ignored. This feature is useful when an established project
2401         should be accepted despite early commits containing errors that
2402         can be safely ignored such as invalid committer email addresses.
2403         Note: corrupt objects cannot be skipped with this setting.
2405 receive.unpackLimit::
2406         If the number of objects received in a push is below this
2407         limit then the objects will be unpacked into loose object
2408         files. However if the number of received objects equals or
2409         exceeds this limit then the received pack will be stored as
2410         a pack, after adding any missing delta bases.  Storing the
2411         pack from a push can make the push operation complete faster,
2412         especially on slow filesystems.  If not set, the value of
2413         `transfer.unpackLimit` is used instead.
2415 receive.denyDeletes::
2416         If set to true, git-receive-pack will deny a ref update that deletes
2417         the ref. Use this to prevent such a ref deletion via a push.
2419 receive.denyDeleteCurrent::
2420         If set to true, git-receive-pack will deny a ref update that
2421         deletes the currently checked out branch of a non-bare repository.
2423 receive.denyCurrentBranch::
2424         If set to true or "refuse", git-receive-pack will deny a ref update
2425         to the currently checked out branch of a non-bare repository.
2426         Such a push is potentially dangerous because it brings the HEAD
2427         out of sync with the index and working tree. If set to "warn",
2428         print a warning of such a push to stderr, but allow the push to
2429         proceed. If set to false or "ignore", allow such pushes with no
2430         message. Defaults to "refuse".
2432 Another option is "updateInstead" which will update the working
2433 tree if pushing into the current branch.  This option is
2434 intended for synchronizing working directories when one side is not easily
2435 accessible via interactive ssh (e.g. a live web site, hence the requirement
2436 that the working directory be clean). This mode also comes in handy when
2437 developing inside a VM to test and fix code on different Operating Systems.
2439 By default, "updateInstead" will refuse the push if the working tree or
2440 the index have any difference from the HEAD, but the `push-to-checkout`
2441 hook can be used to customize this.  See linkgit:githooks[5].
2443 receive.denyNonFastForwards::
2444         If set to true, git-receive-pack will deny a ref update which is
2445         not a fast-forward. Use this to prevent such an update via a push,
2446         even if that push is forced. This configuration variable is
2447         set when initializing a shared repository.
2449 receive.hideRefs::
2450         This variable is the same as `transfer.hideRefs`, but applies
2451         only to `receive-pack` (and so affects pushes, but not fetches).
2452         An attempt to update or delete a hidden ref by `git push` is
2453         rejected.
2455 receive.updateServerInfo::
2456         If set to true, git-receive-pack will run git-update-server-info
2457         after receiving data from git-push and updating refs.
2459 receive.shallowUpdate::
2460         If set to true, .git/shallow can be updated when new refs
2461         require new shallow roots. Otherwise those refs are rejected.
2463 remote.pushDefault::
2464         The remote to push to by default.  Overrides
2465         `branch.<name>.remote` for all branches, and is overridden by
2466         `branch.<name>.pushRemote` for specific branches.
2468 remote.<name>.url::
2469         The URL of a remote repository.  See linkgit:git-fetch[1] or
2470         linkgit:git-push[1].
2472 remote.<name>.pushurl::
2473         The push URL of a remote repository.  See linkgit:git-push[1].
2475 remote.<name>.proxy::
2476         For remotes that require curl (http, https and ftp), the URL to
2477         the proxy to use for that remote.  Set to the empty string to
2478         disable proxying for that remote.
2480 remote.<name>.proxyAuthMethod::
2481         For remotes that require curl (http, https and ftp), the method to use for
2482         authenticating against the proxy in use (probably set in
2483         `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2485 remote.<name>.fetch::
2486         The default set of "refspec" for linkgit:git-fetch[1]. See
2487         linkgit:git-fetch[1].
2489 remote.<name>.push::
2490         The default set of "refspec" for linkgit:git-push[1]. See
2491         linkgit:git-push[1].
2493 remote.<name>.mirror::
2494         If true, pushing to this remote will automatically behave
2495         as if the `--mirror` option was given on the command line.
2497 remote.<name>.skipDefaultUpdate::
2498         If true, this remote will be skipped by default when updating
2499         using linkgit:git-fetch[1] or the `update` subcommand of
2500         linkgit:git-remote[1].
2502 remote.<name>.skipFetchAll::
2503         If true, this remote will be skipped by default when updating
2504         using linkgit:git-fetch[1] or the `update` subcommand of
2505         linkgit:git-remote[1].
2507 remote.<name>.receivepack::
2508         The default program to execute on the remote side when pushing.  See
2509         option --receive-pack of linkgit:git-push[1].
2511 remote.<name>.uploadpack::
2512         The default program to execute on the remote side when fetching.  See
2513         option --upload-pack of linkgit:git-fetch-pack[1].
2515 remote.<name>.tagOpt::
2516         Setting this value to --no-tags disables automatic tag following when
2517         fetching from remote <name>. Setting it to --tags will fetch every
2518         tag from remote <name>, even if they are not reachable from remote
2519         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2520         override this setting. See options --tags and --no-tags of
2521         linkgit:git-fetch[1].
2523 remote.<name>.vcs::
2524         Setting this to a value <vcs> will cause Git to interact with
2525         the remote with the git-remote-<vcs> helper.
2527 remote.<name>.prune::
2528         When set to true, fetching from this remote by default will also
2529         remove any remote-tracking references that no longer exist on the
2530         remote (as if the `--prune` option was given on the command line).
2531         Overrides `fetch.prune` settings, if any.
2533 remotes.<group>::
2534         The list of remotes which are fetched by "git remote update
2535         <group>".  See linkgit:git-remote[1].
2537 repack.useDeltaBaseOffset::
2538         By default, linkgit:git-repack[1] creates packs that use
2539         delta-base offset. If you need to share your repository with
2540         Git older than version 1.4.4, either directly or via a dumb
2541         protocol such as http, then you need to set this option to
2542         "false" and repack. Access from old Git versions over the
2543         native protocol are unaffected by this option.
2545 repack.packKeptObjects::
2546         If set to true, makes `git repack` act as if
2547         `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2548         details. Defaults to `false` normally, but `true` if a bitmap
2549         index is being written (either via `--write-bitmap-index` or
2550         `repack.writeBitmaps`).
2552 repack.writeBitmaps::
2553         When true, git will write a bitmap index when packing all
2554         objects to disk (e.g., when `git repack -a` is run).  This
2555         index can speed up the "counting objects" phase of subsequent
2556         packs created for clones and fetches, at the cost of some disk
2557         space and extra time spent on the initial repack.  Defaults to
2558         false.
2560 rerere.autoUpdate::
2561         When set to true, `git-rerere` updates the index with the
2562         resulting contents after it cleanly resolves conflicts using
2563         previously recorded resolution.  Defaults to false.
2565 rerere.enabled::
2566         Activate recording of resolved conflicts, so that identical
2567         conflict hunks can be resolved automatically, should they be
2568         encountered again.  By default, linkgit:git-rerere[1] is
2569         enabled if there is an `rr-cache` directory under the
2570         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2571         repository.
2573 sendemail.identity::
2574         A configuration identity. When given, causes values in the
2575         'sendemail.<identity>' subsection to take precedence over
2576         values in the 'sendemail' section. The default identity is
2577         the value of 'sendemail.identity'.
2579 sendemail.smtpEncryption::
2580         See linkgit:git-send-email[1] for description.  Note that this
2581         setting is not subject to the 'identity' mechanism.
2583 sendemail.smtpssl (deprecated)::
2584         Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2586 sendemail.smtpsslcertpath::
2587         Path to ca-certificates (either a directory or a single file).
2588         Set it to an empty string to disable certificate verification.
2590 sendemail.<identity>.*::
2591         Identity-specific versions of the 'sendemail.*' parameters
2592         found below, taking precedence over those when the this
2593         identity is selected, through command-line or
2594         'sendemail.identity'.
2596 sendemail.aliasesFile::
2597 sendemail.aliasFileType::
2598 sendemail.annotate::
2599 sendemail.bcc::
2600 sendemail.cc::
2601 sendemail.ccCmd::
2602 sendemail.chainReplyTo::
2603 sendemail.confirm::
2604 sendemail.envelopeSender::
2605 sendemail.from::
2606 sendemail.multiEdit::
2607 sendemail.signedoffbycc::
2608 sendemail.smtpPass::
2609 sendemail.suppresscc::
2610 sendemail.suppressFrom::
2611 sendemail.to::
2612 sendemail.smtpDomain::
2613 sendemail.smtpServer::
2614 sendemail.smtpServerPort::
2615 sendemail.smtpServerOption::
2616 sendemail.smtpUser::
2617 sendemail.thread::
2618 sendemail.transferEncoding::
2619 sendemail.validate::
2620 sendemail.xmailer::
2621         See linkgit:git-send-email[1] for description.
2623 sendemail.signedoffcc (deprecated)::
2624         Deprecated alias for 'sendemail.signedoffbycc'.
2626 showbranch.default::
2627         The default set of branches for linkgit:git-show-branch[1].
2628         See linkgit:git-show-branch[1].
2630 status.relativePaths::
2631         By default, linkgit:git-status[1] shows paths relative to the
2632         current directory. Setting this variable to `false` shows paths
2633         relative to the repository root (this was the default for Git
2634         prior to v1.5.4).
2636 status.short::
2637         Set to true to enable --short by default in linkgit:git-status[1].
2638         The option --no-short takes precedence over this variable.
2640 status.branch::
2641         Set to true to enable --branch by default in linkgit:git-status[1].
2642         The option --no-branch takes precedence over this variable.
2644 status.displayCommentPrefix::
2645         If set to true, linkgit:git-status[1] will insert a comment
2646         prefix before each output line (starting with
2647         `core.commentChar`, i.e. `#` by default). This was the
2648         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2649         Defaults to false.
2651 status.showUntrackedFiles::
2652         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2653         files which are not currently tracked by Git. Directories which
2654         contain only untracked files, are shown with the directory name
2655         only. Showing untracked files means that Git needs to lstat() all
2656         the files in the whole repository, which might be slow on some
2657         systems. So, this variable controls how the commands displays
2658         the untracked files. Possible values are:
2661 * `no` - Show no untracked files.
2662 * `normal` - Show untracked files and directories.
2663 * `all` - Show also individual files in untracked directories.
2666 If this variable is not specified, it defaults to 'normal'.
2667 This variable can be overridden with the -u|--untracked-files option
2668 of linkgit:git-status[1] and linkgit:git-commit[1].
2670 status.submoduleSummary::
2671         Defaults to false.
2672         If this is set to a non zero number or true (identical to -1 or an
2673         unlimited number), the submodule summary will be enabled and a
2674         summary of commits for modified submodules will be shown (see
2675         --summary-limit option of linkgit:git-submodule[1]). Please note
2676         that the summary output command will be suppressed for all
2677         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2678         for those submodules where `submodule.<name>.ignore=all`. The only
2679         exception to that rule is that status and commit will show staged
2680         submodule changes. To
2681         also view the summary for ignored submodules you can either use
2682         the --ignore-submodules=dirty command-line option or the 'git
2683         submodule summary' command, which shows a similar output but does
2684         not honor these settings.
2686 stash.showPatch::
2687         If this is set to true, the `git stash show` command without an
2688         option will show the stash in patch form.  Defaults to false.
2689         See description of 'show' command in linkgit:git-stash[1].
2691 stash.showStat::
2692         If this is set to true, the `git stash show` command without an
2693         option will show diffstat of the stash.  Defaults to true.
2694         See description of 'show' command in linkgit:git-stash[1].
2696 submodule.<name>.path::
2697 submodule.<name>.url::
2698         The path within this project and URL for a submodule. These
2699         variables are initially populated by 'git submodule init'. See
2700         linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2701         details.
2703 submodule.<name>.update::
2704         The default update procedure for a submodule. This variable
2705         is populated by `git submodule init` from the
2706         linkgit:gitmodules[5] file. See description of 'update'
2707         command in linkgit:git-submodule[1].
2709 submodule.<name>.branch::
2710         The remote branch name for a submodule, used by `git submodule
2711         update --remote`.  Set this option to override the value found in
2712         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2713         linkgit:gitmodules[5] for details.
2715 submodule.<name>.fetchRecurseSubmodules::
2716         This option can be used to control recursive fetching of this
2717         submodule. It can be overridden by using the --[no-]recurse-submodules
2718         command-line option to "git fetch" and "git pull".
2719         This setting will override that from in the linkgit:gitmodules[5]
2720         file.
2722 submodule.<name>.ignore::
2723         Defines under what circumstances "git status" and the diff family show
2724         a submodule as modified. When set to "all", it will never be considered
2725         modified (but it will nonetheless show up in the output of status and
2726         commit when it has been staged), "dirty" will ignore all changes
2727         to the submodules work tree and
2728         takes only differences between the HEAD of the submodule and the commit
2729         recorded in the superproject into account. "untracked" will additionally
2730         let submodules with modified tracked files in their work tree show up.
2731         Using "none" (the default when this option is not set) also shows
2732         submodules that have untracked files in their work tree as changed.
2733         This setting overrides any setting made in .gitmodules for this submodule,
2734         both settings can be overridden on the command line by using the
2735         "--ignore-submodules" option. The 'git submodule' commands are not
2736         affected by this setting.
2738 tag.sort::
2739         This variable controls the sort ordering of tags when displayed by
2740         linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2741         value of this variable will be used as the default.
2743 tar.umask::
2744         This variable can be used to restrict the permission bits of
2745         tar archive entries.  The default is 0002, which turns off the
2746         world write bit.  The special value "user" indicates that the
2747         archiving user's umask will be used instead.  See umask(2) and
2748         linkgit:git-archive[1].
2750 transfer.fsckObjects::
2751         When `fetch.fsckObjects` or `receive.fsckObjects` are
2752         not set, the value of this variable is used instead.
2753         Defaults to false.
2755 transfer.hideRefs::
2756         String(s) `receive-pack` and `upload-pack` use to decide which
2757         refs to omit from their initial advertisements.  Use more than
2758         one definition to specify multiple prefix strings. A ref that is
2759         under the hierarchies listed in the value of this variable is
2760         excluded, and is hidden when responding to `git push` or `git
2761         fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
2762         program-specific versions of this config.
2764 You may also include a `!` in front of the ref name to negate the entry,
2765 explicitly exposing it, even if an earlier entry marked it as hidden.
2766 If you have multiple hideRefs values, later entries override earlier ones
2767 (and entries in more-specific config files override less-specific ones).
2769 If a namespace is in use, the namespace prefix is stripped from each
2770 reference before it is matched against `transfer.hiderefs` patterns.
2771 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2772 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2773 is omitted from the advertisements but `refs/heads/master` and
2774 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2775 "have" lines. In order to match refs before stripping, add a `^` in front of
2776 the ref name. If you combine `!` and `^`, `!` must be specified first.
2778 transfer.unpackLimit::
2779         When `fetch.unpackLimit` or `receive.unpackLimit` are
2780         not set, the value of this variable is used instead.
2781         The default value is 100.
2783 uploadarchive.allowUnreachable::
2784         If true, allow clients to use `git archive --remote` to request
2785         any tree, whether reachable from the ref tips or not. See the
2786         discussion in the `SECURITY` section of
2787         linkgit:git-upload-archive[1] for more details. Defaults to
2788         `false`.
2790 uploadpack.hideRefs::
2791         This variable is the same as `transfer.hideRefs`, but applies
2792         only to `upload-pack` (and so affects only fetches, not pushes).
2793         An attempt to fetch a hidden ref by `git fetch` will fail.  See
2794         also `uploadpack.allowTipSHA1InWant`.
2796 uploadpack.allowTipSHA1InWant::
2797         When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2798         to accept a fetch request that asks for an object at the tip
2799         of a hidden ref (by default, such a request is rejected).
2800         see also `uploadpack.hideRefs`.
2802 uploadpack.allowReachableSHA1InWant::
2803         Allow `upload-pack` to accept a fetch request that asks for an
2804         object that is reachable from any ref tip. However, note that
2805         calculating object reachability is computationally expensive.
2806         Defaults to `false`.
2808 uploadpack.keepAlive::
2809         When `upload-pack` has started `pack-objects`, there may be a
2810         quiet period while `pack-objects` prepares the pack. Normally
2811         it would output progress information, but if `--quiet` was used
2812         for the fetch, `pack-objects` will output nothing at all until
2813         the pack data begins. Some clients and networks may consider
2814         the server to be hung and give up. Setting this option instructs
2815         `upload-pack` to send an empty keepalive packet every
2816         `uploadpack.keepAlive` seconds. Setting this option to 0
2817         disables keepalive packets entirely. The default is 5 seconds.
2819 url.<base>.insteadOf::
2820         Any URL that starts with this value will be rewritten to
2821         start, instead, with <base>. In cases where some site serves a
2822         large number of repositories, and serves them with multiple
2823         access methods, and some users need to use different access
2824         methods, this feature allows people to specify any of the
2825         equivalent URLs and have Git automatically rewrite the URL to
2826         the best alternative for the particular user, even for a
2827         never-before-seen repository on the site.  When more than one
2828         insteadOf strings match a given URL, the longest match is used.
2830 url.<base>.pushInsteadOf::
2831         Any URL that starts with this value will not be pushed to;
2832         instead, it will be rewritten to start with <base>, and the
2833         resulting URL will be pushed to. In cases where some site serves
2834         a large number of repositories, and serves them with multiple
2835         access methods, some of which do not allow push, this feature
2836         allows people to specify a pull-only URL and have Git
2837         automatically use an appropriate URL to push, even for a
2838         never-before-seen repository on the site.  When more than one
2839         pushInsteadOf strings match a given URL, the longest match is
2840         used.  If a remote has an explicit pushurl, Git will ignore this
2841         setting for that remote.
2843 user.email::
2844         Your email address to be recorded in any newly created commits.
2845         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2846         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2848 user.name::
2849         Your full name to be recorded in any newly created commits.
2850         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2851         environment variables.  See linkgit:git-commit-tree[1].
2853 user.useConfigOnly::
2854         Instruct Git to avoid trying to guess defaults for 'user.email'
2855         and 'user.name', and instead retrieve the values only from the
2856         configuration. For example, if you have multiple email addresses
2857         and would like to use a different one for each repository, then
2858         with this configuration option set to `true` in the global config
2859         along with a name, Git will prompt you to set up an email before
2860         making new commits in a newly cloned repository.
2861         Defaults to `false`.
2863 user.signingKey::
2864         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2865         key you want it to automatically when creating a signed tag or
2866         commit, you can override the default selection with this variable.
2867         This option is passed unchanged to gpg's --local-user parameter,
2868         so you may specify a key using any method that gpg supports.
2870 versionsort.prereleaseSuffix::
2871         When version sort is used in linkgit:git-tag[1], prerelease
2872         tags (e.g. "1.0-rc1") may appear after the main release
2873         "1.0". By specifying the suffix "-rc" in this variable,
2874         "1.0-rc1" will appear before "1.0".
2876 This variable can be specified multiple times, once per suffix. The
2877 order of suffixes in the config file determines the sorting order
2878 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2879 is sorted before 1.0-rcXX). The sorting order between different
2880 suffixes is undefined if they are in multiple config files.
2882 web.browser::
2883         Specify a web browser that may be used by some commands.
2884         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2885         may use it.