Merge branch 'sg/archive-restrict-remote'
[git.git] / Documentation / config.txt
blob0e1dde3fffc70ff8903e23392dfa7d534d435013
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.aggressiveWindow::
1155         The window size parameter used in the delta compression
1156         algorithm used by 'git gc --aggressive'.  This defaults
1157         to 250.
1159 gc.auto::
1160         When there are approximately more than this many loose
1161         objects in the repository, `git gc --auto` will pack them.
1162         Some Porcelain commands use this command to perform a
1163         light-weight garbage collection from time to time.  The
1164         default value is 6700.  Setting this to 0 disables it.
1166 gc.autopacklimit::
1167         When there are more than this many packs that are not
1168         marked with `*.keep` file in the repository, `git gc
1169         --auto` consolidates them into one larger pack.  The
1170         default value is 50.  Setting this to 0 disables it.
1172 gc.autodetach::
1173         Make `git gc --auto` return immediately andrun in background
1174         if the system supports it. Default is true.
1176 gc.packrefs::
1177         Running `git pack-refs` in a repository renders it
1178         unclonable by Git versions prior to 1.5.1.2 over dumb
1179         transports such as HTTP.  This variable determines whether
1180         'git gc' runs `git pack-refs`. This can be set to `notbare`
1181         to enable it within all non-bare repos or it can be set to a
1182         boolean value.  The default is `true`.
1184 gc.pruneexpire::
1185         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1186         Override the grace period with this config variable.  The value
1187         "now" may be used to disable this  grace period and always prune
1188         unreachable objects immediately.
1190 gc.reflogexpire::
1191 gc.<pattern>.reflogexpire::
1192         'git reflog expire' removes reflog entries older than
1193         this time; defaults to 90 days.  With "<pattern>" (e.g.
1194         "refs/stash") in the middle the setting applies only to
1195         the refs that match the <pattern>.
1197 gc.reflogexpireunreachable::
1198 gc.<ref>.reflogexpireunreachable::
1199         'git reflog expire' removes reflog entries older than
1200         this time and are not reachable from the current tip;
1201         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1202         in the middle, the setting applies only to the refs that
1203         match the <pattern>.
1205 gc.rerereresolved::
1206         Records of conflicted merge you resolved earlier are
1207         kept for this many days when 'git rerere gc' is run.
1208         The default is 60 days.  See linkgit:git-rerere[1].
1210 gc.rerereunresolved::
1211         Records of conflicted merge you have not resolved are
1212         kept for this many days when 'git rerere gc' is run.
1213         The default is 15 days.  See linkgit:git-rerere[1].
1215 gitcvs.commitmsgannotation::
1216         Append this string to each commit message. Set to empty string
1217         to disable this feature. Defaults to "via git-CVS emulator".
1219 gitcvs.enabled::
1220         Whether the CVS server interface is enabled for this repository.
1221         See linkgit:git-cvsserver[1].
1223 gitcvs.logfile::
1224         Path to a log file where the CVS server interface well... logs
1225         various stuff. See linkgit:git-cvsserver[1].
1227 gitcvs.usecrlfattr::
1228         If true, the server will look up the end-of-line conversion
1229         attributes for files to determine the '-k' modes to use. If
1230         the attributes force Git to treat a file as text,
1231         the '-k' mode will be left blank so CVS clients will
1232         treat it as text. If they suppress text conversion, the file
1233         will be set with '-kb' mode, which suppresses any newline munging
1234         the client might otherwise do. If the attributes do not allow
1235         the file type to be determined, then 'gitcvs.allbinary' is
1236         used. See linkgit:gitattributes[5].
1238 gitcvs.allbinary::
1239         This is used if 'gitcvs.usecrlfattr' does not resolve
1240         the correct '-kb' mode to use. If true, all
1241         unresolved files are sent to the client in
1242         mode '-kb'. This causes the client to treat them
1243         as binary files, which suppresses any newline munging it
1244         otherwise might do. Alternatively, if it is set to "guess",
1245         then the contents of the file are examined to decide if
1246         it is binary, similar to 'core.autocrlf'.
1248 gitcvs.dbname::
1249         Database used by git-cvsserver to cache revision information
1250         derived from the Git repository. The exact meaning depends on the
1251         used database driver, for SQLite (which is the default driver) this
1252         is a filename. Supports variable substitution (see
1253         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1254         Default: '%Ggitcvs.%m.sqlite'
1256 gitcvs.dbdriver::
1257         Used Perl DBI driver. You can specify any available driver
1258         for this here, but it might not work. git-cvsserver is tested
1259         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1260         reported *not* to work with 'DBD::mysql'. Experimental feature.
1261         May not contain double colons (`:`). Default: 'SQLite'.
1262         See linkgit:git-cvsserver[1].
1264 gitcvs.dbuser, gitcvs.dbpass::
1265         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1266         since SQLite has no concept of database users and/or passwords.
1267         'gitcvs.dbuser' supports variable substitution (see
1268         linkgit:git-cvsserver[1] for details).
1270 gitcvs.dbTableNamePrefix::
1271         Database table name prefix.  Prepended to the names of any
1272         database tables used, allowing a single database to be used
1273         for several repositories.  Supports variable substitution (see
1274         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1275         characters will be replaced with underscores.
1277 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1278 'gitcvs.allbinary' can also be specified as
1279 'gitcvs.<access_method>.<varname>' (where 'access_method'
1280 is one of "ext" and "pserver") to make them apply only for the given
1281 access method.
1283 gitweb.category::
1284 gitweb.description::
1285 gitweb.owner::
1286 gitweb.url::
1287         See linkgit:gitweb[1] for description.
1289 gitweb.avatar::
1290 gitweb.blame::
1291 gitweb.grep::
1292 gitweb.highlight::
1293 gitweb.patches::
1294 gitweb.pickaxe::
1295 gitweb.remote_heads::
1296 gitweb.showsizes::
1297 gitweb.snapshot::
1298         See linkgit:gitweb.conf[5] for description.
1300 grep.lineNumber::
1301         If set to true, enable '-n' option by default.
1303 grep.patternType::
1304         Set the default matching behavior. Using a value of 'basic', 'extended',
1305         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1306         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1307         value 'default' will return to the default matching behavior.
1309 grep.extendedRegexp::
1310         If set to true, enable '--extended-regexp' option by default. This
1311         option is ignored when the 'grep.patternType' option is set to a value
1312         other than 'default'.
1314 gpg.program::
1315         Use this custom program instead of "gpg" found on $PATH when
1316         making or verifying a PGP signature. The program must support the
1317         same command line interface as GPG, namely, to verify a detached
1318         signature, "gpg --verify $file - <$signature" is run, and the
1319         program is expected to signal a good signature by exiting with
1320         code 0, and to generate an ascii-armored detached signature, the
1321         standard input of "gpg -bsau $key" is fed with the contents to be
1322         signed, and the program is expected to send the result to its
1323         standard output.
1325 gui.commitmsgwidth::
1326         Defines how wide the commit message window is in the
1327         linkgit:git-gui[1]. "75" is the default.
1329 gui.diffcontext::
1330         Specifies how many context lines should be used in calls to diff
1331         made by the linkgit:git-gui[1]. The default is "5".
1333 gui.encoding::
1334         Specifies the default encoding to use for displaying of
1335         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1336         It can be overridden by setting the 'encoding' attribute
1337         for relevant files (see linkgit:gitattributes[5]).
1338         If this option is not set, the tools default to the
1339         locale encoding.
1341 gui.matchtrackingbranch::
1342         Determines if new branches created with linkgit:git-gui[1] should
1343         default to tracking remote branches with matching names or
1344         not. Default: "false".
1346 gui.newbranchtemplate::
1347         Is used as suggested name when creating new branches using the
1348         linkgit:git-gui[1].
1350 gui.pruneduringfetch::
1351         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1352         performing a fetch. The default value is "false".
1354 gui.trustmtime::
1355         Determines if linkgit:git-gui[1] should trust the file modification
1356         timestamp or not. By default the timestamps are not trusted.
1358 gui.spellingdictionary::
1359         Specifies the dictionary used for spell checking commit messages in
1360         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1361         off.
1363 gui.fastcopyblame::
1364         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1365         location detection. It makes blame significantly faster on huge
1366         repositories at the expense of less thorough copy detection.
1368 gui.copyblamethreshold::
1369         Specifies the threshold to use in 'git gui blame' original location
1370         detection, measured in alphanumeric characters. See the
1371         linkgit:git-blame[1] manual for more information on copy detection.
1373 gui.blamehistoryctx::
1374         Specifies the radius of history context in days to show in
1375         linkgit:gitk[1] for the selected commit, when the `Show History
1376         Context` menu item is invoked from 'git gui blame'. If this
1377         variable is set to zero, the whole history is shown.
1379 guitool.<name>.cmd::
1380         Specifies the shell command line to execute when the corresponding item
1381         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1382         mandatory for every tool. The command is executed from the root of
1383         the working directory, and in the environment it receives the name of
1384         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1385         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1386         the head is detached, 'CUR_BRANCH' is empty).
1388 guitool.<name>.needsfile::
1389         Run the tool only if a diff is selected in the GUI. It guarantees
1390         that 'FILENAME' is not empty.
1392 guitool.<name>.noconsole::
1393         Run the command silently, without creating a window to display its
1394         output.
1396 guitool.<name>.norescan::
1397         Don't rescan the working directory for changes after the tool
1398         finishes execution.
1400 guitool.<name>.confirm::
1401         Show a confirmation dialog before actually running the tool.
1403 guitool.<name>.argprompt::
1404         Request a string argument from the user, and pass it to the tool
1405         through the 'ARGS' environment variable. Since requesting an
1406         argument implies confirmation, the 'confirm' option has no effect
1407         if this is enabled. If the option is set to 'true', 'yes', or '1',
1408         the dialog uses a built-in generic prompt; otherwise the exact
1409         value of the variable is used.
1411 guitool.<name>.revprompt::
1412         Request a single valid revision from the user, and set the
1413         'REVISION' environment variable. In other aspects this option
1414         is similar to 'argprompt', and can be used together with it.
1416 guitool.<name>.revunmerged::
1417         Show only unmerged branches in the 'revprompt' subdialog.
1418         This is useful for tools similar to merge or rebase, but not
1419         for things like checkout or reset.
1421 guitool.<name>.title::
1422         Specifies the title to use for the prompt dialog. The default
1423         is the tool name.
1425 guitool.<name>.prompt::
1426         Specifies the general prompt string to display at the top of
1427         the dialog, before subsections for 'argprompt' and 'revprompt'.
1428         The default value includes the actual command.
1430 help.browser::
1431         Specify the browser that will be used to display help in the
1432         'web' format. See linkgit:git-help[1].
1434 help.format::
1435         Override the default help format used by linkgit:git-help[1].
1436         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1437         the default. 'web' and 'html' are the same.
1439 help.autocorrect::
1440         Automatically correct and execute mistyped commands after
1441         waiting for the given number of deciseconds (0.1 sec). If more
1442         than one command can be deduced from the entered text, nothing
1443         will be executed.  If the value of this option is negative,
1444         the corrected command will be executed immediately. If the
1445         value is 0 - the command will be just shown but not executed.
1446         This is the default.
1448 help.htmlpath::
1449         Specify the path where the HTML documentation resides. File system paths
1450         and URLs are supported. HTML pages will be prefixed with this path when
1451         help is displayed in the 'web' format. This defaults to the documentation
1452         path of your Git installation.
1454 http.proxy::
1455         Override the HTTP proxy, normally configured using the 'http_proxy',
1456         'https_proxy', and 'all_proxy' environment variables (see
1457         `curl(1)`).  This can be overridden on a per-remote basis; see
1458         remote.<name>.proxy
1460 http.cookiefile::
1461         File containing previously stored cookie lines which should be used
1462         in the Git http session, if they match the server. The file format
1463         of the file to read cookies from should be plain HTTP headers or
1464         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1465         NOTE that the file specified with http.cookiefile is only used as
1466         input unless http.saveCookies is set.
1468 http.savecookies::
1469         If set, store cookies received during requests to the file specified by
1470         http.cookiefile. Has no effect if http.cookiefile is unset.
1472 http.sslVerify::
1473         Whether to verify the SSL certificate when fetching or pushing
1474         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1475         variable.
1477 http.sslCert::
1478         File containing the SSL certificate when fetching or pushing
1479         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1480         variable.
1482 http.sslKey::
1483         File containing the SSL private key when fetching or pushing
1484         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1485         variable.
1487 http.sslCertPasswordProtected::
1488         Enable Git's password prompt for the SSL certificate.  Otherwise
1489         OpenSSL will prompt the user, possibly many times, if the
1490         certificate or private key is encrypted.  Can be overridden by the
1491         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1493 http.sslCAInfo::
1494         File containing the certificates to verify the peer with when
1495         fetching or pushing over HTTPS. Can be overridden by the
1496         'GIT_SSL_CAINFO' environment variable.
1498 http.sslCAPath::
1499         Path containing files with the CA certificates to verify the peer
1500         with when fetching or pushing over HTTPS. Can be overridden
1501         by the 'GIT_SSL_CAPATH' environment variable.
1503 http.sslTry::
1504         Attempt to use AUTH SSL/TLS and encrypted data transfers
1505         when connecting via regular FTP protocol. This might be needed
1506         if the FTP server requires it for security reasons or you wish
1507         to connect securely whenever remote FTP server supports it.
1508         Default is false since it might trigger certificate verification
1509         errors on misconfigured servers.
1511 http.maxRequests::
1512         How many HTTP requests to launch in parallel. Can be overridden
1513         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1515 http.minSessions::
1516         The number of curl sessions (counted across slots) to be kept across
1517         requests. They will not be ended with curl_easy_cleanup() until
1518         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1519         value will be capped at 1. Defaults to 1.
1521 http.postBuffer::
1522         Maximum size in bytes of the buffer used by smart HTTP
1523         transports when POSTing data to the remote system.
1524         For requests larger than this buffer size, HTTP/1.1 and
1525         Transfer-Encoding: chunked is used to avoid creating a
1526         massive pack file locally.  Default is 1 MiB, which is
1527         sufficient for most requests.
1529 http.lowSpeedLimit, http.lowSpeedTime::
1530         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1531         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1532         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1533         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1535 http.noEPSV::
1536         A boolean which disables using of EPSV ftp command by curl.
1537         This can helpful with some "poor" ftp servers which don't
1538         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1539         environment variable. Default is false (curl will use EPSV).
1541 http.useragent::
1542         The HTTP USER_AGENT string presented to an HTTP server.  The default
1543         value represents the version of the client Git such as git/1.7.1.
1544         This option allows you to override this value to a more common value
1545         such as Mozilla/4.0.  This may be necessary, for instance, if
1546         connecting through a firewall that restricts HTTP connections to a set
1547         of common USER_AGENT strings (but not including those like git/1.7.1).
1548         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1550 http.<url>.*::
1551         Any of the http.* options above can be applied selectively to some urls.
1552         For a config key to match a URL, each element of the config key is
1553         compared to that of the URL, in the following order:
1556 . Scheme (e.g., `https` in `https://example.com/`). This field
1557   must match exactly between the config key and the URL.
1559 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1560   This field must match exactly between the config key and the URL.
1562 . Port number (e.g., `8080` in `http://example.com:8080/`).
1563   This field must match exactly between the config key and the URL.
1564   Omitted port numbers are automatically converted to the correct
1565   default for the scheme before matching.
1567 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1568   path field of the config key must match the path field of the URL
1569   either exactly or as a prefix of slash-delimited path elements.  This means
1570   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1571   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1572   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1573   key with just path `foo/`).
1575 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1576   the config key has a user name it must match the user name in the
1577   URL exactly. If the config key does not have a user name, that
1578   config key will match a URL with any user name (including none),
1579   but at a lower precedence than a config key with a user name.
1582 The list above is ordered by decreasing precedence; a URL that matches
1583 a config key's path is preferred to one that matches its user name. For example,
1584 if the URL is `https://user@example.com/foo/bar` a config key match of
1585 `https://example.com/foo` will be preferred over a config key match of
1586 `https://user@example.com`.
1588 All URLs are normalized before attempting any matching (the password part,
1589 if embedded in the URL, is always ignored for matching purposes) so that
1590 equivalent urls that are simply spelled differently will match properly.
1591 Environment variable settings always override any matches.  The urls that are
1592 matched against are those given directly to Git commands.  This means any URLs
1593 visited as a result of a redirection do not participate in matching.
1595 i18n.commitEncoding::
1596         Character encoding the commit messages are stored in; Git itself
1597         does not care per se, but this information is necessary e.g. when
1598         importing commits from emails or in the gitk graphical history
1599         browser (and possibly at other places in the future or in other
1600         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1602 i18n.logOutputEncoding::
1603         Character encoding the commit messages are converted to when
1604         running 'git log' and friends.
1606 imap::
1607         The configuration variables in the 'imap' section are described
1608         in linkgit:git-imap-send[1].
1610 index.version::
1611         Specify the version with which new index files should be
1612         initialized.  This does not affect existing repositories.
1614 init.templatedir::
1615         Specify the directory from which templates will be copied.
1616         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1618 instaweb.browser::
1619         Specify the program that will be used to browse your working
1620         repository in gitweb. See linkgit:git-instaweb[1].
1622 instaweb.httpd::
1623         The HTTP daemon command-line to start gitweb on your working
1624         repository. See linkgit:git-instaweb[1].
1626 instaweb.local::
1627         If true the web server started by linkgit:git-instaweb[1] will
1628         be bound to the local IP (127.0.0.1).
1630 instaweb.modulepath::
1631         The default module path for linkgit:git-instaweb[1] to use
1632         instead of /usr/lib/apache2/modules.  Only used if httpd
1633         is Apache.
1635 instaweb.port::
1636         The port number to bind the gitweb httpd to. See
1637         linkgit:git-instaweb[1].
1639 interactive.singlekey::
1640         In interactive commands, allow the user to provide one-letter
1641         input with a single key (i.e., without hitting enter).
1642         Currently this is used by the `--patch` mode of
1643         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1644         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1645         setting is silently ignored if portable keystroke input
1646         is not available.
1648 log.abbrevCommit::
1649         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1650         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1651         override this option with `--no-abbrev-commit`.
1653 log.date::
1654         Set the default date-time mode for the 'log' command.
1655         Setting a value for log.date is similar to using 'git log''s
1656         `--date` option.  Possible values are `relative`, `local`,
1657         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1658         for details.
1660 log.decorate::
1661         Print out the ref names of any commits that are shown by the log
1662         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1663         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1664         specified, the full ref name (including prefix) will be printed.
1665         This is the same as the log commands '--decorate' option.
1667 log.showroot::
1668         If true, the initial commit will be shown as a big creation event.
1669         This is equivalent to a diff against an empty tree.
1670         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1671         normally hide the root commit will now show it. True by default.
1673 log.mailmap::
1674         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1675         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1677 mailmap.file::
1678         The location of an augmenting mailmap file. The default
1679         mailmap, located in the root of the repository, is loaded
1680         first, then the mailmap file pointed to by this variable.
1681         The location of the mailmap file may be in a repository
1682         subdirectory, or somewhere outside of the repository itself.
1683         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1685 mailmap.blob::
1686         Like `mailmap.file`, but consider the value as a reference to a
1687         blob in the repository. If both `mailmap.file` and
1688         `mailmap.blob` are given, both are parsed, with entries from
1689         `mailmap.file` taking precedence. In a bare repository, this
1690         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1691         defaults to empty.
1693 man.viewer::
1694         Specify the programs that may be used to display help in the
1695         'man' format. See linkgit:git-help[1].
1697 man.<tool>.cmd::
1698         Specify the command to invoke the specified man viewer. The
1699         specified command is evaluated in shell with the man page
1700         passed as argument. (See linkgit:git-help[1].)
1702 man.<tool>.path::
1703         Override the path for the given tool that may be used to
1704         display help in the 'man' format. See linkgit:git-help[1].
1706 include::merge-config.txt[]
1708 mergetool.<tool>.path::
1709         Override the path for the given tool.  This is useful in case
1710         your tool is not in the PATH.
1712 mergetool.<tool>.cmd::
1713         Specify the command to invoke the specified merge tool.  The
1714         specified command is evaluated in shell with the following
1715         variables available: 'BASE' is the name of a temporary file
1716         containing the common base of the files to be merged, if available;
1717         'LOCAL' is the name of a temporary file containing the contents of
1718         the file on the current branch; 'REMOTE' is the name of a temporary
1719         file containing the contents of the file from the branch being
1720         merged; 'MERGED' contains the name of the file to which the merge
1721         tool should write the results of a successful merge.
1723 mergetool.<tool>.trustExitCode::
1724         For a custom merge command, specify whether the exit code of
1725         the merge command can be used to determine whether the merge was
1726         successful.  If this is not set to true then the merge target file
1727         timestamp is checked and the merge assumed to have been successful
1728         if the file has been updated, otherwise the user is prompted to
1729         indicate the success of the merge.
1731 mergetool.keepBackup::
1732         After performing a merge, the original file with conflict markers
1733         can be saved as a file with a `.orig` extension.  If this variable
1734         is set to `false` then this file is not preserved.  Defaults to
1735         `true` (i.e. keep the backup files).
1737 mergetool.keepTemporaries::
1738         When invoking a custom merge tool, Git uses a set of temporary
1739         files to pass to the tool. If the tool returns an error and this
1740         variable is set to `true`, then these temporary files will be
1741         preserved, otherwise they will be removed after the tool has
1742         exited. Defaults to `false`.
1744 mergetool.prompt::
1745         Prompt before each invocation of the merge resolution program.
1747 notes.displayRef::
1748         The (fully qualified) refname from which to show notes when
1749         showing commit messages.  The value of this variable can be set
1750         to a glob, in which case notes from all matching refs will be
1751         shown.  You may also specify this configuration variable
1752         several times.  A warning will be issued for refs that do not
1753         exist, but a glob that does not match any refs is silently
1754         ignored.
1756 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1757 environment variable, which must be a colon separated list of refs or
1758 globs.
1760 The effective value of "core.notesRef" (possibly overridden by
1761 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1762 displayed.
1764 notes.rewrite.<command>::
1765         When rewriting commits with <command> (currently `amend` or
1766         `rebase`) and this variable is set to `true`, Git
1767         automatically copies your notes from the original to the
1768         rewritten commit.  Defaults to `true`, but see
1769         "notes.rewriteRef" below.
1771 notes.rewriteMode::
1772         When copying notes during a rewrite (see the
1773         "notes.rewrite.<command>" option), determines what to do if
1774         the target commit already has a note.  Must be one of
1775         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1776         `concatenate`.
1778 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1779 environment variable.
1781 notes.rewriteRef::
1782         When copying notes during a rewrite, specifies the (fully
1783         qualified) ref whose notes should be copied.  The ref may be a
1784         glob, in which case notes in all matching refs will be copied.
1785         You may also specify this configuration several times.
1787 Does not have a default value; you must configure this variable to
1788 enable note rewriting.  Set it to `refs/notes/commits` to enable
1789 rewriting for the default commit notes.
1791 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1792 environment variable, which must be a colon separated list of refs or
1793 globs.
1795 pack.window::
1796         The size of the window used by linkgit:git-pack-objects[1] when no
1797         window size is given on the command line. Defaults to 10.
1799 pack.depth::
1800         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1801         maximum depth is given on the command line. Defaults to 50.
1803 pack.windowMemory::
1804         The window memory size limit used by linkgit:git-pack-objects[1]
1805         when no limit is given on the command line.  The value can be
1806         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1807         limit.
1809 pack.compression::
1810         An integer -1..9, indicating the compression level for objects
1811         in a pack file. -1 is the zlib default. 0 means no
1812         compression, and 1..9 are various speed/size tradeoffs, 9 being
1813         slowest.  If not set,  defaults to core.compression.  If that is
1814         not set,  defaults to -1, the zlib default, which is "a default
1815         compromise between speed and compression (currently equivalent
1816         to level 6)."
1818 Note that changing the compression level will not automatically recompress
1819 all existing objects. You can force recompression by passing the -F option
1820 to linkgit:git-repack[1].
1822 pack.deltaCacheSize::
1823         The maximum memory in bytes used for caching deltas in
1824         linkgit:git-pack-objects[1] before writing them out to a pack.
1825         This cache is used to speed up the writing object phase by not
1826         having to recompute the final delta result once the best match
1827         for all objects is found.  Repacking large repositories on machines
1828         which are tight with memory might be badly impacted by this though,
1829         especially if this cache pushes the system into swapping.
1830         A value of 0 means no limit. The smallest size of 1 byte may be
1831         used to virtually disable this cache. Defaults to 256 MiB.
1833 pack.deltaCacheLimit::
1834         The maximum size of a delta, that is cached in
1835         linkgit:git-pack-objects[1]. This cache is used to speed up the
1836         writing object phase by not having to recompute the final delta
1837         result once the best match for all objects is found. Defaults to 1000.
1839 pack.threads::
1840         Specifies the number of threads to spawn when searching for best
1841         delta matches.  This requires that linkgit:git-pack-objects[1]
1842         be compiled with pthreads otherwise this option is ignored with a
1843         warning. This is meant to reduce packing time on multiprocessor
1844         machines. The required amount of memory for the delta search window
1845         is however multiplied by the number of threads.
1846         Specifying 0 will cause Git to auto-detect the number of CPU's
1847         and set the number of threads accordingly.
1849 pack.indexVersion::
1850         Specify the default pack index version.  Valid values are 1 for
1851         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1852         the new pack index with capabilities for packs larger than 4 GB
1853         as well as proper protection against the repacking of corrupted
1854         packs.  Version 2 is the default.  Note that version 2 is enforced
1855         and this config option ignored whenever the corresponding pack is
1856         larger than 2 GB.
1858 If you have an old Git that does not understand the version 2 `*.idx` file,
1859 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1860 that will copy both `*.pack` file and corresponding `*.idx` file from the
1861 other side may give you a repository that cannot be accessed with your
1862 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1863 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1864 the `*.idx` file.
1866 pack.packSizeLimit::
1867         The maximum size of a pack.  This setting only affects
1868         packing to a file when repacking, i.e. the git:// protocol
1869         is unaffected.  It can be overridden by the `--max-pack-size`
1870         option of linkgit:git-repack[1]. The minimum size allowed is
1871         limited to 1 MiB. The default is unlimited.
1872         Common unit suffixes of 'k', 'm', or 'g' are
1873         supported.
1875 pack.useBitmaps::
1876         When true, git will use pack bitmaps (if available) when packing
1877         to stdout (e.g., during the server side of a fetch). Defaults to
1878         true. You should not generally need to turn this off unless
1879         you are debugging pack bitmaps.
1881 pack.writebitmaps::
1882         When true, git will write a bitmap index when packing all
1883         objects to disk (e.g., when `git repack -a` is run).  This
1884         index can speed up the "counting objects" phase of subsequent
1885         packs created for clones and fetches, at the cost of some disk
1886         space and extra time spent on the initial repack.  Defaults to
1887         false.
1889 pack.writeBitmapHashCache::
1890         When true, git will include a "hash cache" section in the bitmap
1891         index (if one is written). This cache can be used to feed git's
1892         delta heuristics, potentially leading to better deltas between
1893         bitmapped and non-bitmapped objects (e.g., when serving a fetch
1894         between an older, bitmapped pack and objects that have been
1895         pushed since the last gc). The downside is that it consumes 4
1896         bytes per object of disk space, and that JGit's bitmap
1897         implementation does not understand it, causing it to complain if
1898         Git and JGit are used on the same repository. Defaults to false.
1900 pager.<cmd>::
1901         If the value is boolean, turns on or off pagination of the
1902         output of a particular Git subcommand when writing to a tty.
1903         Otherwise, turns on pagination for the subcommand using the
1904         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1905         or `--no-pager` is specified on the command line, it takes
1906         precedence over this option.  To disable pagination for all
1907         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1909 pretty.<name>::
1910         Alias for a --pretty= format string, as specified in
1911         linkgit:git-log[1]. Any aliases defined here can be used just
1912         as the built-in pretty formats could. For example,
1913         running `git config pretty.changelog "format:* %H %s"`
1914         would cause the invocation `git log --pretty=changelog`
1915         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1916         Note that an alias with the same name as a built-in format
1917         will be silently ignored.
1919 pull.ff::
1920         By default, Git does not create an extra merge commit when merging
1921         a commit that is a descendant of the current commit. Instead, the
1922         tip of the current branch is fast-forwarded. When set to `false`,
1923         this variable tells Git to create an extra merge commit in such
1924         a case (equivalent to giving the `--no-ff` option from the command
1925         line). When set to `only`, only such fast-forward merges are
1926         allowed (equivalent to giving the `--ff-only` option from the
1927         command line).
1929 pull.rebase::
1930         When true, rebase branches on top of the fetched branch, instead
1931         of merging the default branch from the default remote when "git
1932         pull" is run. See "branch.<name>.rebase" for setting this on a
1933         per-branch basis.
1935         When preserve, also pass `--preserve-merges` along to 'git rebase'
1936         so that locally committed merge commits will not be flattened
1937         by running 'git pull'.
1939 *NOTE*: this is a possibly dangerous operation; do *not* use
1940 it unless you understand the implications (see linkgit:git-rebase[1]
1941 for details).
1943 pull.octopus::
1944         The default merge strategy to use when pulling multiple branches
1945         at once.
1947 pull.twohead::
1948         The default merge strategy to use when pulling a single branch.
1950 push.default::
1951         Defines the action `git push` should take if no refspec is
1952         explicitly given.  Different values are well-suited for
1953         specific workflows; for instance, in a purely central workflow
1954         (i.e. the fetch source is equal to the push destination),
1955         `upstream` is probably what you want.  Possible values are:
1959 * `nothing` - do not push anything (error out) unless a refspec is
1960   explicitly given. This is primarily meant for people who want to
1961   avoid mistakes by always being explicit.
1963 * `current` - push the current branch to update a branch with the same
1964   name on the receiving end.  Works in both central and non-central
1965   workflows.
1967 * `upstream` - push the current branch back to the branch whose
1968   changes are usually integrated into the current branch (which is
1969   called `@{upstream}`).  This mode only makes sense if you are
1970   pushing to the same repository you would normally pull from
1971   (i.e. central workflow).
1973 * `simple` - in centralized workflow, work like `upstream` with an
1974   added safety to refuse to push if the upstream branch's name is
1975   different from the local one.
1977 When pushing to a remote that is different from the remote you normally
1978 pull from, work as `current`.  This is the safest option and is suited
1979 for beginners.
1981 This mode has become the default in Git 2.0.
1983 * `matching` - push all branches having the same name on both ends.
1984   This makes the repository you are pushing to remember the set of
1985   branches that will be pushed out (e.g. if you always push 'maint'
1986   and 'master' there and no other branches, the repository you push
1987   to will have these two branches, and your local 'maint' and
1988   'master' will be pushed there).
1990 To use this mode effectively, you have to make sure _all_ the
1991 branches you would push out are ready to be pushed out before
1992 running 'git push', as the whole point of this mode is to allow you
1993 to push all of the branches in one go.  If you usually finish work
1994 on only one branch and push out the result, while other branches are
1995 unfinished, this mode is not for you.  Also this mode is not
1996 suitable for pushing into a shared central repository, as other
1997 people may add new branches there, or update the tip of existing
1998 branches outside your control.
2000 This used to be the default, but not since Git 2.0 (`simple` is the
2001 new default).
2005 rebase.stat::
2006         Whether to show a diffstat of what changed upstream since the last
2007         rebase. False by default.
2009 rebase.autosquash::
2010         If set to true enable '--autosquash' option by default.
2012 rebase.autostash::
2013         When set to true, automatically create a temporary stash
2014         before the operation begins, and apply it after the operation
2015         ends.  This means that you can run rebase on a dirty worktree.
2016         However, use with care: the final stash application after a
2017         successful rebase might result in non-trivial conflicts.
2018         Defaults to false.
2020 receive.autogc::
2021         By default, git-receive-pack will run "git-gc --auto" after
2022         receiving data from git-push and updating refs.  You can stop
2023         it by setting this variable to false.
2025 receive.fsckObjects::
2026         If it is set to true, git-receive-pack will check all received
2027         objects. It will abort in the case of a malformed object or a
2028         broken link. The result of an abort are only dangling objects.
2029         Defaults to false. If not set, the value of `transfer.fsckObjects`
2030         is used instead.
2032 receive.unpackLimit::
2033         If the number of objects received in a push is below this
2034         limit then the objects will be unpacked into loose object
2035         files. However if the number of received objects equals or
2036         exceeds this limit then the received pack will be stored as
2037         a pack, after adding any missing delta bases.  Storing the
2038         pack from a push can make the push operation complete faster,
2039         especially on slow filesystems.  If not set, the value of
2040         `transfer.unpackLimit` is used instead.
2042 receive.denyDeletes::
2043         If set to true, git-receive-pack will deny a ref update that deletes
2044         the ref. Use this to prevent such a ref deletion via a push.
2046 receive.denyDeleteCurrent::
2047         If set to true, git-receive-pack will deny a ref update that
2048         deletes the currently checked out branch of a non-bare repository.
2050 receive.denyCurrentBranch::
2051         If set to true or "refuse", git-receive-pack will deny a ref update
2052         to the currently checked out branch of a non-bare repository.
2053         Such a push is potentially dangerous because it brings the HEAD
2054         out of sync with the index and working tree. If set to "warn",
2055         print a warning of such a push to stderr, but allow the push to
2056         proceed. If set to false or "ignore", allow such pushes with no
2057         message. Defaults to "refuse".
2059 receive.denyNonFastForwards::
2060         If set to true, git-receive-pack will deny a ref update which is
2061         not a fast-forward. Use this to prevent such an update via a push,
2062         even if that push is forced. This configuration variable is
2063         set when initializing a shared repository.
2065 receive.hiderefs::
2066         String(s) `receive-pack` uses to decide which refs to omit
2067         from its initial advertisement.  Use more than one
2068         definitions to specify multiple prefix strings. A ref that
2069         are under the hierarchies listed on the value of this
2070         variable is excluded, and is hidden when responding to `git
2071         push`, and an attempt to update or delete a hidden ref by
2072         `git push` is rejected.
2074 receive.updateserverinfo::
2075         If set to true, git-receive-pack will run git-update-server-info
2076         after receiving data from git-push and updating refs.
2078 receive.shallowupdate::
2079         If set to true, .git/shallow can be updated when new refs
2080         require new shallow roots. Otherwise those refs are rejected.
2082 remote.pushdefault::
2083         The remote to push to by default.  Overrides
2084         `branch.<name>.remote` for all branches, and is overridden by
2085         `branch.<name>.pushremote` for specific branches.
2087 remote.<name>.url::
2088         The URL of a remote repository.  See linkgit:git-fetch[1] or
2089         linkgit:git-push[1].
2091 remote.<name>.pushurl::
2092         The push URL of a remote repository.  See linkgit:git-push[1].
2094 remote.<name>.proxy::
2095         For remotes that require curl (http, https and ftp), the URL to
2096         the proxy to use for that remote.  Set to the empty string to
2097         disable proxying for that remote.
2099 remote.<name>.fetch::
2100         The default set of "refspec" for linkgit:git-fetch[1]. See
2101         linkgit:git-fetch[1].
2103 remote.<name>.push::
2104         The default set of "refspec" for linkgit:git-push[1]. See
2105         linkgit:git-push[1].
2107 remote.<name>.mirror::
2108         If true, pushing to this remote will automatically behave
2109         as if the `--mirror` option was given on the command line.
2111 remote.<name>.skipDefaultUpdate::
2112         If true, this remote will be skipped by default when updating
2113         using linkgit:git-fetch[1] or the `update` subcommand of
2114         linkgit:git-remote[1].
2116 remote.<name>.skipFetchAll::
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>.receivepack::
2122         The default program to execute on the remote side when pushing.  See
2123         option \--receive-pack of linkgit:git-push[1].
2125 remote.<name>.uploadpack::
2126         The default program to execute on the remote side when fetching.  See
2127         option \--upload-pack of linkgit:git-fetch-pack[1].
2129 remote.<name>.tagopt::
2130         Setting this value to \--no-tags disables automatic tag following when
2131         fetching from remote <name>. Setting it to \--tags will fetch every
2132         tag from remote <name>, even if they are not reachable from remote
2133         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2134         override this setting. See options \--tags and \--no-tags of
2135         linkgit:git-fetch[1].
2137 remote.<name>.vcs::
2138         Setting this to a value <vcs> will cause Git to interact with
2139         the remote with the git-remote-<vcs> helper.
2141 remote.<name>.prune::
2142         When set to true, fetching from this remote by default will also
2143         remove any remote-tracking references that no longer exist on the
2144         remote (as if the `--prune` option was given on the command line).
2145         Overrides `fetch.prune` settings, if any.
2147 remotes.<group>::
2148         The list of remotes which are fetched by "git remote update
2149         <group>".  See linkgit:git-remote[1].
2151 repack.usedeltabaseoffset::
2152         By default, linkgit:git-repack[1] creates packs that use
2153         delta-base offset. If you need to share your repository with
2154         Git older than version 1.4.4, either directly or via a dumb
2155         protocol such as http, then you need to set this option to
2156         "false" and repack. Access from old Git versions over the
2157         native protocol are unaffected by this option.
2159 rerere.autoupdate::
2160         When set to true, `git-rerere` updates the index with the
2161         resulting contents after it cleanly resolves conflicts using
2162         previously recorded resolution.  Defaults to false.
2164 rerere.enabled::
2165         Activate recording of resolved conflicts, so that identical
2166         conflict hunks can be resolved automatically, should they be
2167         encountered again.  By default, linkgit:git-rerere[1] is
2168         enabled if there is an `rr-cache` directory under the
2169         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2170         repository.
2172 sendemail.identity::
2173         A configuration identity. When given, causes values in the
2174         'sendemail.<identity>' subsection to take precedence over
2175         values in the 'sendemail' section. The default identity is
2176         the value of 'sendemail.identity'.
2178 sendemail.smtpencryption::
2179         See linkgit:git-send-email[1] for description.  Note that this
2180         setting is not subject to the 'identity' mechanism.
2182 sendemail.smtpssl::
2183         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2185 sendemail.smtpsslcertpath::
2186         Path to ca-certificates (either a directory or a single file).
2187         Set it to an empty string to disable certificate verification.
2189 sendemail.<identity>.*::
2190         Identity-specific versions of the 'sendemail.*' parameters
2191         found below, taking precedence over those when the this
2192         identity is selected, through command-line or
2193         'sendemail.identity'.
2195 sendemail.aliasesfile::
2196 sendemail.aliasfiletype::
2197 sendemail.annotate::
2198 sendemail.bcc::
2199 sendemail.cc::
2200 sendemail.cccmd::
2201 sendemail.chainreplyto::
2202 sendemail.confirm::
2203 sendemail.envelopesender::
2204 sendemail.from::
2205 sendemail.multiedit::
2206 sendemail.signedoffbycc::
2207 sendemail.smtppass::
2208 sendemail.suppresscc::
2209 sendemail.suppressfrom::
2210 sendemail.to::
2211 sendemail.smtpdomain::
2212 sendemail.smtpserver::
2213 sendemail.smtpserverport::
2214 sendemail.smtpserveroption::
2215 sendemail.smtpuser::
2216 sendemail.thread::
2217 sendemail.validate::
2218         See linkgit:git-send-email[1] for description.
2220 sendemail.signedoffcc::
2221         Deprecated alias for 'sendemail.signedoffbycc'.
2223 showbranch.default::
2224         The default set of branches for linkgit:git-show-branch[1].
2225         See linkgit:git-show-branch[1].
2227 status.relativePaths::
2228         By default, linkgit:git-status[1] shows paths relative to the
2229         current directory. Setting this variable to `false` shows paths
2230         relative to the repository root (this was the default for Git
2231         prior to v1.5.4).
2233 status.short::
2234         Set to true to enable --short by default in linkgit:git-status[1].
2235         The option --no-short takes precedence over this variable.
2237 status.branch::
2238         Set to true to enable --branch by default in linkgit:git-status[1].
2239         The option --no-branch takes precedence over this variable.
2241 status.displayCommentPrefix::
2242         If set to true, linkgit:git-status[1] will insert a comment
2243         prefix before each output line (starting with
2244         `core.commentChar`, i.e. `#` by default). This was the
2245         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2246         Defaults to false.
2248 status.showUntrackedFiles::
2249         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2250         files which are not currently tracked by Git. Directories which
2251         contain only untracked files, are shown with the directory name
2252         only. Showing untracked files means that Git needs to lstat() all
2253         all the files in the whole repository, which might be slow on some
2254         systems. So, this variable controls how the commands displays
2255         the untracked files. Possible values are:
2258 * `no` - Show no untracked files.
2259 * `normal` - Show untracked files and directories.
2260 * `all` - Show also individual files in untracked directories.
2263 If this variable is not specified, it defaults to 'normal'.
2264 This variable can be overridden with the -u|--untracked-files option
2265 of linkgit:git-status[1] and linkgit:git-commit[1].
2267 status.submodulesummary::
2268         Defaults to false.
2269         If this is set to a non zero number or true (identical to -1 or an
2270         unlimited number), the submodule summary will be enabled and a
2271         summary of commits for modified submodules will be shown (see
2272         --summary-limit option of linkgit:git-submodule[1]). Please note
2273         that the summary output command will be suppressed for all
2274         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2275         for those submodules where `submodule.<name>.ignore=all`. To
2276         also view the summary for ignored submodules you can either use
2277         the --ignore-submodules=dirty command line option or the 'git
2278         submodule summary' command, which shows a similar output but does
2279         not honor these settings.
2281 submodule.<name>.path::
2282 submodule.<name>.url::
2283 submodule.<name>.update::
2284         The path within this project, URL, and the updating strategy
2285         for a submodule.  These variables are initially populated
2286         by 'git submodule init'; edit them to override the
2287         URL and other values found in the `.gitmodules` file.  See
2288         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2290 submodule.<name>.branch::
2291         The remote branch name for a submodule, used by `git submodule
2292         update --remote`.  Set this option to override the value found in
2293         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2294         linkgit:gitmodules[5] for details.
2296 submodule.<name>.fetchRecurseSubmodules::
2297         This option can be used to control recursive fetching of this
2298         submodule. It can be overridden by using the --[no-]recurse-submodules
2299         command line option to "git fetch" and "git pull".
2300         This setting will override that from in the linkgit:gitmodules[5]
2301         file.
2303 submodule.<name>.ignore::
2304         Defines under what circumstances "git status" and the diff family show
2305         a submodule as modified. When set to "all", it will never be considered
2306         modified, "dirty" will ignore all changes to the submodules work tree and
2307         takes only differences between the HEAD of the submodule and the commit
2308         recorded in the superproject into account. "untracked" will additionally
2309         let submodules with modified tracked files in their work tree show up.
2310         Using "none" (the default when this option is not set) also shows
2311         submodules that have untracked files in their work tree as changed.
2312         This setting overrides any setting made in .gitmodules for this submodule,
2313         both settings can be overridden on the command line by using the
2314         "--ignore-submodules" option. The 'git submodule' commands are not
2315         affected by this setting.
2317 tar.umask::
2318         This variable can be used to restrict the permission bits of
2319         tar archive entries.  The default is 0002, which turns off the
2320         world write bit.  The special value "user" indicates that the
2321         archiving user's umask will be used instead.  See umask(2) and
2322         linkgit:git-archive[1].
2324 transfer.fsckObjects::
2325         When `fetch.fsckObjects` or `receive.fsckObjects` are
2326         not set, the value of this variable is used instead.
2327         Defaults to false.
2329 transfer.hiderefs::
2330         This variable can be used to set both `receive.hiderefs`
2331         and `uploadpack.hiderefs` at the same time to the same
2332         values.  See entries for these other variables.
2334 transfer.unpackLimit::
2335         When `fetch.unpackLimit` or `receive.unpackLimit` are
2336         not set, the value of this variable is used instead.
2337         The default value is 100.
2339 uploadarchive.allowUnreachable::
2340         If true, allow clients to use `git archive --remote` to request
2341         any tree, whether reachable from the ref tips or not. See the
2342         discussion in the `SECURITY` section of
2343         linkgit:git-upload-archive[1] for more details. Defaults to
2344         `false`.
2346 uploadpack.hiderefs::
2347         String(s) `upload-pack` uses to decide which refs to omit
2348         from its initial advertisement.  Use more than one
2349         definitions to specify multiple prefix strings. A ref that
2350         are under the hierarchies listed on the value of this
2351         variable is excluded, and is hidden from `git ls-remote`,
2352         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2353         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2355 uploadpack.allowtipsha1inwant::
2356         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2357         to accept a fetch request that asks for an object at the tip
2358         of a hidden ref (by default, such a request is rejected).
2359         see also `uploadpack.hiderefs`.
2361 uploadpack.keepalive::
2362         When `upload-pack` has started `pack-objects`, there may be a
2363         quiet period while `pack-objects` prepares the pack. Normally
2364         it would output progress information, but if `--quiet` was used
2365         for the fetch, `pack-objects` will output nothing at all until
2366         the pack data begins. Some clients and networks may consider
2367         the server to be hung and give up. Setting this option instructs
2368         `upload-pack` to send an empty keepalive packet every
2369         `uploadpack.keepalive` seconds. Setting this option to 0
2370         disables keepalive packets entirely. The default is 5 seconds.
2372 url.<base>.insteadOf::
2373         Any URL that starts with this value will be rewritten to
2374         start, instead, with <base>. In cases where some site serves a
2375         large number of repositories, and serves them with multiple
2376         access methods, and some users need to use different access
2377         methods, this feature allows people to specify any of the
2378         equivalent URLs and have Git automatically rewrite the URL to
2379         the best alternative for the particular user, even for a
2380         never-before-seen repository on the site.  When more than one
2381         insteadOf strings match a given URL, the longest match is used.
2383 url.<base>.pushInsteadOf::
2384         Any URL that starts with this value will not be pushed to;
2385         instead, it will be rewritten to start with <base>, and the
2386         resulting URL will be pushed to. In cases where some site serves
2387         a large number of repositories, and serves them with multiple
2388         access methods, some of which do not allow push, this feature
2389         allows people to specify a pull-only URL and have Git
2390         automatically use an appropriate URL to push, even for a
2391         never-before-seen repository on the site.  When more than one
2392         pushInsteadOf strings match a given URL, the longest match is
2393         used.  If a remote has an explicit pushurl, Git will ignore this
2394         setting for that remote.
2396 user.email::
2397         Your email address to be recorded in any newly created commits.
2398         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2399         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2401 user.name::
2402         Your full name to be recorded in any newly created commits.
2403         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2404         environment variables.  See linkgit:git-commit-tree[1].
2406 user.signingkey::
2407         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2408         key you want it to automatically when creating a signed tag or
2409         commit, you can override the default selection with this variable.
2410         This option is passed unchanged to gpg's --local-user parameter,
2411         so you may specify a key using any method that gpg supports.
2413 web.browser::
2414         Specify a web browser that may be used by some commands.
2415         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2416         may use it.