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