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