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