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