git-clean: add colors to interactive git-clean
[git/raj.git] / Documentation / config.txt
blob836138071a2a0cb3a14a828d5e3a2f7733763e6c
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         SHA-1, 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/),
811         `upstream` (upstream tracking branch), `plain` (other
812         refs).
814 The value for these configuration variables is a list of colors (at most
815 two) and attributes (at most one), separated by spaces.  The colors
816 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
817 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
818 `blink` and `reverse`.  The first color given is the foreground; the
819 second is the background.  The position of the attribute, if any,
820 doesn't matter.
822 color.diff::
823         Whether to use ANSI escape sequences to add color to patches.
824         If this is set to `always`, linkgit:git-diff[1],
825         linkgit:git-log[1], and linkgit:git-show[1] will use color
826         for all patches.  If it is set to `true` or `auto`, those
827         commands will only use color when output is to the terminal.
828         Defaults to false.
830 This does not affect linkgit:git-format-patch[1] nor the
831 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
832 command line with the `--color[=<when>]` option.
834 color.diff.<slot>::
835         Use customized color for diff colorization.  `<slot>` specifies
836         which part of the patch to use the specified color, and is one
837         of `plain` (context text), `meta` (metainformation), `frag`
838         (hunk header), 'func' (function in hunk header), `old` (removed lines),
839         `new` (added lines), `commit` (commit headers), or `whitespace`
840         (highlighting whitespace errors). The values of these variables may be
841         specified as in color.branch.<slot>.
843 color.decorate.<slot>::
844         Use customized color for 'git log --decorate' output.  `<slot>` is one
845         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
846         branches, remote-tracking branches, tags, stash and HEAD, respectively.
848 color.grep::
849         When set to `always`, always highlight matches.  When `false` (or
850         `never`), never.  When set to `true` or `auto`, use color only
851         when the output is written to the terminal.  Defaults to `false`.
853 color.grep.<slot>::
854         Use customized color for grep colorization.  `<slot>` specifies which
855         part of the line to use the specified color, and is one of
858 `context`;;
859         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
860 `filename`;;
861         filename prefix (when not using `-h`)
862 `function`;;
863         function name lines (when using `-p`)
864 `linenumber`;;
865         line number prefix (when using `-n`)
866 `match`;;
867         matching text
868 `selected`;;
869         non-matching text in selected lines
870 `separator`;;
871         separators between fields on a line (`:`, `-`, and `=`)
872         and between hunks (`--`)
875 The values of these variables may be specified as in color.branch.<slot>.
877 color.interactive::
878         When set to `always`, always use colors for interactive prompts
879         and displays (such as those used by "git-add --interactive" and
880         "git-clean --interactive"). When false (or `never`), never.
881         When set to `true` or `auto`, use colors only when the output is
882         to the terminal. Defaults to false.
884 color.interactive.<slot>::
885         Use customized color for 'git add --interactive' and 'git clean
886         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
887         or `error`, for four distinct types of normal output from
888         interactive commands.  The values of these variables may be
889         specified as in color.branch.<slot>.
891 color.pager::
892         A boolean to enable/disable colored output when the pager is in
893         use (default is true).
895 color.showbranch::
896         A boolean to enable/disable color in the output of
897         linkgit:git-show-branch[1]. May be set to `always`,
898         `false` (or `never`) or `auto` (or `true`), in which case colors are used
899         only when the output is to a terminal. Defaults to false.
901 color.status::
902         A boolean to enable/disable color in the output of
903         linkgit:git-status[1]. May be set to `always`,
904         `false` (or `never`) or `auto` (or `true`), in which case colors are used
905         only when the output is to a terminal. Defaults to false.
907 color.status.<slot>::
908         Use customized color for status colorization. `<slot>` is
909         one of `header` (the header text of the status message),
910         `added` or `updated` (files which are added but not committed),
911         `changed` (files which are changed but not added in the index),
912         `untracked` (files which are not tracked by Git),
913         `branch` (the current branch), or
914         `nobranch` (the color the 'no branch' warning is shown in, defaulting
915         to red). The values of these variables may be specified as in
916         color.branch.<slot>.
918 color.ui::
919         This variable determines the default value for variables such
920         as `color.diff` and `color.grep` that control the use of color
921         per command family. Its scope will expand as more commands learn
922         configuration to set a default for the `--color` option.  Set it
923         to `always` if you want all output not intended for machine
924         consumption to use color, to `true` or `auto` if you want such
925         output to use color when written to the terminal, or to `false` or
926         `never` if you prefer Git commands not to use color unless enabled
927         explicitly with some other configuration or the `--color` option.
929 column.ui::
930         Specify whether supported commands should output in columns.
931         This variable consists of a list of tokens separated by spaces
932         or commas:
935 `always`;;
936         always show in columns
937 `never`;;
938         never show in columns
939 `auto`;;
940         show in columns if the output is to the terminal
941 `column`;;
942         fill columns before rows (default)
943 `row`;;
944         fill rows before columns
945 `plain`;;
946         show in one column
947 `dense`;;
948         make unequal size columns to utilize more space
949 `nodense`;;
950         make equal size columns
953 This option defaults to 'never'.
955 column.branch::
956         Specify whether to output branch listing in `git branch` in columns.
957         See `column.ui` for details.
959 column.clean::
960         Specify the layout when list items in `git clean -i`, which always
961         shows files and directories in columns. See `column.ui` for details.
963 column.status::
964         Specify whether to output untracked files in `git status` in columns.
965         See `column.ui` for details.
967 column.tag::
968         Specify whether to output tag listing in `git tag` in columns.
969         See `column.ui` for details.
971 commit.cleanup::
972         This setting overrides the default of the `--cleanup` option in
973         `git commit`. See linkgit:git-commit[1] for details. Changing the
974         default can be useful when you always want to keep lines that begin
975         with comment character `#` in your log message, in which case you
976         would do `git config commit.cleanup whitespace` (note that you will
977         have to remove the help lines that begin with `#` in the commit log
978         template yourself, if you do this).
980 commit.status::
981         A boolean to enable/disable inclusion of status information in the
982         commit message template when using an editor to prepare the commit
983         message.  Defaults to true.
985 commit.template::
986         Specify a file to use as the template for new commit messages.
987         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
988         specified user's home directory.
990 credential.helper::
991         Specify an external helper to be called when a username or
992         password credential is needed; the helper may consult external
993         storage to avoid prompting the user for the credentials. See
994         linkgit:gitcredentials[7] for details.
996 credential.useHttpPath::
997         When acquiring credentials, consider the "path" component of an http
998         or https URL to be important. Defaults to false. See
999         linkgit:gitcredentials[7] for more information.
1001 credential.username::
1002         If no username is set for a network authentication, use this username
1003         by default. See credential.<context>.* below, and
1004         linkgit:gitcredentials[7].
1006 credential.<url>.*::
1007         Any of the credential.* options above can be applied selectively to
1008         some credentials. For example "credential.https://example.com.username"
1009         would set the default username only for https connections to
1010         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1011         matched.
1013 include::diff-config.txt[]
1015 difftool.<tool>.path::
1016         Override the path for the given tool.  This is useful in case
1017         your tool is not in the PATH.
1019 difftool.<tool>.cmd::
1020         Specify the command to invoke the specified diff tool.
1021         The specified command is evaluated in shell with the following
1022         variables available:  'LOCAL' is set to the name of the temporary
1023         file containing the contents of the diff pre-image and 'REMOTE'
1024         is set to the name of the temporary file containing the contents
1025         of the diff post-image.
1027 difftool.prompt::
1028         Prompt before each invocation of the diff tool.
1030 fetch.recurseSubmodules::
1031         This option can be either set to a boolean value or to 'on-demand'.
1032         Setting it to a boolean changes the behavior of fetch and pull to
1033         unconditionally recurse into submodules when set to true or to not
1034         recurse at all when set to false. When set to 'on-demand' (the default
1035         value), fetch and pull will only recurse into a populated submodule
1036         when its superproject retrieves a commit that updates the submodule's
1037         reference.
1039 fetch.fsckObjects::
1040         If it is set to true, git-fetch-pack will check all fetched
1041         objects. It will abort in the case of a malformed object or a
1042         broken link. The result of an abort are only dangling objects.
1043         Defaults to false. If not set, the value of `transfer.fsckObjects`
1044         is used instead.
1046 fetch.unpackLimit::
1047         If the number of objects fetched over the Git native
1048         transfer is below this
1049         limit, then the objects will be unpacked into loose object
1050         files. However if the number of received objects equals or
1051         exceeds this limit then the received pack will be stored as
1052         a pack, after adding any missing delta bases.  Storing the
1053         pack from a push can make the push operation complete faster,
1054         especially on slow filesystems.  If not set, the value of
1055         `transfer.unpackLimit` is used instead.
1057 format.attach::
1058         Enable multipart/mixed attachments as the default for
1059         'format-patch'.  The value can also be a double quoted string
1060         which will enable attachments as the default and set the
1061         value as the boundary.  See the --attach option in
1062         linkgit:git-format-patch[1].
1064 format.numbered::
1065         A boolean which can enable or disable sequence numbers in patch
1066         subjects.  It defaults to "auto" which enables it only if there
1067         is more than one patch.  It can be enabled or disabled for all
1068         messages by setting it to "true" or "false".  See --numbered
1069         option in linkgit:git-format-patch[1].
1071 format.headers::
1072         Additional email headers to include in a patch to be submitted
1073         by mail.  See linkgit:git-format-patch[1].
1075 format.to::
1076 format.cc::
1077         Additional recipients to include in a patch to be submitted
1078         by mail.  See the --to and --cc options in
1079         linkgit:git-format-patch[1].
1081 format.subjectprefix::
1082         The default for format-patch is to output files with the '[PATCH]'
1083         subject prefix. Use this variable to change that prefix.
1085 format.signature::
1086         The default for format-patch is to output a signature containing
1087         the Git version number. Use this variable to change that default.
1088         Set this variable to the empty string ("") to suppress
1089         signature generation.
1091 format.suffix::
1092         The default for format-patch is to output files with the suffix
1093         `.patch`. Use this variable to change that suffix (make sure to
1094         include the dot if you want it).
1096 format.pretty::
1097         The default pretty format for log/show/whatchanged command,
1098         See linkgit:git-log[1], linkgit:git-show[1],
1099         linkgit:git-whatchanged[1].
1101 format.thread::
1102         The default threading style for 'git format-patch'.  Can be
1103         a boolean value, or `shallow` or `deep`.  `shallow` threading
1104         makes every mail a reply to the head of the series,
1105         where the head is chosen from the cover letter, the
1106         `--in-reply-to`, and the first patch mail, in this order.
1107         `deep` threading makes every mail a reply to the previous one.
1108         A true boolean value is the same as `shallow`, and a false
1109         value disables threading.
1111 format.signoff::
1112         A boolean value which lets you enable the `-s/--signoff` option of
1113         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1114         patch should be a conscious act and means that you certify you have
1115         the rights to submit this work under the same open source license.
1116         Please see the 'SubmittingPatches' document for further discussion.
1118 format.coverLetter::
1119         A boolean that controls whether to generate a cover-letter when
1120         format-patch is invoked, but in addition can be set to "auto", to
1121         generate a cover-letter only when there's more than one patch.
1123 filter.<driver>.clean::
1124         The command which is used to convert the content of a worktree
1125         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1126         details.
1128 filter.<driver>.smudge::
1129         The command which is used to convert the content of a blob
1130         object to a worktree file upon checkout.  See
1131         linkgit:gitattributes[5] for details.
1133 gc.aggressiveWindow::
1134         The window size parameter used in the delta compression
1135         algorithm used by 'git gc --aggressive'.  This defaults
1136         to 250.
1138 gc.auto::
1139         When there are approximately more than this many loose
1140         objects in the repository, `git gc --auto` will pack them.
1141         Some Porcelain commands use this command to perform a
1142         light-weight garbage collection from time to time.  The
1143         default value is 6700.  Setting this to 0 disables it.
1145 gc.autopacklimit::
1146         When there are more than this many packs that are not
1147         marked with `*.keep` file in the repository, `git gc
1148         --auto` consolidates them into one larger pack.  The
1149         default value is 50.  Setting this to 0 disables it.
1151 gc.packrefs::
1152         Running `git pack-refs` in a repository renders it
1153         unclonable by Git versions prior to 1.5.1.2 over dumb
1154         transports such as HTTP.  This variable determines whether
1155         'git gc' runs `git pack-refs`. This can be set to `notbare`
1156         to enable it within all non-bare repos or it can be set to a
1157         boolean value.  The default is `true`.
1159 gc.pruneexpire::
1160         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1161         Override the grace period with this config variable.  The value
1162         "now" may be used to disable this  grace period and always prune
1163         unreachable objects immediately.
1165 gc.reflogexpire::
1166 gc.<pattern>.reflogexpire::
1167         'git reflog expire' removes reflog entries older than
1168         this time; defaults to 90 days.  With "<pattern>" (e.g.
1169         "refs/stash") in the middle the setting applies only to
1170         the refs that match the <pattern>.
1172 gc.reflogexpireunreachable::
1173 gc.<ref>.reflogexpireunreachable::
1174         'git reflog expire' removes reflog entries older than
1175         this time and are not reachable from the current tip;
1176         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1177         in the middle, the setting applies only to the refs that
1178         match the <pattern>.
1180 gc.rerereresolved::
1181         Records of conflicted merge you resolved earlier are
1182         kept for this many days when 'git rerere gc' is run.
1183         The default is 60 days.  See linkgit:git-rerere[1].
1185 gc.rerereunresolved::
1186         Records of conflicted merge you have not resolved are
1187         kept for this many days when 'git rerere gc' is run.
1188         The default is 15 days.  See linkgit:git-rerere[1].
1190 gitcvs.commitmsgannotation::
1191         Append this string to each commit message. Set to empty string
1192         to disable this feature. Defaults to "via git-CVS emulator".
1194 gitcvs.enabled::
1195         Whether the CVS server interface is enabled for this repository.
1196         See linkgit:git-cvsserver[1].
1198 gitcvs.logfile::
1199         Path to a log file where the CVS server interface well... logs
1200         various stuff. See linkgit:git-cvsserver[1].
1202 gitcvs.usecrlfattr::
1203         If true, the server will look up the end-of-line conversion
1204         attributes for files to determine the '-k' modes to use. If
1205         the attributes force Git to treat a file as text,
1206         the '-k' mode will be left blank so CVS clients will
1207         treat it as text. If they suppress text conversion, the file
1208         will be set with '-kb' mode, which suppresses any newline munging
1209         the client might otherwise do. If the attributes do not allow
1210         the file type to be determined, then 'gitcvs.allbinary' is
1211         used. See linkgit:gitattributes[5].
1213 gitcvs.allbinary::
1214         This is used if 'gitcvs.usecrlfattr' does not resolve
1215         the correct '-kb' mode to use. If true, all
1216         unresolved files are sent to the client in
1217         mode '-kb'. This causes the client to treat them
1218         as binary files, which suppresses any newline munging it
1219         otherwise might do. Alternatively, if it is set to "guess",
1220         then the contents of the file are examined to decide if
1221         it is binary, similar to 'core.autocrlf'.
1223 gitcvs.dbname::
1224         Database used by git-cvsserver to cache revision information
1225         derived from the Git repository. The exact meaning depends on the
1226         used database driver, for SQLite (which is the default driver) this
1227         is a filename. Supports variable substitution (see
1228         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1229         Default: '%Ggitcvs.%m.sqlite'
1231 gitcvs.dbdriver::
1232         Used Perl DBI driver. You can specify any available driver
1233         for this here, but it might not work. git-cvsserver is tested
1234         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1235         reported *not* to work with 'DBD::mysql'. Experimental feature.
1236         May not contain double colons (`:`). Default: 'SQLite'.
1237         See linkgit:git-cvsserver[1].
1239 gitcvs.dbuser, gitcvs.dbpass::
1240         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1241         since SQLite has no concept of database users and/or passwords.
1242         'gitcvs.dbuser' supports variable substitution (see
1243         linkgit:git-cvsserver[1] for details).
1245 gitcvs.dbTableNamePrefix::
1246         Database table name prefix.  Prepended to the names of any
1247         database tables used, allowing a single database to be used
1248         for several repositories.  Supports variable substitution (see
1249         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1250         characters will be replaced with underscores.
1252 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1253 'gitcvs.allbinary' can also be specified as
1254 'gitcvs.<access_method>.<varname>' (where 'access_method'
1255 is one of "ext" and "pserver") to make them apply only for the given
1256 access method.
1258 gitweb.category::
1259 gitweb.description::
1260 gitweb.owner::
1261 gitweb.url::
1262         See linkgit:gitweb[1] for description.
1264 gitweb.avatar::
1265 gitweb.blame::
1266 gitweb.grep::
1267 gitweb.highlight::
1268 gitweb.patches::
1269 gitweb.pickaxe::
1270 gitweb.remote_heads::
1271 gitweb.showsizes::
1272 gitweb.snapshot::
1273         See linkgit:gitweb.conf[5] for description.
1275 grep.lineNumber::
1276         If set to true, enable '-n' option by default.
1278 grep.patternType::
1279         Set the default matching behavior. Using a value of 'basic', 'extended',
1280         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1281         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1282         value 'default' will return to the default matching behavior.
1284 grep.extendedRegexp::
1285         If set to true, enable '--extended-regexp' option by default. This
1286         option is ignored when the 'grep.patternType' option is set to a value
1287         other than 'default'.
1289 gpg.program::
1290         Use this custom program instead of "gpg" found on $PATH when
1291         making or verifying a PGP signature. The program must support the
1292         same command line interface as GPG, namely, to verify a detached
1293         signature, "gpg --verify $file - <$signature" is run, and the
1294         program is expected to signal a good signature by exiting with
1295         code 0, and to generate an ascii-armored detached signature, the
1296         standard input of "gpg -bsau $key" is fed with the contents to be
1297         signed, and the program is expected to send the result to its
1298         standard output.
1300 gui.commitmsgwidth::
1301         Defines how wide the commit message window is in the
1302         linkgit:git-gui[1]. "75" is the default.
1304 gui.diffcontext::
1305         Specifies how many context lines should be used in calls to diff
1306         made by the linkgit:git-gui[1]. The default is "5".
1308 gui.encoding::
1309         Specifies the default encoding to use for displaying of
1310         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1311         It can be overridden by setting the 'encoding' attribute
1312         for relevant files (see linkgit:gitattributes[5]).
1313         If this option is not set, the tools default to the
1314         locale encoding.
1316 gui.matchtrackingbranch::
1317         Determines if new branches created with linkgit:git-gui[1] should
1318         default to tracking remote branches with matching names or
1319         not. Default: "false".
1321 gui.newbranchtemplate::
1322         Is used as suggested name when creating new branches using the
1323         linkgit:git-gui[1].
1325 gui.pruneduringfetch::
1326         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1327         performing a fetch. The default value is "false".
1329 gui.trustmtime::
1330         Determines if linkgit:git-gui[1] should trust the file modification
1331         timestamp or not. By default the timestamps are not trusted.
1333 gui.spellingdictionary::
1334         Specifies the dictionary used for spell checking commit messages in
1335         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1336         off.
1338 gui.fastcopyblame::
1339         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1340         location detection. It makes blame significantly faster on huge
1341         repositories at the expense of less thorough copy detection.
1343 gui.copyblamethreshold::
1344         Specifies the threshold to use in 'git gui blame' original location
1345         detection, measured in alphanumeric characters. See the
1346         linkgit:git-blame[1] manual for more information on copy detection.
1348 gui.blamehistoryctx::
1349         Specifies the radius of history context in days to show in
1350         linkgit:gitk[1] for the selected commit, when the `Show History
1351         Context` menu item is invoked from 'git gui blame'. If this
1352         variable is set to zero, the whole history is shown.
1354 guitool.<name>.cmd::
1355         Specifies the shell command line to execute when the corresponding item
1356         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1357         mandatory for every tool. The command is executed from the root of
1358         the working directory, and in the environment it receives the name of
1359         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1360         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1361         the head is detached, 'CUR_BRANCH' is empty).
1363 guitool.<name>.needsfile::
1364         Run the tool only if a diff is selected in the GUI. It guarantees
1365         that 'FILENAME' is not empty.
1367 guitool.<name>.noconsole::
1368         Run the command silently, without creating a window to display its
1369         output.
1371 guitool.<name>.norescan::
1372         Don't rescan the working directory for changes after the tool
1373         finishes execution.
1375 guitool.<name>.confirm::
1376         Show a confirmation dialog before actually running the tool.
1378 guitool.<name>.argprompt::
1379         Request a string argument from the user, and pass it to the tool
1380         through the 'ARGS' environment variable. Since requesting an
1381         argument implies confirmation, the 'confirm' option has no effect
1382         if this is enabled. If the option is set to 'true', 'yes', or '1',
1383         the dialog uses a built-in generic prompt; otherwise the exact
1384         value of the variable is used.
1386 guitool.<name>.revprompt::
1387         Request a single valid revision from the user, and set the
1388         'REVISION' environment variable. In other aspects this option
1389         is similar to 'argprompt', and can be used together with it.
1391 guitool.<name>.revunmerged::
1392         Show only unmerged branches in the 'revprompt' subdialog.
1393         This is useful for tools similar to merge or rebase, but not
1394         for things like checkout or reset.
1396 guitool.<name>.title::
1397         Specifies the title to use for the prompt dialog. The default
1398         is the tool name.
1400 guitool.<name>.prompt::
1401         Specifies the general prompt string to display at the top of
1402         the dialog, before subsections for 'argprompt' and 'revprompt'.
1403         The default value includes the actual command.
1405 help.browser::
1406         Specify the browser that will be used to display help in the
1407         'web' format. See linkgit:git-help[1].
1409 help.format::
1410         Override the default help format used by linkgit:git-help[1].
1411         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1412         the default. 'web' and 'html' are the same.
1414 help.autocorrect::
1415         Automatically correct and execute mistyped commands after
1416         waiting for the given number of deciseconds (0.1 sec). If more
1417         than one command can be deduced from the entered text, nothing
1418         will be executed.  If the value of this option is negative,
1419         the corrected command will be executed immediately. If the
1420         value is 0 - the command will be just shown but not executed.
1421         This is the default.
1423 help.htmlpath::
1424         Specify the path where the HTML documentation resides. File system paths
1425         and URLs are supported. HTML pages will be prefixed with this path when
1426         help is displayed in the 'web' format. This defaults to the documentation
1427         path of your Git installation.
1429 http.proxy::
1430         Override the HTTP proxy, normally configured using the 'http_proxy',
1431         'https_proxy', and 'all_proxy' environment variables (see
1432         `curl(1)`).  This can be overridden on a per-remote basis; see
1433         remote.<name>.proxy
1435 http.cookiefile::
1436         File containing previously stored cookie lines which should be used
1437         in the Git http session, if they match the server. The file format
1438         of the file to read cookies from should be plain HTTP headers or
1439         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1440         NOTE that the file specified with http.cookiefile is only used as
1441         input. No cookies will be stored in the file.
1443 http.sslVerify::
1444         Whether to verify the SSL certificate when fetching or pushing
1445         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1446         variable.
1448 http.sslCert::
1449         File containing the SSL certificate when fetching or pushing
1450         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1451         variable.
1453 http.sslKey::
1454         File containing the SSL private key when fetching or pushing
1455         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1456         variable.
1458 http.sslCertPasswordProtected::
1459         Enable Git's password prompt for the SSL certificate.  Otherwise
1460         OpenSSL will prompt the user, possibly many times, if the
1461         certificate or private key is encrypted.  Can be overridden by the
1462         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1464 http.sslCAInfo::
1465         File containing the certificates to verify the peer with when
1466         fetching or pushing over HTTPS. Can be overridden by the
1467         'GIT_SSL_CAINFO' environment variable.
1469 http.sslCAPath::
1470         Path containing files with the CA certificates to verify the peer
1471         with when fetching or pushing over HTTPS. Can be overridden
1472         by the 'GIT_SSL_CAPATH' environment variable.
1474 http.sslTry::
1475         Attempt to use AUTH SSL/TLS and encrypted data transfers
1476         when connecting via regular FTP protocol. This might be needed
1477         if the FTP server requires it for security reasons or you wish
1478         to connect securely whenever remote FTP server supports it.
1479         Default is false since it might trigger certificate verification
1480         errors on misconfigured servers.
1482 http.maxRequests::
1483         How many HTTP requests to launch in parallel. Can be overridden
1484         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1486 http.minSessions::
1487         The number of curl sessions (counted across slots) to be kept across
1488         requests. They will not be ended with curl_easy_cleanup() until
1489         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1490         value will be capped at 1. Defaults to 1.
1492 http.postBuffer::
1493         Maximum size in bytes of the buffer used by smart HTTP
1494         transports when POSTing data to the remote system.
1495         For requests larger than this buffer size, HTTP/1.1 and
1496         Transfer-Encoding: chunked is used to avoid creating a
1497         massive pack file locally.  Default is 1 MiB, which is
1498         sufficient for most requests.
1500 http.lowSpeedLimit, http.lowSpeedTime::
1501         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1502         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1503         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1504         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1506 http.noEPSV::
1507         A boolean which disables using of EPSV ftp command by curl.
1508         This can helpful with some "poor" ftp servers which don't
1509         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1510         environment variable. Default is false (curl will use EPSV).
1512 http.useragent::
1513         The HTTP USER_AGENT string presented to an HTTP server.  The default
1514         value represents the version of the client Git such as git/1.7.1.
1515         This option allows you to override this value to a more common value
1516         such as Mozilla/4.0.  This may be necessary, for instance, if
1517         connecting through a firewall that restricts HTTP connections to a set
1518         of common USER_AGENT strings (but not including those like git/1.7.1).
1519         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1521 i18n.commitEncoding::
1522         Character encoding the commit messages are stored in; Git itself
1523         does not care per se, but this information is necessary e.g. when
1524         importing commits from emails or in the gitk graphical history
1525         browser (and possibly at other places in the future or in other
1526         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1528 i18n.logOutputEncoding::
1529         Character encoding the commit messages are converted to when
1530         running 'git log' and friends.
1532 imap::
1533         The configuration variables in the 'imap' section are described
1534         in linkgit:git-imap-send[1].
1536 init.templatedir::
1537         Specify the directory from which templates will be copied.
1538         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1540 instaweb.browser::
1541         Specify the program that will be used to browse your working
1542         repository in gitweb. See linkgit:git-instaweb[1].
1544 instaweb.httpd::
1545         The HTTP daemon command-line to start gitweb on your working
1546         repository. See linkgit:git-instaweb[1].
1548 instaweb.local::
1549         If true the web server started by linkgit:git-instaweb[1] will
1550         be bound to the local IP (127.0.0.1).
1552 instaweb.modulepath::
1553         The default module path for linkgit:git-instaweb[1] to use
1554         instead of /usr/lib/apache2/modules.  Only used if httpd
1555         is Apache.
1557 instaweb.port::
1558         The port number to bind the gitweb httpd to. See
1559         linkgit:git-instaweb[1].
1561 interactive.singlekey::
1562         In interactive commands, allow the user to provide one-letter
1563         input with a single key (i.e., without hitting enter).
1564         Currently this is used by the `--patch` mode of
1565         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1566         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1567         setting is silently ignored if portable keystroke input
1568         is not available.
1570 log.abbrevCommit::
1571         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1572         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1573         override this option with `--no-abbrev-commit`.
1575 log.date::
1576         Set the default date-time mode for the 'log' command.
1577         Setting a value for log.date is similar to using 'git log''s
1578         `--date` option.  Possible values are `relative`, `local`,
1579         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1580         for details.
1582 log.decorate::
1583         Print out the ref names of any commits that are shown by the log
1584         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1585         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1586         specified, the full ref name (including prefix) will be printed.
1587         This is the same as the log commands '--decorate' option.
1589 log.showroot::
1590         If true, the initial commit will be shown as a big creation event.
1591         This is equivalent to a diff against an empty tree.
1592         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1593         normally hide the root commit will now show it. True by default.
1595 log.mailmap::
1596         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1597         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1599 mailmap.file::
1600         The location of an augmenting mailmap file. The default
1601         mailmap, located in the root of the repository, is loaded
1602         first, then the mailmap file pointed to by this variable.
1603         The location of the mailmap file may be in a repository
1604         subdirectory, or somewhere outside of the repository itself.
1605         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1607 mailmap.blob::
1608         Like `mailmap.file`, but consider the value as a reference to a
1609         blob in the repository. If both `mailmap.file` and
1610         `mailmap.blob` are given, both are parsed, with entries from
1611         `mailmap.file` taking precedence. In a bare repository, this
1612         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1613         defaults to empty.
1615 man.viewer::
1616         Specify the programs that may be used to display help in the
1617         'man' format. See linkgit:git-help[1].
1619 man.<tool>.cmd::
1620         Specify the command to invoke the specified man viewer. The
1621         specified command is evaluated in shell with the man page
1622         passed as argument. (See linkgit:git-help[1].)
1624 man.<tool>.path::
1625         Override the path for the given tool that may be used to
1626         display help in the 'man' format. See linkgit:git-help[1].
1628 include::merge-config.txt[]
1630 mergetool.<tool>.path::
1631         Override the path for the given tool.  This is useful in case
1632         your tool is not in the PATH.
1634 mergetool.<tool>.cmd::
1635         Specify the command to invoke the specified merge tool.  The
1636         specified command is evaluated in shell with the following
1637         variables available: 'BASE' is the name of a temporary file
1638         containing the common base of the files to be merged, if available;
1639         'LOCAL' is the name of a temporary file containing the contents of
1640         the file on the current branch; 'REMOTE' is the name of a temporary
1641         file containing the contents of the file from the branch being
1642         merged; 'MERGED' contains the name of the file to which the merge
1643         tool should write the results of a successful merge.
1645 mergetool.<tool>.trustExitCode::
1646         For a custom merge command, specify whether the exit code of
1647         the merge command can be used to determine whether the merge was
1648         successful.  If this is not set to true then the merge target file
1649         timestamp is checked and the merge assumed to have been successful
1650         if the file has been updated, otherwise the user is prompted to
1651         indicate the success of the merge.
1653 mergetool.keepBackup::
1654         After performing a merge, the original file with conflict markers
1655         can be saved as a file with a `.orig` extension.  If this variable
1656         is set to `false` then this file is not preserved.  Defaults to
1657         `true` (i.e. keep the backup files).
1659 mergetool.keepTemporaries::
1660         When invoking a custom merge tool, Git uses a set of temporary
1661         files to pass to the tool. If the tool returns an error and this
1662         variable is set to `true`, then these temporary files will be
1663         preserved, otherwise they will be removed after the tool has
1664         exited. Defaults to `false`.
1666 mergetool.prompt::
1667         Prompt before each invocation of the merge resolution program.
1669 notes.displayRef::
1670         The (fully qualified) refname from which to show notes when
1671         showing commit messages.  The value of this variable can be set
1672         to a glob, in which case notes from all matching refs will be
1673         shown.  You may also specify this configuration variable
1674         several times.  A warning will be issued for refs that do not
1675         exist, but a glob that does not match any refs is silently
1676         ignored.
1678 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1679 environment variable, which must be a colon separated list of refs or
1680 globs.
1682 The effective value of "core.notesRef" (possibly overridden by
1683 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1684 displayed.
1686 notes.rewrite.<command>::
1687         When rewriting commits with <command> (currently `amend` or
1688         `rebase`) and this variable is set to `true`, Git
1689         automatically copies your notes from the original to the
1690         rewritten commit.  Defaults to `true`, but see
1691         "notes.rewriteRef" below.
1693 notes.rewriteMode::
1694         When copying notes during a rewrite (see the
1695         "notes.rewrite.<command>" option), determines what to do if
1696         the target commit already has a note.  Must be one of
1697         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1698         `concatenate`.
1700 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1701 environment variable.
1703 notes.rewriteRef::
1704         When copying notes during a rewrite, specifies the (fully
1705         qualified) ref whose notes should be copied.  The ref may be a
1706         glob, in which case notes in all matching refs will be copied.
1707         You may also specify this configuration several times.
1709 Does not have a default value; you must configure this variable to
1710 enable note rewriting.  Set it to `refs/notes/commits` to enable
1711 rewriting for the default commit notes.
1713 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1714 environment variable, which must be a colon separated list of refs or
1715 globs.
1717 pack.window::
1718         The size of the window used by linkgit:git-pack-objects[1] when no
1719         window size is given on the command line. Defaults to 10.
1721 pack.depth::
1722         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1723         maximum depth is given on the command line. Defaults to 50.
1725 pack.windowMemory::
1726         The window memory size limit used by linkgit:git-pack-objects[1]
1727         when no limit is given on the command line.  The value can be
1728         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1729         limit.
1731 pack.compression::
1732         An integer -1..9, indicating the compression level for objects
1733         in a pack file. -1 is the zlib default. 0 means no
1734         compression, and 1..9 are various speed/size tradeoffs, 9 being
1735         slowest.  If not set,  defaults to core.compression.  If that is
1736         not set,  defaults to -1, the zlib default, which is "a default
1737         compromise between speed and compression (currently equivalent
1738         to level 6)."
1740 Note that changing the compression level will not automatically recompress
1741 all existing objects. You can force recompression by passing the -F option
1742 to linkgit:git-repack[1].
1744 pack.deltaCacheSize::
1745         The maximum memory in bytes used for caching deltas in
1746         linkgit:git-pack-objects[1] before writing them out to a pack.
1747         This cache is used to speed up the writing object phase by not
1748         having to recompute the final delta result once the best match
1749         for all objects is found.  Repacking large repositories on machines
1750         which are tight with memory might be badly impacted by this though,
1751         especially if this cache pushes the system into swapping.
1752         A value of 0 means no limit. The smallest size of 1 byte may be
1753         used to virtually disable this cache. Defaults to 256 MiB.
1755 pack.deltaCacheLimit::
1756         The maximum size of a delta, that is cached in
1757         linkgit:git-pack-objects[1]. This cache is used to speed up the
1758         writing object phase by not having to recompute the final delta
1759         result once the best match for all objects is found. Defaults to 1000.
1761 pack.threads::
1762         Specifies the number of threads to spawn when searching for best
1763         delta matches.  This requires that linkgit:git-pack-objects[1]
1764         be compiled with pthreads otherwise this option is ignored with a
1765         warning. This is meant to reduce packing time on multiprocessor
1766         machines. The required amount of memory for the delta search window
1767         is however multiplied by the number of threads.
1768         Specifying 0 will cause Git to auto-detect the number of CPU's
1769         and set the number of threads accordingly.
1771 pack.indexVersion::
1772         Specify the default pack index version.  Valid values are 1 for
1773         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1774         the new pack index with capabilities for packs larger than 4 GB
1775         as well as proper protection against the repacking of corrupted
1776         packs.  Version 2 is the default.  Note that version 2 is enforced
1777         and this config option ignored whenever the corresponding pack is
1778         larger than 2 GB.
1780 If you have an old Git that does not understand the version 2 `*.idx` file,
1781 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1782 that will copy both `*.pack` file and corresponding `*.idx` file from the
1783 other side may give you a repository that cannot be accessed with your
1784 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1785 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1786 the `*.idx` file.
1788 pack.packSizeLimit::
1789         The maximum size of a pack.  This setting only affects
1790         packing to a file when repacking, i.e. the git:// protocol
1791         is unaffected.  It can be overridden by the `--max-pack-size`
1792         option of linkgit:git-repack[1]. The minimum size allowed is
1793         limited to 1 MiB. The default is unlimited.
1794         Common unit suffixes of 'k', 'm', or 'g' are
1795         supported.
1797 pager.<cmd>::
1798         If the value is boolean, turns on or off pagination of the
1799         output of a particular Git subcommand when writing to a tty.
1800         Otherwise, turns on pagination for the subcommand using the
1801         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1802         or `--no-pager` is specified on the command line, it takes
1803         precedence over this option.  To disable pagination for all
1804         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1806 pretty.<name>::
1807         Alias for a --pretty= format string, as specified in
1808         linkgit:git-log[1]. Any aliases defined here can be used just
1809         as the built-in pretty formats could. For example,
1810         running `git config pretty.changelog "format:* %H %s"`
1811         would cause the invocation `git log --pretty=changelog`
1812         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1813         Note that an alias with the same name as a built-in format
1814         will be silently ignored.
1816 pull.rebase::
1817         When true, rebase branches on top of the fetched branch, instead
1818         of merging the default branch from the default remote when "git
1819         pull" is run. See "branch.<name>.rebase" for setting this on a
1820         per-branch basis.
1822 *NOTE*: this is a possibly dangerous operation; do *not* use
1823 it unless you understand the implications (see linkgit:git-rebase[1]
1824 for details).
1826 pull.octopus::
1827         The default merge strategy to use when pulling multiple branches
1828         at once.
1830 pull.twohead::
1831         The default merge strategy to use when pulling a single branch.
1833 push.default::
1834         Defines the action `git push` should take if no refspec is given
1835         on the command line, no refspec is configured in the remote, and
1836         no refspec is implied by any of the options given on the command
1837         line. Possible values are:
1840 * `nothing` - do not push anything.
1841 * `matching` - push all branches having the same name in both ends.
1842   This is for those who prepare all the branches into a publishable
1843   shape and then push them out with a single command.  It is not
1844   appropriate for pushing into a repository shared by multiple users,
1845   since locally stalled branches will attempt a non-fast forward push
1846   if other users updated the branch.
1847   +
1848   This is currently the default, but Git 2.0 will change the default
1849   to `simple`.
1850 * `upstream` - push the current branch to its upstream branch
1851   (`tracking` is a deprecated synonym for this).
1852   With this, `git push` will update the same remote ref as the one which
1853   is merged by `git pull`, making `push` and `pull` symmetrical.
1854   See "branch.<name>.merge" for how to configure the upstream branch.
1855 * `simple` - like `upstream`, but refuses to push if the upstream
1856   branch's name is different from the local one. This is the safest
1857   option and is well-suited for beginners. It will become the default
1858   in Git 2.0.
1859 * `current` - push the current branch to a branch of the same name.
1862 The `simple`, `current` and `upstream` modes are for those who want to
1863 push out a single branch after finishing work, even when the other
1864 branches are not yet ready to be pushed out. If you are working with
1865 other people to push into the same shared repository, you would want
1866 to use one of these.
1868 rebase.stat::
1869         Whether to show a diffstat of what changed upstream since the last
1870         rebase. False by default.
1872 rebase.autosquash::
1873         If set to true enable '--autosquash' option by default.
1875 receive.autogc::
1876         By default, git-receive-pack will run "git-gc --auto" after
1877         receiving data from git-push and updating refs.  You can stop
1878         it by setting this variable to false.
1880 receive.fsckObjects::
1881         If it is set to true, git-receive-pack will check all received
1882         objects. It will abort in the case of a malformed object or a
1883         broken link. The result of an abort are only dangling objects.
1884         Defaults to false. If not set, the value of `transfer.fsckObjects`
1885         is used instead.
1887 receive.unpackLimit::
1888         If the number of objects received in a push is below this
1889         limit then the objects will be unpacked into loose object
1890         files. However if the number of received objects equals or
1891         exceeds this limit then the received pack will be stored as
1892         a pack, after adding any missing delta bases.  Storing the
1893         pack from a push can make the push operation complete faster,
1894         especially on slow filesystems.  If not set, the value of
1895         `transfer.unpackLimit` is used instead.
1897 receive.denyDeletes::
1898         If set to true, git-receive-pack will deny a ref update that deletes
1899         the ref. Use this to prevent such a ref deletion via a push.
1901 receive.denyDeleteCurrent::
1902         If set to true, git-receive-pack will deny a ref update that
1903         deletes the currently checked out branch of a non-bare repository.
1905 receive.denyCurrentBranch::
1906         If set to true or "refuse", git-receive-pack will deny a ref update
1907         to the currently checked out branch of a non-bare repository.
1908         Such a push is potentially dangerous because it brings the HEAD
1909         out of sync with the index and working tree. If set to "warn",
1910         print a warning of such a push to stderr, but allow the push to
1911         proceed. If set to false or "ignore", allow such pushes with no
1912         message. Defaults to "refuse".
1914 receive.denyNonFastForwards::
1915         If set to true, git-receive-pack will deny a ref update which is
1916         not a fast-forward. Use this to prevent such an update via a push,
1917         even if that push is forced. This configuration variable is
1918         set when initializing a shared repository.
1920 receive.hiderefs::
1921         String(s) `receive-pack` uses to decide which refs to omit
1922         from its initial advertisement.  Use more than one
1923         definitions to specify multiple prefix strings. A ref that
1924         are under the hierarchies listed on the value of this
1925         variable is excluded, and is hidden when responding to `git
1926         push`, and an attempt to update or delete a hidden ref by
1927         `git push` is rejected.
1929 receive.updateserverinfo::
1930         If set to true, git-receive-pack will run git-update-server-info
1931         after receiving data from git-push and updating refs.
1933 remote.pushdefault::
1934         The remote to push to by default.  Overrides
1935         `branch.<name>.remote` for all branches, and is overridden by
1936         `branch.<name>.pushremote` for specific branches.
1938 remote.<name>.url::
1939         The URL of a remote repository.  See linkgit:git-fetch[1] or
1940         linkgit:git-push[1].
1942 remote.<name>.pushurl::
1943         The push URL of a remote repository.  See linkgit:git-push[1].
1945 remote.<name>.proxy::
1946         For remotes that require curl (http, https and ftp), the URL to
1947         the proxy to use for that remote.  Set to the empty string to
1948         disable proxying for that remote.
1950 remote.<name>.fetch::
1951         The default set of "refspec" for linkgit:git-fetch[1]. See
1952         linkgit:git-fetch[1].
1954 remote.<name>.push::
1955         The default set of "refspec" for linkgit:git-push[1]. See
1956         linkgit:git-push[1].
1958 remote.<name>.mirror::
1959         If true, pushing to this remote will automatically behave
1960         as if the `--mirror` option was given on the command line.
1962 remote.<name>.skipDefaultUpdate::
1963         If true, this remote will be skipped by default when updating
1964         using linkgit:git-fetch[1] or the `update` subcommand of
1965         linkgit:git-remote[1].
1967 remote.<name>.skipFetchAll::
1968         If true, this remote will be skipped by default when updating
1969         using linkgit:git-fetch[1] or the `update` subcommand of
1970         linkgit:git-remote[1].
1972 remote.<name>.receivepack::
1973         The default program to execute on the remote side when pushing.  See
1974         option \--receive-pack of linkgit:git-push[1].
1976 remote.<name>.uploadpack::
1977         The default program to execute on the remote side when fetching.  See
1978         option \--upload-pack of linkgit:git-fetch-pack[1].
1980 remote.<name>.tagopt::
1981         Setting this value to \--no-tags disables automatic tag following when
1982         fetching from remote <name>. Setting it to \--tags will fetch every
1983         tag from remote <name>, even if they are not reachable from remote
1984         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1985         override this setting. See options \--tags and \--no-tags of
1986         linkgit:git-fetch[1].
1988 remote.<name>.vcs::
1989         Setting this to a value <vcs> will cause Git to interact with
1990         the remote with the git-remote-<vcs> helper.
1992 remotes.<group>::
1993         The list of remotes which are fetched by "git remote update
1994         <group>".  See linkgit:git-remote[1].
1996 repack.usedeltabaseoffset::
1997         By default, linkgit:git-repack[1] creates packs that use
1998         delta-base offset. If you need to share your repository with
1999         Git older than version 1.4.4, either directly or via a dumb
2000         protocol such as http, then you need to set this option to
2001         "false" and repack. Access from old Git versions over the
2002         native protocol are unaffected by this option.
2004 rerere.autoupdate::
2005         When set to true, `git-rerere` updates the index with the
2006         resulting contents after it cleanly resolves conflicts using
2007         previously recorded resolution.  Defaults to false.
2009 rerere.enabled::
2010         Activate recording of resolved conflicts, so that identical
2011         conflict hunks can be resolved automatically, should they be
2012         encountered again.  By default, linkgit:git-rerere[1] is
2013         enabled if there is an `rr-cache` directory under the
2014         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2015         repository.
2017 sendemail.identity::
2018         A configuration identity. When given, causes values in the
2019         'sendemail.<identity>' subsection to take precedence over
2020         values in the 'sendemail' section. The default identity is
2021         the value of 'sendemail.identity'.
2023 sendemail.smtpencryption::
2024         See linkgit:git-send-email[1] for description.  Note that this
2025         setting is not subject to the 'identity' mechanism.
2027 sendemail.smtpssl::
2028         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2030 sendemail.<identity>.*::
2031         Identity-specific versions of the 'sendemail.*' parameters
2032         found below, taking precedence over those when the this
2033         identity is selected, through command-line or
2034         'sendemail.identity'.
2036 sendemail.aliasesfile::
2037 sendemail.aliasfiletype::
2038 sendemail.annotate::
2039 sendemail.bcc::
2040 sendemail.cc::
2041 sendemail.cccmd::
2042 sendemail.chainreplyto::
2043 sendemail.confirm::
2044 sendemail.envelopesender::
2045 sendemail.from::
2046 sendemail.multiedit::
2047 sendemail.signedoffbycc::
2048 sendemail.smtppass::
2049 sendemail.suppresscc::
2050 sendemail.suppressfrom::
2051 sendemail.to::
2052 sendemail.smtpdomain::
2053 sendemail.smtpserver::
2054 sendemail.smtpserverport::
2055 sendemail.smtpserveroption::
2056 sendemail.smtpuser::
2057 sendemail.thread::
2058 sendemail.validate::
2059         See linkgit:git-send-email[1] for description.
2061 sendemail.signedoffcc::
2062         Deprecated alias for 'sendemail.signedoffbycc'.
2064 showbranch.default::
2065         The default set of branches for linkgit:git-show-branch[1].
2066         See linkgit:git-show-branch[1].
2068 status.relativePaths::
2069         By default, linkgit:git-status[1] shows paths relative to the
2070         current directory. Setting this variable to `false` shows paths
2071         relative to the repository root (this was the default for Git
2072         prior to v1.5.4).
2074 status.showUntrackedFiles::
2075         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2076         files which are not currently tracked by Git. Directories which
2077         contain only untracked files, are shown with the directory name
2078         only. Showing untracked files means that Git needs to lstat() all
2079         all the files in the whole repository, which might be slow on some
2080         systems. So, this variable controls how the commands displays
2081         the untracked files. Possible values are:
2084 * `no` - Show no untracked files.
2085 * `normal` - Show untracked files and directories.
2086 * `all` - Show also individual files in untracked directories.
2089 If this variable is not specified, it defaults to 'normal'.
2090 This variable can be overridden with the -u|--untracked-files option
2091 of linkgit:git-status[1] and linkgit:git-commit[1].
2093 status.submodulesummary::
2094         Defaults to false.
2095         If this is set to a non zero number or true (identical to -1 or an
2096         unlimited number), the submodule summary will be enabled and a
2097         summary of commits for modified submodules will be shown (see
2098         --summary-limit option of linkgit:git-submodule[1]).
2100 submodule.<name>.path::
2101 submodule.<name>.url::
2102 submodule.<name>.update::
2103         The path within this project, URL, and the updating strategy
2104         for a submodule.  These variables are initially populated
2105         by 'git submodule init'; edit them to override the
2106         URL and other values found in the `.gitmodules` file.  See
2107         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2109 submodule.<name>.branch::
2110         The remote branch name for a submodule, used by `git submodule
2111         update --remote`.  Set this option to override the value found in
2112         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2113         linkgit:gitmodules[5] for details.
2115 submodule.<name>.fetchRecurseSubmodules::
2116         This option can be used to control recursive fetching of this
2117         submodule. It can be overridden by using the --[no-]recurse-submodules
2118         command line option to "git fetch" and "git pull".
2119         This setting will override that from in the linkgit:gitmodules[5]
2120         file.
2122 submodule.<name>.ignore::
2123         Defines under what circumstances "git status" and the diff family show
2124         a submodule as modified. When set to "all", it will never be considered
2125         modified, "dirty" will ignore all changes to the submodules work tree and
2126         takes only differences between the HEAD of the submodule and the commit
2127         recorded in the superproject into account. "untracked" will additionally
2128         let submodules with modified tracked files in their work tree show up.
2129         Using "none" (the default when this option is not set) also shows
2130         submodules that have untracked files in their work tree as changed.
2131         This setting overrides any setting made in .gitmodules for this submodule,
2132         both settings can be overridden on the command line by using the
2133         "--ignore-submodules" option.
2135 tar.umask::
2136         This variable can be used to restrict the permission bits of
2137         tar archive entries.  The default is 0002, which turns off the
2138         world write bit.  The special value "user" indicates that the
2139         archiving user's umask will be used instead.  See umask(2) and
2140         linkgit:git-archive[1].
2142 transfer.fsckObjects::
2143         When `fetch.fsckObjects` or `receive.fsckObjects` are
2144         not set, the value of this variable is used instead.
2145         Defaults to false.
2147 transfer.hiderefs::
2148         This variable can be used to set both `receive.hiderefs`
2149         and `uploadpack.hiderefs` at the same time to the same
2150         values.  See entries for these other variables.
2152 transfer.unpackLimit::
2153         When `fetch.unpackLimit` or `receive.unpackLimit` are
2154         not set, the value of this variable is used instead.
2155         The default value is 100.
2157 uploadpack.hiderefs::
2158         String(s) `upload-pack` uses to decide which refs to omit
2159         from its initial advertisement.  Use more than one
2160         definitions to specify multiple prefix strings. A ref that
2161         are under the hierarchies listed on the value of this
2162         variable is excluded, and is hidden from `git ls-remote`,
2163         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2164         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2166 uploadpack.allowtipsha1inwant::
2167         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2168         to accept a fetch request that asks for an object at the tip
2169         of a hidden ref (by default, such a request is rejected).
2170         see also `uploadpack.hiderefs`.
2172 url.<base>.insteadOf::
2173         Any URL that starts with this value will be rewritten to
2174         start, instead, with <base>. In cases where some site serves a
2175         large number of repositories, and serves them with multiple
2176         access methods, and some users need to use different access
2177         methods, this feature allows people to specify any of the
2178         equivalent URLs and have Git automatically rewrite the URL to
2179         the best alternative for the particular user, even for a
2180         never-before-seen repository on the site.  When more than one
2181         insteadOf strings match a given URL, the longest match is used.
2183 url.<base>.pushInsteadOf::
2184         Any URL that starts with this value will not be pushed to;
2185         instead, it will be rewritten to start with <base>, and the
2186         resulting URL will be pushed to. In cases where some site serves
2187         a large number of repositories, and serves them with multiple
2188         access methods, some of which do not allow push, this feature
2189         allows people to specify a pull-only URL and have Git
2190         automatically use an appropriate URL to push, even for a
2191         never-before-seen repository on the site.  When more than one
2192         pushInsteadOf strings match a given URL, the longest match is
2193         used.  If a remote has an explicit pushurl, Git will ignore this
2194         setting for that remote.
2196 user.email::
2197         Your email address to be recorded in any newly created commits.
2198         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2199         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2201 user.name::
2202         Your full name to be recorded in any newly created commits.
2203         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2204         environment variables.  See linkgit:git-commit-tree[1].
2206 user.signingkey::
2207         If linkgit:git-tag[1] is not selecting the key you want it to
2208         automatically when creating a signed tag, you can override the
2209         default selection with this variable.  This option is passed
2210         unchanged to gpg's --local-user parameter, so you may specify a key
2211         using any method that gpg supports.
2213 web.browser::
2214         Specify a web browser that may be used by some commands.
2215         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2216         may use it.