Merge branch 'master' of git://repo.or.cz/alt-git
[git/mingw.git] / Documentation / config.txt
blob391a0c3c857081e0509ea5a1b2ac085e79439d8f
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.ignoreCase::
273         If true, this option enables various workarounds to enable
274         Git to work better on filesystems that are not case sensitive,
275         like FAT. For example, if a directory listing finds
276         "makefile" when Git expects "Makefile", Git will assume
277         it is really the same file, and continue to remember it as
278         "Makefile".
280 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
281 will probe and set core.ignoreCase true if appropriate when the repository
282 is created.
284 core.precomposeUnicode::
285         This option is only used by Mac OS implementation of Git.
286         When core.precomposeUnicode=true, Git reverts the unicode decomposition
287         of filenames done by Mac OS. This is useful when sharing a repository
288         between Mac OS and Linux or Windows.
289         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290         When false, file names are handled fully transparent by Git,
291         which is backward compatible with older versions of Git.
293 core.protectHFS::
294         If set to true, do not allow checkout of paths that would
295         be considered equivalent to `.git` on an HFS+ filesystem.
296         Defaults to `true` on Mac OS, and `false` elsewhere.
298 core.protectNTFS::
299         If set to true, do not allow checkout of paths that would
300         cause problems with the NTFS filesystem, e.g. conflict with
301         8.3 "short" names.
302         Defaults to `true` on Windows, and `false` elsewhere.
304 core.trustctime::
305         If false, the ctime differences between the index and the
306         working tree are ignored; useful when the inode change time
307         is regularly modified by something outside Git (file system
308         crawlers and some backup systems).
309         See linkgit:git-update-index[1]. True by default.
311 core.checkStat::
312         Determines which stat fields to match between the index
313         and work tree. The user can set this to 'default' or
314         'minimal'. Default (or explicitly 'default'), is to check
315         all fields, including the sub-second part of mtime and ctime.
317 core.quotePath::
318         The commands that output paths (e.g. 'ls-files',
319         'diff'), when not given the `-z` option, will quote
320         "unusual" characters in the pathname by enclosing the
321         pathname in a double-quote pair and with backslashes the
322         same way strings in C source code are quoted.  If this
323         variable is set to false, the bytes higher than 0x80 are
324         not quoted but output as verbatim.  Note that double
325         quote, backslash and control characters are always
326         quoted without `-z` regardless of the setting of this
327         variable.
329 core.eol::
330         Sets the line ending type to use in the working directory for
331         files that have the `text` property set.  Alternatives are
332         'lf', 'crlf' and 'native', which uses the platform's native
333         line ending.  The default value is `native`.  See
334         linkgit:gitattributes[5] for more information on end-of-line
335         conversion.
337 core.safecrlf::
338         If true, makes Git check if converting `CRLF` is reversible when
339         end-of-line conversion is active.  Git will verify if a command
340         modifies a file in the work tree either directly or indirectly.
341         For example, committing a file followed by checking out the
342         same file should yield the original file in the work tree.  If
343         this is not the case for the current setting of
344         `core.autocrlf`, Git will reject the file.  The variable can
345         be set to "warn", in which case Git will only warn about an
346         irreversible conversion but continue the operation.
348 CRLF conversion bears a slight chance of corrupting data.
349 When it is enabled, Git will convert CRLF to LF during commit and LF to
350 CRLF during checkout.  A file that contains a mixture of LF and
351 CRLF before the commit cannot be recreated by Git.  For text
352 files this is the right thing to do: it corrects line endings
353 such that we have only LF line endings in the repository.
354 But for binary files that are accidentally classified as text the
355 conversion can corrupt data.
357 If you recognize such corruption early you can easily fix it by
358 setting the conversion type explicitly in .gitattributes.  Right
359 after committing you still have the original file in your work
360 tree and this file is not yet corrupted.  You can explicitly tell
361 Git that this file is binary and Git will handle the file
362 appropriately.
364 Unfortunately, the desired effect of cleaning up text files with
365 mixed line endings and the undesired effect of corrupting binary
366 files cannot be distinguished.  In both cases CRLFs are removed
367 in an irreversible way.  For text files this is the right thing
368 to do because CRLFs are line endings, while for binary files
369 converting CRLFs corrupts data.
371 Note, this safety check does not mean that a checkout will generate a
372 file identical to the original file for a different setting of
373 `core.eol` and `core.autocrlf`, but only for the current one.  For
374 example, a text file with `LF` would be accepted with `core.eol=lf`
375 and could later be checked out with `core.eol=crlf`, in which case the
376 resulting file would contain `CRLF`, although the original file
377 contained `LF`.  However, in both work trees the line endings would be
378 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
379 file with mixed line endings would be reported by the `core.safecrlf`
380 mechanism.
382 core.autocrlf::
383         Setting this variable to "true" is almost the same as setting
384         the `text` attribute to "auto" on all files except that text
385         files are not guaranteed to be normalized: files that contain
386         `CRLF` in the repository will not be touched.  Use this
387         setting if you want to have `CRLF` line endings in your
388         working directory even though the repository does not have
389         normalized line endings.  This variable can be set to 'input',
390         in which case no output conversion is performed.
392 core.symlinks::
393         If false, symbolic links are checked out as small plain files that
394         contain the link text. linkgit:git-update-index[1] and
395         linkgit:git-add[1] will not change the recorded type to regular
396         file. Useful on filesystems like FAT that do not support
397         symbolic links.
399 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
400 will probe and set core.symlinks false if appropriate when the repository
401 is created.
403 core.gitProxy::
404         A "proxy command" to execute (as 'command host port') instead
405         of establishing direct connection to the remote server when
406         using the Git protocol for fetching. If the variable value is
407         in the "COMMAND for DOMAIN" format, the command is applied only
408         on hostnames ending with the specified domain string. This variable
409         may be set multiple times and is matched in the given order;
410         the first match wins.
412 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413 (which always applies universally, without the special "for"
414 handling).
416 The special string `none` can be used as the proxy command to
417 specify that no proxy be used for a given domain pattern.
418 This is useful for excluding servers inside a firewall from
419 proxy use, while defaulting to a common proxy for external domains.
421 core.ignoreStat::
422         If true, Git will avoid using lstat() calls to detect if files have
423         changed by setting the "assume-unchanged" bit for those tracked files
424         which it has updated identically in both the index and working tree.
426 When files are modified outside of Git, the user will need to stage
427 the modified files explicitly (e.g. see 'Examples' section in
428 linkgit:git-update-index[1]).
429 Git will not normally detect changes to those files.
431 This is useful on systems where lstat() calls are very slow, such as
432 CIFS/Microsoft Windows.
434 False by default.
436 core.preferSymlinkRefs::
437         Instead of the default "symref" format for HEAD
438         and other symbolic reference files, use symbolic links.
439         This is sometimes needed to work with old scripts that
440         expect HEAD to be a symbolic link.
442 core.bare::
443         If true this repository is assumed to be 'bare' and has no
444         working directory associated with it.  If this is the case a
445         number of commands that require a working directory will be
446         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
448 This setting is automatically guessed by linkgit:git-clone[1] or
449 linkgit:git-init[1] when the repository was created.  By default a
450 repository that ends in "/.git" is assumed to be not bare (bare =
451 false), while all other repositories are assumed to be bare (bare
452 = true).
454 core.worktree::
455         Set the path to the root of the working tree.
456         If GIT_COMMON_DIR environment variable is set, core.worktree
457         is ignored and not used for determining the root of working tree.
458         This can be overridden by the GIT_WORK_TREE environment
459         variable and the '--work-tree' command-line option.
460         The value can be an absolute path or relative to the path to
461         the .git directory, which is either specified by --git-dir
462         or GIT_DIR, or automatically discovered.
463         If --git-dir or GIT_DIR is specified but none of
464         --work-tree, GIT_WORK_TREE and core.worktree is specified,
465         the current working directory is regarded as the top level
466         of your working tree.
468 Note that this variable is honored even when set in a configuration
469 file in a ".git" subdirectory of a directory and its value differs
470 from the latter directory (e.g. "/path/to/.git/config" has
471 core.worktree set to "/different/path"), which is most likely a
472 misconfiguration.  Running Git commands in the "/path/to" directory will
473 still use "/different/path" as the root of the work tree and can cause
474 confusion unless you know what you are doing (e.g. you are creating a
475 read-only snapshot of the same index to a location different from the
476 repository's usual working tree).
478 core.logAllRefUpdates::
479         Enable the reflog. Updates to a ref <ref> is logged to the file
480         "$GIT_DIR/logs/<ref>", by appending the new and old
481         SHA-1, the date/time and the reason of the update, but
482         only when the file exists.  If this configuration
483         variable is set to true, missing "$GIT_DIR/logs/<ref>"
484         file is automatically created for branch heads (i.e. under
485         refs/heads/), remote refs (i.e. under refs/remotes/),
486         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
488 This information can be used to determine what commit
489 was the tip of a branch "2 days ago".
491 This value is true by default in a repository that has
492 a working directory associated with it, and false by
493 default in a bare repository.
495 core.repositoryFormatVersion::
496         Internal variable identifying the repository format and layout
497         version.
499 core.sharedRepository::
500         When 'group' (or 'true'), the repository is made shareable between
501         several users in a group (making sure all the files and objects are
502         group-writable). When 'all' (or 'world' or 'everybody'), the
503         repository will be readable by all users, additionally to being
504         group-shareable. When 'umask' (or 'false'), Git will use permissions
505         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
506         files in the repository will have this mode value. '0xxx' will override
507         user's umask value (whereas the other options will only override
508         requested parts of the user's umask value). Examples: '0660' will make
509         the repo read/write-able for the owner and group, but inaccessible to
510         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
511         repository that is group-readable but not group-writable.
512         See linkgit:git-init[1]. False by default.
514 core.warnAmbiguousRefs::
515         If true, Git will warn you if the ref name you passed it is ambiguous
516         and might match multiple refs in the repository. True by default.
518 core.compression::
519         An integer -1..9, indicating a default compression level.
520         -1 is the zlib default. 0 means no compression,
521         and 1..9 are various speed/size tradeoffs, 9 being slowest.
522         If set, this provides a default to other compression variables,
523         such as 'core.looseCompression' and 'pack.compression'.
525 core.looseCompression::
526         An integer -1..9, indicating the compression level for objects that
527         are not in a pack file. -1 is the zlib default. 0 means no
528         compression, and 1..9 are various speed/size tradeoffs, 9 being
529         slowest.  If not set,  defaults to core.compression.  If that is
530         not set,  defaults to 1 (best speed).
532 core.packedGitWindowSize::
533         Number of bytes of a pack file to map into memory in a
534         single mapping operation.  Larger window sizes may allow
535         your system to process a smaller number of large pack files
536         more quickly.  Smaller window sizes will negatively affect
537         performance due to increased calls to the operating system's
538         memory manager, but may improve performance when accessing
539         a large number of large pack files.
541 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
542 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
543 be reasonable for all users/operating systems.  You probably do
544 not need to adjust this value.
546 Common unit suffixes of 'k', 'm', or 'g' are supported.
548 core.packedGitLimit::
549         Maximum number of bytes to map simultaneously into memory
550         from pack files.  If Git needs to access more than this many
551         bytes at once to complete an operation it will unmap existing
552         regions to reclaim virtual address space within the process.
554 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
555 This should be reasonable for all users/operating systems, except on
556 the largest projects.  You probably do not need to adjust this value.
558 Common unit suffixes of 'k', 'm', or 'g' are supported.
560 core.deltaBaseCacheLimit::
561         Maximum number of bytes to reserve for caching base objects
562         that may be referenced by multiple deltified objects.  By storing the
563         entire decompressed base objects in a cache Git is able
564         to avoid unpacking and decompressing frequently used base
565         objects multiple times.
567 Default is 96 MiB on all platforms.  This should be reasonable
568 for all users/operating systems, except on the largest projects.
569 You probably do not need to adjust this value.
571 Common unit suffixes of 'k', 'm', or 'g' are supported.
573 core.bigFileThreshold::
574         Files larger than this size are stored deflated, without
575         attempting delta compression.  Storing large files without
576         delta compression avoids excessive memory usage, at the
577         slight expense of increased disk usage. Additionally files
578         larger than this size are always treated as binary.
580 Default is 512 MiB on all platforms.  This should be reasonable
581 for most projects as source code and other text files can still
582 be delta compressed, but larger binary media files won't be.
584 Common unit suffixes of 'k', 'm', or 'g' are supported.
586 core.excludesFile::
587         In addition to '.gitignore' (per-directory) and
588         '.git/info/exclude', Git looks into this file for patterns
589         of files which are not meant to be tracked.  "`~/`" is expanded
590         to the value of `$HOME` and "`~user/`" to the specified user's
591         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
592         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
593         is used instead. See linkgit:gitignore[5].
595 core.askPass::
596         Some commands (e.g. svn and http interfaces) that interactively
597         ask for a password can be told to use an external program given
598         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
599         environment variable. If not set, fall back to the value of the
600         'SSH_ASKPASS' environment variable or, failing that, a simple password
601         prompt. The external program shall be given a suitable prompt as
602         command-line argument and write the password on its STDOUT.
604 core.attributesFile::
605         In addition to '.gitattributes' (per-directory) and
606         '.git/info/attributes', Git looks into this file for attributes
607         (see linkgit:gitattributes[5]). Path expansions are made the same
608         way as for `core.excludesFile`. Its default value is
609         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
610         set or empty, $HOME/.config/git/attributes is used instead.
612 core.editor::
613         Commands such as `commit` and `tag` that lets you edit
614         messages by launching an editor uses the value of this
615         variable when it is set, and the environment variable
616         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
618 core.commentChar::
619         Commands such as `commit` and `tag` that lets you edit
620         messages consider a line that begins with this character
621         commented, and removes them after the editor returns
622         (default '#').
624 If set to "auto", `git-commit` would select a character that is not
625 the beginning character of any line in existing commit messages.
627 core.packedRefsTimeout::
628         The length of time, in milliseconds, to retry when trying to
629         lock the `packed-refs` file. Value 0 means not to retry at
630         all; -1 means to try indefinitely. Default is 1000 (i.e.,
631         retry for 1 second).
633 sequence.editor::
634         Text editor used by `git rebase -i` for editing the rebase instruction file.
635         The value is meant to be interpreted by the shell when it is used.
636         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
637         When not configured the default commit message editor is used instead.
639 core.pager::
640         Text viewer for use by Git commands (e.g., 'less').  The value
641         is meant to be interpreted by the shell.  The order of preference
642         is the `$GIT_PAGER` environment variable, then `core.pager`
643         configuration, then `$PAGER`, and then the default chosen at
644         compile time (usually 'less').
646 When the `LESS` environment variable is unset, Git sets it to `FRX`
647 (if `LESS` environment variable is set, Git does not change it at
648 all).  If you want to selectively override Git's default setting
649 for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
650 be passed to the shell by Git, which will translate the final
651 command to `LESS=FRX less -S`. The environment does not set the
652 `S` option but the command line does, instructing less to truncate
653 long lines. Similarly, setting `core.pager` to `less -+F` will
654 deactivate the `F` option specified by the environment from the
655 command-line, deactivating the "quit if one screen" behavior of
656 `less`.  One can specifically activate some flags for particular
657 commands: for example, setting `pager.blame` to `less -S` enables
658 line truncation only for `git blame`.
660 Likewise, when the `LV` environment variable is unset, Git sets it
661 to `-c`.  You can override this setting by exporting `LV` with
662 another value or setting `core.pager` to `lv +c`.
664 core.whitespace::
665         A comma separated list of common whitespace problems to
666         notice.  'git diff' will use `color.diff.whitespace` to
667         highlight them, and 'git apply --whitespace=error' will
668         consider them as errors.  You can prefix `-` to disable
669         any of them (e.g. `-trailing-space`):
671 * `blank-at-eol` treats trailing whitespaces at the end of the line
672   as an error (enabled by default).
673 * `space-before-tab` treats a space character that appears immediately
674   before a tab character in the initial indent part of the line as an
675   error (enabled by default).
676 * `indent-with-non-tab` treats a line that is indented with space
677   characters instead of the equivalent tabs as an error (not enabled by
678   default).
679 * `tab-in-indent` treats a tab character in the initial indent part of
680   the line as an error (not enabled by default).
681 * `blank-at-eof` treats blank lines added at the end of file as an error
682   (enabled by default).
683 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
684   `blank-at-eof`.
685 * `cr-at-eol` treats a carriage-return at the end of line as
686   part of the line terminator, i.e. with it, `trailing-space`
687   does not trigger if the character before such a carriage-return
688   is not a whitespace (not enabled by default).
689 * `tabwidth=<n>` tells how many character positions a tab occupies; this
690   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
691   errors. The default tab width is 8. Allowed values are 1 to 63.
693 core.fsyncObjectFiles::
694         This boolean will enable 'fsync()' when writing object files.
696 This is a total waste of time and effort on a filesystem that orders
697 data writes properly, but can be useful for filesystems that do not use
698 journalling (traditional UNIX filesystems) or that only journal metadata
699 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
701 core.preloadIndex::
702         Enable parallel index preload for operations like 'git diff'
704 This can speed up operations like 'git diff' and 'git status' especially
705 on filesystems like NFS that have weak caching semantics and thus
706 relatively high IO latencies.  When enabled, Git will do the
707 index comparison to the filesystem data in parallel, allowing
708 overlapping IO's.  Defaults to true.
710 core.createObject::
711         You can set this to 'link', in which case a hardlink followed by
712         a delete of the source are used to make sure that object creation
713         will not overwrite existing objects.
715 On some file system/operating system combinations, this is unreliable.
716 Set this config setting to 'rename' there; However, This will remove the
717 check that makes sure that existing object files will not get overwritten.
719 core.notesRef::
720         When showing commit messages, also show notes which are stored in
721         the given ref.  The ref must be fully qualified.  If the given
722         ref does not exist, it is not an error but means that no
723         notes should be printed.
725 This setting defaults to "refs/notes/commits", and it can be overridden by
726 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
728 core.sparseCheckout::
729         Enable "sparse checkout" feature. See section "Sparse checkout" in
730         linkgit:git-read-tree[1] for more information.
732 core.abbrev::
733         Set the length object names are abbreviated to.  If unspecified,
734         many commands abbreviate to 7 hexdigits, which may not be enough
735         for abbreviated object names to stay unique for sufficiently long
736         time.
738 add.ignoreErrors::
739 add.ignore-errors (deprecated)::
740         Tells 'git add' to continue adding files when some files cannot be
741         added due to indexing errors. Equivalent to the '--ignore-errors'
742         option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
743         as it does not follow the usual naming convention for configuration
744         variables.
746 alias.*::
747         Command aliases for the linkgit:git[1] command wrapper - e.g.
748         after defining "alias.last = cat-file commit HEAD", the invocation
749         "git last" is equivalent to "git cat-file commit HEAD". To avoid
750         confusion and troubles with script usage, aliases that
751         hide existing Git commands are ignored. Arguments are split by
752         spaces, the usual shell quoting and escaping is supported.
753         A quote pair or a backslash can be used to quote them.
755 If the alias expansion is prefixed with an exclamation point,
756 it will be treated as a shell command.  For example, defining
757 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
758 "git new" is equivalent to running the shell command
759 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
760 executed from the top-level directory of a repository, which may
761 not necessarily be the current directory.
762 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
763 from the original current directory. See linkgit:git-rev-parse[1].
765 am.keepcr::
766         If true, git-am will call git-mailsplit for patches in mbox format
767         with parameter '--keep-cr'. In this case git-mailsplit will
768         not remove `\r` from lines ending with `\r\n`. Can be overridden
769         by giving '--no-keep-cr' from the command line.
770         See linkgit:git-am[1], linkgit:git-mailsplit[1].
772 am.threeWay::
773         By default, `git am` will fail if the patch does not apply cleanly. When
774         set to true, this setting tells `git am` to fall back on 3-way merge if
775         the patch records the identity of blobs it is supposed to apply to and
776         we have those blobs available locally (equivalent to giving the `--3way`
777         option from the command line). Defaults to `false`.
778         See linkgit:git-am[1].
780 apply.ignoreWhitespace::
781         When set to 'change', tells 'git apply' to ignore changes in
782         whitespace, in the same way as the '--ignore-space-change'
783         option.
784         When set to one of: no, none, never, false tells 'git apply' to
785         respect all whitespace differences.
786         See linkgit:git-apply[1].
788 apply.whitespace::
789         Tells 'git apply' how to handle whitespaces, in the same way
790         as the '--whitespace' option. See linkgit:git-apply[1].
792 branch.autoSetupMerge::
793         Tells 'git branch' and 'git checkout' to set up new branches
794         so that linkgit:git-pull[1] will appropriately merge from the
795         starting point branch. Note that even if this option is not set,
796         this behavior can be chosen per-branch using the `--track`
797         and `--no-track` options. The valid settings are: `false` -- no
798         automatic setup is done; `true` -- automatic setup is done when the
799         starting point is a remote-tracking branch; `always` --
800         automatic setup is done when the starting point is either a
801         local branch or remote-tracking
802         branch. This option defaults to true.
804 branch.autoSetupRebase::
805         When a new branch is created with 'git branch' or 'git checkout'
806         that tracks another branch, this variable tells Git to set
807         up pull to rebase instead of merge (see "branch.<name>.rebase").
808         When `never`, rebase is never automatically set to true.
809         When `local`, rebase is set to true for tracked branches of
810         other local branches.
811         When `remote`, rebase is set to true for tracked branches of
812         remote-tracking branches.
813         When `always`, rebase will be set to true for all tracking
814         branches.
815         See "branch.autoSetupMerge" for details on how to set up a
816         branch to track another branch.
817         This option defaults to never.
819 branch.<name>.remote::
820         When on branch <name>, it tells 'git fetch' and 'git push'
821         which remote to fetch from/push to.  The remote to push to
822         may be overridden with `remote.pushDefault` (for all branches).
823         The remote to push to, for the current branch, may be further
824         overridden by `branch.<name>.pushRemote`.  If no remote is
825         configured, or if you are not on any branch, it defaults to
826         `origin` for fetching and `remote.pushDefault` for pushing.
827         Additionally, `.` (a period) is the current local repository
828         (a dot-repository), see `branch.<name>.merge`'s final note below.
830 branch.<name>.pushRemote::
831         When on branch <name>, it overrides `branch.<name>.remote` for
832         pushing.  It also overrides `remote.pushDefault` for pushing
833         from branch <name>.  When you pull from one place (e.g. your
834         upstream) and push to another place (e.g. your own publishing
835         repository), you would want to set `remote.pushDefault` to
836         specify the remote to push to for all branches, and use this
837         option to override it for a specific branch.
839 branch.<name>.merge::
840         Defines, together with branch.<name>.remote, the upstream branch
841         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
842         branch to merge and can also affect 'git push' (see push.default).
843         When in branch <name>, it tells 'git fetch' the default
844         refspec to be marked for merging in FETCH_HEAD. The value is
845         handled like the remote part of a refspec, and must match a
846         ref which is fetched from the remote given by
847         "branch.<name>.remote".
848         The merge information is used by 'git pull' (which at first calls
849         'git fetch') to lookup the default branch for merging. Without
850         this option, 'git pull' defaults to merge the first refspec fetched.
851         Specify multiple values to get an octopus merge.
852         If you wish to setup 'git pull' so that it merges into <name> from
853         another branch in the local repository, you can point
854         branch.<name>.merge to the desired branch, and use the relative path
855         setting `.` (a period) for branch.<name>.remote.
857 branch.<name>.mergeOptions::
858         Sets default options for merging into branch <name>. The syntax and
859         supported options are the same as those of linkgit:git-merge[1], but
860         option values containing whitespace characters are currently not
861         supported.
863 branch.<name>.rebase::
864         When true, rebase the branch <name> on top of the fetched branch,
865         instead of merging the default branch from the default remote when
866         "git pull" is run. See "pull.rebase" for doing this in a non
867         branch-specific manner.
869 When preserve, also pass `--preserve-merges` along to 'git rebase'
870 so that locally committed merge commits will not be flattened
871 by running 'git pull'.
873 *NOTE*: this is a possibly dangerous operation; do *not* use
874 it unless you understand the implications (see linkgit:git-rebase[1]
875 for details).
877 branch.<name>.description::
878         Branch description, can be edited with
879         `git branch --edit-description`. Branch description is
880         automatically added in the format-patch cover letter or
881         request-pull summary.
883 browser.<tool>.cmd::
884         Specify the command to invoke the specified browser. The
885         specified command is evaluated in shell with the URLs passed
886         as arguments. (See linkgit:git-web{litdd}browse[1].)
888 browser.<tool>.path::
889         Override the path for the given tool that may be used to
890         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
891         working repository in gitweb (see linkgit:git-instaweb[1]).
893 clean.requireForce::
894         A boolean to make git-clean do nothing unless given -f,
895         -i or -n.   Defaults to true.
897 color.branch::
898         A boolean to enable/disable color in the output of
899         linkgit:git-branch[1]. May be set to `always`,
900         `false` (or `never`) or `auto` (or `true`), in which case colors are used
901         only when the output is to a terminal. Defaults to false.
903 color.branch.<slot>::
904         Use customized color for branch coloration. `<slot>` is one of
905         `current` (the current branch), `local` (a local branch),
906         `remote` (a remote-tracking branch in refs/remotes/),
907         `upstream` (upstream tracking branch), `plain` (other
908         refs).
910 color.diff::
911         Whether to use ANSI escape sequences to add color to patches.
912         If this is set to `always`, linkgit:git-diff[1],
913         linkgit:git-log[1], and linkgit:git-show[1] will use color
914         for all patches.  If it is set to `true` or `auto`, those
915         commands will only use color when output is to the terminal.
916         Defaults to false.
918 This does not affect linkgit:git-format-patch[1] or the
919 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
920 command line with the `--color[=<when>]` option.
922 color.diff.<slot>::
923         Use customized color for diff colorization.  `<slot>` specifies
924         which part of the patch to use the specified color, and is one
925         of `context` (context text - `plain` is a historical synonym),
926         `meta` (metainformation), `frag`
927         (hunk header), 'func' (function in hunk header), `old` (removed lines),
928         `new` (added lines), `commit` (commit headers), or `whitespace`
929         (highlighting whitespace errors).
931 color.decorate.<slot>::
932         Use customized color for 'git log --decorate' output.  `<slot>` is one
933         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
934         branches, remote-tracking branches, tags, stash and HEAD, respectively.
936 color.grep::
937         When set to `always`, always highlight matches.  When `false` (or
938         `never`), never.  When set to `true` or `auto`, use color only
939         when the output is written to the terminal.  Defaults to `false`.
941 color.grep.<slot>::
942         Use customized color for grep colorization.  `<slot>` specifies which
943         part of the line to use the specified color, and is one of
946 `context`;;
947         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
948 `filename`;;
949         filename prefix (when not using `-h`)
950 `function`;;
951         function name lines (when using `-p`)
952 `linenumber`;;
953         line number prefix (when using `-n`)
954 `match`;;
955         matching text (same as setting `matchContext` and `matchSelected`)
956 `matchContext`;;
957         matching text in context lines
958 `matchSelected`;;
959         matching text in selected lines
960 `selected`;;
961         non-matching text in selected lines
962 `separator`;;
963         separators between fields on a line (`:`, `-`, and `=`)
964         and between hunks (`--`)
967 color.interactive::
968         When set to `always`, always use colors for interactive prompts
969         and displays (such as those used by "git-add --interactive" and
970         "git-clean --interactive"). When false (or `never`), never.
971         When set to `true` or `auto`, use colors only when the output is
972         to the terminal. Defaults to false.
974 color.interactive.<slot>::
975         Use customized color for 'git add --interactive' and 'git clean
976         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
977         or `error`, for four distinct types of normal output from
978         interactive commands.
980 color.pager::
981         A boolean to enable/disable colored output when the pager is in
982         use (default is true).
984 color.showBranch::
985         A boolean to enable/disable color in the output of
986         linkgit:git-show-branch[1]. May be set to `always`,
987         `false` (or `never`) or `auto` (or `true`), in which case colors are used
988         only when the output is to a terminal. Defaults to false.
990 color.status::
991         A boolean to enable/disable color in the output of
992         linkgit:git-status[1]. May be set to `always`,
993         `false` (or `never`) or `auto` (or `true`), in which case colors are used
994         only when the output is to a terminal. Defaults to false.
996 color.status.<slot>::
997         Use customized color for status colorization. `<slot>` is
998         one of `header` (the header text of the status message),
999         `added` or `updated` (files which are added but not committed),
1000         `changed` (files which are changed but not added in the index),
1001         `untracked` (files which are not tracked by Git),
1002         `branch` (the current branch),
1003         `nobranch` (the color the 'no branch' warning is shown in, defaulting
1004         to red), or
1005         `unmerged` (files which have unmerged changes).
1007 color.ui::
1008         This variable determines the default value for variables such
1009         as `color.diff` and `color.grep` that control the use of color
1010         per command family. Its scope will expand as more commands learn
1011         configuration to set a default for the `--color` option.  Set it
1012         to `false` or `never` if you prefer Git commands not to use
1013         color unless enabled explicitly with some other configuration
1014         or the `--color` option. Set it to `always` if you want all
1015         output not intended for machine consumption to use color, to
1016         `true` or `auto` (this is the default since Git 1.8.4) if you
1017         want such output to use color when written to the terminal.
1019 column.ui::
1020         Specify whether supported commands should output in columns.
1021         This variable consists of a list of tokens separated by spaces
1022         or commas:
1024 These options control when the feature should be enabled
1025 (defaults to 'never'):
1028 `always`;;
1029         always show in columns
1030 `never`;;
1031         never show in columns
1032 `auto`;;
1033         show in columns if the output is to the terminal
1036 These options control layout (defaults to 'column').  Setting any
1037 of these implies 'always' if none of 'always', 'never', or 'auto' are
1038 specified.
1041 `column`;;
1042         fill columns before rows
1043 `row`;;
1044         fill rows before columns
1045 `plain`;;
1046         show in one column
1049 Finally, these options can be combined with a layout option (defaults
1050 to 'nodense'):
1053 `dense`;;
1054         make unequal size columns to utilize more space
1055 `nodense`;;
1056         make equal size columns
1059 column.branch::
1060         Specify whether to output branch listing in `git branch` in columns.
1061         See `column.ui` for details.
1063 column.clean::
1064         Specify the layout when list items in `git clean -i`, which always
1065         shows files and directories in columns. See `column.ui` for details.
1067 column.status::
1068         Specify whether to output untracked files in `git status` in columns.
1069         See `column.ui` for details.
1071 column.tag::
1072         Specify whether to output tag listing in `git tag` in columns.
1073         See `column.ui` for details.
1075 commit.cleanup::
1076         This setting overrides the default of the `--cleanup` option in
1077         `git commit`. See linkgit:git-commit[1] for details. Changing the
1078         default can be useful when you always want to keep lines that begin
1079         with comment character `#` in your log message, in which case you
1080         would do `git config commit.cleanup whitespace` (note that you will
1081         have to remove the help lines that begin with `#` in the commit log
1082         template yourself, if you do this).
1084 commit.gpgSign::
1086         A boolean to specify whether all commits should be GPG signed.
1087         Use of this option when doing operations such as rebase can
1088         result in a large number of commits being signed. It may be
1089         convenient to use an agent to avoid typing your GPG passphrase
1090         several times.
1092 commit.status::
1093         A boolean to enable/disable inclusion of status information in the
1094         commit message template when using an editor to prepare the commit
1095         message.  Defaults to true.
1097 commit.template::
1098         Specify a file to use as the template for new commit messages.
1099         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1100         specified user's home directory.
1102 credential.helper::
1103         Specify an external helper to be called when a username or
1104         password credential is needed; the helper may consult external
1105         storage to avoid prompting the user for the credentials. See
1106         linkgit:gitcredentials[7] for details.
1108 credential.useHttpPath::
1109         When acquiring credentials, consider the "path" component of an http
1110         or https URL to be important. Defaults to false. See
1111         linkgit:gitcredentials[7] for more information.
1113 credential.username::
1114         If no username is set for a network authentication, use this username
1115         by default. See credential.<context>.* below, and
1116         linkgit:gitcredentials[7].
1118 credential.<url>.*::
1119         Any of the credential.* options above can be applied selectively to
1120         some credentials. For example "credential.https://example.com.username"
1121         would set the default username only for https connections to
1122         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1123         matched.
1125 include::diff-config.txt[]
1127 difftool.<tool>.path::
1128         Override the path for the given tool.  This is useful in case
1129         your tool is not in the PATH.
1131 difftool.<tool>.cmd::
1132         Specify the command to invoke the specified diff tool.
1133         The specified command is evaluated in shell with the following
1134         variables available:  'LOCAL' is set to the name of the temporary
1135         file containing the contents of the diff pre-image and 'REMOTE'
1136         is set to the name of the temporary file containing the contents
1137         of the diff post-image.
1139 difftool.prompt::
1140         Prompt before each invocation of the diff tool.
1142 fetch.recurseSubmodules::
1143         This option can be either set to a boolean value or to 'on-demand'.
1144         Setting it to a boolean changes the behavior of fetch and pull to
1145         unconditionally recurse into submodules when set to true or to not
1146         recurse at all when set to false. When set to 'on-demand' (the default
1147         value), fetch and pull will only recurse into a populated submodule
1148         when its superproject retrieves a commit that updates the submodule's
1149         reference.
1151 fetch.fsckObjects::
1152         If it is set to true, git-fetch-pack will check all fetched
1153         objects. It will abort in the case of a malformed object or a
1154         broken link. The result of an abort are only dangling objects.
1155         Defaults to false. If not set, the value of `transfer.fsckObjects`
1156         is used instead.
1158 fetch.unpackLimit::
1159         If the number of objects fetched over the Git native
1160         transfer is below this
1161         limit, then the objects will be unpacked into loose object
1162         files. However if the number of received objects equals or
1163         exceeds this limit then the received pack will be stored as
1164         a pack, after adding any missing delta bases.  Storing the
1165         pack from a push can make the push operation complete faster,
1166         especially on slow filesystems.  If not set, the value of
1167         `transfer.unpackLimit` is used instead.
1169 fetch.prune::
1170         If true, fetch will automatically behave as if the `--prune`
1171         option was given on the command line.  See also `remote.<name>.prune`.
1173 format.attach::
1174         Enable multipart/mixed attachments as the default for
1175         'format-patch'.  The value can also be a double quoted string
1176         which will enable attachments as the default and set the
1177         value as the boundary.  See the --attach option in
1178         linkgit:git-format-patch[1].
1180 format.numbered::
1181         A boolean which can enable or disable sequence numbers in patch
1182         subjects.  It defaults to "auto" which enables it only if there
1183         is more than one patch.  It can be enabled or disabled for all
1184         messages by setting it to "true" or "false".  See --numbered
1185         option in linkgit:git-format-patch[1].
1187 format.headers::
1188         Additional email headers to include in a patch to be submitted
1189         by mail.  See linkgit:git-format-patch[1].
1191 format.to::
1192 format.cc::
1193         Additional recipients to include in a patch to be submitted
1194         by mail.  See the --to and --cc options in
1195         linkgit:git-format-patch[1].
1197 format.subjectPrefix::
1198         The default for format-patch is to output files with the '[PATCH]'
1199         subject prefix. Use this variable to change that prefix.
1201 format.signature::
1202         The default for format-patch is to output a signature containing
1203         the Git version number. Use this variable to change that default.
1204         Set this variable to the empty string ("") to suppress
1205         signature generation.
1207 format.signatureFile::
1208         Works just like format.signature except the contents of the
1209         file specified by this variable will be used as the signature.
1211 format.suffix::
1212         The default for format-patch is to output files with the suffix
1213         `.patch`. Use this variable to change that suffix (make sure to
1214         include the dot if you want it).
1216 format.pretty::
1217         The default pretty format for log/show/whatchanged command,
1218         See linkgit:git-log[1], linkgit:git-show[1],
1219         linkgit:git-whatchanged[1].
1221 format.thread::
1222         The default threading style for 'git format-patch'.  Can be
1223         a boolean value, or `shallow` or `deep`.  `shallow` threading
1224         makes every mail a reply to the head of the series,
1225         where the head is chosen from the cover letter, the
1226         `--in-reply-to`, and the first patch mail, in this order.
1227         `deep` threading makes every mail a reply to the previous one.
1228         A true boolean value is the same as `shallow`, and a false
1229         value disables threading.
1231 format.signOff::
1232         A boolean value which lets you enable the `-s/--signoff` option of
1233         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1234         patch should be a conscious act and means that you certify you have
1235         the rights to submit this work under the same open source license.
1236         Please see the 'SubmittingPatches' document for further discussion.
1238 format.coverLetter::
1239         A boolean that controls whether to generate a cover-letter when
1240         format-patch is invoked, but in addition can be set to "auto", to
1241         generate a cover-letter only when there's more than one patch.
1243 filter.<driver>.clean::
1244         The command which is used to convert the content of a worktree
1245         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1246         details.
1248 filter.<driver>.smudge::
1249         The command which is used to convert the content of a blob
1250         object to a worktree file upon checkout.  See
1251         linkgit:gitattributes[5] for details.
1253 fsck.<msg-id>::
1254         Allows overriding the message type (error, warn or ignore) of a
1255         specific message ID such as `missingEmail`.
1257 For convenience, fsck prefixes the error/warning with the message ID,
1258 e.g.  "missingEmail: invalid author/committer line - missing email" means
1259 that setting `fsck.missingEmail = ignore` will hide that issue.
1261 This feature is intended to support working with legacy repositories
1262 which cannot be repaired without disruptive changes.
1264 fsck.skipList::
1265         The path to a sorted list of object names (i.e. one SHA-1 per
1266         line) that are known to be broken in a non-fatal way and should
1267         be ignored. This feature is useful when an established project
1268         should be accepted despite early commits containing errors that
1269         can be safely ignored such as invalid committer email addresses.
1270         Note: corrupt objects cannot be skipped with this setting.
1272 gc.aggressiveDepth::
1273         The depth parameter used in the delta compression
1274         algorithm used by 'git gc --aggressive'.  This defaults
1275         to 250.
1277 gc.aggressiveWindow::
1278         The window size parameter used in the delta compression
1279         algorithm used by 'git gc --aggressive'.  This defaults
1280         to 250.
1282 gc.auto::
1283         When there are approximately more than this many loose
1284         objects in the repository, `git gc --auto` will pack them.
1285         Some Porcelain commands use this command to perform a
1286         light-weight garbage collection from time to time.  The
1287         default value is 6700.  Setting this to 0 disables it.
1289 gc.autoPackLimit::
1290         When there are more than this many packs that are not
1291         marked with `*.keep` file in the repository, `git gc
1292         --auto` consolidates them into one larger pack.  The
1293         default value is 50.  Setting this to 0 disables it.
1295 gc.autoDetach::
1296         Make `git gc --auto` return immediately and run in background
1297         if the system supports it. Default is true.
1299 gc.packRefs::
1300         Running `git pack-refs` in a repository renders it
1301         unclonable by Git versions prior to 1.5.1.2 over dumb
1302         transports such as HTTP.  This variable determines whether
1303         'git gc' runs `git pack-refs`. This can be set to `notbare`
1304         to enable it within all non-bare repos or it can be set to a
1305         boolean value.  The default is `true`.
1307 gc.pruneExpire::
1308         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1309         Override the grace period with this config variable.  The value
1310         "now" may be used to disable this grace period and always prune
1311         unreachable objects immediately, or "never" may be used to
1312         suppress pruning.
1314 gc.worktreePruneExpire::
1315         When 'git gc' is run, it calls
1316         'git worktree prune --expire 3.months.ago'.
1317         This config variable can be used to set a different grace
1318         period. The value "now" may be used to disable the grace
1319         period and prune $GIT_DIR/worktrees immediately, or "never"
1320         may be used to suppress pruning.
1322 gc.reflogExpire::
1323 gc.<pattern>.reflogExpire::
1324         'git reflog expire' removes reflog entries older than
1325         this time; defaults to 90 days. The value "now" expires all
1326         entries immediately, and "never" suppresses expiration
1327         altogether. With "<pattern>" (e.g.
1328         "refs/stash") in the middle the setting applies only to
1329         the refs that match the <pattern>.
1331 gc.reflogExpireUnreachable::
1332 gc.<pattern>.reflogExpireUnreachable::
1333         'git reflog expire' removes reflog entries older than
1334         this time and are not reachable from the current tip;
1335         defaults to 30 days. The value "now" expires all entries
1336         immediately, and "never" suppresses expiration altogether.
1337         With "<pattern>" (e.g. "refs/stash")
1338         in the middle, the setting applies only to the refs that
1339         match the <pattern>.
1341 gc.rerereResolved::
1342         Records of conflicted merge you resolved earlier are
1343         kept for this many days when 'git rerere gc' is run.
1344         The default is 60 days.  See linkgit:git-rerere[1].
1346 gc.rerereUnresolved::
1347         Records of conflicted merge you have not resolved are
1348         kept for this many days when 'git rerere gc' is run.
1349         The default is 15 days.  See linkgit:git-rerere[1].
1351 gitcvs.commitMsgAnnotation::
1352         Append this string to each commit message. Set to empty string
1353         to disable this feature. Defaults to "via git-CVS emulator".
1355 gitcvs.enabled::
1356         Whether the CVS server interface is enabled for this repository.
1357         See linkgit:git-cvsserver[1].
1359 gitcvs.logFile::
1360         Path to a log file where the CVS server interface well... logs
1361         various stuff. See linkgit:git-cvsserver[1].
1363 gitcvs.usecrlfattr::
1364         If true, the server will look up the end-of-line conversion
1365         attributes for files to determine the '-k' modes to use. If
1366         the attributes force Git to treat a file as text,
1367         the '-k' mode will be left blank so CVS clients will
1368         treat it as text. If they suppress text conversion, the file
1369         will be set with '-kb' mode, which suppresses any newline munging
1370         the client might otherwise do. If the attributes do not allow
1371         the file type to be determined, then 'gitcvs.allBinary' is
1372         used. See linkgit:gitattributes[5].
1374 gitcvs.allBinary::
1375         This is used if 'gitcvs.usecrlfattr' does not resolve
1376         the correct '-kb' mode to use. If true, all
1377         unresolved files are sent to the client in
1378         mode '-kb'. This causes the client to treat them
1379         as binary files, which suppresses any newline munging it
1380         otherwise might do. Alternatively, if it is set to "guess",
1381         then the contents of the file are examined to decide if
1382         it is binary, similar to 'core.autocrlf'.
1384 gitcvs.dbName::
1385         Database used by git-cvsserver to cache revision information
1386         derived from the Git repository. The exact meaning depends on the
1387         used database driver, for SQLite (which is the default driver) this
1388         is a filename. Supports variable substitution (see
1389         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1390         Default: '%Ggitcvs.%m.sqlite'
1392 gitcvs.dbDriver::
1393         Used Perl DBI driver. You can specify any available driver
1394         for this here, but it might not work. git-cvsserver is tested
1395         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1396         reported *not* to work with 'DBD::mysql'. Experimental feature.
1397         May not contain double colons (`:`). Default: 'SQLite'.
1398         See linkgit:git-cvsserver[1].
1400 gitcvs.dbUser, gitcvs.dbPass::
1401         Database user and password. Only useful if setting 'gitcvs.dbDriver',
1402         since SQLite has no concept of database users and/or passwords.
1403         'gitcvs.dbUser' supports variable substitution (see
1404         linkgit:git-cvsserver[1] for details).
1406 gitcvs.dbTableNamePrefix::
1407         Database table name prefix.  Prepended to the names of any
1408         database tables used, allowing a single database to be used
1409         for several repositories.  Supports variable substitution (see
1410         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1411         characters will be replaced with underscores.
1413 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1414 'gitcvs.allBinary' can also be specified as
1415 'gitcvs.<access_method>.<varname>' (where 'access_method'
1416 is one of "ext" and "pserver") to make them apply only for the given
1417 access method.
1419 gitweb.category::
1420 gitweb.description::
1421 gitweb.owner::
1422 gitweb.url::
1423         See linkgit:gitweb[1] for description.
1425 gitweb.avatar::
1426 gitweb.blame::
1427 gitweb.grep::
1428 gitweb.highlight::
1429 gitweb.patches::
1430 gitweb.pickaxe::
1431 gitweb.remote_heads::
1432 gitweb.showSizes::
1433 gitweb.snapshot::
1434         See linkgit:gitweb.conf[5] for description.
1436 grep.lineNumber::
1437         If set to true, enable '-n' option by default.
1439 grep.patternType::
1440         Set the default matching behavior. Using a value of 'basic', 'extended',
1441         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1442         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1443         value 'default' will return to the default matching behavior.
1445 grep.extendedRegexp::
1446         If set to true, enable '--extended-regexp' option by default. This
1447         option is ignored when the 'grep.patternType' option is set to a value
1448         other than 'default'.
1450 gpg.program::
1451         Use this custom program instead of "gpg" found on $PATH when
1452         making or verifying a PGP signature. The program must support the
1453         same command-line interface as GPG, namely, to verify a detached
1454         signature, "gpg --verify $file - <$signature" is run, and the
1455         program is expected to signal a good signature by exiting with
1456         code 0, and to generate an ASCII-armored detached signature, the
1457         standard input of "gpg -bsau $key" is fed with the contents to be
1458         signed, and the program is expected to send the result to its
1459         standard output.
1461 gui.commitMsgWidth::
1462         Defines how wide the commit message window is in the
1463         linkgit:git-gui[1]. "75" is the default.
1465 gui.diffContext::
1466         Specifies how many context lines should be used in calls to diff
1467         made by the linkgit:git-gui[1]. The default is "5".
1469 gui.displayUntracked::
1470         Determines if linkgit::git-gui[1] shows untracked files
1471         in the file list. The default is "true".
1473 gui.encoding::
1474         Specifies the default encoding to use for displaying of
1475         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1476         It can be overridden by setting the 'encoding' attribute
1477         for relevant files (see linkgit:gitattributes[5]).
1478         If this option is not set, the tools default to the
1479         locale encoding.
1481 gui.matchTrackingBranch::
1482         Determines if new branches created with linkgit:git-gui[1] should
1483         default to tracking remote branches with matching names or
1484         not. Default: "false".
1486 gui.newBranchTemplate::
1487         Is used as suggested name when creating new branches using the
1488         linkgit:git-gui[1].
1490 gui.pruneDuringFetch::
1491         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1492         performing a fetch. The default value is "false".
1494 gui.trustmtime::
1495         Determines if linkgit:git-gui[1] should trust the file modification
1496         timestamp or not. By default the timestamps are not trusted.
1498 gui.spellingDictionary::
1499         Specifies the dictionary used for spell checking commit messages in
1500         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1501         off.
1503 gui.fastCopyBlame::
1504         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1505         location detection. It makes blame significantly faster on huge
1506         repositories at the expense of less thorough copy detection.
1508 gui.copyBlameThreshold::
1509         Specifies the threshold to use in 'git gui blame' original location
1510         detection, measured in alphanumeric characters. See the
1511         linkgit:git-blame[1] manual for more information on copy detection.
1513 gui.blamehistoryctx::
1514         Specifies the radius of history context in days to show in
1515         linkgit:gitk[1] for the selected commit, when the `Show History
1516         Context` menu item is invoked from 'git gui blame'. If this
1517         variable is set to zero, the whole history is shown.
1519 guitool.<name>.cmd::
1520         Specifies the shell command line to execute when the corresponding item
1521         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1522         mandatory for every tool. The command is executed from the root of
1523         the working directory, and in the environment it receives the name of
1524         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1525         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1526         the head is detached, 'CUR_BRANCH' is empty).
1528 guitool.<name>.needsFile::
1529         Run the tool only if a diff is selected in the GUI. It guarantees
1530         that 'FILENAME' is not empty.
1532 guitool.<name>.noConsole::
1533         Run the command silently, without creating a window to display its
1534         output.
1536 guitool.<name>.noRescan::
1537         Don't rescan the working directory for changes after the tool
1538         finishes execution.
1540 guitool.<name>.confirm::
1541         Show a confirmation dialog before actually running the tool.
1543 guitool.<name>.argPrompt::
1544         Request a string argument from the user, and pass it to the tool
1545         through the 'ARGS' environment variable. Since requesting an
1546         argument implies confirmation, the 'confirm' option has no effect
1547         if this is enabled. If the option is set to 'true', 'yes', or '1',
1548         the dialog uses a built-in generic prompt; otherwise the exact
1549         value of the variable is used.
1551 guitool.<name>.revPrompt::
1552         Request a single valid revision from the user, and set the
1553         'REVISION' environment variable. In other aspects this option
1554         is similar to 'argPrompt', and can be used together with it.
1556 guitool.<name>.revUnmerged::
1557         Show only unmerged branches in the 'revPrompt' subdialog.
1558         This is useful for tools similar to merge or rebase, but not
1559         for things like checkout or reset.
1561 guitool.<name>.title::
1562         Specifies the title to use for the prompt dialog. The default
1563         is the tool name.
1565 guitool.<name>.prompt::
1566         Specifies the general prompt string to display at the top of
1567         the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1568         The default value includes the actual command.
1570 help.browser::
1571         Specify the browser that will be used to display help in the
1572         'web' format. See linkgit:git-help[1].
1574 help.format::
1575         Override the default help format used by linkgit:git-help[1].
1576         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1577         the default. 'web' and 'html' are the same.
1579 help.autoCorrect::
1580         Automatically correct and execute mistyped commands after
1581         waiting for the given number of deciseconds (0.1 sec). If more
1582         than one command can be deduced from the entered text, nothing
1583         will be executed.  If the value of this option is negative,
1584         the corrected command will be executed immediately. If the
1585         value is 0 - the command will be just shown but not executed.
1586         This is the default.
1588 help.htmlPath::
1589         Specify the path where the HTML documentation resides. File system paths
1590         and URLs are supported. HTML pages will be prefixed with this path when
1591         help is displayed in the 'web' format. This defaults to the documentation
1592         path of your Git installation.
1594 http.proxy::
1595         Override the HTTP proxy, normally configured using the 'http_proxy',
1596         'https_proxy', and 'all_proxy' environment variables (see
1597         `curl(1)`).  This can be overridden on a per-remote basis; see
1598         remote.<name>.proxy
1600 http.cookieFile::
1601         File containing previously stored cookie lines which should be used
1602         in the Git http session, if they match the server. The file format
1603         of the file to read cookies from should be plain HTTP headers or
1604         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1605         NOTE that the file specified with http.cookieFile is only used as
1606         input unless http.saveCookies is set.
1608 http.saveCookies::
1609         If set, store cookies received during requests to the file specified by
1610         http.cookieFile. Has no effect if http.cookieFile is unset.
1612 http.sslVersion::
1613         The SSL version to use when negotiating an SSL connection, if you
1614         want to force the default.  The available and default version
1615         depend on whether libcurl was built against NSS or OpenSSL and the
1616         particular configuration of the crypto library in use. Internally
1617         this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1618         documentation for more details on the format of this option and
1619         for the ssl version supported. Actually the possible values of
1620         this option are:
1622         - sslv2
1623         - sslv3
1624         - tlsv1
1625         - tlsv1.0
1626         - tlsv1.1
1627         - tlsv1.2
1630 Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1631 To force git to use libcurl's default ssl version and ignore any
1632 explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1633 empty string.
1635 http.sslCipherList::
1636   A list of SSL ciphers to use when negotiating an SSL connection.
1637   The available ciphers depend on whether libcurl was built against
1638   NSS or OpenSSL and the particular configuration of the crypto
1639   library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1640   option; see the libcurl documentation for more details on the format
1641   of this list.
1643 Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1644 To force git to use libcurl's default cipher list and ignore any
1645 explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1646 empty string.
1648 http.sslVerify::
1649         Whether to verify the SSL certificate when fetching or pushing
1650         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1651         variable.
1653 http.sslCert::
1654         File containing the SSL certificate when fetching or pushing
1655         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1656         variable.
1658 http.sslKey::
1659         File containing the SSL private key when fetching or pushing
1660         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1661         variable.
1663 http.sslCertPasswordProtected::
1664         Enable Git's password prompt for the SSL certificate.  Otherwise
1665         OpenSSL will prompt the user, possibly many times, if the
1666         certificate or private key is encrypted.  Can be overridden by the
1667         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1669 http.sslCAInfo::
1670         File containing the certificates to verify the peer with when
1671         fetching or pushing over HTTPS. Can be overridden by the
1672         'GIT_SSL_CAINFO' environment variable.
1674 http.sslCAPath::
1675         Path containing files with the CA certificates to verify the peer
1676         with when fetching or pushing over HTTPS. Can be overridden
1677         by the 'GIT_SSL_CAPATH' environment variable.
1679 http.sslTry::
1680         Attempt to use AUTH SSL/TLS and encrypted data transfers
1681         when connecting via regular FTP protocol. This might be needed
1682         if the FTP server requires it for security reasons or you wish
1683         to connect securely whenever remote FTP server supports it.
1684         Default is false since it might trigger certificate verification
1685         errors on misconfigured servers.
1687 http.maxRequests::
1688         How many HTTP requests to launch in parallel. Can be overridden
1689         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1691 http.minSessions::
1692         The number of curl sessions (counted across slots) to be kept across
1693         requests. They will not be ended with curl_easy_cleanup() until
1694         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1695         value will be capped at 1. Defaults to 1.
1697 http.postBuffer::
1698         Maximum size in bytes of the buffer used by smart HTTP
1699         transports when POSTing data to the remote system.
1700         For requests larger than this buffer size, HTTP/1.1 and
1701         Transfer-Encoding: chunked is used to avoid creating a
1702         massive pack file locally.  Default is 1 MiB, which is
1703         sufficient for most requests.
1705 http.lowSpeedLimit, http.lowSpeedTime::
1706         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1707         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1708         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1709         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1711 http.noEPSV::
1712         A boolean which disables using of EPSV ftp command by curl.
1713         This can helpful with some "poor" ftp servers which don't
1714         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1715         environment variable. Default is false (curl will use EPSV).
1717 http.userAgent::
1718         The HTTP USER_AGENT string presented to an HTTP server.  The default
1719         value represents the version of the client Git such as git/1.7.1.
1720         This option allows you to override this value to a more common value
1721         such as Mozilla/4.0.  This may be necessary, for instance, if
1722         connecting through a firewall that restricts HTTP connections to a set
1723         of common USER_AGENT strings (but not including those like git/1.7.1).
1724         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1726 http.<url>.*::
1727         Any of the http.* options above can be applied selectively to some URLs.
1728         For a config key to match a URL, each element of the config key is
1729         compared to that of the URL, in the following order:
1732 . Scheme (e.g., `https` in `https://example.com/`). This field
1733   must match exactly between the config key and the URL.
1735 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1736   This field must match exactly between the config key and the URL.
1738 . Port number (e.g., `8080` in `http://example.com:8080/`).
1739   This field must match exactly between the config key and the URL.
1740   Omitted port numbers are automatically converted to the correct
1741   default for the scheme before matching.
1743 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1744   path field of the config key must match the path field of the URL
1745   either exactly or as a prefix of slash-delimited path elements.  This means
1746   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1747   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1748   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1749   key with just path `foo/`).
1751 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1752   the config key has a user name it must match the user name in the
1753   URL exactly. If the config key does not have a user name, that
1754   config key will match a URL with any user name (including none),
1755   but at a lower precedence than a config key with a user name.
1758 The list above is ordered by decreasing precedence; a URL that matches
1759 a config key's path is preferred to one that matches its user name. For example,
1760 if the URL is `https://user@example.com/foo/bar` a config key match of
1761 `https://example.com/foo` will be preferred over a config key match of
1762 `https://user@example.com`.
1764 All URLs are normalized before attempting any matching (the password part,
1765 if embedded in the URL, is always ignored for matching purposes) so that
1766 equivalent URLs that are simply spelled differently will match properly.
1767 Environment variable settings always override any matches.  The URLs that are
1768 matched against are those given directly to Git commands.  This means any URLs
1769 visited as a result of a redirection do not participate in matching.
1771 i18n.commitEncoding::
1772         Character encoding the commit messages are stored in; Git itself
1773         does not care per se, but this information is necessary e.g. when
1774         importing commits from emails or in the gitk graphical history
1775         browser (and possibly at other places in the future or in other
1776         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1778 i18n.logOutputEncoding::
1779         Character encoding the commit messages are converted to when
1780         running 'git log' and friends.
1782 imap::
1783         The configuration variables in the 'imap' section are described
1784         in linkgit:git-imap-send[1].
1786 index.version::
1787         Specify the version with which new index files should be
1788         initialized.  This does not affect existing repositories.
1790 init.templateDir::
1791         Specify the directory from which templates will be copied.
1792         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1794 instaweb.browser::
1795         Specify the program that will be used to browse your working
1796         repository in gitweb. See linkgit:git-instaweb[1].
1798 instaweb.httpd::
1799         The HTTP daemon command-line to start gitweb on your working
1800         repository. See linkgit:git-instaweb[1].
1802 instaweb.local::
1803         If true the web server started by linkgit:git-instaweb[1] will
1804         be bound to the local IP (127.0.0.1).
1806 instaweb.modulePath::
1807         The default module path for linkgit:git-instaweb[1] to use
1808         instead of /usr/lib/apache2/modules.  Only used if httpd
1809         is Apache.
1811 instaweb.port::
1812         The port number to bind the gitweb httpd to. See
1813         linkgit:git-instaweb[1].
1815 interactive.singleKey::
1816         In interactive commands, allow the user to provide one-letter
1817         input with a single key (i.e., without hitting enter).
1818         Currently this is used by the `--patch` mode of
1819         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1820         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1821         setting is silently ignored if portable keystroke input
1822         is not available; requires the Perl module Term::ReadKey.
1824 log.abbrevCommit::
1825         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1826         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1827         override this option with `--no-abbrev-commit`.
1829 log.date::
1830         Set the default date-time mode for the 'log' command.
1831         Setting a value for log.date is similar to using 'git log''s
1832         `--date` option.  See linkgit:git-log[1] for details.
1834 log.decorate::
1835         Print out the ref names of any commits that are shown by the log
1836         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1837         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1838         specified, the full ref name (including prefix) will be printed.
1839         This is the same as the log commands '--decorate' option.
1841 log.follow::
1842         If `true`, `git log` will act as if the `--follow` option was used when
1843         a single <path> is given.  This has the same limitations as `--follow`,
1844         i.e. it cannot be used to follow multiple files and does not work well
1845         on non-linear history.
1847 log.showRoot::
1848         If true, the initial commit will be shown as a big creation event.
1849         This is equivalent to a diff against an empty tree.
1850         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1851         normally hide the root commit will now show it. True by default.
1853 log.mailmap::
1854         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1855         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1857 mailinfo.scissors::
1858         If true, makes linkgit:git-mailinfo[1] (and therefore
1859         linkgit:git-am[1]) act by default as if the --scissors option
1860         was provided on the command-line. When active, this features
1861         removes everything from the message body before a scissors
1862         line (i.e. consisting mainly of ">8", "8<" and "-").
1864 mailmap.file::
1865         The location of an augmenting mailmap file. The default
1866         mailmap, located in the root of the repository, is loaded
1867         first, then the mailmap file pointed to by this variable.
1868         The location of the mailmap file may be in a repository
1869         subdirectory, or somewhere outside of the repository itself.
1870         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1872 mailmap.blob::
1873         Like `mailmap.file`, but consider the value as a reference to a
1874         blob in the repository. If both `mailmap.file` and
1875         `mailmap.blob` are given, both are parsed, with entries from
1876         `mailmap.file` taking precedence. In a bare repository, this
1877         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1878         defaults to empty.
1880 man.viewer::
1881         Specify the programs that may be used to display help in the
1882         'man' format. See linkgit:git-help[1].
1884 man.<tool>.cmd::
1885         Specify the command to invoke the specified man viewer. The
1886         specified command is evaluated in shell with the man page
1887         passed as argument. (See linkgit:git-help[1].)
1889 man.<tool>.path::
1890         Override the path for the given tool that may be used to
1891         display help in the 'man' format. See linkgit:git-help[1].
1893 include::merge-config.txt[]
1895 mergetool.<tool>.path::
1896         Override the path for the given tool.  This is useful in case
1897         your tool is not in the PATH.
1899 mergetool.<tool>.cmd::
1900         Specify the command to invoke the specified merge tool.  The
1901         specified command is evaluated in shell with the following
1902         variables available: 'BASE' is the name of a temporary file
1903         containing the common base of the files to be merged, if available;
1904         'LOCAL' is the name of a temporary file containing the contents of
1905         the file on the current branch; 'REMOTE' is the name of a temporary
1906         file containing the contents of the file from the branch being
1907         merged; 'MERGED' contains the name of the file to which the merge
1908         tool should write the results of a successful merge.
1910 mergetool.<tool>.trustExitCode::
1911         For a custom merge command, specify whether the exit code of
1912         the merge command can be used to determine whether the merge was
1913         successful.  If this is not set to true then the merge target file
1914         timestamp is checked and the merge assumed to have been successful
1915         if the file has been updated, otherwise the user is prompted to
1916         indicate the success of the merge.
1918 mergetool.meld.hasOutput::
1919         Older versions of `meld` do not support the `--output` option.
1920         Git will attempt to detect whether `meld` supports `--output`
1921         by inspecting the output of `meld --help`.  Configuring
1922         `mergetool.meld.hasOutput` will make Git skip these checks and
1923         use the configured value instead.  Setting `mergetool.meld.hasOutput`
1924         to `true` tells Git to unconditionally use the `--output` option,
1925         and `false` avoids using `--output`.
1927 mergetool.keepBackup::
1928         After performing a merge, the original file with conflict markers
1929         can be saved as a file with a `.orig` extension.  If this variable
1930         is set to `false` then this file is not preserved.  Defaults to
1931         `true` (i.e. keep the backup files).
1933 mergetool.keepTemporaries::
1934         When invoking a custom merge tool, Git uses a set of temporary
1935         files to pass to the tool. If the tool returns an error and this
1936         variable is set to `true`, then these temporary files will be
1937         preserved, otherwise they will be removed after the tool has
1938         exited. Defaults to `false`.
1940 mergetool.writeToTemp::
1941         Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1942         conflicting files in the worktree by default.  Git will attempt
1943         to use a temporary directory for these files when set `true`.
1944         Defaults to `false`.
1946 mergetool.prompt::
1947         Prompt before each invocation of the merge resolution program.
1949 notes.mergeStrategy::
1950         Which merge strategy to choose by default when resolving notes
1951         conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
1952         `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
1953         section of linkgit:git-notes[1] for more information on each strategy.
1955 notes.<name>.mergeStrategy::
1956         Which merge strategy to choose when doing a notes merge into
1957         refs/notes/<name>.  This overrides the more general
1958         "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
1959         linkgit:git-notes[1] for more information on the available strategies.
1961 notes.displayRef::
1962         The (fully qualified) refname from which to show notes when
1963         showing commit messages.  The value of this variable can be set
1964         to a glob, in which case notes from all matching refs will be
1965         shown.  You may also specify this configuration variable
1966         several times.  A warning will be issued for refs that do not
1967         exist, but a glob that does not match any refs is silently
1968         ignored.
1970 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1971 environment variable, which must be a colon separated list of refs or
1972 globs.
1974 The effective value of "core.notesRef" (possibly overridden by
1975 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1976 displayed.
1978 notes.rewrite.<command>::
1979         When rewriting commits with <command> (currently `amend` or
1980         `rebase`) and this variable is set to `true`, Git
1981         automatically copies your notes from the original to the
1982         rewritten commit.  Defaults to `true`, but see
1983         "notes.rewriteRef" below.
1985 notes.rewriteMode::
1986         When copying notes during a rewrite (see the
1987         "notes.rewrite.<command>" option), determines what to do if
1988         the target commit already has a note.  Must be one of
1989         `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
1990         Defaults to `concatenate`.
1992 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1993 environment variable.
1995 notes.rewriteRef::
1996         When copying notes during a rewrite, specifies the (fully
1997         qualified) ref whose notes should be copied.  The ref may be a
1998         glob, in which case notes in all matching refs will be copied.
1999         You may also specify this configuration several times.
2001 Does not have a default value; you must configure this variable to
2002 enable note rewriting.  Set it to `refs/notes/commits` to enable
2003 rewriting for the default commit notes.
2005 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2006 environment variable, which must be a colon separated list of refs or
2007 globs.
2009 pack.window::
2010         The size of the window used by linkgit:git-pack-objects[1] when no
2011         window size is given on the command line. Defaults to 10.
2013 pack.depth::
2014         The maximum delta depth used by linkgit:git-pack-objects[1] when no
2015         maximum depth is given on the command line. Defaults to 50.
2017 pack.windowMemory::
2018         The maximum size of memory that is consumed by each thread
2019         in linkgit:git-pack-objects[1] for pack window memory when
2020         no limit is given on the command line.  The value can be
2021         suffixed with "k", "m", or "g".  When left unconfigured (or
2022         set explicitly to 0), there will be no limit.
2024 pack.compression::
2025         An integer -1..9, indicating the compression level for objects
2026         in a pack file. -1 is the zlib default. 0 means no
2027         compression, and 1..9 are various speed/size tradeoffs, 9 being
2028         slowest.  If not set,  defaults to core.compression.  If that is
2029         not set,  defaults to -1, the zlib default, which is "a default
2030         compromise between speed and compression (currently equivalent
2031         to level 6)."
2033 Note that changing the compression level will not automatically recompress
2034 all existing objects. You can force recompression by passing the -F option
2035 to linkgit:git-repack[1].
2037 pack.deltaCacheSize::
2038         The maximum memory in bytes used for caching deltas in
2039         linkgit:git-pack-objects[1] before writing them out to a pack.
2040         This cache is used to speed up the writing object phase by not
2041         having to recompute the final delta result once the best match
2042         for all objects is found.  Repacking large repositories on machines
2043         which are tight with memory might be badly impacted by this though,
2044         especially if this cache pushes the system into swapping.
2045         A value of 0 means no limit. The smallest size of 1 byte may be
2046         used to virtually disable this cache. Defaults to 256 MiB.
2048 pack.deltaCacheLimit::
2049         The maximum size of a delta, that is cached in
2050         linkgit:git-pack-objects[1]. This cache is used to speed up the
2051         writing object phase by not having to recompute the final delta
2052         result once the best match for all objects is found. Defaults to 1000.
2054 pack.threads::
2055         Specifies the number of threads to spawn when searching for best
2056         delta matches.  This requires that linkgit:git-pack-objects[1]
2057         be compiled with pthreads otherwise this option is ignored with a
2058         warning. This is meant to reduce packing time on multiprocessor
2059         machines. The required amount of memory for the delta search window
2060         is however multiplied by the number of threads.
2061         Specifying 0 will cause Git to auto-detect the number of CPU's
2062         and set the number of threads accordingly.
2064 pack.indexVersion::
2065         Specify the default pack index version.  Valid values are 1 for
2066         legacy pack index used by Git versions prior to 1.5.2, and 2 for
2067         the new pack index with capabilities for packs larger than 4 GB
2068         as well as proper protection against the repacking of corrupted
2069         packs.  Version 2 is the default.  Note that version 2 is enforced
2070         and this config option ignored whenever the corresponding pack is
2071         larger than 2 GB.
2073 If you have an old Git that does not understand the version 2 `*.idx` file,
2074 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
2075 that will copy both `*.pack` file and corresponding `*.idx` file from the
2076 other side may give you a repository that cannot be accessed with your
2077 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2078 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2079 the `*.idx` file.
2081 pack.packSizeLimit::
2082         The maximum size of a pack.  This setting only affects
2083         packing to a file when repacking, i.e. the git:// protocol
2084         is unaffected.  It can be overridden by the `--max-pack-size`
2085         option of linkgit:git-repack[1]. The minimum size allowed is
2086         limited to 1 MiB. The default is unlimited.
2087         Common unit suffixes of 'k', 'm', or 'g' are
2088         supported.
2090 pack.useBitmaps::
2091         When true, git will use pack bitmaps (if available) when packing
2092         to stdout (e.g., during the server side of a fetch). Defaults to
2093         true. You should not generally need to turn this off unless
2094         you are debugging pack bitmaps.
2096 pack.writeBitmaps (deprecated)::
2097         This is a deprecated synonym for `repack.writeBitmaps`.
2099 pack.writeBitmapHashCache::
2100         When true, git will include a "hash cache" section in the bitmap
2101         index (if one is written). This cache can be used to feed git's
2102         delta heuristics, potentially leading to better deltas between
2103         bitmapped and non-bitmapped objects (e.g., when serving a fetch
2104         between an older, bitmapped pack and objects that have been
2105         pushed since the last gc). The downside is that it consumes 4
2106         bytes per object of disk space, and that JGit's bitmap
2107         implementation does not understand it, causing it to complain if
2108         Git and JGit are used on the same repository. Defaults to false.
2110 pager.<cmd>::
2111         If the value is boolean, turns on or off pagination of the
2112         output of a particular Git subcommand when writing to a tty.
2113         Otherwise, turns on pagination for the subcommand using the
2114         pager specified by the value of `pager.<cmd>`.  If `--paginate`
2115         or `--no-pager` is specified on the command line, it takes
2116         precedence over this option.  To disable pagination for all
2117         commands, set `core.pager` or `GIT_PAGER` to `cat`.
2119 pretty.<name>::
2120         Alias for a --pretty= format string, as specified in
2121         linkgit:git-log[1]. Any aliases defined here can be used just
2122         as the built-in pretty formats could. For example,
2123         running `git config pretty.changelog "format:* %H %s"`
2124         would cause the invocation `git log --pretty=changelog`
2125         to be equivalent to running `git log "--pretty=format:* %H %s"`.
2126         Note that an alias with the same name as a built-in format
2127         will be silently ignored.
2129 pull.ff::
2130         By default, Git does not create an extra merge commit when merging
2131         a commit that is a descendant of the current commit. Instead, the
2132         tip of the current branch is fast-forwarded. When set to `false`,
2133         this variable tells Git to create an extra merge commit in such
2134         a case (equivalent to giving the `--no-ff` option from the command
2135         line). When set to `only`, only such fast-forward merges are
2136         allowed (equivalent to giving the `--ff-only` option from the
2137         command line). This setting overrides `merge.ff` when pulling.
2139 pull.rebase::
2140         When true, rebase branches on top of the fetched branch, instead
2141         of merging the default branch from the default remote when "git
2142         pull" is run. See "branch.<name>.rebase" for setting this on a
2143         per-branch basis.
2145 When preserve, also pass `--preserve-merges` along to 'git rebase'
2146 so that locally committed merge commits will not be flattened
2147 by running 'git pull'.
2149 *NOTE*: this is a possibly dangerous operation; do *not* use
2150 it unless you understand the implications (see linkgit:git-rebase[1]
2151 for details).
2153 pull.octopus::
2154         The default merge strategy to use when pulling multiple branches
2155         at once.
2157 pull.twohead::
2158         The default merge strategy to use when pulling a single branch.
2160 push.default::
2161         Defines the action `git push` should take if no refspec is
2162         explicitly given.  Different values are well-suited for
2163         specific workflows; for instance, in a purely central workflow
2164         (i.e. the fetch source is equal to the push destination),
2165         `upstream` is probably what you want.  Possible values are:
2169 * `nothing` - do not push anything (error out) unless a refspec is
2170   explicitly given. This is primarily meant for people who want to
2171   avoid mistakes by always being explicit.
2173 * `current` - push the current branch to update a branch with the same
2174   name on the receiving end.  Works in both central and non-central
2175   workflows.
2177 * `upstream` - push the current branch back to the branch whose
2178   changes are usually integrated into the current branch (which is
2179   called `@{upstream}`).  This mode only makes sense if you are
2180   pushing to the same repository you would normally pull from
2181   (i.e. central workflow).
2183 * `simple` - in centralized workflow, work like `upstream` with an
2184   added safety to refuse to push if the upstream branch's name is
2185   different from the local one.
2187 When pushing to a remote that is different from the remote you normally
2188 pull from, work as `current`.  This is the safest option and is suited
2189 for beginners.
2191 This mode has become the default in Git 2.0.
2193 * `matching` - push all branches having the same name on both ends.
2194   This makes the repository you are pushing to remember the set of
2195   branches that will be pushed out (e.g. if you always push 'maint'
2196   and 'master' there and no other branches, the repository you push
2197   to will have these two branches, and your local 'maint' and
2198   'master' will be pushed there).
2200 To use this mode effectively, you have to make sure _all_ the
2201 branches you would push out are ready to be pushed out before
2202 running 'git push', as the whole point of this mode is to allow you
2203 to push all of the branches in one go.  If you usually finish work
2204 on only one branch and push out the result, while other branches are
2205 unfinished, this mode is not for you.  Also this mode is not
2206 suitable for pushing into a shared central repository, as other
2207 people may add new branches there, or update the tip of existing
2208 branches outside your control.
2210 This used to be the default, but not since Git 2.0 (`simple` is the
2211 new default).
2215 push.followTags::
2216         If set to true enable '--follow-tags' option by default.  You
2217         may override this configuration at time of push by specifying
2218         '--no-follow-tags'.
2220 push.gpgSign::
2221         May be set to a boolean value, or the string 'if-asked'. A true
2222         value causes all pushes to be GPG signed, as if '--signed' is
2223         passed to linkgit:git-push[1]. The string 'if-asked' causes
2224         pushes to be signed if the server supports it, as if
2225         '--signed=if-asked' is passed to 'git push'. A false value may
2226         override a value from a lower-priority config file. An explicit
2227         command-line flag always overrides this config option.
2229 rebase.stat::
2230         Whether to show a diffstat of what changed upstream since the last
2231         rebase. False by default.
2233 rebase.autoSquash::
2234         If set to true enable '--autosquash' option by default.
2236 rebase.autoStash::
2237         When set to true, automatically create a temporary stash
2238         before the operation begins, and apply it after the operation
2239         ends.  This means that you can run rebase on a dirty worktree.
2240         However, use with care: the final stash application after a
2241         successful rebase might result in non-trivial conflicts.
2242         Defaults to false.
2244 rebase.missingCommitsCheck::
2245         If set to "warn", git rebase -i will print a warning if some
2246         commits are removed (e.g. a line was deleted), however the
2247         rebase will still proceed. If set to "error", it will print
2248         the previous warning and stop the rebase, 'git rebase
2249         --edit-todo' can then be used to correct the error. If set to
2250         "ignore", no checking is done.
2251         To drop a commit without warning or error, use the `drop`
2252         command in the todo-list.
2253         Defaults to "ignore".
2255 rebase.instructionFormat
2256         A format string, as specified in linkgit:git-log[1], to be used for
2257         the instruction list during an interactive rebase.  The format will automatically
2258         have the long commit hash prepended to the format.
2260 receive.advertiseAtomic::
2261         By default, git-receive-pack will advertise the atomic push
2262         capability to its clients. If you don't want to this capability
2263         to be advertised, set this variable to false.
2265 receive.autogc::
2266         By default, git-receive-pack will run "git-gc --auto" after
2267         receiving data from git-push and updating refs.  You can stop
2268         it by setting this variable to false.
2270 receive.certNonceSeed::
2271         By setting this variable to a string, `git receive-pack`
2272         will accept a `git push --signed` and verifies it by using
2273         a "nonce" protected by HMAC using this string as a secret
2274         key.
2276 receive.certNonceSlop::
2277         When a `git push --signed` sent a push certificate with a
2278         "nonce" that was issued by a receive-pack serving the same
2279         repository within this many seconds, export the "nonce"
2280         found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2281         hooks (instead of what the receive-pack asked the sending
2282         side to include).  This may allow writing checks in
2283         `pre-receive` and `post-receive` a bit easier.  Instead of
2284         checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2285         that records by how many seconds the nonce is stale to
2286         decide if they want to accept the certificate, they only
2287         can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2289 receive.fsckObjects::
2290         If it is set to true, git-receive-pack will check all received
2291         objects. It will abort in the case of a malformed object or a
2292         broken link. The result of an abort are only dangling objects.
2293         Defaults to false. If not set, the value of `transfer.fsckObjects`
2294         is used instead.
2296 receive.fsck.<msg-id>::
2297         When `receive.fsckObjects` is set to true, errors can be switched
2298         to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2299         setting where the `<msg-id>` is the fsck message ID and the value
2300         is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2301         the error/warning with the message ID, e.g. "missingEmail: invalid
2302         author/committer line - missing email" means that setting
2303         `receive.fsck.missingEmail = ignore` will hide that issue.
2305 This feature is intended to support working with legacy repositories
2306 which would not pass pushing when `receive.fsckObjects = true`, allowing
2307 the host to accept repositories with certain known issues but still catch
2308 other issues.
2310 receive.fsck.skipList::
2311         The path to a sorted list of object names (i.e. one SHA-1 per
2312         line) that are known to be broken in a non-fatal way and should
2313         be ignored. This feature is useful when an established project
2314         should be accepted despite early commits containing errors that
2315         can be safely ignored such as invalid committer email addresses.
2316         Note: corrupt objects cannot be skipped with this setting.
2318 receive.unpackLimit::
2319         If the number of objects received in a push is below this
2320         limit then the objects will be unpacked into loose object
2321         files. However if the number of received objects equals or
2322         exceeds this limit then the received pack will be stored as
2323         a pack, after adding any missing delta bases.  Storing the
2324         pack from a push can make the push operation complete faster,
2325         especially on slow filesystems.  If not set, the value of
2326         `transfer.unpackLimit` is used instead.
2328 receive.denyDeletes::
2329         If set to true, git-receive-pack will deny a ref update that deletes
2330         the ref. Use this to prevent such a ref deletion via a push.
2332 receive.denyDeleteCurrent::
2333         If set to true, git-receive-pack will deny a ref update that
2334         deletes the currently checked out branch of a non-bare repository.
2336 receive.denyCurrentBranch::
2337         If set to true or "refuse", git-receive-pack will deny a ref update
2338         to the currently checked out branch of a non-bare repository.
2339         Such a push is potentially dangerous because it brings the HEAD
2340         out of sync with the index and working tree. If set to "warn",
2341         print a warning of such a push to stderr, but allow the push to
2342         proceed. If set to false or "ignore", allow such pushes with no
2343         message. Defaults to "refuse".
2345 Another option is "updateInstead" which will update the working
2346 tree if pushing into the current branch.  This option is
2347 intended for synchronizing working directories when one side is not easily
2348 accessible via interactive ssh (e.g. a live web site, hence the requirement
2349 that the working directory be clean). This mode also comes in handy when
2350 developing inside a VM to test and fix code on different Operating Systems.
2352 By default, "updateInstead" will refuse the push if the working tree or
2353 the index have any difference from the HEAD, but the `push-to-checkout`
2354 hook can be used to customize this.  See linkgit:githooks[5].
2356 receive.denyNonFastForwards::
2357         If set to true, git-receive-pack will deny a ref update which is
2358         not a fast-forward. Use this to prevent such an update via a push,
2359         even if that push is forced. This configuration variable is
2360         set when initializing a shared repository.
2362 receive.hideRefs::
2363         This variable is the same as `transfer.hideRefs`, but applies
2364         only to `receive-pack` (and so affects pushes, but not fetches).
2365         An attempt to update or delete a hidden ref by `git push` is
2366         rejected.
2368 receive.updateServerInfo::
2369         If set to true, git-receive-pack will run git-update-server-info
2370         after receiving data from git-push and updating refs.
2372 receive.shallowUpdate::
2373         If set to true, .git/shallow can be updated when new refs
2374         require new shallow roots. Otherwise those refs are rejected.
2376 remote.pushDefault::
2377         The remote to push to by default.  Overrides
2378         `branch.<name>.remote` for all branches, and is overridden by
2379         `branch.<name>.pushRemote` for specific branches.
2381 remote.<name>.url::
2382         The URL of a remote repository.  See linkgit:git-fetch[1] or
2383         linkgit:git-push[1].
2385 remote.<name>.pushurl::
2386         The push URL of a remote repository.  See linkgit:git-push[1].
2388 remote.<name>.proxy::
2389         For remotes that require curl (http, https and ftp), the URL to
2390         the proxy to use for that remote.  Set to the empty string to
2391         disable proxying for that remote.
2393 remote.<name>.fetch::
2394         The default set of "refspec" for linkgit:git-fetch[1]. See
2395         linkgit:git-fetch[1].
2397 remote.<name>.push::
2398         The default set of "refspec" for linkgit:git-push[1]. See
2399         linkgit:git-push[1].
2401 remote.<name>.mirror::
2402         If true, pushing to this remote will automatically behave
2403         as if the `--mirror` option was given on the command line.
2405 remote.<name>.skipDefaultUpdate::
2406         If true, this remote will be skipped by default when updating
2407         using linkgit:git-fetch[1] or the `update` subcommand of
2408         linkgit:git-remote[1].
2410 remote.<name>.skipFetchAll::
2411         If true, this remote will be skipped by default when updating
2412         using linkgit:git-fetch[1] or the `update` subcommand of
2413         linkgit:git-remote[1].
2415 remote.<name>.receivepack::
2416         The default program to execute on the remote side when pushing.  See
2417         option --receive-pack of linkgit:git-push[1].
2419 remote.<name>.uploadpack::
2420         The default program to execute on the remote side when fetching.  See
2421         option --upload-pack of linkgit:git-fetch-pack[1].
2423 remote.<name>.tagOpt::
2424         Setting this value to --no-tags disables automatic tag following when
2425         fetching from remote <name>. Setting it to --tags will fetch every
2426         tag from remote <name>, even if they are not reachable from remote
2427         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2428         override this setting. See options --tags and --no-tags of
2429         linkgit:git-fetch[1].
2431 remote.<name>.vcs::
2432         Setting this to a value <vcs> will cause Git to interact with
2433         the remote with the git-remote-<vcs> helper.
2435 remote.<name>.prune::
2436         When set to true, fetching from this remote by default will also
2437         remove any remote-tracking references that no longer exist on the
2438         remote (as if the `--prune` option was given on the command line).
2439         Overrides `fetch.prune` settings, if any.
2441 remotes.<group>::
2442         The list of remotes which are fetched by "git remote update
2443         <group>".  See linkgit:git-remote[1].
2445 repack.useDeltaBaseOffset::
2446         By default, linkgit:git-repack[1] creates packs that use
2447         delta-base offset. If you need to share your repository with
2448         Git older than version 1.4.4, either directly or via a dumb
2449         protocol such as http, then you need to set this option to
2450         "false" and repack. Access from old Git versions over the
2451         native protocol are unaffected by this option.
2453 repack.packKeptObjects::
2454         If set to true, makes `git repack` act as if
2455         `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2456         details. Defaults to `false` normally, but `true` if a bitmap
2457         index is being written (either via `--write-bitmap-index` or
2458         `repack.writeBitmaps`).
2460 repack.writeBitmaps::
2461         When true, git will write a bitmap index when packing all
2462         objects to disk (e.g., when `git repack -a` is run).  This
2463         index can speed up the "counting objects" phase of subsequent
2464         packs created for clones and fetches, at the cost of some disk
2465         space and extra time spent on the initial repack.  Defaults to
2466         false.
2468 rerere.autoUpdate::
2469         When set to true, `git-rerere` updates the index with the
2470         resulting contents after it cleanly resolves conflicts using
2471         previously recorded resolution.  Defaults to false.
2473 rerere.enabled::
2474         Activate recording of resolved conflicts, so that identical
2475         conflict hunks can be resolved automatically, should they be
2476         encountered again.  By default, linkgit:git-rerere[1] is
2477         enabled if there is an `rr-cache` directory under the
2478         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2479         repository.
2481 sendemail.identity::
2482         A configuration identity. When given, causes values in the
2483         'sendemail.<identity>' subsection to take precedence over
2484         values in the 'sendemail' section. The default identity is
2485         the value of 'sendemail.identity'.
2487 sendemail.smtpEncryption::
2488         See linkgit:git-send-email[1] for description.  Note that this
2489         setting is not subject to the 'identity' mechanism.
2491 sendemail.smtpssl (deprecated)::
2492         Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2494 sendemail.smtpsslcertpath::
2495         Path to ca-certificates (either a directory or a single file).
2496         Set it to an empty string to disable certificate verification.
2498 sendemail.<identity>.*::
2499         Identity-specific versions of the 'sendemail.*' parameters
2500         found below, taking precedence over those when the this
2501         identity is selected, through command-line or
2502         'sendemail.identity'.
2504 sendemail.aliasesFile::
2505 sendemail.aliasFileType::
2506 sendemail.annotate::
2507 sendemail.bcc::
2508 sendemail.cc::
2509 sendemail.ccCmd::
2510 sendemail.chainReplyTo::
2511 sendemail.confirm::
2512 sendemail.envelopeSender::
2513 sendemail.from::
2514 sendemail.multiEdit::
2515 sendemail.signedoffbycc::
2516 sendemail.smtpPass::
2517 sendemail.suppresscc::
2518 sendemail.suppressFrom::
2519 sendemail.to::
2520 sendemail.smtpDomain::
2521 sendemail.smtpServer::
2522 sendemail.smtpServerPort::
2523 sendemail.smtpServerOption::
2524 sendemail.smtpUser::
2525 sendemail.thread::
2526 sendemail.transferEncoding::
2527 sendemail.validate::
2528 sendemail.xmailer::
2529         See linkgit:git-send-email[1] for description.
2531 sendemail.signedoffcc (deprecated)::
2532         Deprecated alias for 'sendemail.signedoffbycc'.
2534 showbranch.default::
2535         The default set of branches for linkgit:git-show-branch[1].
2536         See linkgit:git-show-branch[1].
2538 status.relativePaths::
2539         By default, linkgit:git-status[1] shows paths relative to the
2540         current directory. Setting this variable to `false` shows paths
2541         relative to the repository root (this was the default for Git
2542         prior to v1.5.4).
2544 status.short::
2545         Set to true to enable --short by default in linkgit:git-status[1].
2546         The option --no-short takes precedence over this variable.
2548 status.branch::
2549         Set to true to enable --branch by default in linkgit:git-status[1].
2550         The option --no-branch takes precedence over this variable.
2552 status.displayCommentPrefix::
2553         If set to true, linkgit:git-status[1] will insert a comment
2554         prefix before each output line (starting with
2555         `core.commentChar`, i.e. `#` by default). This was the
2556         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2557         Defaults to false.
2559 status.showUntrackedFiles::
2560         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2561         files which are not currently tracked by Git. Directories which
2562         contain only untracked files, are shown with the directory name
2563         only. Showing untracked files means that Git needs to lstat() all
2564         the files in the whole repository, which might be slow on some
2565         systems. So, this variable controls how the commands displays
2566         the untracked files. Possible values are:
2569 * `no` - Show no untracked files.
2570 * `normal` - Show untracked files and directories.
2571 * `all` - Show also individual files in untracked directories.
2574 If this variable is not specified, it defaults to 'normal'.
2575 This variable can be overridden with the -u|--untracked-files option
2576 of linkgit:git-status[1] and linkgit:git-commit[1].
2578 status.submoduleSummary::
2579         Defaults to false.
2580         If this is set to a non zero number or true (identical to -1 or an
2581         unlimited number), the submodule summary will be enabled and a
2582         summary of commits for modified submodules will be shown (see
2583         --summary-limit option of linkgit:git-submodule[1]). Please note
2584         that the summary output command will be suppressed for all
2585         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2586         for those submodules where `submodule.<name>.ignore=all`. The only
2587         exception to that rule is that status and commit will show staged
2588         submodule changes. To
2589         also view the summary for ignored submodules you can either use
2590         the --ignore-submodules=dirty command-line option or the 'git
2591         submodule summary' command, which shows a similar output but does
2592         not honor these settings.
2594 stash.showPatch::
2595         If this is set to true, the `git stash show` command without an
2596         option will show the stash in patch form.  Defaults to false.
2597         See description of 'show' command in linkgit:git-stash[1].
2599 stash.showStat::
2600         If this is set to true, the `git stash show` command without an
2601         option will show diffstat of the stash.  Defaults to true.
2602         See description of 'show' command in linkgit:git-stash[1].
2604 submodule.<name>.path::
2605 submodule.<name>.url::
2606         The path within this project and URL for a submodule. These
2607         variables are initially populated by 'git submodule init'. See
2608         linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2609         details.
2611 submodule.<name>.update::
2612         The default update procedure for a submodule. This variable
2613         is populated by `git submodule init` from the
2614         linkgit:gitmodules[5] file. See description of 'update'
2615         command in linkgit:git-submodule[1].
2617 submodule.<name>.branch::
2618         The remote branch name for a submodule, used by `git submodule
2619         update --remote`.  Set this option to override the value found in
2620         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2621         linkgit:gitmodules[5] for details.
2623 submodule.<name>.fetchRecurseSubmodules::
2624         This option can be used to control recursive fetching of this
2625         submodule. It can be overridden by using the --[no-]recurse-submodules
2626         command-line option to "git fetch" and "git pull".
2627         This setting will override that from in the linkgit:gitmodules[5]
2628         file.
2630 submodule.<name>.ignore::
2631         Defines under what circumstances "git status" and the diff family show
2632         a submodule as modified. When set to "all", it will never be considered
2633         modified (but it will nonetheless show up in the output of status and
2634         commit when it has been staged), "dirty" will ignore all changes
2635         to the submodules work tree and
2636         takes only differences between the HEAD of the submodule and the commit
2637         recorded in the superproject into account. "untracked" will additionally
2638         let submodules with modified tracked files in their work tree show up.
2639         Using "none" (the default when this option is not set) also shows
2640         submodules that have untracked files in their work tree as changed.
2641         This setting overrides any setting made in .gitmodules for this submodule,
2642         both settings can be overridden on the command line by using the
2643         "--ignore-submodules" option. The 'git submodule' commands are not
2644         affected by this setting.
2646 tag.sort::
2647         This variable controls the sort ordering of tags when displayed by
2648         linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2649         value of this variable will be used as the default.
2651 tar.umask::
2652         This variable can be used to restrict the permission bits of
2653         tar archive entries.  The default is 0002, which turns off the
2654         world write bit.  The special value "user" indicates that the
2655         archiving user's umask will be used instead.  See umask(2) and
2656         linkgit:git-archive[1].
2658 transfer.fsckObjects::
2659         When `fetch.fsckObjects` or `receive.fsckObjects` are
2660         not set, the value of this variable is used instead.
2661         Defaults to false.
2663 transfer.hideRefs::
2664         String(s) `receive-pack` and `upload-pack` use to decide which
2665         refs to omit from their initial advertisements.  Use more than
2666         one definition to specify multiple prefix strings. A ref that is
2667         under the hierarchies listed in the value of this variable is
2668         excluded, and is hidden when responding to `git push` or `git
2669         fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
2670         program-specific versions of this config.
2672 You may also include a `!` in front of the ref name to negate the entry,
2673 explicitly exposing it, even if an earlier entry marked it as hidden.
2674 If you have multiple hideRefs values, later entries override earlier ones
2675 (and entries in more-specific config files override less-specific ones).
2677 transfer.unpackLimit::
2678         When `fetch.unpackLimit` or `receive.unpackLimit` are
2679         not set, the value of this variable is used instead.
2680         The default value is 100.
2682 uploadarchive.allowUnreachable::
2683         If true, allow clients to use `git archive --remote` to request
2684         any tree, whether reachable from the ref tips or not. See the
2685         discussion in the `SECURITY` section of
2686         linkgit:git-upload-archive[1] for more details. Defaults to
2687         `false`.
2689 uploadpack.hideRefs::
2690         This variable is the same as `transfer.hideRefs`, but applies
2691         only to `upload-pack` (and so affects only fetches, not pushes).
2692         An attempt to fetch a hidden ref by `git fetch` will fail.  See
2693         also `uploadpack.allowTipSHA1InWant`.
2695 uploadpack.allowTipSHA1InWant::
2696         When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2697         to accept a fetch request that asks for an object at the tip
2698         of a hidden ref (by default, such a request is rejected).
2699         see also `uploadpack.hideRefs`.
2701 uploadpack.allowReachableSHA1InWant::
2702         Allow `upload-pack` to accept a fetch request that asks for an
2703         object that is reachable from any ref tip. However, note that
2704         calculating object reachability is computationally expensive.
2705         Defaults to `false`.
2707 uploadpack.keepAlive::
2708         When `upload-pack` has started `pack-objects`, there may be a
2709         quiet period while `pack-objects` prepares the pack. Normally
2710         it would output progress information, but if `--quiet` was used
2711         for the fetch, `pack-objects` will output nothing at all until
2712         the pack data begins. Some clients and networks may consider
2713         the server to be hung and give up. Setting this option instructs
2714         `upload-pack` to send an empty keepalive packet every
2715         `uploadpack.keepAlive` seconds. Setting this option to 0
2716         disables keepalive packets entirely. The default is 5 seconds.
2718 url.<base>.insteadOf::
2719         Any URL that starts with this value will be rewritten to
2720         start, instead, with <base>. In cases where some site serves a
2721         large number of repositories, and serves them with multiple
2722         access methods, and some users need to use different access
2723         methods, this feature allows people to specify any of the
2724         equivalent URLs and have Git automatically rewrite the URL to
2725         the best alternative for the particular user, even for a
2726         never-before-seen repository on the site.  When more than one
2727         insteadOf strings match a given URL, the longest match is used.
2729 url.<base>.pushInsteadOf::
2730         Any URL that starts with this value will not be pushed to;
2731         instead, it will be rewritten to start with <base>, and the
2732         resulting URL will be pushed to. In cases where some site serves
2733         a large number of repositories, and serves them with multiple
2734         access methods, some of which do not allow push, this feature
2735         allows people to specify a pull-only URL and have Git
2736         automatically use an appropriate URL to push, even for a
2737         never-before-seen repository on the site.  When more than one
2738         pushInsteadOf strings match a given URL, the longest match is
2739         used.  If a remote has an explicit pushurl, Git will ignore this
2740         setting for that remote.
2742 user.email::
2743         Your email address to be recorded in any newly created commits.
2744         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2745         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2747 user.name::
2748         Your full name to be recorded in any newly created commits.
2749         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2750         environment variables.  See linkgit:git-commit-tree[1].
2752 user.signingKey::
2753         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2754         key you want it to automatically when creating a signed tag or
2755         commit, you can override the default selection with this variable.
2756         This option is passed unchanged to gpg's --local-user parameter,
2757         so you may specify a key using any method that gpg supports.
2759 versionsort.prereleaseSuffix::
2760         When version sort is used in linkgit:git-tag[1], prerelease
2761         tags (e.g. "1.0-rc1") may appear after the main release
2762         "1.0". By specifying the suffix "-rc" in this variable,
2763         "1.0-rc1" will appear before "1.0".
2765 This variable can be specified multiple times, once per suffix. The
2766 order of suffixes in the config file determines the sorting order
2767 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2768 is sorted before 1.0-rcXX). The sorting order between different
2769 suffixes is undefined if they are in multiple config files.
2771 web.browser::
2772         Specify a web browser that may be used by some commands.
2773         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2774         may use it.