t1306: check that XDG_CONFIG_HOME works
[git/mingw.git] / Documentation / config.txt
blobdb07459bbb3380fb0af1b403227a95ec67f4d6f6
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         pushNonFastForward::
144                 Set this variable to 'false' if you want to disable
145                 'pushNonFFCurrent', 'pushNonFFDefault', and
146                 'pushNonFFMatching' simultaneously.
147         pushNonFFCurrent::
148                 Advice shown when linkgit:git-push[1] fails due to a
149                 non-fast-forward update to the current branch.
150         pushNonFFDefault::
151                 Advice to set 'push.default' to 'upstream' or 'current'
152                 when you ran linkgit:git-push[1] and pushed 'matching
153                 refs' by default (i.e. you did not provide an explicit
154                 refspec, and no 'push.default' configuration was set)
155                 and it resulted in a non-fast-forward error.
156         pushNonFFMatching::
157                 Advice shown when you ran linkgit:git-push[1] and pushed
158                 'matching refs' explicitly (i.e. you used ':', or
159                 specified a refspec that isn't your current branch) and
160                 it resulted in a non-fast-forward error.
161         statusHints::
162                 Directions on how to stage/unstage/add shown in the
163                 output of linkgit:git-status[1] and the template shown
164                 when writing commit messages.
165         commitBeforeMerge::
166                 Advice shown when linkgit:git-merge[1] refuses to
167                 merge to avoid overwriting local changes.
168         resolveConflict::
169                 Advices shown by various commands when conflicts
170                 prevent the operation from being performed.
171         implicitIdentity::
172                 Advice on how to set your identity configuration when
173                 your information is guessed from the system username and
174                 domain name.
175         detachedHead::
176                 Advice shown when you used linkgit:git-checkout[1] to
177                 move to the detach HEAD state, to instruct how to create
178                 a local branch after the fact.
181 core.fileMode::
182         If false, the executable bit differences between the index and
183         the working tree are ignored; useful on broken filesystems like FAT.
184         See linkgit:git-update-index[1].
186 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
187 will probe and set core.fileMode false if appropriate when the
188 repository is created.
190 core.ignoreCygwinFSTricks::
191         This option is only used by Cygwin implementation of Git. If false,
192         the Cygwin stat() and lstat() functions are used. This may be useful
193         if your repository consists of a few separate directories joined in
194         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
195         whenever it is possible and falls back to Cygwin functions only to
196         handle symbol links. The native mode is more than twice faster than
197         normal Cygwin l/stat() functions. True by default, unless core.filemode
198         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
199         POSIX emulation is required to support core.filemode.
201 core.ignorecase::
202         If true, this option enables various workarounds to enable
203         git to work better on filesystems that are not case sensitive,
204         like FAT. For example, if a directory listing finds
205         "makefile" when git expects "Makefile", git will assume
206         it is really the same file, and continue to remember it as
207         "Makefile".
209 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
210 will probe and set core.ignorecase true if appropriate when the repository
211 is created.
213 core.trustctime::
214         If false, the ctime differences between the index and the
215         working tree are ignored; useful when the inode change time
216         is regularly modified by something outside Git (file system
217         crawlers and some backup systems).
218         See linkgit:git-update-index[1]. True by default.
220 core.quotepath::
221         The commands that output paths (e.g. 'ls-files',
222         'diff'), when not given the `-z` option, will quote
223         "unusual" characters in the pathname by enclosing the
224         pathname in a double-quote pair and with backslashes the
225         same way strings in C source code are quoted.  If this
226         variable is set to false, the bytes higher than 0x80 are
227         not quoted but output as verbatim.  Note that double
228         quote, backslash and control characters are always
229         quoted without `-z` regardless of the setting of this
230         variable.
232 core.eol::
233         Sets the line ending type to use in the working directory for
234         files that have the `text` property set.  Alternatives are
235         'lf', 'crlf' and 'native', which uses the platform's native
236         line ending.  The default value is `native`.  See
237         linkgit:gitattributes[5] for more information on end-of-line
238         conversion.
240 core.safecrlf::
241         If true, makes git check if converting `CRLF` is reversible when
242         end-of-line conversion is active.  Git will verify if a command
243         modifies a file in the work tree either directly or indirectly.
244         For example, committing a file followed by checking out the
245         same file should yield the original file in the work tree.  If
246         this is not the case for the current setting of
247         `core.autocrlf`, git will reject the file.  The variable can
248         be set to "warn", in which case git will only warn about an
249         irreversible conversion but continue the operation.
251 CRLF conversion bears a slight chance of corrupting data.
252 When it is enabled, git will convert CRLF to LF during commit and LF to
253 CRLF during checkout.  A file that contains a mixture of LF and
254 CRLF before the commit cannot be recreated by git.  For text
255 files this is the right thing to do: it corrects line endings
256 such that we have only LF line endings in the repository.
257 But for binary files that are accidentally classified as text the
258 conversion can corrupt data.
260 If you recognize such corruption early you can easily fix it by
261 setting the conversion type explicitly in .gitattributes.  Right
262 after committing you still have the original file in your work
263 tree and this file is not yet corrupted.  You can explicitly tell
264 git that this file is binary and git will handle the file
265 appropriately.
267 Unfortunately, the desired effect of cleaning up text files with
268 mixed line endings and the undesired effect of corrupting binary
269 files cannot be distinguished.  In both cases CRLFs are removed
270 in an irreversible way.  For text files this is the right thing
271 to do because CRLFs are line endings, while for binary files
272 converting CRLFs corrupts data.
274 Note, this safety check does not mean that a checkout will generate a
275 file identical to the original file for a different setting of
276 `core.eol` and `core.autocrlf`, but only for the current one.  For
277 example, a text file with `LF` would be accepted with `core.eol=lf`
278 and could later be checked out with `core.eol=crlf`, in which case the
279 resulting file would contain `CRLF`, although the original file
280 contained `LF`.  However, in both work trees the line endings would be
281 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
282 file with mixed line endings would be reported by the `core.safecrlf`
283 mechanism.
285 core.autocrlf::
286         Setting this variable to "true" is almost the same as setting
287         the `text` attribute to "auto" on all files except that text
288         files are not guaranteed to be normalized: files that contain
289         `CRLF` in the repository will not be touched.  Use this
290         setting if you want to have `CRLF` line endings in your
291         working directory even though the repository does not have
292         normalized line endings.  This variable can be set to 'input',
293         in which case no output conversion is performed.
295 core.symlinks::
296         If false, symbolic links are checked out as small plain files that
297         contain the link text. linkgit:git-update-index[1] and
298         linkgit:git-add[1] will not change the recorded type to regular
299         file. Useful on filesystems like FAT that do not support
300         symbolic links.
302 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
303 will probe and set core.symlinks false if appropriate when the repository
304 is created.
306 core.gitProxy::
307         A "proxy command" to execute (as 'command host port') instead
308         of establishing direct connection to the remote server when
309         using the git protocol for fetching. If the variable value is
310         in the "COMMAND for DOMAIN" format, the command is applied only
311         on hostnames ending with the specified domain string. This variable
312         may be set multiple times and is matched in the given order;
313         the first match wins.
315 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
316 (which always applies universally, without the special "for"
317 handling).
319 The special string `none` can be used as the proxy command to
320 specify that no proxy be used for a given domain pattern.
321 This is useful for excluding servers inside a firewall from
322 proxy use, while defaulting to a common proxy for external domains.
324 core.ignoreStat::
325         If true, commands which modify both the working tree and the index
326         will mark the updated paths with the "assume unchanged" bit in the
327         index. These marked files are then assumed to stay unchanged in the
328         working tree, until you mark them otherwise manually - Git will not
329         detect the file changes by lstat() calls. This is useful on systems
330         where those are very slow, such as Microsoft Windows.
331         See linkgit:git-update-index[1].
332         False by default.
334 core.preferSymlinkRefs::
335         Instead of the default "symref" format for HEAD
336         and other symbolic reference files, use symbolic links.
337         This is sometimes needed to work with old scripts that
338         expect HEAD to be a symbolic link.
340 core.bare::
341         If true this repository is assumed to be 'bare' and has no
342         working directory associated with it.  If this is the case a
343         number of commands that require a working directory will be
344         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
346 This setting is automatically guessed by linkgit:git-clone[1] or
347 linkgit:git-init[1] when the repository was created.  By default a
348 repository that ends in "/.git" is assumed to be not bare (bare =
349 false), while all other repositories are assumed to be bare (bare
350 = true).
352 core.worktree::
353         Set the path to the root of the working tree.
354         This can be overridden by the GIT_WORK_TREE environment
355         variable and the '--work-tree' command line option.
356         The value can be an absolute path or relative to the path to
357         the .git directory, which is either specified by --git-dir
358         or GIT_DIR, or automatically discovered.
359         If --git-dir or GIT_DIR is specified but none of
360         --work-tree, GIT_WORK_TREE and core.worktree is specified,
361         the current working directory is regarded as the top level
362         of your working tree.
364 Note that this variable is honored even when set in a configuration
365 file in a ".git" subdirectory of a directory and its value differs
366 from the latter directory (e.g. "/path/to/.git/config" has
367 core.worktree set to "/different/path"), which is most likely a
368 misconfiguration.  Running git commands in the "/path/to" directory will
369 still use "/different/path" as the root of the work tree and can cause
370 confusion unless you know what you are doing (e.g. you are creating a
371 read-only snapshot of the same index to a location different from the
372 repository's usual working tree).
374 core.logAllRefUpdates::
375         Enable the reflog. Updates to a ref <ref> is logged to the file
376         "$GIT_DIR/logs/<ref>", by appending the new and old
377         SHA1, the date/time and the reason of the update, but
378         only when the file exists.  If this configuration
379         variable is set to true, missing "$GIT_DIR/logs/<ref>"
380         file is automatically created for branch heads (i.e. under
381         refs/heads/), remote refs (i.e. under refs/remotes/),
382         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
384 This information can be used to determine what commit
385 was the tip of a branch "2 days ago".
387 This value is true by default in a repository that has
388 a working directory associated with it, and false by
389 default in a bare repository.
391 core.repositoryFormatVersion::
392         Internal variable identifying the repository format and layout
393         version.
395 core.sharedRepository::
396         When 'group' (or 'true'), the repository is made shareable between
397         several users in a group (making sure all the files and objects are
398         group-writable). When 'all' (or 'world' or 'everybody'), the
399         repository will be readable by all users, additionally to being
400         group-shareable. When 'umask' (or 'false'), git will use permissions
401         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
402         files in the repository will have this mode value. '0xxx' will override
403         user's umask value (whereas the other options will only override
404         requested parts of the user's umask value). Examples: '0660' will make
405         the repo read/write-able for the owner and group, but inaccessible to
406         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
407         repository that is group-readable but not group-writable.
408         See linkgit:git-init[1]. False by default.
410 core.warnAmbiguousRefs::
411         If true, git will warn you if the ref name you passed it is ambiguous
412         and might match multiple refs in the .git/refs/ tree. True by default.
414 core.compression::
415         An integer -1..9, indicating a default compression level.
416         -1 is the zlib default. 0 means no compression,
417         and 1..9 are various speed/size tradeoffs, 9 being slowest.
418         If set, this provides a default to other compression variables,
419         such as 'core.loosecompression' and 'pack.compression'.
421 core.loosecompression::
422         An integer -1..9, indicating the compression level for objects that
423         are not in a pack file. -1 is the zlib default. 0 means no
424         compression, and 1..9 are various speed/size tradeoffs, 9 being
425         slowest.  If not set,  defaults to core.compression.  If that is
426         not set,  defaults to 1 (best speed).
428 core.packedGitWindowSize::
429         Number of bytes of a pack file to map into memory in a
430         single mapping operation.  Larger window sizes may allow
431         your system to process a smaller number of large pack files
432         more quickly.  Smaller window sizes will negatively affect
433         performance due to increased calls to the operating system's
434         memory manager, but may improve performance when accessing
435         a large number of large pack files.
437 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
438 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
439 be reasonable for all users/operating systems.  You probably do
440 not need to adjust this value.
442 Common unit suffixes of 'k', 'm', or 'g' are supported.
444 core.packedGitLimit::
445         Maximum number of bytes to map simultaneously into memory
446         from pack files.  If Git needs to access more than this many
447         bytes at once to complete an operation it will unmap existing
448         regions to reclaim virtual address space within the process.
450 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
451 This should be reasonable for all users/operating systems, except on
452 the largest projects.  You probably do not need to adjust this value.
454 Common unit suffixes of 'k', 'm', or 'g' are supported.
456 core.deltaBaseCacheLimit::
457         Maximum number of bytes to reserve for caching base objects
458         that may be referenced by multiple deltified objects.  By storing the
459         entire decompressed base objects in a cache Git is able
460         to avoid unpacking and decompressing frequently used base
461         objects multiple times.
463 Default is 16 MiB on all platforms.  This should be reasonable
464 for all users/operating systems, except on the largest projects.
465 You probably do not need to adjust this value.
467 Common unit suffixes of 'k', 'm', or 'g' are supported.
469 core.bigFileThreshold::
470         Files larger than this size are stored deflated, without
471         attempting delta compression.  Storing large files without
472         delta compression avoids excessive memory usage, at the
473         slight expense of increased disk usage.
475 Default is 512 MiB on all platforms.  This should be reasonable
476 for most projects as source code and other text files can still
477 be delta compressed, but larger binary media files won't be.
479 Common unit suffixes of 'k', 'm', or 'g' are supported.
481 core.excludesfile::
482         In addition to '.gitignore' (per-directory) and
483         '.git/info/exclude', git looks into this file for patterns
484         of files which are not meant to be tracked.  "`~/`" is expanded
485         to the value of `$HOME` and "`~user/`" to the specified user's
486         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
487         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
488         is used instead. See linkgit:gitignore[5].
490 core.askpass::
491         Some commands (e.g. svn and http interfaces) that interactively
492         ask for a password can be told to use an external program given
493         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
494         environment variable. If not set, fall back to the value of the
495         'SSH_ASKPASS' environment variable or, failing that, a simple password
496         prompt. The external program shall be given a suitable prompt as
497         command line argument and write the password on its STDOUT.
499 core.attributesfile::
500         In addition to '.gitattributes' (per-directory) and
501         '.git/info/attributes', git looks into this file for attributes
502         (see linkgit:gitattributes[5]). Path expansions are made the same
503         way as for `core.excludesfile`. Its default value is
504         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
505         set or empty, $HOME/.config/git/attributes is used instead.
507 core.editor::
508         Commands such as `commit` and `tag` that lets you edit
509         messages by launching an editor uses the value of this
510         variable when it is set, and the environment variable
511         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
513 sequence.editor::
514         Text editor used by `git rebase -i` for editing the rebase insn file.
515         The value is meant to be interpreted by the shell when it is used.
516         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
517         When not configured the default commit message editor is used instead.
519 core.pager::
520         The command that git will use to paginate output.  Can
521         be overridden with the `GIT_PAGER` environment
522         variable.  Note that git sets the `LESS` environment
523         variable to `FRSX` if it is unset when it runs the
524         pager.  One can change these settings by setting the
525         `LESS` variable to some other value.  Alternately,
526         these settings can be overridden on a project or
527         global basis by setting the `core.pager` option.
528         Setting `core.pager` has no affect on the `LESS`
529         environment variable behaviour above, so if you want
530         to override git's default settings this way, you need
531         to be explicit.  For example, to disable the S option
532         in a backward compatible manner, set `core.pager`
533         to `less -+$LESS -FRX`.  This will be passed to the
534         shell by git, which will translate the final command to
535         `LESS=FRSX less -+FRSX -FRX`.
537 core.whitespace::
538         A comma separated list of common whitespace problems to
539         notice.  'git diff' will use `color.diff.whitespace` to
540         highlight them, and 'git apply --whitespace=error' will
541         consider them as errors.  You can prefix `-` to disable
542         any of them (e.g. `-trailing-space`):
544 * `blank-at-eol` treats trailing whitespaces at the end of the line
545   as an error (enabled by default).
546 * `space-before-tab` treats a space character that appears immediately
547   before a tab character in the initial indent part of the line as an
548   error (enabled by default).
549 * `indent-with-non-tab` treats a line that is indented with 8 or more
550   space characters as an error (not enabled by default).
551 * `tab-in-indent` treats a tab character in the initial indent part of
552   the line as an error (not enabled by default).
553 * `blank-at-eof` treats blank lines added at the end of file as an error
554   (enabled by default).
555 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
556   `blank-at-eof`.
557 * `cr-at-eol` treats a carriage-return at the end of line as
558   part of the line terminator, i.e. with it, `trailing-space`
559   does not trigger if the character before such a carriage-return
560   is not a whitespace (not enabled by default).
561 * `tabwidth=<n>` tells how many character positions a tab occupies; this
562   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
563   errors. The default tab width is 8. Allowed values are 1 to 63.
565 core.fsyncobjectfiles::
566         This boolean will enable 'fsync()' when writing object files.
568 This is a total waste of time and effort on a filesystem that orders
569 data writes properly, but can be useful for filesystems that do not use
570 journalling (traditional UNIX filesystems) or that only journal metadata
571 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
573 core.preloadindex::
574         Enable parallel index preload for operations like 'git diff'
576 This can speed up operations like 'git diff' and 'git status' especially
577 on filesystems like NFS that have weak caching semantics and thus
578 relatively high IO latencies.  With this set to 'true', git will do the
579 index comparison to the filesystem data in parallel, allowing
580 overlapping IO's.
582 core.createObject::
583         You can set this to 'link', in which case a hardlink followed by
584         a delete of the source are used to make sure that object creation
585         will not overwrite existing objects.
587 On some file system/operating system combinations, this is unreliable.
588 Set this config setting to 'rename' there; However, This will remove the
589 check that makes sure that existing object files will not get overwritten.
591 core.notesRef::
592         When showing commit messages, also show notes which are stored in
593         the given ref.  The ref must be fully qualified.  If the given
594         ref does not exist, it is not an error but means that no
595         notes should be printed.
597 This setting defaults to "refs/notes/commits", and it can be overridden by
598 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
600 core.sparseCheckout::
601         Enable "sparse checkout" feature. See section "Sparse checkout" in
602         linkgit:git-read-tree[1] for more information.
604 core.abbrev::
605         Set the length object names are abbreviated to.  If unspecified,
606         many commands abbreviate to 7 hexdigits, which may not be enough
607         for abbreviated object names to stay unique for sufficiently long
608         time.
610 add.ignore-errors::
611 add.ignoreErrors::
612         Tells 'git add' to continue adding files when some files cannot be
613         added due to indexing errors. Equivalent to the '--ignore-errors'
614         option of linkgit:git-add[1].  Older versions of git accept only
615         `add.ignore-errors`, which does not follow the usual naming
616         convention for configuration variables.  Newer versions of git
617         honor `add.ignoreErrors` as well.
619 alias.*::
620         Command aliases for the linkgit:git[1] command wrapper - e.g.
621         after defining "alias.last = cat-file commit HEAD", the invocation
622         "git last" is equivalent to "git cat-file commit HEAD". To avoid
623         confusion and troubles with script usage, aliases that
624         hide existing git commands are ignored. Arguments are split by
625         spaces, the usual shell quoting and escaping is supported.
626         quote pair and a backslash can be used to quote them.
628 If the alias expansion is prefixed with an exclamation point,
629 it will be treated as a shell command.  For example, defining
630 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
631 "git new" is equivalent to running the shell command
632 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
633 executed from the top-level directory of a repository, which may
634 not necessarily be the current directory.
635 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
636 from the original current directory. See linkgit:git-rev-parse[1].
638 am.keepcr::
639         If true, git-am will call git-mailsplit for patches in mbox format
640         with parameter '--keep-cr'. In this case git-mailsplit will
641         not remove `\r` from lines ending with `\r\n`. Can be overridden
642         by giving '--no-keep-cr' from the command line.
643         See linkgit:git-am[1], linkgit:git-mailsplit[1].
645 apply.ignorewhitespace::
646         When set to 'change', tells 'git apply' to ignore changes in
647         whitespace, in the same way as the '--ignore-space-change'
648         option.
649         When set to one of: no, none, never, false tells 'git apply' to
650         respect all whitespace differences.
651         See linkgit:git-apply[1].
653 apply.whitespace::
654         Tells 'git apply' how to handle whitespaces, in the same way
655         as the '--whitespace' option. See linkgit:git-apply[1].
657 branch.autosetupmerge::
658         Tells 'git branch' and 'git checkout' to set up new branches
659         so that linkgit:git-pull[1] will appropriately merge from the
660         starting point branch. Note that even if this option is not set,
661         this behavior can be chosen per-branch using the `--track`
662         and `--no-track` options. The valid settings are: `false` -- no
663         automatic setup is done; `true` -- automatic setup is done when the
664         starting point is a remote-tracking branch; `always` --
665         automatic setup is done when the starting point is either a
666         local branch or remote-tracking
667         branch. This option defaults to true.
669 branch.autosetuprebase::
670         When a new branch is created with 'git branch' or 'git checkout'
671         that tracks another branch, this variable tells git to set
672         up pull to rebase instead of merge (see "branch.<name>.rebase").
673         When `never`, rebase is never automatically set to true.
674         When `local`, rebase is set to true for tracked branches of
675         other local branches.
676         When `remote`, rebase is set to true for tracked branches of
677         remote-tracking branches.
678         When `always`, rebase will be set to true for all tracking
679         branches.
680         See "branch.autosetupmerge" for details on how to set up a
681         branch to track another branch.
682         This option defaults to never.
684 branch.<name>.remote::
685         When in branch <name>, it tells 'git fetch' and 'git push' which
686         remote to fetch from/push to.  It defaults to `origin` if no remote is
687         configured. `origin` is also used if you are not on any branch.
689 branch.<name>.merge::
690         Defines, together with branch.<name>.remote, the upstream branch
691         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
692         branch to merge and can also affect 'git push' (see push.default).
693         When in branch <name>, it tells 'git fetch' the default
694         refspec to be marked for merging in FETCH_HEAD. The value is
695         handled like the remote part of a refspec, and must match a
696         ref which is fetched from the remote given by
697         "branch.<name>.remote".
698         The merge information is used by 'git pull' (which at first calls
699         'git fetch') to lookup the default branch for merging. Without
700         this option, 'git pull' defaults to merge the first refspec fetched.
701         Specify multiple values to get an octopus merge.
702         If you wish to setup 'git pull' so that it merges into <name> from
703         another branch in the local repository, you can point
704         branch.<name>.merge to the desired branch, and use the special setting
705         `.` (a period) for branch.<name>.remote.
707 branch.<name>.mergeoptions::
708         Sets default options for merging into branch <name>. The syntax and
709         supported options are the same as those of linkgit:git-merge[1], but
710         option values containing whitespace characters are currently not
711         supported.
713 branch.<name>.rebase::
714         When true, rebase the branch <name> on top of the fetched branch,
715         instead of merging the default branch from the default remote when
716         "git pull" is run. See "pull.rebase" for doing this in a non
717         branch-specific manner.
719 *NOTE*: this is a possibly dangerous operation; do *not* use
720 it unless you understand the implications (see linkgit:git-rebase[1]
721 for details).
723 browser.<tool>.cmd::
724         Specify the command to invoke the specified browser. The
725         specified command is evaluated in shell with the URLs passed
726         as arguments. (See linkgit:git-web{litdd}browse[1].)
728 browser.<tool>.path::
729         Override the path for the given tool that may be used to
730         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
731         working repository in gitweb (see linkgit:git-instaweb[1]).
733 clean.requireForce::
734         A boolean to make git-clean do nothing unless given -f
735         or -n.   Defaults to true.
737 color.branch::
738         A boolean to enable/disable color in the output of
739         linkgit:git-branch[1]. May be set to `always`,
740         `false` (or `never`) or `auto` (or `true`), in which case colors are used
741         only when the output is to a terminal. Defaults to false.
743 color.branch.<slot>::
744         Use customized color for branch coloration. `<slot>` is one of
745         `current` (the current branch), `local` (a local branch),
746         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
747         refs).
749 The value for these configuration variables is a list of colors (at most
750 two) and attributes (at most one), separated by spaces.  The colors
751 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
752 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
753 `blink` and `reverse`.  The first color given is the foreground; the
754 second is the background.  The position of the attribute, if any,
755 doesn't matter.
757 color.diff::
758         Whether to use ANSI escape sequences to add color to patches.
759         If this is set to `always`, linkgit:git-diff[1],
760         linkgit:git-log[1], and linkgit:git-show[1] will use color
761         for all patches.  If it is set to `true` or `auto`, those
762         commands will only use color when output is to the terminal.
763         Defaults to false.
765 This does not affect linkgit:git-format-patch[1] nor the
766 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
767 command line with the `--color[=<when>]` option.
769 color.diff.<slot>::
770         Use customized color for diff colorization.  `<slot>` specifies
771         which part of the patch to use the specified color, and is one
772         of `plain` (context text), `meta` (metainformation), `frag`
773         (hunk header), 'func' (function in hunk header), `old` (removed lines),
774         `new` (added lines), `commit` (commit headers), or `whitespace`
775         (highlighting whitespace errors). The values of these variables may be
776         specified as in color.branch.<slot>.
778 color.decorate.<slot>::
779         Use customized color for 'git log --decorate' output.  `<slot>` is one
780         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
781         branches, remote-tracking branches, tags, stash and HEAD, respectively.
783 color.grep::
784         When set to `always`, always highlight matches.  When `false` (or
785         `never`), never.  When set to `true` or `auto`, use color only
786         when the output is written to the terminal.  Defaults to `false`.
788 color.grep.<slot>::
789         Use customized color for grep colorization.  `<slot>` specifies which
790         part of the line to use the specified color, and is one of
793 `context`;;
794         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
795 `filename`;;
796         filename prefix (when not using `-h`)
797 `function`;;
798         function name lines (when using `-p`)
799 `linenumber`;;
800         line number prefix (when using `-n`)
801 `match`;;
802         matching text
803 `selected`;;
804         non-matching text in selected lines
805 `separator`;;
806         separators between fields on a line (`:`, `-`, and `=`)
807         and between hunks (`--`)
810 The values of these variables may be specified as in color.branch.<slot>.
812 color.interactive::
813         When set to `always`, always use colors for interactive prompts
814         and displays (such as those used by "git-add --interactive").
815         When false (or `never`), never.  When set to `true` or `auto`, use
816         colors only when the output is to the terminal. Defaults to false.
818 color.interactive.<slot>::
819         Use customized color for 'git add --interactive'
820         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
821         four distinct types of normal output from interactive
822         commands.  The values of these variables may be specified as
823         in color.branch.<slot>.
825 color.pager::
826         A boolean to enable/disable colored output when the pager is in
827         use (default is true).
829 color.showbranch::
830         A boolean to enable/disable color in the output of
831         linkgit:git-show-branch[1]. May be set to `always`,
832         `false` (or `never`) or `auto` (or `true`), in which case colors are used
833         only when the output is to a terminal. Defaults to false.
835 color.status::
836         A boolean to enable/disable color in the output of
837         linkgit:git-status[1]. May be set to `always`,
838         `false` (or `never`) or `auto` (or `true`), in which case colors are used
839         only when the output is to a terminal. Defaults to false.
841 color.status.<slot>::
842         Use customized color for status colorization. `<slot>` is
843         one of `header` (the header text of the status message),
844         `added` or `updated` (files which are added but not committed),
845         `changed` (files which are changed but not added in the index),
846         `untracked` (files which are not tracked by git),
847         `branch` (the current branch), or
848         `nobranch` (the color the 'no branch' warning is shown in, defaulting
849         to red). The values of these variables may be specified as in
850         color.branch.<slot>.
852 color.ui::
853         This variable determines the default value for variables such
854         as `color.diff` and `color.grep` that control the use of color
855         per command family. Its scope will expand as more commands learn
856         configuration to set a default for the `--color` option.  Set it
857         to `always` if you want all output not intended for machine
858         consumption to use color, to `true` or `auto` if you want such
859         output to use color when written to the terminal, or to `false` or
860         `never` if you prefer git commands not to use color unless enabled
861         explicitly with some other configuration or the `--color` option.
863 column.ui::
864         Specify whether supported commands should output in columns.
865         This variable consists of a list of tokens separated by spaces
866         or commas:
869 `always`;;
870         always show in columns
871 `never`;;
872         never show in columns
873 `auto`;;
874         show in columns if the output is to the terminal
875 `column`;;
876         fill columns before rows (default)
877 `row`;;
878         fill rows before columns
879 `plain`;;
880         show in one column
881 `dense`;;
882         make unequal size columns to utilize more space
883 `nodense`;;
884         make equal size columns
887         This option defaults to 'never'.
889 column.branch::
890         Specify whether to output branch listing in `git branch` in columns.
891         See `column.ui` for details.
893 column.status::
894         Specify whether to output untracked files in `git status` in columns.
895         See `column.ui` for details.
897 column.tag::
898         Specify whether to output tag listing in `git tag` in columns.
899         See `column.ui` for details.
901 commit.status::
902         A boolean to enable/disable inclusion of status information in the
903         commit message template when using an editor to prepare the commit
904         message.  Defaults to true.
906 commit.template::
907         Specify a file to use as the template for new commit messages.
908         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
909         specified user's home directory.
911 credential.helper::
912         Specify an external helper to be called when a username or
913         password credential is needed; the helper may consult external
914         storage to avoid prompting the user for the credentials. See
915         linkgit:gitcredentials[7] for details.
917 credential.useHttpPath::
918         When acquiring credentials, consider the "path" component of an http
919         or https URL to be important. Defaults to false. See
920         linkgit:gitcredentials[7] for more information.
922 credential.username::
923         If no username is set for a network authentication, use this username
924         by default. See credential.<context>.* below, and
925         linkgit:gitcredentials[7].
927 credential.<url>.*::
928         Any of the credential.* options above can be applied selectively to
929         some credentials. For example "credential.https://example.com.username"
930         would set the default username only for https connections to
931         example.com. See linkgit:gitcredentials[7] for details on how URLs are
932         matched.
934 include::diff-config.txt[]
936 difftool.<tool>.path::
937         Override the path for the given tool.  This is useful in case
938         your tool is not in the PATH.
940 difftool.<tool>.cmd::
941         Specify the command to invoke the specified diff tool.
942         The specified command is evaluated in shell with the following
943         variables available:  'LOCAL' is set to the name of the temporary
944         file containing the contents of the diff pre-image and 'REMOTE'
945         is set to the name of the temporary file containing the contents
946         of the diff post-image.
948 difftool.prompt::
949         Prompt before each invocation of the diff tool.
951 diff.wordRegex::
952         A POSIX Extended Regular Expression used to determine what is a "word"
953         when performing word-by-word difference calculations.  Character
954         sequences that match the regular expression are "words", all other
955         characters are *ignorable* whitespace.
957 fetch.recurseSubmodules::
958         This option can be either set to a boolean value or to 'on-demand'.
959         Setting it to a boolean changes the behavior of fetch and pull to
960         unconditionally recurse into submodules when set to true or to not
961         recurse at all when set to false. When set to 'on-demand' (the default
962         value), fetch and pull will only recurse into a populated submodule
963         when its superproject retrieves a commit that updates the submodule's
964         reference.
966 fetch.fsckObjects::
967         If it is set to true, git-fetch-pack will check all fetched
968         objects. It will abort in the case of a malformed object or a
969         broken link. The result of an abort are only dangling objects.
970         Defaults to false. If not set, the value of `transfer.fsckObjects`
971         is used instead.
973 fetch.unpackLimit::
974         If the number of objects fetched over the git native
975         transfer is below this
976         limit, then the objects will be unpacked into loose object
977         files. However if the number of received objects equals or
978         exceeds this limit then the received pack will be stored as
979         a pack, after adding any missing delta bases.  Storing the
980         pack from a push can make the push operation complete faster,
981         especially on slow filesystems.  If not set, the value of
982         `transfer.unpackLimit` is used instead.
984 format.attach::
985         Enable multipart/mixed attachments as the default for
986         'format-patch'.  The value can also be a double quoted string
987         which will enable attachments as the default and set the
988         value as the boundary.  See the --attach option in
989         linkgit:git-format-patch[1].
991 format.numbered::
992         A boolean which can enable or disable sequence numbers in patch
993         subjects.  It defaults to "auto" which enables it only if there
994         is more than one patch.  It can be enabled or disabled for all
995         messages by setting it to "true" or "false".  See --numbered
996         option in linkgit:git-format-patch[1].
998 format.headers::
999         Additional email headers to include in a patch to be submitted
1000         by mail.  See linkgit:git-format-patch[1].
1002 format.to::
1003 format.cc::
1004         Additional recipients to include in a patch to be submitted
1005         by mail.  See the --to and --cc options in
1006         linkgit:git-format-patch[1].
1008 format.subjectprefix::
1009         The default for format-patch is to output files with the '[PATCH]'
1010         subject prefix. Use this variable to change that prefix.
1012 format.signature::
1013         The default for format-patch is to output a signature containing
1014         the git version number. Use this variable to change that default.
1015         Set this variable to the empty string ("") to suppress
1016         signature generation.
1018 format.suffix::
1019         The default for format-patch is to output files with the suffix
1020         `.patch`. Use this variable to change that suffix (make sure to
1021         include the dot if you want it).
1023 format.pretty::
1024         The default pretty format for log/show/whatchanged command,
1025         See linkgit:git-log[1], linkgit:git-show[1],
1026         linkgit:git-whatchanged[1].
1028 format.thread::
1029         The default threading style for 'git format-patch'.  Can be
1030         a boolean value, or `shallow` or `deep`.  `shallow` threading
1031         makes every mail a reply to the head of the series,
1032         where the head is chosen from the cover letter, the
1033         `--in-reply-to`, and the first patch mail, in this order.
1034         `deep` threading makes every mail a reply to the previous one.
1035         A true boolean value is the same as `shallow`, and a false
1036         value disables threading.
1038 format.signoff::
1039     A boolean value which lets you enable the `-s/--signoff` option of
1040     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1041     patch should be a conscious act and means that you certify you have
1042     the rights to submit this work under the same open source license.
1043     Please see the 'SubmittingPatches' document for further discussion.
1045 filter.<driver>.clean::
1046         The command which is used to convert the content of a worktree
1047         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1048         details.
1050 filter.<driver>.smudge::
1051         The command which is used to convert the content of a blob
1052         object to a worktree file upon checkout.  See
1053         linkgit:gitattributes[5] for details.
1055 gc.aggressiveWindow::
1056         The window size parameter used in the delta compression
1057         algorithm used by 'git gc --aggressive'.  This defaults
1058         to 250.
1060 gc.auto::
1061         When there are approximately more than this many loose
1062         objects in the repository, `git gc --auto` will pack them.
1063         Some Porcelain commands use this command to perform a
1064         light-weight garbage collection from time to time.  The
1065         default value is 6700.  Setting this to 0 disables it.
1067 gc.autopacklimit::
1068         When there are more than this many packs that are not
1069         marked with `*.keep` file in the repository, `git gc
1070         --auto` consolidates them into one larger pack.  The
1071         default value is 50.  Setting this to 0 disables it.
1073 gc.packrefs::
1074         Running `git pack-refs` in a repository renders it
1075         unclonable by Git versions prior to 1.5.1.2 over dumb
1076         transports such as HTTP.  This variable determines whether
1077         'git gc' runs `git pack-refs`. This can be set to `notbare`
1078         to enable it within all non-bare repos or it can be set to a
1079         boolean value.  The default is `true`.
1081 gc.pruneexpire::
1082         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1083         Override the grace period with this config variable.  The value
1084         "now" may be used to disable this  grace period and always prune
1085         unreachable objects immediately.
1087 gc.reflogexpire::
1088 gc.<pattern>.reflogexpire::
1089         'git reflog expire' removes reflog entries older than
1090         this time; defaults to 90 days.  With "<pattern>" (e.g.
1091         "refs/stash") in the middle the setting applies only to
1092         the refs that match the <pattern>.
1094 gc.reflogexpireunreachable::
1095 gc.<ref>.reflogexpireunreachable::
1096         'git reflog expire' removes reflog entries older than
1097         this time and are not reachable from the current tip;
1098         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1099         in the middle, the setting applies only to the refs that
1100         match the <pattern>.
1102 gc.rerereresolved::
1103         Records of conflicted merge you resolved earlier are
1104         kept for this many days when 'git rerere gc' is run.
1105         The default is 60 days.  See linkgit:git-rerere[1].
1107 gc.rerereunresolved::
1108         Records of conflicted merge you have not resolved are
1109         kept for this many days when 'git rerere gc' is run.
1110         The default is 15 days.  See linkgit:git-rerere[1].
1112 gitcvs.commitmsgannotation::
1113         Append this string to each commit message. Set to empty string
1114         to disable this feature. Defaults to "via git-CVS emulator".
1116 gitcvs.enabled::
1117         Whether the CVS server interface is enabled for this repository.
1118         See linkgit:git-cvsserver[1].
1120 gitcvs.logfile::
1121         Path to a log file where the CVS server interface well... logs
1122         various stuff. See linkgit:git-cvsserver[1].
1124 gitcvs.usecrlfattr::
1125         If true, the server will look up the end-of-line conversion
1126         attributes for files to determine the '-k' modes to use. If
1127         the attributes force git to treat a file as text,
1128         the '-k' mode will be left blank so CVS clients will
1129         treat it as text. If they suppress text conversion, the file
1130         will be set with '-kb' mode, which suppresses any newline munging
1131         the client might otherwise do. If the attributes do not allow
1132         the file type to be determined, then 'gitcvs.allbinary' is
1133         used. See linkgit:gitattributes[5].
1135 gitcvs.allbinary::
1136         This is used if 'gitcvs.usecrlfattr' does not resolve
1137         the correct '-kb' mode to use. If true, all
1138         unresolved files are sent to the client in
1139         mode '-kb'. This causes the client to treat them
1140         as binary files, which suppresses any newline munging it
1141         otherwise might do. Alternatively, if it is set to "guess",
1142         then the contents of the file are examined to decide if
1143         it is binary, similar to 'core.autocrlf'.
1145 gitcvs.dbname::
1146         Database used by git-cvsserver to cache revision information
1147         derived from the git repository. The exact meaning depends on the
1148         used database driver, for SQLite (which is the default driver) this
1149         is a filename. Supports variable substitution (see
1150         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1151         Default: '%Ggitcvs.%m.sqlite'
1153 gitcvs.dbdriver::
1154         Used Perl DBI driver. You can specify any available driver
1155         for this here, but it might not work. git-cvsserver is tested
1156         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1157         reported *not* to work with 'DBD::mysql'. Experimental feature.
1158         May not contain double colons (`:`). Default: 'SQLite'.
1159         See linkgit:git-cvsserver[1].
1161 gitcvs.dbuser, gitcvs.dbpass::
1162         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1163         since SQLite has no concept of database users and/or passwords.
1164         'gitcvs.dbuser' supports variable substitution (see
1165         linkgit:git-cvsserver[1] for details).
1167 gitcvs.dbTableNamePrefix::
1168         Database table name prefix.  Prepended to the names of any
1169         database tables used, allowing a single database to be used
1170         for several repositories.  Supports variable substitution (see
1171         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1172         characters will be replaced with underscores.
1174 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1175 'gitcvs.allbinary' can also be specified as
1176 'gitcvs.<access_method>.<varname>' (where 'access_method'
1177 is one of "ext" and "pserver") to make them apply only for the given
1178 access method.
1180 gitweb.category::
1181 gitweb.description::
1182 gitweb.owner::
1183 gitweb.url::
1184         See linkgit:gitweb[1] for description.
1186 gitweb.avatar::
1187 gitweb.blame::
1188 gitweb.grep::
1189 gitweb.highlight::
1190 gitweb.patches::
1191 gitweb.pickaxe::
1192 gitweb.remote_heads::
1193 gitweb.showsizes::
1194 gitweb.snapshot::
1195         See linkgit:gitweb.conf[5] for description.
1197 grep.lineNumber::
1198         If set to true, enable '-n' option by default.
1200 grep.extendedRegexp::
1201         If set to true, enable '--extended-regexp' option by default.
1203 gpg.program::
1204         Use this custom program instead of "gpg" found on $PATH when
1205         making or verifying a PGP signature. The program must support the
1206         same command line interface as GPG, namely, to verify a detached
1207         signature, "gpg --verify $file - <$signature" is run, and the
1208         program is expected to signal a good signature by exiting with
1209         code 0, and to generate an ascii-armored detached signature, the
1210         standard input of "gpg -bsau $key" is fed with the contents to be
1211         signed, and the program is expected to send the result to its
1212         standard output.
1214 gui.commitmsgwidth::
1215         Defines how wide the commit message window is in the
1216         linkgit:git-gui[1]. "75" is the default.
1218 gui.diffcontext::
1219         Specifies how many context lines should be used in calls to diff
1220         made by the linkgit:git-gui[1]. The default is "5".
1222 gui.encoding::
1223         Specifies the default encoding to use for displaying of
1224         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1225         It can be overridden by setting the 'encoding' attribute
1226         for relevant files (see linkgit:gitattributes[5]).
1227         If this option is not set, the tools default to the
1228         locale encoding.
1230 gui.matchtrackingbranch::
1231         Determines if new branches created with linkgit:git-gui[1] should
1232         default to tracking remote branches with matching names or
1233         not. Default: "false".
1235 gui.newbranchtemplate::
1236         Is used as suggested name when creating new branches using the
1237         linkgit:git-gui[1].
1239 gui.pruneduringfetch::
1240         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1241         performing a fetch. The default value is "false".
1243 gui.trustmtime::
1244         Determines if linkgit:git-gui[1] should trust the file modification
1245         timestamp or not. By default the timestamps are not trusted.
1247 gui.spellingdictionary::
1248         Specifies the dictionary used for spell checking commit messages in
1249         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1250         off.
1252 gui.fastcopyblame::
1253         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1254         location detection. It makes blame significantly faster on huge
1255         repositories at the expense of less thorough copy detection.
1257 gui.copyblamethreshold::
1258         Specifies the threshold to use in 'git gui blame' original location
1259         detection, measured in alphanumeric characters. See the
1260         linkgit:git-blame[1] manual for more information on copy detection.
1262 gui.blamehistoryctx::
1263         Specifies the radius of history context in days to show in
1264         linkgit:gitk[1] for the selected commit, when the `Show History
1265         Context` menu item is invoked from 'git gui blame'. If this
1266         variable is set to zero, the whole history is shown.
1268 guitool.<name>.cmd::
1269         Specifies the shell command line to execute when the corresponding item
1270         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1271         mandatory for every tool. The command is executed from the root of
1272         the working directory, and in the environment it receives the name of
1273         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1274         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1275         the head is detached, 'CUR_BRANCH' is empty).
1277 guitool.<name>.needsfile::
1278         Run the tool only if a diff is selected in the GUI. It guarantees
1279         that 'FILENAME' is not empty.
1281 guitool.<name>.noconsole::
1282         Run the command silently, without creating a window to display its
1283         output.
1285 guitool.<name>.norescan::
1286         Don't rescan the working directory for changes after the tool
1287         finishes execution.
1289 guitool.<name>.confirm::
1290         Show a confirmation dialog before actually running the tool.
1292 guitool.<name>.argprompt::
1293         Request a string argument from the user, and pass it to the tool
1294         through the 'ARGS' environment variable. Since requesting an
1295         argument implies confirmation, the 'confirm' option has no effect
1296         if this is enabled. If the option is set to 'true', 'yes', or '1',
1297         the dialog uses a built-in generic prompt; otherwise the exact
1298         value of the variable is used.
1300 guitool.<name>.revprompt::
1301         Request a single valid revision from the user, and set the
1302         'REVISION' environment variable. In other aspects this option
1303         is similar to 'argprompt', and can be used together with it.
1305 guitool.<name>.revunmerged::
1306         Show only unmerged branches in the 'revprompt' subdialog.
1307         This is useful for tools similar to merge or rebase, but not
1308         for things like checkout or reset.
1310 guitool.<name>.title::
1311         Specifies the title to use for the prompt dialog. The default
1312         is the tool name.
1314 guitool.<name>.prompt::
1315         Specifies the general prompt string to display at the top of
1316         the dialog, before subsections for 'argprompt' and 'revprompt'.
1317         The default value includes the actual command.
1319 help.browser::
1320         Specify the browser that will be used to display help in the
1321         'web' format. See linkgit:git-help[1].
1323 help.format::
1324         Override the default help format used by linkgit:git-help[1].
1325         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1326         the default. 'web' and 'html' are the same.
1328 help.autocorrect::
1329         Automatically correct and execute mistyped commands after
1330         waiting for the given number of deciseconds (0.1 sec). If more
1331         than one command can be deduced from the entered text, nothing
1332         will be executed.  If the value of this option is negative,
1333         the corrected command will be executed immediately. If the
1334         value is 0 - the command will be just shown but not executed.
1335         This is the default.
1337 http.proxy::
1338         Override the HTTP proxy, normally configured using the 'http_proxy',
1339         'https_proxy', and 'all_proxy' environment variables (see
1340         `curl(1)`).  This can be overridden on a per-remote basis; see
1341         remote.<name>.proxy
1343 http.cookiefile::
1344         File containing previously stored cookie lines which should be used
1345         in the git http session, if they match the server. The file format
1346         of the file to read cookies from should be plain HTTP headers or
1347         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1348         NOTE that the file specified with http.cookiefile is only used as
1349         input. No cookies will be stored in the file.
1351 http.sslVerify::
1352         Whether to verify the SSL certificate when fetching or pushing
1353         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1354         variable.
1356 http.sslCert::
1357         File containing the SSL certificate when fetching or pushing
1358         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1359         variable.
1361 http.sslKey::
1362         File containing the SSL private key when fetching or pushing
1363         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1364         variable.
1366 http.sslCertPasswordProtected::
1367         Enable git's password prompt for the SSL certificate.  Otherwise
1368         OpenSSL will prompt the user, possibly many times, if the
1369         certificate or private key is encrypted.  Can be overridden by the
1370         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1372 http.sslCAInfo::
1373         File containing the certificates to verify the peer with when
1374         fetching or pushing over HTTPS. Can be overridden by the
1375         'GIT_SSL_CAINFO' environment variable.
1377 http.sslCAPath::
1378         Path containing files with the CA certificates to verify the peer
1379         with when fetching or pushing over HTTPS. Can be overridden
1380         by the 'GIT_SSL_CAPATH' environment variable.
1382 http.maxRequests::
1383         How many HTTP requests to launch in parallel. Can be overridden
1384         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1386 http.minSessions::
1387         The number of curl sessions (counted across slots) to be kept across
1388         requests. They will not be ended with curl_easy_cleanup() until
1389         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1390         value will be capped at 1. Defaults to 1.
1392 http.postBuffer::
1393         Maximum size in bytes of the buffer used by smart HTTP
1394         transports when POSTing data to the remote system.
1395         For requests larger than this buffer size, HTTP/1.1 and
1396         Transfer-Encoding: chunked is used to avoid creating a
1397         massive pack file locally.  Default is 1 MiB, which is
1398         sufficient for most requests.
1400 http.lowSpeedLimit, http.lowSpeedTime::
1401         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1402         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1403         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1404         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1406 http.noEPSV::
1407         A boolean which disables using of EPSV ftp command by curl.
1408         This can helpful with some "poor" ftp servers which don't
1409         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1410         environment variable. Default is false (curl will use EPSV).
1412 http.useragent::
1413         The HTTP USER_AGENT string presented to an HTTP server.  The default
1414         value represents the version of the client git such as git/1.7.1.
1415         This option allows you to override this value to a more common value
1416         such as Mozilla/4.0.  This may be necessary, for instance, if
1417         connecting through a firewall that restricts HTTP connections to a set
1418         of common USER_AGENT strings (but not including those like git/1.7.1).
1419         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1421 i18n.commitEncoding::
1422         Character encoding the commit messages are stored in; git itself
1423         does not care per se, but this information is necessary e.g. when
1424         importing commits from emails or in the gitk graphical history
1425         browser (and possibly at other places in the future or in other
1426         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1428 i18n.logOutputEncoding::
1429         Character encoding the commit messages are converted to when
1430         running 'git log' and friends.
1432 imap::
1433         The configuration variables in the 'imap' section are described
1434         in linkgit:git-imap-send[1].
1436 init.templatedir::
1437         Specify the directory from which templates will be copied.
1438         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1440 instaweb.browser::
1441         Specify the program that will be used to browse your working
1442         repository in gitweb. See linkgit:git-instaweb[1].
1444 instaweb.httpd::
1445         The HTTP daemon command-line to start gitweb on your working
1446         repository. See linkgit:git-instaweb[1].
1448 instaweb.local::
1449         If true the web server started by linkgit:git-instaweb[1] will
1450         be bound to the local IP (127.0.0.1).
1452 instaweb.modulepath::
1453         The default module path for linkgit:git-instaweb[1] to use
1454         instead of /usr/lib/apache2/modules.  Only used if httpd
1455         is Apache.
1457 instaweb.port::
1458         The port number to bind the gitweb httpd to. See
1459         linkgit:git-instaweb[1].
1461 interactive.singlekey::
1462         In interactive commands, allow the user to provide one-letter
1463         input with a single key (i.e., without hitting enter).
1464         Currently this is used by the `--patch` mode of
1465         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1466         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1467         setting is silently ignored if portable keystroke input
1468         is not available.
1470 log.abbrevCommit::
1471         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1472         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1473         override this option with `--no-abbrev-commit`.
1475 log.date::
1476         Set the default date-time mode for the 'log' command.
1477         Setting a value for log.date is similar to using 'git log''s
1478         `--date` option.  Possible values are `relative`, `local`,
1479         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1480         for details.
1482 log.decorate::
1483         Print out the ref names of any commits that are shown by the log
1484         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1485         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1486         specified, the full ref name (including prefix) will be printed.
1487         This is the same as the log commands '--decorate' option.
1489 log.showroot::
1490         If true, the initial commit will be shown as a big creation event.
1491         This is equivalent to a diff against an empty tree.
1492         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1493         normally hide the root commit will now show it. True by default.
1495 mailmap.file::
1496         The location of an augmenting mailmap file. The default
1497         mailmap, located in the root of the repository, is loaded
1498         first, then the mailmap file pointed to by this variable.
1499         The location of the mailmap file may be in a repository
1500         subdirectory, or somewhere outside of the repository itself.
1501         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1503 man.viewer::
1504         Specify the programs that may be used to display help in the
1505         'man' format. See linkgit:git-help[1].
1507 man.<tool>.cmd::
1508         Specify the command to invoke the specified man viewer. The
1509         specified command is evaluated in shell with the man page
1510         passed as argument. (See linkgit:git-help[1].)
1512 man.<tool>.path::
1513         Override the path for the given tool that may be used to
1514         display help in the 'man' format. See linkgit:git-help[1].
1516 include::merge-config.txt[]
1518 mergetool.<tool>.path::
1519         Override the path for the given tool.  This is useful in case
1520         your tool is not in the PATH.
1522 mergetool.<tool>.cmd::
1523         Specify the command to invoke the specified merge tool.  The
1524         specified command is evaluated in shell with the following
1525         variables available: 'BASE' is the name of a temporary file
1526         containing the common base of the files to be merged, if available;
1527         'LOCAL' is the name of a temporary file containing the contents of
1528         the file on the current branch; 'REMOTE' is the name of a temporary
1529         file containing the contents of the file from the branch being
1530         merged; 'MERGED' contains the name of the file to which the merge
1531         tool should write the results of a successful merge.
1533 mergetool.<tool>.trustExitCode::
1534         For a custom merge command, specify whether the exit code of
1535         the merge command can be used to determine whether the merge was
1536         successful.  If this is not set to true then the merge target file
1537         timestamp is checked and the merge assumed to have been successful
1538         if the file has been updated, otherwise the user is prompted to
1539         indicate the success of the merge.
1541 mergetool.keepBackup::
1542         After performing a merge, the original file with conflict markers
1543         can be saved as a file with a `.orig` extension.  If this variable
1544         is set to `false` then this file is not preserved.  Defaults to
1545         `true` (i.e. keep the backup files).
1547 mergetool.keepTemporaries::
1548         When invoking a custom merge tool, git uses a set of temporary
1549         files to pass to the tool. If the tool returns an error and this
1550         variable is set to `true`, then these temporary files will be
1551         preserved, otherwise they will be removed after the tool has
1552         exited. Defaults to `false`.
1554 mergetool.prompt::
1555         Prompt before each invocation of the merge resolution program.
1557 notes.displayRef::
1558         The (fully qualified) refname from which to show notes when
1559         showing commit messages.  The value of this variable can be set
1560         to a glob, in which case notes from all matching refs will be
1561         shown.  You may also specify this configuration variable
1562         several times.  A warning will be issued for refs that do not
1563         exist, but a glob that does not match any refs is silently
1564         ignored.
1566 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1567 environment variable, which must be a colon separated list of refs or
1568 globs.
1570 The effective value of "core.notesRef" (possibly overridden by
1571 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1572 displayed.
1574 notes.rewrite.<command>::
1575         When rewriting commits with <command> (currently `amend` or
1576         `rebase`) and this variable is set to `true`, git
1577         automatically copies your notes from the original to the
1578         rewritten commit.  Defaults to `true`, but see
1579         "notes.rewriteRef" below.
1581 notes.rewriteMode::
1582         When copying notes during a rewrite (see the
1583         "notes.rewrite.<command>" option), determines what to do if
1584         the target commit already has a note.  Must be one of
1585         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1586         `concatenate`.
1588 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1589 environment variable.
1591 notes.rewriteRef::
1592         When copying notes during a rewrite, specifies the (fully
1593         qualified) ref whose notes should be copied.  The ref may be a
1594         glob, in which case notes in all matching refs will be copied.
1595         You may also specify this configuration several times.
1597 Does not have a default value; you must configure this variable to
1598 enable note rewriting.  Set it to `refs/notes/commits` to enable
1599 rewriting for the default commit notes.
1601 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1602 environment variable, which must be a colon separated list of refs or
1603 globs.
1605 pack.window::
1606         The size of the window used by linkgit:git-pack-objects[1] when no
1607         window size is given on the command line. Defaults to 10.
1609 pack.depth::
1610         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1611         maximum depth is given on the command line. Defaults to 50.
1613 pack.windowMemory::
1614         The window memory size limit used by linkgit:git-pack-objects[1]
1615         when no limit is given on the command line.  The value can be
1616         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1617         limit.
1619 pack.compression::
1620         An integer -1..9, indicating the compression level for objects
1621         in a pack file. -1 is the zlib default. 0 means no
1622         compression, and 1..9 are various speed/size tradeoffs, 9 being
1623         slowest.  If not set,  defaults to core.compression.  If that is
1624         not set,  defaults to -1, the zlib default, which is "a default
1625         compromise between speed and compression (currently equivalent
1626         to level 6)."
1628 Note that changing the compression level will not automatically recompress
1629 all existing objects. You can force recompression by passing the -F option
1630 to linkgit:git-repack[1].
1632 pack.deltaCacheSize::
1633         The maximum memory in bytes used for caching deltas in
1634         linkgit:git-pack-objects[1] before writing them out to a pack.
1635         This cache is used to speed up the writing object phase by not
1636         having to recompute the final delta result once the best match
1637         for all objects is found.  Repacking large repositories on machines
1638         which are tight with memory might be badly impacted by this though,
1639         especially if this cache pushes the system into swapping.
1640         A value of 0 means no limit. The smallest size of 1 byte may be
1641         used to virtually disable this cache. Defaults to 256 MiB.
1643 pack.deltaCacheLimit::
1644         The maximum size of a delta, that is cached in
1645         linkgit:git-pack-objects[1]. This cache is used to speed up the
1646         writing object phase by not having to recompute the final delta
1647         result once the best match for all objects is found. Defaults to 1000.
1649 pack.threads::
1650         Specifies the number of threads to spawn when searching for best
1651         delta matches.  This requires that linkgit:git-pack-objects[1]
1652         be compiled with pthreads otherwise this option is ignored with a
1653         warning. This is meant to reduce packing time on multiprocessor
1654         machines. The required amount of memory for the delta search window
1655         is however multiplied by the number of threads.
1656         Specifying 0 will cause git to auto-detect the number of CPU's
1657         and set the number of threads accordingly.
1659 pack.indexVersion::
1660         Specify the default pack index version.  Valid values are 1 for
1661         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1662         the new pack index with capabilities for packs larger than 4 GB
1663         as well as proper protection against the repacking of corrupted
1664         packs.  Version 2 is the default.  Note that version 2 is enforced
1665         and this config option ignored whenever the corresponding pack is
1666         larger than 2 GB.
1668 If you have an old git that does not understand the version 2 `*.idx` file,
1669 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1670 that will copy both `*.pack` file and corresponding `*.idx` file from the
1671 other side may give you a repository that cannot be accessed with your
1672 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1673 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1674 the `*.idx` file.
1676 pack.packSizeLimit::
1677         The maximum size of a pack.  This setting only affects
1678         packing to a file when repacking, i.e. the git:// protocol
1679         is unaffected.  It can be overridden by the `--max-pack-size`
1680         option of linkgit:git-repack[1]. The minimum size allowed is
1681         limited to 1 MiB. The default is unlimited.
1682         Common unit suffixes of 'k', 'm', or 'g' are
1683         supported.
1685 pager.<cmd>::
1686         If the value is boolean, turns on or off pagination of the
1687         output of a particular git subcommand when writing to a tty.
1688         Otherwise, turns on pagination for the subcommand using the
1689         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1690         or `--no-pager` is specified on the command line, it takes
1691         precedence over this option.  To disable pagination for all
1692         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1694 pretty.<name>::
1695         Alias for a --pretty= format string, as specified in
1696         linkgit:git-log[1]. Any aliases defined here can be used just
1697         as the built-in pretty formats could. For example,
1698         running `git config pretty.changelog "format:* %H %s"`
1699         would cause the invocation `git log --pretty=changelog`
1700         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1701         Note that an alias with the same name as a built-in format
1702         will be silently ignored.
1704 pull.rebase::
1705         When true, rebase branches on top of the fetched branch, instead
1706         of merging the default branch from the default remote when "git
1707         pull" is run. See "branch.<name>.rebase" for setting this on a
1708         per-branch basis.
1710 *NOTE*: this is a possibly dangerous operation; do *not* use
1711 it unless you understand the implications (see linkgit:git-rebase[1]
1712 for details).
1714 pull.octopus::
1715         The default merge strategy to use when pulling multiple branches
1716         at once.
1718 pull.twohead::
1719         The default merge strategy to use when pulling a single branch.
1721 push.default::
1722         Defines the action git push should take if no refspec is given
1723         on the command line, no refspec is configured in the remote, and
1724         no refspec is implied by any of the options given on the command
1725         line. Possible values are:
1727 * `nothing` - do not push anything.
1728 * `matching` - push all branches having the same name in both ends.
1729   This is for those who prepare all the branches into a publishable
1730   shape and then push them out with a single command.  It is not
1731   appropriate for pushing into a repository shared by multiple users,
1732   since locally stalled branches will attempt a non-fast forward push
1733   if other users updated the branch.
1734   +
1735   This is currently the default, but Git 2.0 will change the default
1736   to `simple`.
1737 * `upstream` - push the current branch to its upstream branch.
1738   With this, `git push` will update the same remote ref as the one which
1739   is merged by `git pull`, making `push` and `pull` symmetrical.
1740   See "branch.<name>.merge" for how to configure the upstream branch.
1741 * `simple` - like `upstream`, but refuses to push if the upstream
1742   branch's name is different from the local one. This is the safest
1743   option and is well-suited for beginners. It will become the default
1744   in Git 2.0.
1745 * `current` - push the current branch to a branch of the same name.
1746   +
1747   The `simple`, `current` and `upstream` modes are for those who want to
1748   push out a single branch after finishing work, even when the other
1749   branches are not yet ready to be pushed out. If you are working with
1750   other people to push into the same shared repository, you would want
1751   to use one of these.
1753 rebase.stat::
1754         Whether to show a diffstat of what changed upstream since the last
1755         rebase. False by default.
1757 rebase.autosquash::
1758         If set to true enable '--autosquash' option by default.
1760 receive.autogc::
1761         By default, git-receive-pack will run "git-gc --auto" after
1762         receiving data from git-push and updating refs.  You can stop
1763         it by setting this variable to false.
1765 receive.fsckObjects::
1766         If it is set to true, git-receive-pack will check all received
1767         objects. It will abort in the case of a malformed object or a
1768         broken link. The result of an abort are only dangling objects.
1769         Defaults to false. If not set, the value of `transfer.fsckObjects`
1770         is used instead.
1772 receive.unpackLimit::
1773         If the number of objects received in a push is below this
1774         limit then the objects will be unpacked into loose object
1775         files. However if the number of received objects equals or
1776         exceeds this limit then the received pack will be stored as
1777         a pack, after adding any missing delta bases.  Storing the
1778         pack from a push can make the push operation complete faster,
1779         especially on slow filesystems.  If not set, the value of
1780         `transfer.unpackLimit` is used instead.
1782 receive.denyDeletes::
1783         If set to true, git-receive-pack will deny a ref update that deletes
1784         the ref. Use this to prevent such a ref deletion via a push.
1786 receive.denyDeleteCurrent::
1787         If set to true, git-receive-pack will deny a ref update that
1788         deletes the currently checked out branch of a non-bare repository.
1790 receive.denyCurrentBranch::
1791         If set to true or "refuse", git-receive-pack will deny a ref update
1792         to the currently checked out branch of a non-bare repository.
1793         Such a push is potentially dangerous because it brings the HEAD
1794         out of sync with the index and working tree. If set to "warn",
1795         print a warning of such a push to stderr, but allow the push to
1796         proceed. If set to false or "ignore", allow such pushes with no
1797         message. Defaults to "refuse".
1799 receive.denyNonFastForwards::
1800         If set to true, git-receive-pack will deny a ref update which is
1801         not a fast-forward. Use this to prevent such an update via a push,
1802         even if that push is forced. This configuration variable is
1803         set when initializing a shared repository.
1805 receive.updateserverinfo::
1806         If set to true, git-receive-pack will run git-update-server-info
1807         after receiving data from git-push and updating refs.
1809 remote.<name>.url::
1810         The URL of a remote repository.  See linkgit:git-fetch[1] or
1811         linkgit:git-push[1].
1813 remote.<name>.pushurl::
1814         The push URL of a remote repository.  See linkgit:git-push[1].
1816 remote.<name>.proxy::
1817         For remotes that require curl (http, https and ftp), the URL to
1818         the proxy to use for that remote.  Set to the empty string to
1819         disable proxying for that remote.
1821 remote.<name>.fetch::
1822         The default set of "refspec" for linkgit:git-fetch[1]. See
1823         linkgit:git-fetch[1].
1825 remote.<name>.push::
1826         The default set of "refspec" for linkgit:git-push[1]. See
1827         linkgit:git-push[1].
1829 remote.<name>.mirror::
1830         If true, pushing to this remote will automatically behave
1831         as if the `--mirror` option was given on the command line.
1833 remote.<name>.skipDefaultUpdate::
1834         If true, this remote will be skipped by default when updating
1835         using linkgit:git-fetch[1] or the `update` subcommand of
1836         linkgit:git-remote[1].
1838 remote.<name>.skipFetchAll::
1839         If true, this remote will be skipped by default when updating
1840         using linkgit:git-fetch[1] or the `update` subcommand of
1841         linkgit:git-remote[1].
1843 remote.<name>.receivepack::
1844         The default program to execute on the remote side when pushing.  See
1845         option \--receive-pack of linkgit:git-push[1].
1847 remote.<name>.uploadpack::
1848         The default program to execute on the remote side when fetching.  See
1849         option \--upload-pack of linkgit:git-fetch-pack[1].
1851 remote.<name>.tagopt::
1852         Setting this value to \--no-tags disables automatic tag following when
1853         fetching from remote <name>. Setting it to \--tags will fetch every
1854         tag from remote <name>, even if they are not reachable from remote
1855         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1856         override this setting. See options \--tags and \--no-tags of
1857         linkgit:git-fetch[1].
1859 remote.<name>.vcs::
1860         Setting this to a value <vcs> will cause git to interact with
1861         the remote with the git-remote-<vcs> helper.
1863 remotes.<group>::
1864         The list of remotes which are fetched by "git remote update
1865         <group>".  See linkgit:git-remote[1].
1867 repack.usedeltabaseoffset::
1868         By default, linkgit:git-repack[1] creates packs that use
1869         delta-base offset. If you need to share your repository with
1870         git older than version 1.4.4, either directly or via a dumb
1871         protocol such as http, then you need to set this option to
1872         "false" and repack. Access from old git versions over the
1873         native protocol are unaffected by this option.
1875 rerere.autoupdate::
1876         When set to true, `git-rerere` updates the index with the
1877         resulting contents after it cleanly resolves conflicts using
1878         previously recorded resolution.  Defaults to false.
1880 rerere.enabled::
1881         Activate recording of resolved conflicts, so that identical
1882         conflict hunks can be resolved automatically, should they be
1883         encountered again.  By default, linkgit:git-rerere[1] is
1884         enabled if there is an `rr-cache` directory under the
1885         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1886         repository.
1888 sendemail.identity::
1889         A configuration identity. When given, causes values in the
1890         'sendemail.<identity>' subsection to take precedence over
1891         values in the 'sendemail' section. The default identity is
1892         the value of 'sendemail.identity'.
1894 sendemail.smtpencryption::
1895         See linkgit:git-send-email[1] for description.  Note that this
1896         setting is not subject to the 'identity' mechanism.
1898 sendemail.smtpssl::
1899         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1901 sendemail.<identity>.*::
1902         Identity-specific versions of the 'sendemail.*' parameters
1903         found below, taking precedence over those when the this
1904         identity is selected, through command-line or
1905         'sendemail.identity'.
1907 sendemail.aliasesfile::
1908 sendemail.aliasfiletype::
1909 sendemail.bcc::
1910 sendemail.cc::
1911 sendemail.cccmd::
1912 sendemail.chainreplyto::
1913 sendemail.confirm::
1914 sendemail.envelopesender::
1915 sendemail.from::
1916 sendemail.multiedit::
1917 sendemail.signedoffbycc::
1918 sendemail.smtppass::
1919 sendemail.suppresscc::
1920 sendemail.suppressfrom::
1921 sendemail.to::
1922 sendemail.smtpdomain::
1923 sendemail.smtpserver::
1924 sendemail.smtpserverport::
1925 sendemail.smtpserveroption::
1926 sendemail.smtpuser::
1927 sendemail.thread::
1928 sendemail.validate::
1929         See linkgit:git-send-email[1] for description.
1931 sendemail.signedoffcc::
1932         Deprecated alias for 'sendemail.signedoffbycc'.
1934 showbranch.default::
1935         The default set of branches for linkgit:git-show-branch[1].
1936         See linkgit:git-show-branch[1].
1938 status.relativePaths::
1939         By default, linkgit:git-status[1] shows paths relative to the
1940         current directory. Setting this variable to `false` shows paths
1941         relative to the repository root (this was the default for git
1942         prior to v1.5.4).
1944 status.showUntrackedFiles::
1945         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1946         files which are not currently tracked by Git. Directories which
1947         contain only untracked files, are shown with the directory name
1948         only. Showing untracked files means that Git needs to lstat() all
1949         all the files in the whole repository, which might be slow on some
1950         systems. So, this variable controls how the commands displays
1951         the untracked files. Possible values are:
1954 * `no` - Show no untracked files.
1955 * `normal` - Show untracked files and directories.
1956 * `all` - Show also individual files in untracked directories.
1959 If this variable is not specified, it defaults to 'normal'.
1960 This variable can be overridden with the -u|--untracked-files option
1961 of linkgit:git-status[1] and linkgit:git-commit[1].
1963 status.submodulesummary::
1964         Defaults to false.
1965         If this is set to a non zero number or true (identical to -1 or an
1966         unlimited number), the submodule summary will be enabled and a
1967         summary of commits for modified submodules will be shown (see
1968         --summary-limit option of linkgit:git-submodule[1]).
1970 submodule.<name>.path::
1971 submodule.<name>.url::
1972 submodule.<name>.update::
1973         The path within this project, URL, and the updating strategy
1974         for a submodule.  These variables are initially populated
1975         by 'git submodule init'; edit them to override the
1976         URL and other values found in the `.gitmodules` file.  See
1977         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1979 submodule.<name>.fetchRecurseSubmodules::
1980         This option can be used to control recursive fetching of this
1981         submodule. It can be overridden by using the --[no-]recurse-submodules
1982         command line option to "git fetch" and "git pull".
1983         This setting will override that from in the linkgit:gitmodules[5]
1984         file.
1986 submodule.<name>.ignore::
1987         Defines under what circumstances "git status" and the diff family show
1988         a submodule as modified. When set to "all", it will never be considered
1989         modified, "dirty" will ignore all changes to the submodules work tree and
1990         takes only differences between the HEAD of the submodule and the commit
1991         recorded in the superproject into account. "untracked" will additionally
1992         let submodules with modified tracked files in their work tree show up.
1993         Using "none" (the default when this option is not set) also shows
1994         submodules that have untracked files in their work tree as changed.
1995         This setting overrides any setting made in .gitmodules for this submodule,
1996         both settings can be overridden on the command line by using the
1997         "--ignore-submodules" option.
1999 tar.umask::
2000         This variable can be used to restrict the permission bits of
2001         tar archive entries.  The default is 0002, which turns off the
2002         world write bit.  The special value "user" indicates that the
2003         archiving user's umask will be used instead.  See umask(2) and
2004         linkgit:git-archive[1].
2006 transfer.fsckObjects::
2007         When `fetch.fsckObjects` or `receive.fsckObjects` are
2008         not set, the value of this variable is used instead.
2009         Defaults to false.
2011 transfer.unpackLimit::
2012         When `fetch.unpackLimit` or `receive.unpackLimit` are
2013         not set, the value of this variable is used instead.
2014         The default value is 100.
2016 url.<base>.insteadOf::
2017         Any URL that starts with this value will be rewritten to
2018         start, instead, with <base>. In cases where some site serves a
2019         large number of repositories, and serves them with multiple
2020         access methods, and some users need to use different access
2021         methods, this feature allows people to specify any of the
2022         equivalent URLs and have git automatically rewrite the URL to
2023         the best alternative for the particular user, even for a
2024         never-before-seen repository on the site.  When more than one
2025         insteadOf strings match a given URL, the longest match is used.
2027 url.<base>.pushInsteadOf::
2028         Any URL that starts with this value will not be pushed to;
2029         instead, it will be rewritten to start with <base>, and the
2030         resulting URL will be pushed to. In cases where some site serves
2031         a large number of repositories, and serves them with multiple
2032         access methods, some of which do not allow push, this feature
2033         allows people to specify a pull-only URL and have git
2034         automatically use an appropriate URL to push, even for a
2035         never-before-seen repository on the site.  When more than one
2036         pushInsteadOf strings match a given URL, the longest match is
2037         used.  If a remote has an explicit pushurl, git will ignore this
2038         setting for that remote.
2040 user.email::
2041         Your email address to be recorded in any newly created commits.
2042         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2043         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2045 user.name::
2046         Your full name to be recorded in any newly created commits.
2047         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2048         environment variables.  See linkgit:git-commit-tree[1].
2050 user.signingkey::
2051         If linkgit:git-tag[1] is not selecting the key you want it to
2052         automatically when creating a signed tag, you can override the
2053         default selection with this variable.  This option is passed
2054         unchanged to gpg's --local-user parameter, so you may specify a key
2055         using any method that gpg supports.
2057 web.browser::
2058         Specify a web browser that may be used by some commands.
2059         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2060         may use it.