add infrastructure for read-only file system level caches
[git/mingw/4msysgit.git] / Documentation / config.txt
blob15c340bd4cafdca5e209f5b22a26df758905059c
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.
19 Syntax
20 ~~~~~~
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored.  The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables.  A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins.  Section names are not case sensitive.  Only alphanumeric
29 characters, `-` and `.` are allowed in section names.  Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections.  To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
37 --------
38         [section "subsection"]
40 --------
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively).  Section headers cannot span multiple
45 lines.  Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'.  If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character.  There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
68 1/0, true/false or on/off.  Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS).  No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
102 Example
103 ~~~~~~~
105         # Core variables
106         [core]
107                 ; Don't trust file modes
108                 filemode = false
110         # Our diff algorithm
111         [diff]
112                 external = /usr/local/bin/diff-wrapper
113                 renames = true
115         [branch "devel"]
116                 remote = origin
117                 merge = refs/heads/devel
119         # Proxy settings
120         [core]
121                 gitProxy="ssh" for "kernel.org"
122                 gitProxy=default-proxy ; for the rest
124         [include]
125                 path = /path/to/foo.inc ; include by absolute path
126                 path = foo ; expand "foo" relative to the current file
127                 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
137 advice.*::
138         These variables control various optional help messages designed to
139         aid new users. All 'advice.*' variables default to 'true', and you
140         can tell Git that you do not need help by setting these to 'false':
143         pushUpdateRejected::
144                 Set this variable to 'false' if you want to disable
145                 'pushNonFFCurrent', 'pushNonFFDefault',
146                 'pushNonFFMatching', 'pushAlreadyExists',
147                 'pushFetchFirst', and 'pushNeedsForce'
148                 simultaneously.
149         pushNonFFCurrent::
150                 Advice shown when linkgit:git-push[1] fails due to a
151                 non-fast-forward update to the current branch.
152         pushNonFFDefault::
153                 Advice to set 'push.default' to 'upstream' or 'current'
154                 when you ran linkgit:git-push[1] and pushed 'matching
155                 refs' by default (i.e. you did not provide an explicit
156                 refspec, and no 'push.default' configuration was set)
157                 and it resulted in a non-fast-forward error.
158         pushNonFFMatching::
159                 Advice shown when you ran linkgit:git-push[1] and pushed
160                 'matching refs' explicitly (i.e. you used ':', or
161                 specified a refspec that isn't your current branch) and
162                 it resulted in a non-fast-forward error.
163         pushAlreadyExists::
164                 Shown when linkgit:git-push[1] rejects an update that
165                 does not qualify for fast-forwarding (e.g., a tag.)
166         pushFetchFirst::
167                 Shown when linkgit:git-push[1] rejects an update that
168                 tries to overwrite a remote ref that points at an
169                 object we do not have.
170         pushNeedsForce::
171                 Shown when linkgit:git-push[1] rejects an update that
172                 tries to overwrite a remote ref that points at an
173                 object that is not a commit-ish, or make the remote
174                 ref point at an object that is not a commit-ish.
175         statusHints::
176                 Show directions on how to proceed from the current
177                 state in the output of linkgit:git-status[1], in
178                 the template shown when writing commit messages in
179                 linkgit:git-commit[1], and in the help message shown
180                 by linkgit:git-checkout[1] when switching branch.
181         statusUoption::
182                 Advise to consider using the `-u` option to linkgit:git-status[1]
183                 when the command takes more than 2 seconds to enumerate untracked
184                 files.
185         commitBeforeMerge::
186                 Advice shown when linkgit:git-merge[1] refuses to
187                 merge to avoid overwriting local changes.
188         resolveConflict::
189                 Advice shown by various commands when conflicts
190                 prevent the operation from being performed.
191         implicitIdentity::
192                 Advice on how to set your identity configuration when
193                 your information is guessed from the system username and
194                 domain name.
195         detachedHead::
196                 Advice shown when you used linkgit:git-checkout[1] to
197                 move to the detach HEAD state, to instruct how to create
198                 a local branch after the fact.
199         amWorkDir::
200                 Advice that shows the location of the patch file when
201                 linkgit:git-am[1] fails to apply it.
202         rmHints::
203                 In case of failure in the output of linkgit:git-rm[1],
204                 show directions on how to proceed from the current state.
207 core.fileMode::
208         If false, the executable bit differences between the index and
209         the working tree are ignored; useful on broken filesystems like FAT.
210         See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
216 core.hideDotFiles::
217         (Windows-only) If true (which is the default), mark newly-created
218         directories and files whose name starts with a dot as hidden.
219         If 'dotGitOnly', only the .git/ directory is hidden, but no other
220         files starting with a dot.
222 core.ignorecase::
223         If true, this option enables various workarounds to enable
224         Git to work better on filesystems that are not case sensitive,
225         like FAT. For example, if a directory listing finds
226         "makefile" when Git expects "Makefile", Git will assume
227         it is really the same file, and continue to remember it as
228         "Makefile".
230 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
231 will probe and set core.ignorecase true if appropriate when the repository
232 is created.
234 core.precomposeunicode::
235         This option is only used by Mac OS implementation of Git.
236         When core.precomposeunicode=true, Git reverts the unicode decomposition
237         of filenames done by Mac OS. This is useful when sharing a repository
238         between Mac OS and Linux or Windows.
239         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
240         When false, file names are handled fully transparent by Git,
241         which is backward compatible with older versions of Git.
243 core.trustctime::
244         If false, the ctime differences between the index and the
245         working tree are ignored; useful when the inode change time
246         is regularly modified by something outside Git (file system
247         crawlers and some backup systems).
248         See linkgit:git-update-index[1]. True by default.
250 core.checkstat::
251         Determines which stat fields to match between the index
252         and work tree. The user can set this to 'default' or
253         'minimal'. Default (or explicitly 'default'), is to check
254         all fields, including the sub-second part of mtime and ctime.
256 core.quotepath::
257         The commands that output paths (e.g. 'ls-files',
258         'diff'), when not given the `-z` option, will quote
259         "unusual" characters in the pathname by enclosing the
260         pathname in a double-quote pair and with backslashes the
261         same way strings in C source code are quoted.  If this
262         variable is set to false, the bytes higher than 0x80 are
263         not quoted but output as verbatim.  Note that double
264         quote, backslash and control characters are always
265         quoted without `-z` regardless of the setting of this
266         variable.
268 core.eol::
269         Sets the line ending type to use in the working directory for
270         files that have the `text` property set.  Alternatives are
271         'lf', 'crlf' and 'native', which uses the platform's native
272         line ending.  The default value is `native`.  See
273         linkgit:gitattributes[5] for more information on end-of-line
274         conversion.
276 core.safecrlf::
277         If true, makes Git check if converting `CRLF` is reversible when
278         end-of-line conversion is active.  Git will verify if a command
279         modifies a file in the work tree either directly or indirectly.
280         For example, committing a file followed by checking out the
281         same file should yield the original file in the work tree.  If
282         this is not the case for the current setting of
283         `core.autocrlf`, Git will reject the file.  The variable can
284         be set to "warn", in which case Git will only warn about an
285         irreversible conversion but continue the operation.
287 CRLF conversion bears a slight chance of corrupting data.
288 When it is enabled, Git will convert CRLF to LF during commit and LF to
289 CRLF during checkout.  A file that contains a mixture of LF and
290 CRLF before the commit cannot be recreated by Git.  For text
291 files this is the right thing to do: it corrects line endings
292 such that we have only LF line endings in the repository.
293 But for binary files that are accidentally classified as text the
294 conversion can corrupt data.
296 If you recognize such corruption early you can easily fix it by
297 setting the conversion type explicitly in .gitattributes.  Right
298 after committing you still have the original file in your work
299 tree and this file is not yet corrupted.  You can explicitly tell
300 Git that this file is binary and Git will handle the file
301 appropriately.
303 Unfortunately, the desired effect of cleaning up text files with
304 mixed line endings and the undesired effect of corrupting binary
305 files cannot be distinguished.  In both cases CRLFs are removed
306 in an irreversible way.  For text files this is the right thing
307 to do because CRLFs are line endings, while for binary files
308 converting CRLFs corrupts data.
310 Note, this safety check does not mean that a checkout will generate a
311 file identical to the original file for a different setting of
312 `core.eol` and `core.autocrlf`, but only for the current one.  For
313 example, a text file with `LF` would be accepted with `core.eol=lf`
314 and could later be checked out with `core.eol=crlf`, in which case the
315 resulting file would contain `CRLF`, although the original file
316 contained `LF`.  However, in both work trees the line endings would be
317 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
318 file with mixed line endings would be reported by the `core.safecrlf`
319 mechanism.
321 core.autocrlf::
322         Setting this variable to "true" is almost the same as setting
323         the `text` attribute to "auto" on all files except that text
324         files are not guaranteed to be normalized: files that contain
325         `CRLF` in the repository will not be touched.  Use this
326         setting if you want to have `CRLF` line endings in your
327         working directory even though the repository does not have
328         normalized line endings.  This variable can be set to 'input',
329         in which case no output conversion is performed.
331 core.symlinks::
332         If false, symbolic links are checked out as small plain files that
333         contain the link text. linkgit:git-update-index[1] and
334         linkgit:git-add[1] will not change the recorded type to regular
335         file. Useful on filesystems like FAT that do not support
336         symbolic links.
338 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
339 will probe and set core.symlinks false if appropriate when the repository
340 is created.
342 core.gitProxy::
343         A "proxy command" to execute (as 'command host port') instead
344         of establishing direct connection to the remote server when
345         using the Git protocol for fetching. If the variable value is
346         in the "COMMAND for DOMAIN" format, the command is applied only
347         on hostnames ending with the specified domain string. This variable
348         may be set multiple times and is matched in the given order;
349         the first match wins.
351 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
352 (which always applies universally, without the special "for"
353 handling).
355 The special string `none` can be used as the proxy command to
356 specify that no proxy be used for a given domain pattern.
357 This is useful for excluding servers inside a firewall from
358 proxy use, while defaulting to a common proxy for external domains.
360 core.ignoreStat::
361         If true, commands which modify both the working tree and the index
362         will mark the updated paths with the "assume unchanged" bit in the
363         index. These marked files are then assumed to stay unchanged in the
364         working tree, until you mark them otherwise manually - Git will not
365         detect the file changes by lstat() calls. This is useful on systems
366         where those are very slow, such as Microsoft Windows.
367         See linkgit:git-update-index[1].
368         False by default.
370 core.preferSymlinkRefs::
371         Instead of the default "symref" format for HEAD
372         and other symbolic reference files, use symbolic links.
373         This is sometimes needed to work with old scripts that
374         expect HEAD to be a symbolic link.
376 core.bare::
377         If true this repository is assumed to be 'bare' and has no
378         working directory associated with it.  If this is the case a
379         number of commands that require a working directory will be
380         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
382 This setting is automatically guessed by linkgit:git-clone[1] or
383 linkgit:git-init[1] when the repository was created.  By default a
384 repository that ends in "/.git" is assumed to be not bare (bare =
385 false), while all other repositories are assumed to be bare (bare
386 = true).
388 core.worktree::
389         Set the path to the root of the working tree.
390         This can be overridden by the GIT_WORK_TREE environment
391         variable and the '--work-tree' command line option.
392         The value can be an absolute path or relative to the path to
393         the .git directory, which is either specified by --git-dir
394         or GIT_DIR, or automatically discovered.
395         If --git-dir or GIT_DIR is specified but none of
396         --work-tree, GIT_WORK_TREE and core.worktree is specified,
397         the current working directory is regarded as the top level
398         of your working tree.
400 Note that this variable is honored even when set in a configuration
401 file in a ".git" subdirectory of a directory and its value differs
402 from the latter directory (e.g. "/path/to/.git/config" has
403 core.worktree set to "/different/path"), which is most likely a
404 misconfiguration.  Running Git commands in the "/path/to" directory will
405 still use "/different/path" as the root of the work tree and can cause
406 confusion unless you know what you are doing (e.g. you are creating a
407 read-only snapshot of the same index to a location different from the
408 repository's usual working tree).
410 core.logAllRefUpdates::
411         Enable the reflog. Updates to a ref <ref> is logged to the file
412         "$GIT_DIR/logs/<ref>", by appending the new and old
413         SHA-1, the date/time and the reason of the update, but
414         only when the file exists.  If this configuration
415         variable is set to true, missing "$GIT_DIR/logs/<ref>"
416         file is automatically created for branch heads (i.e. under
417         refs/heads/), remote refs (i.e. under refs/remotes/),
418         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
420 This information can be used to determine what commit
421 was the tip of a branch "2 days ago".
423 This value is true by default in a repository that has
424 a working directory associated with it, and false by
425 default in a bare repository.
427 core.repositoryFormatVersion::
428         Internal variable identifying the repository format and layout
429         version.
431 core.sharedRepository::
432         When 'group' (or 'true'), the repository is made shareable between
433         several users in a group (making sure all the files and objects are
434         group-writable). When 'all' (or 'world' or 'everybody'), the
435         repository will be readable by all users, additionally to being
436         group-shareable. When 'umask' (or 'false'), Git will use permissions
437         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
438         files in the repository will have this mode value. '0xxx' will override
439         user's umask value (whereas the other options will only override
440         requested parts of the user's umask value). Examples: '0660' will make
441         the repo read/write-able for the owner and group, but inaccessible to
442         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
443         repository that is group-readable but not group-writable.
444         See linkgit:git-init[1]. False by default.
446 core.warnAmbiguousRefs::
447         If true, Git will warn you if the ref name you passed it is ambiguous
448         and might match multiple refs in the repository. True by default.
450 core.compression::
451         An integer -1..9, indicating a default compression level.
452         -1 is the zlib default. 0 means no compression,
453         and 1..9 are various speed/size tradeoffs, 9 being slowest.
454         If set, this provides a default to other compression variables,
455         such as 'core.loosecompression' and 'pack.compression'.
457 core.loosecompression::
458         An integer -1..9, indicating the compression level for objects that
459         are not in a pack file. -1 is the zlib default. 0 means no
460         compression, and 1..9 are various speed/size tradeoffs, 9 being
461         slowest.  If not set,  defaults to core.compression.  If that is
462         not set,  defaults to 1 (best speed).
464 core.packedGitWindowSize::
465         Number of bytes of a pack file to map into memory in a
466         single mapping operation.  Larger window sizes may allow
467         your system to process a smaller number of large pack files
468         more quickly.  Smaller window sizes will negatively affect
469         performance due to increased calls to the operating system's
470         memory manager, but may improve performance when accessing
471         a large number of large pack files.
473 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
474 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
475 be reasonable for all users/operating systems.  You probably do
476 not need to adjust this value.
478 Common unit suffixes of 'k', 'm', or 'g' are supported.
480 core.packedGitLimit::
481         Maximum number of bytes to map simultaneously into memory
482         from pack files.  If Git needs to access more than this many
483         bytes at once to complete an operation it will unmap existing
484         regions to reclaim virtual address space within the process.
486 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
487 This should be reasonable for all users/operating systems, except on
488 the largest projects.  You probably do not need to adjust this value.
490 Common unit suffixes of 'k', 'm', or 'g' are supported.
492 core.deltaBaseCacheLimit::
493         Maximum number of bytes to reserve for caching base objects
494         that may be referenced by multiple deltified objects.  By storing the
495         entire decompressed base objects in a cache Git is able
496         to avoid unpacking and decompressing frequently used base
497         objects multiple times.
499 Default is 16 MiB on all platforms.  This should be reasonable
500 for all users/operating systems, except on the largest projects.
501 You probably do not need to adjust this value.
503 Common unit suffixes of 'k', 'm', or 'g' are supported.
505 core.bigFileThreshold::
506         Files larger than this size are stored deflated, without
507         attempting delta compression.  Storing large files without
508         delta compression avoids excessive memory usage, at the
509         slight expense of increased disk usage.
511 Default is 512 MiB on all platforms.  This should be reasonable
512 for most projects as source code and other text files can still
513 be delta compressed, but larger binary media files won't be.
515 Common unit suffixes of 'k', 'm', or 'g' are supported.
517 core.excludesfile::
518         In addition to '.gitignore' (per-directory) and
519         '.git/info/exclude', Git looks into this file for patterns
520         of files which are not meant to be tracked.  "`~/`" is expanded
521         to the value of `$HOME` and "`~user/`" to the specified user's
522         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
523         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
524         is used instead. See linkgit:gitignore[5].
526 core.askpass::
527         Some commands (e.g. svn and http interfaces) that interactively
528         ask for a password can be told to use an external program given
529         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
530         environment variable. If not set, fall back to the value of the
531         'SSH_ASKPASS' environment variable or, failing that, a simple password
532         prompt. The external program shall be given a suitable prompt as
533         command line argument and write the password on its STDOUT.
535 core.attributesfile::
536         In addition to '.gitattributes' (per-directory) and
537         '.git/info/attributes', Git looks into this file for attributes
538         (see linkgit:gitattributes[5]). Path expansions are made the same
539         way as for `core.excludesfile`. Its default value is
540         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
541         set or empty, $HOME/.config/git/attributes is used instead.
543 core.editor::
544         Commands such as `commit` and `tag` that lets you edit
545         messages by launching an editor uses the value of this
546         variable when it is set, and the environment variable
547         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
549 core.commentchar::
550         Commands such as `commit` and `tag` that lets you edit
551         messages consider a line that begins with this character
552         commented, and removes them after the editor returns
553         (default '#').
555 sequence.editor::
556         Text editor used by `git rebase -i` for editing the rebase instruction file.
557         The value is meant to be interpreted by the shell when it is used.
558         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
559         When not configured the default commit message editor is used instead.
561 core.pager::
562         Text viewer for use by Git commands (e.g., 'less').  The value
563         is meant to be interpreted by the shell.  The order of preference
564         is the `$GIT_PAGER` environment variable, then `core.pager`
565         configuration, then `$PAGER`, and then the default chosen at
566         compile time (usually 'less').
568 When the `LESS` environment variable is unset, Git sets it to `FRSX`
569 (if `LESS` environment variable is set, Git does not change it at
570 all).  If you want to selectively override Git's default setting
571 for `LESS`, you can set `core.pager` to e.g. `less -+S`.  This will
572 be passed to the shell by Git, which will translate the final
573 command to `LESS=FRSX less -+S`. The environment tells the command
574 to set the `S` option to chop long lines but the command line
575 resets it to the default to fold long lines.
577 core.whitespace::
578         A comma separated list of common whitespace problems to
579         notice.  'git diff' will use `color.diff.whitespace` to
580         highlight them, and 'git apply --whitespace=error' will
581         consider them as errors.  You can prefix `-` to disable
582         any of them (e.g. `-trailing-space`):
584 * `blank-at-eol` treats trailing whitespaces at the end of the line
585   as an error (enabled by default).
586 * `space-before-tab` treats a space character that appears immediately
587   before a tab character in the initial indent part of the line as an
588   error (enabled by default).
589 * `indent-with-non-tab` treats a line that is indented with space
590   characters instead of the equivalent tabs as an error (not enabled by
591   default).
592 * `tab-in-indent` treats a tab character in the initial indent part of
593   the line as an error (not enabled by default).
594 * `blank-at-eof` treats blank lines added at the end of file as an error
595   (enabled by default).
596 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
597   `blank-at-eof`.
598 * `cr-at-eol` treats a carriage-return at the end of line as
599   part of the line terminator, i.e. with it, `trailing-space`
600   does not trigger if the character before such a carriage-return
601   is not a whitespace (not enabled by default).
602 * `tabwidth=<n>` tells how many character positions a tab occupies; this
603   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
604   errors. The default tab width is 8. Allowed values are 1 to 63.
606 core.fsyncobjectfiles::
607         This boolean will enable 'fsync()' when writing object files.
609 This is a total waste of time and effort on a filesystem that orders
610 data writes properly, but can be useful for filesystems that do not use
611 journalling (traditional UNIX filesystems) or that only journal metadata
612 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
614 core.preloadindex::
615         Enable parallel index preload for operations like 'git diff'
617 This can speed up operations like 'git diff' and 'git status' especially
618 on filesystems like NFS that have weak caching semantics and thus
619 relatively high IO latencies.  With this set to 'true', Git will do the
620 index comparison to the filesystem data in parallel, allowing
621 overlapping IO's.
623 core.fscache::
624         Enable additional caching of file system data for some operations.
626 Git for Windows uses this to bulk-read and cache lstat data of entire
627 directories (instead of doing lstat file by file).
629 core.createObject::
630         You can set this to 'link', in which case a hardlink followed by
631         a delete of the source are used to make sure that object creation
632         will not overwrite existing objects.
634 On some file system/operating system combinations, this is unreliable.
635 Set this config setting to 'rename' there; However, This will remove the
636 check that makes sure that existing object files will not get overwritten.
638 core.notesRef::
639         When showing commit messages, also show notes which are stored in
640         the given ref.  The ref must be fully qualified.  If the given
641         ref does not exist, it is not an error but means that no
642         notes should be printed.
644 This setting defaults to "refs/notes/commits", and it can be overridden by
645 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
647 core.sparseCheckout::
648         Enable "sparse checkout" feature. See section "Sparse checkout" in
649         linkgit:git-read-tree[1] for more information.
651 core.abbrev::
652         Set the length object names are abbreviated to.  If unspecified,
653         many commands abbreviate to 7 hexdigits, which may not be enough
654         for abbreviated object names to stay unique for sufficiently long
655         time.
657 add.ignore-errors::
658 add.ignoreErrors::
659         Tells 'git add' to continue adding files when some files cannot be
660         added due to indexing errors. Equivalent to the '--ignore-errors'
661         option of linkgit:git-add[1].  Older versions of Git accept only
662         `add.ignore-errors`, which does not follow the usual naming
663         convention for configuration variables.  Newer versions of Git
664         honor `add.ignoreErrors` as well.
666 alias.*::
667         Command aliases for the linkgit:git[1] command wrapper - e.g.
668         after defining "alias.last = cat-file commit HEAD", the invocation
669         "git last" is equivalent to "git cat-file commit HEAD". To avoid
670         confusion and troubles with script usage, aliases that
671         hide existing Git commands are ignored. Arguments are split by
672         spaces, the usual shell quoting and escaping is supported.
673         quote pair and a backslash can be used to quote them.
675 If the alias expansion is prefixed with an exclamation point,
676 it will be treated as a shell command.  For example, defining
677 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
678 "git new" is equivalent to running the shell command
679 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
680 executed from the top-level directory of a repository, which may
681 not necessarily be the current directory.
682 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
683 from the original current directory. See linkgit:git-rev-parse[1].
685 am.keepcr::
686         If true, git-am will call git-mailsplit for patches in mbox format
687         with parameter '--keep-cr'. In this case git-mailsplit will
688         not remove `\r` from lines ending with `\r\n`. Can be overridden
689         by giving '--no-keep-cr' from the command line.
690         See linkgit:git-am[1], linkgit:git-mailsplit[1].
692 apply.ignorewhitespace::
693         When set to 'change', tells 'git apply' to ignore changes in
694         whitespace, in the same way as the '--ignore-space-change'
695         option.
696         When set to one of: no, none, never, false tells 'git apply' to
697         respect all whitespace differences.
698         See linkgit:git-apply[1].
700 apply.whitespace::
701         Tells 'git apply' how to handle whitespaces, in the same way
702         as the '--whitespace' option. See linkgit:git-apply[1].
704 branch.autosetupmerge::
705         Tells 'git branch' and 'git checkout' to set up new branches
706         so that linkgit:git-pull[1] will appropriately merge from the
707         starting point branch. Note that even if this option is not set,
708         this behavior can be chosen per-branch using the `--track`
709         and `--no-track` options. The valid settings are: `false` -- no
710         automatic setup is done; `true` -- automatic setup is done when the
711         starting point is a remote-tracking branch; `always` --
712         automatic setup is done when the starting point is either a
713         local branch or remote-tracking
714         branch. This option defaults to true.
716 branch.autosetuprebase::
717         When a new branch is created with 'git branch' or 'git checkout'
718         that tracks another branch, this variable tells Git to set
719         up pull to rebase instead of merge (see "branch.<name>.rebase").
720         When `never`, rebase is never automatically set to true.
721         When `local`, rebase is set to true for tracked branches of
722         other local branches.
723         When `remote`, rebase is set to true for tracked branches of
724         remote-tracking branches.
725         When `always`, rebase will be set to true for all tracking
726         branches.
727         See "branch.autosetupmerge" for details on how to set up a
728         branch to track another branch.
729         This option defaults to never.
731 branch.<name>.remote::
732         When on branch <name>, it tells 'git fetch' and 'git push'
733         which remote to fetch from/push to.  The remote to push to
734         may be overridden with `remote.pushdefault` (for all branches).
735         The remote to push to, for the current branch, may be further
736         overridden by `branch.<name>.pushremote`.  If no remote is
737         configured, or if you are not on any branch, it defaults to
738         `origin` for fetching and `remote.pushdefault` for pushing.
739         Additionally, `.` (a period) is the current local repository
740         (a dot-repository), see `branch.<name>.merge`'s final note below.
742 branch.<name>.pushremote::
743         When on branch <name>, it overrides `branch.<name>.remote` for
744         pushing.  It also overrides `remote.pushdefault` for pushing
745         from branch <name>.  When you pull from one place (e.g. your
746         upstream) and push to another place (e.g. your own publishing
747         repository), you would want to set `remote.pushdefault` to
748         specify the remote to push to for all branches, and use this
749         option to override it for a specific branch.
751 branch.<name>.merge::
752         Defines, together with branch.<name>.remote, the upstream branch
753         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
754         branch to merge and can also affect 'git push' (see push.default).
755         When in branch <name>, it tells 'git fetch' the default
756         refspec to be marked for merging in FETCH_HEAD. The value is
757         handled like the remote part of a refspec, and must match a
758         ref which is fetched from the remote given by
759         "branch.<name>.remote".
760         The merge information is used by 'git pull' (which at first calls
761         'git fetch') to lookup the default branch for merging. Without
762         this option, 'git pull' defaults to merge the first refspec fetched.
763         Specify multiple values to get an octopus merge.
764         If you wish to setup 'git pull' so that it merges into <name> from
765         another branch in the local repository, you can point
766         branch.<name>.merge to the desired branch, and use the relative path
767         setting `.` (a period) for branch.<name>.remote.
769 branch.<name>.mergeoptions::
770         Sets default options for merging into branch <name>. The syntax and
771         supported options are the same as those of linkgit:git-merge[1], but
772         option values containing whitespace characters are currently not
773         supported.
775 branch.<name>.rebase::
776         When true, rebase the branch <name> on top of the fetched branch,
777         instead of merging the default branch from the default remote when
778         "git pull" is run. See "pull.rebase" for doing this in a non
779         branch-specific manner.
780         When the value is `interactive`, the rebase is run in interactive mode.
782         When preserve, also pass `--preserve-merges` along to 'git rebase'
783         so that locally committed merge commits will not be flattened
784         by running 'git pull'.
786 *NOTE*: this is a possibly dangerous operation; do *not* use
787 it unless you understand the implications (see linkgit:git-rebase[1]
788 for details).
790 branch.<name>.description::
791         Branch description, can be edited with
792         `git branch --edit-description`. Branch description is
793         automatically added in the format-patch cover letter or
794         request-pull summary.
796 browser.<tool>.cmd::
797         Specify the command to invoke the specified browser. The
798         specified command is evaluated in shell with the URLs passed
799         as arguments. (See linkgit:git-web{litdd}browse[1].)
801 browser.<tool>.path::
802         Override the path for the given tool that may be used to
803         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
804         working repository in gitweb (see linkgit:git-instaweb[1]).
806 clean.requireForce::
807         A boolean to make git-clean do nothing unless given -f,
808         -i or -n.   Defaults to true.
810 color.branch::
811         A boolean to enable/disable color in the output of
812         linkgit:git-branch[1]. May be set to `always`,
813         `false` (or `never`) or `auto` (or `true`), in which case colors are used
814         only when the output is to a terminal. Defaults to false.
816 color.branch.<slot>::
817         Use customized color for branch coloration. `<slot>` is one of
818         `current` (the current branch), `local` (a local branch),
819         `remote` (a remote-tracking branch in refs/remotes/),
820         `upstream` (upstream tracking branch), `plain` (other
821         refs).
823 The value for these configuration variables is a list of colors (at most
824 two) and attributes (at most one), separated by spaces.  The colors
825 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
826 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
827 `blink` and `reverse`.  The first color given is the foreground; the
828 second is the background.  The position of the attribute, if any,
829 doesn't matter.
831 color.diff::
832         Whether to use ANSI escape sequences to add color to patches.
833         If this is set to `always`, linkgit:git-diff[1],
834         linkgit:git-log[1], and linkgit:git-show[1] will use color
835         for all patches.  If it is set to `true` or `auto`, those
836         commands will only use color when output is to the terminal.
837         Defaults to false.
839 This does not affect linkgit:git-format-patch[1] nor the
840 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
841 command line with the `--color[=<when>]` option.
843 color.diff.<slot>::
844         Use customized color for diff colorization.  `<slot>` specifies
845         which part of the patch to use the specified color, and is one
846         of `plain` (context text), `meta` (metainformation), `frag`
847         (hunk header), 'func' (function in hunk header), `old` (removed lines),
848         `new` (added lines), `commit` (commit headers), or `whitespace`
849         (highlighting whitespace errors). The values of these variables may be
850         specified as in color.branch.<slot>.
852 color.decorate.<slot>::
853         Use customized color for 'git log --decorate' output.  `<slot>` is one
854         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
855         branches, remote-tracking branches, tags, stash and HEAD, respectively.
857 color.grep::
858         When set to `always`, always highlight matches.  When `false` (or
859         `never`), never.  When set to `true` or `auto`, use color only
860         when the output is written to the terminal.  Defaults to `false`.
862 color.grep.<slot>::
863         Use customized color for grep colorization.  `<slot>` specifies which
864         part of the line to use the specified color, and is one of
867 `context`;;
868         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
869 `filename`;;
870         filename prefix (when not using `-h`)
871 `function`;;
872         function name lines (when using `-p`)
873 `linenumber`;;
874         line number prefix (when using `-n`)
875 `match`;;
876         matching text
877 `selected`;;
878         non-matching text in selected lines
879 `separator`;;
880         separators between fields on a line (`:`, `-`, and `=`)
881         and between hunks (`--`)
884 The values of these variables may be specified as in color.branch.<slot>.
886 color.interactive::
887         When set to `always`, always use colors for interactive prompts
888         and displays (such as those used by "git-add --interactive" and
889         "git-clean --interactive"). When false (or `never`), never.
890         When set to `true` or `auto`, use colors only when the output is
891         to the terminal. Defaults to false.
893 color.interactive.<slot>::
894         Use customized color for 'git add --interactive' and 'git clean
895         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
896         or `error`, for four distinct types of normal output from
897         interactive commands.  The values of these variables may be
898         specified as in color.branch.<slot>.
900 color.pager::
901         A boolean to enable/disable colored output when the pager is in
902         use (default is true).
904 color.showbranch::
905         A boolean to enable/disable color in the output of
906         linkgit:git-show-branch[1]. May be set to `always`,
907         `false` (or `never`) or `auto` (or `true`), in which case colors are used
908         only when the output is to a terminal. Defaults to false.
910 color.status::
911         A boolean to enable/disable color in the output of
912         linkgit:git-status[1]. May be set to `always`,
913         `false` (or `never`) or `auto` (or `true`), in which case colors are used
914         only when the output is to a terminal. Defaults to false.
916 color.status.<slot>::
917         Use customized color for status colorization. `<slot>` is
918         one of `header` (the header text of the status message),
919         `added` or `updated` (files which are added but not committed),
920         `changed` (files which are changed but not added in the index),
921         `untracked` (files which are not tracked by Git),
922         `branch` (the current branch), or
923         `nobranch` (the color the 'no branch' warning is shown in, defaulting
924         to red). The values of these variables may be specified as in
925         color.branch.<slot>.
927 color.ui::
928         This variable determines the default value for variables such
929         as `color.diff` and `color.grep` that control the use of color
930         per command family. Its scope will expand as more commands learn
931         configuration to set a default for the `--color` option.  Set it
932         to `false` or `never` if you prefer Git commands not to use
933         color unless enabled explicitly with some other configuration
934         or the `--color` option. Set it to `always` if you want all
935         output not intended for machine consumption to use color, to
936         `true` or `auto` (this is the default since Git 1.8.4) if you
937         want such output to use color when written to the terminal.
939 column.ui::
940         Specify whether supported commands should output in columns.
941         This variable consists of a list of tokens separated by spaces
942         or commas:
944 These options control when the feature should be enabled
945 (defaults to 'never'):
948 `always`;;
949         always show in columns
950 `never`;;
951         never show in columns
952 `auto`;;
953         show in columns if the output is to the terminal
956 These options control layout (defaults to 'column').  Setting any
957 of these implies 'always' if none of 'always', 'never', or 'auto' are
958 specified.
961 `column`;;
962         fill columns before rows
963 `row`;;
964         fill rows before columns
965 `plain`;;
966         show in one column
969 Finally, these options can be combined with a layout option (defaults
970 to 'nodense'):
973 `dense`;;
974         make unequal size columns to utilize more space
975 `nodense`;;
976         make equal size columns
979 column.branch::
980         Specify whether to output branch listing in `git branch` in columns.
981         See `column.ui` for details.
983 column.clean::
984         Specify the layout when list items in `git clean -i`, which always
985         shows files and directories in columns. See `column.ui` for details.
987 column.status::
988         Specify whether to output untracked files in `git status` in columns.
989         See `column.ui` for details.
991 column.tag::
992         Specify whether to output tag listing in `git tag` in columns.
993         See `column.ui` for details.
995 commit.cleanup::
996         This setting overrides the default of the `--cleanup` option in
997         `git commit`. See linkgit:git-commit[1] for details. Changing the
998         default can be useful when you always want to keep lines that begin
999         with comment character `#` in your log message, in which case you
1000         would do `git config commit.cleanup whitespace` (note that you will
1001         have to remove the help lines that begin with `#` in the commit log
1002         template yourself, if you do this).
1004 commit.status::
1005         A boolean to enable/disable inclusion of status information in the
1006         commit message template when using an editor to prepare the commit
1007         message.  Defaults to true.
1009 commit.template::
1010         Specify a file to use as the template for new commit messages.
1011         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1012         specified user's home directory.
1014 credential.helper::
1015         Specify an external helper to be called when a username or
1016         password credential is needed; the helper may consult external
1017         storage to avoid prompting the user for the credentials. See
1018         linkgit:gitcredentials[7] for details.
1020 credential.useHttpPath::
1021         When acquiring credentials, consider the "path" component of an http
1022         or https URL to be important. Defaults to false. See
1023         linkgit:gitcredentials[7] for more information.
1025 credential.username::
1026         If no username is set for a network authentication, use this username
1027         by default. See credential.<context>.* below, and
1028         linkgit:gitcredentials[7].
1030 credential.<url>.*::
1031         Any of the credential.* options above can be applied selectively to
1032         some credentials. For example "credential.https://example.com.username"
1033         would set the default username only for https connections to
1034         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1035         matched.
1037 include::diff-config.txt[]
1039 difftool.<tool>.path::
1040         Override the path for the given tool.  This is useful in case
1041         your tool is not in the PATH.
1043 difftool.<tool>.cmd::
1044         Specify the command to invoke the specified diff tool.
1045         The specified command is evaluated in shell with the following
1046         variables available:  'LOCAL' is set to the name of the temporary
1047         file containing the contents of the diff pre-image and 'REMOTE'
1048         is set to the name of the temporary file containing the contents
1049         of the diff post-image.
1051 difftool.prompt::
1052         Prompt before each invocation of the diff tool.
1054 fetch.recurseSubmodules::
1055         This option can be either set to a boolean value or to 'on-demand'.
1056         Setting it to a boolean changes the behavior of fetch and pull to
1057         unconditionally recurse into submodules when set to true or to not
1058         recurse at all when set to false. When set to 'on-demand' (the default
1059         value), fetch and pull will only recurse into a populated submodule
1060         when its superproject retrieves a commit that updates the submodule's
1061         reference.
1063 fetch.fsckObjects::
1064         If it is set to true, git-fetch-pack will check all fetched
1065         objects. It will abort in the case of a malformed object or a
1066         broken link. The result of an abort are only dangling objects.
1067         Defaults to false. If not set, the value of `transfer.fsckObjects`
1068         is used instead.
1070 fetch.unpackLimit::
1071         If the number of objects fetched over the Git native
1072         transfer is below this
1073         limit, then the objects will be unpacked into loose object
1074         files. However if the number of received objects equals or
1075         exceeds this limit then the received pack will be stored as
1076         a pack, after adding any missing delta bases.  Storing the
1077         pack from a push can make the push operation complete faster,
1078         especially on slow filesystems.  If not set, the value of
1079         `transfer.unpackLimit` is used instead.
1081 fetch.prune::
1082         If true, fetch will automatically behave as if the `--prune`
1083         option was given on the command line.  See also `remote.<name>.prune`.
1085 format.attach::
1086         Enable multipart/mixed attachments as the default for
1087         'format-patch'.  The value can also be a double quoted string
1088         which will enable attachments as the default and set the
1089         value as the boundary.  See the --attach option in
1090         linkgit:git-format-patch[1].
1092 format.numbered::
1093         A boolean which can enable or disable sequence numbers in patch
1094         subjects.  It defaults to "auto" which enables it only if there
1095         is more than one patch.  It can be enabled or disabled for all
1096         messages by setting it to "true" or "false".  See --numbered
1097         option in linkgit:git-format-patch[1].
1099 format.headers::
1100         Additional email headers to include in a patch to be submitted
1101         by mail.  See linkgit:git-format-patch[1].
1103 format.to::
1104 format.cc::
1105         Additional recipients to include in a patch to be submitted
1106         by mail.  See the --to and --cc options in
1107         linkgit:git-format-patch[1].
1109 format.subjectprefix::
1110         The default for format-patch is to output files with the '[PATCH]'
1111         subject prefix. Use this variable to change that prefix.
1113 format.signature::
1114         The default for format-patch is to output a signature containing
1115         the Git version number. Use this variable to change that default.
1116         Set this variable to the empty string ("") to suppress
1117         signature generation.
1119 format.suffix::
1120         The default for format-patch is to output files with the suffix
1121         `.patch`. Use this variable to change that suffix (make sure to
1122         include the dot if you want it).
1124 format.pretty::
1125         The default pretty format for log/show/whatchanged command,
1126         See linkgit:git-log[1], linkgit:git-show[1],
1127         linkgit:git-whatchanged[1].
1129 format.thread::
1130         The default threading style for 'git format-patch'.  Can be
1131         a boolean value, or `shallow` or `deep`.  `shallow` threading
1132         makes every mail a reply to the head of the series,
1133         where the head is chosen from the cover letter, the
1134         `--in-reply-to`, and the first patch mail, in this order.
1135         `deep` threading makes every mail a reply to the previous one.
1136         A true boolean value is the same as `shallow`, and a false
1137         value disables threading.
1139 format.signoff::
1140         A boolean value which lets you enable the `-s/--signoff` option of
1141         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1142         patch should be a conscious act and means that you certify you have
1143         the rights to submit this work under the same open source license.
1144         Please see the 'SubmittingPatches' document for further discussion.
1146 format.coverLetter::
1147         A boolean that controls whether to generate a cover-letter when
1148         format-patch is invoked, but in addition can be set to "auto", to
1149         generate a cover-letter only when there's more than one patch.
1151 filter.<driver>.clean::
1152         The command which is used to convert the content of a worktree
1153         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1154         details.
1156 filter.<driver>.smudge::
1157         The command which is used to convert the content of a blob
1158         object to a worktree file upon checkout.  See
1159         linkgit:gitattributes[5] for details.
1161 gc.aggressiveWindow::
1162         The window size parameter used in the delta compression
1163         algorithm used by 'git gc --aggressive'.  This defaults
1164         to 250.
1166 gc.auto::
1167         When there are approximately more than this many loose
1168         objects in the repository, `git gc --auto` will pack them.
1169         Some Porcelain commands use this command to perform a
1170         light-weight garbage collection from time to time.  The
1171         default value is 6700.  Setting this to 0 disables it.
1173 gc.autopacklimit::
1174         When there are more than this many packs that are not
1175         marked with `*.keep` file in the repository, `git gc
1176         --auto` consolidates them into one larger pack.  The
1177         default value is 50.  Setting this to 0 disables it.
1179 gc.packrefs::
1180         Running `git pack-refs` in a repository renders it
1181         unclonable by Git versions prior to 1.5.1.2 over dumb
1182         transports such as HTTP.  This variable determines whether
1183         'git gc' runs `git pack-refs`. This can be set to `notbare`
1184         to enable it within all non-bare repos or it can be set to a
1185         boolean value.  The default is `true`.
1187 gc.pruneexpire::
1188         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1189         Override the grace period with this config variable.  The value
1190         "now" may be used to disable this  grace period and always prune
1191         unreachable objects immediately.
1193 gc.reflogexpire::
1194 gc.<pattern>.reflogexpire::
1195         'git reflog expire' removes reflog entries older than
1196         this time; defaults to 90 days.  With "<pattern>" (e.g.
1197         "refs/stash") in the middle the setting applies only to
1198         the refs that match the <pattern>.
1200 gc.reflogexpireunreachable::
1201 gc.<ref>.reflogexpireunreachable::
1202         'git reflog expire' removes reflog entries older than
1203         this time and are not reachable from the current tip;
1204         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1205         in the middle, the setting applies only to the refs that
1206         match the <pattern>.
1208 gc.rerereresolved::
1209         Records of conflicted merge you resolved earlier are
1210         kept for this many days when 'git rerere gc' is run.
1211         The default is 60 days.  See linkgit:git-rerere[1].
1213 gc.rerereunresolved::
1214         Records of conflicted merge you have not resolved are
1215         kept for this many days when 'git rerere gc' is run.
1216         The default is 15 days.  See linkgit:git-rerere[1].
1218 gitcvs.commitmsgannotation::
1219         Append this string to each commit message. Set to empty string
1220         to disable this feature. Defaults to "via git-CVS emulator".
1222 gitcvs.enabled::
1223         Whether the CVS server interface is enabled for this repository.
1224         See linkgit:git-cvsserver[1].
1226 gitcvs.logfile::
1227         Path to a log file where the CVS server interface well... logs
1228         various stuff. See linkgit:git-cvsserver[1].
1230 gitcvs.usecrlfattr::
1231         If true, the server will look up the end-of-line conversion
1232         attributes for files to determine the '-k' modes to use. If
1233         the attributes force Git to treat a file as text,
1234         the '-k' mode will be left blank so CVS clients will
1235         treat it as text. If they suppress text conversion, the file
1236         will be set with '-kb' mode, which suppresses any newline munging
1237         the client might otherwise do. If the attributes do not allow
1238         the file type to be determined, then 'gitcvs.allbinary' is
1239         used. See linkgit:gitattributes[5].
1241 gitcvs.allbinary::
1242         This is used if 'gitcvs.usecrlfattr' does not resolve
1243         the correct '-kb' mode to use. If true, all
1244         unresolved files are sent to the client in
1245         mode '-kb'. This causes the client to treat them
1246         as binary files, which suppresses any newline munging it
1247         otherwise might do. Alternatively, if it is set to "guess",
1248         then the contents of the file are examined to decide if
1249         it is binary, similar to 'core.autocrlf'.
1251 gitcvs.dbname::
1252         Database used by git-cvsserver to cache revision information
1253         derived from the Git repository. The exact meaning depends on the
1254         used database driver, for SQLite (which is the default driver) this
1255         is a filename. Supports variable substitution (see
1256         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1257         Default: '%Ggitcvs.%m.sqlite'
1259 gitcvs.dbdriver::
1260         Used Perl DBI driver. You can specify any available driver
1261         for this here, but it might not work. git-cvsserver is tested
1262         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1263         reported *not* to work with 'DBD::mysql'. Experimental feature.
1264         May not contain double colons (`:`). Default: 'SQLite'.
1265         See linkgit:git-cvsserver[1].
1267 gitcvs.dbuser, gitcvs.dbpass::
1268         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1269         since SQLite has no concept of database users and/or passwords.
1270         'gitcvs.dbuser' supports variable substitution (see
1271         linkgit:git-cvsserver[1] for details).
1273 gitcvs.dbTableNamePrefix::
1274         Database table name prefix.  Prepended to the names of any
1275         database tables used, allowing a single database to be used
1276         for several repositories.  Supports variable substitution (see
1277         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1278         characters will be replaced with underscores.
1280 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1281 'gitcvs.allbinary' can also be specified as
1282 'gitcvs.<access_method>.<varname>' (where 'access_method'
1283 is one of "ext" and "pserver") to make them apply only for the given
1284 access method.
1286 gitweb.category::
1287 gitweb.description::
1288 gitweb.owner::
1289 gitweb.url::
1290         See linkgit:gitweb[1] for description.
1292 gitweb.avatar::
1293 gitweb.blame::
1294 gitweb.grep::
1295 gitweb.highlight::
1296 gitweb.patches::
1297 gitweb.pickaxe::
1298 gitweb.remote_heads::
1299 gitweb.showsizes::
1300 gitweb.snapshot::
1301         See linkgit:gitweb.conf[5] for description.
1303 grep.lineNumber::
1304         If set to true, enable '-n' option by default.
1306 grep.patternType::
1307         Set the default matching behavior. Using a value of 'basic', 'extended',
1308         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1309         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1310         value 'default' will return to the default matching behavior.
1312 grep.extendedRegexp::
1313         If set to true, enable '--extended-regexp' option by default. This
1314         option is ignored when the 'grep.patternType' option is set to a value
1315         other than 'default'.
1317 gpg.program::
1318         Use this custom program instead of "gpg" found on $PATH when
1319         making or verifying a PGP signature. The program must support the
1320         same command line interface as GPG, namely, to verify a detached
1321         signature, "gpg --verify $file - <$signature" is run, and the
1322         program is expected to signal a good signature by exiting with
1323         code 0, and to generate an ascii-armored detached signature, the
1324         standard input of "gpg -bsau $key" is fed with the contents to be
1325         signed, and the program is expected to send the result to its
1326         standard output.
1328 gui.commitmsgwidth::
1329         Defines how wide the commit message window is in the
1330         linkgit:git-gui[1]. "75" is the default.
1332 gui.diffcontext::
1333         Specifies how many context lines should be used in calls to diff
1334         made by the linkgit:git-gui[1]. The default is "5".
1336 gui.encoding::
1337         Specifies the default encoding to use for displaying of
1338         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1339         It can be overridden by setting the 'encoding' attribute
1340         for relevant files (see linkgit:gitattributes[5]).
1341         If this option is not set, the tools default to the
1342         locale encoding.
1344 gui.matchtrackingbranch::
1345         Determines if new branches created with linkgit:git-gui[1] should
1346         default to tracking remote branches with matching names or
1347         not. Default: "false".
1349 gui.newbranchtemplate::
1350         Is used as suggested name when creating new branches using the
1351         linkgit:git-gui[1].
1353 gui.pruneduringfetch::
1354         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1355         performing a fetch. The default value is "false".
1357 gui.trustmtime::
1358         Determines if linkgit:git-gui[1] should trust the file modification
1359         timestamp or not. By default the timestamps are not trusted.
1361 gui.spellingdictionary::
1362         Specifies the dictionary used for spell checking commit messages in
1363         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1364         off.
1366 gui.fastcopyblame::
1367         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1368         location detection. It makes blame significantly faster on huge
1369         repositories at the expense of less thorough copy detection.
1371 gui.copyblamethreshold::
1372         Specifies the threshold to use in 'git gui blame' original location
1373         detection, measured in alphanumeric characters. See the
1374         linkgit:git-blame[1] manual for more information on copy detection.
1376 gui.blamehistoryctx::
1377         Specifies the radius of history context in days to show in
1378         linkgit:gitk[1] for the selected commit, when the `Show History
1379         Context` menu item is invoked from 'git gui blame'. If this
1380         variable is set to zero, the whole history is shown.
1382 guitool.<name>.cmd::
1383         Specifies the shell command line to execute when the corresponding item
1384         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1385         mandatory for every tool. The command is executed from the root of
1386         the working directory, and in the environment it receives the name of
1387         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1388         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1389         the head is detached, 'CUR_BRANCH' is empty).
1391 guitool.<name>.needsfile::
1392         Run the tool only if a diff is selected in the GUI. It guarantees
1393         that 'FILENAME' is not empty.
1395 guitool.<name>.noconsole::
1396         Run the command silently, without creating a window to display its
1397         output.
1399 guitool.<name>.norescan::
1400         Don't rescan the working directory for changes after the tool
1401         finishes execution.
1403 guitool.<name>.confirm::
1404         Show a confirmation dialog before actually running the tool.
1406 guitool.<name>.argprompt::
1407         Request a string argument from the user, and pass it to the tool
1408         through the 'ARGS' environment variable. Since requesting an
1409         argument implies confirmation, the 'confirm' option has no effect
1410         if this is enabled. If the option is set to 'true', 'yes', or '1',
1411         the dialog uses a built-in generic prompt; otherwise the exact
1412         value of the variable is used.
1414 guitool.<name>.revprompt::
1415         Request a single valid revision from the user, and set the
1416         'REVISION' environment variable. In other aspects this option
1417         is similar to 'argprompt', and can be used together with it.
1419 guitool.<name>.revunmerged::
1420         Show only unmerged branches in the 'revprompt' subdialog.
1421         This is useful for tools similar to merge or rebase, but not
1422         for things like checkout or reset.
1424 guitool.<name>.title::
1425         Specifies the title to use for the prompt dialog. The default
1426         is the tool name.
1428 guitool.<name>.prompt::
1429         Specifies the general prompt string to display at the top of
1430         the dialog, before subsections for 'argprompt' and 'revprompt'.
1431         The default value includes the actual command.
1433 help.browser::
1434         Specify the browser that will be used to display help in the
1435         'web' format. See linkgit:git-help[1].
1437 help.format::
1438         Override the default help format used by linkgit:git-help[1].
1439         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1440         the default. 'web' and 'html' are the same.
1442 help.autocorrect::
1443         Automatically correct and execute mistyped commands after
1444         waiting for the given number of deciseconds (0.1 sec). If more
1445         than one command can be deduced from the entered text, nothing
1446         will be executed.  If the value of this option is negative,
1447         the corrected command will be executed immediately. If the
1448         value is 0 - the command will be just shown but not executed.
1449         This is the default.
1451 help.htmlpath::
1452         Specify the path where the HTML documentation resides. File system paths
1453         and URLs are supported. HTML pages will be prefixed with this path when
1454         help is displayed in the 'web' format. This defaults to the documentation
1455         path of your Git installation.
1457 http.proxy::
1458         Override the HTTP proxy, normally configured using the 'http_proxy',
1459         'https_proxy', and 'all_proxy' environment variables (see
1460         `curl(1)`).  This can be overridden on a per-remote basis; see
1461         remote.<name>.proxy
1463 http.cookiefile::
1464         File containing previously stored cookie lines which should be used
1465         in the Git http session, if they match the server. The file format
1466         of the file to read cookies from should be plain HTTP headers or
1467         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1468         NOTE that the file specified with http.cookiefile is only used as
1469         input unless http.saveCookies is set.
1471 http.savecookies::
1472         If set, store cookies received during requests to the file specified by
1473         http.cookiefile. Has no effect if http.cookiefile is unset.
1475 http.sslVerify::
1476         Whether to verify the SSL certificate when fetching or pushing
1477         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1478         variable.
1480 http.sslCert::
1481         File containing the SSL certificate when fetching or pushing
1482         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1483         variable.
1485 http.sslKey::
1486         File containing the SSL private key when fetching or pushing
1487         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1488         variable.
1490 http.sslCertPasswordProtected::
1491         Enable Git's password prompt for the SSL certificate.  Otherwise
1492         OpenSSL will prompt the user, possibly many times, if the
1493         certificate or private key is encrypted.  Can be overridden by the
1494         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1496 http.sslCAInfo::
1497         File containing the certificates to verify the peer with when
1498         fetching or pushing over HTTPS. Can be overridden by the
1499         'GIT_SSL_CAINFO' environment variable.
1501 http.sslCAPath::
1502         Path containing files with the CA certificates to verify the peer
1503         with when fetching or pushing over HTTPS. Can be overridden
1504         by the 'GIT_SSL_CAPATH' environment variable.
1506 http.sslTry::
1507         Attempt to use AUTH SSL/TLS and encrypted data transfers
1508         when connecting via regular FTP protocol. This might be needed
1509         if the FTP server requires it for security reasons or you wish
1510         to connect securely whenever remote FTP server supports it.
1511         Default is false since it might trigger certificate verification
1512         errors on misconfigured servers.
1514 http.maxRequests::
1515         How many HTTP requests to launch in parallel. Can be overridden
1516         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1518 http.minSessions::
1519         The number of curl sessions (counted across slots) to be kept across
1520         requests. They will not be ended with curl_easy_cleanup() until
1521         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1522         value will be capped at 1. Defaults to 1.
1524 http.postBuffer::
1525         Maximum size in bytes of the buffer used by smart HTTP
1526         transports when POSTing data to the remote system.
1527         For requests larger than this buffer size, HTTP/1.1 and
1528         Transfer-Encoding: chunked is used to avoid creating a
1529         massive pack file locally.  Default is 1 MiB, which is
1530         sufficient for most requests.
1532 http.lowSpeedLimit, http.lowSpeedTime::
1533         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1534         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1535         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1536         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1538 http.noEPSV::
1539         A boolean which disables using of EPSV ftp command by curl.
1540         This can helpful with some "poor" ftp servers which don't
1541         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1542         environment variable. Default is false (curl will use EPSV).
1544 http.useragent::
1545         The HTTP USER_AGENT string presented to an HTTP server.  The default
1546         value represents the version of the client Git such as git/1.7.1.
1547         This option allows you to override this value to a more common value
1548         such as Mozilla/4.0.  This may be necessary, for instance, if
1549         connecting through a firewall that restricts HTTP connections to a set
1550         of common USER_AGENT strings (but not including those like git/1.7.1).
1551         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1553 http.<url>.*::
1554         Any of the http.* options above can be applied selectively to some urls.
1555         For a config key to match a URL, each element of the config key is
1556         compared to that of the URL, in the following order:
1559 . Scheme (e.g., `https` in `https://example.com/`). This field
1560   must match exactly between the config key and the URL.
1562 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1563   This field must match exactly between the config key and the URL.
1565 . Port number (e.g., `8080` in `http://example.com:8080/`).
1566   This field must match exactly between the config key and the URL.
1567   Omitted port numbers are automatically converted to the correct
1568   default for the scheme before matching.
1570 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1571   path field of the config key must match the path field of the URL
1572   either exactly or as a prefix of slash-delimited path elements.  This means
1573   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1574   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1575   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1576   key with just path `foo/`).
1578 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1579   the config key has a user name it must match the user name in the
1580   URL exactly. If the config key does not have a user name, that
1581   config key will match a URL with any user name (including none),
1582   but at a lower precedence than a config key with a user name.
1585 The list above is ordered by decreasing precedence; a URL that matches
1586 a config key's path is preferred to one that matches its user name. For example,
1587 if the URL is `https://user@example.com/foo/bar` a config key match of
1588 `https://example.com/foo` will be preferred over a config key match of
1589 `https://user@example.com`.
1591 All URLs are normalized before attempting any matching (the password part,
1592 if embedded in the URL, is always ignored for matching purposes) so that
1593 equivalent urls that are simply spelled differently will match properly.
1594 Environment variable settings always override any matches.  The urls that are
1595 matched against are those given directly to Git commands.  This means any URLs
1596 visited as a result of a redirection do not participate in matching.
1598 i18n.commitEncoding::
1599         Character encoding the commit messages are stored in; Git itself
1600         does not care per se, but this information is necessary e.g. when
1601         importing commits from emails or in the gitk graphical history
1602         browser (and possibly at other places in the future or in other
1603         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1605 i18n.logOutputEncoding::
1606         Character encoding the commit messages are converted to when
1607         running 'git log' and friends.
1609 imap::
1610         The configuration variables in the 'imap' section are described
1611         in linkgit:git-imap-send[1].
1613 init.templatedir::
1614         Specify the directory from which templates will be copied.
1615         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1617 instaweb.browser::
1618         Specify the program that will be used to browse your working
1619         repository in gitweb. See linkgit:git-instaweb[1].
1621 instaweb.httpd::
1622         The HTTP daemon command-line to start gitweb on your working
1623         repository. See linkgit:git-instaweb[1].
1625 instaweb.local::
1626         If true the web server started by linkgit:git-instaweb[1] will
1627         be bound to the local IP (127.0.0.1).
1629 instaweb.modulepath::
1630         The default module path for linkgit:git-instaweb[1] to use
1631         instead of /usr/lib/apache2/modules.  Only used if httpd
1632         is Apache.
1634 instaweb.port::
1635         The port number to bind the gitweb httpd to. See
1636         linkgit:git-instaweb[1].
1638 interactive.singlekey::
1639         In interactive commands, allow the user to provide one-letter
1640         input with a single key (i.e., without hitting enter).
1641         Currently this is used by the `--patch` mode of
1642         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1643         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1644         setting is silently ignored if portable keystroke input
1645         is not available.
1647 log.abbrevCommit::
1648         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1649         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1650         override this option with `--no-abbrev-commit`.
1652 log.date::
1653         Set the default date-time mode for the 'log' command.
1654         Setting a value for log.date is similar to using 'git log''s
1655         `--date` option.  Possible values are `relative`, `local`,
1656         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1657         for details.
1659 log.decorate::
1660         Print out the ref names of any commits that are shown by the log
1661         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1662         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1663         specified, the full ref name (including prefix) will be printed.
1664         This is the same as the log commands '--decorate' option.
1666 log.showroot::
1667         If true, the initial commit will be shown as a big creation event.
1668         This is equivalent to a diff against an empty tree.
1669         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1670         normally hide the root commit will now show it. True by default.
1672 log.mailmap::
1673         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1674         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1676 mailmap.file::
1677         The location of an augmenting mailmap file. The default
1678         mailmap, located in the root of the repository, is loaded
1679         first, then the mailmap file pointed to by this variable.
1680         The location of the mailmap file may be in a repository
1681         subdirectory, or somewhere outside of the repository itself.
1682         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1684 mailmap.blob::
1685         Like `mailmap.file`, but consider the value as a reference to a
1686         blob in the repository. If both `mailmap.file` and
1687         `mailmap.blob` are given, both are parsed, with entries from
1688         `mailmap.file` taking precedence. In a bare repository, this
1689         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1690         defaults to empty.
1692 man.viewer::
1693         Specify the programs that may be used to display help in the
1694         'man' format. See linkgit:git-help[1].
1696 man.<tool>.cmd::
1697         Specify the command to invoke the specified man viewer. The
1698         specified command is evaluated in shell with the man page
1699         passed as argument. (See linkgit:git-help[1].)
1701 man.<tool>.path::
1702         Override the path for the given tool that may be used to
1703         display help in the 'man' format. See linkgit:git-help[1].
1705 include::merge-config.txt[]
1707 mergetool.<tool>.path::
1708         Override the path for the given tool.  This is useful in case
1709         your tool is not in the PATH.
1711 mergetool.<tool>.cmd::
1712         Specify the command to invoke the specified merge tool.  The
1713         specified command is evaluated in shell with the following
1714         variables available: 'BASE' is the name of a temporary file
1715         containing the common base of the files to be merged, if available;
1716         'LOCAL' is the name of a temporary file containing the contents of
1717         the file on the current branch; 'REMOTE' is the name of a temporary
1718         file containing the contents of the file from the branch being
1719         merged; 'MERGED' contains the name of the file to which the merge
1720         tool should write the results of a successful merge.
1722 mergetool.<tool>.trustExitCode::
1723         For a custom merge command, specify whether the exit code of
1724         the merge command can be used to determine whether the merge was
1725         successful.  If this is not set to true then the merge target file
1726         timestamp is checked and the merge assumed to have been successful
1727         if the file has been updated, otherwise the user is prompted to
1728         indicate the success of the merge.
1730 mergetool.keepBackup::
1731         After performing a merge, the original file with conflict markers
1732         can be saved as a file with a `.orig` extension.  If this variable
1733         is set to `false` then this file is not preserved.  Defaults to
1734         `true` (i.e. keep the backup files).
1736 mergetool.keepTemporaries::
1737         When invoking a custom merge tool, Git uses a set of temporary
1738         files to pass to the tool. If the tool returns an error and this
1739         variable is set to `true`, then these temporary files will be
1740         preserved, otherwise they will be removed after the tool has
1741         exited. Defaults to `false`.
1743 mergetool.prompt::
1744         Prompt before each invocation of the merge resolution program.
1746 notes.displayRef::
1747         The (fully qualified) refname from which to show notes when
1748         showing commit messages.  The value of this variable can be set
1749         to a glob, in which case notes from all matching refs will be
1750         shown.  You may also specify this configuration variable
1751         several times.  A warning will be issued for refs that do not
1752         exist, but a glob that does not match any refs is silently
1753         ignored.
1755 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1756 environment variable, which must be a colon separated list of refs or
1757 globs.
1759 The effective value of "core.notesRef" (possibly overridden by
1760 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1761 displayed.
1763 notes.rewrite.<command>::
1764         When rewriting commits with <command> (currently `amend` or
1765         `rebase`) and this variable is set to `true`, Git
1766         automatically copies your notes from the original to the
1767         rewritten commit.  Defaults to `true`, but see
1768         "notes.rewriteRef" below.
1770 notes.rewriteMode::
1771         When copying notes during a rewrite (see the
1772         "notes.rewrite.<command>" option), determines what to do if
1773         the target commit already has a note.  Must be one of
1774         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1775         `concatenate`.
1777 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1778 environment variable.
1780 notes.rewriteRef::
1781         When copying notes during a rewrite, specifies the (fully
1782         qualified) ref whose notes should be copied.  The ref may be a
1783         glob, in which case notes in all matching refs will be copied.
1784         You may also specify this configuration several times.
1786 Does not have a default value; you must configure this variable to
1787 enable note rewriting.  Set it to `refs/notes/commits` to enable
1788 rewriting for the default commit notes.
1790 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1791 environment variable, which must be a colon separated list of refs or
1792 globs.
1794 pack.window::
1795         The size of the window used by linkgit:git-pack-objects[1] when no
1796         window size is given on the command line. Defaults to 10.
1798 pack.depth::
1799         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1800         maximum depth is given on the command line. Defaults to 50.
1802 pack.windowMemory::
1803         The window memory size limit used by linkgit:git-pack-objects[1]
1804         when no limit is given on the command line.  The value can be
1805         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1806         limit.
1808 pack.compression::
1809         An integer -1..9, indicating the compression level for objects
1810         in a pack file. -1 is the zlib default. 0 means no
1811         compression, and 1..9 are various speed/size tradeoffs, 9 being
1812         slowest.  If not set,  defaults to core.compression.  If that is
1813         not set,  defaults to -1, the zlib default, which is "a default
1814         compromise between speed and compression (currently equivalent
1815         to level 6)."
1817 Note that changing the compression level will not automatically recompress
1818 all existing objects. You can force recompression by passing the -F option
1819 to linkgit:git-repack[1].
1821 pack.deltaCacheSize::
1822         The maximum memory in bytes used for caching deltas in
1823         linkgit:git-pack-objects[1] before writing them out to a pack.
1824         This cache is used to speed up the writing object phase by not
1825         having to recompute the final delta result once the best match
1826         for all objects is found.  Repacking large repositories on machines
1827         which are tight with memory might be badly impacted by this though,
1828         especially if this cache pushes the system into swapping.
1829         A value of 0 means no limit. The smallest size of 1 byte may be
1830         used to virtually disable this cache. Defaults to 256 MiB.
1832 pack.deltaCacheLimit::
1833         The maximum size of a delta, that is cached in
1834         linkgit:git-pack-objects[1]. This cache is used to speed up the
1835         writing object phase by not having to recompute the final delta
1836         result once the best match for all objects is found. Defaults to 1000.
1838 pack.threads::
1839         Specifies the number of threads to spawn when searching for best
1840         delta matches.  This requires that linkgit:git-pack-objects[1]
1841         be compiled with pthreads otherwise this option is ignored with a
1842         warning. This is meant to reduce packing time on multiprocessor
1843         machines. The required amount of memory for the delta search window
1844         is however multiplied by the number of threads.
1845         Specifying 0 will cause Git to auto-detect the number of CPU's
1846         and set the number of threads accordingly.
1848 pack.indexVersion::
1849         Specify the default pack index version.  Valid values are 1 for
1850         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1851         the new pack index with capabilities for packs larger than 4 GB
1852         as well as proper protection against the repacking of corrupted
1853         packs.  Version 2 is the default.  Note that version 2 is enforced
1854         and this config option ignored whenever the corresponding pack is
1855         larger than 2 GB.
1857 If you have an old Git that does not understand the version 2 `*.idx` file,
1858 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1859 that will copy both `*.pack` file and corresponding `*.idx` file from the
1860 other side may give you a repository that cannot be accessed with your
1861 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1862 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1863 the `*.idx` file.
1865 pack.packSizeLimit::
1866         The maximum size of a pack.  This setting only affects
1867         packing to a file when repacking, i.e. the git:// protocol
1868         is unaffected.  It can be overridden by the `--max-pack-size`
1869         option of linkgit:git-repack[1]. The minimum size allowed is
1870         limited to 1 MiB. The default is unlimited.
1871         Common unit suffixes of 'k', 'm', or 'g' are
1872         supported.
1874 pager.<cmd>::
1875         If the value is boolean, turns on or off pagination of the
1876         output of a particular Git subcommand when writing to a tty.
1877         Otherwise, turns on pagination for the subcommand using the
1878         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1879         or `--no-pager` is specified on the command line, it takes
1880         precedence over this option.  To disable pagination for all
1881         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1883 pretty.<name>::
1884         Alias for a --pretty= format string, as specified in
1885         linkgit:git-log[1]. Any aliases defined here can be used just
1886         as the built-in pretty formats could. For example,
1887         running `git config pretty.changelog "format:* %H %s"`
1888         would cause the invocation `git log --pretty=changelog`
1889         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1890         Note that an alias with the same name as a built-in format
1891         will be silently ignored.
1893 pull.rebase::
1894         When true, rebase branches on top of the fetched branch, instead
1895         of merging the default branch from the default remote when "git
1896         pull" is run. See "branch.<name>.rebase" for setting this on a
1897         per-branch basis.
1899         When preserve, also pass `--preserve-merges` along to 'git rebase'
1900         so that locally committed merge commits will not be flattened
1901         by running 'git pull'.
1903 *NOTE*: this is a possibly dangerous operation; do *not* use
1904 it unless you understand the implications (see linkgit:git-rebase[1]
1905 for details).
1907 pull.octopus::
1908         The default merge strategy to use when pulling multiple branches
1909         at once.
1911 pull.twohead::
1912         The default merge strategy to use when pulling a single branch.
1914 push.default::
1915         Defines the action `git push` should take if no refspec is
1916         explicitly given.  Different values are well-suited for
1917         specific workflows; for instance, in a purely central workflow
1918         (i.e. the fetch source is equal to the push destination),
1919         `upstream` is probably what you want.  Possible values are:
1923 * `nothing` - do not push anything (error out) unless a refspec is
1924   explicitly given. This is primarily meant for people who want to
1925   avoid mistakes by always being explicit.
1927 * `current` - push the current branch to update a branch with the same
1928   name on the receiving end.  Works in both central and non-central
1929   workflows.
1931 * `upstream` - push the current branch back to the branch whose
1932   changes are usually integrated into the current branch (which is
1933   called `@{upstream}`).  This mode only makes sense if you are
1934   pushing to the same repository you would normally pull from
1935   (i.e. central workflow).
1937 * `simple` - in centralized workflow, work like `upstream` with an
1938   added safety to refuse to push if the upstream branch's name is
1939   different from the local one.
1941 When pushing to a remote that is different from the remote you normally
1942 pull from, work as `current`.  This is the safest option and is suited
1943 for beginners.
1945 This mode will become the default in Git 2.0.
1947 * `matching` - push all branches having the same name on both ends.
1948   This makes the repository you are pushing to remember the set of
1949   branches that will be pushed out (e.g. if you always push 'maint'
1950   and 'master' there and no other branches, the repository you push
1951   to will have these two branches, and your local 'maint' and
1952   'master' will be pushed there).
1954 To use this mode effectively, you have to make sure _all_ the
1955 branches you would push out are ready to be pushed out before
1956 running 'git push', as the whole point of this mode is to allow you
1957 to push all of the branches in one go.  If you usually finish work
1958 on only one branch and push out the result, while other branches are
1959 unfinished, this mode is not for you.  Also this mode is not
1960 suitable for pushing into a shared central repository, as other
1961 people may add new branches there, or update the tip of existing
1962 branches outside your control.
1964 This is currently the default, but Git 2.0 will change the default
1965 to `simple`.
1969 rebase.stat::
1970         Whether to show a diffstat of what changed upstream since the last
1971         rebase. False by default.
1973 rebase.autosquash::
1974         If set to true enable '--autosquash' option by default.
1976 rebase.autostash::
1977         When set to true, automatically create a temporary stash
1978         before the operation begins, and apply it after the operation
1979         ends.  This means that you can run rebase on a dirty worktree.
1980         However, use with care: the final stash application after a
1981         successful rebase might result in non-trivial conflicts.
1982         Defaults to false.
1984 receive.autogc::
1985         By default, git-receive-pack will run "git-gc --auto" after
1986         receiving data from git-push and updating refs.  You can stop
1987         it by setting this variable to false.
1989 receive.fsckObjects::
1990         If it is set to true, git-receive-pack will check all received
1991         objects. It will abort in the case of a malformed object or a
1992         broken link. The result of an abort are only dangling objects.
1993         Defaults to false. If not set, the value of `transfer.fsckObjects`
1994         is used instead.
1996 receive.unpackLimit::
1997         If the number of objects received in a push is below this
1998         limit then the objects will be unpacked into loose object
1999         files. However if the number of received objects equals or
2000         exceeds this limit then the received pack will be stored as
2001         a pack, after adding any missing delta bases.  Storing the
2002         pack from a push can make the push operation complete faster,
2003         especially on slow filesystems.  If not set, the value of
2004         `transfer.unpackLimit` is used instead.
2006 receive.denyDeletes::
2007         If set to true, git-receive-pack will deny a ref update that deletes
2008         the ref. Use this to prevent such a ref deletion via a push.
2010 receive.denyDeleteCurrent::
2011         If set to true, git-receive-pack will deny a ref update that
2012         deletes the currently checked out branch of a non-bare repository.
2014 receive.denyCurrentBranch::
2015         If set to true or "refuse", git-receive-pack will deny a ref update
2016         to the currently checked out branch of a non-bare repository.
2017         Such a push is potentially dangerous because it brings the HEAD
2018         out of sync with the index and working tree. If set to "warn",
2019         print a warning of such a push to stderr, but allow the push to
2020         proceed. If set to false or "ignore", allow such pushes with no
2021         message. Defaults to "refuse".
2023 There are two more options that are meant for Git experts: "updateInstead"
2024 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
2025 the HEAD so it does not need to change.  Both options come with their own
2026 set of possible *complications*, but can be appropriate in rare workflows.
2028 receive.denyNonFastForwards::
2029         If set to true, git-receive-pack will deny a ref update which is
2030         not a fast-forward. Use this to prevent such an update via a push,
2031         even if that push is forced. This configuration variable is
2032         set when initializing a shared repository.
2034 receive.hiderefs::
2035         String(s) `receive-pack` uses to decide which refs to omit
2036         from its initial advertisement.  Use more than one
2037         definitions to specify multiple prefix strings. A ref that
2038         are under the hierarchies listed on the value of this
2039         variable is excluded, and is hidden when responding to `git
2040         push`, and an attempt to update or delete a hidden ref by
2041         `git push` is rejected.
2043 receive.updateserverinfo::
2044         If set to true, git-receive-pack will run git-update-server-info
2045         after receiving data from git-push and updating refs.
2047 remote.pushdefault::
2048         The remote to push to by default.  Overrides
2049         `branch.<name>.remote` for all branches, and is overridden by
2050         `branch.<name>.pushremote` for specific branches.
2052 remote.<name>.url::
2053         The URL of a remote repository.  See linkgit:git-fetch[1] or
2054         linkgit:git-push[1].
2056 remote.<name>.pushurl::
2057         The push URL of a remote repository.  See linkgit:git-push[1].
2059 remote.<name>.proxy::
2060         For remotes that require curl (http, https and ftp), the URL to
2061         the proxy to use for that remote.  Set to the empty string to
2062         disable proxying for that remote.
2064 remote.<name>.fetch::
2065         The default set of "refspec" for linkgit:git-fetch[1]. See
2066         linkgit:git-fetch[1].
2068 remote.<name>.push::
2069         The default set of "refspec" for linkgit:git-push[1]. See
2070         linkgit:git-push[1].
2072 remote.<name>.mirror::
2073         If true, pushing to this remote will automatically behave
2074         as if the `--mirror` option was given on the command line.
2076 remote.<name>.skipDefaultUpdate::
2077         If true, this remote will be skipped by default when updating
2078         using linkgit:git-fetch[1] or the `update` subcommand of
2079         linkgit:git-remote[1].
2081 remote.<name>.skipFetchAll::
2082         If true, this remote will be skipped by default when updating
2083         using linkgit:git-fetch[1] or the `update` subcommand of
2084         linkgit:git-remote[1].
2086 remote.<name>.receivepack::
2087         The default program to execute on the remote side when pushing.  See
2088         option \--receive-pack of linkgit:git-push[1].
2090 remote.<name>.uploadpack::
2091         The default program to execute on the remote side when fetching.  See
2092         option \--upload-pack of linkgit:git-fetch-pack[1].
2094 remote.<name>.tagopt::
2095         Setting this value to \--no-tags disables automatic tag following when
2096         fetching from remote <name>. Setting it to \--tags will fetch every
2097         tag from remote <name>, even if they are not reachable from remote
2098         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2099         override this setting. See options \--tags and \--no-tags of
2100         linkgit:git-fetch[1].
2102 remote.<name>.vcs::
2103         Setting this to a value <vcs> will cause Git to interact with
2104         the remote with the git-remote-<vcs> helper.
2106 remote.<name>.prune::
2107         When set to true, fetching from this remote by default will also
2108         remove any remote-tracking branches which no longer exist on the
2109         remote (as if the `--prune` option was give on the command line).
2110         Overrides `fetch.prune` settings, if any.
2112 remotes.<group>::
2113         The list of remotes which are fetched by "git remote update
2114         <group>".  See linkgit:git-remote[1].
2116 repack.usedeltabaseoffset::
2117         By default, linkgit:git-repack[1] creates packs that use
2118         delta-base offset. If you need to share your repository with
2119         Git older than version 1.4.4, either directly or via a dumb
2120         protocol such as http, then you need to set this option to
2121         "false" and repack. Access from old Git versions over the
2122         native protocol are unaffected by this option.
2124 rerere.autoupdate::
2125         When set to true, `git-rerere` updates the index with the
2126         resulting contents after it cleanly resolves conflicts using
2127         previously recorded resolution.  Defaults to false.
2129 rerere.enabled::
2130         Activate recording of resolved conflicts, so that identical
2131         conflict hunks can be resolved automatically, should they be
2132         encountered again.  By default, linkgit:git-rerere[1] is
2133         enabled if there is an `rr-cache` directory under the
2134         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2135         repository.
2137 sendemail.identity::
2138         A configuration identity. When given, causes values in the
2139         'sendemail.<identity>' subsection to take precedence over
2140         values in the 'sendemail' section. The default identity is
2141         the value of 'sendemail.identity'.
2143 sendemail.smtpencryption::
2144         See linkgit:git-send-email[1] for description.  Note that this
2145         setting is not subject to the 'identity' mechanism.
2147 sendemail.smtpssl::
2148         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2150 sendemail.smtpsslcertpath::
2151         Path to ca-certificates (either a directory or a single file).
2152         Set it to an empty string to disable certificate verification.
2154 sendemail.<identity>.*::
2155         Identity-specific versions of the 'sendemail.*' parameters
2156         found below, taking precedence over those when the this
2157         identity is selected, through command-line or
2158         'sendemail.identity'.
2160 sendemail.aliasesfile::
2161 sendemail.aliasfiletype::
2162 sendemail.annotate::
2163 sendemail.bcc::
2164 sendemail.cc::
2165 sendemail.cccmd::
2166 sendemail.chainreplyto::
2167 sendemail.confirm::
2168 sendemail.envelopesender::
2169 sendemail.from::
2170 sendemail.multiedit::
2171 sendemail.signedoffbycc::
2172 sendemail.smtppass::
2173 sendemail.suppresscc::
2174 sendemail.suppressfrom::
2175 sendemail.to::
2176 sendemail.smtpdomain::
2177 sendemail.smtpserver::
2178 sendemail.smtpserverport::
2179 sendemail.smtpserveroption::
2180 sendemail.smtpuser::
2181 sendemail.thread::
2182 sendemail.validate::
2183         See linkgit:git-send-email[1] for description.
2185 sendemail.signedoffcc::
2186         Deprecated alias for 'sendemail.signedoffbycc'.
2188 showbranch.default::
2189         The default set of branches for linkgit:git-show-branch[1].
2190         See linkgit:git-show-branch[1].
2192 status.relativePaths::
2193         By default, linkgit:git-status[1] shows paths relative to the
2194         current directory. Setting this variable to `false` shows paths
2195         relative to the repository root (this was the default for Git
2196         prior to v1.5.4).
2198 status.short::
2199         Set to true to enable --short by default in linkgit:git-status[1].
2200         The option --no-short takes precedence over this variable.
2202 status.branch::
2203         Set to true to enable --branch by default in linkgit:git-status[1].
2204         The option --no-branch takes precedence over this variable.
2206 status.displayCommentPrefix::
2207         If set to true, linkgit:git-status[1] will insert a comment
2208         prefix before each output line (starting with
2209         `core.commentChar`, i.e. `#` by default). This was the
2210         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2211         Defaults to false.
2213 status.showUntrackedFiles::
2214         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2215         files which are not currently tracked by Git. Directories which
2216         contain only untracked files, are shown with the directory name
2217         only. Showing untracked files means that Git needs to lstat() all
2218         all the files in the whole repository, which might be slow on some
2219         systems. So, this variable controls how the commands displays
2220         the untracked files. Possible values are:
2223 * `no` - Show no untracked files.
2224 * `normal` - Show untracked files and directories.
2225 * `all` - Show also individual files in untracked directories.
2228 If this variable is not specified, it defaults to 'normal'.
2229 This variable can be overridden with the -u|--untracked-files option
2230 of linkgit:git-status[1] and linkgit:git-commit[1].
2232 status.submodulesummary::
2233         Defaults to false.
2234         If this is set to a non zero number or true (identical to -1 or an
2235         unlimited number), the submodule summary will be enabled and a
2236         summary of commits for modified submodules will be shown (see
2237         --summary-limit option of linkgit:git-submodule[1]). Please note
2238         that the summary output command will be suppressed for all
2239         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2240         for those submodules where `submodule.<name>.ignore=all`. To
2241         also view the summary for ignored submodules you can either use
2242         the --ignore-submodules=dirty command line option or the 'git
2243         submodule summary' command, which shows a similar output but does
2244         not honor these settings.
2246 submodule.<name>.path::
2247 submodule.<name>.url::
2248 submodule.<name>.update::
2249         The path within this project, URL, and the updating strategy
2250         for a submodule.  These variables are initially populated
2251         by 'git submodule init'; edit them to override the
2252         URL and other values found in the `.gitmodules` file.  See
2253         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2255 submodule.<name>.branch::
2256         The remote branch name for a submodule, used by `git submodule
2257         update --remote`.  Set this option to override the value found in
2258         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2259         linkgit:gitmodules[5] for details.
2261 submodule.<name>.fetchRecurseSubmodules::
2262         This option can be used to control recursive fetching of this
2263         submodule. It can be overridden by using the --[no-]recurse-submodules
2264         command line option to "git fetch" and "git pull".
2265         This setting will override that from in the linkgit:gitmodules[5]
2266         file.
2268 submodule.<name>.ignore::
2269         Defines under what circumstances "git status" and the diff family show
2270         a submodule as modified. When set to "all", it will never be considered
2271         modified, "dirty" will ignore all changes to the submodules work tree and
2272         takes only differences between the HEAD of the submodule and the commit
2273         recorded in the superproject into account. "untracked" will additionally
2274         let submodules with modified tracked files in their work tree show up.
2275         Using "none" (the default when this option is not set) also shows
2276         submodules that have untracked files in their work tree as changed.
2277         This setting overrides any setting made in .gitmodules for this submodule,
2278         both settings can be overridden on the command line by using the
2279         "--ignore-submodules" option. The 'git submodule' commands are not
2280         affected by this setting.
2282 tar.umask::
2283         This variable can be used to restrict the permission bits of
2284         tar archive entries.  The default is 0002, which turns off the
2285         world write bit.  The special value "user" indicates that the
2286         archiving user's umask will be used instead.  See umask(2) and
2287         linkgit:git-archive[1].
2289 transfer.fsckObjects::
2290         When `fetch.fsckObjects` or `receive.fsckObjects` are
2291         not set, the value of this variable is used instead.
2292         Defaults to false.
2294 transfer.hiderefs::
2295         This variable can be used to set both `receive.hiderefs`
2296         and `uploadpack.hiderefs` at the same time to the same
2297         values.  See entries for these other variables.
2299 transfer.unpackLimit::
2300         When `fetch.unpackLimit` or `receive.unpackLimit` are
2301         not set, the value of this variable is used instead.
2302         The default value is 100.
2304 uploadpack.hiderefs::
2305         String(s) `upload-pack` uses to decide which refs to omit
2306         from its initial advertisement.  Use more than one
2307         definitions to specify multiple prefix strings. A ref that
2308         are under the hierarchies listed on the value of this
2309         variable is excluded, and is hidden from `git ls-remote`,
2310         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2311         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2313 uploadpack.allowtipsha1inwant::
2314         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2315         to accept a fetch request that asks for an object at the tip
2316         of a hidden ref (by default, such a request is rejected).
2317         see also `uploadpack.hiderefs`.
2319 uploadpack.keepalive::
2320         When `upload-pack` has started `pack-objects`, there may be a
2321         quiet period while `pack-objects` prepares the pack. Normally
2322         it would output progress information, but if `--quiet` was used
2323         for the fetch, `pack-objects` will output nothing at all until
2324         the pack data begins. Some clients and networks may consider
2325         the server to be hung and give up. Setting this option instructs
2326         `upload-pack` to send an empty keepalive packet every
2327         `uploadpack.keepalive` seconds. Setting this option to 0
2328         disables keepalive packets entirely. The default is 5 seconds.
2330 url.<base>.insteadOf::
2331         Any URL that starts with this value will be rewritten to
2332         start, instead, with <base>. In cases where some site serves a
2333         large number of repositories, and serves them with multiple
2334         access methods, and some users need to use different access
2335         methods, this feature allows people to specify any of the
2336         equivalent URLs and have Git automatically rewrite the URL to
2337         the best alternative for the particular user, even for a
2338         never-before-seen repository on the site.  When more than one
2339         insteadOf strings match a given URL, the longest match is used.
2341 url.<base>.pushInsteadOf::
2342         Any URL that starts with this value will not be pushed to;
2343         instead, it will be rewritten to start with <base>, and the
2344         resulting URL will be pushed to. In cases where some site serves
2345         a large number of repositories, and serves them with multiple
2346         access methods, some of which do not allow push, this feature
2347         allows people to specify a pull-only URL and have Git
2348         automatically use an appropriate URL to push, even for a
2349         never-before-seen repository on the site.  When more than one
2350         pushInsteadOf strings match a given URL, the longest match is
2351         used.  If a remote has an explicit pushurl, Git will ignore this
2352         setting for that remote.
2354 user.email::
2355         Your email address to be recorded in any newly created commits.
2356         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2357         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2359 user.name::
2360         Your full name to be recorded in any newly created commits.
2361         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2362         environment variables.  See linkgit:git-commit-tree[1].
2364 user.signingkey::
2365         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2366         key you want it to automatically when creating a signed tag or
2367         commit, you can override the default selection with this variable.
2368         This option is passed unchanged to gpg's --local-user parameter,
2369         so you may specify a key using any method that gpg supports.
2371 web.browser::
2372         Specify a web browser that may be used by some commands.
2373         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2374         may use it.