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