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